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