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