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