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