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