ide: use ide_tf_load() in execute_drive_cmd()
[linux-2.6] / 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/hdreg.h>
12 #include <linux/hdsmart.h>
13 #include <linux/blkdev.h>
14 #include <linux/proc_fs.h>
15 #include <linux/interrupt.h>
16 #include <linux/bitops.h>
17 #include <linux/bio.h>
18 #include <linux/device.h>
19 #include <linux/pci.h>
20 #include <linux/completion.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/semaphore.h>
28 #include <asm/mutex.h>
29
30 #if defined(CRIS) || defined(FRV)
31 # define SUPPORT_VLB_SYNC 0
32 #else
33 # define SUPPORT_VLB_SYNC 1
34 #endif
35
36 /*
37  * Used to indicate "no IRQ", should be a value that cannot be an IRQ
38  * number.
39  */
40  
41 #define IDE_NO_IRQ              (-1)
42
43 typedef unsigned char   byte;   /* used everywhere */
44
45 /*
46  * Probably not wise to fiddle with these
47  */
48 #define ERROR_MAX       8       /* Max read/write errors per sector */
49 #define ERROR_RESET     3       /* Reset controller every 4th retry */
50 #define ERROR_RECAL     1       /* Recalibrate every 2nd retry */
51
52 /*
53  * Tune flags
54  */
55 #define IDE_TUNE_NOAUTO         2
56 #define IDE_TUNE_AUTO           1
57 #define IDE_TUNE_DEFAULT        0
58
59 /*
60  * state flags
61  */
62
63 #define DMA_PIO_RETRY   1       /* retrying in PIO */
64
65 #define HWIF(drive)             ((ide_hwif_t *)((drive)->hwif))
66 #define HWGROUP(drive)          ((ide_hwgroup_t *)(HWIF(drive)->hwgroup))
67
68 /*
69  * Definitions for accessing IDE controller registers
70  */
71 #define IDE_NR_PORTS            (10)
72
73 #define IDE_DATA_OFFSET         (0)
74 #define IDE_ERROR_OFFSET        (1)
75 #define IDE_NSECTOR_OFFSET      (2)
76 #define IDE_SECTOR_OFFSET       (3)
77 #define IDE_LCYL_OFFSET         (4)
78 #define IDE_HCYL_OFFSET         (5)
79 #define IDE_SELECT_OFFSET       (6)
80 #define IDE_STATUS_OFFSET       (7)
81 #define IDE_CONTROL_OFFSET      (8)
82 #define IDE_IRQ_OFFSET          (9)
83
84 #define IDE_FEATURE_OFFSET      IDE_ERROR_OFFSET
85 #define IDE_COMMAND_OFFSET      IDE_STATUS_OFFSET
86
87 #define IDE_DATA_REG            (HWIF(drive)->io_ports[IDE_DATA_OFFSET])
88 #define IDE_ERROR_REG           (HWIF(drive)->io_ports[IDE_ERROR_OFFSET])
89 #define IDE_NSECTOR_REG         (HWIF(drive)->io_ports[IDE_NSECTOR_OFFSET])
90 #define IDE_SECTOR_REG          (HWIF(drive)->io_ports[IDE_SECTOR_OFFSET])
91 #define IDE_LCYL_REG            (HWIF(drive)->io_ports[IDE_LCYL_OFFSET])
92 #define IDE_HCYL_REG            (HWIF(drive)->io_ports[IDE_HCYL_OFFSET])
93 #define IDE_SELECT_REG          (HWIF(drive)->io_ports[IDE_SELECT_OFFSET])
94 #define IDE_STATUS_REG          (HWIF(drive)->io_ports[IDE_STATUS_OFFSET])
95 #define IDE_CONTROL_REG         (HWIF(drive)->io_ports[IDE_CONTROL_OFFSET])
96 #define IDE_IRQ_REG             (HWIF(drive)->io_ports[IDE_IRQ_OFFSET])
97
98 #define IDE_FEATURE_REG         IDE_ERROR_REG
99 #define IDE_COMMAND_REG         IDE_STATUS_REG
100 #define IDE_ALTSTATUS_REG       IDE_CONTROL_REG
101 #define IDE_IREASON_REG         IDE_NSECTOR_REG
102 #define IDE_BCOUNTL_REG         IDE_LCYL_REG
103 #define IDE_BCOUNTH_REG         IDE_HCYL_REG
104
105 #define OK_STAT(stat,good,bad)  (((stat)&((good)|(bad)))==(good))
106 #define BAD_R_STAT              (BUSY_STAT   | ERR_STAT)
107 #define BAD_W_STAT              (BAD_R_STAT  | WRERR_STAT)
108 #define BAD_STAT                (BAD_R_STAT  | DRQ_STAT)
109 #define DRIVE_READY             (READY_STAT  | SEEK_STAT)
110 #define DATA_READY              (DRQ_STAT)
111
112 #define BAD_CRC                 (ABRT_ERR    | ICRC_ERR)
113
114 #define SATA_NR_PORTS           (3)     /* 16 possible ?? */
115
116 #define SATA_STATUS_OFFSET      (0)
117 #define SATA_STATUS_REG         (HWIF(drive)->sata_scr[SATA_STATUS_OFFSET])
118 #define SATA_ERROR_OFFSET       (1)
119 #define SATA_ERROR_REG          (HWIF(drive)->sata_scr[SATA_ERROR_OFFSET])
120 #define SATA_CONTROL_OFFSET     (2)
121 #define SATA_CONTROL_REG        (HWIF(drive)->sata_scr[SATA_CONTROL_OFFSET])
122
123 #define SATA_MISC_OFFSET        (0)
124 #define SATA_MISC_REG           (HWIF(drive)->sata_misc[SATA_MISC_OFFSET])
125 #define SATA_PHY_OFFSET         (1)
126 #define SATA_PHY_REG            (HWIF(drive)->sata_misc[SATA_PHY_OFFSET])
127 #define SATA_IEN_OFFSET         (2)
128 #define SATA_IEN_REG            (HWIF(drive)->sata_misc[SATA_IEN_OFFSET])
129
130 /*
131  * Our Physical Region Descriptor (PRD) table should be large enough
132  * to handle the biggest I/O request we are likely to see.  Since requests
133  * can have no more than 256 sectors, and since the typical blocksize is
134  * two or more sectors, we could get by with a limit of 128 entries here for
135  * the usual worst case.  Most requests seem to include some contiguous blocks,
136  * further reducing the number of table entries required.
137  *
138  * The driver reverts to PIO mode for individual requests that exceed
139  * this limit (possible with 512 byte blocksizes, eg. MSDOS f/s), so handling
140  * 100% of all crazy scenarios here is not necessary.
141  *
142  * As it turns out though, we must allocate a full 4KB page for this,
143  * so the two PRD tables (ide0 & ide1) will each get half of that,
144  * allowing each to have about 256 entries (8 bytes each) from this.
145  */
146 #define PRD_BYTES       8
147 #define PRD_ENTRIES     256
148
149 /*
150  * Some more useful definitions
151  */
152 #define PARTN_BITS      6       /* number of minor dev bits for partitions */
153 #define MAX_DRIVES      2       /* per interface; 2 assumed by lots of code */
154 #define SECTOR_SIZE     512
155 #define SECTOR_WORDS    (SECTOR_SIZE / 4)       /* number of 32bit words per sector */
156 #define IDE_LARGE_SEEK(b1,b2,t) (((b1) > (b2) + (t)) || ((b2) > (b1) + (t)))
157
158 /*
159  * Timeouts for various operations:
160  */
161 #define WAIT_DRQ        (HZ/10)         /* 100msec - spec allows up to 20ms */
162 #define WAIT_READY      (5*HZ)          /* 5sec - some laptops are very slow */
163 #define WAIT_PIDENTIFY  (10*HZ) /* 10sec  - should be less than 3ms (?), if all ATAPI CD is closed at boot */
164 #define WAIT_WORSTCASE  (30*HZ) /* 30sec  - worst case when spinning up */
165 #define WAIT_CMD        (10*HZ) /* 10sec  - maximum wait for an IRQ to happen */
166 #define WAIT_MIN_SLEEP  (2*HZ/100)      /* 20msec - minimum sleep time */
167
168 /*
169  * Check for an interrupt and acknowledge the interrupt status
170  */
171 struct hwif_s;
172 typedef int (ide_ack_intr_t)(struct hwif_s *);
173
174 /*
175  * hwif_chipset_t is used to keep track of the specific hardware
176  * chipset used by each IDE interface, if known.
177  */
178 enum {          ide_unknown,    ide_generic,    ide_pci,
179                 ide_cmd640,     ide_dtc2278,    ide_ali14xx,
180                 ide_qd65xx,     ide_umc8672,    ide_ht6560b,
181                 ide_rz1000,     ide_trm290,
182                 ide_cmd646,     ide_cy82c693,   ide_4drives,
183                 ide_pmac,       ide_etrax100,   ide_acorn,
184                 ide_au1xxx, ide_forced
185 };
186
187 typedef u8 hwif_chipset_t;
188
189 /*
190  * Structure to hold all information about the location of this port
191  */
192 typedef struct hw_regs_s {
193         unsigned long   io_ports[IDE_NR_PORTS]; /* task file registers */
194         int             irq;                    /* our irq number */
195         ide_ack_intr_t  *ack_intr;              /* acknowledge interrupt */
196         hwif_chipset_t  chipset;
197         struct device   *dev;
198 } hw_regs_t;
199
200 struct hwif_s * ide_find_port(unsigned long);
201
202 int ide_register_hw(hw_regs_t *, void (*)(struct hwif_s *), int,
203                     struct hwif_s **);
204
205 void ide_setup_ports(   hw_regs_t *hw,
206                         unsigned long base,
207                         int *offsets,
208                         unsigned long ctrl,
209                         unsigned long intr,
210                         ide_ack_intr_t *ack_intr,
211 #if 0
212                         ide_io_ops_t *iops,
213 #endif
214                         int irq);
215
216 static inline void ide_std_init_ports(hw_regs_t *hw,
217                                       unsigned long io_addr,
218                                       unsigned long ctl_addr)
219 {
220         unsigned int i;
221
222         for (i = IDE_DATA_OFFSET; i <= IDE_STATUS_OFFSET; i++)
223                 hw->io_ports[i] = io_addr++;
224
225         hw->io_ports[IDE_CONTROL_OFFSET] = ctl_addr;
226 }
227
228 #include <asm/ide.h>
229
230 #if !defined(MAX_HWIFS) || defined(CONFIG_EMBEDDED)
231 #undef MAX_HWIFS
232 #define MAX_HWIFS       CONFIG_IDE_MAX_HWIFS
233 #endif
234
235 /* needed on alpha, x86/x86_64, ia64, mips, ppc32 and sh */
236 #ifndef IDE_ARCH_OBSOLETE_DEFAULTS
237 # define ide_default_io_base(index)     (0)
238 # define ide_default_irq(base)          (0)
239 # define ide_init_default_irq(base)     (0)
240 #endif
241
242 #ifdef CONFIG_IDE_ARCH_OBSOLETE_INIT
243 static inline void ide_init_hwif_ports(hw_regs_t *hw,
244                                        unsigned long io_addr,
245                                        unsigned long ctl_addr,
246                                        int *irq)
247 {
248         if (!ctl_addr)
249                 ide_std_init_ports(hw, io_addr, ide_default_io_ctl(io_addr));
250         else
251                 ide_std_init_ports(hw, io_addr, ctl_addr);
252
253         if (irq)
254                 *irq = 0;
255
256         hw->io_ports[IDE_IRQ_OFFSET] = 0;
257
258 #ifdef CONFIG_PPC32
259         if (ppc_ide_md.ide_init_hwif)
260                 ppc_ide_md.ide_init_hwif(hw, io_addr, ctl_addr, irq);
261 #endif
262 }
263 #else
264 static inline void ide_init_hwif_ports(hw_regs_t *hw,
265                                        unsigned long io_addr,
266                                        unsigned long ctl_addr,
267                                        int *irq)
268 {
269         if (io_addr || ctl_addr)
270                 printk(KERN_WARNING "%s: must not be called\n", __FUNCTION__);
271 }
272 #endif /* CONFIG_IDE_ARCH_OBSOLETE_INIT */
273
274 /* Currently only m68k, apus and m8xx need it */
275 #ifndef IDE_ARCH_ACK_INTR
276 # define ide_ack_intr(hwif) (1)
277 #endif
278
279 /* Currently only Atari needs it */
280 #ifndef IDE_ARCH_LOCK
281 # define ide_release_lock()                     do {} while (0)
282 # define ide_get_lock(hdlr, data)               do {} while (0)
283 #endif /* IDE_ARCH_LOCK */
284
285 /*
286  * Now for the data we need to maintain per-drive:  ide_drive_t
287  */
288
289 #define ide_scsi        0x21
290 #define ide_disk        0x20
291 #define ide_optical     0x7
292 #define ide_cdrom       0x5
293 #define ide_tape        0x1
294 #define ide_floppy      0x0
295
296 /*
297  * Special Driver Flags
298  *
299  * set_geometry : respecify drive geometry
300  * recalibrate  : seek to cyl 0
301  * set_multmode : set multmode count
302  * set_tune     : tune interface for drive
303  * serviced     : service command
304  * reserved     : unused
305  */
306 typedef union {
307         unsigned all                    : 8;
308         struct {
309 #if defined(__LITTLE_ENDIAN_BITFIELD)
310                 unsigned set_geometry   : 1;
311                 unsigned recalibrate    : 1;
312                 unsigned set_multmode   : 1;
313                 unsigned set_tune       : 1;
314                 unsigned serviced       : 1;
315                 unsigned reserved       : 3;
316 #elif defined(__BIG_ENDIAN_BITFIELD)
317                 unsigned reserved       : 3;
318                 unsigned serviced       : 1;
319                 unsigned set_tune       : 1;
320                 unsigned set_multmode   : 1;
321                 unsigned recalibrate    : 1;
322                 unsigned set_geometry   : 1;
323 #else
324 #error "Please fix <asm/byteorder.h>"
325 #endif
326         } b;
327 } special_t;
328
329 /*
330  * ATA DATA Register Special.
331  * ATA NSECTOR Count Register().
332  * ATAPI Byte Count Register.
333  */
334 typedef union {
335         unsigned all                    :16;
336         struct {
337 #if defined(__LITTLE_ENDIAN_BITFIELD)
338                 unsigned low            :8;     /* LSB */
339                 unsigned high           :8;     /* MSB */
340 #elif defined(__BIG_ENDIAN_BITFIELD)
341                 unsigned high           :8;     /* MSB */
342                 unsigned low            :8;     /* LSB */
343 #else
344 #error "Please fix <asm/byteorder.h>"
345 #endif
346         } b;
347 } ata_nsector_t, ata_data_t, atapi_bcount_t;
348
349 /*
350  * ATA-IDE Select Register, aka Device-Head
351  *
352  * head         : always zeros here
353  * unit         : drive select number: 0/1
354  * bit5         : always 1
355  * lba          : using LBA instead of CHS
356  * bit7         : always 1
357  */
358 typedef union {
359         unsigned all                    : 8;
360         struct {
361 #if defined(__LITTLE_ENDIAN_BITFIELD)
362                 unsigned head           : 4;
363                 unsigned unit           : 1;
364                 unsigned bit5           : 1;
365                 unsigned lba            : 1;
366                 unsigned bit7           : 1;
367 #elif defined(__BIG_ENDIAN_BITFIELD)
368                 unsigned bit7           : 1;
369                 unsigned lba            : 1;
370                 unsigned bit5           : 1;
371                 unsigned unit           : 1;
372                 unsigned head           : 4;
373 #else
374 #error "Please fix <asm/byteorder.h>"
375 #endif
376         } b;
377 } select_t, ata_select_t;
378
379 /*
380  * The ATA-IDE Status Register.
381  * The ATAPI Status Register.
382  *
383  * check        : Error occurred
384  * idx          : Index Error
385  * corr         : Correctable error occurred
386  * drq          : Data is request by the device
387  * dsc          : Disk Seek Complete                    : ata
388  *              : Media access command finished         : atapi
389  * df           : Device Fault                          : ata
390  *              : Reserved                              : atapi
391  * drdy         : Ready, Command Mode Capable           : ata
392  *              : Ignored for ATAPI commands            : atapi
393  * bsy          : Disk is Busy
394  *              : The device has access to the command block
395  */
396 typedef union {
397         unsigned all                    :8;
398         struct {
399 #if defined(__LITTLE_ENDIAN_BITFIELD)
400                 unsigned check          :1;
401                 unsigned idx            :1;
402                 unsigned corr           :1;
403                 unsigned drq            :1;
404                 unsigned dsc            :1;
405                 unsigned df             :1;
406                 unsigned drdy           :1;
407                 unsigned bsy            :1;
408 #elif defined(__BIG_ENDIAN_BITFIELD)
409                 unsigned bsy            :1;
410                 unsigned drdy           :1;
411                 unsigned df             :1;
412                 unsigned dsc            :1;
413                 unsigned drq            :1;
414                 unsigned corr           :1;
415                 unsigned idx            :1;
416                 unsigned check          :1;
417 #else
418 #error "Please fix <asm/byteorder.h>"
419 #endif
420         } b;
421 } ata_status_t, atapi_status_t;
422
423 /*
424  * ATAPI Feature Register
425  *
426  * dma          : Using DMA or PIO
427  * reserved321  : Reserved
428  * reserved654  : Reserved (Tag Type)
429  * reserved7    : Reserved
430  */
431 typedef union {
432         unsigned all                    :8;
433         struct {
434 #if defined(__LITTLE_ENDIAN_BITFIELD)
435                 unsigned dma            :1;
436                 unsigned reserved321    :3;
437                 unsigned reserved654    :3;
438                 unsigned reserved7      :1;
439 #elif defined(__BIG_ENDIAN_BITFIELD)
440                 unsigned reserved7      :1;
441                 unsigned reserved654    :3;
442                 unsigned reserved321    :3;
443                 unsigned dma            :1;
444 #else
445 #error "Please fix <asm/byteorder.h>"
446 #endif
447         } b;
448 } atapi_feature_t;
449
450 /*
451  * ATAPI Interrupt Reason Register.
452  *
453  * cod          : Information transferred is command (1) or data (0)
454  * io           : The device requests us to read (1) or write (0)
455  * reserved     : Reserved
456  */
457 typedef union {
458         unsigned all                    :8;
459         struct {
460 #if defined(__LITTLE_ENDIAN_BITFIELD)
461                 unsigned cod            :1;
462                 unsigned io             :1;
463                 unsigned reserved       :6;
464 #elif defined(__BIG_ENDIAN_BITFIELD)
465                 unsigned reserved       :6;
466                 unsigned io             :1;
467                 unsigned cod            :1;
468 #else
469 #error "Please fix <asm/byteorder.h>"
470 #endif
471         } b;
472 } atapi_ireason_t;
473
474 /*
475  * The ATAPI error register.
476  *
477  * ili          : Illegal Length Indication
478  * eom          : End Of Media Detected
479  * abrt         : Aborted command - As defined by ATA
480  * mcr          : Media Change Requested - As defined by ATA
481  * sense_key    : Sense key of the last failed packet command
482  */
483 typedef union {
484         unsigned all                    :8;
485         struct {
486 #if defined(__LITTLE_ENDIAN_BITFIELD)
487                 unsigned ili            :1;
488                 unsigned eom            :1;
489                 unsigned abrt           :1;
490                 unsigned mcr            :1;
491                 unsigned sense_key      :4;
492 #elif defined(__BIG_ENDIAN_BITFIELD)
493                 unsigned sense_key      :4;
494                 unsigned mcr            :1;
495                 unsigned abrt           :1;
496                 unsigned eom            :1;
497                 unsigned ili            :1;
498 #else
499 #error "Please fix <asm/byteorder.h>"
500 #endif
501         } b;
502 } atapi_error_t;
503
504 /*
505  * Status returned from various ide_ functions
506  */
507 typedef enum {
508         ide_stopped,    /* no drive operation was started */
509         ide_started,    /* a drive operation was started, handler was set */
510 } ide_startstop_t;
511
512 struct ide_driver_s;
513 struct ide_settings_s;
514
515 #ifdef CONFIG_BLK_DEV_IDEACPI
516 struct ide_acpi_drive_link;
517 struct ide_acpi_hwif_link;
518 #endif
519
520 typedef struct ide_drive_s {
521         char            name[4];        /* drive name, such as "hda" */
522         char            driver_req[10]; /* requests specific driver */
523
524         struct request_queue    *queue; /* request queue */
525
526         struct request          *rq;    /* current request */
527         struct ide_drive_s      *next;  /* circular list of hwgroup drives */
528         void            *driver_data;   /* extra driver data */
529         struct hd_driveid       *id;    /* drive model identification info */
530 #ifdef CONFIG_IDE_PROC_FS
531         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
532         struct ide_settings_s *settings;/* /proc/ide/ drive settings */
533 #endif
534         struct hwif_s           *hwif;  /* actually (ide_hwif_t *) */
535
536         unsigned long sleep;            /* sleep until this time */
537         unsigned long service_start;    /* time we started last request */
538         unsigned long service_time;     /* service time of last request */
539         unsigned long timeout;          /* max time to wait for irq */
540
541         special_t       special;        /* special action flags */
542         select_t        select;         /* basic drive/head select reg value */
543
544         u8      keep_settings;          /* restore settings after drive reset */
545         u8      using_dma;              /* disk is using dma for read/write */
546         u8      retry_pio;              /* retrying dma capable host in pio */
547         u8      state;                  /* retry state */
548         u8      waiting_for_dma;        /* dma currently in progress */
549         u8      unmask;                 /* okay to unmask other irqs */
550         u8      bswap;                  /* byte swap data */
551         u8      noflush;                /* don't attempt flushes */
552         u8      dsc_overlap;            /* DSC overlap */
553         u8      nice1;                  /* give potential excess bandwidth */
554
555         unsigned present        : 1;    /* drive is physically present */
556         unsigned dead           : 1;    /* device ejected hint */
557         unsigned id_read        : 1;    /* 1=id read from disk 0 = synthetic */
558         unsigned noprobe        : 1;    /* from:  hdx=noprobe */
559         unsigned removable      : 1;    /* 1 if need to do check_media_change */
560         unsigned attach         : 1;    /* needed for removable devices */
561         unsigned forced_geom    : 1;    /* 1 if hdx=c,h,s was given at boot */
562         unsigned no_unmask      : 1;    /* disallow setting unmask bit */
563         unsigned no_io_32bit    : 1;    /* disallow enabling 32bit I/O */
564         unsigned atapi_overlap  : 1;    /* ATAPI overlap (not supported) */
565         unsigned nice0          : 1;    /* give obvious excess bandwidth */
566         unsigned nice2          : 1;    /* give a share in our own bandwidth */
567         unsigned doorlocking    : 1;    /* for removable only: door lock/unlock works */
568         unsigned nodma          : 1;    /* disallow DMA */
569         unsigned autotune       : 2;    /* 0=default, 1=autotune, 2=noautotune */
570         unsigned remap_0_to_1   : 1;    /* 0=noremap, 1=remap 0->1 (for EZDrive) */
571         unsigned blocked        : 1;    /* 1=powermanagment told us not to do anything, so sleep nicely */
572         unsigned vdma           : 1;    /* 1=doing PIO over DMA 0=doing normal DMA */
573         unsigned scsi           : 1;    /* 0=default, 1=ide-scsi emulation */
574         unsigned sleeping       : 1;    /* 1=sleeping & sleep field valid */
575         unsigned post_reset     : 1;
576         unsigned udma33_warned  : 1;
577
578         u8      addressing;     /* 0=28-bit, 1=48-bit, 2=48-bit doing 28-bit */
579         u8      quirk_list;     /* considered quirky, set for a specific host */
580         u8      init_speed;     /* transfer rate set at boot */
581         u8      current_speed;  /* current transfer rate set */
582         u8      desired_speed;  /* desired transfer rate set */
583         u8      dn;             /* now wide spread use */
584         u8      wcache;         /* status of write cache */
585         u8      acoustic;       /* acoustic management */
586         u8      media;          /* disk, cdrom, tape, floppy, ... */
587         u8      ctl;            /* "normal" value for IDE_CONTROL_REG */
588         u8      ready_stat;     /* min status value for drive ready */
589         u8      mult_count;     /* current multiple sector setting */
590         u8      mult_req;       /* requested multiple sector setting */
591         u8      tune_req;       /* requested drive tuning setting */
592         u8      io_32bit;       /* 0=16-bit, 1=32-bit, 2/3=32bit+sync */
593         u8      bad_wstat;      /* used for ignoring WRERR_STAT */
594         u8      nowerr;         /* used for ignoring WRERR_STAT */
595         u8      sect0;          /* offset of first sector for DM6:DDO */
596         u8      head;           /* "real" number of heads */
597         u8      sect;           /* "real" sectors per track */
598         u8      bios_head;      /* BIOS/fdisk/LILO number of heads */
599         u8      bios_sect;      /* BIOS/fdisk/LILO sectors per track */
600
601         unsigned int    bios_cyl;       /* BIOS/fdisk/LILO number of cyls */
602         unsigned int    cyl;            /* "real" number of cyls */
603         unsigned int    drive_data;     /* used by set_pio_mode/selectproc */
604         unsigned int    failures;       /* current failure count */
605         unsigned int    max_failures;   /* maximum allowed failure count */
606         u64             probed_capacity;/* initial reported media capacity (ide-cd only currently) */
607
608         u64             capacity64;     /* total number of sectors */
609
610         int             lun;            /* logical unit */
611         int             crc_count;      /* crc counter to reduce drive speed */
612 #ifdef CONFIG_BLK_DEV_IDEACPI
613         struct ide_acpi_drive_link *acpidata;
614 #endif
615         struct list_head list;
616         struct device   gendev;
617         struct completion gendev_rel_comp;      /* to deal with device release() */
618 } ide_drive_t;
619
620 #define to_ide_device(dev)container_of(dev, ide_drive_t, gendev)
621
622 #define IDE_CHIPSET_PCI_MASK    \
623     ((1<<ide_pci)|(1<<ide_cmd646)|(1<<ide_ali14xx))
624 #define IDE_CHIPSET_IS_PCI(c)   ((IDE_CHIPSET_PCI_MASK >> (c)) & 1)
625
626 struct ide_port_info;
627
628 typedef struct hwif_s {
629         struct hwif_s *next;            /* for linked-list in ide_hwgroup_t */
630         struct hwif_s *mate;            /* other hwif from same PCI chip */
631         struct hwgroup_s *hwgroup;      /* actually (ide_hwgroup_t *) */
632         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
633
634         char name[6];                   /* name of interface, eg. "ide0" */
635
636                 /* task file registers for pata and sata */
637         unsigned long   io_ports[IDE_NR_PORTS];
638         unsigned long   sata_scr[SATA_NR_PORTS];
639         unsigned long   sata_misc[SATA_NR_PORTS];
640
641         ide_drive_t     drives[MAX_DRIVES];     /* drive info */
642
643         u8 major;       /* our major number */
644         u8 index;       /* 0 for ide0; 1 for ide1; ... */
645         u8 channel;     /* for dual-port chips: 0=primary, 1=secondary */
646         u8 straight8;   /* Alan's straight 8 check */
647         u8 bus_state;   /* power state of the IDE bus */
648
649         u32 host_flags;
650
651         u8 pio_mask;
652
653         u8 ultra_mask;
654         u8 mwdma_mask;
655         u8 swdma_mask;
656
657         u8 cbl;         /* cable type */
658
659         hwif_chipset_t chipset; /* sub-module for tuning.. */
660
661         struct pci_dev  *pci_dev;       /* for pci chipsets */
662         const struct ide_port_info *cds;        /* chipset device struct */
663
664         ide_ack_intr_t *ack_intr;
665
666         void (*rw_disk)(ide_drive_t *, struct request *);
667
668 #if 0
669         ide_hwif_ops_t  *hwifops;
670 #else
671         /* routine to program host for PIO mode */
672         void    (*set_pio_mode)(ide_drive_t *, const u8);
673         /* routine to program host for DMA mode */
674         void    (*set_dma_mode)(ide_drive_t *, const u8);
675         /* tweaks hardware to select drive */
676         void    (*selectproc)(ide_drive_t *);
677         /* chipset polling based on hba specifics */
678         int     (*reset_poll)(ide_drive_t *);
679         /* chipset specific changes to default for device-hba resets */
680         void    (*pre_reset)(ide_drive_t *);
681         /* routine to reset controller after a disk reset */
682         void    (*resetproc)(ide_drive_t *);
683         /* special interrupt handling for shared pci interrupts */
684         void    (*intrproc)(ide_drive_t *);
685         /* special host masking for drive selection */
686         void    (*maskproc)(ide_drive_t *, int);
687         /* check host's drive quirk list */
688         int     (*quirkproc)(ide_drive_t *);
689         /* driver soft-power interface */
690         int     (*busproc)(ide_drive_t *, int);
691 #endif
692         u8 (*mdma_filter)(ide_drive_t *);
693         u8 (*udma_filter)(ide_drive_t *);
694
695         void (*fixup)(struct hwif_s *);
696
697         void (*ata_input_data)(ide_drive_t *, void *, u32);
698         void (*ata_output_data)(ide_drive_t *, void *, u32);
699
700         void (*atapi_input_bytes)(ide_drive_t *, void *, u32);
701         void (*atapi_output_bytes)(ide_drive_t *, void *, u32);
702
703         int (*dma_setup)(ide_drive_t *);
704         void (*dma_exec_cmd)(ide_drive_t *, u8);
705         void (*dma_start)(ide_drive_t *);
706         int (*ide_dma_end)(ide_drive_t *drive);
707         int (*ide_dma_on)(ide_drive_t *drive);
708         void (*dma_off_quietly)(ide_drive_t *drive);
709         int (*ide_dma_test_irq)(ide_drive_t *drive);
710         void (*ide_dma_clear_irq)(ide_drive_t *drive);
711         void (*dma_host_on)(ide_drive_t *drive);
712         void (*dma_host_off)(ide_drive_t *drive);
713         void (*dma_lost_irq)(ide_drive_t *drive);
714         void (*dma_timeout)(ide_drive_t *drive);
715
716         void (*OUTB)(u8 addr, unsigned long port);
717         void (*OUTBSYNC)(ide_drive_t *drive, u8 addr, unsigned long port);
718         void (*OUTW)(u16 addr, unsigned long port);
719         void (*OUTSW)(unsigned long port, void *addr, u32 count);
720         void (*OUTSL)(unsigned long port, void *addr, u32 count);
721
722         u8  (*INB)(unsigned long port);
723         u16 (*INW)(unsigned long port);
724         void (*INSW)(unsigned long port, void *addr, u32 count);
725         void (*INSL)(unsigned long port, void *addr, u32 count);
726
727         /* dma physical region descriptor table (cpu view) */
728         unsigned int    *dmatable_cpu;
729         /* dma physical region descriptor table (dma view) */
730         dma_addr_t      dmatable_dma;
731         /* Scatter-gather list used to build the above */
732         struct scatterlist *sg_table;
733         int sg_max_nents;               /* Maximum number of entries in it */
734         int sg_nents;                   /* Current number of entries in it */
735         int sg_dma_direction;           /* dma transfer direction */
736
737         /* data phase of the active command (currently only valid for PIO/DMA) */
738         int             data_phase;
739
740         unsigned int nsect;
741         unsigned int nleft;
742         struct scatterlist *cursg;
743         unsigned int cursg_ofs;
744
745         int             rqsize;         /* max sectors per request */
746         int             irq;            /* our irq number */
747
748         unsigned long   dma_base;       /* base addr for dma ports */
749         unsigned long   dma_command;    /* dma command register */
750         unsigned long   dma_vendor1;    /* dma vendor 1 register */
751         unsigned long   dma_status;     /* dma status register */
752         unsigned long   dma_vendor3;    /* dma vendor 3 register */
753         unsigned long   dma_prdtable;   /* actual prd table address */
754
755         unsigned long   config_data;    /* for use by chipset-specific code */
756         unsigned long   select_data;    /* for use by chipset-specific code */
757
758         unsigned long   extra_base;     /* extra addr for dma ports */
759         unsigned        extra_ports;    /* number of extra dma ports */
760
761         unsigned        noprobe    : 1; /* don't probe for this interface */
762         unsigned        present    : 1; /* this interface exists */
763         unsigned        hold       : 1; /* this interface is always present */
764         unsigned        serialized : 1; /* serialized all channel operation */
765         unsigned        sharing_irq: 1; /* 1 = sharing irq with another hwif */
766         unsigned        reset      : 1; /* reset after probe */
767         unsigned        auto_poll  : 1; /* supports nop auto-poll */
768         unsigned        sg_mapped  : 1; /* sg_table and sg_nents are ready */
769         unsigned        no_io_32bit : 1; /* 1 = can not do 32-bit IO ops */
770         unsigned        mmio       : 1; /* host uses MMIO */
771
772         struct device   gendev;
773         struct completion gendev_rel_comp; /* To deal with device release() */
774
775         void            *hwif_data;     /* extra hwif data */
776
777         unsigned dma;
778
779 #ifdef CONFIG_BLK_DEV_IDEACPI
780         struct ide_acpi_hwif_link *acpidata;
781 #endif
782 } ____cacheline_internodealigned_in_smp ide_hwif_t;
783
784 /*
785  *  internal ide interrupt handler type
786  */
787 typedef ide_startstop_t (ide_pre_handler_t)(ide_drive_t *, struct request *);
788 typedef ide_startstop_t (ide_handler_t)(ide_drive_t *);
789 typedef int (ide_expiry_t)(ide_drive_t *);
790
791 typedef struct hwgroup_s {
792                 /* irq handler, if active */
793         ide_startstop_t (*handler)(ide_drive_t *);
794                 /* irq handler, suspended if active */
795         ide_startstop_t (*handler_save)(ide_drive_t *);
796                 /* BOOL: protects all fields below */
797         volatile int busy;
798                 /* BOOL: wake us up on timer expiry */
799         unsigned int sleeping   : 1;
800                 /* BOOL: polling active & poll_timeout field valid */
801         unsigned int polling    : 1;
802                 /* BOOL: in a polling reset situation. Must not trigger another reset yet */
803         unsigned int resetting  : 1;
804
805                 /* current drive */
806         ide_drive_t *drive;
807                 /* ptr to current hwif in linked-list */
808         ide_hwif_t *hwif;
809
810                 /* for pci chipsets */
811         struct pci_dev *pci_dev;
812
813                 /* current request */
814         struct request *rq;
815                 /* failsafe timer */
816         struct timer_list timer;
817                 /* local copy of current write rq */
818         struct request wrq;
819                 /* timeout value during long polls */
820         unsigned long poll_timeout;
821                 /* queried upon timeouts */
822         int (*expiry)(ide_drive_t *);
823                 /* ide_system_bus_speed */
824         int pio_clock;
825         int req_gen;
826         int req_gen_timer;
827
828         unsigned char cmd_buf[4];
829 } ide_hwgroup_t;
830
831 typedef struct ide_driver_s ide_driver_t;
832
833 extern struct mutex ide_setting_mtx;
834
835 int set_io_32bit(ide_drive_t *, int);
836 int set_pio_mode(ide_drive_t *, int);
837 int set_using_dma(ide_drive_t *, int);
838
839 #ifdef CONFIG_IDE_PROC_FS
840 /*
841  * configurable drive settings
842  */
843
844 #define TYPE_INT        0
845 #define TYPE_BYTE       1
846 #define TYPE_SHORT      2
847
848 #define SETTING_READ    (1 << 0)
849 #define SETTING_WRITE   (1 << 1)
850 #define SETTING_RW      (SETTING_READ | SETTING_WRITE)
851
852 typedef int (ide_procset_t)(ide_drive_t *, int);
853 typedef struct ide_settings_s {
854         char                    *name;
855         int                     rw;
856         int                     data_type;
857         int                     min;
858         int                     max;
859         int                     mul_factor;
860         int                     div_factor;
861         void                    *data;
862         ide_procset_t           *set;
863         int                     auto_remove;
864         struct ide_settings_s   *next;
865 } ide_settings_t;
866
867 int ide_add_setting(ide_drive_t *, const char *, int, int, int, int, int, int, void *, ide_procset_t *set);
868
869 /*
870  * /proc/ide interface
871  */
872 typedef struct {
873         const char      *name;
874         mode_t          mode;
875         read_proc_t     *read_proc;
876         write_proc_t    *write_proc;
877 } ide_proc_entry_t;
878
879 void proc_ide_create(void);
880 void proc_ide_destroy(void);
881 void ide_proc_register_port(ide_hwif_t *);
882 void ide_proc_unregister_port(ide_hwif_t *);
883 void ide_proc_register_driver(ide_drive_t *, ide_driver_t *);
884 void ide_proc_unregister_driver(ide_drive_t *, ide_driver_t *);
885
886 void ide_add_generic_settings(ide_drive_t *);
887
888 read_proc_t proc_ide_read_capacity;
889 read_proc_t proc_ide_read_geometry;
890
891 #ifdef CONFIG_BLK_DEV_IDEPCI
892 void ide_pci_create_host_proc(const char *, get_info_t *);
893 #endif
894
895 /*
896  * Standard exit stuff:
897  */
898 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) \
899 {                                       \
900         len -= off;                     \
901         if (len < count) {              \
902                 *eof = 1;               \
903                 if (len <= 0)           \
904                         return 0;       \
905         } else                          \
906                 len = count;            \
907         *start = page + off;            \
908         return len;                     \
909 }
910 #else
911 static inline void proc_ide_create(void) { ; }
912 static inline void proc_ide_destroy(void) { ; }
913 static inline void ide_proc_register_port(ide_hwif_t *hwif) { ; }
914 static inline void ide_proc_unregister_port(ide_hwif_t *hwif) { ; }
915 static inline void ide_proc_register_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
916 static inline void ide_proc_unregister_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
917 static inline void ide_add_generic_settings(ide_drive_t *drive) { ; }
918 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) return 0;
919 #endif
920
921 /*
922  * Power Management step value (rq->pm->pm_step).
923  *
924  * The step value starts at 0 (ide_pm_state_start_suspend) for a
925  * suspend operation or 1000 (ide_pm_state_start_resume) for a
926  * resume operation.
927  *
928  * For each step, the core calls the subdriver start_power_step() first.
929  * This can return:
930  *      - ide_stopped : In this case, the core calls us back again unless
931  *                      step have been set to ide_power_state_completed.
932  *      - ide_started : In this case, the channel is left busy until an
933  *                      async event (interrupt) occurs.
934  * Typically, start_power_step() will issue a taskfile request with
935  * do_rw_taskfile().
936  *
937  * Upon reception of the interrupt, the core will call complete_power_step()
938  * with the error code if any. This routine should update the step value
939  * and return. It should not start a new request. The core will call
940  * start_power_step for the new step value, unless step have been set to
941  * ide_power_state_completed.
942  *
943  * Subdrivers are expected to define their own additional power
944  * steps from 1..999 for suspend and from 1001..1999 for resume,
945  * other values are reserved for future use.
946  */
947
948 enum {
949         ide_pm_state_completed          = -1,
950         ide_pm_state_start_suspend      = 0,
951         ide_pm_state_start_resume       = 1000,
952 };
953
954 /*
955  * Subdrivers support.
956  *
957  * The gendriver.owner field should be set to the module owner of this driver.
958  * The gendriver.name field should be set to the name of this driver
959  */
960 struct ide_driver_s {
961         const char                      *version;
962         u8                              media;
963         unsigned supports_dsc_overlap   : 1;
964         ide_startstop_t (*do_request)(ide_drive_t *, struct request *, sector_t);
965         int             (*end_request)(ide_drive_t *, int, int);
966         ide_startstop_t (*error)(ide_drive_t *, struct request *rq, u8, u8);
967         ide_startstop_t (*abort)(ide_drive_t *, struct request *rq);
968         struct device_driver    gen_driver;
969         int             (*probe)(ide_drive_t *);
970         void            (*remove)(ide_drive_t *);
971         void            (*resume)(ide_drive_t *);
972         void            (*shutdown)(ide_drive_t *);
973 #ifdef CONFIG_IDE_PROC_FS
974         ide_proc_entry_t        *proc;
975 #endif
976 };
977
978 #define to_ide_driver(drv) container_of(drv, ide_driver_t, gen_driver)
979
980 int generic_ide_ioctl(ide_drive_t *, struct file *, struct block_device *, unsigned, unsigned long);
981
982 /*
983  * ide_hwifs[] is the master data structure used to keep track
984  * of just about everything in ide.c.  Whenever possible, routines
985  * should be using pointers to a drive (ide_drive_t *) or
986  * pointers to a hwif (ide_hwif_t *), rather than indexing this
987  * structure directly (the allocation/layout may change!).
988  *
989  */
990 #ifndef _IDE_C
991 extern  ide_hwif_t      ide_hwifs[];            /* master data repository */
992 #endif
993 extern int noautodma;
994
995 extern int ide_end_request (ide_drive_t *drive, int uptodate, int nrsecs);
996 int ide_end_dequeued_request(ide_drive_t *drive, struct request *rq,
997                              int uptodate, int nr_sectors);
998
999 extern void ide_set_handler (ide_drive_t *drive, ide_handler_t *handler, unsigned int timeout, ide_expiry_t *expiry);
1000
1001 void ide_execute_command(ide_drive_t *, u8, ide_handler_t *, unsigned int,
1002                          ide_expiry_t *);
1003
1004 ide_startstop_t __ide_error(ide_drive_t *, struct request *, u8, u8);
1005
1006 ide_startstop_t ide_error (ide_drive_t *drive, const char *msg, byte stat);
1007
1008 ide_startstop_t __ide_abort(ide_drive_t *, struct request *);
1009
1010 extern ide_startstop_t ide_abort(ide_drive_t *, const char *);
1011
1012 extern void ide_fix_driveid(struct hd_driveid *);
1013
1014 extern void ide_fixstring(u8 *, const int, const int);
1015
1016 int ide_wait_stat(ide_startstop_t *, ide_drive_t *, u8, u8, unsigned long);
1017
1018 extern ide_startstop_t ide_do_reset (ide_drive_t *);
1019
1020 extern void ide_init_drive_cmd (struct request *rq);
1021
1022 /*
1023  * "action" parameter type for ide_do_drive_cmd() below.
1024  */
1025 typedef enum {
1026         ide_wait,       /* insert rq at end of list, and wait for it */
1027         ide_preempt,    /* insert rq in front of current request */
1028         ide_head_wait,  /* insert rq in front of current request and wait for it */
1029         ide_end         /* insert rq at end of list, but don't wait for it */
1030 } ide_action_t;
1031
1032 extern int ide_do_drive_cmd(ide_drive_t *, struct request *, ide_action_t);
1033
1034 extern void ide_end_drive_cmd(ide_drive_t *, u8, u8);
1035
1036 /*
1037  * Issue ATA command and wait for completion.
1038  * Use for implementing commands in kernel
1039  *
1040  *  (ide_drive_t *drive, u8 cmd, u8 nsect, u8 feature, u8 sectors, u8 *buf)
1041  */
1042 extern int ide_wait_cmd(ide_drive_t *, u8, u8, u8, u8, u8 *);
1043
1044 enum {
1045         IDE_TFLAG_LBA48                 = (1 << 0),
1046         IDE_TFLAG_NO_SELECT_MASK        = (1 << 1),
1047         IDE_TFLAG_FLAGGED               = (1 << 2),
1048         IDE_TFLAG_OUT_DATA              = (1 << 3),
1049         IDE_TFLAG_OUT_HOB_FEATURE       = (1 << 4),
1050         IDE_TFLAG_OUT_HOB_NSECT         = (1 << 5),
1051         IDE_TFLAG_OUT_HOB_LBAL          = (1 << 6),
1052         IDE_TFLAG_OUT_HOB_LBAM          = (1 << 7),
1053         IDE_TFLAG_OUT_HOB_LBAH          = (1 << 8),
1054         IDE_TFLAG_OUT_HOB               = IDE_TFLAG_OUT_HOB_FEATURE |
1055                                           IDE_TFLAG_OUT_HOB_NSECT |
1056                                           IDE_TFLAG_OUT_HOB_LBAL |
1057                                           IDE_TFLAG_OUT_HOB_LBAM |
1058                                           IDE_TFLAG_OUT_HOB_LBAH,
1059         IDE_TFLAG_OUT_FEATURE           = (1 << 9),
1060         IDE_TFLAG_OUT_NSECT             = (1 << 10),
1061         IDE_TFLAG_OUT_LBAL              = (1 << 11),
1062         IDE_TFLAG_OUT_LBAM              = (1 << 12),
1063         IDE_TFLAG_OUT_LBAH              = (1 << 13),
1064         IDE_TFLAG_OUT_TF                = IDE_TFLAG_OUT_FEATURE |
1065                                           IDE_TFLAG_OUT_NSECT |
1066                                           IDE_TFLAG_OUT_LBAL |
1067                                           IDE_TFLAG_OUT_LBAM |
1068                                           IDE_TFLAG_OUT_LBAH,
1069         IDE_TFLAG_OUT_DEVICE            = (1 << 14),
1070 };
1071
1072 struct ide_taskfile {
1073         u8      hob_data;       /*  0: high data byte (for TASKFILE IOCTL) */
1074
1075         u8      hob_feature;    /*  1-5: additional data to support LBA48 */
1076         u8      hob_nsect;
1077         u8      hob_lbal;
1078         u8      hob_lbam;
1079         u8      hob_lbah;
1080
1081         u8      data;           /*  6: low data byte (for TASKFILE IOCTL) */
1082
1083         union {                 /* Â 7: */
1084                 u8 error;       /*   read:  error */
1085                 u8 feature;     /*  write: feature */
1086         };
1087
1088         u8      nsect;          /*  8: number of sectors */
1089         u8      lbal;           /*  9: LBA low */
1090         u8      lbam;           /* 10: LBA mid */
1091         u8      lbah;           /* 11: LBA high */
1092
1093         u8      device;         /* 12: device select */
1094
1095         union {                 /* 13: */
1096                 u8 status;      /* Â read: status Â */
1097                 u8 command;     /* write: command */
1098         };
1099 };
1100
1101 typedef struct ide_task_s {
1102         union {
1103                 struct ide_taskfile     tf;
1104                 u8                      tf_array[14];
1105         };
1106         u16                     tf_flags;
1107         ide_reg_valid_t         tf_in_flags;
1108         int                     data_phase;
1109         int                     command_type;
1110         ide_pre_handler_t       *prehandler;
1111         ide_handler_t           *handler;
1112         struct request          *rq;            /* copy of request */
1113         void                    *special;       /* valid_t generally */
1114 } ide_task_t;
1115
1116 void ide_tf_load(ide_drive_t *, ide_task_t *);
1117
1118 extern u32 ide_read_24(ide_drive_t *);
1119
1120 extern void SELECT_DRIVE(ide_drive_t *);
1121 extern void SELECT_INTERRUPT(ide_drive_t *);
1122 extern void SELECT_MASK(ide_drive_t *, int);
1123 extern void QUIRK_LIST(ide_drive_t *);
1124
1125 extern int drive_is_ready(ide_drive_t *);
1126
1127 /*
1128  * taskfile io for disks for now...and builds request from ide_ioctl
1129  */
1130 extern ide_startstop_t do_rw_taskfile(ide_drive_t *, ide_task_t *);
1131
1132 /*
1133  * Special Flagged Register Validation Caller
1134  */
1135 extern ide_startstop_t flagged_taskfile(ide_drive_t *, ide_task_t *);
1136
1137 extern ide_startstop_t set_multmode_intr(ide_drive_t *);
1138 extern ide_startstop_t set_geometry_intr(ide_drive_t *);
1139 extern ide_startstop_t recal_intr(ide_drive_t *);
1140 extern ide_startstop_t task_no_data_intr(ide_drive_t *);
1141 extern ide_startstop_t task_in_intr(ide_drive_t *);
1142 extern ide_startstop_t pre_task_out_intr(ide_drive_t *, struct request *);
1143
1144 extern int ide_raw_taskfile(ide_drive_t *, ide_task_t *, u8 *);
1145
1146 int ide_no_data_taskfile(ide_drive_t *, ide_task_t *);
1147
1148 int ide_taskfile_ioctl(ide_drive_t *, unsigned int, unsigned long);
1149 int ide_cmd_ioctl(ide_drive_t *, unsigned int, unsigned long);
1150 int ide_task_ioctl(ide_drive_t *, unsigned int, unsigned long);
1151
1152 extern int system_bus_clock(void);
1153
1154 extern int ide_driveid_update(ide_drive_t *);
1155 extern int ide_ata66_check(ide_drive_t *, ide_task_t *);
1156 extern int ide_config_drive_speed(ide_drive_t *, u8);
1157 extern u8 eighty_ninty_three (ide_drive_t *);
1158 extern int set_transfer(ide_drive_t *, ide_task_t *);
1159 extern int taskfile_lib_get_identify(ide_drive_t *drive, u8 *);
1160
1161 extern int ide_wait_not_busy(ide_hwif_t *hwif, unsigned long timeout);
1162
1163 extern void ide_stall_queue(ide_drive_t *drive, unsigned long timeout);
1164
1165 extern int ide_spin_wait_hwgroup(ide_drive_t *);
1166 extern void ide_timer_expiry(unsigned long);
1167 extern irqreturn_t ide_intr(int irq, void *dev_id);
1168 extern void do_ide_request(struct request_queue *);
1169
1170 void ide_init_disk(struct gendisk *, ide_drive_t *);
1171
1172 extern int ideprobe_init(void);
1173
1174 #ifdef CONFIG_IDEPCI_PCIBUS_ORDER
1175 extern void ide_scan_pcibus(int scan_direction) __init;
1176 extern int __ide_pci_register_driver(struct pci_driver *driver, struct module *owner, const char *mod_name);
1177 #define ide_pci_register_driver(d) __ide_pci_register_driver(d, THIS_MODULE, KBUILD_MODNAME)
1178 #else
1179 #define ide_pci_register_driver(d) pci_register_driver(d)
1180 #endif
1181
1182 void ide_pci_setup_ports(struct pci_dev *, const struct ide_port_info *, int, u8 *);
1183 void ide_setup_pci_noise(struct pci_dev *, const struct ide_port_info *);
1184
1185 extern void default_hwif_iops(ide_hwif_t *);
1186 extern void default_hwif_mmiops(ide_hwif_t *);
1187 extern void default_hwif_transport(ide_hwif_t *);
1188
1189 typedef struct ide_pci_enablebit_s {
1190         u8      reg;    /* byte pci reg holding the enable-bit */
1191         u8      mask;   /* mask to isolate the enable-bit */
1192         u8      val;    /* value of masked reg when "enabled" */
1193 } ide_pci_enablebit_t;
1194
1195 enum {
1196         /* Uses ISA control ports not PCI ones. */
1197         IDE_HFLAG_ISA_PORTS             = (1 << 0),
1198         /* single port device */
1199         IDE_HFLAG_SINGLE                = (1 << 1),
1200         /* don't use legacy PIO blacklist */
1201         IDE_HFLAG_PIO_NO_BLACKLIST      = (1 << 2),
1202         /* don't use conservative PIO "downgrade" */
1203         IDE_HFLAG_PIO_NO_DOWNGRADE      = (1 << 3),
1204         /* use PIO8/9 for prefetch off/on */
1205         IDE_HFLAG_ABUSE_PREFETCH        = (1 << 4),
1206         /* use PIO6/7 for fast-devsel off/on */
1207         IDE_HFLAG_ABUSE_FAST_DEVSEL     = (1 << 5),
1208         /* use 100-102 and 200-202 PIO values to set DMA modes */
1209         IDE_HFLAG_ABUSE_DMA_MODES       = (1 << 6),
1210         /*
1211          * keep DMA setting when programming PIO mode, may be used only
1212          * for hosts which have separate PIO and DMA timings (ie. PMAC)
1213          */
1214         IDE_HFLAG_SET_PIO_MODE_KEEP_DMA = (1 << 7),
1215         /* program host for the transfer mode after programming device */
1216         IDE_HFLAG_POST_SET_MODE         = (1 << 8),
1217         /* don't program host/device for the transfer mode ("smart" hosts) */
1218         IDE_HFLAG_NO_SET_MODE           = (1 << 9),
1219         /* trust BIOS for programming chipset/device for DMA */
1220         IDE_HFLAG_TRUST_BIOS_FOR_DMA    = (1 << 10),
1221         /* host uses VDMA */
1222         IDE_HFLAG_VDMA                  = (1 << 11),
1223         /* ATAPI DMA is unsupported */
1224         IDE_HFLAG_NO_ATAPI_DMA          = (1 << 12),
1225         /* set if host is a "bootable" controller */
1226         IDE_HFLAG_BOOTABLE              = (1 << 13),
1227         /* host doesn't support DMA */
1228         IDE_HFLAG_NO_DMA                = (1 << 14),
1229         /* check if host is PCI IDE device before allowing DMA */
1230         IDE_HFLAG_NO_AUTODMA            = (1 << 15),
1231         /* host is CS5510/CS5520 */
1232         IDE_HFLAG_CS5520                = (1 << 16),
1233         /* no LBA48 */
1234         IDE_HFLAG_NO_LBA48              = (1 << 17),
1235         /* no LBA48 DMA */
1236         IDE_HFLAG_NO_LBA48_DMA          = (1 << 18),
1237         /* data FIFO is cleared by an error */
1238         IDE_HFLAG_ERROR_STOPS_FIFO      = (1 << 19),
1239         /* serialize ports */
1240         IDE_HFLAG_SERIALIZE             = (1 << 20),
1241         /* use legacy IRQs */
1242         IDE_HFLAG_LEGACY_IRQS           = (1 << 21),
1243         /* force use of legacy IRQs */
1244         IDE_HFLAG_FORCE_LEGACY_IRQS     = (1 << 22),
1245         /* limit LBA48 requests to 256 sectors */
1246         IDE_HFLAG_RQSIZE_256            = (1 << 23),
1247         /* use 32-bit I/O ops */
1248         IDE_HFLAG_IO_32BIT              = (1 << 24),
1249         /* unmask IRQs */
1250         IDE_HFLAG_UNMASK_IRQS           = (1 << 25),
1251 };
1252
1253 #ifdef CONFIG_BLK_DEV_OFFBOARD
1254 # define IDE_HFLAG_OFF_BOARD    IDE_HFLAG_BOOTABLE
1255 #else
1256 # define IDE_HFLAG_OFF_BOARD    0
1257 #endif
1258
1259 struct ide_port_info {
1260         char                    *name;
1261         unsigned int            (*init_chipset)(struct pci_dev *, const char *);
1262         void                    (*init_iops)(ide_hwif_t *);
1263         void                    (*init_hwif)(ide_hwif_t *);
1264         void                    (*init_dma)(ide_hwif_t *, unsigned long);
1265         void                    (*fixup)(ide_hwif_t *);
1266         ide_pci_enablebit_t     enablebits[2];
1267         hwif_chipset_t          chipset;
1268         unsigned int            extra;
1269         u32                     host_flags;
1270         u8                      pio_mask;
1271         u8                      swdma_mask;
1272         u8                      mwdma_mask;
1273         u8                      udma_mask;
1274 };
1275
1276 int ide_setup_pci_device(struct pci_dev *, const struct ide_port_info *);
1277 int ide_setup_pci_devices(struct pci_dev *, struct pci_dev *, const struct ide_port_info *);
1278
1279 void ide_map_sg(ide_drive_t *, struct request *);
1280 void ide_init_sg_cmd(ide_drive_t *, struct request *);
1281
1282 #define BAD_DMA_DRIVE           0
1283 #define GOOD_DMA_DRIVE          1
1284
1285 struct drive_list_entry {
1286         const char *id_model;
1287         const char *id_firmware;
1288 };
1289
1290 int ide_in_drive_list(struct hd_driveid *, const struct drive_list_entry *);
1291
1292 #ifdef CONFIG_BLK_DEV_IDEDMA
1293 int __ide_dma_bad_drive(ide_drive_t *);
1294 int ide_id_dma_bug(ide_drive_t *);
1295
1296 u8 ide_find_dma_mode(ide_drive_t *, u8);
1297
1298 static inline u8 ide_max_dma_mode(ide_drive_t *drive)
1299 {
1300         return ide_find_dma_mode(drive, XFER_UDMA_6);
1301 }
1302
1303 void ide_dma_off(ide_drive_t *);
1304 int ide_set_dma(ide_drive_t *);
1305 ide_startstop_t ide_dma_intr(ide_drive_t *);
1306
1307 #ifdef CONFIG_BLK_DEV_IDEDMA_PCI
1308 extern int ide_build_sglist(ide_drive_t *, struct request *);
1309 extern int ide_build_dmatable(ide_drive_t *, struct request *);
1310 extern void ide_destroy_dmatable(ide_drive_t *);
1311 extern int ide_release_dma(ide_hwif_t *);
1312 extern void ide_setup_dma(ide_hwif_t *, unsigned long, unsigned int);
1313
1314 void ide_dma_host_off(ide_drive_t *);
1315 void ide_dma_off_quietly(ide_drive_t *);
1316 void ide_dma_host_on(ide_drive_t *);
1317 extern int __ide_dma_on(ide_drive_t *);
1318 extern int ide_dma_setup(ide_drive_t *);
1319 extern void ide_dma_start(ide_drive_t *);
1320 extern int __ide_dma_end(ide_drive_t *);
1321 extern void ide_dma_lost_irq(ide_drive_t *);
1322 extern void ide_dma_timeout(ide_drive_t *);
1323 #endif /* CONFIG_BLK_DEV_IDEDMA_PCI */
1324
1325 #else
1326 static inline int ide_id_dma_bug(ide_drive_t *drive) { return 0; }
1327 static inline u8 ide_find_dma_mode(ide_drive_t *drive, u8 speed) { return 0; }
1328 static inline u8 ide_max_dma_mode(ide_drive_t *drive) { return 0; }
1329 static inline void ide_dma_off(ide_drive_t *drive) { ; }
1330 static inline void ide_dma_verbose(ide_drive_t *drive) { ; }
1331 static inline int ide_set_dma(ide_drive_t *drive) { return 1; }
1332 #endif /* CONFIG_BLK_DEV_IDEDMA */
1333
1334 #ifndef CONFIG_BLK_DEV_IDEDMA_PCI
1335 static inline void ide_release_dma(ide_hwif_t *drive) {;}
1336 #endif
1337
1338 #ifdef CONFIG_BLK_DEV_IDEACPI
1339 extern int ide_acpi_exec_tfs(ide_drive_t *drive);
1340 extern void ide_acpi_get_timing(ide_hwif_t *hwif);
1341 extern void ide_acpi_push_timing(ide_hwif_t *hwif);
1342 extern void ide_acpi_init(ide_hwif_t *hwif);
1343 extern void ide_acpi_set_state(ide_hwif_t *hwif, int on);
1344 #else
1345 static inline int ide_acpi_exec_tfs(ide_drive_t *drive) { return 0; }
1346 static inline void ide_acpi_get_timing(ide_hwif_t *hwif) { ; }
1347 static inline void ide_acpi_push_timing(ide_hwif_t *hwif) { ; }
1348 static inline void ide_acpi_init(ide_hwif_t *hwif) { ; }
1349 static inline void ide_acpi_set_state(ide_hwif_t *hwif, int on) {}
1350 #endif
1351
1352 extern int ide_hwif_request_regions(ide_hwif_t *hwif);
1353 extern void ide_hwif_release_regions(ide_hwif_t* hwif);
1354 extern void ide_unregister (unsigned int index);
1355
1356 void ide_register_region(struct gendisk *);
1357 void ide_unregister_region(struct gendisk *);
1358
1359 void ide_undecoded_slave(ide_hwif_t *);
1360
1361 int ide_device_add(u8 idx[4]);
1362
1363 static inline void *ide_get_hwifdata (ide_hwif_t * hwif)
1364 {
1365         return hwif->hwif_data;
1366 }
1367
1368 static inline void ide_set_hwifdata (ide_hwif_t * hwif, void *data)
1369 {
1370         hwif->hwif_data = data;
1371 }
1372
1373 const char *ide_xfer_verbose(u8 mode);
1374 extern void ide_toggle_bounce(ide_drive_t *drive, int on);
1375 extern int ide_set_xfer_rate(ide_drive_t *drive, u8 rate);
1376
1377 static inline int ide_dev_has_iordy(struct hd_driveid *id)
1378 {
1379         return ((id->field_valid & 2) && (id->capability & 8)) ? 1 : 0;
1380 }
1381
1382 static inline int ide_dev_is_sata(struct hd_driveid *id)
1383 {
1384         /*
1385          * See if word 93 is 0 AND drive is at least ATA-5 compatible
1386          * verifying that word 80 by casting it to a signed type --
1387          * this trick allows us to filter out the reserved values of
1388          * 0x0000 and 0xffff along with the earlier ATA revisions...
1389          */
1390         if (id->hw_config == 0 && (short)id->major_rev_num >= 0x0020)
1391                 return 1;
1392         return 0;
1393 }
1394
1395 u8 ide_dump_status(ide_drive_t *, const char *, u8);
1396
1397 typedef struct ide_pio_timings_s {
1398         int     setup_time;     /* Address setup (ns) minimum */
1399         int     active_time;    /* Active pulse (ns) minimum */
1400         int     cycle_time;     /* Cycle time (ns) minimum = */
1401                                 /* active + recovery (+ setup for some chips) */
1402 } ide_pio_timings_t;
1403
1404 unsigned int ide_pio_cycle_time(ide_drive_t *, u8);
1405 u8 ide_get_best_pio_mode(ide_drive_t *, u8, u8);
1406 extern const ide_pio_timings_t ide_pio_timings[6];
1407
1408 int ide_set_pio_mode(ide_drive_t *, u8);
1409 int ide_set_dma_mode(ide_drive_t *, u8);
1410
1411 void ide_set_pio(ide_drive_t *, u8);
1412
1413 static inline void ide_set_max_pio(ide_drive_t *drive)
1414 {
1415         ide_set_pio(drive, 255);
1416 }
1417
1418 extern spinlock_t ide_lock;
1419 extern struct mutex ide_cfg_mtx;
1420 /*
1421  * Structure locking:
1422  *
1423  * ide_cfg_mtx and ide_lock together protect changes to
1424  * ide_hwif_t->{next,hwgroup}
1425  * ide_drive_t->next
1426  *
1427  * ide_hwgroup_t->busy: ide_lock
1428  * ide_hwgroup_t->hwif: ide_lock
1429  * ide_hwif_t->mate: constant, no locking
1430  * ide_drive_t->hwif: constant, no locking
1431  */
1432
1433 #define local_irq_set(flags)    do { local_save_flags((flags)); local_irq_enable_in_hardirq(); } while (0)
1434
1435 extern struct bus_type ide_bus_type;
1436
1437 /* check if CACHE FLUSH (EXT) command is supported (bits defined in ATA-6) */
1438 #define ide_id_has_flush_cache(id)      ((id)->cfs_enable_2 & 0x3000)
1439
1440 /* some Maxtor disks have bit 13 defined incorrectly so check bit 10 too */
1441 #define ide_id_has_flush_cache_ext(id)  \
1442         (((id)->cfs_enable_2 & 0x2400) == 0x2400)
1443
1444 static inline int hwif_to_node(ide_hwif_t *hwif)
1445 {
1446         struct pci_dev *dev = hwif->pci_dev;
1447         return dev ? pcibus_to_node(dev->bus) : -1;
1448 }
1449
1450 static inline ide_drive_t *ide_get_paired_drive(ide_drive_t *drive)
1451 {
1452         ide_hwif_t *hwif        = HWIF(drive);
1453
1454         return &hwif->drives[(drive->dn ^ 1) & 1];
1455 }
1456
1457 #endif /* _IDE_H */