libata: restore SControl on detach
[linux-2.6.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/jiffies.h>
31 #include <linux/interrupt.h>
32 #include <linux/dma-mapping.h>
33 #include <linux/scatterlist.h>
34 #include <linux/io.h>
35 #include <linux/ata.h>
36 #include <linux/workqueue.h>
37 #include <scsi/scsi_host.h>
38 #include <linux/acpi.h>
39 #include <linux/cdrom.h>
40
41 /*
42  * Define if arch has non-standard setup.  This is a _PCI_ standard
43  * not a legacy or ISA standard.
44  */
45 #ifdef CONFIG_ATA_NONSTANDARD
46 #include <asm/libata-portmap.h>
47 #else
48 #include <asm-generic/libata-portmap.h>
49 #endif
50
51 /*
52  * compile-time options: to be removed as soon as all the drivers are
53  * converted to the new debugging mechanism
54  */
55 #undef ATA_DEBUG                /* debugging output */
56 #undef ATA_VERBOSE_DEBUG        /* yet more debugging output */
57 #undef ATA_IRQ_TRAP             /* define to ack screaming irqs */
58 #undef ATA_NDEBUG               /* define to disable quick runtime checks */
59
60
61 /* note: prints function name for you */
62 #ifdef ATA_DEBUG
63 #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
64 #ifdef ATA_VERBOSE_DEBUG
65 #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __func__, ## args)
66 #else
67 #define VPRINTK(fmt, args...)
68 #endif  /* ATA_VERBOSE_DEBUG */
69 #else
70 #define DPRINTK(fmt, args...)
71 #define VPRINTK(fmt, args...)
72 #endif  /* ATA_DEBUG */
73
74 #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __func__, ## args)
75
76 /* NEW: debug levels */
77 #define HAVE_LIBATA_MSG 1
78
79 enum {
80         ATA_MSG_DRV     = 0x0001,
81         ATA_MSG_INFO    = 0x0002,
82         ATA_MSG_PROBE   = 0x0004,
83         ATA_MSG_WARN    = 0x0008,
84         ATA_MSG_MALLOC  = 0x0010,
85         ATA_MSG_CTL     = 0x0020,
86         ATA_MSG_INTR    = 0x0040,
87         ATA_MSG_ERR     = 0x0080,
88 };
89
90 #define ata_msg_drv(p)    ((p)->msg_enable & ATA_MSG_DRV)
91 #define ata_msg_info(p)   ((p)->msg_enable & ATA_MSG_INFO)
92 #define ata_msg_probe(p)  ((p)->msg_enable & ATA_MSG_PROBE)
93 #define ata_msg_warn(p)   ((p)->msg_enable & ATA_MSG_WARN)
94 #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
95 #define ata_msg_ctl(p)    ((p)->msg_enable & ATA_MSG_CTL)
96 #define ata_msg_intr(p)   ((p)->msg_enable & ATA_MSG_INTR)
97 #define ata_msg_err(p)    ((p)->msg_enable & ATA_MSG_ERR)
98
99 static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
100 {
101         if (dval < 0 || dval >= (sizeof(u32) * 8))
102                 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
103         if (!dval)
104                 return 0;
105         return (1 << dval) - 1;
106 }
107
108 /* defines only for the constants which don't work well as enums */
109 #define ATA_TAG_POISON          0xfafbfcfdU
110
111 enum {
112         /* various global constants */
113         LIBATA_MAX_PRD          = ATA_MAX_PRD / 2,
114         LIBATA_DUMB_MAX_PRD     = ATA_MAX_PRD / 4,      /* Worst case */
115         ATA_DEF_QUEUE           = 1,
116         /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
117         ATA_MAX_QUEUE           = 32,
118         ATA_TAG_INTERNAL        = ATA_MAX_QUEUE - 1,
119         ATA_SHORT_PAUSE         = 16,
120
121         ATAPI_MAX_DRAIN         = 16 << 10,
122
123         ATA_ALL_DEVICES         = (1 << ATA_MAX_DEVICES) - 1,
124
125         ATA_SHT_EMULATED        = 1,
126         ATA_SHT_CMD_PER_LUN     = 1,
127         ATA_SHT_THIS_ID         = -1,
128         ATA_SHT_USE_CLUSTERING  = 1,
129
130         /* struct ata_device stuff */
131         ATA_DFLAG_LBA           = (1 << 0), /* device supports LBA */
132         ATA_DFLAG_LBA48         = (1 << 1), /* device supports LBA48 */
133         ATA_DFLAG_CDB_INTR      = (1 << 2), /* device asserts INTRQ when ready for CDB */
134         ATA_DFLAG_NCQ           = (1 << 3), /* device supports NCQ */
135         ATA_DFLAG_FLUSH_EXT     = (1 << 4), /* do FLUSH_EXT instead of FLUSH */
136         ATA_DFLAG_ACPI_PENDING  = (1 << 5), /* ACPI resume action pending */
137         ATA_DFLAG_ACPI_FAILED   = (1 << 6), /* ACPI on devcfg has failed */
138         ATA_DFLAG_AN            = (1 << 7), /* AN configured */
139         ATA_DFLAG_HIPM          = (1 << 8), /* device supports HIPM */
140         ATA_DFLAG_DIPM          = (1 << 9), /* device supports DIPM */
141         ATA_DFLAG_DMADIR        = (1 << 10), /* device requires DMADIR */
142         ATA_DFLAG_CFG_MASK      = (1 << 12) - 1,
143
144         ATA_DFLAG_PIO           = (1 << 12), /* device limited to PIO mode */
145         ATA_DFLAG_NCQ_OFF       = (1 << 13), /* device limited to non-NCQ mode */
146         ATA_DFLAG_SPUNDOWN      = (1 << 14), /* XXX: for spindown_compat */
147         ATA_DFLAG_SLEEPING      = (1 << 15), /* device is sleeping */
148         ATA_DFLAG_DUBIOUS_XFER  = (1 << 16), /* data transfer not verified */
149         ATA_DFLAG_INIT_MASK     = (1 << 24) - 1,
150
151         ATA_DFLAG_DETACH        = (1 << 24),
152         ATA_DFLAG_DETACHED      = (1 << 25),
153
154         ATA_DEV_UNKNOWN         = 0,    /* unknown device */
155         ATA_DEV_ATA             = 1,    /* ATA device */
156         ATA_DEV_ATA_UNSUP       = 2,    /* ATA device (unsupported) */
157         ATA_DEV_ATAPI           = 3,    /* ATAPI device */
158         ATA_DEV_ATAPI_UNSUP     = 4,    /* ATAPI device (unsupported) */
159         ATA_DEV_PMP             = 5,    /* SATA port multiplier */
160         ATA_DEV_PMP_UNSUP       = 6,    /* SATA port multiplier (unsupported) */
161         ATA_DEV_SEMB            = 7,    /* SEMB */
162         ATA_DEV_SEMB_UNSUP      = 8,    /* SEMB (unsupported) */
163         ATA_DEV_NONE            = 9,    /* no device */
164
165         /* struct ata_link flags */
166         ATA_LFLAG_NO_HRST       = (1 << 1), /* avoid hardreset */
167         ATA_LFLAG_NO_SRST       = (1 << 2), /* avoid softreset */
168         ATA_LFLAG_ASSUME_ATA    = (1 << 3), /* assume ATA class */
169         ATA_LFLAG_ASSUME_SEMB   = (1 << 4), /* assume SEMB class */
170         ATA_LFLAG_ASSUME_CLASS  = ATA_LFLAG_ASSUME_ATA | ATA_LFLAG_ASSUME_SEMB,
171         ATA_LFLAG_NO_RETRY      = (1 << 5), /* don't retry this link */
172         ATA_LFLAG_DISABLED      = (1 << 6), /* link is disabled */
173         ATA_LFLAG_SW_ACTIVITY   = (1 << 7), /* keep activity stats */
174
175         /* struct ata_port flags */
176         ATA_FLAG_SLAVE_POSS     = (1 << 0), /* host supports slave dev */
177                                             /* (doesn't imply presence) */
178         ATA_FLAG_SATA           = (1 << 1),
179         ATA_FLAG_NO_LEGACY      = (1 << 2), /* no legacy mode check */
180         ATA_FLAG_MMIO           = (1 << 3), /* use MMIO, not PIO */
181         ATA_FLAG_SRST           = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
182         ATA_FLAG_SATA_RESET     = (1 << 5), /* (obsolete) use COMRESET */
183         ATA_FLAG_NO_ATAPI       = (1 << 6), /* No ATAPI support */
184         ATA_FLAG_PIO_DMA        = (1 << 7), /* PIO cmds via DMA */
185         ATA_FLAG_PIO_LBA48      = (1 << 8), /* Host DMA engine is LBA28 only */
186         ATA_FLAG_PIO_POLLING    = (1 << 9), /* use polling PIO if LLD
187                                              * doesn't handle PIO interrupts */
188         ATA_FLAG_NCQ            = (1 << 10), /* host supports NCQ */
189         ATA_FLAG_DEBUGMSG       = (1 << 13),
190         ATA_FLAG_IGN_SIMPLEX    = (1 << 15), /* ignore SIMPLEX */
191         ATA_FLAG_NO_IORDY       = (1 << 16), /* controller lacks iordy */
192         ATA_FLAG_ACPI_SATA      = (1 << 17), /* need native SATA ACPI layout */
193         ATA_FLAG_AN             = (1 << 18), /* controller supports AN */
194         ATA_FLAG_PMP            = (1 << 19), /* controller supports PMP */
195         ATA_FLAG_IPM            = (1 << 20), /* driver can handle IPM */
196         ATA_FLAG_EM             = (1 << 21), /* driver supports enclosure
197                                               * management */
198         ATA_FLAG_SW_ACTIVITY    = (1 << 22), /* driver supports sw activity
199                                               * led */
200
201         /* The following flag belongs to ap->pflags but is kept in
202          * ap->flags because it's referenced in many LLDs and will be
203          * removed in not-too-distant future.
204          */
205         ATA_FLAG_DISABLED       = (1 << 23), /* port is disabled, ignore it */
206
207         /* bits 24:31 of ap->flags are reserved for LLD specific flags */
208
209         /* struct ata_port pflags */
210         ATA_PFLAG_EH_PENDING    = (1 << 0), /* EH pending */
211         ATA_PFLAG_EH_IN_PROGRESS = (1 << 1), /* EH in progress */
212         ATA_PFLAG_FROZEN        = (1 << 2), /* port is frozen */
213         ATA_PFLAG_RECOVERED     = (1 << 3), /* recovery action performed */
214         ATA_PFLAG_LOADING       = (1 << 4), /* boot/loading probe */
215         ATA_PFLAG_UNLOADING     = (1 << 5), /* module is unloading */
216         ATA_PFLAG_SCSI_HOTPLUG  = (1 << 6), /* SCSI hotplug scheduled */
217         ATA_PFLAG_INITIALIZING  = (1 << 7), /* being initialized, don't touch */
218         ATA_PFLAG_RESETTING     = (1 << 8), /* reset in progress */
219
220         ATA_PFLAG_SUSPENDED     = (1 << 17), /* port is suspended (power) */
221         ATA_PFLAG_PM_PENDING    = (1 << 18), /* PM operation pending */
222         ATA_PFLAG_INIT_GTM_VALID = (1 << 19), /* initial gtm data valid */
223
224         /* struct ata_queued_cmd flags */
225         ATA_QCFLAG_ACTIVE       = (1 << 0), /* cmd not yet ack'd to scsi lyer */
226         ATA_QCFLAG_DMAMAP       = (1 << 1), /* SG table is DMA mapped */
227         ATA_QCFLAG_IO           = (1 << 3), /* standard IO command */
228         ATA_QCFLAG_RESULT_TF    = (1 << 4), /* result TF requested */
229         ATA_QCFLAG_CLEAR_EXCL   = (1 << 5), /* clear excl_link on completion */
230         ATA_QCFLAG_QUIET        = (1 << 6), /* don't report device error */
231         ATA_QCFLAG_RETRY        = (1 << 7), /* retry after failure */
232
233         ATA_QCFLAG_FAILED       = (1 << 16), /* cmd failed and is owned by EH */
234         ATA_QCFLAG_SENSE_VALID  = (1 << 17), /* sense data valid */
235         ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
236
237         /* host set flags */
238         ATA_HOST_SIMPLEX        = (1 << 0),     /* Host is simplex, one DMA channel per host only */
239         ATA_HOST_STARTED        = (1 << 1),     /* Host started */
240
241         /* bits 24:31 of host->flags are reserved for LLD specific flags */
242
243         /* various lengths of time */
244         ATA_TMOUT_BOOT          = 30000,        /* heuristic */
245         ATA_TMOUT_BOOT_QUICK    =  7000,        /* heuristic */
246         ATA_TMOUT_INTERNAL_QUICK = 5000,
247
248         /* FIXME: GoVault needs 2s but we can't afford that without
249          * parallel probing.  800ms is enough for iVDR disk
250          * HHD424020F7SV00.  Increase to 2secs when parallel probing
251          * is in place.
252          */
253         ATA_TMOUT_FF_WAIT       =  800,
254
255         /* Spec mandates to wait for ">= 2ms" before checking status
256          * after reset.  We wait 150ms, because that was the magic
257          * delay used for ATAPI devices in Hale Landis's ATADRVR, for
258          * the period of time between when the ATA command register is
259          * written, and then status is checked.  Because waiting for
260          * "a while" before checking status is fine, post SRST, we
261          * perform this magic delay here as well.
262          *
263          * Old drivers/ide uses the 2mS rule and then waits for ready.
264          */
265         ATA_WAIT_AFTER_RESET    =  150,
266
267         /* If PMP is supported, we have to do follow-up SRST.  As some
268          * PMPs don't send D2H Reg FIS after hardreset, LLDs are
269          * advised to wait only for the following duration before
270          * doing SRST.
271          */
272         ATA_TMOUT_PMP_SRST_WAIT = 1000,
273
274         /* ATA bus states */
275         BUS_UNKNOWN             = 0,
276         BUS_DMA                 = 1,
277         BUS_IDLE                = 2,
278         BUS_NOINTR              = 3,
279         BUS_NODATA              = 4,
280         BUS_TIMER               = 5,
281         BUS_PIO                 = 6,
282         BUS_EDD                 = 7,
283         BUS_IDENTIFY            = 8,
284         BUS_PACKET              = 9,
285
286         /* SATA port states */
287         PORT_UNKNOWN            = 0,
288         PORT_ENABLED            = 1,
289         PORT_DISABLED           = 2,
290
291         /* encoding various smaller bitmaps into a single
292          * unsigned long bitmap
293          */
294         ATA_NR_PIO_MODES        = 7,
295         ATA_NR_MWDMA_MODES      = 5,
296         ATA_NR_UDMA_MODES       = 8,
297
298         ATA_SHIFT_PIO           = 0,
299         ATA_SHIFT_MWDMA         = ATA_SHIFT_PIO + ATA_NR_PIO_MODES,
300         ATA_SHIFT_UDMA          = ATA_SHIFT_MWDMA + ATA_NR_MWDMA_MODES,
301
302         /* size of buffer to pad xfers ending on unaligned boundaries */
303         ATA_DMA_PAD_SZ          = 4,
304
305         /* ering size */
306         ATA_ERING_SIZE          = 32,
307
308         /* return values for ->qc_defer */
309         ATA_DEFER_LINK          = 1,
310         ATA_DEFER_PORT          = 2,
311
312         /* desc_len for ata_eh_info and context */
313         ATA_EH_DESC_LEN         = 80,
314
315         /* reset / recovery action types */
316         ATA_EH_REVALIDATE       = (1 << 0),
317         ATA_EH_SOFTRESET        = (1 << 1), /* meaningful only in ->prereset */
318         ATA_EH_HARDRESET        = (1 << 2), /* meaningful only in ->prereset */
319         ATA_EH_RESET            = ATA_EH_SOFTRESET | ATA_EH_HARDRESET,
320         ATA_EH_ENABLE_LINK      = (1 << 3),
321         ATA_EH_LPM              = (1 << 4),  /* link power management action */
322
323         ATA_EH_PERDEV_MASK      = ATA_EH_REVALIDATE,
324
325         /* ata_eh_info->flags */
326         ATA_EHI_HOTPLUGGED      = (1 << 0),  /* could have been hotplugged */
327         ATA_EHI_NO_AUTOPSY      = (1 << 2),  /* no autopsy */
328         ATA_EHI_QUIET           = (1 << 3),  /* be quiet */
329
330         ATA_EHI_DID_SOFTRESET   = (1 << 16), /* already soft-reset this port */
331         ATA_EHI_DID_HARDRESET   = (1 << 17), /* already soft-reset this port */
332         ATA_EHI_PRINTINFO       = (1 << 18), /* print configuration info */
333         ATA_EHI_SETMODE         = (1 << 19), /* configure transfer mode */
334         ATA_EHI_POST_SETMODE    = (1 << 20), /* revaildating after setmode */
335
336         ATA_EHI_DID_RESET       = ATA_EHI_DID_SOFTRESET | ATA_EHI_DID_HARDRESET,
337
338         /* max tries if error condition is still set after ->error_handler */
339         ATA_EH_MAX_TRIES        = 5,
340
341         /* how hard are we gonna try to probe/recover devices */
342         ATA_PROBE_MAX_TRIES     = 3,
343         ATA_EH_DEV_TRIES        = 3,
344         ATA_EH_PMP_TRIES        = 5,
345         ATA_EH_PMP_LINK_TRIES   = 3,
346
347         SATA_PMP_RW_TIMEOUT     = 3000,         /* PMP read/write timeout */
348
349         /* This should match the actual table size of
350          * ata_eh_cmd_timeout_table in libata-eh.c.
351          */
352         ATA_EH_CMD_TIMEOUT_TABLE_SIZE = 5,
353
354         /* Horkage types. May be set by libata or controller on drives
355            (some horkage may be drive/controller pair dependant */
356
357         ATA_HORKAGE_DIAGNOSTIC  = (1 << 0),     /* Failed boot diag */
358         ATA_HORKAGE_NODMA       = (1 << 1),     /* DMA problems */
359         ATA_HORKAGE_NONCQ       = (1 << 2),     /* Don't use NCQ */
360         ATA_HORKAGE_MAX_SEC_128 = (1 << 3),     /* Limit max sects to 128 */
361         ATA_HORKAGE_BROKEN_HPA  = (1 << 4),     /* Broken HPA */
362         ATA_HORKAGE_DISABLE     = (1 << 5),     /* Disable it */
363         ATA_HORKAGE_HPA_SIZE    = (1 << 6),     /* native size off by one */
364         ATA_HORKAGE_IPM         = (1 << 7),     /* Link PM problems */
365         ATA_HORKAGE_IVB         = (1 << 8),     /* cbl det validity bit bugs */
366         ATA_HORKAGE_STUCK_ERR   = (1 << 9),     /* stuck ERR on next PACKET */
367
368          /* DMA mask for user DMA control: User visible values; DO NOT
369             renumber */
370         ATA_DMA_MASK_ATA        = (1 << 0),     /* DMA on ATA Disk */
371         ATA_DMA_MASK_ATAPI      = (1 << 1),     /* DMA on ATAPI */
372         ATA_DMA_MASK_CFA        = (1 << 2),     /* DMA on CF Card */
373
374         /* ATAPI command types */
375         ATAPI_READ              = 0,            /* READs */
376         ATAPI_WRITE             = 1,            /* WRITEs */
377         ATAPI_READ_CD           = 2,            /* READ CD [MSF] */
378         ATAPI_PASS_THRU         = 3,            /* SAT pass-thru */
379         ATAPI_MISC              = 4,            /* the rest */
380
381         /* Timing constants */
382         ATA_TIMING_SETUP        = (1 << 0),
383         ATA_TIMING_ACT8B        = (1 << 1),
384         ATA_TIMING_REC8B        = (1 << 2),
385         ATA_TIMING_CYC8B        = (1 << 3),
386         ATA_TIMING_8BIT         = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
387                                   ATA_TIMING_CYC8B,
388         ATA_TIMING_ACTIVE       = (1 << 4),
389         ATA_TIMING_RECOVER      = (1 << 5),
390         ATA_TIMING_CYCLE        = (1 << 6),
391         ATA_TIMING_UDMA         = (1 << 7),
392         ATA_TIMING_ALL          = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
393                                   ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
394                                   ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
395                                   ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
396 };
397
398 enum ata_xfer_mask {
399         ATA_MASK_PIO            = ((1LU << ATA_NR_PIO_MODES) - 1)
400                                         << ATA_SHIFT_PIO,
401         ATA_MASK_MWDMA          = ((1LU << ATA_NR_MWDMA_MODES) - 1)
402                                         << ATA_SHIFT_MWDMA,
403         ATA_MASK_UDMA           = ((1LU << ATA_NR_UDMA_MODES) - 1)
404                                         << ATA_SHIFT_UDMA,
405 };
406
407 enum hsm_task_states {
408         HSM_ST_IDLE,            /* no command on going */
409         HSM_ST_FIRST,           /* (waiting the device to)
410                                    write CDB or first data block */
411         HSM_ST,                 /* (waiting the device to) transfer data */
412         HSM_ST_LAST,            /* (waiting the device to) complete command */
413         HSM_ST_ERR,             /* error */
414 };
415
416 enum ata_completion_errors {
417         AC_ERR_DEV              = (1 << 0), /* device reported error */
418         AC_ERR_HSM              = (1 << 1), /* host state machine violation */
419         AC_ERR_TIMEOUT          = (1 << 2), /* timeout */
420         AC_ERR_MEDIA            = (1 << 3), /* media error */
421         AC_ERR_ATA_BUS          = (1 << 4), /* ATA bus error */
422         AC_ERR_HOST_BUS         = (1 << 5), /* host bus error */
423         AC_ERR_SYSTEM           = (1 << 6), /* system error */
424         AC_ERR_INVALID          = (1 << 7), /* invalid argument */
425         AC_ERR_OTHER            = (1 << 8), /* unknown */
426         AC_ERR_NODEV_HINT       = (1 << 9), /* polling device detection hint */
427         AC_ERR_NCQ              = (1 << 10), /* marker for offending NCQ qc */
428 };
429
430 /* forward declarations */
431 struct scsi_device;
432 struct ata_port_operations;
433 struct ata_port;
434 struct ata_link;
435 struct ata_queued_cmd;
436
437 /* typedefs */
438 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
439 typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
440 typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
441                               unsigned long deadline);
442 typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
443
444 /*
445  * host pm policy: If you alter this, you also need to alter libata-scsi.c
446  * (for the ascii descriptions)
447  */
448 enum link_pm {
449         NOT_AVAILABLE,
450         MIN_POWER,
451         MAX_PERFORMANCE,
452         MEDIUM_POWER,
453 };
454 extern struct device_attribute dev_attr_link_power_management_policy;
455 extern struct device_attribute dev_attr_em_message_type;
456 extern struct device_attribute dev_attr_em_message;
457 extern struct device_attribute dev_attr_sw_activity;
458
459 enum sw_activity {
460         OFF,
461         BLINK_ON,
462         BLINK_OFF,
463 };
464
465 #ifdef CONFIG_ATA_SFF
466 struct ata_ioports {
467         void __iomem            *cmd_addr;
468         void __iomem            *data_addr;
469         void __iomem            *error_addr;
470         void __iomem            *feature_addr;
471         void __iomem            *nsect_addr;
472         void __iomem            *lbal_addr;
473         void __iomem            *lbam_addr;
474         void __iomem            *lbah_addr;
475         void __iomem            *device_addr;
476         void __iomem            *status_addr;
477         void __iomem            *command_addr;
478         void __iomem            *altstatus_addr;
479         void __iomem            *ctl_addr;
480         void __iomem            *bmdma_addr;
481         void __iomem            *scr_addr;
482 };
483 #endif /* CONFIG_ATA_SFF */
484
485 struct ata_host {
486         spinlock_t              lock;
487         struct device           *dev;
488         void __iomem * const    *iomap;
489         unsigned int            n_ports;
490         void                    *private_data;
491         struct ata_port_operations *ops;
492         unsigned long           flags;
493 #ifdef CONFIG_ATA_ACPI
494         acpi_handle             acpi_handle;
495 #endif
496         struct ata_port         *simplex_claimed;       /* channel owning the DMA */
497         struct ata_port         *ports[0];
498 };
499
500 struct ata_queued_cmd {
501         struct ata_port         *ap;
502         struct ata_device       *dev;
503
504         struct scsi_cmnd        *scsicmd;
505         void                    (*scsidone)(struct scsi_cmnd *);
506
507         struct ata_taskfile     tf;
508         u8                      cdb[ATAPI_CDB_LEN];
509
510         unsigned long           flags;          /* ATA_QCFLAG_xxx */
511         unsigned int            tag;
512         unsigned int            n_elem;
513
514         int                     dma_dir;
515
516         unsigned int            sect_size;
517
518         unsigned int            nbytes;
519         unsigned int            extrabytes;
520         unsigned int            curbytes;
521
522         struct scatterlist      *cursg;
523         unsigned int            cursg_ofs;
524
525         struct scatterlist      sgent;
526
527         struct scatterlist      *sg;
528
529         unsigned int            err_mask;
530         struct ata_taskfile     result_tf;
531         ata_qc_cb_t             complete_fn;
532
533         void                    *private_data;
534         void                    *lldd_task;
535 };
536
537 struct ata_port_stats {
538         unsigned long           unhandled_irq;
539         unsigned long           idle_irq;
540         unsigned long           rw_reqbuf;
541 };
542
543 struct ata_ering_entry {
544         unsigned int            eflags;
545         unsigned int            err_mask;
546         u64                     timestamp;
547 };
548
549 struct ata_ering {
550         int                     cursor;
551         struct ata_ering_entry  ring[ATA_ERING_SIZE];
552 };
553
554 struct ata_device {
555         struct ata_link         *link;
556         unsigned int            devno;          /* 0 or 1 */
557         unsigned long           flags;          /* ATA_DFLAG_xxx */
558         unsigned int            horkage;        /* List of broken features */
559         struct scsi_device      *sdev;          /* attached SCSI device */
560 #ifdef CONFIG_ATA_ACPI
561         acpi_handle             acpi_handle;
562         union acpi_object       *gtf_cache;
563 #endif
564         /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
565         u64                     n_sectors;      /* size of device, if ATA */
566         unsigned int            class;          /* ATA_DEV_xxx */
567
568         u8                      pio_mode;
569         u8                      dma_mode;
570         u8                      xfer_mode;
571         unsigned int            xfer_shift;     /* ATA_SHIFT_xxx */
572
573         unsigned int            multi_count;    /* sectors count for
574                                                    READ/WRITE MULTIPLE */
575         unsigned int            max_sectors;    /* per-device max sectors */
576         unsigned int            cdb_len;
577
578         /* per-dev xfer mask */
579         unsigned long           pio_mask;
580         unsigned long           mwdma_mask;
581         unsigned long           udma_mask;
582
583         /* for CHS addressing */
584         u16                     cylinders;      /* Number of cylinders */
585         u16                     heads;          /* Number of heads */
586         u16                     sectors;        /* Number of sectors per track */
587
588         /* error history */
589         int                     spdn_cnt;
590         struct ata_ering        ering;
591
592         union {
593                 u16             id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
594                 u32             gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
595         };
596 };
597
598 /* Offset into struct ata_device.  Fields above it are maintained
599  * acress device init.  Fields below are zeroed.
600  */
601 #define ATA_DEVICE_CLEAR_OFFSET         offsetof(struct ata_device, n_sectors)
602
603 struct ata_eh_info {
604         struct ata_device       *dev;           /* offending device */
605         u32                     serror;         /* SError from LLDD */
606         unsigned int            err_mask;       /* port-wide err_mask */
607         unsigned int            action;         /* ATA_EH_* action mask */
608         unsigned int            dev_action[ATA_MAX_DEVICES]; /* dev EH action */
609         unsigned int            flags;          /* ATA_EHI_* flags */
610
611         unsigned int            probe_mask;
612
613         char                    desc[ATA_EH_DESC_LEN];
614         int                     desc_len;
615 };
616
617 struct ata_eh_context {
618         struct ata_eh_info      i;
619         int                     tries[ATA_MAX_DEVICES];
620         int                     cmd_timeout_idx[ATA_MAX_DEVICES]
621                                                [ATA_EH_CMD_TIMEOUT_TABLE_SIZE];
622         unsigned int            classes[ATA_MAX_DEVICES];
623         unsigned int            did_probe_mask;
624         unsigned int            saved_ncq_enabled;
625         u8                      saved_xfer_mode[ATA_MAX_DEVICES];
626         /* timestamp for the last reset attempt or success */
627         unsigned long           last_reset;
628 };
629
630 struct ata_acpi_drive
631 {
632         u32 pio;
633         u32 dma;
634 } __packed;
635
636 struct ata_acpi_gtm {
637         struct ata_acpi_drive drive[2];
638         u32 flags;
639 } __packed;
640
641 struct ata_link {
642         struct ata_port         *ap;
643         int                     pmp;            /* port multiplier port # */
644
645         unsigned int            active_tag;     /* active tag on this link */
646         u32                     sactive;        /* active NCQ commands */
647
648         unsigned int            flags;          /* ATA_LFLAG_xxx */
649
650         u32                     saved_scontrol; /* SControl on probe */
651         unsigned int            hw_sata_spd_limit;
652         unsigned int            sata_spd_limit;
653         unsigned int            sata_spd;       /* current SATA PHY speed */
654
655         /* record runtime error info, protected by host_set lock */
656         struct ata_eh_info      eh_info;
657         /* EH context */
658         struct ata_eh_context   eh_context;
659
660         struct ata_device       device[ATA_MAX_DEVICES];
661 };
662
663 struct ata_port {
664         struct Scsi_Host        *scsi_host; /* our co-allocated scsi host */
665         struct ata_port_operations *ops;
666         spinlock_t              *lock;
667         unsigned long           flags;  /* ATA_FLAG_xxx */
668         unsigned int            pflags; /* ATA_PFLAG_xxx */
669         unsigned int            print_id; /* user visible unique port ID */
670         unsigned int            port_no; /* 0 based port no. inside the host */
671
672         struct ata_prd          *prd;    /* our SG list */
673         dma_addr_t              prd_dma; /* and its DMA mapping */
674
675 #ifdef CONFIG_ATA_SFF
676         struct ata_ioports      ioaddr; /* ATA cmd/ctl/dma register blocks */
677 #endif /* CONFIG_ATA_SFF */
678
679         u8                      ctl;    /* cache of ATA control register */
680         u8                      last_ctl;       /* Cache last written value */
681         unsigned int            pio_mask;
682         unsigned int            mwdma_mask;
683         unsigned int            udma_mask;
684         unsigned int            cbl;    /* cable type; ATA_CBL_xxx */
685
686         struct ata_queued_cmd   qcmd[ATA_MAX_QUEUE];
687         unsigned long           qc_allocated;
688         unsigned int            qc_active;
689         int                     nr_active_links; /* #links with active qcs */
690
691         struct ata_link         link;   /* host default link */
692
693         int                     nr_pmp_links;   /* nr of available PMP links */
694         struct ata_link         *pmp_link;      /* array of PMP links */
695         struct ata_link         *excl_link;     /* for PMP qc exclusion */
696
697         struct ata_port_stats   stats;
698         struct ata_host         *host;
699         struct device           *dev;
700
701         void                    *port_task_data;
702         struct delayed_work     port_task;
703         struct delayed_work     hotplug_task;
704         struct work_struct      scsi_rescan_task;
705
706         unsigned int            hsm_task_state;
707
708         u32                     msg_enable;
709         struct list_head        eh_done_q;
710         wait_queue_head_t       eh_wait_q;
711         int                     eh_tries;
712
713         pm_message_t            pm_mesg;
714         int                     *pm_result;
715         enum link_pm            pm_policy;
716
717         struct timer_list       fastdrain_timer;
718         unsigned long           fastdrain_cnt;
719
720         int                     em_message_type;
721         void                    *private_data;
722
723 #ifdef CONFIG_ATA_ACPI
724         acpi_handle             acpi_handle;
725         struct ata_acpi_gtm     __acpi_init_gtm; /* use ata_acpi_init_gtm() */
726 #endif
727         u8                      sector_buf[ATA_SECT_SIZE]; /* owned by EH */
728 };
729
730 /* The following initializer overrides a method to NULL whether one of
731  * its parent has the method defined or not.  This is equivalent to
732  * ERR_PTR(-ENOENT).  Unfortunately, ERR_PTR doesn't render a constant
733  * expression and thus can't be used as an initializer.
734  */
735 #define ATA_OP_NULL             (void *)(unsigned long)(-ENOENT)
736
737 struct ata_port_operations {
738         /*
739          * Command execution
740          */
741         int  (*qc_defer)(struct ata_queued_cmd *qc);
742         int  (*check_atapi_dma)(struct ata_queued_cmd *qc);
743         void (*qc_prep)(struct ata_queued_cmd *qc);
744         unsigned int (*qc_issue)(struct ata_queued_cmd *qc);
745         bool (*qc_fill_rtf)(struct ata_queued_cmd *qc);
746
747         /*
748          * Configuration and exception handling
749          */
750         int  (*cable_detect)(struct ata_port *ap);
751         unsigned long (*mode_filter)(struct ata_device *dev, unsigned long xfer_mask);
752         void (*set_piomode)(struct ata_port *ap, struct ata_device *dev);
753         void (*set_dmamode)(struct ata_port *ap, struct ata_device *dev);
754         int  (*set_mode)(struct ata_link *link, struct ata_device **r_failed_dev);
755         unsigned int (*read_id)(struct ata_device *dev, struct ata_taskfile *tf, u16 *id);
756
757         void (*dev_config)(struct ata_device *dev);
758
759         void (*freeze)(struct ata_port *ap);
760         void (*thaw)(struct ata_port *ap);
761         ata_prereset_fn_t       prereset;
762         ata_reset_fn_t          softreset;
763         ata_reset_fn_t          hardreset;
764         ata_postreset_fn_t      postreset;
765         ata_prereset_fn_t       pmp_prereset;
766         ata_reset_fn_t          pmp_softreset;
767         ata_reset_fn_t          pmp_hardreset;
768         ata_postreset_fn_t      pmp_postreset;
769         void (*error_handler)(struct ata_port *ap);
770         void (*post_internal_cmd)(struct ata_queued_cmd *qc);
771
772         /*
773          * Optional features
774          */
775         int  (*scr_read)(struct ata_port *ap, unsigned int sc_reg, u32 *val);
776         int  (*scr_write)(struct ata_port *ap, unsigned int sc_reg, u32 val);
777         void (*pmp_attach)(struct ata_port *ap);
778         void (*pmp_detach)(struct ata_port *ap);
779         int  (*enable_pm)(struct ata_port *ap, enum link_pm policy);
780         void (*disable_pm)(struct ata_port *ap);
781
782         /*
783          * Start, stop, suspend and resume
784          */
785         int  (*port_suspend)(struct ata_port *ap, pm_message_t mesg);
786         int  (*port_resume)(struct ata_port *ap);
787         int  (*port_start)(struct ata_port *ap);
788         void (*port_stop)(struct ata_port *ap);
789         void (*host_stop)(struct ata_host *host);
790
791 #ifdef CONFIG_ATA_SFF
792         /*
793          * SFF / taskfile oriented ops
794          */
795         void (*sff_dev_select)(struct ata_port *ap, unsigned int device);
796         u8   (*sff_check_status)(struct ata_port *ap);
797         u8   (*sff_check_altstatus)(struct ata_port *ap);
798         void (*sff_tf_load)(struct ata_port *ap, const struct ata_taskfile *tf);
799         void (*sff_tf_read)(struct ata_port *ap, struct ata_taskfile *tf);
800         void (*sff_exec_command)(struct ata_port *ap,
801                                  const struct ata_taskfile *tf);
802         unsigned int (*sff_data_xfer)(struct ata_device *dev,
803                         unsigned char *buf, unsigned int buflen, int rw);
804         u8   (*sff_irq_on)(struct ata_port *);
805         void (*sff_irq_clear)(struct ata_port *);
806
807         void (*bmdma_setup)(struct ata_queued_cmd *qc);
808         void (*bmdma_start)(struct ata_queued_cmd *qc);
809         void (*bmdma_stop)(struct ata_queued_cmd *qc);
810         u8   (*bmdma_status)(struct ata_port *ap);
811 #endif /* CONFIG_ATA_SFF */
812
813         ssize_t (*em_show)(struct ata_port *ap, char *buf);
814         ssize_t (*em_store)(struct ata_port *ap, const char *message,
815                             size_t size);
816         ssize_t (*sw_activity_show)(struct ata_device *dev, char *buf);
817         ssize_t (*sw_activity_store)(struct ata_device *dev,
818                                      enum sw_activity val);
819         /*
820          * Obsolete
821          */
822         void (*phy_reset)(struct ata_port *ap);
823         void (*eng_timeout)(struct ata_port *ap);
824
825         /*
826          * ->inherits must be the last field and all the preceding
827          * fields must be pointers.
828          */
829         const struct ata_port_operations        *inherits;
830 };
831
832 struct ata_port_info {
833         unsigned long           flags;
834         unsigned long           link_flags;
835         unsigned long           pio_mask;
836         unsigned long           mwdma_mask;
837         unsigned long           udma_mask;
838         struct ata_port_operations *port_ops;
839         void                    *private_data;
840 };
841
842 struct ata_timing {
843         unsigned short mode;            /* ATA mode */
844         unsigned short setup;           /* t1 */
845         unsigned short act8b;           /* t2 for 8-bit I/O */
846         unsigned short rec8b;           /* t2i for 8-bit I/O */
847         unsigned short cyc8b;           /* t0 for 8-bit I/O */
848         unsigned short active;          /* t2 or tD */
849         unsigned short recover;         /* t2i or tK */
850         unsigned short cycle;           /* t0 */
851         unsigned short udma;            /* t2CYCTYP/2 */
852 };
853
854 /*
855  * Core layer - drivers/ata/libata-core.c
856  */
857 extern const unsigned long sata_deb_timing_normal[];
858 extern const unsigned long sata_deb_timing_hotplug[];
859 extern const unsigned long sata_deb_timing_long[];
860
861 extern struct ata_port_operations ata_dummy_port_ops;
862 extern const struct ata_port_info ata_dummy_port_info;
863
864 static inline const unsigned long *
865 sata_ehc_deb_timing(struct ata_eh_context *ehc)
866 {
867         if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
868                 return sata_deb_timing_hotplug;
869         else
870                 return sata_deb_timing_normal;
871 }
872
873 static inline int ata_port_is_dummy(struct ata_port *ap)
874 {
875         return ap->ops == &ata_dummy_port_ops;
876 }
877
878 extern void ata_port_probe(struct ata_port *);
879 extern int sata_set_spd(struct ata_link *link);
880 extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
881 extern int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
882                                 int (*check_ready)(struct ata_link *link));
883 extern int sata_link_debounce(struct ata_link *link,
884                         const unsigned long *params, unsigned long deadline);
885 extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
886                             unsigned long deadline);
887 extern int sata_link_hardreset(struct ata_link *link,
888                         const unsigned long *timing, unsigned long deadline,
889                         bool *online, int (*check_ready)(struct ata_link *));
890 extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
891                               unsigned long deadline);
892 extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
893 extern void ata_port_disable(struct ata_port *);
894
895 extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
896 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
897                         const struct ata_port_info * const * ppi, int n_ports);
898 extern int ata_host_start(struct ata_host *host);
899 extern int ata_host_register(struct ata_host *host,
900                              struct scsi_host_template *sht);
901 extern int ata_host_activate(struct ata_host *host, int irq,
902                              irq_handler_t irq_handler, unsigned long irq_flags,
903                              struct scsi_host_template *sht);
904 extern void ata_host_detach(struct ata_host *host);
905 extern void ata_host_init(struct ata_host *, struct device *,
906                           unsigned long, struct ata_port_operations *);
907 extern int ata_scsi_detect(struct scsi_host_template *sht);
908 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
909 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
910 extern void ata_sas_port_destroy(struct ata_port *);
911 extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
912                                            struct ata_port_info *, struct Scsi_Host *);
913 extern int ata_sas_port_init(struct ata_port *);
914 extern int ata_sas_port_start(struct ata_port *ap);
915 extern void ata_sas_port_stop(struct ata_port *ap);
916 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
917 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
918                             struct ata_port *ap);
919 extern int sata_scr_valid(struct ata_link *link);
920 extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
921 extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
922 extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
923 extern int ata_link_online(struct ata_link *link);
924 extern int ata_link_offline(struct ata_link *link);
925 #ifdef CONFIG_PM
926 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
927 extern void ata_host_resume(struct ata_host *host);
928 #endif
929 extern int ata_ratelimit(void);
930 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
931                              unsigned long interval, unsigned long timeout);
932 extern int atapi_cmd_type(u8 opcode);
933 extern void ata_tf_to_fis(const struct ata_taskfile *tf,
934                           u8 pmp, int is_cmd, u8 *fis);
935 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
936 extern unsigned long ata_pack_xfermask(unsigned long pio_mask,
937                         unsigned long mwdma_mask, unsigned long udma_mask);
938 extern void ata_unpack_xfermask(unsigned long xfer_mask,
939                         unsigned long *pio_mask, unsigned long *mwdma_mask,
940                         unsigned long *udma_mask);
941 extern u8 ata_xfer_mask2mode(unsigned long xfer_mask);
942 extern unsigned long ata_xfer_mode2mask(u8 xfer_mode);
943 extern int ata_xfer_mode2shift(unsigned long xfer_mode);
944 extern const char *ata_mode_string(unsigned long xfer_mask);
945 extern unsigned long ata_id_xfermask(const u16 *id);
946 extern int ata_port_start(struct ata_port *ap);
947 extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
948 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
949 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
950                  unsigned int n_elem);
951 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
952 extern void ata_dev_disable(struct ata_device *adev);
953 extern void ata_id_string(const u16 *id, unsigned char *s,
954                           unsigned int ofs, unsigned int len);
955 extern void ata_id_c_string(const u16 *id, unsigned char *s,
956                             unsigned int ofs, unsigned int len);
957 extern unsigned int ata_do_dev_read_id(struct ata_device *dev,
958                                         struct ata_taskfile *tf, u16 *id);
959 extern void ata_qc_complete(struct ata_queued_cmd *qc);
960 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active);
961 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
962                               void (*done)(struct scsi_cmnd *));
963 extern int ata_std_bios_param(struct scsi_device *sdev,
964                               struct block_device *bdev,
965                               sector_t capacity, int geom[]);
966 extern int ata_scsi_slave_config(struct scsi_device *sdev);
967 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
968 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
969                                        int queue_depth);
970 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
971 extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
972
973 extern int ata_cable_40wire(struct ata_port *ap);
974 extern int ata_cable_80wire(struct ata_port *ap);
975 extern int ata_cable_sata(struct ata_port *ap);
976 extern int ata_cable_ignore(struct ata_port *ap);
977 extern int ata_cable_unknown(struct ata_port *ap);
978
979 /* Timing helpers */
980 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
981 extern const struct ata_timing *ata_timing_find_mode(u8 xfer_mode);
982 extern int ata_timing_compute(struct ata_device *, unsigned short,
983                               struct ata_timing *, int, int);
984 extern void ata_timing_merge(const struct ata_timing *,
985                              const struct ata_timing *, struct ata_timing *,
986                              unsigned int);
987 extern u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle);
988
989 /* PCI */
990 #ifdef CONFIG_PCI
991 struct pci_dev;
992
993 struct pci_bits {
994         unsigned int            reg;    /* PCI config register to read */
995         unsigned int            width;  /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
996         unsigned long           mask;
997         unsigned long           val;
998 };
999
1000 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
1001 extern void ata_pci_remove_one(struct pci_dev *pdev);
1002
1003 #ifdef CONFIG_PM
1004 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
1005 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
1006 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
1007 extern int ata_pci_device_resume(struct pci_dev *pdev);
1008 #endif /* CONFIG_PM */
1009 #endif /* CONFIG_PCI */
1010
1011 /*
1012  * ACPI - drivers/ata/libata-acpi.c
1013  */
1014 #ifdef CONFIG_ATA_ACPI
1015 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1016 {
1017         if (ap->pflags & ATA_PFLAG_INIT_GTM_VALID)
1018                 return &ap->__acpi_init_gtm;
1019         return NULL;
1020 }
1021 int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm);
1022 int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *stm);
1023 unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
1024                                     const struct ata_acpi_gtm *gtm);
1025 int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm);
1026 #else
1027 static inline const struct ata_acpi_gtm *ata_acpi_init_gtm(struct ata_port *ap)
1028 {
1029         return NULL;
1030 }
1031
1032 static inline int ata_acpi_stm(const struct ata_port *ap,
1033                                struct ata_acpi_gtm *stm)
1034 {
1035         return -ENOSYS;
1036 }
1037
1038 static inline int ata_acpi_gtm(const struct ata_port *ap,
1039                                struct ata_acpi_gtm *stm)
1040 {
1041         return -ENOSYS;
1042 }
1043
1044 static inline unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
1045                                         const struct ata_acpi_gtm *gtm)
1046 {
1047         return 0;
1048 }
1049
1050 static inline int ata_acpi_cbl_80wire(struct ata_port *ap,
1051                                       const struct ata_acpi_gtm *gtm)
1052 {
1053         return 0;
1054 }
1055 #endif
1056
1057 /*
1058  * EH - drivers/ata/libata-eh.c
1059  */
1060 extern void ata_port_schedule_eh(struct ata_port *ap);
1061 extern int ata_link_abort(struct ata_link *link);
1062 extern int ata_port_abort(struct ata_port *ap);
1063 extern int ata_port_freeze(struct ata_port *ap);
1064 extern int sata_async_notification(struct ata_port *ap);
1065
1066 extern void ata_eh_freeze_port(struct ata_port *ap);
1067 extern void ata_eh_thaw_port(struct ata_port *ap);
1068
1069 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
1070 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
1071 extern void ata_eh_analyze_ncq_error(struct ata_link *link);
1072
1073 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
1074                       ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
1075                       ata_postreset_fn_t postreset);
1076 extern void ata_std_error_handler(struct ata_port *ap);
1077
1078 /*
1079  * Base operations to inherit from and initializers for sht
1080  *
1081  * Operations
1082  *
1083  * base  : Common to all libata drivers.
1084  * sata  : SATA controllers w/ native interface.
1085  * pmp   : SATA controllers w/ PMP support.
1086  * sff   : SFF ATA controllers w/o BMDMA support.
1087  * bmdma : SFF ATA controllers w/ BMDMA support.
1088  *
1089  * sht initializers
1090  *
1091  * BASE  : Common to all libata drivers.  The user must set
1092  *         sg_tablesize and dma_boundary.
1093  * PIO   : SFF ATA controllers w/ only PIO support.
1094  * BMDMA : SFF ATA controllers w/ BMDMA support.  sg_tablesize and
1095  *         dma_boundary are set to BMDMA limits.
1096  * NCQ   : SATA controllers supporting NCQ.  The user must set
1097  *         sg_tablesize, dma_boundary and can_queue.
1098  */
1099 extern const struct ata_port_operations ata_base_port_ops;
1100 extern const struct ata_port_operations sata_port_ops;
1101
1102 #define ATA_BASE_SHT(drv_name)                                  \
1103         .module                 = THIS_MODULE,                  \
1104         .name                   = drv_name,                     \
1105         .ioctl                  = ata_scsi_ioctl,               \
1106         .queuecommand           = ata_scsi_queuecmd,            \
1107         .can_queue              = ATA_DEF_QUEUE,                \
1108         .this_id                = ATA_SHT_THIS_ID,              \
1109         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,          \
1110         .emulated               = ATA_SHT_EMULATED,             \
1111         .use_clustering         = ATA_SHT_USE_CLUSTERING,       \
1112         .proc_name              = drv_name,                     \
1113         .slave_configure        = ata_scsi_slave_config,        \
1114         .slave_destroy          = ata_scsi_slave_destroy,       \
1115         .bios_param             = ata_std_bios_param
1116
1117 #define ATA_NCQ_SHT(drv_name)                                   \
1118         ATA_BASE_SHT(drv_name),                                 \
1119         .change_queue_depth     = ata_scsi_change_queue_depth
1120
1121 /*
1122  * PMP helpers
1123  */
1124 #ifdef CONFIG_SATA_PMP
1125 static inline bool sata_pmp_supported(struct ata_port *ap)
1126 {
1127         return ap->flags & ATA_FLAG_PMP;
1128 }
1129
1130 static inline bool sata_pmp_attached(struct ata_port *ap)
1131 {
1132         return ap->nr_pmp_links != 0;
1133 }
1134
1135 static inline int ata_is_host_link(const struct ata_link *link)
1136 {
1137         return link == &link->ap->link;
1138 }
1139 #else /* CONFIG_SATA_PMP */
1140 static inline bool sata_pmp_supported(struct ata_port *ap)
1141 {
1142         return false;
1143 }
1144
1145 static inline bool sata_pmp_attached(struct ata_port *ap)
1146 {
1147         return false;
1148 }
1149
1150 static inline int ata_is_host_link(const struct ata_link *link)
1151 {
1152         return 1;
1153 }
1154 #endif /* CONFIG_SATA_PMP */
1155
1156 static inline int sata_srst_pmp(struct ata_link *link)
1157 {
1158         if (sata_pmp_supported(link->ap) && ata_is_host_link(link))
1159                 return SATA_PMP_CTRL_PORT;
1160         return link->pmp;
1161 }
1162
1163 /*
1164  * printk helpers
1165  */
1166 #define ata_port_printk(ap, lv, fmt, args...) \
1167         printk("%sata%u: "fmt, lv, (ap)->print_id , ##args)
1168
1169 #define ata_link_printk(link, lv, fmt, args...) do { \
1170         if (sata_pmp_attached((link)->ap)) \
1171                 printk("%sata%u.%02u: "fmt, lv, (link)->ap->print_id,   \
1172                        (link)->pmp , ##args); \
1173         else \
1174                 printk("%sata%u: "fmt, lv, (link)->ap->print_id , ##args); \
1175         } while(0)
1176
1177 #define ata_dev_printk(dev, lv, fmt, args...) \
1178         printk("%sata%u.%02u: "fmt, lv, (dev)->link->ap->print_id,      \
1179                (dev)->link->pmp + (dev)->devno , ##args)
1180
1181 /*
1182  * ata_eh_info helpers
1183  */
1184 extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1185         __attribute__ ((format (printf, 2, 3)));
1186 extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1187         __attribute__ ((format (printf, 2, 3)));
1188 extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
1189
1190 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1191 {
1192         ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1193         ehi->flags |= ATA_EHI_HOTPLUGGED;
1194         ehi->action |= ATA_EH_RESET | ATA_EH_ENABLE_LINK;
1195         ehi->err_mask |= AC_ERR_ATA_BUS;
1196 }
1197
1198 /*
1199  * port description helpers
1200  */
1201 extern void ata_port_desc(struct ata_port *ap, const char *fmt, ...)
1202         __attribute__ ((format (printf, 2, 3)));
1203 #ifdef CONFIG_PCI
1204 extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1205                                const char *name);
1206 #endif
1207
1208 static inline unsigned int ata_tag_valid(unsigned int tag)
1209 {
1210         return (tag < ATA_MAX_QUEUE) ? 1 : 0;
1211 }
1212
1213 static inline unsigned int ata_tag_internal(unsigned int tag)
1214 {
1215         return tag == ATA_TAG_INTERNAL;
1216 }
1217
1218 /*
1219  * device helpers
1220  */
1221 static inline unsigned int ata_class_enabled(unsigned int class)
1222 {
1223         return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1224                 class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
1225 }
1226
1227 static inline unsigned int ata_class_disabled(unsigned int class)
1228 {
1229         return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1230                 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
1231 }
1232
1233 static inline unsigned int ata_class_absent(unsigned int class)
1234 {
1235         return !ata_class_enabled(class) && !ata_class_disabled(class);
1236 }
1237
1238 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1239 {
1240         return ata_class_enabled(dev->class);
1241 }
1242
1243 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1244 {
1245         return ata_class_disabled(dev->class);
1246 }
1247
1248 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1249 {
1250         return ata_class_absent(dev->class);
1251 }
1252
1253 /*
1254  * link helpers
1255  */
1256 static inline int ata_link_max_devices(const struct ata_link *link)
1257 {
1258         if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1259                 return 2;
1260         return 1;
1261 }
1262
1263 static inline int ata_link_active(struct ata_link *link)
1264 {
1265         return ata_tag_valid(link->active_tag) || link->sactive;
1266 }
1267
1268 static inline struct ata_link *ata_port_first_link(struct ata_port *ap)
1269 {
1270         if (sata_pmp_attached(ap))
1271                 return ap->pmp_link;
1272         return &ap->link;
1273 }
1274
1275 static inline struct ata_link *ata_port_next_link(struct ata_link *link)
1276 {
1277         struct ata_port *ap = link->ap;
1278
1279         if (ata_is_host_link(link)) {
1280                 if (!sata_pmp_attached(ap))
1281                         return NULL;
1282                 return ap->pmp_link;
1283         }
1284
1285         if (++link < ap->nr_pmp_links + ap->pmp_link)
1286                 return link;
1287         return NULL;
1288 }
1289
1290 #define __ata_port_for_each_link(lk, ap) \
1291         for ((lk) = &(ap)->link; (lk); (lk) = ata_port_next_link(lk))
1292
1293 #define ata_port_for_each_link(link, ap) \
1294         for ((link) = ata_port_first_link(ap); (link); \
1295              (link) = ata_port_next_link(link))
1296
1297 #define ata_link_for_each_dev(dev, link) \
1298         for ((dev) = (link)->device; \
1299              (dev) < (link)->device + ata_link_max_devices(link) || ((dev) = NULL); \
1300              (dev)++)
1301
1302 #define ata_link_for_each_dev_reverse(dev, link) \
1303         for ((dev) = (link)->device + ata_link_max_devices(link) - 1; \
1304              (dev) >= (link)->device || ((dev) = NULL); (dev)--)
1305
1306 /**
1307  *      ata_ncq_enabled - Test whether NCQ is enabled
1308  *      @dev: ATA device to test for
1309  *
1310  *      LOCKING:
1311  *      spin_lock_irqsave(host lock)
1312  *
1313  *      RETURNS:
1314  *      1 if NCQ is enabled for @dev, 0 otherwise.
1315  */
1316 static inline int ata_ncq_enabled(struct ata_device *dev)
1317 {
1318         return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1319                               ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1320 }
1321
1322 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1323 {
1324         qc->tf.ctl |= ATA_NIEN;
1325 }
1326
1327 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1328                                                        unsigned int tag)
1329 {
1330         if (likely(ata_tag_valid(tag)))
1331                 return &ap->qcmd[tag];
1332         return NULL;
1333 }
1334
1335 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1336                                                      unsigned int tag)
1337 {
1338         struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1339
1340         if (unlikely(!qc) || !ap->ops->error_handler)
1341                 return qc;
1342
1343         if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1344                           ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1345                 return qc;
1346
1347         return NULL;
1348 }
1349
1350 static inline unsigned int ata_qc_raw_nbytes(struct ata_queued_cmd *qc)
1351 {
1352         return qc->nbytes - min(qc->extrabytes, qc->nbytes);
1353 }
1354
1355 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1356 {
1357         memset(tf, 0, sizeof(*tf));
1358
1359         tf->ctl = dev->link->ap->ctl;
1360         if (dev->devno == 0)
1361                 tf->device = ATA_DEVICE_OBS;
1362         else
1363                 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1364 }
1365
1366 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1367 {
1368         qc->dma_dir = DMA_NONE;
1369         qc->sg = NULL;
1370         qc->flags = 0;
1371         qc->cursg = NULL;
1372         qc->cursg_ofs = 0;
1373         qc->nbytes = qc->extrabytes = qc->curbytes = 0;
1374         qc->n_elem = 0;
1375         qc->err_mask = 0;
1376         qc->sect_size = ATA_SECT_SIZE;
1377
1378         ata_tf_init(qc->dev, &qc->tf);
1379
1380         /* init result_tf such that it indicates normal completion */
1381         qc->result_tf.command = ATA_DRDY;
1382         qc->result_tf.feature = 0;
1383 }
1384
1385 static inline int ata_try_flush_cache(const struct ata_device *dev)
1386 {
1387         return ata_id_wcache_enabled(dev->id) ||
1388                ata_id_has_flush(dev->id) ||
1389                ata_id_has_flush_ext(dev->id);
1390 }
1391
1392 static inline unsigned int ac_err_mask(u8 status)
1393 {
1394         if (status & (ATA_BUSY | ATA_DRQ))
1395                 return AC_ERR_HSM;
1396         if (status & (ATA_ERR | ATA_DF))
1397                 return AC_ERR_DEV;
1398         return 0;
1399 }
1400
1401 static inline unsigned int __ac_err_mask(u8 status)
1402 {
1403         unsigned int mask = ac_err_mask(status);
1404         if (mask == 0)
1405                 return AC_ERR_OTHER;
1406         return mask;
1407 }
1408
1409 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1410 {
1411         return *(struct ata_port **)&host->hostdata[0];
1412 }
1413
1414 static inline int ata_check_ready(u8 status)
1415 {
1416         if (!(status & ATA_BUSY))
1417                 return 1;
1418
1419         /* 0xff indicates either no device or device not ready */
1420         if (status == 0xff)
1421                 return -ENODEV;
1422
1423         return 0;
1424 }
1425
1426 static inline unsigned long ata_deadline(unsigned long from_jiffies,
1427                                          unsigned long timeout_msecs)
1428 {
1429         return from_jiffies + msecs_to_jiffies(timeout_msecs);
1430 }
1431
1432
1433 /**************************************************************************
1434  * PMP - drivers/ata/libata-pmp.c
1435  */
1436 #ifdef CONFIG_SATA_PMP
1437
1438 extern const struct ata_port_operations sata_pmp_port_ops;
1439
1440 extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
1441 extern void sata_pmp_error_handler(struct ata_port *ap);
1442
1443 #else /* CONFIG_SATA_PMP */
1444
1445 #define sata_pmp_port_ops               sata_port_ops
1446 #define sata_pmp_qc_defer_cmd_switch    ata_std_qc_defer
1447 #define sata_pmp_error_handler          ata_std_error_handler
1448
1449 #endif /* CONFIG_SATA_PMP */
1450
1451
1452 /**************************************************************************
1453  * SFF - drivers/ata/libata-sff.c
1454  */
1455 #ifdef CONFIG_ATA_SFF
1456
1457 extern const struct ata_port_operations ata_sff_port_ops;
1458 extern const struct ata_port_operations ata_bmdma_port_ops;
1459
1460 /* PIO only, sg_tablesize and dma_boundary limits can be removed */
1461 #define ATA_PIO_SHT(drv_name)                                   \
1462         ATA_BASE_SHT(drv_name),                                 \
1463         .sg_tablesize           = LIBATA_MAX_PRD,               \
1464         .dma_boundary           = ATA_DMA_BOUNDARY
1465
1466 #define ATA_BMDMA_SHT(drv_name)                                 \
1467         ATA_BASE_SHT(drv_name),                                 \
1468         .sg_tablesize           = LIBATA_MAX_PRD,               \
1469         .dma_boundary           = ATA_DMA_BOUNDARY
1470
1471 extern void ata_sff_qc_prep(struct ata_queued_cmd *qc);
1472 extern void ata_sff_dumb_qc_prep(struct ata_queued_cmd *qc);
1473 extern void ata_sff_dev_select(struct ata_port *ap, unsigned int device);
1474 extern u8 ata_sff_check_status(struct ata_port *ap);
1475 extern void ata_sff_pause(struct ata_port *ap);
1476 extern void ata_sff_dma_pause(struct ata_port *ap);
1477 extern int ata_sff_busy_sleep(struct ata_port *ap,
1478                               unsigned long timeout_pat, unsigned long timeout);
1479 extern int ata_sff_wait_ready(struct ata_link *link, unsigned long deadline);
1480 extern void ata_sff_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
1481 extern void ata_sff_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
1482 extern void ata_sff_exec_command(struct ata_port *ap,
1483                                  const struct ata_taskfile *tf);
1484 extern unsigned int ata_sff_data_xfer(struct ata_device *dev,
1485                         unsigned char *buf, unsigned int buflen, int rw);
1486 extern unsigned int ata_sff_data_xfer_noirq(struct ata_device *dev,
1487                         unsigned char *buf, unsigned int buflen, int rw);
1488 extern u8 ata_sff_irq_on(struct ata_port *ap);
1489 extern void ata_sff_irq_clear(struct ata_port *ap);
1490 extern int ata_sff_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
1491                             u8 status, int in_wq);
1492 extern unsigned int ata_sff_qc_issue(struct ata_queued_cmd *qc);
1493 extern bool ata_sff_qc_fill_rtf(struct ata_queued_cmd *qc);
1494 extern unsigned int ata_sff_host_intr(struct ata_port *ap,
1495                                       struct ata_queued_cmd *qc);
1496 extern irqreturn_t ata_sff_interrupt(int irq, void *dev_instance);
1497 extern void ata_sff_freeze(struct ata_port *ap);
1498 extern void ata_sff_thaw(struct ata_port *ap);
1499 extern int ata_sff_prereset(struct ata_link *link, unsigned long deadline);
1500 extern unsigned int ata_sff_dev_classify(struct ata_device *dev, int present,
1501                                           u8 *r_err);
1502 extern int ata_sff_wait_after_reset(struct ata_link *link, unsigned int devmask,
1503                                     unsigned long deadline);
1504 extern int ata_sff_softreset(struct ata_link *link, unsigned int *classes,
1505                              unsigned long deadline);
1506 extern int sata_sff_hardreset(struct ata_link *link, unsigned int *class,
1507                                unsigned long deadline);
1508 extern void ata_sff_postreset(struct ata_link *link, unsigned int *classes);
1509 extern void ata_sff_error_handler(struct ata_port *ap);
1510 extern void ata_sff_post_internal_cmd(struct ata_queued_cmd *qc);
1511 extern int ata_sff_port_start(struct ata_port *ap);
1512 extern void ata_sff_std_ports(struct ata_ioports *ioaddr);
1513 extern unsigned long ata_bmdma_mode_filter(struct ata_device *dev,
1514                                            unsigned long xfer_mask);
1515 extern void ata_bmdma_setup(struct ata_queued_cmd *qc);
1516 extern void ata_bmdma_start(struct ata_queued_cmd *qc);
1517 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
1518 extern u8 ata_bmdma_status(struct ata_port *ap);
1519 extern void ata_bus_reset(struct ata_port *ap);
1520
1521 #ifdef CONFIG_PCI
1522 extern int ata_pci_bmdma_clear_simplex(struct pci_dev *pdev);
1523 extern int ata_pci_bmdma_init(struct ata_host *host);
1524 extern int ata_pci_sff_init_host(struct ata_host *host);
1525 extern int ata_pci_sff_prepare_host(struct pci_dev *pdev,
1526                                     const struct ata_port_info * const * ppi,
1527                                     struct ata_host **r_host);
1528 extern int ata_pci_sff_activate_host(struct ata_host *host,
1529                                      irq_handler_t irq_handler,
1530                                      struct scsi_host_template *sht);
1531 extern int ata_pci_sff_init_one(struct pci_dev *pdev,
1532                                 const struct ata_port_info * const * ppi,
1533                                 struct scsi_host_template *sht, void *host_priv);
1534 #endif /* CONFIG_PCI */
1535
1536 /**
1537  *      ata_sff_busy_wait - Wait for a port status register
1538  *      @ap: Port to wait for.
1539  *      @bits: bits that must be clear
1540  *      @max: number of 10uS waits to perform
1541  *
1542  *      Waits up to max*10 microseconds for the selected bits in the port's
1543  *      status register to be cleared.
1544  *      Returns final value of status register.
1545  *
1546  *      LOCKING:
1547  *      Inherited from caller.
1548  */
1549 static inline u8 ata_sff_busy_wait(struct ata_port *ap, unsigned int bits,
1550                                    unsigned int max)
1551 {
1552         u8 status;
1553
1554         do {
1555                 udelay(10);
1556                 status = ap->ops->sff_check_status(ap);
1557                 max--;
1558         } while (status != 0xff && (status & bits) && (max > 0));
1559
1560         return status;
1561 }
1562
1563 /**
1564  *      ata_wait_idle - Wait for a port to be idle.
1565  *      @ap: Port to wait for.
1566  *
1567  *      Waits up to 10ms for port's BUSY and DRQ signals to clear.
1568  *      Returns final value of status register.
1569  *
1570  *      LOCKING:
1571  *      Inherited from caller.
1572  */
1573 static inline u8 ata_wait_idle(struct ata_port *ap)
1574 {
1575         u8 status = ata_sff_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1576
1577 #ifdef ATA_DEBUG
1578         if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1579                 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
1580                                 status);
1581 #endif
1582
1583         return status;
1584 }
1585 #endif /* CONFIG_ATA_SFF */
1586
1587 #endif /* __LINUX_LIBATA_H__ */