projects / deliverable / linux.git / blob
? search:


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