[PATCH v2 00/10] smartpqi man page updates

[PATCH v2 00/10] smartpqi man page updates

[Don Brace]

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 V1:
    Broke up the large patch into multiple smaller patches due to review by:
    Alejandro Colomar <alx@kernel.org>
    Link: https://lore.kernel.org/all/096ed4d5-945f-5ac9-eba3-c9be5d32cfe8@kernel.org/

---

Don Brace (10):
  smarpqi: update copyright and email addresses
  smartpqi: update module parameter descriptions
  smartpqi: add-module parameter disable_managed_interrupts
  smartpqi: add module parameter ctrl_ready_timeout
  smartpqi: update FILES section
  smartpqi: update host attribute descriptions
  smartpqi: update device attribute descriptions
  smartpqi: add host attributes
  smartpqi: add device attributes
  smartpqi: add sg entry to see_also

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

-- 
2.42.0.rc2

[PATCH v2 01/10] smarpqi: update copyright and email addresses

[Don Brace]

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

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

diff --git a/man4/smartpqi.4 b/man4/smartpqi.4
index 147d53fc2a0a..463976f88cea 100644
--- a/man4/smartpqi.4
+++ b/man4/smartpqi.4
@@ -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 <kevin.barnett@microsemi.com>
+.\" Written by Kevin Barnett <kevin.barnett@microchip.com>
 .\"
 .\" 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),
-- 
2.42.0.rc2

[PATCH v2 02/10] smartpqi: update module parameter descriptions

[Don Brace]

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

diff --git a/man4/smartpqi.4 b/man4/smartpqi.4
index 463976f88cea..428d79a19840 100644
--- a/man4/smartpqi.4
+++ b/man4/smartpqi.4
@@ -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
-- 
2.42.0.rc2

[PATCH v2 03/10] smartpqi: add-module parameter disable_managed_interrupts

[Don Brace]

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

diff --git a/man4/smartpqi.4 b/man4/smartpqi.4
index 428d79a19840..613ef330aef1 100644
--- a/man4/smartpqi.4
+++ b/man4/smartpqi.4
@@ -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
-- 
2.42.0.rc2

[PATCH v2 04/10] smartpqi: add module parameter ctrl_ready_timeout

[Don Brace]

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

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

diff --git a/man4/smartpqi.4 b/man4/smartpqi.4
index 613ef330aef1..f04472836210 100644
--- a/man4/smartpqi.4
+++ b/man4/smartpqi.4
@@ -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
@@ -107,6 +108,11 @@ 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).
+.TP
+.BR ctrl_ready_timeout= { 0 | 30-1800 }
+This option specifies the timeout in seconds for the driver to wait
+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
-- 
2.42.0.rc2

[PATCH v2 05/10] smartpqi: update FILES section

[Don Brace]

Minor description changes for Device nodes.

Change "Logical drives" to "Disk drives".

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

diff --git a/man4/smartpqi.4 b/man4/smartpqi.4
index f04472836210..87f6990f2455 100644
--- a/man4/smartpqi.4
+++ b/man4/smartpqi.4
@@ -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 ),
-- 
2.42.0.rc2

[PATCH v2 06/10] smartpqi: update host attribute descriptions

[Don Brace]

Minor description changes for host attributes.

Just some small changes to the host attribute descriptions.

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

diff --git a/man4/smartpqi.4 b/man4/smartpqi.4
index 87f6990f2455..165eee6848c3 100644
--- a/man4/smartpqi.4
+++ b/man4/smartpqi.4
@@ -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
@@ -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
 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.
-- 
2.42.0.rc2

[PATCH v2 07/10] smartpqi: update device attribute descriptions

[Don Brace]

Small updates to device attribute descriptions.

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

diff --git a/man4/smartpqi.4 b/man4/smartpqi.4
index 165eee6848c3..635b3fa185ab 100644
--- a/man4/smartpqi.4
+++ b/man4/smartpqi.4
@@ -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
-- 
2.42.0.rc2

[PATCH v2 08/10] smartpqi: add host attributes

[Don Brace]

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

diff --git a/man4/smartpqi.4 b/man4/smartpqi.4
index 635b3fa185ab..19708a01f531 100644
--- a/man4/smartpqi.4
+++ b/man4/smartpqi.4
@@ -235,6 +235,63 @@ $ \c
 Adaptec
 .EE
 .in
+.TP
+.IR /sys/class/scsi_host/host*/enable_stream_detection
+The
+.I enable_stream_detection
+attribute is read-write.
+This attribute enables/disables stream detection in the driver.
+Enabling stream detection can improve sequential write performance for ioaccel-enabled volumes. See the
+.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
-- 
2.42.0.rc2

[PATCH v2 09/10] smartpqi: add device attributes

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

diff --git a/man4/smartpqi.4 b/man4/smartpqi.4
index 19708a01f531..3de8b0c97423 100644
--- a/man4/smartpqi.4
+++ b/man4/smartpqi.4
@@ -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
+.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 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/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
+.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
-- 
2.42.0.rc2

[PATCH v2 10/10] smartpqi: add sg entry to see_also

[Don Brace]

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

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

diff --git a/man4/smartpqi.4 b/man4/smartpqi.4
index 3de8b0c97423..7c1da3c80d57 100644
--- a/man4/smartpqi.4
+++ b/man4/smartpqi.4
@@ -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.
-- 
2.42.0.rc2

Re: [PATCH v2 00/10] smartpqi man page updates

[Don.Brace]

ping


From: Don Brace <don.brace@microchip.com>
Sent: Monday, August 21, 2023 2:57 PM
To: mtk.manpages@gmail.com <mtk.manpages@gmail.com>
Cc: linux-man@vger.kernel.org <linux-man@vger.kernel.org>
Subject: [PATCH v2 00/10] smartpqi man page updates
 
EXTERNAL EMAIL: Do not click links or open attachments unless you know the content is safe

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 V1:
    Broke up the large patch into multiple smaller patches due to review by:
    Alejandro Colomar <alx@kernel.org>
    Link: https://lore.kernel.org/all/096ed4d5-945f-5ac9-eba3-c9be5d32cfe8@kernel.org/

---

Don Brace (10):
  smarpqi: update copyright and email addresses
  smartpqi: update module parameter descriptions
  smartpqi: add-module parameter disable_managed_interrupts
  smartpqi: add module parameter ctrl_ready_timeout
  smartpqi: update FILES section
  smartpqi: update host attribute descriptions
  smartpqi: update device attribute descriptions
  smartpqi: add host attributes
  smartpqi: add device attributes
  smartpqi: add sg entry to see_also

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

--
2.42.0.rc2

Re: [PATCH v2 00/10] smartpqi man page updates

[Alejandro Colomar]

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

Hi Don,

On Wed, Sep 20, 2023 at 02:37:04PM +0000, Don.Brace@microchip.com wrote:
> ping

Can you please resend the patch set?  I don't find it in my inbox.

Thanks,
Alex

> 
> 
> From: Don Brace <don.brace@microchip.com>
> Sent: Monday, August 21, 2023 2:57 PM
> To: mtk.manpages@gmail.com <mtk.manpages@gmail.com>
> Cc: linux-man@vger.kernel.org <linux-man@vger.kernel.org>
> Subject: [PATCH v2 00/10] smartpqi man page updates
>  
> EXTERNAL EMAIL: Do not click links or open attachments unless you know the content is safe
> 
> 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 V1:
>     Broke up the large patch into multiple smaller patches due to review by:
>     Alejandro Colomar <alx@kernel.org>
>     Link: https://lore.kernel.org/all/096ed4d5-945f-5ac9-eba3-c9be5d32cfe8@kernel.org/
> 
> ---
> 
> Don Brace (10):
>   smarpqi: update copyright and email addresses
>   smartpqi: update module parameter descriptions
>   smartpqi: add-module parameter disable_managed_interrupts
>   smartpqi: add module parameter ctrl_ready_timeout
>   smartpqi: update FILES section
>   smartpqi: update host attribute descriptions
>   smartpqi: update device attribute descriptions
>   smartpqi: add host attributes
>   smartpqi: add device attributes
>   smartpqi: add sg entry to see_also
> 
>  man4/smartpqi.4 | 229 +++++++++++++++++++++++++++++++++++++++---------
>  1 file changed, 186 insertions(+), 43 deletions(-)
> 
> --
> 2.42.0.rc2

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

Re: [PATCH v2 00/10] smartpqi man page updates

[Alejandro Colomar]

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

On Tue, Sep 26, 2023 at 07:16:20PM +0000, Don.Brace@microchip.com wrote:
> Resent.
> 
> I had mangled your e-mail address.
> Sorry about that.

No problem.  Thanks!  :)

> ________________________________
> From: Alejandro Colomar <alx@kernel.org>
> Sent: Monday, September 25, 2023 7:12 PM
> To: Don Brace - C33706 <Don.Brace@microchip.com>
> Cc: mtk.manpages@gmail.com <mtk.manpages@gmail.com>; linux-man@vger.kernel.org <linux-man@vger.kernel.org>
> Subject: Re: [PATCH v2 00/10] smartpqi man page updates
> 
> EXTERNAL EMAIL: Do not click links or open attachments unless you know the content is safe

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