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