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