SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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/ata.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 #include <linux/pm.h>
  21 #ifdef CONFIG_BLK_DEV_IDEACPI
  22 #include <acpi/acpi.h>
  23 #endif
  24 #include <asm/byteorder.h>
  25 #include <asm/system.h>
  26 #include <asm/io.h>
  27 #include <asm/mutex.h>
  28
  29 #if defined(CONFIG_CRIS) || defined(CONFIG_FRV) || defined(CONFIG_MN10300)
  30 # define SUPPORT_VLB_SYNC 0
  31 #else
  32 # define SUPPORT_VLB_SYNC 1
  33 #endif
  34
  35 /*
  36  * Probably not wise to fiddle with these
  37  */
  38 #define IDE_DEFAULT_MAX_FAILURES        1
  39 #define ERROR_MAX       8       /* Max read/write errors per sector */
  40 #define ERROR_RESET     3       /* Reset controller every 4th retry */
  41 #define ERROR_RECAL     1       /* Recalibrate every 2nd retry */
  42
  43 /* Error codes returned in rq->errors to the higher part of the driver. */
  44 enum {
  45         IDE_DRV_ERROR_GENERAL   = 101,
  46         IDE_DRV_ERROR_FILEMARK  = 102,
  47         IDE_DRV_ERROR_EOD       = 103,
  48 };
  49
  50 /*
  51  * Definitions for accessing IDE controller registers
  52  */
  53 #define IDE_NR_PORTS            (10)
  54
  55 struct ide_io_ports {
  56         unsigned long   data_addr;
  57
  58         union {
  59                 unsigned long error_addr;       /*   read:  error */
  60                 unsigned long feature_addr;     /*  write: feature */
  61         };
  62
  63         unsigned long   nsect_addr;
  64         unsigned long   lbal_addr;
  65         unsigned long   lbam_addr;
  66         unsigned long   lbah_addr;
  67
  68         unsigned long   device_addr;
  69
  70         union {
  71                 unsigned long status_addr;      /*  read: status  */
  72                 unsigned long command_addr;     /* write: command */
  73         };
  74
  75         unsigned long   ctl_addr;
  76
  77         unsigned long   irq_addr;
  78 };
  79
  80 #define OK_STAT(stat,good,bad)  (((stat)&((good)|(bad)))==(good))
  81
  82 #define BAD_R_STAT      (ATA_BUSY | ATA_ERR)
  83 #define BAD_W_STAT      (BAD_R_STAT | ATA_DF)
  84 #define BAD_STAT        (BAD_R_STAT | ATA_DRQ)
  85 #define DRIVE_READY     (ATA_DRDY | ATA_DSC)
  86
  87 #define BAD_CRC         (ATA_ABORTED | ATA_ICRC)
  88
  89 #define SATA_NR_PORTS           (3)     /* 16 possible ?? */
  90
  91 #define SATA_STATUS_OFFSET      (0)
  92 #define SATA_ERROR_OFFSET       (1)
  93 #define SATA_CONTROL_OFFSET     (2)
  94
  95 /*
  96  * Our Physical Region Descriptor (PRD) table should be large enough
  97  * to handle the biggest I/O request we are likely to see.  Since requests
  98  * can have no more than 256 sectors, and since the typical blocksize is
  99  * two or more sectors, we could get by with a limit of 128 entries here for
 100  * the usual worst case.  Most requests seem to include some contiguous blocks,
 101  * further reducing the number of table entries required.
 102  *
 103  * The driver reverts to PIO mode for individual requests that exceed
 104  * this limit (possible with 512 byte blocksizes, eg. MSDOS f/s), so handling
 105  * 100% of all crazy scenarios here is not necessary.
 106  *
 107  * As it turns out though, we must allocate a full 4KB page for this,
 108  * so the two PRD tables (ide0 & ide1) will each get half of that,
 109  * allowing each to have about 256 entries (8 bytes each) from this.
 110  */
 111 #define PRD_BYTES       8
 112 #define PRD_ENTRIES     256
 113
 114 /*
 115  * Some more useful definitions
 116  */
 117 #define PARTN_BITS      6       /* number of minor dev bits for partitions */
 118 #define MAX_DRIVES      2       /* per interface; 2 assumed by lots of code */
 119 #define SECTOR_SIZE     512
 120
 121 /*
 122  * Timeouts for various operations:
 123  */
 124 enum {
 125         /* spec allows up to 20ms */
 126         WAIT_DRQ        = HZ / 10,      /* 100ms */
 127         /* some laptops are very slow */
 128         WAIT_READY      = 5 * HZ,       /* 5s */
 129         /* should be less than 3ms (?), if all ATAPI CD is closed at boot */
 130         WAIT_PIDENTIFY  = 10 * HZ,      /* 10s */
 131         /* worst case when spinning up */
 132         WAIT_WORSTCASE  = 30 * HZ,      /* 30s */
 133         /* maximum wait for an IRQ to happen */
 134         WAIT_CMD        = 10 * HZ,      /* 10s */
 135         /* Some drives require a longer IRQ timeout. */
 136         WAIT_FLOPPY_CMD = 50 * HZ,      /* 50s */
 137         /*
 138          * Some drives (for example, Seagate STT3401A Travan) require a very
 139          * long timeout, because they don't return an interrupt or clear their
 140          * BSY bit until after the command completes (even retension commands).
 141          */
 142         WAIT_TAPE_CMD   = 900 * HZ,     /* 900s */
 143         /* minimum sleep time */
 144         WAIT_MIN_SLEEP  = HZ / 50,      /* 20ms */
 145 };
 146
 147 /*
 148  * Op codes for special requests to be handled by ide_special_rq().
 149  * Values should be in the range of 0x20 to 0x3f.
 150  */
 151 #define REQ_DRIVE_RESET         0x20
 152 #define REQ_DEVSET_EXEC         0x21
 153 #define REQ_PARK_HEADS          0x22
 154 #define REQ_UNPARK_HEADS        0x23
 155
 156 /*
 157  * Check for an interrupt and acknowledge the interrupt status
 158  */
 159 struct hwif_s;
 160 typedef int (ide_ack_intr_t)(struct hwif_s *);
 161
 162 /*
 163  * hwif_chipset_t is used to keep track of the specific hardware
 164  * chipset used by each IDE interface, if known.
 165  */
 166 enum {          ide_unknown,    ide_generic,    ide_pci,
 167                 ide_cmd640,     ide_dtc2278,    ide_ali14xx,
 168                 ide_qd65xx,     ide_umc8672,    ide_ht6560b,
 169                 ide_4drives,    ide_pmac,       ide_acorn,
 170                 ide_au1xxx,     ide_palm3710
 171 };
 172
 173 typedef u8 hwif_chipset_t;
 174
 175 /*
 176  * Structure to hold all information about the location of this port
 177  */
 178 typedef struct hw_regs_s {
 179         union {
 180                 struct ide_io_ports     io_ports;
 181                 unsigned long           io_ports_array[IDE_NR_PORTS];
 182         };
 183
 184         int             irq;                    /* our irq number */
 185         ide_ack_intr_t  *ack_intr;              /* acknowledge interrupt */
 186         hwif_chipset_t  chipset;
 187         struct device   *dev, *parent;
 188         unsigned long   config;
 189 } hw_regs_t;
 190
 191 static inline void ide_std_init_ports(hw_regs_t *hw,
 192                                       unsigned long io_addr,
 193                                       unsigned long ctl_addr)
 194 {
 195         unsigned int i;
 196
 197         for (i = 0; i <= 7; i++)
 198                 hw->io_ports_array[i] = io_addr++;
 199
 200         hw->io_ports.ctl_addr = ctl_addr;
 201 }
 202
 203 #define MAX_HWIFS       10
 204
 205 /*
 206  * Now for the data we need to maintain per-drive:  ide_drive_t
 207  */
 208
 209 #define ide_scsi        0x21
 210 #define ide_disk        0x20
 211 #define ide_optical     0x7
 212 #define ide_cdrom       0x5
 213 #define ide_tape        0x1
 214 #define ide_floppy      0x0
 215
 216 /*
 217  * Special Driver Flags
 218  *
 219  * set_geometry : respecify drive geometry
 220  * recalibrate  : seek to cyl 0
 221  * set_multmode : set multmode count
 222  * reserved     : unused
 223  */
 224 typedef union {
 225         unsigned all                    : 8;
 226         struct {
 227                 unsigned set_geometry   : 1;
 228                 unsigned recalibrate    : 1;
 229                 unsigned set_multmode   : 1;
 230                 unsigned reserved       : 5;
 231         } b;
 232 } special_t;
 233
 234 /*
 235  * Status returned from various ide_ functions
 236  */
 237 typedef enum {
 238         ide_stopped,    /* no drive operation was started */
 239         ide_started,    /* a drive operation was started, handler was set */
 240 } ide_startstop_t;
 241
 242 enum {
 243         IDE_VALID_ERROR                 = (1 << 1),
 244         IDE_VALID_FEATURE               = IDE_VALID_ERROR,
 245         IDE_VALID_NSECT                 = (1 << 2),
 246         IDE_VALID_LBAL                  = (1 << 3),
 247         IDE_VALID_LBAM                  = (1 << 4),
 248         IDE_VALID_LBAH                  = (1 << 5),
 249         IDE_VALID_DEVICE                = (1 << 6),
 250         IDE_VALID_LBA                   = IDE_VALID_LBAL |
 251                                           IDE_VALID_LBAM |
 252                                           IDE_VALID_LBAH,
 253         IDE_VALID_OUT_TF                = IDE_VALID_FEATURE |
 254                                           IDE_VALID_NSECT |
 255                                           IDE_VALID_LBA,
 256         IDE_VALID_IN_TF                 = IDE_VALID_NSECT |
 257                                           IDE_VALID_LBA,
 258         IDE_VALID_OUT_HOB               = IDE_VALID_OUT_TF,
 259         IDE_VALID_IN_HOB                = IDE_VALID_ERROR |
 260                                           IDE_VALID_NSECT |
 261                                           IDE_VALID_LBA,
 262 };
 263
 264 enum {
 265         IDE_TFLAG_LBA48                 = (1 << 0),
 266         IDE_TFLAG_WRITE                 = (1 << 1),
 267         IDE_TFLAG_CUSTOM_HANDLER        = (1 << 2),
 268         IDE_TFLAG_DMA_PIO_FALLBACK      = (1 << 3),
 269         /* force 16-bit I/O operations */
 270         IDE_TFLAG_IO_16BIT              = (1 << 4),
 271         /* struct ide_cmd was allocated using kmalloc() */
 272         IDE_TFLAG_DYN                   = (1 << 5),
 273         IDE_TFLAG_FS                    = (1 << 6),
 274         IDE_TFLAG_MULTI_PIO             = (1 << 7),
 275 };
 276
 277 enum {
 278         IDE_FTFLAG_FLAGGED              = (1 << 0),
 279         IDE_FTFLAG_SET_IN_FLAGS         = (1 << 1),
 280         IDE_FTFLAG_OUT_DATA             = (1 << 2),
 281         IDE_FTFLAG_IN_DATA              = (1 << 3),
 282 };
 283
 284 struct ide_taskfile {
 285         u8      data;           /* 0: data byte (for TASKFILE ioctl) */
 286         union {                 /* 1: */
 287                 u8 error;       /*  read: error */
 288                 u8 feature;     /* write: feature */
 289         };
 290         u8      nsect;          /* 2: number of sectors */
 291         u8      lbal;           /* 3: LBA low */
 292         u8      lbam;           /* 4: LBA mid */
 293         u8      lbah;           /* 5: LBA high */
 294         u8      device;         /* 6: device select */
 295         union {                 /* 7: */
 296                 u8 status;      /*  read: status */
 297                 u8 command;     /* write: command */
 298         };
 299 };
 300
 301 struct ide_cmd {
 302         struct ide_taskfile     tf;
 303         struct ide_taskfile     hob;
 304         struct {
 305                 struct {
 306                         u8              tf;
 307                         u8              hob;
 308                 } out, in;
 309         } valid;
 310
 311         u8                      tf_flags;
 312         u8                      ftf_flags;      /* for TASKFILE ioctl */
 313         int                     protocol;
 314
 315         int                     sg_nents;         /* number of sg entries */
 316         int                     orig_sg_nents;
 317         int                     sg_dma_direction; /* DMA transfer direction */
 318
 319         unsigned int            nbytes;
 320         unsigned int            nleft;
 321         unsigned int            last_xfer_len;
 322
 323         struct scatterlist      *cursg;
 324         unsigned int            cursg_ofs;
 325
 326         struct request          *rq;            /* copy of request */
 327         void                    *special;       /* valid_t generally */
 328 };
 329
 330 /* ATAPI packet command flags */
 331 enum {
 332         /* set when an error is considered normal - no retry (ide-tape) */
 333         PC_FLAG_ABORT                   = (1 << 0),
 334         PC_FLAG_SUPPRESS_ERROR          = (1 << 1),
 335         PC_FLAG_WAIT_FOR_DSC            = (1 << 2),
 336         PC_FLAG_DMA_OK                  = (1 << 3),
 337         PC_FLAG_DMA_IN_PROGRESS         = (1 << 4),
 338         PC_FLAG_DMA_ERROR               = (1 << 5),
 339         PC_FLAG_WRITING                 = (1 << 6),
 340 };
 341
 342 /*
 343  * With each packet command, we allocate a buffer of IDE_PC_BUFFER_SIZE bytes.
 344  * This is used for several packet commands (not for READ/WRITE commands).
 345  */
 346 #define IDE_PC_BUFFER_SIZE      64
 347 #define ATAPI_WAIT_PC           (60 * HZ)
 348
 349 struct ide_atapi_pc {
 350         /* actual packet bytes */
 351         u8 c[12];
 352         /* incremented on each retry */
 353         int retries;
 354         int error;
 355
 356         /* bytes to transfer */
 357         int req_xfer;
 358         /* bytes actually transferred */
 359         int xferred;
 360
 361         /* data buffer */
 362         u8 *buf;
 363         /* current buffer position */
 364         u8 *cur_pos;
 365         int buf_size;
 366         /* missing/available data on the current buffer */
 367         int b_count;
 368
 369         /* the corresponding request */
 370         struct request *rq;
 371
 372         unsigned long flags;
 373
 374         /*
 375          * those are more or less driver-specific and some of them are subject
 376          * to change/removal later.
 377          */
 378         u8 pc_buf[IDE_PC_BUFFER_SIZE];
 379
 380         /* idetape only */
 381         struct idetape_bh *bh;
 382         char *b_data;
 383
 384         unsigned long timeout;
 385 };
 386
 387 struct ide_devset;
 388 struct ide_driver;
 389
 390 #ifdef CONFIG_BLK_DEV_IDEACPI
 391 struct ide_acpi_drive_link;
 392 struct ide_acpi_hwif_link;
 393 #endif
 394
 395 struct ide_drive_s;
 396
 397 struct ide_disk_ops {
 398         int             (*check)(struct ide_drive_s *, const char *);
 399         int             (*get_capacity)(struct ide_drive_s *);
 400         u64             (*set_capacity)(struct ide_drive_s *, u64);
 401         void            (*setup)(struct ide_drive_s *);
 402         void            (*flush)(struct ide_drive_s *);
 403         int             (*init_media)(struct ide_drive_s *, struct gendisk *);
 404         int             (*set_doorlock)(struct ide_drive_s *, struct gendisk *,
 405                                         int);
 406         ide_startstop_t (*do_request)(struct ide_drive_s *, struct request *,
 407                                       sector_t);
 408         int             (*ioctl)(struct ide_drive_s *, struct block_device *,
 409                                  fmode_t, unsigned int, unsigned long);
 410 };
 411
 412 /* ATAPI device flags */
 413 enum {
 414         IDE_AFLAG_DRQ_INTERRUPT         = (1 << 0),
 415
 416         /* ide-cd */
 417         /* Drive cannot eject the disc. */
 418         IDE_AFLAG_NO_EJECT              = (1 << 1),
 419         /* Drive is a pre ATAPI 1.2 drive. */
 420         IDE_AFLAG_PRE_ATAPI12           = (1 << 2),
 421         /* TOC addresses are in BCD. */
 422         IDE_AFLAG_TOCADDR_AS_BCD        = (1 << 3),
 423         /* TOC track numbers are in BCD. */
 424         IDE_AFLAG_TOCTRACKS_AS_BCD      = (1 << 4),
 425         /* Saved TOC information is current. */
 426         IDE_AFLAG_TOC_VALID             = (1 << 6),
 427         /* We think that the drive door is locked. */
 428         IDE_AFLAG_DOOR_LOCKED           = (1 << 7),
 429         /* SET_CD_SPEED command is unsupported. */
 430         IDE_AFLAG_NO_SPEED_SELECT       = (1 << 8),
 431         IDE_AFLAG_VERTOS_300_SSD        = (1 << 9),
 432         IDE_AFLAG_VERTOS_600_ESD        = (1 << 10),
 433         IDE_AFLAG_SANYO_3CD             = (1 << 11),
 434         IDE_AFLAG_FULL_CAPS_PAGE        = (1 << 12),
 435         IDE_AFLAG_PLAY_AUDIO_OK         = (1 << 13),
 436         IDE_AFLAG_LE_SPEED_FIELDS       = (1 << 14),
 437
 438         /* ide-floppy */
 439         /* Avoid commands not supported in Clik drive */
 440         IDE_AFLAG_CLIK_DRIVE            = (1 << 15),
 441         /* Requires BH algorithm for packets */
 442         IDE_AFLAG_ZIP_DRIVE             = (1 << 16),
 443         /* Supports format progress report */
 444         IDE_AFLAG_SRFP                  = (1 << 17),
 445
 446         /* ide-tape */
 447         IDE_AFLAG_IGNORE_DSC            = (1 << 18),
 448         /* 0 When the tape position is unknown */
 449         IDE_AFLAG_ADDRESS_VALID         = (1 << 19),
 450         /* Device already opened */
 451         IDE_AFLAG_BUSY                  = (1 << 20),
 452         /* Attempt to auto-detect the current user block size */
 453         IDE_AFLAG_DETECT_BS             = (1 << 21),
 454         /* Currently on a filemark */
 455         IDE_AFLAG_FILEMARK              = (1 << 22),
 456         /* 0 = no tape is loaded, so we don't rewind after ejecting */
 457         IDE_AFLAG_MEDIUM_PRESENT        = (1 << 23),
 458
 459         IDE_AFLAG_NO_AUTOCLOSE          = (1 << 24),
 460 };
 461
 462 /* device flags */
 463 enum {
 464         /* restore settings after device reset */
 465         IDE_DFLAG_KEEP_SETTINGS         = (1 << 0),
 466         /* device is using DMA for read/write */
 467         IDE_DFLAG_USING_DMA             = (1 << 1),
 468         /* okay to unmask other IRQs */
 469         IDE_DFLAG_UNMASK                = (1 << 2),
 470         /* don't attempt flushes */
 471         IDE_DFLAG_NOFLUSH               = (1 << 3),
 472         /* DSC overlap */
 473         IDE_DFLAG_DSC_OVERLAP           = (1 << 4),
 474         /* give potential excess bandwidth */
 475         IDE_DFLAG_NICE1                 = (1 << 5),
 476         /* device is physically present */
 477         IDE_DFLAG_PRESENT               = (1 << 6),
 478         /* disable Host Protected Area */
 479         IDE_DFLAG_NOHPA                 = (1 << 7),
 480         /* id read from device (synthetic if not set) */
 481         IDE_DFLAG_ID_READ               = (1 << 8),
 482         IDE_DFLAG_NOPROBE               = (1 << 9),
 483         /* need to do check_media_change() */
 484         IDE_DFLAG_REMOVABLE             = (1 << 10),
 485         /* needed for removable devices */
 486         IDE_DFLAG_ATTACH                = (1 << 11),
 487         IDE_DFLAG_FORCED_GEOM           = (1 << 12),
 488         /* disallow setting unmask bit */
 489         IDE_DFLAG_NO_UNMASK             = (1 << 13),
 490         /* disallow enabling 32-bit I/O */
 491         IDE_DFLAG_NO_IO_32BIT           = (1 << 14),
 492         /* for removable only: door lock/unlock works */
 493         IDE_DFLAG_DOORLOCKING           = (1 << 15),
 494         /* disallow DMA */
 495         IDE_DFLAG_NODMA                 = (1 << 16),
 496         /* powermanagment told us not to do anything, so sleep nicely */
 497         IDE_DFLAG_BLOCKED               = (1 << 17),
 498         /* sleeping & sleep field valid */
 499         IDE_DFLAG_SLEEPING              = (1 << 18),
 500         IDE_DFLAG_POST_RESET            = (1 << 19),
 501         IDE_DFLAG_UDMA33_WARNED         = (1 << 20),
 502         IDE_DFLAG_LBA48                 = (1 << 21),
 503         /* status of write cache */
 504         IDE_DFLAG_WCACHE                = (1 << 22),
 505         /* used for ignoring ATA_DF */
 506         IDE_DFLAG_NOWERR                = (1 << 23),
 507         /* retrying in PIO */
 508         IDE_DFLAG_DMA_PIO_RETRY         = (1 << 24),
 509         IDE_DFLAG_LBA                   = (1 << 25),
 510         /* don't unload heads */
 511         IDE_DFLAG_NO_UNLOAD             = (1 << 26),
 512         /* heads unloaded, please don't reset port */
 513         IDE_DFLAG_PARKED                = (1 << 27),
 514         IDE_DFLAG_MEDIA_CHANGED         = (1 << 28),
 515         /* write protect */
 516         IDE_DFLAG_WP                    = (1 << 29),
 517         IDE_DFLAG_FORMAT_IN_PROGRESS    = (1 << 30),
 518 };
 519
 520 struct ide_drive_s {
 521         char            name[4];        /* drive name, such as "hda" */
 522         char            driver_req[10]; /* requests specific driver */
 523
 524         struct request_queue    *queue; /* request queue */
 525
 526         struct request          *rq;    /* current request */
 527         void            *driver_data;   /* extra driver data */
 528         u16                     *id;    /* identification info */
 529 #ifdef CONFIG_IDE_PROC_FS
 530         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
 531         const struct ide_proc_devset *settings; /* /proc/ide/ drive settings */
 532 #endif
 533         struct hwif_s           *hwif;  /* actually (ide_hwif_t *) */
 534
 535         const struct ide_disk_ops *disk_ops;
 536
 537         unsigned long dev_flags;
 538
 539         unsigned long sleep;            /* sleep until this time */
 540         unsigned long timeout;          /* max time to wait for irq */
 541
 542         special_t       special;        /* special action flags */
 543
 544         u8      select;                 /* basic drive/head select reg value */
 545         u8      retry_pio;              /* retrying dma capable host in pio */
 546         u8      waiting_for_dma;        /* dma currently in progress */
 547         u8      dma;                    /* atapi dma flag */
 548
 549         u8      quirk_list;     /* considered quirky, set for a specific host */
 550         u8      init_speed;     /* transfer rate set at boot */
 551         u8      current_speed;  /* current transfer rate set */
 552         u8      desired_speed;  /* desired transfer rate set */
 553         u8      dn;             /* now wide spread use */
 554         u8      acoustic;       /* acoustic management */
 555         u8      media;          /* disk, cdrom, tape, floppy, ... */
 556         u8      ready_stat;     /* min status value for drive ready */
 557         u8      mult_count;     /* current multiple sector setting */
 558         u8      mult_req;       /* requested multiple sector setting */
 559         u8      io_32bit;       /* 0=16-bit, 1=32-bit, 2/3=32bit+sync */
 560         u8      bad_wstat;      /* used for ignoring ATA_DF */
 561         u8      head;           /* "real" number of heads */
 562         u8      sect;           /* "real" sectors per track */
 563         u8      bios_head;      /* BIOS/fdisk/LILO number of heads */
 564         u8      bios_sect;      /* BIOS/fdisk/LILO sectors per track */
 565
 566         /* delay this long before sending packet command */
 567         u8 pc_delay;
 568
 569         unsigned int    bios_cyl;       /* BIOS/fdisk/LILO number of cyls */
 570         unsigned int    cyl;            /* "real" number of cyls */
 571         unsigned int    drive_data;     /* used by set_pio_mode/dev_select() */
 572         unsigned int    failures;       /* current failure count */
 573         unsigned int    max_failures;   /* maximum allowed failure count */
 574         u64             probed_capacity;/* initial/native media capacity */
 575         u64             capacity64;     /* total number of sectors */
 576
 577         int             lun;            /* logical unit */
 578         int             crc_count;      /* crc counter to reduce drive speed */
 579
 580         unsigned long   debug_mask;     /* debugging levels switch */
 581
 582 #ifdef CONFIG_BLK_DEV_IDEACPI
 583         struct ide_acpi_drive_link *acpidata;
 584 #endif
 585         struct list_head list;
 586         struct device   gendev;
 587         struct completion gendev_rel_comp;      /* to deal with device release() */
 588
 589         /* current packet command */
 590         struct ide_atapi_pc *pc;
 591
 592         /* last failed packet command */
 593         struct ide_atapi_pc *failed_pc;
 594
 595         /* callback for packet commands */
 596         int  (*pc_callback)(struct ide_drive_s *, int);
 597
 598         void (*pc_update_buffers)(struct ide_drive_s *, struct ide_atapi_pc *);
 599         int  (*pc_io_buffers)(struct ide_drive_s *, struct ide_atapi_pc *,
 600                               unsigned int, int);
 601
 602         ide_startstop_t (*irq_handler)(struct ide_drive_s *);
 603
 604         unsigned long atapi_flags;
 605
 606         struct ide_atapi_pc request_sense_pc;
 607         struct request request_sense_rq;
 608 };
 609
 610 typedef struct ide_drive_s ide_drive_t;
 611
 612 #define to_ide_device(dev)              container_of(dev, ide_drive_t, gendev)
 613
 614 #define to_ide_drv(obj, cont_type)      \
 615         container_of(obj, struct cont_type, dev)
 616
 617 #define ide_drv_g(disk, cont_type)      \
 618         container_of((disk)->private_data, struct cont_type, driver)
 619
 620 struct ide_port_info;
 621
 622 struct ide_tp_ops {
 623         void    (*exec_command)(struct hwif_s *, u8);
 624         u8      (*read_status)(struct hwif_s *);
 625         u8      (*read_altstatus)(struct hwif_s *);
 626         void    (*write_devctl)(struct hwif_s *, u8);
 627
 628         void    (*dev_select)(ide_drive_t *);
 629         void    (*tf_load)(ide_drive_t *, struct ide_taskfile *, u8);
 630         void    (*tf_read)(ide_drive_t *, struct ide_taskfile *, u8);
 631
 632         void    (*input_data)(ide_drive_t *, struct ide_cmd *,
 633                               void *, unsigned int);
 634         void    (*output_data)(ide_drive_t *, struct ide_cmd *,
 635                                void *, unsigned int);
 636 };
 637
 638 extern const struct ide_tp_ops default_tp_ops;
 639
 640 /**
 641  * struct ide_port_ops - IDE port operations
 642  *
 643  * @init_dev:           host specific initialization of a device
 644  * @set_pio_mode:       routine to program host for PIO mode
 645  * @set_dma_mode:       routine to program host for DMA mode
 646  * @reset_poll:         chipset polling based on hba specifics
 647  * @pre_reset:          chipset specific changes to default for device-hba resets
 648  * @resetproc:          routine to reset controller after a disk reset
 649  * @maskproc:           special host masking for drive selection
 650  * @quirkproc:          check host's drive quirk list
 651  * @clear_irq:          clear IRQ
 652  *
 653  * @mdma_filter:        filter MDMA modes
 654  * @udma_filter:        filter UDMA modes
 655  *
 656  * @cable_detect:       detect cable type
 657  */
 658 struct ide_port_ops {
 659         void    (*init_dev)(ide_drive_t *);
 660         void    (*set_pio_mode)(ide_drive_t *, const u8);
 661         void    (*set_dma_mode)(ide_drive_t *, const u8);
 662         int     (*reset_poll)(ide_drive_t *);
 663         void    (*pre_reset)(ide_drive_t *);
 664         void    (*resetproc)(ide_drive_t *);
 665         void    (*maskproc)(ide_drive_t *, int);
 666         void    (*quirkproc)(ide_drive_t *);
 667         void    (*clear_irq)(ide_drive_t *);
 668
 669         u8      (*mdma_filter)(ide_drive_t *);
 670         u8      (*udma_filter)(ide_drive_t *);
 671
 672         u8      (*cable_detect)(struct hwif_s *);
 673 };
 674
 675 struct ide_dma_ops {
 676         void    (*dma_host_set)(struct ide_drive_s *, int);
 677         int     (*dma_setup)(struct ide_drive_s *, struct ide_cmd *);
 678         void    (*dma_start)(struct ide_drive_s *);
 679         int     (*dma_end)(struct ide_drive_s *);
 680         int     (*dma_test_irq)(struct ide_drive_s *);
 681         void    (*dma_lost_irq)(struct ide_drive_s *);
 682         /* below ones are optional */
 683         int     (*dma_check)(struct ide_drive_s *, struct ide_cmd *);
 684         int     (*dma_timer_expiry)(struct ide_drive_s *);
 685         void    (*dma_clear)(struct ide_drive_s *);
 686         /*
 687          * The following method is optional and only required to be
 688          * implemented for the SFF-8038i compatible controllers.
 689          */
 690         u8      (*dma_sff_read_status)(struct hwif_s *);
 691 };
 692
 693 struct ide_host;
 694
 695 typedef struct hwif_s {
 696         struct hwif_s *mate;            /* other hwif from same PCI chip */
 697         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
 698
 699         struct ide_host *host;
 700
 701         char name[6];                   /* name of interface, eg. "ide0" */
 702
 703         struct ide_io_ports     io_ports;
 704
 705         unsigned long   sata_scr[SATA_NR_PORTS];
 706
 707         ide_drive_t     *devices[MAX_DRIVES + 1];
 708
 709         u8 major;       /* our major number */
 710         u8 index;       /* 0 for ide0; 1 for ide1; ... */
 711         u8 channel;     /* for dual-port chips: 0=primary, 1=secondary */
 712
 713         u32 host_flags;
 714
 715         u8 pio_mask;
 716
 717         u8 ultra_mask;
 718         u8 mwdma_mask;
 719         u8 swdma_mask;
 720
 721         u8 cbl;         /* cable type */
 722
 723         hwif_chipset_t chipset; /* sub-module for tuning.. */
 724
 725         struct device *dev;
 726
 727         ide_ack_intr_t *ack_intr;
 728
 729         void (*rw_disk)(ide_drive_t *, struct request *);
 730
 731         const struct ide_tp_ops         *tp_ops;
 732         const struct ide_port_ops       *port_ops;
 733         const struct ide_dma_ops        *dma_ops;
 734
 735         /* dma physical region descriptor table (cpu view) */
 736         unsigned int    *dmatable_cpu;
 737         /* dma physical region descriptor table (dma view) */
 738         dma_addr_t      dmatable_dma;
 739
 740         /* maximum number of PRD table entries */
 741         int prd_max_nents;
 742         /* PRD entry size in bytes */
 743         int prd_ent_size;
 744
 745         /* Scatter-gather list used to build the above */
 746         struct scatterlist *sg_table;
 747         int sg_max_nents;               /* Maximum number of entries in it */
 748
 749         struct ide_cmd cmd;             /* current command */
 750
 751         int             rqsize;         /* max sectors per request */
 752         int             irq;            /* our irq number */
 753
 754         unsigned long   dma_base;       /* base addr for dma ports */
 755
 756         unsigned long   config_data;    /* for use by chipset-specific code */
 757         unsigned long   select_data;    /* for use by chipset-specific code */
 758
 759         unsigned long   extra_base;     /* extra addr for dma ports */
 760         unsigned        extra_ports;    /* number of extra dma ports */
 761
 762         unsigned        present    : 1; /* this interface exists */
 763         unsigned        busy       : 1; /* serializes devices on a port */
 764
 765         struct device           gendev;
 766         struct device           *portdev;
 767
 768         struct completion gendev_rel_comp; /* To deal with device release() */
 769
 770         void            *hwif_data;     /* extra hwif data */
 771
 772 #ifdef CONFIG_BLK_DEV_IDEACPI
 773         struct ide_acpi_hwif_link *acpidata;
 774 #endif
 775
 776         /* IRQ handler, if active */
 777         ide_startstop_t (*handler)(ide_drive_t *);
 778
 779         /* BOOL: polling active & poll_timeout field valid */
 780         unsigned int polling : 1;
 781
 782         /* current drive */
 783         ide_drive_t *cur_dev;
 784
 785         /* current request */
 786         struct request *rq;
 787
 788         /* failsafe timer */
 789         struct timer_list timer;
 790         /* timeout value during long polls */
 791         unsigned long poll_timeout;
 792         /* queried upon timeouts */
 793         int (*expiry)(ide_drive_t *);
 794
 795         int req_gen;
 796         int req_gen_timer;
 797
 798         spinlock_t lock;
 799 } ____cacheline_internodealigned_in_smp ide_hwif_t;
 800
 801 #define MAX_HOST_PORTS 4
 802
 803 struct ide_host {
 804         ide_hwif_t      *ports[MAX_HOST_PORTS + 1];
 805         unsigned int    n_ports;
 806         struct device   *dev[2];
 807
 808         int             (*init_chipset)(struct pci_dev *);
 809
 810         void            (*get_lock)(irq_handler_t, void *);
 811         void            (*release_lock)(void);
 812
 813         irq_handler_t   irq_handler;
 814
 815         unsigned long   host_flags;
 816
 817         int             irq_flags;
 818
 819         void            *host_priv;
 820         ide_hwif_t      *cur_port;      /* for hosts requiring serialization */
 821
 822         /* used for hosts requiring serialization */
 823         volatile unsigned long  host_busy;
 824 };
 825
 826 #define IDE_HOST_BUSY 0
 827
 828 /*
 829  *  internal ide interrupt handler type
 830  */
 831 typedef ide_startstop_t (ide_handler_t)(ide_drive_t *);
 832 typedef int (ide_expiry_t)(ide_drive_t *);
 833
 834 /* used by ide-cd, ide-floppy, etc. */
 835 typedef void (xfer_func_t)(ide_drive_t *, struct ide_cmd *, void *, unsigned);
 836
 837 extern struct mutex ide_setting_mtx;
 838
 839 /*
 840  * configurable drive settings
 841  */
 842
 843 #define DS_SYNC (1 << 0)
 844
 845 struct ide_devset {
 846         int             (*get)(ide_drive_t *);
 847         int             (*set)(ide_drive_t *, int);
 848         unsigned int    flags;
 849 };
 850
 851 #define __DEVSET(_flags, _get, _set) { \
 852         .flags  = _flags, \
 853         .get    = _get, \
 854         .set    = _set, \
 855 }
 856
 857 #define ide_devset_get(name, field) \
 858 static int get_##name(ide_drive_t *drive) \
 859 { \
 860         return drive->field; \
 861 }
 862
 863 #define ide_devset_set(name, field) \
 864 static int set_##name(ide_drive_t *drive, int arg) \
 865 { \
 866         drive->field = arg; \
 867         return 0; \
 868 }
 869
 870 #define ide_devset_get_flag(name, flag) \
 871 static int get_##name(ide_drive_t *drive) \
 872 { \
 873         return !!(drive->dev_flags & flag); \
 874 }
 875
 876 #define ide_devset_set_flag(name, flag) \
 877 static int set_##name(ide_drive_t *drive, int arg) \
 878 { \
 879         if (arg) \
 880                 drive->dev_flags |= flag; \
 881         else \
 882                 drive->dev_flags &= ~flag; \
 883         return 0; \
 884 }
 885
 886 #define __IDE_DEVSET(_name, _flags, _get, _set) \
 887 const struct ide_devset ide_devset_##_name = \
 888         __DEVSET(_flags, _get, _set)
 889
 890 #define IDE_DEVSET(_name, _flags, _get, _set) \
 891 static __IDE_DEVSET(_name, _flags, _get, _set)
 892
 893 #define ide_devset_rw(_name, _func) \
 894 IDE_DEVSET(_name, 0, get_##_func, set_##_func)
 895
 896 #define ide_devset_w(_name, _func) \
 897 IDE_DEVSET(_name, 0, NULL, set_##_func)
 898
 899 #define ide_ext_devset_rw(_name, _func) \
 900 __IDE_DEVSET(_name, 0, get_##_func, set_##_func)
 901
 902 #define ide_ext_devset_rw_sync(_name, _func) \
 903 __IDE_DEVSET(_name, DS_SYNC, get_##_func, set_##_func)
 904
 905 #define ide_decl_devset(_name) \
 906 extern const struct ide_devset ide_devset_##_name
 907
 908 ide_decl_devset(io_32bit);
 909 ide_decl_devset(keepsettings);
 910 ide_decl_devset(pio_mode);
 911 ide_decl_devset(unmaskirq);
 912 ide_decl_devset(using_dma);
 913
 914 #ifdef CONFIG_IDE_PROC_FS
 915 /*
 916  * /proc/ide interface
 917  */
 918
 919 #define ide_devset_rw_field(_name, _field) \
 920 ide_devset_get(_name, _field); \
 921 ide_devset_set(_name, _field); \
 922 IDE_DEVSET(_name, DS_SYNC, get_##_name, set_##_name)
 923
 924 #define ide_devset_rw_flag(_name, _field) \
 925 ide_devset_get_flag(_name, _field); \
 926 ide_devset_set_flag(_name, _field); \
 927 IDE_DEVSET(_name, DS_SYNC, get_##_name, set_##_name)
 928
 929 struct ide_proc_devset {
 930         const char              *name;
 931         const struct ide_devset *setting;
 932         int                     min, max;
 933         int                     (*mulf)(ide_drive_t *);
 934         int                     (*divf)(ide_drive_t *);
 935 };
 936
 937 #define __IDE_PROC_DEVSET(_name, _min, _max, _mulf, _divf) { \
 938         .name = __stringify(_name), \
 939         .setting = &ide_devset_##_name, \
 940         .min = _min, \
 941         .max = _max, \
 942         .mulf = _mulf, \
 943         .divf = _divf, \
 944 }
 945
 946 #define IDE_PROC_DEVSET(_name, _min, _max) \
 947 __IDE_PROC_DEVSET(_name, _min, _max, NULL, NULL)
 948
 949 typedef struct {
 950         const char      *name;
 951         mode_t          mode;
 952         read_proc_t     *read_proc;
 953         write_proc_t    *write_proc;
 954 } ide_proc_entry_t;
 955
 956 void proc_ide_create(void);
 957 void proc_ide_destroy(void);
 958 void ide_proc_register_port(ide_hwif_t *);
 959 void ide_proc_port_register_devices(ide_hwif_t *);
 960 void ide_proc_unregister_device(ide_drive_t *);
 961 void ide_proc_unregister_port(ide_hwif_t *);
 962 void ide_proc_register_driver(ide_drive_t *, struct ide_driver *);
 963 void ide_proc_unregister_driver(ide_drive_t *, struct ide_driver *);
 964
 965 read_proc_t proc_ide_read_capacity;
 966 read_proc_t proc_ide_read_geometry;
 967
 968 /*
 969  * Standard exit stuff:
 970  */
 971 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) \
 972 {                                       \
 973         len -= off;                     \
 974         if (len < count) {              \
 975                 *eof = 1;               \
 976                 if (len <= 0)           \
 977                         return 0;       \
 978         } else                          \
 979                 len = count;            \
 980         *start = page + off;            \
 981         return len;                     \
 982 }
 983 #else
 984 static inline void proc_ide_create(void) { ; }
 985 static inline void proc_ide_destroy(void) { ; }
 986 static inline void ide_proc_register_port(ide_hwif_t *hwif) { ; }
 987 static inline void ide_proc_port_register_devices(ide_hwif_t *hwif) { ; }
 988 static inline void ide_proc_unregister_device(ide_drive_t *drive) { ; }
 989 static inline void ide_proc_unregister_port(ide_hwif_t *hwif) { ; }
 990 static inline void ide_proc_register_driver(ide_drive_t *drive,
 991                                             struct ide_driver *driver) { ; }
 992 static inline void ide_proc_unregister_driver(ide_drive_t *drive,
 993                                               struct ide_driver *driver) { ; }
 994 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) return 0;
 995 #endif
 996
 997 enum {
 998         /* enter/exit functions */
 999         IDE_DBG_FUNC =                  (1 << 0),
1000         /* sense key/asc handling */
1001         IDE_DBG_SENSE =                 (1 << 1),
1002         /* packet commands handling */
1003         IDE_DBG_PC =                    (1 << 2),
1004         /* request handling */
1005         IDE_DBG_RQ =                    (1 << 3),
1006         /* driver probing/setup */
1007         IDE_DBG_PROBE =                 (1 << 4),
1008 };
1009
1010 /* DRV_NAME has to be defined in the driver before using the macro below */
1011 #define __ide_debug_log(lvl, fmt, args...)                              \
1012 {                                                                       \
1013         if (unlikely(drive->debug_mask & lvl))                          \
1014                 printk(KERN_INFO DRV_NAME ": %s: " fmt "\n",            \
1015                                           __func__, ## args);           \
1016 }
1017
1018 /*
1019  * Power Management state machine (rq->pm->pm_step).
1020  *
1021  * For each step, the core calls ide_start_power_step() first.
1022  * This can return:
1023  *      - ide_stopped : In this case, the core calls us back again unless
1024  *                      step have been set to ide_power_state_completed.
1025  *      - ide_started : In this case, the channel is left busy until an
1026  *                      async event (interrupt) occurs.
1027  * Typically, ide_start_power_step() will issue a taskfile request with
1028  * do_rw_taskfile().
1029  *
1030  * Upon reception of the interrupt, the core will call ide_complete_power_step()
1031  * with the error code if any. This routine should update the step value
1032  * and return. It should not start a new request. The core will call
1033  * ide_start_power_step() for the new step value, unless step have been
1034  * set to IDE_PM_COMPLETED.
1035  */
1036 enum {
1037         IDE_PM_START_SUSPEND,
1038         IDE_PM_FLUSH_CACHE      = IDE_PM_START_SUSPEND,
1039         IDE_PM_STANDBY,
1040
1041         IDE_PM_START_RESUME,
1042         IDE_PM_RESTORE_PIO      = IDE_PM_START_RESUME,
1043         IDE_PM_IDLE,
1044         IDE_PM_RESTORE_DMA,
1045
1046         IDE_PM_COMPLETED,
1047 };
1048
1049 int generic_ide_suspend(struct device *, pm_message_t);
1050 int generic_ide_resume(struct device *);
1051
1052 void ide_complete_power_step(ide_drive_t *, struct request *);
1053 ide_startstop_t ide_start_power_step(ide_drive_t *, struct request *);
1054 void ide_complete_pm_rq(ide_drive_t *, struct request *);
1055 void ide_check_pm_state(ide_drive_t *, struct request *);
1056
1057 /*
1058  * Subdrivers support.
1059  *
1060  * The gendriver.owner field should be set to the module owner of this driver.
1061  * The gendriver.name field should be set to the name of this driver
1062  */
1063 struct ide_driver {
1064         const char                      *version;
1065         ide_startstop_t (*do_request)(ide_drive_t *, struct request *, sector_t);
1066         struct device_driver    gen_driver;
1067         int             (*probe)(ide_drive_t *);
1068         void            (*remove)(ide_drive_t *);
1069         void            (*resume)(ide_drive_t *);
1070         void            (*shutdown)(ide_drive_t *);
1071 #ifdef CONFIG_IDE_PROC_FS
1072         ide_proc_entry_t *              (*proc_entries)(ide_drive_t *);
1073         const struct ide_proc_devset *  (*proc_devsets)(ide_drive_t *);
1074 #endif
1075 };
1076
1077 #define to_ide_driver(drv) container_of(drv, struct ide_driver, gen_driver)
1078
1079 int ide_device_get(ide_drive_t *);
1080 void ide_device_put(ide_drive_t *);
1081
1082 struct ide_ioctl_devset {
1083         unsigned int    get_ioctl;
1084         unsigned int    set_ioctl;
1085         const struct ide_devset *setting;
1086 };
1087
1088 int ide_setting_ioctl(ide_drive_t *, struct block_device *, unsigned int,
1089                       unsigned long, const struct ide_ioctl_devset *);
1090
1091 int generic_ide_ioctl(ide_drive_t *, struct block_device *, unsigned, unsigned long);
1092
1093 extern int ide_vlb_clk;
1094 extern int ide_pci_clk;
1095
1096 unsigned int ide_rq_bytes(struct request *);
1097 int ide_end_rq(ide_drive_t *, struct request *, int, unsigned int);
1098 void ide_kill_rq(ide_drive_t *, struct request *);
1099
1100 void __ide_set_handler(ide_drive_t *, ide_handler_t *, unsigned int);
1101 void ide_set_handler(ide_drive_t *, ide_handler_t *, unsigned int);
1102
1103 void ide_execute_command(ide_drive_t *, struct ide_cmd *, ide_handler_t *,
1104                          unsigned int);
1105
1106 void ide_pad_transfer(ide_drive_t *, int, int);
1107
1108 ide_startstop_t ide_error(ide_drive_t *, const char *, u8);
1109
1110 void ide_fix_driveid(u16 *);
1111
1112 extern void ide_fixstring(u8 *, const int, const int);
1113
1114 int ide_busy_sleep(ide_drive_t *, unsigned long, int);
1115
1116 int ide_wait_stat(ide_startstop_t *, ide_drive_t *, u8, u8, unsigned long);
1117
1118 ide_startstop_t ide_do_park_unpark(ide_drive_t *, struct request *);
1119 ide_startstop_t ide_do_devset(ide_drive_t *, struct request *);
1120
1121 extern ide_startstop_t ide_do_reset (ide_drive_t *);
1122
1123 extern int ide_devset_execute(ide_drive_t *drive,
1124                               const struct ide_devset *setting, int arg);
1125
1126 void ide_complete_cmd(ide_drive_t *, struct ide_cmd *, u8, u8);
1127 int ide_complete_rq(ide_drive_t *, int, unsigned int);
1128
1129 void ide_tf_readback(ide_drive_t *drive, struct ide_cmd *cmd);
1130 void ide_tf_dump(const char *, struct ide_cmd *);
1131
1132 void ide_exec_command(ide_hwif_t *, u8);
1133 u8 ide_read_status(ide_hwif_t *);
1134 u8 ide_read_altstatus(ide_hwif_t *);
1135 void ide_write_devctl(ide_hwif_t *, u8);
1136
1137 void ide_dev_select(ide_drive_t *);
1138 void ide_tf_load(ide_drive_t *, struct ide_taskfile *, u8);
1139 void ide_tf_read(ide_drive_t *, struct ide_taskfile *, u8);
1140
1141 void ide_input_data(ide_drive_t *, struct ide_cmd *, void *, unsigned int);
1142 void ide_output_data(ide_drive_t *, struct ide_cmd *, void *, unsigned int);
1143
1144 void SELECT_MASK(ide_drive_t *, int);
1145
1146 u8 ide_read_error(ide_drive_t *);
1147 void ide_read_bcount_and_ireason(ide_drive_t *, u16 *, u8 *);
1148
1149 int ide_check_atapi_device(ide_drive_t *, const char *);
1150
1151 void ide_init_pc(struct ide_atapi_pc *);
1152
1153 /* Disk head parking */
1154 extern wait_queue_head_t ide_park_wq;
1155 ssize_t ide_park_show(struct device *dev, struct device_attribute *attr,
1156                       char *buf);
1157 ssize_t ide_park_store(struct device *dev, struct device_attribute *attr,
1158                        const char *buf, size_t len);
1159
1160 /*
1161  * Special requests for ide-tape block device strategy routine.
1162  *
1163  * In order to service a character device command, we add special requests to
1164  * the tail of our block device request queue and wait for their completion.
1165  */
1166 enum {
1167         REQ_IDETAPE_PC1         = (1 << 0), /* packet command (first stage) */
1168         REQ_IDETAPE_PC2         = (1 << 1), /* packet command (second stage) */
1169         REQ_IDETAPE_READ        = (1 << 2),
1170         REQ_IDETAPE_WRITE       = (1 << 3),
1171 };
1172
1173 int ide_queue_pc_tail(ide_drive_t *, struct gendisk *, struct ide_atapi_pc *);
1174
1175 int ide_do_test_unit_ready(ide_drive_t *, struct gendisk *);
1176 int ide_do_start_stop(ide_drive_t *, struct gendisk *, int);
1177 int ide_set_media_lock(ide_drive_t *, struct gendisk *, int);
1178 void ide_create_request_sense_cmd(ide_drive_t *, struct ide_atapi_pc *);
1179 void ide_retry_pc(ide_drive_t *, struct gendisk *);
1180
1181 int ide_cd_expiry(ide_drive_t *);
1182
1183 int ide_cd_get_xferlen(struct request *);
1184
1185 ide_startstop_t ide_issue_pc(ide_drive_t *, struct ide_cmd *);
1186
1187 ide_startstop_t do_rw_taskfile(ide_drive_t *, struct ide_cmd *);
1188
1189 void ide_pio_bytes(ide_drive_t *, struct ide_cmd *, unsigned int, unsigned int);
1190
1191 void ide_finish_cmd(ide_drive_t *, struct ide_cmd *, u8);
1192
1193 int ide_raw_taskfile(ide_drive_t *, struct ide_cmd *, u8 *, u16);
1194 int ide_no_data_taskfile(ide_drive_t *, struct ide_cmd *);
1195
1196 int ide_taskfile_ioctl(ide_drive_t *, unsigned long);
1197
1198 int ide_dev_read_id(ide_drive_t *, u8, u16 *);
1199
1200 extern int ide_driveid_update(ide_drive_t *);
1201 extern int ide_config_drive_speed(ide_drive_t *, u8);
1202 extern u8 eighty_ninty_three (ide_drive_t *);
1203 extern int taskfile_lib_get_identify(ide_drive_t *drive, u8 *);
1204
1205 extern int ide_wait_not_busy(ide_hwif_t *hwif, unsigned long timeout);
1206
1207 extern void ide_stall_queue(ide_drive_t *drive, unsigned long timeout);
1208
1209 extern void ide_timer_expiry(unsigned long);
1210 extern irqreturn_t ide_intr(int irq, void *dev_id);
1211 extern void do_ide_request(struct request_queue *);
1212
1213 void ide_init_disk(struct gendisk *, ide_drive_t *);
1214
1215 #ifdef CONFIG_IDEPCI_PCIBUS_ORDER
1216 extern int __ide_pci_register_driver(struct pci_driver *driver, struct module *owner, const char *mod_name);
1217 #define ide_pci_register_driver(d) __ide_pci_register_driver(d, THIS_MODULE, KBUILD_MODNAME)
1218 #else
1219 #define ide_pci_register_driver(d) pci_register_driver(d)
1220 #endif
1221
1222 static inline int ide_pci_is_in_compatibility_mode(struct pci_dev *dev)
1223 {
1224         if ((dev->class >> 8) == PCI_CLASS_STORAGE_IDE && (dev->class & 5) != 5)
1225                 return 1;
1226         return 0;
1227 }
1228
1229 void ide_pci_setup_ports(struct pci_dev *, const struct ide_port_info *,
1230                          hw_regs_t *, hw_regs_t **);
1231 void ide_setup_pci_noise(struct pci_dev *, const struct ide_port_info *);
1232
1233 #ifdef CONFIG_BLK_DEV_IDEDMA_PCI
1234 int ide_pci_set_master(struct pci_dev *, const char *);
1235 unsigned long ide_pci_dma_base(ide_hwif_t *, const struct ide_port_info *);
1236 int ide_pci_check_simplex(ide_hwif_t *, const struct ide_port_info *);
1237 int ide_hwif_setup_dma(ide_hwif_t *, const struct ide_port_info *);
1238 #else
1239 static inline int ide_hwif_setup_dma(ide_hwif_t *hwif,
1240                                      const struct ide_port_info *d)
1241 {
1242         return -EINVAL;
1243 }
1244 #endif
1245
1246 struct ide_pci_enablebit {
1247         u8      reg;    /* byte pci reg holding the enable-bit */
1248         u8      mask;   /* mask to isolate the enable-bit */
1249         u8      val;    /* value of masked reg when "enabled" */
1250 };
1251
1252 enum {
1253         /* Uses ISA control ports not PCI ones. */
1254         IDE_HFLAG_ISA_PORTS             = (1 << 0),
1255         /* single port device */
1256         IDE_HFLAG_SINGLE                = (1 << 1),
1257         /* don't use legacy PIO blacklist */
1258         IDE_HFLAG_PIO_NO_BLACKLIST      = (1 << 2),
1259         /* set for the second port of QD65xx */
1260         IDE_HFLAG_QD_2ND_PORT           = (1 << 3),
1261         /* use PIO8/9 for prefetch off/on */
1262         IDE_HFLAG_ABUSE_PREFETCH        = (1 << 4),
1263         /* use PIO6/7 for fast-devsel off/on */
1264         IDE_HFLAG_ABUSE_FAST_DEVSEL     = (1 << 5),
1265         /* use 100-102 and 200-202 PIO values to set DMA modes */
1266         IDE_HFLAG_ABUSE_DMA_MODES       = (1 << 6),
1267         /*
1268          * keep DMA setting when programming PIO mode, may be used only
1269          * for hosts which have separate PIO and DMA timings (ie. PMAC)
1270          */
1271         IDE_HFLAG_SET_PIO_MODE_KEEP_DMA = (1 << 7),
1272         /* program host for the transfer mode after programming device */
1273         IDE_HFLAG_POST_SET_MODE         = (1 << 8),
1274         /* don't program host/device for the transfer mode ("smart" hosts) */
1275         IDE_HFLAG_NO_SET_MODE           = (1 << 9),
1276         /* trust BIOS for programming chipset/device for DMA */
1277         IDE_HFLAG_TRUST_BIOS_FOR_DMA    = (1 << 10),
1278         /* host is CS5510/CS5520 */
1279         IDE_HFLAG_CS5520                = (1 << 11),
1280         /* ATAPI DMA is unsupported */
1281         IDE_HFLAG_NO_ATAPI_DMA          = (1 << 12),
1282         /* set if host is a "non-bootable" controller */
1283         IDE_HFLAG_NON_BOOTABLE          = (1 << 13),
1284         /* host doesn't support DMA */
1285         IDE_HFLAG_NO_DMA                = (1 << 14),
1286         /* check if host is PCI IDE device before allowing DMA */
1287         IDE_HFLAG_NO_AUTODMA            = (1 << 15),
1288         /* host uses MMIO */
1289         IDE_HFLAG_MMIO                  = (1 << 16),
1290         /* no LBA48 */
1291         IDE_HFLAG_NO_LBA48              = (1 << 17),
1292         /* no LBA48 DMA */
1293         IDE_HFLAG_NO_LBA48_DMA          = (1 << 18),
1294         /* data FIFO is cleared by an error */
1295         IDE_HFLAG_ERROR_STOPS_FIFO      = (1 << 19),
1296         /* serialize ports */
1297         IDE_HFLAG_SERIALIZE             = (1 << 20),
1298         /* host is DTC2278 */
1299         IDE_HFLAG_DTC2278               = (1 << 21),
1300         /* 4 devices on a single set of I/O ports */
1301         IDE_HFLAG_4DRIVES               = (1 << 22),
1302         /* host is TRM290 */
1303         IDE_HFLAG_TRM290                = (1 << 23),
1304         /* use 32-bit I/O ops */
1305         IDE_HFLAG_IO_32BIT              = (1 << 24),
1306         /* unmask IRQs */
1307         IDE_HFLAG_UNMASK_IRQS           = (1 << 25),
1308         IDE_HFLAG_BROKEN_ALTSTATUS      = (1 << 26),
1309         /* serialize ports if DMA is possible (for sl82c105) */
1310         IDE_HFLAG_SERIALIZE_DMA         = (1 << 27),
1311         /* force host out of "simplex" mode */
1312         IDE_HFLAG_CLEAR_SIMPLEX         = (1 << 28),
1313         /* DSC overlap is unsupported */
1314         IDE_HFLAG_NO_DSC                = (1 << 29),
1315         /* never use 32-bit I/O ops */
1316         IDE_HFLAG_NO_IO_32BIT           = (1 << 30),
1317         /* never unmask IRQs */
1318         IDE_HFLAG_NO_UNMASK_IRQS        = (1 << 31),
1319 };
1320
1321 #ifdef CONFIG_BLK_DEV_OFFBOARD
1322 # define IDE_HFLAG_OFF_BOARD    0
1323 #else
1324 # define IDE_HFLAG_OFF_BOARD    IDE_HFLAG_NON_BOOTABLE
1325 #endif
1326
1327 struct ide_port_info {
1328         char                    *name;
1329
1330         int                     (*init_chipset)(struct pci_dev *);
1331
1332         void                    (*get_lock)(irq_handler_t, void *);
1333         void                    (*release_lock)(void);
1334
1335         void                    (*init_iops)(ide_hwif_t *);
1336         void                    (*init_hwif)(ide_hwif_t *);
1337         int                     (*init_dma)(ide_hwif_t *,
1338                                             const struct ide_port_info *);
1339
1340         const struct ide_tp_ops         *tp_ops;
1341         const struct ide_port_ops       *port_ops;
1342         const struct ide_dma_ops        *dma_ops;
1343
1344         struct ide_pci_enablebit        enablebits[2];
1345
1346         hwif_chipset_t          chipset;
1347
1348         u16                     max_sectors;    /* if < than the default one */
1349
1350         u32                     host_flags;
1351
1352         int                     irq_flags;
1353
1354         u8                      pio_mask;
1355         u8                      swdma_mask;
1356         u8                      mwdma_mask;
1357         u8                      udma_mask;
1358 };
1359
1360 int ide_pci_init_one(struct pci_dev *, const struct ide_port_info *, void *);
1361 int ide_pci_init_two(struct pci_dev *, struct pci_dev *,
1362                      const struct ide_port_info *, void *);
1363 void ide_pci_remove(struct pci_dev *);
1364
1365 #ifdef CONFIG_PM
1366 int ide_pci_suspend(struct pci_dev *, pm_message_t);
1367 int ide_pci_resume(struct pci_dev *);
1368 #else
1369 #define ide_pci_suspend NULL
1370 #define ide_pci_resume NULL
1371 #endif
1372
1373 void ide_map_sg(ide_drive_t *, struct ide_cmd *);
1374 void ide_init_sg_cmd(struct ide_cmd *, unsigned int);
1375
1376 #define BAD_DMA_DRIVE           0
1377 #define GOOD_DMA_DRIVE          1
1378
1379 struct drive_list_entry {
1380         const char *id_model;
1381         const char *id_firmware;
1382 };
1383
1384 int ide_in_drive_list(u16 *, const struct drive_list_entry *);
1385
1386 #ifdef CONFIG_BLK_DEV_IDEDMA
1387 int ide_dma_good_drive(ide_drive_t *);
1388 int __ide_dma_bad_drive(ide_drive_t *);
1389 int ide_id_dma_bug(ide_drive_t *);
1390
1391 u8 ide_find_dma_mode(ide_drive_t *, u8);
1392
1393 static inline u8 ide_max_dma_mode(ide_drive_t *drive)
1394 {
1395         return ide_find_dma_mode(drive, XFER_UDMA_6);
1396 }
1397
1398 void ide_dma_off_quietly(ide_drive_t *);
1399 void ide_dma_off(ide_drive_t *);
1400 void ide_dma_on(ide_drive_t *);
1401 int ide_set_dma(ide_drive_t *);
1402 void ide_check_dma_crc(ide_drive_t *);
1403 ide_startstop_t ide_dma_intr(ide_drive_t *);
1404
1405 int ide_allocate_dma_engine(ide_hwif_t *);
1406 void ide_release_dma_engine(ide_hwif_t *);
1407
1408 int ide_dma_prepare(ide_drive_t *, struct ide_cmd *);
1409 void ide_dma_unmap_sg(ide_drive_t *, struct ide_cmd *);
1410
1411 #ifdef CONFIG_BLK_DEV_IDEDMA_SFF
1412 int config_drive_for_dma(ide_drive_t *);
1413 int ide_build_dmatable(ide_drive_t *, struct ide_cmd *);
1414 void ide_dma_host_set(ide_drive_t *, int);
1415 int ide_dma_setup(ide_drive_t *, struct ide_cmd *);
1416 extern void ide_dma_start(ide_drive_t *);
1417 int ide_dma_end(ide_drive_t *);
1418 int ide_dma_test_irq(ide_drive_t *);
1419 int ide_dma_sff_timer_expiry(ide_drive_t *);
1420 u8 ide_dma_sff_read_status(ide_hwif_t *);
1421 extern const struct ide_dma_ops sff_dma_ops;
1422 #else
1423 static inline int config_drive_for_dma(ide_drive_t *drive) { return 0; }
1424 #endif /* CONFIG_BLK_DEV_IDEDMA_SFF */
1425
1426 void ide_dma_lost_irq(ide_drive_t *);
1427 ide_startstop_t ide_dma_timeout_retry(ide_drive_t *, int);
1428
1429 #else
1430 static inline int ide_id_dma_bug(ide_drive_t *drive) { return 0; }
1431 static inline u8 ide_find_dma_mode(ide_drive_t *drive, u8 speed) { return 0; }
1432 static inline u8 ide_max_dma_mode(ide_drive_t *drive) { return 0; }
1433 static inline void ide_dma_off_quietly(ide_drive_t *drive) { ; }
1434 static inline void ide_dma_off(ide_drive_t *drive) { ; }
1435 static inline void ide_dma_on(ide_drive_t *drive) { ; }
1436 static inline void ide_dma_verbose(ide_drive_t *drive) { ; }
1437 static inline int ide_set_dma(ide_drive_t *drive) { return 1; }
1438 static inline void ide_check_dma_crc(ide_drive_t *drive) { ; }
1439 static inline ide_startstop_t ide_dma_intr(ide_drive_t *drive) { return ide_stopped; }
1440 static inline ide_startstop_t ide_dma_timeout_retry(ide_drive_t *drive, int error) { return ide_stopped; }
1441 static inline void ide_release_dma_engine(ide_hwif_t *hwif) { ; }
1442 static inline int ide_dma_prepare(ide_drive_t *drive,
1443                                   struct ide_cmd *cmd) { return 1; }
1444 static inline void ide_dma_unmap_sg(ide_drive_t *drive,
1445                                     struct ide_cmd *cmd) { ; }
1446 #endif /* CONFIG_BLK_DEV_IDEDMA */
1447
1448 #ifdef CONFIG_BLK_DEV_IDEACPI
1449 int ide_acpi_init(void);
1450 extern int ide_acpi_exec_tfs(ide_drive_t *drive);
1451 extern void ide_acpi_get_timing(ide_hwif_t *hwif);
1452 extern void ide_acpi_push_timing(ide_hwif_t *hwif);
1453 void ide_acpi_init_port(ide_hwif_t *);
1454 void ide_acpi_port_init_devices(ide_hwif_t *);
1455 extern void ide_acpi_set_state(ide_hwif_t *hwif, int on);
1456 #else
1457 static inline int ide_acpi_init(void) { return 0; }
1458 static inline int ide_acpi_exec_tfs(ide_drive_t *drive) { return 0; }
1459 static inline void ide_acpi_get_timing(ide_hwif_t *hwif) { ; }
1460 static inline void ide_acpi_push_timing(ide_hwif_t *hwif) { ; }
1461 static inline void ide_acpi_init_port(ide_hwif_t *hwif) { ; }
1462 static inline void ide_acpi_port_init_devices(ide_hwif_t *hwif) { ; }
1463 static inline void ide_acpi_set_state(ide_hwif_t *hwif, int on) {}
1464 #endif
1465
1466 void ide_register_region(struct gendisk *);
1467 void ide_unregister_region(struct gendisk *);
1468
1469 void ide_undecoded_slave(ide_drive_t *);
1470
1471 void ide_port_apply_params(ide_hwif_t *);
1472 int ide_sysfs_register_port(ide_hwif_t *);
1473
1474 struct ide_host *ide_host_alloc(const struct ide_port_info *, hw_regs_t **);
1475 void ide_host_free(struct ide_host *);
1476 int ide_host_register(struct ide_host *, const struct ide_port_info *,
1477                       hw_regs_t **);
1478 int ide_host_add(const struct ide_port_info *, hw_regs_t **,
1479                  struct ide_host **);
1480 void ide_host_remove(struct ide_host *);
1481 int ide_legacy_device_add(const struct ide_port_info *, unsigned long);
1482 void ide_port_unregister_devices(ide_hwif_t *);
1483 void ide_port_scan(ide_hwif_t *);
1484
1485 static inline void *ide_get_hwifdata (ide_hwif_t * hwif)
1486 {
1487         return hwif->hwif_data;
1488 }
1489
1490 static inline void ide_set_hwifdata (ide_hwif_t * hwif, void *data)
1491 {
1492         hwif->hwif_data = data;
1493 }
1494
1495 extern void ide_toggle_bounce(ide_drive_t *drive, int on);
1496
1497 u64 ide_get_lba_addr(struct ide_cmd *, int);
1498 u8 ide_dump_status(ide_drive_t *, const char *, u8);
1499
1500 struct ide_timing {
1501         u8  mode;
1502         u8  setup;      /* t1 */
1503         u16 act8b;      /* t2 for 8-bit io */
1504         u16 rec8b;      /* t2i for 8-bit io */
1505         u16 cyc8b;      /* t0 for 8-bit io */
1506         u16 active;     /* t2 or tD */
1507         u16 recover;    /* t2i or tK */
1508         u16 cycle;      /* t0 */
1509         u16 udma;       /* t2CYCTYP/2 */
1510 };
1511
1512 enum {
1513         IDE_TIMING_SETUP        = (1 << 0),
1514         IDE_TIMING_ACT8B        = (1 << 1),
1515         IDE_TIMING_REC8B        = (1 << 2),
1516         IDE_TIMING_CYC8B        = (1 << 3),
1517         IDE_TIMING_8BIT         = IDE_TIMING_ACT8B | IDE_TIMING_REC8B |
1518                                   IDE_TIMING_CYC8B,
1519         IDE_TIMING_ACTIVE       = (1 << 4),
1520         IDE_TIMING_RECOVER      = (1 << 5),
1521         IDE_TIMING_CYCLE        = (1 << 6),
1522         IDE_TIMING_UDMA         = (1 << 7),
1523         IDE_TIMING_ALL          = IDE_TIMING_SETUP | IDE_TIMING_8BIT |
1524                                   IDE_TIMING_ACTIVE | IDE_TIMING_RECOVER |
1525                                   IDE_TIMING_CYCLE | IDE_TIMING_UDMA,
1526 };
1527
1528 struct ide_timing *ide_timing_find_mode(u8);
1529 u16 ide_pio_cycle_time(ide_drive_t *, u8);
1530 void ide_timing_merge(struct ide_timing *, struct ide_timing *,
1531                       struct ide_timing *, unsigned int);
1532 int ide_timing_compute(ide_drive_t *, u8, struct ide_timing *, int, int);
1533
1534 #ifdef CONFIG_IDE_XFER_MODE
1535 int ide_scan_pio_blacklist(char *);
1536 const char *ide_xfer_verbose(u8);
1537 u8 ide_get_best_pio_mode(ide_drive_t *, u8, u8);
1538 int ide_set_pio_mode(ide_drive_t *, u8);
1539 int ide_set_dma_mode(ide_drive_t *, u8);
1540 void ide_set_pio(ide_drive_t *, u8);
1541 int ide_set_xfer_rate(ide_drive_t *, u8);
1542 #else
1543 static inline void ide_set_pio(ide_drive_t *drive, u8 pio) { ; }
1544 static inline int ide_set_xfer_rate(ide_drive_t *drive, u8 rate) { return -1; }
1545 #endif
1546
1547 static inline void ide_set_max_pio(ide_drive_t *drive)
1548 {
1549         ide_set_pio(drive, 255);
1550 }
1551
1552 char *ide_media_string(ide_drive_t *);
1553
1554 extern struct device_attribute ide_dev_attrs[];
1555 extern struct bus_type ide_bus_type;
1556 extern struct class *ide_port_class;
1557
1558 static inline void ide_dump_identify(u8 *id)
1559 {
1560         print_hex_dump(KERN_INFO, "", DUMP_PREFIX_NONE, 16, 2, id, 512, 0);
1561 }
1562
1563 static inline int hwif_to_node(ide_hwif_t *hwif)
1564 {
1565         return hwif->dev ? dev_to_node(hwif->dev) : -1;
1566 }
1567
1568 static inline ide_drive_t *ide_get_pair_dev(ide_drive_t *drive)
1569 {
1570         ide_drive_t *peer = drive->hwif->devices[(drive->dn ^ 1) & 1];
1571
1572         return (peer->dev_flags & IDE_DFLAG_PRESENT) ? peer : NULL;
1573 }
1574
1575 #define ide_port_for_each_dev(i, dev, port) \
1576         for ((i) = 0; ((dev) = (port)->devices[i]) || (i) < MAX_DRIVES; (i)++)
1577
1578 #define ide_port_for_each_present_dev(i, dev, port) \
1579         for ((i) = 0; ((dev) = (port)->devices[i]) || (i) < MAX_DRIVES; (i)++) \
1580                 if ((dev)->dev_flags & IDE_DFLAG_PRESENT)
1581
1582 #define ide_host_for_each_port(i, port, host) \
1583         for ((i) = 0; ((port) = (host)->ports[i]) || (i) < MAX_HOST_PORTS; (i)++)
1584
1585 #endif /* _IDE_H */