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