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 struct ide_drive_s {
 463         char            name[4];        /* drive name, such as "hda" */
 464         char            driver_req[10]; /* requests specific driver */
 465
 466         struct request_queue    *queue; /* request queue */
 467
 468         struct request          *rq;    /* current request */
 469         struct ide_drive_s      *next;  /* circular list of hwgroup drives */
 470         void            *driver_data;   /* extra driver data */
 471         u16                     *id;    /* identification info */
 472 #ifdef CONFIG_IDE_PROC_FS
 473         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
 474         const struct ide_proc_devset *settings; /* /proc/ide/ drive settings */
 475 #endif
 476         struct hwif_s           *hwif;  /* actually (ide_hwif_t *) */
 477
 478         unsigned long sleep;            /* sleep until this time */
 479         unsigned long service_start;    /* time we started last request */
 480         unsigned long service_time;     /* service time of last request */
 481         unsigned long timeout;          /* max time to wait for irq */
 482
 483         special_t       special;        /* special action flags */
 484         select_t        select;         /* basic drive/head select reg value */
 485
 486         u8      retry_pio;              /* retrying dma capable host in pio */
 487         u8      state;                  /* retry state */
 488         u8      waiting_for_dma;        /* dma currently in progress */
 489
 490         unsigned keep_settings  : 1;    /* restore settings after drive reset */
 491         unsigned using_dma      : 1;    /* disk is using dma for read/write */
 492         unsigned unmask         : 1;    /* okay to unmask other irqs */
 493         unsigned noflush        : 1;    /* don't attempt flushes */
 494         unsigned dsc_overlap    : 1;    /* DSC overlap */
 495         unsigned nice1          : 1;    /* give potential excess bandwidth */
 496         unsigned present        : 1;    /* drive is physically present */
 497         unsigned dead           : 1;    /* device ejected hint */
 498         unsigned id_read        : 1;    /* 1=id read from disk 0 = synthetic */
 499         unsigned noprobe        : 1;    /* from:  hdx=noprobe */
 500         unsigned removable      : 1;    /* 1 if need to do check_media_change */
 501         unsigned attach         : 1;    /* needed for removable devices */
 502         unsigned forced_geom    : 1;    /* 1 if hdx=c,h,s was given at boot */
 503         unsigned no_unmask      : 1;    /* disallow setting unmask bit */
 504         unsigned no_io_32bit    : 1;    /* disallow enabling 32bit I/O */
 505         unsigned doorlocking    : 1;    /* for removable only: door lock/unlock works */
 506         unsigned nodma          : 1;    /* disallow DMA */
 507         unsigned blocked        : 1;    /* 1=powermanagment told us not to do anything, so sleep nicely */
 508         unsigned scsi           : 1;    /* 0=default, 1=ide-scsi emulation */
 509         unsigned sleeping       : 1;    /* 1=sleeping & sleep field valid */
 510         unsigned post_reset     : 1;
 511         unsigned udma33_warned  : 1;
 512         unsigned addressing     : 2;    /* 0=28-bit, 1=48-bit, 2=48-bit doing 28-bit */
 513         unsigned wcache         : 1;    /* status of write cache */
 514         unsigned nowerr         : 1;    /* used for ignoring ATA_DF */
 515
 516         u8      quirk_list;     /* considered quirky, set for a specific host */
 517         u8      init_speed;     /* transfer rate set at boot */
 518         u8      current_speed;  /* current transfer rate set */
 519         u8      desired_speed;  /* desired transfer rate set */
 520         u8      dn;             /* now wide spread use */
 521         u8      acoustic;       /* acoustic management */
 522         u8      media;          /* disk, cdrom, tape, floppy, ... */
 523         u8      ready_stat;     /* min status value for drive ready */
 524         u8      mult_count;     /* current multiple sector setting */
 525         u8      mult_req;       /* requested multiple sector setting */
 526         u8      tune_req;       /* requested drive tuning setting */
 527         u8      io_32bit;       /* 0=16-bit, 1=32-bit, 2/3=32bit+sync */
 528         u8      bad_wstat;      /* used for ignoring ATA_DF */
 529         u8      head;           /* "real" number of heads */
 530         u8      sect;           /* "real" sectors per track */
 531         u8      bios_head;      /* BIOS/fdisk/LILO number of heads */
 532         u8      bios_sect;      /* BIOS/fdisk/LILO sectors per track */
 533
 534         /* delay this long before sending packet command */
 535         u8 pc_delay;
 536
 537         unsigned int    bios_cyl;       /* BIOS/fdisk/LILO number of cyls */
 538         unsigned int    cyl;            /* "real" number of cyls */
 539         unsigned int    drive_data;     /* used by set_pio_mode/selectproc */
 540         unsigned int    failures;       /* current failure count */
 541         unsigned int    max_failures;   /* maximum allowed failure count */
 542         u64             probed_capacity;/* initial reported media capacity (ide-cd only currently) */
 543
 544         u64             capacity64;     /* total number of sectors */
 545
 546         int             lun;            /* logical unit */
 547         int             crc_count;      /* crc counter to reduce drive speed */
 548
 549         unsigned long   debug_mask;     /* debugging levels switch */
 550
 551 #ifdef CONFIG_BLK_DEV_IDEACPI
 552         struct ide_acpi_drive_link *acpidata;
 553 #endif
 554         struct list_head list;
 555         struct device   gendev;
 556         struct completion gendev_rel_comp;      /* to deal with device release() */
 557
 558         /* current packet command */
 559         struct ide_atapi_pc *pc;
 560
 561         /* callback for packet commands */
 562         void (*pc_callback)(struct ide_drive_s *, int);
 563
 564         void (*pc_update_buffers)(struct ide_drive_s *, struct ide_atapi_pc *);
 565         int  (*pc_io_buffers)(struct ide_drive_s *, struct ide_atapi_pc *,
 566                               unsigned int, int);
 567
 568         unsigned long atapi_flags;
 569
 570         struct ide_atapi_pc request_sense_pc;
 571         struct request request_sense_rq;
 572 };
 573
 574 typedef struct ide_drive_s ide_drive_t;
 575
 576 #define to_ide_device(dev)              container_of(dev, ide_drive_t, gendev)
 577
 578 #define to_ide_drv(obj, cont_type)      \
 579         container_of(obj, struct cont_type, kref)
 580
 581 #define ide_drv_g(disk, cont_type)      \
 582         container_of((disk)->private_data, struct cont_type, driver)
 583
 584 struct ide_task_s;
 585 struct ide_port_info;
 586
 587 struct ide_tp_ops {
 588         void    (*exec_command)(struct hwif_s *, u8);
 589         u8      (*read_status)(struct hwif_s *);
 590         u8      (*read_altstatus)(struct hwif_s *);
 591         u8      (*read_sff_dma_status)(struct hwif_s *);
 592
 593         void    (*set_irq)(struct hwif_s *, int);
 594
 595         void    (*tf_load)(ide_drive_t *, struct ide_task_s *);
 596         void    (*tf_read)(ide_drive_t *, struct ide_task_s *);
 597
 598         void    (*input_data)(ide_drive_t *, struct request *, void *,
 599                               unsigned int);
 600         void    (*output_data)(ide_drive_t *, struct request *, void *,
 601                                unsigned int);
 602 };
 603
 604 extern const struct ide_tp_ops default_tp_ops;
 605
 606 /**
 607  * struct ide_port_ops - IDE port operations
 608  *
 609  * @init_dev:           host specific initialization of a device
 610  * @set_pio_mode:       routine to program host for PIO mode
 611  * @set_dma_mode:       routine to program host for DMA mode
 612  * @selectproc:         tweaks hardware to select drive
 613  * @reset_poll:         chipset polling based on hba specifics
 614  * @pre_reset:          chipset specific changes to default for device-hba resets
 615  * @resetproc:          routine to reset controller after a disk reset
 616  * @maskproc:           special host masking for drive selection
 617  * @quirkproc:          check host's drive quirk list
 618  *
 619  * @mdma_filter:        filter MDMA modes
 620  * @udma_filter:        filter UDMA modes
 621  *
 622  * @cable_detect:       detect cable type
 623  */
 624 struct ide_port_ops {
 625         void    (*init_dev)(ide_drive_t *);
 626         void    (*set_pio_mode)(ide_drive_t *, const u8);
 627         void    (*set_dma_mode)(ide_drive_t *, const u8);
 628         void    (*selectproc)(ide_drive_t *);
 629         int     (*reset_poll)(ide_drive_t *);
 630         void    (*pre_reset)(ide_drive_t *);
 631         void    (*resetproc)(ide_drive_t *);
 632         void    (*maskproc)(ide_drive_t *, int);
 633         void    (*quirkproc)(ide_drive_t *);
 634
 635         u8      (*mdma_filter)(ide_drive_t *);
 636         u8      (*udma_filter)(ide_drive_t *);
 637
 638         u8      (*cable_detect)(struct hwif_s *);
 639 };
 640
 641 struct ide_dma_ops {
 642         void    (*dma_host_set)(struct ide_drive_s *, int);
 643         int     (*dma_setup)(struct ide_drive_s *);
 644         void    (*dma_exec_cmd)(struct ide_drive_s *, u8);
 645         void    (*dma_start)(struct ide_drive_s *);
 646         int     (*dma_end)(struct ide_drive_s *);
 647         int     (*dma_test_irq)(struct ide_drive_s *);
 648         void    (*dma_lost_irq)(struct ide_drive_s *);
 649         void    (*dma_timeout)(struct ide_drive_s *);
 650 };
 651
 652 struct ide_host;
 653
 654 typedef struct hwif_s {
 655         struct hwif_s *next;            /* for linked-list in ide_hwgroup_t */
 656         struct hwif_s *mate;            /* other hwif from same PCI chip */
 657         struct hwgroup_s *hwgroup;      /* actually (ide_hwgroup_t *) */
 658         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
 659
 660         struct ide_host *host;
 661
 662         char name[6];                   /* name of interface, eg. "ide0" */
 663
 664         struct ide_io_ports     io_ports;
 665
 666         unsigned long   sata_scr[SATA_NR_PORTS];
 667
 668         ide_drive_t     drives[MAX_DRIVES];     /* drive info */
 669
 670         u8 major;       /* our major number */
 671         u8 index;       /* 0 for ide0; 1 for ide1; ... */
 672         u8 channel;     /* for dual-port chips: 0=primary, 1=secondary */
 673
 674         u32 host_flags;
 675
 676         u8 pio_mask;
 677
 678         u8 ultra_mask;
 679         u8 mwdma_mask;
 680         u8 swdma_mask;
 681
 682         u8 cbl;         /* cable type */
 683
 684         hwif_chipset_t chipset; /* sub-module for tuning.. */
 685
 686         struct device *dev;
 687
 688         ide_ack_intr_t *ack_intr;
 689
 690         void (*rw_disk)(ide_drive_t *, struct request *);
 691
 692         const struct ide_tp_ops         *tp_ops;
 693         const struct ide_port_ops       *port_ops;
 694         const struct ide_dma_ops        *dma_ops;
 695
 696         void (*ide_dma_clear_irq)(ide_drive_t *drive);
 697
 698         /* dma physical region descriptor table (cpu view) */
 699         unsigned int    *dmatable_cpu;
 700         /* dma physical region descriptor table (dma view) */
 701         dma_addr_t      dmatable_dma;
 702         /* Scatter-gather list used to build the above */
 703         struct scatterlist *sg_table;
 704         int sg_max_nents;               /* Maximum number of entries in it */
 705         int sg_nents;                   /* Current number of entries in it */
 706         int sg_dma_direction;           /* dma transfer direction */
 707
 708         /* data phase of the active command (currently only valid for PIO/DMA) */
 709         int             data_phase;
 710
 711         unsigned int nsect;
 712         unsigned int nleft;
 713         struct scatterlist *cursg;
 714         unsigned int cursg_ofs;
 715
 716         int             rqsize;         /* max sectors per request */
 717         int             irq;            /* our irq number */
 718
 719         unsigned long   dma_base;       /* base addr for dma ports */
 720
 721         unsigned long   config_data;    /* for use by chipset-specific code */
 722         unsigned long   select_data;    /* for use by chipset-specific code */
 723
 724         unsigned long   extra_base;     /* extra addr for dma ports */
 725         unsigned        extra_ports;    /* number of extra dma ports */
 726
 727         unsigned        present    : 1; /* this interface exists */
 728         unsigned        serialized : 1; /* serialized all channel operation */
 729         unsigned        sharing_irq: 1; /* 1 = sharing irq with another hwif */
 730         unsigned        sg_mapped  : 1; /* sg_table and sg_nents are ready */
 731
 732         struct device           gendev;
 733         struct device           *portdev;
 734
 735         struct completion gendev_rel_comp; /* To deal with device release() */
 736
 737         void            *hwif_data;     /* extra hwif data */
 738
 739         unsigned dma;
 740
 741 #ifdef CONFIG_BLK_DEV_IDEACPI
 742         struct ide_acpi_hwif_link *acpidata;
 743 #endif
 744 } ____cacheline_internodealigned_in_smp ide_hwif_t;
 745
 746 struct ide_host {
 747         ide_hwif_t      *ports[MAX_HWIFS];
 748         unsigned int    n_ports;
 749         struct device   *dev[2];
 750         unsigned int    (*init_chipset)(struct pci_dev *);
 751         unsigned long   host_flags;
 752         void            *host_priv;
 753 };
 754
 755 /*
 756  *  internal ide interrupt handler type
 757  */
 758 typedef ide_startstop_t (ide_handler_t)(ide_drive_t *);
 759 typedef int (ide_expiry_t)(ide_drive_t *);
 760
 761 /* used by ide-cd, ide-floppy, etc. */
 762 typedef void (xfer_func_t)(ide_drive_t *, struct request *rq, void *, unsigned);
 763
 764 typedef struct hwgroup_s {
 765                 /* irq handler, if active */
 766         ide_startstop_t (*handler)(ide_drive_t *);
 767
 768                 /* BOOL: protects all fields below */
 769         volatile int busy;
 770                 /* BOOL: wake us up on timer expiry */
 771         unsigned int sleeping   : 1;
 772                 /* BOOL: polling active & poll_timeout field valid */
 773         unsigned int polling    : 1;
 774
 775                 /* current drive */
 776         ide_drive_t *drive;
 777                 /* ptr to current hwif in linked-list */
 778         ide_hwif_t *hwif;
 779
 780                 /* current request */
 781         struct request *rq;
 782
 783                 /* failsafe timer */
 784         struct timer_list timer;
 785                 /* timeout value during long polls */
 786         unsigned long poll_timeout;
 787                 /* queried upon timeouts */
 788         int (*expiry)(ide_drive_t *);
 789
 790         int req_gen;
 791         int req_gen_timer;
 792 } ide_hwgroup_t;
 793
 794 typedef struct ide_driver_s ide_driver_t;
 795
 796 extern struct mutex ide_setting_mtx;
 797
 798 /*
 799  * configurable drive settings
 800  */
 801
 802 #define DS_SYNC (1 << 0)
 803
 804 struct ide_devset {
 805         int             (*get)(ide_drive_t *);
 806         int             (*set)(ide_drive_t *, int);
 807         unsigned int    flags;
 808 };
 809
 810 #define __DEVSET(_flags, _get, _set) { \
 811         .flags  = _flags, \
 812         .get    = _get, \
 813         .set    = _set, \
 814 }
 815
 816 #define ide_devset_get(name, field) \
 817 static int get_##name(ide_drive_t *drive) \
 818 { \
 819         return drive->field; \
 820 }
 821
 822 #define ide_devset_set(name, field) \
 823 static int set_##name(ide_drive_t *drive, int arg) \
 824 { \
 825         drive->field = arg; \
 826         return 0; \
 827 }
 828
 829 #define __IDE_DEVSET(_name, _flags, _get, _set) \
 830 const struct ide_devset ide_devset_##_name = \
 831         __DEVSET(_flags, _get, _set)
 832
 833 #define IDE_DEVSET(_name, _flags, _get, _set) \
 834 static __IDE_DEVSET(_name, _flags, _get, _set)
 835
 836 #define ide_devset_rw(_name, _func) \
 837 IDE_DEVSET(_name, 0, get_##_func, set_##_func)
 838
 839 #define ide_devset_w(_name, _func) \
 840 IDE_DEVSET(_name, 0, NULL, set_##_func)
 841
 842 #define ide_devset_rw_sync(_name, _func) \
 843 IDE_DEVSET(_name, DS_SYNC, get_##_func, set_##_func)
 844
 845 #define ide_decl_devset(_name) \
 846 extern const struct ide_devset ide_devset_##_name
 847
 848 ide_decl_devset(io_32bit);
 849 ide_decl_devset(keepsettings);
 850 ide_decl_devset(pio_mode);
 851 ide_decl_devset(unmaskirq);
 852 ide_decl_devset(using_dma);
 853
 854 #ifdef CONFIG_IDE_PROC_FS
 855 /*
 856  * /proc/ide interface
 857  */
 858
 859 #define ide_devset_rw_field(_name, _field) \
 860 ide_devset_get(_name, _field); \
 861 ide_devset_set(_name, _field); \
 862 IDE_DEVSET(_name, DS_SYNC, get_##_name, set_##_name)
 863
 864 struct ide_proc_devset {
 865         const char              *name;
 866         const struct ide_devset *setting;
 867         int                     min, max;
 868         int                     (*mulf)(ide_drive_t *);
 869         int                     (*divf)(ide_drive_t *);
 870 };
 871
 872 #define __IDE_PROC_DEVSET(_name, _min, _max, _mulf, _divf) { \
 873         .name = __stringify(_name), \
 874         .setting = &ide_devset_##_name, \
 875         .min = _min, \
 876         .max = _max, \
 877         .mulf = _mulf, \
 878         .divf = _divf, \
 879 }
 880
 881 #define IDE_PROC_DEVSET(_name, _min, _max) \
 882 __IDE_PROC_DEVSET(_name, _min, _max, NULL, NULL)
 883
 884 typedef struct {
 885         const char      *name;
 886         mode_t          mode;
 887         read_proc_t     *read_proc;
 888         write_proc_t    *write_proc;
 889 } ide_proc_entry_t;
 890
 891 void proc_ide_create(void);
 892 void proc_ide_destroy(void);
 893 void ide_proc_register_port(ide_hwif_t *);
 894 void ide_proc_port_register_devices(ide_hwif_t *);
 895 void ide_proc_unregister_device(ide_drive_t *);
 896 void ide_proc_unregister_port(ide_hwif_t *);
 897 void ide_proc_register_driver(ide_drive_t *, ide_driver_t *);
 898 void ide_proc_unregister_driver(ide_drive_t *, ide_driver_t *);
 899
 900 read_proc_t proc_ide_read_capacity;
 901 read_proc_t proc_ide_read_geometry;
 902
 903 /*
 904  * Standard exit stuff:
 905  */
 906 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) \
 907 {                                       \
 908         len -= off;                     \
 909         if (len < count) {              \
 910                 *eof = 1;               \
 911                 if (len <= 0)           \
 912                         return 0;       \
 913         } else                          \
 914                 len = count;            \
 915         *start = page + off;            \
 916         return len;                     \
 917 }
 918 #else
 919 static inline void proc_ide_create(void) { ; }
 920 static inline void proc_ide_destroy(void) { ; }
 921 static inline void ide_proc_register_port(ide_hwif_t *hwif) { ; }
 922 static inline void ide_proc_port_register_devices(ide_hwif_t *hwif) { ; }
 923 static inline void ide_proc_unregister_device(ide_drive_t *drive) { ; }
 924 static inline void ide_proc_unregister_port(ide_hwif_t *hwif) { ; }
 925 static inline void ide_proc_register_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
 926 static inline void ide_proc_unregister_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
 927 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) return 0;
 928 #endif
 929
 930 enum {
 931         /* enter/exit functions */
 932         IDE_DBG_FUNC =                  (1 << 0),
 933         /* sense key/asc handling */
 934         IDE_DBG_SENSE =                 (1 << 1),
 935         /* packet commands handling */
 936         IDE_DBG_PC =                    (1 << 2),
 937         /* request handling */
 938         IDE_DBG_RQ =                    (1 << 3),
 939         /* driver probing/setup */
 940         IDE_DBG_PROBE =                 (1 << 4),
 941 };
 942
 943 /* DRV_NAME has to be defined in the driver before using the macro below */
 944 #define __ide_debug_log(lvl, fmt, args...)                      \
 945 {                                                               \
 946         if (unlikely(drive->debug_mask & lvl))                  \
 947                 printk(KERN_INFO DRV_NAME ": " fmt, ## args);   \
 948 }
 949
 950 /*
 951  * Power Management step value (rq->pm->pm_step).
 952  *
 953  * The step value starts at 0 (ide_pm_state_start_suspend) for a
 954  * suspend operation or 1000 (ide_pm_state_start_resume) for a
 955  * resume operation.
 956  *
 957  * For each step, the core calls the subdriver start_power_step() first.
 958  * This can return:
 959  *      - ide_stopped : In this case, the core calls us back again unless
 960  *                      step have been set to ide_power_state_completed.
 961  *      - ide_started : In this case, the channel is left busy until an
 962  *                      async event (interrupt) occurs.
 963  * Typically, start_power_step() will issue a taskfile request with
 964  * do_rw_taskfile().
 965  *
 966  * Upon reception of the interrupt, the core will call complete_power_step()
 967  * with the error code if any. This routine should update the step value
 968  * and return. It should not start a new request. The core will call
 969  * start_power_step for the new step value, unless step have been set to
 970  * ide_power_state_completed.
 971  *
 972  * Subdrivers are expected to define their own additional power
 973  * steps from 1..999 for suspend and from 1001..1999 for resume,
 974  * other values are reserved for future use.
 975  */
 976
 977 enum {
 978         ide_pm_state_completed          = -1,
 979         ide_pm_state_start_suspend      = 0,
 980         ide_pm_state_start_resume       = 1000,
 981 };
 982
 983 /*
 984  * Subdrivers support.
 985  *
 986  * The gendriver.owner field should be set to the module owner of this driver.
 987  * The gendriver.name field should be set to the name of this driver
 988  */
 989 struct ide_driver_s {
 990         const char                      *version;
 991         u8                              media;
 992         ide_startstop_t (*do_request)(ide_drive_t *, struct request *, sector_t);
 993         int             (*end_request)(ide_drive_t *, int, int);
 994         ide_startstop_t (*error)(ide_drive_t *, struct request *rq, u8, u8);
 995         struct device_driver    gen_driver;
 996         int             (*probe)(ide_drive_t *);
 997         void            (*remove)(ide_drive_t *);
 998         void            (*resume)(ide_drive_t *);
 999         void            (*shutdown)(ide_drive_t *);
1000 #ifdef CONFIG_IDE_PROC_FS
1001         ide_proc_entry_t                *proc;
1002         const struct ide_proc_devset    *settings;
1003 #endif
1004 };
1005
1006 #define to_ide_driver(drv) container_of(drv, ide_driver_t, gen_driver)
1007
1008 int ide_device_get(ide_drive_t *);
1009 void ide_device_put(ide_drive_t *);
1010
1011 struct ide_ioctl_devset {
1012         unsigned int    get_ioctl;
1013         unsigned int    set_ioctl;
1014         const struct ide_devset *setting;
1015 };
1016
1017 int ide_setting_ioctl(ide_drive_t *, struct block_device *, unsigned int,
1018                       unsigned long, const struct ide_ioctl_devset *);
1019
1020 int generic_ide_ioctl(ide_drive_t *, struct file *, struct block_device *,
1021                       unsigned, unsigned long);
1022
1023 extern int ide_vlb_clk;
1024 extern int ide_pci_clk;
1025
1026 extern int ide_end_request (ide_drive_t *drive, int uptodate, int nrsecs);
1027 int ide_end_dequeued_request(ide_drive_t *drive, struct request *rq,
1028                              int uptodate, int nr_sectors);
1029
1030 extern void ide_set_handler (ide_drive_t *drive, ide_handler_t *handler, unsigned int timeout, ide_expiry_t *expiry);
1031
1032 void ide_execute_command(ide_drive_t *, u8, ide_handler_t *, unsigned int,
1033                          ide_expiry_t *);
1034
1035 void ide_execute_pkt_cmd(ide_drive_t *);
1036
1037 void ide_pad_transfer(ide_drive_t *, int, int);
1038
1039 ide_startstop_t __ide_error(ide_drive_t *, struct request *, u8, u8);
1040
1041 ide_startstop_t ide_error (ide_drive_t *drive, const char *msg, byte stat);
1042
1043 void ide_fix_driveid(u16 *);
1044
1045 extern void ide_fixstring(u8 *, const int, const int);
1046
1047 int ide_busy_sleep(ide_hwif_t *, unsigned long, int);
1048
1049 int ide_wait_stat(ide_startstop_t *, ide_drive_t *, u8, u8, unsigned long);
1050
1051 extern ide_startstop_t ide_do_reset (ide_drive_t *);
1052
1053 extern int ide_devset_execute(ide_drive_t *drive,
1054                               const struct ide_devset *setting, int arg);
1055
1056 extern void ide_do_drive_cmd(ide_drive_t *, struct request *);
1057
1058 extern void ide_end_drive_cmd(ide_drive_t *, u8, u8);
1059
1060 enum {
1061         IDE_TFLAG_LBA48                 = (1 << 0),
1062         IDE_TFLAG_FLAGGED               = (1 << 2),
1063         IDE_TFLAG_OUT_DATA              = (1 << 3),
1064         IDE_TFLAG_OUT_HOB_FEATURE       = (1 << 4),
1065         IDE_TFLAG_OUT_HOB_NSECT         = (1 << 5),
1066         IDE_TFLAG_OUT_HOB_LBAL          = (1 << 6),
1067         IDE_TFLAG_OUT_HOB_LBAM          = (1 << 7),
1068         IDE_TFLAG_OUT_HOB_LBAH          = (1 << 8),
1069         IDE_TFLAG_OUT_HOB               = IDE_TFLAG_OUT_HOB_FEATURE |
1070                                           IDE_TFLAG_OUT_HOB_NSECT |
1071                                           IDE_TFLAG_OUT_HOB_LBAL |
1072                                           IDE_TFLAG_OUT_HOB_LBAM |
1073                                           IDE_TFLAG_OUT_HOB_LBAH,
1074         IDE_TFLAG_OUT_FEATURE           = (1 << 9),
1075         IDE_TFLAG_OUT_NSECT             = (1 << 10),
1076         IDE_TFLAG_OUT_LBAL              = (1 << 11),
1077         IDE_TFLAG_OUT_LBAM              = (1 << 12),
1078         IDE_TFLAG_OUT_LBAH              = (1 << 13),
1079         IDE_TFLAG_OUT_TF                = IDE_TFLAG_OUT_FEATURE |
1080                                           IDE_TFLAG_OUT_NSECT |
1081                                           IDE_TFLAG_OUT_LBAL |
1082                                           IDE_TFLAG_OUT_LBAM |
1083                                           IDE_TFLAG_OUT_LBAH,
1084         IDE_TFLAG_OUT_DEVICE            = (1 << 14),
1085         IDE_TFLAG_WRITE                 = (1 << 15),
1086         IDE_TFLAG_FLAGGED_SET_IN_FLAGS  = (1 << 16),
1087         IDE_TFLAG_IN_DATA               = (1 << 17),
1088         IDE_TFLAG_CUSTOM_HANDLER        = (1 << 18),
1089         IDE_TFLAG_DMA_PIO_FALLBACK      = (1 << 19),
1090         IDE_TFLAG_IN_HOB_FEATURE        = (1 << 20),
1091         IDE_TFLAG_IN_HOB_NSECT          = (1 << 21),
1092         IDE_TFLAG_IN_HOB_LBAL           = (1 << 22),
1093         IDE_TFLAG_IN_HOB_LBAM           = (1 << 23),
1094         IDE_TFLAG_IN_HOB_LBAH           = (1 << 24),
1095         IDE_TFLAG_IN_HOB_LBA            = IDE_TFLAG_IN_HOB_LBAL |
1096                                           IDE_TFLAG_IN_HOB_LBAM |
1097                                           IDE_TFLAG_IN_HOB_LBAH,
1098         IDE_TFLAG_IN_HOB                = IDE_TFLAG_IN_HOB_FEATURE |
1099                                           IDE_TFLAG_IN_HOB_NSECT |
1100                                           IDE_TFLAG_IN_HOB_LBA,
1101         IDE_TFLAG_IN_FEATURE            = (1 << 1),
1102         IDE_TFLAG_IN_NSECT              = (1 << 25),
1103         IDE_TFLAG_IN_LBAL               = (1 << 26),
1104         IDE_TFLAG_IN_LBAM               = (1 << 27),
1105         IDE_TFLAG_IN_LBAH               = (1 << 28),
1106         IDE_TFLAG_IN_LBA                = IDE_TFLAG_IN_LBAL |
1107                                           IDE_TFLAG_IN_LBAM |
1108                                           IDE_TFLAG_IN_LBAH,
1109         IDE_TFLAG_IN_TF                 = IDE_TFLAG_IN_NSECT |
1110                                           IDE_TFLAG_IN_LBA,
1111         IDE_TFLAG_IN_DEVICE             = (1 << 29),
1112         IDE_TFLAG_HOB                   = IDE_TFLAG_OUT_HOB |
1113                                           IDE_TFLAG_IN_HOB,
1114         IDE_TFLAG_TF                    = IDE_TFLAG_OUT_TF |
1115                                           IDE_TFLAG_IN_TF,
1116         IDE_TFLAG_DEVICE                = IDE_TFLAG_OUT_DEVICE |
1117                                           IDE_TFLAG_IN_DEVICE,
1118         /* force 16-bit I/O operations */
1119         IDE_TFLAG_IO_16BIT              = (1 << 30),
1120         /* ide_task_t was allocated using kmalloc() */
1121         IDE_TFLAG_DYN                   = (1 << 31),
1122 };
1123
1124 struct ide_taskfile {
1125         u8      hob_data;       /*  0: high data byte (for TASKFILE IOCTL) */
1126
1127         u8      hob_feature;    /*  1-5: additional data to support LBA48 */
1128         u8      hob_nsect;
1129         u8      hob_lbal;
1130         u8      hob_lbam;
1131         u8      hob_lbah;
1132
1133         u8      data;           /*  6: low data byte (for TASKFILE IOCTL) */
1134
1135         union {                 /*  7: */
1136                 u8 error;       /*   read:  error */
1137                 u8 feature;     /*  write: feature */
1138         };
1139
1140         u8      nsect;          /*  8: number of sectors */
1141         u8      lbal;           /*  9: LBA low */
1142         u8      lbam;           /* 10: LBA mid */
1143         u8      lbah;           /* 11: LBA high */
1144
1145         u8      device;         /* 12: device select */
1146
1147         union {                 /* 13: */
1148                 u8 status;      /*  read: status  */
1149                 u8 command;     /* write: command */
1150         };
1151 };
1152
1153 typedef struct ide_task_s {
1154         union {
1155                 struct ide_taskfile     tf;
1156                 u8                      tf_array[14];
1157         };
1158         u32                     tf_flags;
1159         int                     data_phase;
1160         struct request          *rq;            /* copy of request */
1161         void                    *special;       /* valid_t generally */
1162 } ide_task_t;
1163
1164 void ide_tf_dump(const char *, struct ide_taskfile *);
1165
1166 void ide_exec_command(ide_hwif_t *, u8);
1167 u8 ide_read_status(ide_hwif_t *);
1168 u8 ide_read_altstatus(ide_hwif_t *);
1169 u8 ide_read_sff_dma_status(ide_hwif_t *);
1170
1171 void ide_set_irq(ide_hwif_t *, int);
1172
1173 void ide_tf_load(ide_drive_t *, ide_task_t *);
1174 void ide_tf_read(ide_drive_t *, ide_task_t *);
1175
1176 void ide_input_data(ide_drive_t *, struct request *, void *, unsigned int);
1177 void ide_output_data(ide_drive_t *, struct request *, void *, unsigned int);
1178
1179 int ide_io_buffers(ide_drive_t *, struct ide_atapi_pc *, unsigned int, int);
1180
1181 extern void SELECT_DRIVE(ide_drive_t *);
1182 void SELECT_MASK(ide_drive_t *, int);
1183
1184 u8 ide_read_error(ide_drive_t *);
1185 void ide_read_bcount_and_ireason(ide_drive_t *, u16 *, u8 *);
1186
1187 extern int drive_is_ready(ide_drive_t *);
1188
1189 void ide_pktcmd_tf_load(ide_drive_t *, u32, u16, u8);
1190
1191 int ide_check_atapi_device(ide_drive_t *, const char *);
1192
1193 void ide_init_pc(struct ide_atapi_pc *);
1194
1195 /*
1196  * Special requests for ide-tape block device strategy routine.
1197  *
1198  * In order to service a character device command, we add special requests to
1199  * the tail of our block device request queue and wait for their completion.
1200  */
1201 enum {
1202         REQ_IDETAPE_PC1         = (1 << 0), /* packet command (first stage) */
1203         REQ_IDETAPE_PC2         = (1 << 1), /* packet command (second stage) */
1204         REQ_IDETAPE_READ        = (1 << 2),
1205         REQ_IDETAPE_WRITE       = (1 << 3),
1206 };
1207
1208 int ide_queue_pc_tail(ide_drive_t *, struct gendisk *, struct ide_atapi_pc *);
1209
1210 int ide_do_test_unit_ready(ide_drive_t *, struct gendisk *);
1211 int ide_do_start_stop(ide_drive_t *, struct gendisk *, int);
1212 int ide_set_media_lock(ide_drive_t *, struct gendisk *, int);
1213 void ide_create_request_sense_cmd(ide_drive_t *, struct ide_atapi_pc *);
1214 void ide_retry_pc(ide_drive_t *, struct gendisk *);
1215
1216 static inline unsigned long ide_scsi_get_timeout(struct ide_atapi_pc *pc)
1217 {
1218         return max_t(unsigned long, WAIT_CMD, pc->timeout - jiffies);
1219 }
1220
1221 int ide_scsi_expiry(ide_drive_t *);
1222
1223 ide_startstop_t ide_issue_pc(ide_drive_t *, unsigned int, ide_expiry_t *);
1224
1225 ide_startstop_t do_rw_taskfile(ide_drive_t *, ide_task_t *);
1226
1227 void task_end_request(ide_drive_t *, struct request *, u8);
1228
1229 int ide_raw_taskfile(ide_drive_t *, ide_task_t *, u8 *, u16);
1230 int ide_no_data_taskfile(ide_drive_t *, ide_task_t *);
1231
1232 int ide_taskfile_ioctl(ide_drive_t *, unsigned int, unsigned long);
1233
1234 extern int ide_driveid_update(ide_drive_t *);
1235 extern int ide_config_drive_speed(ide_drive_t *, u8);
1236 extern u8 eighty_ninty_three (ide_drive_t *);
1237 extern int taskfile_lib_get_identify(ide_drive_t *drive, u8 *);
1238
1239 extern int ide_wait_not_busy(ide_hwif_t *hwif, unsigned long timeout);
1240
1241 extern void ide_stall_queue(ide_drive_t *drive, unsigned long timeout);
1242
1243 extern void ide_timer_expiry(unsigned long);
1244 extern irqreturn_t ide_intr(int irq, void *dev_id);
1245 extern void do_ide_request(struct request_queue *);
1246
1247 void ide_init_disk(struct gendisk *, ide_drive_t *);
1248
1249 #ifdef CONFIG_IDEPCI_PCIBUS_ORDER
1250 extern int __ide_pci_register_driver(struct pci_driver *driver, struct module *owner, const char *mod_name);
1251 #define ide_pci_register_driver(d) __ide_pci_register_driver(d, THIS_MODULE, KBUILD_MODNAME)
1252 #else
1253 #define ide_pci_register_driver(d) pci_register_driver(d)
1254 #endif
1255
1256 void ide_pci_setup_ports(struct pci_dev *, const struct ide_port_info *, int,
1257                          hw_regs_t *, hw_regs_t **);
1258 void ide_setup_pci_noise(struct pci_dev *, const struct ide_port_info *);
1259
1260 #ifdef CONFIG_BLK_DEV_IDEDMA_PCI
1261 int ide_pci_set_master(struct pci_dev *, const char *);
1262 unsigned long ide_pci_dma_base(ide_hwif_t *, const struct ide_port_info *);
1263 int ide_pci_check_simplex(ide_hwif_t *, const struct ide_port_info *);
1264 int ide_hwif_setup_dma(ide_hwif_t *, const struct ide_port_info *);
1265 #else
1266 static inline int ide_hwif_setup_dma(ide_hwif_t *hwif,
1267                                      const struct ide_port_info *d)
1268 {
1269         return -EINVAL;
1270 }
1271 #endif
1272
1273 typedef struct ide_pci_enablebit_s {
1274         u8      reg;    /* byte pci reg holding the enable-bit */
1275         u8      mask;   /* mask to isolate the enable-bit */
1276         u8      val;    /* value of masked reg when "enabled" */
1277 } ide_pci_enablebit_t;
1278
1279 enum {
1280         /* Uses ISA control ports not PCI ones. */
1281         IDE_HFLAG_ISA_PORTS             = (1 << 0),
1282         /* single port device */
1283         IDE_HFLAG_SINGLE                = (1 << 1),
1284         /* don't use legacy PIO blacklist */
1285         IDE_HFLAG_PIO_NO_BLACKLIST      = (1 << 2),
1286         /* set for the second port of QD65xx */
1287         IDE_HFLAG_QD_2ND_PORT           = (1 << 3),
1288         /* use PIO8/9 for prefetch off/on */
1289         IDE_HFLAG_ABUSE_PREFETCH        = (1 << 4),
1290         /* use PIO6/7 for fast-devsel off/on */
1291         IDE_HFLAG_ABUSE_FAST_DEVSEL     = (1 << 5),
1292         /* use 100-102 and 200-202 PIO values to set DMA modes */
1293         IDE_HFLAG_ABUSE_DMA_MODES       = (1 << 6),
1294         /*
1295          * keep DMA setting when programming PIO mode, may be used only
1296          * for hosts which have separate PIO and DMA timings (ie. PMAC)
1297          */
1298         IDE_HFLAG_SET_PIO_MODE_KEEP_DMA = (1 << 7),
1299         /* program host for the transfer mode after programming device */
1300         IDE_HFLAG_POST_SET_MODE         = (1 << 8),
1301         /* don't program host/device for the transfer mode ("smart" hosts) */
1302         IDE_HFLAG_NO_SET_MODE           = (1 << 9),
1303         /* trust BIOS for programming chipset/device for DMA */
1304         IDE_HFLAG_TRUST_BIOS_FOR_DMA    = (1 << 10),
1305         /* host is CS5510/CS5520 */
1306         IDE_HFLAG_CS5520                = (1 << 11),
1307         /* ATAPI DMA is unsupported */
1308         IDE_HFLAG_NO_ATAPI_DMA          = (1 << 12),
1309         /* set if host is a "non-bootable" controller */
1310         IDE_HFLAG_NON_BOOTABLE          = (1 << 13),
1311         /* host doesn't support DMA */
1312         IDE_HFLAG_NO_DMA                = (1 << 14),
1313         /* check if host is PCI IDE device before allowing DMA */
1314         IDE_HFLAG_NO_AUTODMA            = (1 << 15),
1315         /* host uses MMIO */
1316         IDE_HFLAG_MMIO                  = (1 << 16),
1317         /* no LBA48 */
1318         IDE_HFLAG_NO_LBA48              = (1 << 17),
1319         /* no LBA48 DMA */
1320         IDE_HFLAG_NO_LBA48_DMA          = (1 << 18),
1321         /* data FIFO is cleared by an error */
1322         IDE_HFLAG_ERROR_STOPS_FIFO      = (1 << 19),
1323         /* serialize ports */
1324         IDE_HFLAG_SERIALIZE             = (1 << 20),
1325         /* use legacy IRQs */
1326         IDE_HFLAG_LEGACY_IRQS           = (1 << 21),
1327         /* force use of legacy IRQs */
1328         IDE_HFLAG_FORCE_LEGACY_IRQS     = (1 << 22),
1329         /* limit LBA48 requests to 256 sectors */
1330         IDE_HFLAG_RQSIZE_256            = (1 << 23),
1331         /* use 32-bit I/O ops */
1332         IDE_HFLAG_IO_32BIT              = (1 << 24),
1333         /* unmask IRQs */
1334         IDE_HFLAG_UNMASK_IRQS           = (1 << 25),
1335         /* serialize ports if DMA is possible (for sl82c105) */
1336         IDE_HFLAG_SERIALIZE_DMA         = (1 << 27),
1337         /* force host out of "simplex" mode */
1338         IDE_HFLAG_CLEAR_SIMPLEX         = (1 << 28),
1339         /* DSC overlap is unsupported */
1340         IDE_HFLAG_NO_DSC                = (1 << 29),
1341         /* never use 32-bit I/O ops */
1342         IDE_HFLAG_NO_IO_32BIT           = (1 << 30),
1343         /* never unmask IRQs */
1344         IDE_HFLAG_NO_UNMASK_IRQS        = (1 << 31),
1345 };
1346
1347 #ifdef CONFIG_BLK_DEV_OFFBOARD
1348 # define IDE_HFLAG_OFF_BOARD    0
1349 #else
1350 # define IDE_HFLAG_OFF_BOARD    IDE_HFLAG_NON_BOOTABLE
1351 #endif
1352
1353 struct ide_port_info {
1354         char                    *name;
1355         unsigned int            (*init_chipset)(struct pci_dev *);
1356         void                    (*init_iops)(ide_hwif_t *);
1357         void                    (*init_hwif)(ide_hwif_t *);
1358         int                     (*init_dma)(ide_hwif_t *,
1359                                             const struct ide_port_info *);
1360
1361         const struct ide_tp_ops         *tp_ops;
1362         const struct ide_port_ops       *port_ops;
1363         const struct ide_dma_ops        *dma_ops;
1364
1365         ide_pci_enablebit_t     enablebits[2];
1366         hwif_chipset_t          chipset;
1367         u32                     host_flags;
1368         u8                      pio_mask;
1369         u8                      swdma_mask;
1370         u8                      mwdma_mask;
1371         u8                      udma_mask;
1372 };
1373
1374 int ide_pci_init_one(struct pci_dev *, const struct ide_port_info *, void *);
1375 int ide_pci_init_two(struct pci_dev *, struct pci_dev *,
1376                      const struct ide_port_info *, void *);
1377 void ide_pci_remove(struct pci_dev *);
1378
1379 #ifdef CONFIG_PM
1380 int ide_pci_suspend(struct pci_dev *, pm_message_t);
1381 int ide_pci_resume(struct pci_dev *);
1382 #else
1383 #define ide_pci_suspend NULL
1384 #define ide_pci_resume NULL
1385 #endif
1386
1387 void ide_map_sg(ide_drive_t *, struct request *);
1388 void ide_init_sg_cmd(ide_drive_t *, struct request *);
1389
1390 #define BAD_DMA_DRIVE           0
1391 #define GOOD_DMA_DRIVE          1
1392
1393 struct drive_list_entry {
1394         const char *id_model;
1395         const char *id_firmware;
1396 };
1397
1398 int ide_in_drive_list(u16 *, const struct drive_list_entry *);
1399
1400 #ifdef CONFIG_BLK_DEV_IDEDMA
1401 int __ide_dma_bad_drive(ide_drive_t *);
1402 int ide_id_dma_bug(ide_drive_t *);
1403
1404 u8 ide_find_dma_mode(ide_drive_t *, u8);
1405
1406 static inline u8 ide_max_dma_mode(ide_drive_t *drive)
1407 {
1408         return ide_find_dma_mode(drive, XFER_UDMA_6);
1409 }
1410
1411 void ide_dma_off_quietly(ide_drive_t *);
1412 void ide_dma_off(ide_drive_t *);
1413 void ide_dma_on(ide_drive_t *);
1414 int ide_set_dma(ide_drive_t *);
1415 void ide_check_dma_crc(ide_drive_t *);
1416 ide_startstop_t ide_dma_intr(ide_drive_t *);
1417
1418 int ide_build_sglist(ide_drive_t *, struct request *);
1419 void ide_destroy_dmatable(ide_drive_t *);
1420
1421 #ifdef CONFIG_BLK_DEV_IDEDMA_SFF
1422 extern int ide_build_dmatable(ide_drive_t *, struct request *);
1423 int ide_allocate_dma_engine(ide_hwif_t *);
1424 void ide_release_dma_engine(ide_hwif_t *);
1425
1426 void ide_dma_host_set(ide_drive_t *, int);
1427 extern int ide_dma_setup(ide_drive_t *);
1428 void ide_dma_exec_cmd(ide_drive_t *, u8);
1429 extern void ide_dma_start(ide_drive_t *);
1430 extern int __ide_dma_end(ide_drive_t *);
1431 int ide_dma_test_irq(ide_drive_t *);
1432 extern void ide_dma_lost_irq(ide_drive_t *);
1433 extern void ide_dma_timeout(ide_drive_t *);
1434 extern const struct ide_dma_ops sff_dma_ops;
1435 #endif /* CONFIG_BLK_DEV_IDEDMA_SFF */
1436
1437 #else
1438 static inline int ide_id_dma_bug(ide_drive_t *drive) { return 0; }
1439 static inline u8 ide_find_dma_mode(ide_drive_t *drive, u8 speed) { return 0; }
1440 static inline u8 ide_max_dma_mode(ide_drive_t *drive) { return 0; }
1441 static inline void ide_dma_off_quietly(ide_drive_t *drive) { ; }
1442 static inline void ide_dma_off(ide_drive_t *drive) { ; }
1443 static inline void ide_dma_on(ide_drive_t *drive) { ; }
1444 static inline void ide_dma_verbose(ide_drive_t *drive) { ; }
1445 static inline int ide_set_dma(ide_drive_t *drive) { return 1; }
1446 static inline void ide_check_dma_crc(ide_drive_t *drive) { ; }
1447 #endif /* CONFIG_BLK_DEV_IDEDMA */
1448
1449 #ifndef CONFIG_BLK_DEV_IDEDMA_SFF
1450 static inline void ide_release_dma_engine(ide_hwif_t *hwif) { ; }
1451 #endif
1452
1453 #ifdef CONFIG_BLK_DEV_IDEACPI
1454 extern int ide_acpi_exec_tfs(ide_drive_t *drive);
1455 extern void ide_acpi_get_timing(ide_hwif_t *hwif);
1456 extern void ide_acpi_push_timing(ide_hwif_t *hwif);
1457 extern void ide_acpi_init(ide_hwif_t *hwif);
1458 void ide_acpi_port_init_devices(ide_hwif_t *);
1459 extern void ide_acpi_set_state(ide_hwif_t *hwif, int on);
1460 #else
1461 static inline int ide_acpi_exec_tfs(ide_drive_t *drive) { return 0; }
1462 static inline void ide_acpi_get_timing(ide_hwif_t *hwif) { ; }
1463 static inline void ide_acpi_push_timing(ide_hwif_t *hwif) { ; }
1464 static inline void ide_acpi_init(ide_hwif_t *hwif) { ; }
1465 static inline void ide_acpi_port_init_devices(ide_hwif_t *hwif) { ; }
1466 static inline void ide_acpi_set_state(ide_hwif_t *hwif, int on) {}
1467 #endif
1468
1469 void ide_remove_port_from_hwgroup(ide_hwif_t *);
1470 void ide_unregister(ide_hwif_t *);
1471
1472 void ide_register_region(struct gendisk *);
1473 void ide_unregister_region(struct gendisk *);
1474
1475 void ide_undecoded_slave(ide_drive_t *);
1476
1477 void ide_port_apply_params(ide_hwif_t *);
1478
1479 struct ide_host *ide_host_alloc_all(const struct ide_port_info *, hw_regs_t **);
1480 struct ide_host *ide_host_alloc(const struct ide_port_info *, hw_regs_t **);
1481 void ide_host_free(struct ide_host *);
1482 int ide_host_register(struct ide_host *, const struct ide_port_info *,
1483                       hw_regs_t **);
1484 int ide_host_add(const struct ide_port_info *, hw_regs_t **,
1485                  struct ide_host **);
1486 void ide_host_remove(struct ide_host *);
1487 int ide_legacy_device_add(const struct ide_port_info *, unsigned long);
1488 void ide_port_unregister_devices(ide_hwif_t *);
1489 void ide_port_scan(ide_hwif_t *);
1490
1491 static inline void *ide_get_hwifdata (ide_hwif_t * hwif)
1492 {
1493         return hwif->hwif_data;
1494 }
1495
1496 static inline void ide_set_hwifdata (ide_hwif_t * hwif, void *data)
1497 {
1498         hwif->hwif_data = data;
1499 }
1500
1501 const char *ide_xfer_verbose(u8 mode);
1502 extern void ide_toggle_bounce(ide_drive_t *drive, int on);
1503 extern int ide_set_xfer_rate(ide_drive_t *drive, u8 rate);
1504
1505 u64 ide_get_lba_addr(struct ide_taskfile *, int);
1506 u8 ide_dump_status(ide_drive_t *, const char *, u8);
1507
1508 struct ide_timing {
1509         u8  mode;
1510         u8  setup;      /* t1 */
1511         u16 act8b;      /* t2 for 8-bit io */
1512         u16 rec8b;      /* t2i for 8-bit io */
1513         u16 cyc8b;      /* t0 for 8-bit io */
1514         u16 active;     /* t2 or tD */
1515         u16 recover;    /* t2i or tK */
1516         u16 cycle;      /* t0 */
1517         u16 udma;       /* t2CYCTYP/2 */
1518 };
1519
1520 enum {
1521         IDE_TIMING_SETUP        = (1 << 0),
1522         IDE_TIMING_ACT8B        = (1 << 1),
1523         IDE_TIMING_REC8B        = (1 << 2),
1524         IDE_TIMING_CYC8B        = (1 << 3),
1525         IDE_TIMING_8BIT         = IDE_TIMING_ACT8B | IDE_TIMING_REC8B |
1526                                   IDE_TIMING_CYC8B,
1527         IDE_TIMING_ACTIVE       = (1 << 4),
1528         IDE_TIMING_RECOVER      = (1 << 5),
1529         IDE_TIMING_CYCLE        = (1 << 6),
1530         IDE_TIMING_UDMA         = (1 << 7),
1531         IDE_TIMING_ALL          = IDE_TIMING_SETUP | IDE_TIMING_8BIT |
1532                                   IDE_TIMING_ACTIVE | IDE_TIMING_RECOVER |
1533                                   IDE_TIMING_CYCLE | IDE_TIMING_UDMA,
1534 };
1535
1536 struct ide_timing *ide_timing_find_mode(u8);
1537 u16 ide_pio_cycle_time(ide_drive_t *, u8);
1538 void ide_timing_merge(struct ide_timing *, struct ide_timing *,
1539                       struct ide_timing *, unsigned int);
1540 int ide_timing_compute(ide_drive_t *, u8, struct ide_timing *, int, int);
1541
1542 int ide_scan_pio_blacklist(char *);
1543
1544 u8 ide_get_best_pio_mode(ide_drive_t *, u8, u8);
1545
1546 int ide_set_pio_mode(ide_drive_t *, u8);
1547 int ide_set_dma_mode(ide_drive_t *, u8);
1548
1549 void ide_set_pio(ide_drive_t *, u8);
1550
1551 static inline void ide_set_max_pio(ide_drive_t *drive)
1552 {
1553         ide_set_pio(drive, 255);
1554 }
1555
1556 extern spinlock_t ide_lock;
1557 extern struct mutex ide_cfg_mtx;
1558 /*
1559  * Structure locking:
1560  *
1561  * ide_cfg_mtx and ide_lock together protect changes to
1562  * ide_hwif_t->{next,hwgroup}
1563  * ide_drive_t->next
1564  *
1565  * ide_hwgroup_t->busy: ide_lock
1566  * ide_hwgroup_t->hwif: ide_lock
1567  * ide_hwif_t->mate: constant, no locking
1568  * ide_drive_t->hwif: constant, no locking
1569  */
1570
1571 #define local_irq_set(flags)    do { local_save_flags((flags)); local_irq_enable_in_hardirq(); } while (0)
1572
1573 extern struct bus_type ide_bus_type;
1574 extern struct class *ide_port_class;
1575
1576 static inline void ide_dump_identify(u8 *id)
1577 {
1578         print_hex_dump(KERN_INFO, "", DUMP_PREFIX_NONE, 16, 2, id, 512, 0);
1579 }
1580
1581 static inline int hwif_to_node(ide_hwif_t *hwif)
1582 {
1583         return hwif->dev ? dev_to_node(hwif->dev) : -1;
1584 }
1585
1586 static inline ide_drive_t *ide_get_pair_dev(ide_drive_t *drive)
1587 {
1588         ide_drive_t *peer = &drive->hwif->drives[(drive->dn ^ 1) & 1];
1589
1590         return peer->present ? peer : NULL;
1591 }
1592 #endif /* _IDE_H */