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