]> err.no Git - linux-2.6/blob - Documentation/DocBook/libata.tmpl
libata: move EH docs to separate DocBook chapter
[linux-2.6] / Documentation / DocBook / libata.tmpl
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3         "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
4
5 <book id="libataDevGuide">
6  <bookinfo>
7   <title>libATA Developer's Guide</title>
8   
9   <authorgroup>
10    <author>
11     <firstname>Jeff</firstname>
12     <surname>Garzik</surname>
13    </author>
14   </authorgroup>
15
16   <copyright>
17    <year>2003-2005</year>
18    <holder>Jeff Garzik</holder>
19   </copyright>
20
21   <legalnotice>
22    <para>
23    The contents of this file are subject to the Open
24    Software License version 1.1 that can be found at
25    <ulink url="http://www.opensource.org/licenses/osl-1.1.txt">http://www.opensource.org/licenses/osl-1.1.txt</ulink> and is included herein
26    by reference.
27    </para>
28
29    <para>
30    Alternatively, the contents of this file may be used under the terms
31    of the GNU General Public License version 2 (the "GPL") as distributed
32    in the kernel source COPYING file, in which case the provisions of
33    the GPL are applicable instead of the above.  If you wish to allow
34    the use of your version of this file only under the terms of the
35    GPL and not to allow others to use your version of this file under
36    the OSL, indicate your decision by deleting the provisions above and
37    replace them with the notice and other provisions required by the GPL.
38    If you do not delete the provisions above, a recipient may use your
39    version of this file under either the OSL or the GPL.
40    </para>
41
42   </legalnotice>
43  </bookinfo>
44
45 <toc></toc>
46
47   <chapter id="libataIntroduction">
48      <title>Introduction</title>
49   <para>
50   libATA is a library used inside the Linux kernel to support ATA host
51   controllers and devices.  libATA provides an ATA driver API, class
52   transports for ATA and ATAPI devices, and SCSI&lt;-&gt;ATA translation
53   for ATA devices according to the T10 SAT specification.
54   </para>
55   <para>
56   This Guide documents the libATA driver API, library functions, library
57   internals, and a couple sample ATA low-level drivers.
58   </para>
59   </chapter>
60
61   <chapter id="libataDriverApi">
62      <title>libata Driver API</title>
63      <para>
64      struct ata_port_operations is defined for every low-level libata
65      hardware driver, and it controls how the low-level driver
66      interfaces with the ATA and SCSI layers.
67      </para>
68      <para>
69      FIS-based drivers will hook into the system with ->qc_prep() and
70      ->qc_issue() high-level hooks.  Hardware which behaves in a manner
71      similar to PCI IDE hardware may utilize several generic helpers,
72      defining at a bare minimum the bus I/O addresses of the ATA shadow
73      register blocks.
74      </para>
75      <sect1>
76         <title>struct ata_port_operations</title>
77
78         <sect2><title>Disable ATA port</title>
79         <programlisting>
80 void (*port_disable) (struct ata_port *);
81         </programlisting>
82
83         <para>
84         Called from ata_bus_probe() and ata_bus_reset() error paths,
85         as well as when unregistering from the SCSI module (rmmod, hot
86         unplug).
87         This function should do whatever needs to be done to take the
88         port out of use.  In most cases, ata_port_disable() can be used
89         as this hook.
90         </para>
91         <para>
92         Called from ata_bus_probe() on a failed probe.
93         Called from ata_bus_reset() on a failed bus reset.
94         Called from ata_scsi_release().
95         </para>
96
97         </sect2>
98
99         <sect2><title>Post-IDENTIFY device configuration</title>
100         <programlisting>
101 void (*dev_config) (struct ata_port *, struct ata_device *);
102         </programlisting>
103
104         <para>
105         Called after IDENTIFY [PACKET] DEVICE is issued to each device
106         found.  Typically used to apply device-specific fixups prior to
107         issue of SET FEATURES - XFER MODE, and prior to operation.
108         </para>
109         <para>
110         Called by ata_device_add() after ata_dev_identify() determines
111         a device is present.
112         </para>
113         <para>
114         This entry may be specified as NULL in ata_port_operations.
115         </para>
116
117         </sect2>
118
119         <sect2><title>Set PIO/DMA mode</title>
120         <programlisting>
121 void (*set_piomode) (struct ata_port *, struct ata_device *);
122 void (*set_dmamode) (struct ata_port *, struct ata_device *);
123 void (*post_set_mode) (struct ata_port *ap);
124         </programlisting>
125
126         <para>
127         Hooks called prior to the issue of SET FEATURES - XFER MODE
128         command.  dev->pio_mode is guaranteed to be valid when
129         ->set_piomode() is called, and dev->dma_mode is guaranteed to be
130         valid when ->set_dmamode() is called.  ->post_set_mode() is
131         called unconditionally, after the SET FEATURES - XFER MODE
132         command completes successfully.
133         </para>
134
135         <para>
136         ->set_piomode() is always called (if present), but
137         ->set_dma_mode() is only called if DMA is possible.
138         </para>
139
140         </sect2>
141
142         <sect2><title>Taskfile read/write</title>
143         <programlisting>
144 void (*tf_load) (struct ata_port *ap, struct ata_taskfile *tf);
145 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
146         </programlisting>
147
148         <para>
149         ->tf_load() is called to load the given taskfile into hardware
150         registers / DMA buffers.  ->tf_read() is called to read the
151         hardware registers / DMA buffers, to obtain the current set of
152         taskfile register values.
153         Most drivers for taskfile-based hardware (PIO or MMIO) use
154         ata_tf_load() and ata_tf_read() for these hooks.
155         </para>
156
157         </sect2>
158
159         <sect2><title>ATA command execute</title>
160         <programlisting>
161 void (*exec_command)(struct ata_port *ap, struct ata_taskfile *tf);
162         </programlisting>
163
164         <para>
165         causes an ATA command, previously loaded with
166         ->tf_load(), to be initiated in hardware.
167         Most drivers for taskfile-based hardware use ata_exec_command()
168         for this hook.
169         </para>
170
171         </sect2>
172
173         <sect2><title>Per-cmd ATAPI DMA capabilities filter</title>
174         <programlisting>
175 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
176         </programlisting>
177
178         <para>
179 Allow low-level driver to filter ATA PACKET commands, returning a status
180 indicating whether or not it is OK to use DMA for the supplied PACKET
181 command.
182         </para>
183         <para>
184         This hook may be specified as NULL, in which case libata will
185         assume that atapi dma can be supported.
186         </para>
187
188         </sect2>
189
190         <sect2><title>Read specific ATA shadow registers</title>
191         <programlisting>
192 u8   (*check_status)(struct ata_port *ap);
193 u8   (*check_altstatus)(struct ata_port *ap);
194 u8   (*check_err)(struct ata_port *ap);
195         </programlisting>
196
197         <para>
198         Reads the Status/AltStatus/Error ATA shadow register from
199         hardware.  On some hardware, reading the Status register has
200         the side effect of clearing the interrupt condition.
201         Most drivers for taskfile-based hardware use
202         ata_check_status() for this hook.
203         </para>
204         <para>
205         Note that because this is called from ata_device_add(), at
206         least a dummy function that clears device interrupts must be
207         provided for all drivers, even if the controller doesn't
208         actually have a taskfile status register.
209         </para>
210
211         </sect2>
212
213         <sect2><title>Select ATA device on bus</title>
214         <programlisting>
215 void (*dev_select)(struct ata_port *ap, unsigned int device);
216         </programlisting>
217
218         <para>
219         Issues the low-level hardware command(s) that causes one of N
220         hardware devices to be considered 'selected' (active and
221         available for use) on the ATA bus.  This generally has no
222         meaning on FIS-based devices.
223         </para>
224         <para>
225         Most drivers for taskfile-based hardware use
226         ata_std_dev_select() for this hook.  Controllers which do not
227         support second drives on a port (such as SATA contollers) will
228         use ata_noop_dev_select().
229         </para>
230
231         </sect2>
232
233         <sect2><title>Reset ATA bus</title>
234         <programlisting>
235 void (*phy_reset) (struct ata_port *ap);
236         </programlisting>
237
238         <para>
239         The very first step in the probe phase.  Actions vary depending
240         on the bus type, typically.  After waking up the device and probing
241         for device presence (PATA and SATA), typically a soft reset
242         (SRST) will be performed.  Drivers typically use the helper
243         functions ata_bus_reset() or sata_phy_reset() for this hook.
244         Many SATA drivers use sata_phy_reset() or call it from within
245         their own phy_reset() functions.
246         </para>
247
248         </sect2>
249
250         <sect2><title>Control PCI IDE BMDMA engine</title>
251         <programlisting>
252 void (*bmdma_setup) (struct ata_queued_cmd *qc);
253 void (*bmdma_start) (struct ata_queued_cmd *qc);
254 void (*bmdma_stop) (struct ata_port *ap);
255 u8   (*bmdma_status) (struct ata_port *ap);
256         </programlisting>
257
258         <para>
259 When setting up an IDE BMDMA transaction, these hooks arm
260 (->bmdma_setup), fire (->bmdma_start), and halt (->bmdma_stop)
261 the hardware's DMA engine.  ->bmdma_status is used to read the standard
262 PCI IDE DMA Status register.
263         </para>
264
265         <para>
266 These hooks are typically either no-ops, or simply not implemented, in
267 FIS-based drivers.
268         </para>
269         <para>
270 Most legacy IDE drivers use ata_bmdma_setup() for the bmdma_setup()
271 hook.  ata_bmdma_setup() will write the pointer to the PRD table to
272 the IDE PRD Table Address register, enable DMA in the DMA Command
273 register, and call exec_command() to begin the transfer.
274         </para>
275         <para>
276 Most legacy IDE drivers use ata_bmdma_start() for the bmdma_start()
277 hook.  ata_bmdma_start() will write the ATA_DMA_START flag to the DMA
278 Command register.
279         </para>
280         <para>
281 Many legacy IDE drivers use ata_bmdma_stop() for the bmdma_stop()
282 hook.  ata_bmdma_stop() clears the ATA_DMA_START flag in the DMA
283 command register.
284         </para>
285         <para>
286 Many legacy IDE drivers use ata_bmdma_status() as the bmdma_status() hook.
287         </para>
288
289         </sect2>
290
291         <sect2><title>High-level taskfile hooks</title>
292         <programlisting>
293 void (*qc_prep) (struct ata_queued_cmd *qc);
294 int (*qc_issue) (struct ata_queued_cmd *qc);
295         </programlisting>
296
297         <para>
298         Higher-level hooks, these two hooks can potentially supercede
299         several of the above taskfile/DMA engine hooks.  ->qc_prep is
300         called after the buffers have been DMA-mapped, and is typically
301         used to populate the hardware's DMA scatter-gather table.
302         Most drivers use the standard ata_qc_prep() helper function, but
303         more advanced drivers roll their own.
304         </para>
305         <para>
306         ->qc_issue is used to make a command active, once the hardware
307         and S/G tables have been prepared.  IDE BMDMA drivers use the
308         helper function ata_qc_issue_prot() for taskfile protocol-based
309         dispatch.  More advanced drivers implement their own ->qc_issue.
310         </para>
311         <para>
312         ata_qc_issue_prot() calls ->tf_load(), ->bmdma_setup(), and
313         ->bmdma_start() as necessary to initiate a transfer.
314         </para>
315
316         </sect2>
317
318         <sect2><title>Timeout (error) handling</title>
319         <programlisting>
320 void (*eng_timeout) (struct ata_port *ap);
321         </programlisting>
322
323         <para>
324 This is a high level error handling function, called from the
325 error handling thread, when a command times out.  Most newer
326 hardware will implement its own error handling code here.  IDE BMDMA
327 drivers may use the helper function ata_eng_timeout().
328         </para>
329
330         </sect2>
331
332         <sect2><title>Hardware interrupt handling</title>
333         <programlisting>
334 irqreturn_t (*irq_handler)(int, void *, struct pt_regs *);
335 void (*irq_clear) (struct ata_port *);
336         </programlisting>
337
338         <para>
339         ->irq_handler is the interrupt handling routine registered with
340         the system, by libata.  ->irq_clear is called during probe just
341         before the interrupt handler is registered, to be sure hardware
342         is quiet.
343         </para>
344         <para>
345         The second argument, dev_instance, should be cast to a pointer
346         to struct ata_host_set.
347         </para>
348         <para>
349         Most legacy IDE drivers use ata_interrupt() for the
350         irq_handler hook, which scans all ports in the host_set,
351         determines which queued command was active (if any), and calls
352         ata_host_intr(ap,qc).
353         </para>
354         <para>
355         Most legacy IDE drivers use ata_bmdma_irq_clear() for the
356         irq_clear() hook, which simply clears the interrupt and error
357         flags in the DMA status register.
358         </para>
359
360         </sect2>
361
362         <sect2><title>SATA phy read/write</title>
363         <programlisting>
364 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
365 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
366                    u32 val);
367         </programlisting>
368
369         <para>
370         Read and write standard SATA phy registers.  Currently only used
371         if ->phy_reset hook called the sata_phy_reset() helper function.
372         sc_reg is one of SCR_STATUS, SCR_CONTROL, SCR_ERROR, or SCR_ACTIVE.
373         </para>
374
375         </sect2>
376
377         <sect2><title>Init and shutdown</title>
378         <programlisting>
379 int (*port_start) (struct ata_port *ap);
380 void (*port_stop) (struct ata_port *ap);
381 void (*host_stop) (struct ata_host_set *host_set);
382         </programlisting>
383
384         <para>
385         ->port_start() is called just after the data structures for each
386         port are initialized.  Typically this is used to alloc per-port
387         DMA buffers / tables / rings, enable DMA engines, and similar
388         tasks.  Some drivers also use this entry point as a chance to
389         allocate driver-private memory for ap->private_data.
390         </para>
391         <para>
392         Many drivers use ata_port_start() as this hook or call
393         it from their own port_start() hooks.  ata_port_start()
394         allocates space for a legacy IDE PRD table and returns.
395         </para>
396         <para>
397         ->port_stop() is called after ->host_stop().  It's sole function
398         is to release DMA/memory resources, now that they are no longer
399         actively being used.  Many drivers also free driver-private
400         data from port at this time.
401         </para>
402         <para>
403         Many drivers use ata_port_stop() as this hook, which frees the
404         PRD table.
405         </para>
406         <para>
407         ->host_stop() is called after all ->port_stop() calls
408 have completed.  The hook must finalize hardware shutdown, release DMA
409 and other resources, etc.
410         This hook may be specified as NULL, in which case it is not called.
411         </para>
412
413         </sect2>
414
415      </sect1>
416   </chapter>
417
418   <chapter id="libataEH">
419         <title>Error handling</title>
420
421         <para>
422         This chapter describes how errors are handled under libata.
423         Readers are advised to read SCSI EH
424         (Documentation/scsi/scsi_eh.txt) and ATA exceptions doc first.
425         </para>
426
427         <sect1><title>Origins of commands</title>
428         <para>
429         In libata, a command is represented with struct ata_queued_cmd
430         or qc.  qc's are preallocated during port initialization and
431         repetitively used for command executions.  Currently only one
432         qc is allocated per port but yet-to-be-merged NCQ branch
433         allocates one for each tag and maps each qc to NCQ tag 1-to-1.
434         </para>
435         <para>
436         libata commands can originate from two sources - libata itself
437         and SCSI midlayer.  libata internal commands are used for
438         initialization and error handling.  All normal blk requests
439         and commands for SCSI emulation are passed as SCSI commands
440         through queuecommand callback of SCSI host template.
441         </para>
442         </sect1>
443
444         <sect1><title>How commands are issued</title>
445
446         <variablelist>
447
448         <varlistentry><term>Internal commands</term>
449         <listitem>
450         <para>
451         First, qc is allocated and initialized using
452         ata_qc_new_init().  Although ata_qc_new_init() doesn't
453         implement any wait or retry mechanism when qc is not
454         available, internal commands are currently issued only during
455         initialization and error recovery, so no other command is
456         active and allocation is guaranteed to succeed.
457         </para>
458         <para>
459         Once allocated qc's taskfile is initialized for the command to
460         be executed.  qc currently has two mechanisms to notify
461         completion.  One is via qc->complete_fn() callback and the
462         other is completion qc->waiting.  qc->complete_fn() callback
463         is the asynchronous path used by normal SCSI translated
464         commands and qc->waiting is the synchronous (issuer sleeps in
465         process context) path used by internal commands.
466         </para>
467         <para>
468         Once initialization is complete, host_set lock is acquired
469         and the qc is issued.
470         </para>
471         </listitem>
472         </varlistentry>
473
474         <varlistentry><term>SCSI commands</term>
475         <listitem>
476         <para>
477         All libata drivers use ata_scsi_queuecmd() as
478         hostt->queuecommand callback.  scmds can either be simulated
479         or translated.  No qc is involved in processing a simulated
480         scmd.  The result is computed right away and the scmd is
481         completed.
482         </para>
483         <para>
484         For a translated scmd, ata_qc_new_init() is invoked to
485         allocate a qc and the scmd is translated into the qc.  SCSI
486         midlayer's completion notification function pointer is stored
487         into qc->scsidone.
488         </para>
489         <para>
490         qc->complete_fn() callback is used for completion
491         notification.  ATA commands use ata_scsi_qc_complete() while
492         ATAPI commands use atapi_qc_complete().  Both functions end up
493         calling qc->scsidone to notify upper layer when the qc is
494         finished.  After translation is completed, the qc is issued
495         with ata_qc_issue().
496         </para>
497         <para>
498         Note that SCSI midlayer invokes hostt->queuecommand while
499         holding host_set lock, so all above occur while holding
500         host_set lock.
501         </para>
502         </listitem>
503         </varlistentry>
504
505         </variablelist>
506         </sect1>
507
508         <sect1><title>How commands are processed</title>
509         <para>
510         Depending on which protocol and which controller are used,
511         commands are processed differently.  For the purpose of
512         discussion, a controller which uses taskfile interface and all
513         standard callbacks is assumed.
514         </para>
515         <para>
516         Currently 6 ATA command protocols are used.  They can be
517         sorted into the following four categories according to how
518         they are processed.
519         </para>
520
521         <variablelist>
522            <varlistentry><term>ATA NO DATA or DMA</term>
523            <listitem>
524            <para>
525            ATA_PROT_NODATA and ATA_PROT_DMA fall into this category.
526            These types of commands don't require any software
527            intervention once issued.  Device will raise interrupt on
528            completion.
529            </para>
530            </listitem>
531            </varlistentry>
532
533            <varlistentry><term>ATA PIO</term>
534            <listitem>
535            <para>
536            ATA_PROT_PIO is in this category.  libata currently
537            implements PIO with polling.  ATA_NIEN bit is set to turn
538            off interrupt and pio_task on ata_wq performs polling and
539            IO.
540            </para>
541            </listitem>
542            </varlistentry>
543
544            <varlistentry><term>ATAPI NODATA or DMA</term>
545            <listitem>
546            <para>
547            ATA_PROT_ATAPI_NODATA and ATA_PROT_ATAPI_DMA are in this
548            category.  packet_task is used to poll BSY bit after
549            issuing PACKET command.  Once BSY is turned off by the
550            device, packet_task transfers CDB and hands off processing
551            to interrupt handler.
552            </para>
553            </listitem>
554            </varlistentry>
555
556            <varlistentry><term>ATAPI PIO</term>
557            <listitem>
558            <para>
559            ATA_PROT_ATAPI is in this category.  ATA_NIEN bit is set
560            and, as in ATAPI NODATA or DMA, packet_task submits cdb.
561            However, after submitting cdb, further processing (data
562            transfer) is handed off to pio_task.
563            </para>
564            </listitem>
565            </varlistentry>
566         </variablelist>
567         </sect1>
568
569         <sect1><title>How commands are completed</title>
570         <para>
571         Once issued, all qc's are either completed with
572         ata_qc_complete() or time out.  For commands which are handled
573         by interrupts, ata_host_intr() invokes ata_qc_complete(), and,
574         for PIO tasks, pio_task invokes ata_qc_complete().  In error
575         cases, packet_task may also complete commands.
576         </para>
577         <para>
578         ata_qc_complete() does the following.
579         </para>
580
581         <orderedlist>
582
583         <listitem>
584         <para>
585         DMA memory is unmapped.
586         </para>
587         </listitem>
588
589         <listitem>
590         <para>
591         ATA_QCFLAG_ACTIVE is clared from qc->flags.
592         </para>
593         </listitem>
594
595         <listitem>
596         <para>
597         qc->complete_fn() callback is invoked.  If the return value of
598         the callback is not zero.  Completion is short circuited and
599         ata_qc_complete() returns.
600         </para>
601         </listitem>
602
603         <listitem>
604         <para>
605         __ata_qc_complete() is called, which does
606            <orderedlist>
607
608            <listitem>
609            <para>
610            qc->flags is cleared to zero.
611            </para>
612            </listitem>
613
614            <listitem>
615            <para>
616            ap->active_tag and qc->tag are poisoned.
617            </para>
618            </listitem>
619
620            <listitem>
621            <para>
622            qc->waiting is claread &amp; completed (in that order).
623            </para>
624            </listitem>
625
626            <listitem>
627            <para>
628            qc is deallocated by clearing appropriate bit in ap->qactive.
629            </para>
630            </listitem>
631
632            </orderedlist>
633         </para>
634         </listitem>
635
636         </orderedlist>
637
638         <para>
639         So, it basically notifies upper layer and deallocates qc.  One
640         exception is short-circuit path in #3 which is used by
641         atapi_qc_complete().
642         </para>
643         <para>
644         For all non-ATAPI commands, whether it fails or not, almost
645         the same code path is taken and very little error handling
646         takes place.  A qc is completed with success status if it
647         succeeded, with failed status otherwise.
648         </para>
649         <para>
650         However, failed ATAPI commands require more handling as
651         REQUEST SENSE is needed to acquire sense data.  If an ATAPI
652         command fails, ata_qc_complete() is invoked with error status,
653         which in turn invokes atapi_qc_complete() via
654         qc->complete_fn() callback.
655         </para>
656         <para>
657         This makes atapi_qc_complete() set scmd->result to
658         SAM_STAT_CHECK_CONDITION, complete the scmd and return 1.  As
659         the sense data is empty but scmd->result is CHECK CONDITION,
660         SCSI midlayer will invoke EH for the scmd, and returning 1
661         makes ata_qc_complete() to return without deallocating the qc.
662         This leads us to ata_scsi_error() with partially completed qc.
663         </para>
664
665         </sect1>
666
667         <sect1><title>ata_scsi_error()</title>
668         <para>
669         ata_scsi_error() is the current hostt->eh_strategy_handler()
670         for libata.  As discussed above, this will be entered in two
671         cases - timeout and ATAPI error completion.  This function
672         calls low level libata driver's eng_timeout() callback, the
673         standard callback for which is ata_eng_timeout().  It checks
674         if a qc is active and calls ata_qc_timeout() on the qc if so.
675         Actual error handling occurs in ata_qc_timeout().
676         </para>
677         <para>
678         If EH is invoked for timeout, ata_qc_timeout() stops BMDMA and
679         completes the qc.  Note that as we're currently in EH, we
680         cannot call scsi_done.  As described in SCSI EH doc, a
681         recovered scmd should be either retried with
682         scsi_queue_insert() or finished with scsi_finish_command().
683         Here, we override qc->scsidone with scsi_finish_command() and
684         calls ata_qc_complete().
685         </para>
686         <para>
687         If EH is invoked due to a failed ATAPI qc, the qc here is
688         completed but not deallocated.  The purpose of this
689         half-completion is to use the qc as place holder to make EH
690         code reach this place.  This is a bit hackish, but it works.
691         </para>
692         <para>
693         Once control reaches here, the qc is deallocated by invoking
694         __ata_qc_complete() explicitly.  Then, internal qc for REQUEST
695         SENSE is issued.  Once sense data is acquired, scmd is
696         finished by directly invoking scsi_finish_command() on the
697         scmd.  Note that as we already have completed and deallocated
698         the qc which was associated with the scmd, we don't need
699         to/cannot call ata_qc_complete() again.
700         </para>
701
702         </sect1>
703
704         <sect1><title>Problems with the current EH</title>
705
706         <itemizedlist>
707
708         <listitem>
709         <para>
710         Error representation is too crude.  Currently any and all
711         error conditions are represented with ATA STATUS and ERROR
712         registers.  Errors which aren't ATA device errors are treated
713         as ATA device errors by setting ATA_ERR bit.  Better error
714         descriptor which can properly represent ATA and other
715         errors/exceptions is needed.
716         </para>
717         </listitem>
718
719         <listitem>
720         <para>
721         When handling timeouts, no action is taken to make device
722         forget about the timed out command and ready for new commands.
723         </para>
724         </listitem>
725
726         <listitem>
727         <para>
728         EH handling via ata_scsi_error() is not properly protected
729         from usual command processing.  On EH entrance, the device is
730         not in quiescent state.  Timed out commands may succeed or
731         fail any time.  pio_task and atapi_task may still be running.
732         </para>
733         </listitem>
734
735         <listitem>
736         <para>
737         Too weak error recovery.  Devices / controllers causing HSM
738         mismatch errors and other errors quite often require reset to
739         return to known state.  Also, advanced error handling is
740         necessary to support features like NCQ and hotplug.
741         </para>
742         </listitem>
743
744         <listitem>
745         <para>
746         ATA errors are directly handled in the interrupt handler and
747         PIO errors in pio_task.  This is problematic for advanced
748         error handling for the following reasons.
749         </para>
750         <para>
751         First, advanced error handling often requires context and
752         internal qc execution.
753         </para>
754         <para>
755         Second, even a simple failure (say, CRC error) needs
756         information gathering and could trigger complex error handling
757         (say, resetting &amp; reconfiguring).  Having multiple code
758         paths to gather information, enter EH and trigger actions
759         makes life painful.
760         </para>
761         <para>
762         Third, scattered EH code makes implementing low level drivers
763         difficult.  Low level drivers override libata callbacks.  If
764         EH is scattered over several places, each affected callbacks
765         should perform its part of error handling.  This can be error
766         prone and painful.
767         </para>
768         </listitem>
769
770         </itemizedlist>
771         </sect1>
772   </chapter>
773
774   <chapter id="libataExt">
775      <title>libata Library</title>
776 !Edrivers/scsi/libata-core.c
777   </chapter>
778
779   <chapter id="libataInt">
780      <title>libata Core Internals</title>
781 !Idrivers/scsi/libata-core.c
782   </chapter>
783
784   <chapter id="libataScsiInt">
785      <title>libata SCSI translation/emulation</title>
786 !Edrivers/scsi/libata-scsi.c
787 !Idrivers/scsi/libata-scsi.c
788   </chapter>
789
790   <chapter id="PiixInt">
791      <title>ata_piix Internals</title>
792 !Idrivers/scsi/ata_piix.c
793   </chapter>
794
795   <chapter id="SILInt">
796      <title>sata_sil Internals</title>
797 !Idrivers/scsi/sata_sil.c
798   </chapter>
799
800   <chapter id="libataThanks">
801      <title>Thanks</title>
802   <para>
803   The bulk of the ATA knowledge comes thanks to long conversations with
804   Andre Hedrick (www.linux-ide.org), and long hours pondering the ATA
805   and SCSI specifications.
806   </para>
807   <para>
808   Thanks to Alan Cox for pointing out similarities 
809   between SATA and SCSI, and in general for motivation to hack on
810   libata.
811   </para>
812   <para>
813   libata's device detection
814   method, ata_pio_devchk, and in general all the early probing was
815   based on extensive study of Hale Landis's probe/reset code in his
816   ATADRVR driver (www.ata-atapi.com).
817   </para>
818   </chapter>
819
820 </book>