hpsa.4: ffix

[thirdparty/man-pages.git] / man4 / hpsa.4

.\" Copyright (C) 2011, Hewlett-Packard Development Company, L.P.
.\" Written by Stephen M. Cameron <scameron@beardog.cce.hp.com>
.\" Licensed under GNU General Public License version 2 (GPLv2)
.\" 
.\" shorthand for double quote that works everywhere.
.ds q \N'34'
.TH HPSA 4  2011-09-21 "Linux" "Linux Programmer's Manual"
.SH NAME
hpsa \- HP Smart Array SCSI driver
.SH SYNOPSIS
.nf
modprobe hpsa [ hpsa_allow_any=1 ]
.fi
.SH DESCRIPTION
.B hpsa
is a SCSI driver for HP Smart Array RAID controllers.
.SS Options
.IR "hpsa_allow_any=1" :
This option allows the driver to attempt to operate on
any HP Smart Array hardware RAID controller even if it is
not explicitly known to the driver.
This allows newer hardware
to work with older drivers.
Typically this is used for example
to allow installation of OSes from media which predates the
RAID controller though it may also be used to enable hpsa to
drive older controllers that would normally be handled by the
.BR cciss (4)
driver.
These older boards have not been tested and are
not supported with
.BR hpsa ,
and
.BR cciss (4)
should still be used for these.
.SS Supported Hardware
The
.B hpsa
driver supports the following Smart Array boards:
.nf

    Smart Array P700M
    Smart Array P212
    Smart Array P410
    Smart Array P410i
    Smart Array P411
    Smart Array P812
    Smart Array P712m
    Smart Array P711m
    StorageWorks P1210m

.fi
.SS Configuration Details
To configure HP Smart Array controllers, use the HP Array Configuration Utility
(either hpacuxe or hpacucli) or the Offline ROM-based Configuration Utility (ORCA)
run from the Smart Array's option ROM at boot time.
.SH FILES
.SS Device Nodes
Logical drives are accessed via the SCSI disk driver (sd),
tape drives via the SCSI tape driver (st), and
the RAID controller vi the SCSI generic driver (sg), with
device nodes named
.IR /dev/sd*,
.IR /dev/st* ,
and
.IR /dev/sg* ,
respectively.
.SS HPSA-Specific Host Attribute Files in /sys
.TP
.I /sys/class/scsi_host/host*/rescan
the host "rescan" attribute is a write only attribute.
Writing to this
attribute will cause the driver to scan for new, changed, or removed devices
(e.g. hot-plugged tape drives, or newly configured or deleted logical drives,
etc.) and notify the SCSI midlayer of any changes detected.
Normally this is
triggered automatically by HP's Array Configuration Utility (either the GUI or
command line variety) so for logical drive changes, the user should not
normally have to use this.
It may be useful when hot plugging devices like
tape drives, or entire storage boxes containing pre-configured logical drives.
.TP
.I /sys/class/scsi_host/host*/firmware_revision
The "firmware_revision" attribute contains the firmware version of the Smart Array.

For example:

.nf
    # \fBcd /sys/class/scsi_host/host4\fP
    # \fBcat firmware_revision\fP
    7.14
.fi

.SS HPSA-Specific Disk Attribute Files in /sys
.TP
.I /sys/class/scsi_disk/c:b:t:l/device/unique_id
contains a 32 hex-digit unique ID for each logical drive
.nf

For example:

    # \fBcd /sys/class/scsi_disk/4:0:0:0/device\fP
    # \fBcat unique_id\fP
    600508B1001044395355323037570F77
.fi
.TP
.I /sys/class/scsi_disk/c:b:t:l/device/raid_level
contains the RAID level of each logical drive.
.nf

For example:

    # \fBcd /sys/class/scsi_disk/4:0:0:0/device\fP
    # \fBcat raid_level\fP
    RAID 0
.fi
.TP
.I /sys/class/scsi_disk/c:b:t:l/device/lunid
(where c:b:t:l are the controller, bus, target and lun of the device)
contains 16 hex-digit (8 byte) LUN ID by which a logical drive or
physical device can be addressed.
.nf

For example:

    # \fBcd /sys/class/scsi_disk/4:0:0:0/device\fP
    # \fBcat lunid\fP
    0x0000004000000000
.fi
.SS Supported ioctl() operations
For compatibility with applications written for the cciss driver, many, but
not all of the ioctls supported by the cciss driver are also supported by the
hpsa driver.
The data structures used by these are described in
the kernel source file
.IR include/linux/cciss_ioctl.h .
.TP
.BR CCISS_DEREGDISK ", " CCISS_REGNEWDISK ", " CCISS_REGNEWD
The above three ioctls all do exactly the same thing,
which is to cause the driver to rescan for new devices.
This does exactly the same thing as writing to the
hpsa-specific host "rescan" attribute.
.TP
.B CCISS_GETPCIINFO
Returns PCI domain, bus, device and function and "board ID" (PCI subsystem ID).
.TP
.B CCISS_GETDRIVVER
Returns driver version in three bytes encoded as:
.sp
    (major_version << 16) | (minor_version << 8) |
        (subminor_version)
.TP
.BR CCISS_PASSTHRU ", " CCISS_BIG_PASSTHRU
Allows "BMIC" and "CISS" commands to be passed through to the Smart Array.
These are used extensively by the HP Array Configuration Utility, SNMP storage
agents, etc.
See
.I cciss_vol_status at
.I http://cciss.sf.net
for some examples.
.SH "SEE ALSO"
.BR cciss (4),
.BR sd (4),
.BR st (4),
.BR cciss_vol_status (8),
.BR hpacucli (8),
.BR hpacuxe (8),
.IR http://cciss.sf.net ,
and the linux kernel source files
.I Documentation/scsi/hpsa.txt
and
.I Documentation/ABI/testing/sysfs-bus-pci-devices-cciss
.\" .SH AUTHORS
.\" Don Brace, Steve Cameron, Tom Lawler, Mike Miller, Scott Teel
.\" and probably some other people.