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