share/man/man4/ahci.4

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