ide: remove drive->driveid
[linux-2.6.git] / include / linux / ide.h
1 #ifndef _IDE_H
2 #define _IDE_H
3 /*
4  *  linux/include/linux/ide.h
5  *
6  *  Copyright (C) 1994-2002  Linus Torvalds & authors
7  */
8
9 #include <linux/init.h>
10 #include <linux/ioport.h>
11 #include <linux/hdreg.h>
12 #include <linux/blkdev.h>
13 #include <linux/proc_fs.h>
14 #include <linux/interrupt.h>
15 #include <linux/bitops.h>
16 #include <linux/bio.h>
17 #include <linux/device.h>
18 #include <linux/pci.h>
19 #include <linux/completion.h>
20 #ifdef CONFIG_BLK_DEV_IDEACPI
21 #include <acpi/acpi.h>
22 #endif
23 #include <asm/byteorder.h>
24 #include <asm/system.h>
25 #include <asm/io.h>
26 #include <asm/mutex.h>
27
28 #if defined(CONFIG_CRIS) || defined(CONFIG_FRV)
29 # define SUPPORT_VLB_SYNC 0
30 #else
31 # define SUPPORT_VLB_SYNC 1
32 #endif
33
34 /*
35  * Used to indicate "no IRQ", should be a value that cannot be an IRQ
36  * number.
37  */
38  
39 #define IDE_NO_IRQ              (-1)
40
41 typedef unsigned char   byte;   /* used everywhere */
42
43 /*
44  * Probably not wise to fiddle with these
45  */
46 #define ERROR_MAX       8       /* Max read/write errors per sector */
47 #define ERROR_RESET     3       /* Reset controller every 4th retry */
48 #define ERROR_RECAL     1       /* Recalibrate every 2nd retry */
49
50 /*
51  * state flags
52  */
53
54 #define DMA_PIO_RETRY   1       /* retrying in PIO */
55
56 #define HWIF(drive)             ((ide_hwif_t *)((drive)->hwif))
57 #define HWGROUP(drive)          ((ide_hwgroup_t *)(HWIF(drive)->hwgroup))
58
59 /*
60  * Definitions for accessing IDE controller registers
61  */
62 #define IDE_NR_PORTS            (10)
63
64 struct ide_io_ports {
65         unsigned long   data_addr;
66
67         union {
68                 unsigned long error_addr;       /*   read:  error */
69                 unsigned long feature_addr;     /*  write: feature */
70         };
71
72         unsigned long   nsect_addr;
73         unsigned long   lbal_addr;
74         unsigned long   lbam_addr;
75         unsigned long   lbah_addr;
76
77         unsigned long   device_addr;
78
79         union {
80                 unsigned long status_addr;      /*  read: status  */
81                 unsigned long command_addr;     /* write: command */
82         };
83
84         unsigned long   ctl_addr;
85
86         unsigned long   irq_addr;
87 };
88
89 #define OK_STAT(stat,good,bad)  (((stat)&((good)|(bad)))==(good))
90 #define BAD_R_STAT              (BUSY_STAT   | ERR_STAT)
91 #define BAD_W_STAT              (BAD_R_STAT  | WRERR_STAT)
92 #define BAD_STAT                (BAD_R_STAT  | DRQ_STAT)
93 #define DRIVE_READY             (READY_STAT  | SEEK_STAT)
94
95 #define BAD_CRC                 (ABRT_ERR    | ICRC_ERR)
96
97 #define SATA_NR_PORTS           (3)     /* 16 possible ?? */
98
99 #define SATA_STATUS_OFFSET      (0)
100 #define SATA_ERROR_OFFSET       (1)
101 #define SATA_CONTROL_OFFSET     (2)
102
103 /*
104  * Our Physical Region Descriptor (PRD) table should be large enough
105  * to handle the biggest I/O request we are likely to see.  Since requests
106  * can have no more than 256 sectors, and since the typical blocksize is
107  * two or more sectors, we could get by with a limit of 128 entries here for
108  * the usual worst case.  Most requests seem to include some contiguous blocks,
109  * further reducing the number of table entries required.
110  *
111  * The driver reverts to PIO mode for individual requests that exceed
112  * this limit (possible with 512 byte blocksizes, eg. MSDOS f/s), so handling
113  * 100% of all crazy scenarios here is not necessary.
114  *
115  * As it turns out though, we must allocate a full 4KB page for this,
116  * so the two PRD tables (ide0 & ide1) will each get half of that,
117  * allowing each to have about 256 entries (8 bytes each) from this.
118  */
119 #define PRD_BYTES       8
120 #define PRD_ENTRIES     256
121
122 /*
123  * Some more useful definitions
124  */
125 #define PARTN_BITS      6       /* number of minor dev bits for partitions */
126 #define MAX_DRIVES      2       /* per interface; 2 assumed by lots of code */
127 #define SECTOR_SIZE     512
128 #define SECTOR_WORDS    (SECTOR_SIZE / 4)       /* number of 32bit words per sector */
129 #define IDE_LARGE_SEEK(b1,b2,t) (((b1) > (b2) + (t)) || ((b2) > (b1) + (t)))
130
131 /*
132  * Timeouts for various operations:
133  */
134 #define WAIT_DRQ        (HZ/10)         /* 100msec - spec allows up to 20ms */
135 #define WAIT_READY      (5*HZ)          /* 5sec - some laptops are very slow */
136 #define WAIT_PIDENTIFY  (10*HZ) /* 10sec  - should be less than 3ms (?), if all ATAPI CD is closed at boot */
137 #define WAIT_WORSTCASE  (30*HZ) /* 30sec  - worst case when spinning up */
138 #define WAIT_CMD        (10*HZ) /* 10sec  - maximum wait for an IRQ to happen */
139 #define WAIT_MIN_SLEEP  (2*HZ/100)      /* 20msec - minimum sleep time */
140
141 /*
142  * Op codes for special requests to be handled by ide_special_rq().
143  * Values should be in the range of 0x20 to 0x3f.
144  */
145 #define REQ_DRIVE_RESET         0x20
146
147 /*
148  * Check for an interrupt and acknowledge the interrupt status
149  */
150 struct hwif_s;
151 typedef int (ide_ack_intr_t)(struct hwif_s *);
152
153 /*
154  * hwif_chipset_t is used to keep track of the specific hardware
155  * chipset used by each IDE interface, if known.
156  */
157 enum {          ide_unknown,    ide_generic,    ide_pci,
158                 ide_cmd640,     ide_dtc2278,    ide_ali14xx,
159                 ide_qd65xx,     ide_umc8672,    ide_ht6560b,
160                 ide_rz1000,     ide_trm290,
161                 ide_cmd646,     ide_cy82c693,   ide_4drives,
162                 ide_pmac,       ide_acorn,
163                 ide_au1xxx,     ide_palm3710
164 };
165
166 typedef u8 hwif_chipset_t;
167
168 /*
169  * Structure to hold all information about the location of this port
170  */
171 typedef struct hw_regs_s {
172         union {
173                 struct ide_io_ports     io_ports;
174                 unsigned long           io_ports_array[IDE_NR_PORTS];
175         };
176
177         int             irq;                    /* our irq number */
178         ide_ack_intr_t  *ack_intr;              /* acknowledge interrupt */
179         hwif_chipset_t  chipset;
180         struct device   *dev, *parent;
181         unsigned long   config;
182 } hw_regs_t;
183
184 void ide_init_port_data(struct hwif_s *, unsigned int);
185 void ide_init_port_hw(struct hwif_s *, hw_regs_t *);
186
187 static inline void ide_std_init_ports(hw_regs_t *hw,
188                                       unsigned long io_addr,
189                                       unsigned long ctl_addr)
190 {
191         unsigned int i;
192
193         for (i = 0; i <= 7; i++)
194                 hw->io_ports_array[i] = io_addr++;
195
196         hw->io_ports.ctl_addr = ctl_addr;
197 }
198
199 /* for IDE PCI controllers in legacy mode, temporary */
200 static inline int __ide_default_irq(unsigned long base)
201 {
202         switch (base) {
203 #ifdef CONFIG_IA64
204         case 0x1f0: return isa_irq_to_vector(14);
205         case 0x170: return isa_irq_to_vector(15);
206 #else
207         case 0x1f0: return 14;
208         case 0x170: return 15;
209 #endif
210         }
211         return 0;
212 }
213
214 #if defined(CONFIG_ARM) || defined(CONFIG_FRV) || defined(CONFIG_M68K) || \
215     defined(CONFIG_MIPS) || defined(CONFIG_MN10300) || defined(CONFIG_PARISC) \
216     || defined(CONFIG_PPC) || defined(CONFIG_SPARC) || defined(CONFIG_SPARC64)
217 #include <asm/ide.h>
218 #else
219 #include <asm-generic/ide_iops.h>
220 #endif
221
222 #define MAX_HWIFS       10
223
224 /* Currently only m68k, apus and m8xx need it */
225 #ifndef IDE_ARCH_ACK_INTR
226 # define ide_ack_intr(hwif) (1)
227 #endif
228
229 /* Currently only Atari needs it */
230 #ifndef IDE_ARCH_LOCK
231 # define ide_release_lock()                     do {} while (0)
232 # define ide_get_lock(hdlr, data)               do {} while (0)
233 #endif /* IDE_ARCH_LOCK */
234
235 /*
236  * Now for the data we need to maintain per-drive:  ide_drive_t
237  */
238
239 #define ide_scsi        0x21
240 #define ide_disk        0x20
241 #define ide_optical     0x7
242 #define ide_cdrom       0x5
243 #define ide_tape        0x1
244 #define ide_floppy      0x0
245
246 /*
247  * Special Driver Flags
248  *
249  * set_geometry : respecify drive geometry
250  * recalibrate  : seek to cyl 0
251  * set_multmode : set multmode count
252  * set_tune     : tune interface for drive
253  * serviced     : service command
254  * reserved     : unused
255  */
256 typedef union {
257         unsigned all                    : 8;
258         struct {
259                 unsigned set_geometry   : 1;
260                 unsigned recalibrate    : 1;
261                 unsigned set_multmode   : 1;
262                 unsigned set_tune       : 1;
263                 unsigned serviced       : 1;
264                 unsigned reserved       : 3;
265         } b;
266 } special_t;
267
268 /*
269  * ATA-IDE Select Register, aka Device-Head
270  *
271  * head         : always zeros here
272  * unit         : drive select number: 0/1
273  * bit5         : always 1
274  * lba          : using LBA instead of CHS
275  * bit7         : always 1
276  */
277 typedef union {
278         unsigned all                    : 8;
279         struct {
280 #if defined(__LITTLE_ENDIAN_BITFIELD)
281                 unsigned head           : 4;
282                 unsigned unit           : 1;
283                 unsigned bit5           : 1;
284                 unsigned lba            : 1;
285                 unsigned bit7           : 1;
286 #elif defined(__BIG_ENDIAN_BITFIELD)
287                 unsigned bit7           : 1;
288                 unsigned lba            : 1;
289                 unsigned bit5           : 1;
290                 unsigned unit           : 1;
291                 unsigned head           : 4;
292 #else
293 #error "Please fix <asm/byteorder.h>"
294 #endif
295         } b;
296 } select_t, ata_select_t;
297
298 /*
299  * Status returned from various ide_ functions
300  */
301 typedef enum {
302         ide_stopped,    /* no drive operation was started */
303         ide_started,    /* a drive operation was started, handler was set */
304 } ide_startstop_t;
305
306 struct ide_driver_s;
307 struct ide_settings_s;
308
309 #ifdef CONFIG_BLK_DEV_IDEACPI
310 struct ide_acpi_drive_link;
311 struct ide_acpi_hwif_link;
312 #endif
313
314 /* ATAPI device flags */
315 enum {
316         IDE_AFLAG_DRQ_INTERRUPT         = (1 << 0),
317         IDE_AFLAG_MEDIA_CHANGED         = (1 << 1),
318
319         /* ide-cd */
320         /* Drive cannot lock the door. */
321         IDE_AFLAG_NO_DOORLOCK           = (1 << 2),
322         /* Drive cannot eject the disc. */
323         IDE_AFLAG_NO_EJECT              = (1 << 3),
324         /* Drive is a pre ATAPI 1.2 drive. */
325         IDE_AFLAG_PRE_ATAPI12           = (1 << 4),
326         /* TOC addresses are in BCD. */
327         IDE_AFLAG_TOCADDR_AS_BCD        = (1 << 5),
328         /* TOC track numbers are in BCD. */
329         IDE_AFLAG_TOCTRACKS_AS_BCD      = (1 << 6),
330         /*
331          * Drive does not provide data in multiples of SECTOR_SIZE
332          * when more than one interrupt is needed.
333          */
334         IDE_AFLAG_LIMIT_NFRAMES         = (1 << 7),
335         /* Seeking in progress. */
336         IDE_AFLAG_SEEKING               = (1 << 8),
337         /* Saved TOC information is current. */
338         IDE_AFLAG_TOC_VALID             = (1 << 9),
339         /* We think that the drive door is locked. */
340         IDE_AFLAG_DOOR_LOCKED           = (1 << 10),
341         /* SET_CD_SPEED command is unsupported. */
342         IDE_AFLAG_NO_SPEED_SELECT       = (1 << 11),
343         IDE_AFLAG_VERTOS_300_SSD        = (1 << 12),
344         IDE_AFLAG_VERTOS_600_ESD        = (1 << 13),
345         IDE_AFLAG_SANYO_3CD             = (1 << 14),
346         IDE_AFLAG_FULL_CAPS_PAGE        = (1 << 15),
347         IDE_AFLAG_PLAY_AUDIO_OK         = (1 << 16),
348         IDE_AFLAG_LE_SPEED_FIELDS       = (1 << 17),
349
350         /* ide-floppy */
351         /* Format in progress */
352         IDE_AFLAG_FORMAT_IN_PROGRESS    = (1 << 18),
353         /* Avoid commands not supported in Clik drive */
354         IDE_AFLAG_CLIK_DRIVE            = (1 << 19),
355         /* Requires BH algorithm for packets */
356         IDE_AFLAG_ZIP_DRIVE             = (1 << 20),
357
358         /* ide-tape */
359         IDE_AFLAG_IGNORE_DSC            = (1 << 21),
360         /* 0 When the tape position is unknown */
361         IDE_AFLAG_ADDRESS_VALID         = (1 << 22),
362         /* Device already opened */
363         IDE_AFLAG_BUSY                  = (1 << 23),
364         /* Attempt to auto-detect the current user block size */
365         IDE_AFLAG_DETECT_BS             = (1 << 24),
366         /* Currently on a filemark */
367         IDE_AFLAG_FILEMARK              = (1 << 25),
368         /* 0 = no tape is loaded, so we don't rewind after ejecting */
369         IDE_AFLAG_MEDIUM_PRESENT        = (1 << 26),
370
371         IDE_AFLAG_NO_AUTOCLOSE          = (1 << 27),
372 };
373
374 struct ide_drive_s {
375         char            name[4];        /* drive name, such as "hda" */
376         char            driver_req[10]; /* requests specific driver */
377
378         struct request_queue    *queue; /* request queue */
379
380         struct request          *rq;    /* current request */
381         struct ide_drive_s      *next;  /* circular list of hwgroup drives */
382         void            *driver_data;   /* extra driver data */
383         u16                     *id;    /* identification info */
384 #ifdef CONFIG_IDE_PROC_FS
385         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
386         struct ide_settings_s *settings;/* /proc/ide/ drive settings */
387 #endif
388         struct hwif_s           *hwif;  /* actually (ide_hwif_t *) */
389
390         unsigned long sleep;            /* sleep until this time */
391         unsigned long service_start;    /* time we started last request */
392         unsigned long service_time;     /* service time of last request */
393         unsigned long timeout;          /* max time to wait for irq */
394
395         special_t       special;        /* special action flags */
396         select_t        select;         /* basic drive/head select reg value */
397
398         u8      keep_settings;          /* restore settings after drive reset */
399         u8      using_dma;              /* disk is using dma for read/write */
400         u8      retry_pio;              /* retrying dma capable host in pio */
401         u8      state;                  /* retry state */
402         u8      waiting_for_dma;        /* dma currently in progress */
403         u8      unmask;                 /* okay to unmask other irqs */
404         u8      noflush;                /* don't attempt flushes */
405         u8      dsc_overlap;            /* DSC overlap */
406         u8      nice1;                  /* give potential excess bandwidth */
407
408         unsigned present        : 1;    /* drive is physically present */
409         unsigned dead           : 1;    /* device ejected hint */
410         unsigned id_read        : 1;    /* 1=id read from disk 0 = synthetic */
411         unsigned noprobe        : 1;    /* from:  hdx=noprobe */
412         unsigned removable      : 1;    /* 1 if need to do check_media_change */
413         unsigned attach         : 1;    /* needed for removable devices */
414         unsigned forced_geom    : 1;    /* 1 if hdx=c,h,s was given at boot */
415         unsigned no_unmask      : 1;    /* disallow setting unmask bit */
416         unsigned no_io_32bit    : 1;    /* disallow enabling 32bit I/O */
417         unsigned atapi_overlap  : 1;    /* ATAPI overlap (not supported) */
418         unsigned doorlocking    : 1;    /* for removable only: door lock/unlock works */
419         unsigned nodma          : 1;    /* disallow DMA */
420         unsigned remap_0_to_1   : 1;    /* 0=noremap, 1=remap 0->1 (for EZDrive) */
421         unsigned blocked        : 1;    /* 1=powermanagment told us not to do anything, so sleep nicely */
422         unsigned scsi           : 1;    /* 0=default, 1=ide-scsi emulation */
423         unsigned sleeping       : 1;    /* 1=sleeping & sleep field valid */
424         unsigned post_reset     : 1;
425         unsigned udma33_warned  : 1;
426
427         u8      addressing;     /* 0=28-bit, 1=48-bit, 2=48-bit doing 28-bit */
428         u8      quirk_list;     /* considered quirky, set for a specific host */
429         u8      init_speed;     /* transfer rate set at boot */
430         u8      current_speed;  /* current transfer rate set */
431         u8      desired_speed;  /* desired transfer rate set */
432         u8      dn;             /* now wide spread use */
433         u8      wcache;         /* status of write cache */
434         u8      acoustic;       /* acoustic management */
435         u8      media;          /* disk, cdrom, tape, floppy, ... */
436         u8      ready_stat;     /* min status value for drive ready */
437         u8      mult_count;     /* current multiple sector setting */
438         u8      mult_req;       /* requested multiple sector setting */
439         u8      tune_req;       /* requested drive tuning setting */
440         u8      io_32bit;       /* 0=16-bit, 1=32-bit, 2/3=32bit+sync */
441         u8      bad_wstat;      /* used for ignoring WRERR_STAT */
442         u8      nowerr;         /* used for ignoring WRERR_STAT */
443         u8      sect0;          /* offset of first sector for DM6:DDO */
444         u8      head;           /* "real" number of heads */
445         u8      sect;           /* "real" sectors per track */
446         u8      bios_head;      /* BIOS/fdisk/LILO number of heads */
447         u8      bios_sect;      /* BIOS/fdisk/LILO sectors per track */
448
449         unsigned int    bios_cyl;       /* BIOS/fdisk/LILO number of cyls */
450         unsigned int    cyl;            /* "real" number of cyls */
451         unsigned int    drive_data;     /* used by set_pio_mode/selectproc */
452         unsigned int    failures;       /* current failure count */
453         unsigned int    max_failures;   /* maximum allowed failure count */
454         u64             probed_capacity;/* initial reported media capacity (ide-cd only currently) */
455
456         u64             capacity64;     /* total number of sectors */
457
458         int             lun;            /* logical unit */
459         int             crc_count;      /* crc counter to reduce drive speed */
460 #ifdef CONFIG_BLK_DEV_IDEACPI
461         struct ide_acpi_drive_link *acpidata;
462 #endif
463         struct list_head list;
464         struct device   gendev;
465         struct completion gendev_rel_comp;      /* to deal with device release() */
466
467         /* callback for packet commands */
468         void (*pc_callback)(struct ide_drive_s *);
469
470         unsigned long atapi_flags;
471 };
472
473 typedef struct ide_drive_s ide_drive_t;
474
475 #define to_ide_device(dev)container_of(dev, ide_drive_t, gendev)
476
477 #define IDE_CHIPSET_PCI_MASK    \
478     ((1<<ide_pci)|(1<<ide_cmd646)|(1<<ide_ali14xx))
479 #define IDE_CHIPSET_IS_PCI(c)   ((IDE_CHIPSET_PCI_MASK >> (c)) & 1)
480
481 struct ide_task_s;
482 struct ide_port_info;
483
484 struct ide_tp_ops {
485         void    (*exec_command)(struct hwif_s *, u8);
486         u8      (*read_status)(struct hwif_s *);
487         u8      (*read_altstatus)(struct hwif_s *);
488         u8      (*read_sff_dma_status)(struct hwif_s *);
489
490         void    (*set_irq)(struct hwif_s *, int);
491
492         void    (*tf_load)(ide_drive_t *, struct ide_task_s *);
493         void    (*tf_read)(ide_drive_t *, struct ide_task_s *);
494
495         void    (*input_data)(ide_drive_t *, struct request *, void *,
496                               unsigned int);
497         void    (*output_data)(ide_drive_t *, struct request *, void *,
498                                unsigned int);
499 };
500
501 extern const struct ide_tp_ops default_tp_ops;
502
503 /**
504  * struct ide_port_ops - IDE port operations
505  *
506  * @init_dev:           host specific initialization of a device
507  * @set_pio_mode:       routine to program host for PIO mode
508  * @set_dma_mode:       routine to program host for DMA mode
509  * @selectproc:         tweaks hardware to select drive
510  * @reset_poll:         chipset polling based on hba specifics
511  * @pre_reset:          chipset specific changes to default for device-hba resets
512  * @resetproc:          routine to reset controller after a disk reset
513  * @maskproc:           special host masking for drive selection
514  * @quirkproc:          check host's drive quirk list
515  *
516  * @mdma_filter:        filter MDMA modes
517  * @udma_filter:        filter UDMA modes
518  *
519  * @cable_detect:       detect cable type
520  */
521 struct ide_port_ops {
522         void    (*init_dev)(ide_drive_t *);
523         void    (*set_pio_mode)(ide_drive_t *, const u8);
524         void    (*set_dma_mode)(ide_drive_t *, const u8);
525         void    (*selectproc)(ide_drive_t *);
526         int     (*reset_poll)(ide_drive_t *);
527         void    (*pre_reset)(ide_drive_t *);
528         void    (*resetproc)(ide_drive_t *);
529         void    (*maskproc)(ide_drive_t *, int);
530         void    (*quirkproc)(ide_drive_t *);
531
532         u8      (*mdma_filter)(ide_drive_t *);
533         u8      (*udma_filter)(ide_drive_t *);
534
535         u8      (*cable_detect)(struct hwif_s *);
536 };
537
538 struct ide_dma_ops {
539         void    (*dma_host_set)(struct ide_drive_s *, int);
540         int     (*dma_setup)(struct ide_drive_s *);
541         void    (*dma_exec_cmd)(struct ide_drive_s *, u8);
542         void    (*dma_start)(struct ide_drive_s *);
543         int     (*dma_end)(struct ide_drive_s *);
544         int     (*dma_test_irq)(struct ide_drive_s *);
545         void    (*dma_lost_irq)(struct ide_drive_s *);
546         void    (*dma_timeout)(struct ide_drive_s *);
547 };
548
549 struct ide_host;
550
551 typedef struct hwif_s {
552         struct hwif_s *next;            /* for linked-list in ide_hwgroup_t */
553         struct hwif_s *mate;            /* other hwif from same PCI chip */
554         struct hwgroup_s *hwgroup;      /* actually (ide_hwgroup_t *) */
555         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
556
557         struct ide_host *host;
558
559         char name[6];                   /* name of interface, eg. "ide0" */
560
561         struct ide_io_ports     io_ports;
562
563         unsigned long   sata_scr[SATA_NR_PORTS];
564
565         ide_drive_t     drives[MAX_DRIVES];     /* drive info */
566
567         u8 major;       /* our major number */
568         u8 index;       /* 0 for ide0; 1 for ide1; ... */
569         u8 channel;     /* for dual-port chips: 0=primary, 1=secondary */
570         u8 bus_state;   /* power state of the IDE bus */
571
572         u32 host_flags;
573
574         u8 pio_mask;
575
576         u8 ultra_mask;
577         u8 mwdma_mask;
578         u8 swdma_mask;
579
580         u8 cbl;         /* cable type */
581
582         hwif_chipset_t chipset; /* sub-module for tuning.. */
583
584         struct device *dev;
585
586         ide_ack_intr_t *ack_intr;
587
588         void (*rw_disk)(ide_drive_t *, struct request *);
589
590         const struct ide_tp_ops         *tp_ops;
591         const struct ide_port_ops       *port_ops;
592         const struct ide_dma_ops        *dma_ops;
593
594         void (*ide_dma_clear_irq)(ide_drive_t *drive);
595
596         /* dma physical region descriptor table (cpu view) */
597         unsigned int    *dmatable_cpu;
598         /* dma physical region descriptor table (dma view) */
599         dma_addr_t      dmatable_dma;
600         /* Scatter-gather list used to build the above */
601         struct scatterlist *sg_table;
602         int sg_max_nents;               /* Maximum number of entries in it */
603         int sg_nents;                   /* Current number of entries in it */
604         int sg_dma_direction;           /* dma transfer direction */
605
606         /* data phase of the active command (currently only valid for PIO/DMA) */
607         int             data_phase;
608
609         unsigned int nsect;
610         unsigned int nleft;
611         struct scatterlist *cursg;
612         unsigned int cursg_ofs;
613
614         int             rqsize;         /* max sectors per request */
615         int             irq;            /* our irq number */
616
617         unsigned long   dma_base;       /* base addr for dma ports */
618
619         unsigned long   config_data;    /* for use by chipset-specific code */
620         unsigned long   select_data;    /* for use by chipset-specific code */
621
622         unsigned long   extra_base;     /* extra addr for dma ports */
623         unsigned        extra_ports;    /* number of extra dma ports */
624
625         unsigned        present    : 1; /* this interface exists */
626         unsigned        serialized : 1; /* serialized all channel operation */
627         unsigned        sharing_irq: 1; /* 1 = sharing irq with another hwif */
628         unsigned        sg_mapped  : 1; /* sg_table and sg_nents are ready */
629
630         struct device           gendev;
631         struct device           *portdev;
632
633         struct completion gendev_rel_comp; /* To deal with device release() */
634
635         void            *hwif_data;     /* extra hwif data */
636
637         unsigned dma;
638
639 #ifdef CONFIG_BLK_DEV_IDEACPI
640         struct ide_acpi_hwif_link *acpidata;
641 #endif
642 } ____cacheline_internodealigned_in_smp ide_hwif_t;
643
644 struct ide_host {
645         ide_hwif_t      *ports[MAX_HWIFS];
646         unsigned int    n_ports;
647         struct device   *dev[2];
648         unsigned long   host_flags;
649         void            *host_priv;
650 };
651
652 /*
653  *  internal ide interrupt handler type
654  */
655 typedef ide_startstop_t (ide_handler_t)(ide_drive_t *);
656 typedef int (ide_expiry_t)(ide_drive_t *);
657
658 /* used by ide-cd, ide-floppy, etc. */
659 typedef void (xfer_func_t)(ide_drive_t *, struct request *rq, void *, unsigned);
660
661 typedef struct hwgroup_s {
662                 /* irq handler, if active */
663         ide_startstop_t (*handler)(ide_drive_t *);
664
665                 /* BOOL: protects all fields below */
666         volatile int busy;
667                 /* BOOL: wake us up on timer expiry */
668         unsigned int sleeping   : 1;
669                 /* BOOL: polling active & poll_timeout field valid */
670         unsigned int polling    : 1;
671
672                 /* current drive */
673         ide_drive_t *drive;
674                 /* ptr to current hwif in linked-list */
675         ide_hwif_t *hwif;
676
677                 /* current request */
678         struct request *rq;
679
680                 /* failsafe timer */
681         struct timer_list timer;
682                 /* timeout value during long polls */
683         unsigned long poll_timeout;
684                 /* queried upon timeouts */
685         int (*expiry)(ide_drive_t *);
686
687         int req_gen;
688         int req_gen_timer;
689 } ide_hwgroup_t;
690
691 typedef struct ide_driver_s ide_driver_t;
692
693 extern struct mutex ide_setting_mtx;
694
695 int set_io_32bit(ide_drive_t *, int);
696 int set_pio_mode(ide_drive_t *, int);
697 int set_using_dma(ide_drive_t *, int);
698
699 /* ATAPI packet command flags */
700 enum {
701         /* set when an error is considered normal - no retry (ide-tape) */
702         PC_FLAG_ABORT                   = (1 << 0),
703         PC_FLAG_SUPPRESS_ERROR          = (1 << 1),
704         PC_FLAG_WAIT_FOR_DSC            = (1 << 2),
705         PC_FLAG_DMA_OK                  = (1 << 3),
706         PC_FLAG_DMA_IN_PROGRESS         = (1 << 4),
707         PC_FLAG_DMA_ERROR               = (1 << 5),
708         PC_FLAG_WRITING                 = (1 << 6),
709         /* command timed out */
710         PC_FLAG_TIMEDOUT                = (1 << 7),
711 };
712
713 struct ide_atapi_pc {
714         /* actual packet bytes */
715         u8 c[12];
716         /* incremented on each retry */
717         int retries;
718         int error;
719
720         /* bytes to transfer */
721         int req_xfer;
722         /* bytes actually transferred */
723         int xferred;
724
725         /* data buffer */
726         u8 *buf;
727         /* current buffer position */
728         u8 *cur_pos;
729         int buf_size;
730         /* missing/available data on the current buffer */
731         int b_count;
732
733         /* the corresponding request */
734         struct request *rq;
735
736         unsigned long flags;
737
738         /*
739          * those are more or less driver-specific and some of them are subject
740          * to change/removal later.
741          */
742         u8 pc_buf[256];
743
744         /* idetape only */
745         struct idetape_bh *bh;
746         char *b_data;
747
748         /* idescsi only for now */
749         struct scatterlist *sg;
750         unsigned int sg_cnt;
751
752         struct scsi_cmnd *scsi_cmd;
753         void (*done) (struct scsi_cmnd *);
754
755         unsigned long timeout;
756 };
757
758 #ifdef CONFIG_IDE_PROC_FS
759 /*
760  * configurable drive settings
761  */
762
763 #define TYPE_INT        0
764 #define TYPE_BYTE       1
765 #define TYPE_SHORT      2
766
767 #define SETTING_READ    (1 << 0)
768 #define SETTING_WRITE   (1 << 1)
769 #define SETTING_RW      (SETTING_READ | SETTING_WRITE)
770
771 typedef int (ide_procset_t)(ide_drive_t *, int);
772 typedef struct ide_settings_s {
773         char                    *name;
774         int                     rw;
775         int                     data_type;
776         int                     min;
777         int                     max;
778         int                     mul_factor;
779         int                     div_factor;
780         void                    *data;
781         ide_procset_t           *set;
782         int                     auto_remove;
783         struct ide_settings_s   *next;
784 } ide_settings_t;
785
786 int ide_add_setting(ide_drive_t *, const char *, int, int, int, int, int, int, void *, ide_procset_t *set);
787
788 /*
789  * /proc/ide interface
790  */
791 typedef struct {
792         const char      *name;
793         mode_t          mode;
794         read_proc_t     *read_proc;
795         write_proc_t    *write_proc;
796 } ide_proc_entry_t;
797
798 void proc_ide_create(void);
799 void proc_ide_destroy(void);
800 void ide_proc_register_port(ide_hwif_t *);
801 void ide_proc_port_register_devices(ide_hwif_t *);
802 void ide_proc_unregister_device(ide_drive_t *);
803 void ide_proc_unregister_port(ide_hwif_t *);
804 void ide_proc_register_driver(ide_drive_t *, ide_driver_t *);
805 void ide_proc_unregister_driver(ide_drive_t *, ide_driver_t *);
806
807 void ide_add_generic_settings(ide_drive_t *);
808
809 read_proc_t proc_ide_read_capacity;
810 read_proc_t proc_ide_read_geometry;
811
812 /*
813  * Standard exit stuff:
814  */
815 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) \
816 {                                       \
817         len -= off;                     \
818         if (len < count) {              \
819                 *eof = 1;               \
820                 if (len <= 0)           \
821                         return 0;       \
822         } else                          \
823                 len = count;            \
824         *start = page + off;            \
825         return len;                     \
826 }
827 #else
828 static inline void proc_ide_create(void) { ; }
829 static inline void proc_ide_destroy(void) { ; }
830 static inline void ide_proc_register_port(ide_hwif_t *hwif) { ; }
831 static inline void ide_proc_port_register_devices(ide_hwif_t *hwif) { ; }
832 static inline void ide_proc_unregister_device(ide_drive_t *drive) { ; }
833 static inline void ide_proc_unregister_port(ide_hwif_t *hwif) { ; }
834 static inline void ide_proc_register_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
835 static inline void ide_proc_unregister_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
836 static inline void ide_add_generic_settings(ide_drive_t *drive) { ; }
837 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) return 0;
838 #endif
839
840 /*
841  * Power Management step value (rq->pm->pm_step).
842  *
843  * The step value starts at 0 (ide_pm_state_start_suspend) for a
844  * suspend operation or 1000 (ide_pm_state_start_resume) for a
845  * resume operation.
846  *
847  * For each step, the core calls the subdriver start_power_step() first.
848  * This can return:
849  *      - ide_stopped : In this case, the core calls us back again unless
850  *                      step have been set to ide_power_state_completed.
851  *      - ide_started : In this case, the channel is left busy until an
852  *                      async event (interrupt) occurs.
853  * Typically, start_power_step() will issue a taskfile request with
854  * do_rw_taskfile().
855  *
856  * Upon reception of the interrupt, the core will call complete_power_step()
857  * with the error code if any. This routine should update the step value
858  * and return. It should not start a new request. The core will call
859  * start_power_step for the new step value, unless step have been set to
860  * ide_power_state_completed.
861  *
862  * Subdrivers are expected to define their own additional power
863  * steps from 1..999 for suspend and from 1001..1999 for resume,
864  * other values are reserved for future use.
865  */
866
867 enum {
868         ide_pm_state_completed          = -1,
869         ide_pm_state_start_suspend      = 0,
870         ide_pm_state_start_resume       = 1000,
871 };
872
873 /*
874  * Subdrivers support.
875  *
876  * The gendriver.owner field should be set to the module owner of this driver.
877  * The gendriver.name field should be set to the name of this driver
878  */
879 struct ide_driver_s {
880         const char                      *version;
881         u8                              media;
882         unsigned supports_dsc_overlap   : 1;
883         ide_startstop_t (*do_request)(ide_drive_t *, struct request *, sector_t);
884         int             (*end_request)(ide_drive_t *, int, int);
885         ide_startstop_t (*error)(ide_drive_t *, struct request *rq, u8, u8);
886         struct device_driver    gen_driver;
887         int             (*probe)(ide_drive_t *);
888         void            (*remove)(ide_drive_t *);
889         void            (*resume)(ide_drive_t *);
890         void            (*shutdown)(ide_drive_t *);
891 #ifdef CONFIG_IDE_PROC_FS
892         ide_proc_entry_t        *proc;
893 #endif
894 };
895
896 #define to_ide_driver(drv) container_of(drv, ide_driver_t, gen_driver)
897
898 int ide_device_get(ide_drive_t *);
899 void ide_device_put(ide_drive_t *);
900
901 int generic_ide_ioctl(ide_drive_t *, struct file *, struct block_device *, unsigned, unsigned long);
902
903 extern int ide_vlb_clk;
904 extern int ide_pci_clk;
905
906 extern int ide_end_request (ide_drive_t *drive, int uptodate, int nrsecs);
907 int ide_end_dequeued_request(ide_drive_t *drive, struct request *rq,
908                              int uptodate, int nr_sectors);
909
910 extern void ide_set_handler (ide_drive_t *drive, ide_handler_t *handler, unsigned int timeout, ide_expiry_t *expiry);
911
912 void ide_execute_command(ide_drive_t *, u8, ide_handler_t *, unsigned int,
913                          ide_expiry_t *);
914
915 void ide_execute_pkt_cmd(ide_drive_t *);
916
917 void ide_pad_transfer(ide_drive_t *, int, int);
918
919 ide_startstop_t __ide_error(ide_drive_t *, struct request *, u8, u8);
920
921 ide_startstop_t ide_error (ide_drive_t *drive, const char *msg, byte stat);
922
923 void ide_fix_driveid(u16 *);
924
925 extern void ide_fixstring(u8 *, const int, const int);
926
927 int ide_wait_stat(ide_startstop_t *, ide_drive_t *, u8, u8, unsigned long);
928
929 extern ide_startstop_t ide_do_reset (ide_drive_t *);
930
931 extern void ide_do_drive_cmd(ide_drive_t *, struct request *);
932
933 extern void ide_end_drive_cmd(ide_drive_t *, u8, u8);
934
935 enum {
936         IDE_TFLAG_LBA48                 = (1 << 0),
937         IDE_TFLAG_FLAGGED               = (1 << 2),
938         IDE_TFLAG_OUT_DATA              = (1 << 3),
939         IDE_TFLAG_OUT_HOB_FEATURE       = (1 << 4),
940         IDE_TFLAG_OUT_HOB_NSECT         = (1 << 5),
941         IDE_TFLAG_OUT_HOB_LBAL          = (1 << 6),
942         IDE_TFLAG_OUT_HOB_LBAM          = (1 << 7),
943         IDE_TFLAG_OUT_HOB_LBAH          = (1 << 8),
944         IDE_TFLAG_OUT_HOB               = IDE_TFLAG_OUT_HOB_FEATURE |
945                                           IDE_TFLAG_OUT_HOB_NSECT |
946                                           IDE_TFLAG_OUT_HOB_LBAL |
947                                           IDE_TFLAG_OUT_HOB_LBAM |
948                                           IDE_TFLAG_OUT_HOB_LBAH,
949         IDE_TFLAG_OUT_FEATURE           = (1 << 9),
950         IDE_TFLAG_OUT_NSECT             = (1 << 10),
951         IDE_TFLAG_OUT_LBAL              = (1 << 11),
952         IDE_TFLAG_OUT_LBAM              = (1 << 12),
953         IDE_TFLAG_OUT_LBAH              = (1 << 13),
954         IDE_TFLAG_OUT_TF                = IDE_TFLAG_OUT_FEATURE |
955                                           IDE_TFLAG_OUT_NSECT |
956                                           IDE_TFLAG_OUT_LBAL |
957                                           IDE_TFLAG_OUT_LBAM |
958                                           IDE_TFLAG_OUT_LBAH,
959         IDE_TFLAG_OUT_DEVICE            = (1 << 14),
960         IDE_TFLAG_WRITE                 = (1 << 15),
961         IDE_TFLAG_FLAGGED_SET_IN_FLAGS  = (1 << 16),
962         IDE_TFLAG_IN_DATA               = (1 << 17),
963         IDE_TFLAG_CUSTOM_HANDLER        = (1 << 18),
964         IDE_TFLAG_DMA_PIO_FALLBACK      = (1 << 19),
965         IDE_TFLAG_IN_HOB_FEATURE        = (1 << 20),
966         IDE_TFLAG_IN_HOB_NSECT          = (1 << 21),
967         IDE_TFLAG_IN_HOB_LBAL           = (1 << 22),
968         IDE_TFLAG_IN_HOB_LBAM           = (1 << 23),
969         IDE_TFLAG_IN_HOB_LBAH           = (1 << 24),
970         IDE_TFLAG_IN_HOB_LBA            = IDE_TFLAG_IN_HOB_LBAL |
971                                           IDE_TFLAG_IN_HOB_LBAM |
972                                           IDE_TFLAG_IN_HOB_LBAH,
973         IDE_TFLAG_IN_HOB                = IDE_TFLAG_IN_HOB_FEATURE |
974                                           IDE_TFLAG_IN_HOB_NSECT |
975                                           IDE_TFLAG_IN_HOB_LBA,
976         IDE_TFLAG_IN_FEATURE            = (1 << 1),
977         IDE_TFLAG_IN_NSECT              = (1 << 25),
978         IDE_TFLAG_IN_LBAL               = (1 << 26),
979         IDE_TFLAG_IN_LBAM               = (1 << 27),
980         IDE_TFLAG_IN_LBAH               = (1 << 28),
981         IDE_TFLAG_IN_LBA                = IDE_TFLAG_IN_LBAL |
982                                           IDE_TFLAG_IN_LBAM |
983                                           IDE_TFLAG_IN_LBAH,
984         IDE_TFLAG_IN_TF                 = IDE_TFLAG_IN_NSECT |
985                                           IDE_TFLAG_IN_LBA,
986         IDE_TFLAG_IN_DEVICE             = (1 << 29),
987         IDE_TFLAG_HOB                   = IDE_TFLAG_OUT_HOB |
988                                           IDE_TFLAG_IN_HOB,
989         IDE_TFLAG_TF                    = IDE_TFLAG_OUT_TF |
990                                           IDE_TFLAG_IN_TF,
991         IDE_TFLAG_DEVICE                = IDE_TFLAG_OUT_DEVICE |
992                                           IDE_TFLAG_IN_DEVICE,
993         /* force 16-bit I/O operations */
994         IDE_TFLAG_IO_16BIT              = (1 << 30),
995         /* ide_task_t was allocated using kmalloc() */
996         IDE_TFLAG_DYN                   = (1 << 31),
997 };
998
999 struct ide_taskfile {
1000         u8      hob_data;       /*  0: high data byte (for TASKFILE IOCTL) */
1001
1002         u8      hob_feature;    /*  1-5: additional data to support LBA48 */
1003         u8      hob_nsect;
1004         u8      hob_lbal;
1005         u8      hob_lbam;
1006         u8      hob_lbah;
1007
1008         u8      data;           /*  6: low data byte (for TASKFILE IOCTL) */
1009
1010         union {                 /*  7: */
1011                 u8 error;       /*   read:  error */
1012                 u8 feature;     /*  write: feature */
1013         };
1014
1015         u8      nsect;          /*  8: number of sectors */
1016         u8      lbal;           /*  9: LBA low */
1017         u8      lbam;           /* 10: LBA mid */
1018         u8      lbah;           /* 11: LBA high */
1019
1020         u8      device;         /* 12: device select */
1021
1022         union {                 /* 13: */
1023                 u8 status;      /*  read: status  */
1024                 u8 command;     /* write: command */
1025         };
1026 };
1027
1028 typedef struct ide_task_s {
1029         union {
1030                 struct ide_taskfile     tf;
1031                 u8                      tf_array[14];
1032         };
1033         u32                     tf_flags;
1034         int                     data_phase;
1035         struct request          *rq;            /* copy of request */
1036         void                    *special;       /* valid_t generally */
1037 } ide_task_t;
1038
1039 void ide_tf_dump(const char *, struct ide_taskfile *);
1040
1041 void ide_exec_command(ide_hwif_t *, u8);
1042 u8 ide_read_status(ide_hwif_t *);
1043 u8 ide_read_altstatus(ide_hwif_t *);
1044 u8 ide_read_sff_dma_status(ide_hwif_t *);
1045
1046 void ide_set_irq(ide_hwif_t *, int);
1047
1048 void ide_tf_load(ide_drive_t *, ide_task_t *);
1049 void ide_tf_read(ide_drive_t *, ide_task_t *);
1050
1051 void ide_input_data(ide_drive_t *, struct request *, void *, unsigned int);
1052 void ide_output_data(ide_drive_t *, struct request *, void *, unsigned int);
1053
1054 extern void SELECT_DRIVE(ide_drive_t *);
1055 void SELECT_MASK(ide_drive_t *, int);
1056
1057 u8 ide_read_error(ide_drive_t *);
1058 void ide_read_bcount_and_ireason(ide_drive_t *, u16 *, u8 *);
1059
1060 extern int drive_is_ready(ide_drive_t *);
1061
1062 void ide_pktcmd_tf_load(ide_drive_t *, u32, u16, u8);
1063
1064 ide_startstop_t ide_pc_intr(ide_drive_t *drive, struct ide_atapi_pc *pc,
1065         ide_handler_t *handler, unsigned int timeout, ide_expiry_t *expiry,
1066         void (*update_buffers)(ide_drive_t *, struct ide_atapi_pc *),
1067         void (*retry_pc)(ide_drive_t *), void (*dsc_handle)(ide_drive_t *),
1068         void (*io_buffers)(ide_drive_t *, struct ide_atapi_pc *, unsigned int,
1069                            int));
1070 ide_startstop_t ide_transfer_pc(ide_drive_t *, struct ide_atapi_pc *,
1071                                 ide_handler_t *, unsigned int, ide_expiry_t *);
1072 ide_startstop_t ide_issue_pc(ide_drive_t *, struct ide_atapi_pc *,
1073                              ide_handler_t *, unsigned int, ide_expiry_t *);
1074
1075 ide_startstop_t do_rw_taskfile(ide_drive_t *, ide_task_t *);
1076
1077 void task_end_request(ide_drive_t *, struct request *, u8);
1078
1079 int ide_raw_taskfile(ide_drive_t *, ide_task_t *, u8 *, u16);
1080 int ide_no_data_taskfile(ide_drive_t *, ide_task_t *);
1081
1082 int ide_taskfile_ioctl(ide_drive_t *, unsigned int, unsigned long);
1083 int ide_cmd_ioctl(ide_drive_t *, unsigned int, unsigned long);
1084 int ide_task_ioctl(ide_drive_t *, unsigned int, unsigned long);
1085
1086 extern int ide_driveid_update(ide_drive_t *);
1087 extern int ide_config_drive_speed(ide_drive_t *, u8);
1088 extern u8 eighty_ninty_three (ide_drive_t *);
1089 extern int taskfile_lib_get_identify(ide_drive_t *drive, u8 *);
1090
1091 extern int ide_wait_not_busy(ide_hwif_t *hwif, unsigned long timeout);
1092
1093 extern void ide_stall_queue(ide_drive_t *drive, unsigned long timeout);
1094
1095 extern int ide_spin_wait_hwgroup(ide_drive_t *);
1096 extern void ide_timer_expiry(unsigned long);
1097 extern irqreturn_t ide_intr(int irq, void *dev_id);
1098 extern void do_ide_request(struct request_queue *);
1099
1100 void ide_init_disk(struct gendisk *, ide_drive_t *);
1101
1102 #ifdef CONFIG_IDEPCI_PCIBUS_ORDER
1103 extern int __ide_pci_register_driver(struct pci_driver *driver, struct module *owner, const char *mod_name);
1104 #define ide_pci_register_driver(d) __ide_pci_register_driver(d, THIS_MODULE, KBUILD_MODNAME)
1105 #else
1106 #define ide_pci_register_driver(d) pci_register_driver(d)
1107 #endif
1108
1109 void ide_pci_setup_ports(struct pci_dev *, const struct ide_port_info *, int,
1110                          hw_regs_t *, hw_regs_t **);
1111 void ide_setup_pci_noise(struct pci_dev *, const struct ide_port_info *);
1112
1113 #ifdef CONFIG_BLK_DEV_IDEDMA_PCI
1114 int ide_pci_set_master(struct pci_dev *, const char *);
1115 unsigned long ide_pci_dma_base(ide_hwif_t *, const struct ide_port_info *);
1116 int ide_pci_check_simplex(ide_hwif_t *, const struct ide_port_info *);
1117 int ide_hwif_setup_dma(ide_hwif_t *, const struct ide_port_info *);
1118 #else
1119 static inline int ide_hwif_setup_dma(ide_hwif_t *hwif,
1120                                      const struct ide_port_info *d)
1121 {
1122         return -EINVAL;
1123 }
1124 #endif
1125
1126 typedef struct ide_pci_enablebit_s {
1127         u8      reg;    /* byte pci reg holding the enable-bit */
1128         u8      mask;   /* mask to isolate the enable-bit */
1129         u8      val;    /* value of masked reg when "enabled" */
1130 } ide_pci_enablebit_t;
1131
1132 enum {
1133         /* Uses ISA control ports not PCI ones. */
1134         IDE_HFLAG_ISA_PORTS             = (1 << 0),
1135         /* single port device */
1136         IDE_HFLAG_SINGLE                = (1 << 1),
1137         /* don't use legacy PIO blacklist */
1138         IDE_HFLAG_PIO_NO_BLACKLIST      = (1 << 2),
1139         /* set for the second port of QD65xx */
1140         IDE_HFLAG_QD_2ND_PORT           = (1 << 3),
1141         /* use PIO8/9 for prefetch off/on */
1142         IDE_HFLAG_ABUSE_PREFETCH        = (1 << 4),
1143         /* use PIO6/7 for fast-devsel off/on */
1144         IDE_HFLAG_ABUSE_FAST_DEVSEL     = (1 << 5),
1145         /* use 100-102 and 200-202 PIO values to set DMA modes */
1146         IDE_HFLAG_ABUSE_DMA_MODES       = (1 << 6),
1147         /*
1148          * keep DMA setting when programming PIO mode, may be used only
1149          * for hosts which have separate PIO and DMA timings (ie. PMAC)
1150          */
1151         IDE_HFLAG_SET_PIO_MODE_KEEP_DMA = (1 << 7),
1152         /* program host for the transfer mode after programming device */
1153         IDE_HFLAG_POST_SET_MODE         = (1 << 8),
1154         /* don't program host/device for the transfer mode ("smart" hosts) */
1155         IDE_HFLAG_NO_SET_MODE           = (1 << 9),
1156         /* trust BIOS for programming chipset/device for DMA */
1157         IDE_HFLAG_TRUST_BIOS_FOR_DMA    = (1 << 10),
1158         /* host is CS5510/CS5520 */
1159         IDE_HFLAG_CS5520                = (1 << 11),
1160         /* ATAPI DMA is unsupported */
1161         IDE_HFLAG_NO_ATAPI_DMA          = (1 << 12),
1162         /* set if host is a "non-bootable" controller */
1163         IDE_HFLAG_NON_BOOTABLE          = (1 << 13),
1164         /* host doesn't support DMA */
1165         IDE_HFLAG_NO_DMA                = (1 << 14),
1166         /* check if host is PCI IDE device before allowing DMA */
1167         IDE_HFLAG_NO_AUTODMA            = (1 << 15),
1168         /* host uses MMIO */
1169         IDE_HFLAG_MMIO                  = (1 << 16),
1170         /* no LBA48 */
1171         IDE_HFLAG_NO_LBA48              = (1 << 17),
1172         /* no LBA48 DMA */
1173         IDE_HFLAG_NO_LBA48_DMA          = (1 << 18),
1174         /* data FIFO is cleared by an error */
1175         IDE_HFLAG_ERROR_STOPS_FIFO      = (1 << 19),
1176         /* serialize ports */
1177         IDE_HFLAG_SERIALIZE             = (1 << 20),
1178         /* use legacy IRQs */
1179         IDE_HFLAG_LEGACY_IRQS           = (1 << 21),
1180         /* force use of legacy IRQs */
1181         IDE_HFLAG_FORCE_LEGACY_IRQS     = (1 << 22),
1182         /* limit LBA48 requests to 256 sectors */
1183         IDE_HFLAG_RQSIZE_256            = (1 << 23),
1184         /* use 32-bit I/O ops */
1185         IDE_HFLAG_IO_32BIT              = (1 << 24),
1186         /* unmask IRQs */
1187         IDE_HFLAG_UNMASK_IRQS           = (1 << 25),
1188         /* serialize ports if DMA is possible (for sl82c105) */
1189         IDE_HFLAG_SERIALIZE_DMA         = (1 << 27),
1190         /* force host out of "simplex" mode */
1191         IDE_HFLAG_CLEAR_SIMPLEX         = (1 << 28),
1192         /* DSC overlap is unsupported */
1193         IDE_HFLAG_NO_DSC                = (1 << 29),
1194         /* never use 32-bit I/O ops */
1195         IDE_HFLAG_NO_IO_32BIT           = (1 << 30),
1196         /* never unmask IRQs */
1197         IDE_HFLAG_NO_UNMASK_IRQS        = (1 << 31),
1198 };
1199
1200 #ifdef CONFIG_BLK_DEV_OFFBOARD
1201 # define IDE_HFLAG_OFF_BOARD    0
1202 #else
1203 # define IDE_HFLAG_OFF_BOARD    IDE_HFLAG_NON_BOOTABLE
1204 #endif
1205
1206 struct ide_port_info {
1207         char                    *name;
1208         unsigned int            (*init_chipset)(struct pci_dev *);
1209         void                    (*init_iops)(ide_hwif_t *);
1210         void                    (*init_hwif)(ide_hwif_t *);
1211         int                     (*init_dma)(ide_hwif_t *,
1212                                             const struct ide_port_info *);
1213
1214         const struct ide_tp_ops         *tp_ops;
1215         const struct ide_port_ops       *port_ops;
1216         const struct ide_dma_ops        *dma_ops;
1217
1218         ide_pci_enablebit_t     enablebits[2];
1219         hwif_chipset_t          chipset;
1220         u32                     host_flags;
1221         u8                      pio_mask;
1222         u8                      swdma_mask;
1223         u8                      mwdma_mask;
1224         u8                      udma_mask;
1225 };
1226
1227 int ide_pci_init_one(struct pci_dev *, const struct ide_port_info *, void *);
1228 int ide_pci_init_two(struct pci_dev *, struct pci_dev *,
1229                      const struct ide_port_info *, void *);
1230 void ide_pci_remove(struct pci_dev *);
1231
1232 void ide_map_sg(ide_drive_t *, struct request *);
1233 void ide_init_sg_cmd(ide_drive_t *, struct request *);
1234
1235 #define BAD_DMA_DRIVE           0
1236 #define GOOD_DMA_DRIVE          1
1237
1238 struct drive_list_entry {
1239         const char *id_model;
1240         const char *id_firmware;
1241 };
1242
1243 int ide_in_drive_list(u16 *, const struct drive_list_entry *);
1244
1245 #ifdef CONFIG_BLK_DEV_IDEDMA
1246 int __ide_dma_bad_drive(ide_drive_t *);
1247 int ide_id_dma_bug(ide_drive_t *);
1248
1249 u8 ide_find_dma_mode(ide_drive_t *, u8);
1250
1251 static inline u8 ide_max_dma_mode(ide_drive_t *drive)
1252 {
1253         return ide_find_dma_mode(drive, XFER_UDMA_6);
1254 }
1255
1256 void ide_dma_off_quietly(ide_drive_t *);
1257 void ide_dma_off(ide_drive_t *);
1258 void ide_dma_on(ide_drive_t *);
1259 int ide_set_dma(ide_drive_t *);
1260 void ide_check_dma_crc(ide_drive_t *);
1261 ide_startstop_t ide_dma_intr(ide_drive_t *);
1262
1263 int ide_build_sglist(ide_drive_t *, struct request *);
1264 void ide_destroy_dmatable(ide_drive_t *);
1265
1266 #ifdef CONFIG_BLK_DEV_IDEDMA_SFF
1267 extern int ide_build_dmatable(ide_drive_t *, struct request *);
1268 int ide_allocate_dma_engine(ide_hwif_t *);
1269 void ide_release_dma_engine(ide_hwif_t *);
1270
1271 void ide_dma_host_set(ide_drive_t *, int);
1272 extern int ide_dma_setup(ide_drive_t *);
1273 void ide_dma_exec_cmd(ide_drive_t *, u8);
1274 extern void ide_dma_start(ide_drive_t *);
1275 extern int __ide_dma_end(ide_drive_t *);
1276 int ide_dma_test_irq(ide_drive_t *);
1277 extern void ide_dma_lost_irq(ide_drive_t *);
1278 extern void ide_dma_timeout(ide_drive_t *);
1279 extern const struct ide_dma_ops sff_dma_ops;
1280 #endif /* CONFIG_BLK_DEV_IDEDMA_SFF */
1281
1282 #else
1283 static inline int ide_id_dma_bug(ide_drive_t *drive) { return 0; }
1284 static inline u8 ide_find_dma_mode(ide_drive_t *drive, u8 speed) { return 0; }
1285 static inline u8 ide_max_dma_mode(ide_drive_t *drive) { return 0; }
1286 static inline void ide_dma_off_quietly(ide_drive_t *drive) { ; }
1287 static inline void ide_dma_off(ide_drive_t *drive) { ; }
1288 static inline void ide_dma_on(ide_drive_t *drive) { ; }
1289 static inline void ide_dma_verbose(ide_drive_t *drive) { ; }
1290 static inline int ide_set_dma(ide_drive_t *drive) { return 1; }
1291 static inline void ide_check_dma_crc(ide_drive_t *drive) { ; }
1292 #endif /* CONFIG_BLK_DEV_IDEDMA */
1293
1294 #ifndef CONFIG_BLK_DEV_IDEDMA_SFF
1295 static inline void ide_release_dma_engine(ide_hwif_t *hwif) { ; }
1296 #endif
1297
1298 #ifdef CONFIG_BLK_DEV_IDEACPI
1299 extern int ide_acpi_exec_tfs(ide_drive_t *drive);
1300 extern void ide_acpi_get_timing(ide_hwif_t *hwif);
1301 extern void ide_acpi_push_timing(ide_hwif_t *hwif);
1302 extern void ide_acpi_init(ide_hwif_t *hwif);
1303 void ide_acpi_port_init_devices(ide_hwif_t *);
1304 extern void ide_acpi_set_state(ide_hwif_t *hwif, int on);
1305 #else
1306 static inline int ide_acpi_exec_tfs(ide_drive_t *drive) { return 0; }
1307 static inline void ide_acpi_get_timing(ide_hwif_t *hwif) { ; }
1308 static inline void ide_acpi_push_timing(ide_hwif_t *hwif) { ; }
1309 static inline void ide_acpi_init(ide_hwif_t *hwif) { ; }
1310 static inline void ide_acpi_port_init_devices(ide_hwif_t *hwif) { ; }
1311 static inline void ide_acpi_set_state(ide_hwif_t *hwif, int on) {}
1312 #endif
1313
1314 void ide_remove_port_from_hwgroup(ide_hwif_t *);
1315 void ide_unregister(ide_hwif_t *);
1316
1317 void ide_register_region(struct gendisk *);
1318 void ide_unregister_region(struct gendisk *);
1319
1320 void ide_undecoded_slave(ide_drive_t *);
1321
1322 void ide_port_apply_params(ide_hwif_t *);
1323
1324 struct ide_host *ide_host_alloc_all(const struct ide_port_info *, hw_regs_t **);
1325 struct ide_host *ide_host_alloc(const struct ide_port_info *, hw_regs_t **);
1326 void ide_host_free(struct ide_host *);
1327 int ide_host_register(struct ide_host *, const struct ide_port_info *,
1328                       hw_regs_t **);
1329 int ide_host_add(const struct ide_port_info *, hw_regs_t **,
1330                  struct ide_host **);
1331 void ide_host_remove(struct ide_host *);
1332 int ide_legacy_device_add(const struct ide_port_info *, unsigned long);
1333 void ide_port_unregister_devices(ide_hwif_t *);
1334 void ide_port_scan(ide_hwif_t *);
1335
1336 static inline void *ide_get_hwifdata (ide_hwif_t * hwif)
1337 {
1338         return hwif->hwif_data;
1339 }
1340
1341 static inline void ide_set_hwifdata (ide_hwif_t * hwif, void *data)
1342 {
1343         hwif->hwif_data = data;
1344 }
1345
1346 const char *ide_xfer_verbose(u8 mode);
1347 extern void ide_toggle_bounce(ide_drive_t *drive, int on);
1348 extern int ide_set_xfer_rate(ide_drive_t *drive, u8 rate);
1349
1350 static inline int ide_dev_has_iordy(u16 *id)
1351 {
1352         return ((id[ATA_ID_FIELD_VALID] & 2) && ata_id_has_iordy(id)) ? 1 : 0;
1353 }
1354
1355 static inline int ide_dev_is_sata(u16 *id)
1356 {
1357         /*
1358          * See if word 93 is 0 AND drive is at least ATA-5 compatible
1359          * verifying that word 80 by casting it to a signed type --
1360          * this trick allows us to filter out the reserved values of
1361          * 0x0000 and 0xffff along with the earlier ATA revisions...
1362          */
1363         if (id[ATA_ID_HW_CONFIG] == 0 && (short)id[ATA_ID_MAJOR_VER] >= 0x0020)
1364                 return 1;
1365         return 0;
1366 }
1367
1368 u64 ide_get_lba_addr(struct ide_taskfile *, int);
1369 u8 ide_dump_status(ide_drive_t *, const char *, u8);
1370
1371 struct ide_timing {
1372         u8  mode;
1373         u8  setup;      /* t1 */
1374         u16 act8b;      /* t2 for 8-bit io */
1375         u16 rec8b;      /* t2i for 8-bit io */
1376         u16 cyc8b;      /* t0 for 8-bit io */
1377         u16 active;     /* t2 or tD */
1378         u16 recover;    /* t2i or tK */
1379         u16 cycle;      /* t0 */
1380         u16 udma;       /* t2CYCTYP/2 */
1381 };
1382
1383 enum {
1384         IDE_TIMING_SETUP        = (1 << 0),
1385         IDE_TIMING_ACT8B        = (1 << 1),
1386         IDE_TIMING_REC8B        = (1 << 2),
1387         IDE_TIMING_CYC8B        = (1 << 3),
1388         IDE_TIMING_8BIT         = IDE_TIMING_ACT8B | IDE_TIMING_REC8B |
1389                                   IDE_TIMING_CYC8B,
1390         IDE_TIMING_ACTIVE       = (1 << 4),
1391         IDE_TIMING_RECOVER      = (1 << 5),
1392         IDE_TIMING_CYCLE        = (1 << 6),
1393         IDE_TIMING_UDMA         = (1 << 7),
1394         IDE_TIMING_ALL          = IDE_TIMING_SETUP | IDE_TIMING_8BIT |
1395                                   IDE_TIMING_ACTIVE | IDE_TIMING_RECOVER |
1396                                   IDE_TIMING_CYCLE | IDE_TIMING_UDMA,
1397 };
1398
1399 struct ide_timing *ide_timing_find_mode(u8);
1400 u16 ide_pio_cycle_time(ide_drive_t *, u8);
1401 void ide_timing_merge(struct ide_timing *, struct ide_timing *,
1402                       struct ide_timing *, unsigned int);
1403 int ide_timing_compute(ide_drive_t *, u8, struct ide_timing *, int, int);
1404
1405 int ide_scan_pio_blacklist(char *);
1406
1407 u8 ide_get_best_pio_mode(ide_drive_t *, u8, u8);
1408
1409 int ide_set_pio_mode(ide_drive_t *, u8);
1410 int ide_set_dma_mode(ide_drive_t *, u8);
1411
1412 void ide_set_pio(ide_drive_t *, u8);
1413
1414 static inline void ide_set_max_pio(ide_drive_t *drive)
1415 {
1416         ide_set_pio(drive, 255);
1417 }
1418
1419 extern spinlock_t ide_lock;
1420 extern struct mutex ide_cfg_mtx;
1421 /*
1422  * Structure locking:
1423  *
1424  * ide_cfg_mtx and ide_lock together protect changes to
1425  * ide_hwif_t->{next,hwgroup}
1426  * ide_drive_t->next
1427  *
1428  * ide_hwgroup_t->busy: ide_lock
1429  * ide_hwgroup_t->hwif: ide_lock
1430  * ide_hwif_t->mate: constant, no locking
1431  * ide_drive_t->hwif: constant, no locking
1432  */
1433
1434 #define local_irq_set(flags)    do { local_save_flags((flags)); local_irq_enable_in_hardirq(); } while (0)
1435
1436 extern struct bus_type ide_bus_type;
1437 extern struct class *ide_port_class;
1438
1439 /* check if CACHE FLUSH (EXT) command is supported (bits defined in ATA-6) */
1440 #define ide_id_has_flush_cache(id)      ((id)[ATA_ID_CFS_ENABLE_2] & 0x3000)
1441
1442 /* some Maxtor disks have bit 13 defined incorrectly so check bit 10 too */
1443 #define ide_id_has_flush_cache_ext(id)  \
1444         (((id)[ATA_ID_CFS_ENABLE_2] & 0x2400) == 0x2400)
1445
1446 static inline void ide_dump_identify(u8 *id)
1447 {
1448         print_hex_dump(KERN_INFO, "", DUMP_PREFIX_NONE, 16, 2, id, 512, 0);
1449 }
1450
1451 static inline int hwif_to_node(ide_hwif_t *hwif)
1452 {
1453         return hwif->dev ? dev_to_node(hwif->dev) : -1;
1454 }
1455
1456 static inline ide_drive_t *ide_get_paired_drive(ide_drive_t *drive)
1457 {
1458         ide_hwif_t *hwif        = HWIF(drive);
1459
1460         return &hwif->drives[(drive->dn ^ 1) & 1];
1461 }
1462 #endif /* _IDE_H */