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