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