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