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