SAFE public projects git trees. - safe/jmp/linux-2.6/blob - include/linux/ide.h

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