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 .\" SPDX-License-Identifier: GPL-2.0-only
   5 .\"
   6 .\" shorthand for double quote that works everywhere.
   7 .ds q \N'34'
   8 .TH hpsa 4 (date) "Linux man-pages (unreleased)"
   9 .SH NAME
  10 hpsa \- HP Smart Array SCSI driver
  11 .SH SYNOPSIS
  12 .nf
  13 modprobe hpsa [ hpsa_allow_any=1 ]
  14 .fi
  15 .SH DESCRIPTION
  16 .B hpsa
  17 is a SCSI driver for HP Smart Array RAID controllers.
  18 .SS Options
  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
  27 .B hpsa
  28 to drive older controllers that would normally be handled by the
  29 .BR cciss (4)
  30 driver.
  31 These older boards have not been tested and are
  32 not supported with
  33 .BR hpsa ,
  34 and
  35 .BR cciss (4)
  36 should still be used for these.
  37 .SS Supported hardware
  38 The
  39 .B hpsa
  40 driver supports the following Smart Array boards:
  41 .P
  42 .nf
  43     Smart Array P700M
  44     Smart Array P212
  45     Smart Array P410
  46     Smart Array P410i
  47     Smart Array P411
  48     Smart Array P812
  49     Smart Array P712m
  50     Smart Array P711m
  51     StorageWorks P1210m
  52 .fi
  53 .P
  54 .\" commit 135ae6edeb51979d0998daf1357f149a7d6ebb08
  55 Since Linux 4.14, the following Smart Array boards are also supported:
  56 .P
  57 .nf
  58     Smart Array 5300
  59     Smart Array 5312
  60     Smart Array 532
  61     Smart Array 5i
  62     Smart Array 6400
  63     Smart Array 6400 EM
  64     Smart Array 641
  65     Smart Array 642
  66     Smart Array 6i
  67     Smart Array E200
  68     Smart Array E200i
  69     Smart Array E200i
  70     Smart Array E200i
  71     Smart Array E200i
  72     Smart Array E500
  73     Smart Array P400
  74     Smart Array P400i
  75     Smart Array P600
  76     Smart Array P700m
  77     Smart Array P800
  78 .fi
  79 .SS Configuration details
  80 To configure HP Smart Array controllers,
  81 use the HP Array Configuration Utility (either
  82 .BR hpacuxe (8)
  83 or
  84 .BR hpacucli (8))
  85 or the Offline ROM-based Configuration Utility (ORCA)
  86 run from the Smart Array's option ROM at boot time.
  87 .SH FILES
  88 .SS Device nodes
  89 Logical drives are accessed via the SCSI disk driver
  90 .RB ( sd (4)),
  91 tape drives via the SCSI tape driver
  92 .RB ( st (4)),
  93 and
  94 the RAID controller via the SCSI generic driver
  95 .RB ( sg (4)),
  96 with device nodes named
  97 .IR /dev/sd* ,
  98 .IR /dev/st* ,
  99 and
 100 .IR /dev/sg* ,
 101 respectively.
 102 .SS HPSA-specific host attribute files in /sys
 103 .TP
 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.
 117 .TP
 118 .I /sys/class/scsi_host/host*/firmware_revision
 119 This attribute contains the firmware version of the Smart Array.
 120 .IP
 121 For example:
 122 .IP
 123 .in +4n
 124 .EX
 125 # \fBcd /sys/class/scsi_host/host4\fP
 126 # \fBcat firmware_revision\fP
 127 7.14
 128 .EE
 129 .in
 130 .\"
 131 .SS HPSA-specific disk attribute files in /sys
 132 .TP
 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.
 135 .IP
 136 For example:
 137 .IP
 138 .in +4n
 139 .EX
 140 # \fBcd /sys/class/scsi_disk/4:0:0:0/device\fP
 141 # \fBcat unique_id\fP
 142 600508B1001044395355323037570F77
 143 .EE
 144 .in
 145 .TP
 146 .I /sys/class/scsi_disk/c:b:t:l/device/raid_level
 147 This attribute contains the RAID level of each logical drive.
 148 .IP
 149 For example:
 150 .IP
 151 .in +4n
 152 .EX
 153 # \fBcd /sys/class/scsi_disk/4:0:0:0/device\fP
 154 # \fBcat raid_level\fP
 155 RAID 0
 156 .EE
 157 .in
 158 .TP
 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.
 162 .IR c : b : t : l
 163 are the controller, bus, target, and lun of the device.
 164 .P
 165 For example:
 166 .IP
 167 .in +4n
 168 .EX
 169 # \fBcd /sys/class/scsi_disk/4:0:0:0/device\fP
 170 # \fBcat lunid\fP
 171 0x0000004000000000
 172 .EE
 173 .in
 174 .\"
 175 .SS Supported ioctl() operations
 176 For compatibility with applications written for the
 177 .BR cciss (4)
 178 driver, many, but
 179 not all of the ioctls supported by the
 180 .BR cciss (4)
 181 driver are also supported by the
 182 .B hpsa
 183 driver.
 184 The data structures used by these ioctls are described in
 185 the Linux kernel source file
 186 .IR include/linux/cciss_ioctl.h .
 187 .TP
 188 .B CCISS_DEREGDISK
 189 .TQ
 190 .B CCISS_REGNEWDISK
 191 .TQ
 192 .B CCISS_REGNEWD
 193 These three ioctls all do exactly the same thing,
 194 which is to cause the driver to rescan for new devices.
 195 This does exactly the same thing as writing to the
 196 hpsa-specific host "rescan" attribute.
 197 .TP
 198 .B CCISS_GETPCIINFO
 199 Returns PCI domain, bus, device, and function and "board ID" (PCI subsystem ID).
 200 .TP
 201 .B CCISS_GETDRIVVER
 202 Returns driver version in three bytes encoded as:
 203 .IP
 204 .in +4n
 205 .EX
 206 (major_version << 16) | (minor_version << 8) |
 207     (subminor_version)
 208 .EE
 209 .in
 210 .TP
 211 .B CCISS_PASSTHRU
 212 .TQ
 213 .B CCISS_BIG_PASSTHRU
 214 Allows "BMIC" and "CISS" commands to be passed through to the Smart Array.
 215 These are used extensively by the HP Array Configuration Utility,
 216 SNMP storage agents, and so on.
 217 See
 218 .I cciss_vol_status
 219 at
 220 .UR http://cciss.sf.net
 221 .UE
 222 for some examples.
 223 .SH SEE ALSO
 224 .BR cciss (4),
 225 .BR sd (4),
 226 .BR st (4),
 227 .BR cciss_vol_status (8),
 228 .BR hpacucli (8),
 229 .BR hpacuxe (8)
 230 .P
 231 .UR http://cciss.sf.net
 232 .UE ,
 233 and
 234 .I Documentation/scsi/hpsa.txt
 235 and
 236 .I Documentation/ABI/testing/sysfs\-bus\-pci\-devices\-cciss
 237 in the Linux kernel source tree
 238 .\" .SH AUTHORS
 239 .\" Don Brace, Steve Cameron, Tom Lawler, Mike Miller, Scott Teel
 240 .\" and probably some other people.