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