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