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 .El
 103 .It Va hint.ata. Ns Ar X Ns Va .dev Ns Ar X Ns Va .sata_rev
 104 limits the initial SATA revision (speed) for the specified device
 105 on the specified channel.
 106 Values 1, 2 and 3 are respectively 1.5, 3 and 6Gbps.
 107 .It Va hint.ata. Ns Ar X Ns Va .sata_rev
 108 Same, but for every device on the specified channel.
 109 .El
 110 .Sh DESCRIPTION
 111 The
 112 .Nm
 113 driver gives the
 114 .Xr CAM 4
 115 subsystem access to the ATA (IDE) and SATA ports
 116 of many generic controllers.
 117 Depending on the controller, each PATA (IDE)
 118 port or each one or two SATA ports are
 119 represented to CAM as a separate bus with one or two targets.
 120 Most of the bus-management details are handled by the ATA/SATA-specific
 121 transport of CAM.
 122 Connected ATA disks are handled by the ATA protocol disk peripheral driver
 123 .Xr ada 4 .
 124 ATAPI devices are handled by the SCSI protocol peripheral drivers
 125 .Xr cd 4 ,
 126 .Xr da 4 ,
 127 .Xr sa 4 ,
 128 etc.
 129 .Pp
 130 This driver supports ATA, and for the most of controllers, ATAPI devices.
 131 Command queuing and SATA port multipliers are not supported.
 132 Device hot-plug and SATA interface power management is supported only on
 133 some controllers.
 134 .Pp
 135 The
 136 .Nm
 137 driver can change the transfer mode when the system is up and running.
 138 See the
 139 .Cm negotiate
 140 subcommand of
 141 .Xr camcontrol 8 .
 142 .Pp
 143 The
 144 .Nm
 145 driver sets the maximum transfer mode supported by the hardware as default.
 146 However, the
 147 .Nm
 148 driver sometimes warns:
 149 .Dq Sy "DMA limited to UDMA33, non-ATA66 cable or device".
 150 This means that
 151 the
 152 .Nm
 153 driver has detected that the required 80 conductor cable is not present
 154 or could not be detected properly,
 155 or that one of the devices on the channel only accepts up
 156 to UDMA2/ATA33.
 157 The
 158 .Va hw.ata.ata_dma_check_80pin
 159 tunable can be set to 0 to disable this check.
 160 .Sh HARDWARE
 161 The currently supported ATA/SATA controller chips are:
 162 .Pp
 163 .Bl -tag -width "Silicon Image:" -compact
 164 .It Acard:
 165 ATP850P, ATP860A, ATP860R, ATP865A, ATP865R.
 166 .It ALI:
 167 M5228, M5229, M5281, M5283, M5287, M5288, M5289.
 168 .It AMD:
 169 AMD756, AMD766, AMD768, AMD8111, CS5536.
 170 .It ATI:
 171 IXP200, IXP300, IXP400, IXP600, IXP700, IXP800.
 172 .It CMD:
 173 CMD646, CMD646U2, CMD648, CMD649.
 174 .It Cypress:
 175 Cypress 82C693.
 176 .It Cyrix:
 177 Cyrix 5530.
 178 .It HighPoint:
 179 HPT302, HPT366, HPT368, HPT370, HPT371, HPT372, HPT372N, HPT374.
 180 .It Intel:
 181 6300ESB, 31244, PIIX, PIIX3, PIIX4, ESB2, ICH, ICH0, ICH2, ICH3, ICH4, ICH5,
 182 ICH6, ICH7, ICH8, ICH9, ICH10, SCH, PCH.
 183 .It ITE:
 184 IT8211F, IT8212F, IT8213F.
 185 .It JMicron:
 186 JMB360, JMB361, JMB363, JMB365, JMB366, JMB368.
 187 .It Marvell
 188 88SE6101, 88SE6102, 88SE6111, 88SE6121, 88SE6141, 88SE6145.
 189 .It National:
 190 SC1100.
 191 .It NetCell:
 192 NC3000, NC5000.
 193 .It nVidia:
 194 nForce, nForce2, nForce2 MCP, nForce3, nForce3 MCP, nForce3 Pro, nForce4,
 195 MCP51, MCP55, MCP61, MCP65, MCP67, MCP73, MCP77, MCP79, MCP89.
 196 .It Promise:
 197 PDC20246, PDC20262, PDC20263, PDC20265, PDC20267, PDC20268, PDC20269, PDC20270,
 198 PDC20271, PDC20275, PDC20276, PDC20277, PDC20318, PDC20319, PDC20371, PDC20375,
 199 PDC20376, PDC20377, PDC20378, PDC20379, PDC20571, PDC20575, PDC20579, PDC20580,
 200 PDC20617, PDC20618, PDC20619, PDC20620, PDC20621, PDC20622, PDC40518, PDC40519,
 201 PDC40718, PDC40719.
 202 .It ServerWorks:
 203 HT1000, ROSB4, CSB5, CSB6, K2, Frodo4, Frodo8.
 204 .It Silicon Image:
 205 SiI0680, SiI3112, SiI3114, SiI3512.
 206 .It SiS:
 207 SIS180, SIS181, SIS182, SIS5513, SIS530, SIS540, SIS550, SIS620, SIS630,
 208 SIS630S, SIS633, SIS635, SIS730, SIS733, SIS735, SIS745, SIS961, SIS962,
 209 SIS963, SIS964, SIS965.
 210 .It VIA:
 211 VT6410, VT6420, VT6421, VT82C586, VT82C586B, VT82C596, VT82C596B, VT82C686,
 212 VT82C686A, VT82C686B, VT8231, VT8233, VT8233A, VT8233C, VT8235, VT8237,
 213 VT8237A, VT8237S, VT8251, CX700, VX800, VX855, VX900.
 214 .El
 215 .Pp
 216 Some of above chips can be configured for AHCI mode.
 217 In such case they are supported by
 218 .Xr ahci 4
 219 driver instead.
 220 .Pp
 221 Unknown ATA chipsets are supported in PIO modes, and if the standard
 222 busmaster DMA registers are present and contain valid setup, DMA is
 223 also enabled, although the max mode is limited to UDMA33, as it is
 224 not known what the chipset can do and how to program it.
 225 .Sh DEPRECATION NOTICE
 226 The PC Card attachment of this driver is scheduled for removal prior to the release of
 227 .Fx 13.0
 228 .Sh NOTES
 229 Please remember that in order to use UDMA4/ATA66 and above modes you
 230 .Em must
 231 use 80 conductor cables.
 232 Please assure that ribbon cables are no longer than 45cm.
 233 In case of rounded ATA cables, the length depends on the
 234 quality of the cables.
 235 SATA cables can be up to 1m long according to the specification.
 236 External SATA cables can be 2m long and more, but not all controllers
 237 work well on long cables, especially at high speeds.
 238 .Sh SEE ALSO
 239 .Xr ada 4 ,
 240 .Xr ahci 4 ,
 241 .Xr cam 4 ,
 242 .Xr cd 4 ,
 243 .Xr mvs 4 ,
 244 .Xr siis 4 ,
 245 .Xr camcontrol 8
 246 .Sh HISTORY
 247 The
 248 .Nm
 249 driver first appeared in
 250 .Fx 4.0 .
 251 It was turned into a
 252 .Xr CAM 4
 253 interface module in
 254 .Fx 9.0 .
 255 .Sh AUTHORS
 256 .An Alexander Motin Aq Mt mav@FreeBSD.org
 257 .An S\(/oren Schmidt Aq Mt sos@FreeBSD.org