xref: /freebsd/share/man/man4/tws.4 (revision 06c3fb27)
1.\"
2.\"Copyright (c) 2010, 2011 iXsystems, Inc.
3.\"All rights reserved.
4.\" written by: Xin LI <delphij@FreeBSD.org>
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 AND CONTRIBUTORS ``AS IS'' AND
16.\"ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\"IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\"ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\"FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\"DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\"OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\"HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\"LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\"OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\"SUCH DAMAGE.
26.\"
27.Dd October 4, 2011
28.Dt TWS 4
29.Os
30.Sh NAME
31.Nm tws
32.Nd 3ware 9750 SATA+SAS 6Gb/s RAID controller card driver
33.Sh SYNOPSIS
34To compile this driver into the kernel,
35place the following lines in your
36kernel configuration file:
37.Bd -ragged -offset indent
38.Cd "device scbus"
39.Cd "device tws"
40.Ed
41.Pp
42Alternatively, to load the driver as a
43module at boot time, place the following line in
44.Xr loader.conf 5 :
45.Bd -literal -offset indent
46tws_load="YES"
47.Ed
48.Sh DESCRIPTION
49The
50.Nm
51driver provides support for LSI's 3ware 9750 SATA+SAS 6Gb/s RAID controller cards.
52.Pp
53These controllers feature the LSISAS2108 6Gb/s SAS RAID-on-Chip (ROC)
54and are available in 4- and 8-port configurations, supports RAID levels
550, 1, 5, 6, 10, 50 and single disk, with 96 SATA and/or SAS hard drives and SSDs.
56.Pp
57For further hardware information, see
58.Pa http://www.lsi.com/.
59.Sh HARDWARE
60The
61.Nm
62driver supports the following SATA/SAS RAID controller:
63.Pp
64.Bl -bullet -compact
65.It
66LSI's 3ware SAS 9750 series
67.El
68.Sh LOADER TUNABLES
69Tunables can be set at the
70.Xr loader 8
71prompt before booting the kernel or stored in
72.Xr loader.conf 5 .
73.Bl -tag -width "hw.tws.use_32bit_sgls"
74.It Va hw.tws.cam_depth
75The maximum queued CAM SIM requests for one controller.
76The default value is 256.
77.It Va hw.tws.enable_msi
78This tunable enables MSI support on the controller if set to a non-zero value.
79The default value is 0.
80.It Va hw.tws.queue_depth
81The maximum queued requests for one controller.
82.It Va hw.tws.use_32bit_sgls
83Limit the driver to use only 32-bit SG elements regardless whether the operating
84system is running in 64-bit mode.
85The default value is 0.
86.El
87.Sh FILES
88.Bl -tag -width ".Pa /dev/tws?" -compact
89.It Pa /dev/da?
90array/logical disk interface
91.It Pa /dev/tws?
92management interface
93.El
94.Sh DIAGNOSTICS
95Whenever the driver encounters a command failure, it prints out an error code in
96the format:
97.Qq Li "ERROR: (<error source>: <error code>):" ,
98followed by a text description of the error.
99There are other error messages and warnings that the
100driver prints out, depending on the kinds of errors that it encounters.
101If the driver is compiled with
102.Dv TWS_DEBUG
103defined, it prints out a whole bunch of debug
104messages.
105.Sh SEE ALSO
106.Xr da 4 ,
107.Xr scsi 4
108.Sh AUTHORS
109.An -nosplit
110The
111.Nm
112driver was written by
113.An Manjunath Ranganathaiah
114for LSI and this manual page was written by
115.An Xin LI Aq Mt delphij@FreeBSD.org
116for iXsystems, Inc.
117