xref: /freebsd/share/man/man4/hptrr.4 (revision ca6a6373bdaed010d6cbfb27f7249ae96009409d)
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.Dd June 6, 2012
26.Dt HPTRR 4
27.Os
28.Sh NAME
29.Nm hptrr
30.Nd "HighPoint RocketRAID device driver"
31.Sh SYNOPSIS
32To compile this driver into the kernel,
33place the following line in your
34kernel configuration file:
35.Bd -ragged -offset indent
36.Cd "device hptrr"
37.Cd "device scbus"
38.Cd "device da"
39.Ed
40.Pp
41Alternatively, to load the driver as a
42module at boot time, place the following line in
43.Xr loader.conf 5 :
44.Bd -literal -offset indent
45hptrr_load="YES"
46.Ed
47.Pp
48The following tunables are settable from the loader:
49.Bl -ohang
50.It Va hw.hptrr.attach_generic
51set to 1 to permit driver attach to chips with generic Marvell (non-HighPoint)
52PCI identification.
53These chips are also supported by
54.Xr ata 4
55and
56.Xr mvs 4 .
57Some vendors are using same chips, but without providing RAID BIOS.
58.El
59.Sh DESCRIPTION
60The
61.Nm
62driver provides support for HighPoint's RocketRAID based RAID controllers.
63.Pp
64These devices support SATA/ATA disk drives
65and provide RAID0 (striping), RAID1 (mirroring), and RAID5 functionality.
66.Sh HARDWARE
67The
68.Nm
69driver supports the following RAID
70controllers:
71.Pp
72.Bl -bullet -compact
73.It
74RocketRAID 172x series
75.It
76RocketRAID 174x series
77.It
78RocketRAID 2210
79.It
80RocketRAID 222x series
81.It
82RocketRAID 2240
83.It
84RocketRAID 230x series
85.It
86RocketRAID 231x series
87.It
88RocketRAID 232x series
89.It
90RocketRAID 2340
91.It
92RocketRAID 2522
93.El
94.Sh NOTES
95The
96.Nm
97driver only works on the i386 and amd64 platforms as it requires a binary
98blob object from the manufacturer which they only supply for these platforms.
99The
100.Nm
101driver does
102.Em not
103work on i386 with
104.Xr pae 4
105enabled.
106.Pp
107This driver does not support the RR182x series controller.
108See the
109.Xr hptmv 4
110manual page for details on support.
111.Pp
112This driver supersedes the older rr232x driver.
113.Sh SEE ALSO
114.Xr ata 4 ,
115.Xr cam 4 ,
116.Xr hptmv 4 ,
117.Xr mvs 4 ,
118.Xr loader 8
119.Sh HISTORY
120The
121.Nm
122device driver first appeared in
123.Fx 6.3 .
124.Sh AUTHORS
125.An -nosplit
126The
127.Nm
128device driver was written by
129.An HighPoint Technologies, Inc. ,
130and ported to
131.Fx
132by
133.An Scott Long .
134This manual page was written by
135.An David E. O'Brien .
136.Sh BUGS
137The
138.Nm
139driver does not support manipulating the RAID from the OS, RAIDs need
140to be set up from the on-board BIOS.
141