public inbox for linux-man@vger.kernel.org
 help / color / mirror / Atom feed
From: Alejandro Colomar <alx@kernel.org>
To: Don Brace <don.brace@microchip.com>
Cc: linux-man@vger.kernel.org
Subject: Re: [PATCH v9 3/3] smartpqi: add device attributes
Date: Wed, 25 Oct 2023 01:18:04 +0200	[thread overview]
Message-ID: <ZThQrK3fMju8xRIP@debian> (raw)
In-Reply-To: <20231024220153.36748-4-don.brace@microchip.com>

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

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

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

  reply	other threads:[~2023-10-24 23:18 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-10-24 22:01 [PATCH v9 0/3] smartpqi man page updates Don Brace
2023-10-24 22:01 ` [PATCH v9 1/3] smartpqi: update host attribute descriptions Don Brace
2023-10-24 23:04   ` Alejandro Colomar
2023-10-24 22:01 ` [PATCH v9 2/3] smartpqi: remove sysfs entry for version Don Brace
2023-10-24 23:10   ` Alejandro Colomar
2023-10-24 22:01 ` [PATCH v9 3/3] smartpqi: add device attributes Don Brace
2023-10-24 23:18   ` Alejandro Colomar [this message]
2023-10-24 23:23     ` Alejandro Colomar

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=ZThQrK3fMju8xRIP@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox