]> Pileus Git - ~andy/linux/blob - include/linux/ide.h
921cf717f22a20cc3849408355b68933b7959e8a
[~andy/linux] / 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  * ATAPI Feature Register
370  *
371  * dma          : Using DMA or PIO
372  * reserved321  : Reserved
373  * reserved654  : Reserved (Tag Type)
374  * reserved7    : Reserved
375  */
376 typedef union {
377         unsigned all                    :8;
378         struct {
379 #if defined(__LITTLE_ENDIAN_BITFIELD)
380                 unsigned dma            :1;
381                 unsigned reserved321    :3;
382                 unsigned reserved654    :3;
383                 unsigned reserved7      :1;
384 #elif defined(__BIG_ENDIAN_BITFIELD)
385                 unsigned reserved7      :1;
386                 unsigned reserved654    :3;
387                 unsigned reserved321    :3;
388                 unsigned dma            :1;
389 #else
390 #error "Please fix <asm/byteorder.h>"
391 #endif
392         } b;
393 } atapi_feature_t;
394
395 /*
396  * ATAPI Interrupt Reason Register.
397  *
398  * cod          : Information transferred is command (1) or data (0)
399  * io           : The device requests us to read (1) or write (0)
400  * reserved     : Reserved
401  */
402 typedef union {
403         unsigned all                    :8;
404         struct {
405 #if defined(__LITTLE_ENDIAN_BITFIELD)
406                 unsigned cod            :1;
407                 unsigned io             :1;
408                 unsigned reserved       :6;
409 #elif defined(__BIG_ENDIAN_BITFIELD)
410                 unsigned reserved       :6;
411                 unsigned io             :1;
412                 unsigned cod            :1;
413 #else
414 #error "Please fix <asm/byteorder.h>"
415 #endif
416         } b;
417 } atapi_ireason_t;
418
419 /*
420  * The ATAPI error register.
421  *
422  * ili          : Illegal Length Indication
423  * eom          : End Of Media Detected
424  * abrt         : Aborted command - As defined by ATA
425  * mcr          : Media Change Requested - As defined by ATA
426  * sense_key    : Sense key of the last failed packet command
427  */
428 typedef union {
429         unsigned all                    :8;
430         struct {
431 #if defined(__LITTLE_ENDIAN_BITFIELD)
432                 unsigned ili            :1;
433                 unsigned eom            :1;
434                 unsigned abrt           :1;
435                 unsigned mcr            :1;
436                 unsigned sense_key      :4;
437 #elif defined(__BIG_ENDIAN_BITFIELD)
438                 unsigned sense_key      :4;
439                 unsigned mcr            :1;
440                 unsigned abrt           :1;
441                 unsigned eom            :1;
442                 unsigned ili            :1;
443 #else
444 #error "Please fix <asm/byteorder.h>"
445 #endif
446         } b;
447 } atapi_error_t;
448
449 /*
450  * Status returned from various ide_ functions
451  */
452 typedef enum {
453         ide_stopped,    /* no drive operation was started */
454         ide_started,    /* a drive operation was started, handler was set */
455 } ide_startstop_t;
456
457 struct ide_driver_s;
458 struct ide_settings_s;
459
460 #ifdef CONFIG_BLK_DEV_IDEACPI
461 struct ide_acpi_drive_link;
462 struct ide_acpi_hwif_link;
463 #endif
464
465 typedef struct ide_drive_s {
466         char            name[4];        /* drive name, such as "hda" */
467         char            driver_req[10]; /* requests specific driver */
468
469         struct request_queue    *queue; /* request queue */
470
471         struct request          *rq;    /* current request */
472         struct ide_drive_s      *next;  /* circular list of hwgroup drives */
473         void            *driver_data;   /* extra driver data */
474         struct hd_driveid       *id;    /* drive model identification info */
475 #ifdef CONFIG_IDE_PROC_FS
476         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
477         struct ide_settings_s *settings;/* /proc/ide/ drive settings */
478 #endif
479         struct hwif_s           *hwif;  /* actually (ide_hwif_t *) */
480
481         unsigned long sleep;            /* sleep until this time */
482         unsigned long service_start;    /* time we started last request */
483         unsigned long service_time;     /* service time of last request */
484         unsigned long timeout;          /* max time to wait for irq */
485
486         special_t       special;        /* special action flags */
487         select_t        select;         /* basic drive/head select reg value */
488
489         u8      keep_settings;          /* restore settings after drive reset */
490         u8      using_dma;              /* disk is using dma for read/write */
491         u8      retry_pio;              /* retrying dma capable host in pio */
492         u8      state;                  /* retry state */
493         u8      waiting_for_dma;        /* dma currently in progress */
494         u8      unmask;                 /* okay to unmask other irqs */
495         u8      bswap;                  /* byte swap data */
496         u8      noflush;                /* don't attempt flushes */
497         u8      dsc_overlap;            /* DSC overlap */
498         u8      nice1;                  /* give potential excess bandwidth */
499
500         unsigned present        : 1;    /* drive is physically present */
501         unsigned dead           : 1;    /* device ejected hint */
502         unsigned id_read        : 1;    /* 1=id read from disk 0 = synthetic */
503         unsigned noprobe        : 1;    /* from:  hdx=noprobe */
504         unsigned removable      : 1;    /* 1 if need to do check_media_change */
505         unsigned attach         : 1;    /* needed for removable devices */
506         unsigned forced_geom    : 1;    /* 1 if hdx=c,h,s was given at boot */
507         unsigned no_unmask      : 1;    /* disallow setting unmask bit */
508         unsigned no_io_32bit    : 1;    /* disallow enabling 32bit I/O */
509         unsigned atapi_overlap  : 1;    /* ATAPI overlap (not supported) */
510         unsigned nice0          : 1;    /* give obvious excess bandwidth */
511         unsigned nice2          : 1;    /* give a share in our own bandwidth */
512         unsigned doorlocking    : 1;    /* for removable only: door lock/unlock works */
513         unsigned nodma          : 1;    /* disallow DMA */
514         unsigned autotune       : 2;    /* 0=default, 1=autotune, 2=noautotune */
515         unsigned remap_0_to_1   : 1;    /* 0=noremap, 1=remap 0->1 (for EZDrive) */
516         unsigned blocked        : 1;    /* 1=powermanagment told us not to do anything, so sleep nicely */
517         unsigned vdma           : 1;    /* 1=doing PIO over DMA 0=doing normal DMA */
518         unsigned scsi           : 1;    /* 0=default, 1=ide-scsi emulation */
519         unsigned sleeping       : 1;    /* 1=sleeping & sleep field valid */
520         unsigned post_reset     : 1;
521         unsigned udma33_warned  : 1;
522
523         u8      addressing;     /* 0=28-bit, 1=48-bit, 2=48-bit doing 28-bit */
524         u8      quirk_list;     /* considered quirky, set for a specific host */
525         u8      init_speed;     /* transfer rate set at boot */
526         u8      current_speed;  /* current transfer rate set */
527         u8      desired_speed;  /* desired transfer rate set */
528         u8      dn;             /* now wide spread use */
529         u8      wcache;         /* status of write cache */
530         u8      acoustic;       /* acoustic management */
531         u8      media;          /* disk, cdrom, tape, floppy, ... */
532         u8      ctl;            /* "normal" value for IDE_CONTROL_REG */
533         u8      ready_stat;     /* min status value for drive ready */
534         u8      mult_count;     /* current multiple sector setting */
535         u8      mult_req;       /* requested multiple sector setting */
536         u8      tune_req;       /* requested drive tuning setting */
537         u8      io_32bit;       /* 0=16-bit, 1=32-bit, 2/3=32bit+sync */
538         u8      bad_wstat;      /* used for ignoring WRERR_STAT */
539         u8      nowerr;         /* used for ignoring WRERR_STAT */
540         u8      sect0;          /* offset of first sector for DM6:DDO */
541         u8      head;           /* "real" number of heads */
542         u8      sect;           /* "real" sectors per track */
543         u8      bios_head;      /* BIOS/fdisk/LILO number of heads */
544         u8      bios_sect;      /* BIOS/fdisk/LILO sectors per track */
545
546         unsigned int    bios_cyl;       /* BIOS/fdisk/LILO number of cyls */
547         unsigned int    cyl;            /* "real" number of cyls */
548         unsigned int    drive_data;     /* used by set_pio_mode/selectproc */
549         unsigned int    failures;       /* current failure count */
550         unsigned int    max_failures;   /* maximum allowed failure count */
551         u64             probed_capacity;/* initial reported media capacity (ide-cd only currently) */
552
553         u64             capacity64;     /* total number of sectors */
554
555         int             lun;            /* logical unit */
556         int             crc_count;      /* crc counter to reduce drive speed */
557 #ifdef CONFIG_BLK_DEV_IDEACPI
558         struct ide_acpi_drive_link *acpidata;
559 #endif
560         struct list_head list;
561         struct device   gendev;
562         struct completion gendev_rel_comp;      /* to deal with device release() */
563 } ide_drive_t;
564
565 #define to_ide_device(dev)container_of(dev, ide_drive_t, gendev)
566
567 #define IDE_CHIPSET_PCI_MASK    \
568     ((1<<ide_pci)|(1<<ide_cmd646)|(1<<ide_ali14xx))
569 #define IDE_CHIPSET_IS_PCI(c)   ((IDE_CHIPSET_PCI_MASK >> (c)) & 1)
570
571 struct ide_port_info;
572
573 typedef struct hwif_s {
574         struct hwif_s *next;            /* for linked-list in ide_hwgroup_t */
575         struct hwif_s *mate;            /* other hwif from same PCI chip */
576         struct hwgroup_s *hwgroup;      /* actually (ide_hwgroup_t *) */
577         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
578
579         char name[6];                   /* name of interface, eg. "ide0" */
580
581                 /* task file registers for pata and sata */
582         unsigned long   io_ports[IDE_NR_PORTS];
583         unsigned long   sata_scr[SATA_NR_PORTS];
584         unsigned long   sata_misc[SATA_NR_PORTS];
585
586         ide_drive_t     drives[MAX_DRIVES];     /* drive info */
587
588         u8 major;       /* our major number */
589         u8 index;       /* 0 for ide0; 1 for ide1; ... */
590         u8 channel;     /* for dual-port chips: 0=primary, 1=secondary */
591         u8 straight8;   /* Alan's straight 8 check */
592         u8 bus_state;   /* power state of the IDE bus */
593
594         u32 host_flags;
595
596         u8 pio_mask;
597
598         u8 ultra_mask;
599         u8 mwdma_mask;
600         u8 swdma_mask;
601
602         u8 cbl;         /* cable type */
603
604         hwif_chipset_t chipset; /* sub-module for tuning.. */
605
606         struct pci_dev  *pci_dev;       /* for pci chipsets */
607         const struct ide_port_info *cds;        /* chipset device struct */
608
609         ide_ack_intr_t *ack_intr;
610
611         void (*rw_disk)(ide_drive_t *, struct request *);
612
613 #if 0
614         ide_hwif_ops_t  *hwifops;
615 #else
616         /* routine to program host for PIO mode */
617         void    (*set_pio_mode)(ide_drive_t *, const u8);
618         /* routine to program host for DMA mode */
619         void    (*set_dma_mode)(ide_drive_t *, const u8);
620         /* tweaks hardware to select drive */
621         void    (*selectproc)(ide_drive_t *);
622         /* chipset polling based on hba specifics */
623         int     (*reset_poll)(ide_drive_t *);
624         /* chipset specific changes to default for device-hba resets */
625         void    (*pre_reset)(ide_drive_t *);
626         /* routine to reset controller after a disk reset */
627         void    (*resetproc)(ide_drive_t *);
628         /* special interrupt handling for shared pci interrupts */
629         void    (*intrproc)(ide_drive_t *);
630         /* special host masking for drive selection */
631         void    (*maskproc)(ide_drive_t *, int);
632         /* check host's drive quirk list */
633         int     (*quirkproc)(ide_drive_t *);
634         /* driver soft-power interface */
635         int     (*busproc)(ide_drive_t *, int);
636 #endif
637         u8 (*mdma_filter)(ide_drive_t *);
638         u8 (*udma_filter)(ide_drive_t *);
639
640         void (*fixup)(struct hwif_s *);
641
642         void (*ata_input_data)(ide_drive_t *, void *, u32);
643         void (*ata_output_data)(ide_drive_t *, void *, u32);
644
645         void (*atapi_input_bytes)(ide_drive_t *, void *, u32);
646         void (*atapi_output_bytes)(ide_drive_t *, void *, u32);
647
648         int (*dma_setup)(ide_drive_t *);
649         void (*dma_exec_cmd)(ide_drive_t *, u8);
650         void (*dma_start)(ide_drive_t *);
651         int (*ide_dma_end)(ide_drive_t *drive);
652         int (*ide_dma_on)(ide_drive_t *drive);
653         void (*dma_off_quietly)(ide_drive_t *drive);
654         int (*ide_dma_test_irq)(ide_drive_t *drive);
655         void (*ide_dma_clear_irq)(ide_drive_t *drive);
656         void (*dma_host_on)(ide_drive_t *drive);
657         void (*dma_host_off)(ide_drive_t *drive);
658         void (*dma_lost_irq)(ide_drive_t *drive);
659         void (*dma_timeout)(ide_drive_t *drive);
660
661         void (*OUTB)(u8 addr, unsigned long port);
662         void (*OUTBSYNC)(ide_drive_t *drive, u8 addr, unsigned long port);
663         void (*OUTW)(u16 addr, unsigned long port);
664         void (*OUTSW)(unsigned long port, void *addr, u32 count);
665         void (*OUTSL)(unsigned long port, void *addr, u32 count);
666
667         u8  (*INB)(unsigned long port);
668         u16 (*INW)(unsigned long port);
669         void (*INSW)(unsigned long port, void *addr, u32 count);
670         void (*INSL)(unsigned long port, void *addr, u32 count);
671
672         /* dma physical region descriptor table (cpu view) */
673         unsigned int    *dmatable_cpu;
674         /* dma physical region descriptor table (dma view) */
675         dma_addr_t      dmatable_dma;
676         /* Scatter-gather list used to build the above */
677         struct scatterlist *sg_table;
678         int sg_max_nents;               /* Maximum number of entries in it */
679         int sg_nents;                   /* Current number of entries in it */
680         int sg_dma_direction;           /* dma transfer direction */
681
682         /* data phase of the active command (currently only valid for PIO/DMA) */
683         int             data_phase;
684
685         unsigned int nsect;
686         unsigned int nleft;
687         struct scatterlist *cursg;
688         unsigned int cursg_ofs;
689
690         int             rqsize;         /* max sectors per request */
691         int             irq;            /* our irq number */
692
693         unsigned long   dma_base;       /* base addr for dma ports */
694         unsigned long   dma_command;    /* dma command register */
695         unsigned long   dma_vendor1;    /* dma vendor 1 register */
696         unsigned long   dma_status;     /* dma status register */
697         unsigned long   dma_vendor3;    /* dma vendor 3 register */
698         unsigned long   dma_prdtable;   /* actual prd table address */
699
700         unsigned long   config_data;    /* for use by chipset-specific code */
701         unsigned long   select_data;    /* for use by chipset-specific code */
702
703         unsigned long   extra_base;     /* extra addr for dma ports */
704         unsigned        extra_ports;    /* number of extra dma ports */
705
706         unsigned        noprobe    : 1; /* don't probe for this interface */
707         unsigned        present    : 1; /* this interface exists */
708         unsigned        hold       : 1; /* this interface is always present */
709         unsigned        serialized : 1; /* serialized all channel operation */
710         unsigned        sharing_irq: 1; /* 1 = sharing irq with another hwif */
711         unsigned        reset      : 1; /* reset after probe */
712         unsigned        auto_poll  : 1; /* supports nop auto-poll */
713         unsigned        sg_mapped  : 1; /* sg_table and sg_nents are ready */
714         unsigned        no_io_32bit : 1; /* 1 = can not do 32-bit IO ops */
715         unsigned        mmio       : 1; /* host uses MMIO */
716
717         struct device   gendev;
718         struct completion gendev_rel_comp; /* To deal with device release() */
719
720         void            *hwif_data;     /* extra hwif data */
721
722         unsigned dma;
723
724 #ifdef CONFIG_BLK_DEV_IDEACPI
725         struct ide_acpi_hwif_link *acpidata;
726 #endif
727 } ____cacheline_internodealigned_in_smp ide_hwif_t;
728
729 /*
730  *  internal ide interrupt handler type
731  */
732 typedef ide_startstop_t (ide_pre_handler_t)(ide_drive_t *, struct request *);
733 typedef ide_startstop_t (ide_handler_t)(ide_drive_t *);
734 typedef int (ide_expiry_t)(ide_drive_t *);
735
736 typedef struct hwgroup_s {
737                 /* irq handler, if active */
738         ide_startstop_t (*handler)(ide_drive_t *);
739                 /* irq handler, suspended if active */
740         ide_startstop_t (*handler_save)(ide_drive_t *);
741                 /* BOOL: protects all fields below */
742         volatile int busy;
743                 /* BOOL: wake us up on timer expiry */
744         unsigned int sleeping   : 1;
745                 /* BOOL: polling active & poll_timeout field valid */
746         unsigned int polling    : 1;
747                 /* BOOL: in a polling reset situation. Must not trigger another reset yet */
748         unsigned int resetting  : 1;
749
750                 /* current drive */
751         ide_drive_t *drive;
752                 /* ptr to current hwif in linked-list */
753         ide_hwif_t *hwif;
754
755                 /* for pci chipsets */
756         struct pci_dev *pci_dev;
757
758                 /* current request */
759         struct request *rq;
760                 /* failsafe timer */
761         struct timer_list timer;
762                 /* local copy of current write rq */
763         struct request wrq;
764                 /* timeout value during long polls */
765         unsigned long poll_timeout;
766                 /* queried upon timeouts */
767         int (*expiry)(ide_drive_t *);
768                 /* ide_system_bus_speed */
769         int pio_clock;
770         int req_gen;
771         int req_gen_timer;
772
773         unsigned char cmd_buf[4];
774 } ide_hwgroup_t;
775
776 typedef struct ide_driver_s ide_driver_t;
777
778 extern struct mutex ide_setting_mtx;
779
780 int set_io_32bit(ide_drive_t *, int);
781 int set_pio_mode(ide_drive_t *, int);
782 int set_using_dma(ide_drive_t *, int);
783
784 #ifdef CONFIG_IDE_PROC_FS
785 /*
786  * configurable drive settings
787  */
788
789 #define TYPE_INT        0
790 #define TYPE_BYTE       1
791 #define TYPE_SHORT      2
792
793 #define SETTING_READ    (1 << 0)
794 #define SETTING_WRITE   (1 << 1)
795 #define SETTING_RW      (SETTING_READ | SETTING_WRITE)
796
797 typedef int (ide_procset_t)(ide_drive_t *, int);
798 typedef struct ide_settings_s {
799         char                    *name;
800         int                     rw;
801         int                     data_type;
802         int                     min;
803         int                     max;
804         int                     mul_factor;
805         int                     div_factor;
806         void                    *data;
807         ide_procset_t           *set;
808         int                     auto_remove;
809         struct ide_settings_s   *next;
810 } ide_settings_t;
811
812 int ide_add_setting(ide_drive_t *, const char *, int, int, int, int, int, int, void *, ide_procset_t *set);
813
814 /*
815  * /proc/ide interface
816  */
817 typedef struct {
818         const char      *name;
819         mode_t          mode;
820         read_proc_t     *read_proc;
821         write_proc_t    *write_proc;
822 } ide_proc_entry_t;
823
824 void proc_ide_create(void);
825 void proc_ide_destroy(void);
826 void ide_proc_register_port(ide_hwif_t *);
827 void ide_proc_unregister_port(ide_hwif_t *);
828 void ide_proc_register_driver(ide_drive_t *, ide_driver_t *);
829 void ide_proc_unregister_driver(ide_drive_t *, ide_driver_t *);
830
831 void ide_add_generic_settings(ide_drive_t *);
832
833 read_proc_t proc_ide_read_capacity;
834 read_proc_t proc_ide_read_geometry;
835
836 #ifdef CONFIG_BLK_DEV_IDEPCI
837 void ide_pci_create_host_proc(const char *, get_info_t *);
838 #endif
839
840 /*
841  * Standard exit stuff:
842  */
843 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) \
844 {                                       \
845         len -= off;                     \
846         if (len < count) {              \
847                 *eof = 1;               \
848                 if (len <= 0)           \
849                         return 0;       \
850         } else                          \
851                 len = count;            \
852         *start = page + off;            \
853         return len;                     \
854 }
855 #else
856 static inline void proc_ide_create(void) { ; }
857 static inline void proc_ide_destroy(void) { ; }
858 static inline void ide_proc_register_port(ide_hwif_t *hwif) { ; }
859 static inline void ide_proc_unregister_port(ide_hwif_t *hwif) { ; }
860 static inline void ide_proc_register_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
861 static inline void ide_proc_unregister_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
862 static inline void ide_add_generic_settings(ide_drive_t *drive) { ; }
863 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) return 0;
864 #endif
865
866 /*
867  * Power Management step value (rq->pm->pm_step).
868  *
869  * The step value starts at 0 (ide_pm_state_start_suspend) for a
870  * suspend operation or 1000 (ide_pm_state_start_resume) for a
871  * resume operation.
872  *
873  * For each step, the core calls the subdriver start_power_step() first.
874  * This can return:
875  *      - ide_stopped : In this case, the core calls us back again unless
876  *                      step have been set to ide_power_state_completed.
877  *      - ide_started : In this case, the channel is left busy until an
878  *                      async event (interrupt) occurs.
879  * Typically, start_power_step() will issue a taskfile request with
880  * do_rw_taskfile().
881  *
882  * Upon reception of the interrupt, the core will call complete_power_step()
883  * with the error code if any. This routine should update the step value
884  * and return. It should not start a new request. The core will call
885  * start_power_step for the new step value, unless step have been set to
886  * ide_power_state_completed.
887  *
888  * Subdrivers are expected to define their own additional power
889  * steps from 1..999 for suspend and from 1001..1999 for resume,
890  * other values are reserved for future use.
891  */
892
893 enum {
894         ide_pm_state_completed          = -1,
895         ide_pm_state_start_suspend      = 0,
896         ide_pm_state_start_resume       = 1000,
897 };
898
899 /*
900  * Subdrivers support.
901  *
902  * The gendriver.owner field should be set to the module owner of this driver.
903  * The gendriver.name field should be set to the name of this driver
904  */
905 struct ide_driver_s {
906         const char                      *version;
907         u8                              media;
908         unsigned supports_dsc_overlap   : 1;
909         ide_startstop_t (*do_request)(ide_drive_t *, struct request *, sector_t);
910         int             (*end_request)(ide_drive_t *, int, int);
911         ide_startstop_t (*error)(ide_drive_t *, struct request *rq, u8, u8);
912         ide_startstop_t (*abort)(ide_drive_t *, struct request *rq);
913         struct device_driver    gen_driver;
914         int             (*probe)(ide_drive_t *);
915         void            (*remove)(ide_drive_t *);
916         void            (*resume)(ide_drive_t *);
917         void            (*shutdown)(ide_drive_t *);
918 #ifdef CONFIG_IDE_PROC_FS
919         ide_proc_entry_t        *proc;
920 #endif
921 };
922
923 #define to_ide_driver(drv) container_of(drv, ide_driver_t, gen_driver)
924
925 int generic_ide_ioctl(ide_drive_t *, struct file *, struct block_device *, unsigned, unsigned long);
926
927 /*
928  * ide_hwifs[] is the master data structure used to keep track
929  * of just about everything in ide.c.  Whenever possible, routines
930  * should be using pointers to a drive (ide_drive_t *) or
931  * pointers to a hwif (ide_hwif_t *), rather than indexing this
932  * structure directly (the allocation/layout may change!).
933  *
934  */
935 #ifndef _IDE_C
936 extern  ide_hwif_t      ide_hwifs[];            /* master data repository */
937 #endif
938 extern int noautodma;
939
940 extern int ide_end_request (ide_drive_t *drive, int uptodate, int nrsecs);
941 int ide_end_dequeued_request(ide_drive_t *drive, struct request *rq,
942                              int uptodate, int nr_sectors);
943
944 extern void ide_set_handler (ide_drive_t *drive, ide_handler_t *handler, unsigned int timeout, ide_expiry_t *expiry);
945
946 void ide_execute_command(ide_drive_t *, u8, ide_handler_t *, unsigned int,
947                          ide_expiry_t *);
948
949 ide_startstop_t __ide_error(ide_drive_t *, struct request *, u8, u8);
950
951 ide_startstop_t ide_error (ide_drive_t *drive, const char *msg, byte stat);
952
953 ide_startstop_t __ide_abort(ide_drive_t *, struct request *);
954
955 extern ide_startstop_t ide_abort(ide_drive_t *, const char *);
956
957 extern void ide_fix_driveid(struct hd_driveid *);
958
959 extern void ide_fixstring(u8 *, const int, const int);
960
961 int ide_wait_stat(ide_startstop_t *, ide_drive_t *, u8, u8, unsigned long);
962
963 extern ide_startstop_t ide_do_reset (ide_drive_t *);
964
965 extern void ide_init_drive_cmd (struct request *rq);
966
967 /*
968  * "action" parameter type for ide_do_drive_cmd() below.
969  */
970 typedef enum {
971         ide_wait,       /* insert rq at end of list, and wait for it */
972         ide_preempt,    /* insert rq in front of current request */
973         ide_head_wait,  /* insert rq in front of current request and wait for it */
974         ide_end         /* insert rq at end of list, but don't wait for it */
975 } ide_action_t;
976
977 extern int ide_do_drive_cmd(ide_drive_t *, struct request *, ide_action_t);
978
979 extern void ide_end_drive_cmd(ide_drive_t *, u8, u8);
980
981 /*
982  * Issue ATA command and wait for completion.
983  * Use for implementing commands in kernel
984  *
985  *  (ide_drive_t *drive, u8 cmd, u8 nsect, u8 feature, u8 sectors, u8 *buf)
986  */
987 extern int ide_wait_cmd(ide_drive_t *, u8, u8, u8, u8, u8 *);
988
989 enum {
990         IDE_TFLAG_LBA48                 = (1 << 0),
991         IDE_TFLAG_NO_SELECT_MASK        = (1 << 1),
992         IDE_TFLAG_FLAGGED               = (1 << 2),
993         IDE_TFLAG_OUT_DATA              = (1 << 3),
994         IDE_TFLAG_OUT_HOB_FEATURE       = (1 << 4),
995         IDE_TFLAG_OUT_HOB_NSECT         = (1 << 5),
996         IDE_TFLAG_OUT_HOB_LBAL          = (1 << 6),
997         IDE_TFLAG_OUT_HOB_LBAM          = (1 << 7),
998         IDE_TFLAG_OUT_HOB_LBAH          = (1 << 8),
999         IDE_TFLAG_OUT_HOB               = IDE_TFLAG_OUT_HOB_FEATURE |
1000                                           IDE_TFLAG_OUT_HOB_NSECT |
1001                                           IDE_TFLAG_OUT_HOB_LBAL |
1002                                           IDE_TFLAG_OUT_HOB_LBAM |
1003                                           IDE_TFLAG_OUT_HOB_LBAH,
1004         IDE_TFLAG_OUT_FEATURE           = (1 << 9),
1005         IDE_TFLAG_OUT_NSECT             = (1 << 10),
1006         IDE_TFLAG_OUT_LBAL              = (1 << 11),
1007         IDE_TFLAG_OUT_LBAM              = (1 << 12),
1008         IDE_TFLAG_OUT_LBAH              = (1 << 13),
1009         IDE_TFLAG_OUT_TF                = IDE_TFLAG_OUT_FEATURE |
1010                                           IDE_TFLAG_OUT_NSECT |
1011                                           IDE_TFLAG_OUT_LBAL |
1012                                           IDE_TFLAG_OUT_LBAM |
1013                                           IDE_TFLAG_OUT_LBAH,
1014         IDE_TFLAG_OUT_DEVICE            = (1 << 14),
1015 };
1016
1017 struct ide_taskfile {
1018         u8      hob_data;       /*  0: high data byte (for TASKFILE IOCTL) */
1019
1020         u8      hob_feature;    /*  1-5: additional data to support LBA48 */
1021         u8      hob_nsect;
1022         u8      hob_lbal;
1023         u8      hob_lbam;
1024         u8      hob_lbah;
1025
1026         u8      data;           /*  6: low data byte (for TASKFILE IOCTL) */
1027
1028         union {                 /* Â 7: */
1029                 u8 error;       /*   read:  error */
1030                 u8 feature;     /*  write: feature */
1031         };
1032
1033         u8      nsect;          /*  8: number of sectors */
1034         u8      lbal;           /*  9: LBA low */
1035         u8      lbam;           /* 10: LBA mid */
1036         u8      lbah;           /* 11: LBA high */
1037
1038         u8      device;         /* 12: device select */
1039
1040         union {                 /* 13: */
1041                 u8 status;      /* Â read: status Â */
1042                 u8 command;     /* write: command */
1043         };
1044 };
1045
1046 typedef struct ide_task_s {
1047         union {
1048                 struct ide_taskfile     tf;
1049                 u8                      tf_array[14];
1050         };
1051         u16                     tf_flags;
1052         ide_reg_valid_t         tf_in_flags;
1053         int                     data_phase;
1054         int                     command_type;
1055         ide_pre_handler_t       *prehandler;
1056         ide_handler_t           *handler;
1057         struct request          *rq;            /* copy of request */
1058         void                    *special;       /* valid_t generally */
1059 } ide_task_t;
1060
1061 void ide_tf_load(ide_drive_t *, ide_task_t *);
1062
1063 extern u32 ide_read_24(ide_drive_t *);
1064
1065 extern void SELECT_DRIVE(ide_drive_t *);
1066 extern void SELECT_INTERRUPT(ide_drive_t *);
1067 extern void SELECT_MASK(ide_drive_t *, int);
1068 extern void QUIRK_LIST(ide_drive_t *);
1069
1070 extern int drive_is_ready(ide_drive_t *);
1071
1072 /*
1073  * taskfile io for disks for now...and builds request from ide_ioctl
1074  */
1075 extern ide_startstop_t do_rw_taskfile(ide_drive_t *, ide_task_t *);
1076
1077 /*
1078  * Special Flagged Register Validation Caller
1079  */
1080 extern ide_startstop_t flagged_taskfile(ide_drive_t *, ide_task_t *);
1081
1082 extern ide_startstop_t set_multmode_intr(ide_drive_t *);
1083 extern ide_startstop_t set_geometry_intr(ide_drive_t *);
1084 extern ide_startstop_t recal_intr(ide_drive_t *);
1085 extern ide_startstop_t task_no_data_intr(ide_drive_t *);
1086 extern ide_startstop_t task_in_intr(ide_drive_t *);
1087 extern ide_startstop_t pre_task_out_intr(ide_drive_t *, struct request *);
1088
1089 extern int ide_raw_taskfile(ide_drive_t *, ide_task_t *, u8 *);
1090
1091 int ide_no_data_taskfile(ide_drive_t *, ide_task_t *);
1092
1093 int ide_taskfile_ioctl(ide_drive_t *, unsigned int, unsigned long);
1094 int ide_cmd_ioctl(ide_drive_t *, unsigned int, unsigned long);
1095 int ide_task_ioctl(ide_drive_t *, unsigned int, unsigned long);
1096
1097 extern int system_bus_clock(void);
1098
1099 extern int ide_driveid_update(ide_drive_t *);
1100 extern int ide_ata66_check(ide_drive_t *, ide_task_t *);
1101 extern int ide_config_drive_speed(ide_drive_t *, u8);
1102 extern u8 eighty_ninty_three (ide_drive_t *);
1103 extern int set_transfer(ide_drive_t *, ide_task_t *);
1104 extern int taskfile_lib_get_identify(ide_drive_t *drive, u8 *);
1105
1106 extern int ide_wait_not_busy(ide_hwif_t *hwif, unsigned long timeout);
1107
1108 extern void ide_stall_queue(ide_drive_t *drive, unsigned long timeout);
1109
1110 extern int ide_spin_wait_hwgroup(ide_drive_t *);
1111 extern void ide_timer_expiry(unsigned long);
1112 extern irqreturn_t ide_intr(int irq, void *dev_id);
1113 extern void do_ide_request(struct request_queue *);
1114
1115 void ide_init_disk(struct gendisk *, ide_drive_t *);
1116
1117 extern int ideprobe_init(void);
1118
1119 #ifdef CONFIG_IDEPCI_PCIBUS_ORDER
1120 extern void ide_scan_pcibus(int scan_direction) __init;
1121 extern int __ide_pci_register_driver(struct pci_driver *driver, struct module *owner, const char *mod_name);
1122 #define ide_pci_register_driver(d) __ide_pci_register_driver(d, THIS_MODULE, KBUILD_MODNAME)
1123 #else
1124 #define ide_pci_register_driver(d) pci_register_driver(d)
1125 #endif
1126
1127 void ide_pci_setup_ports(struct pci_dev *, const struct ide_port_info *, int, u8 *);
1128 void ide_setup_pci_noise(struct pci_dev *, const struct ide_port_info *);
1129
1130 extern void default_hwif_iops(ide_hwif_t *);
1131 extern void default_hwif_mmiops(ide_hwif_t *);
1132 extern void default_hwif_transport(ide_hwif_t *);
1133
1134 typedef struct ide_pci_enablebit_s {
1135         u8      reg;    /* byte pci reg holding the enable-bit */
1136         u8      mask;   /* mask to isolate the enable-bit */
1137         u8      val;    /* value of masked reg when "enabled" */
1138 } ide_pci_enablebit_t;
1139
1140 enum {
1141         /* Uses ISA control ports not PCI ones. */
1142         IDE_HFLAG_ISA_PORTS             = (1 << 0),
1143         /* single port device */
1144         IDE_HFLAG_SINGLE                = (1 << 1),
1145         /* don't use legacy PIO blacklist */
1146         IDE_HFLAG_PIO_NO_BLACKLIST      = (1 << 2),
1147         /* don't use conservative PIO "downgrade" */
1148         IDE_HFLAG_PIO_NO_DOWNGRADE      = (1 << 3),
1149         /* use PIO8/9 for prefetch off/on */
1150         IDE_HFLAG_ABUSE_PREFETCH        = (1 << 4),
1151         /* use PIO6/7 for fast-devsel off/on */
1152         IDE_HFLAG_ABUSE_FAST_DEVSEL     = (1 << 5),
1153         /* use 100-102 and 200-202 PIO values to set DMA modes */
1154         IDE_HFLAG_ABUSE_DMA_MODES       = (1 << 6),
1155         /*
1156          * keep DMA setting when programming PIO mode, may be used only
1157          * for hosts which have separate PIO and DMA timings (ie. PMAC)
1158          */
1159         IDE_HFLAG_SET_PIO_MODE_KEEP_DMA = (1 << 7),
1160         /* program host for the transfer mode after programming device */
1161         IDE_HFLAG_POST_SET_MODE         = (1 << 8),
1162         /* don't program host/device for the transfer mode ("smart" hosts) */
1163         IDE_HFLAG_NO_SET_MODE           = (1 << 9),
1164         /* trust BIOS for programming chipset/device for DMA */
1165         IDE_HFLAG_TRUST_BIOS_FOR_DMA    = (1 << 10),
1166         /* host uses VDMA */
1167         IDE_HFLAG_VDMA                  = (1 << 11),
1168         /* ATAPI DMA is unsupported */
1169         IDE_HFLAG_NO_ATAPI_DMA          = (1 << 12),
1170         /* set if host is a "bootable" controller */
1171         IDE_HFLAG_BOOTABLE              = (1 << 13),
1172         /* host doesn't support DMA */
1173         IDE_HFLAG_NO_DMA                = (1 << 14),
1174         /* check if host is PCI IDE device before allowing DMA */
1175         IDE_HFLAG_NO_AUTODMA            = (1 << 15),
1176         /* host is CS5510/CS5520 */
1177         IDE_HFLAG_CS5520                = (1 << 16),
1178         /* no LBA48 */
1179         IDE_HFLAG_NO_LBA48              = (1 << 17),
1180         /* no LBA48 DMA */
1181         IDE_HFLAG_NO_LBA48_DMA          = (1 << 18),
1182         /* data FIFO is cleared by an error */
1183         IDE_HFLAG_ERROR_STOPS_FIFO      = (1 << 19),
1184         /* serialize ports */
1185         IDE_HFLAG_SERIALIZE             = (1 << 20),
1186         /* use legacy IRQs */
1187         IDE_HFLAG_LEGACY_IRQS           = (1 << 21),
1188         /* force use of legacy IRQs */
1189         IDE_HFLAG_FORCE_LEGACY_IRQS     = (1 << 22),
1190         /* limit LBA48 requests to 256 sectors */
1191         IDE_HFLAG_RQSIZE_256            = (1 << 23),
1192         /* use 32-bit I/O ops */
1193         IDE_HFLAG_IO_32BIT              = (1 << 24),
1194         /* unmask IRQs */
1195         IDE_HFLAG_UNMASK_IRQS           = (1 << 25),
1196 };
1197
1198 #ifdef CONFIG_BLK_DEV_OFFBOARD
1199 # define IDE_HFLAG_OFF_BOARD    IDE_HFLAG_BOOTABLE
1200 #else
1201 # define IDE_HFLAG_OFF_BOARD    0
1202 #endif
1203
1204 struct ide_port_info {
1205         char                    *name;
1206         unsigned int            (*init_chipset)(struct pci_dev *, const char *);
1207         void                    (*init_iops)(ide_hwif_t *);
1208         void                    (*init_hwif)(ide_hwif_t *);
1209         void                    (*init_dma)(ide_hwif_t *, unsigned long);
1210         void                    (*fixup)(ide_hwif_t *);
1211         ide_pci_enablebit_t     enablebits[2];
1212         hwif_chipset_t          chipset;
1213         unsigned int            extra;
1214         u32                     host_flags;
1215         u8                      pio_mask;
1216         u8                      swdma_mask;
1217         u8                      mwdma_mask;
1218         u8                      udma_mask;
1219 };
1220
1221 int ide_setup_pci_device(struct pci_dev *, const struct ide_port_info *);
1222 int ide_setup_pci_devices(struct pci_dev *, struct pci_dev *, const struct ide_port_info *);
1223
1224 void ide_map_sg(ide_drive_t *, struct request *);
1225 void ide_init_sg_cmd(ide_drive_t *, struct request *);
1226
1227 #define BAD_DMA_DRIVE           0
1228 #define GOOD_DMA_DRIVE          1
1229
1230 struct drive_list_entry {
1231         const char *id_model;
1232         const char *id_firmware;
1233 };
1234
1235 int ide_in_drive_list(struct hd_driveid *, const struct drive_list_entry *);
1236
1237 #ifdef CONFIG_BLK_DEV_IDEDMA
1238 int __ide_dma_bad_drive(ide_drive_t *);
1239 int ide_id_dma_bug(ide_drive_t *);
1240
1241 u8 ide_find_dma_mode(ide_drive_t *, u8);
1242
1243 static inline u8 ide_max_dma_mode(ide_drive_t *drive)
1244 {
1245         return ide_find_dma_mode(drive, XFER_UDMA_6);
1246 }
1247
1248 void ide_dma_off(ide_drive_t *);
1249 int ide_set_dma(ide_drive_t *);
1250 ide_startstop_t ide_dma_intr(ide_drive_t *);
1251
1252 #ifdef CONFIG_BLK_DEV_IDEDMA_PCI
1253 extern int ide_build_sglist(ide_drive_t *, struct request *);
1254 extern int ide_build_dmatable(ide_drive_t *, struct request *);
1255 extern void ide_destroy_dmatable(ide_drive_t *);
1256 extern int ide_release_dma(ide_hwif_t *);
1257 extern void ide_setup_dma(ide_hwif_t *, unsigned long, unsigned int);
1258
1259 void ide_dma_host_off(ide_drive_t *);
1260 void ide_dma_off_quietly(ide_drive_t *);
1261 void ide_dma_host_on(ide_drive_t *);
1262 extern int __ide_dma_on(ide_drive_t *);
1263 extern int ide_dma_setup(ide_drive_t *);
1264 extern void ide_dma_start(ide_drive_t *);
1265 extern int __ide_dma_end(ide_drive_t *);
1266 extern void ide_dma_lost_irq(ide_drive_t *);
1267 extern void ide_dma_timeout(ide_drive_t *);
1268 #endif /* CONFIG_BLK_DEV_IDEDMA_PCI */
1269
1270 #else
1271 static inline int ide_id_dma_bug(ide_drive_t *drive) { return 0; }
1272 static inline u8 ide_find_dma_mode(ide_drive_t *drive, u8 speed) { return 0; }
1273 static inline u8 ide_max_dma_mode(ide_drive_t *drive) { return 0; }
1274 static inline void ide_dma_off(ide_drive_t *drive) { ; }
1275 static inline void ide_dma_verbose(ide_drive_t *drive) { ; }
1276 static inline int ide_set_dma(ide_drive_t *drive) { return 1; }
1277 #endif /* CONFIG_BLK_DEV_IDEDMA */
1278
1279 #ifndef CONFIG_BLK_DEV_IDEDMA_PCI
1280 static inline void ide_release_dma(ide_hwif_t *drive) {;}
1281 #endif
1282
1283 #ifdef CONFIG_BLK_DEV_IDEACPI
1284 extern int ide_acpi_exec_tfs(ide_drive_t *drive);
1285 extern void ide_acpi_get_timing(ide_hwif_t *hwif);
1286 extern void ide_acpi_push_timing(ide_hwif_t *hwif);
1287 extern void ide_acpi_init(ide_hwif_t *hwif);
1288 extern void ide_acpi_set_state(ide_hwif_t *hwif, int on);
1289 #else
1290 static inline int ide_acpi_exec_tfs(ide_drive_t *drive) { return 0; }
1291 static inline void ide_acpi_get_timing(ide_hwif_t *hwif) { ; }
1292 static inline void ide_acpi_push_timing(ide_hwif_t *hwif) { ; }
1293 static inline void ide_acpi_init(ide_hwif_t *hwif) { ; }
1294 static inline void ide_acpi_set_state(ide_hwif_t *hwif, int on) {}
1295 #endif
1296
1297 extern int ide_hwif_request_regions(ide_hwif_t *hwif);
1298 extern void ide_hwif_release_regions(ide_hwif_t* hwif);
1299 extern void ide_unregister (unsigned int index);
1300
1301 void ide_register_region(struct gendisk *);
1302 void ide_unregister_region(struct gendisk *);
1303
1304 void ide_undecoded_slave(ide_hwif_t *);
1305
1306 int ide_device_add(u8 idx[4]);
1307
1308 static inline void *ide_get_hwifdata (ide_hwif_t * hwif)
1309 {
1310         return hwif->hwif_data;
1311 }
1312
1313 static inline void ide_set_hwifdata (ide_hwif_t * hwif, void *data)
1314 {
1315         hwif->hwif_data = data;
1316 }
1317
1318 const char *ide_xfer_verbose(u8 mode);
1319 extern void ide_toggle_bounce(ide_drive_t *drive, int on);
1320 extern int ide_set_xfer_rate(ide_drive_t *drive, u8 rate);
1321
1322 static inline int ide_dev_has_iordy(struct hd_driveid *id)
1323 {
1324         return ((id->field_valid & 2) && (id->capability & 8)) ? 1 : 0;
1325 }
1326
1327 static inline int ide_dev_is_sata(struct hd_driveid *id)
1328 {
1329         /*
1330          * See if word 93 is 0 AND drive is at least ATA-5 compatible
1331          * verifying that word 80 by casting it to a signed type --
1332          * this trick allows us to filter out the reserved values of
1333          * 0x0000 and 0xffff along with the earlier ATA revisions...
1334          */
1335         if (id->hw_config == 0 && (short)id->major_rev_num >= 0x0020)
1336                 return 1;
1337         return 0;
1338 }
1339
1340 u8 ide_dump_status(ide_drive_t *, const char *, u8);
1341
1342 typedef struct ide_pio_timings_s {
1343         int     setup_time;     /* Address setup (ns) minimum */
1344         int     active_time;    /* Active pulse (ns) minimum */
1345         int     cycle_time;     /* Cycle time (ns) minimum = */
1346                                 /* active + recovery (+ setup for some chips) */
1347 } ide_pio_timings_t;
1348
1349 unsigned int ide_pio_cycle_time(ide_drive_t *, u8);
1350 u8 ide_get_best_pio_mode(ide_drive_t *, u8, u8);
1351 extern const ide_pio_timings_t ide_pio_timings[6];
1352
1353 int ide_set_pio_mode(ide_drive_t *, u8);
1354 int ide_set_dma_mode(ide_drive_t *, u8);
1355
1356 void ide_set_pio(ide_drive_t *, u8);
1357
1358 static inline void ide_set_max_pio(ide_drive_t *drive)
1359 {
1360         ide_set_pio(drive, 255);
1361 }
1362
1363 extern spinlock_t ide_lock;
1364 extern struct mutex ide_cfg_mtx;
1365 /*
1366  * Structure locking:
1367  *
1368  * ide_cfg_mtx and ide_lock together protect changes to
1369  * ide_hwif_t->{next,hwgroup}
1370  * ide_drive_t->next
1371  *
1372  * ide_hwgroup_t->busy: ide_lock
1373  * ide_hwgroup_t->hwif: ide_lock
1374  * ide_hwif_t->mate: constant, no locking
1375  * ide_drive_t->hwif: constant, no locking
1376  */
1377
1378 #define local_irq_set(flags)    do { local_save_flags((flags)); local_irq_enable_in_hardirq(); } while (0)
1379
1380 extern struct bus_type ide_bus_type;
1381
1382 /* check if CACHE FLUSH (EXT) command is supported (bits defined in ATA-6) */
1383 #define ide_id_has_flush_cache(id)      ((id)->cfs_enable_2 & 0x3000)
1384
1385 /* some Maxtor disks have bit 13 defined incorrectly so check bit 10 too */
1386 #define ide_id_has_flush_cache_ext(id)  \
1387         (((id)->cfs_enable_2 & 0x2400) == 0x2400)
1388
1389 static inline int hwif_to_node(ide_hwif_t *hwif)
1390 {
1391         struct pci_dev *dev = hwif->pci_dev;
1392         return dev ? pcibus_to_node(dev->bus) : -1;
1393 }
1394
1395 static inline ide_drive_t *ide_get_paired_drive(ide_drive_t *drive)
1396 {
1397         ide_hwif_t *hwif        = HWIF(drive);
1398
1399         return &hwif->drives[(drive->dn ^ 1) & 1];
1400 }
1401
1402 #endif /* _IDE_H */