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