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