[PATCH] libata-eh-fw: update ata_scsi_error() for new EH
[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/io.h>
34 #include <linux/ata.h>
35 #include <linux/workqueue.h>
36 #include <scsi/scsi_host.h>
37
38 /*
39 * compile-time options: to be removed as soon as all the drivers are
40 * converted to the new debugging mechanism
41 */
42 #undef ATA_DEBUG /* debugging output */
43 #undef ATA_VERBOSE_DEBUG /* yet more debugging output */
44 #undef ATA_IRQ_TRAP /* define to ack screaming irqs */
45 #undef ATA_NDEBUG /* define to disable quick runtime checks */
46 #undef ATA_ENABLE_PATA /* define to enable PATA support in some
47 * low-level drivers */
48
49
50 /* note: prints function name for you */
51 #ifdef ATA_DEBUG
52 #define DPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
53 #ifdef ATA_VERBOSE_DEBUG
54 #define VPRINTK(fmt, args...) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
55 #else
56 #define VPRINTK(fmt, args...)
57 #endif /* ATA_VERBOSE_DEBUG */
58 #else
59 #define DPRINTK(fmt, args...)
60 #define VPRINTK(fmt, args...)
61 #endif /* ATA_DEBUG */
62
63 #define BPRINTK(fmt, args...) if (ap->flags & ATA_FLAG_DEBUGMSG) printk(KERN_ERR "%s: " fmt, __FUNCTION__, ## args)
64
65 /* NEW: debug levels */
66 #define HAVE_LIBATA_MSG 1
67
68 enum {
69 ATA_MSG_DRV = 0x0001,
70 ATA_MSG_INFO = 0x0002,
71 ATA_MSG_PROBE = 0x0004,
72 ATA_MSG_WARN = 0x0008,
73 ATA_MSG_MALLOC = 0x0010,
74 ATA_MSG_CTL = 0x0020,
75 ATA_MSG_INTR = 0x0040,
76 ATA_MSG_ERR = 0x0080,
77 };
78
79 #define ata_msg_drv(p) ((p)->msg_enable & ATA_MSG_DRV)
80 #define ata_msg_info(p) ((p)->msg_enable & ATA_MSG_INFO)
81 #define ata_msg_probe(p) ((p)->msg_enable & ATA_MSG_PROBE)
82 #define ata_msg_warn(p) ((p)->msg_enable & ATA_MSG_WARN)
83 #define ata_msg_malloc(p) ((p)->msg_enable & ATA_MSG_MALLOC)
84 #define ata_msg_ctl(p) ((p)->msg_enable & ATA_MSG_CTL)
85 #define ata_msg_intr(p) ((p)->msg_enable & ATA_MSG_INTR)
86 #define ata_msg_err(p) ((p)->msg_enable & ATA_MSG_ERR)
87
88 static inline u32 ata_msg_init(int dval, int default_msg_enable_bits)
89 {
90 if (dval < 0 || dval >= (sizeof(u32) * 8))
91 return default_msg_enable_bits; /* should be 0x1 - only driver info msgs */
92 if (!dval)
93 return 0;
94 return (1 << dval) - 1;
95 }
96
97 /* defines only for the constants which don't work well as enums */
98 #define ATA_TAG_POISON 0xfafbfcfdU
99
100 /* move to PCI layer? */
101 static inline struct device *pci_dev_to_dev(struct pci_dev *pdev)
102 {
103 return &pdev->dev;
104 }
105
106 enum {
107 /* various global constants */
108 LIBATA_MAX_PRD = ATA_MAX_PRD / 2,
109 ATA_MAX_PORTS = 8,
110 ATA_DEF_QUEUE = 1,
111 /* tag ATA_MAX_QUEUE - 1 is reserved for internal commands */
112 ATA_MAX_QUEUE = 2,
113 ATA_TAG_INTERNAL = ATA_MAX_QUEUE - 1,
114 ATA_MAX_SECTORS = 200, /* FIXME */
115 ATA_MAX_BUS = 2,
116 ATA_DEF_BUSY_WAIT = 10000,
117 ATA_SHORT_PAUSE = (HZ >> 6) + 1,
118
119 ATA_SHT_EMULATED = 1,
120 ATA_SHT_CMD_PER_LUN = 1,
121 ATA_SHT_THIS_ID = -1,
122 ATA_SHT_USE_CLUSTERING = 1,
123
124 /* struct ata_device stuff */
125 ATA_DFLAG_LBA = (1 << 0), /* device supports LBA */
126 ATA_DFLAG_LBA48 = (1 << 1), /* device supports LBA48 */
127 ATA_DFLAG_CFG_MASK = (1 << 8) - 1,
128
129 ATA_DFLAG_PIO = (1 << 8), /* device currently in PIO mode */
130
131 ATA_DEV_UNKNOWN = 0, /* unknown device */
132 ATA_DEV_ATA = 1, /* ATA device */
133 ATA_DEV_ATA_UNSUP = 2, /* ATA device (unsupported) */
134 ATA_DEV_ATAPI = 3, /* ATAPI device */
135 ATA_DEV_ATAPI_UNSUP = 4, /* ATAPI device (unsupported) */
136 ATA_DEV_NONE = 5, /* no device */
137
138 /* struct ata_port flags */
139 ATA_FLAG_SLAVE_POSS = (1 << 0), /* host supports slave dev */
140 /* (doesn't imply presence) */
141 ATA_FLAG_SATA = (1 << 1),
142 ATA_FLAG_NO_LEGACY = (1 << 2), /* no legacy mode check */
143 ATA_FLAG_MMIO = (1 << 3), /* use MMIO, not PIO */
144 ATA_FLAG_SRST = (1 << 4), /* (obsolete) use ATA SRST, not E.D.D. */
145 ATA_FLAG_SATA_RESET = (1 << 5), /* (obsolete) use COMRESET */
146 ATA_FLAG_NO_ATAPI = (1 << 6), /* No ATAPI support */
147 ATA_FLAG_PIO_DMA = (1 << 7), /* PIO cmds via DMA */
148 ATA_FLAG_PIO_LBA48 = (1 << 8), /* Host DMA engine is LBA28 only */
149 ATA_FLAG_IRQ_MASK = (1 << 9), /* Mask IRQ in PIO xfers */
150
151 ATA_FLAG_NOINTR = (1 << 13), /* FIXME: Remove this once
152 * proper HSM is in place. */
153 ATA_FLAG_DEBUGMSG = (1 << 14),
154 ATA_FLAG_FLUSH_PORT_TASK = (1 << 15), /* flush port task */
155
156 ATA_FLAG_EH_PENDING = (1 << 16), /* EH pending */
157 ATA_FLAG_FROZEN = (1 << 17), /* port is frozen */
158
159 ATA_FLAG_DISABLED = (1 << 22), /* port is disabled, ignore it */
160 ATA_FLAG_SUSPENDED = (1 << 23), /* port is suspended (power) */
161
162 /* bits 24:31 of ap->flags are reserved for LLDD specific flags */
163
164 /* struct ata_queued_cmd flags */
165 ATA_QCFLAG_ACTIVE = (1 << 0), /* cmd not yet ack'd to scsi lyer */
166 ATA_QCFLAG_SG = (1 << 1), /* have s/g table? */
167 ATA_QCFLAG_SINGLE = (1 << 2), /* no s/g, just a single buffer */
168 ATA_QCFLAG_DMAMAP = ATA_QCFLAG_SG | ATA_QCFLAG_SINGLE,
169 ATA_QCFLAG_IO = (1 << 3), /* standard IO command */
170 ATA_QCFLAG_RESULT_TF = (1 << 4), /* result TF requested */
171
172 ATA_QCFLAG_FAILED = (1 << 16), /* cmd failed and is owned by EH */
173 ATA_QCFLAG_SENSE_VALID = (1 << 17), /* sense data valid */
174 ATA_QCFLAG_EH_SCHEDULED = (1 << 18), /* EH scheduled (obsolete) */
175
176 /* host set flags */
177 ATA_HOST_SIMPLEX = (1 << 0), /* Host is simplex, one DMA channel per host_set only */
178
179 /* various lengths of time */
180 ATA_TMOUT_PIO = 30 * HZ,
181 ATA_TMOUT_BOOT = 30 * HZ, /* heuristic */
182 ATA_TMOUT_BOOT_QUICK = 7 * HZ, /* heuristic */
183 ATA_TMOUT_CDB = 30 * HZ,
184 ATA_TMOUT_CDB_QUICK = 5 * HZ,
185 ATA_TMOUT_INTERNAL = 30 * HZ,
186 ATA_TMOUT_INTERNAL_QUICK = 5 * HZ,
187
188 /* ATA bus states */
189 BUS_UNKNOWN = 0,
190 BUS_DMA = 1,
191 BUS_IDLE = 2,
192 BUS_NOINTR = 3,
193 BUS_NODATA = 4,
194 BUS_TIMER = 5,
195 BUS_PIO = 6,
196 BUS_EDD = 7,
197 BUS_IDENTIFY = 8,
198 BUS_PACKET = 9,
199
200 /* SATA port states */
201 PORT_UNKNOWN = 0,
202 PORT_ENABLED = 1,
203 PORT_DISABLED = 2,
204
205 /* encoding various smaller bitmaps into a single
206 * unsigned int bitmap
207 */
208 ATA_BITS_PIO = 5,
209 ATA_BITS_MWDMA = 3,
210 ATA_BITS_UDMA = 8,
211
212 ATA_SHIFT_PIO = 0,
213 ATA_SHIFT_MWDMA = ATA_SHIFT_PIO + ATA_BITS_PIO,
214 ATA_SHIFT_UDMA = ATA_SHIFT_MWDMA + ATA_BITS_MWDMA,
215
216 ATA_MASK_PIO = ((1 << ATA_BITS_PIO) - 1) << ATA_SHIFT_PIO,
217 ATA_MASK_MWDMA = ((1 << ATA_BITS_MWDMA) - 1) << ATA_SHIFT_MWDMA,
218 ATA_MASK_UDMA = ((1 << ATA_BITS_UDMA) - 1) << ATA_SHIFT_UDMA,
219
220 /* size of buffer to pad xfers ending on unaligned boundaries */
221 ATA_DMA_PAD_SZ = 4,
222 ATA_DMA_PAD_BUF_SZ = ATA_DMA_PAD_SZ * ATA_MAX_QUEUE,
223
224 /* masks for port functions */
225 ATA_PORT_PRIMARY = (1 << 0),
226 ATA_PORT_SECONDARY = (1 << 1),
227
228 /* max repeat if error condition is still set after ->error_handler */
229 ATA_EH_MAX_REPEAT = 5,
230
231 /* how hard are we gonna try to probe/recover devices */
232 ATA_PROBE_MAX_TRIES = 3,
233 };
234
235 enum hsm_task_states {
236 HSM_ST_UNKNOWN,
237 HSM_ST_IDLE,
238 HSM_ST_POLL,
239 HSM_ST_TMOUT,
240 HSM_ST,
241 HSM_ST_LAST,
242 HSM_ST_LAST_POLL,
243 HSM_ST_ERR,
244 };
245
246 enum ata_completion_errors {
247 AC_ERR_DEV = (1 << 0), /* device reported error */
248 AC_ERR_HSM = (1 << 1), /* host state machine violation */
249 AC_ERR_TIMEOUT = (1 << 2), /* timeout */
250 AC_ERR_MEDIA = (1 << 3), /* media error */
251 AC_ERR_ATA_BUS = (1 << 4), /* ATA bus error */
252 AC_ERR_HOST_BUS = (1 << 5), /* host bus error */
253 AC_ERR_SYSTEM = (1 << 6), /* system error */
254 AC_ERR_INVALID = (1 << 7), /* invalid argument */
255 AC_ERR_OTHER = (1 << 8), /* unknown */
256 };
257
258 /* forward declarations */
259 struct scsi_device;
260 struct ata_port_operations;
261 struct ata_port;
262 struct ata_queued_cmd;
263
264 /* typedefs */
265 typedef void (*ata_qc_cb_t) (struct ata_queued_cmd *qc);
266 typedef void (*ata_probeinit_fn_t)(struct ata_port *);
267 typedef int (*ata_reset_fn_t)(struct ata_port *, unsigned int *);
268 typedef void (*ata_postreset_fn_t)(struct ata_port *ap, unsigned int *);
269
270 struct ata_ioports {
271 unsigned long cmd_addr;
272 unsigned long data_addr;
273 unsigned long error_addr;
274 unsigned long feature_addr;
275 unsigned long nsect_addr;
276 unsigned long lbal_addr;
277 unsigned long lbam_addr;
278 unsigned long lbah_addr;
279 unsigned long device_addr;
280 unsigned long status_addr;
281 unsigned long command_addr;
282 unsigned long altstatus_addr;
283 unsigned long ctl_addr;
284 unsigned long bmdma_addr;
285 unsigned long scr_addr;
286 };
287
288 struct ata_probe_ent {
289 struct list_head node;
290 struct device *dev;
291 const struct ata_port_operations *port_ops;
292 struct scsi_host_template *sht;
293 struct ata_ioports port[ATA_MAX_PORTS];
294 unsigned int n_ports;
295 unsigned int hard_port_no;
296 unsigned int pio_mask;
297 unsigned int mwdma_mask;
298 unsigned int udma_mask;
299 unsigned int legacy_mode;
300 unsigned long irq;
301 unsigned int irq_flags;
302 unsigned long host_flags;
303 unsigned long host_set_flags;
304 void __iomem *mmio_base;
305 void *private_data;
306 };
307
308 struct ata_host_set {
309 spinlock_t lock;
310 struct device *dev;
311 unsigned long irq;
312 void __iomem *mmio_base;
313 unsigned int n_ports;
314 void *private_data;
315 const struct ata_port_operations *ops;
316 unsigned long flags;
317 int simplex_claimed; /* Keep seperate in case we
318 ever need to do this locked */
319 struct ata_port * ports[0];
320 };
321
322 struct ata_queued_cmd {
323 struct ata_port *ap;
324 struct ata_device *dev;
325
326 struct scsi_cmnd *scsicmd;
327 void (*scsidone)(struct scsi_cmnd *);
328
329 struct ata_taskfile tf;
330 u8 cdb[ATAPI_CDB_LEN];
331
332 unsigned long flags; /* ATA_QCFLAG_xxx */
333 unsigned int tag;
334 unsigned int n_elem;
335 unsigned int orig_n_elem;
336
337 int dma_dir;
338
339 unsigned int pad_len;
340
341 unsigned int nsect;
342 unsigned int cursect;
343
344 unsigned int nbytes;
345 unsigned int curbytes;
346
347 unsigned int cursg;
348 unsigned int cursg_ofs;
349
350 struct scatterlist sgent;
351 struct scatterlist pad_sgent;
352 void *buf_virt;
353
354 /* DO NOT iterate over __sg manually, use ata_for_each_sg() */
355 struct scatterlist *__sg;
356
357 unsigned int err_mask;
358 struct ata_taskfile result_tf;
359 ata_qc_cb_t complete_fn;
360
361 void *private_data;
362 };
363
364 struct ata_host_stats {
365 unsigned long unhandled_irq;
366 unsigned long idle_irq;
367 unsigned long rw_reqbuf;
368 };
369
370 struct ata_device {
371 struct ata_port *ap;
372 u64 n_sectors; /* size of device, if ATA */
373 unsigned long flags; /* ATA_DFLAG_xxx */
374 unsigned int class; /* ATA_DEV_xxx */
375 unsigned int devno; /* 0 or 1 */
376 u16 id[ATA_ID_WORDS]; /* IDENTIFY xxx DEVICE data */
377 u8 pio_mode;
378 u8 dma_mode;
379 u8 xfer_mode;
380 unsigned int xfer_shift; /* ATA_SHIFT_xxx */
381
382 unsigned int multi_count; /* sectors count for
383 READ/WRITE MULTIPLE */
384 unsigned int max_sectors; /* per-device max sectors */
385 unsigned int cdb_len;
386
387 /* per-dev xfer mask */
388 unsigned int pio_mask;
389 unsigned int mwdma_mask;
390 unsigned int udma_mask;
391
392 /* for CHS addressing */
393 u16 cylinders; /* Number of cylinders */
394 u16 heads; /* Number of heads */
395 u16 sectors; /* Number of sectors per track */
396 };
397
398 struct ata_port {
399 struct Scsi_Host *host; /* our co-allocated scsi host */
400 const struct ata_port_operations *ops;
401 unsigned long flags; /* ATA_FLAG_xxx */
402 unsigned int id; /* unique id req'd by scsi midlyr */
403 unsigned int port_no; /* unique port #; from zero */
404 unsigned int hard_port_no; /* hardware port #; from zero */
405
406 struct ata_prd *prd; /* our SG list */
407 dma_addr_t prd_dma; /* and its DMA mapping */
408
409 void *pad; /* array of DMA pad buffers */
410 dma_addr_t pad_dma;
411
412 struct ata_ioports ioaddr; /* ATA cmd/ctl/dma register blocks */
413
414 u8 ctl; /* cache of ATA control register */
415 u8 last_ctl; /* Cache last written value */
416 unsigned int pio_mask;
417 unsigned int mwdma_mask;
418 unsigned int udma_mask;
419 unsigned int cbl; /* cable type; ATA_CBL_xxx */
420 unsigned int sata_spd_limit; /* SATA PHY speed limit */
421
422 struct ata_device device[ATA_MAX_DEVICES];
423
424 struct ata_queued_cmd qcmd[ATA_MAX_QUEUE];
425 unsigned long qactive;
426 unsigned int active_tag;
427
428 struct ata_host_stats stats;
429 struct ata_host_set *host_set;
430 struct device *dev;
431
432 struct work_struct port_task;
433
434 unsigned int hsm_task_state;
435 unsigned long pio_task_timeout;
436
437 u32 msg_enable;
438 struct list_head eh_done_q;
439
440 void *private_data;
441
442 u8 sector_buf[ATA_SECT_SIZE]; /* owned by EH */
443 };
444
445 struct ata_port_operations {
446 void (*port_disable) (struct ata_port *);
447
448 void (*dev_config) (struct ata_port *, struct ata_device *);
449
450 void (*set_piomode) (struct ata_port *, struct ata_device *);
451 void (*set_dmamode) (struct ata_port *, struct ata_device *);
452 unsigned long (*mode_filter) (const struct ata_port *, struct ata_device *, unsigned long);
453
454 void (*tf_load) (struct ata_port *ap, const struct ata_taskfile *tf);
455 void (*tf_read) (struct ata_port *ap, struct ata_taskfile *tf);
456
457 void (*exec_command)(struct ata_port *ap, const struct ata_taskfile *tf);
458 u8 (*check_status)(struct ata_port *ap);
459 u8 (*check_altstatus)(struct ata_port *ap);
460 void (*dev_select)(struct ata_port *ap, unsigned int device);
461
462 void (*phy_reset) (struct ata_port *ap); /* obsolete */
463 void (*set_mode) (struct ata_port *ap);
464 int (*probe_reset) (struct ata_port *ap, unsigned int *classes);
465
466 void (*post_set_mode) (struct ata_port *ap);
467
468 int (*check_atapi_dma) (struct ata_queued_cmd *qc);
469
470 void (*bmdma_setup) (struct ata_queued_cmd *qc);
471 void (*bmdma_start) (struct ata_queued_cmd *qc);
472
473 void (*qc_prep) (struct ata_queued_cmd *qc);
474 unsigned int (*qc_issue) (struct ata_queued_cmd *qc);
475
476 /* Error handlers. ->error_handler overrides ->eng_timeout and
477 * indicates that new-style EH is in place.
478 */
479 void (*eng_timeout) (struct ata_port *ap); /* obsolete */
480
481 void (*freeze) (struct ata_port *ap);
482 void (*thaw) (struct ata_port *ap);
483 void (*error_handler) (struct ata_port *ap);
484 void (*post_internal_cmd) (struct ata_queued_cmd *qc);
485
486 irqreturn_t (*irq_handler)(int, void *, struct pt_regs *);
487 void (*irq_clear) (struct ata_port *);
488
489 u32 (*scr_read) (struct ata_port *ap, unsigned int sc_reg);
490 void (*scr_write) (struct ata_port *ap, unsigned int sc_reg,
491 u32 val);
492
493 int (*port_start) (struct ata_port *ap);
494 void (*port_stop) (struct ata_port *ap);
495
496 void (*host_stop) (struct ata_host_set *host_set);
497
498 void (*bmdma_stop) (struct ata_queued_cmd *qc);
499 u8 (*bmdma_status) (struct ata_port *ap);
500 };
501
502 struct ata_port_info {
503 struct scsi_host_template *sht;
504 unsigned long host_flags;
505 unsigned long pio_mask;
506 unsigned long mwdma_mask;
507 unsigned long udma_mask;
508 const struct ata_port_operations *port_ops;
509 void *private_data;
510 };
511
512 struct ata_timing {
513 unsigned short mode; /* ATA mode */
514 unsigned short setup; /* t1 */
515 unsigned short act8b; /* t2 for 8-bit I/O */
516 unsigned short rec8b; /* t2i for 8-bit I/O */
517 unsigned short cyc8b; /* t0 for 8-bit I/O */
518 unsigned short active; /* t2 or tD */
519 unsigned short recover; /* t2i or tK */
520 unsigned short cycle; /* t0 */
521 unsigned short udma; /* t2CYCTYP/2 */
522 };
523
524 #define FIT(v,vmin,vmax) max_t(short,min_t(short,v,vmax),vmin)
525
526 extern void ata_port_probe(struct ata_port *);
527 extern void __sata_phy_reset(struct ata_port *ap);
528 extern void sata_phy_reset(struct ata_port *ap);
529 extern void ata_bus_reset(struct ata_port *ap);
530 extern int sata_set_spd(struct ata_port *ap);
531 extern int ata_drive_probe_reset(struct ata_port *ap,
532 ata_probeinit_fn_t probeinit,
533 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
534 ata_postreset_fn_t postreset, unsigned int *classes);
535 extern void ata_std_probeinit(struct ata_port *ap);
536 extern int ata_std_softreset(struct ata_port *ap, unsigned int *classes);
537 extern int sata_std_hardreset(struct ata_port *ap, unsigned int *class);
538 extern void ata_std_postreset(struct ata_port *ap, unsigned int *classes);
539 extern int ata_dev_revalidate(struct ata_device *dev, int post_reset);
540 extern void ata_port_disable(struct ata_port *);
541 extern void ata_std_ports(struct ata_ioports *ioaddr);
542 #ifdef CONFIG_PCI
543 extern int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
544 unsigned int n_ports);
545 extern void ata_pci_remove_one (struct pci_dev *pdev);
546 extern int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t state);
547 extern int ata_pci_device_resume(struct pci_dev *pdev);
548 extern int ata_pci_clear_simplex(struct pci_dev *pdev);
549 #endif /* CONFIG_PCI */
550 extern int ata_device_add(const struct ata_probe_ent *ent);
551 extern void ata_host_set_remove(struct ata_host_set *host_set);
552 extern int ata_scsi_detect(struct scsi_host_template *sht);
553 extern int ata_scsi_ioctl(struct scsi_device *dev, int cmd, void __user *arg);
554 extern int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *));
555 extern int ata_scsi_release(struct Scsi_Host *host);
556 extern unsigned int ata_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
557 extern int sata_scr_valid(struct ata_port *ap);
558 extern int sata_scr_read(struct ata_port *ap, int reg, u32 *val);
559 extern int sata_scr_write(struct ata_port *ap, int reg, u32 val);
560 extern int sata_scr_write_flush(struct ata_port *ap, int reg, u32 val);
561 extern int ata_port_online(struct ata_port *ap);
562 extern int ata_port_offline(struct ata_port *ap);
563 extern int ata_scsi_device_resume(struct scsi_device *);
564 extern int ata_scsi_device_suspend(struct scsi_device *, pm_message_t state);
565 extern int ata_device_resume(struct ata_device *);
566 extern int ata_device_suspend(struct ata_device *, pm_message_t state);
567 extern int ata_ratelimit(void);
568 extern unsigned int ata_busy_sleep(struct ata_port *ap,
569 unsigned long timeout_pat,
570 unsigned long timeout);
571 extern void ata_port_queue_task(struct ata_port *ap, void (*fn)(void *),
572 void *data, unsigned long delay);
573 extern u32 ata_wait_register(void __iomem *reg, u32 mask, u32 val,
574 unsigned long interval_msec,
575 unsigned long timeout_msec);
576
577 /*
578 * Default driver ops implementations
579 */
580 extern void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
581 extern void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
582 extern void ata_tf_to_fis(const struct ata_taskfile *tf, u8 *fis, u8 pmp);
583 extern void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf);
584 extern void ata_noop_dev_select (struct ata_port *ap, unsigned int device);
585 extern void ata_std_dev_select (struct ata_port *ap, unsigned int device);
586 extern u8 ata_check_status(struct ata_port *ap);
587 extern u8 ata_altstatus(struct ata_port *ap);
588 extern void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf);
589 extern int ata_std_probe_reset(struct ata_port *ap, unsigned int *classes);
590 extern int ata_port_start (struct ata_port *ap);
591 extern void ata_port_stop (struct ata_port *ap);
592 extern void ata_host_stop (struct ata_host_set *host_set);
593 extern irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
594 extern void ata_qc_prep(struct ata_queued_cmd *qc);
595 extern void ata_noop_qc_prep(struct ata_queued_cmd *qc);
596 extern unsigned int ata_qc_issue_prot(struct ata_queued_cmd *qc);
597 extern void ata_sg_init_one(struct ata_queued_cmd *qc, void *buf,
598 unsigned int buflen);
599 extern void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
600 unsigned int n_elem);
601 extern unsigned int ata_dev_classify(const struct ata_taskfile *tf);
602 extern void ata_id_string(const u16 *id, unsigned char *s,
603 unsigned int ofs, unsigned int len);
604 extern void ata_id_c_string(const u16 *id, unsigned char *s,
605 unsigned int ofs, unsigned int len);
606 extern void ata_bmdma_setup (struct ata_queued_cmd *qc);
607 extern void ata_bmdma_start (struct ata_queued_cmd *qc);
608 extern void ata_bmdma_stop(struct ata_queued_cmd *qc);
609 extern u8 ata_bmdma_status(struct ata_port *ap);
610 extern void ata_bmdma_irq_clear(struct ata_port *ap);
611 extern void ata_qc_complete(struct ata_queued_cmd *qc);
612 extern void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
613 void (*done)(struct scsi_cmnd *));
614 extern int ata_std_bios_param(struct scsi_device *sdev,
615 struct block_device *bdev,
616 sector_t capacity, int geom[]);
617 extern int ata_scsi_slave_config(struct scsi_device *sdev);
618 extern struct ata_device *ata_dev_pair(struct ata_device *adev);
619
620 /*
621 * Timing helpers
622 */
623
624 extern unsigned int ata_pio_need_iordy(const struct ata_device *);
625 extern int ata_timing_compute(struct ata_device *, unsigned short,
626 struct ata_timing *, int, int);
627 extern void ata_timing_merge(const struct ata_timing *,
628 const struct ata_timing *, struct ata_timing *,
629 unsigned int);
630
631 enum {
632 ATA_TIMING_SETUP = (1 << 0),
633 ATA_TIMING_ACT8B = (1 << 1),
634 ATA_TIMING_REC8B = (1 << 2),
635 ATA_TIMING_CYC8B = (1 << 3),
636 ATA_TIMING_8BIT = ATA_TIMING_ACT8B | ATA_TIMING_REC8B |
637 ATA_TIMING_CYC8B,
638 ATA_TIMING_ACTIVE = (1 << 4),
639 ATA_TIMING_RECOVER = (1 << 5),
640 ATA_TIMING_CYCLE = (1 << 6),
641 ATA_TIMING_UDMA = (1 << 7),
642 ATA_TIMING_ALL = ATA_TIMING_SETUP | ATA_TIMING_ACT8B |
643 ATA_TIMING_REC8B | ATA_TIMING_CYC8B |
644 ATA_TIMING_ACTIVE | ATA_TIMING_RECOVER |
645 ATA_TIMING_CYCLE | ATA_TIMING_UDMA,
646 };
647
648
649 #ifdef CONFIG_PCI
650 struct pci_bits {
651 unsigned int reg; /* PCI config register to read */
652 unsigned int width; /* 1 (8 bit), 2 (16 bit), 4 (32 bit) */
653 unsigned long mask;
654 unsigned long val;
655 };
656
657 extern void ata_pci_host_stop (struct ata_host_set *host_set);
658 extern struct ata_probe_ent *
659 ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int portmask);
660 extern int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits);
661 extern unsigned long ata_pci_default_filter(const struct ata_port *, struct ata_device *, unsigned long);
662 #endif /* CONFIG_PCI */
663
664 /*
665 * EH
666 */
667 extern void ata_eng_timeout(struct ata_port *ap);
668
669 extern void ata_port_schedule_eh(struct ata_port *ap);
670 extern int ata_port_abort(struct ata_port *ap);
671 extern int ata_port_freeze(struct ata_port *ap);
672
673 extern void ata_eh_freeze_port(struct ata_port *ap);
674 extern void ata_eh_thaw_port(struct ata_port *ap);
675
676 extern void ata_eh_qc_complete(struct ata_queued_cmd *qc);
677 extern void ata_eh_qc_retry(struct ata_queued_cmd *qc);
678
679 /*
680 * printk helpers
681 */
682 #define ata_port_printk(ap, lv, fmt, args...) \
683 printk(lv"ata%u: "fmt, (ap)->id , ##args)
684
685 #define ata_dev_printk(dev, lv, fmt, args...) \
686 printk(lv"ata%u.%02u: "fmt, (dev)->ap->id, (dev)->devno , ##args)
687
688 /*
689 * qc helpers
690 */
691 static inline int
692 ata_sg_is_last(struct scatterlist *sg, struct ata_queued_cmd *qc)
693 {
694 if (sg == &qc->pad_sgent)
695 return 1;
696 if (qc->pad_len)
697 return 0;
698 if (((sg - qc->__sg) + 1) == qc->n_elem)
699 return 1;
700 return 0;
701 }
702
703 static inline struct scatterlist *
704 ata_qc_first_sg(struct ata_queued_cmd *qc)
705 {
706 if (qc->n_elem)
707 return qc->__sg;
708 if (qc->pad_len)
709 return &qc->pad_sgent;
710 return NULL;
711 }
712
713 static inline struct scatterlist *
714 ata_qc_next_sg(struct scatterlist *sg, struct ata_queued_cmd *qc)
715 {
716 if (sg == &qc->pad_sgent)
717 return NULL;
718 if (++sg - qc->__sg < qc->n_elem)
719 return sg;
720 if (qc->pad_len)
721 return &qc->pad_sgent;
722 return NULL;
723 }
724
725 #define ata_for_each_sg(sg, qc) \
726 for (sg = ata_qc_first_sg(qc); sg; sg = ata_qc_next_sg(sg, qc))
727
728 static inline unsigned int ata_tag_valid(unsigned int tag)
729 {
730 return (tag < ATA_MAX_QUEUE) ? 1 : 0;
731 }
732
733 static inline unsigned int ata_tag_internal(unsigned int tag)
734 {
735 return tag == ATA_MAX_QUEUE - 1;
736 }
737
738 static inline unsigned int ata_class_enabled(unsigned int class)
739 {
740 return class == ATA_DEV_ATA || class == ATA_DEV_ATAPI;
741 }
742
743 static inline unsigned int ata_class_disabled(unsigned int class)
744 {
745 return class == ATA_DEV_ATA_UNSUP || class == ATA_DEV_ATAPI_UNSUP;
746 }
747
748 static inline unsigned int ata_class_absent(unsigned int class)
749 {
750 return !ata_class_enabled(class) && !ata_class_disabled(class);
751 }
752
753 static inline unsigned int ata_dev_enabled(const struct ata_device *dev)
754 {
755 return ata_class_enabled(dev->class);
756 }
757
758 static inline unsigned int ata_dev_disabled(const struct ata_device *dev)
759 {
760 return ata_class_disabled(dev->class);
761 }
762
763 static inline unsigned int ata_dev_absent(const struct ata_device *dev)
764 {
765 return ata_class_absent(dev->class);
766 }
767
768 static inline u8 ata_chk_status(struct ata_port *ap)
769 {
770 return ap->ops->check_status(ap);
771 }
772
773
774 /**
775 * ata_pause - Flush writes and pause 400 nanoseconds.
776 * @ap: Port to wait for.
777 *
778 * LOCKING:
779 * Inherited from caller.
780 */
781
782 static inline void ata_pause(struct ata_port *ap)
783 {
784 ata_altstatus(ap);
785 ndelay(400);
786 }
787
788
789 /**
790 * ata_busy_wait - Wait for a port status register
791 * @ap: Port to wait for.
792 *
793 * Waits up to max*10 microseconds for the selected bits in the port's
794 * status register to be cleared.
795 * Returns final value of status register.
796 *
797 * LOCKING:
798 * Inherited from caller.
799 */
800
801 static inline u8 ata_busy_wait(struct ata_port *ap, unsigned int bits,
802 unsigned int max)
803 {
804 u8 status;
805
806 do {
807 udelay(10);
808 status = ata_chk_status(ap);
809 max--;
810 } while ((status & bits) && (max > 0));
811
812 return status;
813 }
814
815
816 /**
817 * ata_wait_idle - Wait for a port to be idle.
818 * @ap: Port to wait for.
819 *
820 * Waits up to 10ms for port's BUSY and DRQ signals to clear.
821 * Returns final value of status register.
822 *
823 * LOCKING:
824 * Inherited from caller.
825 */
826
827 static inline u8 ata_wait_idle(struct ata_port *ap)
828 {
829 u8 status = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
830
831 if (status & (ATA_BUSY | ATA_DRQ)) {
832 unsigned long l = ap->ioaddr.status_addr;
833 if (ata_msg_warn(ap))
834 printk(KERN_WARNING "ATA: abnormal status 0x%X on port 0x%lX\n",
835 status, l);
836 }
837
838 return status;
839 }
840
841 static inline void ata_qc_set_polling(struct ata_queued_cmd *qc)
842 {
843 qc->tf.ctl |= ATA_NIEN;
844 }
845
846 static inline struct ata_queued_cmd *__ata_qc_from_tag(struct ata_port *ap,
847 unsigned int tag)
848 {
849 if (likely(ata_tag_valid(tag)))
850 return &ap->qcmd[tag];
851 return NULL;
852 }
853
854 static inline struct ata_queued_cmd *ata_qc_from_tag(struct ata_port *ap,
855 unsigned int tag)
856 {
857 struct ata_queued_cmd *qc = __ata_qc_from_tag(ap, tag);
858
859 if (unlikely(!qc) || !ap->ops->error_handler)
860 return qc;
861
862 if ((qc->flags & (ATA_QCFLAG_ACTIVE |
863 ATA_QCFLAG_FAILED)) == ATA_QCFLAG_ACTIVE)
864 return qc;
865
866 return NULL;
867 }
868
869 static inline void ata_tf_init(struct ata_device *dev, struct ata_taskfile *tf)
870 {
871 memset(tf, 0, sizeof(*tf));
872
873 tf->ctl = dev->ap->ctl;
874 if (dev->devno == 0)
875 tf->device = ATA_DEVICE_OBS;
876 else
877 tf->device = ATA_DEVICE_OBS | ATA_DEV1;
878 }
879
880 static inline void ata_qc_reinit(struct ata_queued_cmd *qc)
881 {
882 qc->__sg = NULL;
883 qc->flags = 0;
884 qc->cursect = qc->cursg = qc->cursg_ofs = 0;
885 qc->nsect = 0;
886 qc->nbytes = qc->curbytes = 0;
887 qc->err_mask = 0;
888
889 ata_tf_init(qc->dev, &qc->tf);
890
891 /* init result_tf such that it indicates normal completion */
892 qc->result_tf.command = ATA_DRDY;
893 qc->result_tf.feature = 0;
894 }
895
896 /**
897 * ata_irq_on - Enable interrupts on a port.
898 * @ap: Port on which interrupts are enabled.
899 *
900 * Enable interrupts on a legacy IDE device using MMIO or PIO,
901 * wait for idle, clear any pending interrupts.
902 *
903 * LOCKING:
904 * Inherited from caller.
905 */
906
907 static inline u8 ata_irq_on(struct ata_port *ap)
908 {
909 struct ata_ioports *ioaddr = &ap->ioaddr;
910 u8 tmp;
911
912 ap->ctl &= ~ATA_NIEN;
913 ap->last_ctl = ap->ctl;
914
915 if (ap->flags & ATA_FLAG_MMIO)
916 writeb(ap->ctl, (void __iomem *) ioaddr->ctl_addr);
917 else
918 outb(ap->ctl, ioaddr->ctl_addr);
919 tmp = ata_wait_idle(ap);
920
921 ap->ops->irq_clear(ap);
922
923 return tmp;
924 }
925
926
927 /**
928 * ata_irq_ack - Acknowledge a device interrupt.
929 * @ap: Port on which interrupts are enabled.
930 *
931 * Wait up to 10 ms for legacy IDE device to become idle (BUSY
932 * or BUSY+DRQ clear). Obtain dma status and port status from
933 * device. Clear the interrupt. Return port status.
934 *
935 * LOCKING:
936 */
937
938 static inline u8 ata_irq_ack(struct ata_port *ap, unsigned int chk_drq)
939 {
940 unsigned int bits = chk_drq ? ATA_BUSY | ATA_DRQ : ATA_BUSY;
941 u8 host_stat, post_stat, status;
942
943 status = ata_busy_wait(ap, bits, 1000);
944 if (status & bits)
945 if (ata_msg_err(ap))
946 printk(KERN_ERR "abnormal status 0x%X\n", status);
947
948 /* get controller status; clear intr, err bits */
949 if (ap->flags & ATA_FLAG_MMIO) {
950 void __iomem *mmio = (void __iomem *) ap->ioaddr.bmdma_addr;
951 host_stat = readb(mmio + ATA_DMA_STATUS);
952 writeb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
953 mmio + ATA_DMA_STATUS);
954
955 post_stat = readb(mmio + ATA_DMA_STATUS);
956 } else {
957 host_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
958 outb(host_stat | ATA_DMA_INTR | ATA_DMA_ERR,
959 ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
960
961 post_stat = inb(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
962 }
963
964 if (ata_msg_intr(ap))
965 printk(KERN_INFO "%s: irq ack: host_stat 0x%X, new host_stat 0x%X, drv_stat 0x%X\n",
966 __FUNCTION__,
967 host_stat, post_stat, status);
968
969 return status;
970 }
971
972 static inline int ata_try_flush_cache(const struct ata_device *dev)
973 {
974 return ata_id_wcache_enabled(dev->id) ||
975 ata_id_has_flush(dev->id) ||
976 ata_id_has_flush_ext(dev->id);
977 }
978
979 static inline unsigned int ac_err_mask(u8 status)
980 {
981 if (status & ATA_BUSY)
982 return AC_ERR_HSM;
983 if (status & (ATA_ERR | ATA_DF))
984 return AC_ERR_DEV;
985 return 0;
986 }
987
988 static inline unsigned int __ac_err_mask(u8 status)
989 {
990 unsigned int mask = ac_err_mask(status);
991 if (mask == 0)
992 return AC_ERR_OTHER;
993 return mask;
994 }
995
996 static inline int ata_pad_alloc(struct ata_port *ap, struct device *dev)
997 {
998 ap->pad_dma = 0;
999 ap->pad = dma_alloc_coherent(dev, ATA_DMA_PAD_BUF_SZ,
1000 &ap->pad_dma, GFP_KERNEL);
1001 return (ap->pad == NULL) ? -ENOMEM : 0;
1002 }
1003
1004 static inline void ata_pad_free(struct ata_port *ap, struct device *dev)
1005 {
1006 dma_free_coherent(dev, ATA_DMA_PAD_BUF_SZ, ap->pad, ap->pad_dma);
1007 }
1008
1009 static inline struct ata_port *ata_shost_to_port(struct Scsi_Host *host)
1010 {
1011 return (struct ata_port *) &host->hostdata[0];
1012 }
1013
1014 #endif /* __LINUX_LIBATA_H__ */
This page took 0.067775 seconds and 6 git commands to generate.