original/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 2012-08-05 "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 .nf
  44
  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 .SS Configuration details
  56 To configure HP Smart Array controllers,
  57 use the HP Array Configuration Utility (either
  58 .BR hpacuxe (8)
  59 or
  60 .BR hpacucli (8))
  61 or the Offline ROM-based Configuration Utility (ORCA)
  62 run from the Smart Array's option ROM at boot time.
  63 .SH FILES
  64 .SS Device nodes
  65 Logical drives are accessed via the SCSI disk driver
  66 .RB ( sd (4)),
  67 tape drives via the SCSI tape driver
  68 .RB ( st (4)),
  69 and
  70 the RAID controller via the SCSI generic driver
  71 .RB ( sg (4)),
  72 with device nodes named
  73 .IR /dev/sd* ,
  74 .IR /dev/st* ,
  75 and
  76 .IR /dev/sg* ,
  77 respectively.
  78 .SS HPSA-specific host attribute files in /sys
  79 .TP
  80 .I /sys/class/scsi_host/host*/rescan
  81 This is a write-only attribute.
  82 Writing to this attribute will cause the driver to scan for
  83 new, changed, or removed devices (e.g,. hot-plugged tape drives,
  84 or newly configured or deleted logical drives, etc.)
  85 and notify the SCSI midlayer of any changes detected.
  86 Normally a rescan is triggered automatically
  87 by HP's Array Configuration Utility (either the GUI or the
  88 command-line variety);
  89 thus, for logical drive changes, the user should not
  90 normally have to use this attribute.
  91 This attribute may be useful when hot plugging devices like tape drives,
  92 or entire storage boxes containing preconfigured logical drives.
  93 .TP
  94 .I /sys/class/scsi_host/host*/firmware_revision
  95 This attribute contains the firmware version of the Smart Array.
  96
  97 For example:
  98
  99 .nf
 100     # \fBcd /sys/class/scsi_host/host4\fP
 101     # \fBcat firmware_revision\fP
 102     7.14
 103 .fi
 104 .SS HPSA-specific disk attribute files in /sys
 105 .TP
 106 .I /sys/class/scsi_disk/c:b:t:l/device/unique_id
 107 This attribute contains a 32 hex-digit unique ID for each logical drive.
 108 .nf
 109
 110 For example:
 111
 112     # \fBcd /sys/class/scsi_disk/4:0:0:0/device\fP
 113     # \fBcat unique_id\fP
 114     600508B1001044395355323037570F77
 115 .fi
 116 .TP
 117 .I /sys/class/scsi_disk/c:b:t:l/device/raid_level
 118 This attribute contains the RAID level of each logical drive.
 119 .nf
 120
 121 For example:
 122
 123     # \fBcd /sys/class/scsi_disk/4:0:0:0/device\fP
 124     # \fBcat raid_level\fP
 125     RAID 0
 126 .fi
 127 .TP
 128 .I /sys/class/scsi_disk/c:b:t:l/device/lunid
 129 This attribute contains the 16 hex-digit (8 byte) LUN ID
 130 by which a logical drive or physical device can be addressed.
 131 .IR c : b : t : l
 132 are the controller, bus, target, and lun of the device.
 133 .nf
 134
 135 For example:
 136
 137     # \fBcd /sys/class/scsi_disk/4:0:0:0/device\fP
 138     # \fBcat lunid\fP
 139     0x0000004000000000
 140 .fi
 141 .SS Supported ioctl() operations
 142 For compatibility with applications written for the
 143 .BR cciss (4)
 144 driver, many, but
 145 not all of the ioctls supported by the
 146 .BR cciss (4)
 147 driver are also supported by the
 148 .B hpsa
 149 driver.
 150 The data structures used by these ioctls are described in
 151 the Linux kernel source file
 152 .IR include/linux/cciss_ioctl.h .
 153 .TP
 154 .BR CCISS_DEREGDISK ", " CCISS_REGNEWDISK ", " CCISS_REGNEWD
 155 These three ioctls all do exactly the same thing,
 156 which is to cause the driver to rescan for new devices.
 157 This does exactly the same thing as writing to the
 158 hpsa-specific host "rescan" attribute.
 159 .TP
 160 .B CCISS_GETPCIINFO
 161 Returns PCI domain, bus, device and function and "board ID" (PCI subsystem ID).
 162 .TP
 163 .B CCISS_GETDRIVVER
 164 Returns driver version in three bytes encoded as:
 165 .sp
 166     (major_version << 16) | (minor_version << 8) |
 167         (subminor_version)
 168 .TP
 169 .BR CCISS_PASSTHRU ", " CCISS_BIG_PASSTHRU
 170 Allows "BMIC" and "CISS" commands to be passed through to the Smart Array.
 171 These are used extensively by the HP Array Configuration Utility,
 172 SNMP storage agents, and so on.
 173 See
 174 .I cciss_vol_status
 175 at
 176 .UR http://cciss.sf.net
 177 .UE
 178 for some examples.
 179 .SH SEE ALSO
 180 .BR cciss (4),
 181 .BR sd (4),
 182 .BR st (4),
 183 .BR cciss_vol_status (8),
 184 .BR hpacucli (8),
 185 .BR hpacuxe (8),
 186
 187 .UR http://cciss.sf.net
 188 .UE ,
 189 and
 190 .I Documentation/scsi/hpsa.txt
 191 and
 192 .I Documentation/ABI/testing/sysfs-bus-pci-devices-cciss
 193 in the Linux kernel source tree
 194 .\" .SH AUTHORS
 195 .\" Don Brace, Steve Cameron, Tom Lawler, Mike Miller, Scott Teel
 196 .\" and probably some other people.
 197 .SH COLOPHON
 198 This page is part of release 3.67 of the Linux
 199 .I man-pages
 200 project.
 201 A description of the project,
 202 information about reporting bugs,
 203 and the latest version of this page,
 204 can be found at
 205 \%http://www.kernel.org/doc/man\-pages/.