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