NetBSD/share/man/man4/pciide.4

.\"	$NetBSD: pciide.4,v 1.65 2010/11/07 11:51:14 wiz Exp $
.\"
.\" Copyright (c) 1998,2003 Manuel Bouyer.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd November 7, 2010
.Dt PCIIDE 4
.Os
.Sh NAME
.Nm pciide
.Nd PCI IDE disk controllers driver
.Sh SYNOPSIS
.Cd "pciide* at pci? dev ? function ? flags 0x0000"
.Cd "pciide* at pnpbios? index ?"
.Sh DESCRIPTION
The
.Nm
driver supports the PCI IDE controllers as specified in the
"PCI IDE controller specification, revision 1.0" draft, and provides the
interface with the hardware for the
.Ic ata
driver.
Please use the chip-specific drivers for the following controllers for
enhanced and DMA support:
.Bl -dash -compact -offset indent
.It
Acard ATP850 (Ultra/33) and ATP860 (Ultra/66) IDE Controllers:
.Xr acardide 4
.It
Acer labs M5229 IDE Controller:
.Xr aceride 4
.It
Advanced Micro Devices AMD-756, 766, and 768 IDE Controllers:
.Xr viaide 4
.It
Advanced Micro Devices Geode IDE Controllers:
.Xr geodeide 4
.It
CMD Tech PCI0643, PCI0646, PCI0648, and PCI0649 IDE Controllers:
.Xr cmdide 4
.It
Contaq Microsystems/Cypress CY82C693 IDE Controller:
.Xr cypide 4
.It
HighPoint HPT366 Ultra/66, HPT370 Ultra/100, HPT372, and HPT374 Ultra/133
IDE controller:
.Xr hptide 4
.It
Intel PIIX, PIIX3, and PIIX4 IDE Controllers:
.Xr piixide 4
.It
Intel i31244 Serial ATA controller:
.Xr artsata 4
.It
Intel 82801 (ICH/ICH0/ICH2/ICH3/ICH4/ICH5/ICH6) IDE Controllers:
.Xr piixide 4
.It
Intel SCH IDE Controllers:
.Xr schide 4
.It
NVIDIA nForce/nForce2 IDE Controllers:
.Xr viaide 4
.It
OPTi 82c621 (plus a few of its derivatives) IDE Controllers:
.Xr optiide 4
.It
Promise PDC20246 (Ultra/33), PDC20262 (Ultra/66), PDC20265/PDC20267 (Ultra100),
PDC20268 (Ultra/100TX2 and Ultra/100TX2v2), Ultra/133, Ultra/133TX2 and
Ultra/133TX2v2 PCI IDE controllers:
.Xr pdcide 4
.It
Serverworks K2 SATA controllers:
.Xr svwsata 4
.It
Silicon Image 0680 IDE controller:
.Xr cmdide 4
.It
Silicon Image SATALink 3112 Serial ATA controller:
.Xr satalink 4
.It
Silicon Image SteelVine 3124/3132/3531 Serial ATA II controller:
.Xr siisata 4
.It
Silicon Integrated System 5597/5598 IDE controller:
.Xr siside 4
.It
Symphony Labs 82C105 and Winbond W83C553F IDE controller:
.Xr slide 4
.It
VIA Technologies VT82C586, VT82C586A, VT82C596A, VT82C686A, VT8233A,
and VT8235 IDE Controllers:
.Xr viaide 4
.El
.Pp
The 0x0001 flag forces the
.Nm
driver to use DMA when there is no explicit DMA mode setting support for
the controller but DMA is present.
If the BIOS didn't set up the controller
properly, this can cause a machine hang.
.Pp
The 0x0002 flag forces the
.Nm
driver to disable DMA on chipsets for which DMA would normally be
enabled.
This can be used as a debugging aid, or to work around
problems where the IDE controller is wired up to the system incorrectly.
.Sh SEE ALSO
.Xr acardide 4 ,
.Xr aceride 4 ,
.Xr artsata 4 ,
.Xr ata 4 ,
.Xr atapi 4 ,
.Xr cmdide 4 ,
.Xr cypide 4 ,
.Xr geodeide 4 ,
.Xr hptide 4 ,
.Xr intro 4 ,
.Xr optiide 4 ,
.Xr pci 4 ,
.Xr pdcide 4 ,
.Xr piixide 4 ,
.Xr pnpbios 4 ,
.Xr satalink 4 ,
.Xr schide 4 ,
.Xr siisata 4 ,
.Xr siside 4 ,
.Xr slide 4 ,
.Xr viaide 4 ,
.Xr wd 4 ,
.Xr wdc 4
Bump date for schide(4). 2010-11-07 14:51:14 +03:00			`.\" $NetBSD: pciide.4,v 1.65 2010/11/07 11:51:14 wiz Exp $`
New man pages for the ide drivers. More verbose notes about ATAPI in scsi(4). The wdc(4) man page is i386-only. Other ports with a wdc front end should add a manual page as well. 1998-10-19 16:44:15 +04:00			`.\"`
Add man page for per-chip pciide drivers. 2003-10-08 16:02:40 +04:00			`.\" Copyright (c) 1998,2003 Manuel Bouyer.`
New man pages for the ide drivers. More verbose notes about ATAPI in scsi(4). The wdc(4) man page is i386-only. Other ports with a wdc front end should add a manual page as well. 1998-10-19 16:44:15 +04:00			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\"`
Use same copyrigth notice everywhere. 2000-05-15 10:33:21 +04:00			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
			`.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES`
Typos/whitespace fixes. 2001-06-12 15:26:21 +04:00			`.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.`
			`.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,`
Use same copyrigth notice everywhere. 2000-05-15 10:33:21 +04:00			`.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT`
			`.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,`
			`.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY`
			`.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT`
			`.\" INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF`
			`.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.`
New man pages for the ide drivers. More verbose notes about ATAPI in scsi(4). The wdc(4) man page is i386-only. Other ports with a wdc front end should add a manual page as well. 1998-10-19 16:44:15 +04:00			`.\"`
Bump date for schide(4). 2010-11-07 14:51:14 +03:00			`.Dd November 7, 2010`
GC spurious blank lines. 2000-05-13 19:27:17 +04:00			`.Dt PCIIDE 4`
More and more of .Os cleanups. .Os is defined in the tmac.doc-common file, so we shouldn't override it with versions in the manpages. Many more to come. 1999-03-16 04:19:14 +03:00			`.Os`
New man pages for the ide drivers. More verbose notes about ATAPI in scsi(4). The wdc(4) man page is i386-only. Other ports with a wdc front end should add a manual page as well. 1998-10-19 16:44:15 +04:00			`.Sh NAME`
fix up various .Nm abuses: - keep the case consistent between the actual name and what's referenced. e.g, if it's `foo', don't use '.Nm Foo' at the start of a sentence. - remove unnecessary `.Nm foo' after the first occurrence (except for using `.Nm ""' if there's stuff following, or for the 2nd and so on occurrences in a SYNOPSIS - use Sx, Ic, Li, Em, Sq, and Xr as appropriate 2000-11-07 09:43:24 +03:00			`.Nm pciide`
Misc small fixes to try to standardise the format to make it easier to parse by an automated script (say one that just might want to generate webpage summaries of available drivers :) 1999-12-16 01:07:30 +03:00			`.Nd PCI IDE disk controllers driver`
New man pages for the ide drivers. More verbose notes about ATAPI in scsi(4). The wdc(4) man page is i386-only. Other ports with a wdc front end should add a manual page as well. 1998-10-19 16:44:15 +04:00			`.Sh SYNOPSIS`
Add a first shot at a pnpbios man page. Update other man pages to reflect the fact that devices can attach to pnpbios. 1999-11-14 20:02:20 +03:00			`.Cd "pciide* at pci? dev ? function ? flags 0x0000"`
			`.Cd "pciide* at pnpbios? index ?"`
New man pages for the ide drivers. More verbose notes about ATAPI in scsi(4). The wdc(4) man page is i386-only. Other ports with a wdc front end should add a manual page as well. 1998-10-19 16:44:15 +04:00			`.Sh DESCRIPTION`
			`The`
fix up various .Nm abuses: - keep the case consistent between the actual name and what's referenced. e.g, if it's `foo', don't use '.Nm Foo' at the start of a sentence. - remove unnecessary `.Nm foo' after the first occurrence (except for using `.Nm ""' if there's stuff following, or for the 2nd and so on occurrences in a SYNOPSIS - use Sx, Ic, Li, Em, Sq, and Xr as appropriate 2000-11-07 09:43:24 +03:00			`.Nm`
New man pages for the ide drivers. More verbose notes about ATAPI in scsi(4). The wdc(4) man page is i386-only. Other ports with a wdc front end should add a manual page as well. 1998-10-19 16:44:15 +04:00			`driver supports the PCI IDE controllers as specified in the`
Add a ata(4) man page, with a symlink to atabus(4), and xref where appropriate. 2003-10-08 15:20:09 +04:00			`"PCI IDE controller specification, revision 1.0" draft, and provides the`
			`interface with the hardware for the`
			`.Ic ata`
			`driver.`
Add man page for per-chip pciide drivers. 2003-10-08 16:02:40 +04:00			`Please use the chip-specific drivers for the following controllers for`
			`enhanced and DMA support:`
Update supported hardware list to reality, + a few cosmetic changes. 1999-02-02 19:56:54 +03:00			`.Bl -dash -compact -offset indent`
			`.It`
Add man page for per-chip pciide drivers. 2003-10-08 16:02:40 +04:00			`Acard ATP850 (Ultra/33) and ATP860 (Ultra/66) IDE Controllers:`
			`.Xr acardide 4`
Note the Acard UIDE controllers. 2001-07-28 16:18:19 +04:00			`.It`
Add man page for per-chip pciide drivers. 2003-10-08 16:02:40 +04:00			`Acer labs M5229 IDE Controller:`
			`.Xr aceride 4`
Update supported hardware list to reality, + a few cosmetic changes. 1999-02-02 19:56:54 +03:00			`.It`
Add man page for per-chip pciide drivers. 2003-10-08 16:02:40 +04:00			`Advanced Micro Devices AMD-756, 766, and 768 IDE Controllers:`
			`.Xr viaide 4`
Note Advanced Micro Devices AMD-756 IDE Controller support, remarked by Dave Sainty in kern/9640. 2000-03-19 13:07:37 +03:00			`.It`
Mention geodeide(4). Bump date. 2004-07-10 03:17:08 +04:00			`Advanced Micro Devices Geode IDE Controllers:`
			`.Xr geodeide 4`
			`.It`
Add man page for per-chip pciide drivers. 2003-10-08 16:02:40 +04:00			`CMD Tech PCI0643, PCI0646, PCI0648, and PCI0649 IDE Controllers:`
			`.Xr cmdide 4`
Update supported hardware list to reality, + a few cosmetic changes. 1999-02-02 19:56:54 +03:00			`.It`
Add man page for per-chip pciide drivers. 2003-10-08 16:02:40 +04:00			`Contaq Microsystems/Cypress CY82C693 IDE Controller:`
			`.Xr cypide 4`
Update supported hardware list to reality, + a few cosmetic changes. 1999-02-02 19:56:54 +03:00			`.It`
Add some commas in enumerations, and bump date for recent changes. 2002-08-31 02:13:03 +04:00			`HighPoint HPT366 Ultra/66, HPT370 Ultra/100, HPT372, and HPT374 Ultra/133`
Add man page for per-chip pciide drivers. 2003-10-08 16:02:40 +04:00			`IDE controller:`
			`.Xr hptide 4`
Note HPT366 support. 2000-06-13 01:27:12 +04:00			`.It`
Add man page for per-chip pciide drivers. 2003-10-08 16:02:40 +04:00			`Intel PIIX, PIIX3, and PIIX4 IDE Controllers:`
			`.Xr piixide 4`
Update supported hardware list to reality, + a few cosmetic changes. 1999-02-02 19:56:54 +03:00			`.It`
Add man page for per-chip pciide drivers. 2003-10-08 16:02:40 +04:00			`Intel i31244 Serial ATA controller:`
Fix Xrefs for artsata and satalink; bump date. 2003-12-14 12:22:11 +03:00			`.Xr artsata 4`
Note Intel i31244 and Silicon Image 3112 Serial ATA controllers. 2003-03-20 07:33:51 +03:00			`.It`
Add ICH6 southbridge to list of support devices. 2005-03-07 14:27:29 +03:00			`Intel 82801 (ICH/ICH0/ICH2/ICH3/ICH4/ICH5/ICH6) IDE Controllers:`
Add man page for per-chip pciide drivers. 2003-10-08 16:02:40 +04:00			`.Xr piixide 4`
Note Intel 82801 support. 1999-08-30 17:12:50 +04:00			`.It`
Add schide(4) man page. 2010-11-07 04:12:22 +03:00			`Intel SCH IDE Controllers:`
			`.Xr schide 4`
			`.It`
Add man page for per-chip pciide drivers. 2003-10-08 16:02:40 +04:00			`NVIDIA nForce/nForce2 IDE Controllers:`
			`.Xr viaide 4`
			`.It`
			`OPTi 82c621 (plus a few of its derivatives) IDE Controllers:`
			`.Xr optiide 4`
Document OPTi 82c621 support. 2000-06-13 13:43:07 +04:00			`.It`
Note support of newer promise controllers. 2001-12-17 02:40:23 +03:00			`Promise PDC20246 (Ultra/33), PDC20262 (Ultra/66), PDC20265/PDC20267 (Ultra100),`
Add some commas in enumerations, and bump date for recent changes. 2002-08-31 02:13:03 +04:00			`PDC20268 (Ultra/100TX2 and Ultra/100TX2v2), Ultra/133, Ultra/133TX2 and`
Add man page for per-chip pciide drivers. 2003-10-08 16:02:40 +04:00			`Ultra/133TX2v2 PCI IDE controllers:`
			`.Xr pdcide 4`
Note support of Promise Ultra/33 and /66 controllers. 1999-08-29 22:14:26 +04:00			`.It`
Add svwsata(4), a driver for Serverworks K2 SATA controllers. From OpenBSD via Joerg Sonnenberger. 2006-03-06 21:35:24 +03:00			`Serverworks K2 SATA controllers:`
			`.Xr svwsata 4`
			`.It`
Add man page for per-chip pciide drivers. 2003-10-08 16:02:40 +04:00			`Silicon Image 0680 IDE controller:`
			`.Xr cmdide 4`
Note Silicon Image 0680 support 2002-07-26 14:37:32 +04:00			`.It`
Add man page for per-chip pciide drivers. 2003-10-08 16:02:40 +04:00			`Silicon Image SATALink 3112 Serial ATA controller:`
Fix Xrefs for artsata and satalink; bump date. 2003-12-14 12:22:11 +03:00			`.Xr satalink 4`
Note Intel i31244 and Silicon Image 3112 Serial ATA controllers. 2003-03-20 07:33:51 +03:00			`.It`
add reference to siisata(4) 2008-05-29 12:23:39 +04:00			`Silicon Image SteelVine 3124/3132/3531 Serial ATA II controller:`
			`.Xr siisata 4`
			`.It`
Add man page for per-chip pciide drivers. 2003-10-08 16:02:40 +04:00			`Silicon Integrated System 5597/5598 IDE controller:`
			`.Xr siside 4`
Update supported hardware list to reality, + a few cosmetic changes. 1999-02-02 19:56:54 +03:00			`.It`
Note the slide(4) driver in the list of chips in the pciide driver, and fix a missing space in the slide manpage. 2006-10-31 02:39:38 +03:00			`Symphony Labs 82C105 and Winbond W83C553F IDE controller:`
			`.Xr slide 4`
			`.It`
Note VIA VT8235. 2002-10-05 21:10:01 +04:00			`VIA Technologies VT82C586, VT82C586A, VT82C596A, VT82C686A, VT8233A,`
Add man page for per-chip pciide drivers. 2003-10-08 16:02:40 +04:00			`and VT8235 IDE Controllers:`
			`.Xr viaide 4`
Typos/whitespace fixes. 2001-06-12 15:26:21 +04:00			`.El`
Note the pciide config flags. 1998-10-22 19:15:16 +04:00			`.Pp`
Fixed typos (mostly from OpenBSD) 1999-10-17 00:17:29 +04:00			`The 0x0001 flag forces the`
fix up various .Nm abuses: - keep the case consistent between the actual name and what's referenced. e.g, if it's `foo', don't use '.Nm Foo' at the start of a sentence. - remove unnecessary `.Nm foo' after the first occurrence (except for using `.Nm ""' if there's stuff following, or for the 2nd and so on occurrences in a SYNOPSIS - use Sx, Ic, Li, Em, Sq, and Xr as appropriate 2000-11-07 09:43:24 +03:00			`.Nm`
Note the pciide config flags. 1998-10-22 19:15:16 +04:00			`driver to use DMA when there is no explicit DMA mode setting support for`
Bump date for VT8235; fix a major whitespace error; new sentence, new line. 2002-10-07 04:09:16 +04:00			`the controller but DMA is present.`
			`If the BIOS didn't set up the controller`
Note the pciide config flags. 1998-10-22 19:15:16 +04:00			`properly, this can cause a machine hang.`
Document the 0x02 flag. 2001-10-21 22:57:39 +04:00			`.Pp`
			`The 0x0002 flag forces the`
			`.Nm`
			`driver to disable DMA on chipsets for which DMA would normally be`
Bump date for VT8235; fix a major whitespace error; new sentence, new line. 2002-10-07 04:09:16 +04:00			`enabled.`
			`This can be used as a debugging aid, or to work around`
Document the 0x02 flag. 2001-10-21 22:57:39 +04:00			`problems where the IDE controller is wired up to the system incorrectly.`
Sort SEE ALSO, sort sections, drop some .Pp, misc. markup improvements. 2001-09-22 19:58:13 +04:00			`.Sh SEE ALSO`
Add man page for per-chip pciide drivers. 2003-10-08 16:02:40 +04:00			`.Xr acardide 4 ,`
			`.Xr aceride 4 ,`
Fix Xrefs for artsata and satalink; bump date. 2003-12-14 12:22:11 +03:00			`.Xr artsata 4 ,`
Sort SEE ALSO. 2003-10-15 12:38:10 +04:00			`.Xr ata 4 ,`
			`.Xr atapi 4 ,`
Add man page for per-chip pciide drivers. 2003-10-08 16:02:40 +04:00			`.Xr cmdide 4 ,`
			`.Xr cypide 4 ,`
Mention geodeide(4). Bump date. 2004-07-10 03:17:08 +04:00			`.Xr geodeide 4 ,`
Add man page for per-chip pciide drivers. 2003-10-08 16:02:40 +04:00			`.Xr hptide 4 ,`
Sort SEE ALSO. 2003-10-15 12:38:10 +04:00			`.Xr intro 4 ,`
Add man page for per-chip pciide drivers. 2003-10-08 16:02:40 +04:00			`.Xr optiide 4 ,`
Sort SEE ALSO. 2003-10-15 12:38:10 +04:00			`.Xr pci 4 ,`
Add man page for per-chip pciide drivers. 2003-10-08 16:02:40 +04:00			`.Xr pdcide 4 ,`
			`.Xr piixide 4 ,`
Sort SEE ALSO. 2003-10-15 12:38:10 +04:00			`.Xr pnpbios 4 ,`
Fix Xrefs for artsata and satalink; bump date. 2003-12-14 12:22:11 +03:00			`.Xr satalink 4 ,`
Add schide(4) man page. 2010-11-07 04:12:22 +03:00			`.Xr schide 4 ,`
add reference to siisata(4) 2008-05-29 12:23:39 +04:00			`.Xr siisata 4 ,`
Add man page for per-chip pciide drivers. 2003-10-08 16:02:40 +04:00			`.Xr siside 4 ,`
			`.Xr slide 4 ,`
			`.Xr viaide 4 ,`
Sort SEE ALSO. 2003-10-15 12:38:10 +04:00			`.Xr wd 4 ,`
Sort SEE ALSO, sort sections, drop some .Pp, misc. markup improvements. 2001-09-22 19:58:13 +04:00			`.Xr wdc 4`