Re: [PATCH v7 4/4] smartpqi: add device attributes

[Alejandro Colomar <alx@kernel.org>]

[-- Attachment #1: Type: text/plain, Size: 4139 bytes --]

Hi Don,

On Wed, Oct 11, 2023 at 02:00:24PM -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 a32eac206904..00524bb32850 100644
> --- a/man4/smartpqi.4
> +++ b/man4/smartpqi.4
> @@ -363,6 +363,101 @@ $ \c
>  0
>  .EE
>  .in
> +.TP
> +.I /sys/class/scsi_disk/c : b : t : l/device/lunid

I think this should rather be something like

.IR /sys/class/scsi_disk/ c : b : t : l /device/lunid

These rules from groff_man_style(7) apply:

              Use  italics  for  file  and path names, ...
                                      ...  An exception involves vari‐
              ant  text  in a context already typeset in italics, such
              as file or path names with  replaceable  components;  in
              such cases, follow the convention of mathematical typog‐
              raphy: set the file or path name in italics as usual but
              use  roman for the variant part (see .IR and .RI below),
              ...

Thanks,
Alex

> +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
> +.I /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
> +.I /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
> +.I /sys/class/scsi_disk/13:1:0:3/device/raid_bypass_cnt
> +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
> +.I /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.345.gaab89be2eb
> 

-- 
<https://www.alejandro-colomar.es/>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]