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