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