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