share/man/man4/siis.4

   1 .\" Copyright (c) 2009 Alexander Motin <mav@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. The name of the author may not be used to endorse or promote products
  13 .\"    derived from this software without specific prior written permission.
  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 April 8, 2011
  29 .Dt SIIS 4
  30 .Os
  31 .Sh NAME
  32 .Nm siis
  33 .Nd SiliconImage Serial ATA Host Controller 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 pci"
  40 .Cd "device scbus"
  41 .Cd "device siis"
  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 siis_load="YES"
  49 .Ed
  50 .Pp
  51 The following tunables are settable from the
  52 .Xr loader 8 :
  53 .Bl -ohang
  54 .It Va hint.siis. Ns Ar X Ns Va .msi
  55 controls Message Signaled Interrupts (MSI) usage by the specified controller.
  56 .It Va hint.siisch. Ns Ar X Ns Va .pm_level
  57 controls SATA interface Power Management for the specified channel,
  58 allowing some power to be saved at the cost of additional command
  59 latency.
  60 Possible values:
  61 .Bl -tag -compact
  62 .It 0
  63 interface Power Management is disabled (default);
  64 .It 1
  65 device is allowed to initiate PM state change, host is passive.
  66 .El
  67 Note that interface Power Management is not compatible with
  68 device presence detection.
  69 A manual bus reset is needed on device hot-plug.
  70 .It Va hint.siisch. Ns Ar X Ns Va .sata_rev
  71 setting to nonzero value limits maximum SATA revision (speed).
  72 Values 1, 2 and 3 are respectively 1.5, 3 and 6Gbps.
  73 .El
  74 .Sh DESCRIPTION
  75 This driver provides the
  76 .Xr CAM 4
  77 subsystem with native access to the
  78 .Tn SATA
  79 ports of controller.
  80 Each SATA port is represented to CAM as a separate bus with 16 targets.
  81 Most of the bus-management details are handled by the SATA-specific
  82 transport of CAM.
  83 Connected ATA disks are handled by the ATA protocol disk peripheral driver
  84 .Xr ada 4 .
  85 ATAPI devices are handled by the SCSI protocol peripheral drivers
  86 .Xr cd 4 ,
  87 .Xr da 4 ,
  88 .Xr sa 4 ,
  89 etc.
  90 .Pp
  91 Driver features include support for Serial ATA and ATAPI devices,
  92 Port Multipliers (including FIS-based switching), hardware command queues
  93 (31 command per port), Native Command Queuing, SATA interface Power Management,
  94 device hot-plug and Message Signaled Interrupts.
  95 .Pp
  96 The activity LEDs of the adapters supported by the
  97 .Nm
  98 driver can be controlled via the
  99 .Xr led 4
 100 API for localization or status reporting purposes.
 101 .Pp
 102 Same hardware is also supported by the atasiliconimage driver from
 103 .Xr ata 4
 104 subsystem.
 105 If both drivers are loaded at the same time, this one will be
 106 given precedence as the more functional of the two.
 107 .Sh HARDWARE
 108 The
 109 .Nm
 110 driver supports the following controller chips:
 111 .Bl -bullet -compact
 112 .It
 113 SiI3124 (PCI-X 133MHz/64bit, 4 ports)
 114 .It
 115 SiI3131 (PCIe 1.0 x1, 1 port)
 116 .It
 117 SiI3132 (PCIe 1.0 x1, 2 ports)
 118 .It
 119 SiI3531 (PCIe 1.0 x1, 1 port)
 120 .El
 121 .Sh FILES
 122 .Bl -tag -width /dev/led/siisch*
 123 .It Pa /dev/led/siisch*
 124 identification LED device nodes
 125 .El
 126 .Sh SEE ALSO
 127 .Xr ada 4 ,
 128 .Xr ata 4 ,
 129 .Xr cam 4 ,
 130 .Xr cd 4 ,
 131 .Xr da 4 ,
 132 .Xr led 4 ,
 133 .Xr sa 4
 134 .Sh HISTORY
 135 The
 136 .Nm
 137 driver first appeared in
 138 .Fx 8.0 .
 139 .Sh AUTHORS
 140 .An Alexander Motin Aq mav@FreeBSD.org .