ide: add struct ide_port_ops (take 2)
[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  * Tune flags
52  */
53 #define IDE_TUNE_NOAUTO         2
54 #define IDE_TUNE_AUTO           1
55 #define IDE_TUNE_DEFAULT        0
56
57 /*
58  * state flags
59  */
60
61 #define DMA_PIO_RETRY   1       /* retrying in PIO */
62
63 #define HWIF(drive)             ((ide_hwif_t *)((drive)->hwif))
64 #define HWGROUP(drive)          ((ide_hwgroup_t *)(HWIF(drive)->hwgroup))
65
66 /*
67  * Definitions for accessing IDE controller registers
68  */
69 #define IDE_NR_PORTS            (10)
70
71 #define IDE_DATA_OFFSET         (0)
72 #define IDE_ERROR_OFFSET        (1)
73 #define IDE_NSECTOR_OFFSET      (2)
74 #define IDE_SECTOR_OFFSET       (3)
75 #define IDE_LCYL_OFFSET         (4)
76 #define IDE_HCYL_OFFSET         (5)
77 #define IDE_SELECT_OFFSET       (6)
78 #define IDE_STATUS_OFFSET       (7)
79 #define IDE_CONTROL_OFFSET      (8)
80 #define IDE_IRQ_OFFSET          (9)
81
82 #define IDE_FEATURE_OFFSET      IDE_ERROR_OFFSET
83 #define IDE_COMMAND_OFFSET      IDE_STATUS_OFFSET
84 #define IDE_ALTSTATUS_OFFSET    IDE_CONTROL_OFFSET
85 #define IDE_IREASON_OFFSET      IDE_NSECTOR_OFFSET
86 #define IDE_BCOUNTL_OFFSET      IDE_LCYL_OFFSET
87 #define IDE_BCOUNTH_OFFSET      IDE_HCYL_OFFSET
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  * Check for an interrupt and acknowledge the interrupt status
143  */
144 struct hwif_s;
145 typedef int (ide_ack_intr_t)(struct hwif_s *);
146
147 /*
148  * hwif_chipset_t is used to keep track of the specific hardware
149  * chipset used by each IDE interface, if known.
150  */
151 enum {          ide_unknown,    ide_generic,    ide_pci,
152                 ide_cmd640,     ide_dtc2278,    ide_ali14xx,
153                 ide_qd65xx,     ide_umc8672,    ide_ht6560b,
154                 ide_rz1000,     ide_trm290,
155                 ide_cmd646,     ide_cy82c693,   ide_4drives,
156                 ide_pmac,       ide_etrax100,   ide_acorn,
157                 ide_au1xxx,     ide_palm3710
158 };
159
160 typedef u8 hwif_chipset_t;
161
162 /*
163  * Structure to hold all information about the location of this port
164  */
165 typedef struct hw_regs_s {
166         unsigned long   io_ports[IDE_NR_PORTS]; /* task file registers */
167         int             irq;                    /* our irq number */
168         ide_ack_intr_t  *ack_intr;              /* acknowledge interrupt */
169         hwif_chipset_t  chipset;
170         struct device   *dev;
171 } hw_regs_t;
172
173 void ide_init_port_data(struct hwif_s *, unsigned int);
174 void ide_init_port_hw(struct hwif_s *, hw_regs_t *);
175
176 static inline void ide_std_init_ports(hw_regs_t *hw,
177                                       unsigned long io_addr,
178                                       unsigned long ctl_addr)
179 {
180         unsigned int i;
181
182         for (i = IDE_DATA_OFFSET; i <= IDE_STATUS_OFFSET; i++)
183                 hw->io_ports[i] = io_addr++;
184
185         hw->io_ports[IDE_CONTROL_OFFSET] = ctl_addr;
186 }
187
188 #include <asm/ide.h>
189
190 #if !defined(MAX_HWIFS) || defined(CONFIG_EMBEDDED)
191 #undef MAX_HWIFS
192 #define MAX_HWIFS       CONFIG_IDE_MAX_HWIFS
193 #endif
194
195 /* Currently only m68k, apus and m8xx need it */
196 #ifndef IDE_ARCH_ACK_INTR
197 # define ide_ack_intr(hwif) (1)
198 #endif
199
200 /* Currently only Atari needs it */
201 #ifndef IDE_ARCH_LOCK
202 # define ide_release_lock()                     do {} while (0)
203 # define ide_get_lock(hdlr, data)               do {} while (0)
204 #endif /* IDE_ARCH_LOCK */
205
206 /*
207  * Now for the data we need to maintain per-drive:  ide_drive_t
208  */
209
210 #define ide_scsi        0x21
211 #define ide_disk        0x20
212 #define ide_optical     0x7
213 #define ide_cdrom       0x5
214 #define ide_tape        0x1
215 #define ide_floppy      0x0
216
217 /*
218  * Special Driver Flags
219  *
220  * set_geometry : respecify drive geometry
221  * recalibrate  : seek to cyl 0
222  * set_multmode : set multmode count
223  * set_tune     : tune interface for drive
224  * serviced     : service command
225  * reserved     : unused
226  */
227 typedef union {
228         unsigned all                    : 8;
229         struct {
230                 unsigned set_geometry   : 1;
231                 unsigned recalibrate    : 1;
232                 unsigned set_multmode   : 1;
233                 unsigned set_tune       : 1;
234                 unsigned serviced       : 1;
235                 unsigned reserved       : 3;
236         } b;
237 } special_t;
238
239 /*
240  * ATA-IDE Select Register, aka Device-Head
241  *
242  * head         : always zeros here
243  * unit         : drive select number: 0/1
244  * bit5         : always 1
245  * lba          : using LBA instead of CHS
246  * bit7         : always 1
247  */
248 typedef union {
249         unsigned all                    : 8;
250         struct {
251 #if defined(__LITTLE_ENDIAN_BITFIELD)
252                 unsigned head           : 4;
253                 unsigned unit           : 1;
254                 unsigned bit5           : 1;
255                 unsigned lba            : 1;
256                 unsigned bit7           : 1;
257 #elif defined(__BIG_ENDIAN_BITFIELD)
258                 unsigned bit7           : 1;
259                 unsigned lba            : 1;
260                 unsigned bit5           : 1;
261                 unsigned unit           : 1;
262                 unsigned head           : 4;
263 #else
264 #error "Please fix <asm/byteorder.h>"
265 #endif
266         } b;
267 } select_t, ata_select_t;
268
269 /*
270  * Status returned from various ide_ functions
271  */
272 typedef enum {
273         ide_stopped,    /* no drive operation was started */
274         ide_started,    /* a drive operation was started, handler was set */
275 } ide_startstop_t;
276
277 struct ide_driver_s;
278 struct ide_settings_s;
279
280 #ifdef CONFIG_BLK_DEV_IDEACPI
281 struct ide_acpi_drive_link;
282 struct ide_acpi_hwif_link;
283 #endif
284
285 typedef struct ide_drive_s {
286         char            name[4];        /* drive name, such as "hda" */
287         char            driver_req[10]; /* requests specific driver */
288
289         struct request_queue    *queue; /* request queue */
290
291         struct request          *rq;    /* current request */
292         struct ide_drive_s      *next;  /* circular list of hwgroup drives */
293         void            *driver_data;   /* extra driver data */
294         struct hd_driveid       *id;    /* drive model identification info */
295 #ifdef CONFIG_IDE_PROC_FS
296         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
297         struct ide_settings_s *settings;/* /proc/ide/ drive settings */
298 #endif
299         struct hwif_s           *hwif;  /* actually (ide_hwif_t *) */
300
301         unsigned long sleep;            /* sleep until this time */
302         unsigned long service_start;    /* time we started last request */
303         unsigned long service_time;     /* service time of last request */
304         unsigned long timeout;          /* max time to wait for irq */
305
306         special_t       special;        /* special action flags */
307         select_t        select;         /* basic drive/head select reg value */
308
309         u8      keep_settings;          /* restore settings after drive reset */
310         u8      using_dma;              /* disk is using dma for read/write */
311         u8      retry_pio;              /* retrying dma capable host in pio */
312         u8      state;                  /* retry state */
313         u8      waiting_for_dma;        /* dma currently in progress */
314         u8      unmask;                 /* okay to unmask other irqs */
315         u8      noflush;                /* don't attempt flushes */
316         u8      dsc_overlap;            /* DSC overlap */
317         u8      nice1;                  /* give potential excess bandwidth */
318
319         unsigned present        : 1;    /* drive is physically present */
320         unsigned dead           : 1;    /* device ejected hint */
321         unsigned id_read        : 1;    /* 1=id read from disk 0 = synthetic */
322         unsigned noprobe        : 1;    /* from:  hdx=noprobe */
323         unsigned removable      : 1;    /* 1 if need to do check_media_change */
324         unsigned attach         : 1;    /* needed for removable devices */
325         unsigned forced_geom    : 1;    /* 1 if hdx=c,h,s was given at boot */
326         unsigned no_unmask      : 1;    /* disallow setting unmask bit */
327         unsigned no_io_32bit    : 1;    /* disallow enabling 32bit I/O */
328         unsigned atapi_overlap  : 1;    /* ATAPI overlap (not supported) */
329         unsigned doorlocking    : 1;    /* for removable only: door lock/unlock works */
330         unsigned nodma          : 1;    /* disallow DMA */
331         unsigned autotune       : 2;    /* 0=default, 1=autotune, 2=noautotune */
332         unsigned remap_0_to_1   : 1;    /* 0=noremap, 1=remap 0->1 (for EZDrive) */
333         unsigned blocked        : 1;    /* 1=powermanagment told us not to do anything, so sleep nicely */
334         unsigned vdma           : 1;    /* 1=doing PIO over DMA 0=doing normal DMA */
335         unsigned scsi           : 1;    /* 0=default, 1=ide-scsi emulation */
336         unsigned sleeping       : 1;    /* 1=sleeping & sleep field valid */
337         unsigned post_reset     : 1;
338         unsigned udma33_warned  : 1;
339
340         u8      addressing;     /* 0=28-bit, 1=48-bit, 2=48-bit doing 28-bit */
341         u8      quirk_list;     /* considered quirky, set for a specific host */
342         u8      init_speed;     /* transfer rate set at boot */
343         u8      current_speed;  /* current transfer rate set */
344         u8      desired_speed;  /* desired transfer rate set */
345         u8      dn;             /* now wide spread use */
346         u8      wcache;         /* status of write cache */
347         u8      acoustic;       /* acoustic management */
348         u8      media;          /* disk, cdrom, tape, floppy, ... */
349         u8      ctl;            /* "normal" value for Control register */
350         u8      ready_stat;     /* min status value for drive ready */
351         u8      mult_count;     /* current multiple sector setting */
352         u8      mult_req;       /* requested multiple sector setting */
353         u8      tune_req;       /* requested drive tuning setting */
354         u8      io_32bit;       /* 0=16-bit, 1=32-bit, 2/3=32bit+sync */
355         u8      bad_wstat;      /* used for ignoring WRERR_STAT */
356         u8      nowerr;         /* used for ignoring WRERR_STAT */
357         u8      sect0;          /* offset of first sector for DM6:DDO */
358         u8      head;           /* "real" number of heads */
359         u8      sect;           /* "real" sectors per track */
360         u8      bios_head;      /* BIOS/fdisk/LILO number of heads */
361         u8      bios_sect;      /* BIOS/fdisk/LILO sectors per track */
362
363         unsigned int    bios_cyl;       /* BIOS/fdisk/LILO number of cyls */
364         unsigned int    cyl;            /* "real" number of cyls */
365         unsigned int    drive_data;     /* used by set_pio_mode/selectproc */
366         unsigned int    failures;       /* current failure count */
367         unsigned int    max_failures;   /* maximum allowed failure count */
368         u64             probed_capacity;/* initial reported media capacity (ide-cd only currently) */
369
370         u64             capacity64;     /* total number of sectors */
371
372         int             lun;            /* logical unit */
373         int             crc_count;      /* crc counter to reduce drive speed */
374 #ifdef CONFIG_BLK_DEV_IDEACPI
375         struct ide_acpi_drive_link *acpidata;
376 #endif
377         struct list_head list;
378         struct device   gendev;
379         struct completion gendev_rel_comp;      /* to deal with device release() */
380 } ide_drive_t;
381
382 #define to_ide_device(dev)container_of(dev, ide_drive_t, gendev)
383
384 #define IDE_CHIPSET_PCI_MASK    \
385     ((1<<ide_pci)|(1<<ide_cmd646)|(1<<ide_ali14xx))
386 #define IDE_CHIPSET_IS_PCI(c)   ((IDE_CHIPSET_PCI_MASK >> (c)) & 1)
387
388 struct ide_port_info;
389
390 struct ide_port_ops {
391         /* host specific initialization of devices on a port */
392         void    (*port_init_devs)(struct hwif_s *);
393         /* routine to program host for PIO mode */
394         void    (*set_pio_mode)(ide_drive_t *, const u8);
395         /* routine to program host for DMA mode */
396         void    (*set_dma_mode)(ide_drive_t *, const u8);
397         /* tweaks hardware to select drive */
398         void    (*selectproc)(ide_drive_t *);
399         /* chipset polling based on hba specifics */
400         int     (*reset_poll)(ide_drive_t *);
401         /* chipset specific changes to default for device-hba resets */
402         void    (*pre_reset)(ide_drive_t *);
403         /* routine to reset controller after a disk reset */
404         void    (*resetproc)(ide_drive_t *);
405         /* special host masking for drive selection */
406         void    (*maskproc)(ide_drive_t *, int);
407         /* check host's drive quirk list */
408         void    (*quirkproc)(ide_drive_t *);
409
410         u8      (*mdma_filter)(ide_drive_t *);
411         u8      (*udma_filter)(ide_drive_t *);
412
413         u8      (*cable_detect)(struct hwif_s *);
414 };
415
416 typedef struct hwif_s {
417         struct hwif_s *next;            /* for linked-list in ide_hwgroup_t */
418         struct hwif_s *mate;            /* other hwif from same PCI chip */
419         struct hwgroup_s *hwgroup;      /* actually (ide_hwgroup_t *) */
420         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
421
422         char name[6];                   /* name of interface, eg. "ide0" */
423
424                 /* task file registers for pata and sata */
425         unsigned long   io_ports[IDE_NR_PORTS];
426         unsigned long   sata_scr[SATA_NR_PORTS];
427
428         ide_drive_t     drives[MAX_DRIVES];     /* drive info */
429
430         u8 major;       /* our major number */
431         u8 index;       /* 0 for ide0; 1 for ide1; ... */
432         u8 channel;     /* for dual-port chips: 0=primary, 1=secondary */
433         u8 bus_state;   /* power state of the IDE bus */
434
435         u32 host_flags;
436
437         u8 pio_mask;
438
439         u8 ultra_mask;
440         u8 mwdma_mask;
441         u8 swdma_mask;
442
443         u8 cbl;         /* cable type */
444
445         hwif_chipset_t chipset; /* sub-module for tuning.. */
446
447         struct device *dev;
448
449         const struct ide_port_info *cds;        /* chipset device struct */
450
451         ide_ack_intr_t *ack_intr;
452
453         void (*rw_disk)(ide_drive_t *, struct request *);
454
455         const struct ide_port_ops       *port_ops;
456
457         void (*ata_input_data)(ide_drive_t *, void *, u32);
458         void (*ata_output_data)(ide_drive_t *, void *, u32);
459
460         void (*atapi_input_bytes)(ide_drive_t *, void *, u32);
461         void (*atapi_output_bytes)(ide_drive_t *, void *, u32);
462
463         void (*dma_host_set)(ide_drive_t *, int);
464         int (*dma_setup)(ide_drive_t *);
465         void (*dma_exec_cmd)(ide_drive_t *, u8);
466         void (*dma_start)(ide_drive_t *);
467         int (*ide_dma_end)(ide_drive_t *drive);
468         int (*ide_dma_test_irq)(ide_drive_t *drive);
469         void (*ide_dma_clear_irq)(ide_drive_t *drive);
470         void (*dma_lost_irq)(ide_drive_t *drive);
471         void (*dma_timeout)(ide_drive_t *drive);
472
473         void (*OUTB)(u8 addr, unsigned long port);
474         void (*OUTBSYNC)(ide_drive_t *drive, u8 addr, unsigned long port);
475         void (*OUTW)(u16 addr, unsigned long port);
476         void (*OUTSW)(unsigned long port, void *addr, u32 count);
477         void (*OUTSL)(unsigned long port, void *addr, u32 count);
478
479         u8  (*INB)(unsigned long port);
480         u16 (*INW)(unsigned long port);
481         void (*INSW)(unsigned long port, void *addr, u32 count);
482         void (*INSL)(unsigned long port, void *addr, u32 count);
483
484         /* dma physical region descriptor table (cpu view) */
485         unsigned int    *dmatable_cpu;
486         /* dma physical region descriptor table (dma view) */
487         dma_addr_t      dmatable_dma;
488         /* Scatter-gather list used to build the above */
489         struct scatterlist *sg_table;
490         int sg_max_nents;               /* Maximum number of entries in it */
491         int sg_nents;                   /* Current number of entries in it */
492         int sg_dma_direction;           /* dma transfer direction */
493
494         /* data phase of the active command (currently only valid for PIO/DMA) */
495         int             data_phase;
496
497         unsigned int nsect;
498         unsigned int nleft;
499         struct scatterlist *cursg;
500         unsigned int cursg_ofs;
501
502         int             rqsize;         /* max sectors per request */
503         int             irq;            /* our irq number */
504
505         unsigned long   dma_base;       /* base addr for dma ports */
506         unsigned long   dma_command;    /* dma command register */
507         unsigned long   dma_vendor1;    /* dma vendor 1 register */
508         unsigned long   dma_status;     /* dma status register */
509         unsigned long   dma_vendor3;    /* dma vendor 3 register */
510         unsigned long   dma_prdtable;   /* actual prd table address */
511
512         unsigned long   config_data;    /* for use by chipset-specific code */
513         unsigned long   select_data;    /* for use by chipset-specific code */
514
515         unsigned long   extra_base;     /* extra addr for dma ports */
516         unsigned        extra_ports;    /* number of extra dma ports */
517
518         unsigned        noprobe    : 1; /* don't probe for this interface */
519         unsigned        present    : 1; /* this interface exists */
520         unsigned        serialized : 1; /* serialized all channel operation */
521         unsigned        sharing_irq: 1; /* 1 = sharing irq with another hwif */
522         unsigned        reset      : 1; /* reset after probe */
523         unsigned        sg_mapped  : 1; /* sg_table and sg_nents are ready */
524         unsigned        mmio       : 1; /* host uses MMIO */
525
526         struct device           gendev;
527         struct device           *portdev;
528
529         struct completion gendev_rel_comp; /* To deal with device release() */
530
531         void            *hwif_data;     /* extra hwif data */
532
533         unsigned dma;
534
535 #ifdef CONFIG_BLK_DEV_IDEACPI
536         struct ide_acpi_hwif_link *acpidata;
537 #endif
538 } ____cacheline_internodealigned_in_smp ide_hwif_t;
539
540 /*
541  *  internal ide interrupt handler type
542  */
543 typedef ide_startstop_t (ide_handler_t)(ide_drive_t *);
544 typedef int (ide_expiry_t)(ide_drive_t *);
545
546 /* used by ide-cd, ide-floppy, etc. */
547 typedef void (xfer_func_t)(ide_drive_t *, void *, u32);
548
549 typedef struct hwgroup_s {
550                 /* irq handler, if active */
551         ide_startstop_t (*handler)(ide_drive_t *);
552
553                 /* BOOL: protects all fields below */
554         volatile int busy;
555                 /* BOOL: wake us up on timer expiry */
556         unsigned int sleeping   : 1;
557                 /* BOOL: polling active & poll_timeout field valid */
558         unsigned int polling    : 1;
559                 /* BOOL: in a polling reset situation. Must not trigger another reset yet */
560         unsigned int resetting  : 1;
561
562                 /* current drive */
563         ide_drive_t *drive;
564                 /* ptr to current hwif in linked-list */
565         ide_hwif_t *hwif;
566
567                 /* current request */
568         struct request *rq;
569
570                 /* failsafe timer */
571         struct timer_list timer;
572                 /* timeout value during long polls */
573         unsigned long poll_timeout;
574                 /* queried upon timeouts */
575         int (*expiry)(ide_drive_t *);
576
577         int req_gen;
578         int req_gen_timer;
579 } ide_hwgroup_t;
580
581 typedef struct ide_driver_s ide_driver_t;
582
583 extern struct mutex ide_setting_mtx;
584
585 int set_io_32bit(ide_drive_t *, int);
586 int set_pio_mode(ide_drive_t *, int);
587 int set_using_dma(ide_drive_t *, int);
588
589 /* ATAPI packet command flags */
590 enum {
591         /* set when an error is considered normal - no retry (ide-tape) */
592         PC_FLAG_ABORT                   = (1 << 0),
593         PC_FLAG_SUPPRESS_ERROR          = (1 << 1),
594         PC_FLAG_WAIT_FOR_DSC            = (1 << 2),
595         PC_FLAG_DMA_OK                  = (1 << 3),
596         PC_FLAG_DMA_RECOMMENDED         = (1 << 4),
597         PC_FLAG_DMA_IN_PROGRESS         = (1 << 5),
598         PC_FLAG_DMA_ERROR               = (1 << 6),
599         PC_FLAG_WRITING                 = (1 << 7),
600         /* command timed out */
601         PC_FLAG_TIMEDOUT                = (1 << 8),
602 };
603
604 struct ide_atapi_pc {
605         /* actual packet bytes */
606         u8 c[12];
607         /* incremented on each retry */
608         int retries;
609         int error;
610
611         /* bytes to transfer */
612         int req_xfer;
613         /* bytes actually transferred */
614         int xferred;
615
616         /* data buffer */
617         u8 *buf;
618         /* current buffer position */
619         u8 *cur_pos;
620         int buf_size;
621         /* missing/available data on the current buffer */
622         int b_count;
623
624         /* the corresponding request */
625         struct request *rq;
626
627         unsigned long flags;
628
629         /*
630          * those are more or less driver-specific and some of them are subject
631          * to change/removal later.
632          */
633         u8 pc_buf[256];
634         void (*idefloppy_callback) (ide_drive_t *);
635         ide_startstop_t (*idetape_callback) (ide_drive_t *);
636
637         /* idetape only */
638         struct idetape_bh *bh;
639         char *b_data;
640
641         /* idescsi only for now */
642         struct scatterlist *sg;
643         unsigned int sg_cnt;
644
645         struct scsi_cmnd *scsi_cmd;
646         void (*done) (struct scsi_cmnd *);
647
648         unsigned long timeout;
649 };
650
651 #ifdef CONFIG_IDE_PROC_FS
652 /*
653  * configurable drive settings
654  */
655
656 #define TYPE_INT        0
657 #define TYPE_BYTE       1
658 #define TYPE_SHORT      2
659
660 #define SETTING_READ    (1 << 0)
661 #define SETTING_WRITE   (1 << 1)
662 #define SETTING_RW      (SETTING_READ | SETTING_WRITE)
663
664 typedef int (ide_procset_t)(ide_drive_t *, int);
665 typedef struct ide_settings_s {
666         char                    *name;
667         int                     rw;
668         int                     data_type;
669         int                     min;
670         int                     max;
671         int                     mul_factor;
672         int                     div_factor;
673         void                    *data;
674         ide_procset_t           *set;
675         int                     auto_remove;
676         struct ide_settings_s   *next;
677 } ide_settings_t;
678
679 int ide_add_setting(ide_drive_t *, const char *, int, int, int, int, int, int, void *, ide_procset_t *set);
680
681 /*
682  * /proc/ide interface
683  */
684 typedef struct {
685         const char      *name;
686         mode_t          mode;
687         read_proc_t     *read_proc;
688         write_proc_t    *write_proc;
689 } ide_proc_entry_t;
690
691 void proc_ide_create(void);
692 void proc_ide_destroy(void);
693 void ide_proc_register_port(ide_hwif_t *);
694 void ide_proc_port_register_devices(ide_hwif_t *);
695 void ide_proc_unregister_device(ide_drive_t *);
696 void ide_proc_unregister_port(ide_hwif_t *);
697 void ide_proc_register_driver(ide_drive_t *, ide_driver_t *);
698 void ide_proc_unregister_driver(ide_drive_t *, ide_driver_t *);
699
700 void ide_add_generic_settings(ide_drive_t *);
701
702 read_proc_t proc_ide_read_capacity;
703 read_proc_t proc_ide_read_geometry;
704
705 #ifdef CONFIG_BLK_DEV_IDEPCI
706 void ide_pci_create_host_proc(const char *, get_info_t *);
707 #endif
708
709 /*
710  * Standard exit stuff:
711  */
712 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) \
713 {                                       \
714         len -= off;                     \
715         if (len < count) {              \
716                 *eof = 1;               \
717                 if (len <= 0)           \
718                         return 0;       \
719         } else                          \
720                 len = count;            \
721         *start = page + off;            \
722         return len;                     \
723 }
724 #else
725 static inline void proc_ide_create(void) { ; }
726 static inline void proc_ide_destroy(void) { ; }
727 static inline void ide_proc_register_port(ide_hwif_t *hwif) { ; }
728 static inline void ide_proc_port_register_devices(ide_hwif_t *hwif) { ; }
729 static inline void ide_proc_unregister_device(ide_drive_t *drive) { ; }
730 static inline void ide_proc_unregister_port(ide_hwif_t *hwif) { ; }
731 static inline void ide_proc_register_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
732 static inline void ide_proc_unregister_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
733 static inline void ide_add_generic_settings(ide_drive_t *drive) { ; }
734 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) return 0;
735 #endif
736
737 /*
738  * Power Management step value (rq->pm->pm_step).
739  *
740  * The step value starts at 0 (ide_pm_state_start_suspend) for a
741  * suspend operation or 1000 (ide_pm_state_start_resume) for a
742  * resume operation.
743  *
744  * For each step, the core calls the subdriver start_power_step() first.
745  * This can return:
746  *      - ide_stopped : In this case, the core calls us back again unless
747  *                      step have been set to ide_power_state_completed.
748  *      - ide_started : In this case, the channel is left busy until an
749  *                      async event (interrupt) occurs.
750  * Typically, start_power_step() will issue a taskfile request with
751  * do_rw_taskfile().
752  *
753  * Upon reception of the interrupt, the core will call complete_power_step()
754  * with the error code if any. This routine should update the step value
755  * and return. It should not start a new request. The core will call
756  * start_power_step for the new step value, unless step have been set to
757  * ide_power_state_completed.
758  *
759  * Subdrivers are expected to define their own additional power
760  * steps from 1..999 for suspend and from 1001..1999 for resume,
761  * other values are reserved for future use.
762  */
763
764 enum {
765         ide_pm_state_completed          = -1,
766         ide_pm_state_start_suspend      = 0,
767         ide_pm_state_start_resume       = 1000,
768 };
769
770 /*
771  * Subdrivers support.
772  *
773  * The gendriver.owner field should be set to the module owner of this driver.
774  * The gendriver.name field should be set to the name of this driver
775  */
776 struct ide_driver_s {
777         const char                      *version;
778         u8                              media;
779         unsigned supports_dsc_overlap   : 1;
780         ide_startstop_t (*do_request)(ide_drive_t *, struct request *, sector_t);
781         int             (*end_request)(ide_drive_t *, int, int);
782         ide_startstop_t (*error)(ide_drive_t *, struct request *rq, u8, u8);
783         ide_startstop_t (*abort)(ide_drive_t *, struct request *rq);
784         struct device_driver    gen_driver;
785         int             (*probe)(ide_drive_t *);
786         void            (*remove)(ide_drive_t *);
787         void            (*resume)(ide_drive_t *);
788         void            (*shutdown)(ide_drive_t *);
789 #ifdef CONFIG_IDE_PROC_FS
790         ide_proc_entry_t        *proc;
791 #endif
792 };
793
794 #define to_ide_driver(drv) container_of(drv, ide_driver_t, gen_driver)
795
796 int generic_ide_ioctl(ide_drive_t *, struct file *, struct block_device *, unsigned, unsigned long);
797
798 /*
799  * ide_hwifs[] is the master data structure used to keep track
800  * of just about everything in ide.c.  Whenever possible, routines
801  * should be using pointers to a drive (ide_drive_t *) or
802  * pointers to a hwif (ide_hwif_t *), rather than indexing this
803  * structure directly (the allocation/layout may change!).
804  *
805  */
806 #ifndef _IDE_C
807 extern  ide_hwif_t      ide_hwifs[];            /* master data repository */
808 #endif
809 extern int noautodma;
810
811 ide_hwif_t *ide_find_port_slot(const struct ide_port_info *);
812
813 static inline ide_hwif_t *ide_find_port(void)
814 {
815         return ide_find_port_slot(NULL);
816 }
817
818 extern int ide_end_request (ide_drive_t *drive, int uptodate, int nrsecs);
819 int ide_end_dequeued_request(ide_drive_t *drive, struct request *rq,
820                              int uptodate, int nr_sectors);
821
822 extern void ide_set_handler (ide_drive_t *drive, ide_handler_t *handler, unsigned int timeout, ide_expiry_t *expiry);
823
824 void ide_execute_command(ide_drive_t *, u8, ide_handler_t *, unsigned int,
825                          ide_expiry_t *);
826
827 ide_startstop_t __ide_error(ide_drive_t *, struct request *, u8, u8);
828
829 ide_startstop_t ide_error (ide_drive_t *drive, const char *msg, byte stat);
830
831 ide_startstop_t __ide_abort(ide_drive_t *, struct request *);
832
833 extern ide_startstop_t ide_abort(ide_drive_t *, const char *);
834
835 extern void ide_fix_driveid(struct hd_driveid *);
836
837 extern void ide_fixstring(u8 *, const int, const int);
838
839 int ide_wait_stat(ide_startstop_t *, ide_drive_t *, u8, u8, unsigned long);
840
841 extern ide_startstop_t ide_do_reset (ide_drive_t *);
842
843 extern void ide_init_drive_cmd (struct request *rq);
844
845 /*
846  * "action" parameter type for ide_do_drive_cmd() below.
847  */
848 typedef enum {
849         ide_wait,       /* insert rq at end of list, and wait for it */
850         ide_preempt,    /* insert rq in front of current request */
851         ide_head_wait,  /* insert rq in front of current request and wait for it */
852         ide_end         /* insert rq at end of list, but don't wait for it */
853 } ide_action_t;
854
855 extern int ide_do_drive_cmd(ide_drive_t *, struct request *, ide_action_t);
856
857 extern void ide_end_drive_cmd(ide_drive_t *, u8, u8);
858
859 enum {
860         IDE_TFLAG_LBA48                 = (1 << 0),
861         IDE_TFLAG_NO_SELECT_MASK        = (1 << 1),
862         IDE_TFLAG_FLAGGED               = (1 << 2),
863         IDE_TFLAG_OUT_DATA              = (1 << 3),
864         IDE_TFLAG_OUT_HOB_FEATURE       = (1 << 4),
865         IDE_TFLAG_OUT_HOB_NSECT         = (1 << 5),
866         IDE_TFLAG_OUT_HOB_LBAL          = (1 << 6),
867         IDE_TFLAG_OUT_HOB_LBAM          = (1 << 7),
868         IDE_TFLAG_OUT_HOB_LBAH          = (1 << 8),
869         IDE_TFLAG_OUT_HOB               = IDE_TFLAG_OUT_HOB_FEATURE |
870                                           IDE_TFLAG_OUT_HOB_NSECT |
871                                           IDE_TFLAG_OUT_HOB_LBAL |
872                                           IDE_TFLAG_OUT_HOB_LBAM |
873                                           IDE_TFLAG_OUT_HOB_LBAH,
874         IDE_TFLAG_OUT_FEATURE           = (1 << 9),
875         IDE_TFLAG_OUT_NSECT             = (1 << 10),
876         IDE_TFLAG_OUT_LBAL              = (1 << 11),
877         IDE_TFLAG_OUT_LBAM              = (1 << 12),
878         IDE_TFLAG_OUT_LBAH              = (1 << 13),
879         IDE_TFLAG_OUT_TF                = IDE_TFLAG_OUT_FEATURE |
880                                           IDE_TFLAG_OUT_NSECT |
881                                           IDE_TFLAG_OUT_LBAL |
882                                           IDE_TFLAG_OUT_LBAM |
883                                           IDE_TFLAG_OUT_LBAH,
884         IDE_TFLAG_OUT_DEVICE            = (1 << 14),
885         IDE_TFLAG_WRITE                 = (1 << 15),
886         IDE_TFLAG_FLAGGED_SET_IN_FLAGS  = (1 << 16),
887         IDE_TFLAG_IN_DATA               = (1 << 17),
888         IDE_TFLAG_CUSTOM_HANDLER        = (1 << 18),
889         IDE_TFLAG_DMA_PIO_FALLBACK      = (1 << 19),
890         IDE_TFLAG_IN_HOB_FEATURE        = (1 << 20),
891         IDE_TFLAG_IN_HOB_NSECT          = (1 << 21),
892         IDE_TFLAG_IN_HOB_LBAL           = (1 << 22),
893         IDE_TFLAG_IN_HOB_LBAM           = (1 << 23),
894         IDE_TFLAG_IN_HOB_LBAH           = (1 << 24),
895         IDE_TFLAG_IN_HOB_LBA            = IDE_TFLAG_IN_HOB_LBAL |
896                                           IDE_TFLAG_IN_HOB_LBAM |
897                                           IDE_TFLAG_IN_HOB_LBAH,
898         IDE_TFLAG_IN_HOB                = IDE_TFLAG_IN_HOB_FEATURE |
899                                           IDE_TFLAG_IN_HOB_NSECT |
900                                           IDE_TFLAG_IN_HOB_LBA,
901         IDE_TFLAG_IN_NSECT              = (1 << 25),
902         IDE_TFLAG_IN_LBAL               = (1 << 26),
903         IDE_TFLAG_IN_LBAM               = (1 << 27),
904         IDE_TFLAG_IN_LBAH               = (1 << 28),
905         IDE_TFLAG_IN_LBA                = IDE_TFLAG_IN_LBAL |
906                                           IDE_TFLAG_IN_LBAM |
907                                           IDE_TFLAG_IN_LBAH,
908         IDE_TFLAG_IN_TF                 = IDE_TFLAG_IN_NSECT |
909                                           IDE_TFLAG_IN_LBA,
910         IDE_TFLAG_IN_DEVICE             = (1 << 29),
911         IDE_TFLAG_HOB                   = IDE_TFLAG_OUT_HOB |
912                                           IDE_TFLAG_IN_HOB,
913         IDE_TFLAG_TF                    = IDE_TFLAG_OUT_TF |
914                                           IDE_TFLAG_IN_TF,
915         IDE_TFLAG_DEVICE                = IDE_TFLAG_OUT_DEVICE |
916                                           IDE_TFLAG_IN_DEVICE,
917         /* force 16-bit I/O operations */
918         IDE_TFLAG_IO_16BIT              = (1 << 30),
919         /* ide_task_t was allocated using kmalloc() */
920         IDE_TFLAG_DYN                   = (1 << 31),
921 };
922
923 struct ide_taskfile {
924         u8      hob_data;       /*  0: high data byte (for TASKFILE IOCTL) */
925
926         u8      hob_feature;    /*  1-5: additional data to support LBA48 */
927         u8      hob_nsect;
928         u8      hob_lbal;
929         u8      hob_lbam;
930         u8      hob_lbah;
931
932         u8      data;           /*  6: low data byte (for TASKFILE IOCTL) */
933
934         union {                 /*  7: */
935                 u8 error;       /*   read:  error */
936                 u8 feature;     /*  write: feature */
937         };
938
939         u8      nsect;          /*  8: number of sectors */
940         u8      lbal;           /*  9: LBA low */
941         u8      lbam;           /* 10: LBA mid */
942         u8      lbah;           /* 11: LBA high */
943
944         u8      device;         /* 12: device select */
945
946         union {                 /* 13: */
947                 u8 status;      /*  read: status  */
948                 u8 command;     /* write: command */
949         };
950 };
951
952 typedef struct ide_task_s {
953         union {
954                 struct ide_taskfile     tf;
955                 u8                      tf_array[14];
956         };
957         u32                     tf_flags;
958         int                     data_phase;
959         struct request          *rq;            /* copy of request */
960         void                    *special;       /* valid_t generally */
961 } ide_task_t;
962
963 void ide_tf_load(ide_drive_t *, ide_task_t *);
964 void ide_tf_read(ide_drive_t *, ide_task_t *);
965
966 extern void SELECT_DRIVE(ide_drive_t *);
967 extern void SELECT_MASK(ide_drive_t *, int);
968
969 extern int drive_is_ready(ide_drive_t *);
970
971 void ide_pktcmd_tf_load(ide_drive_t *, u32, u16, u8);
972
973 ide_startstop_t do_rw_taskfile(ide_drive_t *, ide_task_t *);
974
975 void task_end_request(ide_drive_t *, struct request *, u8);
976
977 int ide_raw_taskfile(ide_drive_t *, ide_task_t *, u8 *, u16);
978 int ide_no_data_taskfile(ide_drive_t *, ide_task_t *);
979
980 int ide_taskfile_ioctl(ide_drive_t *, unsigned int, unsigned long);
981 int ide_cmd_ioctl(ide_drive_t *, unsigned int, unsigned long);
982 int ide_task_ioctl(ide_drive_t *, unsigned int, unsigned long);
983
984 extern int system_bus_clock(void);
985
986 extern int ide_driveid_update(ide_drive_t *);
987 extern int ide_config_drive_speed(ide_drive_t *, u8);
988 extern u8 eighty_ninty_three (ide_drive_t *);
989 extern int taskfile_lib_get_identify(ide_drive_t *drive, u8 *);
990
991 extern int ide_wait_not_busy(ide_hwif_t *hwif, unsigned long timeout);
992
993 extern void ide_stall_queue(ide_drive_t *drive, unsigned long timeout);
994
995 extern int ide_spin_wait_hwgroup(ide_drive_t *);
996 extern void ide_timer_expiry(unsigned long);
997 extern irqreturn_t ide_intr(int irq, void *dev_id);
998 extern void do_ide_request(struct request_queue *);
999
1000 void ide_init_disk(struct gendisk *, ide_drive_t *);
1001
1002 #ifdef CONFIG_IDEPCI_PCIBUS_ORDER
1003 extern int __ide_pci_register_driver(struct pci_driver *driver, struct module *owner, const char *mod_name);
1004 #define ide_pci_register_driver(d) __ide_pci_register_driver(d, THIS_MODULE, KBUILD_MODNAME)
1005 #else
1006 #define ide_pci_register_driver(d) pci_register_driver(d)
1007 #endif
1008
1009 void ide_pci_setup_ports(struct pci_dev *, const struct ide_port_info *, int, u8 *);
1010 void ide_setup_pci_noise(struct pci_dev *, const struct ide_port_info *);
1011
1012 #ifdef CONFIG_BLK_DEV_IDEDMA_PCI
1013 void ide_hwif_setup_dma(ide_hwif_t *, const struct ide_port_info *);
1014 #else
1015 static inline void ide_hwif_setup_dma(ide_hwif_t *hwif,
1016                                       const struct ide_port_info *d) { }
1017 #endif
1018
1019 extern void default_hwif_iops(ide_hwif_t *);
1020 extern void default_hwif_mmiops(ide_hwif_t *);
1021 extern void default_hwif_transport(ide_hwif_t *);
1022
1023 typedef struct ide_pci_enablebit_s {
1024         u8      reg;    /* byte pci reg holding the enable-bit */
1025         u8      mask;   /* mask to isolate the enable-bit */
1026         u8      val;    /* value of masked reg when "enabled" */
1027 } ide_pci_enablebit_t;
1028
1029 enum {
1030         /* Uses ISA control ports not PCI ones. */
1031         IDE_HFLAG_ISA_PORTS             = (1 << 0),
1032         /* single port device */
1033         IDE_HFLAG_SINGLE                = (1 << 1),
1034         /* don't use legacy PIO blacklist */
1035         IDE_HFLAG_PIO_NO_BLACKLIST      = (1 << 2),
1036         /* set for the second port of QD65xx */
1037         IDE_HFLAG_QD_2ND_PORT           = (1 << 3),
1038         /* use PIO8/9 for prefetch off/on */
1039         IDE_HFLAG_ABUSE_PREFETCH        = (1 << 4),
1040         /* use PIO6/7 for fast-devsel off/on */
1041         IDE_HFLAG_ABUSE_FAST_DEVSEL     = (1 << 5),
1042         /* use 100-102 and 200-202 PIO values to set DMA modes */
1043         IDE_HFLAG_ABUSE_DMA_MODES       = (1 << 6),
1044         /*
1045          * keep DMA setting when programming PIO mode, may be used only
1046          * for hosts which have separate PIO and DMA timings (ie. PMAC)
1047          */
1048         IDE_HFLAG_SET_PIO_MODE_KEEP_DMA = (1 << 7),
1049         /* program host for the transfer mode after programming device */
1050         IDE_HFLAG_POST_SET_MODE         = (1 << 8),
1051         /* don't program host/device for the transfer mode ("smart" hosts) */
1052         IDE_HFLAG_NO_SET_MODE           = (1 << 9),
1053         /* trust BIOS for programming chipset/device for DMA */
1054         IDE_HFLAG_TRUST_BIOS_FOR_DMA    = (1 << 10),
1055         /* host uses VDMA (tied with IDE_HFLAG_CS5520 for now) */
1056         IDE_HFLAG_VDMA                  = (1 << 11),
1057         /* ATAPI DMA is unsupported */
1058         IDE_HFLAG_NO_ATAPI_DMA          = (1 << 12),
1059         /* set if host is a "non-bootable" controller */
1060         IDE_HFLAG_NON_BOOTABLE          = (1 << 13),
1061         /* host doesn't support DMA */
1062         IDE_HFLAG_NO_DMA                = (1 << 14),
1063         /* check if host is PCI IDE device before allowing DMA */
1064         IDE_HFLAG_NO_AUTODMA            = (1 << 15),
1065         /* don't autotune PIO */
1066         IDE_HFLAG_NO_AUTOTUNE           = (1 << 16),
1067         /* host is CS5510/CS5520 */
1068         IDE_HFLAG_CS5520                = IDE_HFLAG_VDMA,
1069         /* no LBA48 */
1070         IDE_HFLAG_NO_LBA48              = (1 << 17),
1071         /* no LBA48 DMA */
1072         IDE_HFLAG_NO_LBA48_DMA          = (1 << 18),
1073         /* data FIFO is cleared by an error */
1074         IDE_HFLAG_ERROR_STOPS_FIFO      = (1 << 19),
1075         /* serialize ports */
1076         IDE_HFLAG_SERIALIZE             = (1 << 20),
1077         /* use legacy IRQs */
1078         IDE_HFLAG_LEGACY_IRQS           = (1 << 21),
1079         /* force use of legacy IRQs */
1080         IDE_HFLAG_FORCE_LEGACY_IRQS     = (1 << 22),
1081         /* limit LBA48 requests to 256 sectors */
1082         IDE_HFLAG_RQSIZE_256            = (1 << 23),
1083         /* use 32-bit I/O ops */
1084         IDE_HFLAG_IO_32BIT              = (1 << 24),
1085         /* unmask IRQs */
1086         IDE_HFLAG_UNMASK_IRQS           = (1 << 25),
1087         IDE_HFLAG_ABUSE_SET_DMA_MODE    = (1 << 26),
1088         /* force host out of "simplex" mode */
1089         IDE_HFLAG_CLEAR_SIMPLEX         = (1 << 28),
1090         /* DSC overlap is unsupported */
1091         IDE_HFLAG_NO_DSC                = (1 << 29),
1092         /* never use 32-bit I/O ops */
1093         IDE_HFLAG_NO_IO_32BIT           = (1 << 30),
1094         /* never unmask IRQs */
1095         IDE_HFLAG_NO_UNMASK_IRQS        = (1 << 31),
1096 };
1097
1098 #ifdef CONFIG_BLK_DEV_OFFBOARD
1099 # define IDE_HFLAG_OFF_BOARD    0
1100 #else
1101 # define IDE_HFLAG_OFF_BOARD    IDE_HFLAG_NON_BOOTABLE
1102 #endif
1103
1104 struct ide_port_info {
1105         char                    *name;
1106         unsigned int            (*init_chipset)(struct pci_dev *, const char *);
1107         void                    (*init_iops)(ide_hwif_t *);
1108         void                    (*init_hwif)(ide_hwif_t *);
1109         void                    (*init_dma)(ide_hwif_t *, unsigned long);
1110
1111         const struct ide_port_ops       *port_ops;
1112
1113         ide_pci_enablebit_t     enablebits[2];
1114         hwif_chipset_t          chipset;
1115         u8                      extra;
1116         u32                     host_flags;
1117         u8                      pio_mask;
1118         u8                      swdma_mask;
1119         u8                      mwdma_mask;
1120         u8                      udma_mask;
1121 };
1122
1123 int ide_setup_pci_device(struct pci_dev *, const struct ide_port_info *);
1124 int ide_setup_pci_devices(struct pci_dev *, struct pci_dev *, const struct ide_port_info *);
1125
1126 void ide_map_sg(ide_drive_t *, struct request *);
1127 void ide_init_sg_cmd(ide_drive_t *, struct request *);
1128
1129 #define BAD_DMA_DRIVE           0
1130 #define GOOD_DMA_DRIVE          1
1131
1132 struct drive_list_entry {
1133         const char *id_model;
1134         const char *id_firmware;
1135 };
1136
1137 int ide_in_drive_list(struct hd_driveid *, const struct drive_list_entry *);
1138
1139 #ifdef CONFIG_BLK_DEV_IDEDMA
1140 int __ide_dma_bad_drive(ide_drive_t *);
1141 int ide_id_dma_bug(ide_drive_t *);
1142
1143 u8 ide_find_dma_mode(ide_drive_t *, u8);
1144
1145 static inline u8 ide_max_dma_mode(ide_drive_t *drive)
1146 {
1147         return ide_find_dma_mode(drive, XFER_UDMA_6);
1148 }
1149
1150 void ide_dma_off_quietly(ide_drive_t *);
1151 void ide_dma_off(ide_drive_t *);
1152 void ide_dma_on(ide_drive_t *);
1153 int ide_set_dma(ide_drive_t *);
1154 void ide_check_dma_crc(ide_drive_t *);
1155 ide_startstop_t ide_dma_intr(ide_drive_t *);
1156
1157 int ide_build_sglist(ide_drive_t *, struct request *);
1158 void ide_destroy_dmatable(ide_drive_t *);
1159
1160 #ifdef CONFIG_BLK_DEV_IDEDMA_SFF
1161 extern int ide_build_dmatable(ide_drive_t *, struct request *);
1162 extern int ide_release_dma(ide_hwif_t *);
1163 extern void ide_setup_dma(ide_hwif_t *, unsigned long);
1164
1165 void ide_dma_host_set(ide_drive_t *, int);
1166 extern int ide_dma_setup(ide_drive_t *);
1167 extern void ide_dma_start(ide_drive_t *);
1168 extern int __ide_dma_end(ide_drive_t *);
1169 extern void ide_dma_lost_irq(ide_drive_t *);
1170 extern void ide_dma_timeout(ide_drive_t *);
1171 #endif /* CONFIG_BLK_DEV_IDEDMA_SFF */
1172
1173 #else
1174 static inline int ide_id_dma_bug(ide_drive_t *drive) { return 0; }
1175 static inline u8 ide_find_dma_mode(ide_drive_t *drive, u8 speed) { return 0; }
1176 static inline u8 ide_max_dma_mode(ide_drive_t *drive) { return 0; }
1177 static inline void ide_dma_off_quietly(ide_drive_t *drive) { ; }
1178 static inline void ide_dma_off(ide_drive_t *drive) { ; }
1179 static inline void ide_dma_on(ide_drive_t *drive) { ; }
1180 static inline void ide_dma_verbose(ide_drive_t *drive) { ; }
1181 static inline int ide_set_dma(ide_drive_t *drive) { return 1; }
1182 static inline void ide_check_dma_crc(ide_drive_t *drive) { ; }
1183 #endif /* CONFIG_BLK_DEV_IDEDMA */
1184
1185 #ifndef CONFIG_BLK_DEV_IDEDMA_SFF
1186 static inline void ide_release_dma(ide_hwif_t *drive) {;}
1187 #endif
1188
1189 #ifdef CONFIG_BLK_DEV_IDEACPI
1190 extern int ide_acpi_exec_tfs(ide_drive_t *drive);
1191 extern void ide_acpi_get_timing(ide_hwif_t *hwif);
1192 extern void ide_acpi_push_timing(ide_hwif_t *hwif);
1193 extern void ide_acpi_init(ide_hwif_t *hwif);
1194 void ide_acpi_port_init_devices(ide_hwif_t *);
1195 extern void ide_acpi_set_state(ide_hwif_t *hwif, int on);
1196 #else
1197 static inline int ide_acpi_exec_tfs(ide_drive_t *drive) { return 0; }
1198 static inline void ide_acpi_get_timing(ide_hwif_t *hwif) { ; }
1199 static inline void ide_acpi_push_timing(ide_hwif_t *hwif) { ; }
1200 static inline void ide_acpi_init(ide_hwif_t *hwif) { ; }
1201 static inline void ide_acpi_port_init_devices(ide_hwif_t *hwif) { ; }
1202 static inline void ide_acpi_set_state(ide_hwif_t *hwif, int on) {}
1203 #endif
1204
1205 void ide_remove_port_from_hwgroup(ide_hwif_t *);
1206 extern int ide_hwif_request_regions(ide_hwif_t *hwif);
1207 extern void ide_hwif_release_regions(ide_hwif_t* hwif);
1208 void ide_unregister(unsigned int);
1209
1210 void ide_register_region(struct gendisk *);
1211 void ide_unregister_region(struct gendisk *);
1212
1213 void ide_undecoded_slave(ide_drive_t *);
1214
1215 int ide_device_add_all(u8 *idx, const struct ide_port_info *);
1216 int ide_device_add(u8 idx[4], const struct ide_port_info *);
1217 void ide_port_unregister_devices(ide_hwif_t *);
1218 void ide_port_scan(ide_hwif_t *);
1219
1220 static inline void *ide_get_hwifdata (ide_hwif_t * hwif)
1221 {
1222         return hwif->hwif_data;
1223 }
1224
1225 static inline void ide_set_hwifdata (ide_hwif_t * hwif, void *data)
1226 {
1227         hwif->hwif_data = data;
1228 }
1229
1230 const char *ide_xfer_verbose(u8 mode);
1231 extern void ide_toggle_bounce(ide_drive_t *drive, int on);
1232 extern int ide_set_xfer_rate(ide_drive_t *drive, u8 rate);
1233
1234 static inline int ide_dev_has_iordy(struct hd_driveid *id)
1235 {
1236         return ((id->field_valid & 2) && (id->capability & 8)) ? 1 : 0;
1237 }
1238
1239 static inline int ide_dev_is_sata(struct hd_driveid *id)
1240 {
1241         /*
1242          * See if word 93 is 0 AND drive is at least ATA-5 compatible
1243          * verifying that word 80 by casting it to a signed type --
1244          * this trick allows us to filter out the reserved values of
1245          * 0x0000 and 0xffff along with the earlier ATA revisions...
1246          */
1247         if (id->hw_config == 0 && (short)id->major_rev_num >= 0x0020)
1248                 return 1;
1249         return 0;
1250 }
1251
1252 u64 ide_get_lba_addr(struct ide_taskfile *, int);
1253 u8 ide_dump_status(ide_drive_t *, const char *, u8);
1254
1255 typedef struct ide_pio_timings_s {
1256         int     setup_time;     /* Address setup (ns) minimum */
1257         int     active_time;    /* Active pulse (ns) minimum */
1258         int     cycle_time;     /* Cycle time (ns) minimum = */
1259                                 /* active + recovery (+ setup for some chips) */
1260 } ide_pio_timings_t;
1261
1262 unsigned int ide_pio_cycle_time(ide_drive_t *, u8);
1263 u8 ide_get_best_pio_mode(ide_drive_t *, u8, u8);
1264 extern const ide_pio_timings_t ide_pio_timings[6];
1265
1266 int ide_set_pio_mode(ide_drive_t *, u8);
1267 int ide_set_dma_mode(ide_drive_t *, u8);
1268
1269 void ide_set_pio(ide_drive_t *, u8);
1270
1271 static inline void ide_set_max_pio(ide_drive_t *drive)
1272 {
1273         ide_set_pio(drive, 255);
1274 }
1275
1276 extern spinlock_t ide_lock;
1277 extern struct mutex ide_cfg_mtx;
1278 /*
1279  * Structure locking:
1280  *
1281  * ide_cfg_mtx and ide_lock together protect changes to
1282  * ide_hwif_t->{next,hwgroup}
1283  * ide_drive_t->next
1284  *
1285  * ide_hwgroup_t->busy: ide_lock
1286  * ide_hwgroup_t->hwif: ide_lock
1287  * ide_hwif_t->mate: constant, no locking
1288  * ide_drive_t->hwif: constant, no locking
1289  */
1290
1291 #define local_irq_set(flags)    do { local_save_flags((flags)); local_irq_enable_in_hardirq(); } while (0)
1292
1293 extern struct bus_type ide_bus_type;
1294 extern struct class *ide_port_class;
1295
1296 /* check if CACHE FLUSH (EXT) command is supported (bits defined in ATA-6) */
1297 #define ide_id_has_flush_cache(id)      ((id)->cfs_enable_2 & 0x3000)
1298
1299 /* some Maxtor disks have bit 13 defined incorrectly so check bit 10 too */
1300 #define ide_id_has_flush_cache_ext(id)  \
1301         (((id)->cfs_enable_2 & 0x2400) == 0x2400)
1302
1303 static inline void ide_dump_identify(u8 *id)
1304 {
1305         print_hex_dump(KERN_INFO, "", DUMP_PREFIX_NONE, 16, 2, id, 512, 0);
1306 }
1307
1308 static inline int hwif_to_node(ide_hwif_t *hwif)
1309 {
1310         struct pci_dev *dev = to_pci_dev(hwif->dev);
1311         return hwif->dev ? pcibus_to_node(dev->bus) : -1;
1312 }
1313
1314 static inline ide_drive_t *ide_get_paired_drive(ide_drive_t *drive)
1315 {
1316         ide_hwif_t *hwif        = HWIF(drive);
1317
1318         return &hwif->drives[(drive->dn ^ 1) & 1];
1319 }
1320
1321 static inline void ide_set_irq(ide_drive_t *drive, int on)
1322 {
1323         ide_hwif_t *hwif = drive->hwif;
1324
1325         hwif->OUTB(drive->ctl | (on ? 0 : 2),
1326                    hwif->io_ports[IDE_CONTROL_OFFSET]);
1327 }
1328
1329 static inline u8 ide_read_status(ide_drive_t *drive)
1330 {
1331         ide_hwif_t *hwif = drive->hwif;
1332
1333         return hwif->INB(hwif->io_ports[IDE_STATUS_OFFSET]);
1334 }
1335
1336 static inline u8 ide_read_altstatus(ide_drive_t *drive)
1337 {
1338         ide_hwif_t *hwif = drive->hwif;
1339
1340         return hwif->INB(hwif->io_ports[IDE_CONTROL_OFFSET]);
1341 }
1342
1343 static inline u8 ide_read_error(ide_drive_t *drive)
1344 {
1345         ide_hwif_t *hwif = drive->hwif;
1346
1347         return hwif->INB(hwif->io_ports[IDE_ERROR_OFFSET]);
1348 }
1349
1350 /*
1351  * Too bad. The drive wants to send us data which we are not ready to accept.
1352  * Just throw it away.
1353  */
1354 static inline void ide_atapi_discard_data(ide_drive_t *drive, unsigned bcount)
1355 {
1356         ide_hwif_t *hwif = drive->hwif;
1357
1358         /* FIXME: use ->atapi_input_bytes */
1359         while (bcount--)
1360                 (void)hwif->INB(hwif->io_ports[IDE_DATA_OFFSET]);
1361 }
1362
1363 static inline void ide_atapi_write_zeros(ide_drive_t *drive, unsigned bcount)
1364 {
1365         ide_hwif_t *hwif = drive->hwif;
1366
1367         /* FIXME: use ->atapi_output_bytes */
1368         while (bcount--)
1369                 hwif->OUTB(0, hwif->io_ports[IDE_DATA_OFFSET]);
1370 }
1371
1372 #endif /* _IDE_H */