share/man/man4/twa.4

   1 .\"
   2 .\" Copyright (c) 2004 3ware, Inc.
   3 .\" Copyright (c) 2000 BSDi
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd February 20, 2006
  29 .Dt TWA 4
  30 .Os
  31 .Sh NAME
  32 .Nm twa
  33 .Nd 3ware 9000/9500/9550 series SATA RAID controllers driver
  34 .Sh SYNOPSIS
  35 To compile this driver into the kernel,
  36 place the following lines in your
  37 kernel configuration file:
  38 .Bd -ragged -offset indent
  39 .Cd "device scbus"
  40 .Cd "device twa"
  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 twa_load="YES"
  48 .Ed
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 driver provides support for AMCC's 3ware 9000/9500/9550 series
  53 SATA controllers.
  54 .Pp
  55 These controllers are available in 4, 8, 12 or 16-port configurations,
  56 and support the following RAID levels: 0, 1, 10, 5, 50.
  57 The device nodes for the controllers are of the form
  58 .Pa /dev/twa Ns Ar X ,
  59 where
  60 .Ar X
  61 is the controller number.
  62 The driver is implemented as a SCSI SIM
  63 under CAM, and, as such, the logical units that it controls are accessible
  64 via the device nodes,
  65 .Pa /dev/da Ns Ar Y ,
  66 where
  67 .Ar Y
  68 is the logical unit number.
  69 .Sh HARDWARE
  70 The
  71 .Nm
  72 driver supports the following SATA RAID controllers:
  73 .Pp
  74 .Bl -bullet -compact
  75 .It
  76 AMCC's 3ware 9500S-4LP
  77 .It
  78 AMCC's 3ware 9500S-8
  79 .It
  80 AMCC's 3ware 9500S-8MI
  81 .It
  82 AMCC's 3ware 9500S-12
  83 .It
  84 AMCC's 3ware 9500S-12MI
  85 .It
  86 AMCC's 3ware 9500SX-4LP
  87 .It
  88 AMCC's 3ware 9500SX-8LP
  89 .It
  90 AMCC's 3ware 9500SX-12
  91 .It
  92 AMCC's 3ware 9500SX-12MI
  93 .It
  94 AMCC's 3ware 9500SX-16ML
  95 .It
  96 AMCC's 3ware 9550SX-4LP
  97 .It
  98 AMCC's 3ware 9550SX-8LP
  99 .It
 100 AMCC's 3ware 9550SX-12
 101 .It
 102 AMCC's 3ware 9550SX-12MI
 103 .It
 104 AMCC's 3ware 9550SX-16ML
 105 .El
 106 .Sh DIAGNOSTICS
 107 Whenever the driver encounters a command failure, it prints out an error code in
 108 the format:
 109 .Qq Li "ERROR: (<error source>: <error code>):" ,
 110 followed by a text description of the error.
 111 There are other error messages and warnings that the
 112 driver prints out, depending on the kinds of errors that it encounters.
 113 If the driver is compiled with
 114 .Dv TWA_DEBUG
 115 defined, it prints out a whole bunch of debug
 116 messages, the quantity of which varies depending on the value assigned to
 117 .Dv TWA_DEBUG
 118 (0 to 10).
 119 .Sh AUTHORS
 120 The
 121 .Nm
 122 driver and manpage were written by
 123 .An Vinod Kashyap Aq vkashyap@FreeBSD.org .