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