smartpqi man page updates

PATCH Superseded Don Brace 2 participants 8 messages Oct 24, 2023 Man-pages: manual pages for Linux -- Sections 2, 3, 4, 5, and 7

lore

Share & tools

lore

Don Brace

author

2023-10-24 22:03 UTC #0 lore raw

v9 cover smartpqi man page updates

These patches are based the man page content found in
git://git.kernel.org/pub/scm/docs/man-pages/man-pages.git

The Linux man page smartpqi.4 is out-of-date with the man page provided by our out-of-box driver. This patch series brings the Linux man page up to date.

The changes are:
smarpqi-update-copyright-and-email-addresses
The copyright, email, and URLs have changed to Microchip.
smartpqi-update-module-parameter-descriptions
We changed some descriptions of some of our module parameters. Clarifies what their default values are.
smartpqi-add-module-parameter_disable_managed_interrupts
We added a new module parameter to allow users to disable how interrupts are managed allowing them to change affinity.
smartpqi-add-module-parameter_ctrl_ready_timeout
We added a new module parameter to allow users to change how
long the driver waits for the controller becomes ready. The
default is 180 seconds and can be changed from 30-1800 seconds.
The longer wait times are useful for large configurations.
smartpqi-update_FILES_section
Minor change to the FILES section. The word "Logical" was changed to "Disk" since HBA disks are also supported.
smartpqi-update-host-attribute-descriptions
Updated the descriptions of existing host attributes accessed through sysfs.
smartpqi-update-device-attribute-descriptions
Updated the descriptions of existing device attributes accessed through sysfs.
smartpqi-add-host-attributes
We added some new host attributes:
enable_stream_detection: For RAID5/6 sequential write operations, this
can help increase IOPS. Reduces Read/Modify/Write operations. This is for AIO capable devices. (Volumes consisting of non-rotating media).
enable_r5_writes: Send down RAID 5 write operations down the AIO path.
enable_r6_writes: Send down RAID 6 write operations down the AIO path.
smartpqi-add-device-attributes
We added some new device attributes:
lunid - SCSI LUN ID
unique_id - 16-byte ID that uniquely identifies the device within the controller. path_info - Host:Bus:Target:Lun (h:b:t:l), device type, Active/Inactive raid_bypass_cnt - Count of the number of request sent down the AIO path. sas_ncq_prio_enable - Enables SATA NCQ priority support.
smartpqi-add-sg-entry-to-see_also
Simple addition of the sg(4) driver to the SEE ALSO section.

Changes since V8:

smartpqi-update-host-attribute-descriptions
I added an explanation for changing "logical drives" to "logical volumes". Alejandro Colomar <[email protected]>

Link https://lore.kernel.org/linux-man/ZS3IKF9XHOuQaMMt@debian/ open here

smartpqi-add-device-attributes
Changed the sysfs entry from a specific Host:Bus:Target:Lun to generic c : b : t : l
Shortened some lines.
Alejandro Colomar <[email protected]>

Link https://lore.kernel.org/linux-man/ZS3MwU7MNF3p7yes@debian/ open here

Changes since V7:

smartpqi-update-host-attribute-descriptions
I had removed some patch context, but did not update the patch description to reflect the updated patch.
Alejandro Colomar <[email protected]>

Link https://marc.info/?l=linux-man&m=169732291731554&w=2

smartpqi: add device attributes
Changed the sysfs path entry for each device attribute from ".I" to ".IR". Alejandro Colomar <[email protected]>

Link https://marc.info/?l=linux-man&m=169732400031940&w=2

Thanks Alejandro for your review and suggestions.

Changes since V6:
patch "(smartpqi-add-module-parameter_ctrl_ready_timeout)" was applied.
patch "(smartpqi-update_FILES_section)" was applied. Some minor updates requested by Alejandro Colomar <[email protected]> Thanks Alejandro for your review and suggestions.

The V7 updates include the following patches:

smartpqi-update-host-attribute-descriptions
Moved the sysfs entry removal description for "version"
smartpqi-remove-sysfs-entry-for-version
New patch for removal of sysfs entry for "version". Added HISTORY section.
Alejandro Colomar <[email protected]>

Link https://marc.info/?l=linux-man&m=169680471921234&w=2

Changes since V5:
smartpqi: add module parameter ctrl_ready_timeout
Forgot to change the range of values for ctrl_ready_timeout. Changed 0 or 30,1800 to 0 or [30,1800]
Alejandro Colomar <[email protected]>

Link https://lore.kernel.org/linux-man/ZRtfS8DIxlqNN-XH@debian/ open here

Sorry about that. Thanks for your review.

Changes since V4:
Added patch smartpqi-add-HISTORY-section
Added HISTORY section to explain that the sysfs entry for 'version' was replaced by two new sysfs entries: driver_version, and firmware_version.

Link https://lore.kernel.org/linux-man/ZRtgG396-1Cj4gn2@debian/ open here

smartpqi: add module parameter ctrl_ready_timeout
Minor update to parameter description due to suggestion by:
Alejandro Colomar <[email protected]>

Link https://lore.kernel.org/linux-man/ZRtfS8DIxlqNN-XH@debian/ open here

Changes since V3:
Updated content for the following pages due to reviews by:
Alejandro Colomar <[email protected]>

smartpqi: add module parameter ctrl_ready_timeout

Link https://lore.kernel.org/linux-man/axwssorupkp6fv3b7zqgjyd243exvhlw7rle2ftyy43jxhm4yf@woxzbz4hm766/ open here

smartpqi: update FILES section

Link https://lore.kernel.org/linux-man/fwpvmbussvf2zzug5bsqhrd7mvwcvdllvna6a4ngke3hw6w5am@b4icgpgirck4/ open here

smartpqi: update host attribute descriptions

Link https://lore.kernel.org/linux-man/ss7k5ooeoi7y56j6otvdpwhgd5yltzk6nt5l6ujiiupxzpmrdx@zrcvhw364ejx/ open here

smartpqi: add host attributes

Link https://lore.kernel.org/linux-man/nbt3jt7busx6akj7ykaxs7df6vlbbxtvcdy4ckvlp7saol3djl@rb6ckz3lzzot/ open here

smartpqi: add device attributes

Link https://lore.kernel.org/linux-man/ytcsqleu53iwpn5gsjmmuoqz2cy5oegvvafwlwxn422bcn3a5e@ne3khvixxzuq/ open here

The other patches have already been applied and were removed from the remaining patch set after a rebase.

Thanks for your attention and reviews for these patches.

Changes since V2:
Resending due to bad e-mail address for maintainer.

Changes since V1:
Broke up the large patch into multiple smaller patches due to review by:
Alejandro Colomar <[email protected]>

Link https://lore.kernel.org/all/[email protected]/ open here

---

Don Brace (3):
smartpqi: update host attribute descriptions
smartpqi: remove sysfs entry for version
smartpqi: add device attributes

 man4/smartpqi.4 | 128 ++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 108 insertions(+), 20 deletions(-)

Signature · 1 line

2.42.0.482.g2e8e77cbac

Don Brace

author

2023-10-24 22:02 UTC #1 lore raw

PATCH v9 1/3 smartpqi: update host attribute descriptions

Minor description changes for host attributes.

Change the word "drives" to "volumes" to match our documentation and how they are presented to SCSI Mid-layer:
as "LOGICAL VOLUMES".

I.E.
[0:1:0:0] disk HP LOGICAL VOLUME 7.02 /dev/sdc

Reviewed-by Scott Benesh <[email protected]>

Reviewed-by Scott Teel <[email protected]>

Reviewed-by Mike McGowen <[email protected]>

Reviewed-by Kevin Barnett <[email protected]>

Signed-off-by Don Brace <[email protected]>

---
 man4/smartpqi.4 | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

man4/smartpqi.4 +2 -2

index 8227f455e052..ea8bd5e2d612 100644
@@ -138,12 +138,12 @@ The host
 attribute is a write-only attribute.
 Writing to this attribute will cause the driver to scan for new,
 changed, or removed devices (e.g., hot-plugged tape drives, or newly
-configured or deleted logical drives) and notify the SCSI mid-layer of
+configured or deleted logical volumes) and notify the SCSI mid-layer of
 any changes detected.
 Usually this action is triggered automatically by configuration
 changes, so the user should not normally have to write to this file.
 Doing so may be useful when hot-plugging devices such as tape drives or
-entire storage boxes containing pre-configured logical drives.
+entire storage boxes containing pre-configured logical volumes.
 .TP
 .IR /sys/class/scsi_host/host * /version
 The host

Signature · 1 line

2.42.0.482.g2e8e77cbac

Alejandro Colomar

maintainer

2023-10-24 23:04 UTC #2 lore raw

Re: [PATCH v9 1/3] smartpqi: update host attribute descriptions

Hi Don,

Quoted 9 lines · Don Brace

Minor description changes for host attributes.
Change the word "drives" to "volumes" to match our documentation and how they are presented to SCSI Mid-layer:
as "LOGICAL VOLUMES".
I.E.
[0:1:0:0] disk HP LOGICAL VOLUME 7.02 /dev/sdc

Quoted 6 lines

Reviewed-by Scott Benesh <[email protected]>
Reviewed-by Scott Teel <[email protected]>
Reviewed-by Mike McGowen <[email protected]>
Reviewed-by Kevin Barnett <[email protected]>
Signed-off-by Don Brace <[email protected]>
---

Patch applied.

Thanks,
Alex

Quoted 25 lines

 man4/smartpqi.4 | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

man4/smartpqi.4 +2 -2

index 8227f455e052..ea8bd5e2d612 100644
@@ -138,12 +138,12 @@ The host
 attribute is a write-only attribute.
 Writing to this attribute will cause the driver to scan for new,
 changed, or removed devices (e.g., hot-plugged tape drives, or newly
-configured or deleted logical drives) and notify the SCSI mid-layer of
+configured or deleted logical volumes) and notify the SCSI mid-layer of
 any changes detected.
 Usually this action is triggered automatically by configuration
 changes, so the user should not normally have to write to this file.
 Doing so may be useful when hot-plugging devices such as tape drives or
-entire storage boxes containing pre-configured logical drives.
+entire storage boxes containing pre-configured logical volumes.
 .TP
 .IR /sys/class/scsi_host/host * /version
 The host

Signature · 1 line

2.42.0.482.g2e8e77cbac

Signature · 1 line

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

Don Brace

author

2023-10-24 22:02 UTC #3 lore raw

PATCH v9 2/3 smartpqi: remove sysfs entry for version

In reply to Don Brace

Remove the "version" sysfs entry. This entry was changed into two sysfs entries: driver_version and firmware_version.

Add HISTORY section.
Enumerate old sysfs entries replaced by newer entries.

Signed-off-by Don Brace <[email protected]>

---
 man4/smartpqi.4 | 25 +++++++------------------
 1 file changed, 7 insertions(+), 18 deletions(-)

man4/smartpqi.4 +7 ~~-18~~

index ea8bd5e2d612..0cb018d01fc5 100644
@@ -145,24 +145,6 @@ changes, so the user should not normally have to write to this file.
 Doing so may be useful when hot-plugging devices such as tape drives or
 entire storage boxes containing pre-configured logical volumes.
 .TP
-.IR /sys/class/scsi_host/host * /version
-The host
-.I version
-attribute is a read-only attribute.
-This attribute contains the driver version and the controller firmware
-version.
-.IP
-For example:
-.IP
-.in +4n
-.EX
-$ \c
-.B cat /sys/class/scsi_host/host1/version
-driver: 1.1.2\-126
-firmware: 1.29\-112
-.EE
-.in
-.TP
 .IR /sys/class/scsi_host/host * /lockup_action
 The host
 .I lockup_action

@@ -393,6 +375,13 @@ refer to the User Guide for the controller,
 which can be found by searching for the specific controller at
 .UR https://www.microchip.com/design-centers/storage
 .UE .
+.SH HISTORY
+.I /sys/class/scsi_host/host*/version
+was replaced by two sysfs entries:
+.IP
+.I /sys/class/scsi_host/host*/driver_version
+.IP
+.I /sys/class/scsi_host/host*/firmware_version
 .SH SEE ALSO
 .BR cciss (4),
 .BR hpsa (4),

Signature · 1 line

2.42.0.482.g2e8e77cbac

Alejandro Colomar

maintainer

2023-10-24 23:10 UTC #4 lore raw

Re: [PATCH v9 2/3] smartpqi: remove sysfs entry for version

Hi Don,

Quoted 43 lines · Don Brace

Remove the "version" sysfs entry. This entry was changed into two sysfs entries: driver_version and firmware_version.

Add HISTORY section.
Enumerate old sysfs entries replaced by newer entries.

Signed-off-by Don Brace <[email protected]>

---
 man4/smartpqi.4 | 25 +++++++------------------
 1 file changed, 7 insertions(+), 18 deletions(-)

man4/smartpqi.4 +0 ~~-18~~

index ea8bd5e2d612..0cb018d01fc5 100644
@@ -145,24 +145,6 @@ changes, so the user should not normally have to write to this file.
 Doing so may be useful when hot-plugging devices such as tape drives or
 entire storage boxes containing pre-configured logical volumes.
 .TP
-.IR /sys/class/scsi_host/host * /version
-The host
-.I version
-attribute is a read-only attribute.
-This attribute contains the driver version and the controller firmware
-version.
-.IP
-For example:
-.IP
-.in +4n
-.EX
-$ \c
-.B cat /sys/class/scsi_host/host1/version
-driver: 1.1.2\-126
-firmware: 1.29\-112
-.EE
-.in
-.TP
 .IR /sys/class/scsi_host/host * /lockup_action
 The host
 .I lockup_action

man4/smartpqi.4 refer to the User Guide for the controller, · line 384

Quoted 10 lines

man4/smartpqi.4 +7 -0

@@ -393,6 +375,13 @@ refer to the User Guide for the controller,
 which can be found by searching for the specific controller at
 .UR https://www.microchip.com/design-centers/storage
 .UE .
+.SH HISTORY
+.I /sys/class/scsi_host/host*/version
+was replaced by two sysfs entries:
+.IP
+.I /sys/class/scsi_host/host*/driver_version
+.IP
+.I /sys/class/scsi_host/host*/firmware_version

Should we maybe specify when this changed? Do you think that would be relevant to programmers?

Thanks,
Alex

Quoted 6 lines

man4/smartpqi.4 +0 -0
 .SH SEE ALSO
 .BR cciss (4),
 .BR hpsa (4),
Signature · 1 line
2.42.0.482.g2e8e77cbac

Signature · 1 line

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

Don Brace

author

2023-10-24 22:02 UTC #5 lore raw

PATCH v9 3/3 smartpqi: add device attributes

In reply to Don Brace

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 <[email protected]>

Reviewed-by Scott Teel <[email protected]>

Reviewed-by Mike McGowen <[email protected]>

Reviewed-by Kevin Barnett <[email protected]>

Signed-off-by Don Brace <[email protected]>

---
 man4/smartpqi.4 | 99 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 99 insertions(+)

man4/smartpqi.4 +99 -0

index 0cb018d01fc5..d06f34d55d10 100644
@@ -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
+
+$ \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
+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

Signature · 1 line

2.42.0.482.g2e8e77cbac

Alejandro Colomar

maintainer

2023-10-24 23:18 UTC #6 lore raw

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

Hi Don,

Quoted 1 line

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

Subject modified to "smartpqi.4: Add device attributes".

Quoted 7 lines · Don Brace

Add in some device level sysfs entry descriptions:
lunid
unique_id
path_info
raid_bypass_cnt
sas_ncq_prio_enable

Quoted 7 lines

These have already been provided by the driver.
Reviewed-by Scott Benesh <[email protected]>
Reviewed-by Scott Teel <[email protected]>
Reviewed-by Mike McGowen <[email protected]>
Reviewed-by Kevin Barnett <[email protected]>
Signed-off-by Don Brace <[email protected]>

Patch applied (with a minor tweak; see a comment below).

Cheers,
Alex

Quoted 57 lines

---
 man4/smartpqi.4 | 99 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 99 insertions(+)

man4/smartpqi.4 +45 -0

index 0cb018d01fc5..d06f34d55d10 100644
@@ -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

man4/smartpqi.4 $ \c · line 421

Quoted 10 lines

man4/smartpqi.4 +10 -0

+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

Quoted 50 lines

man4/smartpqi.4 +44 -0

+$ \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
+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

Signature · 1 line

2.42.0.482.g2e8e77cbac

Signature · 1 line

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

Alejandro Colomar

maintainer

2023-10-24 23:23 UTC #7 lore raw

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

Quoted 110 lines · Alejandro Colomar

Hi Don,
Quoted 1 line
Subject: Re: [PATCH v9 3/3] smartpqi: add device attributes
Subject modified to "smartpqi.4: Add device attributes".
Quoted 7 lines · Don Brace
Add in some device level sysfs entry descriptions:
lunid
unique_id
path_info
raid_bypass_cnt
sas_ncq_prio_enable
Quoted 7 lines
These have already been provided by the driver.
Reviewed-by Scott Benesh <[email protected]>
Reviewed-by Scott Teel <[email protected]>
Reviewed-by Mike McGowen <[email protected]>
Reviewed-by Kevin Barnett <[email protected]>
Signed-off-by Don Brace <[email protected]>
Patch applied (with a minor tweak; see a comment below).
Cheers,
Alex
Quoted 57 lines
---
 man4/smartpqi.4 | 99 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 99 insertions(+)
man4/smartpqi.4 +45 -0
index 0cb018d01fc5..d06f34d55d10 100644
@@ -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
man4/smartpqi.4 $ \c · line 421
Quoted 10 lines
man4/smartpqi.4 +10 -0
+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.
(quoted diff) +1 -1
@@ -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

Quoted 16 lines

Quoted 6 lines

man4/smartpqi.4 +6 -0

+$ \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

man4/smartpqi.4 $ \c · line 437

Quoted 10 lines

man4/smartpqi.4 +10 -0

+.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

Quoted 37 lines

Quoted 34 lines

man4/smartpqi.4 +28 -0

+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

Signature · 1 line

2.42.0.482.g2e8e77cbac

Signature · 1 line

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

Signature · 1 line

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