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 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd April 8, 2011
  28 .Dt SIIS 4
  29 .Os
  30 .Sh NAME
  31 .Nm siis
  32 .Nd SiliconImage Serial ATA Host Controller driver
  33 .Sh SYNOPSIS
  34 To compile this driver into the kernel,
  35 place the following lines in your
  36 kernel configuration file:
  37 .Bd -ragged -offset indent
  38 .Cd "device pci"
  39 .Cd "device scbus"
  40 .Cd "device siis"
  41 .Ed
  42 .Pp
  43 Alternatively, to load the driver as a
  44 module at boot time, place the following line in
  45 .Xr loader.conf 5 :
  46 .Bd -literal -offset indent
  47 siis_load="YES"
  48 .Ed
  49 .Pp
  50 The following tunables are settable from the
  51 .Xr loader 8 :
  52 .Bl -ohang
  53 .It Va hint.siis. Ns Ar X Ns Va .msi
  54 controls Message Signaled Interrupts (MSI) usage by the specified controller.
  55 .It Va hint.siisch. Ns Ar X Ns Va .pm_level
  56 controls SATA interface Power Management for the specified channel,
  57 allowing some power to be saved at the cost of additional command
  58 latency.
  59 Possible values:
  60 .Bl -tag -compact
  61 .It 0
  62 interface Power Management is disabled (default);
  63 .It 1
  64 device is allowed to initiate PM state change, host is passive.
  65 .El
  66 Note that interface Power Management is not compatible with
  67 device presence detection.
  68 A manual bus reset is needed on device hot-plug.
  69 .It Va hint.siisch. Ns Ar X Ns Va .sata_rev
  70 setting to nonzero value limits maximum SATA revision (speed).
  71 Values 1, 2 and 3 are respectively 1.5, 3 and 6Gbps.
  72 .El
  73 .Sh DESCRIPTION
  74 This driver provides the
  75 .Xr CAM 4
  76 subsystem with native access to the
  77 .Tn SATA
  78 ports of controller.
  79 Each SATA port is represented to CAM as a separate bus with 16 targets.
  80 Most of the bus-management details are handled by the SATA-specific
  81 transport of CAM.
  82 Connected ATA disks are handled by the ATA protocol disk peripheral driver
  83 .Xr ada 4 .
  84 ATAPI devices are handled by the SCSI protocol peripheral drivers
  85 .Xr cd 4 ,
  86 .Xr da 4 ,
  87 .Xr sa 4 ,
  88 etc.
  89 .Pp
  90 Driver features include support for Serial ATA and ATAPI devices,
  91 Port Multipliers (including FIS-based switching), hardware command queues
  92 (31 command per port), Native Command Queuing, SATA interface Power Management,
  93 device hot-plug and Message Signaled Interrupts.
  94 .Pp
  95 The activity LEDs of the adapters supported by the
  96 .Nm
  97 driver can be controlled via the
  98 .Xr led 4
  99 API for localization or status reporting purposes.
 100 .Pp
 101 Same hardware is also supported by the atasiliconimage driver from
 102 .Xr ata 4
 103 subsystem.
 104 If both drivers are loaded at the same time, this one will be
 105 given precedence as the more functional of the two.
 106 .Sh HARDWARE
 107 The
 108 .Nm
 109 driver supports the following controller chips:
 110 .Bl -bullet -compact
 111 .It
 112 SiI3124 (PCI-X 133MHz/64bit, 4 ports)
 113 .It
 114 SiI3131 (PCIe 1.0 x1, 1 port)
 115 .It
 116 SiI3132 (PCIe 1.0 x1, 2 ports)
 117 .It
 118 SiI3531 (PCIe 1.0 x1, 1 port)
 119 .El
 120 .Sh FILES
 121 .Bl -tag -width /dev/led/siisch*
 122 .It Pa /dev/led/siisch*
 123 identification LED device nodes
 124 .El
 125 .Sh SEE ALSO
 126 .Xr ada 4 ,
 127 .Xr ata 4 ,
 128 .Xr cam 4 ,
 129 .Xr cd 4 ,
 130 .Xr da 4 ,
 131 .Xr led 4 ,
 132 .Xr sa 4
 133 .Sh HISTORY
 134 The
 135 .Nm
 136 driver first appeared in
 137 .Fx 8.0 .
 138 .Sh AUTHORS
 139 .An Alexander Motin Aq mav@FreeBSD.org .