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 August 18, 2008
  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 The following tunables are settable from the loader:
  85 .Bl -ohang
  86 .It Va hw.ata.ata_dma
  87 set to 1 for DMA access, 0 for PIO (default is DMA).
  88 .It Va hw.ata.ata_dma_check_80pin
  89 set to 0 to disable the 80pin cable check (default is 1, check the cable)
  90 .It Va hw.ata.atapi_dma
  91 set to 1 for DMA access, 0 for PIO (default is DMA).
  92 .It Va hw.ata.wc
  93 set to 1 to enable Write Caching, 0 to disable (default is enabled).
  94 .Em WARNING :
  95 can cause data loss on power failures and crashes.
  96 .El
  97 .Sh DESCRIPTION
  98 The
  99 .Nm
 100 driver provides access to ATA (IDE) and SerialATA disk drives,
 101 ATAPI CDROM/DVD drives, ZIP/LS120 ATAPI drives and ATAPI tape drives
 102 connected to controllers according to the ATA/ATAPI standards.
 103 .Pp
 104 The currently supported ATA/SATA controller chips are:
 105 .Pp
 106 .Bl -tag -width "Silicon Image:" -compact
 107 .It Acard:
 108 ATP850P, ATP860A, ATP860R, ATP865A, ATP865R.
 109 .It ALI:
 110 M5229, M5281, M5287, M5288, M5289.
 111 .It AMD:
 112 AMD756, AMD766, AMD768, AMD8111, CS5536.
 113 .It ATI:
 114 IXP200, IXP300, IXP400.
 115 .It CMD:
 116 CMD646, CMD646U2, CMD648, CMD649.
 117 .It Cypress:
 118 Cypress 82C693.
 119 .It Cyrix:
 120 Cyrix 5530.
 121 .It HighPoint:
 122 HPT302, HPT366, HPT368, HPT370, HPT371, HPT372, HPT372N, HPT374.
 123 .It Intel:
 124 6300ESB, 31244, PIIX, PIIX3, PIIX4, ESB2, ICH, ICH0, ICH2, ICH3, ICH4, ICH5, ICH6, ICH7, ICH8, ICH9.
 125 .It ITE:
 126 IT8211F, IT8212F.
 127 .It JMicron:
 128 JMB360, JMB361, JMB363, JMB365, JMB366, JMB368.
 129 .It Marvell
 130 88SX5040, 88SX5041, 88SX5080, 88SX5081, 88SX6041, 88SX6081, 88SX6101, 88SX6141.
 131 .It National:
 132 SC1100.
 133 .It NetCell:
 134 NC3000, NC5000.
 135 .It nVidia:
 136 nForce, nForce2, nForce2 MCP, nForce3, nForce3 MCP, nForce3 Pro, nForce4.
 137 .It Promise:
 138 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.
 139 .It ServerWorks:
 140 HT1000, ROSB4, CSB5, CSB6, K2, Frodo4, Frodo8.
 141 .It Silicon Image:
 142 SiI0680, SiI3112, SiI3114, SiI3124, SiI3132, SiI3512.
 143 .It SiS:
 144 SIS180, SIS181, SIS182, SIS5513, SIS530, SIS540, SIS550, SIS620, SIS630, SIS630S, SIS633, SIS635, SIS730, SIS733, SIS735, SIS745, SIS961, SIS962, SIS963, SIS964, SIS965.
 145 .It VIA:
 146 VT6410, VT6420, VT6421, VT82C586, VT82C586B, VT82C596, VT82C596B, VT82C686, VT82C686A, VT82C686B, VT8231, VT8233, VT8233A, VT8233C, VT8235, VT8237, VT8237A, VT8237S, VT8251.
 147 .El
 148 .Pp
 149 Unknown ATA chipsets are supported in PIO modes, and if the standard
 150 busmaster DMA registers are present and contain valid setup, DMA is
 151 also enabled, although the max mode is limited to UDMA33, as it is
 152 not known what the chipset can do and how to program it.
 153 .Pp
 154 The
 155 .Nm
 156 driver can change the transfer mode and various other parameters
 157 when the system is up and running.
 158 See
 159 .Xr atacontrol 8 .
 160 .Pp
 161 The
 162 .Nm
 163 driver sets the maximum transfer mode supported by the hardware as default.
 164 However the
 165 .Nm
 166 driver sometimes warns:
 167 .Dq Sy "DMA limited to UDMA33, non-ATA66 cable or device".
 168 This means that
 169 the
 170 .Nm
 171 driver has detected that the required 80 conductor cable is not present
 172 or could not be detected properly,
 173 or that one of the devices on the channel only accepts up
 174 to UDMA2/ATA33. The
 175 .Va hw.ata.ata_dma_check_80pin
 176 tunable can be set to 0 to disable this check.
 177 .Pp
 178 Unknown ATAPI devices are initialized to DMA mode if the
 179 .Va hw.ata.atapi_dma
 180 tunable is set to 1 and they support at least UDMA33 transfers.
 181 Otherwise they are set to PIO mode because severe DMA problems are
 182 common even if the device capabilities indicate support.
 183 You can always try to set DMA mode on an ATAPI device using
 184 .Xr atacontrol 8 ,
 185 but be aware that your hardware might
 186 .Em not
 187 support it and can potentially
 188 .Em hang
 189 the entire system causing data loss.
 190 .Sh FILES
 191 .Bl -tag -width ".Pa /sys/i386/conf/GENERIC" -compact
 192 .It Pa /dev/ad*
 193 ATA disk device nodes
 194 .It Pa /dev/ar*
 195 ATA RAID device nodes
 196 .It Pa /dev/acd*
 197 ATAPI CD-ROM device nodes
 198 .It Pa /dev/afd*
 199 ATAPI floppy drive device nodes
 200 .It Pa /dev/ast*
 201 ATAPI tape drive device nodes
 202 .It Pa /sys/i386/conf/GENERIC
 203 sample generic kernel config file for
 204 .Nm
 205 based systems
 206 .El
 207 .Sh NOTES
 208 Please remember that in order to use UDMA4/ATA66 and above modes you
 209 .Em must
 210 use 80 conductor cables.
 211 Please assure that ribbon cables are no longer than 45cm.
 212 In case of rounded ATA cables, the length depends on the
 213 quality of the cables.
 214 SATA cables can be up to 1m long according to the specification.
 215 .Pp
 216 Static device numbering
 217 (enabled with the
 218 .Dv ATA_STATIC_ID
 219 kernel option)
 220 reserves a number for each possibly connected disk,
 221 even when not present.
 222 This is useful in hotswap scenarios
 223 where disks should always show up as the same numbered device,
 224 and not depend on attach order.
 225 .Pp
 226 Native Command Queuing (NCQ) on SATA drives is not yet supported.
 227 .Sh SEE ALSO
 228 .Xr ataraid 4 ,
 229 .Xr atacontrol 8 ,
 230 .Xr burncd 8
 231 .Sh HISTORY
 232 The
 233 .Nm
 234 driver first appeared in
 235 .Fx 4.0 .
 236 .Sh AUTHORS
 237 .An S\(/oren Schmidt
 238 .Aq sos@FreeBSD.org .