133 lines
4.5 KiB
Groff
133 lines
4.5 KiB
Groff
|
.\" Copyright (c) 2009 Alexander Motin <mav@FreeBSD.org>
|
||
|
|
.\" All rights reserved.
|
||
|
|
.\"
|
||
|
|
.\" Redistribution and use in source and binary forms, with or without
|
||
|
|
.\" modification, are permitted provided that the following conditions
|
||
|
|
.\" are met:
|
||
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
||
|
|
.\" notice, this list of conditions and the following disclaimer.
|
||
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
||
|
|
.\" documentation and/or other materials provided with the distribution.
|
||
|
|
.\" 3. The name of the author may not be used to endorse or promote products
|
||
|
|
.\" derived from this software without specific prior written permission.
|
||
|
|
.\"
|
||
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
||
|
|
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||
|
|
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
||
|
|
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
||
|
|
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
||
|
|
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||
|
|
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||
|
|
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||
|
|
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
||
|
|
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
|
.\"
|
||
|
|
.\" $FreeBSD$
|
||
|
|
.\"
|
||
|
|
.Dd June 26, 2009
|
||
|
|
.Dt AHCI 4
|
||
|
|
.Os
|
||
|
|
.Sh NAME
|
||
|
|
.Nm ahci
|
||
|
|
.Nd Serial ATA Advanced Host Controller Interface driver
|
||
|
|
.Sh SYNOPSIS
|
||
|
|
To compile this driver into the kernel,
|
||
|
|
place the following lines in your
|
||
|
|
kernel configuration file:
|
||
|
|
.Bd -ragged -offset indent
|
||
|
|
.Cd "device pci"
|
||
|
|
.Cd "device scbus"
|
||
|
|
.Cd "device ahci"
|
||
|
|
.Ed
|
||
|
|
.Pp
|
||
|
|
Alternatively, to load the driver as a
|
||
|
|
module at boot time, place the following line in
|
||
|
|
.Xr loader.conf 5 :
|
||
|
|
.Bd -literal -offset indent
|
||
|
|
ahci_load="YES"
|
||
|
|
.Ed
|
||
|
|
.Pp
|
||
|
|
The following tunables are settable from the loader:
|
||
|
|
.Bl -ohang
|
||
|
|
.It Va hint.ahci.X.msi
|
||
|
|
controls Message Signaled Interrupts (MSI) usage by the specified controller
|
||
|
|
.Bl -tag -compact
|
||
|
|
.It 0
|
||
|
|
MSI disabled;
|
||
|
|
.It 1
|
||
|
|
single MSI vector used, if supported (default);
|
||
|
|
.It 2
|
||
|
|
multiple MSI vectors used, if supported;
|
||
|
|
.El
|
||
|
|
.It Va hint.ahcich.X.pm_level
|
||
|
|
controls SATA interface Power Management for specified channel,
|
||
|
|
allowing some power to be saved at the cost of additional command
|
||
|
|
latency.
|
||
|
|
Possible values:
|
||
|
|
.Bl -tag -compact
|
||
|
|
.It 0
|
||
|
|
interface Power Management is disabled (default);
|
||
|
|
.It 1
|
||
|
|
device is allowed to initiate PM state change, host is passive;
|
||
|
|
.It 2
|
||
|
|
host initiates PARTIAL PM state transition every time port becomes idle;
|
||
|
|
.It 3
|
||
|
|
host initiates SLUMBER PM state transition every time port becomes idle.
|
||
|
|
.El
|
||
|
|
Note that interface Power Management is not compatible with
|
||
|
|
device presence detection.
|
||
|
|
You will have to reset bus manually on device hot-plug.
|
||
|
|
.It Va hint.ahcich.X.sata_rev
|
||
|
|
setting to nonzero value limits maximum SATA revision (speed).
|
||
|
|
Values 1, 2 and 3 are respectively 1.5, 3 and 6Gbps.
|
||
|
|
.El
|
||
|
|
.Sh DESCRIPTION
|
||
|
|
This driver provides the CAM subsystem with native access to the
|
||
|
|
.Tn SATA
|
||
|
|
ports of AHCI-compatible controllers.
|
||
|
|
Each SATA port found is represented to CAM as a separate bus with one
|
||
|
|
target, or, if HBA supports Port Multipliers, 15 targets.
|
||
|
|
Most of the bus-management details are handled by the SATA-specific
|
||
|
|
transport of CAM.
|
||
|
|
Connected ATA disks are handled by the ATA protocol disk peripheral driver
|
||
|
|
.Xr ada 4 .
|
||
|
|
ATAPI devices are handled by the SCSI protocol peripheral drivers
|
||
|
|
.Xr cd 4 ,
|
||
|
|
.Xr da 4 ,
|
||
|
|
.Xr sa 4 ,
|
||
|
|
etc.
|
||
|
|
.Pp
|
||
|
|
Driver features include support for Serial ATA and ATAPI devices,
|
||
|
|
Port Multipliers, hardware command queues (up to 32 commands per port),
|
||
|
|
Native Command Queuing, SATA interface Power Management, device hot-plug
|
||
|
|
and Message Signaled Interrupts.
|
||
|
|
.Pp
|
||
|
|
The Port Multiplier FIS Based Switching feature added in the AHCI 1.2
|
||
|
|
specification, which is required for effective parallel operation of devices
|
||
|
|
behind Port Multipliers, is not yet supported.
|
||
|
|
.Pp
|
||
|
|
AHCI hardware is also supported by ataahci driver from
|
||
|
|
.Xr ata 4
|
||
|
|
subsystem. If both drivers are loaded at the same time, this one will be
|
||
|
|
given precedence as the more functional of the two.
|
||
|
|
.Sh HARDWARE
|
||
|
|
The
|
||
|
|
.Nm
|
||
|
|
driver supports AHCI compatible controllers having PCI class 1 (mass storage),
|
||
|
|
subclass 6 (SATA) and programming interface 1 (AHCI).
|
||
|
|
.Sh SEE ALSO
|
||
|
|
.Xr ada 4 ,
|
||
|
|
.Xr cd 4 ,
|
||
|
|
.Xr da 4 ,
|
||
|
|
.Xr sa 4 ,
|
||
|
|
.Xr scsi 4 ,
|
||
|
|
.Xr ata 4
|
||
|
|
.Sh HISTORY
|
||
|
|
The
|
||
|
|
.Nm
|
||
|
|
driver first appeared in
|
||
|
|
.Fx 8.0 .
|
||
|
|
.Sh AUTHORS
|
||
|
|
.An Alexander Motin Aq mav@FreeBSD.org .
|