1.\" Copyright (c) 2011 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 October 3, 2012 28.Dt ATA 4 29.Os 30.Sh NAME 31.Nm ata 32.Nd generic ATA/SATA controller driver 33.Sh SYNOPSIS 34To compile this driver into the kernel, place the following lines in your 35kernel configuration file: 36.Bd -ragged -offset indent 37.Cd "device scbus" 38.Cd "device ata" 39.Cd "options ATA_CAM" 40.Ed 41.Pp 42Alternatively, to load the driver as set of modules at boot time, 43place some of the following lines in 44.Xr loader.conf 5 : 45.Bd -literal -offset indent 46ata_load="YES" 47 48atacard_load="YES" 49ataisa_load="YES" 50atapci_load="YES" 51 52ataacard_load="YES" 53ataacerlabs_load="YES" 54ataadaptec_load="YES" 55ataahci_load="YES" 56ataamd_load="YES" 57ataati_load="YES" 58atacenatek_load="YES" 59atacypress_load="YES" 60atacyrix_load="YES" 61atahighpoint_load="YES" 62ataintel_load="YES" 63ataite_load="YES" 64atajmicron_load="YES" 65atamarvell_load="YES" 66atamicron_load="YES" 67atanational_load="YES" 68atanetcell_load="YES" 69atanvidia_load="YES" 70atapromise_load="YES" 71ataserverworks_load="YES" 72atasiliconimage_load="YES" 73atasis_load="YES" 74atavia_load="YES" 75.Ed 76.Pp 77The first line is for the common hardware independent code, and is a 78prerequisite for the other modules. 79The next three lines are generic bus-specific drivers. 80Of the rest, ataahci is the AHCI driver. 81The others are vendor-specific PCI drivers. 82The 83.Dv ATA_CAM 84option should always remain in the kernel configuration, to make 85the driver work as a 86.Xr CAM 4 87subsystem module. 88.Pp 89The following tunables are settable from the 90.Xr loader 8 : 91.Bl -ohang 92.It Va hw.ahci.force 93set to nonzero value for forcing drivers to attach to some known AHCI-capable 94chips even if they are configured for legacy IDE emulation (the default is 1, 95force the attach). 96.It Va hw.ata.ata_dma_check_80pin 97set to 0 to disable the 80pin cable check (the default is 1, check the cable). 98.It Va hint.atapci.X.msi 99set to 1 to allow Message Signalled Interrupts (MSI) to be used by the 100specified PCI ATA controller, if supported. 101.It Va hint.ata.X.devX.mode 102limits the initial ATA mode for the specified device on the specified channel. 103.It Va hint.ata.X.mode 104limits the initial ATA mode for every device on the specified channel. 105.It Va hint.ata.X.pm_level 106controls SATA interface Power Management for the specified channel, 107allowing some power savings at the cost of additional command latency. 108Possible values: 109.Pp 110.Bl -tag -width 4n -offset indent -compact 111.It 0 112Interface Power Management is disabled. 113This is the default value. 114.It 1 115The device is allowed to initiate a PM state change; the host is passive. 116.It 2 117The host initiates a PARTIAL PM state transition every time a port becomes idle. 118.It 3 119host initiates SLUMBER PM state transition every time port becomes idle. 120.El 121.Pp 122Modes 2 and 3 are only supported for AHCI. 123.It Va hint.ata. Ns Ar X Ns Va .dev Ns Ar X Ns Va .sata_rev 124limits the initial SATA revision (speed) for the specified device 125on the specified channel. 126Values 1, 2 and 3 are respectively 1.5, 3 and 6Gbps. 127.It Va hint.ata. Ns Ar X Ns Va .sata_rev 128Same, but for every device on the specified channel. 129.El 130.Sh DESCRIPTION 131The 132.Nm 133driver gives the 134.Xr CAM 4 135subsystem access to the ATA (IDE) and SATA ports 136of many generic controllers. 137Depending on the controller, each PATA (IDE) 138port or each one or two SATA ports are 139represented to CAM as a separate bus with one or two targets. 140Most of the bus-management details are handled by the ATA/SATA-specific 141transport of CAM. 142Connected ATA disks are handled by the ATA protocol disk peripheral driver 143.Xr ada 4 . 144ATAPI devices are handled by the SCSI protocol peripheral drivers 145.Xr cd 4 , 146.Xr da 4 , 147.Xr sa 4 , 148etc. 149.Pp 150This driver supports ATA, and for the most of controllers, ATAPI devices. 151Command queuing and SATA port multipliers are not supported. 152Device hot-plug and SATA interface power management is supported only on 153some controllers. 154.Pp 155The 156.Nm 157driver can change the transfer mode when the system is up and running. 158See the 159.Cm negotiate 160subcommand of 161.Xr camcontrol 8 . 162.Pp 163The 164.Nm 165driver sets the maximum transfer mode supported by the hardware as default. 166However, the 167.Nm 168driver sometimes warns: 169.Dq Sy "DMA limited to UDMA33, non-ATA66 cable or device". 170This means that 171the 172.Nm 173driver has detected that the required 80 conductor cable is not present 174or could not be detected properly, 175or that one of the devices on the channel only accepts up 176to UDMA2/ATA33. 177The 178.Va hw.ata.ata_dma_check_80pin 179tunable can be set to 0 to disable this check. 180.Sh HARDWARE 181The currently supported ATA/SATA controller chips are: 182.Pp 183.Bl -tag -width "Silicon Image:" -compact 184.It Acard: 185ATP850P, ATP860A, ATP860R, ATP865A, ATP865R. 186.It ALI: 187M5228, M5229, M5281, M5283, M5287, M5288, M5289. 188.It AMD: 189AMD756, AMD766, AMD768, AMD8111, CS5536. 190.It ATI: 191IXP200, IXP300, IXP400, IXP600, IXP700, IXP800. 192.It CMD: 193CMD646, CMD646U2, CMD648, CMD649. 194.It Cypress: 195Cypress 82C693. 196.It Cyrix: 197Cyrix 5530. 198.It HighPoint: 199HPT302, HPT366, HPT368, HPT370, HPT371, HPT372, HPT372N, HPT374. 200.It Intel: 2016300ESB, 31244, PIIX, PIIX3, PIIX4, ESB2, ICH, ICH0, ICH2, ICH3, ICH4, ICH5, 202ICH6, ICH7, ICH8, ICH9, ICH10, SCH, PCH. 203.It ITE: 204IT8211F, IT8212F, IT8213F. 205.It JMicron: 206JMB360, JMB361, JMB363, JMB365, JMB366, JMB368. 207.It Marvell 20888SX5040, 88SX5041, 88SX5080, 88SX5081, 88SX6041, 88SX6042, 88SX6081, 88SE6101, 20988SE6102, 88SE6111, 88SE6121, 88SE6141, 88SE6145, 88SX7042. 210.It National: 211SC1100. 212.It NetCell: 213NC3000, NC5000. 214.It nVidia: 215nForce, nForce2, nForce2 MCP, nForce3, nForce3 MCP, nForce3 Pro, nForce4, 216MCP51, MCP55, MCP61, MCP65, MCP67, MCP73, MCP77, MCP79, MCP89. 217.It Promise: 218PDC20246, PDC20262, PDC20263, PDC20265, PDC20267, PDC20268, PDC20269, PDC20270, 219PDC20271, PDC20275, PDC20276, PDC20277, PDC20318, PDC20319, PDC20371, PDC20375, 220PDC20376, PDC20377, PDC20378, PDC20379, PDC20571, PDC20575, PDC20579, PDC20580, 221PDC20617, PDC20618, PDC20619, PDC20620, PDC20621, PDC20622, PDC40518, PDC40519, 222PDC40718, PDC40719. 223.It ServerWorks: 224HT1000, ROSB4, CSB5, CSB6, K2, Frodo4, Frodo8. 225.It Silicon Image: 226SiI0680, SiI3112, SiI3114, SiI3124, SiI3132, SiI3512. 227.It SiS: 228SIS180, SIS181, SIS182, SIS5513, SIS530, SIS540, SIS550, SIS620, SIS630, 229SIS630S, SIS633, SIS635, SIS730, SIS733, SIS735, SIS745, SIS961, SIS962, 230SIS963, SIS964, SIS965. 231.It VIA: 232VT6410, VT6420, VT6421, VT82C586, VT82C586B, VT82C596, VT82C596B, VT82C686, 233VT82C686A, VT82C686B, VT8231, VT8233, VT8233A, VT8233C, VT8235, VT8237, 234VT8237A, VT8237S, VT8251, CX700, VX800, VX855, VX900. 235.El 236.Pp 237Some of above chips are also supported by the more featured 238.Xr ahci 4 , 239.Xr mvs 4 , 240and 241.Xr siis 4 242drivers. 243If both drivers are loaded at the same time, those will have precedence. 244.Pp 245Unknown ATA chipsets are supported in PIO modes, and if the standard 246busmaster DMA registers are present and contain valid setup, DMA is 247also enabled, although the max mode is limited to UDMA33, as it is 248not known what the chipset can do and how to program it. 249.Sh NOTES 250Please remember that in order to use UDMA4/ATA66 and above modes you 251.Em must 252use 80 conductor cables. 253Please assure that ribbon cables are no longer than 45cm. 254In case of rounded ATA cables, the length depends on the 255quality of the cables. 256SATA cables can be up to 1m long according to the specification. 257External SATA cables can be 2m long and more, but not all controllers 258work well on long cables, especially at high speeds. 259.Sh SEE ALSO 260.Xr ada 4 , 261.Xr ahci 4 , 262.Xr cam 4 , 263.Xr camcontrol 8 , 264.Xr cd 4 , 265.Xr mvs 4 , 266.Xr siis 4 267.Sh HISTORY 268The 269.Nm 270driver first appeared in 271.Fx 4.0 . 272It was turned into a 273.Xr CAM 4 274interface module in 275.Fx 9.0 . 276.Sh AUTHORS 277.An Alexander Motin 278.Aq mav@FreeBSD.org , 279.An S\(/oren Schmidt 280.Aq sos@FreeBSD.org 281