Add the hptrr(4) driver for HighPoint RocketRAID 17xx, 22xx, 23xx and 25xx.
[dragonfly.git] / share / man / man4 / hptrr.4
CommitLineData
0e32bd08
SW
1.\"
2.\" Copyright (c) 2007 Me
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\" notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\" notice, this list of conditions and the following disclaimer in the
12.\" documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
15.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
18.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24.\"
25.\" $FreeBSD: src/share/man/man4/hptrr.4,v 1.6 2012/06/17 03:54:10 eadler Exp $
26.\"
27.Dd August 3, 2012
28.Dt HPTRR 4
29.Os
30.Sh NAME
31.Nm hptrr
32.Nd "HighPoint RocketRAID device driver"
33.Sh SYNOPSIS
34To compile this driver into the kernel,
35place the following line in your
36kernel configuration file:
37.Bd -ragged -offset indent
38.Cd "device hptrr"
39.Cd "device scbus"
40.Cd "device da"
41.Ed
42.Pp
43Alternatively, to load the driver as a
44module at boot time, place the following line in
45.Xr loader.conf 5 :
46.Bd -literal -offset indent
47hptrr_load="YES"
48.Ed
49.Pp
50The following tunables are settable from the loader:
51.Bl -ohang
52.It Va hw.hptrr.attach_generic
53set to 1 to permit driver attach to chips with generic Marvell (non-HighPoint)
54PCI identification. These chips are also supported by
55.Xr nata 4 .
56.\"and
57.\".Xr mvs 4 .
58Some vendors are using same chips, but without providing RAID BIOS.
59.El
60.Sh DESCRIPTION
61The
62.Nm
63driver provides support for HighPoint's RocketRAID based RAID controllers.
64.Pp
65These devices support SATA/ATA disk drives
66and provide RAID0 (striping), RAID1 (mirroring), and RAID5 functionality.
67.Sh HARDWARE
68The
69.Nm
70driver supports the following RAID
71controllers:
72.Pp
73.Bl -bullet -compact
74.It
75RocketRAID 172x series
76.It
77RocketRAID 174x series
78.It
79RocketRAID 2210
80.It
81RocketRAID 222x series
82.It
83RocketRAID 2240
84.It
85RocketRAID 230x series
86.It
87RocketRAID 231x series
88.It
89RocketRAID 232x series
90.It
91RocketRAID 2340
92.It
93RocketRAID 2522
94.El
95.Sh NOTES
96The
97.Nm
98driver only works on the i386 and x86_64 platforms as it requires a
99blob from the manufacturer which they only supply for these platforms.
100.\"The
101.\".Nm
102.\"driver does
103.\".Em not
104.\"work on i386 with
105.\".Xr pae 4
106.\"enabled.
107.Pp
108This driver does not support the RR182x series controller.
109See the
110.Xr hptmv 4
111manual page for details on support.
112.\".Pp
113.\"This driver supersedes the older rr232x driver.
114.Sh SEE ALSO
115.Xr cam 4 ,
116.Xr hptiop 4 ,
117.Xr hptmv 4 ,
118.\".Xr mvs 4 ,
119.Xr nata 4 ,
120.Xr loader 8
121.Sh HISTORY
122The
123.Nm
124device driver first appeared in
125.Fx 6.3 .
126.Sh AUTHORS
127.An -nosplit
128The
129.Nm
130device driver was written by
131.An HighPoint Technologies, Inc. ,
132and ported to
133.Fx
134by
135.An Scott Long .
136This manual page was written by
137.An David E. O'Brien .
138.Sh BUGS
139The
140.Nm
141driver does not support manipulating the RAID from the OS, RAIDs need
142to be set up from the on-board BIOS.