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