linux-ide.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Damien Le Moal <damien.lemoal@wdc.com>
To: Jens Axboe <axboe@kernel.dk>, linux-ide@vger.kernel.org
Cc: linux-block@vger.kernel.org
Subject: [PATCH v7 10/11] docs: sysfs-block-device: improve ncq_prio_enable documentation
Date: Mon, 16 Aug 2021 10:44:55 +0900	[thread overview]
Message-ID: <20210816014456.2191776-11-damien.lemoal@wdc.com> (raw)
In-Reply-To: <20210816014456.2191776-1-damien.lemoal@wdc.com>

From: Niklas Cassel <niklas.cassel@wdc.com>

NCQ priority is an optional feature of the NCQ feature set and should
not be confused with the NCQ feature set itself. Clarify the
description of the ncq_prio_enable attribute to avoid this confusion.

Also add the missing documentation for the equivalent
sas_ncq_prio_enable attribute.

Signed-off-by: Niklas Cassel <niklas.cassel@wdc.com>
Signed-off-by: Damien Le Moal <damien.lemoal@wdc.com>
---
 Documentation/ABI/testing/sysfs-block-device | 20 +++++++++++++++++---
 1 file changed, 17 insertions(+), 3 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-block-device b/Documentation/ABI/testing/sysfs-block-device
index aa0fb500e3c9..cf1013df4b92 100644
--- a/Documentation/ABI/testing/sysfs-block-device
+++ b/Documentation/ABI/testing/sysfs-block-device
@@ -55,6 +55,20 @@ Date:		Oct, 2016
 KernelVersion:	v4.10
 Contact:	linux-ide@vger.kernel.org
 Description:
-		(RW) Write to the file to turn on or off the SATA ncq (native
-		command queueing) support. By default this feature is turned
-		off.
+		(RW) Write to the file to turn on or off the SATA NCQ (native
+		command queueing) priority support. By default this feature is
+		turned off. If the device does not support the SATA NCQ
+		priority feature, writing "1" to this file results in an error.
+
+
+What:		/sys/block/*/device/sas_ncq_prio_enable
+Date:		Oct, 2016
+KernelVersion:	v4.10
+Contact:	linux-ide@vger.kernel.org
+Description:
+		(RW) This is the equivalent of the ncq_prio_enable attribute
+		file for SATA devices connected to a SAS host-bus-adapter
+		(HBA) implementing support for the SATA NCQ priority feature.
+		This file does not exist if the HBA driver does not implement
+		support for the SATA NCQ priority feature, regardless of the
+		device support for this feature.
-- 
2.31.1


  parent reply	other threads:[~2021-08-16  1:45 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-08-16  1:44 [PATCH v7 00/11] libata cleanups and improvements Damien Le Moal
2021-08-16  1:44 ` [PATCH v7 01/11] libata: fix ata_host_alloc_pinfo() Damien Le Moal
2021-08-16  5:53   ` Hannes Reinecke
2021-08-16 11:29   ` James Bottomley
2021-08-16 11:43     ` Damien Le Moal
2021-08-16  1:44 ` [PATCH v7 02/11] libata: fix ata_host_start() Damien Le Moal
2021-08-16  1:44 ` [PATCH v7 03/11] libata: simplify ata_scsi_rbuf_fill() Damien Le Moal
2021-08-16  1:44 ` [PATCH v7 04/11] libata: cleanup device sleep capability detection Damien Le Moal
2021-08-16  1:44 ` [PATCH v7 05/11] libata: cleanup ata_dev_configure() Damien Le Moal
2021-08-16  1:44 ` [PATCH v7 06/11] libata: cleanup NCQ priority handling Damien Le Moal
2021-08-16  1:44 ` [PATCH v7 07/11] libata: fix ata_read_log_page() warning Damien Le Moal
2021-08-16  1:44 ` [PATCH v7 08/11] libata: print feature list on device scan Damien Le Moal
2021-08-16  1:44 ` [PATCH v7 09/11] libata: Introduce ncq_prio_supported sysfs sttribute Damien Le Moal
2021-08-16  5:54   ` Hannes Reinecke
2021-08-16  1:44 ` Damien Le Moal [this message]
2021-08-16  5:54   ` [PATCH v7 10/11] docs: sysfs-block-device: improve ncq_prio_enable documentation Hannes Reinecke
2021-08-16  1:44 ` [PATCH v7 11/11] docs: sysfs-block-device: document ncq_prio_supported Damien Le Moal
2021-08-16  5:55   ` Hannes Reinecke
2021-08-18  9:54 ` [PATCH v7 00/11] libata cleanups and improvements Damien Le Moal
2021-08-18 13:20 ` Jens Axboe
2021-08-18 21:53   ` Damien Le Moal

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210816014456.2191776-11-damien.lemoal@wdc.com \
    --to=damien.lemoal@wdc.com \
    --cc=axboe@kernel.dk \
    --cc=linux-block@vger.kernel.org \
    --cc=linux-ide@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).