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