Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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
9#include <linux/init.h>
10#include <linux/ioport.h>
11#include <linux/ata.h>
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>
19#include <linux/completion.h>
20#include <linux/pm.h>
21#ifdef CONFIG_BLK_DEV_IDEACPI
22#include <acpi/acpi.h>
23#endif
24#include <asm/byteorder.h>
25#include <asm/system.h>
26#include <asm/io.h>
27#include <asm/mutex.h>
28
29#if defined(CONFIG_CRIS) || defined(CONFIG_FRV)
30# define SUPPORT_VLB_SYNC 0
31#else
32# define SUPPORT_VLB_SYNC 1
33#endif
34
35typedef unsigned char byte; /* used everywhere */
36
37/*
38 * Probably not wise to fiddle with these
39 */
40#define ERROR_MAX 8 /* Max read/write errors per sector */
41#define ERROR_RESET 3 /* Reset controller every 4th retry */
42#define ERROR_RECAL 1 /* Recalibrate every 2nd retry */
43
44#define HWIF(drive) ((ide_hwif_t *)((drive)->hwif))
45#define HWGROUP(drive) ((ide_hwgroup_t *)(HWIF(drive)->hwgroup))
46
47/*
48 * Definitions for accessing IDE controller registers
49 */
50#define IDE_NR_PORTS (10)
51
52struct ide_io_ports {
53 unsigned long data_addr;
54
55 union {
56 unsigned long error_addr; /* read: error */
57 unsigned long feature_addr; /* write: feature */
58 };
59
60 unsigned long nsect_addr;
61 unsigned long lbal_addr;
62 unsigned long lbam_addr;
63 unsigned long lbah_addr;
64
65 unsigned long device_addr;
66
67 union {
68 unsigned long status_addr; /* read: status */
69 unsigned long command_addr; /* write: command */
70 };
71
72 unsigned long ctl_addr;
73
74 unsigned long irq_addr;
75};
76
77#define OK_STAT(stat,good,bad) (((stat)&((good)|(bad)))==(good))
78
79#define BAD_R_STAT (ATA_BUSY | ATA_ERR)
80#define BAD_W_STAT (BAD_R_STAT | ATA_DF)
81#define BAD_STAT (BAD_R_STAT | ATA_DRQ)
82#define DRIVE_READY (ATA_DRDY | ATA_DSC)
83
84#define BAD_CRC (ATA_ABORTED | ATA_ICRC)
85
86#define SATA_NR_PORTS (3) /* 16 possible ?? */
87
88#define SATA_STATUS_OFFSET (0)
89#define SATA_ERROR_OFFSET (1)
90#define SATA_CONTROL_OFFSET (2)
91
92/*
93 * Our Physical Region Descriptor (PRD) table should be large enough
94 * to handle the biggest I/O request we are likely to see. Since requests
95 * can have no more than 256 sectors, and since the typical blocksize is
96 * two or more sectors, we could get by with a limit of 128 entries here for
97 * the usual worst case. Most requests seem to include some contiguous blocks,
98 * further reducing the number of table entries required.
99 *
100 * The driver reverts to PIO mode for individual requests that exceed
101 * this limit (possible with 512 byte blocksizes, eg. MSDOS f/s), so handling
102 * 100% of all crazy scenarios here is not necessary.
103 *
104 * As it turns out though, we must allocate a full 4KB page for this,
105 * so the two PRD tables (ide0 & ide1) will each get half of that,
106 * allowing each to have about 256 entries (8 bytes each) from this.
107 */
108#define PRD_BYTES 8
109#define PRD_ENTRIES 256
110
111/*
112 * Some more useful definitions
113 */
114#define PARTN_BITS 6 /* number of minor dev bits for partitions */
115#define MAX_DRIVES 2 /* per interface; 2 assumed by lots of code */
116#define SECTOR_SIZE 512
117
118/*
119 * Timeouts for various operations:
120 */
121enum {
122 /* spec allows up to 20ms */
123 WAIT_DRQ = HZ / 10, /* 100ms */
124 /* some laptops are very slow */
125 WAIT_READY = 5 * HZ, /* 5s */
126 /* should be less than 3ms (?), if all ATAPI CD is closed at boot */
127 WAIT_PIDENTIFY = 10 * HZ, /* 10s */
128 /* worst case when spinning up */
129 WAIT_WORSTCASE = 30 * HZ, /* 30s */
130 /* maximum wait for an IRQ to happen */
131 WAIT_CMD = 10 * HZ, /* 10s */
132 /* Some drives require a longer IRQ timeout. */
133 WAIT_FLOPPY_CMD = 50 * HZ, /* 50s */
134 /*
135 * Some drives (for example, Seagate STT3401A Travan) require a very
136 * long timeout, because they don't return an interrupt or clear their
137 * BSY bit until after the command completes (even retension commands).
138 */
139 WAIT_TAPE_CMD = 900 * HZ, /* 900s */
140 /* minimum sleep time */
141 WAIT_MIN_SLEEP = HZ / 50, /* 20ms */
142};
143
144/*
145 * Op codes for special requests to be handled by ide_special_rq().
146 * Values should be in the range of 0x20 to 0x3f.
147 */
148#define REQ_DRIVE_RESET 0x20
149#define REQ_DEVSET_EXEC 0x21
150#define REQ_PARK_HEADS 0x22
151#define REQ_UNPARK_HEADS 0x23
152
153/*
154 * Check for an interrupt and acknowledge the interrupt status
155 */
156struct hwif_s;
157typedef int (ide_ack_intr_t)(struct hwif_s *);
158
159/*
160 * hwif_chipset_t is used to keep track of the specific hardware
161 * chipset used by each IDE interface, if known.
162 */
163enum { ide_unknown, ide_generic, ide_pci,
164 ide_cmd640, ide_dtc2278, ide_ali14xx,
165 ide_qd65xx, ide_umc8672, ide_ht6560b,
166 ide_4drives, ide_pmac, ide_acorn,
167 ide_au1xxx, ide_palm3710
168};
169
170typedef u8 hwif_chipset_t;
171
172/*
173 * Structure to hold all information about the location of this port
174 */
175typedef struct hw_regs_s {
176 union {
177 struct ide_io_ports io_ports;
178 unsigned long io_ports_array[IDE_NR_PORTS];
179 };
180
181 int irq; /* our irq number */
182 ide_ack_intr_t *ack_intr; /* acknowledge interrupt */
183 hwif_chipset_t chipset;
184 struct device *dev, *parent;
185 unsigned long config;
186} hw_regs_t;
187
188void ide_init_port_data(struct hwif_s *, unsigned int);
189void ide_init_port_hw(struct hwif_s *, hw_regs_t *);
190
191static inline void ide_std_init_ports(hw_regs_t *hw,
192 unsigned long io_addr,
193 unsigned long ctl_addr)
194{
195 unsigned int i;
196
197 for (i = 0; i <= 7; i++)
198 hw->io_ports_array[i] = io_addr++;
199
200 hw->io_ports.ctl_addr = ctl_addr;
201}
202
203/* for IDE PCI controllers in legacy mode, temporary */
204static inline int __ide_default_irq(unsigned long base)
205{
206 switch (base) {
207#ifdef CONFIG_IA64
208 case 0x1f0: return isa_irq_to_vector(14);
209 case 0x170: return isa_irq_to_vector(15);
210#else
211 case 0x1f0: return 14;
212 case 0x170: return 15;
213#endif
214 }
215 return 0;
216}
217
218#if defined(CONFIG_ARM) || defined(CONFIG_FRV) || defined(CONFIG_M68K) || \
219 defined(CONFIG_MIPS) || defined(CONFIG_MN10300) || defined(CONFIG_PARISC) \
220 || defined(CONFIG_PPC) || defined(CONFIG_SPARC) || defined(CONFIG_SPARC64)
221#include <asm/ide.h>
222#else
223#include <asm-generic/ide_iops.h>
224#endif
225
226#define MAX_HWIFS 10
227
228/* Currently only m68k, apus and m8xx need it */
229#ifndef IDE_ARCH_ACK_INTR
230# define ide_ack_intr(hwif) (1)
231#endif
232
233/* Currently only Atari needs it */
234#ifndef IDE_ARCH_LOCK
235# define ide_release_lock() do {} while (0)
236# define ide_get_lock(hdlr, data) do {} while (0)
237#endif /* IDE_ARCH_LOCK */
238
239/*
240 * Now for the data we need to maintain per-drive: ide_drive_t
241 */
242
243#define ide_scsi 0x21
244#define ide_disk 0x20
245#define ide_optical 0x7
246#define ide_cdrom 0x5
247#define ide_tape 0x1
248#define ide_floppy 0x0
249
250/*
251 * Special Driver Flags
252 *
253 * set_geometry : respecify drive geometry
254 * recalibrate : seek to cyl 0
255 * set_multmode : set multmode count
256 * reserved : unused
257 */
258typedef union {
259 unsigned all : 8;
260 struct {
261 unsigned set_geometry : 1;
262 unsigned recalibrate : 1;
263 unsigned set_multmode : 1;
264 unsigned reserved : 5;
265 } b;
266} special_t;
267
268/*
269 * Status returned from various ide_ functions
270 */
271typedef enum {
272 ide_stopped, /* no drive operation was started */
273 ide_started, /* a drive operation was started, handler was set */
274} ide_startstop_t;
275
276enum {
277 IDE_TFLAG_LBA48 = (1 << 0),
278 IDE_TFLAG_FLAGGED = (1 << 2),
279 IDE_TFLAG_OUT_DATA = (1 << 3),
280 IDE_TFLAG_OUT_HOB_FEATURE = (1 << 4),
281 IDE_TFLAG_OUT_HOB_NSECT = (1 << 5),
282 IDE_TFLAG_OUT_HOB_LBAL = (1 << 6),
283 IDE_TFLAG_OUT_HOB_LBAM = (1 << 7),
284 IDE_TFLAG_OUT_HOB_LBAH = (1 << 8),
285 IDE_TFLAG_OUT_HOB = IDE_TFLAG_OUT_HOB_FEATURE |
286 IDE_TFLAG_OUT_HOB_NSECT |
287 IDE_TFLAG_OUT_HOB_LBAL |
288 IDE_TFLAG_OUT_HOB_LBAM |
289 IDE_TFLAG_OUT_HOB_LBAH,
290 IDE_TFLAG_OUT_FEATURE = (1 << 9),
291 IDE_TFLAG_OUT_NSECT = (1 << 10),
292 IDE_TFLAG_OUT_LBAL = (1 << 11),
293 IDE_TFLAG_OUT_LBAM = (1 << 12),
294 IDE_TFLAG_OUT_LBAH = (1 << 13),
295 IDE_TFLAG_OUT_TF = IDE_TFLAG_OUT_FEATURE |
296 IDE_TFLAG_OUT_NSECT |
297 IDE_TFLAG_OUT_LBAL |
298 IDE_TFLAG_OUT_LBAM |
299 IDE_TFLAG_OUT_LBAH,
300 IDE_TFLAG_OUT_DEVICE = (1 << 14),
301 IDE_TFLAG_WRITE = (1 << 15),
302 IDE_TFLAG_FLAGGED_SET_IN_FLAGS = (1 << 16),
303 IDE_TFLAG_IN_DATA = (1 << 17),
304 IDE_TFLAG_CUSTOM_HANDLER = (1 << 18),
305 IDE_TFLAG_DMA_PIO_FALLBACK = (1 << 19),
306 IDE_TFLAG_IN_HOB_FEATURE = (1 << 20),
307 IDE_TFLAG_IN_HOB_NSECT = (1 << 21),
308 IDE_TFLAG_IN_HOB_LBAL = (1 << 22),
309 IDE_TFLAG_IN_HOB_LBAM = (1 << 23),
310 IDE_TFLAG_IN_HOB_LBAH = (1 << 24),
311 IDE_TFLAG_IN_HOB_LBA = IDE_TFLAG_IN_HOB_LBAL |
312 IDE_TFLAG_IN_HOB_LBAM |
313 IDE_TFLAG_IN_HOB_LBAH,
314 IDE_TFLAG_IN_HOB = IDE_TFLAG_IN_HOB_FEATURE |
315 IDE_TFLAG_IN_HOB_NSECT |
316 IDE_TFLAG_IN_HOB_LBA,
317 IDE_TFLAG_IN_FEATURE = (1 << 1),
318 IDE_TFLAG_IN_NSECT = (1 << 25),
319 IDE_TFLAG_IN_LBAL = (1 << 26),
320 IDE_TFLAG_IN_LBAM = (1 << 27),
321 IDE_TFLAG_IN_LBAH = (1 << 28),
322 IDE_TFLAG_IN_LBA = IDE_TFLAG_IN_LBAL |
323 IDE_TFLAG_IN_LBAM |
324 IDE_TFLAG_IN_LBAH,
325 IDE_TFLAG_IN_TF = IDE_TFLAG_IN_NSECT |
326 IDE_TFLAG_IN_LBA,
327 IDE_TFLAG_IN_DEVICE = (1 << 29),
328 IDE_TFLAG_HOB = IDE_TFLAG_OUT_HOB |
329 IDE_TFLAG_IN_HOB,
330 IDE_TFLAG_TF = IDE_TFLAG_OUT_TF |
331 IDE_TFLAG_IN_TF,
332 IDE_TFLAG_DEVICE = IDE_TFLAG_OUT_DEVICE |
333 IDE_TFLAG_IN_DEVICE,
334 /* force 16-bit I/O operations */
335 IDE_TFLAG_IO_16BIT = (1 << 30),
336 /* ide_task_t was allocated using kmalloc() */
337 IDE_TFLAG_DYN = (1 << 31),
338};
339
340struct ide_taskfile {
341 u8 hob_data; /* 0: high data byte (for TASKFILE IOCTL) */
342
343 u8 hob_feature; /* 1-5: additional data to support LBA48 */
344 u8 hob_nsect;
345 u8 hob_lbal;
346 u8 hob_lbam;
347 u8 hob_lbah;
348
349 u8 data; /* 6: low data byte (for TASKFILE IOCTL) */
350
351 union { /* 7: */
352 u8 error; /* read: error */
353 u8 feature; /* write: feature */
354 };
355
356 u8 nsect; /* 8: number of sectors */
357 u8 lbal; /* 9: LBA low */
358 u8 lbam; /* 10: LBA mid */
359 u8 lbah; /* 11: LBA high */
360
361 u8 device; /* 12: device select */
362
363 union { /* 13: */
364 u8 status; /* read: status */
365 u8 command; /* write: command */
366 };
367};
368
369typedef struct ide_task_s {
370 union {
371 struct ide_taskfile tf;
372 u8 tf_array[14];
373 };
374 u32 tf_flags;
375 int data_phase;
376 struct request *rq; /* copy of request */
377 void *special; /* valid_t generally */
378} ide_task_t;
379
380/* ATAPI packet command flags */
381enum {
382 /* set when an error is considered normal - no retry (ide-tape) */
383 PC_FLAG_ABORT = (1 << 0),
384 PC_FLAG_SUPPRESS_ERROR = (1 << 1),
385 PC_FLAG_WAIT_FOR_DSC = (1 << 2),
386 PC_FLAG_DMA_OK = (1 << 3),
387 PC_FLAG_DMA_IN_PROGRESS = (1 << 4),
388 PC_FLAG_DMA_ERROR = (1 << 5),
389 PC_FLAG_WRITING = (1 << 6),
390 /* command timed out */
391 PC_FLAG_TIMEDOUT = (1 << 7),
392};
393
394/*
395 * With each packet command, we allocate a buffer of IDE_PC_BUFFER_SIZE bytes.
396 * This is used for several packet commands (not for READ/WRITE commands).
397 */
398#define IDE_PC_BUFFER_SIZE 256
399#define ATAPI_WAIT_PC (60 * HZ)
400
401struct ide_atapi_pc {
402 /* actual packet bytes */
403 u8 c[12];
404 /* incremented on each retry */
405 int retries;
406 int error;
407
408 /* bytes to transfer */
409 int req_xfer;
410 /* bytes actually transferred */
411 int xferred;
412
413 /* data buffer */
414 u8 *buf;
415 /* current buffer position */
416 u8 *cur_pos;
417 int buf_size;
418 /* missing/available data on the current buffer */
419 int b_count;
420
421 /* the corresponding request */
422 struct request *rq;
423
424 unsigned long flags;
425
426 /*
427 * those are more or less driver-specific and some of them are subject
428 * to change/removal later.
429 */
430 u8 pc_buf[IDE_PC_BUFFER_SIZE];
431
432 /* idetape only */
433 struct idetape_bh *bh;
434 char *b_data;
435
436 /* idescsi only for now */
437 struct scatterlist *sg;
438 unsigned int sg_cnt;
439
440 struct scsi_cmnd *scsi_cmd;
441 void (*done) (struct scsi_cmnd *);
442
443 unsigned long timeout;
444};
445
446struct ide_devset;
447struct ide_driver_s;
448
449#ifdef CONFIG_BLK_DEV_IDEACPI
450struct ide_acpi_drive_link;
451struct ide_acpi_hwif_link;
452#endif
453
454struct ide_drive_s;
455
456struct ide_disk_ops {
457 int (*check)(struct ide_drive_s *, const char *);
458 int (*get_capacity)(struct ide_drive_s *);
459 void (*setup)(struct ide_drive_s *);
460 void (*flush)(struct ide_drive_s *);
461 int (*init_media)(struct ide_drive_s *, struct gendisk *);
462 int (*set_doorlock)(struct ide_drive_s *, struct gendisk *,
463 int);
464 ide_startstop_t (*do_request)(struct ide_drive_s *, struct request *,
465 sector_t);
466 int (*end_request)(struct ide_drive_s *, int, int);
467 int (*ioctl)(struct ide_drive_s *, struct block_device *,
468 fmode_t, unsigned int, unsigned long);
469};
470
471/* ATAPI device flags */
472enum {
473 IDE_AFLAG_DRQ_INTERRUPT = (1 << 0),
474
475 /* ide-cd */
476 /* Drive cannot eject the disc. */
477 IDE_AFLAG_NO_EJECT = (1 << 1),
478 /* Drive is a pre ATAPI 1.2 drive. */
479 IDE_AFLAG_PRE_ATAPI12 = (1 << 2),
480 /* TOC addresses are in BCD. */
481 IDE_AFLAG_TOCADDR_AS_BCD = (1 << 3),
482 /* TOC track numbers are in BCD. */
483 IDE_AFLAG_TOCTRACKS_AS_BCD = (1 << 4),
484 /*
485 * Drive does not provide data in multiples of SECTOR_SIZE
486 * when more than one interrupt is needed.
487 */
488 IDE_AFLAG_LIMIT_NFRAMES = (1 << 5),
489 /* Saved TOC information is current. */
490 IDE_AFLAG_TOC_VALID = (1 << 6),
491 /* We think that the drive door is locked. */
492 IDE_AFLAG_DOOR_LOCKED = (1 << 7),
493 /* SET_CD_SPEED command is unsupported. */
494 IDE_AFLAG_NO_SPEED_SELECT = (1 << 8),
495 IDE_AFLAG_VERTOS_300_SSD = (1 << 9),
496 IDE_AFLAG_VERTOS_600_ESD = (1 << 10),
497 IDE_AFLAG_SANYO_3CD = (1 << 11),
498 IDE_AFLAG_FULL_CAPS_PAGE = (1 << 12),
499 IDE_AFLAG_PLAY_AUDIO_OK = (1 << 13),
500 IDE_AFLAG_LE_SPEED_FIELDS = (1 << 14),
501
502 /* ide-floppy */
503 /* Avoid commands not supported in Clik drive */
504 IDE_AFLAG_CLIK_DRIVE = (1 << 15),
505 /* Requires BH algorithm for packets */
506 IDE_AFLAG_ZIP_DRIVE = (1 << 16),
507 /* Supports format progress report */
508 IDE_AFLAG_SRFP = (1 << 17),
509
510 /* ide-tape */
511 IDE_AFLAG_IGNORE_DSC = (1 << 18),
512 /* 0 When the tape position is unknown */
513 IDE_AFLAG_ADDRESS_VALID = (1 << 19),
514 /* Device already opened */
515 IDE_AFLAG_BUSY = (1 << 20),
516 /* Attempt to auto-detect the current user block size */
517 IDE_AFLAG_DETECT_BS = (1 << 21),
518 /* Currently on a filemark */
519 IDE_AFLAG_FILEMARK = (1 << 22),
520 /* 0 = no tape is loaded, so we don't rewind after ejecting */
521 IDE_AFLAG_MEDIUM_PRESENT = (1 << 23),
522
523 IDE_AFLAG_NO_AUTOCLOSE = (1 << 24),
524};
525
526/* device flags */
527enum {
528 /* restore settings after device reset */
529 IDE_DFLAG_KEEP_SETTINGS = (1 << 0),
530 /* device is using DMA for read/write */
531 IDE_DFLAG_USING_DMA = (1 << 1),
532 /* okay to unmask other IRQs */
533 IDE_DFLAG_UNMASK = (1 << 2),
534 /* don't attempt flushes */
535 IDE_DFLAG_NOFLUSH = (1 << 3),
536 /* DSC overlap */
537 IDE_DFLAG_DSC_OVERLAP = (1 << 4),
538 /* give potential excess bandwidth */
539 IDE_DFLAG_NICE1 = (1 << 5),
540 /* device is physically present */
541 IDE_DFLAG_PRESENT = (1 << 6),
542 /* device ejected hint */
543 IDE_DFLAG_DEAD = (1 << 7),
544 /* id read from device (synthetic if not set) */
545 IDE_DFLAG_ID_READ = (1 << 8),
546 IDE_DFLAG_NOPROBE = (1 << 9),
547 /* need to do check_media_change() */
548 IDE_DFLAG_REMOVABLE = (1 << 10),
549 /* needed for removable devices */
550 IDE_DFLAG_ATTACH = (1 << 11),
551 IDE_DFLAG_FORCED_GEOM = (1 << 12),
552 /* disallow setting unmask bit */
553 IDE_DFLAG_NO_UNMASK = (1 << 13),
554 /* disallow enabling 32-bit I/O */
555 IDE_DFLAG_NO_IO_32BIT = (1 << 14),
556 /* for removable only: door lock/unlock works */
557 IDE_DFLAG_DOORLOCKING = (1 << 15),
558 /* disallow DMA */
559 IDE_DFLAG_NODMA = (1 << 16),
560 /* powermanagment told us not to do anything, so sleep nicely */
561 IDE_DFLAG_BLOCKED = (1 << 17),
562 /* sleeping & sleep field valid */
563 IDE_DFLAG_SLEEPING = (1 << 18),
564 IDE_DFLAG_POST_RESET = (1 << 19),
565 IDE_DFLAG_UDMA33_WARNED = (1 << 20),
566 IDE_DFLAG_LBA48 = (1 << 21),
567 /* status of write cache */
568 IDE_DFLAG_WCACHE = (1 << 22),
569 /* used for ignoring ATA_DF */
570 IDE_DFLAG_NOWERR = (1 << 23),
571 /* retrying in PIO */
572 IDE_DFLAG_DMA_PIO_RETRY = (1 << 24),
573 IDE_DFLAG_LBA = (1 << 25),
574 /* don't unload heads */
575 IDE_DFLAG_NO_UNLOAD = (1 << 26),
576 /* heads unloaded, please don't reset port */
577 IDE_DFLAG_PARKED = (1 << 27),
578 IDE_DFLAG_MEDIA_CHANGED = (1 << 28),
579 /* write protect */
580 IDE_DFLAG_WP = (1 << 29),
581 IDE_DFLAG_FORMAT_IN_PROGRESS = (1 << 30),
582};
583
584struct ide_drive_s {
585 char name[4]; /* drive name, such as "hda" */
586 char driver_req[10]; /* requests specific driver */
587
588 struct request_queue *queue; /* request queue */
589
590 struct request *rq; /* current request */
591 struct ide_drive_s *next; /* circular list of hwgroup drives */
592 void *driver_data; /* extra driver data */
593 u16 *id; /* identification info */
594#ifdef CONFIG_IDE_PROC_FS
595 struct proc_dir_entry *proc; /* /proc/ide/ directory entry */
596 const struct ide_proc_devset *settings; /* /proc/ide/ drive settings */
597#endif
598 struct hwif_s *hwif; /* actually (ide_hwif_t *) */
599
600 const struct ide_disk_ops *disk_ops;
601
602 unsigned long dev_flags;
603
604 unsigned long sleep; /* sleep until this time */
605 unsigned long timeout; /* max time to wait for irq */
606
607 special_t special; /* special action flags */
608
609 u8 select; /* basic drive/head select reg value */
610 u8 retry_pio; /* retrying dma capable host in pio */
611 u8 waiting_for_dma; /* dma currently in progress */
612 u8 dma; /* atapi dma flag */
613
614 u8 quirk_list; /* considered quirky, set for a specific host */
615 u8 init_speed; /* transfer rate set at boot */
616 u8 current_speed; /* current transfer rate set */
617 u8 desired_speed; /* desired transfer rate set */
618 u8 dn; /* now wide spread use */
619 u8 acoustic; /* acoustic management */
620 u8 media; /* disk, cdrom, tape, floppy, ... */
621 u8 ready_stat; /* min status value for drive ready */
622 u8 mult_count; /* current multiple sector setting */
623 u8 mult_req; /* requested multiple sector setting */
624 u8 io_32bit; /* 0=16-bit, 1=32-bit, 2/3=32bit+sync */
625 u8 bad_wstat; /* used for ignoring ATA_DF */
626 u8 head; /* "real" number of heads */
627 u8 sect; /* "real" sectors per track */
628 u8 bios_head; /* BIOS/fdisk/LILO number of heads */
629 u8 bios_sect; /* BIOS/fdisk/LILO sectors per track */
630
631 /* delay this long before sending packet command */
632 u8 pc_delay;
633
634 unsigned int bios_cyl; /* BIOS/fdisk/LILO number of cyls */
635 unsigned int cyl; /* "real" number of cyls */
636 unsigned int drive_data; /* used by set_pio_mode/selectproc */
637 unsigned int failures; /* current failure count */
638 unsigned int max_failures; /* maximum allowed failure count */
639 u64 probed_capacity;/* initial reported media capacity (ide-cd only currently) */
640
641 u64 capacity64; /* total number of sectors */
642
643 int lun; /* logical unit */
644 int crc_count; /* crc counter to reduce drive speed */
645
646 unsigned long debug_mask; /* debugging levels switch */
647
648#ifdef CONFIG_BLK_DEV_IDEACPI
649 struct ide_acpi_drive_link *acpidata;
650#endif
651 struct list_head list;
652 struct device gendev;
653 struct completion gendev_rel_comp; /* to deal with device release() */
654
655 /* current packet command */
656 struct ide_atapi_pc *pc;
657
658 /* callback for packet commands */
659 void (*pc_callback)(struct ide_drive_s *, int);
660
661 void (*pc_update_buffers)(struct ide_drive_s *, struct ide_atapi_pc *);
662 int (*pc_io_buffers)(struct ide_drive_s *, struct ide_atapi_pc *,
663 unsigned int, int);
664
665 unsigned long atapi_flags;
666
667 struct ide_atapi_pc request_sense_pc;
668 struct request request_sense_rq;
669};
670
671typedef struct ide_drive_s ide_drive_t;
672
673#define to_ide_device(dev) container_of(dev, ide_drive_t, gendev)
674
675#define to_ide_drv(obj, cont_type) \
676 container_of(obj, struct cont_type, kref)
677
678#define ide_drv_g(disk, cont_type) \
679 container_of((disk)->private_data, struct cont_type, driver)
680
681struct ide_port_info;
682
683struct ide_tp_ops {
684 void (*exec_command)(struct hwif_s *, u8);
685 u8 (*read_status)(struct hwif_s *);
686 u8 (*read_altstatus)(struct hwif_s *);
687 u8 (*read_sff_dma_status)(struct hwif_s *);
688
689 void (*set_irq)(struct hwif_s *, int);
690
691 void (*tf_load)(ide_drive_t *, struct ide_task_s *);
692 void (*tf_read)(ide_drive_t *, struct ide_task_s *);
693
694 void (*input_data)(ide_drive_t *, struct request *, void *,
695 unsigned int);
696 void (*output_data)(ide_drive_t *, struct request *, void *,
697 unsigned int);
698};
699
700extern const struct ide_tp_ops default_tp_ops;
701
702/**
703 * struct ide_port_ops - IDE port operations
704 *
705 * @init_dev: host specific initialization of a device
706 * @set_pio_mode: routine to program host for PIO mode
707 * @set_dma_mode: routine to program host for DMA mode
708 * @selectproc: tweaks hardware to select drive
709 * @reset_poll: chipset polling based on hba specifics
710 * @pre_reset: chipset specific changes to default for device-hba resets
711 * @resetproc: routine to reset controller after a disk reset
712 * @maskproc: special host masking for drive selection
713 * @quirkproc: check host's drive quirk list
714 * @clear_irq: clear IRQ
715 *
716 * @mdma_filter: filter MDMA modes
717 * @udma_filter: filter UDMA modes
718 *
719 * @cable_detect: detect cable type
720 */
721struct ide_port_ops {
722 void (*init_dev)(ide_drive_t *);
723 void (*set_pio_mode)(ide_drive_t *, const u8);
724 void (*set_dma_mode)(ide_drive_t *, const u8);
725 void (*selectproc)(ide_drive_t *);
726 int (*reset_poll)(ide_drive_t *);
727 void (*pre_reset)(ide_drive_t *);
728 void (*resetproc)(ide_drive_t *);
729 void (*maskproc)(ide_drive_t *, int);
730 void (*quirkproc)(ide_drive_t *);
731 void (*clear_irq)(ide_drive_t *);
732
733 u8 (*mdma_filter)(ide_drive_t *);
734 u8 (*udma_filter)(ide_drive_t *);
735
736 u8 (*cable_detect)(struct hwif_s *);
737};
738
739struct ide_dma_ops {
740 void (*dma_host_set)(struct ide_drive_s *, int);
741 int (*dma_setup)(struct ide_drive_s *);
742 void (*dma_exec_cmd)(struct ide_drive_s *, u8);
743 void (*dma_start)(struct ide_drive_s *);
744 int (*dma_end)(struct ide_drive_s *);
745 int (*dma_test_irq)(struct ide_drive_s *);
746 void (*dma_lost_irq)(struct ide_drive_s *);
747 void (*dma_timeout)(struct ide_drive_s *);
748};
749
750struct ide_host;
751
752typedef struct hwif_s {
753 struct hwif_s *next; /* for linked-list in ide_hwgroup_t */
754 struct hwif_s *mate; /* other hwif from same PCI chip */
755 struct hwgroup_s *hwgroup; /* actually (ide_hwgroup_t *) */
756 struct proc_dir_entry *proc; /* /proc/ide/ directory entry */
757
758 struct ide_host *host;
759
760 char name[6]; /* name of interface, eg. "ide0" */
761
762 struct ide_io_ports io_ports;
763
764 unsigned long sata_scr[SATA_NR_PORTS];
765
766 ide_drive_t drives[MAX_DRIVES]; /* drive info */
767
768 u8 major; /* our major number */
769 u8 index; /* 0 for ide0; 1 for ide1; ... */
770 u8 channel; /* for dual-port chips: 0=primary, 1=secondary */
771
772 u32 host_flags;
773
774 u8 pio_mask;
775
776 u8 ultra_mask;
777 u8 mwdma_mask;
778 u8 swdma_mask;
779
780 u8 cbl; /* cable type */
781
782 hwif_chipset_t chipset; /* sub-module for tuning.. */
783
784 struct device *dev;
785
786 ide_ack_intr_t *ack_intr;
787
788 void (*rw_disk)(ide_drive_t *, struct request *);
789
790 const struct ide_tp_ops *tp_ops;
791 const struct ide_port_ops *port_ops;
792 const struct ide_dma_ops *dma_ops;
793
794 /* dma physical region descriptor table (cpu view) */
795 unsigned int *dmatable_cpu;
796 /* dma physical region descriptor table (dma view) */
797 dma_addr_t dmatable_dma;
798
799 /* maximum number of PRD table entries */
800 int prd_max_nents;
801 /* PRD entry size in bytes */
802 int prd_ent_size;
803
804 /* Scatter-gather list used to build the above */
805 struct scatterlist *sg_table;
806 int sg_max_nents; /* Maximum number of entries in it */
807 int sg_nents; /* Current number of entries in it */
808 int sg_dma_direction; /* dma transfer direction */
809
810 /* data phase of the active command (currently only valid for PIO/DMA) */
811 int data_phase;
812
813 struct ide_task_s task; /* current command */
814
815 unsigned int nsect;
816 unsigned int nleft;
817 struct scatterlist *cursg;
818 unsigned int cursg_ofs;
819
820 int rqsize; /* max sectors per request */
821 int irq; /* our irq number */
822
823 unsigned long dma_base; /* base addr for dma ports */
824
825 unsigned long config_data; /* for use by chipset-specific code */
826 unsigned long select_data; /* for use by chipset-specific code */
827
828 unsigned long extra_base; /* extra addr for dma ports */
829 unsigned extra_ports; /* number of extra dma ports */
830
831 unsigned present : 1; /* this interface exists */
832 unsigned sg_mapped : 1; /* sg_table and sg_nents are ready */
833
834 struct device gendev;
835 struct device *portdev;
836
837 struct completion gendev_rel_comp; /* To deal with device release() */
838
839 void *hwif_data; /* extra hwif data */
840
841#ifdef CONFIG_BLK_DEV_IDEACPI
842 struct ide_acpi_hwif_link *acpidata;
843#endif
844} ____cacheline_internodealigned_in_smp ide_hwif_t;
845
846#define MAX_HOST_PORTS 4
847
848struct ide_host {
849 ide_hwif_t *ports[MAX_HOST_PORTS];
850 unsigned int n_ports;
851 struct device *dev[2];
852 unsigned int (*init_chipset)(struct pci_dev *);
853 unsigned long host_flags;
854 void *host_priv;
855};
856
857/*
858 * internal ide interrupt handler type
859 */
860typedef ide_startstop_t (ide_handler_t)(ide_drive_t *);
861typedef int (ide_expiry_t)(ide_drive_t *);
862
863/* used by ide-cd, ide-floppy, etc. */
864typedef void (xfer_func_t)(ide_drive_t *, struct request *rq, void *, unsigned);
865
866typedef struct hwgroup_s {
867 /* irq handler, if active */
868 ide_startstop_t (*handler)(ide_drive_t *);
869
870 /* BOOL: protects all fields below */
871 volatile int busy;
872 /* BOOL: polling active & poll_timeout field valid */
873 unsigned int polling : 1;
874
875 /* current drive */
876 ide_drive_t *drive;
877 /* ptr to current hwif in linked-list */
878 ide_hwif_t *hwif;
879
880 /* current request */
881 struct request *rq;
882
883 /* failsafe timer */
884 struct timer_list timer;
885 /* timeout value during long polls */
886 unsigned long poll_timeout;
887 /* queried upon timeouts */
888 int (*expiry)(ide_drive_t *);
889
890 int req_gen;
891 int req_gen_timer;
892
893 spinlock_t lock;
894} ide_hwgroup_t;
895
896typedef struct ide_driver_s ide_driver_t;
897
898extern struct mutex ide_setting_mtx;
899
900/*
901 * configurable drive settings
902 */
903
904#define DS_SYNC (1 << 0)
905
906struct ide_devset {
907 int (*get)(ide_drive_t *);
908 int (*set)(ide_drive_t *, int);
909 unsigned int flags;
910};
911
912#define __DEVSET(_flags, _get, _set) { \
913 .flags = _flags, \
914 .get = _get, \
915 .set = _set, \
916}
917
918#define ide_devset_get(name, field) \
919static int get_##name(ide_drive_t *drive) \
920{ \
921 return drive->field; \
922}
923
924#define ide_devset_set(name, field) \
925static int set_##name(ide_drive_t *drive, int arg) \
926{ \
927 drive->field = arg; \
928 return 0; \
929}
930
931#define ide_devset_get_flag(name, flag) \
932static int get_##name(ide_drive_t *drive) \
933{ \
934 return !!(drive->dev_flags & flag); \
935}
936
937#define ide_devset_set_flag(name, flag) \
938static int set_##name(ide_drive_t *drive, int arg) \
939{ \
940 if (arg) \
941 drive->dev_flags |= flag; \
942 else \
943 drive->dev_flags &= ~flag; \
944 return 0; \
945}
946
947#define __IDE_DEVSET(_name, _flags, _get, _set) \
948const struct ide_devset ide_devset_##_name = \
949 __DEVSET(_flags, _get, _set)
950
951#define IDE_DEVSET(_name, _flags, _get, _set) \
952static __IDE_DEVSET(_name, _flags, _get, _set)
953
954#define ide_devset_rw(_name, _func) \
955IDE_DEVSET(_name, 0, get_##_func, set_##_func)
956
957#define ide_devset_w(_name, _func) \
958IDE_DEVSET(_name, 0, NULL, set_##_func)
959
960#define ide_ext_devset_rw(_name, _func) \
961__IDE_DEVSET(_name, 0, get_##_func, set_##_func)
962
963#define ide_ext_devset_rw_sync(_name, _func) \
964__IDE_DEVSET(_name, DS_SYNC, get_##_func, set_##_func)
965
966#define ide_decl_devset(_name) \
967extern const struct ide_devset ide_devset_##_name
968
969ide_decl_devset(io_32bit);
970ide_decl_devset(keepsettings);
971ide_decl_devset(pio_mode);
972ide_decl_devset(unmaskirq);
973ide_decl_devset(using_dma);
974
975#ifdef CONFIG_IDE_PROC_FS
976/*
977 * /proc/ide interface
978 */
979
980#define ide_devset_rw_field(_name, _field) \
981ide_devset_get(_name, _field); \
982ide_devset_set(_name, _field); \
983IDE_DEVSET(_name, DS_SYNC, get_##_name, set_##_name)
984
985#define ide_devset_rw_flag(_name, _field) \
986ide_devset_get_flag(_name, _field); \
987ide_devset_set_flag(_name, _field); \
988IDE_DEVSET(_name, DS_SYNC, get_##_name, set_##_name)
989
990struct ide_proc_devset {
991 const char *name;
992 const struct ide_devset *setting;
993 int min, max;
994 int (*mulf)(ide_drive_t *);
995 int (*divf)(ide_drive_t *);
996};
997
998#define __IDE_PROC_DEVSET(_name, _min, _max, _mulf, _divf) { \
999 .name = __stringify(_name), \
1000 .setting = &ide_devset_##_name, \
1001 .min = _min, \
1002 .max = _max, \
1003 .mulf = _mulf, \
1004 .divf = _divf, \
1005}
1006
1007#define IDE_PROC_DEVSET(_name, _min, _max) \
1008__IDE_PROC_DEVSET(_name, _min, _max, NULL, NULL)
1009
1010typedef struct {
1011 const char *name;
1012 mode_t mode;
1013 read_proc_t *read_proc;
1014 write_proc_t *write_proc;
1015} ide_proc_entry_t;
1016
1017void proc_ide_create(void);
1018void proc_ide_destroy(void);
1019void ide_proc_register_port(ide_hwif_t *);
1020void ide_proc_port_register_devices(ide_hwif_t *);
1021void ide_proc_unregister_device(ide_drive_t *);
1022void ide_proc_unregister_port(ide_hwif_t *);
1023void ide_proc_register_driver(ide_drive_t *, ide_driver_t *);
1024void ide_proc_unregister_driver(ide_drive_t *, ide_driver_t *);
1025
1026read_proc_t proc_ide_read_capacity;
1027read_proc_t proc_ide_read_geometry;
1028
1029/*
1030 * Standard exit stuff:
1031 */
1032#define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) \
1033{ \
1034 len -= off; \
1035 if (len < count) { \
1036 *eof = 1; \
1037 if (len <= 0) \
1038 return 0; \
1039 } else \
1040 len = count; \
1041 *start = page + off; \
1042 return len; \
1043}
1044#else
1045static inline void proc_ide_create(void) { ; }
1046static inline void proc_ide_destroy(void) { ; }
1047static inline void ide_proc_register_port(ide_hwif_t *hwif) { ; }
1048static inline void ide_proc_port_register_devices(ide_hwif_t *hwif) { ; }
1049static inline void ide_proc_unregister_device(ide_drive_t *drive) { ; }
1050static inline void ide_proc_unregister_port(ide_hwif_t *hwif) { ; }
1051static inline void ide_proc_register_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
1052static inline void ide_proc_unregister_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
1053#define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) return 0;
1054#endif
1055
1056enum {
1057 /* enter/exit functions */
1058 IDE_DBG_FUNC = (1 << 0),
1059 /* sense key/asc handling */
1060 IDE_DBG_SENSE = (1 << 1),
1061 /* packet commands handling */
1062 IDE_DBG_PC = (1 << 2),
1063 /* request handling */
1064 IDE_DBG_RQ = (1 << 3),
1065 /* driver probing/setup */
1066 IDE_DBG_PROBE = (1 << 4),
1067};
1068
1069/* DRV_NAME has to be defined in the driver before using the macro below */
1070#define __ide_debug_log(lvl, fmt, args...) \
1071{ \
1072 if (unlikely(drive->debug_mask & lvl)) \
1073 printk(KERN_INFO DRV_NAME ": " fmt, ## args); \
1074}
1075
1076/*
1077 * Power Management state machine (rq->pm->pm_step).
1078 *
1079 * For each step, the core calls ide_start_power_step() first.
1080 * This can return:
1081 * - ide_stopped : In this case, the core calls us back again unless
1082 * step have been set to ide_power_state_completed.
1083 * - ide_started : In this case, the channel is left busy until an
1084 * async event (interrupt) occurs.
1085 * Typically, ide_start_power_step() will issue a taskfile request with
1086 * do_rw_taskfile().
1087 *
1088 * Upon reception of the interrupt, the core will call ide_complete_power_step()
1089 * with the error code if any. This routine should update the step value
1090 * and return. It should not start a new request. The core will call
1091 * ide_start_power_step() for the new step value, unless step have been
1092 * set to IDE_PM_COMPLETED.
1093 */
1094enum {
1095 IDE_PM_START_SUSPEND,
1096 IDE_PM_FLUSH_CACHE = IDE_PM_START_SUSPEND,
1097 IDE_PM_STANDBY,
1098
1099 IDE_PM_START_RESUME,
1100 IDE_PM_RESTORE_PIO = IDE_PM_START_RESUME,
1101 IDE_PM_IDLE,
1102 IDE_PM_RESTORE_DMA,
1103
1104 IDE_PM_COMPLETED,
1105};
1106
1107int generic_ide_suspend(struct device *, pm_message_t);
1108int generic_ide_resume(struct device *);
1109
1110void ide_complete_power_step(ide_drive_t *, struct request *);
1111ide_startstop_t ide_start_power_step(ide_drive_t *, struct request *);
1112void ide_complete_pm_request(ide_drive_t *, struct request *);
1113void ide_check_pm_state(ide_drive_t *, struct request *);
1114
1115/*
1116 * Subdrivers support.
1117 *
1118 * The gendriver.owner field should be set to the module owner of this driver.
1119 * The gendriver.name field should be set to the name of this driver
1120 */
1121struct ide_driver_s {
1122 const char *version;
1123 ide_startstop_t (*do_request)(ide_drive_t *, struct request *, sector_t);
1124 int (*end_request)(ide_drive_t *, int, int);
1125 ide_startstop_t (*error)(ide_drive_t *, struct request *rq, u8, u8);
1126 struct device_driver gen_driver;
1127 int (*probe)(ide_drive_t *);
1128 void (*remove)(ide_drive_t *);
1129 void (*resume)(ide_drive_t *);
1130 void (*shutdown)(ide_drive_t *);
1131#ifdef CONFIG_IDE_PROC_FS
1132 ide_proc_entry_t * (*proc_entries)(ide_drive_t *);
1133 const struct ide_proc_devset * (*proc_devsets)(ide_drive_t *);
1134#endif
1135};
1136
1137#define to_ide_driver(drv) container_of(drv, ide_driver_t, gen_driver)
1138
1139int ide_device_get(ide_drive_t *);
1140void ide_device_put(ide_drive_t *);
1141
1142struct ide_ioctl_devset {
1143 unsigned int get_ioctl;
1144 unsigned int set_ioctl;
1145 const struct ide_devset *setting;
1146};
1147
1148int ide_setting_ioctl(ide_drive_t *, struct block_device *, unsigned int,
1149 unsigned long, const struct ide_ioctl_devset *);
1150
1151int generic_ide_ioctl(ide_drive_t *, struct block_device *, unsigned, unsigned long);
1152
1153extern int ide_vlb_clk;
1154extern int ide_pci_clk;
1155
1156extern int ide_end_request (ide_drive_t *drive, int uptodate, int nrsecs);
1157int ide_end_dequeued_request(ide_drive_t *drive, struct request *rq,
1158 int uptodate, int nr_sectors);
1159
1160extern void ide_set_handler (ide_drive_t *drive, ide_handler_t *handler, unsigned int timeout, ide_expiry_t *expiry);
1161
1162void ide_execute_command(ide_drive_t *, u8, ide_handler_t *, unsigned int,
1163 ide_expiry_t *);
1164
1165void ide_execute_pkt_cmd(ide_drive_t *);
1166
1167void ide_pad_transfer(ide_drive_t *, int, int);
1168
1169ide_startstop_t __ide_error(ide_drive_t *, struct request *, u8, u8);
1170
1171ide_startstop_t ide_error (ide_drive_t *drive, const char *msg, byte stat);
1172
1173void ide_fix_driveid(u16 *);
1174
1175extern void ide_fixstring(u8 *, const int, const int);
1176
1177int ide_busy_sleep(ide_hwif_t *, unsigned long, int);
1178
1179int ide_wait_stat(ide_startstop_t *, ide_drive_t *, u8, u8, unsigned long);
1180
1181extern ide_startstop_t ide_do_reset (ide_drive_t *);
1182
1183extern int ide_devset_execute(ide_drive_t *drive,
1184 const struct ide_devset *setting, int arg);
1185
1186extern void ide_do_drive_cmd(ide_drive_t *, struct request *);
1187
1188extern void ide_end_drive_cmd(ide_drive_t *, u8, u8);
1189
1190void ide_tf_dump(const char *, struct ide_taskfile *);
1191
1192void ide_exec_command(ide_hwif_t *, u8);
1193u8 ide_read_status(ide_hwif_t *);
1194u8 ide_read_altstatus(ide_hwif_t *);
1195u8 ide_read_sff_dma_status(ide_hwif_t *);
1196
1197void ide_set_irq(ide_hwif_t *, int);
1198
1199void ide_tf_load(ide_drive_t *, ide_task_t *);
1200void ide_tf_read(ide_drive_t *, ide_task_t *);
1201
1202void ide_input_data(ide_drive_t *, struct request *, void *, unsigned int);
1203void ide_output_data(ide_drive_t *, struct request *, void *, unsigned int);
1204
1205int ide_io_buffers(ide_drive_t *, struct ide_atapi_pc *, unsigned int, int);
1206
1207extern void SELECT_DRIVE(ide_drive_t *);
1208void SELECT_MASK(ide_drive_t *, int);
1209
1210u8 ide_read_error(ide_drive_t *);
1211void ide_read_bcount_and_ireason(ide_drive_t *, u16 *, u8 *);
1212
1213extern int drive_is_ready(ide_drive_t *);
1214
1215void ide_pktcmd_tf_load(ide_drive_t *, u32, u16, u8);
1216
1217int ide_check_atapi_device(ide_drive_t *, const char *);
1218
1219void ide_init_pc(struct ide_atapi_pc *);
1220
1221/* Disk head parking */
1222extern wait_queue_head_t ide_park_wq;
1223ssize_t ide_park_show(struct device *dev, struct device_attribute *attr,
1224 char *buf);
1225ssize_t ide_park_store(struct device *dev, struct device_attribute *attr,
1226 const char *buf, size_t len);
1227
1228/*
1229 * Special requests for ide-tape block device strategy routine.
1230 *
1231 * In order to service a character device command, we add special requests to
1232 * the tail of our block device request queue and wait for their completion.
1233 */
1234enum {
1235 REQ_IDETAPE_PC1 = (1 << 0), /* packet command (first stage) */
1236 REQ_IDETAPE_PC2 = (1 << 1), /* packet command (second stage) */
1237 REQ_IDETAPE_READ = (1 << 2),
1238 REQ_IDETAPE_WRITE = (1 << 3),
1239};
1240
1241int ide_queue_pc_tail(ide_drive_t *, struct gendisk *, struct ide_atapi_pc *);
1242
1243int ide_do_test_unit_ready(ide_drive_t *, struct gendisk *);
1244int ide_do_start_stop(ide_drive_t *, struct gendisk *, int);
1245int ide_set_media_lock(ide_drive_t *, struct gendisk *, int);
1246void ide_create_request_sense_cmd(ide_drive_t *, struct ide_atapi_pc *);
1247void ide_retry_pc(ide_drive_t *, struct gendisk *);
1248
1249int ide_cd_expiry(ide_drive_t *);
1250
1251int ide_cd_get_xferlen(struct request *);
1252
1253ide_startstop_t ide_issue_pc(ide_drive_t *);
1254
1255ide_startstop_t do_rw_taskfile(ide_drive_t *, ide_task_t *);
1256
1257void task_end_request(ide_drive_t *, struct request *, u8);
1258
1259int ide_raw_taskfile(ide_drive_t *, ide_task_t *, u8 *, u16);
1260int ide_no_data_taskfile(ide_drive_t *, ide_task_t *);
1261
1262int ide_taskfile_ioctl(ide_drive_t *, unsigned int, unsigned long);
1263
1264extern int ide_driveid_update(ide_drive_t *);
1265extern int ide_config_drive_speed(ide_drive_t *, u8);
1266extern u8 eighty_ninty_three (ide_drive_t *);
1267extern int taskfile_lib_get_identify(ide_drive_t *drive, u8 *);
1268
1269extern int ide_wait_not_busy(ide_hwif_t *hwif, unsigned long timeout);
1270
1271extern void ide_stall_queue(ide_drive_t *drive, unsigned long timeout);
1272
1273extern void ide_timer_expiry(unsigned long);
1274extern irqreturn_t ide_intr(int irq, void *dev_id);
1275
1276static inline int ide_lock_hwgroup(ide_hwgroup_t *hwgroup)
1277{
1278 if (hwgroup->busy)
1279 return 1;
1280
1281 hwgroup->busy = 1;
1282 /* for atari only */
1283 ide_get_lock(ide_intr, hwgroup);
1284
1285 return 0;
1286}
1287
1288static inline void ide_unlock_hwgroup(ide_hwgroup_t *hwgroup)
1289{
1290 /* for atari only */
1291 ide_release_lock();
1292 hwgroup->busy = 0;
1293}
1294
1295extern void do_ide_request(struct request_queue *);
1296
1297void ide_init_disk(struct gendisk *, ide_drive_t *);
1298
1299#ifdef CONFIG_IDEPCI_PCIBUS_ORDER
1300extern int __ide_pci_register_driver(struct pci_driver *driver, struct module *owner, const char *mod_name);
1301#define ide_pci_register_driver(d) __ide_pci_register_driver(d, THIS_MODULE, KBUILD_MODNAME)
1302#else
1303#define ide_pci_register_driver(d) pci_register_driver(d)
1304#endif
1305
1306static inline int ide_pci_is_in_compatibility_mode(struct pci_dev *dev)
1307{
1308 if ((dev->class >> 8) == PCI_CLASS_STORAGE_IDE && (dev->class & 5) != 5)
1309 return 1;
1310 return 0;
1311}
1312
1313void ide_pci_setup_ports(struct pci_dev *, const struct ide_port_info *, int,
1314 hw_regs_t *, hw_regs_t **);
1315void ide_setup_pci_noise(struct pci_dev *, const struct ide_port_info *);
1316
1317#ifdef CONFIG_BLK_DEV_IDEDMA_PCI
1318int ide_pci_set_master(struct pci_dev *, const char *);
1319unsigned long ide_pci_dma_base(ide_hwif_t *, const struct ide_port_info *);
1320int ide_pci_check_simplex(ide_hwif_t *, const struct ide_port_info *);
1321int ide_hwif_setup_dma(ide_hwif_t *, const struct ide_port_info *);
1322#else
1323static inline int ide_hwif_setup_dma(ide_hwif_t *hwif,
1324 const struct ide_port_info *d)
1325{
1326 return -EINVAL;
1327}
1328#endif
1329
1330typedef struct ide_pci_enablebit_s {
1331 u8 reg; /* byte pci reg holding the enable-bit */
1332 u8 mask; /* mask to isolate the enable-bit */
1333 u8 val; /* value of masked reg when "enabled" */
1334} ide_pci_enablebit_t;
1335
1336enum {
1337 /* Uses ISA control ports not PCI ones. */
1338 IDE_HFLAG_ISA_PORTS = (1 << 0),
1339 /* single port device */
1340 IDE_HFLAG_SINGLE = (1 << 1),
1341 /* don't use legacy PIO blacklist */
1342 IDE_HFLAG_PIO_NO_BLACKLIST = (1 << 2),
1343 /* set for the second port of QD65xx */
1344 IDE_HFLAG_QD_2ND_PORT = (1 << 3),
1345 /* use PIO8/9 for prefetch off/on */
1346 IDE_HFLAG_ABUSE_PREFETCH = (1 << 4),
1347 /* use PIO6/7 for fast-devsel off/on */
1348 IDE_HFLAG_ABUSE_FAST_DEVSEL = (1 << 5),
1349 /* use 100-102 and 200-202 PIO values to set DMA modes */
1350 IDE_HFLAG_ABUSE_DMA_MODES = (1 << 6),
1351 /*
1352 * keep DMA setting when programming PIO mode, may be used only
1353 * for hosts which have separate PIO and DMA timings (ie. PMAC)
1354 */
1355 IDE_HFLAG_SET_PIO_MODE_KEEP_DMA = (1 << 7),
1356 /* program host for the transfer mode after programming device */
1357 IDE_HFLAG_POST_SET_MODE = (1 << 8),
1358 /* don't program host/device for the transfer mode ("smart" hosts) */
1359 IDE_HFLAG_NO_SET_MODE = (1 << 9),
1360 /* trust BIOS for programming chipset/device for DMA */
1361 IDE_HFLAG_TRUST_BIOS_FOR_DMA = (1 << 10),
1362 /* host is CS5510/CS5520 */
1363 IDE_HFLAG_CS5520 = (1 << 11),
1364 /* ATAPI DMA is unsupported */
1365 IDE_HFLAG_NO_ATAPI_DMA = (1 << 12),
1366 /* set if host is a "non-bootable" controller */
1367 IDE_HFLAG_NON_BOOTABLE = (1 << 13),
1368 /* host doesn't support DMA */
1369 IDE_HFLAG_NO_DMA = (1 << 14),
1370 /* check if host is PCI IDE device before allowing DMA */
1371 IDE_HFLAG_NO_AUTODMA = (1 << 15),
1372 /* host uses MMIO */
1373 IDE_HFLAG_MMIO = (1 << 16),
1374 /* no LBA48 */
1375 IDE_HFLAG_NO_LBA48 = (1 << 17),
1376 /* no LBA48 DMA */
1377 IDE_HFLAG_NO_LBA48_DMA = (1 << 18),
1378 /* data FIFO is cleared by an error */
1379 IDE_HFLAG_ERROR_STOPS_FIFO = (1 << 19),
1380 /* serialize ports */
1381 IDE_HFLAG_SERIALIZE = (1 << 20),
1382 /* use legacy IRQs */
1383 IDE_HFLAG_LEGACY_IRQS = (1 << 21),
1384 /* force use of legacy IRQs */
1385 IDE_HFLAG_FORCE_LEGACY_IRQS = (1 << 22),
1386 /* host is TRM290 */
1387 IDE_HFLAG_TRM290 = (1 << 23),
1388 /* use 32-bit I/O ops */
1389 IDE_HFLAG_IO_32BIT = (1 << 24),
1390 /* unmask IRQs */
1391 IDE_HFLAG_UNMASK_IRQS = (1 << 25),
1392 IDE_HFLAG_BROKEN_ALTSTATUS = (1 << 26),
1393 /* serialize ports if DMA is possible (for sl82c105) */
1394 IDE_HFLAG_SERIALIZE_DMA = (1 << 27),
1395 /* force host out of "simplex" mode */
1396 IDE_HFLAG_CLEAR_SIMPLEX = (1 << 28),
1397 /* DSC overlap is unsupported */
1398 IDE_HFLAG_NO_DSC = (1 << 29),
1399 /* never use 32-bit I/O ops */
1400 IDE_HFLAG_NO_IO_32BIT = (1 << 30),
1401 /* never unmask IRQs */
1402 IDE_HFLAG_NO_UNMASK_IRQS = (1 << 31),
1403};
1404
1405#ifdef CONFIG_BLK_DEV_OFFBOARD
1406# define IDE_HFLAG_OFF_BOARD 0
1407#else
1408# define IDE_HFLAG_OFF_BOARD IDE_HFLAG_NON_BOOTABLE
1409#endif
1410
1411struct ide_port_info {
1412 char *name;
1413 unsigned int (*init_chipset)(struct pci_dev *);
1414 void (*init_iops)(ide_hwif_t *);
1415 void (*init_hwif)(ide_hwif_t *);
1416 int (*init_dma)(ide_hwif_t *,
1417 const struct ide_port_info *);
1418
1419 const struct ide_tp_ops *tp_ops;
1420 const struct ide_port_ops *port_ops;
1421 const struct ide_dma_ops *dma_ops;
1422
1423 ide_pci_enablebit_t enablebits[2];
1424 hwif_chipset_t chipset;
1425
1426 u16 max_sectors; /* if < than the default one */
1427
1428 u32 host_flags;
1429 u8 pio_mask;
1430 u8 swdma_mask;
1431 u8 mwdma_mask;
1432 u8 udma_mask;
1433};
1434
1435int ide_pci_init_one(struct pci_dev *, const struct ide_port_info *, void *);
1436int ide_pci_init_two(struct pci_dev *, struct pci_dev *,
1437 const struct ide_port_info *, void *);
1438void ide_pci_remove(struct pci_dev *);
1439
1440#ifdef CONFIG_PM
1441int ide_pci_suspend(struct pci_dev *, pm_message_t);
1442int ide_pci_resume(struct pci_dev *);
1443#else
1444#define ide_pci_suspend NULL
1445#define ide_pci_resume NULL
1446#endif
1447
1448void ide_map_sg(ide_drive_t *, struct request *);
1449void ide_init_sg_cmd(ide_drive_t *, struct request *);
1450
1451#define BAD_DMA_DRIVE 0
1452#define GOOD_DMA_DRIVE 1
1453
1454struct drive_list_entry {
1455 const char *id_model;
1456 const char *id_firmware;
1457};
1458
1459int ide_in_drive_list(u16 *, const struct drive_list_entry *);
1460
1461#ifdef CONFIG_BLK_DEV_IDEDMA
1462int ide_dma_good_drive(ide_drive_t *);
1463int __ide_dma_bad_drive(ide_drive_t *);
1464int ide_id_dma_bug(ide_drive_t *);
1465
1466u8 ide_find_dma_mode(ide_drive_t *, u8);
1467
1468static inline u8 ide_max_dma_mode(ide_drive_t *drive)
1469{
1470 return ide_find_dma_mode(drive, XFER_UDMA_6);
1471}
1472
1473void ide_dma_off_quietly(ide_drive_t *);
1474void ide_dma_off(ide_drive_t *);
1475void ide_dma_on(ide_drive_t *);
1476int ide_set_dma(ide_drive_t *);
1477void ide_check_dma_crc(ide_drive_t *);
1478ide_startstop_t ide_dma_intr(ide_drive_t *);
1479
1480int ide_allocate_dma_engine(ide_hwif_t *);
1481void ide_release_dma_engine(ide_hwif_t *);
1482
1483int ide_build_sglist(ide_drive_t *, struct request *);
1484void ide_destroy_dmatable(ide_drive_t *);
1485
1486#ifdef CONFIG_BLK_DEV_IDEDMA_SFF
1487int config_drive_for_dma(ide_drive_t *);
1488extern int ide_build_dmatable(ide_drive_t *, struct request *);
1489void ide_dma_host_set(ide_drive_t *, int);
1490extern int ide_dma_setup(ide_drive_t *);
1491void ide_dma_exec_cmd(ide_drive_t *, u8);
1492extern void ide_dma_start(ide_drive_t *);
1493int ide_dma_end(ide_drive_t *);
1494int ide_dma_test_irq(ide_drive_t *);
1495extern const struct ide_dma_ops sff_dma_ops;
1496#else
1497static inline int config_drive_for_dma(ide_drive_t *drive) { return 0; }
1498#endif /* CONFIG_BLK_DEV_IDEDMA_SFF */
1499
1500void ide_dma_lost_irq(ide_drive_t *);
1501void ide_dma_timeout(ide_drive_t *);
1502
1503#else
1504static inline int ide_id_dma_bug(ide_drive_t *drive) { return 0; }
1505static inline u8 ide_find_dma_mode(ide_drive_t *drive, u8 speed) { return 0; }
1506static inline u8 ide_max_dma_mode(ide_drive_t *drive) { return 0; }
1507static inline void ide_dma_off_quietly(ide_drive_t *drive) { ; }
1508static inline void ide_dma_off(ide_drive_t *drive) { ; }
1509static inline void ide_dma_on(ide_drive_t *drive) { ; }
1510static inline void ide_dma_verbose(ide_drive_t *drive) { ; }
1511static inline int ide_set_dma(ide_drive_t *drive) { return 1; }
1512static inline void ide_check_dma_crc(ide_drive_t *drive) { ; }
1513static inline void ide_release_dma_engine(ide_hwif_t *hwif) { ; }
1514#endif /* CONFIG_BLK_DEV_IDEDMA */
1515
1516#ifdef CONFIG_BLK_DEV_IDEACPI
1517extern int ide_acpi_exec_tfs(ide_drive_t *drive);
1518extern void ide_acpi_get_timing(ide_hwif_t *hwif);
1519extern void ide_acpi_push_timing(ide_hwif_t *hwif);
1520extern void ide_acpi_init(ide_hwif_t *hwif);
1521void ide_acpi_port_init_devices(ide_hwif_t *);
1522extern void ide_acpi_set_state(ide_hwif_t *hwif, int on);
1523#else
1524static inline int ide_acpi_exec_tfs(ide_drive_t *drive) { return 0; }
1525static inline void ide_acpi_get_timing(ide_hwif_t *hwif) { ; }
1526static inline void ide_acpi_push_timing(ide_hwif_t *hwif) { ; }
1527static inline void ide_acpi_init(ide_hwif_t *hwif) { ; }
1528static inline void ide_acpi_port_init_devices(ide_hwif_t *hwif) { ; }
1529static inline void ide_acpi_set_state(ide_hwif_t *hwif, int on) {}
1530#endif
1531
1532void ide_remove_port_from_hwgroup(ide_hwif_t *);
1533void ide_unregister(ide_hwif_t *);
1534
1535void ide_register_region(struct gendisk *);
1536void ide_unregister_region(struct gendisk *);
1537
1538void ide_undecoded_slave(ide_drive_t *);
1539
1540void ide_port_apply_params(ide_hwif_t *);
1541int ide_sysfs_register_port(ide_hwif_t *);
1542
1543struct ide_host *ide_host_alloc(const struct ide_port_info *, hw_regs_t **);
1544void ide_host_free(struct ide_host *);
1545int ide_host_register(struct ide_host *, const struct ide_port_info *,
1546 hw_regs_t **);
1547int ide_host_add(const struct ide_port_info *, hw_regs_t **,
1548 struct ide_host **);
1549void ide_host_remove(struct ide_host *);
1550int ide_legacy_device_add(const struct ide_port_info *, unsigned long);
1551void ide_port_unregister_devices(ide_hwif_t *);
1552void ide_port_scan(ide_hwif_t *);
1553
1554static inline void *ide_get_hwifdata (ide_hwif_t * hwif)
1555{
1556 return hwif->hwif_data;
1557}
1558
1559static inline void ide_set_hwifdata (ide_hwif_t * hwif, void *data)
1560{
1561 hwif->hwif_data = data;
1562}
1563
1564const char *ide_xfer_verbose(u8 mode);
1565extern void ide_toggle_bounce(ide_drive_t *drive, int on);
1566extern int ide_set_xfer_rate(ide_drive_t *drive, u8 rate);
1567
1568u64 ide_get_lba_addr(struct ide_taskfile *, int);
1569u8 ide_dump_status(ide_drive_t *, const char *, u8);
1570
1571struct ide_timing {
1572 u8 mode;
1573 u8 setup; /* t1 */
1574 u16 act8b; /* t2 for 8-bit io */
1575 u16 rec8b; /* t2i for 8-bit io */
1576 u16 cyc8b; /* t0 for 8-bit io */
1577 u16 active; /* t2 or tD */
1578 u16 recover; /* t2i or tK */
1579 u16 cycle; /* t0 */
1580 u16 udma; /* t2CYCTYP/2 */
1581};
1582
1583enum {
1584 IDE_TIMING_SETUP = (1 << 0),
1585 IDE_TIMING_ACT8B = (1 << 1),
1586 IDE_TIMING_REC8B = (1 << 2),
1587 IDE_TIMING_CYC8B = (1 << 3),
1588 IDE_TIMING_8BIT = IDE_TIMING_ACT8B | IDE_TIMING_REC8B |
1589 IDE_TIMING_CYC8B,
1590 IDE_TIMING_ACTIVE = (1 << 4),
1591 IDE_TIMING_RECOVER = (1 << 5),
1592 IDE_TIMING_CYCLE = (1 << 6),
1593 IDE_TIMING_UDMA = (1 << 7),
1594 IDE_TIMING_ALL = IDE_TIMING_SETUP | IDE_TIMING_8BIT |
1595 IDE_TIMING_ACTIVE | IDE_TIMING_RECOVER |
1596 IDE_TIMING_CYCLE | IDE_TIMING_UDMA,
1597};
1598
1599struct ide_timing *ide_timing_find_mode(u8);
1600u16 ide_pio_cycle_time(ide_drive_t *, u8);
1601void ide_timing_merge(struct ide_timing *, struct ide_timing *,
1602 struct ide_timing *, unsigned int);
1603int ide_timing_compute(ide_drive_t *, u8, struct ide_timing *, int, int);
1604
1605int ide_scan_pio_blacklist(char *);
1606
1607u8 ide_get_best_pio_mode(ide_drive_t *, u8, u8);
1608
1609int ide_set_pio_mode(ide_drive_t *, u8);
1610int ide_set_dma_mode(ide_drive_t *, u8);
1611
1612void ide_set_pio(ide_drive_t *, u8);
1613
1614static inline void ide_set_max_pio(ide_drive_t *drive)
1615{
1616 ide_set_pio(drive, 255);
1617}
1618
1619extern spinlock_t ide_lock;
1620extern struct mutex ide_cfg_mtx;
1621/*
1622 * Structure locking:
1623 *
1624 * ide_cfg_mtx and hwgroup->lock together protect changes to
1625 * ide_hwif_t->next
1626 * ide_drive_t->next
1627 *
1628 * ide_hwgroup_t->busy: hwgroup->lock
1629 * ide_hwgroup_t->hwif: hwgroup->lock
1630 * ide_hwif_t->{hwgroup,mate}: constant, no locking
1631 * ide_drive_t->hwif: constant, no locking
1632 */
1633
1634#define local_irq_set(flags) do { local_save_flags((flags)); local_irq_enable_in_hardirq(); } while (0)
1635
1636char *ide_media_string(ide_drive_t *);
1637
1638extern struct device_attribute ide_dev_attrs[];
1639extern struct bus_type ide_bus_type;
1640extern struct class *ide_port_class;
1641
1642static inline void ide_dump_identify(u8 *id)
1643{
1644 print_hex_dump(KERN_INFO, "", DUMP_PREFIX_NONE, 16, 2, id, 512, 0);
1645}
1646
1647static inline int hwif_to_node(ide_hwif_t *hwif)
1648{
1649 return hwif->dev ? dev_to_node(hwif->dev) : -1;
1650}
1651
1652static inline ide_drive_t *ide_get_pair_dev(ide_drive_t *drive)
1653{
1654 ide_drive_t *peer = &drive->hwif->drives[(drive->dn ^ 1) & 1];
1655
1656 return (peer->dev_flags & IDE_DFLAG_PRESENT) ? peer : NULL;
1657}
1658#endif /* _IDE_H */