]> git.karo-electronics.de Git - mv-sheeva.git/blob - include/linux/ide.h
ide: CPU endianness doesn't matter for special_t
[mv-sheeva.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/init.h>
10 #include <linux/ioport.h>
11 #include <linux/hdreg.h>
12 #include <linux/hdsmart.h>
13 #include <linux/blkdev.h>
14 #include <linux/proc_fs.h>
15 #include <linux/interrupt.h>
16 #include <linux/bitops.h>
17 #include <linux/bio.h>
18 #include <linux/device.h>
19 #include <linux/pci.h>
20 #include <linux/completion.h>
21 #ifdef CONFIG_BLK_DEV_IDEACPI
22 #include <acpi/acpi.h>
23 #endif
24 #include <asm/byteorder.h>
25 #include <asm/system.h>
26 #include <asm/io.h>
27 #include <asm/semaphore.h>
28 #include <asm/mutex.h>
29
30 #if defined(CRIS) || defined(FRV)
31 # define SUPPORT_VLB_SYNC 0
32 #else
33 # define SUPPORT_VLB_SYNC 1
34 #endif
35
36 /*
37  * Used to indicate "no IRQ", should be a value that cannot be an IRQ
38  * number.
39  */
40  
41 #define IDE_NO_IRQ              (-1)
42
43 typedef unsigned char   byte;   /* used everywhere */
44
45 /*
46  * Probably not wise to fiddle with these
47  */
48 #define ERROR_MAX       8       /* Max read/write errors per sector */
49 #define ERROR_RESET     3       /* Reset controller every 4th retry */
50 #define ERROR_RECAL     1       /* Recalibrate every 2nd retry */
51
52 /*
53  * Tune flags
54  */
55 #define IDE_TUNE_NOAUTO         2
56 #define IDE_TUNE_AUTO           1
57 #define IDE_TUNE_DEFAULT        0
58
59 /*
60  * state flags
61  */
62
63 #define DMA_PIO_RETRY   1       /* retrying in PIO */
64
65 #define HWIF(drive)             ((ide_hwif_t *)((drive)->hwif))
66 #define HWGROUP(drive)          ((ide_hwgroup_t *)(HWIF(drive)->hwgroup))
67
68 /*
69  * Definitions for accessing IDE controller registers
70  */
71 #define IDE_NR_PORTS            (10)
72
73 #define IDE_DATA_OFFSET         (0)
74 #define IDE_ERROR_OFFSET        (1)
75 #define IDE_NSECTOR_OFFSET      (2)
76 #define IDE_SECTOR_OFFSET       (3)
77 #define IDE_LCYL_OFFSET         (4)
78 #define IDE_HCYL_OFFSET         (5)
79 #define IDE_SELECT_OFFSET       (6)
80 #define IDE_STATUS_OFFSET       (7)
81 #define IDE_CONTROL_OFFSET      (8)
82 #define IDE_IRQ_OFFSET          (9)
83
84 #define IDE_FEATURE_OFFSET      IDE_ERROR_OFFSET
85 #define IDE_COMMAND_OFFSET      IDE_STATUS_OFFSET
86
87 #define IDE_DATA_REG            (HWIF(drive)->io_ports[IDE_DATA_OFFSET])
88 #define IDE_ERROR_REG           (HWIF(drive)->io_ports[IDE_ERROR_OFFSET])
89 #define IDE_NSECTOR_REG         (HWIF(drive)->io_ports[IDE_NSECTOR_OFFSET])
90 #define IDE_SECTOR_REG          (HWIF(drive)->io_ports[IDE_SECTOR_OFFSET])
91 #define IDE_LCYL_REG            (HWIF(drive)->io_ports[IDE_LCYL_OFFSET])
92 #define IDE_HCYL_REG            (HWIF(drive)->io_ports[IDE_HCYL_OFFSET])
93 #define IDE_SELECT_REG          (HWIF(drive)->io_ports[IDE_SELECT_OFFSET])
94 #define IDE_STATUS_REG          (HWIF(drive)->io_ports[IDE_STATUS_OFFSET])
95 #define IDE_CONTROL_REG         (HWIF(drive)->io_ports[IDE_CONTROL_OFFSET])
96 #define IDE_IRQ_REG             (HWIF(drive)->io_ports[IDE_IRQ_OFFSET])
97
98 #define IDE_FEATURE_REG         IDE_ERROR_REG
99 #define IDE_COMMAND_REG         IDE_STATUS_REG
100 #define IDE_ALTSTATUS_REG       IDE_CONTROL_REG
101 #define IDE_IREASON_REG         IDE_NSECTOR_REG
102 #define IDE_BCOUNTL_REG         IDE_LCYL_REG
103 #define IDE_BCOUNTH_REG         IDE_HCYL_REG
104
105 #define OK_STAT(stat,good,bad)  (((stat)&((good)|(bad)))==(good))
106 #define BAD_R_STAT              (BUSY_STAT   | ERR_STAT)
107 #define BAD_W_STAT              (BAD_R_STAT  | WRERR_STAT)
108 #define BAD_STAT                (BAD_R_STAT  | DRQ_STAT)
109 #define DRIVE_READY             (READY_STAT  | SEEK_STAT)
110 #define DATA_READY              (DRQ_STAT)
111
112 #define BAD_CRC                 (ABRT_ERR    | ICRC_ERR)
113
114 #define SATA_NR_PORTS           (3)     /* 16 possible ?? */
115
116 #define SATA_STATUS_OFFSET      (0)
117 #define SATA_STATUS_REG         (HWIF(drive)->sata_scr[SATA_STATUS_OFFSET])
118 #define SATA_ERROR_OFFSET       (1)
119 #define SATA_ERROR_REG          (HWIF(drive)->sata_scr[SATA_ERROR_OFFSET])
120 #define SATA_CONTROL_OFFSET     (2)
121 #define SATA_CONTROL_REG        (HWIF(drive)->sata_scr[SATA_CONTROL_OFFSET])
122
123 #define SATA_MISC_OFFSET        (0)
124 #define SATA_MISC_REG           (HWIF(drive)->sata_misc[SATA_MISC_OFFSET])
125 #define SATA_PHY_OFFSET         (1)
126 #define SATA_PHY_REG            (HWIF(drive)->sata_misc[SATA_PHY_OFFSET])
127 #define SATA_IEN_OFFSET         (2)
128 #define SATA_IEN_REG            (HWIF(drive)->sata_misc[SATA_IEN_OFFSET])
129
130 /*
131  * Our Physical Region Descriptor (PRD) table should be large enough
132  * to handle the biggest I/O request we are likely to see.  Since requests
133  * can have no more than 256 sectors, and since the typical blocksize is
134  * two or more sectors, we could get by with a limit of 128 entries here for
135  * the usual worst case.  Most requests seem to include some contiguous blocks,
136  * further reducing the number of table entries required.
137  *
138  * The driver reverts to PIO mode for individual requests that exceed
139  * this limit (possible with 512 byte blocksizes, eg. MSDOS f/s), so handling
140  * 100% of all crazy scenarios here is not necessary.
141  *
142  * As it turns out though, we must allocate a full 4KB page for this,
143  * so the two PRD tables (ide0 & ide1) will each get half of that,
144  * allowing each to have about 256 entries (8 bytes each) from this.
145  */
146 #define PRD_BYTES       8
147 #define PRD_ENTRIES     256
148
149 /*
150  * Some more useful definitions
151  */
152 #define PARTN_BITS      6       /* number of minor dev bits for partitions */
153 #define MAX_DRIVES      2       /* per interface; 2 assumed by lots of code */
154 #define SECTOR_SIZE     512
155 #define SECTOR_WORDS    (SECTOR_SIZE / 4)       /* number of 32bit words per sector */
156 #define IDE_LARGE_SEEK(b1,b2,t) (((b1) > (b2) + (t)) || ((b2) > (b1) + (t)))
157
158 /*
159  * Timeouts for various operations:
160  */
161 #define WAIT_DRQ        (HZ/10)         /* 100msec - spec allows up to 20ms */
162 #define WAIT_READY      (5*HZ)          /* 5sec - some laptops are very slow */
163 #define WAIT_PIDENTIFY  (10*HZ) /* 10sec  - should be less than 3ms (?), if all ATAPI CD is closed at boot */
164 #define WAIT_WORSTCASE  (30*HZ) /* 30sec  - worst case when spinning up */
165 #define WAIT_CMD        (10*HZ) /* 10sec  - maximum wait for an IRQ to happen */
166 #define WAIT_MIN_SLEEP  (2*HZ/100)      /* 20msec - minimum sleep time */
167
168 /*
169  * Check for an interrupt and acknowledge the interrupt status
170  */
171 struct hwif_s;
172 typedef int (ide_ack_intr_t)(struct hwif_s *);
173
174 /*
175  * hwif_chipset_t is used to keep track of the specific hardware
176  * chipset used by each IDE interface, if known.
177  */
178 enum {          ide_unknown,    ide_generic,    ide_pci,
179                 ide_cmd640,     ide_dtc2278,    ide_ali14xx,
180                 ide_qd65xx,     ide_umc8672,    ide_ht6560b,
181                 ide_rz1000,     ide_trm290,
182                 ide_cmd646,     ide_cy82c693,   ide_4drives,
183                 ide_pmac,       ide_etrax100,   ide_acorn,
184                 ide_au1xxx, ide_forced
185 };
186
187 typedef u8 hwif_chipset_t;
188
189 /*
190  * Structure to hold all information about the location of this port
191  */
192 typedef struct hw_regs_s {
193         unsigned long   io_ports[IDE_NR_PORTS]; /* task file registers */
194         int             irq;                    /* our irq number */
195         ide_ack_intr_t  *ack_intr;              /* acknowledge interrupt */
196         hwif_chipset_t  chipset;
197         struct device   *dev;
198 } hw_regs_t;
199
200 struct hwif_s * ide_find_port(unsigned long);
201
202 int ide_register_hw(hw_regs_t *, void (*)(struct hwif_s *), int,
203                     struct hwif_s **);
204
205 void ide_setup_ports(   hw_regs_t *hw,
206                         unsigned long base,
207                         int *offsets,
208                         unsigned long ctrl,
209                         unsigned long intr,
210                         ide_ack_intr_t *ack_intr,
211 #if 0
212                         ide_io_ops_t *iops,
213 #endif
214                         int irq);
215
216 static inline void ide_std_init_ports(hw_regs_t *hw,
217                                       unsigned long io_addr,
218                                       unsigned long ctl_addr)
219 {
220         unsigned int i;
221
222         for (i = IDE_DATA_OFFSET; i <= IDE_STATUS_OFFSET; i++)
223                 hw->io_ports[i] = io_addr++;
224
225         hw->io_ports[IDE_CONTROL_OFFSET] = ctl_addr;
226 }
227
228 #include <asm/ide.h>
229
230 #if !defined(MAX_HWIFS) || defined(CONFIG_EMBEDDED)
231 #undef MAX_HWIFS
232 #define MAX_HWIFS       CONFIG_IDE_MAX_HWIFS
233 #endif
234
235 /* needed on alpha, x86/x86_64, ia64, mips, ppc32 and sh */
236 #ifndef IDE_ARCH_OBSOLETE_DEFAULTS
237 # define ide_default_io_base(index)     (0)
238 # define ide_default_irq(base)          (0)
239 # define ide_init_default_irq(base)     (0)
240 #endif
241
242 #ifdef CONFIG_IDE_ARCH_OBSOLETE_INIT
243 static inline void ide_init_hwif_ports(hw_regs_t *hw,
244                                        unsigned long io_addr,
245                                        unsigned long ctl_addr,
246                                        int *irq)
247 {
248         if (!ctl_addr)
249                 ide_std_init_ports(hw, io_addr, ide_default_io_ctl(io_addr));
250         else
251                 ide_std_init_ports(hw, io_addr, ctl_addr);
252
253         if (irq)
254                 *irq = 0;
255
256         hw->io_ports[IDE_IRQ_OFFSET] = 0;
257
258 #ifdef CONFIG_PPC32
259         if (ppc_ide_md.ide_init_hwif)
260                 ppc_ide_md.ide_init_hwif(hw, io_addr, ctl_addr, irq);
261 #endif
262 }
263 #else
264 static inline void ide_init_hwif_ports(hw_regs_t *hw,
265                                        unsigned long io_addr,
266                                        unsigned long ctl_addr,
267                                        int *irq)
268 {
269         if (io_addr || ctl_addr)
270                 printk(KERN_WARNING "%s: must not be called\n", __FUNCTION__);
271 }
272 #endif /* CONFIG_IDE_ARCH_OBSOLETE_INIT */
273
274 /* Currently only m68k, apus and m8xx need it */
275 #ifndef IDE_ARCH_ACK_INTR
276 # define ide_ack_intr(hwif) (1)
277 #endif
278
279 /* Currently only Atari needs it */
280 #ifndef IDE_ARCH_LOCK
281 # define ide_release_lock()                     do {} while (0)
282 # define ide_get_lock(hdlr, data)               do {} while (0)
283 #endif /* IDE_ARCH_LOCK */
284
285 /*
286  * Now for the data we need to maintain per-drive:  ide_drive_t
287  */
288
289 #define ide_scsi        0x21
290 #define ide_disk        0x20
291 #define ide_optical     0x7
292 #define ide_cdrom       0x5
293 #define ide_tape        0x1
294 #define ide_floppy      0x0
295
296 /*
297  * Special Driver Flags
298  *
299  * set_geometry : respecify drive geometry
300  * recalibrate  : seek to cyl 0
301  * set_multmode : set multmode count
302  * set_tune     : tune interface for drive
303  * serviced     : service command
304  * reserved     : unused
305  */
306 typedef union {
307         unsigned all                    : 8;
308         struct {
309                 unsigned set_geometry   : 1;
310                 unsigned recalibrate    : 1;
311                 unsigned set_multmode   : 1;
312                 unsigned set_tune       : 1;
313                 unsigned serviced       : 1;
314                 unsigned reserved       : 3;
315         } b;
316 } special_t;
317
318 /*
319  * ATA DATA Register Special.
320  * ATA NSECTOR Count Register().
321  * ATAPI Byte Count Register.
322  */
323 typedef union {
324         unsigned all                    :16;
325         struct {
326 #if defined(__LITTLE_ENDIAN_BITFIELD)
327                 unsigned low            :8;     /* LSB */
328                 unsigned high           :8;     /* MSB */
329 #elif defined(__BIG_ENDIAN_BITFIELD)
330                 unsigned high           :8;     /* MSB */
331                 unsigned low            :8;     /* LSB */
332 #else
333 #error "Please fix <asm/byteorder.h>"
334 #endif
335         } b;
336 } ata_nsector_t, ata_data_t, atapi_bcount_t;
337
338 /*
339  * ATA-IDE Select Register, aka Device-Head
340  *
341  * head         : always zeros here
342  * unit         : drive select number: 0/1
343  * bit5         : always 1
344  * lba          : using LBA instead of CHS
345  * bit7         : always 1
346  */
347 typedef union {
348         unsigned all                    : 8;
349         struct {
350 #if defined(__LITTLE_ENDIAN_BITFIELD)
351                 unsigned head           : 4;
352                 unsigned unit           : 1;
353                 unsigned bit5           : 1;
354                 unsigned lba            : 1;
355                 unsigned bit7           : 1;
356 #elif defined(__BIG_ENDIAN_BITFIELD)
357                 unsigned bit7           : 1;
358                 unsigned lba            : 1;
359                 unsigned bit5           : 1;
360                 unsigned unit           : 1;
361                 unsigned head           : 4;
362 #else
363 #error "Please fix <asm/byteorder.h>"
364 #endif
365         } b;
366 } select_t, ata_select_t;
367
368 /*
369  * The ATA-IDE Status Register.
370  * The ATAPI Status Register.
371  *
372  * check        : Error occurred
373  * idx          : Index Error
374  * corr         : Correctable error occurred
375  * drq          : Data is request by the device
376  * dsc          : Disk Seek Complete                    : ata
377  *              : Media access command finished         : atapi
378  * df           : Device Fault                          : ata
379  *              : Reserved                              : atapi
380  * drdy         : Ready, Command Mode Capable           : ata
381  *              : Ignored for ATAPI commands            : atapi
382  * bsy          : Disk is Busy
383  *              : The device has access to the command block
384  */
385 typedef union {
386         unsigned all                    :8;
387         struct {
388 #if defined(__LITTLE_ENDIAN_BITFIELD)
389                 unsigned check          :1;
390                 unsigned idx            :1;
391                 unsigned corr           :1;
392                 unsigned drq            :1;
393                 unsigned dsc            :1;
394                 unsigned df             :1;
395                 unsigned drdy           :1;
396                 unsigned bsy            :1;
397 #elif defined(__BIG_ENDIAN_BITFIELD)
398                 unsigned bsy            :1;
399                 unsigned drdy           :1;
400                 unsigned df             :1;
401                 unsigned dsc            :1;
402                 unsigned drq            :1;
403                 unsigned corr           :1;
404                 unsigned idx            :1;
405                 unsigned check          :1;
406 #else
407 #error "Please fix <asm/byteorder.h>"
408 #endif
409         } b;
410 } ata_status_t, atapi_status_t;
411
412 /*
413  * ATAPI Feature Register
414  *
415  * dma          : Using DMA or PIO
416  * reserved321  : Reserved
417  * reserved654  : Reserved (Tag Type)
418  * reserved7    : Reserved
419  */
420 typedef union {
421         unsigned all                    :8;
422         struct {
423 #if defined(__LITTLE_ENDIAN_BITFIELD)
424                 unsigned dma            :1;
425                 unsigned reserved321    :3;
426                 unsigned reserved654    :3;
427                 unsigned reserved7      :1;
428 #elif defined(__BIG_ENDIAN_BITFIELD)
429                 unsigned reserved7      :1;
430                 unsigned reserved654    :3;
431                 unsigned reserved321    :3;
432                 unsigned dma            :1;
433 #else
434 #error "Please fix <asm/byteorder.h>"
435 #endif
436         } b;
437 } atapi_feature_t;
438
439 /*
440  * ATAPI Interrupt Reason Register.
441  *
442  * cod          : Information transferred is command (1) or data (0)
443  * io           : The device requests us to read (1) or write (0)
444  * reserved     : Reserved
445  */
446 typedef union {
447         unsigned all                    :8;
448         struct {
449 #if defined(__LITTLE_ENDIAN_BITFIELD)
450                 unsigned cod            :1;
451                 unsigned io             :1;
452                 unsigned reserved       :6;
453 #elif defined(__BIG_ENDIAN_BITFIELD)
454                 unsigned reserved       :6;
455                 unsigned io             :1;
456                 unsigned cod            :1;
457 #else
458 #error "Please fix <asm/byteorder.h>"
459 #endif
460         } b;
461 } atapi_ireason_t;
462
463 /*
464  * The ATAPI error register.
465  *
466  * ili          : Illegal Length Indication
467  * eom          : End Of Media Detected
468  * abrt         : Aborted command - As defined by ATA
469  * mcr          : Media Change Requested - As defined by ATA
470  * sense_key    : Sense key of the last failed packet command
471  */
472 typedef union {
473         unsigned all                    :8;
474         struct {
475 #if defined(__LITTLE_ENDIAN_BITFIELD)
476                 unsigned ili            :1;
477                 unsigned eom            :1;
478                 unsigned abrt           :1;
479                 unsigned mcr            :1;
480                 unsigned sense_key      :4;
481 #elif defined(__BIG_ENDIAN_BITFIELD)
482                 unsigned sense_key      :4;
483                 unsigned mcr            :1;
484                 unsigned abrt           :1;
485                 unsigned eom            :1;
486                 unsigned ili            :1;
487 #else
488 #error "Please fix <asm/byteorder.h>"
489 #endif
490         } b;
491 } atapi_error_t;
492
493 /*
494  * Status returned from various ide_ functions
495  */
496 typedef enum {
497         ide_stopped,    /* no drive operation was started */
498         ide_started,    /* a drive operation was started, handler was set */
499 } ide_startstop_t;
500
501 struct ide_driver_s;
502 struct ide_settings_s;
503
504 #ifdef CONFIG_BLK_DEV_IDEACPI
505 struct ide_acpi_drive_link;
506 struct ide_acpi_hwif_link;
507 #endif
508
509 typedef struct ide_drive_s {
510         char            name[4];        /* drive name, such as "hda" */
511         char            driver_req[10]; /* requests specific driver */
512
513         struct request_queue    *queue; /* request queue */
514
515         struct request          *rq;    /* current request */
516         struct ide_drive_s      *next;  /* circular list of hwgroup drives */
517         void            *driver_data;   /* extra driver data */
518         struct hd_driveid       *id;    /* drive model identification info */
519 #ifdef CONFIG_IDE_PROC_FS
520         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
521         struct ide_settings_s *settings;/* /proc/ide/ drive settings */
522 #endif
523         struct hwif_s           *hwif;  /* actually (ide_hwif_t *) */
524
525         unsigned long sleep;            /* sleep until this time */
526         unsigned long service_start;    /* time we started last request */
527         unsigned long service_time;     /* service time of last request */
528         unsigned long timeout;          /* max time to wait for irq */
529
530         special_t       special;        /* special action flags */
531         select_t        select;         /* basic drive/head select reg value */
532
533         u8      keep_settings;          /* restore settings after drive reset */
534         u8      using_dma;              /* disk is using dma for read/write */
535         u8      retry_pio;              /* retrying dma capable host in pio */
536         u8      state;                  /* retry state */
537         u8      waiting_for_dma;        /* dma currently in progress */
538         u8      unmask;                 /* okay to unmask other irqs */
539         u8      bswap;                  /* byte swap data */
540         u8      noflush;                /* don't attempt flushes */
541         u8      dsc_overlap;            /* DSC overlap */
542         u8      nice1;                  /* give potential excess bandwidth */
543
544         unsigned present        : 1;    /* drive is physically present */
545         unsigned dead           : 1;    /* device ejected hint */
546         unsigned id_read        : 1;    /* 1=id read from disk 0 = synthetic */
547         unsigned noprobe        : 1;    /* from:  hdx=noprobe */
548         unsigned removable      : 1;    /* 1 if need to do check_media_change */
549         unsigned attach         : 1;    /* needed for removable devices */
550         unsigned forced_geom    : 1;    /* 1 if hdx=c,h,s was given at boot */
551         unsigned no_unmask      : 1;    /* disallow setting unmask bit */
552         unsigned no_io_32bit    : 1;    /* disallow enabling 32bit I/O */
553         unsigned atapi_overlap  : 1;    /* ATAPI overlap (not supported) */
554         unsigned nice0          : 1;    /* give obvious excess bandwidth */
555         unsigned nice2          : 1;    /* give a share in our own bandwidth */
556         unsigned doorlocking    : 1;    /* for removable only: door lock/unlock works */
557         unsigned nodma          : 1;    /* disallow DMA */
558         unsigned autotune       : 2;    /* 0=default, 1=autotune, 2=noautotune */
559         unsigned remap_0_to_1   : 1;    /* 0=noremap, 1=remap 0->1 (for EZDrive) */
560         unsigned blocked        : 1;    /* 1=powermanagment told us not to do anything, so sleep nicely */
561         unsigned vdma           : 1;    /* 1=doing PIO over DMA 0=doing normal DMA */
562         unsigned scsi           : 1;    /* 0=default, 1=ide-scsi emulation */
563         unsigned sleeping       : 1;    /* 1=sleeping & sleep field valid */
564         unsigned post_reset     : 1;
565         unsigned udma33_warned  : 1;
566
567         u8      addressing;     /* 0=28-bit, 1=48-bit, 2=48-bit doing 28-bit */
568         u8      quirk_list;     /* considered quirky, set for a specific host */
569         u8      init_speed;     /* transfer rate set at boot */
570         u8      current_speed;  /* current transfer rate set */
571         u8      desired_speed;  /* desired transfer rate set */
572         u8      dn;             /* now wide spread use */
573         u8      wcache;         /* status of write cache */
574         u8      acoustic;       /* acoustic management */
575         u8      media;          /* disk, cdrom, tape, floppy, ... */
576         u8      ctl;            /* "normal" value for IDE_CONTROL_REG */
577         u8      ready_stat;     /* min status value for drive ready */
578         u8      mult_count;     /* current multiple sector setting */
579         u8      mult_req;       /* requested multiple sector setting */
580         u8      tune_req;       /* requested drive tuning setting */
581         u8      io_32bit;       /* 0=16-bit, 1=32-bit, 2/3=32bit+sync */
582         u8      bad_wstat;      /* used for ignoring WRERR_STAT */
583         u8      nowerr;         /* used for ignoring WRERR_STAT */
584         u8      sect0;          /* offset of first sector for DM6:DDO */
585         u8      head;           /* "real" number of heads */
586         u8      sect;           /* "real" sectors per track */
587         u8      bios_head;      /* BIOS/fdisk/LILO number of heads */
588         u8      bios_sect;      /* BIOS/fdisk/LILO sectors per track */
589
590         unsigned int    bios_cyl;       /* BIOS/fdisk/LILO number of cyls */
591         unsigned int    cyl;            /* "real" number of cyls */
592         unsigned int    drive_data;     /* used by set_pio_mode/selectproc */
593         unsigned int    failures;       /* current failure count */
594         unsigned int    max_failures;   /* maximum allowed failure count */
595         u64             probed_capacity;/* initial reported media capacity (ide-cd only currently) */
596
597         u64             capacity64;     /* total number of sectors */
598
599         int             lun;            /* logical unit */
600         int             crc_count;      /* crc counter to reduce drive speed */
601 #ifdef CONFIG_BLK_DEV_IDEACPI
602         struct ide_acpi_drive_link *acpidata;
603 #endif
604         struct list_head list;
605         struct device   gendev;
606         struct completion gendev_rel_comp;      /* to deal with device release() */
607 } ide_drive_t;
608
609 #define to_ide_device(dev)container_of(dev, ide_drive_t, gendev)
610
611 #define IDE_CHIPSET_PCI_MASK    \
612     ((1<<ide_pci)|(1<<ide_cmd646)|(1<<ide_ali14xx))
613 #define IDE_CHIPSET_IS_PCI(c)   ((IDE_CHIPSET_PCI_MASK >> (c)) & 1)
614
615 struct ide_port_info;
616
617 typedef struct hwif_s {
618         struct hwif_s *next;            /* for linked-list in ide_hwgroup_t */
619         struct hwif_s *mate;            /* other hwif from same PCI chip */
620         struct hwgroup_s *hwgroup;      /* actually (ide_hwgroup_t *) */
621         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
622
623         char name[6];                   /* name of interface, eg. "ide0" */
624
625                 /* task file registers for pata and sata */
626         unsigned long   io_ports[IDE_NR_PORTS];
627         unsigned long   sata_scr[SATA_NR_PORTS];
628         unsigned long   sata_misc[SATA_NR_PORTS];
629
630         ide_drive_t     drives[MAX_DRIVES];     /* drive info */
631
632         u8 major;       /* our major number */
633         u8 index;       /* 0 for ide0; 1 for ide1; ... */
634         u8 channel;     /* for dual-port chips: 0=primary, 1=secondary */
635         u8 straight8;   /* Alan's straight 8 check */
636         u8 bus_state;   /* power state of the IDE bus */
637
638         u32 host_flags;
639
640         u8 pio_mask;
641
642         u8 ultra_mask;
643         u8 mwdma_mask;
644         u8 swdma_mask;
645
646         u8 cbl;         /* cable type */
647
648         hwif_chipset_t chipset; /* sub-module for tuning.. */
649
650         struct pci_dev  *pci_dev;       /* for pci chipsets */
651         const struct ide_port_info *cds;        /* chipset device struct */
652
653         ide_ack_intr_t *ack_intr;
654
655         void (*rw_disk)(ide_drive_t *, struct request *);
656
657 #if 0
658         ide_hwif_ops_t  *hwifops;
659 #else
660         /* routine to program host for PIO mode */
661         void    (*set_pio_mode)(ide_drive_t *, const u8);
662         /* routine to program host for DMA mode */
663         void    (*set_dma_mode)(ide_drive_t *, const u8);
664         /* tweaks hardware to select drive */
665         void    (*selectproc)(ide_drive_t *);
666         /* chipset polling based on hba specifics */
667         int     (*reset_poll)(ide_drive_t *);
668         /* chipset specific changes to default for device-hba resets */
669         void    (*pre_reset)(ide_drive_t *);
670         /* routine to reset controller after a disk reset */
671         void    (*resetproc)(ide_drive_t *);
672         /* special interrupt handling for shared pci interrupts */
673         void    (*intrproc)(ide_drive_t *);
674         /* special host masking for drive selection */
675         void    (*maskproc)(ide_drive_t *, int);
676         /* check host's drive quirk list */
677         int     (*quirkproc)(ide_drive_t *);
678         /* driver soft-power interface */
679         int     (*busproc)(ide_drive_t *, int);
680 #endif
681         u8 (*mdma_filter)(ide_drive_t *);
682         u8 (*udma_filter)(ide_drive_t *);
683
684         void (*fixup)(struct hwif_s *);
685
686         void (*ata_input_data)(ide_drive_t *, void *, u32);
687         void (*ata_output_data)(ide_drive_t *, void *, u32);
688
689         void (*atapi_input_bytes)(ide_drive_t *, void *, u32);
690         void (*atapi_output_bytes)(ide_drive_t *, void *, u32);
691
692         int (*dma_setup)(ide_drive_t *);
693         void (*dma_exec_cmd)(ide_drive_t *, u8);
694         void (*dma_start)(ide_drive_t *);
695         int (*ide_dma_end)(ide_drive_t *drive);
696         int (*ide_dma_on)(ide_drive_t *drive);
697         void (*dma_off_quietly)(ide_drive_t *drive);
698         int (*ide_dma_test_irq)(ide_drive_t *drive);
699         void (*ide_dma_clear_irq)(ide_drive_t *drive);
700         void (*dma_host_on)(ide_drive_t *drive);
701         void (*dma_host_off)(ide_drive_t *drive);
702         void (*dma_lost_irq)(ide_drive_t *drive);
703         void (*dma_timeout)(ide_drive_t *drive);
704
705         void (*OUTB)(u8 addr, unsigned long port);
706         void (*OUTBSYNC)(ide_drive_t *drive, u8 addr, unsigned long port);
707         void (*OUTW)(u16 addr, unsigned long port);
708         void (*OUTSW)(unsigned long port, void *addr, u32 count);
709         void (*OUTSL)(unsigned long port, void *addr, u32 count);
710
711         u8  (*INB)(unsigned long port);
712         u16 (*INW)(unsigned long port);
713         void (*INSW)(unsigned long port, void *addr, u32 count);
714         void (*INSL)(unsigned long port, void *addr, u32 count);
715
716         /* dma physical region descriptor table (cpu view) */
717         unsigned int    *dmatable_cpu;
718         /* dma physical region descriptor table (dma view) */
719         dma_addr_t      dmatable_dma;
720         /* Scatter-gather list used to build the above */
721         struct scatterlist *sg_table;
722         int sg_max_nents;               /* Maximum number of entries in it */
723         int sg_nents;                   /* Current number of entries in it */
724         int sg_dma_direction;           /* dma transfer direction */
725
726         /* data phase of the active command (currently only valid for PIO/DMA) */
727         int             data_phase;
728
729         unsigned int nsect;
730         unsigned int nleft;
731         struct scatterlist *cursg;
732         unsigned int cursg_ofs;
733
734         int             rqsize;         /* max sectors per request */
735         int             irq;            /* our irq number */
736
737         unsigned long   dma_base;       /* base addr for dma ports */
738         unsigned long   dma_command;    /* dma command register */
739         unsigned long   dma_vendor1;    /* dma vendor 1 register */
740         unsigned long   dma_status;     /* dma status register */
741         unsigned long   dma_vendor3;    /* dma vendor 3 register */
742         unsigned long   dma_prdtable;   /* actual prd table address */
743
744         unsigned long   config_data;    /* for use by chipset-specific code */
745         unsigned long   select_data;    /* for use by chipset-specific code */
746
747         unsigned long   extra_base;     /* extra addr for dma ports */
748         unsigned        extra_ports;    /* number of extra dma ports */
749
750         unsigned        noprobe    : 1; /* don't probe for this interface */
751         unsigned        present    : 1; /* this interface exists */
752         unsigned        hold       : 1; /* this interface is always present */
753         unsigned        serialized : 1; /* serialized all channel operation */
754         unsigned        sharing_irq: 1; /* 1 = sharing irq with another hwif */
755         unsigned        reset      : 1; /* reset after probe */
756         unsigned        auto_poll  : 1; /* supports nop auto-poll */
757         unsigned        sg_mapped  : 1; /* sg_table and sg_nents are ready */
758         unsigned        no_io_32bit : 1; /* 1 = can not do 32-bit IO ops */
759         unsigned        mmio       : 1; /* host uses MMIO */
760
761         struct device   gendev;
762         struct completion gendev_rel_comp; /* To deal with device release() */
763
764         void            *hwif_data;     /* extra hwif data */
765
766         unsigned dma;
767
768 #ifdef CONFIG_BLK_DEV_IDEACPI
769         struct ide_acpi_hwif_link *acpidata;
770 #endif
771 } ____cacheline_internodealigned_in_smp ide_hwif_t;
772
773 /*
774  *  internal ide interrupt handler type
775  */
776 typedef ide_startstop_t (ide_pre_handler_t)(ide_drive_t *, struct request *);
777 typedef ide_startstop_t (ide_handler_t)(ide_drive_t *);
778 typedef int (ide_expiry_t)(ide_drive_t *);
779
780 typedef struct hwgroup_s {
781                 /* irq handler, if active */
782         ide_startstop_t (*handler)(ide_drive_t *);
783                 /* irq handler, suspended if active */
784         ide_startstop_t (*handler_save)(ide_drive_t *);
785                 /* BOOL: protects all fields below */
786         volatile int busy;
787                 /* BOOL: wake us up on timer expiry */
788         unsigned int sleeping   : 1;
789                 /* BOOL: polling active & poll_timeout field valid */
790         unsigned int polling    : 1;
791                 /* BOOL: in a polling reset situation. Must not trigger another reset yet */
792         unsigned int resetting  : 1;
793
794                 /* current drive */
795         ide_drive_t *drive;
796                 /* ptr to current hwif in linked-list */
797         ide_hwif_t *hwif;
798
799                 /* for pci chipsets */
800         struct pci_dev *pci_dev;
801
802                 /* current request */
803         struct request *rq;
804                 /* failsafe timer */
805         struct timer_list timer;
806                 /* local copy of current write rq */
807         struct request wrq;
808                 /* timeout value during long polls */
809         unsigned long poll_timeout;
810                 /* queried upon timeouts */
811         int (*expiry)(ide_drive_t *);
812                 /* ide_system_bus_speed */
813         int pio_clock;
814         int req_gen;
815         int req_gen_timer;
816
817         unsigned char cmd_buf[4];
818 } ide_hwgroup_t;
819
820 typedef struct ide_driver_s ide_driver_t;
821
822 extern struct mutex ide_setting_mtx;
823
824 int set_io_32bit(ide_drive_t *, int);
825 int set_pio_mode(ide_drive_t *, int);
826 int set_using_dma(ide_drive_t *, int);
827
828 #ifdef CONFIG_IDE_PROC_FS
829 /*
830  * configurable drive settings
831  */
832
833 #define TYPE_INT        0
834 #define TYPE_BYTE       1
835 #define TYPE_SHORT      2
836
837 #define SETTING_READ    (1 << 0)
838 #define SETTING_WRITE   (1 << 1)
839 #define SETTING_RW      (SETTING_READ | SETTING_WRITE)
840
841 typedef int (ide_procset_t)(ide_drive_t *, int);
842 typedef struct ide_settings_s {
843         char                    *name;
844         int                     rw;
845         int                     data_type;
846         int                     min;
847         int                     max;
848         int                     mul_factor;
849         int                     div_factor;
850         void                    *data;
851         ide_procset_t           *set;
852         int                     auto_remove;
853         struct ide_settings_s   *next;
854 } ide_settings_t;
855
856 int ide_add_setting(ide_drive_t *, const char *, int, int, int, int, int, int, void *, ide_procset_t *set);
857
858 /*
859  * /proc/ide interface
860  */
861 typedef struct {
862         const char      *name;
863         mode_t          mode;
864         read_proc_t     *read_proc;
865         write_proc_t    *write_proc;
866 } ide_proc_entry_t;
867
868 void proc_ide_create(void);
869 void proc_ide_destroy(void);
870 void ide_proc_register_port(ide_hwif_t *);
871 void ide_proc_unregister_port(ide_hwif_t *);
872 void ide_proc_register_driver(ide_drive_t *, ide_driver_t *);
873 void ide_proc_unregister_driver(ide_drive_t *, ide_driver_t *);
874
875 void ide_add_generic_settings(ide_drive_t *);
876
877 read_proc_t proc_ide_read_capacity;
878 read_proc_t proc_ide_read_geometry;
879
880 #ifdef CONFIG_BLK_DEV_IDEPCI
881 void ide_pci_create_host_proc(const char *, get_info_t *);
882 #endif
883
884 /*
885  * Standard exit stuff:
886  */
887 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) \
888 {                                       \
889         len -= off;                     \
890         if (len < count) {              \
891                 *eof = 1;               \
892                 if (len <= 0)           \
893                         return 0;       \
894         } else                          \
895                 len = count;            \
896         *start = page + off;            \
897         return len;                     \
898 }
899 #else
900 static inline void proc_ide_create(void) { ; }
901 static inline void proc_ide_destroy(void) { ; }
902 static inline void ide_proc_register_port(ide_hwif_t *hwif) { ; }
903 static inline void ide_proc_unregister_port(ide_hwif_t *hwif) { ; }
904 static inline void ide_proc_register_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
905 static inline void ide_proc_unregister_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
906 static inline void ide_add_generic_settings(ide_drive_t *drive) { ; }
907 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) return 0;
908 #endif
909
910 /*
911  * Power Management step value (rq->pm->pm_step).
912  *
913  * The step value starts at 0 (ide_pm_state_start_suspend) for a
914  * suspend operation or 1000 (ide_pm_state_start_resume) for a
915  * resume operation.
916  *
917  * For each step, the core calls the subdriver start_power_step() first.
918  * This can return:
919  *      - ide_stopped : In this case, the core calls us back again unless
920  *                      step have been set to ide_power_state_completed.
921  *      - ide_started : In this case, the channel is left busy until an
922  *                      async event (interrupt) occurs.
923  * Typically, start_power_step() will issue a taskfile request with
924  * do_rw_taskfile().
925  *
926  * Upon reception of the interrupt, the core will call complete_power_step()
927  * with the error code if any. This routine should update the step value
928  * and return. It should not start a new request. The core will call
929  * start_power_step for the new step value, unless step have been set to
930  * ide_power_state_completed.
931  *
932  * Subdrivers are expected to define their own additional power
933  * steps from 1..999 for suspend and from 1001..1999 for resume,
934  * other values are reserved for future use.
935  */
936
937 enum {
938         ide_pm_state_completed          = -1,
939         ide_pm_state_start_suspend      = 0,
940         ide_pm_state_start_resume       = 1000,
941 };
942
943 /*
944  * Subdrivers support.
945  *
946  * The gendriver.owner field should be set to the module owner of this driver.
947  * The gendriver.name field should be set to the name of this driver
948  */
949 struct ide_driver_s {
950         const char                      *version;
951         u8                              media;
952         unsigned supports_dsc_overlap   : 1;
953         ide_startstop_t (*do_request)(ide_drive_t *, struct request *, sector_t);
954         int             (*end_request)(ide_drive_t *, int, int);
955         ide_startstop_t (*error)(ide_drive_t *, struct request *rq, u8, u8);
956         ide_startstop_t (*abort)(ide_drive_t *, struct request *rq);
957         struct device_driver    gen_driver;
958         int             (*probe)(ide_drive_t *);
959         void            (*remove)(ide_drive_t *);
960         void            (*resume)(ide_drive_t *);
961         void            (*shutdown)(ide_drive_t *);
962 #ifdef CONFIG_IDE_PROC_FS
963         ide_proc_entry_t        *proc;
964 #endif
965 };
966
967 #define to_ide_driver(drv) container_of(drv, ide_driver_t, gen_driver)
968
969 int generic_ide_ioctl(ide_drive_t *, struct file *, struct block_device *, unsigned, unsigned long);
970
971 /*
972  * ide_hwifs[] is the master data structure used to keep track
973  * of just about everything in ide.c.  Whenever possible, routines
974  * should be using pointers to a drive (ide_drive_t *) or
975  * pointers to a hwif (ide_hwif_t *), rather than indexing this
976  * structure directly (the allocation/layout may change!).
977  *
978  */
979 #ifndef _IDE_C
980 extern  ide_hwif_t      ide_hwifs[];            /* master data repository */
981 #endif
982 extern int noautodma;
983
984 extern int ide_end_request (ide_drive_t *drive, int uptodate, int nrsecs);
985 int ide_end_dequeued_request(ide_drive_t *drive, struct request *rq,
986                              int uptodate, int nr_sectors);
987
988 extern void ide_set_handler (ide_drive_t *drive, ide_handler_t *handler, unsigned int timeout, ide_expiry_t *expiry);
989
990 void ide_execute_command(ide_drive_t *, u8, ide_handler_t *, unsigned int,
991                          ide_expiry_t *);
992
993 ide_startstop_t __ide_error(ide_drive_t *, struct request *, u8, u8);
994
995 ide_startstop_t ide_error (ide_drive_t *drive, const char *msg, byte stat);
996
997 ide_startstop_t __ide_abort(ide_drive_t *, struct request *);
998
999 extern ide_startstop_t ide_abort(ide_drive_t *, const char *);
1000
1001 extern void ide_fix_driveid(struct hd_driveid *);
1002
1003 extern void ide_fixstring(u8 *, const int, const int);
1004
1005 int ide_wait_stat(ide_startstop_t *, ide_drive_t *, u8, u8, unsigned long);
1006
1007 extern ide_startstop_t ide_do_reset (ide_drive_t *);
1008
1009 extern void ide_init_drive_cmd (struct request *rq);
1010
1011 /*
1012  * "action" parameter type for ide_do_drive_cmd() below.
1013  */
1014 typedef enum {
1015         ide_wait,       /* insert rq at end of list, and wait for it */
1016         ide_preempt,    /* insert rq in front of current request */
1017         ide_head_wait,  /* insert rq in front of current request and wait for it */
1018         ide_end         /* insert rq at end of list, but don't wait for it */
1019 } ide_action_t;
1020
1021 extern int ide_do_drive_cmd(ide_drive_t *, struct request *, ide_action_t);
1022
1023 extern void ide_end_drive_cmd(ide_drive_t *, u8, u8);
1024
1025 /*
1026  * Issue ATA command and wait for completion.
1027  * Use for implementing commands in kernel
1028  *
1029  *  (ide_drive_t *drive, u8 cmd, u8 nsect, u8 feature, u8 sectors, u8 *buf)
1030  */
1031 extern int ide_wait_cmd(ide_drive_t *, u8, u8, u8, u8, u8 *);
1032
1033 enum {
1034         IDE_TFLAG_LBA48                 = (1 << 0),
1035         IDE_TFLAG_NO_SELECT_MASK        = (1 << 1),
1036         IDE_TFLAG_FLAGGED               = (1 << 2),
1037         IDE_TFLAG_OUT_DATA              = (1 << 3),
1038         IDE_TFLAG_OUT_HOB_FEATURE       = (1 << 4),
1039         IDE_TFLAG_OUT_HOB_NSECT         = (1 << 5),
1040         IDE_TFLAG_OUT_HOB_LBAL          = (1 << 6),
1041         IDE_TFLAG_OUT_HOB_LBAM          = (1 << 7),
1042         IDE_TFLAG_OUT_HOB_LBAH          = (1 << 8),
1043         IDE_TFLAG_OUT_HOB               = IDE_TFLAG_OUT_HOB_FEATURE |
1044                                           IDE_TFLAG_OUT_HOB_NSECT |
1045                                           IDE_TFLAG_OUT_HOB_LBAL |
1046                                           IDE_TFLAG_OUT_HOB_LBAM |
1047                                           IDE_TFLAG_OUT_HOB_LBAH,
1048         IDE_TFLAG_OUT_FEATURE           = (1 << 9),
1049         IDE_TFLAG_OUT_NSECT             = (1 << 10),
1050         IDE_TFLAG_OUT_LBAL              = (1 << 11),
1051         IDE_TFLAG_OUT_LBAM              = (1 << 12),
1052         IDE_TFLAG_OUT_LBAH              = (1 << 13),
1053         IDE_TFLAG_OUT_TF                = IDE_TFLAG_OUT_FEATURE |
1054                                           IDE_TFLAG_OUT_NSECT |
1055                                           IDE_TFLAG_OUT_LBAL |
1056                                           IDE_TFLAG_OUT_LBAM |
1057                                           IDE_TFLAG_OUT_LBAH,
1058         IDE_TFLAG_OUT_DEVICE            = (1 << 14),
1059 };
1060
1061 struct ide_taskfile {
1062         u8      hob_data;       /*  0: high data byte (for TASKFILE IOCTL) */
1063
1064         u8      hob_feature;    /*  1-5: additional data to support LBA48 */
1065         u8      hob_nsect;
1066         u8      hob_lbal;
1067         u8      hob_lbam;
1068         u8      hob_lbah;
1069
1070         u8      data;           /*  6: low data byte (for TASKFILE IOCTL) */
1071
1072         union {                 /* Â 7: */
1073                 u8 error;       /*   read:  error */
1074                 u8 feature;     /*  write: feature */
1075         };
1076
1077         u8      nsect;          /*  8: number of sectors */
1078         u8      lbal;           /*  9: LBA low */
1079         u8      lbam;           /* 10: LBA mid */
1080         u8      lbah;           /* 11: LBA high */
1081
1082         u8      device;         /* 12: device select */
1083
1084         union {                 /* 13: */
1085                 u8 status;      /* Â read: status Â */
1086                 u8 command;     /* write: command */
1087         };
1088 };
1089
1090 typedef struct ide_task_s {
1091         union {
1092                 struct ide_taskfile     tf;
1093                 u8                      tf_array[14];
1094         };
1095         u16                     tf_flags;
1096         ide_reg_valid_t         tf_in_flags;
1097         int                     data_phase;
1098         int                     command_type;
1099         ide_pre_handler_t       *prehandler;
1100         ide_handler_t           *handler;
1101         struct request          *rq;            /* copy of request */
1102         void                    *special;       /* valid_t generally */
1103 } ide_task_t;
1104
1105 void ide_tf_load(ide_drive_t *, ide_task_t *);
1106
1107 extern u32 ide_read_24(ide_drive_t *);
1108
1109 extern void SELECT_DRIVE(ide_drive_t *);
1110 extern void SELECT_INTERRUPT(ide_drive_t *);
1111 extern void SELECT_MASK(ide_drive_t *, int);
1112 extern void QUIRK_LIST(ide_drive_t *);
1113
1114 extern int drive_is_ready(ide_drive_t *);
1115
1116 /*
1117  * taskfile io for disks for now...and builds request from ide_ioctl
1118  */
1119 extern ide_startstop_t do_rw_taskfile(ide_drive_t *, ide_task_t *);
1120
1121 /*
1122  * Special Flagged Register Validation Caller
1123  */
1124 extern ide_startstop_t flagged_taskfile(ide_drive_t *, ide_task_t *);
1125
1126 extern ide_startstop_t set_multmode_intr(ide_drive_t *);
1127 extern ide_startstop_t set_geometry_intr(ide_drive_t *);
1128 extern ide_startstop_t recal_intr(ide_drive_t *);
1129 extern ide_startstop_t task_no_data_intr(ide_drive_t *);
1130 extern ide_startstop_t task_in_intr(ide_drive_t *);
1131 extern ide_startstop_t pre_task_out_intr(ide_drive_t *, struct request *);
1132
1133 extern int ide_raw_taskfile(ide_drive_t *, ide_task_t *, u8 *);
1134
1135 int ide_no_data_taskfile(ide_drive_t *, ide_task_t *);
1136
1137 int ide_taskfile_ioctl(ide_drive_t *, unsigned int, unsigned long);
1138 int ide_cmd_ioctl(ide_drive_t *, unsigned int, unsigned long);
1139 int ide_task_ioctl(ide_drive_t *, unsigned int, unsigned long);
1140
1141 extern int system_bus_clock(void);
1142
1143 extern int ide_driveid_update(ide_drive_t *);
1144 extern int ide_ata66_check(ide_drive_t *, ide_task_t *);
1145 extern int ide_config_drive_speed(ide_drive_t *, u8);
1146 extern u8 eighty_ninty_three (ide_drive_t *);
1147 extern int set_transfer(ide_drive_t *, ide_task_t *);
1148 extern int taskfile_lib_get_identify(ide_drive_t *drive, u8 *);
1149
1150 extern int ide_wait_not_busy(ide_hwif_t *hwif, unsigned long timeout);
1151
1152 extern void ide_stall_queue(ide_drive_t *drive, unsigned long timeout);
1153
1154 extern int ide_spin_wait_hwgroup(ide_drive_t *);
1155 extern void ide_timer_expiry(unsigned long);
1156 extern irqreturn_t ide_intr(int irq, void *dev_id);
1157 extern void do_ide_request(struct request_queue *);
1158
1159 void ide_init_disk(struct gendisk *, ide_drive_t *);
1160
1161 extern int ideprobe_init(void);
1162
1163 #ifdef CONFIG_IDEPCI_PCIBUS_ORDER
1164 extern void ide_scan_pcibus(int scan_direction) __init;
1165 extern int __ide_pci_register_driver(struct pci_driver *driver, struct module *owner, const char *mod_name);
1166 #define ide_pci_register_driver(d) __ide_pci_register_driver(d, THIS_MODULE, KBUILD_MODNAME)
1167 #else
1168 #define ide_pci_register_driver(d) pci_register_driver(d)
1169 #endif
1170
1171 void ide_pci_setup_ports(struct pci_dev *, const struct ide_port_info *, int, u8 *);
1172 void ide_setup_pci_noise(struct pci_dev *, const struct ide_port_info *);
1173
1174 extern void default_hwif_iops(ide_hwif_t *);
1175 extern void default_hwif_mmiops(ide_hwif_t *);
1176 extern void default_hwif_transport(ide_hwif_t *);
1177
1178 typedef struct ide_pci_enablebit_s {
1179         u8      reg;    /* byte pci reg holding the enable-bit */
1180         u8      mask;   /* mask to isolate the enable-bit */
1181         u8      val;    /* value of masked reg when "enabled" */
1182 } ide_pci_enablebit_t;
1183
1184 enum {
1185         /* Uses ISA control ports not PCI ones. */
1186         IDE_HFLAG_ISA_PORTS             = (1 << 0),
1187         /* single port device */
1188         IDE_HFLAG_SINGLE                = (1 << 1),
1189         /* don't use legacy PIO blacklist */
1190         IDE_HFLAG_PIO_NO_BLACKLIST      = (1 << 2),
1191         /* don't use conservative PIO "downgrade" */
1192         IDE_HFLAG_PIO_NO_DOWNGRADE      = (1 << 3),
1193         /* use PIO8/9 for prefetch off/on */
1194         IDE_HFLAG_ABUSE_PREFETCH        = (1 << 4),
1195         /* use PIO6/7 for fast-devsel off/on */
1196         IDE_HFLAG_ABUSE_FAST_DEVSEL     = (1 << 5),
1197         /* use 100-102 and 200-202 PIO values to set DMA modes */
1198         IDE_HFLAG_ABUSE_DMA_MODES       = (1 << 6),
1199         /*
1200          * keep DMA setting when programming PIO mode, may be used only
1201          * for hosts which have separate PIO and DMA timings (ie. PMAC)
1202          */
1203         IDE_HFLAG_SET_PIO_MODE_KEEP_DMA = (1 << 7),
1204         /* program host for the transfer mode after programming device */
1205         IDE_HFLAG_POST_SET_MODE         = (1 << 8),
1206         /* don't program host/device for the transfer mode ("smart" hosts) */
1207         IDE_HFLAG_NO_SET_MODE           = (1 << 9),
1208         /* trust BIOS for programming chipset/device for DMA */
1209         IDE_HFLAG_TRUST_BIOS_FOR_DMA    = (1 << 10),
1210         /* host uses VDMA */
1211         IDE_HFLAG_VDMA                  = (1 << 11),
1212         /* ATAPI DMA is unsupported */
1213         IDE_HFLAG_NO_ATAPI_DMA          = (1 << 12),
1214         /* set if host is a "bootable" controller */
1215         IDE_HFLAG_BOOTABLE              = (1 << 13),
1216         /* host doesn't support DMA */
1217         IDE_HFLAG_NO_DMA                = (1 << 14),
1218         /* check if host is PCI IDE device before allowing DMA */
1219         IDE_HFLAG_NO_AUTODMA            = (1 << 15),
1220         /* host is CS5510/CS5520 */
1221         IDE_HFLAG_CS5520                = (1 << 16),
1222         /* no LBA48 */
1223         IDE_HFLAG_NO_LBA48              = (1 << 17),
1224         /* no LBA48 DMA */
1225         IDE_HFLAG_NO_LBA48_DMA          = (1 << 18),
1226         /* data FIFO is cleared by an error */
1227         IDE_HFLAG_ERROR_STOPS_FIFO      = (1 << 19),
1228         /* serialize ports */
1229         IDE_HFLAG_SERIALIZE             = (1 << 20),
1230         /* use legacy IRQs */
1231         IDE_HFLAG_LEGACY_IRQS           = (1 << 21),
1232         /* force use of legacy IRQs */
1233         IDE_HFLAG_FORCE_LEGACY_IRQS     = (1 << 22),
1234         /* limit LBA48 requests to 256 sectors */
1235         IDE_HFLAG_RQSIZE_256            = (1 << 23),
1236         /* use 32-bit I/O ops */
1237         IDE_HFLAG_IO_32BIT              = (1 << 24),
1238         /* unmask IRQs */
1239         IDE_HFLAG_UNMASK_IRQS           = (1 << 25),
1240 };
1241
1242 #ifdef CONFIG_BLK_DEV_OFFBOARD
1243 # define IDE_HFLAG_OFF_BOARD    IDE_HFLAG_BOOTABLE
1244 #else
1245 # define IDE_HFLAG_OFF_BOARD    0
1246 #endif
1247
1248 struct ide_port_info {
1249         char                    *name;
1250         unsigned int            (*init_chipset)(struct pci_dev *, const char *);
1251         void                    (*init_iops)(ide_hwif_t *);
1252         void                    (*init_hwif)(ide_hwif_t *);
1253         void                    (*init_dma)(ide_hwif_t *, unsigned long);
1254         void                    (*fixup)(ide_hwif_t *);
1255         ide_pci_enablebit_t     enablebits[2];
1256         hwif_chipset_t          chipset;
1257         unsigned int            extra;
1258         u32                     host_flags;
1259         u8                      pio_mask;
1260         u8                      swdma_mask;
1261         u8                      mwdma_mask;
1262         u8                      udma_mask;
1263 };
1264
1265 int ide_setup_pci_device(struct pci_dev *, const struct ide_port_info *);
1266 int ide_setup_pci_devices(struct pci_dev *, struct pci_dev *, const struct ide_port_info *);
1267
1268 void ide_map_sg(ide_drive_t *, struct request *);
1269 void ide_init_sg_cmd(ide_drive_t *, struct request *);
1270
1271 #define BAD_DMA_DRIVE           0
1272 #define GOOD_DMA_DRIVE          1
1273
1274 struct drive_list_entry {
1275         const char *id_model;
1276         const char *id_firmware;
1277 };
1278
1279 int ide_in_drive_list(struct hd_driveid *, const struct drive_list_entry *);
1280
1281 #ifdef CONFIG_BLK_DEV_IDEDMA
1282 int __ide_dma_bad_drive(ide_drive_t *);
1283 int ide_id_dma_bug(ide_drive_t *);
1284
1285 u8 ide_find_dma_mode(ide_drive_t *, u8);
1286
1287 static inline u8 ide_max_dma_mode(ide_drive_t *drive)
1288 {
1289         return ide_find_dma_mode(drive, XFER_UDMA_6);
1290 }
1291
1292 void ide_dma_off(ide_drive_t *);
1293 int ide_set_dma(ide_drive_t *);
1294 ide_startstop_t ide_dma_intr(ide_drive_t *);
1295
1296 #ifdef CONFIG_BLK_DEV_IDEDMA_PCI
1297 extern int ide_build_sglist(ide_drive_t *, struct request *);
1298 extern int ide_build_dmatable(ide_drive_t *, struct request *);
1299 extern void ide_destroy_dmatable(ide_drive_t *);
1300 extern int ide_release_dma(ide_hwif_t *);
1301 extern void ide_setup_dma(ide_hwif_t *, unsigned long, unsigned int);
1302
1303 void ide_dma_host_off(ide_drive_t *);
1304 void ide_dma_off_quietly(ide_drive_t *);
1305 void ide_dma_host_on(ide_drive_t *);
1306 extern int __ide_dma_on(ide_drive_t *);
1307 extern int ide_dma_setup(ide_drive_t *);
1308 extern void ide_dma_start(ide_drive_t *);
1309 extern int __ide_dma_end(ide_drive_t *);
1310 extern void ide_dma_lost_irq(ide_drive_t *);
1311 extern void ide_dma_timeout(ide_drive_t *);
1312 #endif /* CONFIG_BLK_DEV_IDEDMA_PCI */
1313
1314 #else
1315 static inline int ide_id_dma_bug(ide_drive_t *drive) { return 0; }
1316 static inline u8 ide_find_dma_mode(ide_drive_t *drive, u8 speed) { return 0; }
1317 static inline u8 ide_max_dma_mode(ide_drive_t *drive) { return 0; }
1318 static inline void ide_dma_off(ide_drive_t *drive) { ; }
1319 static inline void ide_dma_verbose(ide_drive_t *drive) { ; }
1320 static inline int ide_set_dma(ide_drive_t *drive) { return 1; }
1321 #endif /* CONFIG_BLK_DEV_IDEDMA */
1322
1323 #ifndef CONFIG_BLK_DEV_IDEDMA_PCI
1324 static inline void ide_release_dma(ide_hwif_t *drive) {;}
1325 #endif
1326
1327 #ifdef CONFIG_BLK_DEV_IDEACPI
1328 extern int ide_acpi_exec_tfs(ide_drive_t *drive);
1329 extern void ide_acpi_get_timing(ide_hwif_t *hwif);
1330 extern void ide_acpi_push_timing(ide_hwif_t *hwif);
1331 extern void ide_acpi_init(ide_hwif_t *hwif);
1332 extern void ide_acpi_set_state(ide_hwif_t *hwif, int on);
1333 #else
1334 static inline int ide_acpi_exec_tfs(ide_drive_t *drive) { return 0; }
1335 static inline void ide_acpi_get_timing(ide_hwif_t *hwif) { ; }
1336 static inline void ide_acpi_push_timing(ide_hwif_t *hwif) { ; }
1337 static inline void ide_acpi_init(ide_hwif_t *hwif) { ; }
1338 static inline void ide_acpi_set_state(ide_hwif_t *hwif, int on) {}
1339 #endif
1340
1341 extern int ide_hwif_request_regions(ide_hwif_t *hwif);
1342 extern void ide_hwif_release_regions(ide_hwif_t* hwif);
1343 extern void ide_unregister (unsigned int index);
1344
1345 void ide_register_region(struct gendisk *);
1346 void ide_unregister_region(struct gendisk *);
1347
1348 void ide_undecoded_slave(ide_hwif_t *);
1349
1350 int ide_device_add(u8 idx[4]);
1351
1352 static inline void *ide_get_hwifdata (ide_hwif_t * hwif)
1353 {
1354         return hwif->hwif_data;
1355 }
1356
1357 static inline void ide_set_hwifdata (ide_hwif_t * hwif, void *data)
1358 {
1359         hwif->hwif_data = data;
1360 }
1361
1362 const char *ide_xfer_verbose(u8 mode);
1363 extern void ide_toggle_bounce(ide_drive_t *drive, int on);
1364 extern int ide_set_xfer_rate(ide_drive_t *drive, u8 rate);
1365
1366 static inline int ide_dev_has_iordy(struct hd_driveid *id)
1367 {
1368         return ((id->field_valid & 2) && (id->capability & 8)) ? 1 : 0;
1369 }
1370
1371 static inline int ide_dev_is_sata(struct hd_driveid *id)
1372 {
1373         /*
1374          * See if word 93 is 0 AND drive is at least ATA-5 compatible
1375          * verifying that word 80 by casting it to a signed type --
1376          * this trick allows us to filter out the reserved values of
1377          * 0x0000 and 0xffff along with the earlier ATA revisions...
1378          */
1379         if (id->hw_config == 0 && (short)id->major_rev_num >= 0x0020)
1380                 return 1;
1381         return 0;
1382 }
1383
1384 u8 ide_dump_status(ide_drive_t *, const char *, u8);
1385
1386 typedef struct ide_pio_timings_s {
1387         int     setup_time;     /* Address setup (ns) minimum */
1388         int     active_time;    /* Active pulse (ns) minimum */
1389         int     cycle_time;     /* Cycle time (ns) minimum = */
1390                                 /* active + recovery (+ setup for some chips) */
1391 } ide_pio_timings_t;
1392
1393 unsigned int ide_pio_cycle_time(ide_drive_t *, u8);
1394 u8 ide_get_best_pio_mode(ide_drive_t *, u8, u8);
1395 extern const ide_pio_timings_t ide_pio_timings[6];
1396
1397 int ide_set_pio_mode(ide_drive_t *, u8);
1398 int ide_set_dma_mode(ide_drive_t *, u8);
1399
1400 void ide_set_pio(ide_drive_t *, u8);
1401
1402 static inline void ide_set_max_pio(ide_drive_t *drive)
1403 {
1404         ide_set_pio(drive, 255);
1405 }
1406
1407 extern spinlock_t ide_lock;
1408 extern struct mutex ide_cfg_mtx;
1409 /*
1410  * Structure locking:
1411  *
1412  * ide_cfg_mtx and ide_lock together protect changes to
1413  * ide_hwif_t->{next,hwgroup}
1414  * ide_drive_t->next
1415  *
1416  * ide_hwgroup_t->busy: ide_lock
1417  * ide_hwgroup_t->hwif: ide_lock
1418  * ide_hwif_t->mate: constant, no locking
1419  * ide_drive_t->hwif: constant, no locking
1420  */
1421
1422 #define local_irq_set(flags)    do { local_save_flags((flags)); local_irq_enable_in_hardirq(); } while (0)
1423
1424 extern struct bus_type ide_bus_type;
1425
1426 /* check if CACHE FLUSH (EXT) command is supported (bits defined in ATA-6) */
1427 #define ide_id_has_flush_cache(id)      ((id)->cfs_enable_2 & 0x3000)
1428
1429 /* some Maxtor disks have bit 13 defined incorrectly so check bit 10 too */
1430 #define ide_id_has_flush_cache_ext(id)  \
1431         (((id)->cfs_enable_2 & 0x2400) == 0x2400)
1432
1433 static inline int hwif_to_node(ide_hwif_t *hwif)
1434 {
1435         struct pci_dev *dev = hwif->pci_dev;
1436         return dev ? pcibus_to_node(dev->bus) : -1;
1437 }
1438
1439 static inline ide_drive_t *ide_get_paired_drive(ide_drive_t *drive)
1440 {
1441         ide_hwif_t *hwif        = HWIF(drive);
1442
1443         return &hwif->drives[(drive->dn ^ 1) & 1];
1444 }
1445
1446 #endif /* _IDE_H */