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