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