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 June 18, 2012
  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.ahci.force
  94 set to nonzero value for forcing drivers to attach to some known AHCI-capable
  95 chips even if they are configured for legacy IDE emulation (the default is 1,
  96 force the attach).
  97 .It Va hw.ata.ata_dma
  98 set to 1 for DMA access, 0 for PIO (default is DMA).
  99 .It Va hw.ata.ata_dma_check_80pin
 100 set to 0 to disable the 80pin cable check (default is 1, check the cable).
 101 .It Va hw.ata.atapi_dma
 102 set to 1 for DMA access, 0 for PIO (default is DMA).
 103 .It Va hw.ata.wc
 104 set to 1 to enable Write Caching, 0 to disable (default is enabled).
 105 .Em WARNING :
 106 can cause data loss on power failures and crashes.
 107 .It Va hint.atapci.X.msi
 108 set to 1 to allow Message Signalled Interrupts (MSI) to be used by
 109 specified PCI ATA controller, if supported.
 110 .It Va hint.ata.X.devX.mode
 111 limits initial ATA mode for specified device on specified channel.
 112 .It Va hint.ata.X.mode
 113 limits initial ATA mode for every device on specified channel.
 114 .It Va hint.ata.X.pm_level
 115 controls SATA interface Power Management for specified channel,
 116 allowing to save some power by the cost of additional command latency.
 117 Possible values:
 118 .Bl -tag -compact
 119 .It 0
 120 interface Power Management is disabled, default value.
 121 .It 1
 122 device is allowed to initiate PM state change, host is passive.
 123 .It 2
 124 host initiates PARTIAL PM state transition every time port becomes idle.
 125 .It 3
 126 host initiates SLUMBER PM state transition every time port becomes idle.
 127 .El
 128 Modes 2 and 3 are implemented only for AHCI driver now.
 129 .El
 130 .Sh DESCRIPTION
 131 The
 132 .Nm
 133 driver provides access to ATA (IDE) and SerialATA disk drives,
 134 ATAPI CDROM/DVD drives, ZIP/LS120 ATAPI drives and ATAPI tape drives
 135 connected to controllers according to the ATA/ATAPI standards.
 136 .Pp
 137 The currently supported ATA/SATA controller chips are:
 138 .Pp
 139 .Bl -tag -width "Silicon Image:" -compact
 140 .It Acard:
 141 ATP850P, ATP860A, ATP860R, ATP865A, ATP865R.
 142 .It ALI:
 143 M5228, M5229, M5281, M5283, M5287, M5288, M5289.
 144 .It AMD:
 145 AMD756, AMD766, AMD768, AMD8111, CS5536.
 146 .It ATI:
 147 IXP200, IXP300, IXP400, IXP600, IXP700, IXP800.
 148 .It CMD:
 149 CMD646, CMD646U2, CMD648, CMD649.
 150 .It Cypress:
 151 Cypress 82C693.
 152 .It Cyrix:
 153 Cyrix 5530.
 154 .It HighPoint:
 155 HPT302, HPT366, HPT368, HPT370, HPT371, HPT372, HPT372N, HPT374.
 156 .It Intel:
 157 6300ESB, 31244, PIIX, PIIX3, PIIX4, ESB2, ICH, ICH0, ICH2, ICH3, ICH4, ICH5,
 158 ICH6, ICH7, ICH8, ICH9, ICH10, SCH, PCH.
 159 .It ITE:
 160 IT8211F, IT8212F, IT8213F.
 161 .It JMicron:
 162 JMB360, JMB361, JMB363, JMB365, JMB366, JMB368.
 163 .It Marvell
 164 88SX5040, 88SX5041, 88SX5080, 88SX5081, 88SX6041, 88SX6042, 88SX6081, 88SX6101,
 165 88SX6102, 88SX6111, 88SX6121, 88SX6141, 88SX6145, 88SX7042.
 166 .It National:
 167 SC1100.
 168 .It NetCell:
 169 NC3000, NC5000.
 170 .It nVidia:
 171 nForce, nForce2, nForce2 MCP, nForce3, nForce3 MCP, nForce3 Pro, nForce4,
 172 MCP51, MCP55, MCP61, MCP65, MCP67, MCP73, MCP77, MCP79, MCP89.
 173 .It Promise:
 174 PDC20246, PDC20262, PDC20263, PDC20265, PDC20267, PDC20268, PDC20269, PDC20270,
 175 PDC20271, PDC20275, PDC20276, PDC20277, PDC20318, PDC20319, PDC20371, PDC20375,
 176 PDC20376, PDC20377, PDC20378, PDC20379, PDC20571, PDC20575, PDC20579, PDC20580,
 177 PDC20617, PDC20618, PDC20619, PDC20620, PDC20621, PDC20622, PDC40518, PDC40519,
 178 PDC40718, PDC40719.
 179 .It ServerWorks:
 180 HT1000, ROSB4, CSB5, CSB6, K2, Frodo4, Frodo8.
 181 .It Silicon Image:
 182 SiI0680, SiI3112, SiI3114, SiI3124, SiI3132, SiI3512.
 183 .It SiS:
 184 SIS180, SIS181, SIS182, SIS5513, SIS530, SIS540, SIS550, SIS620, SIS630,
 185 SIS630S, SIS633, SIS635, SIS730, SIS733, SIS735, SIS745, SIS961, SIS962,
 186 SIS963, SIS964, SIS965.
 187 .It VIA:
 188 VT6410, VT6420, VT6421, VT82C586, VT82C586B, VT82C596, VT82C596B, VT82C686,
 189 VT82C686A, VT82C686B, VT8231, VT8233, VT8233A, VT8233C, VT8235, VT8237,
 190 VT8237A, VT8237S, VT8251, CX700, VX800, VX855, VX900.
 191 .El
 192 .Pp
 193 Unknown ATA chipsets are supported in PIO modes, and if the standard
 194 busmaster DMA registers are present and contain valid setup, DMA is
 195 also enabled, although the max mode is limited to UDMA33, as it is
 196 not known what the chipset can do and how to program it.
 197 .Pp
 198 The
 199 .Nm
 200 driver can change the transfer mode and various other parameters
 201 when the system is up and running.
 202 See
 203 .Xr atacontrol 8 .
 204 .Pp
 205 The
 206 .Nm
 207 driver sets the maximum transfer mode supported by the hardware as default.
 208 However the
 209 .Nm
 210 driver sometimes warns:
 211 .Dq Sy "DMA limited to UDMA33, non-ATA66 cable or device".
 212 This means that
 213 the
 214 .Nm
 215 driver has detected that the required 80 conductor cable is not present
 216 or could not be detected properly,
 217 or that one of the devices on the channel only accepts up
 218 to UDMA2/ATA33.
 219 The
 220 .Va hw.ata.ata_dma_check_80pin
 221 tunable can be set to 0 to disable this check.
 222 .Pp
 223 Unknown ATAPI devices are initialized to DMA mode if the
 224 .Va hw.ata.atapi_dma
 225 tunable is set to 1 and they support at least UDMA33 transfers.
 226 Otherwise they are set to PIO mode because severe DMA problems are
 227 common even if the device capabilities indicate support.
 228 You can always try to set DMA mode on an ATAPI device using
 229 .Xr atacontrol 8 ,
 230 but be aware that your hardware might
 231 .Em not
 232 support it and can potentially
 233 .Em hang
 234 the entire system causing data loss.
 235 .Sh FILES
 236 .Bl -tag -width ".Pa /sys/i386/conf/GENERIC" -compact
 237 .It Pa /dev/ad*
 238 ATA disk device nodes
 239 .It Pa /dev/ar*
 240 ATA RAID device nodes
 241 .It Pa /dev/acd*
 242 ATAPI CD-ROM device nodes
 243 .It Pa /dev/afd*
 244 ATAPI floppy drive device nodes
 245 .It Pa /dev/ast*
 246 ATAPI tape drive device nodes
 247 .It Pa /sys/i386/conf/GENERIC
 248 sample generic kernel config file for
 249 .Nm
 250 based systems
 251 .El
 252 .Sh NOTES
 253 Please remember that in order to use UDMA4/ATA66 and above modes you
 254 .Em must
 255 use 80 conductor cables.
 256 Please assure that ribbon cables are no longer than 45cm.
 257 In case of rounded ATA cables, the length depends on the
 258 quality of the cables.
 259 SATA cables can be up to 1m long according to the specification.
 260 .Pp
 261 Static device numbering
 262 (enabled with the
 263 .Dv ATA_STATIC_ID
 264 kernel option)
 265 reserves a number for each possibly connected disk,
 266 even when not present.
 267 This is useful in hotswap scenarios
 268 where disks should always show up as the same numbered device,
 269 and not depend on attach order.
 270 .Pp
 271 Native Command Queuing (NCQ) on SATA drives is not yet supported.
 272 .Sh SEE ALSO
 273 .Xr ahci 4 ,
 274 .Xr cam 4 ,
 275 .Xr ataraid 4 ,
 276 .Xr atacontrol 8 ,
 277 .Xr burncd 8 ,
 278 .Xr siis 4
 279 .Sh HISTORY
 280 The
 281 .Nm
 282 driver first appeared in
 283 .Fx 4.0 .
 284 .Sh AUTHORS
 285 .An S\(/oren Schmidt
 286 .Aq sos@FreeBSD.org .