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