xref: /dragonfly/share/man/man4/nataraid.4 (revision 7bc7e232)
1.\" Copyright (c) 2005 Christian Brueffer
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD: src/share/man/man4/ataraid.4,v 1.10 2006/09/18 15:24:18 ru Exp $
26.\" $DragonFly: src/share/man/man4/nataraid.4,v 1.2 2007/06/24 17:42:58 swildner Exp $
27.\"
28.Dd June 24, 2007
29.Dt NATARAID 4
30.Os
31.Sh NAME
32.Nm nataraid ,
33.Nm ar
34.Nd "ATA software RAID support"
35.Sh SYNOPSIS
36.Cd "device nata"
37.Cd "device nataraid"
38.Sh DESCRIPTION
39The
40.Nm
41driver provides support for so-called software RAID
42(sometimes referred to as fake RAID or pseudo RAID).
43.Pp
44When a controller that supports software RAID is instructed to
45create a RAID array, its BIOS writes data structures in a specific
46metadata format to the disks.
47These data structures are picked up by the
48.Nm
49driver, so that
50.Dx
51can work with the array.
52The
53.Nm
54driver has to understand the specific metadata format of a
55controller BIOS in order to support its RAID capabilities.
56.Pp
57Read-only support for a metadata format means that
58.Dx
59can use the given RAID array for normal read/write operations.
60Creation and rebuild of such arrays has to be done from the
61controller BIOS.
62.Pp
63Read and write support for a metadata format means that
64.Dx
65can use the given RAID array for normal read/write operations.
66Additionally, the
67.Xr natacontrol 8
68utility can be used to create, rebuild, update and fail such
69RAID arrays.
70.Pp
71The
72.Nm
73driver can read the following metadata formats:
74.Pp
75.Bl -bullet -compact
76.It
77Adaptec HostRAID
78.It
79Highpoint V2 RocketRAID
80.It
81Highpoint V3 RocketRAID
82.It
83Intel MatrixRAID
84.It
85Integrated Technology Express (ITE)
86.It
87JMicron
88.It
89LSI Logic V2 MegaRAID
90.It
91LSI Logic V3 MegaRAID
92.It
93NVIDIA MediaShield
94.It
95Promise FastTrak
96.It
97Silicon Image Medley
98.It
99Silicon Integrated Systems (SiS)
100.It
101VIA Tech V-RAID
102.It
103FreeBSD PseudoRAID
104.El
105.Pp
106The
107.Nm
108driver can write the following metadata formats:
109.Pp
110.Bl -bullet -compact
111.It
112Highpoint V2 RocketRAID
113.It
114Intel MatrixRAID
115.It
116JMicron
117.It
118Promise FastTrak
119.It
120Silicon Integrated Systems (SiS)
121.It
122VIA Tech V-RAID
123.It
124FreeBSD PseudoRAID
125.El
126.Pp
127It is also possible to use software RAID on controllers
128that do not have special software RAID capabilities.
129See
130.Xr natacontrol 8
131for details.
132.Sh FILES
133.Bl -tag -width ".Pa /dev/ar*" -compact
134.It Pa /dev/ar*
135ATA RAID device nodes
136.El
137.Sh SEE ALSO
138.Xr nata 4 ,
139.Xr natacontrol 8
140.Sh CAVEATS
141RAID5 is not supported at this time.
142Code exists, but it neither uses nor maintains parity information.
143.Sh AUTHORS
144.An -nosplit
145The
146.Nm
147driver was written by
148.An S\(/oren Schmidt Aq sos@FreeBSD.org .
149This manual page was written by
150.An Christian Brueffer Aq brueffer@FreeBSD.org .
151