include/linux/ide.h

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