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