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