Re: [PATCH v9 3/3] smartpqi: add device attributes

Alejandro Colomar
2023-10-24T23:23:07Z

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

On Wed, Oct 25, 2023 at 01:18:04AM +0200, Alejandro Colomar wrote:
> Hi Don,
>
> > Subject: Re: [PATCH v9 3/3] smartpqi: add device attributes
>
> Subject modified to "smartpqi.4: Add device attributes".
>
> On Tue, Oct 24, 2023 at 05:01:53PM -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>
>
> Patch applied (with a minor tweak; see a comment below).
>
> Cheers,
> Alex
>
> > ---
> > man4/smartpqi.4 | 99 +++++++++++++++++++++++++++++++++++++++++++++++++
> > 1 file changed, 99 insertions(+)
> >
> > diff --git a/man4/smartpqi.4 b/man4/smartpqi.4
> > index 0cb018d01fc5..d06f34d55d10 100644
> > --- a/man4/smartpqi.4
> > +++ b/man4/smartpqi.4
> > @@ -364,6 +364,105 @@ $ \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
> > +.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.
> > +.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
> > +
>
> Blank lines in man(7) source produce warnings, as they are usually a
> mistake. In this case it's fine, but to silence the warning, we use a
> dummy character, which produces no output, but makes it so that the
> input line is not empty.
>
> @@ -440,7 +440,7 @@ .SS SmartPQI-specific disk attribute files in \f[BI]/sys\fP
> $ \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
>
> > +$ \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/ c : b : t : l /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

Oh, and this triggered a warning. I've amended it to use B instead of
BI. See:

$ make lint build check -j24 -k
TROFF .tmp/man/man4/smartpqi.4.cat.set
an.tmac:man4/smartpqi.4:459: style: .BI expects at least 2 arguments, got 1
make: *** [share/mk/build/catman.mk:54: .tmp/man/man4/smartpqi.4.cat.set] Error 1
make: *** Deleting file '.tmp/man/man4/smartpqi.4.cat.set'
make: Target 'build' not remade because of errors.
make: Target 'check' not remade because of errors.

Cheers,
Alex

> > +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/ c : b : t : l /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.482.g2e8e77cbac
> >
>
> --
> <https://www.alejandro-colomar.es/>