share/man/man4/ata.4

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