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