diff options
Diffstat (limited to '')
| -rw-r--r-- | man4/smartpqi.4 | 268 |
1 files changed, 219 insertions, 49 deletions
diff --git a/man4/smartpqi.4 b/man4/smartpqi.4 index ce1f5b7..5e9f25c 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 2022-12-15 "Linux man-pages 6.05.01" +.TH smartpqi 4 2023-10-31 "Linux man-pages 6.7" .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 }] @@ -16,10 +16,12 @@ smartpqi \- Microsemi Smart Family 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 }] +.RB [ ctrl_ready_timeout= { 0 |[ 30 , 1800 ]}] .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) @@ -36,7 +38,11 @@ The data structures used by these operations are described in the Linux kernel source file .IR include/linux/cciss_ioctl.h . .TP -.BR CCISS_DEREGDISK ", " CCISS_REGNEWDISK ", " CCISS_REGNEWD +.B CCISS_DEREGDISK +.TQ +.B CCISS_REGNEWDISK +.TQ +.B CCISS_REGNEWD These operations all do exactly the same thing, which is to cause the driver to re-scan for new devices. @@ -66,17 +72,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,17 +100,29 @@ 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). +.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). +.TP +.BR ctrl_ready_timeout= { 0 |[ 30 , 1800 ]} +This option specifies the timeout in seconds for the driver to wait +for the controller to be ready. +The valid range is 0 or +.RB [ 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 ), @@ -124,30 +142,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 -.in +entire storage boxes containing pre-configured logical volumes. .TP .IR /sys/class/scsi_host/host * /lockup_action The host @@ -162,7 +162,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. @@ -178,7 +178,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. @@ -194,7 +194,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. @@ -210,7 +210,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. @@ -226,7 +226,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. @@ -241,6 +241,69 @@ $ \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 +.B 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 +.B 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 +.B 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 @@ -256,7 +319,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 @@ -268,11 +331,11 @@ RAID 0 .EE .in .TP -.IR /sys/class/scsi_disk/c : b : t : l/device/sas_address +.IR /sys/class/scsi_disk/ c : b : t : l /device/sas_address 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 @@ -284,7 +347,7 @@ $ \c .EE .in .TP -.IR /sys/class/scsi_disk/c : b : t : l/device/ssd_smart_path_enabled +.IR /sys/class/scsi_disk/ c : b : t : l /device/ssd_smart_path_enabled The .I ssd_smart_path_enabled attribute is read-only. @@ -305,22 +368,129 @@ $ \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 +.B 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 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 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), .BR sd (4), -.BR st (4) -.PP +.BR st (4), +.BR sg (4) +.P .I Documentation/ABI/testing/sysfs\-bus\-pci\-devices\-cciss in the Linux kernel source tree. |