]> www.pilppa.org Git - linux-2.6-omap-h63xx.git/blob - include/linux/libata.h
[PATCH] libata: Add ata_host_set_init
[linux-2.6-omap-h63xx.git] / include / linux / libata.h
1 /*
2  *  Copyright 2003-2005 Red Hat, Inc.  All rights reserved.
3  *  Copyright 2003-2005 Jeff Garzik
4  *
5  *
6  *  This program is free software; you can redistribute it and/or modify
7  *  it under the terms of the GNU General Public License as published by
8  *  the Free Software Foundation; either version 2, or (at your option)
9  *  any later version.
10  *
11  *  This program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *  GNU General Public License for more details.
15  *
16  *  You should have received a copy of the GNU General Public License
17  *  along with this program; see the file COPYING.  If not, write to
18  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
19  *
20  *
21  *  libata documentation is available via 'make {ps|pdf}docs',
22  *  as Documentation/DocBook/libata.*
23  *
24  */
25
26 #ifndef __LINUX_LIBATA_H__
27 #define __LINUX_LIBATA_H__
28
29 #include <linux/delay.h>
30 #include <linux/interrupt.h>
31 #include <linux/pci.h>
32 #include <linux/dma-mapping.h>
33 #include <asm/scatterlist.h>
34 #include <asm/io.h>
35 #include <linux/ata.h>
36 #include <linux/workqueue.h>
37 #include <scsi/scsi_host.h>
38
39 /*
40  * compile-time options: to be removed as soon as all the drivers are
41  * converted to the new debugging mechanism
42  */
43 #undef ATA_DEBUG                /* debugging output */
44 #undef ATA_VERBOSE_DEBUG        /* yet more debugging output */
45 #undef ATA_IRQ_TRAP             /* define to ack screaming irqs */
46 #undef ATA_NDEBUG               /* define to disable quick runtime checks */
47 #undef ATA_ENABLE_PATA          /* define to enable PATA support in some
48                                  * low-level drivers */
49
50
51 /* note: prints function name for you */
52 #ifdef ATA_DEBUG
53 #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
54 #ifdef ATA_VERBOSE_DEBUG
55 #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
56 #else
57 #define VPRINTK(fmt, args...)
58 #endif  /* ATA_VERBOSE_DEBUG */
59 #else
60 #define DPRINTK(fmt, args...)
61 #define VPRINTK(fmt, args...)
62 #endif  /* ATA_DEBUG */
63
64 #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
65
66 /* NEW: debug levels */
67 #define HAVE_LIBATA_MSG 1
68
69 enum {
70         ATA_MSG_DRV     = 0x0001,
71         ATA_MSG_INFO    = 0x0002,
72         ATA_MSG_PROBE   = 0x0004,
73         ATA_MSG_WARN    = 0x0008,
74         ATA_MSG_MALLOC  = 0x0010,
75         ATA_MSG_CTL     = 0x0020,
76         ATA_MSG_INTR    = 0x0040,
77         ATA_MSG_ERR     = 0x0080,
78 };
79
80 #define ata_msg_drv(p)    ((p)->msg_enable & ATA_MSG_DRV)
81 #define ata_msg_info(p)   ((p)->msg_enable & ATA_MSG_INFO)
82 #define ata_msg_probe(p)  ((p)->msg_enable & ATA_MSG_PROBE)
83 #define ata_msg_warn(p)   ((p)->msg_enable & ATA_MSG_WARN)
84 #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
85 #define ata_msg_ctl(p)    ((p)->msg_enable & ATA_MSG_CTL)
86 #define ata_msg_intr(p)   ((p)->msg_enable & ATA_MSG_INTR)
87 #define ata_msg_err(p)    ((p)->msg_enable & ATA_MSG_ERR)
88
89 static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
90 {
91         if (dval < 0 || dval >= (sizeof(u32) * 8))
92                 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
93         if (!dval)
94                 return 0;
95         return (1 << dval) - 1;
96 }
97
98 /* defines only for the constants which don't work well as enums */
99 #define ATA_TAG_POISON          0xfafbfcfdU
100
101 /* move to PCI layer? */
102 static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
103 {
104         return &pdev->dev;
105 }
106
107 enum {
108         /* various global constants */
109         LIBATA_MAX_PRD          = ATA_MAX_PRD / 2,
110         ATA_MAX_PORTS           = 8,
111         ATA_DEF_QUEUE           = 1,
112         /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
113         ATA_MAX_QUEUE           = 32,
114         ATA_TAG_INTERNAL        = ATA_MAX_QUEUE - 1,
115         ATA_MAX_SECTORS         = 200,  /* FIXME */
116         ATA_MAX_SECTORS_LBA48   = 65535,
117         ATA_MAX_BUS             = 2,
118         ATA_DEF_BUSY_WAIT       = 10000,
119         ATA_SHORT_PAUSE         = (HZ >> 6) + 1,
120
121         ATA_SHT_EMULATED        = 1,
122         ATA_SHT_CMD_PER_LUN     = 1,
123         ATA_SHT_THIS_ID         = -1,
124         ATA_SHT_USE_CLUSTERING  = 1,
125
126         /* struct ata_device stuff */
127         ATA_DFLAG_LBA           = (1 << 0), /* device supports LBA */
128         ATA_DFLAG_LBA48         = (1 << 1), /* device supports LBA48 */
129         ATA_DFLAG_CDB_INTR      = (1 << 2), /* device asserts INTRQ when ready for CDB */
130         ATA_DFLAG_NCQ           = (1 << 3), /* device supports NCQ */
131         ATA_DFLAG_CFG_MASK      = (1 << 8) - 1,
132
133         ATA_DFLAG_PIO           = (1 << 8), /* device currently in PIO mode */
134         ATA_DFLAG_SUSPENDED     = (1 << 9), /* device suspended */
135         ATA_DFLAG_INIT_MASK     = (1 << 16) - 1,
136
137         ATA_DFLAG_DETACH        = (1 << 16),
138         ATA_DFLAG_DETACHED      = (1 << 17),
139
140         ATA_DEV_UNKNOWN         = 0,    /* unknown device */
141         ATA_DEV_ATA             = 1,    /* ATA device */
142         ATA_DEV_ATA_UNSUP       = 2,    /* ATA device (unsupported) */
143         ATA_DEV_ATAPI           = 3,    /* ATAPI device */
144         ATA_DEV_ATAPI_UNSUP     = 4,    /* ATAPI device (unsupported) */
145         ATA_DEV_NONE            = 5,    /* no device */
146
147         /* struct ata_port flags */
148         ATA_FLAG_SLAVE_POSS     = (1 << 0), /* host supports slave dev */
149                                             /* (doesn't imply presence) */
150         ATA_FLAG_SATA           = (1 << 1),
151         ATA_FLAG_NO_LEGACY      = (1 << 2), /* no legacy mode check */
152         ATA_FLAG_MMIO           = (1 << 3), /* use MMIO, not PIO */
153         ATA_FLAG_SRST           = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
154         ATA_FLAG_SATA_RESET     = (1 << 5), /* (obsolete) use COMRESET */
155         ATA_FLAG_NO_ATAPI       = (1 << 6), /* No ATAPI support */
156         ATA_FLAG_PIO_DMA        = (1 << 7), /* PIO cmds via DMA */
157         ATA_FLAG_PIO_LBA48      = (1 << 8), /* Host DMA engine is LBA28 only */
158         ATA_FLAG_PIO_POLLING    = (1 << 9), /* use polling PIO if LLD
159                                              * doesn't handle PIO interrupts */
160         ATA_FLAG_NCQ            = (1 << 10), /* host supports NCQ */
161         ATA_FLAG_HRST_TO_RESUME = (1 << 11), /* hardreset to resume phy */
162         ATA_FLAG_SKIP_D2H_BSY   = (1 << 12), /* can't wait for the first D2H
163                                               * Register FIS clearing BSY */
164         ATA_FLAG_DEBUGMSG       = (1 << 13),
165
166         /* The following flag belongs to ap->pflags but is kept in
167          * ap->flags because it's referenced in many LLDs and will be
168          * removed in not-too-distant future.
169          */
170         ATA_FLAG_DISABLED       = (1 << 23), /* port is disabled, ignore it */
171
172         /* bits 24:31 of ap->flags are reserved for LLD specific flags */
173
174         /* struct ata_port pflags */
175         ATA_PFLAG_EH_PENDING    = (1 << 0), /* EH pending */
176         ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
177         ATA_PFLAG_FROZEN        = (1 << 2), /* port is frozen */
178         ATA_PFLAG_RECOVERED     = (1 << 3), /* recovery action performed */
179         ATA_PFLAG_LOADING       = (1 << 4), /* boot/loading probe */
180         ATA_PFLAG_UNLOADING     = (1 << 5), /* module is unloading */
181         ATA_PFLAG_SCSI_HOTPLUG  = (1 << 6), /* SCSI hotplug scheduled */
182
183         ATA_PFLAG_FLUSH_PORT_TASK = (1 << 16), /* flush port task */
184         ATA_PFLAG_SUSPENDED     = (1 << 17), /* port is suspended (power) */
185         ATA_PFLAG_PM_PENDING    = (1 << 18), /* PM operation pending */
186
187         /* struct ata_queued_cmd flags */
188         ATA_QCFLAG_ACTIVE       = (1 << 0), /* cmd not yet ack'd to scsi lyer */
189         ATA_QCFLAG_SG           = (1 << 1), /* have s/g table? */
190         ATA_QCFLAG_SINGLE       = (1 << 2), /* no s/g, just a single buffer */
191         ATA_QCFLAG_DMAMAP       = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
192         ATA_QCFLAG_IO           = (1 << 3), /* standard IO command */
193         ATA_QCFLAG_RESULT_TF    = (1 << 4), /* result TF requested */
194
195         ATA_QCFLAG_FAILED       = (1 << 16), /* cmd failed and is owned by EH */
196         ATA_QCFLAG_SENSE_VALID  = (1 << 17), /* sense data valid */
197         ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
198
199         /* host set flags */
200         ATA_HOST_SIMPLEX        = (1 << 0),     /* Host is simplex, one DMA channel per host_set only */
201         
202         /* various lengths of time */
203         ATA_TMOUT_BOOT          = 30 * HZ,      /* heuristic */
204         ATA_TMOUT_BOOT_QUICK    = 7 * HZ,       /* heuristic */
205         ATA_TMOUT_INTERNAL      = 30 * HZ,
206         ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
207
208         /* ATA bus states */
209         BUS_UNKNOWN             = 0,
210         BUS_DMA                 = 1,
211         BUS_IDLE                = 2,
212         BUS_NOINTR              = 3,
213         BUS_NODATA              = 4,
214         BUS_TIMER               = 5,
215         BUS_PIO                 = 6,
216         BUS_EDD                 = 7,
217         BUS_IDENTIFY            = 8,
218         BUS_PACKET              = 9,
219
220         /* SATA port states */
221         PORT_UNKNOWN            = 0,
222         PORT_ENABLED            = 1,
223         PORT_DISABLED           = 2,
224
225         /* encoding various smaller bitmaps into a single
226          * unsigned int bitmap
227          */
228         ATA_BITS_PIO            = 5,
229         ATA_BITS_MWDMA          = 3,
230         ATA_BITS_UDMA           = 8,
231
232         ATA_SHIFT_PIO           = 0,
233         ATA_SHIFT_MWDMA         = ATA_SHIFT_PIO + ATA_BITS_PIO,
234         ATA_SHIFT_UDMA          = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
235
236         ATA_MASK_PIO            = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
237         ATA_MASK_MWDMA          = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
238         ATA_MASK_UDMA           = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
239
240         /* size of buffer to pad xfers ending on unaligned boundaries */
241         ATA_DMA_PAD_SZ          = 4,
242         ATA_DMA_PAD_BUF_SZ      = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
243
244         /* masks for port functions */
245         ATA_PORT_PRIMARY        = (1 << 0),
246         ATA_PORT_SECONDARY      = (1 << 1),
247
248         /* ering size */
249         ATA_ERING_SIZE          = 32,
250
251         /* desc_len for ata_eh_info and context */
252         ATA_EH_DESC_LEN         = 80,
253
254         /* reset / recovery action types */
255         ATA_EH_REVALIDATE       = (1 << 0),
256         ATA_EH_SOFTRESET        = (1 << 1),
257         ATA_EH_HARDRESET        = (1 << 2),
258         ATA_EH_SUSPEND          = (1 << 3),
259         ATA_EH_RESUME           = (1 << 4),
260         ATA_EH_PM_FREEZE        = (1 << 5),
261
262         ATA_EH_RESET_MASK       = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
263         ATA_EH_PERDEV_MASK      = ATA_EH_REVALIDATE | ATA_EH_SUSPEND |
264                                   ATA_EH_RESUME | ATA_EH_PM_FREEZE,
265
266         /* ata_eh_info->flags */
267         ATA_EHI_HOTPLUGGED      = (1 << 0),  /* could have been hotplugged */
268         ATA_EHI_RESUME_LINK     = (1 << 1),  /* resume link (reset modifier) */
269         ATA_EHI_NO_AUTOPSY      = (1 << 2),  /* no autopsy */
270         ATA_EHI_QUIET           = (1 << 3),  /* be quiet */
271
272         ATA_EHI_DID_RESET       = (1 << 16), /* already reset this port */
273
274         ATA_EHI_RESET_MODIFIER_MASK = ATA_EHI_RESUME_LINK,
275
276         /* max repeat if error condition is still set after ->error_handler */
277         ATA_EH_MAX_REPEAT       = 5,
278
279         /* how hard are we gonna try to probe/recover devices */
280         ATA_PROBE_MAX_TRIES     = 3,
281         ATA_EH_RESET_TRIES      = 3,
282         ATA_EH_DEV_TRIES        = 3,
283
284         /* Drive spinup time (time from power-on to the first D2H FIS)
285          * in msecs - 8s currently.  Failing to get ready in this time
286          * isn't critical.  It will result in reset failure for
287          * controllers which can't wait for the first D2H FIS.  libata
288          * will retry, so it just has to be long enough to spin up
289          * most devices.
290          */
291         ATA_SPINUP_WAIT         = 8000,
292 };
293
294 enum hsm_task_states {
295         HSM_ST_UNKNOWN,         /* state unknown */
296         HSM_ST_IDLE,            /* no command on going */
297         HSM_ST,                 /* (waiting the device to) transfer data */
298         HSM_ST_LAST,            /* (waiting the device to) complete command */
299         HSM_ST_ERR,             /* error */
300         HSM_ST_FIRST,           /* (waiting the device to)
301                                    write CDB or first data block */
302 };
303
304 enum ata_completion_errors {
305         AC_ERR_DEV              = (1 << 0), /* device reported error */
306         AC_ERR_HSM              = (1 << 1), /* host state machine violation */
307         AC_ERR_TIMEOUT          = (1 << 2), /* timeout */
308         AC_ERR_MEDIA            = (1 << 3), /* media error */
309         AC_ERR_ATA_BUS          = (1 << 4), /* ATA bus error */
310         AC_ERR_HOST_BUS         = (1 << 5), /* host bus error */
311         AC_ERR_SYSTEM           = (1 << 6), /* system error */
312         AC_ERR_INVALID          = (1 << 7), /* invalid argument */
313         AC_ERR_OTHER            = (1 << 8), /* unknown */
314 };
315
316 /* forward declarations */
317 struct scsi_device;
318 struct ata_port_operations;
319 struct ata_port;
320 struct ata_queued_cmd;
321
322 /* typedefs */
323 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
324 typedef int (*ata_prereset_fn_t)(struct ata_port *ap);
325 typedef int (*ata_reset_fn_t)(struct ata_port *ap, unsigned int *classes);
326 typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *classes);
327
328 struct ata_ioports {
329         unsigned long           cmd_addr;
330         unsigned long           data_addr;
331         unsigned long           error_addr;
332         unsigned long           feature_addr;
333         unsigned long           nsect_addr;
334         unsigned long           lbal_addr;
335         unsigned long           lbam_addr;
336         unsigned long           lbah_addr;
337         unsigned long           device_addr;
338         unsigned long           status_addr;
339         unsigned long           command_addr;
340         unsigned long           altstatus_addr;
341         unsigned long           ctl_addr;
342         unsigned long           bmdma_addr;
343         unsigned long           scr_addr;
344 };
345
346 struct ata_probe_ent {
347         struct list_head        node;
348         struct device           *dev;
349         const struct ata_port_operations *port_ops;
350         struct scsi_host_template *sht;
351         struct ata_ioports      port[ATA_MAX_PORTS];
352         unsigned int            n_ports;
353         unsigned int            hard_port_no;
354         unsigned int            pio_mask;
355         unsigned int            mwdma_mask;
356         unsigned int            udma_mask;
357         unsigned int            legacy_mode;
358         unsigned long           irq;
359         unsigned int            irq_flags;
360         unsigned long           host_flags;
361         unsigned long           host_set_flags;
362         void __iomem            *mmio_base;
363         void                    *private_data;
364 };
365
366 struct ata_host_set {
367         spinlock_t              lock;
368         struct device           *dev;
369         unsigned long           irq;
370         void __iomem            *mmio_base;
371         unsigned int            n_ports;
372         void                    *private_data;
373         const struct ata_port_operations *ops;
374         unsigned long           flags;
375         int                     simplex_claimed;        /* Keep seperate in case we
376                                                            ever need to do this locked */
377         struct ata_host_set     *next;          /* for legacy mode */
378         struct ata_port         *ports[0];
379 };
380
381 struct ata_queued_cmd {
382         struct ata_port         *ap;
383         struct ata_device       *dev;
384
385         struct scsi_cmnd        *scsicmd;
386         void                    (*scsidone)(struct scsi_cmnd *);
387
388         struct ata_taskfile     tf;
389         u8                      cdb[ATAPI_CDB_LEN];
390
391         unsigned long           flags;          /* ATA_QCFLAG_xxx */
392         unsigned int            tag;
393         unsigned int            n_elem;
394         unsigned int            orig_n_elem;
395
396         int                     dma_dir;
397
398         unsigned int            pad_len;
399
400         unsigned int            nsect;
401         unsigned int            cursect;
402
403         unsigned int            nbytes;
404         unsigned int            curbytes;
405
406         unsigned int            cursg;
407         unsigned int            cursg_ofs;
408
409         struct scatterlist      sgent;
410         struct scatterlist      pad_sgent;
411         void                    *buf_virt;
412
413         /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
414         struct scatterlist      *__sg;
415
416         unsigned int            err_mask;
417         struct ata_taskfile     result_tf;
418         ata_qc_cb_t             complete_fn;
419
420         void                    *private_data;
421 };
422
423 struct ata_host_stats {
424         unsigned long           unhandled_irq;
425         unsigned long           idle_irq;
426         unsigned long           rw_reqbuf;
427 };
428
429 struct ata_ering_entry {
430         int                     is_io;
431         unsigned int            err_mask;
432         u64                     timestamp;
433 };
434
435 struct ata_ering {
436         int                     cursor;
437         struct ata_ering_entry  ring[ATA_ERING_SIZE];
438 };
439
440 struct ata_device {
441         struct ata_port         *ap;
442         unsigned int            devno;          /* 0 or 1 */
443         unsigned long           flags;          /* ATA_DFLAG_xxx */
444         struct scsi_device      *sdev;          /* attached SCSI device */
445         /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
446         u64                     n_sectors;      /* size of device, if ATA */
447         unsigned int            class;          /* ATA_DEV_xxx */
448         u16                     id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
449         u8                      pio_mode;
450         u8                      dma_mode;
451         u8                      xfer_mode;
452         unsigned int            xfer_shift;     /* ATA_SHIFT_xxx */
453
454         unsigned int            multi_count;    /* sectors count for
455                                                    READ/WRITE MULTIPLE */
456         unsigned int            max_sectors;    /* per-device max sectors */
457         unsigned int            cdb_len;
458
459         /* per-dev xfer mask */
460         unsigned int            pio_mask;
461         unsigned int            mwdma_mask;
462         unsigned int            udma_mask;
463
464         /* for CHS addressing */
465         u16                     cylinders;      /* Number of cylinders */
466         u16                     heads;          /* Number of heads */
467         u16                     sectors;        /* Number of sectors per track */
468
469         /* error history */
470         struct ata_ering        ering;
471 };
472
473 /* Offset into struct ata_device.  Fields above it are maintained
474  * acress device init.  Fields below are zeroed.
475  */
476 #define ATA_DEVICE_CLEAR_OFFSET         offsetof(struct ata_device, n_sectors)
477
478 struct ata_eh_info {
479         struct ata_device       *dev;           /* offending device */
480         u32                     serror;         /* SError from LLDD */
481         unsigned int            err_mask;       /* port-wide err_mask */
482         unsigned int            action;         /* ATA_EH_* action mask */
483         unsigned int            dev_action[ATA_MAX_DEVICES]; /* dev EH action */
484         unsigned int            flags;          /* ATA_EHI_* flags */
485
486         unsigned long           hotplug_timestamp;
487         unsigned int            probe_mask;
488
489         char                    desc[ATA_EH_DESC_LEN];
490         int                     desc_len;
491 };
492
493 struct ata_eh_context {
494         struct ata_eh_info      i;
495         int                     tries[ATA_MAX_DEVICES];
496         unsigned int            classes[ATA_MAX_DEVICES];
497         unsigned int            did_probe_mask;
498 };
499
500 struct ata_port {
501         struct Scsi_Host        *host;  /* our co-allocated scsi host */
502         const struct ata_port_operations *ops;
503         spinlock_t              *lock;
504         unsigned long           flags;  /* ATA_FLAG_xxx */
505         unsigned int            pflags; /* ATA_PFLAG_xxx */
506         unsigned int            id;     /* unique id req'd by scsi midlyr */
507         unsigned int            port_no; /* unique port #; from zero */
508         unsigned int            hard_port_no;   /* hardware port #; from zero */
509
510         struct ata_prd          *prd;    /* our SG list */
511         dma_addr_t              prd_dma; /* and its DMA mapping */
512
513         void                    *pad;   /* array of DMA pad buffers */
514         dma_addr_t              pad_dma;
515
516         struct ata_ioports      ioaddr; /* ATA cmd/ctl/dma register blocks */
517
518         u8                      ctl;    /* cache of ATA control register */
519         u8                      last_ctl;       /* Cache last written value */
520         unsigned int            pio_mask;
521         unsigned int            mwdma_mask;
522         unsigned int            udma_mask;
523         unsigned int            cbl;    /* cable type; ATA_CBL_xxx */
524         unsigned int            hw_sata_spd_limit;
525         unsigned int            sata_spd_limit; /* SATA PHY speed limit */
526
527         /* record runtime error info, protected by host_set lock */
528         struct ata_eh_info      eh_info;
529         /* EH context owned by EH */
530         struct ata_eh_context   eh_context;
531
532         struct ata_device       device[ATA_MAX_DEVICES];
533
534         struct ata_queued_cmd   qcmd[ATA_MAX_QUEUE];
535         unsigned long           qc_allocated;
536         unsigned int            qc_active;
537
538         unsigned int            active_tag;
539         u32                     sactive;
540
541         struct ata_host_stats   stats;
542         struct ata_host_set     *host_set;
543         struct device           *dev;
544
545         struct work_struct      port_task;
546         struct work_struct      hotplug_task;
547         struct work_struct      scsi_rescan_task;
548
549         unsigned int            hsm_task_state;
550
551         u32                     msg_enable;
552         struct list_head        eh_done_q;
553         wait_queue_head_t       eh_wait_q;
554
555         pm_message_t            pm_mesg;
556         int                     *pm_result;
557
558         void                    *private_data;
559
560         u8                      sector_buf[ATA_SECT_SIZE]; /* owned by EH */
561 };
562
563 struct ata_port_operations {
564         void (*port_disable) (struct ata_port *);
565
566         void (*dev_config) (struct ata_port *, struct ata_device *);
567
568         void (*set_piomode) (struct ata_port *, struct ata_device *);
569         void (*set_dmamode) (struct ata_port *, struct ata_device *);
570         unsigned long (*mode_filter) (const struct ata_port *, struct ata_device *, unsigned long);
571
572         void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
573         void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
574
575         void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
576         u8   (*check_status)(struct ata_port *ap);
577         u8   (*check_altstatus)(struct ata_port *ap);
578         void (*dev_select)(struct ata_port *ap, unsigned int device);
579
580         void (*phy_reset) (struct ata_port *ap); /* obsolete */
581         void (*set_mode) (struct ata_port *ap);
582
583         void (*post_set_mode) (struct ata_port *ap);
584
585         int (*check_atapi_dma) (struct ata_queued_cmd *qc);
586
587         void (*bmdma_setup) (struct ata_queued_cmd *qc);
588         void (*bmdma_start) (struct ata_queued_cmd *qc);
589
590         void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
591
592         void (*qc_prep) (struct ata_queued_cmd *qc);
593         unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
594
595         /* Error handlers.  ->error_handler overrides ->eng_timeout and
596          * indicates that new-style EH is in place.
597          */
598         void (*eng_timeout) (struct ata_port *ap); /* obsolete */
599
600         void (*freeze) (struct ata_port *ap);
601         void (*thaw) (struct ata_port *ap);
602         void (*error_handler) (struct ata_port *ap);
603         void (*post_internal_cmd) (struct ata_queued_cmd *qc);
604
605         irqreturn_t (*irq_handler)(int, void *, struct pt_regs *);
606         void (*irq_clear) (struct ata_port *);
607
608         u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
609         void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
610                            u32 val);
611
612         int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
613         int (*port_resume) (struct ata_port *ap);
614
615         int (*port_start) (struct ata_port *ap);
616         void (*port_stop) (struct ata_port *ap);
617
618         void (*host_stop) (struct ata_host_set *host_set);
619
620         void (*bmdma_stop) (struct ata_queued_cmd *qc);
621         u8   (*bmdma_status) (struct ata_port *ap);
622 };
623
624 struct ata_port_info {
625         struct scsi_host_template       *sht;
626         unsigned long           host_flags;
627         unsigned long           pio_mask;
628         unsigned long           mwdma_mask;
629         unsigned long           udma_mask;
630         const struct ata_port_operations *port_ops;
631         void                    *private_data;
632 };
633
634 struct ata_timing {
635         unsigned short mode;            /* ATA mode */
636         unsigned short setup;           /* t1 */
637         unsigned short act8b;           /* t2 for 8-bit I/O */
638         unsigned short rec8b;           /* t2i for 8-bit I/O */
639         unsigned short cyc8b;           /* t0 for 8-bit I/O */
640         unsigned short active;          /* t2 or tD */
641         unsigned short recover;         /* t2i or tK */
642         unsigned short cycle;           /* t0 */
643         unsigned short udma;            /* t2CYCTYP/2 */
644 };
645
646 #define FIT(v,vmin,vmax)        max_t(short,min_t(short,v,vmax),vmin)
647
648 extern const unsigned long sata_deb_timing_normal[];
649 extern const unsigned long sata_deb_timing_hotplug[];
650 extern const unsigned long sata_deb_timing_long[];
651
652 static inline const unsigned long *
653 sata_ehc_deb_timing(struct ata_eh_context *ehc)
654 {
655         if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
656                 return sata_deb_timing_hotplug;
657         else
658                 return sata_deb_timing_normal;
659 }
660
661 extern void ata_port_probe(struct ata_port *);
662 extern void __sata_phy_reset(struct ata_port *ap);
663 extern void sata_phy_reset(struct ata_port *ap);
664 extern void ata_bus_reset(struct ata_port *ap);
665 extern int sata_set_spd(struct ata_port *ap);
666 extern int sata_phy_debounce(struct ata_port *ap, const unsigned long *param);
667 extern int sata_phy_resume(struct ata_port *ap, const unsigned long *param);
668 extern int ata_std_prereset(struct ata_port *ap);
669 extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes);
670 extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class);
671 extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
672 extern int ata_dev_revalidate(struct ata_device *dev, int post_reset);
673 extern void ata_port_disable(struct ata_port *);
674 extern void ata_std_ports(struct ata_ioports *ioaddr);
675 #ifdef CONFIG_PCI
676 extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
677                              unsigned int n_ports);
678 extern void ata_pci_remove_one (struct pci_dev *pdev);
679 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
680 extern void ata_pci_device_do_resume(struct pci_dev *pdev);
681 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
682 extern int ata_pci_device_resume(struct pci_dev *pdev);
683 extern int ata_pci_clear_simplex(struct pci_dev *pdev);
684 #endif /* CONFIG_PCI */
685 extern int ata_device_add(const struct ata_probe_ent *ent);
686 extern void ata_port_detach(struct ata_port *ap);
687 extern void ata_host_set_init(struct ata_host_set *, struct device *,
688                               unsigned long, const struct ata_port_operations *);
689 extern void ata_host_set_remove(struct ata_host_set *host_set);
690 extern int ata_scsi_detect(struct scsi_host_template *sht);
691 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
692 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
693 extern int ata_scsi_release(struct Scsi_Host *host);
694 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
695 extern int sata_scr_valid(struct ata_port *ap);
696 extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
697 extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
698 extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
699 extern int ata_port_online(struct ata_port *ap);
700 extern int ata_port_offline(struct ata_port *ap);
701 extern int ata_scsi_device_resume(struct scsi_device *);
702 extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t mesg);
703 extern int ata_host_set_suspend(struct ata_host_set *host_set,
704                                 pm_message_t mesg);
705 extern void ata_host_set_resume(struct ata_host_set *host_set);
706 extern int ata_ratelimit(void);
707 extern unsigned int ata_busy_sleep(struct ata_port *ap,
708                                    unsigned long timeout_pat,
709                                    unsigned long timeout);
710 extern void ata_port_queue_task(struct ata_port *ap, void (*fn)(void *),
711                                 void *data, unsigned long delay);
712 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
713                              unsigned long interval_msec,
714                              unsigned long timeout_msec);
715
716 /*
717  * Default driver ops implementations
718  */
719 extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
720 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
721 extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
722 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
723 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
724 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
725 extern u8 ata_check_status(struct ata_port *ap);
726 extern u8 ata_altstatus(struct ata_port *ap);
727 extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
728 extern int ata_port_start (struct ata_port *ap);
729 extern void ata_port_stop (struct ata_port *ap);
730 extern void ata_host_stop (struct ata_host_set *host_set);
731 extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
732 extern void ata_mmio_data_xfer(struct ata_device *adev, unsigned char *buf,
733                                unsigned int buflen, int write_data);
734 extern void ata_pio_data_xfer(struct ata_device *adev, unsigned char *buf,
735                               unsigned int buflen, int write_data);
736 extern void ata_pio_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
737                               unsigned int buflen, int write_data);
738 extern void ata_qc_prep(struct ata_queued_cmd *qc);
739 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
740 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
741 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
742                 unsigned int buflen);
743 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
744                  unsigned int n_elem);
745 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
746 extern void ata_id_string(const u16 *id, unsigned char *s,
747                           unsigned int ofs, unsigned int len);
748 extern void ata_id_c_string(const u16 *id, unsigned char *s,
749                             unsigned int ofs, unsigned int len);
750 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
751 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
752 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
753 extern u8   ata_bmdma_status(struct ata_port *ap);
754 extern void ata_bmdma_irq_clear(struct ata_port *ap);
755 extern void ata_bmdma_freeze(struct ata_port *ap);
756 extern void ata_bmdma_thaw(struct ata_port *ap);
757 extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
758                                ata_reset_fn_t softreset,
759                                ata_reset_fn_t hardreset,
760                                ata_postreset_fn_t postreset);
761 extern void ata_bmdma_error_handler(struct ata_port *ap);
762 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
763 extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
764                         u8 status, int in_wq);
765 extern void ata_qc_complete(struct ata_queued_cmd *qc);
766 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
767                                     void (*finish_qc)(struct ata_queued_cmd *));
768 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
769                               void (*done)(struct scsi_cmnd *));
770 extern int ata_std_bios_param(struct scsi_device *sdev,
771                               struct block_device *bdev,
772                               sector_t capacity, int geom[]);
773 extern int ata_scsi_slave_config(struct scsi_device *sdev);
774 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
775 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
776                                        int queue_depth);
777 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
778
779 /*
780  * Timing helpers
781  */
782
783 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
784 extern int ata_timing_compute(struct ata_device *, unsigned short,
785                               struct ata_timing *, int, int);
786 extern void ata_timing_merge(const struct ata_timing *,
787                              const struct ata_timing *, struct ata_timing *,
788                              unsigned int);
789
790 enum {
791         ATA_TIMING_SETUP        = (1 << 0),
792         ATA_TIMING_ACT8B        = (1 << 1),
793         ATA_TIMING_REC8B        = (1 << 2),
794         ATA_TIMING_CYC8B        = (1 << 3),
795         ATA_TIMING_8BIT         = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
796                                   ATA_TIMING_CYC8B,
797         ATA_TIMING_ACTIVE       = (1 << 4),
798         ATA_TIMING_RECOVER      = (1 << 5),
799         ATA_TIMING_CYCLE        = (1 << 6),
800         ATA_TIMING_UDMA         = (1 << 7),
801         ATA_TIMING_ALL          = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
802                                   ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
803                                   ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
804                                   ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
805 };
806
807
808 #ifdef CONFIG_PCI
809 struct pci_bits {
810         unsigned int            reg;    /* PCI config register to read */
811         unsigned int            width;  /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
812         unsigned long           mask;
813         unsigned long           val;
814 };
815
816 extern void ata_pci_host_stop (struct ata_host_set *host_set);
817 extern struct ata_probe_ent *
818 ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
819 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
820 extern unsigned long ata_pci_default_filter(const struct ata_port *, struct ata_device *, unsigned long);
821 #endif /* CONFIG_PCI */
822
823 /*
824  * EH
825  */
826 extern void ata_eng_timeout(struct ata_port *ap);
827
828 extern void ata_port_schedule_eh(struct ata_port *ap);
829 extern int ata_port_abort(struct ata_port *ap);
830 extern int ata_port_freeze(struct ata_port *ap);
831
832 extern void ata_eh_freeze_port(struct ata_port *ap);
833 extern void ata_eh_thaw_port(struct ata_port *ap);
834
835 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
836 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
837
838 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
839                       ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
840                       ata_postreset_fn_t postreset);
841
842 /*
843  * printk helpers
844  */
845 #define ata_port_printk(ap, lv, fmt, args...) \
846         printk(lv"ata%u: "fmt, (ap)->id , ##args)
847
848 #define ata_dev_printk(dev, lv, fmt, args...) \
849         printk(lv"ata%u.%02u: "fmt, (dev)->ap->id, (dev)->devno , ##args)
850
851 /*
852  * ata_eh_info helpers
853  */
854 #define ata_ehi_push_desc(ehi, fmt, args...) do { \
855         (ehi)->desc_len += scnprintf((ehi)->desc + (ehi)->desc_len, \
856                                      ATA_EH_DESC_LEN - (ehi)->desc_len, \
857                                      fmt , ##args); \
858 } while (0)
859
860 #define ata_ehi_clear_desc(ehi) do { \
861         (ehi)->desc[0] = '\0'; \
862         (ehi)->desc_len = 0; \
863 } while (0)
864
865 static inline void __ata_ehi_hotplugged(struct ata_eh_info *ehi)
866 {
867         if (ehi->flags & ATA_EHI_HOTPLUGGED)
868                 return;
869
870         ehi->flags |= ATA_EHI_HOTPLUGGED | ATA_EHI_RESUME_LINK;
871         ehi->hotplug_timestamp = jiffies;
872
873         ehi->action |= ATA_EH_SOFTRESET;
874         ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
875 }
876
877 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
878 {
879         __ata_ehi_hotplugged(ehi);
880         ehi->err_mask |= AC_ERR_ATA_BUS;
881 }
882
883 /*
884  * qc helpers
885  */
886 static inline int
887 ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
888 {
889         if (sg == &qc->pad_sgent)
890                 return 1;
891         if (qc->pad_len)
892                 return 0;
893         if (((sg - qc->__sg) + 1) == qc->n_elem)
894                 return 1;
895         return 0;
896 }
897
898 static inline struct scatterlist *
899 ata_qc_first_sg(struct ata_queued_cmd *qc)
900 {
901         if (qc->n_elem)
902                 return qc->__sg;
903         if (qc->pad_len)
904                 return &qc->pad_sgent;
905         return NULL;
906 }
907
908 static inline struct scatterlist *
909 ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
910 {
911         if (sg == &qc->pad_sgent)
912                 return NULL;
913         if (++sg - qc->__sg < qc->n_elem)
914                 return sg;
915         if (qc->pad_len)
916                 return &qc->pad_sgent;
917         return NULL;
918 }
919
920 #define ata_for_each_sg(sg, qc) \
921         for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
922
923 static inline unsigned int ata_tag_valid(unsigned int tag)
924 {
925         return (tag < ATA_MAX_QUEUE) ? 1 : 0;
926 }
927
928 static inline unsigned int ata_tag_internal(unsigned int tag)
929 {
930         return tag == ATA_MAX_QUEUE - 1;
931 }
932
933 /*
934  * device helpers
935  */
936 static inline unsigned int ata_class_enabled(unsigned int class)
937 {
938         return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
939 }
940
941 static inline unsigned int ata_class_disabled(unsigned int class)
942 {
943         return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
944 }
945
946 static inline unsigned int ata_class_absent(unsigned int class)
947 {
948         return !ata_class_enabled(class) && !ata_class_disabled(class);
949 }
950
951 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
952 {
953         return ata_class_enabled(dev->class);
954 }
955
956 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
957 {
958         return ata_class_disabled(dev->class);
959 }
960
961 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
962 {
963         return ata_class_absent(dev->class);
964 }
965
966 static inline unsigned int ata_dev_ready(const struct ata_device *dev)
967 {
968         return ata_dev_enabled(dev) && !(dev->flags & ATA_DFLAG_SUSPENDED);
969 }
970
971 /*
972  * port helpers
973  */
974 static inline int ata_port_max_devices(const struct ata_port *ap)
975 {
976         if (ap->flags & ATA_FLAG_SLAVE_POSS)
977                 return 2;
978         return 1;
979 }
980
981
982 static inline u8 ata_chk_status(struct ata_port *ap)
983 {
984         return ap->ops->check_status(ap);
985 }
986
987
988 /**
989  *      ata_pause - Flush writes and pause 400 nanoseconds.
990  *      @ap: Port to wait for.
991  *
992  *      LOCKING:
993  *      Inherited from caller.
994  */
995
996 static inline void ata_pause(struct ata_port *ap)
997 {
998         ata_altstatus(ap);
999         ndelay(400);
1000 }
1001
1002
1003 /**
1004  *      ata_busy_wait - Wait for a port status register
1005  *      @ap: Port to wait for.
1006  *
1007  *      Waits up to max*10 microseconds for the selected bits in the port's
1008  *      status register to be cleared.
1009  *      Returns final value of status register.
1010  *
1011  *      LOCKING:
1012  *      Inherited from caller.
1013  */
1014
1015 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1016                                unsigned int max)
1017 {
1018         u8 status;
1019
1020         do {
1021                 udelay(10);
1022                 status = ata_chk_status(ap);
1023                 max--;
1024         } while ((status & bits) && (max > 0));
1025
1026         return status;
1027 }
1028
1029
1030 /**
1031  *      ata_wait_idle - Wait for a port to be idle.
1032  *      @ap: Port to wait for.
1033  *
1034  *      Waits up to 10ms for port's BUSY and DRQ signals to clear.
1035  *      Returns final value of status register.
1036  *
1037  *      LOCKING:
1038  *      Inherited from caller.
1039  */
1040
1041 static inline u8 ata_wait_idle(struct ata_port *ap)
1042 {
1043         u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1044
1045         if (status & (ATA_BUSY | ATA_DRQ)) {
1046                 unsigned long l = ap->ioaddr.status_addr;
1047                 if (ata_msg_warn(ap))
1048                         printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%lX\n",
1049                                 status, l);
1050         }
1051
1052         return status;
1053 }
1054
1055 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1056 {
1057         qc->tf.ctl |= ATA_NIEN;
1058 }
1059
1060 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1061                                                        unsigned int tag)
1062 {
1063         if (likely(ata_tag_valid(tag)))
1064                 return &ap->qcmd[tag];
1065         return NULL;
1066 }
1067
1068 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1069                                                      unsigned int tag)
1070 {
1071         struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1072
1073         if (unlikely(!qc) || !ap->ops->error_handler)
1074                 return qc;
1075
1076         if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1077                           ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1078                 return qc;
1079
1080         return NULL;
1081 }
1082
1083 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1084 {
1085         memset(tf, 0, sizeof(*tf));
1086
1087         tf->ctl = dev->ap->ctl;
1088         if (dev->devno == 0)
1089                 tf->device = ATA_DEVICE_OBS;
1090         else
1091                 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1092 }
1093
1094 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1095 {
1096         qc->__sg = NULL;
1097         qc->flags = 0;
1098         qc->cursect = qc->cursg = qc->cursg_ofs = 0;
1099         qc->nsect = 0;
1100         qc->nbytes = qc->curbytes = 0;
1101         qc->err_mask = 0;
1102
1103         ata_tf_init(qc->dev, &qc->tf);
1104
1105         /* init result_tf such that it indicates normal completion */
1106         qc->result_tf.command = ATA_DRDY;
1107         qc->result_tf.feature = 0;
1108 }
1109
1110 /**
1111  *      ata_irq_on - Enable interrupts on a port.
1112  *      @ap: Port on which interrupts are enabled.
1113  *
1114  *      Enable interrupts on a legacy IDE device using MMIO or PIO,
1115  *      wait for idle, clear any pending interrupts.
1116  *
1117  *      LOCKING:
1118  *      Inherited from caller.
1119  */
1120
1121 static inline u8 ata_irq_on(struct ata_port *ap)
1122 {
1123         struct ata_ioports *ioaddr = &ap->ioaddr;
1124         u8 tmp;
1125
1126         ap->ctl &= ~ATA_NIEN;
1127         ap->last_ctl = ap->ctl;
1128
1129         if (ap->flags & ATA_FLAG_MMIO)
1130                 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
1131         else
1132                 outb(ap->ctl, ioaddr->ctl_addr);
1133         tmp = ata_wait_idle(ap);
1134
1135         ap->ops->irq_clear(ap);
1136
1137         return tmp;
1138 }
1139
1140
1141 /**
1142  *      ata_irq_ack - Acknowledge a device interrupt.
1143  *      @ap: Port on which interrupts are enabled.
1144  *
1145  *      Wait up to 10 ms for legacy IDE device to become idle (BUSY
1146  *      or BUSY+DRQ clear).  Obtain dma status and port status from
1147  *      device.  Clear the interrupt.  Return port status.
1148  *
1149  *      LOCKING:
1150  */
1151
1152 static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
1153 {
1154         unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
1155         u8 host_stat, post_stat, status;
1156
1157         status = ata_busy_wait(ap, bits, 1000);
1158         if (status & bits)
1159                 if (ata_msg_err(ap))
1160                         printk(KERN_ERR "abnormal status 0x%X\n", status);
1161
1162         /* get controller status; clear intr, err bits */
1163         if (ap->flags & ATA_FLAG_MMIO) {
1164                 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
1165                 host_stat = readb(mmio + ATA_DMA_STATUS);
1166                 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
1167                        mmio + ATA_DMA_STATUS);
1168
1169                 post_stat = readb(mmio + ATA_DMA_STATUS);
1170         } else {
1171                 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1172                 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
1173                      ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1174
1175                 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
1176         }
1177
1178         if (ata_msg_intr(ap))
1179                 printk(KERN_INFO "%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
1180                         __FUNCTION__,
1181                         host_stat, post_stat, status);
1182
1183         return status;
1184 }
1185
1186 static inline int ata_try_flush_cache(const struct ata_device *dev)
1187 {
1188         return ata_id_wcache_enabled(dev->id) ||
1189                ata_id_has_flush(dev->id) ||
1190                ata_id_has_flush_ext(dev->id);
1191 }
1192
1193 static inline unsigned int ac_err_mask(u8 status)
1194 {
1195         if (status & (ATA_BUSY | ATA_DRQ))
1196                 return AC_ERR_HSM;
1197         if (status & (ATA_ERR | ATA_DF))
1198                 return AC_ERR_DEV;
1199         return 0;
1200 }
1201
1202 static inline unsigned int __ac_err_mask(u8 status)
1203 {
1204         unsigned int mask = ac_err_mask(status);
1205         if (mask == 0)
1206                 return AC_ERR_OTHER;
1207         return mask;
1208 }
1209
1210 static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1211 {
1212         ap->pad_dma = 0;
1213         ap->pad = dma_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1214                                      &ap->pad_dma, GFP_KERNEL);
1215         return (ap->pad == NULL) ? -ENOMEM : 0;
1216 }
1217
1218 static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1219 {
1220         dma_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
1221 }
1222
1223 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1224 {
1225         return (struct ata_port *) &host->hostdata[0];
1226 }
1227
1228 #endif /* __LINUX_LIBATA_H__ */