share/man/man4/ahci.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 May 17, 2011
  28 .Dt AHCI 4
  29 .Os
  30 .Sh NAME
  31 .Nm ahci
  32 .Nd Serial ATA Advanced Host Controller Interface 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 ahci"
  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 ahci_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.ahci. Ns Ar X Ns Va .msi
  54 controls Message Signaled Interrupts (MSI) usage by the specified controller
  55 .Bl -tag -compact
  56 .It 0
  57 MSI disabled;
  58 .It 1
  59 single MSI vector used, if supported (default);
  60 .It 2
  61 multiple MSI vectors used, if supported;
  62 .El
  63 .It Va hint.ahci. Ns Ar X Ns Va .ccc
  64 controls Command Completion Coalescing (CCC) usage by the specified controller.
  65 Non-zero value enables CCC and defines maximum time (in ms), request can wait
  66 for interrupt, if there are some more requests present on controller queue.
  67 CCC reduces number of context switches on systems with many parallel requests,
  68 but it can decrease disk performance on some workloads due to additional
  69 command latency.
  70 .It Va hint.ahcich. Ns Ar X Ns Va .pm_level
  71 controls SATA interface Power Management for the specified channel,
  72 allowing some power to be saved at the cost of additional command
  73 latency.
  74 Possible values:
  75 .Bl -tag -compact
  76 .It 0
  77 interface Power Management is disabled (default);
  78 .It 1
  79 device is allowed to initiate PM state change, host is passive;
  80 .It 2
  81 host initiates PARTIAL PM state transition every time port becomes idle;
  82 .It 3
  83 host initiates SLUMBER PM state transition every time port becomes idle.
  84 .It 4
  85 driver initiates PARTIAL PM state transition 1ms after port becomes idle;
  86 .It 5
  87 driver initiates SLUMBER PM state transition 125ms after port becomes idle.
  88 .El
  89 Some controllers, such as ICH8, do not implement modes 2 and 3 with NCQ used.
  90 Because of artificial entering latency, performance degradation in modes
  91 4 and 5 is much smaller then in modes 2 and 3.
  92 .Pp
  93 Note that interface Power Management is not compatible with
  94 device presence detection.
  95 A manual bus reset is needed on device hot-plug.
  96 .It Va hint.ahcich. Ns Ar X Ns Va .sata_rev
  97 setting to nonzero value limits maximum SATA revision (speed).
  98 Values 1, 2 and 3 are respectively 1.5, 3 and 6Gbps.
  99 .El
 100 .Sh DESCRIPTION
 101 This driver provides the
 102 .Xr CAM 4
 103 subsystem with native access to the
 104 .Tn SATA
 105 ports of AHCI-compatible controllers.
 106 Each SATA port found is represented to CAM as a separate bus with one
 107 target, or, if HBA supports Port Multipliers, 16 targets.
 108 Most of the bus-management details are handled by the SATA-specific
 109 transport of CAM.
 110 Connected ATA disks are handled by the ATA protocol disk peripheral driver
 111 .Xr ada 4 .
 112 ATAPI devices are handled by the SCSI protocol peripheral drivers
 113 .Xr cd 4 ,
 114 .Xr da 4 ,
 115 .Xr sa 4 ,
 116 etc.
 117 .Pp
 118 Driver features include support for Serial ATA and ATAPI devices,
 119 Port Multipliers (including FIS-based switching, when supported),
 120 hardware command queues (up to 32 commands per port),
 121 Native Command Queuing, SATA interface Power Management, device hot-plug
 122 and Message Signaled Interrupts.
 123 .Pp
 124 Driver supports "LED" enclosure management messages, defined by the AHCI.
 125 When supported by hardware, it allows to control per-port activity, locate
 126 and fault LEDs via the
 127 .Xr led 4
 128 API for localization and status reporting purposes.
 129 Supporting AHCI controllers may transmit that information to the backplane
 130 controllers via SGPIO interface. Backplane controllers interpret received
 131 statuses in some way (IBPI standard) to report them using present indicators.
 132 .Pp
 133 AHCI hardware is also supported by ataahci driver from
 134 .Xr ata 4
 135 subsystem.
 136 If both drivers are loaded at the same time, this one will be
 137 given precedence as the more functional of the two.
 138 .Sh HARDWARE
 139 The
 140 .Nm
 141 driver supports AHCI compatible controllers having PCI class 1 (mass storage),
 142 subclass 6 (SATA) and programming interface 1 (AHCI).
 143 .Pp
 144 Also, in cooperation with atamarvell and atajmicron drivers of ata(4),
 145 it supports AHCI part of legacy-PATA + AHCI-SATA combined controllers,
 146 such as JMicron JMB36x and Marvell 88SX61xx.
 147 .Sh FILES
 148 .Bl -tag -width /dev/led/ahcich*.locate
 149 .It Pa /dev/led/ahcich*.act
 150 activity LED device nodes
 151 .It Pa /dev/led/ahcich*.fault
 152 fault LED device nodes
 153 .It Pa /dev/led/ahcich*.locate
 154 locate LED device nodes
 155 .El
 156 .Sh SEE ALSO
 157 .Xr ada 4 ,
 158 .Xr ata 4 ,
 159 .Xr cam 4 ,
 160 .Xr cd 4 ,
 161 .Xr da 4 ,
 162 .Xr sa 4
 163 .Sh HISTORY
 164 The
 165 .Nm
 166 driver first appeared in
 167 .Fx 8.0 .
 168 .Sh AUTHORS
 169 .An Alexander Motin Aq mav@FreeBSD.org .