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


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