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