Add tws(4), a driver for the LSI 3ware 9750 series SATA/SAS RAID controllers.
[dragonfly.git] / share / man / man4 / tws.4
1 .\"
2 .\" Copyright (c) 2010
3 .\"     The DragonFly Project.  All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\"
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
13 .\"    the documentation and/or other materials provided with the
14 .\"    distribution.
15 .\" 3. Neither the name of The DragonFly Project nor the names of its
16 .\"    contributors may be used to endorse or promote products derived
17 .\"    from this software without specific, prior written permission.
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
23 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
25 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
29 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .Dd December 20, 2010
33 .Dt TWS 4
34 .Os
35 .Sh NAME
36 .Nm tws
37 .Nd 3ware 9750 series SATA/SAS RAID controllers driver
38 .Sh SYNOPSIS
39 To compile this driver into the kernel,
40 place the following lines in your
41 kernel configuration file:
42 .Bd -ragged -offset indent
43 .Cd "device scbus"
44 .Cd "device tws"
45 .Ed
46 .Pp
47 Alternatively, to load the driver as a
48 module at boot time, place the following line in
49 .Xr loader.conf 5 :
50 .Bd -literal -offset indent
51 tws_load="YES"
52 .Ed
53 .Sh DESCRIPTION
54 The
55 .Nm
56 driver provides support for LSI's 3ware 9750 series
57 SATA/SAS controllers.
58 .Pp
59 These controllers are available in 4, 8, 16 or 24-port configurations,
60 and support the following RAID levels: 0, 1, 10, 5, 50, 6.
61 The device nodes for the controllers are of the form
62 .Pa /dev/tws Ns Ar X ,
63 where
64 .Ar X
65 is the controller number.
66 The driver is implemented as a SCSI SIM
67 under CAM, and, as such, the logical units that it controls are accessible
68 via the device nodes,
69 .Pa /dev/da Ns Ar Y ,
70 where
71 .Ar Y
72 is the logical unit number.
73 .Sh HARDWARE
74 The
75 .Nm
76 driver supports the following SATA RAID controllers:
77 .Pp
78 .Bl -bullet -compact
79 .It
80 LSI's 3ware SAS 9750-4i
81 .It
82 LSI's 3ware SAS 9750-4i4e
83 .It
84 LSI's 3ware SAS 9750-8i
85 .It
86 LSI's 3ware SAS 9750-8e
87 .It
88 LSI's 3ware SAS 9750-16i4e
89 .It
90 LSI's 3ware SAS 9750-24i4e
91 .El
92 .Sh SEE ALSO
93 .Xr da 4 ,
94 .Xr twa 4 ,
95 .Xr twe 4
96 .Sh COPYRIGHT
97 .Bd -literal
98 Copyright (c) 2010, LSI Corp.
99 All rights reserved.
100 Author : Manjunath Ranganathaiah
101 Support: freebsdraid@lsi.com
102
103 Redistribution and use in source and binary forms, with or without
104 modification, are permitted provided that the following conditions
105 are met:
106
107 1. Redistributions of source code must retain the above copyright
108    notice, this list of conditions and the following disclaimer.
109 2. Redistributions in binary form must reproduce the above copyright
110    notice, this list of conditions and the following disclaimer in
111    the documentation and/or other materials provided with the
112    distribution.
113 3. Neither the name of the <ORGANIZATION> nor the names of its
114    contributors may be used to endorse or promote products derived
115    from this software without specific prior written permission.
116
117 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
118 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
119 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
120 FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
121 COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
122 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
123 BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
124 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
125 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
126 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
127 ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
128 POSSIBILITY OF SUCH DAMAGE.
129 .Ed