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