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