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