^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) .. SPDX-License-Identifier: GPL-2.0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) ==============================================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) SMARTPQI - Microchip Smart Storage SCSI driver
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) ==============================================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) This file describes the smartpqi SCSI driver for Microchip
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) (http://www.microchip.com) PQI controllers. The smartpqi driver
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) is the next generation SCSI driver for Microchip Corp. The smartpqi
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) driver is the first SCSI driver to implement the PQI queuing model.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) The smartpqi driver will replace the aacraid driver for Adaptec Series 9
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) controllers. Customers running an older kernel (Pre-4.9) using an Adaptec
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) Series 9 controller will have to configure the smartpqi driver or their
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) volumes will not be added to the OS.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) For Microchip smartpqi controller support, enable the smartpqi driver
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) when configuring the kernel.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) For more information on the PQI Queuing Interface, please see:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) - http://www.t10.org/drafts.htm
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) - http://www.t10.org/members/w_pqi2.htm
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) Supported devices
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) =================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) <Controller names to be added as they become publicly available.>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) smartpqi specific entries in /sys
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) =================================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) smartpqi host attributes
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) ------------------------
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) - /sys/class/scsi_host/host*/rescan
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) - /sys/class/scsi_host/host*/driver_version
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) The host rescan attribute is a write only attribute. Writing to this
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) attribute will trigger the driver to scan for new, changed, or removed
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) devices and notify the SCSI mid-layer of any changes detected.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) The version attribute is read-only and will return the driver version
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) and the controller firmware version.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) For example::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) driver: 0.9.13-370
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) firmware: 0.01-522
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) smartpqi sas device attributes
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) ------------------------------
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) HBA devices are added to the SAS transport layer. These attributes are
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) automatically added by the SAS transport layer.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) /sys/class/sas_device/end_device-X:X/sas_address
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) /sys/class/sas_device/end_device-X:X/enclosure_identifier
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) /sys/class/sas_device/end_device-X:X/scsi_target_id
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) smartpqi specific ioctls
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) ========================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) For compatibility with applications written for the cciss protocol.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) CCISS_DEREGDISK, CCISS_REGNEWDISK, CCISS_REGNEWD
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) The above three ioctls all do exactly the same thing, which is to cause the driver
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) to rescan for new devices. This does exactly the same thing as writing to the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) smartpqi specific host "rescan" attribute.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) CCISS_GETPCIINFO
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) Returns PCI domain, bus, device and function and "board ID" (PCI subsystem ID).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) CCISS_GETDRIVVER
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) Returns driver version in three bytes encoded as::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) (DRIVER_MAJOR << 28) | (DRIVER_MINOR << 24) | (DRIVER_RELEASE << 16) | DRIVER_REVISION;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) CCISS_PASSTHRU
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) Allows "BMIC" and "CISS" commands to be passed through to the Smart Storage Array.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) These are used extensively by the SSA Array Configuration Utility, SNMP storage
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) agents, etc.