1 .\" Copyright (C) 2011, Hewlett-Packard Development Company, L.P.
2 .\" Written by Stephen M. Cameron <scameron@beardog.cce.hp.com>
4 .\" SPDX-License-Identifier: GPL-2.0-only
6 .\" shorthand for double quote that works everywhere.
8 .TH HPSA 4 2021-03-22 "Linux man-pages (unreleased)" "Linux Programmer's Manual"
10 hpsa \- HP Smart Array SCSI driver
13 modprobe hpsa [ hpsa_allow_any=1 ]
17 is a SCSI driver for HP Smart Array RAID controllers.
19 .IR "hpsa_allow_any=1" :
20 This option allows the driver to attempt to operate on
21 any HP Smart Array hardware RAID controller,
22 even if it is not explicitly known to the driver.
23 This allows newer hardware to work with older drivers.
24 Typically this is used to allow installation of
25 operating systems from media that predates the
26 RAID controller, though it may also be used to enable
28 to drive older controllers that would normally be handled by the
31 These older boards have not been tested and are
36 should still be used for these.
37 .SS Supported hardware
40 driver supports the following Smart Array boards:
54 .\" commit 135ae6edeb51979d0998daf1357f149a7d6ebb08
55 Since Linux 4.14, the following Smart Array boards are also supported:
79 .SS Configuration details
80 To configure HP Smart Array controllers,
81 use the HP Array Configuration Utility (either
85 or the Offline ROM-based Configuration Utility (ORCA)
86 run from the Smart Array's option ROM at boot time.
89 Logical drives are accessed via the SCSI disk driver
91 tape drives via the SCSI tape driver
94 the RAID controller via the SCSI generic driver
96 with device nodes named
102 .SS HPSA-specific host attribute files in /sys
104 .I /sys/class/scsi_host/host*/rescan
105 This is a write-only attribute.
106 Writing to this attribute will cause the driver to scan for
107 new, changed, or removed devices (e.g., hot-plugged tape drives,
108 or newly configured or deleted logical drives, etc.)
109 and notify the SCSI midlayer of any changes detected.
110 Normally a rescan is triggered automatically
111 by HP's Array Configuration Utility (either the GUI or the
112 command-line variety);
113 thus, for logical drive changes, the user should not
114 normally have to use this attribute.
115 This attribute may be useful when hot plugging devices like tape drives,
116 or entire storage boxes containing preconfigured logical drives.
118 .I /sys/class/scsi_host/host*/firmware_revision
119 This attribute contains the firmware version of the Smart Array.
125 # \fBcd /sys/class/scsi_host/host4\fP
126 # \fBcat firmware_revision\fP
131 .SS HPSA-specific disk attribute files in /sys
133 .I /sys/class/scsi_disk/c:b:t:l/device/unique_id
134 This attribute contains a 32 hex-digit unique ID for each logical drive.
140 # \fBcd /sys/class/scsi_disk/4:0:0:0/device\fP
141 # \fBcat unique_id\fP
142 600508B1001044395355323037570F77
146 .I /sys/class/scsi_disk/c:b:t:l/device/raid_level
147 This attribute contains the RAID level of each logical drive.
153 # \fBcd /sys/class/scsi_disk/4:0:0:0/device\fP
154 # \fBcat raid_level\fP
159 .I /sys/class/scsi_disk/c:b:t:l/device/lunid
160 This attribute contains the 16 hex-digit (8 byte) LUN ID
161 by which a logical drive or physical device can be addressed.
163 are the controller, bus, target, and lun of the device.
169 # \fBcd /sys/class/scsi_disk/4:0:0:0/device\fP
175 .SS Supported ioctl() operations
176 For compatibility with applications written for the
179 not all of the ioctls supported by the
181 driver are also supported by the
184 The data structures used by these ioctls are described in
185 the Linux kernel source file
186 .IR include/linux/cciss_ioctl.h .
188 .BR CCISS_DEREGDISK ", " CCISS_REGNEWDISK ", " CCISS_REGNEWD
189 These three ioctls all do exactly the same thing,
190 which is to cause the driver to rescan for new devices.
191 This does exactly the same thing as writing to the
192 hpsa-specific host "rescan" attribute.
195 Returns PCI domain, bus, device, and function and "board ID" (PCI subsystem ID).
198 Returns driver version in three bytes encoded as:
202 (major_version << 16) | (minor_version << 8) |
207 .BR CCISS_PASSTHRU ", " CCISS_BIG_PASSTHRU
208 Allows "BMIC" and "CISS" commands to be passed through to the Smart Array.
209 These are used extensively by the HP Array Configuration Utility,
210 SNMP storage agents, and so on.
214 .UR http://cciss.sf.net
221 .BR cciss_vol_status (8),
225 .UR http://cciss.sf.net
228 .I Documentation/scsi/hpsa.txt
230 .I Documentation/ABI/testing/sysfs\-bus\-pci\-devices\-cciss
231 in the Linux kernel source tree
233 .\" Don Brace, Steve Cameron, Tom Lawler, Mike Miller, Scott Teel
234 .\" and probably some other people.