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/blkdev.h>
  13 #include <linux/proc_fs.h>
  14 #include <linux/interrupt.h>
  15 #include <linux/bitops.h>
  16 #include <linux/bio.h>
  17 #include <linux/device.h>
  18 #include <linux/pci.h>
  19 #include <linux/completion.h>
  20 #ifdef CONFIG_BLK_DEV_IDEACPI
  21 #include <acpi/acpi.h>
  22 #endif
  23 #include <asm/byteorder.h>
  24 #include <asm/system.h>
  25 #include <asm/io.h>
  26 #include <asm/mutex.h>
  27
  28 #if defined(CONFIG_CRIS) || defined(CONFIG_FRV)
  29 # define SUPPORT_VLB_SYNC 0
  30 #else
  31 # define SUPPORT_VLB_SYNC 1
  32 #endif
  33
  34 /*
  35  * Used to indicate "no IRQ", should be a value that cannot be an IRQ
  36  * number.
  37  */
  38
  39 #define IDE_NO_IRQ              (-1)
  40
  41 typedef unsigned char   byte;   /* used everywhere */
  42
  43 /*
  44  * Probably not wise to fiddle with these
  45  */
  46 #define ERROR_MAX       8       /* Max read/write errors per sector */
  47 #define ERROR_RESET     3       /* Reset controller every 4th retry */
  48 #define ERROR_RECAL     1       /* Recalibrate every 2nd retry */
  49
  50 /*
  51  * state flags
  52  */
  53
  54 #define DMA_PIO_RETRY   1       /* retrying in PIO */
  55
  56 #define HWIF(drive)             ((ide_hwif_t *)((drive)->hwif))
  57 #define HWGROUP(drive)          ((ide_hwgroup_t *)(HWIF(drive)->hwgroup))
  58
  59 /*
  60  * Definitions for accessing IDE controller registers
  61  */
  62 #define IDE_NR_PORTS            (10)
  63
  64 struct ide_io_ports {
  65         unsigned long   data_addr;
  66
  67         union {
  68                 unsigned long error_addr;       /*   read:  error */
  69                 unsigned long feature_addr;     /*  write: feature */
  70         };
  71
  72         unsigned long   nsect_addr;
  73         unsigned long   lbal_addr;
  74         unsigned long   lbam_addr;
  75         unsigned long   lbah_addr;
  76
  77         unsigned long   device_addr;
  78
  79         union {
  80                 unsigned long status_addr;      /*  read: status  */
  81                 unsigned long command_addr;     /* write: command */
  82         };
  83
  84         unsigned long   ctl_addr;
  85
  86         unsigned long   irq_addr;
  87 };
  88
  89 #define OK_STAT(stat,good,bad)  (((stat)&((good)|(bad)))==(good))
  90 #define BAD_R_STAT              (BUSY_STAT   | ERR_STAT)
  91 #define BAD_W_STAT              (BAD_R_STAT  | WRERR_STAT)
  92 #define BAD_STAT                (BAD_R_STAT  | DRQ_STAT)
  93 #define DRIVE_READY             (READY_STAT  | SEEK_STAT)
  94
  95 #define BAD_CRC                 (ABRT_ERR    | ICRC_ERR)
  96
  97 #define SATA_NR_PORTS           (3)     /* 16 possible ?? */
  98
  99 #define SATA_STATUS_OFFSET      (0)
 100 #define SATA_ERROR_OFFSET       (1)
 101 #define SATA_CONTROL_OFFSET     (2)
 102
 103 /*
 104  * Our Physical Region Descriptor (PRD) table should be large enough
 105  * to handle the biggest I/O request we are likely to see.  Since requests
 106  * can have no more than 256 sectors, and since the typical blocksize is
 107  * two or more sectors, we could get by with a limit of 128 entries here for
 108  * the usual worst case.  Most requests seem to include some contiguous blocks,
 109  * further reducing the number of table entries required.
 110  *
 111  * The driver reverts to PIO mode for individual requests that exceed
 112  * this limit (possible with 512 byte blocksizes, eg. MSDOS f/s), so handling
 113  * 100% of all crazy scenarios here is not necessary.
 114  *
 115  * As it turns out though, we must allocate a full 4KB page for this,
 116  * so the two PRD tables (ide0 & ide1) will each get half of that,
 117  * allowing each to have about 256 entries (8 bytes each) from this.
 118  */
 119 #define PRD_BYTES       8
 120 #define PRD_ENTRIES     256
 121
 122 /*
 123  * Some more useful definitions
 124  */
 125 #define PARTN_BITS      6       /* number of minor dev bits for partitions */
 126 #define MAX_DRIVES      2       /* per interface; 2 assumed by lots of code */
 127 #define SECTOR_SIZE     512
 128 #define SECTOR_WORDS    (SECTOR_SIZE / 4)       /* number of 32bit words per sector */
 129 #define IDE_LARGE_SEEK(b1,b2,t) (((b1) > (b2) + (t)) || ((b2) > (b1) + (t)))
 130
 131 /*
 132  * Timeouts for various operations:
 133  */
 134 #define WAIT_DRQ        (HZ/10)         /* 100msec - spec allows up to 20ms */
 135 #define WAIT_READY      (5*HZ)          /* 5sec - some laptops are very slow */
 136 #define WAIT_PIDENTIFY  (10*HZ) /* 10sec  - should be less than 3ms (?), if all ATAPI CD is closed at boot */
 137 #define WAIT_WORSTCASE  (30*HZ) /* 30sec  - worst case when spinning up */
 138 #define WAIT_CMD        (10*HZ) /* 10sec  - maximum wait for an IRQ to happen */
 139 #define WAIT_MIN_SLEEP  (2*HZ/100)      /* 20msec - minimum sleep time */
 140
 141 /*
 142  * Op codes for special requests to be handled by ide_special_rq().
 143  * Values should be in the range of 0x20 to 0x3f.
 144  */
 145 #define REQ_DRIVE_RESET         0x20
 146
 147 /*
 148  * Check for an interrupt and acknowledge the interrupt status
 149  */
 150 struct hwif_s;
 151 typedef int (ide_ack_intr_t)(struct hwif_s *);
 152
 153 /*
 154  * hwif_chipset_t is used to keep track of the specific hardware
 155  * chipset used by each IDE interface, if known.
 156  */
 157 enum {          ide_unknown,    ide_generic,    ide_pci,
 158                 ide_cmd640,     ide_dtc2278,    ide_ali14xx,
 159                 ide_qd65xx,     ide_umc8672,    ide_ht6560b,
 160                 ide_rz1000,     ide_trm290,
 161                 ide_cmd646,     ide_cy82c693,   ide_4drives,
 162                 ide_pmac,       ide_acorn,
 163                 ide_au1xxx,     ide_palm3710
 164 };
 165
 166 typedef u8 hwif_chipset_t;
 167
 168 /*
 169  * Structure to hold all information about the location of this port
 170  */
 171 typedef struct hw_regs_s {
 172         union {
 173                 struct ide_io_ports     io_ports;
 174                 unsigned long           io_ports_array[IDE_NR_PORTS];
 175         };
 176
 177         int             irq;                    /* our irq number */
 178         ide_ack_intr_t  *ack_intr;              /* acknowledge interrupt */
 179         hwif_chipset_t  chipset;
 180         struct device   *dev, *parent;
 181         unsigned long   config;
 182 } hw_regs_t;
 183
 184 void ide_init_port_data(struct hwif_s *, unsigned int);
 185 void ide_init_port_hw(struct hwif_s *, hw_regs_t *);
 186
 187 static inline void ide_std_init_ports(hw_regs_t *hw,
 188                                       unsigned long io_addr,
 189                                       unsigned long ctl_addr)
 190 {
 191         unsigned int i;
 192
 193         for (i = 0; i <= 7; i++)
 194                 hw->io_ports_array[i] = io_addr++;
 195
 196         hw->io_ports.ctl_addr = ctl_addr;
 197 }
 198
 199 /* for IDE PCI controllers in legacy mode, temporary */
 200 static inline int __ide_default_irq(unsigned long base)
 201 {
 202         switch (base) {
 203 #ifdef CONFIG_IA64
 204         case 0x1f0: return isa_irq_to_vector(14);
 205         case 0x170: return isa_irq_to_vector(15);
 206 #else
 207         case 0x1f0: return 14;
 208         case 0x170: return 15;
 209 #endif
 210         }
 211         return 0;
 212 }
 213
 214 #include <asm/ide.h>
 215
 216 #if !defined(MAX_HWIFS) || defined(CONFIG_EMBEDDED)
 217 #undef MAX_HWIFS
 218 #define MAX_HWIFS       CONFIG_IDE_MAX_HWIFS
 219 #endif
 220
 221 /* Currently only m68k, apus and m8xx need it */
 222 #ifndef IDE_ARCH_ACK_INTR
 223 # define ide_ack_intr(hwif) (1)
 224 #endif
 225
 226 /* Currently only Atari needs it */
 227 #ifndef IDE_ARCH_LOCK
 228 # define ide_release_lock()                     do {} while (0)
 229 # define ide_get_lock(hdlr, data)               do {} while (0)
 230 #endif /* IDE_ARCH_LOCK */
 231
 232 /*
 233  * Now for the data we need to maintain per-drive:  ide_drive_t
 234  */
 235
 236 #define ide_scsi        0x21
 237 #define ide_disk        0x20
 238 #define ide_optical     0x7
 239 #define ide_cdrom       0x5
 240 #define ide_tape        0x1
 241 #define ide_floppy      0x0
 242
 243 /*
 244  * Special Driver Flags
 245  *
 246  * set_geometry : respecify drive geometry
 247  * recalibrate  : seek to cyl 0
 248  * set_multmode : set multmode count
 249  * set_tune     : tune interface for drive
 250  * serviced     : service command
 251  * reserved     : unused
 252  */
 253 typedef union {
 254         unsigned all                    : 8;
 255         struct {
 256                 unsigned set_geometry   : 1;
 257                 unsigned recalibrate    : 1;
 258                 unsigned set_multmode   : 1;
 259                 unsigned set_tune       : 1;
 260                 unsigned serviced       : 1;
 261                 unsigned reserved       : 3;
 262         } b;
 263 } special_t;
 264
 265 /*
 266  * ATA-IDE Select Register, aka Device-Head
 267  *
 268  * head         : always zeros here
 269  * unit         : drive select number: 0/1
 270  * bit5         : always 1
 271  * lba          : using LBA instead of CHS
 272  * bit7         : always 1
 273  */
 274 typedef union {
 275         unsigned all                    : 8;
 276         struct {
 277 #if defined(__LITTLE_ENDIAN_BITFIELD)
 278                 unsigned head           : 4;
 279                 unsigned unit           : 1;
 280                 unsigned bit5           : 1;
 281                 unsigned lba            : 1;
 282                 unsigned bit7           : 1;
 283 #elif defined(__BIG_ENDIAN_BITFIELD)
 284                 unsigned bit7           : 1;
 285                 unsigned lba            : 1;
 286                 unsigned bit5           : 1;
 287                 unsigned unit           : 1;
 288                 unsigned head           : 4;
 289 #else
 290 #error "Please fix <asm/byteorder.h>"
 291 #endif
 292         } b;
 293 } select_t, ata_select_t;
 294
 295 /*
 296  * Status returned from various ide_ functions
 297  */
 298 typedef enum {
 299         ide_stopped,    /* no drive operation was started */
 300         ide_started,    /* a drive operation was started, handler was set */
 301 } ide_startstop_t;
 302
 303 struct ide_driver_s;
 304 struct ide_settings_s;
 305
 306 #ifdef CONFIG_BLK_DEV_IDEACPI
 307 struct ide_acpi_drive_link;
 308 struct ide_acpi_hwif_link;
 309 #endif
 310
 311 typedef struct ide_drive_s {
 312         char            name[4];        /* drive name, such as "hda" */
 313         char            driver_req[10]; /* requests specific driver */
 314
 315         struct request_queue    *queue; /* request queue */
 316
 317         struct request          *rq;    /* current request */
 318         struct ide_drive_s      *next;  /* circular list of hwgroup drives */
 319         void            *driver_data;   /* extra driver data */
 320         struct hd_driveid       *id;    /* drive model identification info */
 321 #ifdef CONFIG_IDE_PROC_FS
 322         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
 323         struct ide_settings_s *settings;/* /proc/ide/ drive settings */
 324 #endif
 325         struct hwif_s           *hwif;  /* actually (ide_hwif_t *) */
 326
 327         unsigned long sleep;            /* sleep until this time */
 328         unsigned long service_start;    /* time we started last request */
 329         unsigned long service_time;     /* service time of last request */
 330         unsigned long timeout;          /* max time to wait for irq */
 331
 332         special_t       special;        /* special action flags */
 333         select_t        select;         /* basic drive/head select reg value */
 334
 335         u8      keep_settings;          /* restore settings after drive reset */
 336         u8      using_dma;              /* disk is using dma for read/write */
 337         u8      retry_pio;              /* retrying dma capable host in pio */
 338         u8      state;                  /* retry state */
 339         u8      waiting_for_dma;        /* dma currently in progress */
 340         u8      unmask;                 /* okay to unmask other irqs */
 341         u8      noflush;                /* don't attempt flushes */
 342         u8      dsc_overlap;            /* DSC overlap */
 343         u8      nice1;                  /* give potential excess bandwidth */
 344
 345         unsigned present        : 1;    /* drive is physically present */
 346         unsigned dead           : 1;    /* device ejected hint */
 347         unsigned id_read        : 1;    /* 1=id read from disk 0 = synthetic */
 348         unsigned noprobe        : 1;    /* from:  hdx=noprobe */
 349         unsigned removable      : 1;    /* 1 if need to do check_media_change */
 350         unsigned attach         : 1;    /* needed for removable devices */
 351         unsigned forced_geom    : 1;    /* 1 if hdx=c,h,s was given at boot */
 352         unsigned no_unmask      : 1;    /* disallow setting unmask bit */
 353         unsigned no_io_32bit    : 1;    /* disallow enabling 32bit I/O */
 354         unsigned atapi_overlap  : 1;    /* ATAPI overlap (not supported) */
 355         unsigned doorlocking    : 1;    /* for removable only: door lock/unlock works */
 356         unsigned nodma          : 1;    /* disallow DMA */
 357         unsigned remap_0_to_1   : 1;    /* 0=noremap, 1=remap 0->1 (for EZDrive) */
 358         unsigned blocked        : 1;    /* 1=powermanagment told us not to do anything, so sleep nicely */
 359         unsigned scsi           : 1;    /* 0=default, 1=ide-scsi emulation */
 360         unsigned sleeping       : 1;    /* 1=sleeping & sleep field valid */
 361         unsigned post_reset     : 1;
 362         unsigned udma33_warned  : 1;
 363
 364         u8      addressing;     /* 0=28-bit, 1=48-bit, 2=48-bit doing 28-bit */
 365         u8      quirk_list;     /* considered quirky, set for a specific host */
 366         u8      init_speed;     /* transfer rate set at boot */
 367         u8      current_speed;  /* current transfer rate set */
 368         u8      desired_speed;  /* desired transfer rate set */
 369         u8      dn;             /* now wide spread use */
 370         u8      wcache;         /* status of write cache */
 371         u8      acoustic;       /* acoustic management */
 372         u8      media;          /* disk, cdrom, tape, floppy, ... */
 373         u8      ready_stat;     /* min status value for drive ready */
 374         u8      mult_count;     /* current multiple sector setting */
 375         u8      mult_req;       /* requested multiple sector setting */
 376         u8      tune_req;       /* requested drive tuning setting */
 377         u8      io_32bit;       /* 0=16-bit, 1=32-bit, 2/3=32bit+sync */
 378         u8      bad_wstat;      /* used for ignoring WRERR_STAT */
 379         u8      nowerr;         /* used for ignoring WRERR_STAT */
 380         u8      sect0;          /* offset of first sector for DM6:DDO */
 381         u8      head;           /* "real" number of heads */
 382         u8      sect;           /* "real" sectors per track */
 383         u8      bios_head;      /* BIOS/fdisk/LILO number of heads */
 384         u8      bios_sect;      /* BIOS/fdisk/LILO sectors per track */
 385
 386         unsigned int    bios_cyl;       /* BIOS/fdisk/LILO number of cyls */
 387         unsigned int    cyl;            /* "real" number of cyls */
 388         unsigned int    drive_data;     /* used by set_pio_mode/selectproc */
 389         unsigned int    failures;       /* current failure count */
 390         unsigned int    max_failures;   /* maximum allowed failure count */
 391         u64             probed_capacity;/* initial reported media capacity (ide-cd only currently) */
 392
 393         u64             capacity64;     /* total number of sectors */
 394
 395         int             lun;            /* logical unit */
 396         int             crc_count;      /* crc counter to reduce drive speed */
 397 #ifdef CONFIG_BLK_DEV_IDEACPI
 398         struct ide_acpi_drive_link *acpidata;
 399 #endif
 400         struct list_head list;
 401         struct device   gendev;
 402         struct completion gendev_rel_comp;      /* to deal with device release() */
 403 } ide_drive_t;
 404
 405 #define to_ide_device(dev)container_of(dev, ide_drive_t, gendev)
 406
 407 #define IDE_CHIPSET_PCI_MASK    \
 408     ((1<<ide_pci)|(1<<ide_cmd646)|(1<<ide_ali14xx))
 409 #define IDE_CHIPSET_IS_PCI(c)   ((IDE_CHIPSET_PCI_MASK >> (c)) & 1)
 410
 411 struct ide_task_s;
 412 struct ide_port_info;
 413
 414 struct ide_tp_ops {
 415         void    (*exec_command)(struct hwif_s *, u8);
 416         u8      (*read_status)(struct hwif_s *);
 417         u8      (*read_altstatus)(struct hwif_s *);
 418         u8      (*read_sff_dma_status)(struct hwif_s *);
 419
 420         void    (*set_irq)(struct hwif_s *, int);
 421
 422         void    (*tf_load)(ide_drive_t *, struct ide_task_s *);
 423         void    (*tf_read)(ide_drive_t *, struct ide_task_s *);
 424
 425         void    (*input_data)(ide_drive_t *, struct request *, void *,
 426                               unsigned int);
 427         void    (*output_data)(ide_drive_t *, struct request *, void *,
 428                                unsigned int);
 429 };
 430
 431 extern const struct ide_tp_ops default_tp_ops;
 432
 433 struct ide_port_ops {
 434         /* host specific initialization of a device */
 435         void    (*init_dev)(ide_drive_t *);
 436         /* routine to program host for PIO mode */
 437         void    (*set_pio_mode)(ide_drive_t *, const u8);
 438         /* routine to program host for DMA mode */
 439         void    (*set_dma_mode)(ide_drive_t *, const u8);
 440         /* tweaks hardware to select drive */
 441         void    (*selectproc)(ide_drive_t *);
 442         /* chipset polling based on hba specifics */
 443         int     (*reset_poll)(ide_drive_t *);
 444         /* chipset specific changes to default for device-hba resets */
 445         void    (*pre_reset)(ide_drive_t *);
 446         /* routine to reset controller after a disk reset */
 447         void    (*resetproc)(ide_drive_t *);
 448         /* special host masking for drive selection */
 449         void    (*maskproc)(ide_drive_t *, int);
 450         /* check host's drive quirk list */
 451         void    (*quirkproc)(ide_drive_t *);
 452
 453         u8      (*mdma_filter)(ide_drive_t *);
 454         u8      (*udma_filter)(ide_drive_t *);
 455
 456         u8      (*cable_detect)(struct hwif_s *);
 457 };
 458
 459 struct ide_dma_ops {
 460         void    (*dma_host_set)(struct ide_drive_s *, int);
 461         int     (*dma_setup)(struct ide_drive_s *);
 462         void    (*dma_exec_cmd)(struct ide_drive_s *, u8);
 463         void    (*dma_start)(struct ide_drive_s *);
 464         int     (*dma_end)(struct ide_drive_s *);
 465         int     (*dma_test_irq)(struct ide_drive_s *);
 466         void    (*dma_lost_irq)(struct ide_drive_s *);
 467         void    (*dma_timeout)(struct ide_drive_s *);
 468 };
 469
 470 typedef struct hwif_s {
 471         struct hwif_s *next;            /* for linked-list in ide_hwgroup_t */
 472         struct hwif_s *mate;            /* other hwif from same PCI chip */
 473         struct hwgroup_s *hwgroup;      /* actually (ide_hwgroup_t *) */
 474         struct proc_dir_entry *proc;    /* /proc/ide/ directory entry */
 475
 476         char name[6];                   /* name of interface, eg. "ide0" */
 477
 478         struct ide_io_ports     io_ports;
 479
 480         unsigned long   sata_scr[SATA_NR_PORTS];
 481
 482         ide_drive_t     drives[MAX_DRIVES];     /* drive info */
 483
 484         u8 major;       /* our major number */
 485         u8 index;       /* 0 for ide0; 1 for ide1; ... */
 486         u8 channel;     /* for dual-port chips: 0=primary, 1=secondary */
 487         u8 bus_state;   /* power state of the IDE bus */
 488
 489         u32 host_flags;
 490
 491         u8 pio_mask;
 492
 493         u8 ultra_mask;
 494         u8 mwdma_mask;
 495         u8 swdma_mask;
 496
 497         u8 cbl;         /* cable type */
 498
 499         hwif_chipset_t chipset; /* sub-module for tuning.. */
 500
 501         struct device *dev;
 502
 503         ide_ack_intr_t *ack_intr;
 504
 505         void (*rw_disk)(ide_drive_t *, struct request *);
 506
 507         const struct ide_tp_ops         *tp_ops;
 508         const struct ide_port_ops       *port_ops;
 509         const struct ide_dma_ops        *dma_ops;
 510
 511         void (*ide_dma_clear_irq)(ide_drive_t *drive);
 512
 513         /* dma physical region descriptor table (cpu view) */
 514         unsigned int    *dmatable_cpu;
 515         /* dma physical region descriptor table (dma view) */
 516         dma_addr_t      dmatable_dma;
 517         /* Scatter-gather list used to build the above */
 518         struct scatterlist *sg_table;
 519         int sg_max_nents;               /* Maximum number of entries in it */
 520         int sg_nents;                   /* Current number of entries in it */
 521         int sg_dma_direction;           /* dma transfer direction */
 522
 523         /* data phase of the active command (currently only valid for PIO/DMA) */
 524         int             data_phase;
 525
 526         unsigned int nsect;
 527         unsigned int nleft;
 528         struct scatterlist *cursg;
 529         unsigned int cursg_ofs;
 530
 531         int             rqsize;         /* max sectors per request */
 532         int             irq;            /* our irq number */
 533
 534         unsigned long   dma_base;       /* base addr for dma ports */
 535
 536         unsigned long   config_data;    /* for use by chipset-specific code */
 537         unsigned long   select_data;    /* for use by chipset-specific code */
 538
 539         unsigned long   extra_base;     /* extra addr for dma ports */
 540         unsigned        extra_ports;    /* number of extra dma ports */
 541
 542         unsigned        present    : 1; /* this interface exists */
 543         unsigned        serialized : 1; /* serialized all channel operation */
 544         unsigned        sharing_irq: 1; /* 1 = sharing irq with another hwif */
 545         unsigned        sg_mapped  : 1; /* sg_table and sg_nents are ready */
 546
 547         struct device           gendev;
 548         struct device           *portdev;
 549
 550         struct completion gendev_rel_comp; /* To deal with device release() */
 551
 552         void            *hwif_data;     /* extra hwif data */
 553
 554         unsigned dma;
 555
 556 #ifdef CONFIG_BLK_DEV_IDEACPI
 557         struct ide_acpi_hwif_link *acpidata;
 558 #endif
 559 } ____cacheline_internodealigned_in_smp ide_hwif_t;
 560
 561 struct ide_host {
 562         ide_hwif_t      *ports[MAX_HWIFS];
 563         unsigned int    n_ports;
 564 };
 565
 566 /*
 567  *  internal ide interrupt handler type
 568  */
 569 typedef ide_startstop_t (ide_handler_t)(ide_drive_t *);
 570 typedef int (ide_expiry_t)(ide_drive_t *);
 571
 572 /* used by ide-cd, ide-floppy, etc. */
 573 typedef void (xfer_func_t)(ide_drive_t *, struct request *rq, void *, unsigned);
 574
 575 typedef struct hwgroup_s {
 576                 /* irq handler, if active */
 577         ide_startstop_t (*handler)(ide_drive_t *);
 578
 579                 /* BOOL: protects all fields below */
 580         volatile int busy;
 581                 /* BOOL: wake us up on timer expiry */
 582         unsigned int sleeping   : 1;
 583                 /* BOOL: polling active & poll_timeout field valid */
 584         unsigned int polling    : 1;
 585
 586                 /* current drive */
 587         ide_drive_t *drive;
 588                 /* ptr to current hwif in linked-list */
 589         ide_hwif_t *hwif;
 590
 591                 /* current request */
 592         struct request *rq;
 593
 594                 /* failsafe timer */
 595         struct timer_list timer;
 596                 /* timeout value during long polls */
 597         unsigned long poll_timeout;
 598                 /* queried upon timeouts */
 599         int (*expiry)(ide_drive_t *);
 600
 601         int req_gen;
 602         int req_gen_timer;
 603 } ide_hwgroup_t;
 604
 605 typedef struct ide_driver_s ide_driver_t;
 606
 607 extern struct mutex ide_setting_mtx;
 608
 609 int set_io_32bit(ide_drive_t *, int);
 610 int set_pio_mode(ide_drive_t *, int);
 611 int set_using_dma(ide_drive_t *, int);
 612
 613 /* ATAPI packet command flags */
 614 enum {
 615         /* set when an error is considered normal - no retry (ide-tape) */
 616         PC_FLAG_ABORT                   = (1 << 0),
 617         PC_FLAG_SUPPRESS_ERROR          = (1 << 1),
 618         PC_FLAG_WAIT_FOR_DSC            = (1 << 2),
 619         PC_FLAG_DMA_OK                  = (1 << 3),
 620         PC_FLAG_DMA_IN_PROGRESS         = (1 << 4),
 621         PC_FLAG_DMA_ERROR               = (1 << 5),
 622         PC_FLAG_WRITING                 = (1 << 6),
 623         /* command timed out */
 624         PC_FLAG_TIMEDOUT                = (1 << 7),
 625         PC_FLAG_ZIP_DRIVE               = (1 << 8),
 626         PC_FLAG_DRQ_INTERRUPT           = (1 << 9),
 627 };
 628
 629 struct ide_atapi_pc {
 630         /* actual packet bytes */
 631         u8 c[12];
 632         /* incremented on each retry */
 633         int retries;
 634         int error;
 635
 636         /* bytes to transfer */
 637         int req_xfer;
 638         /* bytes actually transferred */
 639         int xferred;
 640
 641         /* data buffer */
 642         u8 *buf;
 643         /* current buffer position */
 644         u8 *cur_pos;
 645         int buf_size;
 646         /* missing/available data on the current buffer */
 647         int b_count;
 648
 649         /* the corresponding request */
 650         struct request *rq;
 651
 652         unsigned long flags;
 653
 654         /*
 655          * those are more or less driver-specific and some of them are subject
 656          * to change/removal later.
 657          */
 658         u8 pc_buf[256];
 659
 660         void (*callback)(ide_drive_t *);
 661
 662         /* idetape only */
 663         struct idetape_bh *bh;
 664         char *b_data;
 665
 666         /* idescsi only for now */
 667         struct scatterlist *sg;
 668         unsigned int sg_cnt;
 669
 670         struct scsi_cmnd *scsi_cmd;
 671         void (*done) (struct scsi_cmnd *);
 672
 673         unsigned long timeout;
 674 };
 675
 676 #ifdef CONFIG_IDE_PROC_FS
 677 /*
 678  * configurable drive settings
 679  */
 680
 681 #define TYPE_INT        0
 682 #define TYPE_BYTE       1
 683 #define TYPE_SHORT      2
 684
 685 #define SETTING_READ    (1 << 0)
 686 #define SETTING_WRITE   (1 << 1)
 687 #define SETTING_RW      (SETTING_READ | SETTING_WRITE)
 688
 689 typedef int (ide_procset_t)(ide_drive_t *, int);
 690 typedef struct ide_settings_s {
 691         char                    *name;
 692         int                     rw;
 693         int                     data_type;
 694         int                     min;
 695         int                     max;
 696         int                     mul_factor;
 697         int                     div_factor;
 698         void                    *data;
 699         ide_procset_t           *set;
 700         int                     auto_remove;
 701         struct ide_settings_s   *next;
 702 } ide_settings_t;
 703
 704 int ide_add_setting(ide_drive_t *, const char *, int, int, int, int, int, int, void *, ide_procset_t *set);
 705
 706 /*
 707  * /proc/ide interface
 708  */
 709 typedef struct {
 710         const char      *name;
 711         mode_t          mode;
 712         read_proc_t     *read_proc;
 713         write_proc_t    *write_proc;
 714 } ide_proc_entry_t;
 715
 716 void proc_ide_create(void);
 717 void proc_ide_destroy(void);
 718 void ide_proc_register_port(ide_hwif_t *);
 719 void ide_proc_port_register_devices(ide_hwif_t *);
 720 void ide_proc_unregister_device(ide_drive_t *);
 721 void ide_proc_unregister_port(ide_hwif_t *);
 722 void ide_proc_register_driver(ide_drive_t *, ide_driver_t *);
 723 void ide_proc_unregister_driver(ide_drive_t *, ide_driver_t *);
 724
 725 void ide_add_generic_settings(ide_drive_t *);
 726
 727 read_proc_t proc_ide_read_capacity;
 728 read_proc_t proc_ide_read_geometry;
 729
 730 /*
 731  * Standard exit stuff:
 732  */
 733 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) \
 734 {                                       \
 735         len -= off;                     \
 736         if (len < count) {              \
 737                 *eof = 1;               \
 738                 if (len <= 0)           \
 739                         return 0;       \
 740         } else                          \
 741                 len = count;            \
 742         *start = page + off;            \
 743         return len;                     \
 744 }
 745 #else
 746 static inline void proc_ide_create(void) { ; }
 747 static inline void proc_ide_destroy(void) { ; }
 748 static inline void ide_proc_register_port(ide_hwif_t *hwif) { ; }
 749 static inline void ide_proc_port_register_devices(ide_hwif_t *hwif) { ; }
 750 static inline void ide_proc_unregister_device(ide_drive_t *drive) { ; }
 751 static inline void ide_proc_unregister_port(ide_hwif_t *hwif) { ; }
 752 static inline void ide_proc_register_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
 753 static inline void ide_proc_unregister_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
 754 static inline void ide_add_generic_settings(ide_drive_t *drive) { ; }
 755 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) return 0;
 756 #endif
 757
 758 /*
 759  * Power Management step value (rq->pm->pm_step).
 760  *
 761  * The step value starts at 0 (ide_pm_state_start_suspend) for a
 762  * suspend operation or 1000 (ide_pm_state_start_resume) for a
 763  * resume operation.
 764  *
 765  * For each step, the core calls the subdriver start_power_step() first.
 766  * This can return:
 767  *      - ide_stopped : In this case, the core calls us back again unless
 768  *                      step have been set to ide_power_state_completed.
 769  *      - ide_started : In this case, the channel is left busy until an
 770  *                      async event (interrupt) occurs.
 771  * Typically, start_power_step() will issue a taskfile request with
 772  * do_rw_taskfile().
 773  *
 774  * Upon reception of the interrupt, the core will call complete_power_step()
 775  * with the error code if any. This routine should update the step value
 776  * and return. It should not start a new request. The core will call
 777  * start_power_step for the new step value, unless step have been set to
 778  * ide_power_state_completed.
 779  *
 780  * Subdrivers are expected to define their own additional power
 781  * steps from 1..999 for suspend and from 1001..1999 for resume,
 782  * other values are reserved for future use.
 783  */
 784
 785 enum {
 786         ide_pm_state_completed          = -1,
 787         ide_pm_state_start_suspend      = 0,
 788         ide_pm_state_start_resume       = 1000,
 789 };
 790
 791 /*
 792  * Subdrivers support.
 793  *
 794  * The gendriver.owner field should be set to the module owner of this driver.
 795  * The gendriver.name field should be set to the name of this driver
 796  */
 797 struct ide_driver_s {
 798         const char                      *version;
 799         u8                              media;
 800         unsigned supports_dsc_overlap   : 1;
 801         ide_startstop_t (*do_request)(ide_drive_t *, struct request *, sector_t);
 802         int             (*end_request)(ide_drive_t *, int, int);
 803         ide_startstop_t (*error)(ide_drive_t *, struct request *rq, u8, u8);
 804         struct device_driver    gen_driver;
 805         int             (*probe)(ide_drive_t *);
 806         void            (*remove)(ide_drive_t *);
 807         void            (*resume)(ide_drive_t *);
 808         void            (*shutdown)(ide_drive_t *);
 809 #ifdef CONFIG_IDE_PROC_FS
 810         ide_proc_entry_t        *proc;
 811 #endif
 812 };
 813
 814 #define to_ide_driver(drv) container_of(drv, ide_driver_t, gen_driver)
 815
 816 int generic_ide_ioctl(ide_drive_t *, struct file *, struct block_device *, unsigned, unsigned long);
 817
 818 extern int ide_vlb_clk;
 819 extern int ide_pci_clk;
 820
 821 extern int ide_end_request (ide_drive_t *drive, int uptodate, int nrsecs);
 822 int ide_end_dequeued_request(ide_drive_t *drive, struct request *rq,
 823                              int uptodate, int nr_sectors);
 824
 825 extern void ide_set_handler (ide_drive_t *drive, ide_handler_t *handler, unsigned int timeout, ide_expiry_t *expiry);
 826
 827 void ide_execute_command(ide_drive_t *, u8, ide_handler_t *, unsigned int,
 828                          ide_expiry_t *);
 829
 830 void ide_execute_pkt_cmd(ide_drive_t *);
 831
 832 void ide_pad_transfer(ide_drive_t *, int, int);
 833
 834 ide_startstop_t __ide_error(ide_drive_t *, struct request *, u8, u8);
 835
 836 ide_startstop_t ide_error (ide_drive_t *drive, const char *msg, byte stat);
 837
 838 extern void ide_fix_driveid(struct hd_driveid *);
 839
 840 extern void ide_fixstring(u8 *, const int, const int);
 841
 842 int ide_wait_stat(ide_startstop_t *, ide_drive_t *, u8, u8, unsigned long);
 843
 844 extern ide_startstop_t ide_do_reset (ide_drive_t *);
 845
 846 extern void ide_do_drive_cmd(ide_drive_t *, struct request *);
 847
 848 extern void ide_end_drive_cmd(ide_drive_t *, u8, u8);
 849
 850 enum {
 851         IDE_TFLAG_LBA48                 = (1 << 0),
 852         IDE_TFLAG_FLAGGED               = (1 << 2),
 853         IDE_TFLAG_OUT_DATA              = (1 << 3),
 854         IDE_TFLAG_OUT_HOB_FEATURE       = (1 << 4),
 855         IDE_TFLAG_OUT_HOB_NSECT         = (1 << 5),
 856         IDE_TFLAG_OUT_HOB_LBAL          = (1 << 6),
 857         IDE_TFLAG_OUT_HOB_LBAM          = (1 << 7),
 858         IDE_TFLAG_OUT_HOB_LBAH          = (1 << 8),
 859         IDE_TFLAG_OUT_HOB               = IDE_TFLAG_OUT_HOB_FEATURE |
 860                                           IDE_TFLAG_OUT_HOB_NSECT |
 861                                           IDE_TFLAG_OUT_HOB_LBAL |
 862                                           IDE_TFLAG_OUT_HOB_LBAM |
 863                                           IDE_TFLAG_OUT_HOB_LBAH,
 864         IDE_TFLAG_OUT_FEATURE           = (1 << 9),
 865         IDE_TFLAG_OUT_NSECT             = (1 << 10),
 866         IDE_TFLAG_OUT_LBAL              = (1 << 11),
 867         IDE_TFLAG_OUT_LBAM              = (1 << 12),
 868         IDE_TFLAG_OUT_LBAH              = (1 << 13),
 869         IDE_TFLAG_OUT_TF                = IDE_TFLAG_OUT_FEATURE |
 870                                           IDE_TFLAG_OUT_NSECT |
 871                                           IDE_TFLAG_OUT_LBAL |
 872                                           IDE_TFLAG_OUT_LBAM |
 873                                           IDE_TFLAG_OUT_LBAH,
 874         IDE_TFLAG_OUT_DEVICE            = (1 << 14),
 875         IDE_TFLAG_WRITE                 = (1 << 15),
 876         IDE_TFLAG_FLAGGED_SET_IN_FLAGS  = (1 << 16),
 877         IDE_TFLAG_IN_DATA               = (1 << 17),
 878         IDE_TFLAG_CUSTOM_HANDLER        = (1 << 18),
 879         IDE_TFLAG_DMA_PIO_FALLBACK      = (1 << 19),
 880         IDE_TFLAG_IN_HOB_FEATURE        = (1 << 20),
 881         IDE_TFLAG_IN_HOB_NSECT          = (1 << 21),
 882         IDE_TFLAG_IN_HOB_LBAL           = (1 << 22),
 883         IDE_TFLAG_IN_HOB_LBAM           = (1 << 23),
 884         IDE_TFLAG_IN_HOB_LBAH           = (1 << 24),
 885         IDE_TFLAG_IN_HOB_LBA            = IDE_TFLAG_IN_HOB_LBAL |
 886                                           IDE_TFLAG_IN_HOB_LBAM |
 887                                           IDE_TFLAG_IN_HOB_LBAH,
 888         IDE_TFLAG_IN_HOB                = IDE_TFLAG_IN_HOB_FEATURE |
 889                                           IDE_TFLAG_IN_HOB_NSECT |
 890                                           IDE_TFLAG_IN_HOB_LBA,
 891         IDE_TFLAG_IN_FEATURE            = (1 << 1),
 892         IDE_TFLAG_IN_NSECT              = (1 << 25),
 893         IDE_TFLAG_IN_LBAL               = (1 << 26),
 894         IDE_TFLAG_IN_LBAM               = (1 << 27),
 895         IDE_TFLAG_IN_LBAH               = (1 << 28),
 896         IDE_TFLAG_IN_LBA                = IDE_TFLAG_IN_LBAL |
 897                                           IDE_TFLAG_IN_LBAM |
 898                                           IDE_TFLAG_IN_LBAH,
 899         IDE_TFLAG_IN_TF                 = IDE_TFLAG_IN_NSECT |
 900                                           IDE_TFLAG_IN_LBA,
 901         IDE_TFLAG_IN_DEVICE             = (1 << 29),
 902         IDE_TFLAG_HOB                   = IDE_TFLAG_OUT_HOB |
 903                                           IDE_TFLAG_IN_HOB,
 904         IDE_TFLAG_TF                    = IDE_TFLAG_OUT_TF |
 905                                           IDE_TFLAG_IN_TF,
 906         IDE_TFLAG_DEVICE                = IDE_TFLAG_OUT_DEVICE |
 907                                           IDE_TFLAG_IN_DEVICE,
 908         /* force 16-bit I/O operations */
 909         IDE_TFLAG_IO_16BIT              = (1 << 30),
 910         /* ide_task_t was allocated using kmalloc() */
 911         IDE_TFLAG_DYN                   = (1 << 31),
 912 };
 913
 914 struct ide_taskfile {
 915         u8      hob_data;       /*  0: high data byte (for TASKFILE IOCTL) */
 916
 917         u8      hob_feature;    /*  1-5: additional data to support LBA48 */
 918         u8      hob_nsect;
 919         u8      hob_lbal;
 920         u8      hob_lbam;
 921         u8      hob_lbah;
 922
 923         u8      data;           /*  6: low data byte (for TASKFILE IOCTL) */
 924
 925         union {                 /*  7: */
 926                 u8 error;       /*   read:  error */
 927                 u8 feature;     /*  write: feature */
 928         };
 929
 930         u8      nsect;          /*  8: number of sectors */
 931         u8      lbal;           /*  9: LBA low */
 932         u8      lbam;           /* 10: LBA mid */
 933         u8      lbah;           /* 11: LBA high */
 934
 935         u8      device;         /* 12: device select */
 936
 937         union {                 /* 13: */
 938                 u8 status;      /*  read: status  */
 939                 u8 command;     /* write: command */
 940         };
 941 };
 942
 943 typedef struct ide_task_s {
 944         union {
 945                 struct ide_taskfile     tf;
 946                 u8                      tf_array[14];
 947         };
 948         u32                     tf_flags;
 949         int                     data_phase;
 950         struct request          *rq;            /* copy of request */
 951         void                    *special;       /* valid_t generally */
 952 } ide_task_t;
 953
 954 void ide_tf_dump(const char *, struct ide_taskfile *);
 955
 956 void ide_exec_command(ide_hwif_t *, u8);
 957 u8 ide_read_status(ide_hwif_t *);
 958 u8 ide_read_altstatus(ide_hwif_t *);
 959 u8 ide_read_sff_dma_status(ide_hwif_t *);
 960
 961 void ide_set_irq(ide_hwif_t *, int);
 962
 963 void ide_tf_load(ide_drive_t *, ide_task_t *);
 964 void ide_tf_read(ide_drive_t *, ide_task_t *);
 965
 966 void ide_input_data(ide_drive_t *, struct request *, void *, unsigned int);
 967 void ide_output_data(ide_drive_t *, struct request *, void *, unsigned int);
 968
 969 extern void SELECT_DRIVE(ide_drive_t *);
 970 void SELECT_MASK(ide_drive_t *, int);
 971
 972 u8 ide_read_error(ide_drive_t *);
 973 void ide_read_bcount_and_ireason(ide_drive_t *, u16 *, u8 *);
 974
 975 extern int drive_is_ready(ide_drive_t *);
 976
 977 void ide_pktcmd_tf_load(ide_drive_t *, u32, u16, u8);
 978
 979 ide_startstop_t ide_pc_intr(ide_drive_t *drive, struct ide_atapi_pc *pc,
 980         ide_handler_t *handler, unsigned int timeout, ide_expiry_t *expiry,
 981         void (*update_buffers)(ide_drive_t *, struct ide_atapi_pc *),
 982         void (*retry_pc)(ide_drive_t *), void (*dsc_handle)(ide_drive_t *),
 983         void (*io_buffers)(ide_drive_t *, struct ide_atapi_pc *, unsigned int,
 984                            int));
 985 ide_startstop_t ide_transfer_pc(ide_drive_t *, struct ide_atapi_pc *,
 986                                 ide_handler_t *, unsigned int, ide_expiry_t *);
 987 ide_startstop_t ide_issue_pc(ide_drive_t *, struct ide_atapi_pc *,
 988                              ide_handler_t *, unsigned int, ide_expiry_t *);
 989
 990 ide_startstop_t do_rw_taskfile(ide_drive_t *, ide_task_t *);
 991
 992 void task_end_request(ide_drive_t *, struct request *, u8);
 993
 994 int ide_raw_taskfile(ide_drive_t *, ide_task_t *, u8 *, u16);
 995 int ide_no_data_taskfile(ide_drive_t *, ide_task_t *);
 996
 997 int ide_taskfile_ioctl(ide_drive_t *, unsigned int, unsigned long);
 998 int ide_cmd_ioctl(ide_drive_t *, unsigned int, unsigned long);
 999 int ide_task_ioctl(ide_drive_t *, unsigned int, unsigned long);
1000
1001 extern int ide_driveid_update(ide_drive_t *);
1002 extern int ide_config_drive_speed(ide_drive_t *, u8);
1003 extern u8 eighty_ninty_three (ide_drive_t *);
1004 extern int taskfile_lib_get_identify(ide_drive_t *drive, u8 *);
1005
1006 extern int ide_wait_not_busy(ide_hwif_t *hwif, unsigned long timeout);
1007
1008 extern void ide_stall_queue(ide_drive_t *drive, unsigned long timeout);
1009
1010 extern int ide_spin_wait_hwgroup(ide_drive_t *);
1011 extern void ide_timer_expiry(unsigned long);
1012 extern irqreturn_t ide_intr(int irq, void *dev_id);
1013 extern void do_ide_request(struct request_queue *);
1014
1015 void ide_init_disk(struct gendisk *, ide_drive_t *);
1016
1017 #ifdef CONFIG_IDEPCI_PCIBUS_ORDER
1018 extern int __ide_pci_register_driver(struct pci_driver *driver, struct module *owner, const char *mod_name);
1019 #define ide_pci_register_driver(d) __ide_pci_register_driver(d, THIS_MODULE, KBUILD_MODNAME)
1020 #else
1021 #define ide_pci_register_driver(d) pci_register_driver(d)
1022 #endif
1023
1024 void ide_pci_setup_ports(struct pci_dev *, const struct ide_port_info *, int,
1025                          hw_regs_t *, hw_regs_t **);
1026 void ide_setup_pci_noise(struct pci_dev *, const struct ide_port_info *);
1027
1028 #ifdef CONFIG_BLK_DEV_IDEDMA_PCI
1029 int ide_pci_set_master(struct pci_dev *, const char *);
1030 unsigned long ide_pci_dma_base(ide_hwif_t *, const struct ide_port_info *);
1031 extern const struct ide_dma_ops sff_dma_ops;
1032 int ide_pci_check_simplex(ide_hwif_t *, const struct ide_port_info *);
1033 int ide_hwif_setup_dma(ide_hwif_t *, const struct ide_port_info *);
1034 #else
1035 static inline int ide_hwif_setup_dma(ide_hwif_t *hwif,
1036                                      const struct ide_port_info *d)
1037 {
1038         return -EINVAL;
1039 }
1040 #endif
1041
1042 typedef struct ide_pci_enablebit_s {
1043         u8      reg;    /* byte pci reg holding the enable-bit */
1044         u8      mask;   /* mask to isolate the enable-bit */
1045         u8      val;    /* value of masked reg when "enabled" */
1046 } ide_pci_enablebit_t;
1047
1048 enum {
1049         /* Uses ISA control ports not PCI ones. */
1050         IDE_HFLAG_ISA_PORTS             = (1 << 0),
1051         /* single port device */
1052         IDE_HFLAG_SINGLE                = (1 << 1),
1053         /* don't use legacy PIO blacklist */
1054         IDE_HFLAG_PIO_NO_BLACKLIST      = (1 << 2),
1055         /* set for the second port of QD65xx */
1056         IDE_HFLAG_QD_2ND_PORT           = (1 << 3),
1057         /* use PIO8/9 for prefetch off/on */
1058         IDE_HFLAG_ABUSE_PREFETCH        = (1 << 4),
1059         /* use PIO6/7 for fast-devsel off/on */
1060         IDE_HFLAG_ABUSE_FAST_DEVSEL     = (1 << 5),
1061         /* use 100-102 and 200-202 PIO values to set DMA modes */
1062         IDE_HFLAG_ABUSE_DMA_MODES       = (1 << 6),
1063         /*
1064          * keep DMA setting when programming PIO mode, may be used only
1065          * for hosts which have separate PIO and DMA timings (ie. PMAC)
1066          */
1067         IDE_HFLAG_SET_PIO_MODE_KEEP_DMA = (1 << 7),
1068         /* program host for the transfer mode after programming device */
1069         IDE_HFLAG_POST_SET_MODE         = (1 << 8),
1070         /* don't program host/device for the transfer mode ("smart" hosts) */
1071         IDE_HFLAG_NO_SET_MODE           = (1 << 9),
1072         /* trust BIOS for programming chipset/device for DMA */
1073         IDE_HFLAG_TRUST_BIOS_FOR_DMA    = (1 << 10),
1074         /* host is CS5510/CS5520 */
1075         IDE_HFLAG_CS5520                = (1 << 11),
1076         /* ATAPI DMA is unsupported */
1077         IDE_HFLAG_NO_ATAPI_DMA          = (1 << 12),
1078         /* set if host is a "non-bootable" controller */
1079         IDE_HFLAG_NON_BOOTABLE          = (1 << 13),
1080         /* host doesn't support DMA */
1081         IDE_HFLAG_NO_DMA                = (1 << 14),
1082         /* check if host is PCI IDE device before allowing DMA */
1083         IDE_HFLAG_NO_AUTODMA            = (1 << 15),
1084         /* host uses MMIO */
1085         IDE_HFLAG_MMIO                  = (1 << 16),
1086         /* no LBA48 */
1087         IDE_HFLAG_NO_LBA48              = (1 << 17),
1088         /* no LBA48 DMA */
1089         IDE_HFLAG_NO_LBA48_DMA          = (1 << 18),
1090         /* data FIFO is cleared by an error */
1091         IDE_HFLAG_ERROR_STOPS_FIFO      = (1 << 19),
1092         /* serialize ports */
1093         IDE_HFLAG_SERIALIZE             = (1 << 20),
1094         /* use legacy IRQs */
1095         IDE_HFLAG_LEGACY_IRQS           = (1 << 21),
1096         /* force use of legacy IRQs */
1097         IDE_HFLAG_FORCE_LEGACY_IRQS     = (1 << 22),
1098         /* limit LBA48 requests to 256 sectors */
1099         IDE_HFLAG_RQSIZE_256            = (1 << 23),
1100         /* use 32-bit I/O ops */
1101         IDE_HFLAG_IO_32BIT              = (1 << 24),
1102         /* unmask IRQs */
1103         IDE_HFLAG_UNMASK_IRQS           = (1 << 25),
1104         /* serialize ports if DMA is possible (for sl82c105) */
1105         IDE_HFLAG_SERIALIZE_DMA         = (1 << 27),
1106         /* force host out of "simplex" mode */
1107         IDE_HFLAG_CLEAR_SIMPLEX         = (1 << 28),
1108         /* DSC overlap is unsupported */
1109         IDE_HFLAG_NO_DSC                = (1 << 29),
1110         /* never use 32-bit I/O ops */
1111         IDE_HFLAG_NO_IO_32BIT           = (1 << 30),
1112         /* never unmask IRQs */
1113         IDE_HFLAG_NO_UNMASK_IRQS        = (1 << 31),
1114 };
1115
1116 #ifdef CONFIG_BLK_DEV_OFFBOARD
1117 # define IDE_HFLAG_OFF_BOARD    0
1118 #else
1119 # define IDE_HFLAG_OFF_BOARD    IDE_HFLAG_NON_BOOTABLE
1120 #endif
1121
1122 struct ide_port_info {
1123         char                    *name;
1124         unsigned int            (*init_chipset)(struct pci_dev *, const char *);
1125         void                    (*init_iops)(ide_hwif_t *);
1126         void                    (*init_hwif)(ide_hwif_t *);
1127         int                     (*init_dma)(ide_hwif_t *,
1128                                             const struct ide_port_info *);
1129
1130         const struct ide_tp_ops         *tp_ops;
1131         const struct ide_port_ops       *port_ops;
1132         const struct ide_dma_ops        *dma_ops;
1133
1134         ide_pci_enablebit_t     enablebits[2];
1135         hwif_chipset_t          chipset;
1136         u32                     host_flags;
1137         u8                      pio_mask;
1138         u8                      swdma_mask;
1139         u8                      mwdma_mask;
1140         u8                      udma_mask;
1141 };
1142
1143 int ide_setup_pci_device(struct pci_dev *, const struct ide_port_info *);
1144 int ide_setup_pci_devices(struct pci_dev *, struct pci_dev *, const struct ide_port_info *);
1145
1146 void ide_map_sg(ide_drive_t *, struct request *);
1147 void ide_init_sg_cmd(ide_drive_t *, struct request *);
1148
1149 #define BAD_DMA_DRIVE           0
1150 #define GOOD_DMA_DRIVE          1
1151
1152 struct drive_list_entry {
1153         const char *id_model;
1154         const char *id_firmware;
1155 };
1156
1157 int ide_in_drive_list(struct hd_driveid *, const struct drive_list_entry *);
1158
1159 #ifdef CONFIG_BLK_DEV_IDEDMA
1160 int __ide_dma_bad_drive(ide_drive_t *);
1161 int ide_id_dma_bug(ide_drive_t *);
1162
1163 u8 ide_find_dma_mode(ide_drive_t *, u8);
1164
1165 static inline u8 ide_max_dma_mode(ide_drive_t *drive)
1166 {
1167         return ide_find_dma_mode(drive, XFER_UDMA_6);
1168 }
1169
1170 void ide_dma_off_quietly(ide_drive_t *);
1171 void ide_dma_off(ide_drive_t *);
1172 void ide_dma_on(ide_drive_t *);
1173 int ide_set_dma(ide_drive_t *);
1174 void ide_check_dma_crc(ide_drive_t *);
1175 ide_startstop_t ide_dma_intr(ide_drive_t *);
1176
1177 int ide_build_sglist(ide_drive_t *, struct request *);
1178 void ide_destroy_dmatable(ide_drive_t *);
1179
1180 #ifdef CONFIG_BLK_DEV_IDEDMA_SFF
1181 extern int ide_build_dmatable(ide_drive_t *, struct request *);
1182 int ide_allocate_dma_engine(ide_hwif_t *);
1183 void ide_release_dma_engine(ide_hwif_t *);
1184
1185 void ide_dma_host_set(ide_drive_t *, int);
1186 extern int ide_dma_setup(ide_drive_t *);
1187 void ide_dma_exec_cmd(ide_drive_t *, u8);
1188 extern void ide_dma_start(ide_drive_t *);
1189 extern int __ide_dma_end(ide_drive_t *);
1190 int ide_dma_test_irq(ide_drive_t *);
1191 extern void ide_dma_lost_irq(ide_drive_t *);
1192 extern void ide_dma_timeout(ide_drive_t *);
1193 #endif /* CONFIG_BLK_DEV_IDEDMA_SFF */
1194
1195 #else
1196 static inline int ide_id_dma_bug(ide_drive_t *drive) { return 0; }
1197 static inline u8 ide_find_dma_mode(ide_drive_t *drive, u8 speed) { return 0; }
1198 static inline u8 ide_max_dma_mode(ide_drive_t *drive) { return 0; }
1199 static inline void ide_dma_off_quietly(ide_drive_t *drive) { ; }
1200 static inline void ide_dma_off(ide_drive_t *drive) { ; }
1201 static inline void ide_dma_on(ide_drive_t *drive) { ; }
1202 static inline void ide_dma_verbose(ide_drive_t *drive) { ; }
1203 static inline int ide_set_dma(ide_drive_t *drive) { return 1; }
1204 static inline void ide_check_dma_crc(ide_drive_t *drive) { ; }
1205 #endif /* CONFIG_BLK_DEV_IDEDMA */
1206
1207 #ifndef CONFIG_BLK_DEV_IDEDMA_SFF
1208 static inline void ide_release_dma_engine(ide_hwif_t *hwif) { ; }
1209 #endif
1210
1211 #ifdef CONFIG_BLK_DEV_IDEACPI
1212 extern int ide_acpi_exec_tfs(ide_drive_t *drive);
1213 extern void ide_acpi_get_timing(ide_hwif_t *hwif);
1214 extern void ide_acpi_push_timing(ide_hwif_t *hwif);
1215 extern void ide_acpi_init(ide_hwif_t *hwif);
1216 void ide_acpi_port_init_devices(ide_hwif_t *);
1217 extern void ide_acpi_set_state(ide_hwif_t *hwif, int on);
1218 #else
1219 static inline int ide_acpi_exec_tfs(ide_drive_t *drive) { return 0; }
1220 static inline void ide_acpi_get_timing(ide_hwif_t *hwif) { ; }
1221 static inline void ide_acpi_push_timing(ide_hwif_t *hwif) { ; }
1222 static inline void ide_acpi_init(ide_hwif_t *hwif) { ; }
1223 static inline void ide_acpi_port_init_devices(ide_hwif_t *hwif) { ; }
1224 static inline void ide_acpi_set_state(ide_hwif_t *hwif, int on) {}
1225 #endif
1226
1227 void ide_remove_port_from_hwgroup(ide_hwif_t *);
1228 void ide_unregister(ide_hwif_t *);
1229
1230 void ide_register_region(struct gendisk *);
1231 void ide_unregister_region(struct gendisk *);
1232
1233 void ide_undecoded_slave(ide_drive_t *);
1234
1235 void ide_port_apply_params(ide_hwif_t *);
1236
1237 struct ide_host *ide_host_alloc_all(const struct ide_port_info *, hw_regs_t **);
1238 struct ide_host *ide_host_alloc(const struct ide_port_info *, hw_regs_t **);
1239 void ide_host_free(struct ide_host *);
1240 int ide_host_register(struct ide_host *, const struct ide_port_info *,
1241                       hw_regs_t **);
1242 int ide_host_add(const struct ide_port_info *, hw_regs_t **,
1243                  struct ide_host **);
1244 void ide_host_remove(struct ide_host *);
1245 int ide_legacy_device_add(const struct ide_port_info *, unsigned long);
1246 void ide_port_unregister_devices(ide_hwif_t *);
1247 void ide_port_scan(ide_hwif_t *);
1248
1249 static inline void *ide_get_hwifdata (ide_hwif_t * hwif)
1250 {
1251         return hwif->hwif_data;
1252 }
1253
1254 static inline void ide_set_hwifdata (ide_hwif_t * hwif, void *data)
1255 {
1256         hwif->hwif_data = data;
1257 }
1258
1259 const char *ide_xfer_verbose(u8 mode);
1260 extern void ide_toggle_bounce(ide_drive_t *drive, int on);
1261 extern int ide_set_xfer_rate(ide_drive_t *drive, u8 rate);
1262
1263 static inline int ide_dev_has_iordy(struct hd_driveid *id)
1264 {
1265         return ((id->field_valid & 2) && (id->capability & 8)) ? 1 : 0;
1266 }
1267
1268 static inline int ide_dev_is_sata(struct hd_driveid *id)
1269 {
1270         /*
1271          * See if word 93 is 0 AND drive is at least ATA-5 compatible
1272          * verifying that word 80 by casting it to a signed type --
1273          * this trick allows us to filter out the reserved values of
1274          * 0x0000 and 0xffff along with the earlier ATA revisions...
1275          */
1276         if (id->hw_config == 0 && (short)id->major_rev_num >= 0x0020)
1277                 return 1;
1278         return 0;
1279 }
1280
1281 u64 ide_get_lba_addr(struct ide_taskfile *, int);
1282 u8 ide_dump_status(ide_drive_t *, const char *, u8);
1283
1284 struct ide_timing {
1285         u8  mode;
1286         u8  setup;      /* t1 */
1287         u16 act8b;      /* t2 for 8-bit io */
1288         u16 rec8b;      /* t2i for 8-bit io */
1289         u16 cyc8b;      /* t0 for 8-bit io */
1290         u16 active;     /* t2 or tD */
1291         u16 recover;    /* t2i or tK */
1292         u16 cycle;      /* t0 */
1293         u16 udma;       /* t2CYCTYP/2 */
1294 };
1295
1296 enum {
1297         IDE_TIMING_SETUP        = (1 << 0),
1298         IDE_TIMING_ACT8B        = (1 << 1),
1299         IDE_TIMING_REC8B        = (1 << 2),
1300         IDE_TIMING_CYC8B        = (1 << 3),
1301         IDE_TIMING_8BIT         = IDE_TIMING_ACT8B | IDE_TIMING_REC8B |
1302                                   IDE_TIMING_CYC8B,
1303         IDE_TIMING_ACTIVE       = (1 << 4),
1304         IDE_TIMING_RECOVER      = (1 << 5),
1305         IDE_TIMING_CYCLE        = (1 << 6),
1306         IDE_TIMING_UDMA         = (1 << 7),
1307         IDE_TIMING_ALL          = IDE_TIMING_SETUP | IDE_TIMING_8BIT |
1308                                   IDE_TIMING_ACTIVE | IDE_TIMING_RECOVER |
1309                                   IDE_TIMING_CYCLE | IDE_TIMING_UDMA,
1310 };
1311
1312 struct ide_timing *ide_timing_find_mode(u8);
1313 u16 ide_pio_cycle_time(ide_drive_t *, u8);
1314 void ide_timing_merge(struct ide_timing *, struct ide_timing *,
1315                       struct ide_timing *, unsigned int);
1316 int ide_timing_compute(ide_drive_t *, u8, struct ide_timing *, int, int);
1317
1318 int ide_scan_pio_blacklist(char *);
1319
1320 u8 ide_get_best_pio_mode(ide_drive_t *, u8, u8);
1321
1322 int ide_set_pio_mode(ide_drive_t *, u8);
1323 int ide_set_dma_mode(ide_drive_t *, u8);
1324
1325 void ide_set_pio(ide_drive_t *, u8);
1326
1327 static inline void ide_set_max_pio(ide_drive_t *drive)
1328 {
1329         ide_set_pio(drive, 255);
1330 }
1331
1332 extern spinlock_t ide_lock;
1333 extern struct mutex ide_cfg_mtx;
1334 /*
1335  * Structure locking:
1336  *
1337  * ide_cfg_mtx and ide_lock together protect changes to
1338  * ide_hwif_t->{next,hwgroup}
1339  * ide_drive_t->next
1340  *
1341  * ide_hwgroup_t->busy: ide_lock
1342  * ide_hwgroup_t->hwif: ide_lock
1343  * ide_hwif_t->mate: constant, no locking
1344  * ide_drive_t->hwif: constant, no locking
1345  */
1346
1347 #define local_irq_set(flags)    do { local_save_flags((flags)); local_irq_enable_in_hardirq(); } while (0)
1348
1349 extern struct bus_type ide_bus_type;
1350 extern struct class *ide_port_class;
1351
1352 /* check if CACHE FLUSH (EXT) command is supported (bits defined in ATA-6) */
1353 #define ide_id_has_flush_cache(id)      ((id)->cfs_enable_2 & 0x3000)
1354
1355 /* some Maxtor disks have bit 13 defined incorrectly so check bit 10 too */
1356 #define ide_id_has_flush_cache_ext(id)  \
1357         (((id)->cfs_enable_2 & 0x2400) == 0x2400)
1358
1359 static inline void ide_dump_identify(u8 *id)
1360 {
1361         print_hex_dump(KERN_INFO, "", DUMP_PREFIX_NONE, 16, 2, id, 512, 0);
1362 }
1363
1364 static inline int hwif_to_node(ide_hwif_t *hwif)
1365 {
1366         struct pci_dev *dev = to_pci_dev(hwif->dev);
1367         return hwif->dev ? pcibus_to_node(dev->bus) : -1;
1368 }
1369
1370 static inline ide_drive_t *ide_get_paired_drive(ide_drive_t *drive)
1371 {
1372         ide_hwif_t *hwif        = HWIF(drive);
1373
1374         return &hwif->drives[(drive->dn ^ 1) & 1];
1375 }
1376 #endif /* _IDE_H */