include/linux/ide.h

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