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