From owner-svn-src-all@FreeBSD.ORG Fri Sep 2 18:52:28 2011 Return-Path: Delivered-To: svn-src-all@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id 78749106566B; Fri, 2 Sep 2011 18:52:28 +0000 (UTC) (envelope-from brueffer@FreeBSD.org) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:4f8:fff6::2c]) by mx1.freebsd.org (Postfix) with ESMTP id 5DEB98FC0A; Fri, 2 Sep 2011 18:52:28 +0000 (UTC) Received: from svn.freebsd.org (localhost [127.0.0.1]) by svn.freebsd.org (8.14.4/8.14.4) with ESMTP id p82IqSjs011894; Fri, 2 Sep 2011 18:52:28 GMT (envelope-from brueffer@svn.freebsd.org) Received: (from brueffer@localhost) by svn.freebsd.org (8.14.4/8.14.4/Submit) id p82IqS0w011892; Fri, 2 Sep 2011 18:52:28 GMT (envelope-from brueffer@svn.freebsd.org) Message-Id: <201109021852.p82IqS0w011892@svn.freebsd.org> From: Christian Brueffer Date: Fri, 2 Sep 2011 18:52:28 +0000 (UTC) To: src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org X-SVN-Group: head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Cc: Subject: svn commit: r225352 - head/share/man/man4 X-BeenThere: svn-src-all@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "SVN commit messages for the entire src tree \(except for " user" and " projects" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 02 Sep 2011 18:52:28 -0000 Author: brueffer Date: Fri Sep 2 18:52:28 2011 New Revision: 225352 URL: http://svn.freebsd.org/changeset/base/225352 Log: Wording, grammar and markup cleanup. PR: 159948 Submitted by: Ben Kaduk Approved by: re (kib) Modified: head/share/man/man4/ata.4 Modified: head/share/man/man4/ata.4 ============================================================================== --- head/share/man/man4/ata.4 Fri Sep 2 18:52:17 2011 (r225351) +++ head/share/man/man4/ata.4 Fri Sep 2 18:52:28 2011 (r225352) @@ -74,47 +74,56 @@ 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. +The first line is for the common hardware independent code, and is a +prerequisite for the other modules. +The next three lines are generic bus-specific drivers. +Of the rest, ataahci is the AHCI driver. +The others are vendor-specific PCI drivers. +The +.Dv ATA_CAM +option should always remain in the kernel configuration, to make +the driver work as a +.Xr CAM 4 +subsystem module. .Pp The following tunables are settable from the .Xr loader 8 : .Bl -ohang .It Va hw.ata.ata_dma_check_80pin -set to 0 to disable the 80pin cable check (default is 1, check the cable) +set to 0 to disable the 80pin cable check (the default is 1, check the cable) .It Va hint.atapci.X.msi -set to 1 to allow Message Signalled Interrupts (MSI) to be used by +set to 1 to allow Message Signalled Interrupts (MSI) to be used by the specified PCI ATA controller, if supported. .It Va hint.ata.X.devX.mode -limits initial ATA mode for specified device on specified channel. +limits the initial ATA mode for the specified device on specified the channel. .It Va hint.ata.X.mode -limits initial ATA mode for every device on specified channel. +limits the initial ATA mode for every device on the specified channel. .It Va hint.ata.X.pm_level -controls SATA interface Power Management for specified channel, -allowing to save some power by the cost of additional command latency. +controls SATA interface Power Management for the specified channel, +allowing some power savings at the cost of additional command latency. Possible values: .Bl -tag -compact .It 0 -interface Power Management is disabled, default value. +Interface Power Management is disabled. +This is the default value. .It 1 -device is allowed to initiate PM state change, host is passive. +The device is allowed to initiate a PM state change; the host is passive. .It 2 -host initiates PARTIAL PM state transition every time port becomes idle. +The host initiates a PARTIAL PM state transition every time a port becomes idle. .It 3 host initiates SLUMBER PM state transition every time port becomes idle. .El -Modes 2 and 3 are supported only for AHCI. +Modes 2 and 3 are only supported for AHCI. .El .Sh DESCRIPTION The .Nm -driver provides the CAM(4) subsystem access to ATA (IDE) and SATA ports +driver gives the +.Xr CAM 4 +subsystem access to the ATA (IDE) and SATA ports of many generic controllers. -Depending on controller, each PATA port or each one or two SATA ports are +Depending on the controller, each PATA (IDE) +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. @@ -126,22 +135,23 @@ ATAPI devices are handled by the SCSI pr .Xr sa 4 , etc. .Pp -Driver supports ATA and for the most of controllers ATAPI devices. +This 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 +Device hot-plug and SATA interface power management is 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. +See the +.Cm negotiate +subcommand of +.Xr camcontrol 8 . .Pp The .Nm driver sets the maximum transfer mode supported by the hardware as default. -However the +However, the .Nm driver sometimes warns: .Dq Sy "DMA limited to UDMA33, non-ATA66 cable or device". @@ -247,10 +257,12 @@ The .Nm driver first appeared in .Fx 4.0 . -Turned into CAM(4) interface module in +It was turned into a +.Xr 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 . +.Aq sos@FreeBSD.org