ide: replace IDE_TFLAG_* flags by IDE_VALID_*
[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 #include <linux/pm.h>
21 #ifdef CONFIG_BLK_DEV_IDEACPI
22 #include <acpi/acpi.h>
23 #endif
24 #include <asm/byteorder.h>
25 #include <asm/system.h>
26 #include <asm/io.h>
27 #include <asm/mutex.h>
28
29 #if defined(CONFIG_CRIS) || defined(CONFIG_FRV) || defined(CONFIG_MN10300)
30 # define SUPPORT_VLB_SYNC 0
31 #else
32 # define SUPPORT_VLB_SYNC 1
33 #endif
34
35 /*
36  * Probably not wise to fiddle with these
37  */
38 #define IDE_DEFAULT_MAX_FAILURES        1
39 #define ERROR_MAX       8       /* Max read/write errors per sector */
40 #define ERROR_RESET     3       /* Reset controller every 4th retry */
41 #define ERROR_RECAL     1       /* Recalibrate every 2nd retry */
42
43 /* Error codes returned in rq->errors to the higher part of the driver. */
44 enum {
45         IDE_DRV_ERROR_GENERAL   = 101,
46         IDE_DRV_ERROR_FILEMARK  = 102,
47         IDE_DRV_ERROR_EOD       = 103,
48 };
49
50 /*
51  * Definitions for accessing IDE controller registers
52  */
53 #define IDE_NR_PORTS            (10)
54
55 struct ide_io_ports {
56         unsigned long   data_addr;
57
58         union {
59                 unsigned long error_addr;       /*   read:  error */
60                 unsigned long feature_addr;     /*  write: feature */
61         };
62
63         unsigned long   nsect_addr;
64         unsigned long   lbal_addr;
65         unsigned long   lbam_addr;
66         unsigned long   lbah_addr;
67
68         unsigned long   device_addr;
69
70         union {
71                 unsigned long status_addr;      /*  read: status  */
72                 unsigned long command_addr;     /* write: command */
73         };
74
75         unsigned long   ctl_addr;
76
77         unsigned long   irq_addr;
78 };
79
80 #define OK_STAT(stat,good,bad)  (((stat)&((good)|(bad)))==(good))
81
82 #define BAD_R_STAT      (ATA_BUSY | ATA_ERR)
83 #define BAD_W_STAT      (BAD_R_STAT | ATA_DF)
84 #define BAD_STAT        (BAD_R_STAT | ATA_DRQ)
85 #define DRIVE_READY     (ATA_DRDY | ATA_DSC)
86
87 #define BAD_CRC         (ATA_ABORTED | ATA_ICRC)
88
89 #define SATA_NR_PORTS           (3)     /* 16 possible ?? */
90
91 #define SATA_STATUS_OFFSET      (0)
92 #define SATA_ERROR_OFFSET       (1)
93 #define SATA_CONTROL_OFFSET     (2)
94
95 /*
96  * Our Physical Region Descriptor (PRD) table should be large enough
97  * to handle the biggest I/O request we are likely to see.  Since requests
98  * can have no more than 256 sectors, and since the typical blocksize is
99  * two or more sectors, we could get by with a limit of 128 entries here for
100  * the usual worst case.  Most requests seem to include some contiguous blocks,
101  * further reducing the number of table entries required.
102  *
103  * The driver reverts to PIO mode for individual requests that exceed
104  * this limit (possible with 512 byte blocksizes, eg. MSDOS f/s), so handling
105  * 100% of all crazy scenarios here is not necessary.
106  *
107  * As it turns out though, we must allocate a full 4KB page for this,
108  * so the two PRD tables (ide0 & ide1) will each get half of that,
109  * allowing each to have about 256 entries (8 bytes each) from this.
110  */
111 #define PRD_BYTES       8
112 #define PRD_ENTRIES     256
113
114 /*
115  * Some more useful definitions
116  */
117 #define PARTN_BITS      6       /* number of minor dev bits for partitions */
118 #define MAX_DRIVES      2       /* per interface; 2 assumed by lots of code */
119 #define SECTOR_SIZE     512
120
121 /*
122  * Timeouts for various operations:
123  */
124 enum {
125         /* spec allows up to 20ms */
126         WAIT_DRQ        = HZ / 10,      /* 100ms */
127         /* some laptops are very slow */
128         WAIT_READY      = 5 * HZ,       /* 5s */
129         /* should be less than 3ms (?), if all ATAPI CD is closed at boot */
130         WAIT_PIDENTIFY  = 10 * HZ,      /* 10s */
131         /* worst case when spinning up */
132         WAIT_WORSTCASE  = 30 * HZ,      /* 30s */
133         /* maximum wait for an IRQ to happen */
134         WAIT_CMD        = 10 * HZ,      /* 10s */
135         /* Some drives require a longer IRQ timeout. */
136         WAIT_FLOPPY_CMD = 50 * HZ,      /* 50s */
137         /*
138          * Some drives (for example, Seagate STT3401A Travan) require a very
139          * long timeout, because they don't return an interrupt or clear their
140          * BSY bit until after the command completes (even retension commands).
141          */
142         WAIT_TAPE_CMD   = 900 * HZ,     /* 900s */
143         /* minimum sleep time */
144         WAIT_MIN_SLEEP  = HZ / 50,      /* 20ms */
145 };
146
147 /*
148  * Op codes for special requests to be handled by ide_special_rq().
149  * Values should be in the range of 0x20 to 0x3f.
150  */
151 #define REQ_DRIVE_RESET         0x20
152 #define REQ_DEVSET_EXEC         0x21
153 #define REQ_PARK_HEADS          0x22
154 #define REQ_UNPARK_HEADS        0x23
155
156 /*
157  * Check for an interrupt and acknowledge the interrupt status
158  */
159 struct hwif_s;
160 typedef int (ide_ack_intr_t)(struct hwif_s *);
161
162 /*
163  * hwif_chipset_t is used to keep track of the specific hardware
164  * chipset used by each IDE interface, if known.
165  */
166 enum {          ide_unknown,    ide_generic,    ide_pci,
167                 ide_cmd640,     ide_dtc2278,    ide_ali14xx,
168                 ide_qd65xx,     ide_umc8672,    ide_ht6560b,
169                 ide_4drives,    ide_pmac,       ide_acorn,
170                 ide_au1xxx,     ide_palm3710
171 };
172
173 typedef u8 hwif_chipset_t;
174
175 /*
176  * Structure to hold all information about the location of this port
177  */
178 typedef struct hw_regs_s {
179         union {
180                 struct ide_io_ports     io_ports;
181                 unsigned long           io_ports_array[IDE_NR_PORTS];
182         };
183
184         int             irq;                    /* our irq number */
185         ide_ack_intr_t  *ack_intr;              /* acknowledge interrupt */
186         hwif_chipset_t  chipset;
187         struct device   *dev, *parent;
188         unsigned long   config;
189 } hw_regs_t;
190
191 static inline void ide_std_init_ports(hw_regs_t *hw,
192                                       unsigned long io_addr,
193                                       unsigned long ctl_addr)
194 {
195         unsigned int i;
196
197         for (i = 0; i <= 7; i++)
198                 hw->io_ports_array[i] = io_addr++;
199
200         hw->io_ports.ctl_addr = ctl_addr;
201 }
202
203 #define MAX_HWIFS       10
204
205 /*
206  * Now for the data we need to maintain per-drive:  ide_drive_t
207  */
208
209 #define ide_scsi        0x21
210 #define ide_disk        0x20
211 #define ide_optical     0x7
212 #define ide_cdrom       0x5
213 #define ide_tape        0x1
214 #define ide_floppy      0x0
215
216 /*
217  * Special Driver Flags
218  *
219  * set_geometry : respecify drive geometry
220  * recalibrate  : seek to cyl 0
221  * set_multmode : set multmode count
222  * reserved     : unused
223  */
224 typedef union {
225         unsigned all                    : 8;
226         struct {
227                 unsigned set_geometry   : 1;
228                 unsigned recalibrate    : 1;
229                 unsigned set_multmode   : 1;
230                 unsigned reserved       : 5;
231         } b;
232 } special_t;
233
234 /*
235  * Status returned from various ide_ functions
236  */
237 typedef enum {
238         ide_stopped,    /* no drive operation was started */
239         ide_started,    /* a drive operation was started, handler was set */
240 } ide_startstop_t;
241
242 enum {
243         IDE_VALID_ERROR                 = (1 << 1),
244         IDE_VALID_FEATURE               = IDE_VALID_ERROR,
245         IDE_VALID_NSECT                 = (1 << 2),
246         IDE_VALID_LBAL                  = (1 << 3),
247         IDE_VALID_LBAM                  = (1 << 4),
248         IDE_VALID_LBAH                  = (1 << 5),
249         IDE_VALID_DEVICE                = (1 << 6),
250         IDE_VALID_LBA                   = IDE_VALID_LBAL |
251                                           IDE_VALID_LBAM |
252                                           IDE_VALID_LBAH,
253         IDE_VALID_OUT_TF                = IDE_VALID_FEATURE |
254                                           IDE_VALID_NSECT |
255                                           IDE_VALID_LBA,
256         IDE_VALID_IN_TF                 = IDE_VALID_NSECT |
257                                           IDE_VALID_LBA,
258         IDE_VALID_OUT_HOB               = IDE_VALID_OUT_TF,
259         IDE_VALID_IN_HOB                = IDE_VALID_ERROR |
260                                           IDE_VALID_NSECT |
261                                           IDE_VALID_LBA,
262 };
263
264 enum {
265         IDE_TFLAG_LBA48                 = (1 << 0),
266         IDE_TFLAG_WRITE                 = (1 << 1),
267         IDE_TFLAG_CUSTOM_HANDLER        = (1 << 2),
268         IDE_TFLAG_DMA_PIO_FALLBACK      = (1 << 3),
269         /* force 16-bit I/O operations */
270         IDE_TFLAG_IO_16BIT              = (1 << 4),
271         /* struct ide_cmd was allocated using kmalloc() */
272         IDE_TFLAG_DYN                   = (1 << 5),
273         IDE_TFLAG_FS                    = (1 << 6),
274         IDE_TFLAG_MULTI_PIO             = (1 << 7),
275 };
276
277 enum {
278         IDE_FTFLAG_FLAGGED              = (1 << 0),
279         IDE_FTFLAG_SET_IN_FLAGS         = (1 << 1),
280         IDE_FTFLAG_OUT_DATA             = (1 << 2),
281         IDE_FTFLAG_IN_DATA              = (1 << 3),
282 };
283
284 struct ide_taskfile {
285         u8      hob_data;       /*  0: high data byte (for TASKFILE IOCTL) */
286                                 /*  1-5: additional data to support LBA48 */
287         union {
288                 u8 hob_error;   /*   read: error */
289                 u8 hob_feature; /*  write: feature */
290         };
291
292         u8      hob_nsect;
293         u8      hob_lbal;
294         u8      hob_lbam;
295         u8      hob_lbah;
296
297         u8      data;           /*  6: low data byte (for TASKFILE IOCTL) */
298
299         union {                 /*  7: */
300                 u8 error;       /*   read:  error */
301                 u8 feature;     /*  write: feature */
302         };
303
304         u8      nsect;          /*  8: number of sectors */
305         u8      lbal;           /*  9: LBA low */
306         u8      lbam;           /* 10: LBA mid */
307         u8      lbah;           /* 11: LBA high */
308
309         u8      device;         /* 12: device select */
310
311         union {                 /* 13: */
312                 u8 status;      /*  read: status  */
313                 u8 command;     /* write: command */
314         };
315 };
316
317 struct ide_cmd {
318         union {
319                 struct ide_taskfile     tf;
320                 u8                      tf_array[14];
321         };
322
323         struct {
324                 struct {
325                         u8              tf;
326                         u8              hob;
327                 } out, in;
328         } valid;
329
330         u8                      tf_flags;
331         u8                      ftf_flags;      /* for TASKFILE ioctl */
332         int                     protocol;
333
334         int                     sg_nents;         /* number of sg entries */
335         int                     orig_sg_nents;
336         int                     sg_dma_direction; /* DMA transfer direction */
337
338         unsigned int            nbytes;
339         unsigned int            nleft;
340         unsigned int            last_xfer_len;
341
342         struct scatterlist      *cursg;
343         unsigned int            cursg_ofs;
344
345         struct request          *rq;            /* copy of request */
346         void                    *special;       /* valid_t generally */
347 };
348
349 /* ATAPI packet command flags */
350 enum {
351         /* set when an error is considered normal - no retry (ide-tape) */
352         PC_FLAG_ABORT                   = (1 << 0),
353         PC_FLAG_SUPPRESS_ERROR          = (1 << 1),
354         PC_FLAG_WAIT_FOR_DSC            = (1 << 2),
355         PC_FLAG_DMA_OK                  = (1 << 3),
356         PC_FLAG_DMA_IN_PROGRESS         = (1 << 4),
357         PC_FLAG_DMA_ERROR               = (1 << 5),
358         PC_FLAG_WRITING                 = (1 << 6),
359 };
360
361 /*
362  * With each packet command, we allocate a buffer of IDE_PC_BUFFER_SIZE bytes.
363  * This is used for several packet commands (not for READ/WRITE commands).
364  */
365 #define IDE_PC_BUFFER_SIZE      64
366 #define ATAPI_WAIT_PC           (60 * HZ)
367
368 struct ide_atapi_pc {
369         /* actual packet bytes */
370         u8 c[12];
371         /* incremented on each retry */
372         int retries;
373         int error;
374
375         /* bytes to transfer */
376         int req_xfer;
377         /* bytes actually transferred */
378         int xferred;
379
380         /* data buffer */
381         u8 *buf;
382         /* current buffer position */
383         u8 *cur_pos;
384         int buf_size;
385         /* missing/available data on the current buffer */
386         int b_count;
387
388         /* the corresponding request */
389         struct request *rq;
390
391         unsigned long flags;
392
393         /*
394          * those are more or less driver-specific and some of them are subject
395          * to change/removal later.
396          */
397         u8 pc_buf[IDE_PC_BUFFER_SIZE];
398
399         /* idetape only */
400         struct idetape_bh *bh;
401         char *b_data;
402
403         unsigned long timeout;
404 };
405
406 struct ide_devset;
407 struct ide_driver;
408
409 #ifdef CONFIG_BLK_DEV_IDEACPI
410 struct ide_acpi_drive_link;
411 struct ide_acpi_hwif_link;
412 #endif
413
414 struct ide_drive_s;
415
416 struct ide_disk_ops {
417         int             (*check)(struct ide_drive_s *, const char *);
418         int             (*get_capacity)(struct ide_drive_s *);
419         void            (*setup)(struct ide_drive_s *);
420         void            (*flush)(struct ide_drive_s *);
421         int             (*init_media)(struct ide_drive_s *, struct gendisk *);
422         int             (*set_doorlock)(struct ide_drive_s *, struct gendisk *,
423                                         int);
424         ide_startstop_t (*do_request)(struct ide_drive_s *, struct request *,
425                                       sector_t);
426         int             (*ioctl)(struct ide_drive_s *, struct block_device *,
427                                  fmode_t, unsigned int, unsigned long);
428 };
429
430 /* ATAPI device flags */
431 enum {
432         IDE_AFLAG_DRQ_INTERRUPT         = (1 << 0),
433
434         /* ide-cd */
435         /* Drive cannot eject the disc. */
436         IDE_AFLAG_NO_EJECT              = (1 << 1),
437         /* Drive is a pre ATAPI 1.2 drive. */
438         IDE_AFLAG_PRE_ATAPI12           = (1 << 2),
439         /* TOC addresses are in BCD. */
440         IDE_AFLAG_TOCADDR_AS_BCD        = (1 << 3),
441         /* TOC track numbers are in BCD. */
442         IDE_AFLAG_TOCTRACKS_AS_BCD      = (1 << 4),
443         /* Saved TOC information is current. */
444         IDE_AFLAG_TOC_VALID             = (1 << 6),
445         /* We think that the drive door is locked. */
446         IDE_AFLAG_DOOR_LOCKED           = (1 << 7),
447         /* SET_CD_SPEED command is unsupported. */
448         IDE_AFLAG_NO_SPEED_SELECT       = (1 << 8),
449         IDE_AFLAG_VERTOS_300_SSD        = (1 << 9),
450         IDE_AFLAG_VERTOS_600_ESD        = (1 << 10),
451         IDE_AFLAG_SANYO_3CD             = (1 << 11),
452         IDE_AFLAG_FULL_CAPS_PAGE        = (1 << 12),
453         IDE_AFLAG_PLAY_AUDIO_OK         = (1 << 13),
454         IDE_AFLAG_LE_SPEED_FIELDS       = (1 << 14),
455
456         /* ide-floppy */
457         /* Avoid commands not supported in Clik drive */
458         IDE_AFLAG_CLIK_DRIVE            = (1 << 15),
459         /* Requires BH algorithm for packets */
460         IDE_AFLAG_ZIP_DRIVE             = (1 << 16),
461         /* Supports format progress report */
462         IDE_AFLAG_SRFP                  = (1 << 17),
463
464         /* ide-tape */
465         IDE_AFLAG_IGNORE_DSC            = (1 << 18),
466         /* 0 When the tape position is unknown */
467         IDE_AFLAG_ADDRESS_VALID         = (1 << 19),
468         /* Device already opened */
469         IDE_AFLAG_BUSY                  = (1 << 20),
470         /* Attempt to auto-detect the current user block size */
471         IDE_AFLAG_DETECT_BS             = (1 << 21),
472         /* Currently on a filemark */
473         IDE_AFLAG_FILEMARK              = (1 << 22),
474         /* 0 = no tape is loaded, so we don't rewind after ejecting */
475         IDE_AFLAG_MEDIUM_PRESENT        = (1 << 23),
476
477         IDE_AFLAG_NO_AUTOCLOSE          = (1 << 24),
478 };
479
480 /* device flags */
481 enum {
482         /* restore settings after device reset */
483         IDE_DFLAG_KEEP_SETTINGS         = (1 << 0),
484         /* device is using DMA for read/write */
485         IDE_DFLAG_USING_DMA             = (1 << 1),
486         /* okay to unmask other IRQs */
487         IDE_DFLAG_UNMASK                = (1 << 2),
488         /* don't attempt flushes */
489         IDE_DFLAG_NOFLUSH               = (1 << 3),
490         /* DSC overlap */
491         IDE_DFLAG_DSC_OVERLAP           = (1 << 4),
492         /* give potential excess bandwidth */
493         IDE_DFLAG_NICE1                 = (1 << 5),
494         /* device is physically present */
495         IDE_DFLAG_PRESENT               = (1 << 6),
496         /* id read from device (synthetic if not set) */
497         IDE_DFLAG_ID_READ               = (1 << 8),
498         IDE_DFLAG_NOPROBE               = (1 << 9),
499         /* need to do check_media_change() */
500         IDE_DFLAG_REMOVABLE             = (1 << 10),
501         /* needed for removable devices */
502         IDE_DFLAG_ATTACH                = (1 << 11),
503         IDE_DFLAG_FORCED_GEOM           = (1 << 12),
504         /* disallow setting unmask bit */
505         IDE_DFLAG_NO_UNMASK             = (1 << 13),
506         /* disallow enabling 32-bit I/O */
507         IDE_DFLAG_NO_IO_32BIT           = (1 << 14),
508         /* for removable only: door lock/unlock works */
509         IDE_DFLAG_DOORLOCKING           = (1 << 15),
510         /* disallow DMA */
511         IDE_DFLAG_NODMA                 = (1 << 16),
512         /* powermanagment told us not to do anything, so sleep nicely */
513         IDE_DFLAG_BLOCKED               = (1 << 17),
514         /* sleeping & sleep field valid */
515         IDE_DFLAG_SLEEPING              = (1 << 18),
516         IDE_DFLAG_POST_RESET            = (1 << 19),
517         IDE_DFLAG_UDMA33_WARNED         = (1 << 20),
518         IDE_DFLAG_LBA48                 = (1 << 21),
519         /* status of write cache */
520         IDE_DFLAG_WCACHE                = (1 << 22),
521         /* used for ignoring ATA_DF */
522         IDE_DFLAG_NOWERR                = (1 << 23),
523         /* retrying in PIO */
524         IDE_DFLAG_DMA_PIO_RETRY         = (1 << 24),
525         IDE_DFLAG_LBA                   = (1 << 25),
526         /* don't unload heads */
527         IDE_DFLAG_NO_UNLOAD             = (1 << 26),
528         /* heads unloaded, please don't reset port */
529         IDE_DFLAG_PARKED                = (1 << 27),
530         IDE_DFLAG_MEDIA_CHANGED         = (1 << 28),
531         /* write protect */
532         IDE_DFLAG_WP                    = (1 << 29),
533         IDE_DFLAG_FORMAT_IN_PROGRESS    = (1 << 30),
534 };
535
536 struct ide_drive_s {
537         char            name[4];        /* drive name, such as "hda" */
538         char            driver_req[10]; /* requests specific driver */
539
540         struct request_queue    *queue; /* request queue */
541
542         struct request          *rq;    /* current request */
543         void            *driver_data;   /* extra driver data */
544         u16                     *id;    /* identification info */
545 #ifdef CONFIG_IDE_PROC_FS
546         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
547         const struct ide_proc_devset *settings; /* /proc/ide/ drive settings */
548 #endif
549         struct hwif_s           *hwif;  /* actually (ide_hwif_t *) */
550
551         const struct ide_disk_ops *disk_ops;
552
553         unsigned long dev_flags;
554
555         unsigned long sleep;            /* sleep until this time */
556         unsigned long timeout;          /* max time to wait for irq */
557
558         special_t       special;        /* special action flags */
559
560         u8      select;                 /* basic drive/head select reg value */
561         u8      retry_pio;              /* retrying dma capable host in pio */
562         u8      waiting_for_dma;        /* dma currently in progress */
563         u8      dma;                    /* atapi dma flag */
564
565         u8      quirk_list;     /* considered quirky, set for a specific host */
566         u8      init_speed;     /* transfer rate set at boot */
567         u8      current_speed;  /* current transfer rate set */
568         u8      desired_speed;  /* desired transfer rate set */
569         u8      dn;             /* now wide spread use */
570         u8      acoustic;       /* acoustic management */
571         u8      media;          /* disk, cdrom, tape, floppy, ... */
572         u8      ready_stat;     /* min status value for drive ready */
573         u8      mult_count;     /* current multiple sector setting */
574         u8      mult_req;       /* requested multiple sector setting */
575         u8      io_32bit;       /* 0=16-bit, 1=32-bit, 2/3=32bit+sync */
576         u8      bad_wstat;      /* used for ignoring ATA_DF */
577         u8      head;           /* "real" number of heads */
578         u8      sect;           /* "real" sectors per track */
579         u8      bios_head;      /* BIOS/fdisk/LILO number of heads */
580         u8      bios_sect;      /* BIOS/fdisk/LILO sectors per track */
581
582         /* delay this long before sending packet command */
583         u8 pc_delay;
584
585         unsigned int    bios_cyl;       /* BIOS/fdisk/LILO number of cyls */
586         unsigned int    cyl;            /* "real" number of cyls */
587         unsigned int    drive_data;     /* used by set_pio_mode/dev_select() */
588         unsigned int    failures;       /* current failure count */
589         unsigned int    max_failures;   /* maximum allowed failure count */
590         u64             probed_capacity;/* initial reported media capacity (ide-cd only currently) */
591
592         u64             capacity64;     /* total number of sectors */
593
594         int             lun;            /* logical unit */
595         int             crc_count;      /* crc counter to reduce drive speed */
596
597         unsigned long   debug_mask;     /* debugging levels switch */
598
599 #ifdef CONFIG_BLK_DEV_IDEACPI
600         struct ide_acpi_drive_link *acpidata;
601 #endif
602         struct list_head list;
603         struct device   gendev;
604         struct completion gendev_rel_comp;      /* to deal with device release() */
605
606         /* current packet command */
607         struct ide_atapi_pc *pc;
608
609         /* last failed packet command */
610         struct ide_atapi_pc *failed_pc;
611
612         /* callback for packet commands */
613         int  (*pc_callback)(struct ide_drive_s *, int);
614
615         void (*pc_update_buffers)(struct ide_drive_s *, struct ide_atapi_pc *);
616         int  (*pc_io_buffers)(struct ide_drive_s *, struct ide_atapi_pc *,
617                               unsigned int, int);
618
619         ide_startstop_t (*irq_handler)(struct ide_drive_s *);
620
621         unsigned long atapi_flags;
622
623         struct ide_atapi_pc request_sense_pc;
624         struct request request_sense_rq;
625 };
626
627 typedef struct ide_drive_s ide_drive_t;
628
629 #define to_ide_device(dev)              container_of(dev, ide_drive_t, gendev)
630
631 #define to_ide_drv(obj, cont_type)      \
632         container_of(obj, struct cont_type, dev)
633
634 #define ide_drv_g(disk, cont_type)      \
635         container_of((disk)->private_data, struct cont_type, driver)
636
637 struct ide_port_info;
638
639 struct ide_tp_ops {
640         void    (*exec_command)(struct hwif_s *, u8);
641         u8      (*read_status)(struct hwif_s *);
642         u8      (*read_altstatus)(struct hwif_s *);
643         void    (*write_devctl)(struct hwif_s *, u8);
644
645         void    (*dev_select)(ide_drive_t *);
646         void    (*tf_load)(ide_drive_t *, struct ide_cmd *);
647         void    (*tf_read)(ide_drive_t *, struct ide_cmd *);
648
649         void    (*input_data)(ide_drive_t *, struct ide_cmd *,
650                               void *, unsigned int);
651         void    (*output_data)(ide_drive_t *, struct ide_cmd *,
652                                void *, unsigned int);
653 };
654
655 extern const struct ide_tp_ops default_tp_ops;
656
657 /**
658  * struct ide_port_ops - IDE port operations
659  *
660  * @init_dev:           host specific initialization of a device
661  * @set_pio_mode:       routine to program host for PIO mode
662  * @set_dma_mode:       routine to program host for DMA mode
663  * @reset_poll:         chipset polling based on hba specifics
664  * @pre_reset:          chipset specific changes to default for device-hba resets
665  * @resetproc:          routine to reset controller after a disk reset
666  * @maskproc:           special host masking for drive selection
667  * @quirkproc:          check host's drive quirk list
668  * @clear_irq:          clear IRQ
669  *
670  * @mdma_filter:        filter MDMA modes
671  * @udma_filter:        filter UDMA modes
672  *
673  * @cable_detect:       detect cable type
674  */
675 struct ide_port_ops {
676         void    (*init_dev)(ide_drive_t *);
677         void    (*set_pio_mode)(ide_drive_t *, const u8);
678         void    (*set_dma_mode)(ide_drive_t *, const u8);
679         int     (*reset_poll)(ide_drive_t *);
680         void    (*pre_reset)(ide_drive_t *);
681         void    (*resetproc)(ide_drive_t *);
682         void    (*maskproc)(ide_drive_t *, int);
683         void    (*quirkproc)(ide_drive_t *);
684         void    (*clear_irq)(ide_drive_t *);
685
686         u8      (*mdma_filter)(ide_drive_t *);
687         u8      (*udma_filter)(ide_drive_t *);
688
689         u8      (*cable_detect)(struct hwif_s *);
690 };
691
692 struct ide_dma_ops {
693         void    (*dma_host_set)(struct ide_drive_s *, int);
694         int     (*dma_setup)(struct ide_drive_s *, struct ide_cmd *);
695         void    (*dma_start)(struct ide_drive_s *);
696         int     (*dma_end)(struct ide_drive_s *);
697         int     (*dma_test_irq)(struct ide_drive_s *);
698         void    (*dma_lost_irq)(struct ide_drive_s *);
699         /* below ones are optional */
700         int     (*dma_check)(struct ide_drive_s *, struct ide_cmd *);
701         int     (*dma_timer_expiry)(struct ide_drive_s *);
702         void    (*dma_clear)(struct ide_drive_s *);
703         /*
704          * The following method is optional and only required to be
705          * implemented for the SFF-8038i compatible controllers.
706          */
707         u8      (*dma_sff_read_status)(struct hwif_s *);
708 };
709
710 struct ide_host;
711
712 typedef struct hwif_s {
713         struct hwif_s *mate;            /* other hwif from same PCI chip */
714         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
715
716         struct ide_host *host;
717
718         char name[6];                   /* name of interface, eg. "ide0" */
719
720         struct ide_io_ports     io_ports;
721
722         unsigned long   sata_scr[SATA_NR_PORTS];
723
724         ide_drive_t     *devices[MAX_DRIVES + 1];
725
726         u8 major;       /* our major number */
727         u8 index;       /* 0 for ide0; 1 for ide1; ... */
728         u8 channel;     /* for dual-port chips: 0=primary, 1=secondary */
729
730         u32 host_flags;
731
732         u8 pio_mask;
733
734         u8 ultra_mask;
735         u8 mwdma_mask;
736         u8 swdma_mask;
737
738         u8 cbl;         /* cable type */
739
740         hwif_chipset_t chipset; /* sub-module for tuning.. */
741
742         struct device *dev;
743
744         ide_ack_intr_t *ack_intr;
745
746         void (*rw_disk)(ide_drive_t *, struct request *);
747
748         const struct ide_tp_ops         *tp_ops;
749         const struct ide_port_ops       *port_ops;
750         const struct ide_dma_ops        *dma_ops;
751
752         /* dma physical region descriptor table (cpu view) */
753         unsigned int    *dmatable_cpu;
754         /* dma physical region descriptor table (dma view) */
755         dma_addr_t      dmatable_dma;
756
757         /* maximum number of PRD table entries */
758         int prd_max_nents;
759         /* PRD entry size in bytes */
760         int prd_ent_size;
761
762         /* Scatter-gather list used to build the above */
763         struct scatterlist *sg_table;
764         int sg_max_nents;               /* Maximum number of entries in it */
765
766         struct ide_cmd cmd;             /* current command */
767
768         int             rqsize;         /* max sectors per request */
769         int             irq;            /* our irq number */
770
771         unsigned long   dma_base;       /* base addr for dma ports */
772
773         unsigned long   config_data;    /* for use by chipset-specific code */
774         unsigned long   select_data;    /* for use by chipset-specific code */
775
776         unsigned long   extra_base;     /* extra addr for dma ports */
777         unsigned        extra_ports;    /* number of extra dma ports */
778
779         unsigned        present    : 1; /* this interface exists */
780         unsigned        busy       : 1; /* serializes devices on a port */
781
782         struct device           gendev;
783         struct device           *portdev;
784
785         struct completion gendev_rel_comp; /* To deal with device release() */
786
787         void            *hwif_data;     /* extra hwif data */
788
789 #ifdef CONFIG_BLK_DEV_IDEACPI
790         struct ide_acpi_hwif_link *acpidata;
791 #endif
792
793         /* IRQ handler, if active */
794         ide_startstop_t (*handler)(ide_drive_t *);
795
796         /* BOOL: polling active & poll_timeout field valid */
797         unsigned int polling : 1;
798
799         /* current drive */
800         ide_drive_t *cur_dev;
801
802         /* current request */
803         struct request *rq;
804
805         /* failsafe timer */
806         struct timer_list timer;
807         /* timeout value during long polls */
808         unsigned long poll_timeout;
809         /* queried upon timeouts */
810         int (*expiry)(ide_drive_t *);
811
812         int req_gen;
813         int req_gen_timer;
814
815         spinlock_t lock;
816 } ____cacheline_internodealigned_in_smp ide_hwif_t;
817
818 #define MAX_HOST_PORTS 4
819
820 struct ide_host {
821         ide_hwif_t      *ports[MAX_HOST_PORTS + 1];
822         unsigned int    n_ports;
823         struct device   *dev[2];
824
825         int             (*init_chipset)(struct pci_dev *);
826
827         void            (*get_lock)(irq_handler_t, void *);
828         void            (*release_lock)(void);
829
830         irq_handler_t   irq_handler;
831
832         unsigned long   host_flags;
833
834         int             irq_flags;
835
836         void            *host_priv;
837         ide_hwif_t      *cur_port;      /* for hosts requiring serialization */
838
839         /* used for hosts requiring serialization */
840         volatile unsigned long  host_busy;
841 };
842
843 #define IDE_HOST_BUSY 0
844
845 /*
846  *  internal ide interrupt handler type
847  */
848 typedef ide_startstop_t (ide_handler_t)(ide_drive_t *);
849 typedef int (ide_expiry_t)(ide_drive_t *);
850
851 /* used by ide-cd, ide-floppy, etc. */
852 typedef void (xfer_func_t)(ide_drive_t *, struct ide_cmd *, void *, unsigned);
853
854 extern struct mutex ide_setting_mtx;
855
856 /*
857  * configurable drive settings
858  */
859
860 #define DS_SYNC (1 << 0)
861
862 struct ide_devset {
863         int             (*get)(ide_drive_t *);
864         int             (*set)(ide_drive_t *, int);
865         unsigned int    flags;
866 };
867
868 #define __DEVSET(_flags, _get, _set) { \
869         .flags  = _flags, \
870         .get    = _get, \
871         .set    = _set, \
872 }
873
874 #define ide_devset_get(name, field) \
875 static int get_##name(ide_drive_t *drive) \
876 { \
877         return drive->field; \
878 }
879
880 #define ide_devset_set(name, field) \
881 static int set_##name(ide_drive_t *drive, int arg) \
882 { \
883         drive->field = arg; \
884         return 0; \
885 }
886
887 #define ide_devset_get_flag(name, flag) \
888 static int get_##name(ide_drive_t *drive) \
889 { \
890         return !!(drive->dev_flags & flag); \
891 }
892
893 #define ide_devset_set_flag(name, flag) \
894 static int set_##name(ide_drive_t *drive, int arg) \
895 { \
896         if (arg) \
897                 drive->dev_flags |= flag; \
898         else \
899                 drive->dev_flags &= ~flag; \
900         return 0; \
901 }
902
903 #define __IDE_DEVSET(_name, _flags, _get, _set) \
904 const struct ide_devset ide_devset_##_name = \
905         __DEVSET(_flags, _get, _set)
906
907 #define IDE_DEVSET(_name, _flags, _get, _set) \
908 static __IDE_DEVSET(_name, _flags, _get, _set)
909
910 #define ide_devset_rw(_name, _func) \
911 IDE_DEVSET(_name, 0, get_##_func, set_##_func)
912
913 #define ide_devset_w(_name, _func) \
914 IDE_DEVSET(_name, 0, NULL, set_##_func)
915
916 #define ide_ext_devset_rw(_name, _func) \
917 __IDE_DEVSET(_name, 0, get_##_func, set_##_func)
918
919 #define ide_ext_devset_rw_sync(_name, _func) \
920 __IDE_DEVSET(_name, DS_SYNC, get_##_func, set_##_func)
921
922 #define ide_decl_devset(_name) \
923 extern const struct ide_devset ide_devset_##_name
924
925 ide_decl_devset(io_32bit);
926 ide_decl_devset(keepsettings);
927 ide_decl_devset(pio_mode);
928 ide_decl_devset(unmaskirq);
929 ide_decl_devset(using_dma);
930
931 #ifdef CONFIG_IDE_PROC_FS
932 /*
933  * /proc/ide interface
934  */
935
936 #define ide_devset_rw_field(_name, _field) \
937 ide_devset_get(_name, _field); \
938 ide_devset_set(_name, _field); \
939 IDE_DEVSET(_name, DS_SYNC, get_##_name, set_##_name)
940
941 #define ide_devset_rw_flag(_name, _field) \
942 ide_devset_get_flag(_name, _field); \
943 ide_devset_set_flag(_name, _field); \
944 IDE_DEVSET(_name, DS_SYNC, get_##_name, set_##_name)
945
946 struct ide_proc_devset {
947         const char              *name;
948         const struct ide_devset *setting;
949         int                     min, max;
950         int                     (*mulf)(ide_drive_t *);
951         int                     (*divf)(ide_drive_t *);
952 };
953
954 #define __IDE_PROC_DEVSET(_name, _min, _max, _mulf, _divf) { \
955         .name = __stringify(_name), \
956         .setting = &ide_devset_##_name, \
957         .min = _min, \
958         .max = _max, \
959         .mulf = _mulf, \
960         .divf = _divf, \
961 }
962
963 #define IDE_PROC_DEVSET(_name, _min, _max) \
964 __IDE_PROC_DEVSET(_name, _min, _max, NULL, NULL)
965
966 typedef struct {
967         const char      *name;
968         mode_t          mode;
969         read_proc_t     *read_proc;
970         write_proc_t    *write_proc;
971 } ide_proc_entry_t;
972
973 void proc_ide_create(void);
974 void proc_ide_destroy(void);
975 void ide_proc_register_port(ide_hwif_t *);
976 void ide_proc_port_register_devices(ide_hwif_t *);
977 void ide_proc_unregister_device(ide_drive_t *);
978 void ide_proc_unregister_port(ide_hwif_t *);
979 void ide_proc_register_driver(ide_drive_t *, struct ide_driver *);
980 void ide_proc_unregister_driver(ide_drive_t *, struct ide_driver *);
981
982 read_proc_t proc_ide_read_capacity;
983 read_proc_t proc_ide_read_geometry;
984
985 /*
986  * Standard exit stuff:
987  */
988 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) \
989 {                                       \
990         len -= off;                     \
991         if (len < count) {              \
992                 *eof = 1;               \
993                 if (len <= 0)           \
994                         return 0;       \
995         } else                          \
996                 len = count;            \
997         *start = page + off;            \
998         return len;                     \
999 }
1000 #else
1001 static inline void proc_ide_create(void) { ; }
1002 static inline void proc_ide_destroy(void) { ; }
1003 static inline void ide_proc_register_port(ide_hwif_t *hwif) { ; }
1004 static inline void ide_proc_port_register_devices(ide_hwif_t *hwif) { ; }
1005 static inline void ide_proc_unregister_device(ide_drive_t *drive) { ; }
1006 static inline void ide_proc_unregister_port(ide_hwif_t *hwif) { ; }
1007 static inline void ide_proc_register_driver(ide_drive_t *drive,
1008                                             struct ide_driver *driver) { ; }
1009 static inline void ide_proc_unregister_driver(ide_drive_t *drive,
1010                                               struct ide_driver *driver) { ; }
1011 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) return 0;
1012 #endif
1013
1014 enum {
1015         /* enter/exit functions */
1016         IDE_DBG_FUNC =                  (1 << 0),
1017         /* sense key/asc handling */
1018         IDE_DBG_SENSE =                 (1 << 1),
1019         /* packet commands handling */
1020         IDE_DBG_PC =                    (1 << 2),
1021         /* request handling */
1022         IDE_DBG_RQ =                    (1 << 3),
1023         /* driver probing/setup */
1024         IDE_DBG_PROBE =                 (1 << 4),
1025 };
1026
1027 /* DRV_NAME has to be defined in the driver before using the macro below */
1028 #define __ide_debug_log(lvl, fmt, args...)                              \
1029 {                                                                       \
1030         if (unlikely(drive->debug_mask & lvl))                          \
1031                 printk(KERN_INFO DRV_NAME ": %s: " fmt "\n",            \
1032                                           __func__, ## args);           \
1033 }
1034
1035 /*
1036  * Power Management state machine (rq->pm->pm_step).
1037  *
1038  * For each step, the core calls ide_start_power_step() first.
1039  * This can return:
1040  *      - ide_stopped : In this case, the core calls us back again unless
1041  *                      step have been set to ide_power_state_completed.
1042  *      - ide_started : In this case, the channel is left busy until an
1043  *                      async event (interrupt) occurs.
1044  * Typically, ide_start_power_step() will issue a taskfile request with
1045  * do_rw_taskfile().
1046  *
1047  * Upon reception of the interrupt, the core will call ide_complete_power_step()
1048  * with the error code if any. This routine should update the step value
1049  * and return. It should not start a new request. The core will call
1050  * ide_start_power_step() for the new step value, unless step have been
1051  * set to IDE_PM_COMPLETED.
1052  */
1053 enum {
1054         IDE_PM_START_SUSPEND,
1055         IDE_PM_FLUSH_CACHE      = IDE_PM_START_SUSPEND,
1056         IDE_PM_STANDBY,
1057
1058         IDE_PM_START_RESUME,
1059         IDE_PM_RESTORE_PIO      = IDE_PM_START_RESUME,
1060         IDE_PM_IDLE,
1061         IDE_PM_RESTORE_DMA,
1062
1063         IDE_PM_COMPLETED,
1064 };
1065
1066 int generic_ide_suspend(struct device *, pm_message_t);
1067 int generic_ide_resume(struct device *);
1068
1069 void ide_complete_power_step(ide_drive_t *, struct request *);
1070 ide_startstop_t ide_start_power_step(ide_drive_t *, struct request *);
1071 void ide_complete_pm_rq(ide_drive_t *, struct request *);
1072 void ide_check_pm_state(ide_drive_t *, struct request *);
1073
1074 /*
1075  * Subdrivers support.
1076  *
1077  * The gendriver.owner field should be set to the module owner of this driver.
1078  * The gendriver.name field should be set to the name of this driver
1079  */
1080 struct ide_driver {
1081         const char                      *version;
1082         ide_startstop_t (*do_request)(ide_drive_t *, struct request *, sector_t);
1083         struct device_driver    gen_driver;
1084         int             (*probe)(ide_drive_t *);
1085         void            (*remove)(ide_drive_t *);
1086         void            (*resume)(ide_drive_t *);
1087         void            (*shutdown)(ide_drive_t *);
1088 #ifdef CONFIG_IDE_PROC_FS
1089         ide_proc_entry_t *              (*proc_entries)(ide_drive_t *);
1090         const struct ide_proc_devset *  (*proc_devsets)(ide_drive_t *);
1091 #endif
1092 };
1093
1094 #define to_ide_driver(drv) container_of(drv, struct ide_driver, gen_driver)
1095
1096 int ide_device_get(ide_drive_t *);
1097 void ide_device_put(ide_drive_t *);
1098
1099 struct ide_ioctl_devset {
1100         unsigned int    get_ioctl;
1101         unsigned int    set_ioctl;
1102         const struct ide_devset *setting;
1103 };
1104
1105 int ide_setting_ioctl(ide_drive_t *, struct block_device *, unsigned int,
1106                       unsigned long, const struct ide_ioctl_devset *);
1107
1108 int generic_ide_ioctl(ide_drive_t *, struct block_device *, unsigned, unsigned long);
1109
1110 extern int ide_vlb_clk;
1111 extern int ide_pci_clk;
1112
1113 unsigned int ide_rq_bytes(struct request *);
1114 int ide_end_rq(ide_drive_t *, struct request *, int, unsigned int);
1115 void ide_kill_rq(ide_drive_t *, struct request *);
1116
1117 void __ide_set_handler(ide_drive_t *, ide_handler_t *, unsigned int);
1118 void ide_set_handler(ide_drive_t *, ide_handler_t *, unsigned int);
1119
1120 void ide_execute_command(ide_drive_t *, struct ide_cmd *, ide_handler_t *,
1121                          unsigned int);
1122
1123 void ide_pad_transfer(ide_drive_t *, int, int);
1124
1125 ide_startstop_t ide_error(ide_drive_t *, const char *, u8);
1126
1127 void ide_fix_driveid(u16 *);
1128
1129 extern void ide_fixstring(u8 *, const int, const int);
1130
1131 int ide_busy_sleep(ide_hwif_t *, unsigned long, int);
1132
1133 int ide_wait_stat(ide_startstop_t *, ide_drive_t *, u8, u8, unsigned long);
1134
1135 ide_startstop_t ide_do_park_unpark(ide_drive_t *, struct request *);
1136 ide_startstop_t ide_do_devset(ide_drive_t *, struct request *);
1137
1138 extern ide_startstop_t ide_do_reset (ide_drive_t *);
1139
1140 extern int ide_devset_execute(ide_drive_t *drive,
1141                               const struct ide_devset *setting, int arg);
1142
1143 void ide_complete_cmd(ide_drive_t *, struct ide_cmd *, u8, u8);
1144 int ide_complete_rq(ide_drive_t *, int, unsigned int);
1145
1146 void ide_tf_dump(const char *, struct ide_taskfile *);
1147
1148 void ide_exec_command(ide_hwif_t *, u8);
1149 u8 ide_read_status(ide_hwif_t *);
1150 u8 ide_read_altstatus(ide_hwif_t *);
1151 void ide_write_devctl(ide_hwif_t *, u8);
1152
1153 void ide_dev_select(ide_drive_t *);
1154 void ide_tf_load(ide_drive_t *, struct ide_cmd *);
1155 void ide_tf_read(ide_drive_t *, struct ide_cmd *);
1156
1157 void ide_input_data(ide_drive_t *, struct ide_cmd *, void *, unsigned int);
1158 void ide_output_data(ide_drive_t *, struct ide_cmd *, void *, unsigned int);
1159
1160 void SELECT_MASK(ide_drive_t *, int);
1161
1162 u8 ide_read_error(ide_drive_t *);
1163 void ide_read_bcount_and_ireason(ide_drive_t *, u16 *, u8 *);
1164
1165 int ide_check_atapi_device(ide_drive_t *, const char *);
1166
1167 void ide_init_pc(struct ide_atapi_pc *);
1168
1169 /* Disk head parking */
1170 extern wait_queue_head_t ide_park_wq;
1171 ssize_t ide_park_show(struct device *dev, struct device_attribute *attr,
1172                       char *buf);
1173 ssize_t ide_park_store(struct device *dev, struct device_attribute *attr,
1174                        const char *buf, size_t len);
1175
1176 /*
1177  * Special requests for ide-tape block device strategy routine.
1178  *
1179  * In order to service a character device command, we add special requests to
1180  * the tail of our block device request queue and wait for their completion.
1181  */
1182 enum {
1183         REQ_IDETAPE_PC1         = (1 << 0), /* packet command (first stage) */
1184         REQ_IDETAPE_PC2         = (1 << 1), /* packet command (second stage) */
1185         REQ_IDETAPE_READ        = (1 << 2),
1186         REQ_IDETAPE_WRITE       = (1 << 3),
1187 };
1188
1189 int ide_queue_pc_tail(ide_drive_t *, struct gendisk *, struct ide_atapi_pc *);
1190
1191 int ide_do_test_unit_ready(ide_drive_t *, struct gendisk *);
1192 int ide_do_start_stop(ide_drive_t *, struct gendisk *, int);
1193 int ide_set_media_lock(ide_drive_t *, struct gendisk *, int);
1194 void ide_create_request_sense_cmd(ide_drive_t *, struct ide_atapi_pc *);
1195 void ide_retry_pc(ide_drive_t *, struct gendisk *);
1196
1197 int ide_cd_expiry(ide_drive_t *);
1198
1199 int ide_cd_get_xferlen(struct request *);
1200
1201 ide_startstop_t ide_issue_pc(ide_drive_t *, struct ide_cmd *);
1202
1203 ide_startstop_t do_rw_taskfile(ide_drive_t *, struct ide_cmd *);
1204
1205 void ide_pio_bytes(ide_drive_t *, struct ide_cmd *, unsigned int, unsigned int);
1206
1207 void ide_finish_cmd(ide_drive_t *, struct ide_cmd *, u8);
1208
1209 int ide_raw_taskfile(ide_drive_t *, struct ide_cmd *, u8 *, u16);
1210 int ide_no_data_taskfile(ide_drive_t *, struct ide_cmd *);
1211
1212 int ide_taskfile_ioctl(ide_drive_t *, unsigned long);
1213
1214 int ide_dev_read_id(ide_drive_t *, u8, u16 *);
1215
1216 extern int ide_driveid_update(ide_drive_t *);
1217 extern int ide_config_drive_speed(ide_drive_t *, u8);
1218 extern u8 eighty_ninty_three (ide_drive_t *);
1219 extern int taskfile_lib_get_identify(ide_drive_t *drive, u8 *);
1220
1221 extern int ide_wait_not_busy(ide_hwif_t *hwif, unsigned long timeout);
1222
1223 extern void ide_stall_queue(ide_drive_t *drive, unsigned long timeout);
1224
1225 extern void ide_timer_expiry(unsigned long);
1226 extern irqreturn_t ide_intr(int irq, void *dev_id);
1227 extern void do_ide_request(struct request_queue *);
1228
1229 void ide_init_disk(struct gendisk *, ide_drive_t *);
1230
1231 #ifdef CONFIG_IDEPCI_PCIBUS_ORDER
1232 extern int __ide_pci_register_driver(struct pci_driver *driver, struct module *owner, const char *mod_name);
1233 #define ide_pci_register_driver(d) __ide_pci_register_driver(d, THIS_MODULE, KBUILD_MODNAME)
1234 #else
1235 #define ide_pci_register_driver(d) pci_register_driver(d)
1236 #endif
1237
1238 static inline int ide_pci_is_in_compatibility_mode(struct pci_dev *dev)
1239 {
1240         if ((dev->class >> 8) == PCI_CLASS_STORAGE_IDE && (dev->class & 5) != 5)
1241                 return 1;
1242         return 0;
1243 }
1244
1245 void ide_pci_setup_ports(struct pci_dev *, const struct ide_port_info *,
1246                          hw_regs_t *, hw_regs_t **);
1247 void ide_setup_pci_noise(struct pci_dev *, const struct ide_port_info *);
1248
1249 #ifdef CONFIG_BLK_DEV_IDEDMA_PCI
1250 int ide_pci_set_master(struct pci_dev *, const char *);
1251 unsigned long ide_pci_dma_base(ide_hwif_t *, const struct ide_port_info *);
1252 int ide_pci_check_simplex(ide_hwif_t *, const struct ide_port_info *);
1253 int ide_hwif_setup_dma(ide_hwif_t *, const struct ide_port_info *);
1254 #else
1255 static inline int ide_hwif_setup_dma(ide_hwif_t *hwif,
1256                                      const struct ide_port_info *d)
1257 {
1258         return -EINVAL;
1259 }
1260 #endif
1261
1262 struct ide_pci_enablebit {
1263         u8      reg;    /* byte pci reg holding the enable-bit */
1264         u8      mask;   /* mask to isolate the enable-bit */
1265         u8      val;    /* value of masked reg when "enabled" */
1266 };
1267
1268 enum {
1269         /* Uses ISA control ports not PCI ones. */
1270         IDE_HFLAG_ISA_PORTS             = (1 << 0),
1271         /* single port device */
1272         IDE_HFLAG_SINGLE                = (1 << 1),
1273         /* don't use legacy PIO blacklist */
1274         IDE_HFLAG_PIO_NO_BLACKLIST      = (1 << 2),
1275         /* set for the second port of QD65xx */
1276         IDE_HFLAG_QD_2ND_PORT           = (1 << 3),
1277         /* use PIO8/9 for prefetch off/on */
1278         IDE_HFLAG_ABUSE_PREFETCH        = (1 << 4),
1279         /* use PIO6/7 for fast-devsel off/on */
1280         IDE_HFLAG_ABUSE_FAST_DEVSEL     = (1 << 5),
1281         /* use 100-102 and 200-202 PIO values to set DMA modes */
1282         IDE_HFLAG_ABUSE_DMA_MODES       = (1 << 6),
1283         /*
1284          * keep DMA setting when programming PIO mode, may be used only
1285          * for hosts which have separate PIO and DMA timings (ie. PMAC)
1286          */
1287         IDE_HFLAG_SET_PIO_MODE_KEEP_DMA = (1 << 7),
1288         /* program host for the transfer mode after programming device */
1289         IDE_HFLAG_POST_SET_MODE         = (1 << 8),
1290         /* don't program host/device for the transfer mode ("smart" hosts) */
1291         IDE_HFLAG_NO_SET_MODE           = (1 << 9),
1292         /* trust BIOS for programming chipset/device for DMA */
1293         IDE_HFLAG_TRUST_BIOS_FOR_DMA    = (1 << 10),
1294         /* host is CS5510/CS5520 */
1295         IDE_HFLAG_CS5520                = (1 << 11),
1296         /* ATAPI DMA is unsupported */
1297         IDE_HFLAG_NO_ATAPI_DMA          = (1 << 12),
1298         /* set if host is a "non-bootable" controller */
1299         IDE_HFLAG_NON_BOOTABLE          = (1 << 13),
1300         /* host doesn't support DMA */
1301         IDE_HFLAG_NO_DMA                = (1 << 14),
1302         /* check if host is PCI IDE device before allowing DMA */
1303         IDE_HFLAG_NO_AUTODMA            = (1 << 15),
1304         /* host uses MMIO */
1305         IDE_HFLAG_MMIO                  = (1 << 16),
1306         /* no LBA48 */
1307         IDE_HFLAG_NO_LBA48              = (1 << 17),
1308         /* no LBA48 DMA */
1309         IDE_HFLAG_NO_LBA48_DMA          = (1 << 18),
1310         /* data FIFO is cleared by an error */
1311         IDE_HFLAG_ERROR_STOPS_FIFO      = (1 << 19),
1312         /* serialize ports */
1313         IDE_HFLAG_SERIALIZE             = (1 << 20),
1314         /* host is DTC2278 */
1315         IDE_HFLAG_DTC2278               = (1 << 21),
1316         /* 4 devices on a single set of I/O ports */
1317         IDE_HFLAG_4DRIVES               = (1 << 22),
1318         /* host is TRM290 */
1319         IDE_HFLAG_TRM290                = (1 << 23),
1320         /* use 32-bit I/O ops */
1321         IDE_HFLAG_IO_32BIT              = (1 << 24),
1322         /* unmask IRQs */
1323         IDE_HFLAG_UNMASK_IRQS           = (1 << 25),
1324         IDE_HFLAG_BROKEN_ALTSTATUS      = (1 << 26),
1325         /* serialize ports if DMA is possible (for sl82c105) */
1326         IDE_HFLAG_SERIALIZE_DMA         = (1 << 27),
1327         /* force host out of "simplex" mode */
1328         IDE_HFLAG_CLEAR_SIMPLEX         = (1 << 28),
1329         /* DSC overlap is unsupported */
1330         IDE_HFLAG_NO_DSC                = (1 << 29),
1331         /* never use 32-bit I/O ops */
1332         IDE_HFLAG_NO_IO_32BIT           = (1 << 30),
1333         /* never unmask IRQs */
1334         IDE_HFLAG_NO_UNMASK_IRQS        = (1 << 31),
1335 };
1336
1337 #ifdef CONFIG_BLK_DEV_OFFBOARD
1338 # define IDE_HFLAG_OFF_BOARD    0
1339 #else
1340 # define IDE_HFLAG_OFF_BOARD    IDE_HFLAG_NON_BOOTABLE
1341 #endif
1342
1343 struct ide_port_info {
1344         char                    *name;
1345
1346         int                     (*init_chipset)(struct pci_dev *);
1347
1348         void                    (*get_lock)(irq_handler_t, void *);
1349         void                    (*release_lock)(void);
1350
1351         void                    (*init_iops)(ide_hwif_t *);
1352         void                    (*init_hwif)(ide_hwif_t *);
1353         int                     (*init_dma)(ide_hwif_t *,
1354                                             const struct ide_port_info *);
1355
1356         const struct ide_tp_ops         *tp_ops;
1357         const struct ide_port_ops       *port_ops;
1358         const struct ide_dma_ops        *dma_ops;
1359
1360         struct ide_pci_enablebit        enablebits[2];
1361
1362         hwif_chipset_t          chipset;
1363
1364         u16                     max_sectors;    /* if < than the default one */
1365
1366         u32                     host_flags;
1367
1368         int                     irq_flags;
1369
1370         u8                      pio_mask;
1371         u8                      swdma_mask;
1372         u8                      mwdma_mask;
1373         u8                      udma_mask;
1374 };
1375
1376 int ide_pci_init_one(struct pci_dev *, const struct ide_port_info *, void *);
1377 int ide_pci_init_two(struct pci_dev *, struct pci_dev *,
1378                      const struct ide_port_info *, void *);
1379 void ide_pci_remove(struct pci_dev *);
1380
1381 #ifdef CONFIG_PM
1382 int ide_pci_suspend(struct pci_dev *, pm_message_t);
1383 int ide_pci_resume(struct pci_dev *);
1384 #else
1385 #define ide_pci_suspend NULL
1386 #define ide_pci_resume NULL
1387 #endif
1388
1389 void ide_map_sg(ide_drive_t *, struct ide_cmd *);
1390 void ide_init_sg_cmd(struct ide_cmd *, unsigned int);
1391
1392 #define BAD_DMA_DRIVE           0
1393 #define GOOD_DMA_DRIVE          1
1394
1395 struct drive_list_entry {
1396         const char *id_model;
1397         const char *id_firmware;
1398 };
1399
1400 int ide_in_drive_list(u16 *, const struct drive_list_entry *);
1401
1402 #ifdef CONFIG_BLK_DEV_IDEDMA
1403 int ide_dma_good_drive(ide_drive_t *);
1404 int __ide_dma_bad_drive(ide_drive_t *);
1405 int ide_id_dma_bug(ide_drive_t *);
1406
1407 u8 ide_find_dma_mode(ide_drive_t *, u8);
1408
1409 static inline u8 ide_max_dma_mode(ide_drive_t *drive)
1410 {
1411         return ide_find_dma_mode(drive, XFER_UDMA_6);
1412 }
1413
1414 void ide_dma_off_quietly(ide_drive_t *);
1415 void ide_dma_off(ide_drive_t *);
1416 void ide_dma_on(ide_drive_t *);
1417 int ide_set_dma(ide_drive_t *);
1418 void ide_check_dma_crc(ide_drive_t *);
1419 ide_startstop_t ide_dma_intr(ide_drive_t *);
1420
1421 int ide_allocate_dma_engine(ide_hwif_t *);
1422 void ide_release_dma_engine(ide_hwif_t *);
1423
1424 int ide_dma_prepare(ide_drive_t *, struct ide_cmd *);
1425 void ide_dma_unmap_sg(ide_drive_t *, struct ide_cmd *);
1426
1427 #ifdef CONFIG_BLK_DEV_IDEDMA_SFF
1428 int config_drive_for_dma(ide_drive_t *);
1429 int ide_build_dmatable(ide_drive_t *, struct ide_cmd *);
1430 void ide_dma_host_set(ide_drive_t *, int);
1431 int ide_dma_setup(ide_drive_t *, struct ide_cmd *);
1432 extern void ide_dma_start(ide_drive_t *);
1433 int ide_dma_end(ide_drive_t *);
1434 int ide_dma_test_irq(ide_drive_t *);
1435 int ide_dma_sff_timer_expiry(ide_drive_t *);
1436 u8 ide_dma_sff_read_status(ide_hwif_t *);
1437 extern const struct ide_dma_ops sff_dma_ops;
1438 #else
1439 static inline int config_drive_for_dma(ide_drive_t *drive) { return 0; }
1440 #endif /* CONFIG_BLK_DEV_IDEDMA_SFF */
1441
1442 void ide_dma_lost_irq(ide_drive_t *);
1443 ide_startstop_t ide_dma_timeout_retry(ide_drive_t *, int);
1444
1445 #else
1446 static inline int ide_id_dma_bug(ide_drive_t *drive) { return 0; }
1447 static inline u8 ide_find_dma_mode(ide_drive_t *drive, u8 speed) { return 0; }
1448 static inline u8 ide_max_dma_mode(ide_drive_t *drive) { return 0; }
1449 static inline void ide_dma_off_quietly(ide_drive_t *drive) { ; }
1450 static inline void ide_dma_off(ide_drive_t *drive) { ; }
1451 static inline void ide_dma_on(ide_drive_t *drive) { ; }
1452 static inline void ide_dma_verbose(ide_drive_t *drive) { ; }
1453 static inline int ide_set_dma(ide_drive_t *drive) { return 1; }
1454 static inline void ide_check_dma_crc(ide_drive_t *drive) { ; }
1455 static inline ide_startstop_t ide_dma_intr(ide_drive_t *drive) { return ide_stopped; }
1456 static inline ide_startstop_t ide_dma_timeout_retry(ide_drive_t *drive, int error) { return ide_stopped; }
1457 static inline void ide_release_dma_engine(ide_hwif_t *hwif) { ; }
1458 static inline int ide_dma_prepare(ide_drive_t *drive,
1459                                   struct ide_cmd *cmd) { return 1; }
1460 static inline void ide_dma_unmap_sg(ide_drive_t *drive,
1461                                     struct ide_cmd *cmd) { ; }
1462 #endif /* CONFIG_BLK_DEV_IDEDMA */
1463
1464 #ifdef CONFIG_BLK_DEV_IDEACPI
1465 int ide_acpi_init(void);
1466 extern int ide_acpi_exec_tfs(ide_drive_t *drive);
1467 extern void ide_acpi_get_timing(ide_hwif_t *hwif);
1468 extern void ide_acpi_push_timing(ide_hwif_t *hwif);
1469 void ide_acpi_init_port(ide_hwif_t *);
1470 void ide_acpi_port_init_devices(ide_hwif_t *);
1471 extern void ide_acpi_set_state(ide_hwif_t *hwif, int on);
1472 #else
1473 static inline int ide_acpi_init(void) { return 0; }
1474 static inline int ide_acpi_exec_tfs(ide_drive_t *drive) { return 0; }
1475 static inline void ide_acpi_get_timing(ide_hwif_t *hwif) { ; }
1476 static inline void ide_acpi_push_timing(ide_hwif_t *hwif) { ; }
1477 static inline void ide_acpi_init_port(ide_hwif_t *hwif) { ; }
1478 static inline void ide_acpi_port_init_devices(ide_hwif_t *hwif) { ; }
1479 static inline void ide_acpi_set_state(ide_hwif_t *hwif, int on) {}
1480 #endif
1481
1482 void ide_register_region(struct gendisk *);
1483 void ide_unregister_region(struct gendisk *);
1484
1485 void ide_undecoded_slave(ide_drive_t *);
1486
1487 void ide_port_apply_params(ide_hwif_t *);
1488 int ide_sysfs_register_port(ide_hwif_t *);
1489
1490 struct ide_host *ide_host_alloc(const struct ide_port_info *, hw_regs_t **);
1491 void ide_host_free(struct ide_host *);
1492 int ide_host_register(struct ide_host *, const struct ide_port_info *,
1493                       hw_regs_t **);
1494 int ide_host_add(const struct ide_port_info *, hw_regs_t **,
1495                  struct ide_host **);
1496 void ide_host_remove(struct ide_host *);
1497 int ide_legacy_device_add(const struct ide_port_info *, unsigned long);
1498 void ide_port_unregister_devices(ide_hwif_t *);
1499 void ide_port_scan(ide_hwif_t *);
1500
1501 static inline void *ide_get_hwifdata (ide_hwif_t * hwif)
1502 {
1503         return hwif->hwif_data;
1504 }
1505
1506 static inline void ide_set_hwifdata (ide_hwif_t * hwif, void *data)
1507 {
1508         hwif->hwif_data = data;
1509 }
1510
1511 extern void ide_toggle_bounce(ide_drive_t *drive, int on);
1512
1513 u64 ide_get_lba_addr(struct ide_taskfile *, int);
1514 u8 ide_dump_status(ide_drive_t *, const char *, u8);
1515
1516 struct ide_timing {
1517         u8  mode;
1518         u8  setup;      /* t1 */
1519         u16 act8b;      /* t2 for 8-bit io */
1520         u16 rec8b;      /* t2i for 8-bit io */
1521         u16 cyc8b;      /* t0 for 8-bit io */
1522         u16 active;     /* t2 or tD */
1523         u16 recover;    /* t2i or tK */
1524         u16 cycle;      /* t0 */
1525         u16 udma;       /* t2CYCTYP/2 */
1526 };
1527
1528 enum {
1529         IDE_TIMING_SETUP        = (1 << 0),
1530         IDE_TIMING_ACT8B        = (1 << 1),
1531         IDE_TIMING_REC8B        = (1 << 2),
1532         IDE_TIMING_CYC8B        = (1 << 3),
1533         IDE_TIMING_8BIT         = IDE_TIMING_ACT8B | IDE_TIMING_REC8B |
1534                                   IDE_TIMING_CYC8B,
1535         IDE_TIMING_ACTIVE       = (1 << 4),
1536         IDE_TIMING_RECOVER      = (1 << 5),
1537         IDE_TIMING_CYCLE        = (1 << 6),
1538         IDE_TIMING_UDMA         = (1 << 7),
1539         IDE_TIMING_ALL          = IDE_TIMING_SETUP | IDE_TIMING_8BIT |
1540                                   IDE_TIMING_ACTIVE | IDE_TIMING_RECOVER |
1541                                   IDE_TIMING_CYCLE | IDE_TIMING_UDMA,
1542 };
1543
1544 struct ide_timing *ide_timing_find_mode(u8);
1545 u16 ide_pio_cycle_time(ide_drive_t *, u8);
1546 void ide_timing_merge(struct ide_timing *, struct ide_timing *,
1547                       struct ide_timing *, unsigned int);
1548 int ide_timing_compute(ide_drive_t *, u8, struct ide_timing *, int, int);
1549
1550 #ifdef CONFIG_IDE_XFER_MODE
1551 int ide_scan_pio_blacklist(char *);
1552 const char *ide_xfer_verbose(u8);
1553 u8 ide_get_best_pio_mode(ide_drive_t *, u8, u8);
1554 int ide_set_pio_mode(ide_drive_t *, u8);
1555 int ide_set_dma_mode(ide_drive_t *, u8);
1556 void ide_set_pio(ide_drive_t *, u8);
1557 int ide_set_xfer_rate(ide_drive_t *, u8);
1558 #else
1559 static inline void ide_set_pio(ide_drive_t *drive, u8 pio) { ; }
1560 static inline int ide_set_xfer_rate(ide_drive_t *drive, u8 rate) { return -1; }
1561 #endif
1562
1563 static inline void ide_set_max_pio(ide_drive_t *drive)
1564 {
1565         ide_set_pio(drive, 255);
1566 }
1567
1568 char *ide_media_string(ide_drive_t *);
1569
1570 extern struct device_attribute ide_dev_attrs[];
1571 extern struct bus_type ide_bus_type;
1572 extern struct class *ide_port_class;
1573
1574 static inline void ide_dump_identify(u8 *id)
1575 {
1576         print_hex_dump(KERN_INFO, "", DUMP_PREFIX_NONE, 16, 2, id, 512, 0);
1577 }
1578
1579 static inline int hwif_to_node(ide_hwif_t *hwif)
1580 {
1581         return hwif->dev ? dev_to_node(hwif->dev) : -1;
1582 }
1583
1584 static inline ide_drive_t *ide_get_pair_dev(ide_drive_t *drive)
1585 {
1586         ide_drive_t *peer = drive->hwif->devices[(drive->dn ^ 1) & 1];
1587
1588         return (peer->dev_flags & IDE_DFLAG_PRESENT) ? peer : NULL;
1589 }
1590
1591 #define ide_port_for_each_dev(i, dev, port) \
1592         for ((i) = 0; ((dev) = (port)->devices[i]) || (i) < MAX_DRIVES; (i)++)
1593
1594 #define ide_port_for_each_present_dev(i, dev, port) \
1595         for ((i) = 0; ((dev) = (port)->devices[i]) || (i) < MAX_DRIVES; (i)++) \
1596                 if ((dev)->dev_flags & IDE_DFLAG_PRESENT)
1597
1598 #define ide_host_for_each_port(i, port, host) \
1599         for ((i) = 0; ((port) = (host)->ports[i]) || (i) < MAX_HOST_PORTS; (i)++)
1600
1601 #endif /* _IDE_H */