xref: /freebsd/share/man/man4/ata.4 (revision 7aa383846770374466b1dcb2cefd71bde9acf463)
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 July 3, 2010
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
84To turn
85.Xr ata 4
86subsystem controller drivers into cam(4) interface modules (disables all native
87.Xr ata 4
88APIs and periperal drivers):
89.Cd options ATA_CAM
90.Pp
91The following tunables are settable from the loader:
92.Bl -ohang
93.It Va hw.ata.ata_dma
94set to 1 for DMA access, 0 for PIO (default is DMA).
95.It Va hw.ata.ata_dma_check_80pin
96set to 0 to disable the 80pin cable check (default is 1, check the cable)
97.It Va hw.ata.atapi_dma
98set to 1 for DMA access, 0 for PIO (default is DMA).
99.It Va hw.ata.wc
100set to 1 to enable Write Caching, 0 to disable (default is enabled).
101.Em WARNING :
102can cause data loss on power failures and crashes.
103.It Va hint.atapci.X.msi
104set to 1 to allow Message Signalled Interrupts (MSI) to be used by
105specified PCI ATA controller, if supported.
106.It Va hint.ata.X.devX.mode
107limits initial ATA mode for specified device on specified channel.
108.It Va hint.ata.X.mode
109limits initial ATA mode for every device on specified channel.
110.It Va hint.ata.X.pm_level
111controls SATA interface Power Management for specified channel,
112allowing to save some power by the cost of additional command latency.
113Possible values:
114.Bl -tag -compact
115.It 0
116interface Power Management is disabled, default value.
117.It 1
118device is allowed to initiate PM state change, host is passive.
119.It 2
120host initiates PARTIAL PM state transition every time port becomes idle.
121.It 3
122host initiates SLUMBER PM state transition every time port becomes idle.
123.El
124Modes 2 and 3 are implemented only for AHCI driver now.
125.El
126.Sh DESCRIPTION
127The
128.Nm
129driver provides access to ATA (IDE) and SerialATA disk drives,
130ATAPI CDROM/DVD drives, ZIP/LS120 ATAPI drives and ATAPI tape drives
131connected to controllers according to the ATA/ATAPI standards.
132.Pp
133The currently supported ATA/SATA controller chips are:
134.Pp
135.Bl -tag -width "Silicon Image:" -compact
136.It Acard:
137ATP850P, ATP860A, ATP860R, ATP865A, ATP865R.
138.It ALI:
139M5228, M5229, M5281, M5283, M5287, M5288, M5289.
140.It AMD:
141AMD756, AMD766, AMD768, AMD8111, CS5536.
142.It ATI:
143IXP200, IXP300, IXP400, IXP600, IXP700, IXP800.
144.It CMD:
145CMD646, CMD646U2, CMD648, CMD649.
146.It Cypress:
147Cypress 82C693.
148.It Cyrix:
149Cyrix 5530.
150.It HighPoint:
151HPT302, HPT366, HPT368, HPT370, HPT371, HPT372, HPT372N, HPT374.
152.It Intel:
1536300ESB, 31244, PIIX, PIIX3, PIIX4, ESB2, ICH, ICH0, ICH2, ICH3, ICH4, ICH5,
154ICH6, ICH7, ICH8, ICH9, ICH10, SCH, PCH.
155.It ITE:
156IT8211F, IT8212F, IT8213F.
157.It JMicron:
158JMB360, JMB361, JMB363, JMB365, JMB366, JMB368.
159.It Marvell
16088SX5040, 88SX5041, 88SX5080, 88SX5081, 88SX6041, 88SX6042, 88SX6081, 88SX6101,
16188SX6102, 88SX6111, 88SX6121, 88SX6141, 88SX6145, 88SX7042.
162.It National:
163SC1100.
164.It NetCell:
165NC3000, NC5000.
166.It nVidia:
167nForce, nForce2, nForce2 MCP, nForce3, nForce3 MCP, nForce3 Pro, nForce4,
168MCP51, MCP55, MCP61, MCP65, MCP67, MCP73, MCP77, MCP79, MCP89.
169.It Promise:
170PDC20246, 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.
171.It ServerWorks:
172HT1000, ROSB4, CSB5, CSB6, K2, Frodo4, Frodo8.
173.It Silicon Image:
174SiI0680, SiI3112, SiI3114, SiI3124, SiI3132, SiI3512.
175.It SiS:
176SIS180, SIS181, SIS182, SIS5513, SIS530, SIS540, SIS550, SIS620, SIS630, SIS630S, SIS633, SIS635, SIS730, SIS733, SIS735, SIS745, SIS961, SIS962, SIS963, SIS964, SIS965.
177.It VIA:
178VT6410, VT6420, VT6421, VT82C586, VT82C586B, VT82C596, VT82C596B, VT82C686,
179VT82C686A, VT82C686B, VT8231, VT8233, VT8233A, VT8233C, VT8235, VT8237,
180VT8237A, VT8237S, VT8251, CX700, VX800, VX855.
181.El
182.Pp
183Unknown ATA chipsets are supported in PIO modes, and if the standard
184busmaster DMA registers are present and contain valid setup, DMA is
185also enabled, although the max mode is limited to UDMA33, as it is
186not known what the chipset can do and how to program it.
187.Pp
188The
189.Nm
190driver can change the transfer mode and various other parameters
191when the system is up and running.
192See
193.Xr atacontrol 8 .
194.Pp
195The
196.Nm
197driver sets the maximum transfer mode supported by the hardware as default.
198However the
199.Nm
200driver sometimes warns:
201.Dq Sy "DMA limited to UDMA33, non-ATA66 cable or device".
202This means that
203the
204.Nm
205driver has detected that the required 80 conductor cable is not present
206or could not be detected properly,
207or that one of the devices on the channel only accepts up
208to UDMA2/ATA33.
209The
210.Va hw.ata.ata_dma_check_80pin
211tunable can be set to 0 to disable this check.
212.Pp
213Unknown ATAPI devices are initialized to DMA mode if the
214.Va hw.ata.atapi_dma
215tunable is set to 1 and they support at least UDMA33 transfers.
216Otherwise they are set to PIO mode because severe DMA problems are
217common even if the device capabilities indicate support.
218You can always try to set DMA mode on an ATAPI device using
219.Xr atacontrol 8 ,
220but be aware that your hardware might
221.Em not
222support it and can potentially
223.Em hang
224the entire system causing data loss.
225.Sh FILES
226.Bl -tag -width ".Pa /sys/i386/conf/GENERIC" -compact
227.It Pa /dev/ad*
228ATA disk device nodes
229.It Pa /dev/ar*
230ATA RAID device nodes
231.It Pa /dev/acd*
232ATAPI CD-ROM device nodes
233.It Pa /dev/afd*
234ATAPI floppy drive device nodes
235.It Pa /dev/ast*
236ATAPI tape drive device nodes
237.It Pa /sys/i386/conf/GENERIC
238sample generic kernel config file for
239.Nm
240based systems
241.El
242.Sh NOTES
243Please remember that in order to use UDMA4/ATA66 and above modes you
244.Em must
245use 80 conductor cables.
246Please assure that ribbon cables are no longer than 45cm.
247In case of rounded ATA cables, the length depends on the
248quality of the cables.
249SATA cables can be up to 1m long according to the specification.
250.Pp
251Static device numbering
252(enabled with the
253.Dv ATA_STATIC_ID
254kernel option)
255reserves a number for each possibly connected disk,
256even when not present.
257This is useful in hotswap scenarios
258where disks should always show up as the same numbered device,
259and not depend on attach order.
260.Pp
261Native Command Queuing (NCQ) on SATA drives is not yet supported.
262.Sh SEE ALSO
263.Xr ahci 4 ,
264.Xr cam 4 ,
265.Xr ataraid 4 ,
266.Xr atacontrol 8 ,
267.Xr burncd 8 ,
268.Xr siis 4
269.Sh HISTORY
270The
271.Nm
272driver first appeared in
273.Fx 4.0 .
274.Sh AUTHORS
275.An S\(/oren Schmidt
276.Aq sos@FreeBSD.org .
277