Add re(4) to the list of manpages. Update the list of NICs supporting
[dragonfly.git] / share / man / man4 / ata.4
1 .\"
2 .\" Copyright (c) 2000 Jeroen Ruigrok van der Werven
3 .\" Copyright (c) 2000,2001,2002 Søren Schmidt
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
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 .\"
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 .\" SUCH DAMAGE.
26 .\"
27 .\" $FreeBSD: src/share/man/man4/ata.4,v 1.3.2.18 2002/10/16 13:40:51 fjoe Exp $
28 .\" $DragonFly: src/share/man/man4/ata.4,v 1.2 2003/06/17 04:36:58 dillon Exp $
29 .\"
30 .Dd January 27, 2000
31 .Dt ATA 4
32 .Os
33 .Sh NAME
34 .Nm ata ,
35 .Nm acd ,
36 .Nm ad ,
37 .Nm afd ,
38 .Nm ast
39 .Nd generic ATA/ATAPI disk controller driver
40 .Sh SYNOPSIS
41 For ISA based ATA/ATAPI support:
42 .Cd device isa
43 .Cd device ata0 at isa? port IO_WD1 irq 14
44 .Cd device ata1 at isa? port IO_WD2 irq 15
45 .Pp
46 For PCI based ATA/ATAPI support:
47 .Cd device pci
48 .Cd device ata
49 .Pp
50 To support ATA compliant disk drives:
51 .Cd device atadisk
52 .Pp
53 To support ATAPI CD-ROM, CDR, CDRW, DVD-ROM and DVD-RAM drives:
54 .Cd device atapicd
55 .Pp
56 To support ATAPI floppy drives,
57 such as the ZIP and LS120:
58 .Cd device atapifd
59 .Pp
60 To support ATAPI tape drives:
61 .Cd device atapist
62 .Pp
63 The following tunables are setable from the loader:
64 .Bl -ohang
65 .It Va hw.ata.ata_dma
66 set to 1 for DMA access, 0 for PIO (default is DMA).
67 .It Va hw.ata.atapi_dma
68 set to 1 for DMA access, 0 for PIO (default is PIO).
69 .It Va hw.ata.wc
70 set to 1 to enable Write Caching, 0 to disable (default is enabled).
71 (WARNING: might cause data loss on power failures.)
72 .It Va hw.ata.tags
73 set to 1 to enable Tagged Queuing support, 0 to disable (default is disabled).
74 (Only IBM DPTA, DTLA, ICxxxxxxAT, ICxxxxxxAV drives support that.)
75 .El
76 .Sh DESCRIPTION
77 This driver provides access to disk drives, ATAPI CD-ROM and DVD drives,
78 ZIP drives and tape streamers connected to controllers
79 according to the ATA and ATAPI standards.
80 These devices are also commonly known as IDE or EIDE devices.
81 .Pp
82 The currently supported controllers with their maximum speed include:
83 .Pp
84 .Bl -tag -width "Promise Ultra/Fasttrak-100 TX2/TX2000" -compact
85 .It Acerlabs Aladdin
86 Ultra DMA 100 (UDMA5), 100 MB/sec (depending on model, max stated at boot)
87 .It AMD 756
88 Ultra DMA 66 (UDMA4), 66 MB/sec
89 .It AMD 766
90 Ultra DMA 100 (UDMA5), 100 MB/sec
91 .It CMD 646
92 DMA 2 (WDMA2), 16 MB/sec
93 .It CMD 648
94 Ultra DMA 66 (UDMA4), 66 MB/sec
95 .It CMD 649
96 Ultra DMA 100 (UDMA5), 100 MB/sec
97 .It Cypress 82C693
98 DMA 2 (WDMA2), 16 MB/sec
99 .It Cyrix 5530
100 Ultra DMA 33 (UDMA2), 33 MB/sec
101 .It HighPoint HPT366
102 Ultra DMA 66 (UDMA4), 66 MB/sec
103 .It HighPoint HPT370
104 Ultra DMA 100 (UDMA5), 100 MB/sec
105 .It HighPoint HPT372
106 Ultra DMA 133 (UDMA6), 133 MB/sec
107 .It HighPoint HPT374
108 Ultra DMA 133 (UDMA6), 133 MB/sec
109 .It Intel PIIX
110 DMA 2 (WDMA2), 16 MB/sec
111 .It Intel PIIX3
112 DMA 2 (WDMA2), 16 MB/sec
113 .It Intel PIIX4
114 Ultra DMA 33 (UDMA2), 33 MB/sec
115 .It Intel ICH0
116 Ultra DMA 33 (UDMA2), 33 MB/sec
117 .It Intel ICH
118 Ultra DMA 66 (UDMA4), 66 MB/sec
119 .It Intel ICH2
120 Ultra DMA 100 (UDMA5), 100 MB/sec
121 .It Intel ICH3
122 Ultra DMA 100 (UDMA5), 100 MB/sec
123 .It Intel ICH4
124 Ultra DMA 100 (UDMA5), 100 MB/sec
125 .It Promise Ultra/Fasttrak-33
126 Ultra DMA 33 (UDMA2), 33 MB/sec
127 .It Promise Ultra/Fasttrak-66
128 Ultra DMA 66 (UDMA4), 66 MB/sec
129 .It Promise Ultra/Fasttrak-100
130 Ultra DMA 100 (UDMA5), 100 MB/sec
131 .It Promise Ultra/Fasttrak-100 TX2/TX4
132 Ultra DMA 100 (UDMA5), 100 MB/sec
133 .It Promise Ultra/Fasttrak-133 TX2/TX2000
134 Ultra DMA 133 (UDMA6), 133 MB/sec
135 .It ServerWorks ROSB4
136 Ultra DMA 33 (UDMA2), 33 MB/sec
137 .It ServerWorks CSB5
138 Ultra DMA 100 (UDMA5), 100 MB/sec (depending on model, max stated at boot)
139 .It Sil 0680
140 Ultra DMA 133 (UDMA6), 133 MB/sec (depending on model, max stated at boot)
141 .It SiS 5591
142 Ultra DMA 100 (UDMA5), 100 MB/sec (depending on model, max stated at boot)
143 .It VIA 82C586
144 Ultra DMA 33 (UDMA2), 33 MB/sec
145 .It VIA 82C596
146 Ultra DMA 66 (UDMA4), 66 MB/sec (depending on model, max stated at boot)
147 .It VIA 82C686a
148 Ultra DMA 66 (UDMA4), 66 MB/sec
149 .It VIA 82C686b
150 Ultra DMA 100 (UDMA5), 100 MB/sec
151 .It VIA 8233/8235
152 Ultra DMA 133 (UDMA6), 133 MB/sec (depending on model, max stated at boot)
153 .El
154 .Pp
155 All unknown chipsets are supported at the maximum speed of 16 MB/sec.
156 .Pp
157 The
158 .Nm
159 driver also allows for changes to the transfer mode of the devices
160 at a later time when the system is up and running, see
161 .Xr atacontrol 8 .
162 .Pp
163 The driver attempts to set the maximum performance transfer mode on your disk
164 drives by selecting the highest possible DMA mode. However the 
165 .Nm
166 driver sometimes issue the message 
167 "DMA limited to UDMA33, non-ATA66 cable or device",
168 if the cable is ATA66 (or above) compliant, it is because the other device
169 on this channel states it can only accept upto UDMA2/ATA33 signals.
170 ATAPI devices are left in PIO mode because DMA problems are common despite the
171 device specifications.
172 You can always try to set DMA mode on an ATAPI device using
173 .Xr atacontrol 8 ,
174 but be aware that your hardware might
175 .Em not
176 support it and can
177 .Em hang
178 the system.
179 .Sh FILES
180 .Bl -tag -width "/sys/i386/conf/GENERIC " -compact
181 .It Pa /dev/ad*
182 ATA disk device nodes
183 .It Pa /dev/acd*
184 ATAPI CD-ROM device nodes
185 .It Pa /dev/afd*
186 ATAPI floppy drive device nodes
187 .It Pa /dev/ast*
188 ATAPI tape drive device nodes
189 .It Pa /sys/i386/conf/GENERIC
190 sample generic kernel config file for
191 .Nm
192 based systems
193 .El
194 .Sh NOTES
195 Static numbering
196 (enabled with the
197 .Dv ATA_STATIC_ID
198 kernel option)
199 reserves a number for each possibly connected disk,
200 even when not present.
201 This may result in odd situations where,
202 for example,
203 ad0 and ad2 exist in the absence of ad1.
204 The advantage is that the addition of the formerly absent drive
205 does not cause the numbers of the other drives to change.
206 .Pp
207 The
208 .Nm
209 driver does not support MFM/RLL/ESDI (ST-506) style disks.
210 .Pp
211 Remember that in order to use UDMA4 (and above) mode you
212 .Em have
213 to use a special 80 conductor cable,
214 and the driver tries to determine if you have such a cable
215 attached before setting UDMA4 mode.
216 .Pp
217 The use of UDMA4(66MHz) and higher together with non-UDMA4 devices on
218 the same ATA channel is not recommended,
219 unless they are run at the non-UDMA4 device's lower speed.
220 The driver has been designed to handle that kind of setup but lots of
221 older devices do not like this.
222 .Sh SEE ALSO
223 .Xr atacontrol 8 ,
224 .Xr burncd 8
225 .Sh HISTORY
226 The
227 .Nm
228 driver first appeared in
229 .Fx 4.0 .
230 .Sh AUTHORS
231 .An -nosplit
232 The
233 .Nm
234 driver was written by
235 .An S\(/oren Schmidt
236 .Aq sos@FreeBSD.org .
237 .Pp
238 This manual page was written by
239 .An Jeroen Ruigrok van der Werven
240 .Aq asmodai@FreeBSD.org
241 and
242 .An S\(/oren Schmidt
243 .Aq sos@FreeBSD.org .