~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/linux/libata.h

Version: ~ [ linux-5.2-rc1 ] ~ [ linux-5.1.2 ] ~ [ linux-5.0.16 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.43 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.119 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.176 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.179 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.139 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.67 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-3.9.11 ] ~ [ linux-3.8.13 ] ~ [ linux-3.7.10 ] ~ [ linux-3.6.11 ] ~ [ linux-3.5.7 ] ~ [ linux-3.4.113 ] ~ [ linux-3.3.8 ] ~ [ linux-3.2.102 ] ~ [ linux-3.1.10 ] ~ [ linux-3.0.101 ] ~ [ linux-2.6.39.4 ] ~ [ linux-2.6.38.8 ] ~ [ linux-2.6.37.6 ] ~ [ linux-2.6.36.4 ] ~ [ linux-2.6.35.14 ] ~ [ linux-2.6.34.15 ] ~ [ linux-2.6.33.20 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

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

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp