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