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/hdreg.h>
  12 #include <linux/hdsmart.h>
  13 #include <linux/blkdev.h>
  14 #include <linux/proc_fs.h>
  15 #include <linux/interrupt.h>
  16 #include <linux/bitops.h>
  17 #include <linux/bio.h>
  18 #include <linux/device.h>
  19 #include <linux/pci.h>
  20 #include <linux/completion.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/semaphore.h>
  28 #include <asm/mutex.h>
  29
  30 /******************************************************************************
  31  * IDE driver configuration options (play with these as desired):
  32  *
  33  * REALLY_SLOW_IO can be defined in ide.c and ide-cd.c, if necessary
  34  */
  35 #define INITIAL_MULT_COUNT      0       /* off=0; on=2,4,8,16,32, etc.. */
  36
  37 #ifndef SUPPORT_SLOW_DATA_PORTS         /* 1 to support slow data ports */
  38 #define SUPPORT_SLOW_DATA_PORTS 1       /* 0 to reduce kernel size */
  39 #endif
  40 #ifndef SUPPORT_VLB_SYNC                /* 1 to support weird 32-bit chips */
  41 #define SUPPORT_VLB_SYNC        1       /* 0 to reduce kernel size */
  42 #endif
  43 #ifndef OK_TO_RESET_CONTROLLER          /* 1 needed for good error recovery */
  44 #define OK_TO_RESET_CONTROLLER  1       /* 0 for use with AH2372A/B interface */
  45 #endif
  46
  47 #ifndef DISABLE_IRQ_NOSYNC
  48 #define DISABLE_IRQ_NOSYNC      0
  49 #endif
  50
  51 /*
  52  * Used to indicate "no IRQ", should be a value that cannot be an IRQ
  53  * number.
  54  */
  55
  56 #define IDE_NO_IRQ              (-1)
  57
  58 /*
  59  *  "No user-serviceable parts" beyond this point  :)
  60  *****************************************************************************/
  61
  62 typedef unsigned char   byte;   /* used everywhere */
  63
  64 /*
  65  * Probably not wise to fiddle with these
  66  */
  67 #define ERROR_MAX       8       /* Max read/write errors per sector */
  68 #define ERROR_RESET     3       /* Reset controller every 4th retry */
  69 #define ERROR_RECAL     1       /* Recalibrate every 2nd retry */
  70
  71 /*
  72  * Tune flags
  73  */
  74 #define IDE_TUNE_NOAUTO         2
  75 #define IDE_TUNE_AUTO           1
  76 #define IDE_TUNE_DEFAULT        0
  77
  78 /*
  79  * state flags
  80  */
  81
  82 #define DMA_PIO_RETRY   1       /* retrying in PIO */
  83
  84 #define HWIF(drive)             ((ide_hwif_t *)((drive)->hwif))
  85 #define HWGROUP(drive)          ((ide_hwgroup_t *)(HWIF(drive)->hwgroup))
  86
  87 /*
  88  * Definitions for accessing IDE controller registers
  89  */
  90 #define IDE_NR_PORTS            (10)
  91
  92 #define IDE_DATA_OFFSET         (0)
  93 #define IDE_ERROR_OFFSET        (1)
  94 #define IDE_NSECTOR_OFFSET      (2)
  95 #define IDE_SECTOR_OFFSET       (3)
  96 #define IDE_LCYL_OFFSET         (4)
  97 #define IDE_HCYL_OFFSET         (5)
  98 #define IDE_SELECT_OFFSET       (6)
  99 #define IDE_STATUS_OFFSET       (7)
 100 #define IDE_CONTROL_OFFSET      (8)
 101 #define IDE_IRQ_OFFSET          (9)
 102
 103 #define IDE_FEATURE_OFFSET      IDE_ERROR_OFFSET
 104 #define IDE_COMMAND_OFFSET      IDE_STATUS_OFFSET
 105
 106 #define IDE_CONTROL_OFFSET_HOB  (7)
 107
 108 #define IDE_DATA_REG            (HWIF(drive)->io_ports[IDE_DATA_OFFSET])
 109 #define IDE_ERROR_REG           (HWIF(drive)->io_ports[IDE_ERROR_OFFSET])
 110 #define IDE_NSECTOR_REG         (HWIF(drive)->io_ports[IDE_NSECTOR_OFFSET])
 111 #define IDE_SECTOR_REG          (HWIF(drive)->io_ports[IDE_SECTOR_OFFSET])
 112 #define IDE_LCYL_REG            (HWIF(drive)->io_ports[IDE_LCYL_OFFSET])
 113 #define IDE_HCYL_REG            (HWIF(drive)->io_ports[IDE_HCYL_OFFSET])
 114 #define IDE_SELECT_REG          (HWIF(drive)->io_ports[IDE_SELECT_OFFSET])
 115 #define IDE_STATUS_REG          (HWIF(drive)->io_ports[IDE_STATUS_OFFSET])
 116 #define IDE_CONTROL_REG         (HWIF(drive)->io_ports[IDE_CONTROL_OFFSET])
 117 #define IDE_IRQ_REG             (HWIF(drive)->io_ports[IDE_IRQ_OFFSET])
 118
 119 #define IDE_FEATURE_REG         IDE_ERROR_REG
 120 #define IDE_COMMAND_REG         IDE_STATUS_REG
 121 #define IDE_ALTSTATUS_REG       IDE_CONTROL_REG
 122 #define IDE_IREASON_REG         IDE_NSECTOR_REG
 123 #define IDE_BCOUNTL_REG         IDE_LCYL_REG
 124 #define IDE_BCOUNTH_REG         IDE_HCYL_REG
 125
 126 #define OK_STAT(stat,good,bad)  (((stat)&((good)|(bad)))==(good))
 127 #define BAD_R_STAT              (BUSY_STAT   | ERR_STAT)
 128 #define BAD_W_STAT              (BAD_R_STAT  | WRERR_STAT)
 129 #define BAD_STAT                (BAD_R_STAT  | DRQ_STAT)
 130 #define DRIVE_READY             (READY_STAT  | SEEK_STAT)
 131 #define DATA_READY              (DRQ_STAT)
 132
 133 #define BAD_CRC                 (ABRT_ERR    | ICRC_ERR)
 134
 135 #define SATA_NR_PORTS           (3)     /* 16 possible ?? */
 136
 137 #define SATA_STATUS_OFFSET      (0)
 138 #define SATA_STATUS_REG         (HWIF(drive)->sata_scr[SATA_STATUS_OFFSET])
 139 #define SATA_ERROR_OFFSET       (1)
 140 #define SATA_ERROR_REG          (HWIF(drive)->sata_scr[SATA_ERROR_OFFSET])
 141 #define SATA_CONTROL_OFFSET     (2)
 142 #define SATA_CONTROL_REG        (HWIF(drive)->sata_scr[SATA_CONTROL_OFFSET])
 143
 144 #define SATA_MISC_OFFSET        (0)
 145 #define SATA_MISC_REG           (HWIF(drive)->sata_misc[SATA_MISC_OFFSET])
 146 #define SATA_PHY_OFFSET         (1)
 147 #define SATA_PHY_REG            (HWIF(drive)->sata_misc[SATA_PHY_OFFSET])
 148 #define SATA_IEN_OFFSET         (2)
 149 #define SATA_IEN_REG            (HWIF(drive)->sata_misc[SATA_IEN_OFFSET])
 150
 151 /*
 152  * Our Physical Region Descriptor (PRD) table should be large enough
 153  * to handle the biggest I/O request we are likely to see.  Since requests
 154  * can have no more than 256 sectors, and since the typical blocksize is
 155  * two or more sectors, we could get by with a limit of 128 entries here for
 156  * the usual worst case.  Most requests seem to include some contiguous blocks,
 157  * further reducing the number of table entries required.
 158  *
 159  * The driver reverts to PIO mode for individual requests that exceed
 160  * this limit (possible with 512 byte blocksizes, eg. MSDOS f/s), so handling
 161  * 100% of all crazy scenarios here is not necessary.
 162  *
 163  * As it turns out though, we must allocate a full 4KB page for this,
 164  * so the two PRD tables (ide0 & ide1) will each get half of that,
 165  * allowing each to have about 256 entries (8 bytes each) from this.
 166  */
 167 #define PRD_BYTES       8
 168 #define PRD_ENTRIES     256
 169
 170 /*
 171  * Some more useful definitions
 172  */
 173 #define PARTN_BITS      6       /* number of minor dev bits for partitions */
 174 #define MAX_DRIVES      2       /* per interface; 2 assumed by lots of code */
 175 #define SECTOR_SIZE     512
 176 #define SECTOR_WORDS    (SECTOR_SIZE / 4)       /* number of 32bit words per sector */
 177 #define IDE_LARGE_SEEK(b1,b2,t) (((b1) > (b2) + (t)) || ((b2) > (b1) + (t)))
 178
 179 /*
 180  * Timeouts for various operations:
 181  */
 182 #define WAIT_DRQ        (HZ/10)         /* 100msec - spec allows up to 20ms */
 183 #define WAIT_READY      (5*HZ)          /* 5sec - some laptops are very slow */
 184 #define WAIT_PIDENTIFY  (10*HZ) /* 10sec  - should be less than 3ms (?), if all ATAPI CD is closed at boot */
 185 #define WAIT_WORSTCASE  (30*HZ) /* 30sec  - worst case when spinning up */
 186 #define WAIT_CMD        (10*HZ) /* 10sec  - maximum wait for an IRQ to happen */
 187 #define WAIT_MIN_SLEEP  (2*HZ/100)      /* 20msec - minimum sleep time */
 188
 189 /*
 190  * Check for an interrupt and acknowledge the interrupt status
 191  */
 192 struct hwif_s;
 193 typedef int (ide_ack_intr_t)(struct hwif_s *);
 194
 195 #ifndef NO_DMA
 196 #define NO_DMA  255
 197 #endif
 198
 199 /*
 200  * hwif_chipset_t is used to keep track of the specific hardware
 201  * chipset used by each IDE interface, if known.
 202  */
 203 typedef enum {  ide_unknown,    ide_generic,    ide_pci,
 204                 ide_cmd640,     ide_dtc2278,    ide_ali14xx,
 205                 ide_qd65xx,     ide_umc8672,    ide_ht6560b,
 206                 ide_rz1000,     ide_trm290,
 207                 ide_cmd646,     ide_cy82c693,   ide_4drives,
 208                 ide_pmac,       ide_etrax100,   ide_acorn,
 209                 ide_au1xxx, ide_forced
 210 } hwif_chipset_t;
 211
 212 /*
 213  * Structure to hold all information about the location of this port
 214  */
 215 typedef struct hw_regs_s {
 216         unsigned long   io_ports[IDE_NR_PORTS]; /* task file registers */
 217         int             irq;                    /* our irq number */
 218         int             dma;                    /* our dma entry */
 219         ide_ack_intr_t  *ack_intr;              /* acknowledge interrupt */
 220         hwif_chipset_t  chipset;
 221         struct device   *dev;
 222 } hw_regs_t;
 223
 224 /*
 225  * Register new hardware with ide
 226  */
 227 int ide_register_hw(hw_regs_t *, int, struct hwif_s **);
 228 int ide_register_hw_with_fixup(hw_regs_t *, int, struct hwif_s **,
 229                                void (*)(struct hwif_s *));
 230
 231 /*
 232  * Set up hw_regs_t structure before calling ide_register_hw (optional)
 233  */
 234 void ide_setup_ports(   hw_regs_t *hw,
 235                         unsigned long base,
 236                         int *offsets,
 237                         unsigned long ctrl,
 238                         unsigned long intr,
 239                         ide_ack_intr_t *ack_intr,
 240 #if 0
 241                         ide_io_ops_t *iops,
 242 #endif
 243                         int irq);
 244
 245 static inline void ide_std_init_ports(hw_regs_t *hw,
 246                                       unsigned long io_addr,
 247                                       unsigned long ctl_addr)
 248 {
 249         unsigned int i;
 250
 251         for (i = IDE_DATA_OFFSET; i <= IDE_STATUS_OFFSET; i++)
 252                 hw->io_ports[i] = io_addr++;
 253
 254         hw->io_ports[IDE_CONTROL_OFFSET] = ctl_addr;
 255 }
 256
 257 #include <asm/ide.h>
 258
 259 #if !defined(MAX_HWIFS) || defined(CONFIG_EMBEDDED)
 260 #undef MAX_HWIFS
 261 #define MAX_HWIFS       CONFIG_IDE_MAX_HWIFS
 262 #endif
 263
 264 /* needed on alpha, x86/x86_64, ia64, mips, ppc32 and sh */
 265 #ifndef IDE_ARCH_OBSOLETE_DEFAULTS
 266 # define ide_default_io_base(index)     (0)
 267 # define ide_default_irq(base)          (0)
 268 # define ide_init_default_irq(base)     (0)
 269 #endif
 270
 271 /*
 272  * ide_init_hwif_ports() is OBSOLETE and will be removed in 2.7 series.
 273  * New ports shouldn't define IDE_ARCH_OBSOLETE_INIT in <asm/ide.h>.
 274  */
 275 #ifdef IDE_ARCH_OBSOLETE_INIT
 276 static inline void ide_init_hwif_ports(hw_regs_t *hw,
 277                                        unsigned long io_addr,
 278                                        unsigned long ctl_addr,
 279                                        int *irq)
 280 {
 281         if (!ctl_addr)
 282                 ide_std_init_ports(hw, io_addr, ide_default_io_ctl(io_addr));
 283         else
 284                 ide_std_init_ports(hw, io_addr, ctl_addr);
 285
 286         if (irq)
 287                 *irq = 0;
 288
 289         hw->io_ports[IDE_IRQ_OFFSET] = 0;
 290
 291 #ifdef CONFIG_PPC32
 292         if (ppc_ide_md.ide_init_hwif)
 293                 ppc_ide_md.ide_init_hwif(hw, io_addr, ctl_addr, irq);
 294 #endif
 295 }
 296 #else
 297 static inline void ide_init_hwif_ports(hw_regs_t *hw,
 298                                        unsigned long io_addr,
 299                                        unsigned long ctl_addr,
 300                                        int *irq)
 301 {
 302         if (io_addr || ctl_addr)
 303                 printk(KERN_WARNING "%s: must not be called\n", __FUNCTION__);
 304 }
 305 #endif /* IDE_ARCH_OBSOLETE_INIT */
 306
 307 /* Currently only m68k, apus and m8xx need it */
 308 #ifndef IDE_ARCH_ACK_INTR
 309 # define ide_ack_intr(hwif) (1)
 310 #endif
 311
 312 /* Currently only Atari needs it */
 313 #ifndef IDE_ARCH_LOCK
 314 # define ide_release_lock()                     do {} while (0)
 315 # define ide_get_lock(hdlr, data)               do {} while (0)
 316 #endif /* IDE_ARCH_LOCK */
 317
 318 /*
 319  * Now for the data we need to maintain per-drive:  ide_drive_t
 320  */
 321
 322 #define ide_scsi        0x21
 323 #define ide_disk        0x20
 324 #define ide_optical     0x7
 325 #define ide_cdrom       0x5
 326 #define ide_tape        0x1
 327 #define ide_floppy      0x0
 328
 329 /*
 330  * Special Driver Flags
 331  *
 332  * set_geometry : respecify drive geometry
 333  * recalibrate  : seek to cyl 0
 334  * set_multmode : set multmode count
 335  * set_tune     : tune interface for drive
 336  * serviced     : service command
 337  * reserved     : unused
 338  */
 339 typedef union {
 340         unsigned all                    : 8;
 341         struct {
 342 #if defined(__LITTLE_ENDIAN_BITFIELD)
 343                 unsigned set_geometry   : 1;
 344                 unsigned recalibrate    : 1;
 345                 unsigned set_multmode   : 1;
 346                 unsigned set_tune       : 1;
 347                 unsigned serviced       : 1;
 348                 unsigned reserved       : 3;
 349 #elif defined(__BIG_ENDIAN_BITFIELD)
 350                 unsigned reserved       : 3;
 351                 unsigned serviced       : 1;
 352                 unsigned set_tune       : 1;
 353                 unsigned set_multmode   : 1;
 354                 unsigned recalibrate    : 1;
 355                 unsigned set_geometry   : 1;
 356 #else
 357 #error "Please fix <asm/byteorder.h>"
 358 #endif
 359         } b;
 360 } special_t;
 361
 362 /*
 363  * ATA DATA Register Special.
 364  * ATA NSECTOR Count Register().
 365  * ATAPI Byte Count Register.
 366  * Channel index ordering pairs.
 367  */
 368 typedef union {
 369         unsigned all                    :16;
 370         struct {
 371 #if defined(__LITTLE_ENDIAN_BITFIELD)
 372                 unsigned low            :8;     /* LSB */
 373                 unsigned high           :8;     /* MSB */
 374 #elif defined(__BIG_ENDIAN_BITFIELD)
 375                 unsigned high           :8;     /* MSB */
 376                 unsigned low            :8;     /* LSB */
 377 #else
 378 #error "Please fix <asm/byteorder.h>"
 379 #endif
 380         } b;
 381 } ata_nsector_t, ata_data_t, atapi_bcount_t, ata_index_t;
 382
 383 /*
 384  * ATA-IDE Select Register, aka Device-Head
 385  *
 386  * head         : always zeros here
 387  * unit         : drive select number: 0/1
 388  * bit5         : always 1
 389  * lba          : using LBA instead of CHS
 390  * bit7         : always 1
 391  */
 392 typedef union {
 393         unsigned all                    : 8;
 394         struct {
 395 #if defined(__LITTLE_ENDIAN_BITFIELD)
 396                 unsigned head           : 4;
 397                 unsigned unit           : 1;
 398                 unsigned bit5           : 1;
 399                 unsigned lba            : 1;
 400                 unsigned bit7           : 1;
 401 #elif defined(__BIG_ENDIAN_BITFIELD)
 402                 unsigned bit7           : 1;
 403                 unsigned lba            : 1;
 404                 unsigned bit5           : 1;
 405                 unsigned unit           : 1;
 406                 unsigned head           : 4;
 407 #else
 408 #error "Please fix <asm/byteorder.h>"
 409 #endif
 410         } b;
 411 } select_t, ata_select_t;
 412
 413 /*
 414  * The ATA-IDE Status Register.
 415  * The ATAPI Status Register.
 416  *
 417  * check        : Error occurred
 418  * idx          : Index Error
 419  * corr         : Correctable error occurred
 420  * drq          : Data is request by the device
 421  * dsc          : Disk Seek Complete                    : ata
 422  *              : Media access command finished         : atapi
 423  * df           : Device Fault                          : ata
 424  *              : Reserved                              : atapi
 425  * drdy         : Ready, Command Mode Capable           : ata
 426  *              : Ignored for ATAPI commands            : atapi
 427  * bsy          : Disk is Busy
 428  *              : The device has access to the command block
 429  */
 430 typedef union {
 431         unsigned all                    :8;
 432         struct {
 433 #if defined(__LITTLE_ENDIAN_BITFIELD)
 434                 unsigned check          :1;
 435                 unsigned idx            :1;
 436                 unsigned corr           :1;
 437                 unsigned drq            :1;
 438                 unsigned dsc            :1;
 439                 unsigned df             :1;
 440                 unsigned drdy           :1;
 441                 unsigned bsy            :1;
 442 #elif defined(__BIG_ENDIAN_BITFIELD)
 443                 unsigned bsy            :1;
 444                 unsigned drdy           :1;
 445                 unsigned df             :1;
 446                 unsigned dsc            :1;
 447                 unsigned drq            :1;
 448                 unsigned corr           :1;
 449                 unsigned idx            :1;
 450                 unsigned check          :1;
 451 #else
 452 #error "Please fix <asm/byteorder.h>"
 453 #endif
 454         } b;
 455 } ata_status_t, atapi_status_t;
 456
 457 /*
 458  * ATAPI Feature Register
 459  *
 460  * dma          : Using DMA or PIO
 461  * reserved321  : Reserved
 462  * reserved654  : Reserved (Tag Type)
 463  * reserved7    : Reserved
 464  */
 465 typedef union {
 466         unsigned all                    :8;
 467         struct {
 468 #if defined(__LITTLE_ENDIAN_BITFIELD)
 469                 unsigned dma            :1;
 470                 unsigned reserved321    :3;
 471                 unsigned reserved654    :3;
 472                 unsigned reserved7      :1;
 473 #elif defined(__BIG_ENDIAN_BITFIELD)
 474                 unsigned reserved7      :1;
 475                 unsigned reserved654    :3;
 476                 unsigned reserved321    :3;
 477                 unsigned dma            :1;
 478 #else
 479 #error "Please fix <asm/byteorder.h>"
 480 #endif
 481         } b;
 482 } atapi_feature_t;
 483
 484 /*
 485  * ATAPI Interrupt Reason Register.
 486  *
 487  * cod          : Information transferred is command (1) or data (0)
 488  * io           : The device requests us to read (1) or write (0)
 489  * reserved     : Reserved
 490  */
 491 typedef union {
 492         unsigned all                    :8;
 493         struct {
 494 #if defined(__LITTLE_ENDIAN_BITFIELD)
 495                 unsigned cod            :1;
 496                 unsigned io             :1;
 497                 unsigned reserved       :6;
 498 #elif defined(__BIG_ENDIAN_BITFIELD)
 499                 unsigned reserved       :6;
 500                 unsigned io             :1;
 501                 unsigned cod            :1;
 502 #else
 503 #error "Please fix <asm/byteorder.h>"
 504 #endif
 505         } b;
 506 } atapi_ireason_t;
 507
 508 /*
 509  * The ATAPI error register.
 510  *
 511  * ili          : Illegal Length Indication
 512  * eom          : End Of Media Detected
 513  * abrt         : Aborted command - As defined by ATA
 514  * mcr          : Media Change Requested - As defined by ATA
 515  * sense_key    : Sense key of the last failed packet command
 516  */
 517 typedef union {
 518         unsigned all                    :8;
 519         struct {
 520 #if defined(__LITTLE_ENDIAN_BITFIELD)
 521                 unsigned ili            :1;
 522                 unsigned eom            :1;
 523                 unsigned abrt           :1;
 524                 unsigned mcr            :1;
 525                 unsigned sense_key      :4;
 526 #elif defined(__BIG_ENDIAN_BITFIELD)
 527                 unsigned sense_key      :4;
 528                 unsigned mcr            :1;
 529                 unsigned abrt           :1;
 530                 unsigned eom            :1;
 531                 unsigned ili            :1;
 532 #else
 533 #error "Please fix <asm/byteorder.h>"
 534 #endif
 535         } b;
 536 } atapi_error_t;
 537
 538 /*
 539  * Status returned from various ide_ functions
 540  */
 541 typedef enum {
 542         ide_stopped,    /* no drive operation was started */
 543         ide_started,    /* a drive operation was started, handler was set */
 544 } ide_startstop_t;
 545
 546 struct ide_driver_s;
 547 struct ide_settings_s;
 548
 549 #ifdef CONFIG_BLK_DEV_IDEACPI
 550 struct ide_acpi_drive_link;
 551 struct ide_acpi_hwif_link;
 552 #endif
 553
 554 typedef struct ide_drive_s {
 555         char            name[4];        /* drive name, such as "hda" */
 556         char            driver_req[10]; /* requests specific driver */
 557
 558         request_queue_t         *queue; /* request queue */
 559
 560         struct request          *rq;    /* current request */
 561         struct ide_drive_s      *next;  /* circular list of hwgroup drives */
 562         void            *driver_data;   /* extra driver data */
 563         struct hd_driveid       *id;    /* drive model identification info */
 564 #ifdef CONFIG_IDE_PROC_FS
 565         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
 566         struct ide_settings_s *settings;/* /proc/ide/ drive settings */
 567 #endif
 568         struct hwif_s           *hwif;  /* actually (ide_hwif_t *) */
 569
 570         unsigned long sleep;            /* sleep until this time */
 571         unsigned long service_start;    /* time we started last request */
 572         unsigned long service_time;     /* service time of last request */
 573         unsigned long timeout;          /* max time to wait for irq */
 574
 575         special_t       special;        /* special action flags */
 576         select_t        select;         /* basic drive/head select reg value */
 577
 578         u8      keep_settings;          /* restore settings after drive reset */
 579         u8      autodma;                /* device can safely use dma on host */
 580         u8      using_dma;              /* disk is using dma for read/write */
 581         u8      retry_pio;              /* retrying dma capable host in pio */
 582         u8      state;                  /* retry state */
 583         u8      waiting_for_dma;        /* dma currently in progress */
 584         u8      unmask;                 /* okay to unmask other irqs */
 585         u8      bswap;                  /* byte swap data */
 586         u8      noflush;                /* don't attempt flushes */
 587         u8      dsc_overlap;            /* DSC overlap */
 588         u8      nice1;                  /* give potential excess bandwidth */
 589
 590         unsigned present        : 1;    /* drive is physically present */
 591         unsigned dead           : 1;    /* device ejected hint */
 592         unsigned id_read        : 1;    /* 1=id read from disk 0 = synthetic */
 593         unsigned noprobe        : 1;    /* from:  hdx=noprobe */
 594         unsigned removable      : 1;    /* 1 if need to do check_media_change */
 595         unsigned attach         : 1;    /* needed for removable devices */
 596         unsigned forced_geom    : 1;    /* 1 if hdx=c,h,s was given at boot */
 597         unsigned no_unmask      : 1;    /* disallow setting unmask bit */
 598         unsigned no_io_32bit    : 1;    /* disallow enabling 32bit I/O */
 599         unsigned atapi_overlap  : 1;    /* ATAPI overlap (not supported) */
 600         unsigned nice0          : 1;    /* give obvious excess bandwidth */
 601         unsigned nice2          : 1;    /* give a share in our own bandwidth */
 602         unsigned doorlocking    : 1;    /* for removable only: door lock/unlock works */
 603         unsigned autotune       : 2;    /* 0=default, 1=autotune, 2=noautotune */
 604         unsigned remap_0_to_1   : 1;    /* 0=noremap, 1=remap 0->1 (for EZDrive) */
 605         unsigned blocked        : 1;    /* 1=powermanagment told us not to do anything, so sleep nicely */
 606         unsigned vdma           : 1;    /* 1=doing PIO over DMA 0=doing normal DMA */
 607         unsigned scsi           : 1;    /* 0=default, 1=ide-scsi emulation */
 608         unsigned sleeping       : 1;    /* 1=sleeping & sleep field valid */
 609         unsigned post_reset     : 1;
 610         unsigned udma33_warned  : 1;
 611
 612         u8      addressing;     /* 0=28-bit, 1=48-bit, 2=48-bit doing 28-bit */
 613         u8      quirk_list;     /* considered quirky, set for a specific host */
 614         u8      init_speed;     /* transfer rate set at boot */
 615         u8      current_speed;  /* current transfer rate set */
 616         u8      desired_speed;  /* desired transfer rate set */
 617         u8      dn;             /* now wide spread use */
 618         u8      wcache;         /* status of write cache */
 619         u8      acoustic;       /* acoustic management */
 620         u8      media;          /* disk, cdrom, tape, floppy, ... */
 621         u8      ctl;            /* "normal" value for IDE_CONTROL_REG */
 622         u8      ready_stat;     /* min status value for drive ready */
 623         u8      mult_count;     /* current multiple sector setting */
 624         u8      mult_req;       /* requested multiple sector setting */
 625         u8      tune_req;       /* requested drive tuning setting */
 626         u8      io_32bit;       /* 0=16-bit, 1=32-bit, 2/3=32bit+sync */
 627         u8      bad_wstat;      /* used for ignoring WRERR_STAT */
 628         u8      nowerr;         /* used for ignoring WRERR_STAT */
 629         u8      sect0;          /* offset of first sector for DM6:DDO */
 630         u8      head;           /* "real" number of heads */
 631         u8      sect;           /* "real" sectors per track */
 632         u8      bios_head;      /* BIOS/fdisk/LILO number of heads */
 633         u8      bios_sect;      /* BIOS/fdisk/LILO sectors per track */
 634
 635         unsigned int    bios_cyl;       /* BIOS/fdisk/LILO number of cyls */
 636         unsigned int    cyl;            /* "real" number of cyls */
 637         unsigned int    drive_data;     /* use by tuneproc/selectproc */
 638         unsigned int    failures;       /* current failure count */
 639         unsigned int    max_failures;   /* maximum allowed failure count */
 640         u64             probed_capacity;/* initial reported media capacity (ide-cd only currently) */
 641
 642         u64             capacity64;     /* total number of sectors */
 643
 644         int             lun;            /* logical unit */
 645         int             crc_count;      /* crc counter to reduce drive speed */
 646 #ifdef CONFIG_BLK_DEV_IDEACPI
 647         struct ide_acpi_drive_link *acpidata;
 648 #endif
 649         struct list_head list;
 650         struct device   gendev;
 651         struct completion gendev_rel_comp;      /* to deal with device release() */
 652 } ide_drive_t;
 653
 654 #define to_ide_device(dev)container_of(dev, ide_drive_t, gendev)
 655
 656 #define IDE_CHIPSET_PCI_MASK    \
 657     ((1<<ide_pci)|(1<<ide_cmd646)|(1<<ide_ali14xx))
 658 #define IDE_CHIPSET_IS_PCI(c)   ((IDE_CHIPSET_PCI_MASK >> (c)) & 1)
 659
 660 struct ide_pci_device_s;
 661
 662 typedef struct hwif_s {
 663         struct hwif_s *next;            /* for linked-list in ide_hwgroup_t */
 664         struct hwif_s *mate;            /* other hwif from same PCI chip */
 665         struct hwgroup_s *hwgroup;      /* actually (ide_hwgroup_t *) */
 666         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
 667
 668         char name[6];                   /* name of interface, eg. "ide0" */
 669
 670                 /* task file registers for pata and sata */
 671         unsigned long   io_ports[IDE_NR_PORTS];
 672         unsigned long   sata_scr[SATA_NR_PORTS];
 673         unsigned long   sata_misc[SATA_NR_PORTS];
 674
 675         hw_regs_t       hw;             /* Hardware info */
 676         ide_drive_t     drives[MAX_DRIVES];     /* drive info */
 677
 678         u8 major;       /* our major number */
 679         u8 index;       /* 0 for ide0; 1 for ide1; ... */
 680         u8 channel;     /* for dual-port chips: 0=primary, 1=secondary */
 681         u8 straight8;   /* Alan's straight 8 check */
 682         u8 bus_state;   /* power state of the IDE bus */
 683
 684         u8 host_flags;
 685
 686         u8 pio_mask;
 687
 688         u8 atapi_dma;   /* host supports atapi_dma */
 689         u8 ultra_mask;
 690         u8 mwdma_mask;
 691         u8 swdma_mask;
 692
 693         u8 cbl;         /* cable type */
 694
 695         hwif_chipset_t chipset; /* sub-module for tuning.. */
 696
 697         struct pci_dev  *pci_dev;       /* for pci chipsets */
 698         struct ide_pci_device_s *cds;   /* chipset device struct */
 699
 700         void (*rw_disk)(ide_drive_t *, struct request *);
 701
 702 #if 0
 703         ide_hwif_ops_t  *hwifops;
 704 #else
 705         /* routine to tune PIO mode for drives */
 706         void    (*tuneproc)(ide_drive_t *, u8);
 707         /* routine to retune DMA modes for drives */
 708         int     (*speedproc)(ide_drive_t *, u8);
 709         /* tweaks hardware to select drive */
 710         void    (*selectproc)(ide_drive_t *);
 711         /* chipset polling based on hba specifics */
 712         int     (*reset_poll)(ide_drive_t *);
 713         /* chipset specific changes to default for device-hba resets */
 714         void    (*pre_reset)(ide_drive_t *);
 715         /* routine to reset controller after a disk reset */
 716         void    (*resetproc)(ide_drive_t *);
 717         /* special interrupt handling for shared pci interrupts */
 718         void    (*intrproc)(ide_drive_t *);
 719         /* special host masking for drive selection */
 720         void    (*maskproc)(ide_drive_t *, int);
 721         /* check host's drive quirk list */
 722         int     (*quirkproc)(ide_drive_t *);
 723         /* driver soft-power interface */
 724         int     (*busproc)(ide_drive_t *, int);
 725 #endif
 726         u8 (*udma_filter)(ide_drive_t *);
 727
 728         void (*ata_input_data)(ide_drive_t *, void *, u32);
 729         void (*ata_output_data)(ide_drive_t *, void *, u32);
 730
 731         void (*atapi_input_bytes)(ide_drive_t *, void *, u32);
 732         void (*atapi_output_bytes)(ide_drive_t *, void *, u32);
 733
 734         int (*dma_setup)(ide_drive_t *);
 735         void (*dma_exec_cmd)(ide_drive_t *, u8);
 736         void (*dma_start)(ide_drive_t *);
 737         int (*ide_dma_end)(ide_drive_t *drive);
 738         int (*ide_dma_check)(ide_drive_t *drive);
 739         int (*ide_dma_on)(ide_drive_t *drive);
 740         void (*dma_off_quietly)(ide_drive_t *drive);
 741         int (*ide_dma_test_irq)(ide_drive_t *drive);
 742         void (*ide_dma_clear_irq)(ide_drive_t *drive);
 743         void (*dma_host_on)(ide_drive_t *drive);
 744         void (*dma_host_off)(ide_drive_t *drive);
 745         void (*dma_lost_irq)(ide_drive_t *drive);
 746         void (*dma_timeout)(ide_drive_t *drive);
 747
 748         void (*OUTB)(u8 addr, unsigned long port);
 749         void (*OUTBSYNC)(ide_drive_t *drive, u8 addr, unsigned long port);
 750         void (*OUTW)(u16 addr, unsigned long port);
 751         void (*OUTSW)(unsigned long port, void *addr, u32 count);
 752         void (*OUTSL)(unsigned long port, void *addr, u32 count);
 753
 754         u8  (*INB)(unsigned long port);
 755         u16 (*INW)(unsigned long port);
 756         void (*INSW)(unsigned long port, void *addr, u32 count);
 757         void (*INSL)(unsigned long port, void *addr, u32 count);
 758
 759         /* dma physical region descriptor table (cpu view) */
 760         unsigned int    *dmatable_cpu;
 761         /* dma physical region descriptor table (dma view) */
 762         dma_addr_t      dmatable_dma;
 763         /* Scatter-gather list used to build the above */
 764         struct scatterlist *sg_table;
 765         int sg_max_nents;               /* Maximum number of entries in it */
 766         int sg_nents;                   /* Current number of entries in it */
 767         int sg_dma_direction;           /* dma transfer direction */
 768
 769         /* data phase of the active command (currently only valid for PIO/DMA) */
 770         int             data_phase;
 771
 772         unsigned int nsect;
 773         unsigned int nleft;
 774         unsigned int cursg;
 775         unsigned int cursg_ofs;
 776
 777         int             rqsize;         /* max sectors per request */
 778         int             irq;            /* our irq number */
 779
 780         unsigned long   dma_master;     /* reference base addr dmabase */
 781         unsigned long   dma_base;       /* base addr for dma ports */
 782         unsigned long   dma_command;    /* dma command register */
 783         unsigned long   dma_vendor1;    /* dma vendor 1 register */
 784         unsigned long   dma_status;     /* dma status register */
 785         unsigned long   dma_vendor3;    /* dma vendor 3 register */
 786         unsigned long   dma_prdtable;   /* actual prd table address */
 787
 788         unsigned long   config_data;    /* for use by chipset-specific code */
 789         unsigned long   select_data;    /* for use by chipset-specific code */
 790
 791         unsigned long   extra_base;     /* extra addr for dma ports */
 792         unsigned        extra_ports;    /* number of extra dma ports */
 793
 794         unsigned        noprobe    : 1; /* don't probe for this interface */
 795         unsigned        present    : 1; /* this interface exists */
 796         unsigned        hold       : 1; /* this interface is always present */
 797         unsigned        serialized : 1; /* serialized all channel operation */
 798         unsigned        sharing_irq: 1; /* 1 = sharing irq with another hwif */
 799         unsigned        reset      : 1; /* reset after probe */
 800         unsigned        autodma    : 1; /* auto-attempt using DMA at boot */
 801         unsigned        no_lba48   : 1; /* 1 = cannot do LBA48 */
 802         unsigned        no_lba48_dma : 1; /* 1 = cannot do LBA48 DMA */
 803         unsigned        auto_poll  : 1; /* supports nop auto-poll */
 804         unsigned        sg_mapped  : 1; /* sg_table and sg_nents are ready */
 805         unsigned        no_io_32bit : 1; /* 1 = can not do 32-bit IO ops */
 806         unsigned        err_stops_fifo : 1; /* 1=data FIFO is cleared by an error */
 807         unsigned        mmio       : 1; /* host uses MMIO */
 808
 809         struct device   gendev;
 810         struct completion gendev_rel_comp; /* To deal with device release() */
 811
 812         void            *hwif_data;     /* extra hwif data */
 813
 814         unsigned dma;
 815
 816 #ifdef CONFIG_BLK_DEV_IDEACPI
 817         struct ide_acpi_hwif_link *acpidata;
 818 #endif
 819 } ____cacheline_internodealigned_in_smp ide_hwif_t;
 820
 821 /*
 822  *  internal ide interrupt handler type
 823  */
 824 typedef ide_startstop_t (ide_pre_handler_t)(ide_drive_t *, struct request *);
 825 typedef ide_startstop_t (ide_handler_t)(ide_drive_t *);
 826 typedef int (ide_expiry_t)(ide_drive_t *);
 827
 828 typedef struct hwgroup_s {
 829                 /* irq handler, if active */
 830         ide_startstop_t (*handler)(ide_drive_t *);
 831                 /* irq handler, suspended if active */
 832         ide_startstop_t (*handler_save)(ide_drive_t *);
 833                 /* BOOL: protects all fields below */
 834         volatile int busy;
 835                 /* BOOL: wake us up on timer expiry */
 836         unsigned int sleeping   : 1;
 837                 /* BOOL: polling active & poll_timeout field valid */
 838         unsigned int polling    : 1;
 839                 /* BOOL: in a polling reset situation. Must not trigger another reset yet */
 840         unsigned int resetting  : 1;
 841
 842                 /* current drive */
 843         ide_drive_t *drive;
 844                 /* ptr to current hwif in linked-list */
 845         ide_hwif_t *hwif;
 846
 847                 /* for pci chipsets */
 848         struct pci_dev *pci_dev;
 849                 /* chipset device struct */
 850         struct ide_pci_device_s *cds;
 851
 852                 /* current request */
 853         struct request *rq;
 854                 /* failsafe timer */
 855         struct timer_list timer;
 856                 /* local copy of current write rq */
 857         struct request wrq;
 858                 /* timeout value during long polls */
 859         unsigned long poll_timeout;
 860                 /* queried upon timeouts */
 861         int (*expiry)(ide_drive_t *);
 862                 /* ide_system_bus_speed */
 863         int pio_clock;
 864         int req_gen;
 865         int req_gen_timer;
 866
 867         unsigned char cmd_buf[4];
 868 } ide_hwgroup_t;
 869
 870 typedef struct ide_driver_s ide_driver_t;
 871
 872 extern struct mutex ide_setting_mtx;
 873
 874 int set_io_32bit(ide_drive_t *, int);
 875 int set_pio_mode(ide_drive_t *, int);
 876 int set_using_dma(ide_drive_t *, int);
 877
 878 #ifdef CONFIG_IDE_PROC_FS
 879 /*
 880  * configurable drive settings
 881  */
 882
 883 #define TYPE_INT        0
 884 #define TYPE_BYTE       1
 885 #define TYPE_SHORT      2
 886
 887 #define SETTING_READ    (1 << 0)
 888 #define SETTING_WRITE   (1 << 1)
 889 #define SETTING_RW      (SETTING_READ | SETTING_WRITE)
 890
 891 typedef int (ide_procset_t)(ide_drive_t *, int);
 892 typedef struct ide_settings_s {
 893         char                    *name;
 894         int                     rw;
 895         int                     data_type;
 896         int                     min;
 897         int                     max;
 898         int                     mul_factor;
 899         int                     div_factor;
 900         void                    *data;
 901         ide_procset_t           *set;
 902         int                     auto_remove;
 903         struct ide_settings_s   *next;
 904 } ide_settings_t;
 905
 906 int ide_add_setting(ide_drive_t *, const char *, int, int, int, int, int, int, void *, ide_procset_t *set);
 907
 908 /*
 909  * /proc/ide interface
 910  */
 911 typedef struct {
 912         const char      *name;
 913         mode_t          mode;
 914         read_proc_t     *read_proc;
 915         write_proc_t    *write_proc;
 916 } ide_proc_entry_t;
 917
 918 void proc_ide_create(void);
 919 void proc_ide_destroy(void);
 920 void ide_proc_register_port(ide_hwif_t *);
 921 void ide_proc_unregister_port(ide_hwif_t *);
 922 void ide_proc_register_driver(ide_drive_t *, ide_driver_t *);
 923 void ide_proc_unregister_driver(ide_drive_t *, ide_driver_t *);
 924
 925 void ide_add_generic_settings(ide_drive_t *);
 926
 927 read_proc_t proc_ide_read_capacity;
 928 read_proc_t proc_ide_read_geometry;
 929
 930 #ifdef CONFIG_BLK_DEV_IDEPCI
 931 void ide_pci_create_host_proc(const char *, get_info_t *);
 932 #endif
 933
 934 /*
 935  * Standard exit stuff:
 936  */
 937 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) \
 938 {                                       \
 939         len -= off;                     \
 940         if (len < count) {              \
 941                 *eof = 1;               \
 942                 if (len <= 0)           \
 943                         return 0;       \
 944         } else                          \
 945                 len = count;            \
 946         *start = page + off;            \
 947         return len;                     \
 948 }
 949 #else
 950 static inline void proc_ide_create(void) { ; }
 951 static inline void proc_ide_destroy(void) { ; }
 952 static inline void ide_proc_register_port(ide_hwif_t *hwif) { ; }
 953 static inline void ide_proc_unregister_port(ide_hwif_t *hwif) { ; }
 954 static inline void ide_proc_register_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
 955 static inline void ide_proc_unregister_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
 956 static inline void ide_add_generic_settings(ide_drive_t *drive) { ; }
 957 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) return 0;
 958 #endif
 959
 960 /*
 961  * Power Management step value (rq->pm->pm_step).
 962  *
 963  * The step value starts at 0 (ide_pm_state_start_suspend) for a
 964  * suspend operation or 1000 (ide_pm_state_start_resume) for a
 965  * resume operation.
 966  *
 967  * For each step, the core calls the subdriver start_power_step() first.
 968  * This can return:
 969  *      - ide_stopped : In this case, the core calls us back again unless
 970  *                      step have been set to ide_power_state_completed.
 971  *      - ide_started : In this case, the channel is left busy until an
 972  *                      async event (interrupt) occurs.
 973  * Typically, start_power_step() will issue a taskfile request with
 974  * do_rw_taskfile().
 975  *
 976  * Upon reception of the interrupt, the core will call complete_power_step()
 977  * with the error code if any. This routine should update the step value
 978  * and return. It should not start a new request. The core will call
 979  * start_power_step for the new step value, unless step have been set to
 980  * ide_power_state_completed.
 981  *
 982  * Subdrivers are expected to define their own additional power
 983  * steps from 1..999 for suspend and from 1001..1999 for resume,
 984  * other values are reserved for future use.
 985  */
 986
 987 enum {
 988         ide_pm_state_completed          = -1,
 989         ide_pm_state_start_suspend      = 0,
 990         ide_pm_state_start_resume       = 1000,
 991 };
 992
 993 /*
 994  * Subdrivers support.
 995  *
 996  * The gendriver.owner field should be set to the module owner of this driver.
 997  * The gendriver.name field should be set to the name of this driver
 998  */
 999 struct ide_driver_s {
1000         const char                      *version;
1001         u8                              media;
1002         unsigned supports_dsc_overlap   : 1;
1003         ide_startstop_t (*do_request)(ide_drive_t *, struct request *, sector_t);
1004         int             (*end_request)(ide_drive_t *, int, int);
1005         ide_startstop_t (*error)(ide_drive_t *, struct request *rq, u8, u8);
1006         ide_startstop_t (*abort)(ide_drive_t *, struct request *rq);
1007         struct device_driver    gen_driver;
1008         int             (*probe)(ide_drive_t *);
1009         void            (*remove)(ide_drive_t *);
1010         void            (*resume)(ide_drive_t *);
1011         void            (*shutdown)(ide_drive_t *);
1012 #ifdef CONFIG_IDE_PROC_FS
1013         ide_proc_entry_t        *proc;
1014 #endif
1015 };
1016
1017 #define to_ide_driver(drv) container_of(drv, ide_driver_t, gen_driver)
1018
1019 int generic_ide_ioctl(ide_drive_t *, struct file *, struct block_device *, unsigned, unsigned long);
1020
1021 /*
1022  * ide_hwifs[] is the master data structure used to keep track
1023  * of just about everything in ide.c.  Whenever possible, routines
1024  * should be using pointers to a drive (ide_drive_t *) or
1025  * pointers to a hwif (ide_hwif_t *), rather than indexing this
1026  * structure directly (the allocation/layout may change!).
1027  *
1028  */
1029 #ifndef _IDE_C
1030 extern  ide_hwif_t      ide_hwifs[];            /* master data repository */
1031 #endif
1032 extern int noautodma;
1033
1034 extern int ide_end_request (ide_drive_t *drive, int uptodate, int nrsecs);
1035 int ide_end_dequeued_request(ide_drive_t *drive, struct request *rq,
1036                              int uptodate, int nr_sectors);
1037
1038 /*
1039  * This is used on exit from the driver to designate the next irq handler
1040  * and also to start the safety timer.
1041  */
1042 extern void ide_set_handler (ide_drive_t *drive, ide_handler_t *handler, unsigned int timeout, ide_expiry_t *expiry);
1043
1044 /*
1045  * This is used on exit from the driver to designate the next irq handler
1046  * and start the safety time safely and atomically from the IRQ handler
1047  * with respect to the command issue (which it also does)
1048  */
1049 extern void ide_execute_command(ide_drive_t *, task_ioreg_t cmd, ide_handler_t *, unsigned int, ide_expiry_t *);
1050
1051 ide_startstop_t __ide_error(ide_drive_t *, struct request *, u8, u8);
1052
1053 /*
1054  * ide_error() takes action based on the error returned by the controller.
1055  * The caller should return immediately after invoking this.
1056  *
1057  * (drive, msg, status)
1058  */
1059 ide_startstop_t ide_error (ide_drive_t *drive, const char *msg, byte stat);
1060
1061 ide_startstop_t __ide_abort(ide_drive_t *, struct request *);
1062
1063 /*
1064  * Abort a running command on the controller triggering the abort
1065  * from a host side, non error situation
1066  * (drive, msg)
1067  */
1068 extern ide_startstop_t ide_abort(ide_drive_t *, const char *);
1069
1070 extern void ide_fix_driveid(struct hd_driveid *);
1071 /*
1072  * ide_fixstring() cleans up and (optionally) byte-swaps a text string,
1073  * removing leading/trailing blanks and compressing internal blanks.
1074  * It is primarily used to tidy up the model name/number fields as
1075  * returned by the WIN_[P]IDENTIFY commands.
1076  *
1077  * (s, bytecount, byteswap)
1078  */
1079 extern void ide_fixstring(u8 *, const int, const int);
1080
1081 /*
1082  * This routine busy-waits for the drive status to be not "busy".
1083  * It then checks the status for all of the "good" bits and none
1084  * of the "bad" bits, and if all is okay it returns 0.  All other
1085  * cases return 1 after doing "*startstop = ide_error()", and the
1086  * caller should return the updated value of "startstop" in this case.
1087  * "startstop" is unchanged when the function returns 0;
1088  * (startstop, drive, good, bad, timeout)
1089  */
1090 extern int ide_wait_stat(ide_startstop_t *, ide_drive_t *, u8, u8, unsigned long);
1091
1092 /*
1093  * Start a reset operation for an IDE interface.
1094  * The caller should return immediately after invoking this.
1095  */
1096 extern ide_startstop_t ide_do_reset (ide_drive_t *);
1097
1098 /*
1099  * This function is intended to be used prior to invoking ide_do_drive_cmd().
1100  */
1101 extern void ide_init_drive_cmd (struct request *rq);
1102
1103 /*
1104  * this function returns error location sector offset in case of a write error
1105  */
1106 extern u64 ide_get_error_location(ide_drive_t *, char *);
1107
1108 /*
1109  * "action" parameter type for ide_do_drive_cmd() below.
1110  */
1111 typedef enum {
1112         ide_wait,       /* insert rq at end of list, and wait for it */
1113         ide_preempt,    /* insert rq in front of current request */
1114         ide_head_wait,  /* insert rq in front of current request and wait for it */
1115         ide_end         /* insert rq at end of list, but don't wait for it */
1116 } ide_action_t;
1117
1118 extern int ide_do_drive_cmd(ide_drive_t *, struct request *, ide_action_t);
1119
1120 /*
1121  * Clean up after success/failure of an explicit drive cmd.
1122  * stat/err are used only when (HWGROUP(drive)->rq->cmd == IDE_DRIVE_CMD).
1123  * stat/err are used only when (HWGROUP(drive)->rq->cmd == IDE_DRIVE_TASK_MASK).
1124  *
1125  * (ide_drive_t *drive, u8 stat, u8 err)
1126  */
1127 extern void ide_end_drive_cmd(ide_drive_t *, u8, u8);
1128
1129 /*
1130  * Issue ATA command and wait for completion.
1131  * Use for implementing commands in kernel
1132  *
1133  *  (ide_drive_t *drive, u8 cmd, u8 nsect, u8 feature, u8 sectors, u8 *buf)
1134  */
1135 extern int ide_wait_cmd(ide_drive_t *, u8, u8, u8, u8, u8 *);
1136
1137 typedef struct ide_task_s {
1138 /*
1139  *      struct hd_drive_task_hdr        tf;
1140  *      task_struct_t           tf;
1141  *      struct hd_drive_hob_hdr         hobf;
1142  *      hob_struct_t            hobf;
1143  */
1144         task_ioreg_t            tfRegister[8];
1145         task_ioreg_t            hobRegister[8];
1146         ide_reg_valid_t         tf_out_flags;
1147         ide_reg_valid_t         tf_in_flags;
1148         int                     data_phase;
1149         int                     command_type;
1150         ide_pre_handler_t       *prehandler;
1151         ide_handler_t           *handler;
1152         struct request          *rq;            /* copy of request */
1153         void                    *special;       /* valid_t generally */
1154 } ide_task_t;
1155
1156 extern u32 ide_read_24(ide_drive_t *);
1157
1158 extern void SELECT_DRIVE(ide_drive_t *);
1159 extern void SELECT_INTERRUPT(ide_drive_t *);
1160 extern void SELECT_MASK(ide_drive_t *, int);
1161 extern void QUIRK_LIST(ide_drive_t *);
1162
1163 extern int drive_is_ready(ide_drive_t *);
1164 extern int wait_for_ready(ide_drive_t *, int /* timeout */);
1165
1166 /*
1167  * taskfile io for disks for now...and builds request from ide_ioctl
1168  */
1169 extern ide_startstop_t do_rw_taskfile(ide_drive_t *, ide_task_t *);
1170
1171 /*
1172  * Special Flagged Register Validation Caller
1173  */
1174 extern ide_startstop_t flagged_taskfile(ide_drive_t *, ide_task_t *);
1175
1176 extern ide_startstop_t set_multmode_intr(ide_drive_t *);
1177 extern ide_startstop_t set_geometry_intr(ide_drive_t *);
1178 extern ide_startstop_t recal_intr(ide_drive_t *);
1179 extern ide_startstop_t task_no_data_intr(ide_drive_t *);
1180 extern ide_startstop_t task_in_intr(ide_drive_t *);
1181 extern ide_startstop_t pre_task_out_intr(ide_drive_t *, struct request *);
1182
1183 extern int ide_raw_taskfile(ide_drive_t *, ide_task_t *, u8 *);
1184
1185 int ide_taskfile_ioctl(ide_drive_t *, unsigned int, unsigned long);
1186 int ide_cmd_ioctl(ide_drive_t *, unsigned int, unsigned long);
1187 int ide_task_ioctl(ide_drive_t *, unsigned int, unsigned long);
1188
1189 extern int system_bus_clock(void);
1190
1191 extern int ide_driveid_update(ide_drive_t *);
1192 extern int ide_ata66_check(ide_drive_t *, ide_task_t *);
1193 extern int ide_config_drive_speed(ide_drive_t *, u8);
1194 extern u8 eighty_ninty_three (ide_drive_t *);
1195 extern int set_transfer(ide_drive_t *, ide_task_t *);
1196 extern int taskfile_lib_get_identify(ide_drive_t *drive, u8 *);
1197
1198 extern int ide_wait_not_busy(ide_hwif_t *hwif, unsigned long timeout);
1199
1200 /*
1201  * ide_stall_queue() can be used by a drive to give excess bandwidth back
1202  * to the hwgroup by sleeping for timeout jiffies.
1203  */
1204 extern void ide_stall_queue(ide_drive_t *drive, unsigned long timeout);
1205
1206 extern int ide_spin_wait_hwgroup(ide_drive_t *);
1207 extern void ide_timer_expiry(unsigned long);
1208 extern irqreturn_t ide_intr(int irq, void *dev_id);
1209 extern void do_ide_request(request_queue_t *);
1210
1211 void ide_init_disk(struct gendisk *, ide_drive_t *);
1212
1213 extern int ideprobe_init(void);
1214
1215 #ifdef CONFIG_IDEPCI_PCIBUS_ORDER
1216 extern void ide_scan_pcibus(int scan_direction) __init;
1217 extern int __ide_pci_register_driver(struct pci_driver *driver, struct module *owner, const char *mod_name);
1218 #define ide_pci_register_driver(d) __ide_pci_register_driver(d, THIS_MODULE, KBUILD_MODNAME)
1219 #else
1220 #define ide_pci_register_driver(d) pci_register_driver(d)
1221 #endif
1222
1223 void ide_pci_setup_ports(struct pci_dev *, struct ide_pci_device_s *, int, ata_index_t *);
1224 extern void ide_setup_pci_noise (struct pci_dev *dev, struct ide_pci_device_s *d);
1225
1226 extern void default_hwif_iops(ide_hwif_t *);
1227 extern void default_hwif_mmiops(ide_hwif_t *);
1228 extern void default_hwif_transport(ide_hwif_t *);
1229
1230 #define ON_BOARD                1
1231 #define NEVER_BOARD             0
1232
1233 #ifdef CONFIG_BLK_DEV_OFFBOARD
1234 #  define OFF_BOARD             ON_BOARD
1235 #else /* CONFIG_BLK_DEV_OFFBOARD */
1236 #  define OFF_BOARD             NEVER_BOARD
1237 #endif /* CONFIG_BLK_DEV_OFFBOARD */
1238
1239 #define NODMA 0
1240 #define NOAUTODMA 1
1241 #define AUTODMA 2
1242
1243 typedef struct ide_pci_enablebit_s {
1244         u8      reg;    /* byte pci reg holding the enable-bit */
1245         u8      mask;   /* mask to isolate the enable-bit */
1246         u8      val;    /* value of masked reg when "enabled" */
1247 } ide_pci_enablebit_t;
1248
1249 enum {
1250         /* Uses ISA control ports not PCI ones. */
1251         IDE_HFLAG_ISA_PORTS             = (1 << 0),
1252         /* single port device */
1253         IDE_HFLAG_SINGLE                = (1 << 1),
1254         /* don't use legacy PIO blacklist */
1255         IDE_HFLAG_PIO_NO_BLACKLIST      = (1 << 2),
1256         /* don't use conservative PIO "downgrade" */
1257         IDE_HFLAG_PIO_NO_DOWNGRADE      = (1 << 3),
1258 };
1259
1260 typedef struct ide_pci_device_s {
1261         char                    *name;
1262         int                     (*init_setup)(struct pci_dev *, struct ide_pci_device_s *);
1263         void                    (*init_setup_dma)(struct pci_dev *, struct ide_pci_device_s *, ide_hwif_t *);
1264         unsigned int            (*init_chipset)(struct pci_dev *, const char *);
1265         void                    (*init_iops)(ide_hwif_t *);
1266         void                    (*init_hwif)(ide_hwif_t *);
1267         void                    (*init_dma)(ide_hwif_t *, unsigned long);
1268         void                    (*fixup)(ide_hwif_t *);
1269         u8                      autodma;
1270         ide_pci_enablebit_t     enablebits[2];
1271         u8                      bootable;
1272         unsigned int            extra;
1273         struct ide_pci_device_s *next;
1274         u8                      host_flags;
1275         u8                      pio_mask;
1276         u8                      udma_mask;
1277 } ide_pci_device_t;
1278
1279 extern int ide_setup_pci_device(struct pci_dev *, ide_pci_device_t *);
1280 extern int ide_setup_pci_devices(struct pci_dev *, struct pci_dev *, ide_pci_device_t *);
1281
1282 void ide_map_sg(ide_drive_t *, struct request *);
1283 void ide_init_sg_cmd(ide_drive_t *, struct request *);
1284
1285 #define BAD_DMA_DRIVE           0
1286 #define GOOD_DMA_DRIVE          1
1287
1288 #ifdef CONFIG_BLK_DEV_IDEDMA
1289 struct drive_list_entry {
1290         const char *id_model;
1291         const char *id_firmware;
1292 };
1293
1294 int ide_in_drive_list(struct hd_driveid *, const struct drive_list_entry *);
1295 int __ide_dma_bad_drive(ide_drive_t *);
1296 int __ide_dma_good_drive(ide_drive_t *);
1297 u8 ide_max_dma_mode(ide_drive_t *);
1298 int ide_tune_dma(ide_drive_t *);
1299 void ide_dma_off(ide_drive_t *);
1300 void ide_dma_verbose(ide_drive_t *);
1301 int ide_set_dma(ide_drive_t *);
1302 ide_startstop_t ide_dma_intr(ide_drive_t *);
1303
1304 #ifdef CONFIG_BLK_DEV_IDEDMA_PCI
1305 extern int ide_build_sglist(ide_drive_t *, struct request *);
1306 extern int ide_build_dmatable(ide_drive_t *, struct request *);
1307 extern void ide_destroy_dmatable(ide_drive_t *);
1308 extern int ide_release_dma(ide_hwif_t *);
1309 extern void ide_setup_dma(ide_hwif_t *, unsigned long, unsigned int);
1310
1311 void ide_dma_host_off(ide_drive_t *);
1312 void ide_dma_off_quietly(ide_drive_t *);
1313 void ide_dma_host_on(ide_drive_t *);
1314 extern int __ide_dma_on(ide_drive_t *);
1315 extern int __ide_dma_check(ide_drive_t *);
1316 extern int ide_dma_setup(ide_drive_t *);
1317 extern void ide_dma_start(ide_drive_t *);
1318 extern int __ide_dma_end(ide_drive_t *);
1319 extern void ide_dma_lost_irq(ide_drive_t *);
1320 extern void ide_dma_timeout(ide_drive_t *);
1321 #endif /* CONFIG_BLK_DEV_IDEDMA_PCI */
1322
1323 #else
1324 static inline u8 ide_max_dma_mode(ide_drive_t *drive) { return 0; }
1325 static inline int ide_tune_dma(ide_drive_t *drive) { return 0; }
1326 static inline void ide_dma_off(ide_drive_t *drive) { ; }
1327 static inline void ide_dma_verbose(ide_drive_t *drive) { ; }
1328 static inline int ide_set_dma(ide_drive_t *drive) { return 1; }
1329 #endif /* CONFIG_BLK_DEV_IDEDMA */
1330
1331 #ifndef CONFIG_BLK_DEV_IDEDMA_PCI
1332 static inline void ide_release_dma(ide_hwif_t *drive) {;}
1333 #endif
1334
1335 #ifdef CONFIG_BLK_DEV_IDEACPI
1336 extern int ide_acpi_exec_tfs(ide_drive_t *drive);
1337 extern void ide_acpi_get_timing(ide_hwif_t *hwif);
1338 extern void ide_acpi_push_timing(ide_hwif_t *hwif);
1339 extern void ide_acpi_init(ide_hwif_t *hwif);
1340 #else
1341 static inline int ide_acpi_exec_tfs(ide_drive_t *drive) { return 0; }
1342 static inline void ide_acpi_get_timing(ide_hwif_t *hwif) { ; }
1343 static inline void ide_acpi_push_timing(ide_hwif_t *hwif) { ; }
1344 static inline void ide_acpi_init(ide_hwif_t *hwif) { ; }
1345 #endif
1346
1347 extern int ide_hwif_request_regions(ide_hwif_t *hwif);
1348 extern void ide_hwif_release_regions(ide_hwif_t* hwif);
1349 extern void ide_unregister (unsigned int index);
1350
1351 void ide_register_region(struct gendisk *);
1352 void ide_unregister_region(struct gendisk *);
1353
1354 void ide_undecoded_slave(ide_hwif_t *);
1355
1356 int probe_hwif_init_with_fixup(ide_hwif_t *, void (*)(ide_hwif_t *));
1357 extern int probe_hwif_init(ide_hwif_t *);
1358
1359 static inline void *ide_get_hwifdata (ide_hwif_t * hwif)
1360 {
1361         return hwif->hwif_data;
1362 }
1363
1364 static inline void ide_set_hwifdata (ide_hwif_t * hwif, void *data)
1365 {
1366         hwif->hwif_data = data;
1367 }
1368
1369 /* ide-lib.c */
1370 u8 ide_rate_filter(ide_drive_t *, u8);
1371 extern char *ide_xfer_verbose(u8 xfer_rate);
1372 extern void ide_toggle_bounce(ide_drive_t *drive, int on);
1373 extern int ide_set_xfer_rate(ide_drive_t *drive, u8 rate);
1374 int ide_use_fast_pio(ide_drive_t *);
1375
1376 static inline int ide_dev_has_iordy(struct hd_driveid *id)
1377 {
1378         return ((id->field_valid & 2) && (id->capability & 8)) ? 1 : 0;
1379 }
1380
1381 u8 ide_dump_status(ide_drive_t *, const char *, u8);
1382
1383 typedef struct ide_pio_timings_s {
1384         int     setup_time;     /* Address setup (ns) minimum */
1385         int     active_time;    /* Active pulse (ns) minimum */
1386         int     cycle_time;     /* Cycle time (ns) minimum = */
1387                                 /* active + recovery (+ setup for some chips) */
1388 } ide_pio_timings_t;
1389
1390 unsigned int ide_pio_cycle_time(ide_drive_t *, u8);
1391 u8 ide_get_best_pio_mode(ide_drive_t *, u8, u8);
1392 extern const ide_pio_timings_t ide_pio_timings[6];
1393
1394
1395 extern spinlock_t ide_lock;
1396 extern struct mutex ide_cfg_mtx;
1397 /*
1398  * Structure locking:
1399  *
1400  * ide_cfg_mtx and ide_lock together protect changes to
1401  * ide_hwif_t->{next,hwgroup}
1402  * ide_drive_t->next
1403  *
1404  * ide_hwgroup_t->busy: ide_lock
1405  * ide_hwgroup_t->hwif: ide_lock
1406  * ide_hwif_t->mate: constant, no locking
1407  * ide_drive_t->hwif: constant, no locking
1408  */
1409
1410 #define local_irq_set(flags)    do { local_save_flags((flags)); local_irq_enable_in_hardirq(); } while (0)
1411
1412 extern struct bus_type ide_bus_type;
1413
1414 /* check if CACHE FLUSH (EXT) command is supported (bits defined in ATA-6) */
1415 #define ide_id_has_flush_cache(id)      ((id)->cfs_enable_2 & 0x3000)
1416
1417 /* some Maxtor disks have bit 13 defined incorrectly so check bit 10 too */
1418 #define ide_id_has_flush_cache_ext(id)  \
1419         (((id)->cfs_enable_2 & 0x2400) == 0x2400)
1420
1421 static inline int hwif_to_node(ide_hwif_t *hwif)
1422 {
1423         struct pci_dev *dev = hwif->pci_dev;
1424         return dev ? pcibus_to_node(dev->bus) : -1;
1425 }
1426
1427 #endif /* _IDE_H */