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