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