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