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

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

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

~ [ 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