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