ide: ide_id_has_flush_cache_ext() -> ata_id_flush_ext_enabled()
[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/ata.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
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_devset;
308 struct ide_driver_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         const struct ide_devset **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      retry_pio;              /* retrying dma capable host in pio */
400         u8      state;                  /* retry state */
401         u8      waiting_for_dma;        /* dma currently in progress */
402
403         unsigned keep_settings  : 1;    /* restore settings after drive reset */
404         unsigned using_dma      : 1;    /* disk is using dma for read/write */
405         unsigned unmask         : 1;    /* okay to unmask other irqs */
406         unsigned noflush        : 1;    /* don't attempt flushes */
407         unsigned dsc_overlap    : 1;    /* DSC overlap */
408         unsigned nice1          : 1;    /* give potential excess bandwidth */
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 doorlocking    : 1;    /* for removable only: door lock/unlock works */
419         unsigned nodma          : 1;    /* disallow DMA */
420         unsigned blocked        : 1;    /* 1=powermanagment told us not to do anything, so sleep nicely */
421         unsigned scsi           : 1;    /* 0=default, 1=ide-scsi emulation */
422         unsigned sleeping       : 1;    /* 1=sleeping & sleep field valid */
423         unsigned post_reset     : 1;
424         unsigned udma33_warned  : 1;
425         unsigned addressing     : 2;    /* 0=28-bit, 1=48-bit, 2=48-bit doing 28-bit */
426         unsigned wcache         : 1;    /* status of write cache */
427         unsigned nowerr         : 1;    /* used for ignoring ATA_DF */
428
429         u8      quirk_list;     /* considered quirky, set for a specific host */
430         u8      init_speed;     /* transfer rate set at boot */
431         u8      current_speed;  /* current transfer rate set */
432         u8      desired_speed;  /* desired transfer rate set */
433         u8      dn;             /* now wide spread use */
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      head;           /* "real" number of heads */
443         u8      sect;           /* "real" sectors per track */
444         u8      bios_head;      /* BIOS/fdisk/LILO number of heads */
445         u8      bios_sect;      /* BIOS/fdisk/LILO sectors per track */
446
447         unsigned int    bios_cyl;       /* BIOS/fdisk/LILO number of cyls */
448         unsigned int    cyl;            /* "real" number of cyls */
449         unsigned int    drive_data;     /* used by set_pio_mode/selectproc */
450         unsigned int    failures;       /* current failure count */
451         unsigned int    max_failures;   /* maximum allowed failure count */
452         u64             probed_capacity;/* initial reported media capacity (ide-cd only currently) */
453
454         u64             capacity64;     /* total number of sectors */
455
456         int             lun;            /* logical unit */
457         int             crc_count;      /* crc counter to reduce drive speed */
458 #ifdef CONFIG_BLK_DEV_IDEACPI
459         struct ide_acpi_drive_link *acpidata;
460 #endif
461         struct list_head list;
462         struct device   gendev;
463         struct completion gendev_rel_comp;      /* to deal with device release() */
464
465         /* callback for packet commands */
466         void (*pc_callback)(struct ide_drive_s *);
467
468         unsigned long atapi_flags;
469 };
470
471 typedef struct ide_drive_s ide_drive_t;
472
473 #define to_ide_device(dev)container_of(dev, ide_drive_t, gendev)
474
475 struct ide_task_s;
476 struct ide_port_info;
477
478 struct ide_tp_ops {
479         void    (*exec_command)(struct hwif_s *, u8);
480         u8      (*read_status)(struct hwif_s *);
481         u8      (*read_altstatus)(struct hwif_s *);
482         u8      (*read_sff_dma_status)(struct hwif_s *);
483
484         void    (*set_irq)(struct hwif_s *, int);
485
486         void    (*tf_load)(ide_drive_t *, struct ide_task_s *);
487         void    (*tf_read)(ide_drive_t *, struct ide_task_s *);
488
489         void    (*input_data)(ide_drive_t *, struct request *, void *,
490                               unsigned int);
491         void    (*output_data)(ide_drive_t *, struct request *, void *,
492                                unsigned int);
493 };
494
495 extern const struct ide_tp_ops default_tp_ops;
496
497 /**
498  * struct ide_port_ops - IDE port operations
499  *
500  * @init_dev:           host specific initialization of a device
501  * @set_pio_mode:       routine to program host for PIO mode
502  * @set_dma_mode:       routine to program host for DMA mode
503  * @selectproc:         tweaks hardware to select drive
504  * @reset_poll:         chipset polling based on hba specifics
505  * @pre_reset:          chipset specific changes to default for device-hba resets
506  * @resetproc:          routine to reset controller after a disk reset
507  * @maskproc:           special host masking for drive selection
508  * @quirkproc:          check host's drive quirk list
509  *
510  * @mdma_filter:        filter MDMA modes
511  * @udma_filter:        filter UDMA modes
512  *
513  * @cable_detect:       detect cable type
514  */
515 struct ide_port_ops {
516         void    (*init_dev)(ide_drive_t *);
517         void    (*set_pio_mode)(ide_drive_t *, const u8);
518         void    (*set_dma_mode)(ide_drive_t *, const u8);
519         void    (*selectproc)(ide_drive_t *);
520         int     (*reset_poll)(ide_drive_t *);
521         void    (*pre_reset)(ide_drive_t *);
522         void    (*resetproc)(ide_drive_t *);
523         void    (*maskproc)(ide_drive_t *, int);
524         void    (*quirkproc)(ide_drive_t *);
525
526         u8      (*mdma_filter)(ide_drive_t *);
527         u8      (*udma_filter)(ide_drive_t *);
528
529         u8      (*cable_detect)(struct hwif_s *);
530 };
531
532 struct ide_dma_ops {
533         void    (*dma_host_set)(struct ide_drive_s *, int);
534         int     (*dma_setup)(struct ide_drive_s *);
535         void    (*dma_exec_cmd)(struct ide_drive_s *, u8);
536         void    (*dma_start)(struct ide_drive_s *);
537         int     (*dma_end)(struct ide_drive_s *);
538         int     (*dma_test_irq)(struct ide_drive_s *);
539         void    (*dma_lost_irq)(struct ide_drive_s *);
540         void    (*dma_timeout)(struct ide_drive_s *);
541 };
542
543 struct ide_host;
544
545 typedef struct hwif_s {
546         struct hwif_s *next;            /* for linked-list in ide_hwgroup_t */
547         struct hwif_s *mate;            /* other hwif from same PCI chip */
548         struct hwgroup_s *hwgroup;      /* actually (ide_hwgroup_t *) */
549         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
550
551         struct ide_host *host;
552
553         char name[6];                   /* name of interface, eg. "ide0" */
554
555         struct ide_io_ports     io_ports;
556
557         unsigned long   sata_scr[SATA_NR_PORTS];
558
559         ide_drive_t     drives[MAX_DRIVES];     /* drive info */
560
561         u8 major;       /* our major number */
562         u8 index;       /* 0 for ide0; 1 for ide1; ... */
563         u8 channel;     /* for dual-port chips: 0=primary, 1=secondary */
564         u8 bus_state;   /* power state of the IDE bus */
565
566         u32 host_flags;
567
568         u8 pio_mask;
569
570         u8 ultra_mask;
571         u8 mwdma_mask;
572         u8 swdma_mask;
573
574         u8 cbl;         /* cable type */
575
576         hwif_chipset_t chipset; /* sub-module for tuning.. */
577
578         struct device *dev;
579
580         ide_ack_intr_t *ack_intr;
581
582         void (*rw_disk)(ide_drive_t *, struct request *);
583
584         const struct ide_tp_ops         *tp_ops;
585         const struct ide_port_ops       *port_ops;
586         const struct ide_dma_ops        *dma_ops;
587
588         void (*ide_dma_clear_irq)(ide_drive_t *drive);
589
590         /* dma physical region descriptor table (cpu view) */
591         unsigned int    *dmatable_cpu;
592         /* dma physical region descriptor table (dma view) */
593         dma_addr_t      dmatable_dma;
594         /* Scatter-gather list used to build the above */
595         struct scatterlist *sg_table;
596         int sg_max_nents;               /* Maximum number of entries in it */
597         int sg_nents;                   /* Current number of entries in it */
598         int sg_dma_direction;           /* dma transfer direction */
599
600         /* data phase of the active command (currently only valid for PIO/DMA) */
601         int             data_phase;
602
603         unsigned int nsect;
604         unsigned int nleft;
605         struct scatterlist *cursg;
606         unsigned int cursg_ofs;
607
608         int             rqsize;         /* max sectors per request */
609         int             irq;            /* our irq number */
610
611         unsigned long   dma_base;       /* base addr for dma ports */
612
613         unsigned long   config_data;    /* for use by chipset-specific code */
614         unsigned long   select_data;    /* for use by chipset-specific code */
615
616         unsigned long   extra_base;     /* extra addr for dma ports */
617         unsigned        extra_ports;    /* number of extra dma ports */
618
619         unsigned        present    : 1; /* this interface exists */
620         unsigned        serialized : 1; /* serialized all channel operation */
621         unsigned        sharing_irq: 1; /* 1 = sharing irq with another hwif */
622         unsigned        sg_mapped  : 1; /* sg_table and sg_nents are ready */
623
624         struct device           gendev;
625         struct device           *portdev;
626
627         struct completion gendev_rel_comp; /* To deal with device release() */
628
629         void            *hwif_data;     /* extra hwif data */
630
631         unsigned dma;
632
633 #ifdef CONFIG_BLK_DEV_IDEACPI
634         struct ide_acpi_hwif_link *acpidata;
635 #endif
636 } ____cacheline_internodealigned_in_smp ide_hwif_t;
637
638 struct ide_host {
639         ide_hwif_t      *ports[MAX_HWIFS];
640         unsigned int    n_ports;
641         struct device   *dev[2];
642         unsigned long   host_flags;
643         void            *host_priv;
644 };
645
646 /*
647  *  internal ide interrupt handler type
648  */
649 typedef ide_startstop_t (ide_handler_t)(ide_drive_t *);
650 typedef int (ide_expiry_t)(ide_drive_t *);
651
652 /* used by ide-cd, ide-floppy, etc. */
653 typedef void (xfer_func_t)(ide_drive_t *, struct request *rq, void *, unsigned);
654
655 typedef struct hwgroup_s {
656                 /* irq handler, if active */
657         ide_startstop_t (*handler)(ide_drive_t *);
658
659                 /* BOOL: protects all fields below */
660         volatile int busy;
661                 /* BOOL: wake us up on timer expiry */
662         unsigned int sleeping   : 1;
663                 /* BOOL: polling active & poll_timeout field valid */
664         unsigned int polling    : 1;
665
666                 /* current drive */
667         ide_drive_t *drive;
668                 /* ptr to current hwif in linked-list */
669         ide_hwif_t *hwif;
670
671                 /* current request */
672         struct request *rq;
673
674                 /* failsafe timer */
675         struct timer_list timer;
676                 /* timeout value during long polls */
677         unsigned long poll_timeout;
678                 /* queried upon timeouts */
679         int (*expiry)(ide_drive_t *);
680
681         int req_gen;
682         int req_gen_timer;
683 } ide_hwgroup_t;
684
685 typedef struct ide_driver_s ide_driver_t;
686
687 extern struct mutex ide_setting_mtx;
688
689 int get_io_32bit(ide_drive_t *);
690 int set_io_32bit(ide_drive_t *, int);
691 int get_ksettings(ide_drive_t *);
692 int set_ksettings(ide_drive_t *, int);
693 int set_pio_mode(ide_drive_t *, int);
694 int get_unmaskirq(ide_drive_t *);
695 int set_unmaskirq(ide_drive_t *, int);
696 int get_using_dma(ide_drive_t *);
697 int set_using_dma(ide_drive_t *, int);
698
699 #define ide_devset_get(name, field) \
700 int get_##name(ide_drive_t *drive) \
701 { \
702         return drive->field; \
703 }
704
705 #define ide_devset_set(name, field) \
706 int set_##name(ide_drive_t *drive, int arg) \
707 { \
708         drive->field = arg; \
709         return 0; \
710 }
711
712 /* ATAPI packet command flags */
713 enum {
714         /* set when an error is considered normal - no retry (ide-tape) */
715         PC_FLAG_ABORT                   = (1 << 0),
716         PC_FLAG_SUPPRESS_ERROR          = (1 << 1),
717         PC_FLAG_WAIT_FOR_DSC            = (1 << 2),
718         PC_FLAG_DMA_OK                  = (1 << 3),
719         PC_FLAG_DMA_IN_PROGRESS         = (1 << 4),
720         PC_FLAG_DMA_ERROR               = (1 << 5),
721         PC_FLAG_WRITING                 = (1 << 6),
722         /* command timed out */
723         PC_FLAG_TIMEDOUT                = (1 << 7),
724 };
725
726 struct ide_atapi_pc {
727         /* actual packet bytes */
728         u8 c[12];
729         /* incremented on each retry */
730         int retries;
731         int error;
732
733         /* bytes to transfer */
734         int req_xfer;
735         /* bytes actually transferred */
736         int xferred;
737
738         /* data buffer */
739         u8 *buf;
740         /* current buffer position */
741         u8 *cur_pos;
742         int buf_size;
743         /* missing/available data on the current buffer */
744         int b_count;
745
746         /* the corresponding request */
747         struct request *rq;
748
749         unsigned long flags;
750
751         /*
752          * those are more or less driver-specific and some of them are subject
753          * to change/removal later.
754          */
755         u8 pc_buf[256];
756
757         /* idetape only */
758         struct idetape_bh *bh;
759         char *b_data;
760
761         /* idescsi only for now */
762         struct scatterlist *sg;
763         unsigned int sg_cnt;
764
765         struct scsi_cmnd *scsi_cmd;
766         void (*done) (struct scsi_cmnd *);
767
768         unsigned long timeout;
769 };
770
771 #ifdef CONFIG_IDE_PROC_FS
772 /*
773  * configurable drive settings
774  */
775
776 #define S_READ          (1 << 0)
777 #define S_WRITE         (1 << 1)
778 #define S_RW            (S_READ | S_WRITE)
779 #define S_NOLOCK        (1 << 2)
780
781 struct ide_devset {
782         const char      *name;
783         unsigned int    flags;
784         int             min, max;
785         int             (*get)(ide_drive_t *);
786         int             (*set)(ide_drive_t *, int);
787         int             (*mulf)(ide_drive_t *);
788         int             (*divf)(ide_drive_t *);
789 };
790
791 #define __DEVSET(_name, _flags, _min, _max, _get, _set, _mulf, _divf) { \
792         .name   = __stringify(_name), \
793         .flags  = _flags, \
794         .min    = _min, \
795         .max    = _max, \
796         .get    = _get, \
797         .set    = _set, \
798         .mulf   = _mulf, \
799         .divf   = _divf, \
800 }
801
802 #define __IDE_DEVSET(_name, _flags, _min, _max, _get, _set, _mulf, _divf) \
803 static const struct ide_devset ide_devset_##_name = \
804         __DEVSET(_name, _flags, _min, _max, _get, _set, _mulf, _divf)
805
806 #define IDE_DEVSET(_name, _flags, _min, _max, _get, _set) \
807 __IDE_DEVSET(_name, _flags, _min, _max, _get, _set, NULL, NULL)
808
809 #define ide_devset_rw_nolock(_name, _min, _max, _func) \
810 IDE_DEVSET(_name, S_RW | S_NOLOCK, _min, _max, get_##_func, set_##_func)
811
812 #define ide_devset_w_nolock(_name, _min, _max, _func) \
813 IDE_DEVSET(_name, S_WRITE | S_NOLOCK, _min, _max, NULL, set_##_func)
814
815 #define ide_devset_rw(_name, _min, _max, _field) \
816 static ide_devset_get(_name, _field); \
817 static ide_devset_set(_name, _field); \
818 IDE_DEVSET(_name, S_RW, _min, _max, get_##_name, set_##_name)
819
820 #define ide_devset_r(_name, _min, _max, _field) \
821 ide_devset_get(_name, _field) \
822 IDE_DEVSET(_name, S_READ, _min, _max, get_##_name, NULL)
823
824 /*
825  * /proc/ide interface
826  */
827 typedef struct {
828         const char      *name;
829         mode_t          mode;
830         read_proc_t     *read_proc;
831         write_proc_t    *write_proc;
832 } ide_proc_entry_t;
833
834 void proc_ide_create(void);
835 void proc_ide_destroy(void);
836 void ide_proc_register_port(ide_hwif_t *);
837 void ide_proc_port_register_devices(ide_hwif_t *);
838 void ide_proc_unregister_device(ide_drive_t *);
839 void ide_proc_unregister_port(ide_hwif_t *);
840 void ide_proc_register_driver(ide_drive_t *, ide_driver_t *);
841 void ide_proc_unregister_driver(ide_drive_t *, ide_driver_t *);
842
843 read_proc_t proc_ide_read_capacity;
844 read_proc_t proc_ide_read_geometry;
845
846 /*
847  * Standard exit stuff:
848  */
849 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) \
850 {                                       \
851         len -= off;                     \
852         if (len < count) {              \
853                 *eof = 1;               \
854                 if (len <= 0)           \
855                         return 0;       \
856         } else                          \
857                 len = count;            \
858         *start = page + off;            \
859         return len;                     \
860 }
861 #else
862 static inline void proc_ide_create(void) { ; }
863 static inline void proc_ide_destroy(void) { ; }
864 static inline void ide_proc_register_port(ide_hwif_t *hwif) { ; }
865 static inline void ide_proc_port_register_devices(ide_hwif_t *hwif) { ; }
866 static inline void ide_proc_unregister_device(ide_drive_t *drive) { ; }
867 static inline void ide_proc_unregister_port(ide_hwif_t *hwif) { ; }
868 static inline void ide_proc_register_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
869 static inline void ide_proc_unregister_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
870 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) return 0;
871 #endif
872
873 /*
874  * Power Management step value (rq->pm->pm_step).
875  *
876  * The step value starts at 0 (ide_pm_state_start_suspend) for a
877  * suspend operation or 1000 (ide_pm_state_start_resume) for a
878  * resume operation.
879  *
880  * For each step, the core calls the subdriver start_power_step() first.
881  * This can return:
882  *      - ide_stopped : In this case, the core calls us back again unless
883  *                      step have been set to ide_power_state_completed.
884  *      - ide_started : In this case, the channel is left busy until an
885  *                      async event (interrupt) occurs.
886  * Typically, start_power_step() will issue a taskfile request with
887  * do_rw_taskfile().
888  *
889  * Upon reception of the interrupt, the core will call complete_power_step()
890  * with the error code if any. This routine should update the step value
891  * and return. It should not start a new request. The core will call
892  * start_power_step for the new step value, unless step have been set to
893  * ide_power_state_completed.
894  *
895  * Subdrivers are expected to define their own additional power
896  * steps from 1..999 for suspend and from 1001..1999 for resume,
897  * other values are reserved for future use.
898  */
899
900 enum {
901         ide_pm_state_completed          = -1,
902         ide_pm_state_start_suspend      = 0,
903         ide_pm_state_start_resume       = 1000,
904 };
905
906 /*
907  * Subdrivers support.
908  *
909  * The gendriver.owner field should be set to the module owner of this driver.
910  * The gendriver.name field should be set to the name of this driver
911  */
912 struct ide_driver_s {
913         const char                      *version;
914         u8                              media;
915         ide_startstop_t (*do_request)(ide_drive_t *, struct request *, sector_t);
916         int             (*end_request)(ide_drive_t *, int, int);
917         ide_startstop_t (*error)(ide_drive_t *, struct request *rq, u8, u8);
918         struct device_driver    gen_driver;
919         int             (*probe)(ide_drive_t *);
920         void            (*remove)(ide_drive_t *);
921         void            (*resume)(ide_drive_t *);
922         void            (*shutdown)(ide_drive_t *);
923 #ifdef CONFIG_IDE_PROC_FS
924         ide_proc_entry_t        *proc;
925         const struct ide_devset **settings;
926 #endif
927 };
928
929 #define to_ide_driver(drv) container_of(drv, ide_driver_t, gen_driver)
930
931 int ide_device_get(ide_drive_t *);
932 void ide_device_put(ide_drive_t *);
933
934 int generic_ide_ioctl(ide_drive_t *, struct file *, struct block_device *, unsigned, unsigned long);
935
936 extern int ide_vlb_clk;
937 extern int ide_pci_clk;
938
939 extern int ide_end_request (ide_drive_t *drive, int uptodate, int nrsecs);
940 int ide_end_dequeued_request(ide_drive_t *drive, struct request *rq,
941                              int uptodate, int nr_sectors);
942
943 extern void ide_set_handler (ide_drive_t *drive, ide_handler_t *handler, unsigned int timeout, ide_expiry_t *expiry);
944
945 void ide_execute_command(ide_drive_t *, u8, ide_handler_t *, unsigned int,
946                          ide_expiry_t *);
947
948 void ide_execute_pkt_cmd(ide_drive_t *);
949
950 void ide_pad_transfer(ide_drive_t *, int, int);
951
952 ide_startstop_t __ide_error(ide_drive_t *, struct request *, u8, u8);
953
954 ide_startstop_t ide_error (ide_drive_t *drive, const char *msg, byte stat);
955
956 void ide_fix_driveid(u16 *);
957
958 extern void ide_fixstring(u8 *, const int, const int);
959
960 int ide_busy_sleep(ide_hwif_t *, unsigned long, int);
961
962 int ide_wait_stat(ide_startstop_t *, ide_drive_t *, u8, u8, unsigned long);
963
964 extern ide_startstop_t ide_do_reset (ide_drive_t *);
965
966 extern void ide_do_drive_cmd(ide_drive_t *, struct request *);
967
968 extern void ide_end_drive_cmd(ide_drive_t *, u8, u8);
969
970 enum {
971         IDE_TFLAG_LBA48                 = (1 << 0),
972         IDE_TFLAG_FLAGGED               = (1 << 2),
973         IDE_TFLAG_OUT_DATA              = (1 << 3),
974         IDE_TFLAG_OUT_HOB_FEATURE       = (1 << 4),
975         IDE_TFLAG_OUT_HOB_NSECT         = (1 << 5),
976         IDE_TFLAG_OUT_HOB_LBAL          = (1 << 6),
977         IDE_TFLAG_OUT_HOB_LBAM          = (1 << 7),
978         IDE_TFLAG_OUT_HOB_LBAH          = (1 << 8),
979         IDE_TFLAG_OUT_HOB               = IDE_TFLAG_OUT_HOB_FEATURE |
980                                           IDE_TFLAG_OUT_HOB_NSECT |
981                                           IDE_TFLAG_OUT_HOB_LBAL |
982                                           IDE_TFLAG_OUT_HOB_LBAM |
983                                           IDE_TFLAG_OUT_HOB_LBAH,
984         IDE_TFLAG_OUT_FEATURE           = (1 << 9),
985         IDE_TFLAG_OUT_NSECT             = (1 << 10),
986         IDE_TFLAG_OUT_LBAL              = (1 << 11),
987         IDE_TFLAG_OUT_LBAM              = (1 << 12),
988         IDE_TFLAG_OUT_LBAH              = (1 << 13),
989         IDE_TFLAG_OUT_TF                = IDE_TFLAG_OUT_FEATURE |
990                                           IDE_TFLAG_OUT_NSECT |
991                                           IDE_TFLAG_OUT_LBAL |
992                                           IDE_TFLAG_OUT_LBAM |
993                                           IDE_TFLAG_OUT_LBAH,
994         IDE_TFLAG_OUT_DEVICE            = (1 << 14),
995         IDE_TFLAG_WRITE                 = (1 << 15),
996         IDE_TFLAG_FLAGGED_SET_IN_FLAGS  = (1 << 16),
997         IDE_TFLAG_IN_DATA               = (1 << 17),
998         IDE_TFLAG_CUSTOM_HANDLER        = (1 << 18),
999         IDE_TFLAG_DMA_PIO_FALLBACK      = (1 << 19),
1000         IDE_TFLAG_IN_HOB_FEATURE        = (1 << 20),
1001         IDE_TFLAG_IN_HOB_NSECT          = (1 << 21),
1002         IDE_TFLAG_IN_HOB_LBAL           = (1 << 22),
1003         IDE_TFLAG_IN_HOB_LBAM           = (1 << 23),
1004         IDE_TFLAG_IN_HOB_LBAH           = (1 << 24),
1005         IDE_TFLAG_IN_HOB_LBA            = IDE_TFLAG_IN_HOB_LBAL |
1006                                           IDE_TFLAG_IN_HOB_LBAM |
1007                                           IDE_TFLAG_IN_HOB_LBAH,
1008         IDE_TFLAG_IN_HOB                = IDE_TFLAG_IN_HOB_FEATURE |
1009                                           IDE_TFLAG_IN_HOB_NSECT |
1010                                           IDE_TFLAG_IN_HOB_LBA,
1011         IDE_TFLAG_IN_FEATURE            = (1 << 1),
1012         IDE_TFLAG_IN_NSECT              = (1 << 25),
1013         IDE_TFLAG_IN_LBAL               = (1 << 26),
1014         IDE_TFLAG_IN_LBAM               = (1 << 27),
1015         IDE_TFLAG_IN_LBAH               = (1 << 28),
1016         IDE_TFLAG_IN_LBA                = IDE_TFLAG_IN_LBAL |
1017                                           IDE_TFLAG_IN_LBAM |
1018                                           IDE_TFLAG_IN_LBAH,
1019         IDE_TFLAG_IN_TF                 = IDE_TFLAG_IN_NSECT |
1020                                           IDE_TFLAG_IN_LBA,
1021         IDE_TFLAG_IN_DEVICE             = (1 << 29),
1022         IDE_TFLAG_HOB                   = IDE_TFLAG_OUT_HOB |
1023                                           IDE_TFLAG_IN_HOB,
1024         IDE_TFLAG_TF                    = IDE_TFLAG_OUT_TF |
1025                                           IDE_TFLAG_IN_TF,
1026         IDE_TFLAG_DEVICE                = IDE_TFLAG_OUT_DEVICE |
1027                                           IDE_TFLAG_IN_DEVICE,
1028         /* force 16-bit I/O operations */
1029         IDE_TFLAG_IO_16BIT              = (1 << 30),
1030         /* ide_task_t was allocated using kmalloc() */
1031         IDE_TFLAG_DYN                   = (1 << 31),
1032 };
1033
1034 struct ide_taskfile {
1035         u8      hob_data;       /*  0: high data byte (for TASKFILE IOCTL) */
1036
1037         u8      hob_feature;    /*  1-5: additional data to support LBA48 */
1038         u8      hob_nsect;
1039         u8      hob_lbal;
1040         u8      hob_lbam;
1041         u8      hob_lbah;
1042
1043         u8      data;           /*  6: low data byte (for TASKFILE IOCTL) */
1044
1045         union {                 /*  7: */
1046                 u8 error;       /*   read:  error */
1047                 u8 feature;     /*  write: feature */
1048         };
1049
1050         u8      nsect;          /*  8: number of sectors */
1051         u8      lbal;           /*  9: LBA low */
1052         u8      lbam;           /* 10: LBA mid */
1053         u8      lbah;           /* 11: LBA high */
1054
1055         u8      device;         /* 12: device select */
1056
1057         union {                 /* 13: */
1058                 u8 status;      /*  read: status  */
1059                 u8 command;     /* write: command */
1060         };
1061 };
1062
1063 typedef struct ide_task_s {
1064         union {
1065                 struct ide_taskfile     tf;
1066                 u8                      tf_array[14];
1067         };
1068         u32                     tf_flags;
1069         int                     data_phase;
1070         struct request          *rq;            /* copy of request */
1071         void                    *special;       /* valid_t generally */
1072 } ide_task_t;
1073
1074 void ide_tf_dump(const char *, struct ide_taskfile *);
1075
1076 void ide_exec_command(ide_hwif_t *, u8);
1077 u8 ide_read_status(ide_hwif_t *);
1078 u8 ide_read_altstatus(ide_hwif_t *);
1079 u8 ide_read_sff_dma_status(ide_hwif_t *);
1080
1081 void ide_set_irq(ide_hwif_t *, int);
1082
1083 void ide_tf_load(ide_drive_t *, ide_task_t *);
1084 void ide_tf_read(ide_drive_t *, ide_task_t *);
1085
1086 void ide_input_data(ide_drive_t *, struct request *, void *, unsigned int);
1087 void ide_output_data(ide_drive_t *, struct request *, void *, unsigned int);
1088
1089 extern void SELECT_DRIVE(ide_drive_t *);
1090 void SELECT_MASK(ide_drive_t *, int);
1091
1092 u8 ide_read_error(ide_drive_t *);
1093 void ide_read_bcount_and_ireason(ide_drive_t *, u16 *, u8 *);
1094
1095 extern int drive_is_ready(ide_drive_t *);
1096
1097 void ide_pktcmd_tf_load(ide_drive_t *, u32, u16, u8);
1098
1099 ide_startstop_t ide_pc_intr(ide_drive_t *drive, struct ide_atapi_pc *pc,
1100         ide_handler_t *handler, unsigned int timeout, ide_expiry_t *expiry,
1101         void (*update_buffers)(ide_drive_t *, struct ide_atapi_pc *),
1102         void (*retry_pc)(ide_drive_t *), void (*dsc_handle)(ide_drive_t *),
1103         void (*io_buffers)(ide_drive_t *, struct ide_atapi_pc *, unsigned int,
1104                            int));
1105 ide_startstop_t ide_transfer_pc(ide_drive_t *, struct ide_atapi_pc *,
1106                                 ide_handler_t *, unsigned int, ide_expiry_t *);
1107 ide_startstop_t ide_issue_pc(ide_drive_t *, struct ide_atapi_pc *,
1108                              ide_handler_t *, unsigned int, ide_expiry_t *);
1109
1110 ide_startstop_t do_rw_taskfile(ide_drive_t *, ide_task_t *);
1111
1112 void task_end_request(ide_drive_t *, struct request *, u8);
1113
1114 int ide_raw_taskfile(ide_drive_t *, ide_task_t *, u8 *, u16);
1115 int ide_no_data_taskfile(ide_drive_t *, ide_task_t *);
1116
1117 int ide_taskfile_ioctl(ide_drive_t *, unsigned int, unsigned long);
1118 int ide_cmd_ioctl(ide_drive_t *, unsigned int, unsigned long);
1119 int ide_task_ioctl(ide_drive_t *, unsigned int, unsigned long);
1120
1121 extern int ide_driveid_update(ide_drive_t *);
1122 extern int ide_config_drive_speed(ide_drive_t *, u8);
1123 extern u8 eighty_ninty_three (ide_drive_t *);
1124 extern int taskfile_lib_get_identify(ide_drive_t *drive, u8 *);
1125
1126 extern int ide_wait_not_busy(ide_hwif_t *hwif, unsigned long timeout);
1127
1128 extern void ide_stall_queue(ide_drive_t *drive, unsigned long timeout);
1129
1130 extern int ide_spin_wait_hwgroup(ide_drive_t *);
1131 extern void ide_timer_expiry(unsigned long);
1132 extern irqreturn_t ide_intr(int irq, void *dev_id);
1133 extern void do_ide_request(struct request_queue *);
1134
1135 void ide_init_disk(struct gendisk *, ide_drive_t *);
1136
1137 #ifdef CONFIG_IDEPCI_PCIBUS_ORDER
1138 extern int __ide_pci_register_driver(struct pci_driver *driver, struct module *owner, const char *mod_name);
1139 #define ide_pci_register_driver(d) __ide_pci_register_driver(d, THIS_MODULE, KBUILD_MODNAME)
1140 #else
1141 #define ide_pci_register_driver(d) pci_register_driver(d)
1142 #endif
1143
1144 void ide_pci_setup_ports(struct pci_dev *, const struct ide_port_info *, int,
1145                          hw_regs_t *, hw_regs_t **);
1146 void ide_setup_pci_noise(struct pci_dev *, const struct ide_port_info *);
1147
1148 #ifdef CONFIG_BLK_DEV_IDEDMA_PCI
1149 int ide_pci_set_master(struct pci_dev *, const char *);
1150 unsigned long ide_pci_dma_base(ide_hwif_t *, const struct ide_port_info *);
1151 int ide_pci_check_simplex(ide_hwif_t *, const struct ide_port_info *);
1152 int ide_hwif_setup_dma(ide_hwif_t *, const struct ide_port_info *);
1153 #else
1154 static inline int ide_hwif_setup_dma(ide_hwif_t *hwif,
1155                                      const struct ide_port_info *d)
1156 {
1157         return -EINVAL;
1158 }
1159 #endif
1160
1161 typedef struct ide_pci_enablebit_s {
1162         u8      reg;    /* byte pci reg holding the enable-bit */
1163         u8      mask;   /* mask to isolate the enable-bit */
1164         u8      val;    /* value of masked reg when "enabled" */
1165 } ide_pci_enablebit_t;
1166
1167 enum {
1168         /* Uses ISA control ports not PCI ones. */
1169         IDE_HFLAG_ISA_PORTS             = (1 << 0),
1170         /* single port device */
1171         IDE_HFLAG_SINGLE                = (1 << 1),
1172         /* don't use legacy PIO blacklist */
1173         IDE_HFLAG_PIO_NO_BLACKLIST      = (1 << 2),
1174         /* set for the second port of QD65xx */
1175         IDE_HFLAG_QD_2ND_PORT           = (1 << 3),
1176         /* use PIO8/9 for prefetch off/on */
1177         IDE_HFLAG_ABUSE_PREFETCH        = (1 << 4),
1178         /* use PIO6/7 for fast-devsel off/on */
1179         IDE_HFLAG_ABUSE_FAST_DEVSEL     = (1 << 5),
1180         /* use 100-102 and 200-202 PIO values to set DMA modes */
1181         IDE_HFLAG_ABUSE_DMA_MODES       = (1 << 6),
1182         /*
1183          * keep DMA setting when programming PIO mode, may be used only
1184          * for hosts which have separate PIO and DMA timings (ie. PMAC)
1185          */
1186         IDE_HFLAG_SET_PIO_MODE_KEEP_DMA = (1 << 7),
1187         /* program host for the transfer mode after programming device */
1188         IDE_HFLAG_POST_SET_MODE         = (1 << 8),
1189         /* don't program host/device for the transfer mode ("smart" hosts) */
1190         IDE_HFLAG_NO_SET_MODE           = (1 << 9),
1191         /* trust BIOS for programming chipset/device for DMA */
1192         IDE_HFLAG_TRUST_BIOS_FOR_DMA    = (1 << 10),
1193         /* host is CS5510/CS5520 */
1194         IDE_HFLAG_CS5520                = (1 << 11),
1195         /* ATAPI DMA is unsupported */
1196         IDE_HFLAG_NO_ATAPI_DMA          = (1 << 12),
1197         /* set if host is a "non-bootable" controller */
1198         IDE_HFLAG_NON_BOOTABLE          = (1 << 13),
1199         /* host doesn't support DMA */
1200         IDE_HFLAG_NO_DMA                = (1 << 14),
1201         /* check if host is PCI IDE device before allowing DMA */
1202         IDE_HFLAG_NO_AUTODMA            = (1 << 15),
1203         /* host uses MMIO */
1204         IDE_HFLAG_MMIO                  = (1 << 16),
1205         /* no LBA48 */
1206         IDE_HFLAG_NO_LBA48              = (1 << 17),
1207         /* no LBA48 DMA */
1208         IDE_HFLAG_NO_LBA48_DMA          = (1 << 18),
1209         /* data FIFO is cleared by an error */
1210         IDE_HFLAG_ERROR_STOPS_FIFO      = (1 << 19),
1211         /* serialize ports */
1212         IDE_HFLAG_SERIALIZE             = (1 << 20),
1213         /* use legacy IRQs */
1214         IDE_HFLAG_LEGACY_IRQS           = (1 << 21),
1215         /* force use of legacy IRQs */
1216         IDE_HFLAG_FORCE_LEGACY_IRQS     = (1 << 22),
1217         /* limit LBA48 requests to 256 sectors */
1218         IDE_HFLAG_RQSIZE_256            = (1 << 23),
1219         /* use 32-bit I/O ops */
1220         IDE_HFLAG_IO_32BIT              = (1 << 24),
1221         /* unmask IRQs */
1222         IDE_HFLAG_UNMASK_IRQS           = (1 << 25),
1223         /* serialize ports if DMA is possible (for sl82c105) */
1224         IDE_HFLAG_SERIALIZE_DMA         = (1 << 27),
1225         /* force host out of "simplex" mode */
1226         IDE_HFLAG_CLEAR_SIMPLEX         = (1 << 28),
1227         /* DSC overlap is unsupported */
1228         IDE_HFLAG_NO_DSC                = (1 << 29),
1229         /* never use 32-bit I/O ops */
1230         IDE_HFLAG_NO_IO_32BIT           = (1 << 30),
1231         /* never unmask IRQs */
1232         IDE_HFLAG_NO_UNMASK_IRQS        = (1 << 31),
1233 };
1234
1235 #ifdef CONFIG_BLK_DEV_OFFBOARD
1236 # define IDE_HFLAG_OFF_BOARD    0
1237 #else
1238 # define IDE_HFLAG_OFF_BOARD    IDE_HFLAG_NON_BOOTABLE
1239 #endif
1240
1241 struct ide_port_info {
1242         char                    *name;
1243         unsigned int            (*init_chipset)(struct pci_dev *);
1244         void                    (*init_iops)(ide_hwif_t *);
1245         void                    (*init_hwif)(ide_hwif_t *);
1246         int                     (*init_dma)(ide_hwif_t *,
1247                                             const struct ide_port_info *);
1248
1249         const struct ide_tp_ops         *tp_ops;
1250         const struct ide_port_ops       *port_ops;
1251         const struct ide_dma_ops        *dma_ops;
1252
1253         ide_pci_enablebit_t     enablebits[2];
1254         hwif_chipset_t          chipset;
1255         u32                     host_flags;
1256         u8                      pio_mask;
1257         u8                      swdma_mask;
1258         u8                      mwdma_mask;
1259         u8                      udma_mask;
1260 };
1261
1262 int ide_pci_init_one(struct pci_dev *, const struct ide_port_info *, void *);
1263 int ide_pci_init_two(struct pci_dev *, struct pci_dev *,
1264                      const struct ide_port_info *, void *);
1265 void ide_pci_remove(struct pci_dev *);
1266
1267 void ide_map_sg(ide_drive_t *, struct request *);
1268 void ide_init_sg_cmd(ide_drive_t *, struct request *);
1269
1270 #define BAD_DMA_DRIVE           0
1271 #define GOOD_DMA_DRIVE          1
1272
1273 struct drive_list_entry {
1274         const char *id_model;
1275         const char *id_firmware;
1276 };
1277
1278 int ide_in_drive_list(u16 *, const struct drive_list_entry *);
1279
1280 #ifdef CONFIG_BLK_DEV_IDEDMA
1281 int __ide_dma_bad_drive(ide_drive_t *);
1282 int ide_id_dma_bug(ide_drive_t *);
1283
1284 u8 ide_find_dma_mode(ide_drive_t *, u8);
1285
1286 static inline u8 ide_max_dma_mode(ide_drive_t *drive)
1287 {
1288         return ide_find_dma_mode(drive, XFER_UDMA_6);
1289 }
1290
1291 void ide_dma_off_quietly(ide_drive_t *);
1292 void ide_dma_off(ide_drive_t *);
1293 void ide_dma_on(ide_drive_t *);
1294 int ide_set_dma(ide_drive_t *);
1295 void ide_check_dma_crc(ide_drive_t *);
1296 ide_startstop_t ide_dma_intr(ide_drive_t *);
1297
1298 int ide_build_sglist(ide_drive_t *, struct request *);
1299 void ide_destroy_dmatable(ide_drive_t *);
1300
1301 #ifdef CONFIG_BLK_DEV_IDEDMA_SFF
1302 extern int ide_build_dmatable(ide_drive_t *, struct request *);
1303 int ide_allocate_dma_engine(ide_hwif_t *);
1304 void ide_release_dma_engine(ide_hwif_t *);
1305
1306 void ide_dma_host_set(ide_drive_t *, int);
1307 extern int ide_dma_setup(ide_drive_t *);
1308 void ide_dma_exec_cmd(ide_drive_t *, u8);
1309 extern void ide_dma_start(ide_drive_t *);
1310 extern int __ide_dma_end(ide_drive_t *);
1311 int ide_dma_test_irq(ide_drive_t *);
1312 extern void ide_dma_lost_irq(ide_drive_t *);
1313 extern void ide_dma_timeout(ide_drive_t *);
1314 extern const struct ide_dma_ops sff_dma_ops;
1315 #endif /* CONFIG_BLK_DEV_IDEDMA_SFF */
1316
1317 #else
1318 static inline int ide_id_dma_bug(ide_drive_t *drive) { return 0; }
1319 static inline u8 ide_find_dma_mode(ide_drive_t *drive, u8 speed) { return 0; }
1320 static inline u8 ide_max_dma_mode(ide_drive_t *drive) { return 0; }
1321 static inline void ide_dma_off_quietly(ide_drive_t *drive) { ; }
1322 static inline void ide_dma_off(ide_drive_t *drive) { ; }
1323 static inline void ide_dma_on(ide_drive_t *drive) { ; }
1324 static inline void ide_dma_verbose(ide_drive_t *drive) { ; }
1325 static inline int ide_set_dma(ide_drive_t *drive) { return 1; }
1326 static inline void ide_check_dma_crc(ide_drive_t *drive) { ; }
1327 #endif /* CONFIG_BLK_DEV_IDEDMA */
1328
1329 #ifndef CONFIG_BLK_DEV_IDEDMA_SFF
1330 static inline void ide_release_dma_engine(ide_hwif_t *hwif) { ; }
1331 #endif
1332
1333 #ifdef CONFIG_BLK_DEV_IDEACPI
1334 extern int ide_acpi_exec_tfs(ide_drive_t *drive);
1335 extern void ide_acpi_get_timing(ide_hwif_t *hwif);
1336 extern void ide_acpi_push_timing(ide_hwif_t *hwif);
1337 extern void ide_acpi_init(ide_hwif_t *hwif);
1338 void ide_acpi_port_init_devices(ide_hwif_t *);
1339 extern void ide_acpi_set_state(ide_hwif_t *hwif, int on);
1340 #else
1341 static inline int ide_acpi_exec_tfs(ide_drive_t *drive) { return 0; }
1342 static inline void ide_acpi_get_timing(ide_hwif_t *hwif) { ; }
1343 static inline void ide_acpi_push_timing(ide_hwif_t *hwif) { ; }
1344 static inline void ide_acpi_init(ide_hwif_t *hwif) { ; }
1345 static inline void ide_acpi_port_init_devices(ide_hwif_t *hwif) { ; }
1346 static inline void ide_acpi_set_state(ide_hwif_t *hwif, int on) {}
1347 #endif
1348
1349 void ide_remove_port_from_hwgroup(ide_hwif_t *);
1350 void ide_unregister(ide_hwif_t *);
1351
1352 void ide_register_region(struct gendisk *);
1353 void ide_unregister_region(struct gendisk *);
1354
1355 void ide_undecoded_slave(ide_drive_t *);
1356
1357 void ide_port_apply_params(ide_hwif_t *);
1358
1359 struct ide_host *ide_host_alloc_all(const struct ide_port_info *, hw_regs_t **);
1360 struct ide_host *ide_host_alloc(const struct ide_port_info *, hw_regs_t **);
1361 void ide_host_free(struct ide_host *);
1362 int ide_host_register(struct ide_host *, const struct ide_port_info *,
1363                       hw_regs_t **);
1364 int ide_host_add(const struct ide_port_info *, hw_regs_t **,
1365                  struct ide_host **);
1366 void ide_host_remove(struct ide_host *);
1367 int ide_legacy_device_add(const struct ide_port_info *, unsigned long);
1368 void ide_port_unregister_devices(ide_hwif_t *);
1369 void ide_port_scan(ide_hwif_t *);
1370
1371 static inline void *ide_get_hwifdata (ide_hwif_t * hwif)
1372 {
1373         return hwif->hwif_data;
1374 }
1375
1376 static inline void ide_set_hwifdata (ide_hwif_t * hwif, void *data)
1377 {
1378         hwif->hwif_data = data;
1379 }
1380
1381 const char *ide_xfer_verbose(u8 mode);
1382 extern void ide_toggle_bounce(ide_drive_t *drive, int on);
1383 extern int ide_set_xfer_rate(ide_drive_t *drive, u8 rate);
1384
1385 u64 ide_get_lba_addr(struct ide_taskfile *, int);
1386 u8 ide_dump_status(ide_drive_t *, const char *, u8);
1387
1388 struct ide_timing {
1389         u8  mode;
1390         u8  setup;      /* t1 */
1391         u16 act8b;      /* t2 for 8-bit io */
1392         u16 rec8b;      /* t2i for 8-bit io */
1393         u16 cyc8b;      /* t0 for 8-bit io */
1394         u16 active;     /* t2 or tD */
1395         u16 recover;    /* t2i or tK */
1396         u16 cycle;      /* t0 */
1397         u16 udma;       /* t2CYCTYP/2 */
1398 };
1399
1400 enum {
1401         IDE_TIMING_SETUP        = (1 << 0),
1402         IDE_TIMING_ACT8B        = (1 << 1),
1403         IDE_TIMING_REC8B        = (1 << 2),
1404         IDE_TIMING_CYC8B        = (1 << 3),
1405         IDE_TIMING_8BIT         = IDE_TIMING_ACT8B | IDE_TIMING_REC8B |
1406                                   IDE_TIMING_CYC8B,
1407         IDE_TIMING_ACTIVE       = (1 << 4),
1408         IDE_TIMING_RECOVER      = (1 << 5),
1409         IDE_TIMING_CYCLE        = (1 << 6),
1410         IDE_TIMING_UDMA         = (1 << 7),
1411         IDE_TIMING_ALL          = IDE_TIMING_SETUP | IDE_TIMING_8BIT |
1412                                   IDE_TIMING_ACTIVE | IDE_TIMING_RECOVER |
1413                                   IDE_TIMING_CYCLE | IDE_TIMING_UDMA,
1414 };
1415
1416 struct ide_timing *ide_timing_find_mode(u8);
1417 u16 ide_pio_cycle_time(ide_drive_t *, u8);
1418 void ide_timing_merge(struct ide_timing *, struct ide_timing *,
1419                       struct ide_timing *, unsigned int);
1420 int ide_timing_compute(ide_drive_t *, u8, struct ide_timing *, int, int);
1421
1422 int ide_scan_pio_blacklist(char *);
1423
1424 u8 ide_get_best_pio_mode(ide_drive_t *, u8, u8);
1425
1426 int ide_set_pio_mode(ide_drive_t *, u8);
1427 int ide_set_dma_mode(ide_drive_t *, u8);
1428
1429 void ide_set_pio(ide_drive_t *, u8);
1430
1431 static inline void ide_set_max_pio(ide_drive_t *drive)
1432 {
1433         ide_set_pio(drive, 255);
1434 }
1435
1436 extern spinlock_t ide_lock;
1437 extern struct mutex ide_cfg_mtx;
1438 /*
1439  * Structure locking:
1440  *
1441  * ide_cfg_mtx and ide_lock together protect changes to
1442  * ide_hwif_t->{next,hwgroup}
1443  * ide_drive_t->next
1444  *
1445  * ide_hwgroup_t->busy: ide_lock
1446  * ide_hwgroup_t->hwif: ide_lock
1447  * ide_hwif_t->mate: constant, no locking
1448  * ide_drive_t->hwif: constant, no locking
1449  */
1450
1451 #define local_irq_set(flags)    do { local_save_flags((flags)); local_irq_enable_in_hardirq(); } while (0)
1452
1453 extern struct bus_type ide_bus_type;
1454 extern struct class *ide_port_class;
1455
1456 static inline void ide_dump_identify(u8 *id)
1457 {
1458         print_hex_dump(KERN_INFO, "", DUMP_PREFIX_NONE, 16, 2, id, 512, 0);
1459 }
1460
1461 static inline int hwif_to_node(ide_hwif_t *hwif)
1462 {
1463         return hwif->dev ? dev_to_node(hwif->dev) : -1;
1464 }
1465
1466 static inline ide_drive_t *ide_get_pair_dev(ide_drive_t *drive)
1467 {
1468         ide_drive_t *peer = &drive->hwif->drives[(drive->dn ^ 1) & 1];
1469
1470         return peer->present ? peer : NULL;
1471 }
1472 #endif /* _IDE_H */