smartpqi man page updates

Add Copyright entry for Microchip.
Change e-mail addresses from Microsemi to Microchip. Change URL to Microchip.

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 | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

man4/smartpqi.4 +6 -6

index 147d53fc2a0a..463976f88cea 100644
@@ -1,13 +1,13 @@
 '\" t
-.\" Copyright (C) 2019, Microchip Technology Inc. and its subsidiaries
+.\" Copyright (C) 2019-2023, Microchip Technology Inc. and its subsidiaries
 .\" Copyright (C) 2016-2018, Microsemi Corporation
 .\" Copyright (C) 2016, PMC-Sierra, Inc.
-.\" Written by Kevin Barnett <[email protected]>
+.\" Written by Kevin Barnett <[email protected]>
 .\"
 .\" SPDX-License-Identifier: GPL-2.0-only
 .TH smartpqi 4 (date) "Linux man-pages (unreleased)"
 .SH NAME
-smartpqi \- Microsemi Smart Family SCSI driver
+smartpqi \- Microchip Smart Storage SCSI driver
 .SH SYNOPSIS
 .SY "modprobe smartpqi"
 .RB [ disable_device_id_wildcards= { 0 | 1 }]

@@ -19,7 +19,7 @@ smartpqi \- Microsemi Smart Family SCSI driver
 .YS
 .SH DESCRIPTION
 .B smartpqi
-is a SCSI driver for Microsemi Smart Family controllers.
+is a SCSI driver for Microchip Smart Storage controllers.
 .SS Supported \f[BI]ioctl\fP\/() operations
 For compatibility with applications written for the
 .BR cciss (4)

@@ -311,10 +311,10 @@ The
 driver was added in Linux 4.9.
 .SH NOTES
 .SS Configuration
-To configure a Microsemi Smart Family controller,
+To configure a Microchip Smart Storage controller,
 refer to the User Guide for the controller,
 which can be found by searching for the specific controller at
-.UR https://storage.microsemi.com/
+.UR https://www.microchip.com/design-centers/storage
 .UE .
 .SH SEE ALSO
 .BR cciss (4),

Signature · 1 line

2.42.0.158.g94e83dcf5b

Minor changes to the descriptions of the following module parameters:
disable_device_id_wildcards
disable_heartbeat
disable_ctrl_shutdown
expose_ld_first
hide_vsep

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 | 16 +++++++---------
 1 file changed, 7 insertions(+), 9 deletions(-)

man4/smartpqi.4 +7 -9

index 463976f88cea..428d79a19840 100644
@@ -66,17 +66,17 @@ Allows BMIC and CISS commands to be passed through to the controller.
 .TP
 .BR disable_device_id_wildcards= { 0 | 1 }
 Disables support for device ID wildcards.
-The default value is 0.
+The default value is 0 (wildcards are enabled).
 .TP
 .BR disable_heartbeat= { 0 | 1 }
 Disables support for the controller's heartbeat check.
 This parameter is used for debugging purposes.
-The default value is 0, leaving the controller's heartbeat check active.
+The default value is 0 (the controller's heartbeat check is enabled).
 .TP
 .BR disable_ctrl_shutdown= { 0 | 1 }
 Disables support for shutting down the controller in the
 event of a controller lockup.
-The default value is 0.
+The default value is 0 (controller will be shut down).
 .TP
 .BR lockup_action= { none | reboot | panic }
 Specifies the action the driver takes when a controller

@@ -94,14 +94,12 @@ parameter	action
 .TE
 .TP
 .BR expose_ld_first= { 0 | 1 }
-This option enables support for exposing logical devices to
-the operating system before physical devices.
-The default value is 0.
+This option exposes logical devices to the OS before physical devices.
+The default value is 0 (physical devices exposed first).
 .TP
 .BR hide_vsep= { 0 | 1 }
-This option enables disabling exposure of the virtual SEP to the host.
-This is usually associated with direct attached drives.
-The default value is 0.
+This option disables exposure of the virtual SEP to the OS.
+The default value is 0 (virtual SEP is exposed).
 .SH FILES
 .SS Device nodes
 Logical drives are accessed via the SCSI disk driver

Signature · 1 line

2.42.0.158.g94e83dcf5b

Add in a description for module parameter disable_managed_interrupts.

This module parameter allows users to change interrupt affinity by echoing values into /proc/irq/<irq number>/*affinity.

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 | 7 +++++++
 1 file changed, 7 insertions(+)

man4/smartpqi.4 +7 -0

index 428d79a19840..613ef330aef1 100644
@@ -16,6 +16,7 @@ smartpqi \- Microchip Smart Storage SCSI driver
 .RB [ lockup_action= { none | reboot | panic }]
 .RB [ expose_ld_first= { 0 | 1 }]
 .RB [ hide_vsep= { 0 | 1 }]
+.RB [ disable_managed_interrupts= { 0 | 1 }]
 .YS
 .SH DESCRIPTION
 .B smartpqi

@@ -100,6 +101,12 @@ The default value is 0 (physical devices exposed first).
 .BR hide_vsep= { 0 | 1 }
 This option disables exposure of the virtual SEP to the OS.
 The default value is 0 (virtual SEP is exposed).
+.TP
+.BR disable_managed_interrupts= { 0 | 1 }
+Disables driver utilization of Linux kernel managed interrupts for
+controllers. The managed interrupts feature automatically distributes
+interrupts to all available CPUs and assigns SMP affinity.
+The default value is 0 (managed interrupts enabled).
 .SH FILES
 .SS Device nodes
 Logical drives are accessed via the SCSI disk driver

Signature · 1 line

2.42.0.158.g94e83dcf5b

Allow user to change the length of time that the driver will wait for the controller to become ready.

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 | 6 ++++++
 1 file changed, 6 insertions(+)

man4/smartpqi.4 +1 -0

index 613ef330aef1..f04472836210 100644
@@ -17,6 +17,7 @@ smartpqi \- Microchip Smart Storage SCSI driver
 .RB [ expose_ld_first= { 0 | 1 }]
 .RB [ hide_vsep= { 0 | 1 }]
 .RB [ disable_managed_interrupts= { 0 | 1 }]
+.RB [ ctrl_ready_timeout= { 0 | 30-1800 }]
 .YS
 .SH DESCRIPTION
 .B smartpqi

man4/smartpqi.4 +1 -0

+is 0, which causes the driver to use a timeout of 180 seconds.
 .SH FILES
 .SS Device nodes
 Logical drives are accessed via the SCSI disk driver

Signature · 1 line

2.42.0.158.g94e83dcf5b

Minor description changes for Device nodes.

Change "Logical drives" to "Disk drives".

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 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

man4/smartpqi.4 +1 -1

index f04472836210..87f6990f2455 100644
@@ -115,7 +115,7 @@ for controller ready. The valid range is 0 or 30-1800. The default value
 is 0, which causes the driver to use a timeout of 180 seconds.
 .SH FILES
 .SS Device nodes
-Logical drives are accessed via the SCSI disk driver
+Disk drives are accessed via the SCSI disk driver
 .RI ( sd ),
 tape drives via the SCSI tape driver
 .RI ( st ),

Signature · 1 line

2.42.0.158.g94e83dcf5b

Minor description changes for host attributes.

Just some small changes to the host attribute descriptions.

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 | 31 +++++++------------------------
 1 file changed, 7 insertions(+), 24 deletions(-)

man4/smartpqi.4 +2 -19

index 87f6990f2455..165eee6848c3 100644
@@ -135,29 +135,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.
-.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
+entire storage boxes containing pre-configured logical volumes.
 .in
 .TP
 .IR /sys/class/scsi_host/host * /lockup_action

man4/smartpqi.4 +4 -4

 The
 .I driver_version
 attribute is read-only.

@@ -189,7 +172,7 @@ $ \c
 .EE
 .in
 .TP
-.I /sys/class/scsi_host/host*/firmware_version
+.IR /sys/class/scsi_host/host*/firmware_version
 The
 .I firmware_version
 attribute is read-only.

@@ -205,7 +188,7 @@ $ \c
 .EE
 .in
 .TP
-.I /sys/class/scsi_host/host*/model
+.IR /sys/class/scsi_host/host*/model
 The
 .I model
 attribute is read-only.

@@ -221,7 +204,7 @@ $ \c
 .EE
 .in
 .TP
-.I /sys/class/scsi_host/host*/serial_number
+.IR /sys/class/scsi_host/host*/serial_number
 The
 .I serial_number
 attribute is read-only.

@@ -237,7 +220,7 @@ $ \c
 .EE
 .in
 .TP
-.I /sys/class/scsi_host/host*/vendor
+.IR /sys/class/scsi_host/host*/vendor
 The
 .I vendor
 attribute is read-only.

Signature · 1 line

2.42.0.158.g94e83dcf5b

  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

man4/smartpqi.4 +1 -1

-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

man4/smartpqi.4 +1 -18

-entire storage boxes containing pre-configured logical drives.
 
-.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
 
+entire storage boxes containing pre-configured logical volumes.

  .in

  .TP

  .IR /sys/class/scsi_host/host * /lockup_action

(quoted diff) +0 -0

@@ -173,7 +156,7 @@ for an explanation of the
 

  .I lockup_action

  values.

  .TP

-.I /sys/class/scsi_host/host*/driver_version

+.IR /sys/class/scsi_host/host*/driver_version

Quoted 3 lines

-.I /sys/class/scsi_host/host*/driver_version

+.IR /sys/class/scsi_host/host*/driver_version

This is wrong.  Why would you want this change?

Thanks,

Alex
--------

Could you clarify? Do you mean the last HUNK about driver_version? Of the content above?

Also, I have rebased and applied your review input to the other patches.

Small updates to device attribute descriptions.

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 165eee6848c3..635b3fa185ab 100644
@@ -250,7 +250,7 @@ is the logical unit number (LUN).
 The
 .I raid_level
 attribute is read-only.
-This attribute contains the RAID level of each logical drive.
+This attribute contains the RAID level of the logical volume.
 .IP
 For example:
 .IP

@@ -266,7 +266,7 @@ RAID 0
 The
 .I sas_address
 attribute is read-only.
-This attribute contains the unique identifier of the disk.
+This attribute contains the SAS address of the device.
 .IP
 For example:
 .IP

Signature · 1 line

2.42.0.158.g94e83dcf5b

Add in some host level sysfs entries:
enable_stream_detection - Send RAID 5/6 writes down the normal I/O path.
Allow for full-stripe write requests.
ssd_smart_path_enabled - Indicates that our Accelerated I/O path is

                          enabled. (AIO).

enable_r5_writes - Allow RAID 5 write operations down the AIO path.
enable_r6_writes - Allow RAID 6 write operations down the AIO path.

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 | 57 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)

man4/smartpqi.4 +0 -0

index 635b3fa185ab..19708a01f531 100644

man4/smartpqi.4 +50 -0

+.BI ssd_smart_path_enabled
+disk attribute section for details on ioaccel-enabled volumes.
+The default value is 1 (stream detection enabled).
+.IP
+Enable example:
+.IP
+.in +4n
+.EX
+$ \c
+.B echo 1 > /sys/class/scsi_host/host1/enable_stream_detection
+.EE
+.in
+.TP
+.IR /sys/class/scsi_host/host*/enable_r5_writes
+The
+.I enable_r5_writes
+attribute is read-write.
+This attribute enables/disables RAID 5 write operations for ioaccel-enabled volumes.
+Enabling can improve sequential write performance. See the
+.BI ssd_smart_path_enabled
+disk attribute section for details on ioaccel-enabled volumes.
+The default value is 1 (RAID 5 writes enabled).
+.IP
+Enable example:
+.IP
+.in +4n
+.EX
+$ \c
+.B echo 1 > /sys/class/scsi_host/host1/enable_r5_writes
+.EE
+.in
+.TP
+.IR /sys/class/scsi_host/host*/enable_r6_writes
+The
+.I enable_r6_writes
+attribute is read-write.
+This attribute enables/disables RAID 6 write operations for ioaccel-enabled volumes.
+Enabling can improve sequential write performance. See the
+.BI ssd_smart_path_enabled
+disk attribute section for details on ioaccel-enabled volumes.
+The default value is 1 (RAID 6 writes enabled).
+.IP
+Enable example:
+.IP
+.in +4n
+.EX
+$ \c
+.B echo 1 > /sys/class/scsi_host/host1/enable_r6_writes
+.EE
+.in
 .SS SmartPQI-specific disk attribute files in \f[BI]/sys\fP
 In the file specifications below,
 .I c

Signature · 1 line

2.42.0.158.g94e83dcf5b

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 | 91 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 91 insertions(+)

man4/smartpqi.4 +12 -0

index 19708a01f531..3de8b0c97423 100644
@@ -356,6 +356,97 @@ $ \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

man4/smartpqi.4 +17 -0

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

man4/smartpqi.4 +34 -0

+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

Signature · 1 line

2.42.0.158.g94e83dcf5b

The sg driver can interface with smartpqi. Add this into the SEE ALSO section of the man page.

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 | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

man4/smartpqi.4 +2 -1

index 3de8b0c97423..7c1da3c80d57 100644
@@ -462,7 +462,8 @@ which can be found by searching for the specific controller at
 .BR cciss (4),
 .BR hpsa (4),
 .BR sd (4),
-.BR st (4)
+.BR st (4),
+.BR sg (4)
 .PP
 .I Documentation/ABI/testing/sysfs\-bus\-pci\-devices\-cciss
 in the Linux kernel source tree.

Signature · 1 line

2.42.0.158.g94e83dcf5b