From patchwork Wed Jul 13 08:56:27 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 590118 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 9FF8DCCA488 for ; Wed, 13 Jul 2022 08:57:31 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235948AbiGMI53 (ORCPT ); Wed, 13 Jul 2022 04:57:29 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:38308 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235845AbiGMI5R (ORCPT ); Wed, 13 Jul 2022 04:57:17 -0400 Received: from mail-pg1-x535.google.com (mail-pg1-x535.google.com [IPv6:2607:f8b0:4864:20::535]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 9F5B9F271B; Wed, 13 Jul 2022 01:57:15 -0700 (PDT) Received: by mail-pg1-x535.google.com with SMTP id 73so9851389pgb.10; Wed, 13 Jul 2022 01:57:15 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=0BbmHqIsS3LgTRBAHaCLnc7YjI6SPA8/UqmwKvGHG6c=; b=D7Ohc/n1r3wvmPrwBti8cFe+/g6huQZ9SM8KeSGnhXTZXmg9HjqFE+apKi/zL2InTO KPKrYadJyuMATzg/M6obYfYBrhmMz3BcDQU59TB5GcMKcv+mIRH0TO5HQjZqhZOR6DZC Lq72gt0usWH07bIVHc2JoayfGdVwAoah4hZbZNm9VspsP2eJXfzE8m1VZ1BcSvN0CJHf FFIe8IsBOZdAgVgaWaq4wNwokKg932+uhsrRBg8vRvfgTdBtL8cEA8maa3EgzDVKhX4+ huO799+X4JwLPz8UF+4VPRvqDWLbGiOmHJE4vgh8xA8W/vuIrkI/svFL4x3nn1v5F97K qNPg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=0BbmHqIsS3LgTRBAHaCLnc7YjI6SPA8/UqmwKvGHG6c=; b=y1kM9jfhgvPV2D6msfnIqU4Lvf9PTxw8PFd/LMDfTy/V7fc2b4g4lNGORITHeC6c9f D8T8Dr02wrcEhDioz6IiIDFxkP5UfQ40duh0bd/8QJCbD/1+/A6K5H+WdAsp3/ArYD6B ehj409fWIgwgD0538W0zWjlizoI3C3XnT86gFSBDcG3NvAHQkVyrMYTx5gsNhRUpD3gL rpsDdD3cFY8s3eaEjKAgYcGsaeqxrvO+i8HBz6VcHG0e8G66Ckq8X3hwDjwVuujvUL/h khxsU0v9aahaLzrDACzW/l5tT1pj6mPFR927y5idYYyEwUekiCbA7RhkP5oPRQ9WPCW5 T9IQ== X-Gm-Message-State: AJIora9h6LP+7lfKrB3a2i+sX+vy1H0TGvEyj0SnIu+CbfbJqfXhdKYf wm0OIv3Sj03OtakP/a5uC8k= X-Google-Smtp-Source: AGRyM1sL0/JfwjzDQb6MDrfsWbRBcm6ZMKq/4K85O8vUUTLhjMkCBdlEo3fBsc0SIhuhas04OSErUw== X-Received: by 2002:a05:6a00:1aca:b0:528:1f7d:4ffe with SMTP id f10-20020a056a001aca00b005281f7d4ffemr2422613pfv.16.1657702635083; Wed, 13 Jul 2022 01:57:15 -0700 (PDT) Received: from debian.me (subs09a-223-255-225-69.three.co.id. [223.255.225.69]) by smtp.gmail.com with ESMTPSA id x13-20020aa78f0d000000b005292729cc5csm8242289pfr.160.2022.07.13.01.57.14 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 13 Jul 2022 01:57:14 -0700 (PDT) Received: by debian.me (Postfix, from userid 1000) id B022C103993; Wed, 13 Jul 2022 15:57:11 +0700 (WIB) From: Bagas Sanjaya To: linux-doc@vger.kernel.org, linux-next@vger.kernel.org Cc: Bagas Sanjaya , kernel test robot , Stephen Rothwell , Giovanni Cabiddu , Wojciech Ziemba , Adam Guerin , Fiona Trahe , Herbert Xu , Vladis Dronov , Tomasz Kowallik , linux-crypto@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH RESEND v2 1/2] Documentation: qat: Use code block for qat sysfs example Date: Wed, 13 Jul 2022 15:56:27 +0700 Message-Id: <20220713085627.175604-2-bagasdotme@gmail.com> X-Mailer: git-send-email 2.37.0 In-Reply-To: <20220713085627.175604-1-bagasdotme@gmail.com> References: <20220713085627.175604-1-bagasdotme@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-crypto@vger.kernel.org kernel test robot and Stephen Rothwell reported htmldocs warning: Documentation/ABI/testing/sysfs-driver-qat:24: WARNING: Unexpected indentation. The warning isn't caused by Date: field pointed by the warning, but rather by sysfs example that isn't in literal code block. Add the code block marker. Link: https://lore.kernel.org/linux-next/20220711204932.333379b4@canb.auug.org.au/ Link: https://lore.kernel.org/linux-doc/202207090803.TEGI95qw-lkp@intel.com/ Reported-by: kernel test robot Reported-by: Stephen Rothwell Fixes: d4cfb144f60551 ("crypto: qat - expose device config through sysfs for 4xxx") Acked-by: Giovanni Cabiddu Cc: Wojciech Ziemba Cc: Adam Guerin Cc: Fiona Trahe Cc: Herbert Xu Cc: Vladis Dronov Cc: Tomasz Kowallik Cc: linux-crypto@vger.kernel.org Cc: linux-kernel@vger.kernel.org Signed-off-by: Bagas Sanjaya --- Documentation/ABI/testing/sysfs-driver-qat | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Documentation/ABI/testing/sysfs-driver-qat b/Documentation/ABI/testing/sysfs-driver-qat index a600531e95628f..43e081ec22cc4a 100644 --- a/Documentation/ABI/testing/sysfs-driver-qat +++ b/Documentation/ABI/testing/sysfs-driver-qat @@ -46,7 +46,8 @@ Description: Reports the current configuration of the QAT device and allows The following example shows how to change the configuration of a device configured for running crypto services in order to - run data compression: + run data compression:: + # cat /sys/bus/pci/devices//qat/state up # cat /sys/bus/pci/devices//qat/cfg_services From patchwork Wed Jul 13 08:56:28 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 590119 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id E5E6FCCA482 for ; Wed, 13 Jul 2022 08:57:29 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235937AbiGMI52 (ORCPT ); Wed, 13 Jul 2022 04:57:28 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:38496 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235843AbiGMI5R (ORCPT ); Wed, 13 Jul 2022 04:57:17 -0400 Received: from mail-pf1-x42a.google.com (mail-pf1-x42a.google.com [IPv6:2607:f8b0:4864:20::42a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 7213CEE1DA; Wed, 13 Jul 2022 01:57:15 -0700 (PDT) Received: by mail-pf1-x42a.google.com with SMTP id d10so9673033pfd.9; Wed, 13 Jul 2022 01:57:15 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=TceMcUV+/l4WL/aDjeSG/t8FqTVXmRKi59JDreDyO4Y=; b=YR/UIXngdQpbtO47p/B49pkTwIduq8++/5exxY/5NLK1C4BARqLnsubk4tY1++NqEO ls+3wm0B21K6RIKR0/nBtyN7pGpL8T3LT2DmDuR/R6VkoZpEDwUQSv9qkAgqZ9APiIBI /87jaCS63a2eQ//jGmiUocWT2cNVEIowHg/FJCYc+pG1HtrDp9MHC5vB972LJPz1eWds 2pbgGZVKV8kmpZ40Oq0/2oEn3h+eeiYMenyrh4upNTZJiYYAA2oSJQvuxG3l0QmfsmIs vH4aNPePyNgeBAfTLT2rnKtcGb5evoKbMTWbJx8fnQM/p/9YVjkROnIg3tZaxalurIQx 3DfQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=TceMcUV+/l4WL/aDjeSG/t8FqTVXmRKi59JDreDyO4Y=; b=LwuIsgw2sq1zISF7Tw83Obhe7tmfmSp8H1xyvSFxm1RIDBxQgGjybVPTBglcau67HR G3nTnU0D+ooXYfhm8Fc38VoIL3sxQr5M7fkPPvj/EfDPH1Kwa100IhWiBJtwxhivrIfT FJOwRyTIIenZ82pv+ygM5gsKKKe7YLf1Yv34pwUqYBG+o5NxghGvU5hG7IEYJ5reGYfb eqGIA+MhMYfVfqRlzauKAx6pCnguydBusNf8qY5HND+SiMMMigIQcqJPCzg4Fndw7Ujl KOdjXxriS19uELGAWddB4EzosOAe9+hElZr5RwaKZr6aGcM537n7auyuKuqHU15zhIUv gpcw== X-Gm-Message-State: AJIora9uOALxWbtB6rFe/+d3mY8sdFWazUaF1Y+/9azDo0p9Em4b08j3 ikgAT0EeyzHfVkMF3EBR68Ywb/8lmor8Qg== X-Google-Smtp-Source: AGRyM1tsu1SxBk9EPNd+2+dGJgv7KO2elKPTAjyLJ2yuTvRLc4nOy0gSj01drJXgpzr9DvVr6YOkkw== X-Received: by 2002:a63:1a4c:0:b0:416:1821:733d with SMTP id a12-20020a631a4c000000b004161821733dmr2088509pgm.444.1657702634761; Wed, 13 Jul 2022 01:57:14 -0700 (PDT) Received: from debian.me (subs09a-223-255-225-69.three.co.id. [223.255.225.69]) by smtp.gmail.com with ESMTPSA id r2-20020a170902e3c200b0016c0eb202a5sm8202527ple.225.2022.07.13.01.57.14 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 13 Jul 2022 01:57:14 -0700 (PDT) Received: by debian.me (Postfix, from userid 1000) id 8A5DC103975; Wed, 13 Jul 2022 15:57:11 +0700 (WIB) From: Bagas Sanjaya To: linux-doc@vger.kernel.org, linux-next@vger.kernel.org Cc: Bagas Sanjaya , Giovanni Cabiddu , Adam Guerin , Tomasz Kowallik , Wojciech Ziemba , Fiona Trahe , linux-crypto@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH RESEND v2 2/2] Documentation: qat: rewrite description Date: Wed, 13 Jul 2022 15:56:28 +0700 Message-Id: <20220713085627.175604-3-bagasdotme@gmail.com> X-Mailer: git-send-email 2.37.0 In-Reply-To: <20220713085627.175604-1-bagasdotme@gmail.com> References: <20220713085627.175604-1-bagasdotme@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-crypto@vger.kernel.org The sysfs description contains redundancy on returned and allowed values list, due to the described sysfs is read-write. Rewrite. Acked-by: Giovanni Cabiddu Cc: Adam Guerin Cc: Tomasz Kowallik Cc: Giovanni Cabiddu Cc: Wojciech Ziemba Cc: Fiona Trahe Cc: linux-crypto@vger.kernel.org Cc: linux-kernel@vger.kernel.org Signed-off-by: Bagas Sanjaya --- Documentation/ABI/testing/sysfs-driver-qat | 34 +++++++--------------- 1 file changed, 11 insertions(+), 23 deletions(-) diff --git a/Documentation/ABI/testing/sysfs-driver-qat b/Documentation/ABI/testing/sysfs-driver-qat index 43e081ec22cc4a..185f81a2aab360 100644 --- a/Documentation/ABI/testing/sysfs-driver-qat +++ b/Documentation/ABI/testing/sysfs-driver-qat @@ -2,18 +2,14 @@ What: /sys/bus/pci/devices//qat/state Date: June 2022 KernelVersion: 5.20 Contact: qat-linux@intel.com -Description: Reports the current state of the QAT device and allows to - change it. +Description: (RW) Reports the current state of the QAT device. Write to + the file to start or stop the device. - This attribute is RW. + The values are: - Returned values: - up: the device is up and running - down: the device is down + * up: the device is up and running + * down: the device is down - Allowed values: - up: initialize and start the device - down: stop the device and bring it down It is possible to transition the device from up to down only if the device is up and vice versa. @@ -24,22 +20,14 @@ What: /sys/bus/pci/devices//qat/cfg_services Date: June 2022 KernelVersion: 5.20 Contact: qat-linux@intel.com -Description: Reports the current configuration of the QAT device and allows - to change it. +Description: (RW) Reports the current configuration of the QAT device. + Write to the file to change the configured services. - This attribute is RW. + The values are: - Returned values: - sym;asym: the device is configured for running - crypto services - dc: the device is configured for running - compression services - - Allowed values: - sym;asym: configure the device for running - crypto services - dc: configure the device for running - compression services + * sym;asym: the device is configured for running crypto + services + * dc: the device is configured for running compression services It is possible to set the configuration only if the device is in the `down` state (see /sys/bus/pci/devices//qat/state)