Date: Wed, 17 Aug 2011 19:43:41 +0000 (UTC) From: Alexander Motin <mav@FreeBSD.org> To: src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: svn commit: r224949 - head/share/man/man4 Message-ID: <201108171943.p7HJhffq020420@svn.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: mav Date: Wed Aug 17 19:43:41 2011 New Revision: 224949 URL: http://svn.freebsd.org/changeset/base/224949 Log: Update ata(4) manual page, reflecting migration to CAM-based ATA stack (`options ATA_CAM` enabled by default). Approved by: re (kib) Modified: head/share/man/man4/Makefile head/share/man/man4/ata.4 Modified: head/share/man/man4/Makefile ============================================================================== --- head/share/man/man4/Makefile Wed Aug 17 17:04:43 2011 (r224948) +++ head/share/man/man4/Makefile Wed Aug 17 19:43:41 2011 (r224949) @@ -526,10 +526,6 @@ MLINKS+=agp.4 agpgart.4 MLINKS+=ale.4 if_ale.4 MLINKS+=altq.4 ALTQ.4 MLINKS+=an.4 if_an.4 -MLINKS+=ata.4 acd.4 \ - ata.4 ad.4 \ - ata.4 afd.4 \ - ata.4 ast.4 MLINKS+=aue.4 if_aue.4 MLINKS+=axe.4 if_axe.4 MLINKS+=bce.4 if_bce.4 Modified: head/share/man/man4/ata.4 ============================================================================== --- head/share/man/man4/ata.4 Wed Aug 17 17:04:43 2011 (r224948) +++ head/share/man/man4/ata.4 Wed Aug 17 19:43:41 2011 (r224949) @@ -1,105 +1,91 @@ -.\" -.\" Copyright (c) 2003 Søren Schmidt <sos@FreeBSD.org> +.\" Copyright (c) 2011 Alexander Motin <mav@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, -.\" without modification, immediately at the beginning of the file. +.\" 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. 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. +.\" 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. .\" .\" $FreeBSD$ .\" -.Dd July 3, 2010 +.Dd August 17, 2011 .Dt ATA 4 .Os .Sh NAME -.Nm ata , -.Nm ar , -.Nm acd , -.Nm ad , -.Nm afd , -.Nm ast -.Nd generic ATA/ATAPI disk controller driver +.Nm ata +.Nd generic ATA/SATA controller driver .Sh SYNOPSIS -For ISA based ATA/ATAPI support: -.Cd device isa -.Cd device ata -.Pp -In -.Pa /boot/device.hints : -.Cd hint.ata.0.at="isa" -.Cd hint.ata.0.port="0x1f0" -.Cd hint.ata.0.irq="14" -.Cd hint.ata.1.at="isa" -.Cd hint.ata.1.port="0x170" -.Cd hint.ata.1.irq="15" -.Pp -For PC98 based ATA/ATAPI support: -.Cd device isa -.Cd device ata -.Pp -In -.Pa /boot/device.hints : -.Cd hint.atacbus.0.at="isa" -.Cd hint.atacbus.0.port="0x640" -.Cd hint.atacbus.0.irq="9" -.Pp -For PCI based ATA/ATAPI support: -.Cd device pci -.Cd device ata -.Pp -To support ATA compliant disk drives: -.Cd device atadisk -.Pp -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: -.Cd device atapifd +To compile this driver into the kernel, place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device scbus" +.Cd "device ata" +.Cd "options ATA_CAM" +.Ed +.Pp +Alternatively, to load the driver as set of modules at boot time, +place some of the following lines in +.Xr loader.conf 5 : +.Bd -literal -offset indent +ata_load="YES" + +atacard_load="YES" +ataisa_load="YES" +atapci_load="YES" + +ataacard_load="YES" +ataacerlabs_load="YES" +ataadaptec_load="YES" +ataahci_load="YES" +ataamd_load="YES" +ataati_load="YES" +atacenatek_load="YES" +atacypress_load="YES" +atacyrix_load="YES" +atahighpoint_load="YES" +ataintel_load="YES" +ataite_load="YES" +atajmicron_load="YES" +atamarvell_load="YES" +atamicron_load="YES" +atanational_load="YES" +atanetcell_load="YES" +atanvidia_load="YES" +atapromise_load="YES" +ataserverworks_load="YES" +atasiliconimage_load="YES" +atasis_load="YES" +atavia_load="YES" +.Ed +.Pp +First line is common hardware independent code. +Next three lines are generic bus-specific drivers. +ataahci is AHCI driver. +The rest are vendor-specific PCI drivers. +ATA_CAM option should always remain in kernel configuration to make +the driver work as CAM(4) subsystem module. .Pp -To support ATAPI tape drives: -.Cd device atapist -.Pp -To turn -.Xr ata 4 -subsystem controller drivers into cam(4) interface modules (disables all native -.Xr ata 4 -APIs and peripheral drivers): -.Cd options ATA_CAM -.Pp -The following tunables are settable from the loader: +The following tunables are settable from the +.Xr loader 8 : .Bl -ohang -.It Va hw.ata.ata_dma -set to 1 for DMA access, 0 for PIO (default is DMA). .It Va hw.ata.ata_dma_check_80pin set to 0 to disable the 80pin cable check (default is 1, check the cable) -.It Va hw.ata.atapi_dma -set to 1 for DMA access, 0 for PIO (default is DMA). -.It Va hw.ata.wc -set to 1 to enable Write Caching, 0 to disable (default is enabled). -.Em WARNING : -can cause data loss on power failures and crashes. .It Va hint.atapci.X.msi set to 1 to allow Message Signalled Interrupts (MSI) to be used by specified PCI ATA controller, if supported. @@ -121,15 +107,55 @@ host initiates PARTIAL PM state transiti .It 3 host initiates SLUMBER PM state transition every time port becomes idle. .El -Modes 2 and 3 are implemented only for AHCI driver now. +Modes 2 and 3 are supported only for AHCI. .El .Sh DESCRIPTION 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. +driver provides the CAM(4) subsystem access to ATA (IDE) and SATA ports +of many generic controllers. +Depending on controller, each PATA port or each one or two SATA ports are +represented to CAM as a separate bus with one or two targets. +Most of the bus-management details are handled by the ATA/SATA-specific +transport of CAM. +Connected ATA disks are handled by the ATA protocol disk peripheral driver +.Xr ada 4 . +ATAPI devices are handled by the SCSI protocol peripheral drivers +.Xr cd 4 , +.Xr da 4 , +.Xr sa 4 , +etc. +.Pp +Driver supports ATA and for the most of controllers ATAPI devices. +Command queuing and SATA port multipliers are not supported. +Device hot-plug and SATA interface power management supported only on +some controllers. +.Pp +The +.Nm +driver can change the transfer mode when the system is up and running. +See +.Xr camcontrol 8 +negotiate subcommand. .Pp +The +.Nm +driver sets the maximum transfer mode supported by the hardware as default. +However the +.Nm +driver sometimes warns: +.Dq Sy "DMA limited to UDMA33, non-ATA66 cable or device". +This means that +the +.Nm +driver has detected that the required 80 conductor cable is not present +or could not be detected properly, +or that one of the devices on the channel only accepts up +to UDMA2/ATA33. +The +.Va hw.ata.ata_dma_check_80pin +tunable can be set to 0 to disable this check. +.Sh HARDWARE The currently supported ATA/SATA controller chips are: .Pp .Bl -tag -width "Silicon Image:" -compact @@ -186,72 +212,18 @@ VT82C686A, VT82C686B, VT8231, VT8233, VT VT8237A, VT8237S, VT8251, CX700, VX800, VX855, VX900. .El .Pp +Some of above chips are also supported by the more featured +.Xr ahci 4 , +.Xr mvs 4 , +and +.Xr siis 4 +drivers. +If both drivers are loaded at the same time, those will have precedence. +.Pp Unknown ATA chipsets are supported in PIO modes, and if the standard busmaster DMA registers are present and contain valid setup, DMA is also enabled, although the max mode is limited to UDMA33, as it is not known what the chipset can do and how to program it. -.Pp -The -.Nm -driver can change the transfer mode and various other parameters -when the system is up and running. -See -.Xr atacontrol 8 . -.Pp -The -.Nm -driver sets the maximum transfer mode supported by the hardware as default. -However the -.Nm -driver sometimes warns: -.Dq Sy "DMA limited to UDMA33, non-ATA66 cable or device". -This means that -the -.Nm -driver has detected that the required 80 conductor cable is not present -or could not be detected properly, -or that one of the devices on the channel only accepts up -to UDMA2/ATA33. -The -.Va hw.ata.ata_dma_check_80pin -tunable can be set to 0 to disable this check. -.Pp -Unknown ATAPI devices are initialized to DMA mode if the -.Va hw.ata.atapi_dma -tunable is set to 1 and they support at least UDMA33 transfers. -Otherwise they are set to PIO mode because severe DMA problems are -common even if the device capabilities indicate support. -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 potentially -.Em hang -the entire system causing data loss. -.Pp -The -.Nm acd -driver implements most of the -.Fn ioctl -requests documented by -.Xr cd 4 . -.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* -ATAPI floppy drive device nodes -.It Pa /dev/ast* -ATAPI tape drive device nodes -.It Pa /sys/i386/conf/GENERIC -sample generic kernel config file for -.Nm -based systems -.El .Sh NOTES Please remember that in order to use UDMA4/ATA66 and above modes you .Em must @@ -260,31 +232,25 @@ Please assure that ribbon cables are no 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 the specification. -.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 is useful in hotswap scenarios -where disks should always show up as the same numbered device, -and not depend on attach order. -.Pp -Native Command Queuing (NCQ) on SATA drives is not yet supported. +External SATA cables can be 2m long and more, but not all controllers +work well on long cables, especially at high speeds. .Sh SEE ALSO +.Xr ada 4 , .Xr ahci 4 , .Xr cam 4 , -.Xr ataraid 4 , -.Xr atacontrol 8 , -.Xr burncd 8 , +.Xr camcontrol 8 , .Xr cd 4 , +.Xr mvs 4 , .Xr siis 4 .Sh HISTORY The .Nm driver first appeared in .Fx 4.0 . +Turned into CAM(4) interface module in +.Fx 9.0 . .Sh AUTHORS +.An Alexander Motin +.Aq mav@FreeBSD.org , .An S\(/oren Schmidt .Aq sos@FreeBSD.org .
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201108171943.p7HJhffq020420>