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