lk/linux-kernel-test
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

libata: move EH docs to separate DocBook chapter

Browse Source
This commit is contained in:
Jeff Garzik
2005-09-28 13:26:47 -04:00
parent bfd00722ac
commit a1213499b0
1 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
Documentation/DocBook/libata.tmpl
View File

@@ -413,7 +413,9 @@ and other resources, etc.
</sect2> </sect2>
</sect1> </sect1>
<sect1> </chapter>
<chapter id="libataEH">
<title>Error handling</title> <title>Error handling</title>
<para> <para>
@@ -422,7 +424,7 @@ and other resources, etc.
(Documentation/scsi/scsi_eh.txt) and ATA exceptions doc first. (Documentation/scsi/scsi_eh.txt) and ATA exceptions doc first.
</para> </para>
<sect2><title>Origins of commands</title> <sect1><title>Origins of commands</title>
<para> <para>
In libata, a command is represented with struct ata_queued_cmd In libata, a command is represented with struct ata_queued_cmd
or qc. qc's are preallocated during port initialization and or qc. qc's are preallocated during port initialization and
@@ -437,9 +439,9 @@ and other resources, etc.
and commands for SCSI emulation are passed as SCSI commands and commands for SCSI emulation are passed as SCSI commands
through queuecommand callback of SCSI host template. through queuecommand callback of SCSI host template.
</para> </para>
</sect2> </sect1>
<sect2><title>How commands are issued</title> <sect1><title>How commands are issued</title>
<variablelist> <variablelist>
@@ -501,9 +503,9 @@ and other resources, etc.
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</sect2> </sect1>
<sect2><title>How commands are processed</title> <sect1><title>How commands are processed</title>
<para> <para>
Depending on which protocol and which controller are used, Depending on which protocol and which controller are used,
commands are processed differently. For the purpose of commands are processed differently. For the purpose of
@@ -562,9 +564,9 @@ and other resources, etc.
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</sect2> </sect1>
<sect2><title>How commands are completed</title> <sect1><title>How commands are completed</title>
<para> <para>
Once issued, all qc's are either completed with Once issued, all qc's are either completed with
ata_qc_complete() or time out. For commands which are handled ata_qc_complete() or time out. For commands which are handled
@@ -660,9 +662,9 @@ and other resources, etc.
This leads us to ata_scsi_error() with partially completed qc. This leads us to ata_scsi_error() with partially completed qc.
</para> </para>
</sect2> </sect1>
<sect2><title>ata_scsi_error()</title> <sect1><title>ata_scsi_error()</title>
<para> <para>
ata_scsi_error() is the current hostt->eh_strategy_handler() ata_scsi_error() is the current hostt->eh_strategy_handler()
for libata. As discussed above, this will be entered in two for libata. As discussed above, this will be entered in two
@@ -697,9 +699,9 @@ and other resources, etc.
to/cannot call ata_qc_complete() again. to/cannot call ata_qc_complete() again.
</para> </para>
</sect2> </sect1>
<sect2><title>Problems with the current EH</title> <sect1><title>Problems with the current EH</title>
<itemizedlist> <itemizedlist>
@@ -766,8 +768,6 @@ and other resources, etc.
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</sect2>
</sect1> </sect1>
</chapter> </chapter>