include/linux/ide.h

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