Start of new ATA man page that reflects the curretn state of art.

mdoc handling possibly fragile :)

1 files changed, 97 insertions, 149 deletions

diff --git a/share/man/man4/ata.4 b/share/man/man4/ata.4
index 50aad25..68c88de 100644
--- a/share/man/man4/ata.4
+++ b/share/man/man4/ata.4
@@ -1,36 +1,38 @@
 .\"
-.\" Copyright (c) 2000 Jeroen Ruigrok van der Werven
-.\" Copyright (c) 2000,2001,2002 Søren Schmidt
+.\" Copyright (c) 2003 Søren Schmidt <sos@FreeBSD.org>
 .\" 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.
+.\"    notice, this list of conditions and the following disclaimer,
+.\"    without modification, immediately at the beginning of the file.
 .\" 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. 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 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 AUTHOR 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.
+.\" 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.
 .\"
 .\" $FreeBSD$
 .\"
-.Dd January 27, 2000
+.Dd November 4, 2003
 .Dt ATA 4
 .Os
 .Sh NAME
 .Nm ata ,
+.Nm ar ,
 .Nm acd ,
 .Nm ad ,
 .Nm afd ,
@@ -67,11 +69,13 @@ For PCI based ATA/ATAPI support:
 To support ATA compliant disk drives:
 .Cd device atadisk
 .Pp
-To support ATAPI CD-ROM, CDR, CDRW, DVD-ROM and DVD-RAM drives:
+To support ATA software RAID's
+.Cd device ataraid
+.Pp
+To support ATAPI CDROM, DVD and CD/DVD burner drives,
 .Cd device atapicd
 .Pp
 To support ATAPI floppy drives,
-such as the ZIP and LS120:
 .Cd device atapifd
 .Pp
 To support ATAPI tape drives:
@@ -85,125 +89,91 @@ set to 1 for DMA access, 0 for PIO (default is DMA).
 set to 1 for DMA access, 0 for PIO (default is PIO).
 .It Va hw.ata.wc
 set to 1 to enable Write Caching, 0 to disable (default is enabled).
-(WARNING: might cause data loss on power failures.)
-.It Va hw.ata.tags
-set to 1 to enable Tagged Queuing support, 0 to disable (default is disabled).
-(Only IBM DPTA, DTLA, ICxxxxxxAT, ICxxxxxxAV drives support that.)
+(WARNING: can cause data loss on power failures.)
 .El
 .Sh DESCRIPTION
-This driver provides access to disk drives, ATAPI CD-ROM and DVD drives,
-ZIP drives and tape streamers connected to controllers
-according to the ATA and ATAPI standards.
-These devices are also commonly known as IDE or EIDE devices.
-.Pp
-The currently supported controllers with their maximum speed include:
-.Pp
-.Bl -tag -width "Promise Ultra/Fasttrak-100 TX2/TX2000" -compact
-.It Acerlabs Aladdin
-Ultra DMA 100 (UDMA5), 100 MB/sec (depending on model, max stated at boot)
-.It AMD 756
-Ultra DMA 66 (UDMA4), 66 MB/sec
-.It AMD 766
-Ultra DMA 100 (UDMA5), 100 MB/sec
-.It Acard ATP850
-Ultra DMA 33 (UDMA2), 33 MB/sec
-.It Acard ATP860
-Ultra DMA 66 (UDMA4), 66 MB/sec
-.It Acard ATP865
-Ultra DMA 133 (UDMA6), 133 MB/sec
-.It CMD 646
-DMA 2 (WDMA2), 16 MB/sec
-.It CMD 648
-Ultra DMA 66 (UDMA4), 66 MB/sec
-.It CMD 649
-Ultra DMA 100 (UDMA5), 100 MB/sec
-.It Cypress 82C693
-DMA 2 (WDMA2), 16 MB/sec
-.It Cyrix 5530
-Ultra DMA 33 (UDMA2), 33 MB/sec
-.It HighPoint HPT366
-Ultra DMA 66 (UDMA4), 66 MB/sec
-.It HighPoint HPT370
-Ultra DMA 100 (UDMA5), 100 MB/sec
-.It HighPoint HPT372
-Ultra DMA 133 (UDMA6), 133 MB/sec
-.It HighPoint HPT374
-Ultra DMA 133 (UDMA6), 133 MB/sec
-.It Intel PIIX
-DMA 2 (WDMA2), 16 MB/sec
-.It Intel PIIX3
-DMA 2 (WDMA2), 16 MB/sec
-.It Intel PIIX4
-Ultra DMA 33 (UDMA2), 33 MB/sec
-.It Intel ICH0
-Ultra DMA 33 (UDMA2), 33 MB/sec
-.It Intel ICH
-Ultra DMA 66 (UDMA4), 66 MB/sec
-.It Intel ICH2
-Ultra DMA 100 (UDMA5), 100 MB/sec
-.It Intel ICH3
-Ultra DMA 100 (UDMA5), 100 MB/sec
-.It Intel ICH4
-Ultra DMA 100 (UDMA5), 100 MB/sec
-.It Promise Ultra/Fasttrak-33
-Ultra DMA 33 (UDMA2), 33 MB/sec
-.It Promise Ultra/Fasttrak-66
-Ultra DMA 66 (UDMA4), 66 MB/sec
-.It Promise Ultra/Fasttrak-100
-Ultra DMA 100 (UDMA5), 100 MB/sec
-.It Promise Ultra/Fasttrak-100 TX2/TX4
-Ultra DMA 100 (UDMA5), 100 MB/sec
-.It Promise Ultra/Fasttrak-133 TX2/TX2000
-Ultra DMA 133 (UDMA6), 133 MB/sec
-.It ServerWorks ROSB4
-Ultra DMA 33 (UDMA2), 33 MB/sec
-.It ServerWorks CSB5
-Ultra DMA 100 (UDMA5), 100 MB/sec (depending on model, max stated at boot)
-.It Sil 0680
-Ultra DMA 133 (UDMA6), 133 MB/sec (depending on model, max stated at boot)
-.It SiS 5591
-Ultra DMA 100 (UDMA5), 100 MB/sec (depending on model, max stated at boot)
-.It VIA 82C586
-Ultra DMA 33 (UDMA2), 33 MB/sec
-.It VIA 82C596
-Ultra DMA 66 (UDMA4), 66 MB/sec (depending on model, max stated at boot)
-.It VIA 82C686a
-Ultra DMA 66 (UDMA4), 66 MB/sec
-.It VIA 82C686b
-Ultra DMA 100 (UDMA5), 100 MB/sec
-.It VIA 8233/8235
-Ultra DMA 133 (UDMA6), 133 MB/sec (depending on model, max stated at boot)
+The
+.Nm
+driver provides access to ATA (IDE) and SerialATA disk drives,
+ATAPI CDROM/DVD drives, ZIP/LS120 ATAPI drives and ATAPI tape drives
+connected to controllers according to the ATA/ATAPI standards. 
+.Pp
+The currently supported ATA/SATA controller chips are:
+.Pp
+.Bl -tag -width "Silicon Image:" -compact
+.It Acard:
+ATP850P, ATP860A, ATP860R, ATP865A, ATP865R
+.It ALI:
+Aladdin (ALi5229) compatible chips.
+.It AMD:
+AMD756, AMD766, AMD768, AMD8111.
+.It CMD:
+CMD646, CMD648, CMD649.
+.It Cyrix:
+Cyrix 5530.
+.It Cypress:
+Cypress 82C693.
+.It HighPoint:
+HPT302, HPT366, HPT366, HPT368, HPT370, HPT371, HPT372, HPT374.
+.It Intel:
+PIIX, PIIX3, PIIX4, ICH, ICH0, ICH2, ICH3, ICH4, ICH5.
+.It National:
+SC1100.
+.It nVidia:
+nForce, nForce2, nForce3.
+.It Promise:
+PDC20246, PDC20262, PDC20263, PDC20265, PDC20267, PDC20268, PDC20269, PDC20270, PDC20271, PDC20275, PDC20276, PDC20277, PDC20318, PDC20319, PDC20371, PDC20375, PDC20376, PDC20377, PDC20378, PDC20379, PDC20617, PDC20618, PDC20619, PDC20620.
+.It ServerWorks:
+ROSB4, CSB5, CSB6.
+.It Silicon Image:
+SiI0680, SiI3112.
+.It SiS:
+SIS5513, SIS530, SIS540, SIS550, SIS620, SIS630, SIS630S, SIS633, SIS635, SIS730, SIS733, SIS735, SIS745, SIS961, SIS962, SIS963
+.It VIA:
+VT82C586, VT82C586B, VT82C596, VT82C596B, VT82C686, VT82C686A, VT82C686B, VT8231, VT8233, VT8233A, VT8233C, VT8235, VT8237.
 .El
 .Pp
-All unknown chipsets are supported at the maximum speed of 16 MB/sec.
+Unknown ATA chipsets are supported in PIO modes, and if the standard 
+busmaster DMA registers are present and contains valid setup, DMA is
+also enabled, however the max mode is limitted to UDMA33, as it is
+not known what the chipset can do and how to program it.
 .Pp
 The
 .Nm
-driver also allows for changes to the transfer mode of the devices
-at a later time when the system is up and running, see
+driver can change the transfer mode and various other parameters
+when the system is up and running, see
 .Xr atacontrol 8 .
 .Pp
-The driver attempts to set the maximum performance transfer mode on your disk
-drives by selecting the highest possible DMA mode.
+The
+.nm
+driver sets the maximum transfer mode supported by the hardware as default.
 However the
 .Nm
-driver sometimes issues the message
-.Dq Sy "DMA limited to UDMA33, non-ATA66 cable or device" ,
-if the cable is ATA66 (or above) compliant, it is because the other device
-on this channel states it can only accept up to UDMA2/ATA33 signals.
-ATAPI devices are left in PIO mode because DMA problems are common despite the
-device specifications.
+driver sometimes warns:
+.Dq Sy "DMA limited to UDMA33, non-ATA66 cable or device"
+This means that
+the
+.Mn
+driver has detected that the needed 80 conductor cable is not present or
+at least could not be deteceted properly. If the cable is 80 conductor, 
+it can also be because one of the devices on the channel only accepts up 
+to UDMA2/ATA33.
+.Pp
+ATAPI devices are default set to PIO mode because severe DMA problems are
+common even if the device capabilities shows that it supports it.
 You can always try to set DMA mode on an ATAPI device using
 .Xr atacontrol 8 ,
 but be aware that your hardware might
 .Em not
-support it and can
+support it and can potentially
 .Em hang
-the system.
+the entire system causing data loss.
 .Sh FILES
 .Bl -tag -width ".Pa /sys/i386/conf/GENERIC" -compact
 .It Pa /dev/ad*
 ATA disk device nodes
+.It Pa /dev/ar*
+ATA RAID device nodes
 .It Pa /dev/acd*
 ATAPI CD-ROM device nodes
 .It Pa /dev/afd*
@@ -216,33 +186,21 @@ sample generic kernel config file for
 based systems
 .El
 .Sh NOTES
-Static numbering
+Please remember that in order to use UDMA4/ATA66 and above modes you
+.Em must
+use 80 conductor cables. Please assure that ribbon cables are no longer
+than 45cm's. In case of rounded ATA cables the length depends on the
+quality of the cables. SATA cables can be up to 1m long according to spec.
+.Pp
+Static device numbering
 (enabled with the
 .Dv ATA_STATIC_ID
 kernel option)
 reserves a number for each possibly connected disk,
-even when not present.
-This may result in odd situations where,
-for example,
-ad0 and ad2 exist in the absence of ad1.
-The advantage is that the addition of the formerly absent drive
-does not cause the numbers of the other drives to change.
+even when not present. This is usefull in hotswap senarios
+where disks always will show up as the same numbered device,
+and not depend on attach order.
 .Pp
-The
-.Nm
-driver does not support MFM/RLL/ESDI (ST-506) style disks.
-.Pp
-Remember that in order to use UDMA4 (and above) mode you
-.Em have
-to use a special 80 conductor cable,
-and the driver tries to determine if you have such a cable
-attached before setting UDMA4 mode.
-.Pp
-The use of UDMA4(66MHz) and higher together with non-UDMA4 devices on
-the same ATA channel is not recommended,
-unless they are run at the non-UDMA4 device's lower speed.
-The driver has been designed to handle that kind of setup but lots of
-older devices do not like this.
 .Sh SEE ALSO
 .Xr atacontrol 8 ,
 .Xr burncd 8
@@ -251,17 +209,7 @@ The
 .Nm
 driver first appeared in
 .Fx 4.0 .
-.Sh AUTHORS
-.An -nosplit
-The
-.Nm
-driver was written by
+.Sh AUTHOR
 .An S\(/oren Schmidt
 .Aq sos@FreeBSD.org .
 .Pp
-This manual page was written by
-.An Jeroen Ruigrok van der Werven
-.Aq asmodai@FreeBSD.org
-and
-.An S\(/oren Schmidt
-.Aq sos@FreeBSD.org .