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