1 .\" Copyright (c) 2011 Alexander Motin <mav@FreeBSD.org>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
32 .Nd generic ATA/SATA controller driver
34 To compile this driver into the kernel, place the following lines in your
35 kernel configuration file:
36 .Bd -ragged -offset indent
42 Alternatively, to load the driver as set of modules at boot time,
43 place some of the following lines in
45 .Bd -literal -offset indent
53 ataacerlabs_load="YES"
61 atahighpoint_load="YES"
67 atanational_load="YES"
71 ataserverworks_load="YES"
72 atasiliconimage_load="YES"
77 The first line is for the common hardware independent code, and is a
78 prerequisite for the other modules.
79 The next three lines are generic bus-specific drivers.
80 Of the rest, ataahci is the AHCI driver.
81 The others are vendor-specific PCI drivers.
84 option should always remain in the kernel configuration, to make
89 The following tunables are settable from the
93 set to nonzero value for forcing drivers to attach to some known AHCI-capable
94 chips even if they are configured for legacy IDE emulation (the default is 1,
96 .It Va hw.ata.ata_dma_check_80pin
97 set to 0 to disable the 80pin cable check (the default is 1, check the cable).
98 .It Va hint.atapci.X.msi
99 set to 1 to allow Message Signalled Interrupts (MSI) to be used by the
100 specified PCI ATA controller, if supported.
101 .It Va hint.ata.X.devX.mode
102 limits the initial ATA mode for the specified device on specified the channel.
103 .It Va hint.ata.X.mode
104 limits the initial ATA mode for every device on the specified channel.
105 .It Va hint.ata.X.pm_level
106 controls SATA interface Power Management for the specified channel,
107 allowing some power savings at the cost of additional command latency.
110 .Bl -tag -width 4n -offset indent -compact
112 Interface Power Management is disabled.
113 This is the default value.
115 The device is allowed to initiate a PM state change; the host is passive.
117 The host initiates a PARTIAL PM state transition every time a port becomes idle.
119 host initiates SLUMBER PM state transition every time port becomes idle.
122 Modes 2 and 3 are only supported for AHCI.
129 subsystem access to the ATA (IDE) and SATA ports
130 of many generic controllers.
131 Depending on the controller, each PATA (IDE)
132 port or each one or two SATA ports are
133 represented to CAM as a separate bus with one or two targets.
134 Most of the bus-management details are handled by the ATA/SATA-specific
136 Connected ATA disks are handled by the ATA protocol disk peripheral driver
138 ATAPI devices are handled by the SCSI protocol peripheral drivers
144 This driver supports ATA, and for the most of controllers, ATAPI devices.
145 Command queuing and SATA port multipliers are not supported.
146 Device hot-plug and SATA interface power management is supported only on
151 driver can change the transfer mode when the system is up and running.
159 driver sets the maximum transfer mode supported by the hardware as default.
162 driver sometimes warns:
163 .Dq Sy "DMA limited to UDMA33, non-ATA66 cable or device".
167 driver has detected that the required 80 conductor cable is not present
168 or could not be detected properly,
169 or that one of the devices on the channel only accepts up
172 .Va hw.ata.ata_dma_check_80pin
173 tunable can be set to 0 to disable this check.
175 The currently supported ATA/SATA controller chips are:
177 .Bl -tag -width "Silicon Image:" -compact
179 ATP850P, ATP860A, ATP860R, ATP865A, ATP865R.
181 M5228, M5229, M5281, M5283, M5287, M5288, M5289.
183 AMD756, AMD766, AMD768, AMD8111, CS5536.
185 IXP200, IXP300, IXP400, IXP600, IXP700, IXP800.
187 CMD646, CMD646U2, CMD648, CMD649.
193 HPT302, HPT366, HPT368, HPT370, HPT371, HPT372, HPT372N, HPT374.
195 6300ESB, 31244, PIIX, PIIX3, PIIX4, ESB2, ICH, ICH0, ICH2, ICH3, ICH4, ICH5,
196 ICH6, ICH7, ICH8, ICH9, ICH10, SCH, PCH.
198 IT8211F, IT8212F, IT8213F.
200 JMB360, JMB361, JMB363, JMB365, JMB366, JMB368.
202 88SX5040, 88SX5041, 88SX5080, 88SX5081, 88SX6041, 88SX6042, 88SX6081, 88SE6101,
203 88SE6102, 88SE6111, 88SE6121, 88SE6141, 88SE6145, 88SX7042.
209 nForce, nForce2, nForce2 MCP, nForce3, nForce3 MCP, nForce3 Pro, nForce4,
210 MCP51, MCP55, MCP61, MCP65, MCP67, MCP73, MCP77, MCP79, MCP89.
212 PDC20246, PDC20262, PDC20263, PDC20265, PDC20267, PDC20268, PDC20269, PDC20270,
213 PDC20271, PDC20275, PDC20276, PDC20277, PDC20318, PDC20319, PDC20371, PDC20375,
214 PDC20376, PDC20377, PDC20378, PDC20379, PDC20571, PDC20575, PDC20579, PDC20580,
215 PDC20617, PDC20618, PDC20619, PDC20620, PDC20621, PDC20622, PDC40518, PDC40519,
218 HT1000, ROSB4, CSB5, CSB6, K2, Frodo4, Frodo8.
220 SiI0680, SiI3112, SiI3114, SiI3124, SiI3132, SiI3512.
222 SIS180, SIS181, SIS182, SIS5513, SIS530, SIS540, SIS550, SIS620, SIS630,
223 SIS630S, SIS633, SIS635, SIS730, SIS733, SIS735, SIS745, SIS961, SIS962,
224 SIS963, SIS964, SIS965.
226 VT6410, VT6420, VT6421, VT82C586, VT82C586B, VT82C596, VT82C596B, VT82C686,
227 VT82C686A, VT82C686B, VT8231, VT8233, VT8233A, VT8233C, VT8235, VT8237,
228 VT8237A, VT8237S, VT8251, CX700, VX800, VX855, VX900.
231 Some of above chips are also supported by the more featured
237 If both drivers are loaded at the same time, those will have precedence.
239 Unknown ATA chipsets are supported in PIO modes, and if the standard
240 busmaster DMA registers are present and contain valid setup, DMA is
241 also enabled, although the max mode is limited to UDMA33, as it is
242 not known what the chipset can do and how to program it.
244 Please remember that in order to use UDMA4/ATA66 and above modes you
246 use 80 conductor cables.
247 Please assure that ribbon cables are no longer than 45cm.
248 In case of rounded ATA cables, the length depends on the
249 quality of the cables.
250 SATA cables can be up to 1m long according to the specification.
251 External SATA cables can be 2m long and more, but not all controllers
252 work well on long cables, especially at high speeds.
264 driver first appeared in
272 .Aq mav@FreeBSD.org ,