Integrate docs for new ATA/IDE stuff into the tree for edited by csapuntz@,

especially the SYNOPSIS sections.

3 files changed, 190 insertions, 55 deletions

diff --git a/share/man/man4/man4.i386/pciide.4 b/share/man/man4/man4.i386/pciide.4
new file mode 100644
index 00000000000..d6233d87573
--- /dev/null
+++ b/share/man/man4/man4.i386/pciide.4
@@ -0,0 +1,96 @@
+.\"	$OpenBSD: pciide.4,v 1.1 1999/07/21 23:57:55 aaron Exp $
+.\"	$NetBSD: pciide.4,v 1.8 1999/03/16 01:19:17 garbled Exp $
+.\"
+.\" Copyright (c) 1998 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.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"	This product includes software developed by the University of
+.\"	California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``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 REGENTS OR CONTRIBUTORS 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 October 15, 1998
+.Dt pciide 4
+.Os
+.Sh NAME
+.Nm pciide
+.Nd PCI IDE controller driver
+.Sh SYNOPSIS
+.Cd "pciide* at pci ? dev ? function ? flags 0x0000"
+.Cd "options PCIIDE_CMD064x_DISABLE"
+.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 core
+functions for the
+.Xr wd 4
+and
+.Xr atapi 4
+drivers. This driver includes specific, enhanced support for the CMD Tech
+PCI0640 controller and IDE DMA/UltraDMA support for the following
+controllers:
+.Pp
+.Bl -item -compact -offset indent
+.It
+Acer Labs M5229 IDE controller
+.It
+CMD Tech PCI0643 and PCI0646 IDE controllers
+.It
+Contaq Microsystems/Cypress CY82C693 IDE controller
+.It
+Intel PIIX, PIIX3, and PIIX4 IDE controllers
+.It
+Silicon Integrated System 5597/5598 IDE controller
+.It
+VIA Technologies VT82C586 and VT82C586A IDE controllers
+.El 
+.Pp
+Some of these contollers are only available in multifunction PCI chips.
+.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 configure the controller
+properly, this can cause a machine hang.
+
+.Sh BUGS
+There's no way to reliably know if a PCI064x controller is enabled or not.
+If the driver finds a PCI064x, it will assume it is enabled unless
+.Dv PCIIDE_CMD064x_DISABLE
+is specified in the kernel config file.
+This will be a problem only if the controller has been disabled in the BIOS
+and another controller has been installed which uses the ISA legacy I/O ports
+and interrupts.
+.Pp
+The timings used for the PIO and DMA modes for controllers listed above
+are for a PCI bus running at 30 or 33 Mhz. This driver may not
+work properly on overclocked systems.
+.Sh SEE ALSO
+.Xr intro 4 ,
+.Xr scsi 4 ,
+.Xr wd 4 ,
+.Xr wdc 4
diff --git a/share/man/man4/man4.i386/wdc.4 b/share/man/man4/man4.i386/wdc.4
index c1d3aaab89f..dee638a361c 100644
--- a/share/man/man4/man4.i386/wdc.4
+++ b/share/man/man4/man4.i386/wdc.4
@@ -1,33 +1,43 @@
-.\"	$OpenBSD: wdc.4,v 1.7 1999/07/21 11:20:33 deraadt Exp $
+.\"	$OpenBSD: wdc.4,v 1.8 1999/07/21 23:57:54 aaron Exp $
+.\"	$NetBSD: wdc.4,v 1.4 1999/05/19 14:44:02 bouyer Exp $
 .\"
-.\" Copyright (c) 1994 James A. Jegers
-.\" All rights reserved.
+.\" Copyright (c) 1998 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. The name of the author may not be used to endorse or promote products
-.\"    derived from this software without specific prior written permission
+.\" 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.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"	This product includes software developed by the University of
+.\"	California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
 .\"
-.\" 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.
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``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 REGENTS OR CONTRIBUTORS 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 July 12, 1998
-.Dt WDC 4 i386
+
+.Dd October 15, 1998
+.Dt WDC 4
 .Os
 .Sh NAME
 .Nm wdc
-.Nd WD100x compatible hard disk driver
+.Nd WD100x compatible hard disk controller driver
 .Sh SYNOPSIS
 .Cd "wdc0 at isa? port 0x1f0 irq 14"
 .Cd "wdc0 at isa? port 0x170 irq 15"
@@ -37,16 +47,19 @@
 .Sh DESCRIPTION
 The
 .Nm
-driver supports hard disk controllers which emulate the Western
-Digital WD100x.  This includes standard MFM, RLL, ESDI and IDE
-controllers.
-.\" .Pp
-.\" Support for extended EIDE controllers is
-.\" .Ud .
+driver provides the basic functions for the
+.Xr wd 4
+and
+.Xr atapi 4
+drivers. It supports IDE and EIDE controllers, as well as MFM, RLL, and ESDI on
+the ISA bus. PCI IDE controllers in legacy mode are also supported, but the
+.Xr pciide 4
+driver may provide more functionalities.
 .Pp
-Enhanced IDE and UltraDMA is not supported by this driver, though such
-devices should still work (in normal PIO mode).
+For the ISA front-end, the 0x01 flag enables 32-bit I/O negotiation.
+This is known to cause problems with some motherboards.
 .Sh SEE ALSO
-.Xr acd 4 ,
 .Xr intro 4 ,
+.Xr pciide 4 ,
+.Xr scsi 4 ,
 .Xr wd 4
diff --git a/share/man/man4/wd.4 b/share/man/man4/wd.4
index 7b7794ea424..d26c9ebeb41 100644
--- a/share/man/man4/wd.4
+++ b/share/man/man4/wd.4
@@ -1,44 +1,70 @@
-.\"	$OpenBSD: wd.4,v 1.3 1999/07/09 13:35:48 aaron Exp $
+.\"	$OpenBSD: wd.4,v 1.4 1999/07/21 23:57:55 aaron Exp $
+.\"	$NetBSD: wd.4,v 1.4 1999/04/25 00:00:05 mjl Exp $
 .\"
-.\" Copyright (c) 1998, Jason Downs.  All rights reserved.
+.\"
+.\" Copyright (c) 1994 James A. Jegers
+.\" All rights reserved.
 .\"
 .\" 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(S) ``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(S) 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.
+.\" 2. The name of the author may not be used to endorse or promote products
+.\"    derived from this software without specific prior written permission
+.\" 
+.\" 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 July 12, 1998
-.Dt WD 4
+.Dd October 15, 1998
+.Dt WD 4 
 .Os
 .Sh NAME
-.Nm wd
-.Nd ST506/ESDI/IDE disk driver
+.Nm wd 
+.Nd WD100x compatible hard disk driver
 .Sh SYNOPSIS
-.Cd "wd* at wdc?"
+.Cd "wd* at wdc? channel ? drive ? flags 0x0000"
+.Cd "wd* at pciide? channel ? drive ? flags 0x0000"
 .Sh DESCRIPTION
 The
-.Nm wd
-driver provides support for random access disk drives, using standard
-ST506/ESDI/IDE controllers.
-.Sh FILES
-.Xr /dev/wd*
-.Xr /dev/rwd*
+.Nm
+driver supports hard disks which emulate the Western Digital WD100x.
+This includes standard MFM, RLL, ESDI, IDE, and EIDE drives.
+.Pp
+The
+.Cm flags
+are used only with controllers that support DMA operations and
+mode settings (like some
+.Xr pciide 4
+controllers).
+The lowest order (right-most) nibble of the
+.Cm flags
+define the PIO mode to use. The next four bits indicate the DMA mode and the
+third nibble the UltraDMA mode.
+.Pp
+For each set of four bits, the 3 lower bits define the mode to use
+and the last bit must be set to 1 for this setting to be used.
+For DMA and UltraDMA, 0xf (1111) means
+.Dq disable .
+For example, a
+.Cm flags
+value of 0x0fac (1111 1010 1100) 
+means
+.Do
+use PIO mode 4, DMA mode 2, disable UltraDMA
+.Dc .
+The special setting 0x0000 means
+.Dq use whatever the drive claims to support .
 .Sh SEE ALSO
 .Xr intro 4 ,
+.Xr pciide 4 ,
+.Xr scsi 4 ,
 .Xr wdc 4