smartpqi.rst 2.8 KB

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