man4/hpsa.4

   1 .\" Copyright (C) 2011, Hewlett-Packard Development Company, L.P.
   2 .\" Written by Stephen M. Cameron <scameron@beardog.cce.hp.com>
   3 .\"
   4 .\" %%%LICENSE_START(GPLv2_ONELINE)
   5 .\" Licensed under GNU General Public License version 2 (GPLv2)
   6 .\" %%%LICENSE_END
   7 .\"
   8 .\" shorthand for double quote that works everywhere.
   9 .ds q \N'34'
  10 .TH HPSA 4 2021-03-22 "Linux" "Linux Programmer's Manual"
  11 .SH NAME
  12 hpsa \- HP Smart Array SCSI driver
  13 .SH SYNOPSIS
  14 .nf
  15 modprobe hpsa [ hpsa_allow_any=1 ]
  16 .fi
  17 .SH DESCRIPTION
  18 .B hpsa
  19 is a SCSI driver for HP Smart Array RAID controllers.
  20 .SS Options
  21 .IR "hpsa_allow_any=1" :
  22 This option allows the driver to attempt to operate on
  23 any HP Smart Array hardware RAID controller,
  24 even if it is not explicitly known to the driver.
  25 This allows newer hardware to work with older drivers.
  26 Typically this is used to allow installation of
  27 operating systems from media that predates the
  28 RAID controller, though it may also be used to enable
  29 .B hpsa
  30 to drive older controllers that would normally be handled by the
  31 .BR cciss (4)
  32 driver.
  33 These older boards have not been tested and are
  34 not supported with
  35 .BR hpsa ,
  36 and
  37 .BR cciss (4)
  38 should still be used for these.
  39 .SS Supported hardware
  40 The
  41 .B hpsa
  42 driver supports the following Smart Array boards:
  43 .PP
  44 .nf
  45     Smart Array P700M
  46     Smart Array P212
  47     Smart Array P410
  48     Smart Array P410i
  49     Smart Array P411
  50     Smart Array P812
  51     Smart Array P712m
  52     Smart Array P711m
  53     StorageWorks P1210m
  54 .fi
  55 .PP
  56 .\" commit 135ae6edeb51979d0998daf1357f149a7d6ebb08
  57 Since Linux 4.14, the following Smart Array boards are also supported:
  58 .PP
  59 .nf
  60     Smart Array 5300
  61     Smart Array 5312
  62     Smart Array 532
  63     Smart Array 5i
  64     Smart Array 6400
  65     Smart Array 6400 EM
  66     Smart Array 641
  67     Smart Array 642
  68     Smart Array 6i
  69     Smart Array E200
  70     Smart Array E200i
  71     Smart Array E200i
  72     Smart Array E200i
  73     Smart Array E200i
  74     Smart Array E500
  75     Smart Array P400
  76     Smart Array P400i
  77     Smart Array P600
  78     Smart Array P700m
  79     Smart Array P800
  80 .fi
  81 .SS Configuration details
  82 To configure HP Smart Array controllers,
  83 use the HP Array Configuration Utility (either
  84 .BR hpacuxe (8)
  85 or
  86 .BR hpacucli (8))
  87 or the Offline ROM-based Configuration Utility (ORCA)
  88 run from the Smart Array's option ROM at boot time.
  89 .SH FILES
  90 .SS Device nodes
  91 Logical drives are accessed via the SCSI disk driver
  92 .RB ( sd (4)),
  93 tape drives via the SCSI tape driver
  94 .RB ( st (4)),
  95 and
  96 the RAID controller via the SCSI generic driver
  97 .RB ( sg (4)),
  98 with device nodes named
  99 .IR /dev/sd* ,
 100 .IR /dev/st* ,
 101 and
 102 .IR /dev/sg* ,
 103 respectively.
 104 .SS HPSA-specific host attribute files in /sys
 105 .TP
 106 .I /sys/class/scsi_host/host*/rescan
 107 This is a write-only attribute.
 108 Writing to this attribute will cause the driver to scan for
 109 new, changed, or removed devices (e.g., hot-plugged tape drives,
 110 or newly configured or deleted logical drives, etc.)
 111 and notify the SCSI midlayer of any changes detected.
 112 Normally a rescan is triggered automatically
 113 by HP's Array Configuration Utility (either the GUI or the
 114 command-line variety);
 115 thus, for logical drive changes, the user should not
 116 normally have to use this attribute.
 117 This attribute may be useful when hot plugging devices like tape drives,
 118 or entire storage boxes containing preconfigured logical drives.
 119 .TP
 120 .I /sys/class/scsi_host/host*/firmware_revision
 121 This attribute contains the firmware version of the Smart Array.
 122 .IP
 123 For example:
 124 .IP
 125 .in +4n
 126 .EX
 127 # \fBcd /sys/class/scsi_host/host4\fP
 128 # \fBcat firmware_revision\fP
 129 7.14
 130 .EE
 131 .in
 132 .\"
 133 .SS HPSA-specific disk attribute files in /sys
 134 .TP
 135 .I /sys/class/scsi_disk/c:b:t:l/device/unique_id
 136 This attribute contains a 32 hex-digit unique ID for each logical drive.
 137 .IP
 138 For example:
 139 .IP
 140 .in +4n
 141 .EX
 142 # \fBcd /sys/class/scsi_disk/4:0:0:0/device\fP
 143 # \fBcat unique_id\fP
 144 600508B1001044395355323037570F77
 145 .EE
 146 .in
 147 .TP
 148 .I /sys/class/scsi_disk/c:b:t:l/device/raid_level
 149 This attribute contains the RAID level of each logical drive.
 150 .IP
 151 For example:
 152 .IP
 153 .in +4n
 154 .EX
 155 # \fBcd /sys/class/scsi_disk/4:0:0:0/device\fP
 156 # \fBcat raid_level\fP
 157 RAID 0
 158 .EE
 159 .in
 160 .TP
 161 .I /sys/class/scsi_disk/c:b:t:l/device/lunid
 162 This attribute contains the 16 hex-digit (8 byte) LUN ID
 163 by which a logical drive or physical device can be addressed.
 164 .IR c : b : t : l
 165 are the controller, bus, target, and lun of the device.
 166 .PP
 167 For example:
 168 .IP
 169 .in +4n
 170 .EX
 171 # \fBcd /sys/class/scsi_disk/4:0:0:0/device\fP
 172 # \fBcat lunid\fP
 173 0x0000004000000000
 174 .EE
 175 .in
 176 .\"
 177 .SS Supported ioctl() operations
 178 For compatibility with applications written for the
 179 .BR cciss (4)
 180 driver, many, but
 181 not all of the ioctls supported by the
 182 .BR cciss (4)
 183 driver are also supported by the
 184 .B hpsa
 185 driver.
 186 The data structures used by these ioctls are described in
 187 the Linux kernel source file
 188 .IR include/linux/cciss_ioctl.h .
 189 .TP
 190 .BR CCISS_DEREGDISK ", " CCISS_REGNEWDISK ", " CCISS_REGNEWD
 191 These three ioctls all do exactly the same thing,
 192 which is to cause the driver to rescan for new devices.
 193 This does exactly the same thing as writing to the
 194 hpsa-specific host "rescan" attribute.
 195 .TP
 196 .B CCISS_GETPCIINFO
 197 Returns PCI domain, bus, device, and function and "board ID" (PCI subsystem ID).
 198 .TP
 199 .B CCISS_GETDRIVVER
 200 Returns driver version in three bytes encoded as:
 201 .IP
 202 .in +4n
 203 .EX
 204 (major_version << 16) | (minor_version << 8) |
 205     (subminor_version)
 206 .EE
 207 .in
 208 .TP
 209 .BR CCISS_PASSTHRU ", " CCISS_BIG_PASSTHRU
 210 Allows "BMIC" and "CISS" commands to be passed through to the Smart Array.
 211 These are used extensively by the HP Array Configuration Utility,
 212 SNMP storage agents, and so on.
 213 See
 214 .I cciss_vol_status
 215 at
 216 .UR http://cciss.sf.net
 217 .UE
 218 for some examples.
 219 .SH SEE ALSO
 220 .BR cciss (4),
 221 .BR sd (4),
 222 .BR st (4),
 223 .BR cciss_vol_status (8),
 224 .BR hpacucli (8),
 225 .BR hpacuxe (8),
 226 .PP
 227 .UR http://cciss.sf.net
 228 .UE ,
 229 and
 230 .I Documentation/scsi/hpsa.txt
 231 and
 232 .I Documentation/ABI/testing/sysfs\-bus\-pci\-devices\-cciss
 233 in the Linux kernel source tree
 234 .\" .SH AUTHORS
 235 .\" Don Brace, Steve Cameron, Tom Lawler, Mike Miller, Scott Teel
 236 .\" and probably some other people.