Merge branch 'for-2.6.39' of git://linux-nfs.org/~bfields/linux

[pandora-kernel.git] / Documentation / DocBook / libata.tmpl

diff --git a/Documentation/DocBook/libata.tmpl b/Documentation/DocBook/libata.tmpl
index ff3e5be..cdd1bb9 100644 (file)
--- a/Documentation/DocBook/libata.tmpl
+++ b/Documentation/DocBook/libata.tmpl
@@ -81,16 +81,14 @@ void (*port_disable) (struct ata_port *);
        </programlisting>
 
        <para>
-       Called from ata_bus_probe() and ata_bus_reset() error paths,
-       as well as when unregistering from the SCSI module (rmmod, hot
-       unplug).
+       Called from ata_bus_probe() error path, as well as when
+       unregistering from the SCSI module (rmmod, hot unplug).
        This function should do whatever needs to be done to take the
        port out of use.  In most cases, ata_port_disable() can be used
        as this hook.
        </para>
        <para>
        Called from ata_bus_probe() on a failed probe.
-       Called from ata_bus_reset() on a failed bus reset.
        Called from ata_scsi_release().
        </para>
 
@@ -227,6 +225,18 @@ u8   (*sff_check_altstatus)(struct ata_port *ap);
 
        </sect2>
 
+       <sect2><title>Write specific ATA shadow register</title>
+       <programlisting>
+void (*sff_set_devctl)(struct ata_port *ap, u8 ctl);
+       </programlisting>
+
+       <para>
+       Write the device control ATA shadow register to the hardware.
+       Most drivers don't need to define this.
+       </para>
+
+       </sect2>
+
        <sect2><title>Select ATA device on bus</title>
        <programlisting>
 void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
@@ -477,7 +487,7 @@ void (*host_stop) (struct ata_host_set *host_set);
        allocates space for a legacy IDE PRD table and returns.
        </para>
        <para>
-       ->port_stop() is called after ->host_stop().  It's sole function
+       ->port_stop() is called after ->host_stop().  Its sole function
        is to release DMA/memory resources, now that they are no longer
        actively being used.  Many drivers also free driver-private
        data from port at this time.
@@ -1022,7 +1032,7 @@ and other resources, etc.
           <listitem>
           <para>
           This is indicated by ICRC bit in the ERROR register and
-          means that corruption occurred during data transfer.  Upto
+          means that corruption occurred during data transfer.  Up to
           ATA/ATAPI-7, the standard specifies that this bit is only
           applicable to UDMA transfers but ATA/ATAPI-8 draft revision
           1f says that the bit may be applicable to multiword DMA and
@@ -1035,10 +1045,10 @@ and other resources, etc.
           <term>ABRT error during data transfer or on completion</term>
           <listitem>
           <para>
-          Upto ATA/ATAPI-7, the standard specifies that ABRT could be
+          Up to ATA/ATAPI-7, the standard specifies that ABRT could be
           set on ICRC errors and on cases where a device is not able
           to complete a command.  Combined with the fact that MWDMA
-          and PIO transfer errors aren't allowed to use ICRC bit upto
+          and PIO transfer errors aren't allowed to use ICRC bit up to
           ATA/ATAPI-7, it seems to imply that ABRT bit alone could
           indicate tranfer errors.
           </para>
@@ -1112,7 +1122,7 @@ and other resources, etc.
        <para>
        Depending on commands, not all STATUS/ERROR bits are
        applicable.  These non-applicable bits are marked with
-       &quot;na&quot; in the output descriptions but upto ATA/ATAPI-7
+       &quot;na&quot; in the output descriptions but up to ATA/ATAPI-7
        no definition of &quot;na&quot; can be found.  However,
        ATA/ATAPI-8 draft revision 1f describes &quot;N/A&quot; as
        follows.
@@ -1497,7 +1507,7 @@ and other resources, etc.
 
        <listitem>
        <para>
-       CHS set up with INITIALIZE DEVICE PARAMETERS (seldomly used)
+       CHS set up with INITIALIZE DEVICE PARAMETERS (seldom used)
        </para>
        </listitem>