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