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