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

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