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