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 August 24, 2009
  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 loader:
  52 .Bl -ohang
  53 .It Va hint.ahci.X.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.X.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.X.pm_level
  71 controls SATA interface Power Management for 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 You will have to reset bus manually on device hot-plug.
  96 .It Va hint.ahcich.X.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 CAM subsystem with native access to the
 102 .Tn SATA
 103 ports of AHCI-compatible controllers.
 104 Each SATA port found is represented to CAM as a separate bus with one
 105 target, or, if HBA supports Port Multipliers, 16 targets.
 106 Most of the bus-management details are handled by the SATA-specific
 107 transport of CAM.
 108 Connected ATA disks are handled by the ATA protocol disk peripheral driver
 109 .Xr ada 4 .
 110 ATAPI devices are handled by the SCSI protocol peripheral drivers
 111 .Xr cd 4 ,
 112 .Xr da 4 ,
 113 .Xr sa 4 ,
 114 etc.
 115 .Pp
 116 Driver features include support for Serial ATA and ATAPI devices,
 117 Port Multipliers, hardware command queues (up to 32 commands per port),
 118 Native Command Queuing, SATA interface Power Management, device hot-plug
 119 and Message Signaled Interrupts.
 120 .Pp
 121 The Port Multiplier FIS Based Switching feature added in the AHCI 1.2
 122 specification, which is required for effective parallel operation of devices
 123 behind Port Multipliers, is not yet supported.
 124 .Pp
 125 AHCI hardware is also supported by ataahci driver from
 126 .Xr ata 4
 127 subsystem. If both drivers are loaded at the same time, this one will be
 128 given precedence as the more functional of the two.
 129 .Sh HARDWARE
 130 The
 131 .Nm
 132 driver supports AHCI compatible controllers having PCI class 1 (mass storage),
 133 subclass 6 (SATA) and programming interface 1 (AHCI).
 134 .Sh SEE ALSO
 135 .Xr ada 4 ,
 136 .Xr cd 4 ,
 137 .Xr da 4 ,
 138 .Xr sa 4 ,
 139 .Xr scsi 4 ,
 140 .Xr ata 4
 141 .Sh HISTORY
 142 The
 143 .Nm
 144 driver first appeared in
 145 .Fx 8.0 .
 146 .Sh AUTHORS
 147 .An Alexander Motin Aq mav@FreeBSD.org .