share/man/man4/ahci.4

   1 .\" Copyright (c) 2009-2013 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 August 21, 2019
  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;
  61 .It 2
  62 multiple MSI vectors used, if supported (default);
  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.ahci. Ns Ar X Ns Va .direct
  72 controls whether the driver should use direct command completion from
  73 interrupt thread(s), or queue them to CAM completion threads.
  74 Default value depends on number of MSI interrupts supported and number of
  75 implemented SATA ports.
  76 .It Va hint.ahcich. Ns Ar X Ns Va .pm_level
  77 controls SATA interface Power Management for the specified channel,
  78 allowing some power to be saved at the cost of additional command
  79 latency.
  80 Possible values:
  81 .Pp
  82 .Bl -tag -width 4n -offset indent -compact
  83 .It 0
  84 interface Power Management is disabled (default);
  85 .It 1
  86 device is allowed to initiate PM state change, host is passive;
  87 .It 2
  88 host initiates PARTIAL PM state transition every time port becomes idle;
  89 .It 3
  90 host initiates SLUMBER PM state transition every time port becomes idle.
  91 .It 4
  92 driver initiates PARTIAL PM state transition 1ms after port becomes idle;
  93 .It 5
  94 driver initiates SLUMBER PM state transition 125ms after port becomes idle.
  95 .El
  96 .Pp
  97 Some controllers, such as ICH8, do not implement modes 2 and 3 with NCQ used.
  98 Because of artificial entering latency, performance degradation in modes
  99 4 and 5 is much smaller then in modes 2 and 3.
 100 .Pp
 101 Note that interface Power Management complicates device presence detection.
 102 A manual bus reset/rescan may be needed after device hot-plug, unless hardware
 103 implements Cold Presence Detection.
 104 .It Va hint.ahcich. Ns Ar X Ns Va .sata_rev
 105 setting to nonzero value limits maximum SATA revision (speed).
 106 Values 1, 2 and 3 are respectively 1.5, 3 and 6Gbps.
 107 .It Va hw.ahci.force
 108 setting to nonzero value forces driver attach to some known AHCI-capable
 109 chips even if they are configured for legacy IDE emulation.
 110 Default is 1.
 111 .El
 112 .Sh DESCRIPTION
 113 This driver provides the
 114 .Xr CAM 4
 115 subsystem with native access to the
 116 .Tn SATA
 117 ports of AHCI-compatible controllers.
 118 Each SATA port found is represented to CAM as a separate bus with one
 119 target, or, if HBA supports Port Multipliers, 16 targets.
 120 Most of the bus-management details are handled by the SATA-specific
 121 transport of CAM.
 122 Connected ATA disks are handled by the ATA protocol disk peripheral driver
 123 .Xr ada 4 .
 124 ATAPI devices are handled by the SCSI protocol peripheral drivers
 125 .Xr cd 4 ,
 126 .Xr da 4 ,
 127 .Xr sa 4 ,
 128 etc.
 129 .Pp
 130 Driver features include support for Serial ATA and ATAPI devices,
 131 Port Multipliers (including FIS-based switching, when supported),
 132 hardware command queues (up to 32 commands per port),
 133 Native Command Queuing, SATA interface Power Management, device hot-plug
 134 and Message Signaled Interrupts.
 135 .Pp
 136 Driver supports "LED" enclosure management messages, defined by the AHCI.
 137 When supported by hardware, it allows to control per-port activity, locate
 138 and fault LEDs via the
 139 .Xr led 4
 140 API or emulated
 141 .Xr ses 4
 142 device for localization and status reporting purposes.
 143 Supporting AHCI controllers may transmit that information to the backplane
 144 controllers via SGPIO interface.
 145 Backplane controllers interpret received
 146 statuses in some way (IBPI standard) to report them using present indicators.
 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 .Pp
 157 The
 158 .Nm
 159 driver also supports AHCI devices that act as PCI bridges for
 160 .Xr nvme 4
 161 using Intel Rapid Storage Technology (RST).
 162 To use the
 163 .Xr nvme 4
 164 device, either one must set the SATA mode in the BIOS to AHCI (from RST),
 165 or one must accept the performance with RST enabled due to interrupt sharing.
 166 .Fx
 167 will automatically detect AHCI devices with this extension that are in RST
 168 mode.
 169 When that happens,
 170 .Nm
 171 will attach
 172 .Xr nvme 4
 173 children to the
 174 .Xr ahci 4
 175 device.
 176 .Sh FILES
 177 .Bl -tag -width /dev/led/ahcich*.locate
 178 .It Pa /dev/led/ahci*.*.act
 179 activity LED device nodes
 180 .It Pa /dev/led/ahci*.*.fault
 181 fault LED device nodes
 182 .It Pa /dev/led/ahci*.*.locate
 183 locate LED device nodes
 184 .El
 185 .Sh SYSCTL
 186 .Bl -tag
 187 .It Pa dev.ahcich.X.disable_phy
 188 Set to 1 to disable the phy for the drive on channel X.
 189 Set to 0 to enable the phy.
 190 Useful for turning off troublemakers.
 191 Also useful for debugging when you need the ada drive to come and go.
 192 .El
 193 .Sh SEE ALSO
 194 .Xr ada 4 ,
 195 .Xr ata 4 ,
 196 .Xr cam 4 ,
 197 .Xr cd 4 ,
 198 .Xr da 4 ,
 199 .Xr sa 4 ,
 200 .Xr ses 4
 201 .Sh HISTORY
 202 The
 203 .Nm
 204 driver first appeared in
 205 .Fx 8.0 .
 206 .Sh AUTHORS
 207 .An Alexander Motin Aq Mt mav@FreeBSD.org