share/man/man4/nataraid.4

   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 .\"
  27 .Dd June 24, 2007
  28 .Dt NATARAID 4
  29 .Os
  30 .Sh NAME
  31 .Nm nataraid ,
  32 .Nm ar
  33 .Nd "ATA software RAID support"
  34 .Sh SYNOPSIS
  35 .Cd "device nata"
  36 .Cd "device nataraid"
  37 .Sh DESCRIPTION
  38 The
  39 .Nm
  40 driver provides support for so-called software RAID
  41 (sometimes referred to as fake RAID or pseudo RAID).
  42 .Pp
  43 When a controller that supports software RAID is instructed to
  44 create a RAID array, its BIOS writes data structures in a specific
  45 metadata format to the disks.
  46 These data structures are picked up by the
  47 .Nm
  48 driver, so that
  49 .Dx
  50 can work with the array.
  51 The
  52 .Nm
  53 driver has to understand the specific metadata format of a
  54 controller BIOS in order to support its RAID capabilities.
  55 .Pp
  56 Read-only support for a metadata format means that
  57 .Dx
  58 can use the given RAID array for normal read/write operations.
  59 Creation and rebuild of such arrays has to be done from the
  60 controller BIOS.
  61 .Pp
  62 Read and write support for a metadata format means that
  63 .Dx
  64 can use the given RAID array for normal read/write operations.
  65 Additionally, the
  66 .Xr natacontrol 8
  67 utility can be used to create, rebuild, update and fail such
  68 RAID arrays.
  69 .Pp
  70 The
  71 .Nm
  72 driver can read the following metadata formats:
  73 .Pp
  74 .Bl -bullet -compact
  75 .It
  76 Adaptec HostRAID
  77 .It
  78 Highpoint V2 RocketRAID
  79 .It
  80 Highpoint V3 RocketRAID
  81 .It
  82 Intel MatrixRAID
  83 .It
  84 Integrated Technology Express (ITE)
  85 .It
  86 JMicron
  87 .It
  88 LSI Logic V2 MegaRAID
  89 .It
  90 LSI Logic V3 MegaRAID
  91 .It
  92 NVIDIA MediaShield
  93 .It
  94 Promise FastTrak
  95 .It
  96 Silicon Image Medley
  97 .It
  98 Silicon Integrated Systems (SiS)
  99 .It
 100 VIA Tech V-RAID
 101 .It
 102 FreeBSD PseudoRAID
 103 .El
 104 .Pp
 105 The
 106 .Nm
 107 driver can write the following metadata formats:
 108 .Pp
 109 .Bl -bullet -compact
 110 .It
 111 Highpoint V2 RocketRAID
 112 .It
 113 Intel MatrixRAID
 114 .It
 115 JMicron
 116 .It
 117 Promise FastTrak
 118 .It
 119 Silicon Integrated Systems (SiS)
 120 .It
 121 VIA Tech V-RAID
 122 .It
 123 FreeBSD PseudoRAID
 124 .El
 125 .Pp
 126 It is also possible to use software RAID on controllers
 127 that do not have special software RAID capabilities.
 128 See
 129 .Xr natacontrol 8
 130 for details.
 131 .Sh FILES
 132 .Bl -tag -width ".Pa /dev/ar*" -compact
 133 .It Pa /dev/ar*
 134 ATA RAID device nodes
 135 .El
 136 .Sh SEE ALSO
 137 .Xr nata 4 ,
 138 .Xr natacontrol 8
 139 .Sh CAVEATS
 140 RAID5 is not supported at this time.
 141 Code exists, but it neither uses nor maintains parity information.
 142 .Sh AUTHORS
 143 .An -nosplit
 144 The
 145 .Nm
 146 driver was written by
 147 .An S\(/oren Schmidt Aq Mt sos@FreeBSD.org .
 148 This manual page was written by
 149 .An Christian Brueffer Aq Mt brueffer@FreeBSD.org .