From patchwork Wed Jul 13 03:03:32 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 12915927 X-Patchwork-Delegate: herbert@gondor.apana.org.au 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 DC244CCA47F for ; Wed, 13 Jul 2022 03:04:08 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233601AbiGMDEF (ORCPT ); Tue, 12 Jul 2022 23:04:05 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36930 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233227AbiGMDEB (ORCPT ); Tue, 12 Jul 2022 23:04:01 -0400 Received: from mail-pf1-x436.google.com (mail-pf1-x436.google.com [IPv6:2607:f8b0:4864:20::436]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 8FF9126567; Tue, 12 Jul 2022 20:03:54 -0700 (PDT) Received: by mail-pf1-x436.google.com with SMTP id o12so9091373pfp.5; Tue, 12 Jul 2022 20:03:54 -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=nsfHfTVqf90nEaiU6k56lVhPYCBIEYDk4kIaHhxKKC2Af6TF9nsJZVwV59NUAvJhbx 1E3EF34yHVhJ88LHTBq3ZsR8+I699/7CQ+yYYSTcPHjjehjTx4C0FNwoJ//hhQgyxdcO DzzOkH9IprQbyq9cORzqtauFSpc7ZuRJDfbGQuAHfU/wPt5s4dF+CNQnuKW/gpMN+BYn TEKe85oJxCGbJXVd0AvZ7XeSKi0JXE+j3HAISQc4C+mnbuhBAePPEjUGm7I4OwAZmU/t WKjscUDWZ/cwLXiF3vyMBaQx+Fl2ydvIW6BHRcMsYNk+VnSll9ZhgLS5PkEm0Eq6dSXm ppxg== 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=zrJkY+lIHca/nlWvJvF3MKfwaoosdbxJGYFZDIBPVQREbrNE3VFI64spqTkOpl/If7 2uf6+Qdg6PfzAO3FN8ceVpme+U43NmXrAG1+ZY1iczmIlCBd/FtPHqfmlYhuKy4Gucg2 G3JVE3wd/Hc0eAXsN61LSGvdt7ltXCM4G++FkrPTzHE4EMetshtLzX4udECnHHgsac+h Cxw0SIRwrSIy4pxsk3uNBHk35CbjTFN5Bf2b3fxnkxNVRR7wwTS5RlhhsjtvoD9j3/wA UNIpW7nOgS4yADlXSgC5+I7/fGoq0RKL8gFc6pGAIrbZxDu3lFR8O2VMsJLGO2ck92EP Oaaw== X-Gm-Message-State: AJIora954w3mA2IlHS0hiF7RY6ByYWzU3w9R3pnmqLmmgE9Oh5h2OUeT TfjbdHyzOFR1BnoqFVM1cUxmsv9pBLKK/A== X-Google-Smtp-Source: AGRyM1sFEVXE8R9JzFF5X/rPxNJh3P77fMfRFwqdya5oRjJl3g+1tCHo0tlt1d77OFs4PThnzM6/+w== X-Received: by 2002:a05:6a00:158e:b0:52a:e628:8b3b with SMTP id u14-20020a056a00158e00b0052ae6288b3bmr1278718pfk.80.1657681434169; Tue, 12 Jul 2022 20:03:54 -0700 (PDT) Received: from debian.me (subs02-180-214-232-20.three.co.id. [180.214.232.20]) by smtp.gmail.com with ESMTPSA id lk2-20020a17090b33c200b001eee7950428sm313605pjb.44.2022.07.12.20.03.53 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 12 Jul 2022 20:03:53 -0700 (PDT) Received: by debian.me (Postfix, from userid 1000) id 113F3103132; Wed, 13 Jul 2022 10:03:47 +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 1/2] Documentation: qat: Use code block for qat sysfs example Date: Wed, 13 Jul 2022 10:03:32 +0700 Message-Id: <20220713030332.158525-2-bagasdotme@gmail.com> X-Mailer: git-send-email 2.37.0 In-Reply-To: <20220713030332.158525-1-bagasdotme@gmail.com> References: <20220713030332.158525-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 03:03:33 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 12915926 X-Patchwork-Delegate: herbert@gondor.apana.org.au 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 4F1E9CCA480 for ; Wed, 13 Jul 2022 03:04:05 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233061AbiGMDEC (ORCPT ); Tue, 12 Jul 2022 23:04:02 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36876 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233105AbiGMDEA (ORCPT ); Tue, 12 Jul 2022 23:04:00 -0400 Received: from mail-pj1-x1031.google.com (mail-pj1-x1031.google.com [IPv6:2607:f8b0:4864:20::1031]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 9014426ACA; Tue, 12 Jul 2022 20:03:54 -0700 (PDT) Received: by mail-pj1-x1031.google.com with SMTP id cp18-20020a17090afb9200b001ef79e8484aso2622322pjb.1; Tue, 12 Jul 2022 20:03:54 -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=LgwCqeVcRYkCGf4XTCEuyfhdt+DypSM7nZPaxNKHD/63Y6XZ3h802i7v6BFOlbTEcX cqc4Wuq3jhys/RSbVU3FzEitLPAOLrHnL6oUTWlMcXWEQCs+I5w8ZU/Y0prsig8sJXg3 1BGTuGsd9S/ZUSViw2qIK+NsfMrDZE7PV5Y0LqAF5z2IfV9OPviN1NyMj8w0pJlov8x7 JALigW7v+06Qk+BiK4Hg6Eihv9INXN6JVuz78ASq/P/QZGLINnvn65oaK/RkUX8OlKwk Fm8Cm0D6lBzgYTbG3kwhwmM07WislvSilTbsY57wRZPAXlgErXjOePXzmPq67/zewXKp qUiw== 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=OuZmALjGwFlCpiFKwzYzD8fiIUMxgOajJMJp4y9V7i9xpdbR3wEah9A1Z3gpFj0ePp /9dUyz1LW7CFsjmcJl9f4Nogl9RK8e0lWPzv3vVEfJfCw8BD3BVjYnkCBcWwjJ2SErhg r/JeJVJZ4I3y/KEDFGDpnU5eevGePGxJNCGRo+Fe9C+oTjSTs6pGdF9LcC2iFHd4hJNN /3ap+JFFT79oFd4zvO3GYYxxW/j8tkL+f34iIlFUqadSOAY29e/FLCQauoJX7sG6fJF/ l+U0SkNHJ2SGcsIsItrVON2cujzwKPE+O01QQYNzjxyMxHO8DmFLbaqmWaYh+6bBzNF0 03fw== X-Gm-Message-State: AJIora9Xl/CgzZgm7y+fD+RczuQQgMCs5qEYFL3KgAAhKoJ8uNHSfOYS BtpozYXYo4hn3Gs9iqicFXAg9yJmXQoy4w== X-Google-Smtp-Source: AGRyM1s/8vU43pwgJyeE2uZ33X0EfSLycxmaVf9MwR6348/GdgjdSlV7qRI5QkUGPhqsz86dDcxxJg== X-Received: by 2002:a17:902:d4c2:b0:16b:ffc5:9705 with SMTP id o2-20020a170902d4c200b0016bffc59705mr1137459plg.142.1657681433925; Tue, 12 Jul 2022 20:03:53 -0700 (PDT) Received: from debian.me (subs02-180-214-232-20.three.co.id. [180.214.232.20]) by smtp.gmail.com with ESMTPSA id l9-20020a170902f68900b0015e8d4eb24fsm7486570plg.153.2022.07.12.20.03.53 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 12 Jul 2022 20:03:53 -0700 (PDT) Received: by debian.me (Postfix, from userid 1000) id 2F2AD103950; Wed, 13 Jul 2022 10:03:47 +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 2/2] Documentation: qat: rewrite description Date: Wed, 13 Jul 2022 10:03:33 +0700 Message-Id: <20220713030332.158525-3-bagasdotme@gmail.com> X-Mailer: git-send-email 2.37.0 In-Reply-To: <20220713030332.158525-1-bagasdotme@gmail.com> References: <20220713030332.158525-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)