]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - include/linux/ide.h
ide: drop 'initializing' argument from ide_register_hw()
[mirror_ubuntu-artful-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
4ee06b7e
BZ
30#if defined(CRIS) || defined(FRV)
31# define SUPPORT_VLB_SYNC 0
32#else
33# define SUPPORT_VLB_SYNC 1
1da177e4
LT
34#endif
35
36/*
37 * Used to indicate "no IRQ", should be a value that cannot be an IRQ
38 * number.
39 */
40
41#define IDE_NO_IRQ (-1)
42
1da177e4
LT
43typedef unsigned char byte; /* used everywhere */
44
45/*
46 * Probably not wise to fiddle with these
47 */
48#define ERROR_MAX 8 /* Max read/write errors per sector */
49#define ERROR_RESET 3 /* Reset controller every 4th retry */
50#define ERROR_RECAL 1 /* Recalibrate every 2nd retry */
51
52/*
53 * Tune flags
54 */
55#define IDE_TUNE_NOAUTO 2
56#define IDE_TUNE_AUTO 1
57#define IDE_TUNE_DEFAULT 0
58
59/*
60 * state flags
61 */
62
63#define DMA_PIO_RETRY 1 /* retrying in PIO */
64
65#define HWIF(drive) ((ide_hwif_t *)((drive)->hwif))
66#define HWGROUP(drive) ((ide_hwgroup_t *)(HWIF(drive)->hwgroup))
67
68/*
69 * Definitions for accessing IDE controller registers
70 */
71#define IDE_NR_PORTS (10)
72
73#define IDE_DATA_OFFSET (0)
74#define IDE_ERROR_OFFSET (1)
75#define IDE_NSECTOR_OFFSET (2)
76#define IDE_SECTOR_OFFSET (3)
77#define IDE_LCYL_OFFSET (4)
78#define IDE_HCYL_OFFSET (5)
79#define IDE_SELECT_OFFSET (6)
80#define IDE_STATUS_OFFSET (7)
81#define IDE_CONTROL_OFFSET (8)
82#define IDE_IRQ_OFFSET (9)
83
84#define IDE_FEATURE_OFFSET IDE_ERROR_OFFSET
85#define IDE_COMMAND_OFFSET IDE_STATUS_OFFSET
86
1da177e4
LT
87#define IDE_DATA_REG (HWIF(drive)->io_ports[IDE_DATA_OFFSET])
88#define IDE_ERROR_REG (HWIF(drive)->io_ports[IDE_ERROR_OFFSET])
89#define IDE_NSECTOR_REG (HWIF(drive)->io_ports[IDE_NSECTOR_OFFSET])
90#define IDE_SECTOR_REG (HWIF(drive)->io_ports[IDE_SECTOR_OFFSET])
91#define IDE_LCYL_REG (HWIF(drive)->io_ports[IDE_LCYL_OFFSET])
92#define IDE_HCYL_REG (HWIF(drive)->io_ports[IDE_HCYL_OFFSET])
93#define IDE_SELECT_REG (HWIF(drive)->io_ports[IDE_SELECT_OFFSET])
94#define IDE_STATUS_REG (HWIF(drive)->io_ports[IDE_STATUS_OFFSET])
95#define IDE_CONTROL_REG (HWIF(drive)->io_ports[IDE_CONTROL_OFFSET])
96#define IDE_IRQ_REG (HWIF(drive)->io_ports[IDE_IRQ_OFFSET])
97
98#define IDE_FEATURE_REG IDE_ERROR_REG
99#define IDE_COMMAND_REG IDE_STATUS_REG
100#define IDE_ALTSTATUS_REG IDE_CONTROL_REG
101#define IDE_IREASON_REG IDE_NSECTOR_REG
102#define IDE_BCOUNTL_REG IDE_LCYL_REG
103#define IDE_BCOUNTH_REG IDE_HCYL_REG
104
105#define OK_STAT(stat,good,bad) (((stat)&((good)|(bad)))==(good))
106#define BAD_R_STAT (BUSY_STAT | ERR_STAT)
107#define BAD_W_STAT (BAD_R_STAT | WRERR_STAT)
108#define BAD_STAT (BAD_R_STAT | DRQ_STAT)
109#define DRIVE_READY (READY_STAT | SEEK_STAT)
110#define DATA_READY (DRQ_STAT)
111
112#define BAD_CRC (ABRT_ERR | ICRC_ERR)
113
114#define SATA_NR_PORTS (3) /* 16 possible ?? */
115
116#define SATA_STATUS_OFFSET (0)
117#define SATA_STATUS_REG (HWIF(drive)->sata_scr[SATA_STATUS_OFFSET])
118#define SATA_ERROR_OFFSET (1)
119#define SATA_ERROR_REG (HWIF(drive)->sata_scr[SATA_ERROR_OFFSET])
120#define SATA_CONTROL_OFFSET (2)
121#define SATA_CONTROL_REG (HWIF(drive)->sata_scr[SATA_CONTROL_OFFSET])
122
123#define SATA_MISC_OFFSET (0)
124#define SATA_MISC_REG (HWIF(drive)->sata_misc[SATA_MISC_OFFSET])
125#define SATA_PHY_OFFSET (1)
126#define SATA_PHY_REG (HWIF(drive)->sata_misc[SATA_PHY_OFFSET])
127#define SATA_IEN_OFFSET (2)
128#define SATA_IEN_REG (HWIF(drive)->sata_misc[SATA_IEN_OFFSET])
129
130/*
131 * Our Physical Region Descriptor (PRD) table should be large enough
132 * to handle the biggest I/O request we are likely to see. Since requests
133 * can have no more than 256 sectors, and since the typical blocksize is
134 * two or more sectors, we could get by with a limit of 128 entries here for
135 * the usual worst case. Most requests seem to include some contiguous blocks,
136 * further reducing the number of table entries required.
137 *
138 * The driver reverts to PIO mode for individual requests that exceed
139 * this limit (possible with 512 byte blocksizes, eg. MSDOS f/s), so handling
140 * 100% of all crazy scenarios here is not necessary.
141 *
142 * As it turns out though, we must allocate a full 4KB page for this,
143 * so the two PRD tables (ide0 & ide1) will each get half of that,
144 * allowing each to have about 256 entries (8 bytes each) from this.
145 */
146#define PRD_BYTES 8
147#define PRD_ENTRIES 256
148
149/*
150 * Some more useful definitions
151 */
152#define PARTN_BITS 6 /* number of minor dev bits for partitions */
153#define MAX_DRIVES 2 /* per interface; 2 assumed by lots of code */
154#define SECTOR_SIZE 512
155#define SECTOR_WORDS (SECTOR_SIZE / 4) /* number of 32bit words per sector */
156#define IDE_LARGE_SEEK(b1,b2,t) (((b1) > (b2) + (t)) || ((b2) > (b1) + (t)))
157
158/*
159 * Timeouts for various operations:
160 */
161#define WAIT_DRQ (HZ/10) /* 100msec - spec allows up to 20ms */
162#define WAIT_READY (5*HZ) /* 5sec - some laptops are very slow */
163#define WAIT_PIDENTIFY (10*HZ) /* 10sec - should be less than 3ms (?), if all ATAPI CD is closed at boot */
164#define WAIT_WORSTCASE (30*HZ) /* 30sec - worst case when spinning up */
165#define WAIT_CMD (10*HZ) /* 10sec - maximum wait for an IRQ to happen */
166#define WAIT_MIN_SLEEP (2*HZ/100) /* 20msec - minimum sleep time */
167
1da177e4
LT
168/*
169 * Check for an interrupt and acknowledge the interrupt status
170 */
171struct hwif_s;
172typedef int (ide_ack_intr_t)(struct hwif_s *);
173
1da177e4
LT
174/*
175 * hwif_chipset_t is used to keep track of the specific hardware
176 * chipset used by each IDE interface, if known.
177 */
528a572d 178enum { ide_unknown, ide_generic, ide_pci,
1da177e4
LT
179 ide_cmd640, ide_dtc2278, ide_ali14xx,
180 ide_qd65xx, ide_umc8672, ide_ht6560b,
181 ide_rz1000, ide_trm290,
182 ide_cmd646, ide_cy82c693, ide_4drives,
183 ide_pmac, ide_etrax100, ide_acorn,
26a940e2 184 ide_au1xxx, ide_forced
528a572d
BZ
185};
186
187typedef u8 hwif_chipset_t;
1da177e4
LT
188
189/*
190 * Structure to hold all information about the location of this port
191 */
192typedef struct hw_regs_s {
193 unsigned long io_ports[IDE_NR_PORTS]; /* task file registers */
194 int irq; /* our irq number */
1da177e4
LT
195 ide_ack_intr_t *ack_intr; /* acknowledge interrupt */
196 hwif_chipset_t chipset;
4349d5cd 197 struct device *dev;
1da177e4
LT
198} hw_regs_t;
199
baa8f3e9 200struct hwif_s * ide_find_port(unsigned long);
cbb010c1 201void ide_init_port_data(struct hwif_s *, unsigned int);
57c802e8 202void ide_init_port_hw(struct hwif_s *, hw_regs_t *);
baa8f3e9 203
f01393e4 204struct ide_drive_s;
cbb010c1 205int ide_register_hw(hw_regs_t *, void (*)(struct ide_drive_s *),
fd9bb539 206 struct hwif_s **);
1da177e4 207
1da177e4
LT
208void ide_setup_ports( hw_regs_t *hw,
209 unsigned long base,
210 int *offsets,
211 unsigned long ctrl,
212 unsigned long intr,
213 ide_ack_intr_t *ack_intr,
214#if 0
215 ide_io_ops_t *iops,
216#endif
217 int irq);
218
219static inline void ide_std_init_ports(hw_regs_t *hw,
220 unsigned long io_addr,
221 unsigned long ctl_addr)
222{
223 unsigned int i;
224
225 for (i = IDE_DATA_OFFSET; i <= IDE_STATUS_OFFSET; i++)
226 hw->io_ports[i] = io_addr++;
227
228 hw->io_ports[IDE_CONTROL_OFFSET] = ctl_addr;
229}
230
231#include <asm/ide.h>
232
83d7dbc4
MM
233#if !defined(MAX_HWIFS) || defined(CONFIG_EMBEDDED)
234#undef MAX_HWIFS
83ae20c8
BH
235#define MAX_HWIFS CONFIG_IDE_MAX_HWIFS
236#endif
237
1da177e4
LT
238/* needed on alpha, x86/x86_64, ia64, mips, ppc32 and sh */
239#ifndef IDE_ARCH_OBSOLETE_DEFAULTS
240# define ide_default_io_base(index) (0)
241# define ide_default_irq(base) (0)
242# define ide_init_default_irq(base) (0)
243#endif
244
847ddd2b 245#ifdef CONFIG_IDE_ARCH_OBSOLETE_INIT
1da177e4
LT
246static inline void ide_init_hwif_ports(hw_regs_t *hw,
247 unsigned long io_addr,
248 unsigned long ctl_addr,
249 int *irq)
250{
251 if (!ctl_addr)
252 ide_std_init_ports(hw, io_addr, ide_default_io_ctl(io_addr));
253 else
254 ide_std_init_ports(hw, io_addr, ctl_addr);
255
256 if (irq)
257 *irq = 0;
258
259 hw->io_ports[IDE_IRQ_OFFSET] = 0;
260
261#ifdef CONFIG_PPC32
262 if (ppc_ide_md.ide_init_hwif)
263 ppc_ide_md.ide_init_hwif(hw, io_addr, ctl_addr, irq);
264#endif
265}
266#else
267static inline void ide_init_hwif_ports(hw_regs_t *hw,
268 unsigned long io_addr,
269 unsigned long ctl_addr,
270 int *irq)
271{
272 if (io_addr || ctl_addr)
273 printk(KERN_WARNING "%s: must not be called\n", __FUNCTION__);
274}
847ddd2b 275#endif /* CONFIG_IDE_ARCH_OBSOLETE_INIT */
1da177e4
LT
276
277/* Currently only m68k, apus and m8xx need it */
278#ifndef IDE_ARCH_ACK_INTR
279# define ide_ack_intr(hwif) (1)
280#endif
281
282/* Currently only Atari needs it */
283#ifndef IDE_ARCH_LOCK
284# define ide_release_lock() do {} while (0)
285# define ide_get_lock(hdlr, data) do {} while (0)
286#endif /* IDE_ARCH_LOCK */
287
288/*
289 * Now for the data we need to maintain per-drive: ide_drive_t
290 */
291
292#define ide_scsi 0x21
293#define ide_disk 0x20
294#define ide_optical 0x7
295#define ide_cdrom 0x5
296#define ide_tape 0x1
297#define ide_floppy 0x0
298
299/*
300 * Special Driver Flags
301 *
302 * set_geometry : respecify drive geometry
303 * recalibrate : seek to cyl 0
304 * set_multmode : set multmode count
305 * set_tune : tune interface for drive
306 * serviced : service command
307 * reserved : unused
308 */
309typedef union {
310 unsigned all : 8;
311 struct {
1da177e4
LT
312 unsigned set_geometry : 1;
313 unsigned recalibrate : 1;
314 unsigned set_multmode : 1;
315 unsigned set_tune : 1;
316 unsigned serviced : 1;
317 unsigned reserved : 3;
1da177e4
LT
318 } b;
319} special_t;
320
1da177e4
LT
321/*
322 * ATA-IDE Select Register, aka Device-Head
323 *
324 * head : always zeros here
325 * unit : drive select number: 0/1
326 * bit5 : always 1
327 * lba : using LBA instead of CHS
328 * bit7 : always 1
329 */
330typedef union {
331 unsigned all : 8;
332 struct {
333#if defined(__LITTLE_ENDIAN_BITFIELD)
334 unsigned head : 4;
335 unsigned unit : 1;
336 unsigned bit5 : 1;
337 unsigned lba : 1;
338 unsigned bit7 : 1;
339#elif defined(__BIG_ENDIAN_BITFIELD)
340 unsigned bit7 : 1;
341 unsigned lba : 1;
342 unsigned bit5 : 1;
343 unsigned unit : 1;
344 unsigned head : 4;
345#else
346#error "Please fix <asm/byteorder.h>"
347#endif
348 } b;
349} select_t, ata_select_t;
350
1da177e4
LT
351/*
352 * Status returned from various ide_ functions
353 */
354typedef enum {
355 ide_stopped, /* no drive operation was started */
356 ide_started, /* a drive operation was started, handler was set */
357} ide_startstop_t;
358
359struct ide_driver_s;
360struct ide_settings_s;
361
e3a59b4d
HR
362#ifdef CONFIG_BLK_DEV_IDEACPI
363struct ide_acpi_drive_link;
364struct ide_acpi_hwif_link;
365#endif
366
1da177e4
LT
367typedef struct ide_drive_s {
368 char name[4]; /* drive name, such as "hda" */
369 char driver_req[10]; /* requests specific driver */
370
165125e1 371 struct request_queue *queue; /* request queue */
1da177e4
LT
372
373 struct request *rq; /* current request */
374 struct ide_drive_s *next; /* circular list of hwgroup drives */
1da177e4
LT
375 void *driver_data; /* extra driver data */
376 struct hd_driveid *id; /* drive model identification info */
7662d046 377#ifdef CONFIG_IDE_PROC_FS
1da177e4
LT
378 struct proc_dir_entry *proc; /* /proc/ide/ directory entry */
379 struct ide_settings_s *settings;/* /proc/ide/ drive settings */
7662d046 380#endif
1da177e4
LT
381 struct hwif_s *hwif; /* actually (ide_hwif_t *) */
382
383 unsigned long sleep; /* sleep until this time */
384 unsigned long service_start; /* time we started last request */
385 unsigned long service_time; /* service time of last request */
386 unsigned long timeout; /* max time to wait for irq */
387
388 special_t special; /* special action flags */
389 select_t select; /* basic drive/head select reg value */
390
391 u8 keep_settings; /* restore settings after drive reset */
1da177e4
LT
392 u8 using_dma; /* disk is using dma for read/write */
393 u8 retry_pio; /* retrying dma capable host in pio */
394 u8 state; /* retry state */
395 u8 waiting_for_dma; /* dma currently in progress */
396 u8 unmask; /* okay to unmask other irqs */
397 u8 bswap; /* byte swap data */
36193484 398 u8 noflush; /* don't attempt flushes */
1da177e4
LT
399 u8 dsc_overlap; /* DSC overlap */
400 u8 nice1; /* give potential excess bandwidth */
401
402 unsigned present : 1; /* drive is physically present */
403 unsigned dead : 1; /* device ejected hint */
404 unsigned id_read : 1; /* 1=id read from disk 0 = synthetic */
405 unsigned noprobe : 1; /* from: hdx=noprobe */
406 unsigned removable : 1; /* 1 if need to do check_media_change */
407 unsigned attach : 1; /* needed for removable devices */
1da177e4
LT
408 unsigned forced_geom : 1; /* 1 if hdx=c,h,s was given at boot */
409 unsigned no_unmask : 1; /* disallow setting unmask bit */
410 unsigned no_io_32bit : 1; /* disallow enabling 32bit I/O */
411 unsigned atapi_overlap : 1; /* ATAPI overlap (not supported) */
412 unsigned nice0 : 1; /* give obvious excess bandwidth */
413 unsigned nice2 : 1; /* give a share in our own bandwidth */
414 unsigned doorlocking : 1; /* for removable only: door lock/unlock works */
c223701c 415 unsigned nodma : 1; /* disallow DMA */
1da177e4
LT
416 unsigned autotune : 2; /* 0=default, 1=autotune, 2=noautotune */
417 unsigned remap_0_to_1 : 1; /* 0=noremap, 1=remap 0->1 (for EZDrive) */
418 unsigned blocked : 1; /* 1=powermanagment told us not to do anything, so sleep nicely */
419 unsigned vdma : 1; /* 1=doing PIO over DMA 0=doing normal DMA */
1da177e4
LT
420 unsigned scsi : 1; /* 0=default, 1=ide-scsi emulation */
421 unsigned sleeping : 1; /* 1=sleeping & sleep field valid */
422 unsigned post_reset : 1;
7f8f48af 423 unsigned udma33_warned : 1;
1da177e4 424
1497943e 425 u8 addressing; /* 0=28-bit, 1=48-bit, 2=48-bit doing 28-bit */
1da177e4
LT
426 u8 quirk_list; /* considered quirky, set for a specific host */
427 u8 init_speed; /* transfer rate set at boot */
1da177e4 428 u8 current_speed; /* current transfer rate set */
513daadd 429 u8 desired_speed; /* desired transfer rate set */
1da177e4
LT
430 u8 dn; /* now wide spread use */
431 u8 wcache; /* status of write cache */
432 u8 acoustic; /* acoustic management */
433 u8 media; /* disk, cdrom, tape, floppy, ... */
434 u8 ctl; /* "normal" value for IDE_CONTROL_REG */
435 u8 ready_stat; /* min status value for drive ready */
436 u8 mult_count; /* current multiple sector setting */
437 u8 mult_req; /* requested multiple sector setting */
438 u8 tune_req; /* requested drive tuning setting */
439 u8 io_32bit; /* 0=16-bit, 1=32-bit, 2/3=32bit+sync */
440 u8 bad_wstat; /* used for ignoring WRERR_STAT */
441 u8 nowerr; /* used for ignoring WRERR_STAT */
442 u8 sect0; /* offset of first sector for DM6:DDO */
443 u8 head; /* "real" number of heads */
444 u8 sect; /* "real" sectors per track */
445 u8 bios_head; /* BIOS/fdisk/LILO number of heads */
446 u8 bios_sect; /* BIOS/fdisk/LILO sectors per track */
447
448 unsigned int bios_cyl; /* BIOS/fdisk/LILO number of cyls */
449 unsigned int cyl; /* "real" number of cyls */
26bcb879 450 unsigned int drive_data; /* used by set_pio_mode/selectproc */
1da177e4
LT
451 unsigned int failures; /* current failure count */
452 unsigned int max_failures; /* maximum allowed failure count */
dbe217af 453 u64 probed_capacity;/* initial reported media capacity (ide-cd only currently) */
1da177e4
LT
454
455 u64 capacity64; /* total number of sectors */
456
457 int lun; /* logical unit */
458 int crc_count; /* crc counter to reduce drive speed */
e3a59b4d
HR
459#ifdef CONFIG_BLK_DEV_IDEACPI
460 struct ide_acpi_drive_link *acpidata;
461#endif
1da177e4
LT
462 struct list_head list;
463 struct device gendev;
f36d4024 464 struct completion gendev_rel_comp; /* to deal with device release() */
1da177e4
LT
465} ide_drive_t;
466
8604affd
BZ
467#define to_ide_device(dev)container_of(dev, ide_drive_t, gendev)
468
1da177e4
LT
469#define IDE_CHIPSET_PCI_MASK \
470 ((1<<ide_pci)|(1<<ide_cmd646)|(1<<ide_ali14xx))
471#define IDE_CHIPSET_IS_PCI(c) ((IDE_CHIPSET_PCI_MASK >> (c)) & 1)
472
039788e1 473struct ide_port_info;
1da177e4
LT
474
475typedef struct hwif_s {
476 struct hwif_s *next; /* for linked-list in ide_hwgroup_t */
477 struct hwif_s *mate; /* other hwif from same PCI chip */
478 struct hwgroup_s *hwgroup; /* actually (ide_hwgroup_t *) */
479 struct proc_dir_entry *proc; /* /proc/ide/ directory entry */
480
481 char name[6]; /* name of interface, eg. "ide0" */
482
483 /* task file registers for pata and sata */
484 unsigned long io_ports[IDE_NR_PORTS];
485 unsigned long sata_scr[SATA_NR_PORTS];
486 unsigned long sata_misc[SATA_NR_PORTS];
487
1da177e4
LT
488 ide_drive_t drives[MAX_DRIVES]; /* drive info */
489
490 u8 major; /* our major number */
491 u8 index; /* 0 for ide0; 1 for ide1; ... */
492 u8 channel; /* for dual-port chips: 0=primary, 1=secondary */
493 u8 straight8; /* Alan's straight 8 check */
494 u8 bus_state; /* power state of the IDE bus */
495
e95d9c6b 496 u32 host_flags;
6a824c92 497
4099d143
BZ
498 u8 pio_mask;
499
1da177e4
LT
500 u8 ultra_mask;
501 u8 mwdma_mask;
502 u8 swdma_mask;
503
49521f97
BZ
504 u8 cbl; /* cable type */
505
1da177e4
LT
506 hwif_chipset_t chipset; /* sub-module for tuning.. */
507
508 struct pci_dev *pci_dev; /* for pci chipsets */
85620436 509 const struct ide_port_info *cds; /* chipset device struct */
1da177e4 510
18e181fe
BZ
511 ide_ack_intr_t *ack_intr;
512
1da177e4
LT
513 void (*rw_disk)(ide_drive_t *, struct request *);
514
515#if 0
516 ide_hwif_ops_t *hwifops;
517#else
88b2b32b 518 /* routine to program host for PIO mode */
26bcb879 519 void (*set_pio_mode)(ide_drive_t *, const u8);
88b2b32b
BZ
520 /* routine to program host for DMA mode */
521 void (*set_dma_mode)(ide_drive_t *, const u8);
1da177e4
LT
522 /* tweaks hardware to select drive */
523 void (*selectproc)(ide_drive_t *);
524 /* chipset polling based on hba specifics */
525 int (*reset_poll)(ide_drive_t *);
526 /* chipset specific changes to default for device-hba resets */
527 void (*pre_reset)(ide_drive_t *);
528 /* routine to reset controller after a disk reset */
529 void (*resetproc)(ide_drive_t *);
1da177e4
LT
530 /* special host masking for drive selection */
531 void (*maskproc)(ide_drive_t *, int);
532 /* check host's drive quirk list */
f01393e4 533 void (*quirkproc)(ide_drive_t *);
1da177e4
LT
534 /* driver soft-power interface */
535 int (*busproc)(ide_drive_t *, int);
1da177e4 536#endif
b4e44369 537 u8 (*mdma_filter)(ide_drive_t *);
2d5eaa6d 538 u8 (*udma_filter)(ide_drive_t *);
1da177e4
LT
539
540 void (*ata_input_data)(ide_drive_t *, void *, u32);
541 void (*ata_output_data)(ide_drive_t *, void *, u32);
542
543 void (*atapi_input_bytes)(ide_drive_t *, void *, u32);
544 void (*atapi_output_bytes)(ide_drive_t *, void *, u32);
545
15ce926a 546 void (*dma_host_set)(ide_drive_t *, int);
1da177e4
LT
547 int (*dma_setup)(ide_drive_t *);
548 void (*dma_exec_cmd)(ide_drive_t *, u8);
549 void (*dma_start)(ide_drive_t *);
550 int (*ide_dma_end)(ide_drive_t *drive);
1da177e4 551 int (*ide_dma_test_irq)(ide_drive_t *drive);
f0dd8712 552 void (*ide_dma_clear_irq)(ide_drive_t *drive);
841d2a9b 553 void (*dma_lost_irq)(ide_drive_t *drive);
c283f5db 554 void (*dma_timeout)(ide_drive_t *drive);
1da177e4
LT
555
556 void (*OUTB)(u8 addr, unsigned long port);
557 void (*OUTBSYNC)(ide_drive_t *drive, u8 addr, unsigned long port);
558 void (*OUTW)(u16 addr, unsigned long port);
1da177e4
LT
559 void (*OUTSW)(unsigned long port, void *addr, u32 count);
560 void (*OUTSL)(unsigned long port, void *addr, u32 count);
561
562 u8 (*INB)(unsigned long port);
563 u16 (*INW)(unsigned long port);
1da177e4
LT
564 void (*INSW)(unsigned long port, void *addr, u32 count);
565 void (*INSL)(unsigned long port, void *addr, u32 count);
566
567 /* dma physical region descriptor table (cpu view) */
568 unsigned int *dmatable_cpu;
569 /* dma physical region descriptor table (dma view) */
570 dma_addr_t dmatable_dma;
571 /* Scatter-gather list used to build the above */
572 struct scatterlist *sg_table;
573 int sg_max_nents; /* Maximum number of entries in it */
574 int sg_nents; /* Current number of entries in it */
575 int sg_dma_direction; /* dma transfer direction */
576
577 /* data phase of the active command (currently only valid for PIO/DMA) */
578 int data_phase;
579
580 unsigned int nsect;
581 unsigned int nleft;
55c16a70 582 struct scatterlist *cursg;
1da177e4
LT
583 unsigned int cursg_ofs;
584
1da177e4
LT
585 int rqsize; /* max sectors per request */
586 int irq; /* our irq number */
587
1da177e4
LT
588 unsigned long dma_base; /* base addr for dma ports */
589 unsigned long dma_command; /* dma command register */
590 unsigned long dma_vendor1; /* dma vendor 1 register */
591 unsigned long dma_status; /* dma status register */
592 unsigned long dma_vendor3; /* dma vendor 3 register */
593 unsigned long dma_prdtable; /* actual prd table address */
1da177e4 594
1da177e4
LT
595 unsigned long config_data; /* for use by chipset-specific code */
596 unsigned long select_data; /* for use by chipset-specific code */
597
020e322d
SS
598 unsigned long extra_base; /* extra addr for dma ports */
599 unsigned extra_ports; /* number of extra dma ports */
600
1da177e4
LT
601 unsigned noprobe : 1; /* don't probe for this interface */
602 unsigned present : 1; /* this interface exists */
603 unsigned hold : 1; /* this interface is always present */
604 unsigned serialized : 1; /* serialized all channel operation */
605 unsigned sharing_irq: 1; /* 1 = sharing irq with another hwif */
606 unsigned reset : 1; /* reset after probe */
1da177e4
LT
607 unsigned auto_poll : 1; /* supports nop auto-poll */
608 unsigned sg_mapped : 1; /* sg_table and sg_nents are ready */
208a08f7 609 unsigned no_io_32bit : 1; /* 1 = can not do 32-bit IO ops */
2ad1e558 610 unsigned mmio : 1; /* host uses MMIO */
1da177e4
LT
611
612 struct device gendev;
f36d4024 613 struct completion gendev_rel_comp; /* To deal with device release() */
1da177e4
LT
614
615 void *hwif_data; /* extra hwif data */
616
617 unsigned dma;
e3a59b4d
HR
618
619#ifdef CONFIG_BLK_DEV_IDEACPI
620 struct ide_acpi_hwif_link *acpidata;
621#endif
22fc6ecc 622} ____cacheline_internodealigned_in_smp ide_hwif_t;
1da177e4
LT
623
624/*
625 * internal ide interrupt handler type
626 */
1da177e4
LT
627typedef ide_startstop_t (ide_handler_t)(ide_drive_t *);
628typedef int (ide_expiry_t)(ide_drive_t *);
629
630typedef struct hwgroup_s {
631 /* irq handler, if active */
632 ide_startstop_t (*handler)(ide_drive_t *);
633 /* irq handler, suspended if active */
634 ide_startstop_t (*handler_save)(ide_drive_t *);
635 /* BOOL: protects all fields below */
636 volatile int busy;
637 /* BOOL: wake us up on timer expiry */
638 unsigned int sleeping : 1;
639 /* BOOL: polling active & poll_timeout field valid */
640 unsigned int polling : 1;
913759ac
AC
641 /* BOOL: in a polling reset situation. Must not trigger another reset yet */
642 unsigned int resetting : 1;
643
1da177e4
LT
644 /* current drive */
645 ide_drive_t *drive;
646 /* ptr to current hwif in linked-list */
647 ide_hwif_t *hwif;
648
649 /* for pci chipsets */
650 struct pci_dev *pci_dev;
1da177e4
LT
651
652 /* current request */
653 struct request *rq;
654 /* failsafe timer */
655 struct timer_list timer;
656 /* local copy of current write rq */
657 struct request wrq;
658 /* timeout value during long polls */
659 unsigned long poll_timeout;
660 /* queried upon timeouts */
661 int (*expiry)(ide_drive_t *);
662 /* ide_system_bus_speed */
663 int pio_clock;
23450319
SS
664 int req_gen;
665 int req_gen_timer;
1da177e4
LT
666
667 unsigned char cmd_buf[4];
668} ide_hwgroup_t;
669
7662d046
BZ
670typedef struct ide_driver_s ide_driver_t;
671
f9383c42 672extern struct mutex ide_setting_mtx;
1da177e4 673
7662d046
BZ
674int set_io_32bit(ide_drive_t *, int);
675int set_pio_mode(ide_drive_t *, int);
676int set_using_dma(ide_drive_t *, int);
677
678#ifdef CONFIG_IDE_PROC_FS
1da177e4
LT
679/*
680 * configurable drive settings
681 */
682
683#define TYPE_INT 0
1497943e
BZ
684#define TYPE_BYTE 1
685#define TYPE_SHORT 2
1da177e4
LT
686
687#define SETTING_READ (1 << 0)
688#define SETTING_WRITE (1 << 1)
689#define SETTING_RW (SETTING_READ | SETTING_WRITE)
690
691typedef int (ide_procset_t)(ide_drive_t *, int);
692typedef struct ide_settings_s {
693 char *name;
694 int rw;
1da177e4
LT
695 int data_type;
696 int min;
697 int max;
698 int mul_factor;
699 int div_factor;
700 void *data;
701 ide_procset_t *set;
702 int auto_remove;
703 struct ide_settings_s *next;
704} ide_settings_t;
705
1497943e 706int ide_add_setting(ide_drive_t *, const char *, int, int, int, int, int, int, void *, ide_procset_t *set);
1da177e4
LT
707
708/*
709 * /proc/ide interface
710 */
711typedef struct {
712 const char *name;
713 mode_t mode;
714 read_proc_t *read_proc;
715 write_proc_t *write_proc;
716} ide_proc_entry_t;
717
ecfd80e4
BZ
718void proc_ide_create(void);
719void proc_ide_destroy(void);
5cbf79cd
BZ
720void ide_proc_register_port(ide_hwif_t *);
721void ide_proc_unregister_port(ide_hwif_t *);
7662d046
BZ
722void ide_proc_register_driver(ide_drive_t *, ide_driver_t *);
723void ide_proc_unregister_driver(ide_drive_t *, ide_driver_t *);
724
725void ide_add_generic_settings(ide_drive_t *);
726
1da177e4
LT
727read_proc_t proc_ide_read_capacity;
728read_proc_t proc_ide_read_geometry;
729
730#ifdef CONFIG_BLK_DEV_IDEPCI
731void ide_pci_create_host_proc(const char *, get_info_t *);
732#endif
733
734/*
735 * Standard exit stuff:
736 */
737#define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) \
738{ \
739 len -= off; \
740 if (len < count) { \
741 *eof = 1; \
742 if (len <= 0) \
743 return 0; \
744 } else \
745 len = count; \
746 *start = page + off; \
747 return len; \
748}
749#else
ecfd80e4
BZ
750static inline void proc_ide_create(void) { ; }
751static inline void proc_ide_destroy(void) { ; }
5cbf79cd
BZ
752static inline void ide_proc_register_port(ide_hwif_t *hwif) { ; }
753static inline void ide_proc_unregister_port(ide_hwif_t *hwif) { ; }
7662d046
BZ
754static inline void ide_proc_register_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
755static inline void ide_proc_unregister_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
756static inline void ide_add_generic_settings(ide_drive_t *drive) { ; }
1da177e4
LT
757#define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) return 0;
758#endif
759
760/*
761 * Power Management step value (rq->pm->pm_step).
762 *
763 * The step value starts at 0 (ide_pm_state_start_suspend) for a
764 * suspend operation or 1000 (ide_pm_state_start_resume) for a
765 * resume operation.
766 *
767 * For each step, the core calls the subdriver start_power_step() first.
768 * This can return:
769 * - ide_stopped : In this case, the core calls us back again unless
770 * step have been set to ide_power_state_completed.
771 * - ide_started : In this case, the channel is left busy until an
772 * async event (interrupt) occurs.
773 * Typically, start_power_step() will issue a taskfile request with
774 * do_rw_taskfile().
775 *
776 * Upon reception of the interrupt, the core will call complete_power_step()
777 * with the error code if any. This routine should update the step value
778 * and return. It should not start a new request. The core will call
779 * start_power_step for the new step value, unless step have been set to
780 * ide_power_state_completed.
781 *
782 * Subdrivers are expected to define their own additional power
783 * steps from 1..999 for suspend and from 1001..1999 for resume,
784 * other values are reserved for future use.
785 */
786
787enum {
788 ide_pm_state_completed = -1,
789 ide_pm_state_start_suspend = 0,
790 ide_pm_state_start_resume = 1000,
791};
792
793/*
794 * Subdrivers support.
4ef3b8f4
LR
795 *
796 * The gendriver.owner field should be set to the module owner of this driver.
797 * The gendriver.name field should be set to the name of this driver
1da177e4 798 */
7662d046 799struct ide_driver_s {
1da177e4
LT
800 const char *version;
801 u8 media;
1da177e4 802 unsigned supports_dsc_overlap : 1;
1da177e4
LT
803 ide_startstop_t (*do_request)(ide_drive_t *, struct request *, sector_t);
804 int (*end_request)(ide_drive_t *, int, int);
805 ide_startstop_t (*error)(ide_drive_t *, struct request *rq, u8, u8);
806 ide_startstop_t (*abort)(ide_drive_t *, struct request *rq);
1da177e4 807 struct device_driver gen_driver;
4031bbe4
RK
808 int (*probe)(ide_drive_t *);
809 void (*remove)(ide_drive_t *);
0d2157f7 810 void (*resume)(ide_drive_t *);
4031bbe4 811 void (*shutdown)(ide_drive_t *);
7662d046
BZ
812#ifdef CONFIG_IDE_PROC_FS
813 ide_proc_entry_t *proc;
814#endif
815};
1da177e4 816
4031bbe4
RK
817#define to_ide_driver(drv) container_of(drv, ide_driver_t, gen_driver)
818
1da177e4
LT
819int generic_ide_ioctl(ide_drive_t *, struct file *, struct block_device *, unsigned, unsigned long);
820
821/*
822 * ide_hwifs[] is the master data structure used to keep track
823 * of just about everything in ide.c. Whenever possible, routines
824 * should be using pointers to a drive (ide_drive_t *) or
825 * pointers to a hwif (ide_hwif_t *), rather than indexing this
826 * structure directly (the allocation/layout may change!).
827 *
828 */
829#ifndef _IDE_C
830extern ide_hwif_t ide_hwifs[]; /* master data repository */
831#endif
832extern int noautodma;
833
834extern int ide_end_request (ide_drive_t *drive, int uptodate, int nrsecs);
dbe217af
AC
835int ide_end_dequeued_request(ide_drive_t *drive, struct request *rq,
836 int uptodate, int nr_sectors);
1da177e4 837
1da177e4
LT
838extern void ide_set_handler (ide_drive_t *drive, ide_handler_t *handler, unsigned int timeout, ide_expiry_t *expiry);
839
cd2a2d96
BZ
840void ide_execute_command(ide_drive_t *, u8, ide_handler_t *, unsigned int,
841 ide_expiry_t *);
1da177e4
LT
842
843ide_startstop_t __ide_error(ide_drive_t *, struct request *, u8, u8);
844
1da177e4
LT
845ide_startstop_t ide_error (ide_drive_t *drive, const char *msg, byte stat);
846
847ide_startstop_t __ide_abort(ide_drive_t *, struct request *);
848
1da177e4
LT
849extern ide_startstop_t ide_abort(ide_drive_t *, const char *);
850
851extern void ide_fix_driveid(struct hd_driveid *);
01745112 852
1da177e4
LT
853extern void ide_fixstring(u8 *, const int, const int);
854
74af21cf 855int ide_wait_stat(ide_startstop_t *, ide_drive_t *, u8, u8, unsigned long);
1da177e4 856
1da177e4
LT
857extern ide_startstop_t ide_do_reset (ide_drive_t *);
858
1da177e4
LT
859extern void ide_init_drive_cmd (struct request *rq);
860
1da177e4
LT
861/*
862 * "action" parameter type for ide_do_drive_cmd() below.
863 */
864typedef enum {
865 ide_wait, /* insert rq at end of list, and wait for it */
1da177e4
LT
866 ide_preempt, /* insert rq in front of current request */
867 ide_head_wait, /* insert rq in front of current request and wait for it */
868 ide_end /* insert rq at end of list, but don't wait for it */
869} ide_action_t;
870
1da177e4
LT
871extern int ide_do_drive_cmd(ide_drive_t *, struct request *, ide_action_t);
872
1da177e4
LT
873extern void ide_end_drive_cmd(ide_drive_t *, u8, u8);
874
875/*
876 * Issue ATA command and wait for completion.
877 * Use for implementing commands in kernel
878 *
879 * (ide_drive_t *drive, u8 cmd, u8 nsect, u8 feature, u8 sectors, u8 *buf)
880 */
881extern int ide_wait_cmd(ide_drive_t *, u8, u8, u8, u8, u8 *);
882
9e42237f
BZ
883enum {
884 IDE_TFLAG_LBA48 = (1 << 0),
885 IDE_TFLAG_NO_SELECT_MASK = (1 << 1),
74095a91
BZ
886 IDE_TFLAG_FLAGGED = (1 << 2),
887 IDE_TFLAG_OUT_DATA = (1 << 3),
888 IDE_TFLAG_OUT_HOB_FEATURE = (1 << 4),
889 IDE_TFLAG_OUT_HOB_NSECT = (1 << 5),
890 IDE_TFLAG_OUT_HOB_LBAL = (1 << 6),
891 IDE_TFLAG_OUT_HOB_LBAM = (1 << 7),
892 IDE_TFLAG_OUT_HOB_LBAH = (1 << 8),
893 IDE_TFLAG_OUT_HOB = IDE_TFLAG_OUT_HOB_FEATURE |
894 IDE_TFLAG_OUT_HOB_NSECT |
895 IDE_TFLAG_OUT_HOB_LBAL |
896 IDE_TFLAG_OUT_HOB_LBAM |
897 IDE_TFLAG_OUT_HOB_LBAH,
898 IDE_TFLAG_OUT_FEATURE = (1 << 9),
899 IDE_TFLAG_OUT_NSECT = (1 << 10),
900 IDE_TFLAG_OUT_LBAL = (1 << 11),
901 IDE_TFLAG_OUT_LBAM = (1 << 12),
902 IDE_TFLAG_OUT_LBAH = (1 << 13),
903 IDE_TFLAG_OUT_TF = IDE_TFLAG_OUT_FEATURE |
904 IDE_TFLAG_OUT_NSECT |
905 IDE_TFLAG_OUT_LBAL |
906 IDE_TFLAG_OUT_LBAM |
907 IDE_TFLAG_OUT_LBAH,
807e35d6 908 IDE_TFLAG_OUT_DEVICE = (1 << 14),
ac026ff2 909 IDE_TFLAG_WRITE = (1 << 15),
866e2ec9
BZ
910 IDE_TFLAG_FLAGGED_SET_IN_FLAGS = (1 << 16),
911 IDE_TFLAG_IN_DATA = (1 << 17),
57d7366b 912 IDE_TFLAG_CUSTOM_HANDLER = (1 << 18),
f6e29e35 913 IDE_TFLAG_DMA_PIO_FALLBACK = (1 << 19),
c2b57cdc
BZ
914 IDE_TFLAG_IN_HOB_FEATURE = (1 << 20),
915 IDE_TFLAG_IN_HOB_NSECT = (1 << 21),
916 IDE_TFLAG_IN_HOB_LBAL = (1 << 22),
917 IDE_TFLAG_IN_HOB_LBAM = (1 << 23),
918 IDE_TFLAG_IN_HOB_LBAH = (1 << 24),
919 IDE_TFLAG_IN_HOB_LBA = IDE_TFLAG_IN_HOB_LBAL |
920 IDE_TFLAG_IN_HOB_LBAM |
921 IDE_TFLAG_IN_HOB_LBAH,
922 IDE_TFLAG_IN_HOB = IDE_TFLAG_IN_HOB_FEATURE |
923 IDE_TFLAG_IN_HOB_NSECT |
924 IDE_TFLAG_IN_HOB_LBA,
925 IDE_TFLAG_IN_NSECT = (1 << 25),
926 IDE_TFLAG_IN_LBAL = (1 << 26),
927 IDE_TFLAG_IN_LBAM = (1 << 27),
928 IDE_TFLAG_IN_LBAH = (1 << 28),
929 IDE_TFLAG_IN_LBA = IDE_TFLAG_IN_LBAL |
930 IDE_TFLAG_IN_LBAM |
931 IDE_TFLAG_IN_LBAH,
932 IDE_TFLAG_IN_TF = IDE_TFLAG_IN_NSECT |
933 IDE_TFLAG_IN_LBA,
934 IDE_TFLAG_IN_DEVICE = (1 << 29),
9e42237f
BZ
935};
936
650d841d
BZ
937struct ide_taskfile {
938 u8 hob_data; /* 0: high data byte (for TASKFILE IOCTL) */
939
940 u8 hob_feature; /* 1-5: additional data to support LBA48 */
941 u8 hob_nsect;
942 u8 hob_lbal;
943 u8 hob_lbam;
944 u8 hob_lbah;
945
946 u8 data; /* 6: low data byte (for TASKFILE IOCTL) */
947
948 union { /*  7: */
949 u8 error; /* read: error */
950 u8 feature; /* write: feature */
951 };
952
953 u8 nsect; /* 8: number of sectors */
954 u8 lbal; /* 9: LBA low */
955 u8 lbam; /* 10: LBA mid */
956 u8 lbah; /* 11: LBA high */
957
958 u8 device; /* 12: device select */
959
960 union { /* 13: */
961 u8 status; /*  read: status  */
962 u8 command; /* write: command */
963 };
964};
965
1da177e4 966typedef struct ide_task_s {
650d841d
BZ
967 union {
968 struct ide_taskfile tf;
969 u8 tf_array[14];
970 };
866e2ec9 971 u32 tf_flags;
1da177e4 972 int data_phase;
1da177e4
LT
973 struct request *rq; /* copy of request */
974 void *special; /* valid_t generally */
975} ide_task_t;
976
9e42237f 977void ide_tf_load(ide_drive_t *, ide_task_t *);
c2b57cdc 978void ide_tf_read(ide_drive_t *, ide_task_t *);
1da177e4
LT
979
980extern void SELECT_DRIVE(ide_drive_t *);
1da177e4 981extern void SELECT_MASK(ide_drive_t *, int);
1da177e4
LT
982
983extern int drive_is_ready(ide_drive_t *);
1da177e4 984
2fc57388
BZ
985void ide_pktcmd_tf_load(ide_drive_t *, u32, u16, u8);
986
f6e29e35 987ide_startstop_t do_rw_taskfile(ide_drive_t *, ide_task_t *);
1da177e4 988
ac026ff2 989int ide_raw_taskfile(ide_drive_t *, ide_task_t *, u8 *, u16);
9a3c49be
BZ
990int ide_no_data_taskfile(ide_drive_t *, ide_task_t *);
991
1da177e4
LT
992int ide_taskfile_ioctl(ide_drive_t *, unsigned int, unsigned long);
993int ide_cmd_ioctl(ide_drive_t *, unsigned int, unsigned long);
994int ide_task_ioctl(ide_drive_t *, unsigned int, unsigned long);
995
996extern int system_bus_clock(void);
997
998extern int ide_driveid_update(ide_drive_t *);
999extern int ide_ata66_check(ide_drive_t *, ide_task_t *);
1000extern int ide_config_drive_speed(ide_drive_t *, u8);
1001extern u8 eighty_ninty_three (ide_drive_t *);
1002extern int set_transfer(ide_drive_t *, ide_task_t *);
1003extern int taskfile_lib_get_identify(ide_drive_t *drive, u8 *);
1004
1005extern int ide_wait_not_busy(ide_hwif_t *hwif, unsigned long timeout);
1006
1da177e4
LT
1007extern void ide_stall_queue(ide_drive_t *drive, unsigned long timeout);
1008
1009extern int ide_spin_wait_hwgroup(ide_drive_t *);
1010extern void ide_timer_expiry(unsigned long);
7d12e780 1011extern irqreturn_t ide_intr(int irq, void *dev_id);
165125e1 1012extern void do_ide_request(struct request_queue *);
1da177e4
LT
1013
1014void ide_init_disk(struct gendisk *, ide_drive_t *);
1015
6d208b39 1016#ifdef CONFIG_IDEPCI_PCIBUS_ORDER
1da177e4 1017extern void ide_scan_pcibus(int scan_direction) __init;
725522b5
GKH
1018extern int __ide_pci_register_driver(struct pci_driver *driver, struct module *owner, const char *mod_name);
1019#define ide_pci_register_driver(d) __ide_pci_register_driver(d, THIS_MODULE, KBUILD_MODNAME)
6d208b39
BZ
1020#else
1021#define ide_pci_register_driver(d) pci_register_driver(d)
1022#endif
1023
85620436
BZ
1024void ide_pci_setup_ports(struct pci_dev *, const struct ide_port_info *, int, u8 *);
1025void ide_setup_pci_noise(struct pci_dev *, const struct ide_port_info *);
1da177e4
LT
1026
1027extern void default_hwif_iops(ide_hwif_t *);
1028extern void default_hwif_mmiops(ide_hwif_t *);
1029extern void default_hwif_transport(ide_hwif_t *);
1030
1da177e4
LT
1031typedef struct ide_pci_enablebit_s {
1032 u8 reg; /* byte pci reg holding the enable-bit */
1033 u8 mask; /* mask to isolate the enable-bit */
1034 u8 val; /* value of masked reg when "enabled" */
1035} ide_pci_enablebit_t;
1036
1037enum {
1038 /* Uses ISA control ports not PCI ones. */
a5d8c5c8 1039 IDE_HFLAG_ISA_PORTS = (1 << 0),
6a824c92 1040 /* single port device */
a5d8c5c8 1041 IDE_HFLAG_SINGLE = (1 << 1),
6a824c92
BZ
1042 /* don't use legacy PIO blacklist */
1043 IDE_HFLAG_PIO_NO_BLACKLIST = (1 << 2),
1044 /* don't use conservative PIO "downgrade" */
1045 IDE_HFLAG_PIO_NO_DOWNGRADE = (1 << 3),
26bcb879
BZ
1046 /* use PIO8/9 for prefetch off/on */
1047 IDE_HFLAG_ABUSE_PREFETCH = (1 << 4),
1048 /* use PIO6/7 for fast-devsel off/on */
1049 IDE_HFLAG_ABUSE_FAST_DEVSEL = (1 << 5),
1050 /* use 100-102 and 200-202 PIO values to set DMA modes */
1051 IDE_HFLAG_ABUSE_DMA_MODES = (1 << 6),
aedea591
BZ
1052 /*
1053 * keep DMA setting when programming PIO mode, may be used only
1054 * for hosts which have separate PIO and DMA timings (ie. PMAC)
1055 */
1056 IDE_HFLAG_SET_PIO_MODE_KEEP_DMA = (1 << 7),
88b2b32b
BZ
1057 /* program host for the transfer mode after programming device */
1058 IDE_HFLAG_POST_SET_MODE = (1 << 8),
1059 /* don't program host/device for the transfer mode ("smart" hosts) */
1060 IDE_HFLAG_NO_SET_MODE = (1 << 9),
0ae2e178
BZ
1061 /* trust BIOS for programming chipset/device for DMA */
1062 IDE_HFLAG_TRUST_BIOS_FOR_DMA = (1 << 10),
1063 /* host uses VDMA */
1064 IDE_HFLAG_VDMA = (1 << 11),
33c1002e
BZ
1065 /* ATAPI DMA is unsupported */
1066 IDE_HFLAG_NO_ATAPI_DMA = (1 << 12),
7cab14a7
BZ
1067 /* set if host is a "bootable" controller */
1068 IDE_HFLAG_BOOTABLE = (1 << 13),
47b68788
BZ
1069 /* host doesn't support DMA */
1070 IDE_HFLAG_NO_DMA = (1 << 14),
1071 /* check if host is PCI IDE device before allowing DMA */
1072 IDE_HFLAG_NO_AUTODMA = (1 << 15),
9ffcf364
BZ
1073 /* host is CS5510/CS5520 */
1074 IDE_HFLAG_CS5520 = (1 << 16),
238e4f14
BZ
1075 /* no LBA48 */
1076 IDE_HFLAG_NO_LBA48 = (1 << 17),
1077 /* no LBA48 DMA */
1078 IDE_HFLAG_NO_LBA48_DMA = (1 << 18),
ed67b923
BZ
1079 /* data FIFO is cleared by an error */
1080 IDE_HFLAG_ERROR_STOPS_FIFO = (1 << 19),
1c51361a
BZ
1081 /* serialize ports */
1082 IDE_HFLAG_SERIALIZE = (1 << 20),
3985ee3b
BZ
1083 /* use legacy IRQs */
1084 IDE_HFLAG_LEGACY_IRQS = (1 << 21),
8acf28c0
BZ
1085 /* force use of legacy IRQs */
1086 IDE_HFLAG_FORCE_LEGACY_IRQS = (1 << 22),
272a3709
BZ
1087 /* limit LBA48 requests to 256 sectors */
1088 IDE_HFLAG_RQSIZE_256 = (1 << 23),
caea7602
BZ
1089 /* use 32-bit I/O ops */
1090 IDE_HFLAG_IO_32BIT = (1 << 24),
1091 /* unmask IRQs */
1092 IDE_HFLAG_UNMASK_IRQS = (1 << 25),
4db90a14 1093 IDE_HFLAG_ABUSE_SET_DMA_MODE = (1 << 26),
8704de8f
BZ
1094 /* host is CY82C693 */
1095 IDE_HFLAG_CY82C693 = (1 << 27),
1da177e4
LT
1096};
1097
7cab14a7
BZ
1098#ifdef CONFIG_BLK_DEV_OFFBOARD
1099# define IDE_HFLAG_OFF_BOARD IDE_HFLAG_BOOTABLE
1100#else
1101# define IDE_HFLAG_OFF_BOARD 0
1102#endif
1103
039788e1 1104struct ide_port_info {
1da177e4 1105 char *name;
1da177e4
LT
1106 unsigned int (*init_chipset)(struct pci_dev *, const char *);
1107 void (*init_iops)(ide_hwif_t *);
1108 void (*init_hwif)(ide_hwif_t *);
1109 void (*init_dma)(ide_hwif_t *, unsigned long);
1da177e4 1110 ide_pci_enablebit_t enablebits[2];
528a572d 1111 hwif_chipset_t chipset;
3071a9d0 1112 u8 extra;
9ffcf364 1113 u32 host_flags;
4099d143 1114 u8 pio_mask;
5f8b6c34
BZ
1115 u8 swdma_mask;
1116 u8 mwdma_mask;
18137207 1117 u8 udma_mask;
039788e1 1118};
1da177e4 1119
85620436
BZ
1120int ide_setup_pci_device(struct pci_dev *, const struct ide_port_info *);
1121int ide_setup_pci_devices(struct pci_dev *, struct pci_dev *, const struct ide_port_info *);
1da177e4
LT
1122
1123void ide_map_sg(ide_drive_t *, struct request *);
1124void ide_init_sg_cmd(ide_drive_t *, struct request *);
1125
1126#define BAD_DMA_DRIVE 0
1127#define GOOD_DMA_DRIVE 1
1128
65e5f2e3
JC
1129struct drive_list_entry {
1130 const char *id_model;
1131 const char *id_firmware;
1132};
1133
1134int ide_in_drive_list(struct hd_driveid *, const struct drive_list_entry *);
a5b7e70d
BZ
1135
1136#ifdef CONFIG_BLK_DEV_IDEDMA
1da177e4 1137int __ide_dma_bad_drive(ide_drive_t *);
3ab7efe8 1138int ide_id_dma_bug(ide_drive_t *);
7670df73
BZ
1139
1140u8 ide_find_dma_mode(ide_drive_t *, u8);
1141
1142static inline u8 ide_max_dma_mode(ide_drive_t *drive)
1143{
1144 return ide_find_dma_mode(drive, XFER_UDMA_6);
1145}
1146
4a546e04 1147void ide_dma_off_quietly(ide_drive_t *);
7469aaf6 1148void ide_dma_off(ide_drive_t *);
4a546e04 1149void ide_dma_on(ide_drive_t *);
3608b5d7 1150int ide_set_dma(ide_drive_t *);
1da177e4
LT
1151ide_startstop_t ide_dma_intr(ide_drive_t *);
1152
1153#ifdef CONFIG_BLK_DEV_IDEDMA_PCI
1154extern int ide_build_sglist(ide_drive_t *, struct request *);
1155extern int ide_build_dmatable(ide_drive_t *, struct request *);
1156extern void ide_destroy_dmatable(ide_drive_t *);
1157extern int ide_release_dma(ide_hwif_t *);
1158extern void ide_setup_dma(ide_hwif_t *, unsigned long, unsigned int);
1159
15ce926a 1160void ide_dma_host_set(ide_drive_t *, int);
1da177e4
LT
1161extern int ide_dma_setup(ide_drive_t *);
1162extern void ide_dma_start(ide_drive_t *);
1163extern int __ide_dma_end(ide_drive_t *);
841d2a9b 1164extern void ide_dma_lost_irq(ide_drive_t *);
c283f5db 1165extern void ide_dma_timeout(ide_drive_t *);
1da177e4
LT
1166#endif /* CONFIG_BLK_DEV_IDEDMA_PCI */
1167
1168#else
3ab7efe8 1169static inline int ide_id_dma_bug(ide_drive_t *drive) { return 0; }
7670df73 1170static inline u8 ide_find_dma_mode(ide_drive_t *drive, u8 speed) { return 0; }
2d5eaa6d 1171static inline u8 ide_max_dma_mode(ide_drive_t *drive) { return 0; }
4a546e04 1172static inline void ide_dma_off_quietly(ide_drive_t *drive) { ; }
7469aaf6 1173static inline void ide_dma_off(ide_drive_t *drive) { ; }
4a546e04 1174static inline void ide_dma_on(ide_drive_t *drive) { ; }
1da177e4 1175static inline void ide_dma_verbose(ide_drive_t *drive) { ; }
3608b5d7 1176static inline int ide_set_dma(ide_drive_t *drive) { return 1; }
1da177e4
LT
1177#endif /* CONFIG_BLK_DEV_IDEDMA */
1178
1179#ifndef CONFIG_BLK_DEV_IDEDMA_PCI
1180static inline void ide_release_dma(ide_hwif_t *drive) {;}
1181#endif
1182
e3a59b4d
HR
1183#ifdef CONFIG_BLK_DEV_IDEACPI
1184extern int ide_acpi_exec_tfs(ide_drive_t *drive);
1185extern void ide_acpi_get_timing(ide_hwif_t *hwif);
1186extern void ide_acpi_push_timing(ide_hwif_t *hwif);
1187extern void ide_acpi_init(ide_hwif_t *hwif);
5e32132b 1188extern void ide_acpi_set_state(ide_hwif_t *hwif, int on);
e3a59b4d
HR
1189#else
1190static inline int ide_acpi_exec_tfs(ide_drive_t *drive) { return 0; }
1191static inline void ide_acpi_get_timing(ide_hwif_t *hwif) { ; }
1192static inline void ide_acpi_push_timing(ide_hwif_t *hwif) { ; }
1193static inline void ide_acpi_init(ide_hwif_t *hwif) { ; }
5e32132b 1194static inline void ide_acpi_set_state(ide_hwif_t *hwif, int on) {}
e3a59b4d
HR
1195#endif
1196
1da177e4
LT
1197extern int ide_hwif_request_regions(ide_hwif_t *hwif);
1198extern void ide_hwif_release_regions(ide_hwif_t* hwif);
1199extern void ide_unregister (unsigned int index);
1200
1201void ide_register_region(struct gendisk *);
1202void ide_unregister_region(struct gendisk *);
1203
f01393e4 1204void ide_undecoded_slave(ide_drive_t *);
1da177e4 1205
b0d5bc27 1206int ide_device_add_all(u8 *idx);
8447d9d5 1207int ide_device_add(u8 idx[4]);
1da177e4
LT
1208
1209static inline void *ide_get_hwifdata (ide_hwif_t * hwif)
1210{
1211 return hwif->hwif_data;
1212}
1213
1214static inline void ide_set_hwifdata (ide_hwif_t * hwif, void *data)
1215{
1216 hwif->hwif_data = data;
1217}
1218
3ab7efe8 1219const char *ide_xfer_verbose(u8 mode);
1da177e4
LT
1220extern void ide_toggle_bounce(ide_drive_t *drive, int on);
1221extern int ide_set_xfer_rate(ide_drive_t *drive, u8 rate);
1222
2229833c
BZ
1223static inline int ide_dev_has_iordy(struct hd_driveid *id)
1224{
1225 return ((id->field_valid & 2) && (id->capability & 8)) ? 1 : 0;
1226}
1227
6c3c22f3
SS
1228static inline int ide_dev_is_sata(struct hd_driveid *id)
1229{
1230 /*
1231 * See if word 93 is 0 AND drive is at least ATA-5 compatible
1232 * verifying that word 80 by casting it to a signed type --
1233 * this trick allows us to filter out the reserved values of
1234 * 0x0000 and 0xffff along with the earlier ATA revisions...
1235 */
1236 if (id->hw_config == 0 && (short)id->major_rev_num >= 0x0020)
1237 return 1;
1238 return 0;
1239}
1240
a501633c 1241u64 ide_get_lba_addr(struct ide_taskfile *, int);
1da177e4
LT
1242u8 ide_dump_status(ide_drive_t *, const char *, u8);
1243
1244typedef struct ide_pio_timings_s {
1245 int setup_time; /* Address setup (ns) minimum */
1246 int active_time; /* Active pulse (ns) minimum */
81d368e0
SS
1247 int cycle_time; /* Cycle time (ns) minimum = */
1248 /* active + recovery (+ setup for some chips) */
1da177e4
LT
1249} ide_pio_timings_t;
1250
7dd00083 1251unsigned int ide_pio_cycle_time(ide_drive_t *, u8);
2134758d 1252u8 ide_get_best_pio_mode(ide_drive_t *, u8, u8);
1da177e4
LT
1253extern const ide_pio_timings_t ide_pio_timings[6];
1254
88b2b32b
BZ
1255int ide_set_pio_mode(ide_drive_t *, u8);
1256int ide_set_dma_mode(ide_drive_t *, u8);
1257
26bcb879
BZ
1258void ide_set_pio(ide_drive_t *, u8);
1259
1260static inline void ide_set_max_pio(ide_drive_t *drive)
1261{
1262 ide_set_pio(drive, 255);
1263}
1da177e4
LT
1264
1265extern spinlock_t ide_lock;
ef29888e 1266extern struct mutex ide_cfg_mtx;
1da177e4
LT
1267/*
1268 * Structure locking:
1269 *
ef29888e 1270 * ide_cfg_mtx and ide_lock together protect changes to
1da177e4
LT
1271 * ide_hwif_t->{next,hwgroup}
1272 * ide_drive_t->next
1273 *
1274 * ide_hwgroup_t->busy: ide_lock
1275 * ide_hwgroup_t->hwif: ide_lock
1276 * ide_hwif_t->mate: constant, no locking
1277 * ide_drive_t->hwif: constant, no locking
1278 */
1279
366c7f55 1280#define local_irq_set(flags) do { local_save_flags((flags)); local_irq_enable_in_hardirq(); } while (0)
1da177e4
LT
1281
1282extern struct bus_type ide_bus_type;
1283
1284/* check if CACHE FLUSH (EXT) command is supported (bits defined in ATA-6) */
1285#define ide_id_has_flush_cache(id) ((id)->cfs_enable_2 & 0x3000)
1286
1287/* some Maxtor disks have bit 13 defined incorrectly so check bit 10 too */
1288#define ide_id_has_flush_cache_ext(id) \
1289 (((id)->cfs_enable_2 & 0x2400) == 0x2400)
1290
86b37860
CL
1291static inline int hwif_to_node(ide_hwif_t *hwif)
1292{
1293 struct pci_dev *dev = hwif->pci_dev;
1294 return dev ? pcibus_to_node(dev->bus) : -1;
1295}
1296
1b678347
BH
1297static inline ide_drive_t *ide_get_paired_drive(ide_drive_t *drive)
1298{
1299 ide_hwif_t *hwif = HWIF(drive);
1300
1301 return &hwif->drives[(drive->dn ^ 1) & 1];
1302}
1303
1da177e4 1304#endif /* _IDE_H */