?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
initial commit with v2.6.9
[linux-2.6.9-moxart.git] / include / linux / ide.h
blobf6a39379ada93e77f68f9cd52db9f69445d976fa
1 #ifndef _IDE_H
2 #define _IDE_H
3 /*
4 * linux/include/linux/ide.h
5 *
6 * Copyright (C) 1994-2002 Linus Torvalds & authors
7 */
8
9 #include <linux/config.h>
10 #include <linux/init.h>
11 #include <linux/ioport.h>
12 #include <linux/hdreg.h>
13 #include <linux/hdsmart.h>
14 #include <linux/blkdev.h>
15 #include <linux/proc_fs.h>
16 #include <linux/interrupt.h>
17 #include <linux/bitops.h>
18 #include <linux/bio.h>
19 #include <linux/device.h>
20 #include <linux/pci.h>
21 #include <asm/byteorder.h>
22 #include <asm/system.h>
23 #include <asm/io.h>
24 #include <asm/semaphore.h>
25
26 /*
27 * This is the multiple IDE interface driver, as evolved from hd.c.
28 * It supports up to four IDE interfaces, on one or more IRQs (usually 14 & 15).
29 * There can be up to two drives per interface, as per the ATA-2 spec.
30 *
31 * Primary i/f: ide0: major=3; (hda) minor=0; (hdb) minor=64
32 * Secondary i/f: ide1: major=22; (hdc or hd1a) minor=0; (hdd or hd1b) minor=64
33 * Tertiary i/f: ide2: major=33; (hde) minor=0; (hdf) minor=64
34 * Quaternary i/f: ide3: major=34; (hdg) minor=0; (hdh) minor=64
35 */
36
37 /******************************************************************************
38 * IDE driver configuration options (play with these as desired):
39 *
40 * REALLY_SLOW_IO can be defined in ide.c and ide-cd.c, if necessary
41 */
42 #define REALLY_FAST_IO /* define if ide ports are perfect */
43 #define INITIAL_MULT_COUNT 0 /* off=0; on=2,4,8,16,32, etc.. */
44
45 #ifndef SUPPORT_SLOW_DATA_PORTS /* 1 to support slow data ports */
46 #define SUPPORT_SLOW_DATA_PORTS 1 /* 0 to reduce kernel size */
47 #endif
48 #ifndef SUPPORT_VLB_SYNC /* 1 to support weird 32-bit chips */
49 #define SUPPORT_VLB_SYNC 1 /* 0 to reduce kernel size */
50 #endif
51 #ifndef OK_TO_RESET_CONTROLLER /* 1 needed for good error recovery */
52 #define OK_TO_RESET_CONTROLLER 1 /* 0 for use with AH2372A/B interface */
53 #endif
54
55 #ifndef DISABLE_IRQ_NOSYNC
56 #define DISABLE_IRQ_NOSYNC 0
57 #endif
58
59 /*
60 * Used to indicate "no IRQ", should be a value that cannot be an IRQ
61 * number.
62 */
63
64 #define IDE_NO_IRQ (-1)
65
66 /*
67 * IDE_DRIVE_CMD is used to implement many features of the hdparm utility
68 */
69 #define IDE_DRIVE_CMD 99 /* (magic) undef to reduce kernel size*/
70
71 #define IDE_DRIVE_TASK 98
72
73 /*
74 * IDE_DRIVE_TASKFILE is used to implement many features needed for raw tasks
75 */
76 #define IDE_DRIVE_TASKFILE 97
77
78 /*
79 * "No user-serviceable parts" beyond this point :)
80 *****************************************************************************/
81
82 typedef unsigned char byte; /* used everywhere */
83
84 /*
85 * Probably not wise to fiddle with these
86 */
87 #define ERROR_MAX 8 /* Max read/write errors per sector */
88 #define ERROR_RESET 3 /* Reset controller every 4th retry */
89 #define ERROR_RECAL 1 /* Recalibrate every 2nd retry */
90
91 /*
92 * Tune flags
93 */
94 #define IDE_TUNE_NOAUTO 2
95 #define IDE_TUNE_AUTO 1
96 #define IDE_TUNE_DEFAULT 0
97
98 /*
99 * state flags
100 */
101
102 #define DMA_PIO_RETRY 1 /* retrying in PIO */
103
104 /*
105 * Ensure that various configuration flags have compatible settings
106 */
107 #ifdef REALLY_SLOW_IO
108 #undef REALLY_FAST_IO
109 #endif
110
111 #define HWIF(drive) ((ide_hwif_t *)((drive)->hwif))
112 #define HWGROUP(drive) ((ide_hwgroup_t *)(HWIF(drive)->hwgroup))
113
114 /*
115 * Definitions for accessing IDE controller registers
116 */
117 #define IDE_NR_PORTS (10)
118
119 #define IDE_DATA_OFFSET (0)
120 #define IDE_ERROR_OFFSET (1)
121 #define IDE_NSECTOR_OFFSET (2)
122 #define IDE_SECTOR_OFFSET (3)
123 #define IDE_LCYL_OFFSET (4)
124 #define IDE_HCYL_OFFSET (5)
125 #define IDE_SELECT_OFFSET (6)
126 #define IDE_STATUS_OFFSET (7)
127 #define IDE_CONTROL_OFFSET (8)
128 #define IDE_IRQ_OFFSET (9)
129
130 #define IDE_FEATURE_OFFSET IDE_ERROR_OFFSET
131 #define IDE_COMMAND_OFFSET IDE_STATUS_OFFSET
132
133 #define IDE_CONTROL_OFFSET_HOB (7)
134
135 #define IDE_DATA_REG (HWIF(drive)->io_ports[IDE_DATA_OFFSET])
136 #define IDE_ERROR_REG (HWIF(drive)->io_ports[IDE_ERROR_OFFSET])
137 #define IDE_NSECTOR_REG (HWIF(drive)->io_ports[IDE_NSECTOR_OFFSET])
138 #define IDE_SECTOR_REG (HWIF(drive)->io_ports[IDE_SECTOR_OFFSET])
139 #define IDE_LCYL_REG (HWIF(drive)->io_ports[IDE_LCYL_OFFSET])
140 #define IDE_HCYL_REG (HWIF(drive)->io_ports[IDE_HCYL_OFFSET])
141 #define IDE_SELECT_REG (HWIF(drive)->io_ports[IDE_SELECT_OFFSET])
142 #define IDE_STATUS_REG (HWIF(drive)->io_ports[IDE_STATUS_OFFSET])
143 #define IDE_CONTROL_REG (HWIF(drive)->io_ports[IDE_CONTROL_OFFSET])
144 #define IDE_IRQ_REG (HWIF(drive)->io_ports[IDE_IRQ_OFFSET])
145
146 #define IDE_FEATURE_REG IDE_ERROR_REG
147 #define IDE_COMMAND_REG IDE_STATUS_REG
148 #define IDE_ALTSTATUS_REG IDE_CONTROL_REG
149 #define IDE_IREASON_REG IDE_NSECTOR_REG
150 #define IDE_BCOUNTL_REG IDE_LCYL_REG
151 #define IDE_BCOUNTH_REG IDE_HCYL_REG
152
153 #define OK_STAT(stat,good,bad) (((stat)&((good)|(bad)))==(good))
154 #define BAD_R_STAT (BUSY_STAT | ERR_STAT)
155 #define BAD_W_STAT (BAD_R_STAT | WRERR_STAT)
156 #define BAD_STAT (BAD_R_STAT | DRQ_STAT)
157 #define DRIVE_READY (READY_STAT | SEEK_STAT)
158 #define DATA_READY (DRQ_STAT)
159
160 #define BAD_CRC (ABRT_ERR | ICRC_ERR)
161
162 #define SATA_NR_PORTS (3) /* 16 possible ?? */
163
164 #define SATA_STATUS_OFFSET (0)
165 #define SATA_STATUS_REG (HWIF(drive)->sata_scr[SATA_STATUS_OFFSET])
166 #define SATA_ERROR_OFFSET (1)
167 #define SATA_ERROR_REG (HWIF(drive)->sata_scr[SATA_ERROR_OFFSET])
168 #define SATA_CONTROL_OFFSET (2)
169 #define SATA_CONTROL_REG (HWIF(drive)->sata_scr[SATA_CONTROL_OFFSET])
170
171 #define SATA_MISC_OFFSET (0)
172 #define SATA_MISC_REG (HWIF(drive)->sata_misc[SATA_MISC_OFFSET])
173 #define SATA_PHY_OFFSET (1)
174 #define SATA_PHY_REG (HWIF(drive)->sata_misc[SATA_PHY_OFFSET])
175 #define SATA_IEN_OFFSET (2)
176 #define SATA_IEN_REG (HWIF(drive)->sata_misc[SATA_IEN_OFFSET])
177
178 /*
179 * Our Physical Region Descriptor (PRD) table should be large enough
180 * to handle the biggest I/O request we are likely to see. Since requests
181 * can have no more than 256 sectors, and since the typical blocksize is
182 * two or more sectors, we could get by with a limit of 128 entries here for
183 * the usual worst case. Most requests seem to include some contiguous blocks,
184 * further reducing the number of table entries required.
185 *
186 * The driver reverts to PIO mode for individual requests that exceed
187 * this limit (possible with 512 byte blocksizes, eg. MSDOS f/s), so handling
188 * 100% of all crazy scenarios here is not necessary.
189 *
190 * As it turns out though, we must allocate a full 4KB page for this,
191 * so the two PRD tables (ide0 & ide1) will each get half of that,
192 * allowing each to have about 256 entries (8 bytes each) from this.
193 */
194 #define PRD_BYTES 8
195 #define PRD_ENTRIES 256
196
197 /*
198 * Some more useful definitions
199 */
200 #define IDE_MAJOR_NAME "hd" /* the same for all i/f; see also genhd.c */
201 #define MAJOR_NAME IDE_MAJOR_NAME
202 #define PARTN_BITS 6 /* number of minor dev bits for partitions */
203 #define PARTN_MASK ((1<<PARTN_BITS)-1) /* a useful bit mask */
204 #define MAX_DRIVES 2 /* per interface; 2 assumed by lots of code */
205 #define SECTOR_SIZE 512
206 #define SECTOR_WORDS (SECTOR_SIZE / 4) /* number of 32bit words per sector */
207 #define IDE_LARGE_SEEK(b1,b2,t) (((b1) > (b2) + (t)) || ((b2) > (b1) + (t)))
208
209 /*
210 * Timeouts for various operations:
211 */
212 #define WAIT_DRQ (HZ/10) /* 100msec - spec allows up to 20ms */
213 #if defined(CONFIG_APM) || defined(CONFIG_APM_MODULE)
214 #define WAIT_READY (5*HZ) /* 5sec - some laptops are very slow */
215 #else
216 #define WAIT_READY (HZ/10) /* 100msec - should be instantaneous */
217 #endif /* CONFIG_APM || CONFIG_APM_MODULE */
218 #define WAIT_PIDENTIFY (10*HZ) /* 10sec - should be less than 3ms (?), if all ATAPI CD is closed at boot */
219 #define WAIT_WORSTCASE (30*HZ) /* 30sec - worst case when spinning up */
220 #define WAIT_CMD (10*HZ) /* 10sec - maximum wait for an IRQ to happen */
221 #define WAIT_MIN_SLEEP (2*HZ/100) /* 20msec - minimum sleep time */
222
223 #define HOST(hwif,chipset) \
224 { \
225 return ((hwif)->chipset == chipset) ? 1 : 0; \
226 }
227
228 /*
229 * Check for an interrupt and acknowledge the interrupt status
230 */
231 struct hwif_s;
232 typedef int (ide_ack_intr_t)(struct hwif_s *);
233
234 #ifndef NO_DMA
235 #define NO_DMA 255
236 #endif
237
238 /*
239 * hwif_chipset_t is used to keep track of the specific hardware
240 * chipset used by each IDE interface, if known.
241 */
242 typedef enum { ide_unknown, ide_generic, ide_pci,
243 ide_cmd640, ide_dtc2278, ide_ali14xx,
244 ide_qd65xx, ide_umc8672, ide_ht6560b,
245 ide_pdc4030, ide_rz1000, ide_trm290,
246 ide_cmd646, ide_cy82c693, ide_4drives,
247 ide_pmac, ide_etrax100, ide_acorn,
248 ide_forced
249 } hwif_chipset_t;
250
251 /*
252 * Structure to hold all information about the location of this port
253 */
254 typedef struct hw_regs_s {
255 unsigned long io_ports[IDE_NR_PORTS]; /* task file registers */
256 int irq; /* our irq number */
257 int dma; /* our dma entry */
258 ide_ack_intr_t *ack_intr; /* acknowledge interrupt */
259 void *priv; /* interface specific data */
260 hwif_chipset_t chipset;
261 unsigned long sata_scr[SATA_NR_PORTS];
262 unsigned long sata_misc[SATA_NR_PORTS];
263 } hw_regs_t;
264
265 /*
266 * Register new hardware with ide
267 */
268 int ide_register_hw(hw_regs_t *hw, struct hwif_s **hwifp);
269
270 /*
271 * Set up hw_regs_t structure before calling ide_register_hw (optional)
272 */
273 void ide_setup_ports( hw_regs_t *hw,
274 unsigned long base,
275 int *offsets,
276 unsigned long ctrl,
277 unsigned long intr,
278 ide_ack_intr_t *ack_intr,
279 #if 0
280 ide_io_ops_t *iops,
281 #endif
282 int irq);
283
284 static inline void ide_std_init_ports(hw_regs_t *hw,
285 unsigned long io_addr,
286 unsigned long ctl_addr)
287 {
288 unsigned int i;
289
290 for (i = IDE_DATA_OFFSET; i <= IDE_STATUS_OFFSET; i++)
291 hw->io_ports[i] = io_addr++;
292
293 hw->io_ports[IDE_CONTROL_OFFSET] = ctl_addr;
294 }
295
296 #include <asm/ide.h>
297
298 /* needed on alpha, x86/x86_64, ia64, mips, ppc32 and sh */
299 #ifndef IDE_ARCH_OBSOLETE_DEFAULTS
300 # define ide_default_io_base(index) (0)
301 # define ide_default_irq(base) (0)
302 # define ide_init_default_irq(base) (0)
303 #endif
304
305 /*
306 * ide_init_hwif_ports() is OBSOLETE and will be removed in 2.7 series.
307 * New ports shouldn't define IDE_ARCH_OBSOLETE_INIT in <asm/ide.h>.
308 */
309 #ifdef IDE_ARCH_OBSOLETE_INIT
310 static inline void ide_init_hwif_ports(hw_regs_t *hw,
311 unsigned long io_addr,
312 unsigned long ctl_addr,
313 int *irq)
314 {
315 if (!ctl_addr)
316 ide_std_init_ports(hw, io_addr, ide_default_io_ctl(io_addr));
317 else
318 ide_std_init_ports(hw, io_addr, ctl_addr);
319
320 if (irq)
321 *irq = 0;
322
323 hw->io_ports[IDE_IRQ_OFFSET] = 0;
324
325 #ifdef CONFIG_PPC32
326 if (ppc_ide_md.ide_init_hwif)
327 ppc_ide_md.ide_init_hwif(hw, io_addr, ctl_addr, irq);
328 #endif
329 }
330 #else
331 static inline void ide_init_hwif_ports(hw_regs_t *hw,
332 unsigned long io_addr,
333 unsigned long ctl_addr,
334 int *irq)
335 {
336 if (io_addr || ctl_addr)
337 printk(KERN_WARNING "%s: must not be called\n", __FUNCTION__);
338 }
339 #endif /* IDE_ARCH_OBSOLETE_INIT */
340
341 /* Currently only m68k, apus and m8xx need it */
342 #ifndef IDE_ARCH_ACK_INTR
343 # define ide_ack_intr(hwif) (1)
344 #endif
345
346 /* Currently only Atari needs it */
347 #ifndef IDE_ARCH_LOCK
348 # define ide_release_lock() do {} while (0)
349 # define ide_get_lock(hdlr, data) do {} while (0)
350 #endif /* IDE_ARCH_LOCK */
351
352 /*
353 * Now for the data we need to maintain per-drive: ide_drive_t
354 */
355
356 #define ide_scsi 0x21
357 #define ide_disk 0x20
358 #define ide_optical 0x7
359 #define ide_cdrom 0x5
360 #define ide_tape 0x1
361 #define ide_floppy 0x0
362
363 /*
364 * Special Driver Flags
365 *
366 * set_geometry : respecify drive geometry
367 * recalibrate : seek to cyl 0
368 * set_multmode : set multmode count
369 * set_tune : tune interface for drive
370 * serviced : service command
371 * reserved : unused
372 */
373 typedef union {
374 unsigned all : 8;
375 struct {
376 #if defined(__LITTLE_ENDIAN_BITFIELD)
377 unsigned set_geometry : 1;
378 unsigned recalibrate : 1;
379 unsigned set_multmode : 1;
380 unsigned set_tune : 1;
381 unsigned serviced : 1;
382 unsigned reserved : 3;
383 #elif defined(__BIG_ENDIAN_BITFIELD)
384 unsigned reserved : 3;
385 unsigned serviced : 1;
386 unsigned set_tune : 1;
387 unsigned set_multmode : 1;
388 unsigned recalibrate : 1;
389 unsigned set_geometry : 1;
390 #else
391 #error "Please fix <asm/byteorder.h>"
392 #endif
393 } b;
394 } special_t;
395
396 /*
397 * ATA DATA Register Special.
398 * ATA NSECTOR Count Register().
399 * ATAPI Byte Count Register.
400 * Channel index ordering pairs.
401 */
402 typedef union {
403 unsigned all :16;
404 struct {
405 #if defined(__LITTLE_ENDIAN_BITFIELD)
406 unsigned low :8; /* LSB */
407 unsigned high :8; /* MSB */
408 #elif defined(__BIG_ENDIAN_BITFIELD)
409 unsigned high :8; /* MSB */
410 unsigned low :8; /* LSB */
411 #else
412 #error "Please fix <asm/byteorder.h>"
413 #endif
414 } b;
415 } ata_nsector_t, ata_data_t, atapi_bcount_t, ata_index_t;
416
417 /*
418 * ATA-IDE Error Register
419 *
420 * mark : Bad address mark
421 * tzero : Couldn't find track 0
422 * abrt : Aborted Command
423 * mcr : Media Change Request
424 * id : ID field not found
425 * mce : Media Change Event
426 * ecc : Uncorrectable ECC error
427 * bdd : dual meaing
428 */
429 typedef union {
430 unsigned all :8;
431 struct {
432 #if defined(__LITTLE_ENDIAN_BITFIELD)
433 unsigned mark :1;
434 unsigned tzero :1;
435 unsigned abrt :1;
436 unsigned mcr :1;
437 unsigned id :1;
438 unsigned mce :1;
439 unsigned ecc :1;
440 unsigned bdd :1;
441 #elif defined(__BIG_ENDIAN_BITFIELD)
442 unsigned bdd :1;
443 unsigned ecc :1;
444 unsigned mce :1;
445 unsigned id :1;
446 unsigned mcr :1;
447 unsigned abrt :1;
448 unsigned tzero :1;
449 unsigned mark :1;
450 #else
451 #error "Please fix <asm/byteorder.h>"
452 #endif
453 } b;
454 } ata_error_t;
455
456 /*
457 * ATA-IDE Select Register, aka Device-Head
458 *
459 * head : always zeros here
460 * unit : drive select number: 0/1
461 * bit5 : always 1
462 * lba : using LBA instead of CHS
463 * bit7 : always 1
464 */
465 typedef union {
466 unsigned all : 8;
467 struct {
468 #if defined(__LITTLE_ENDIAN_BITFIELD)
469 unsigned head : 4;
470 unsigned unit : 1;
471 unsigned bit5 : 1;
472 unsigned lba : 1;
473 unsigned bit7 : 1;
474 #elif defined(__BIG_ENDIAN_BITFIELD)
475 unsigned bit7 : 1;
476 unsigned lba : 1;
477 unsigned bit5 : 1;
478 unsigned unit : 1;
479 unsigned head : 4;
480 #else
481 #error "Please fix <asm/byteorder.h>"
482 #endif
483 } b;
484 } select_t, ata_select_t;
485
486 /*
487 * The ATA-IDE Status Register.
488 * The ATAPI Status Register.
489 *
490 * check : Error occurred
491 * idx : Index Error
492 * corr : Correctable error occurred
493 * drq : Data is request by the device
494 * dsc : Disk Seek Complete : ata
495 * : Media access command finished : atapi
496 * df : Device Fault : ata
497 * : Reserved : atapi
498 * drdy : Ready, Command Mode Capable : ata
499 * : Ignored for ATAPI commands : atapi
500 * bsy : Disk is Busy
501 * : The device has access to the command block
502 */
503 typedef union {
504 unsigned all :8;
505 struct {
506 #if defined(__LITTLE_ENDIAN_BITFIELD)
507 unsigned check :1;
508 unsigned idx :1;
509 unsigned corr :1;
510 unsigned drq :1;
511 unsigned dsc :1;
512 unsigned df :1;
513 unsigned drdy :1;
514 unsigned bsy :1;
515 #elif defined(__BIG_ENDIAN_BITFIELD)
516 unsigned bsy :1;
517 unsigned drdy :1;
518 unsigned df :1;
519 unsigned dsc :1;
520 unsigned drq :1;
521 unsigned corr :1;
522 unsigned idx :1;
523 unsigned check :1;
524 #else
525 #error "Please fix <asm/byteorder.h>"
526 #endif
527 } b;
528 } ata_status_t, atapi_status_t;
529
530 /*
531 * ATA-IDE Control Register
532 *
533 * bit0 : Should be set to zero
534 * nIEN : device INTRQ to host
535 * SRST : host soft reset bit
536 * bit3 : ATA-2 thingy, Should be set to 1
537 * reserved456 : Reserved
538 * HOB : 48-bit address ordering, High Ordered Bit
539 */
540 typedef union {
541 unsigned all : 8;
542 struct {
543 #if defined(__LITTLE_ENDIAN_BITFIELD)
544 unsigned bit0 : 1;
545 unsigned nIEN : 1;
546 unsigned SRST : 1;
547 unsigned bit3 : 1;
548 unsigned reserved456 : 3;
549 unsigned HOB : 1;
550 #elif defined(__BIG_ENDIAN_BITFIELD)
551 unsigned HOB : 1;
552 unsigned reserved456 : 3;
553 unsigned bit3 : 1;
554 unsigned SRST : 1;
555 unsigned nIEN : 1;
556 unsigned bit0 : 1;
557 #else
558 #error "Please fix <asm/byteorder.h>"
559 #endif
560 } b;
561 } ata_control_t;
562
563 /*
564 * ATAPI Feature Register
565 *
566 * dma : Using DMA or PIO
567 * reserved321 : Reserved
568 * reserved654 : Reserved (Tag Type)
569 * reserved7 : Reserved
570 */
571 typedef union {
572 unsigned all :8;
573 struct {
574 #if defined(__LITTLE_ENDIAN_BITFIELD)
575 unsigned dma :1;
576 unsigned reserved321 :3;
577 unsigned reserved654 :3;
578 unsigned reserved7 :1;
579 #elif defined(__BIG_ENDIAN_BITFIELD)
580 unsigned reserved7 :1;
581 unsigned reserved654 :3;
582 unsigned reserved321 :3;
583 unsigned dma :1;
584 #else
585 #error "Please fix <asm/byteorder.h>"
586 #endif
587 } b;
588 } atapi_feature_t;
589
590 /*
591 * ATAPI Interrupt Reason Register.
592 *
593 * cod : Information transferred is command (1) or data (0)
594 * io : The device requests us to read (1) or write (0)
595 * reserved : Reserved
596 */
597 typedef union {
598 unsigned all :8;
599 struct {
600 #if defined(__LITTLE_ENDIAN_BITFIELD)
601 unsigned cod :1;
602 unsigned io :1;
603 unsigned reserved :6;
604 #elif defined(__BIG_ENDIAN_BITFIELD)
605 unsigned reserved :6;
606 unsigned io :1;
607 unsigned cod :1;
608 #else
609 #error "Please fix <asm/byteorder.h>"
610 #endif
611 } b;
612 } atapi_ireason_t;
613
614 /*
615 * The ATAPI error register.
616 *
617 * ili : Illegal Length Indication
618 * eom : End Of Media Detected
619 * abrt : Aborted command - As defined by ATA
620 * mcr : Media Change Requested - As defined by ATA
621 * sense_key : Sense key of the last failed packet command
622 */
623 typedef union {
624 unsigned all :8;
625 struct {
626 #if defined(__LITTLE_ENDIAN_BITFIELD)
627 unsigned ili :1;
628 unsigned eom :1;
629 unsigned abrt :1;
630 unsigned mcr :1;
631 unsigned sense_key :4;
632 #elif defined(__BIG_ENDIAN_BITFIELD)
633 unsigned sense_key :4;
634 unsigned mcr :1;
635 unsigned abrt :1;
636 unsigned eom :1;
637 unsigned ili :1;
638 #else
639 #error "Please fix <asm/byteorder.h>"
640 #endif
641 } b;
642 } atapi_error_t;
643
644 /*
645 * ATAPI floppy Drive Select Register
646 *
647 * sam_lun : Logical unit number
648 * reserved3 : Reserved
649 * drv : The responding drive will be drive 0 (0) or drive 1 (1)
650 * one5 : Should be set to 1
651 * reserved6 : Reserved
652 * one7 : Should be set to 1
653 */
654 typedef union {
655 unsigned all :8;
656 struct {
657 #if defined(__LITTLE_ENDIAN_BITFIELD)
658 unsigned sam_lun :3;
659 unsigned reserved3 :1;
660 unsigned drv :1;
661 unsigned one5 :1;
662 unsigned reserved6 :1;
663 unsigned one7 :1;
664 #elif defined(__BIG_ENDIAN_BITFIELD)
665 unsigned one7 :1;
666 unsigned reserved6 :1;
667 unsigned one5 :1;
668 unsigned drv :1;
669 unsigned reserved3 :1;
670 unsigned sam_lun :3;
671 #else
672 #error "Please fix <asm/byteorder.h>"
673 #endif
674 } b;
675 } atapi_select_t;
676
677 /*
678 * Status returned from various ide_ functions
679 */
680 typedef enum {
681 ide_stopped, /* no drive operation was started */
682 ide_started, /* a drive operation was started, handler was set */
683 } ide_startstop_t;
684
685 struct ide_driver_s;
686 struct ide_settings_s;
687
688 typedef struct ide_drive_s {
689 char name[4]; /* drive name, such as "hda" */
690 char driver_req[10]; /* requests specific driver */
691
692 request_queue_t *queue; /* request queue */
693
694 struct request *rq; /* current request */
695 struct ide_drive_s *next; /* circular list of hwgroup drives */
696 struct ide_driver_s *driver;/* (ide_driver_t *) */
697 void *driver_data; /* extra driver data */
698 struct hd_driveid *id; /* drive model identification info */
699 struct proc_dir_entry *proc; /* /proc/ide/ directory entry */
700 struct ide_settings_s *settings;/* /proc/ide/ drive settings */
701 char devfs_name[64]; /* devfs crap */
702
703 struct hwif_s *hwif; /* actually (ide_hwif_t *) */
704
705 unsigned long sleep; /* sleep until this time */
706 unsigned long service_start; /* time we started last request */
707 unsigned long service_time; /* service time of last request */
708 unsigned long timeout; /* max time to wait for irq */
709
710 special_t special; /* special action flags */
711 select_t select; /* basic drive/head select reg value */
712
713 u8 keep_settings; /* restore settings after drive reset */
714 u8 autodma; /* device can safely use dma on host */
715 u8 using_dma; /* disk is using dma for read/write */
716 u8 retry_pio; /* retrying dma capable host in pio */
717 u8 state; /* retry state */
718 u8 waiting_for_dma; /* dma currently in progress */
719 u8 unmask; /* okay to unmask other irqs */
720 u8 bswap; /* byte swap data */
721 u8 dsc_overlap; /* DSC overlap */
722 u8 nice1; /* give potential excess bandwidth */
723
724 unsigned present : 1; /* drive is physically present */
725 unsigned dead : 1; /* device ejected hint */
726 unsigned id_read : 1; /* 1=id read from disk 0 = synthetic */
727 unsigned noprobe : 1; /* from: hdx=noprobe */
728 unsigned removable : 1; /* 1 if need to do check_media_change */
729 unsigned attach : 1; /* needed for removable devices */
730 unsigned is_flash : 1; /* 1 if probed as flash */
731 unsigned forced_geom : 1; /* 1 if hdx=c,h,s was given at boot */
732 unsigned no_unmask : 1; /* disallow setting unmask bit */
733 unsigned no_io_32bit : 1; /* disallow enabling 32bit I/O */
734 unsigned atapi_overlap : 1; /* ATAPI overlap (not supported) */
735 unsigned nice0 : 1; /* give obvious excess bandwidth */
736 unsigned nice2 : 1; /* give a share in our own bandwidth */
737 unsigned doorlocking : 1; /* for removable only: door lock/unlock works */
738 unsigned autotune : 2; /* 0=default, 1=autotune, 2=noautotune */
739 unsigned remap_0_to_1 : 1; /* 0=noremap, 1=remap 0->1 (for EZDrive) */
740 unsigned blocked : 1; /* 1=powermanagment told us not to do anything, so sleep nicely */
741 unsigned vdma : 1; /* 1=doing PIO over DMA 0=doing normal DMA */
742 unsigned stroke : 1; /* from: hdx=stroke */
743 unsigned addressing; /* : 3;
744 * 0=28-bit
745 * 1=48-bit
746 * 2=48-bit doing 28-bit
747 * 3=64-bit
748 */
749 unsigned scsi : 1; /* 0=default, 1=ide-scsi emulation */
750
751 u8 quirk_list; /* considered quirky, set for a specific host */
752 u8 suspend_reset; /* drive suspend mode flag, soft-reset recovers */
753 u8 init_speed; /* transfer rate set at boot */
754 u8 pio_speed; /* unused by core, used by some drivers for fallback from DMA */
755 u8 current_speed; /* current transfer rate set */
756 u8 dn; /* now wide spread use */
757 u8 wcache; /* status of write cache */
758 u8 acoustic; /* acoustic management */
759 u8 media; /* disk, cdrom, tape, floppy, ... */
760 u8 ctl; /* "normal" value for IDE_CONTROL_REG */
761 u8 ready_stat; /* min status value for drive ready */
762 u8 mult_count; /* current multiple sector setting */
763 u8 mult_req; /* requested multiple sector setting */
764 u8 tune_req; /* requested drive tuning setting */
765 u8 io_32bit; /* 0=16-bit, 1=32-bit, 2/3=32bit+sync */
766 u8 bad_wstat; /* used for ignoring WRERR_STAT */
767 u8 nowerr; /* used for ignoring WRERR_STAT */
768 u8 sect0; /* offset of first sector for DM6:DDO */
769 u8 head; /* "real" number of heads */
770 u8 sect; /* "real" sectors per track */
771 u8 bios_head; /* BIOS/fdisk/LILO number of heads */
772 u8 bios_sect; /* BIOS/fdisk/LILO sectors per track */
773 u8 doing_barrier; /* state, 1=currently doing flush */
774
775 unsigned int bios_cyl; /* BIOS/fdisk/LILO number of cyls */
776 unsigned int cyl; /* "real" number of cyls */
777 unsigned int drive_data; /* use by tuneproc/selectproc */
778 unsigned int usage; /* current "open()" count for drive */
779 unsigned int failures; /* current failure count */
780 unsigned int max_failures; /* maximum allowed failure count */
781
782 u64 capacity64; /* total number of sectors */
783
784 int lun; /* logical unit */
785 int crc_count; /* crc counter to reduce drive speed */
786 struct list_head list;
787 struct device gendev;
788 struct semaphore gendev_rel_sem; /* to deal with device release() */
789 struct gendisk *disk;
790 } ide_drive_t;
791
792 /*
793 * mapping stuff, prepare for highmem...
794 *
795 * temporarily mapping a (possible) highmem bio for PIO transfer
796 */
797 #ifndef CONFIG_IDE_TASKFILE_IO
798
799 #define ide_rq_offset(rq) \
800 (((rq)->hard_cur_sectors - (rq)->current_nr_sectors) << 9)
801
802 static inline void *ide_map_buffer(struct request *rq, unsigned long *flags)
803 {
804 return bio_kmap_irq(rq->bio, flags) + ide_rq_offset(rq);
805 }
806
807 static inline void ide_unmap_buffer(struct request *rq, char *buffer, unsigned long *flags)
808 {
809 bio_kunmap_irq(buffer, flags);
810 }
811 #endif /* !CONFIG_IDE_TASKFILE_IO */
812
813 #define IDE_CHIPSET_PCI_MASK \
814 ((1<<ide_pci)|(1<<ide_cmd646)|(1<<ide_ali14xx))
815 #define IDE_CHIPSET_IS_PCI(c) ((IDE_CHIPSET_PCI_MASK >> (c)) & 1)
816
817 struct ide_pci_device_s;
818
819 typedef struct hwif_s {
820 struct hwif_s *next; /* for linked-list in ide_hwgroup_t */
821 struct hwif_s *mate; /* other hwif from same PCI chip */
822 struct hwgroup_s *hwgroup; /* actually (ide_hwgroup_t *) */
823 struct proc_dir_entry *proc; /* /proc/ide/ directory entry */
824
825 char name[6]; /* name of interface, eg. "ide0" */
826
827 /* task file registers for pata and sata */
828 unsigned long io_ports[IDE_NR_PORTS];
829 unsigned long sata_scr[SATA_NR_PORTS];
830 unsigned long sata_misc[SATA_NR_PORTS];
831
832 hw_regs_t hw; /* Hardware info */
833 ide_drive_t drives[MAX_DRIVES]; /* drive info */
834
835 u8 major; /* our major number */
836 u8 index; /* 0 for ide0; 1 for ide1; ... */
837 u8 channel; /* for dual-port chips: 0=primary, 1=secondary */
838 u8 straight8; /* Alan's straight 8 check */
839 u8 bus_state; /* power state of the IDE bus */
840
841 u8 atapi_dma; /* host supports atapi_dma */
842 u8 ultra_mask;
843 u8 mwdma_mask;
844 u8 swdma_mask;
845
846 hwif_chipset_t chipset; /* sub-module for tuning.. */
847
848 struct pci_dev *pci_dev; /* for pci chipsets */
849 struct ide_pci_device_s *cds; /* chipset device struct */
850
851 ide_startstop_t (*rw_disk)(ide_drive_t *, struct request *, sector_t);
852
853 #if 0
854 ide_hwif_ops_t *hwifops;
855 #else
856 /* routine is for HBA specific IDENTITY operations */
857 int (*identify)(ide_drive_t *);
858 /* routine to tune PIO mode for drives */
859 void (*tuneproc)(ide_drive_t *, u8);
860 /* routine to retune DMA modes for drives */
861 int (*speedproc)(ide_drive_t *, u8);
862 /* tweaks hardware to select drive */
863 void (*selectproc)(ide_drive_t *);
864 /* chipset polling based on hba specifics */
865 int (*reset_poll)(ide_drive_t *);
866 /* chipset specific changes to default for device-hba resets */
867 void (*pre_reset)(ide_drive_t *);
868 /* routine to reset controller after a disk reset */
869 void (*resetproc)(ide_drive_t *);
870 /* special interrupt handling for shared pci interrupts */
871 void (*intrproc)(ide_drive_t *);
872 /* special host masking for drive selection */
873 void (*maskproc)(ide_drive_t *, int);
874 /* check host's drive quirk list */
875 int (*quirkproc)(ide_drive_t *);
876 /* driver soft-power interface */
877 int (*busproc)(ide_drive_t *, int);
878 // /* host rate limiter */
879 // u8 (*ratemask)(ide_drive_t *);
880 // /* device rate limiter */
881 // u8 (*ratefilter)(ide_drive_t *, u8);
882 #endif
883
884 void (*ata_input_data)(ide_drive_t *, void *, u32);
885 void (*ata_output_data)(ide_drive_t *, void *, u32);
886
887 void (*atapi_input_bytes)(ide_drive_t *, void *, u32);
888 void (*atapi_output_bytes)(ide_drive_t *, void *, u32);
889
890 int (*ide_dma_read)(ide_drive_t *drive);
891 int (*ide_dma_write)(ide_drive_t *drive);
892 int (*ide_dma_begin)(ide_drive_t *drive);
893 int (*ide_dma_end)(ide_drive_t *drive);
894 int (*ide_dma_check)(ide_drive_t *drive);
895 int (*ide_dma_on)(ide_drive_t *drive);
896 int (*ide_dma_off_quietly)(ide_drive_t *drive);
897 int (*ide_dma_test_irq)(ide_drive_t *drive);
898 int (*ide_dma_host_on)(ide_drive_t *drive);
899 int (*ide_dma_host_off)(ide_drive_t *drive);
900 int (*ide_dma_verbose)(ide_drive_t *drive);
901 int (*ide_dma_lostirq)(ide_drive_t *drive);
902 int (*ide_dma_timeout)(ide_drive_t *drive);
903
904 void (*OUTB)(u8 addr, unsigned long port);
905 void (*OUTBSYNC)(ide_drive_t *drive, u8 addr, unsigned long port);
906 void (*OUTW)(u16 addr, unsigned long port);
907 void (*OUTL)(u32 addr, unsigned long port);
908 void (*OUTSW)(unsigned long port, void *addr, u32 count);
909 void (*OUTSL)(unsigned long port, void *addr, u32 count);
910
911 u8 (*INB)(unsigned long port);
912 u16 (*INW)(unsigned long port);
913 u32 (*INL)(unsigned long port);
914 void (*INSW)(unsigned long port, void *addr, u32 count);
915 void (*INSL)(unsigned long port, void *addr, u32 count);
916
917 /* dma physical region descriptor table (cpu view) */
918 unsigned int *dmatable_cpu;
919 /* dma physical region descriptor table (dma view) */
920 dma_addr_t dmatable_dma;
921 /* Scatter-gather list used to build the above */
922 struct scatterlist *sg_table;
923 int sg_nents; /* Current number of entries in it */
924 int sg_dma_direction; /* dma transfer direction */
925
926 /* data phase of the active command (currently only valid for PIO/DMA) */
927 int data_phase;
928
929 int mmio; /* hosts iomio (0) or custom (2) select */
930 int rqsize; /* max sectors per request */
931 int irq; /* our irq number */
932
933 unsigned long dma_master; /* reference base addr dmabase */
934 unsigned long dma_base; /* base addr for dma ports */
935 unsigned long dma_command; /* dma command register */
936 unsigned long dma_vendor1; /* dma vendor 1 register */
937 unsigned long dma_status; /* dma status register */
938 unsigned long dma_vendor3; /* dma vendor 3 register */
939 unsigned long dma_prdtable; /* actual prd table address */
940 unsigned long dma_base2; /* extended base addr for dma ports */
941
942 unsigned dma_extra; /* extra addr for dma ports */
943 unsigned long config_data; /* for use by chipset-specific code */
944 unsigned long select_data; /* for use by chipset-specific code */
945
946 unsigned noprobe : 1; /* don't probe for this interface */
947 unsigned present : 1; /* this interface exists */
948 unsigned hold : 1; /* this interface is always present */
949 unsigned serialized : 1; /* serialized all channel operation */
950 unsigned sharing_irq: 1; /* 1 = sharing irq with another hwif */
951 unsigned reset : 1; /* reset after probe */
952 unsigned autodma : 1; /* auto-attempt using DMA at boot */
953 unsigned udma_four : 1; /* 1=ATA-66 capable, 0=default */
954 unsigned no_lba48 : 1; /* 1 = cannot do LBA48 */
955 unsigned no_lba48_dma : 1; /* 1 = cannot do LBA48 DMA */
956 unsigned no_dsc : 1; /* 0 default, 1 dsc_overlap disabled */
957 unsigned auto_poll : 1; /* supports nop auto-poll */
958
959 struct device gendev;
960 struct semaphore gendev_rel_sem; /* To deal with device release() */
961
962 void *hwif_data; /* extra hwif data */
963
964 unsigned dma;
965
966 void (*led_act)(void *data, int rw);
967 } ide_hwif_t;
968
969 /*
970 * internal ide interrupt handler type
971 */
972 typedef ide_startstop_t (ide_pre_handler_t)(ide_drive_t *, struct request *);
973 typedef ide_startstop_t (ide_handler_t)(ide_drive_t *);
974 typedef int (ide_expiry_t)(ide_drive_t *);
975
976 typedef struct hwgroup_s {
977 /* irq handler, if active */
978 ide_startstop_t (*handler)(ide_drive_t *);
979 /* irq handler, suspended if active */
980 ide_startstop_t (*handler_save)(ide_drive_t *);
981 /* BOOL: protects all fields below */
982 volatile int busy;
983 /* BOOL: wake us up on timer expiry */
984 int sleeping;
985 /* current drive */
986 ide_drive_t *drive;
987 /* ptr to current hwif in linked-list */
988 ide_hwif_t *hwif;
989
990 /* for pci chipsets */
991 struct pci_dev *pci_dev;
992 /* chipset device struct */
993 struct ide_pci_device_s *cds;
994
995 /* current request */
996 struct request *rq;
997 /* failsafe timer */
998 struct timer_list timer;
999 /* local copy of current write rq */
1000 struct request wrq;
1001 /* timeout value during long polls */
1002 unsigned long poll_timeout;
1003 /* queried upon timeouts */
1004 int (*expiry)(ide_drive_t *);
1005 /* ide_system_bus_speed */
1006 int pio_clock;
1007
1008 unsigned char cmd_buf[4];
1009 } ide_hwgroup_t;
1010
1011 /* structure attached to the request for IDE_TASK_CMDS */
1012
1013 /*
1014 * configurable drive settings
1015 */
1016
1017 #define TYPE_INT 0
1018 #define TYPE_INTA 1
1019 #define TYPE_BYTE 2
1020 #define TYPE_SHORT 3
1021
1022 #define SETTING_READ (1 << 0)
1023 #define SETTING_WRITE (1 << 1)
1024 #define SETTING_RW (SETTING_READ | SETTING_WRITE)
1025
1026 typedef int (ide_procset_t)(ide_drive_t *, int);
1027 typedef struct ide_settings_s {
1028 char *name;
1029 int rw;
1030 int read_ioctl;
1031 int write_ioctl;
1032 int data_type;
1033 int min;
1034 int max;
1035 int mul_factor;
1036 int div_factor;
1037 void *data;
1038 ide_procset_t *set;
1039 int auto_remove;
1040 struct ide_settings_s *next;
1041 } ide_settings_t;
1042
1043 extern struct semaphore ide_setting_sem;
1044 extern int ide_add_setting(ide_drive_t *drive, const char *name, int rw, int read_ioctl, int write_ioctl, int data_type, int min, int max, int mul_factor, int div_factor, void *data, ide_procset_t *set);
1045 extern ide_settings_t *ide_find_setting_by_name(ide_drive_t *drive, char *name);
1046 extern int ide_read_setting(ide_drive_t *t, ide_settings_t *setting);
1047 extern int ide_write_setting(ide_drive_t *drive, ide_settings_t *setting, int val);
1048 extern void ide_add_generic_settings(ide_drive_t *drive);
1049
1050 /*
1051 * /proc/ide interface
1052 */
1053 typedef struct {
1054 const char *name;
1055 mode_t mode;
1056 read_proc_t *read_proc;
1057 write_proc_t *write_proc;
1058 } ide_proc_entry_t;
1059
1060 #ifdef CONFIG_PROC_FS
1061 extern struct proc_dir_entry *proc_ide_root;
1062
1063 extern void proc_ide_create(void);
1064 extern void proc_ide_destroy(void);
1065 extern void destroy_proc_ide_drives(ide_hwif_t *);
1066 extern void create_proc_ide_interfaces(void);
1067 extern void ide_add_proc_entries(struct proc_dir_entry *, ide_proc_entry_t *, void *);
1068 extern void ide_remove_proc_entries(struct proc_dir_entry *, ide_proc_entry_t *);
1069 read_proc_t proc_ide_read_capacity;
1070 read_proc_t proc_ide_read_geometry;
1071
1072 #ifdef CONFIG_BLK_DEV_IDEPCI
1073 void ide_pci_create_host_proc(const char *, get_info_t *);
1074 #endif
1075
1076 /*
1077 * Standard exit stuff:
1078 */
1079 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) \
1080 { \
1081 len -= off; \
1082 if (len < count) { \
1083 *eof = 1; \
1084 if (len <= 0) \
1085 return 0; \
1086 } else \
1087 len = count; \
1088 *start = page + off; \
1089 return len; \
1090 }
1091 #else
1092 static inline void create_proc_ide_interfaces(void) { ; }
1093 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) return 0;
1094 #endif
1095
1096 /*
1097 * Power Management step value (rq->pm->pm_step).
1098 *
1099 * The step value starts at 0 (ide_pm_state_start_suspend) for a
1100 * suspend operation or 1000 (ide_pm_state_start_resume) for a
1101 * resume operation.
1102 *
1103 * For each step, the core calls the subdriver start_power_step() first.
1104 * This can return:
1105 * - ide_stopped : In this case, the core calls us back again unless
1106 * step have been set to ide_power_state_completed.
1107 * - ide_started : In this case, the channel is left busy until an
1108 * async event (interrupt) occurs.
1109 * Typically, start_power_step() will issue a taskfile request with
1110 * do_rw_taskfile().
1111 *
1112 * Upon reception of the interrupt, the core will call complete_power_step()
1113 * with the error code if any. This routine should update the step value
1114 * and return. It should not start a new request. The core will call
1115 * start_power_step for the new step value, unless step have been set to
1116 * ide_power_state_completed.
1117 *
1118 * Subdrivers are expected to define their own additional power
1119 * steps from 1..999 for suspend and from 1001..1999 for resume,
1120 * other values are reserved for future use.
1121 */
1122
1123 enum {
1124 ide_pm_state_completed = -1,
1125 ide_pm_state_start_suspend = 0,
1126 ide_pm_state_start_resume = 1000,
1127 };
1128
1129 /*
1130 * Subdrivers support.
1131 */
1132 typedef struct ide_driver_s {
1133 struct module *owner;
1134 const char *name;
1135 const char *version;
1136 u8 media;
1137 unsigned busy : 1;
1138 unsigned supports_dsc_overlap : 1;
1139 int (*cleanup)(ide_drive_t *);
1140 ide_startstop_t (*do_request)(ide_drive_t *, struct request *, sector_t);
1141 int (*end_request)(ide_drive_t *, int, int);
1142 u8 (*sense)(ide_drive_t *, const char *, u8);
1143 ide_startstop_t (*error)(ide_drive_t *, const char *, u8);
1144 ide_startstop_t (*abort)(ide_drive_t *, const char *);
1145 int (*ioctl)(ide_drive_t *, struct inode *, struct file *, unsigned int, unsigned long);
1146 void (*pre_reset)(ide_drive_t *);
1147 sector_t (*capacity)(ide_drive_t *);
1148 ide_startstop_t (*special)(ide_drive_t *);
1149 ide_proc_entry_t *proc;
1150 int (*attach)(ide_drive_t *);
1151 void (*ata_prebuilder)(ide_drive_t *);
1152 void (*atapi_prebuilder)(ide_drive_t *);
1153 ide_startstop_t (*start_power_step)(ide_drive_t *, struct request *);
1154 void (*complete_power_step)(ide_drive_t *, struct request *, u8, u8);
1155 struct device_driver gen_driver;
1156 struct list_head drives;
1157 struct list_head drivers;
1158 } ide_driver_t;
1159
1160 #define DRIVER(drive) ((drive)->driver)
1161
1162 extern int generic_ide_ioctl(struct file *, struct block_device *, unsigned, unsigned long);
1163
1164 /*
1165 * ide_hwifs[] is the master data structure used to keep track
1166 * of just about everything in ide.c. Whenever possible, routines
1167 * should be using pointers to a drive (ide_drive_t *) or
1168 * pointers to a hwif (ide_hwif_t *), rather than indexing this
1169 * structure directly (the allocation/layout may change!).
1170 *
1171 */
1172 #ifndef _IDE_C
1173 extern ide_hwif_t ide_hwifs[]; /* master data repository */
1174 #endif
1175 extern int noautodma;
1176
1177 extern int ide_end_request (ide_drive_t *drive, int uptodate, int nrsecs);
1178
1179 /*
1180 * This is used on exit from the driver to designate the next irq handler
1181 * and also to start the safety timer.
1182 */
1183 extern void ide_set_handler (ide_drive_t *drive, ide_handler_t *handler, unsigned int timeout, ide_expiry_t *expiry);
1184
1185 /*
1186 * This is used on exit from the driver to designate the next irq handler
1187 * and start the safety time safely and atomically from the IRQ handler
1188 * with respect to the command issue (which it also does)
1189 */
1190 extern void ide_execute_command(ide_drive_t *, task_ioreg_t cmd, ide_handler_t *, unsigned int, ide_expiry_t *);
1191
1192 /*
1193 * Error reporting, in human readable form (luxurious, but a memory hog).
1194 *
1195 * (drive, msg, status)
1196 */
1197 byte ide_dump_status (ide_drive_t *drive, const char *msg, byte stat);
1198
1199 /*
1200 * ide_error() takes action based on the error returned by the controller.
1201 * The caller should return immediately after invoking this.
1202 *
1203 * (drive, msg, status)
1204 */
1205 ide_startstop_t ide_error (ide_drive_t *drive, const char *msg, byte stat);
1206
1207 /*
1208 * Abort a running command on the controller triggering the abort
1209 * from a host side, non error situation
1210 * (drive, msg)
1211 */
1212 extern ide_startstop_t ide_abort(ide_drive_t *, const char *);
1213
1214 /*
1215 * Issue a simple drive command
1216 * The drive must be selected beforehand.
1217 *
1218 * (drive, command, nsector, handler)
1219 */
1220 extern void ide_cmd(ide_drive_t *, u8, u8, ide_handler_t *);
1221
1222 extern void ide_fix_driveid(struct hd_driveid *);
1223 /*
1224 * ide_fixstring() cleans up and (optionally) byte-swaps a text string,
1225 * removing leading/trailing blanks and compressing internal blanks.
1226 * It is primarily used to tidy up the model name/number fields as
1227 * returned by the WIN_[P]IDENTIFY commands.
1228 *
1229 * (s, bytecount, byteswap)
1230 */
1231 extern void ide_fixstring(u8 *, const int, const int);
1232
1233 /*
1234 * This routine busy-waits for the drive status to be not "busy".
1235 * It then checks the status for all of the "good" bits and none
1236 * of the "bad" bits, and if all is okay it returns 0. All other
1237 * cases return 1 after doing "*startstop = ide_error()", and the
1238 * caller should return the updated value of "startstop" in this case.
1239 * "startstop" is unchanged when the function returns 0;
1240 * (startstop, drive, good, bad, timeout)
1241 */
1242 extern int ide_wait_stat(ide_startstop_t *, ide_drive_t *, u8, u8, unsigned long);
1243
1244 /*
1245 * Return the current idea about the total capacity of this drive.
1246 */
1247 extern sector_t current_capacity (ide_drive_t *drive);
1248
1249 /*
1250 * Start a reset operation for an IDE interface.
1251 * The caller should return immediately after invoking this.
1252 */
1253 extern ide_startstop_t ide_do_reset (ide_drive_t *);
1254
1255 /*
1256 * This function is intended to be used prior to invoking ide_do_drive_cmd().
1257 */
1258 extern void ide_init_drive_cmd (struct request *rq);
1259
1260 /*
1261 * this function returns error location sector offset in case of a write error
1262 */
1263 extern u64 ide_get_error_location(ide_drive_t *, char *);
1264
1265 /*
1266 * "action" parameter type for ide_do_drive_cmd() below.
1267 */
1268 typedef enum {
1269 ide_wait, /* insert rq at end of list, and wait for it */
1270 ide_next, /* insert rq immediately after current request */
1271 ide_preempt, /* insert rq in front of current request */
1272 ide_head_wait, /* insert rq in front of current request and wait for it */
1273 ide_end /* insert rq at end of list, but don't wait for it */
1274 } ide_action_t;
1275
1276 /*
1277 * This function issues a special IDE device request
1278 * onto the request queue.
1279 *
1280 * If action is ide_wait, then the rq is queued at the end of the
1281 * request queue, and the function sleeps until it has been processed.
1282 * This is for use when invoked from an ioctl handler.
1283 *
1284 * If action is ide_preempt, then the rq is queued at the head of
1285 * the request queue, displacing the currently-being-processed
1286 * request and this function returns immediately without waiting
1287 * for the new rq to be completed. This is VERY DANGEROUS, and is
1288 * intended for careful use by the ATAPI tape/cdrom driver code.
1289 *
1290 * If action is ide_next, then the rq is queued immediately after
1291 * the currently-being-processed-request (if any), and the function
1292 * returns without waiting for the new rq to be completed. As above,
1293 * This is VERY DANGEROUS, and is intended for careful use by the
1294 * ATAPI tape/cdrom driver code.
1295 *
1296 * If action is ide_end, then the rq is queued at the end of the
1297 * request queue, and the function returns immediately without waiting
1298 * for the new rq to be completed. This is again intended for careful
1299 * use by the ATAPI tape/cdrom driver code.
1300 */
1301 extern int ide_do_drive_cmd(ide_drive_t *, struct request *, ide_action_t);
1302
1303 /*
1304 * Clean up after success/failure of an explicit drive cmd.
1305 * stat/err are used only when (HWGROUP(drive)->rq->cmd == IDE_DRIVE_CMD).
1306 * stat/err are used only when (HWGROUP(drive)->rq->cmd == IDE_DRIVE_TASK_MASK).
1307 *
1308 * (ide_drive_t *drive, u8 stat, u8 err)
1309 */
1310 extern void ide_end_drive_cmd(ide_drive_t *, u8, u8);
1311
1312 extern void try_to_flush_leftover_data(ide_drive_t *);
1313
1314 /*
1315 * Issue ATA command and wait for completion.
1316 * Use for implementing commands in kernel
1317 *
1318 * (ide_drive_t *drive, u8 cmd, u8 nsect, u8 feature, u8 sectors, u8 *buf)
1319 */
1320 extern int ide_wait_cmd(ide_drive_t *, u8, u8, u8, u8, u8 *);
1321
1322 /* (ide_drive_t *drive, u8 *buf) */
1323 extern int ide_wait_cmd_task(ide_drive_t *, u8 *);
1324
1325 typedef struct ide_task_s {
1326 /*
1327 * struct hd_drive_task_hdr tf;
1328 * task_struct_t tf;
1329 * struct hd_drive_hob_hdr hobf;
1330 * hob_struct_t hobf;
1331 */
1332 task_ioreg_t tfRegister[8];
1333 task_ioreg_t hobRegister[8];
1334 ide_reg_valid_t tf_out_flags;
1335 ide_reg_valid_t tf_in_flags;
1336 int data_phase;
1337 int command_type;
1338 ide_pre_handler_t *prehandler;
1339 ide_handler_t *handler;
1340 struct request *rq; /* copy of request */
1341 void *special; /* valid_t generally */
1342 } ide_task_t;
1343
1344 typedef struct pkt_task_s {
1345 /*
1346 * struct hd_drive_task_hdr pktf;
1347 * task_struct_t pktf;
1348 * u8 pkcdb[12];
1349 */
1350 task_ioreg_t tfRegister[8];
1351 int data_phase;
1352 int command_type;
1353 ide_handler_t *handler;
1354 struct request *rq; /* copy of request */
1355 void *special;
1356 } pkt_task_t;
1357
1358 extern u32 ide_read_24(ide_drive_t *);
1359
1360 extern void SELECT_DRIVE(ide_drive_t *);
1361 extern void SELECT_INTERRUPT(ide_drive_t *);
1362 extern void SELECT_MASK(ide_drive_t *, int);
1363 extern void QUIRK_LIST(ide_drive_t *);
1364
1365 extern void ata_input_data(ide_drive_t *, void *, u32);
1366 extern void ata_output_data(ide_drive_t *, void *, u32);
1367 extern void atapi_input_bytes(ide_drive_t *, void *, u32);
1368 extern void atapi_output_bytes(ide_drive_t *, void *, u32);
1369 extern void taskfile_input_data(ide_drive_t *, void *, u32);
1370 extern void taskfile_output_data(ide_drive_t *, void *, u32);
1371
1372 #define IDE_PIO_IN 0
1373 #define IDE_PIO_OUT 1
1374
1375 static inline void __task_sectors(ide_drive_t *drive, char *buf,
1376 unsigned nsect, unsigned rw)
1377 {
1378 /*
1379 * IRQ can happen instantly after reading/writing
1380 * last sector of the datablock.
1381 */
1382 if (rw == IDE_PIO_OUT)
1383 taskfile_output_data(drive, buf, nsect * SECTOR_WORDS);
1384 else
1385 taskfile_input_data(drive, buf, nsect * SECTOR_WORDS);
1386 }
1387
1388 #ifdef CONFIG_IDE_TASKFILE_IO
1389 static inline void task_bio_sectors(ide_drive_t *drive, struct request *rq,
1390 unsigned nsect, unsigned rw)
1391 {
1392 unsigned long flags;
1393 char *buf = rq_map_buffer(rq, &flags);
1394
1395 process_that_request_first(rq, nsect);
1396 __task_sectors(drive, buf, nsect, rw);
1397 rq_unmap_buffer(buf, &flags);
1398 }
1399 #endif /* CONFIG_IDE_TASKFILE_IO */
1400
1401 extern int drive_is_ready(ide_drive_t *);
1402 extern int wait_for_ready(ide_drive_t *, int /* timeout */);
1403
1404 /*
1405 * taskfile io for disks for now...and builds request from ide_ioctl
1406 */
1407 extern ide_startstop_t do_rw_taskfile(ide_drive_t *, ide_task_t *);
1408
1409 /*
1410 * Special Flagged Register Validation Caller
1411 */
1412 extern ide_startstop_t flagged_taskfile(ide_drive_t *, ide_task_t *);
1413
1414 extern ide_startstop_t set_multmode_intr(ide_drive_t *);
1415 extern ide_startstop_t set_geometry_intr(ide_drive_t *);
1416 extern ide_startstop_t recal_intr(ide_drive_t *);
1417 extern ide_startstop_t task_no_data_intr(ide_drive_t *);
1418 extern ide_startstop_t task_in_intr(ide_drive_t *);
1419 extern ide_startstop_t pre_task_out_intr(ide_drive_t *, struct request *);
1420 extern ide_startstop_t task_out_intr(ide_drive_t *);
1421
1422 extern int ide_raw_taskfile(ide_drive_t *, ide_task_t *, u8 *);
1423
1424 int ide_taskfile_ioctl(ide_drive_t *, unsigned int, unsigned long);
1425 int ide_cmd_ioctl(ide_drive_t *, unsigned int, unsigned long);
1426 int ide_task_ioctl(ide_drive_t *, unsigned int, unsigned long);
1427
1428 extern int system_bus_clock(void);
1429
1430 extern u8 ide_auto_reduce_xfer(ide_drive_t *);
1431 extern int ide_driveid_update(ide_drive_t *);
1432 extern int ide_ata66_check(ide_drive_t *, ide_task_t *);
1433 extern int ide_config_drive_speed(ide_drive_t *, u8);
1434 extern u8 eighty_ninty_three (ide_drive_t *);
1435 extern int set_transfer(ide_drive_t *, ide_task_t *);
1436 extern int taskfile_lib_get_identify(ide_drive_t *drive, u8 *);
1437
1438 extern int ide_wait_not_busy(ide_hwif_t *hwif, unsigned long timeout);
1439 ide_startstop_t __ide_do_rw_disk(ide_drive_t *drive, struct request *rq, sector_t block);
1440
1441 /*
1442 * ide_system_bus_speed() returns what we think is the system VESA/PCI
1443 * bus speed (in MHz). This is used for calculating interface PIO timings.
1444 * The default is 40 for known PCI systems, 50 otherwise.
1445 * The "idebus=xx" parameter can be used to override this value.
1446 */
1447 extern int ide_system_bus_speed(void);
1448
1449 /*
1450 * ide_stall_queue() can be used by a drive to give excess bandwidth back
1451 * to the hwgroup by sleeping for timeout jiffies.
1452 */
1453 extern void ide_stall_queue(ide_drive_t *drive, unsigned long timeout);
1454
1455 extern int ide_spin_wait_hwgroup(ide_drive_t *);
1456 extern void ide_timer_expiry(unsigned long);
1457 extern irqreturn_t ide_intr(int irq, void *dev_id, struct pt_regs *regs);
1458 extern void do_ide_request(request_queue_t *);
1459 extern void ide_init_subdrivers(void);
1460
1461 extern struct block_device_operations ide_fops[];
1462 extern ide_proc_entry_t generic_subdriver_entries[];
1463
1464 extern int ata_attach(ide_drive_t *);
1465
1466 extern int ideprobe_init(void);
1467
1468 extern void ide_scan_pcibus(int scan_direction) __init;
1469 extern int ide_pci_register_driver(struct pci_driver *driver);
1470 extern void ide_pci_unregister_driver(struct pci_driver *driver);
1471 extern void ide_pci_setup_ports(struct pci_dev *dev, struct ide_pci_device_s *d, int autodma, int pciirq, ata_index_t *index);
1472 extern void ide_setup_pci_noise (struct pci_dev *dev, struct ide_pci_device_s *d);
1473
1474 extern void default_hwif_iops(ide_hwif_t *);
1475 extern void default_hwif_mmiops(ide_hwif_t *);
1476 extern void default_hwif_transport(ide_hwif_t *);
1477
1478 int ide_register_driver(ide_driver_t *driver);
1479 void ide_unregister_driver(ide_driver_t *driver);
1480 int ide_register_subdriver(ide_drive_t *, ide_driver_t *);
1481 int ide_unregister_subdriver (ide_drive_t *drive);
1482 int ide_replace_subdriver(ide_drive_t *drive, const char *driver);
1483
1484 #define ON_BOARD 1
1485 #define NEVER_BOARD 0
1486
1487 #ifdef CONFIG_BLK_DEV_OFFBOARD
1488 # define OFF_BOARD ON_BOARD
1489 #else /* CONFIG_BLK_DEV_OFFBOARD */
1490 # define OFF_BOARD NEVER_BOARD
1491 #endif /* CONFIG_BLK_DEV_OFFBOARD */
1492
1493 #define NODMA 0
1494 #define NOAUTODMA 1
1495 #define AUTODMA 2
1496
1497 typedef struct ide_pci_enablebit_s {
1498 u8 reg; /* byte pci reg holding the enable-bit */
1499 u8 mask; /* mask to isolate the enable-bit */
1500 u8 val; /* value of masked reg when "enabled" */
1501 } ide_pci_enablebit_t;
1502
1503 enum {
1504 /* Uses ISA control ports not PCI ones. */
1505 IDEPCI_FLAG_ISA_PORTS = (1 << 0),
1506
1507 IDEPCI_FLAG_FORCE_MASTER = (1 << 1),
1508 IDEPCI_FLAG_FORCE_PDC = (1 << 2),
1509 };
1510
1511 typedef struct ide_pci_device_s {
1512 char *name;
1513 void (*init_setup)(struct pci_dev *, struct ide_pci_device_s *);
1514 void (*init_setup_dma)(struct pci_dev *, struct ide_pci_device_s *, ide_hwif_t *);
1515 unsigned int (*init_chipset)(struct pci_dev *, const char *);
1516 void (*init_iops)(ide_hwif_t *);
1517 void (*init_hwif)(ide_hwif_t *);
1518 void (*init_dma)(ide_hwif_t *, unsigned long);
1519 u8 channels;
1520 u8 autodma;
1521 ide_pci_enablebit_t enablebits[2];
1522 u8 bootable;
1523 unsigned int extra;
1524 struct ide_pci_device_s *next;
1525 u8 flags;
1526 } ide_pci_device_t;
1527
1528 extern void ide_setup_pci_device(struct pci_dev *, ide_pci_device_t *);
1529 extern void ide_setup_pci_devices(struct pci_dev *, struct pci_dev *, ide_pci_device_t *);
1530
1531 #define BAD_DMA_DRIVE 0
1532 #define GOOD_DMA_DRIVE 1
1533
1534 #ifdef CONFIG_BLK_DEV_IDEDMA
1535 int __ide_dma_bad_drive(ide_drive_t *);
1536 int __ide_dma_good_drive(ide_drive_t *);
1537 int __ide_dma_off(ide_drive_t *);
1538
1539 #ifdef CONFIG_BLK_DEV_IDEDMA_PCI
1540 extern int ide_build_sglist(ide_drive_t *, struct request *);
1541 extern int ide_raw_build_sglist(ide_drive_t *, struct request *);
1542 extern int ide_build_dmatable(ide_drive_t *, struct request *);
1543 extern void ide_destroy_dmatable(ide_drive_t *);
1544 extern ide_startstop_t ide_dma_intr(ide_drive_t *);
1545 extern int ide_release_dma(ide_hwif_t *);
1546 extern void ide_setup_dma(ide_hwif_t *, unsigned long, unsigned int);
1547 extern int ide_start_dma(ide_hwif_t *, ide_drive_t *, int);
1548
1549 extern int __ide_dma_host_off(ide_drive_t *);
1550 extern int __ide_dma_off_quietly(ide_drive_t *);
1551 extern int __ide_dma_host_on(ide_drive_t *);
1552 extern int __ide_dma_on(ide_drive_t *);
1553 extern int __ide_dma_check(ide_drive_t *);
1554 extern int __ide_dma_read(ide_drive_t *);
1555 extern int __ide_dma_write(ide_drive_t *);
1556 extern int __ide_dma_begin(ide_drive_t *);
1557 extern int __ide_dma_end(ide_drive_t *);
1558 extern int __ide_dma_test_irq(ide_drive_t *);
1559 extern int __ide_dma_verbose(ide_drive_t *);
1560 extern int __ide_dma_lostirq(ide_drive_t *);
1561 extern int __ide_dma_timeout(ide_drive_t *);
1562 #endif /* CONFIG_BLK_DEV_IDEDMA_PCI */
1563
1564 #else
1565 static inline int __ide_dma_off(ide_drive_t *drive) { return 0; }
1566 #endif /* CONFIG_BLK_DEV_IDEDMA */
1567
1568 #ifndef CONFIG_BLK_DEV_IDEDMA_PCI
1569 static inline void ide_release_dma(ide_hwif_t *drive) {;}
1570 #endif
1571
1572 extern int ide_hwif_request_regions(ide_hwif_t *hwif);
1573 extern void ide_hwif_release_regions(ide_hwif_t* hwif);
1574 extern void ide_unregister (unsigned int index);
1575
1576 extern int probe_hwif_init(ide_hwif_t *);
1577
1578 static inline void *ide_get_hwifdata (ide_hwif_t * hwif)
1579 {
1580 return hwif->hwif_data;
1581 }
1582
1583 static inline void ide_set_hwifdata (ide_hwif_t * hwif, void *data)
1584 {
1585 hwif->hwif_data = data;
1586 }
1587
1588 /* ide-lib.c */
1589 extern u8 ide_dma_speed(ide_drive_t *drive, u8 mode);
1590 extern u8 ide_rate_filter(u8 mode, u8 speed);
1591 extern int ide_dma_enable(ide_drive_t *drive);
1592 extern char *ide_xfer_verbose(u8 xfer_rate);
1593 extern void ide_toggle_bounce(ide_drive_t *drive, int on);
1594 extern int ide_set_xfer_rate(ide_drive_t *drive, u8 rate);
1595 extern byte ide_dump_atapi_status(ide_drive_t *drive, const char *msg, byte stat);
1596
1597 typedef struct ide_pio_timings_s {
1598 int setup_time; /* Address setup (ns) minimum */
1599 int active_time; /* Active pulse (ns) minimum */
1600 int cycle_time; /* Cycle time (ns) minimum = (setup + active + recovery) */
1601 } ide_pio_timings_t;
1602
1603 typedef struct ide_pio_data_s {
1604 u8 pio_mode;
1605 u8 use_iordy;
1606 u8 overridden;
1607 u8 blacklisted;
1608 unsigned int cycle_time;
1609 } ide_pio_data_t;
1610
1611 extern u8 ide_get_best_pio_mode (ide_drive_t *drive, u8 mode_wanted, u8 max_mode, ide_pio_data_t *d);
1612 extern const ide_pio_timings_t ide_pio_timings[6];
1613
1614
1615 extern spinlock_t ide_lock;
1616 extern struct semaphore ide_cfg_sem;
1617 /*
1618 * Structure locking:
1619 *
1620 * ide_cfg_sem and ide_lock together protect changes to
1621 * ide_hwif_t->{next,hwgroup}
1622 * ide_drive_t->next
1623 *
1624 * ide_hwgroup_t->busy: ide_lock
1625 * ide_hwgroup_t->hwif: ide_lock
1626 * ide_hwif_t->mate: constant, no locking
1627 * ide_drive_t->hwif: constant, no locking
1628 */
1629
1630 #define local_irq_set(flags) do { local_save_flags((flags)); local_irq_enable(); } while (0)
1631
1632 extern struct bus_type ide_bus_type;
1633
1634 /* check if CACHE FLUSH (EXT) command is supported (bits defined in ATA-6) */
1635 #define ide_id_has_flush_cache(id) ((id)->cfs_enable_2 & 0x3000)
1636
1637 /* some Maxtor disks have bit 13 defined incorrectly so check bit 10 too */
1638 #define ide_id_has_flush_cache_ext(id) \
1639 (((id)->cfs_enable_2 & 0x2400) == 0x2400)
1640
1641 #endif /* _IDE_H */
MOXA 2.6.9 from sdlinux-moxaart.tgz