share/man/man4/tws.4

   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 .\" $FreeBSD$
  28 .\"
  29 .Dd October 4, 2011
  30 .Dt TWS 4
  31 .Os
  32 .Sh NAME
  33 .Nm tws
  34 .Nd 3ware 9750 SATA+SAS 6Gb/s RAID controller card driver
  35 .Sh SYNOPSIS
  36 To compile this driver into the kernel,
  37 place the following lines in your
  38 kernel configuration file:
  39 .Bd -ragged -offset indent
  40 .Cd "device scbus"
  41 .Cd "device tws"
  42 .Ed
  43 .Pp
  44 Alternatively, to load the driver as a
  45 module at boot time, place the following line in
  46 .Xr loader.conf 5 :
  47 .Bd -literal -offset indent
  48 tws_load="YES"
  49 .Ed
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 driver provides support for LSI's 3ware 9750 SATA+SAS 6Gb/s RAID controller cards.
  54 .Pp
  55 These controllers feature the LSISAS2108 6Gb/s SAS RAID-on-Chip (ROC)
  56 and are available in 4- and 8-port configurations, supports RAID levels
  57 0, 1, 5, 6, 10, 50 and single disk, with 96 SATA and/or SAS hard drives and SSDs.
  58 .Pp
  59 For further hardware information, see
  60 .Pa http://www.lsi.com/.
  61 .Sh HARDWARE
  62 The
  63 .Nm
  64 driver supports the following SATA/SAS RAID controller:
  65 .Pp
  66 .Bl -bullet -compact
  67 .It
  68 LSI's 3ware SAS 9750 series
  69 .El
  70 .Sh LOADER TUNABLES
  71 Tunables can be set at the
  72 .Xr loader 8
  73 prompt before booting the kernel or stored in
  74 .Xr loader.conf 5 .
  75 .Bl -tag -width "hw.tws.use_32bit_sgls"
  76 .It Va hw.tws.cam_depth
  77 The maximum queued CAM SIM requests for one controller.
  78 The default value is 256.
  79 .It Va hw.tws.enable_msi
  80 This tunable enables MSI support on the controller if set to a non-zero value.
  81 The default value is 0.
  82 .It Va hw.tws.queue_depth
  83 The maximum queued requests for one controller.
  84 .It Va hw.tws.use_32bit_sgls
  85 Limit the driver to use only 32-bit SG elements regardless whether the operating
  86 system is running in 64-bit mode.
  87 The default value is 0.
  88 .El
  89 .Sh FILES
  90 .Bl -tag -width ".Pa /dev/tws?" -compact
  91 .It Pa /dev/da?
  92 array/logical disk interface
  93 .It Pa /dev/tws?
  94 management interface
  95 .El
  96 .Sh DIAGNOSTICS
  97 Whenever the driver encounters a command failure, it prints out an error code in
  98 the format:
  99 .Qq Li "ERROR: (<error source>: <error code>):" ,
 100 followed by a text description of the error.
 101 There are other error messages and warnings that the
 102 driver prints out, depending on the kinds of errors that it encounters.
 103 If the driver is compiled with
 104 .Dv TWS_DEBUG
 105 defined, it prints out a whole bunch of debug
 106 messages.
 107 .Sh SEE ALSO
 108 .Xr da 4 ,
 109 .Xr scsi 4
 110 .Sh AUTHORS
 111 .An -nosplit
 112 The
 113 .Nm
 114 driver was written by
 115 .An Manjunath Ranganathaiah
 116 for LSI and this manual page was written by
 117 .An Xin LI Aq delphij@FreeBSD.org
 118 for iXsystems, Inc.