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