From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Niklas Cassel <niklas.cassel@wdc.com>, linux-kernel@vger.kernel.org
Cc: Hannes Reinecke <hare@suse.de>,
linux-scsi@vger.kernel.org,
Damien Le Moal <damien.lemoal@opensource.wdc.com>
Subject: Re: [PATCH 25/25] Documentation: sysfs-block-device: document command duration limits
Date: Fri, 9 Dec 2022 10:22:36 +0700 [thread overview]
Message-ID: <Y5Kp/JhhwF1rjrdu@debian.me> (raw)
In-Reply-To: <20221208105947.2399894-26-niklas.cassel@wdc.com>
[-- Attachment #1: Type: text/plain, Size: 7721 bytes --]
On Thu, Dec 08, 2022 at 11:59:41AM +0100, Niklas Cassel wrote:
> +What: /sys/block/*/device/duration_limits/enable
> +Date: Dec, 2022
> +KernelVersion: v6.3
> +Contact: linux-scsi@vger.kernel.org
> +Description:
> + (RW) For ATA and SCSI devices supporting the command duration
> + limits feature, write to the file to turn on or off the
> + feature. By default this feature is turned off. If the device
> + does not support the command duration limits feature, this
> + attribute does not exist (the directory
> + "/sys/block/*/device/duration_limits" does not exist).
> + Writing "1" to this file enables the use of command duration
> + limits for read and write commands in the kernel and turns on
> + the feature on the device. Writing "0" disables the feature.
Sphinx reported inline emphasis warning due to unescaped asterisk above:
Documentation/ABI/testing/sysfs-block-device:101: WARNING: Inline emphasis start-string without end-string.
I have applied the fixup:
---- >8 ----
diff --git a/Documentation/ABI/testing/sysfs-block-device b/Documentation/ABI/testing/sysfs-block-device
index 44841f91c69bfe..2cf806b638fbb3 100644
--- a/Documentation/ABI/testing/sysfs-block-device
+++ b/Documentation/ABI/testing/sysfs-block-device
@@ -107,7 +107,7 @@ Description:
feature. By default this feature is turned off. If the device
does not support the command duration limits feature, this
attribute does not exist (the directory
- "/sys/block/*/device/duration_limits" does not exist).
+ "/sys/block/\*/device/duration_limits" does not exist).
Writing "1" to this file enables the use of command duration
limits for read and write commands in the kernel and turns on
the feature on the device. Writing "0" disables the feature.
> +
> +
> +What: /sys/block/*/device/duration_limits/read/[1-7]/*
> +Date: Dec, 2022
> +KernelVersion: v6.3
> +Contact: linux-scsi@vger.kernel.org
> +Description:
> + (RO) For ATA and SCSI devices supporting the command duration
> + limits feature, this shows the set of 7 command duration limits
> + descriptors for read commands currently set on the device. For
> + each of the 7 descritors, the following read-only attributes
> + are present:
> +
> + - duration_guideline: specifies the preferred length of time
> + in microseconds for the completion of a command.
> +
> + - duration_guideline_policy: specifies the policy action
> + taken if the duration_guideline attribute specifies a
> + non-zero command duration guideline that the device is
> + unable to achieve for a command.
> +
> + Possible values are:
> +
> + - 0x0: The device will complete the command at the
> + earliest possible time consistent with the
> + specified command duration guideline.
> + - 0x1: If the specified command duration guideline has
> + not been achieved and the command duration
> + guideline policy field is not the seventh command
> + duration limits descriptor, then the device
> + continues processing that command using the
> + command duration limits descriptor that has
> + the next higher number.
> + - 0x2: The device will continue processing the command
> + as with no command duration limits descriptor
> + being used.
> + - 0xD: The device will complete the command and an IO
> + failure will be reported to the user with the ETIME
> + error code.
> + - 0xF: Same as 0xD.
> +
> <snipped>...
> + Possible values are:
> +
> + - 0x0: The device will complete the command at the
> + earliest possible time (i.e, do nothing based on
> + the max limit not being met).
> + - 0xD: The device will complete the command and an IO
> + failure will be reported to the user with the ETIME
> + error code.
> + - 0xE: Same as 0xD.
> + - 0xF: Same as 0xD.
> +
> <snipped>...
> + Possible values are:
> +
> + - 0x0: The device will complete the command at the
> + earliest possible time (i.e, do nothing based on
> + the time limit not being met).
> + - 0xD: The device will complete the command and an IO
> + failure will be reported to the user with the ETIME
> + error code.
> + - 0xF: Same as 0xD.
> +
The lists items above looks poorly indented in htmldocs (due to use of
proportional fonts). The fix is to align to first character after bullet
list marker, like:
---- >8 ----
diff --git a/Documentation/ABI/testing/sysfs-block-device b/Documentation/ABI/testing/sysfs-block-device
index 2cf806b638fbb3..79f67b975d57ac 100644
--- a/Documentation/ABI/testing/sysfs-block-device
+++ b/Documentation/ABI/testing/sysfs-block-device
@@ -135,21 +135,25 @@ Description:
Possible values are:
- 0x0: The device will complete the command at the
- earliest possible time consistent with the
- specified command duration guideline.
+ earliest possible time consistent with the
+ specified command duration guideline.
+
- 0x1: If the specified command duration guideline has
- not been achieved and the command duration
- guideline policy field is not the seventh command
- duration limits descriptor, then the device
- continues processing that command using the
- command duration limits descriptor that has
- the next higher number.
+ not been achieved and the command duration
+ guideline policy field is not the seventh command
+ duration limits descriptor, then the device
+ continues processing that command using the
+ command duration limits descriptor that has
+ the next higher number.
+
- 0x2: The device will continue processing the command
- as with no command duration limits descriptor
- being used.
+ as with no command duration limits descriptor
+ being used.
+
- 0xD: The device will complete the command and an IO
- failure will be reported to the user with the ETIME
- error code.
+ failure will be reported to the user with the ETIME
+ error code.
+
- 0xF: Same as 0xD.
- max_active_time: specifies an upper limit in microseconds
@@ -165,12 +169,15 @@ Description:
Possible values are:
- 0x0: The device will complete the command at the
- earliest possible time (i.e, do nothing based on
- the max limit not being met).
+ earliest possible time (i.e, do nothing based on
+ the max limit not being met).
+
- 0xD: The device will complete the command and an IO
- failure will be reported to the user with the ETIME
- error code.
+ failure will be reported to the user with the ETIME
+ error code.
+
- 0xE: Same as 0xD.
+
- 0xF: Same as 0xD.
- max_inactive_time: specifies an upper limit in microseconds
@@ -185,11 +192,13 @@ Description:
Possible values are:
- 0x0: The device will complete the command at the
- earliest possible time (i.e, do nothing based on
- the time limit not being met).
+ earliest possible time (i.e, do nothing based on
+ the time limit not being met).
+
- 0xD: The device will complete the command and an IO
- failure will be reported to the user with the ETIME
- error code.
+ failure will be reported to the user with the ETIME
+ error code.
+
- 0xF: Same as 0xD.
Thanks.
--
An old man doll... just what I always wanted! - Clara
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
next prev parent reply other threads:[~2022-12-09 3:22 UTC|newest]
Thread overview: 38+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-12-08 10:59 [PATCH 00/25] Add Command Duration Limits support Niklas Cassel
2022-12-08 10:59 ` [PATCH 01/25] ata: scsi: rename flag ATA_QCFLAG_FAILED to ATA_QCFLAG_EH Niklas Cassel
2022-12-21 11:47 ` John Garry
2022-12-08 10:59 ` [PATCH 02/25] ata: libata: move NCQ related ATA_DFLAGs Niklas Cassel
2022-12-08 10:59 ` [PATCH 03/25] ata: libata: simplify qc_fill_rtf port operation interface Niklas Cassel
2022-12-21 11:48 ` John Garry
2022-12-08 10:59 ` [PATCH 04/25] ata: libata: fix broken NCQ command status handling Niklas Cassel
2022-12-08 10:59 ` [PATCH 05/25] ata: libata: respect successfully completed commands during errors Niklas Cassel
2022-12-08 10:59 ` [PATCH 06/25] ata: libata: allow ata_scsi_set_sense() to not set CHECK_CONDITION Niklas Cassel
2022-12-08 10:59 ` [PATCH 07/25] ata: libata: allow ata_eh_request_sense() " Niklas Cassel
2022-12-08 10:59 ` [PATCH 08/25] ata: libata-scsi: do not overwrite SCSI ML and status bytes Niklas Cassel
2022-12-08 10:59 ` [PATCH 09/25] ata: libata-scsi: improve ata_scsiop_maint_in() Niklas Cassel
2022-12-08 10:59 ` [PATCH 10/25] scsi: core: allow libata to complete successful commands via EH Niklas Cassel
2022-12-08 10:59 ` [PATCH 11/25] scsi: move get_scsi_ml_byte() to scsi_priv.h Niklas Cassel
2022-12-08 23:58 ` Mike Christie
2022-12-28 20:41 ` Niklas Cassel
2022-12-29 18:55 ` Mike Christie
2022-12-29 20:19 ` Niklas Cassel
2022-12-08 10:59 ` [PATCH 12/25] scsi: support retrieving sub-pages of mode pages Niklas Cassel
2022-12-08 10:59 ` [PATCH 13/25] scsi: support service action in scsi_report_opcode() Niklas Cassel
2022-12-08 10:59 ` [PATCH 14/25] block: introduce duration-limits priority class Niklas Cassel
2022-12-08 10:59 ` [PATCH 15/25] block: introduce BLK_STS_DURATION_LIMIT Niklas Cassel
2022-12-08 10:59 ` [PATCH 16/25] ata: libata: detect support for command duration limits Niklas Cassel
2022-12-08 10:59 ` [PATCH 17/25] ata: libata-scsi: handle CDL bits in ata_scsiop_maint_in() Niklas Cassel
2022-12-08 10:59 ` [PATCH 18/25] ata: libata-scsi: add support for CDL pages mode sense Niklas Cassel
2022-12-08 10:59 ` [PATCH 19/25] ata: libata: add ATA feature control sub-page translation Niklas Cassel
2022-12-08 10:59 ` [PATCH 20/25] ata: libata: set read/write commands CDL index Niklas Cassel
2022-12-08 10:59 ` [PATCH 21/25] scsi: sd: detect support for command duration limits Niklas Cassel
2022-12-08 10:59 ` [PATCH 22/25] scsi: sd: set read/write commands CDL index Niklas Cassel
2022-12-08 10:59 ` [PATCH 23/25] scsi: sd: handle read/write CDL timeout failures Niklas Cassel
2022-12-09 0:13 ` Mike Christie
2022-12-09 0:26 ` Damien Le Moal
2022-12-08 10:59 ` [PATCH 24/25] ata: libata: handle completion of CDL commands using policy 0xD Niklas Cassel
2022-12-08 10:59 ` [PATCH 25/25] Documentation: sysfs-block-device: document command duration limits Niklas Cassel
2022-12-09 3:22 ` Bagas Sanjaya [this message]
2022-12-09 3:31 ` Damien Le Moal
2022-12-08 18:18 ` [PATCH 00/25] Add Command Duration Limits support Chaitanya Kulkarni
2022-12-09 0:29 ` 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=Y5Kp/JhhwF1rjrdu@debian.me \
--to=bagasdotme@gmail.com \
--cc=damien.lemoal@opensource.wdc.com \
--cc=hare@suse.de \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-scsi@vger.kernel.org \
--cc=niklas.cassel@wdc.com \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.