Add tws(4), a driver for the LSI 3ware 9750 series SATA/SAS RAID controllers.
[dragonfly.git] / share / man / man4 / twa.4
CommitLineData
45ea7810
SW
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.\"
df54c2f9 26.\" $FreeBSD: src/share/man/man4/twa.4,v 1.9 2010/05/13 12:07:55 uqs Exp $
45ea7810 27.\"
df54c2f9 28.Dd August 1, 2010
45ea7810
SW
29.Dt TWA 4
30.Os
31.Sh NAME
32.Nm twa
df54c2f9 33.Nd 3ware 9000/9500/9550/9650 series SATA RAID controllers driver
45ea7810 34.Sh SYNOPSIS
df54c2f9
SW
35To compile this driver into the kernel,
36place the following lines in your
37kernel configuration file:
38.Bd -ragged -offset indent
39.Cd "device scbus"
45ea7810 40.Cd "device twa"
df54c2f9
SW
41.Ed
42.Pp
43Alternatively, to load the driver as a
44module at boot time, place the following line in
45.Xr loader.conf 5 :
46.Bd -literal -offset indent
47twa_load="YES"
48.Ed
45ea7810
SW
49.Sh DESCRIPTION
50The
51.Nm
df54c2f9
SW
52driver provides support for AMCC's 3ware 9000/9500/9550/9650 series
53SATA controllers.
45ea7810 54.Pp
df54c2f9 55These controllers are available in 4, 8, 12 or 16-port configurations,
45ea7810
SW
56and support the following RAID levels: 0, 1, 10, 5, 50.
57The device nodes for the controllers are of the form
58.Pa /dev/twa Ns Ar X ,
59where
60.Ar X
61is the controller number.
62The driver is implemented as a SCSI SIM
63under CAM, and, as such, the logical units that it controls are accessible
64via the device nodes,
65.Pa /dev/da Ns Ar Y ,
66where
67.Ar Y
68is the logical unit number.
69.Sh HARDWARE
70The
71.Nm
72driver supports the following SATA RAID controllers:
73.Pp
74.Bl -bullet -compact
75.It
76AMCC's 3ware 9500S-4LP
77.It
78AMCC's 3ware 9500S-8
79.It
80AMCC's 3ware 9500S-8MI
81.It
82AMCC's 3ware 9500S-12
83.It
84AMCC's 3ware 9500S-12MI
df54c2f9
SW
85.It
86AMCC's 3ware 9500SX-4LP
87.It
88AMCC's 3ware 9500SX-8LP
89.It
90AMCC's 3ware 9500SX-12
91.It
92AMCC's 3ware 9500SX-12MI
93.It
94AMCC's 3ware 9500SX-16ML
95.It
96AMCC's 3ware 9550SX-4LP
97.It
98AMCC's 3ware 9550SX-8LP
99.It
100AMCC's 3ware 9550SX-12
101.It
102AMCC's 3ware 9550SX-12MI
103.It
104AMCC's 3ware 9550SX-16ML
105.It
106AMCC's 3ware 9650SE-2LP
107.It
108AMCC's 3ware 9650SE-4LPML
109.It
110AMCC's 3ware 9650SE-8LPML
111.It
112AMCC's 3ware 9650SE-12ML
113.It
114AMCC's 3ware 9650SE-16ML
115.It
116AMCC's 3ware 9650SE-24M8
45ea7810
SW
117.El
118.Sh DIAGNOSTICS
119Whenever the driver encounters a command failure, it prints out an error code in
120the format:
121.Qq Li "ERROR: (<error source>: <error code>):" ,
122followed by a text description of the error.
123There are other error messages and warnings that the
124driver prints out, depending on the kinds of errors that it encounters.
125If the driver is compiled with
126.Dv TWA_DEBUG
127defined, it prints out a whole bunch of debug
128messages, the quantity of which varies depending on the value assigned to
129.Dv TWA_DEBUG
130(0 to 10).
33190b70
SW
131.Sh SEE ALSO
132.Xr da 4 ,
133.Xr twe 4 ,
134.Xr tws 4
45ea7810
SW
135.Sh AUTHORS
136The
137.Nm
138driver and manpage were written by
139.An Vinod Kashyap Aq vkashyap@FreeBSD.org .