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