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