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