share/man/man4/ata.4

   1 .\"
   2 .\" Copyright (c) 2003 Søren Schmidt <sos@FreeBSD.org>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer,
  10 .\"    without modification, immediately at the beginning of the file.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. The name of the author may not be used to endorse or promote products
  15 .\"    derived from this software without specific prior written permission.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd July 3, 2010
  31 .Dt ATA 4
  32 .Os
  33 .Sh NAME
  34 .Nm ata ,
  35 .Nm ar ,
  36 .Nm acd ,
  37 .Nm ad ,
  38 .Nm afd ,
  39 .Nm ast
  40 .Nd generic ATA/ATAPI disk controller driver
  41 .Sh SYNOPSIS
  42 For ISA based ATA/ATAPI support:
  43 .Cd device isa
  44 .Cd device ata
  45 .Pp
  46 In
  47 .Pa /boot/device.hints :
  48 .Cd hint.ata.0.at="isa"
  49 .Cd hint.ata.0.port="0x1f0"
  50 .Cd hint.ata.0.irq="14"
  51 .Cd hint.ata.1.at="isa"
  52 .Cd hint.ata.1.port="0x170"
  53 .Cd hint.ata.1.irq="15"
  54 .Pp
  55 For PC98 based ATA/ATAPI support:
  56 .Cd device isa
  57 .Cd device ata
  58 .Pp
  59 In
  60 .Pa /boot/device.hints :
  61 .Cd hint.atacbus.0.at="isa"
  62 .Cd hint.atacbus.0.port="0x640"
  63 .Cd hint.atacbus.0.irq="9"
  64 .Pp
  65 For PCI based ATA/ATAPI support:
  66 .Cd device pci
  67 .Cd device ata
  68 .Pp
  69 To support ATA compliant disk drives:
  70 .Cd device atadisk
  71 .Pp
  72 To support ATA software RAID's:
  73 .Cd device ataraid
  74 .Pp
  75 To support ATAPI CDROM, DVD and CD/DVD burner drives:
  76 .Cd device atapicd
  77 .Pp
  78 To support ATAPI floppy drives:
  79 .Cd device atapifd
  80 .Pp
  81 To support ATAPI tape drives:
  82 .Cd device atapist
  83 .Pp
  84 To turn
  85 .Xr ata 4
  86 subsystem controller drivers into cam(4) interface modules (disables all native
  87 .Xr ata 4
  88 APIs and periperal drivers):
  89 .Cd options ATA_CAM
  90 .Pp
  91 The following tunables are settable from the loader:
  92 .Bl -ohang
  93 .It Va hw.ata.ata_dma
  94 set to 1 for DMA access, 0 for PIO (default is DMA).
  95 .It Va hw.ata.ata_dma_check_80pin
  96 set to 0 to disable the 80pin cable check (default is 1, check the cable)
  97 .It Va hw.ata.atapi_dma
  98 set to 1 for DMA access, 0 for PIO (default is DMA).
  99 .It Va hw.ata.wc
 100 set to 1 to enable Write Caching, 0 to disable (default is enabled).
 101 .Em WARNING :
 102 can cause data loss on power failures and crashes.
 103 .It Va hint.atapci.X.msi
 104 set to 1 to allow Message Signalled Interrupts (MSI) to be used by
 105 specified PCI ATA controller, if supported.
 106 .It Va hint.ata.X.devX.mode
 107 limits initial ATA mode for specified device on specified channel.
 108 .It Va hint.ata.X.mode
 109 limits initial ATA mode for every device on specified channel.
 110 .It Va hint.ata.X.pm_level
 111 controls SATA interface Power Management for specified channel,
 112 allowing to save some power by the cost of additional command latency.
 113 Possible values:
 114 .Bl -tag -compact
 115 .It 0
 116 interface Power Management is disabled, default value.
 117 .It 1
 118 device is allowed to initiate PM state change, host is passive.
 119 .It 2
 120 host initiates PARTIAL PM state transition every time port becomes idle.
 121 .It 3
 122 host initiates SLUMBER PM state transition every time port becomes idle.
 123 .El
 124 Modes 2 and 3 are implemented only for AHCI driver now.
 125 .El
 126 .Sh DESCRIPTION
 127 The
 128 .Nm
 129 driver provides access to ATA (IDE) and SerialATA disk drives,
 130 ATAPI CDROM/DVD drives, ZIP/LS120 ATAPI drives and ATAPI tape drives
 131 connected to controllers according to the ATA/ATAPI standards.
 132 .Pp
 133 The currently supported ATA/SATA controller chips are:
 134 .Pp
 135 .Bl -tag -width "Silicon Image:" -compact
 136 .It Acard:
 137 ATP850P, ATP860A, ATP860R, ATP865A, ATP865R.
 138 .It ALI:
 139 M5228, M5229, M5281, M5283, M5287, M5288, M5289.
 140 .It AMD:
 141 AMD756, AMD766, AMD768, AMD8111, CS5536.
 142 .It ATI:
 143 IXP200, IXP300, IXP400, IXP600, IXP700, IXP800.
 144 .It CMD:
 145 CMD646, CMD646U2, CMD648, CMD649.
 146 .It Cypress:
 147 Cypress 82C693.
 148 .It Cyrix:
 149 Cyrix 5530.
 150 .It HighPoint:
 151 HPT302, HPT366, HPT368, HPT370, HPT371, HPT372, HPT372N, HPT374.
 152 .It Intel:
 153 6300ESB, 31244, PIIX, PIIX3, PIIX4, ESB2, ICH, ICH0, ICH2, ICH3, ICH4, ICH5,
 154 ICH6, ICH7, ICH8, ICH9, ICH10, SCH, PCH.
 155 .It ITE:
 156 IT8211F, IT8212F, IT8213F.
 157 .It JMicron:
 158 JMB360, JMB361, JMB363, JMB365, JMB366, JMB368.
 159 .It Marvell
 160 88SX5040, 88SX5041, 88SX5080, 88SX5081, 88SX6041, 88SX6042, 88SX6081, 88SX6101,
 161 88SX6102, 88SX6111, 88SX6121, 88SX6141, 88SX6145, 88SX7042.
 162 .It National:
 163 SC1100.
 164 .It NetCell:
 165 NC3000, NC5000.
 166 .It nVidia:
 167 nForce, nForce2, nForce2 MCP, nForce3, nForce3 MCP, nForce3 Pro, nForce4,
 168 MCP51, MCP55, MCP61, MCP65, MCP67, MCP73, MCP77, MCP79, MCP89.
 169 .It Promise:
 170 PDC20246, PDC20262, PDC20263, PDC20265, PDC20267, PDC20268, PDC20269, PDC20270,
 171 PDC20271, PDC20275, PDC20276, PDC20277, PDC20318, PDC20319, PDC20371, PDC20375,
 172 PDC20376, PDC20377, PDC20378, PDC20379, PDC20571, PDC20575, PDC20579, PDC20580,
 173 PDC20617, PDC20618, PDC20619, PDC20620, PDC20621, PDC20622, PDC40518, PDC40519,
 174 PDC40718, PDC40719.
 175 .It ServerWorks:
 176 HT1000, ROSB4, CSB5, CSB6, K2, Frodo4, Frodo8.
 177 .It Silicon Image:
 178 SiI0680, SiI3112, SiI3114, SiI3124, SiI3132, SiI3512.
 179 .It SiS:
 180 SIS180, SIS181, SIS182, SIS5513, SIS530, SIS540, SIS550, SIS620, SIS630,
 181 SIS630S, SIS633, SIS635, SIS730, SIS733, SIS735, SIS745, SIS961, SIS962,
 182 SIS963, SIS964, SIS965.
 183 .It VIA:
 184 VT6410, VT6420, VT6421, VT82C586, VT82C586B, VT82C596, VT82C596B, VT82C686,
 185 VT82C686A, VT82C686B, VT8231, VT8233, VT8233A, VT8233C, VT8235, VT8237,
 186 VT8237A, VT8237S, VT8251, CX700, VX800, VX855, VX900.
 187 .El
 188 .Pp
 189 Unknown ATA chipsets are supported in PIO modes, and if the standard
 190 busmaster DMA registers are present and contain valid setup, DMA is
 191 also enabled, although the max mode is limited to UDMA33, as it is
 192 not known what the chipset can do and how to program it.
 193 .Pp
 194 The
 195 .Nm
 196 driver can change the transfer mode and various other parameters
 197 when the system is up and running.
 198 See
 199 .Xr atacontrol 8 .
 200 .Pp
 201 The
 202 .Nm
 203 driver sets the maximum transfer mode supported by the hardware as default.
 204 However the
 205 .Nm
 206 driver sometimes warns:
 207 .Dq Sy "DMA limited to UDMA33, non-ATA66 cable or device".
 208 This means that
 209 the
 210 .Nm
 211 driver has detected that the required 80 conductor cable is not present
 212 or could not be detected properly,
 213 or that one of the devices on the channel only accepts up
 214 to UDMA2/ATA33.
 215 The
 216 .Va hw.ata.ata_dma_check_80pin
 217 tunable can be set to 0 to disable this check.
 218 .Pp
 219 Unknown ATAPI devices are initialized to DMA mode if the
 220 .Va hw.ata.atapi_dma
 221 tunable is set to 1 and they support at least UDMA33 transfers.
 222 Otherwise they are set to PIO mode because severe DMA problems are
 223 common even if the device capabilities indicate support.
 224 You can always try to set DMA mode on an ATAPI device using
 225 .Xr atacontrol 8 ,
 226 but be aware that your hardware might
 227 .Em not
 228 support it and can potentially
 229 .Em hang
 230 the entire system causing data loss.
 231 .Sh FILES
 232 .Bl -tag -width ".Pa /sys/i386/conf/GENERIC" -compact
 233 .It Pa /dev/ad*
 234 ATA disk device nodes
 235 .It Pa /dev/ar*
 236 ATA RAID device nodes
 237 .It Pa /dev/acd*
 238 ATAPI CD-ROM device nodes
 239 .It Pa /dev/afd*
 240 ATAPI floppy drive device nodes
 241 .It Pa /dev/ast*
 242 ATAPI tape drive device nodes
 243 .It Pa /sys/i386/conf/GENERIC
 244 sample generic kernel config file for
 245 .Nm
 246 based systems
 247 .El
 248 .Sh NOTES
 249 Please remember that in order to use UDMA4/ATA66 and above modes you
 250 .Em must
 251 use 80 conductor cables.
 252 Please assure that ribbon cables are no longer than 45cm.
 253 In case of rounded ATA cables, the length depends on the
 254 quality of the cables.
 255 SATA cables can be up to 1m long according to the specification.
 256 .Pp
 257 Static device numbering
 258 (enabled with the
 259 .Dv ATA_STATIC_ID
 260 kernel option)
 261 reserves a number for each possibly connected disk,
 262 even when not present.
 263 This is useful in hotswap scenarios
 264 where disks should always show up as the same numbered device,
 265 and not depend on attach order.
 266 .Pp
 267 Native Command Queuing (NCQ) on SATA drives is not yet supported.
 268 .Sh SEE ALSO
 269 .Xr ahci 4 ,
 270 .Xr cam 4 ,
 271 .Xr ataraid 4 ,
 272 .Xr atacontrol 8 ,
 273 .Xr burncd 8 ,
 274 .Xr siis 4
 275 .Sh HISTORY
 276 The
 277 .Nm
 278 driver first appeared in
 279 .Fx 4.0 .
 280 .Sh AUTHORS
 281 .An S\(/oren Schmidt
 282 .Aq sos@FreeBSD.org .