ahci: Add MCP79 support to AHCI driver
[deliverable/linux.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 ATA_HORKAGE_HPA_SIZE = (1 << 6), /* native size off by one */
334 };
335
336 enum hsm_task_states {
337 HSM_ST_IDLE, /* no command on going */
338 HSM_ST_FIRST, /* (waiting the device to)
339 write CDB or first data block */
340 HSM_ST, /* (waiting the device to) transfer data */
341 HSM_ST_LAST, /* (waiting the device to) complete command */
342 HSM_ST_ERR, /* error */
343 };
344
345 enum ata_completion_errors {
346 AC_ERR_DEV = (1 << 0), /* device reported error */
347 AC_ERR_HSM = (1 << 1), /* host state machine violation */
348 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
349 AC_ERR_MEDIA = (1 << 3), /* media error */
350 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
351 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
352 AC_ERR_SYSTEM = (1 << 6), /* system error */
353 AC_ERR_INVALID = (1 << 7), /* invalid argument */
354 AC_ERR_OTHER = (1 << 8), /* unknown */
355 AC_ERR_NODEV_HINT = (1 << 9), /* polling device detection hint */
356 AC_ERR_NCQ = (1 << 10), /* marker for offending NCQ qc */
357 };
358
359 /* forward declarations */
360 struct scsi_device;
361 struct ata_port_operations;
362 struct ata_port;
363 struct ata_link;
364 struct ata_queued_cmd;
365
366 /* typedefs */
367 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
368 typedef int (*ata_prereset_fn_t)(struct ata_link *link, unsigned long deadline);
369 typedef int (*ata_reset_fn_t)(struct ata_link *link, unsigned int *classes,
370 unsigned long deadline);
371 typedef void (*ata_postreset_fn_t)(struct ata_link *link, unsigned int *classes);
372
373 struct ata_ioports {
374 void __iomem *cmd_addr;
375 void __iomem *data_addr;
376 void __iomem *error_addr;
377 void __iomem *feature_addr;
378 void __iomem *nsect_addr;
379 void __iomem *lbal_addr;
380 void __iomem *lbam_addr;
381 void __iomem *lbah_addr;
382 void __iomem *device_addr;
383 void __iomem *status_addr;
384 void __iomem *command_addr;
385 void __iomem *altstatus_addr;
386 void __iomem *ctl_addr;
387 void __iomem *bmdma_addr;
388 void __iomem *scr_addr;
389 };
390
391 struct ata_host {
392 spinlock_t lock;
393 struct device *dev;
394 void __iomem * const *iomap;
395 unsigned int n_ports;
396 void *private_data;
397 const struct ata_port_operations *ops;
398 unsigned long flags;
399 #ifdef CONFIG_ATA_ACPI
400 acpi_handle acpi_handle;
401 #endif
402 struct ata_port *simplex_claimed; /* channel owning the DMA */
403 struct ata_port *ports[0];
404 };
405
406 struct ata_queued_cmd {
407 struct ata_port *ap;
408 struct ata_device *dev;
409
410 struct scsi_cmnd *scsicmd;
411 void (*scsidone)(struct scsi_cmnd *);
412
413 struct ata_taskfile tf;
414 u8 cdb[ATAPI_CDB_LEN];
415
416 unsigned long flags; /* ATA_QCFLAG_xxx */
417 unsigned int tag;
418 unsigned int n_elem;
419 unsigned int orig_n_elem;
420
421 int dma_dir;
422
423 unsigned int pad_len;
424 unsigned int sect_size;
425
426 unsigned int nbytes;
427 unsigned int curbytes;
428
429 unsigned int cursg;
430 unsigned int cursg_ofs;
431
432 struct scatterlist sgent;
433 struct scatterlist pad_sgent;
434 void *buf_virt;
435
436 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
437 struct scatterlist *__sg;
438
439 unsigned int err_mask;
440 struct ata_taskfile result_tf;
441 ata_qc_cb_t complete_fn;
442
443 void *private_data;
444 void *lldd_task;
445 };
446
447 struct ata_port_stats {
448 unsigned long unhandled_irq;
449 unsigned long idle_irq;
450 unsigned long rw_reqbuf;
451 };
452
453 struct ata_ering_entry {
454 int is_io;
455 unsigned int err_mask;
456 u64 timestamp;
457 };
458
459 struct ata_ering {
460 int cursor;
461 struct ata_ering_entry ring[ATA_ERING_SIZE];
462 };
463
464 struct ata_device {
465 struct ata_link *link;
466 unsigned int devno; /* 0 or 1 */
467 unsigned long flags; /* ATA_DFLAG_xxx */
468 unsigned int horkage; /* List of broken features */
469 struct scsi_device *sdev; /* attached SCSI device */
470 #ifdef CONFIG_ATA_ACPI
471 acpi_handle acpi_handle;
472 #endif
473 /* n_sector is used as CLEAR_OFFSET, read comment above CLEAR_OFFSET */
474 u64 n_sectors; /* size of device, if ATA */
475 unsigned int class; /* ATA_DEV_xxx */
476
477 union {
478 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
479 u32 gscr[SATA_PMP_GSCR_DWORDS]; /* PMP GSCR block */
480 };
481
482 u8 pio_mode;
483 u8 dma_mode;
484 u8 xfer_mode;
485 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
486
487 unsigned int multi_count; /* sectors count for
488 READ/WRITE MULTIPLE */
489 unsigned int max_sectors; /* per-device max sectors */
490 unsigned int cdb_len;
491
492 /* per-dev xfer mask */
493 unsigned int pio_mask;
494 unsigned int mwdma_mask;
495 unsigned int udma_mask;
496
497 /* for CHS addressing */
498 u16 cylinders; /* Number of cylinders */
499 u16 heads; /* Number of heads */
500 u16 sectors; /* Number of sectors per track */
501
502 /* error history */
503 struct ata_ering ering;
504 int spdn_cnt;
505 };
506
507 /* Offset into struct ata_device. Fields above it are maintained
508 * acress device init. Fields below are zeroed.
509 */
510 #define ATA_DEVICE_CLEAR_OFFSET offsetof(struct ata_device, n_sectors)
511
512 struct ata_eh_info {
513 struct ata_device *dev; /* offending device */
514 u32 serror; /* SError from LLDD */
515 unsigned int err_mask; /* port-wide err_mask */
516 unsigned int action; /* ATA_EH_* action mask */
517 unsigned int dev_action[ATA_MAX_DEVICES]; /* dev EH action */
518 unsigned int flags; /* ATA_EHI_* flags */
519
520 unsigned int probe_mask;
521
522 char desc[ATA_EH_DESC_LEN];
523 int desc_len;
524 };
525
526 struct ata_eh_context {
527 struct ata_eh_info i;
528 int tries[ATA_MAX_DEVICES];
529 unsigned int classes[ATA_MAX_DEVICES];
530 unsigned int did_probe_mask;
531 };
532
533 struct ata_acpi_drive
534 {
535 u32 pio;
536 u32 dma;
537 } __packed;
538
539 struct ata_acpi_gtm {
540 struct ata_acpi_drive drive[2];
541 u32 flags;
542 } __packed;
543
544 struct ata_link {
545 struct ata_port *ap;
546 int pmp; /* port multiplier port # */
547
548 unsigned int active_tag; /* active tag on this link */
549 u32 sactive; /* active NCQ commands */
550
551 unsigned int flags; /* ATA_LFLAG_xxx */
552
553 unsigned int hw_sata_spd_limit;
554 unsigned int sata_spd_limit;
555 unsigned int sata_spd; /* current SATA PHY speed */
556
557 /* record runtime error info, protected by host_set lock */
558 struct ata_eh_info eh_info;
559 /* EH context */
560 struct ata_eh_context eh_context;
561
562 struct ata_device device[ATA_MAX_DEVICES];
563 };
564
565 struct ata_port {
566 struct Scsi_Host *scsi_host; /* our co-allocated scsi host */
567 const struct ata_port_operations *ops;
568 spinlock_t *lock;
569 unsigned long flags; /* ATA_FLAG_xxx */
570 unsigned int pflags; /* ATA_PFLAG_xxx */
571 unsigned int print_id; /* user visible unique port ID */
572 unsigned int port_no; /* 0 based port no. inside the host */
573
574 struct ata_prd *prd; /* our SG list */
575 dma_addr_t prd_dma; /* and its DMA mapping */
576
577 void *pad; /* array of DMA pad buffers */
578 dma_addr_t pad_dma;
579
580 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
581
582 u8 ctl; /* cache of ATA control register */
583 u8 last_ctl; /* Cache last written value */
584 unsigned int pio_mask;
585 unsigned int mwdma_mask;
586 unsigned int udma_mask;
587 unsigned int cbl; /* cable type; ATA_CBL_xxx */
588
589 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
590 unsigned long qc_allocated;
591 unsigned int qc_active;
592 int nr_active_links; /* #links with active qcs */
593
594 struct ata_link link; /* host default link */
595
596 int nr_pmp_links; /* nr of available PMP links */
597 struct ata_link *pmp_link; /* array of PMP links */
598 struct ata_link *excl_link; /* for PMP qc exclusion */
599
600 struct ata_port_stats stats;
601 struct ata_host *host;
602 struct device *dev;
603
604 void *port_task_data;
605 struct delayed_work port_task;
606 struct delayed_work hotplug_task;
607 struct work_struct scsi_rescan_task;
608
609 unsigned int hsm_task_state;
610
611 u32 msg_enable;
612 struct list_head eh_done_q;
613 wait_queue_head_t eh_wait_q;
614 int eh_tries;
615
616 pm_message_t pm_mesg;
617 int *pm_result;
618
619 struct timer_list fastdrain_timer;
620 unsigned long fastdrain_cnt;
621
622 void *private_data;
623
624 #ifdef CONFIG_ATA_ACPI
625 acpi_handle acpi_handle;
626 struct ata_acpi_gtm acpi_gtm;
627 #endif
628 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
629 };
630
631 struct ata_port_operations {
632 void (*dev_config) (struct ata_device *);
633
634 void (*set_piomode) (struct ata_port *, struct ata_device *);
635 void (*set_dmamode) (struct ata_port *, struct ata_device *);
636 unsigned long (*mode_filter) (struct ata_device *, unsigned long);
637
638 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
639 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
640
641 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
642 u8 (*check_status)(struct ata_port *ap);
643 u8 (*check_altstatus)(struct ata_port *ap);
644 void (*dev_select)(struct ata_port *ap, unsigned int device);
645
646 void (*phy_reset) (struct ata_port *ap); /* obsolete */
647 int (*set_mode) (struct ata_link *link, struct ata_device **r_failed_dev);
648
649 int (*cable_detect) (struct ata_port *ap);
650
651 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
652
653 void (*bmdma_setup) (struct ata_queued_cmd *qc);
654 void (*bmdma_start) (struct ata_queued_cmd *qc);
655
656 void (*data_xfer) (struct ata_device *, unsigned char *, unsigned int, int);
657
658 int (*qc_defer) (struct ata_queued_cmd *qc);
659 void (*qc_prep) (struct ata_queued_cmd *qc);
660 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
661
662 /* port multiplier */
663 void (*pmp_attach) (struct ata_port *ap);
664 void (*pmp_detach) (struct ata_port *ap);
665 int (*pmp_read) (struct ata_device *dev, int pmp, int reg, u32 *r_val);
666 int (*pmp_write) (struct ata_device *dev, int pmp, int reg, u32 val);
667
668 /* Error handlers. ->error_handler overrides ->eng_timeout and
669 * indicates that new-style EH is in place.
670 */
671 void (*eng_timeout) (struct ata_port *ap); /* obsolete */
672
673 void (*freeze) (struct ata_port *ap);
674 void (*thaw) (struct ata_port *ap);
675 void (*error_handler) (struct ata_port *ap);
676 void (*post_internal_cmd) (struct ata_queued_cmd *qc);
677
678 irq_handler_t irq_handler;
679 void (*irq_clear) (struct ata_port *);
680 u8 (*irq_on) (struct ata_port *);
681
682 int (*scr_read) (struct ata_port *ap, unsigned int sc_reg, u32 *val);
683 int (*scr_write) (struct ata_port *ap, unsigned int sc_reg, u32 val);
684
685 int (*port_suspend) (struct ata_port *ap, pm_message_t mesg);
686 int (*port_resume) (struct ata_port *ap);
687
688 int (*port_start) (struct ata_port *ap);
689 void (*port_stop) (struct ata_port *ap);
690
691 void (*host_stop) (struct ata_host *host);
692
693 void (*bmdma_stop) (struct ata_queued_cmd *qc);
694 u8 (*bmdma_status) (struct ata_port *ap);
695 };
696
697 struct ata_port_info {
698 struct scsi_host_template *sht;
699 unsigned long flags;
700 unsigned long link_flags;
701 unsigned long pio_mask;
702 unsigned long mwdma_mask;
703 unsigned long udma_mask;
704 const struct ata_port_operations *port_ops;
705 irq_handler_t irq_handler;
706 void *private_data;
707 };
708
709 struct ata_timing {
710 unsigned short mode; /* ATA mode */
711 unsigned short setup; /* t1 */
712 unsigned short act8b; /* t2 for 8-bit I/O */
713 unsigned short rec8b; /* t2i for 8-bit I/O */
714 unsigned short cyc8b; /* t0 for 8-bit I/O */
715 unsigned short active; /* t2 or tD */
716 unsigned short recover; /* t2i or tK */
717 unsigned short cycle; /* t0 */
718 unsigned short udma; /* t2CYCTYP/2 */
719 };
720
721 #define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
722
723 extern const unsigned long sata_deb_timing_normal[];
724 extern const unsigned long sata_deb_timing_hotplug[];
725 extern const unsigned long sata_deb_timing_long[];
726
727 extern const struct ata_port_operations ata_dummy_port_ops;
728 extern const struct ata_port_info ata_dummy_port_info;
729
730 static inline const unsigned long *
731 sata_ehc_deb_timing(struct ata_eh_context *ehc)
732 {
733 if (ehc->i.flags & ATA_EHI_HOTPLUGGED)
734 return sata_deb_timing_hotplug;
735 else
736 return sata_deb_timing_normal;
737 }
738
739 static inline int ata_port_is_dummy(struct ata_port *ap)
740 {
741 return ap->ops == &ata_dummy_port_ops;
742 }
743
744 extern void sata_print_link_status(struct ata_link *link);
745 extern void ata_port_probe(struct ata_port *);
746 extern void __sata_phy_reset(struct ata_port *ap);
747 extern void sata_phy_reset(struct ata_port *ap);
748 extern void ata_bus_reset(struct ata_port *ap);
749 extern int sata_set_spd(struct ata_link *link);
750 extern int sata_link_debounce(struct ata_link *link,
751 const unsigned long *params, unsigned long deadline);
752 extern int sata_link_resume(struct ata_link *link, const unsigned long *params,
753 unsigned long deadline);
754 extern int ata_std_prereset(struct ata_link *link, unsigned long deadline);
755 extern int ata_std_softreset(struct ata_link *link, unsigned int *classes,
756 unsigned long deadline);
757 extern int sata_link_hardreset(struct ata_link *link,
758 const unsigned long *timing, unsigned long deadline);
759 extern int sata_std_hardreset(struct ata_link *link, unsigned int *class,
760 unsigned long deadline);
761 extern void ata_std_postreset(struct ata_link *link, unsigned int *classes);
762 extern void ata_port_disable(struct ata_port *);
763 extern void ata_std_ports(struct ata_ioports *ioaddr);
764 #ifdef CONFIG_PCI
765 extern int ata_pci_init_one (struct pci_dev *pdev,
766 const struct ata_port_info * const * ppi);
767 extern void ata_pci_remove_one (struct pci_dev *pdev);
768 #ifdef CONFIG_PM
769 extern void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg);
770 extern int __must_check ata_pci_device_do_resume(struct pci_dev *pdev);
771 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg);
772 extern int ata_pci_device_resume(struct pci_dev *pdev);
773 #endif
774 extern int ata_pci_clear_simplex(struct pci_dev *pdev);
775 #endif /* CONFIG_PCI */
776 extern struct ata_host *ata_host_alloc(struct device *dev, int max_ports);
777 extern struct ata_host *ata_host_alloc_pinfo(struct device *dev,
778 const struct ata_port_info * const * ppi, int n_ports);
779 extern int ata_host_start(struct ata_host *host);
780 extern int ata_host_register(struct ata_host *host,
781 struct scsi_host_template *sht);
782 extern int ata_host_activate(struct ata_host *host, int irq,
783 irq_handler_t irq_handler, unsigned long irq_flags,
784 struct scsi_host_template *sht);
785 extern void ata_host_detach(struct ata_host *host);
786 extern void ata_host_init(struct ata_host *, struct device *,
787 unsigned long, const struct ata_port_operations *);
788 extern int ata_scsi_detect(struct scsi_host_template *sht);
789 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
790 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
791 extern void ata_sas_port_destroy(struct ata_port *);
792 extern struct ata_port *ata_sas_port_alloc(struct ata_host *,
793 struct ata_port_info *, struct Scsi_Host *);
794 extern int ata_sas_port_init(struct ata_port *);
795 extern int ata_sas_port_start(struct ata_port *ap);
796 extern void ata_sas_port_stop(struct ata_port *ap);
797 extern int ata_sas_slave_configure(struct scsi_device *, struct ata_port *);
798 extern int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
799 struct ata_port *ap);
800 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
801 extern int sata_scr_valid(struct ata_link *link);
802 extern int sata_scr_read(struct ata_link *link, int reg, u32 *val);
803 extern int sata_scr_write(struct ata_link *link, int reg, u32 val);
804 extern int sata_scr_write_flush(struct ata_link *link, int reg, u32 val);
805 extern int ata_link_online(struct ata_link *link);
806 extern int ata_link_offline(struct ata_link *link);
807 #ifdef CONFIG_PM
808 extern int ata_host_suspend(struct ata_host *host, pm_message_t mesg);
809 extern void ata_host_resume(struct ata_host *host);
810 #endif
811 extern int ata_ratelimit(void);
812 extern int ata_busy_sleep(struct ata_port *ap,
813 unsigned long timeout_pat, unsigned long timeout);
814 extern int ata_wait_ready(struct ata_port *ap, unsigned long deadline);
815 extern void ata_port_queue_task(struct ata_port *ap, work_func_t fn,
816 void *data, unsigned long delay);
817 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
818 unsigned long interval_msec,
819 unsigned long timeout_msec);
820 extern unsigned int ata_dev_try_classify(struct ata_device *dev, int present,
821 u8 *r_err);
822
823 /*
824 * Default driver ops implementations
825 */
826 extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
827 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
828 extern void ata_tf_to_fis(const struct ata_taskfile *tf,
829 u8 pmp, int is_cmd, u8 *fis);
830 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
831 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
832 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
833 extern u8 ata_check_status(struct ata_port *ap);
834 extern u8 ata_altstatus(struct ata_port *ap);
835 extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
836 extern int ata_port_start (struct ata_port *ap);
837 extern int ata_sff_port_start (struct ata_port *ap);
838 extern irqreturn_t ata_interrupt (int irq, void *dev_instance);
839 extern void ata_data_xfer(struct ata_device *adev, unsigned char *buf,
840 unsigned int buflen, int write_data);
841 extern void ata_data_xfer_noirq(struct ata_device *adev, unsigned char *buf,
842 unsigned int buflen, int write_data);
843 extern int ata_std_qc_defer(struct ata_queued_cmd *qc);
844 extern void ata_dumb_qc_prep(struct ata_queued_cmd *qc);
845 extern void ata_qc_prep(struct ata_queued_cmd *qc);
846 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
847 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
848 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
849 unsigned int buflen);
850 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
851 unsigned int n_elem);
852 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
853 extern void ata_dev_disable(struct ata_device *adev);
854 extern void ata_id_string(const u16 *id, unsigned char *s,
855 unsigned int ofs, unsigned int len);
856 extern void ata_id_c_string(const u16 *id, unsigned char *s,
857 unsigned int ofs, unsigned int len);
858 extern void ata_id_to_dma_mode(struct ata_device *dev, u8 unknown);
859 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
860 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
861 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
862 extern u8 ata_bmdma_status(struct ata_port *ap);
863 extern void ata_bmdma_irq_clear(struct ata_port *ap);
864 extern void ata_bmdma_freeze(struct ata_port *ap);
865 extern void ata_bmdma_thaw(struct ata_port *ap);
866 extern void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
867 ata_reset_fn_t softreset,
868 ata_reset_fn_t hardreset,
869 ata_postreset_fn_t postreset);
870 extern void ata_bmdma_error_handler(struct ata_port *ap);
871 extern void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc);
872 extern int ata_hsm_move(struct ata_port *ap, struct ata_queued_cmd *qc,
873 u8 status, int in_wq);
874 extern void ata_qc_complete(struct ata_queued_cmd *qc);
875 extern int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active,
876 void (*finish_qc)(struct ata_queued_cmd *));
877 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
878 void (*done)(struct scsi_cmnd *));
879 extern int ata_std_bios_param(struct scsi_device *sdev,
880 struct block_device *bdev,
881 sector_t capacity, int geom[]);
882 extern int ata_scsi_slave_config(struct scsi_device *sdev);
883 extern void ata_scsi_slave_destroy(struct scsi_device *sdev);
884 extern int ata_scsi_change_queue_depth(struct scsi_device *sdev,
885 int queue_depth);
886 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
887 extern int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev);
888 extern u8 ata_irq_on(struct ata_port *ap);
889
890 extern int ata_cable_40wire(struct ata_port *ap);
891 extern int ata_cable_80wire(struct ata_port *ap);
892 extern int ata_cable_sata(struct ata_port *ap);
893 extern int ata_cable_unknown(struct ata_port *ap);
894
895 /*
896 * Timing helpers
897 */
898
899 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
900 extern int ata_timing_compute(struct ata_device *, unsigned short,
901 struct ata_timing *, int, int);
902 extern void ata_timing_merge(const struct ata_timing *,
903 const struct ata_timing *, struct ata_timing *,
904 unsigned int);
905
906 enum {
907 ATA_TIMING_SETUP = (1 << 0),
908 ATA_TIMING_ACT8B = (1 << 1),
909 ATA_TIMING_REC8B = (1 << 2),
910 ATA_TIMING_CYC8B = (1 << 3),
911 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
912 ATA_TIMING_CYC8B,
913 ATA_TIMING_ACTIVE = (1 << 4),
914 ATA_TIMING_RECOVER = (1 << 5),
915 ATA_TIMING_CYCLE = (1 << 6),
916 ATA_TIMING_UDMA = (1 << 7),
917 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
918 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
919 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
920 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
921 };
922
923 /* libata-acpi.c */
924 #ifdef CONFIG_ATA_ACPI
925 extern int ata_acpi_cbl_80wire(struct ata_port *ap);
926 #else
927 static inline int ata_acpi_cbl_80wire(struct ata_port *ap) { return 0; }
928 #endif
929
930 #ifdef CONFIG_PCI
931 struct pci_bits {
932 unsigned int reg; /* PCI config register to read */
933 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
934 unsigned long mask;
935 unsigned long val;
936 };
937
938 extern int ata_pci_init_sff_host(struct ata_host *host);
939 extern int ata_pci_init_bmdma(struct ata_host *host);
940 extern int ata_pci_prepare_sff_host(struct pci_dev *pdev,
941 const struct ata_port_info * const * ppi,
942 struct ata_host **r_host);
943 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
944 extern unsigned long ata_pci_default_filter(struct ata_device *, unsigned long);
945 #endif /* CONFIG_PCI */
946
947 /*
948 * PMP
949 */
950 extern int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc);
951 extern void sata_pmp_read_init_tf(struct ata_taskfile *tf,
952 struct ata_device *dev, int pmp, int reg);
953 extern u32 sata_pmp_read_val(const struct ata_taskfile *tf);
954 extern void sata_pmp_write_init_tf(struct ata_taskfile *tf,
955 struct ata_device *dev,
956 int pmp, int reg, u32 val);
957 extern int sata_pmp_std_prereset(struct ata_link *link, unsigned long deadline);
958 extern int sata_pmp_std_hardreset(struct ata_link *link, unsigned int *class,
959 unsigned long deadline);
960 extern void sata_pmp_std_postreset(struct ata_link *link, unsigned int *class);
961 extern void sata_pmp_do_eh(struct ata_port *ap,
962 ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
963 ata_reset_fn_t hardreset, ata_postreset_fn_t postreset,
964 ata_prereset_fn_t pmp_prereset, ata_reset_fn_t pmp_softreset,
965 ata_reset_fn_t pmp_hardreset, ata_postreset_fn_t pmp_postreset);
966
967 /*
968 * EH
969 */
970 extern void ata_eng_timeout(struct ata_port *ap);
971
972 extern void ata_port_schedule_eh(struct ata_port *ap);
973 extern int ata_link_abort(struct ata_link *link);
974 extern int ata_port_abort(struct ata_port *ap);
975 extern int ata_port_freeze(struct ata_port *ap);
976 extern int sata_async_notification(struct ata_port *ap);
977
978 extern void ata_eh_freeze_port(struct ata_port *ap);
979 extern void ata_eh_thaw_port(struct ata_port *ap);
980
981 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
982 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
983
984 extern void ata_do_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
985 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
986 ata_postreset_fn_t postreset);
987
988 /*
989 * printk helpers
990 */
991 #define ata_port_printk(ap, lv, fmt, args...) \
992 printk(lv"ata%u: "fmt, (ap)->print_id , ##args)
993
994 #define ata_link_printk(link, lv, fmt, args...) do { \
995 if ((link)->ap->nr_pmp_links) \
996 printk(lv"ata%u.%02u: "fmt, (link)->ap->print_id, \
997 (link)->pmp , ##args); \
998 else \
999 printk(lv"ata%u: "fmt, (link)->ap->print_id , ##args); \
1000 } while(0)
1001
1002 #define ata_dev_printk(dev, lv, fmt, args...) \
1003 printk(lv"ata%u.%02u: "fmt, (dev)->link->ap->print_id, \
1004 (dev)->link->pmp + (dev)->devno , ##args)
1005
1006 /*
1007 * ata_eh_info helpers
1008 */
1009 extern void __ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1010 __attribute__ ((format (printf, 2, 3)));
1011 extern void ata_ehi_push_desc(struct ata_eh_info *ehi, const char *fmt, ...)
1012 __attribute__ ((format (printf, 2, 3)));
1013 extern void ata_ehi_clear_desc(struct ata_eh_info *ehi);
1014
1015 static inline void ata_ehi_schedule_probe(struct ata_eh_info *ehi)
1016 {
1017 ehi->flags |= ATA_EHI_RESUME_LINK;
1018 ehi->action |= ATA_EH_SOFTRESET;
1019 ehi->probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
1020 }
1021
1022 static inline void ata_ehi_hotplugged(struct ata_eh_info *ehi)
1023 {
1024 ata_ehi_schedule_probe(ehi);
1025 ehi->flags |= ATA_EHI_HOTPLUGGED;
1026 ehi->action |= ATA_EH_ENABLE_LINK;
1027 ehi->err_mask |= AC_ERR_ATA_BUS;
1028 }
1029
1030 /*
1031 * port description helpers
1032 */
1033 extern void ata_port_desc(struct ata_port *ap, const char *fmt, ...)
1034 __attribute__ ((format (printf, 2, 3)));
1035 #ifdef CONFIG_PCI
1036 extern void ata_port_pbar_desc(struct ata_port *ap, int bar, ssize_t offset,
1037 const char *name);
1038 #endif
1039
1040 /*
1041 * qc helpers
1042 */
1043 static inline int
1044 ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
1045 {
1046 if (sg == &qc->pad_sgent)
1047 return 1;
1048 if (qc->pad_len)
1049 return 0;
1050 if (((sg - qc->__sg) + 1) == qc->n_elem)
1051 return 1;
1052 return 0;
1053 }
1054
1055 static inline struct scatterlist *
1056 ata_qc_first_sg(struct ata_queued_cmd *qc)
1057 {
1058 if (qc->n_elem)
1059 return qc->__sg;
1060 if (qc->pad_len)
1061 return &qc->pad_sgent;
1062 return NULL;
1063 }
1064
1065 static inline struct scatterlist *
1066 ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
1067 {
1068 if (sg == &qc->pad_sgent)
1069 return NULL;
1070 if (++sg - qc->__sg < qc->n_elem)
1071 return sg;
1072 if (qc->pad_len)
1073 return &qc->pad_sgent;
1074 return NULL;
1075 }
1076
1077 #define ata_for_each_sg(sg, qc) \
1078 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
1079
1080 static inline unsigned int ata_tag_valid(unsigned int tag)
1081 {
1082 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
1083 }
1084
1085 static inline unsigned int ata_tag_internal(unsigned int tag)
1086 {
1087 return tag == ATA_MAX_QUEUE - 1;
1088 }
1089
1090 /*
1091 * device helpers
1092 */
1093 static inline unsigned int ata_class_enabled(unsigned int class)
1094 {
1095 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI ||
1096 class == ATA_DEV_PMP || class == ATA_DEV_SEMB;
1097 }
1098
1099 static inline unsigned int ata_class_disabled(unsigned int class)
1100 {
1101 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP ||
1102 class == ATA_DEV_PMP_UNSUP || class == ATA_DEV_SEMB_UNSUP;
1103 }
1104
1105 static inline unsigned int ata_class_absent(unsigned int class)
1106 {
1107 return !ata_class_enabled(class) && !ata_class_disabled(class);
1108 }
1109
1110 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
1111 {
1112 return ata_class_enabled(dev->class);
1113 }
1114
1115 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
1116 {
1117 return ata_class_disabled(dev->class);
1118 }
1119
1120 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
1121 {
1122 return ata_class_absent(dev->class);
1123 }
1124
1125 /*
1126 * link helpers
1127 */
1128 static inline int ata_is_host_link(const struct ata_link *link)
1129 {
1130 return link == &link->ap->link;
1131 }
1132
1133 static inline int ata_link_max_devices(const struct ata_link *link)
1134 {
1135 if (ata_is_host_link(link) && link->ap->flags & ATA_FLAG_SLAVE_POSS)
1136 return 2;
1137 return 1;
1138 }
1139
1140 static inline int ata_link_active(struct ata_link *link)
1141 {
1142 return ata_tag_valid(link->active_tag) || link->sactive;
1143 }
1144
1145 static inline struct ata_link *ata_port_first_link(struct ata_port *ap)
1146 {
1147 if (ap->nr_pmp_links)
1148 return ap->pmp_link;
1149 return &ap->link;
1150 }
1151
1152 static inline struct ata_link *ata_port_next_link(struct ata_link *link)
1153 {
1154 struct ata_port *ap = link->ap;
1155
1156 if (link == &ap->link) {
1157 if (!ap->nr_pmp_links)
1158 return NULL;
1159 return ap->pmp_link;
1160 }
1161
1162 if (++link - ap->pmp_link < ap->nr_pmp_links)
1163 return link;
1164 return NULL;
1165 }
1166
1167 #define __ata_port_for_each_link(lk, ap) \
1168 for ((lk) = &(ap)->link; (lk); (lk) = ata_port_next_link(lk))
1169
1170 #define ata_port_for_each_link(link, ap) \
1171 for ((link) = ata_port_first_link(ap); (link); \
1172 (link) = ata_port_next_link(link))
1173
1174 #define ata_link_for_each_dev(dev, link) \
1175 for ((dev) = (link)->device; \
1176 (dev) < (link)->device + ata_link_max_devices(link) || ((dev) = NULL); \
1177 (dev)++)
1178
1179 #define ata_link_for_each_dev_reverse(dev, link) \
1180 for ((dev) = (link)->device + ata_link_max_devices(link) - 1; \
1181 (dev) >= (link)->device || ((dev) = NULL); (dev)--)
1182
1183 static inline u8 ata_chk_status(struct ata_port *ap)
1184 {
1185 return ap->ops->check_status(ap);
1186 }
1187
1188 /**
1189 * ata_ncq_enabled - Test whether NCQ is enabled
1190 * @dev: ATA device to test for
1191 *
1192 * LOCKING:
1193 * spin_lock_irqsave(host lock)
1194 *
1195 * RETURNS:
1196 * 1 if NCQ is enabled for @dev, 0 otherwise.
1197 */
1198 static inline int ata_ncq_enabled(struct ata_device *dev)
1199 {
1200 return (dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
1201 ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ;
1202 }
1203
1204 /**
1205 * ata_pause - Flush writes and pause 400 nanoseconds.
1206 * @ap: Port to wait for.
1207 *
1208 * LOCKING:
1209 * Inherited from caller.
1210 */
1211
1212 static inline void ata_pause(struct ata_port *ap)
1213 {
1214 ata_altstatus(ap);
1215 ndelay(400);
1216 }
1217
1218
1219 /**
1220 * ata_busy_wait - Wait for a port status register
1221 * @ap: Port to wait for.
1222 * @bits: bits that must be clear
1223 * @max: number of 10uS waits to perform
1224 *
1225 * Waits up to max*10 microseconds for the selected bits in the port's
1226 * status register to be cleared.
1227 * Returns final value of status register.
1228 *
1229 * LOCKING:
1230 * Inherited from caller.
1231 */
1232
1233 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
1234 unsigned int max)
1235 {
1236 u8 status;
1237
1238 do {
1239 udelay(10);
1240 status = ata_chk_status(ap);
1241 max--;
1242 } while (status != 0xff && (status & bits) && (max > 0));
1243
1244 return status;
1245 }
1246
1247
1248 /**
1249 * ata_wait_idle - Wait for a port to be idle.
1250 * @ap: Port to wait for.
1251 *
1252 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
1253 * Returns final value of status register.
1254 *
1255 * LOCKING:
1256 * Inherited from caller.
1257 */
1258
1259 static inline u8 ata_wait_idle(struct ata_port *ap)
1260 {
1261 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
1262
1263 #ifdef ATA_DEBUG
1264 if (status != 0xff && (status & (ATA_BUSY | ATA_DRQ)))
1265 ata_port_printk(ap, KERN_DEBUG, "abnormal Status 0x%X\n",
1266 status);
1267 #endif
1268
1269 return status;
1270 }
1271
1272 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
1273 {
1274 qc->tf.ctl |= ATA_NIEN;
1275 }
1276
1277 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
1278 unsigned int tag)
1279 {
1280 if (likely(ata_tag_valid(tag)))
1281 return &ap->qcmd[tag];
1282 return NULL;
1283 }
1284
1285 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
1286 unsigned int tag)
1287 {
1288 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
1289
1290 if (unlikely(!qc) || !ap->ops->error_handler)
1291 return qc;
1292
1293 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
1294 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
1295 return qc;
1296
1297 return NULL;
1298 }
1299
1300 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
1301 {
1302 memset(tf, 0, sizeof(*tf));
1303
1304 tf->ctl = dev->link->ap->ctl;
1305 if (dev->devno == 0)
1306 tf->device = ATA_DEVICE_OBS;
1307 else
1308 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
1309 }
1310
1311 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
1312 {
1313 qc->dma_dir = DMA_NONE;
1314 qc->__sg = NULL;
1315 qc->flags = 0;
1316 qc->cursg = qc->cursg_ofs = 0;
1317 qc->nbytes = qc->curbytes = 0;
1318 qc->n_elem = 0;
1319 qc->err_mask = 0;
1320 qc->pad_len = 0;
1321 qc->sect_size = ATA_SECT_SIZE;
1322
1323 ata_tf_init(qc->dev, &qc->tf);
1324
1325 /* init result_tf such that it indicates normal completion */
1326 qc->result_tf.command = ATA_DRDY;
1327 qc->result_tf.feature = 0;
1328 }
1329
1330 static inline int ata_try_flush_cache(const struct ata_device *dev)
1331 {
1332 return ata_id_wcache_enabled(dev->id) ||
1333 ata_id_has_flush(dev->id) ||
1334 ata_id_has_flush_ext(dev->id);
1335 }
1336
1337 static inline unsigned int ac_err_mask(u8 status)
1338 {
1339 if (status & (ATA_BUSY | ATA_DRQ))
1340 return AC_ERR_HSM;
1341 if (status & (ATA_ERR | ATA_DF))
1342 return AC_ERR_DEV;
1343 return 0;
1344 }
1345
1346 static inline unsigned int __ac_err_mask(u8 status)
1347 {
1348 unsigned int mask = ac_err_mask(status);
1349 if (mask == 0)
1350 return AC_ERR_OTHER;
1351 return mask;
1352 }
1353
1354 static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
1355 {
1356 ap->pad_dma = 0;
1357 ap->pad = dmam_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1358 &ap->pad_dma, GFP_KERNEL);
1359 return (ap->pad == NULL) ? -ENOMEM : 0;
1360 }
1361
1362 static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1363 {
1364 dmam_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
1365 }
1366
1367 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1368 {
1369 return *(struct ata_port **)&host->hostdata[0];
1370 }
1371
1372 #endif /* __LINUX_LIBATA_H__ */
This page took 0.060737 seconds and 6 git commands to generate.