From: Alejandro Colomar <alx@kernel.org>
To: Don Brace <don.brace@microchip.com>
Cc: linux-man@vger.kernel.org
Subject: Re: [PATCH v8 3/3] smartpqi: add device attributes
Date: Tue, 17 Oct 2023 01:52:33 +0200 [thread overview]
Message-ID: <ZS3MwU7MNF3p7yes@debian> (raw)
In-Reply-To: <20231016160403.636655-4-don.brace@microchip.com>
[-- Attachment #1: Type: text/plain, Size: 6151 bytes --]
Hi Don,
On Mon, Oct 16, 2023 at 11:04:03AM -0500, Don Brace wrote:
> Add in some device level sysfs entry descriptions:
> lunid
> unique_id
> path_info
> raid_bypass_cnt
> sas_ncq_prio_enable
>
> These have already been provided by the driver.
>
> Reviewed-by: Scott Benesh <scott.benesh@microchip.com>
> Reviewed-by: Scott Teel <scott.teel@microchip.com>
> Reviewed-by: Mike McGowen <mike.mcgowen@microchip.com>
> Reviewed-by: Kevin Barnett <kevin.barnett@microchip.com>
> Signed-off-by: Don Brace <don.brace@microchip.com>
> ---
> man4/smartpqi.4 | 95 +++++++++++++++++++++++++++++++++++++++++++++++++
> 1 file changed, 95 insertions(+)
>
> diff --git a/man4/smartpqi.4 b/man4/smartpqi.4
> index 89387c0498fd..00a8146eba6b 100644
> --- a/man4/smartpqi.4
> +++ b/man4/smartpqi.4
> @@ -301,6 +301,101 @@ $ \c
> 0
> .EE
> .in
> +.TP
> +.IR /sys/class/scsi_disk/c : b : t : l/device/lunid
> +The
> +.I lunid
> +attribute is read-only.
> +This attribute contains the SCSI LUN ID for the device.
> +.IP
> +For example:
> +.IP
> +.in +4n
> +.EX
> +$ \c
> +.B cat /sys/class/scsi_disk/13:1:0:3/device/lunid
> +0x0300004000000000
> +.EE
> +.in
> +.TP
> +.IR /sys/class/scsi_disk/c : b : t : l/device/unique_id
> +The
> +.I unique_id
> +attribute is read-only.
> +This attribute contains a 16-byte ID that uniquely identifies the device
> +within the controller.
> +.IP
> +For example:
> +.IP
> +.in +4n
> +.EX
> +$ \c
> +.B cat /sys/class/scsi_disk/13:1:0:3/device/unique_id
> +600508B1001C6D4723A8E98D704FDB94
> +.EE
> +.in
> +.TP
> +.IR /sys/class/scsi_disk/c : b : t : l/device/path_info
> +The
> +.I path_info
> +attribute is read-only.
> +This attribute contains the c:b:t:l of the device along with the device
> +type and whether the device is Active or Inactive.
> +If the device is an HBA device,
> +.I path_info
> +will also display the PORT, BOX, and BAY the device is plugged into.
> +.IP
> +For example:
> +.IP
> +.in +4n
> +.EX
> +$ \c
> +.B cat /sys/class/scsi_disk/13:1:0:3/device/path_info
> +[13:1:0:3] Direct-Access Active
> +
> +$ \c
> +.B cat /sys/class/scsi_disk/12:0:9:0/device/path_info
> +[12:0:9:0] Direct-Access PORT: C1 BOX: 1 BAY: 14 Inactive
> +[12:0:9:0] Direct-Access PORT: C0 BOX: 1 BAY: 14 Active
> +.EE
> +.in
> +.TP
> +.IR /sys/class/scsi_disk/13:1:0:3/device/raid_bypass_cnt
This is probably a typo. I guess you wanted to use c:b:t:l too.
> +The
> +.I raid_bypass_cnt
> +attribute is read-only.
> +This attribute contains the number of I/O requests that have gone
> +through the ioaccel path for ioaccel-enabled volumes.
> +See the
> +.BI ssd_smart_path_enabled
> +disk attribute section for details on ioaccel-enabled volumes.
> +.IP
> +For example:
> +.IP
> +.in +4n
> +.EX
> +$ \c
> +.B cat /sys/class/scsi_disk/13:1:0:3/device/raid_bypass_cnt
> +0x300
> +.EE
> +.in
> +.TP
> +.IR /sys/class/scsi_disk/13:1:0:3/device/sas_ncq_prio_enable
> +The
> +.I sas_ncq_prio_enable
> +attribute is read/write.
> +This attribute enables SATA NCQ priority support.
> +This attribute works only when device has NCQ support and
> +controller firmware can handle IO with NCQ priority attribute.
> +.IP
> +For example:
> +.IP
> +.in +4n
> +.EX
> +$ \c
> +.B echo 1 > /sys/class/scsi_disk/13:1:0:3/device/sas_ncq_prio_enable
> +.EE
> +.in
> .SH VERSIONS
> The
> .B smartpqi
> --
> 2.42.0.357.g59167d7d09
>
I've applied a few formatting fixes to the patch. Please apply the
below diff to your patch before fixing the typo.
Thanks,
Alex
diff --git a/man4/smartpqi.4 b/man4/smartpqi.4
index c0b305935..4aefbfde0 100644
--- a/man4/smartpqi.4
+++ b/man4/smartpqi.4
@@ -383,7 +383,7 @@ .SS SmartPQI-specific disk attribute files in \f[BI]/sys\fP
.EE
.in
.TP
-.IR /sys/class/scsi_disk/c : b : t : l/device/lunid
+.IR /sys/class/scsi_disk/ c : b : t : l /device/lunid
The
.I lunid
attribute is read-only.
@@ -399,12 +399,12 @@ .SS SmartPQI-specific disk attribute files in \f[BI]/sys\fP
.EE
.in
.TP
-.IR /sys/class/scsi_disk/c : b : t : l/device/unique_id
+.IR /sys/class/scsi_disk/ c : b : t : l /device/unique_id
The
.I unique_id
attribute is read-only.
-This attribute contains a 16-byte ID that uniquely identifies the device
-within the controller.
+This attribute contains a 16-byte ID
+that uniquely identifies the device within the controller.
.IP
For example:
.IP
@@ -416,12 +416,15 @@ .SS SmartPQI-specific disk attribute files in \f[BI]/sys\fP
.EE
.in
.TP
-.IR /sys/class/scsi_disk/c : b : t : l/device/path_info
+.IR /sys/class/scsi_disk/ c : b : t : l /device/path_info
The
.I path_info
attribute is read-only.
-This attribute contains the c:b:t:l of the device along with the device
-type and whether the device is Active or Inactive.
+This attribute contains the
+.IR c : b : t : l
+of the device
+along with the device type
+and whether the device is Active or Inactive.
If the device is an HBA device,
.I path_info
will also display the PORT, BOX, and BAY the device is plugged into.
@@ -445,8 +448,9 @@ .SS SmartPQI-specific disk attribute files in \f[BI]/sys\fP
The
.I raid_bypass_cnt
attribute is read-only.
-This attribute contains the number of I/O requests that have gone
-through the ioaccel path for ioaccel-enabled volumes.
+This attribute contains the number of I/O requests
+that have gone through the ioaccel path
+for ioaccel-enabled volumes.
See the
.BI ssd_smart_path_enabled
disk attribute section for details on ioaccel-enabled volumes.
@@ -466,8 +470,8 @@ .SS SmartPQI-specific disk attribute files in \f[BI]/sys\fP
.I sas_ncq_prio_enable
attribute is read/write.
This attribute enables SATA NCQ priority support.
-This attribute works only when device has NCQ support and
-controller firmware can handle IO with NCQ priority attribute.
+This attribute works only when device has NCQ support
+and controller firmware can handle IO with NCQ priority attribute.
.IP
For example:
.IP
--
<https://www.alejandro-colomar.es/>
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
prev parent reply other threads:[~2023-10-16 23:52 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-10-16 16:04 [PATCH v8 0/3] smartpqi man page updates Don Brace
2023-10-16 16:04 ` [PATCH v8 1/3] smartpqi: update host attribute descriptions Don Brace
2023-10-16 23:32 ` Alejandro Colomar
2023-10-16 16:04 ` [PATCH v8 2/3] smartpqi: remove sysfs entry for version Don Brace
2023-10-16 16:04 ` [PATCH v8 3/3] smartpqi: add device attributes Don Brace
2023-10-16 23:52 ` Alejandro Colomar [this message]
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=ZS3MwU7MNF3p7yes@debian \
--to=alx@kernel.org \
--cc=don.brace@microchip.com \
--cc=linux-man@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 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.