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