?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
ide: add ide_[un]lock_hwgroup() helpers
[linux-2.6/libata-dev.git] / include / linux / ide.h
blobf408d6123f14e5159a363259199c7435452fd2cc
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
35 typedef 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
52 struct 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 */
121 enum {
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 */
156 struct hwif_s;
157 typedef 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 */
163 enum { 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
170 typedef u8 hwif_chipset_t;
171
172 /*
173 * Structure to hold all information about the location of this port
174 */
175 typedef 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
188 void ide_init_port_data(struct hwif_s *, unsigned int);
189 void ide_init_port_hw(struct hwif_s *, hw_regs_t *);
190
191 static 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 */
204 static 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 */
258 typedef 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 */
271 typedef 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
276 enum {
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
340 struct 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
369 typedef 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 */
381 enum {
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
400 struct ide_atapi_pc {
401 /* actual packet bytes */
402 u8 c[12];
403 /* incremented on each retry */
404 int retries;
405 int error;
406
407 /* bytes to transfer */
408 int req_xfer;
409 /* bytes actually transferred */
410 int xferred;
411
412 /* data buffer */
413 u8 *buf;
414 /* current buffer position */
415 u8 *cur_pos;
416 int buf_size;
417 /* missing/available data on the current buffer */
418 int b_count;
419
420 /* the corresponding request */
421 struct request *rq;
422
423 unsigned long flags;
424
425 /*
426 * those are more or less driver-specific and some of them are subject
427 * to change/removal later.
428 */
429 u8 pc_buf[IDE_PC_BUFFER_SIZE];
430
431 /* idetape only */
432 struct idetape_bh *bh;
433 char *b_data;
434
435 /* idescsi only for now */
436 struct scatterlist *sg;
437 unsigned int sg_cnt;
438
439 struct scsi_cmnd *scsi_cmd;
440 void (*done) (struct scsi_cmnd *);
441
442 unsigned long timeout;
443 };
444
445 struct ide_devset;
446 struct ide_driver_s;
447
448 #ifdef CONFIG_BLK_DEV_IDEACPI
449 struct ide_acpi_drive_link;
450 struct ide_acpi_hwif_link;
451 #endif
452
453 struct ide_drive_s;
454
455 struct ide_disk_ops {
456 int (*check)(struct ide_drive_s *, const char *);
457 int (*get_capacity)(struct ide_drive_s *);
458 void (*setup)(struct ide_drive_s *);
459 void (*flush)(struct ide_drive_s *);
460 int (*init_media)(struct ide_drive_s *, struct gendisk *);
461 int (*set_doorlock)(struct ide_drive_s *, struct gendisk *,
462 int);
463 ide_startstop_t (*do_request)(struct ide_drive_s *, struct request *,
464 sector_t);
465 int (*end_request)(struct ide_drive_s *, int, int);
466 int (*ioctl)(struct ide_drive_s *, struct block_device *,
467 fmode_t, unsigned int, unsigned long);
468 };
469
470 /* ATAPI device flags */
471 enum {
472 IDE_AFLAG_DRQ_INTERRUPT = (1 << 0),
473
474 /* ide-cd */
475 /* Drive cannot eject the disc. */
476 IDE_AFLAG_NO_EJECT = (1 << 3),
477 /* Drive is a pre ATAPI 1.2 drive. */
478 IDE_AFLAG_PRE_ATAPI12 = (1 << 4),
479 /* TOC addresses are in BCD. */
480 IDE_AFLAG_TOCADDR_AS_BCD = (1 << 5),
481 /* TOC track numbers are in BCD. */
482 IDE_AFLAG_TOCTRACKS_AS_BCD = (1 << 6),
483 /*
484 * Drive does not provide data in multiples of SECTOR_SIZE
485 * when more than one interrupt is needed.
486 */
487 IDE_AFLAG_LIMIT_NFRAMES = (1 << 7),
488 /* Saved TOC information is current. */
489 IDE_AFLAG_TOC_VALID = (1 << 9),
490 /* We think that the drive door is locked. */
491 IDE_AFLAG_DOOR_LOCKED = (1 << 10),
492 /* SET_CD_SPEED command is unsupported. */
493 IDE_AFLAG_NO_SPEED_SELECT = (1 << 11),
494 IDE_AFLAG_VERTOS_300_SSD = (1 << 12),
495 IDE_AFLAG_VERTOS_600_ESD = (1 << 13),
496 IDE_AFLAG_SANYO_3CD = (1 << 14),
497 IDE_AFLAG_FULL_CAPS_PAGE = (1 << 15),
498 IDE_AFLAG_PLAY_AUDIO_OK = (1 << 16),
499 IDE_AFLAG_LE_SPEED_FIELDS = (1 << 17),
500
501 /* ide-floppy */
502 /* Avoid commands not supported in Clik drive */
503 IDE_AFLAG_CLIK_DRIVE = (1 << 19),
504 /* Requires BH algorithm for packets */
505 IDE_AFLAG_ZIP_DRIVE = (1 << 20),
506 /* Supports format progress report */
507 IDE_AFLAG_SRFP = (1 << 22),
508
509 /* ide-tape */
510 IDE_AFLAG_IGNORE_DSC = (1 << 23),
511 /* 0 When the tape position is unknown */
512 IDE_AFLAG_ADDRESS_VALID = (1 << 24),
513 /* Device already opened */
514 IDE_AFLAG_BUSY = (1 << 25),
515 /* Attempt to auto-detect the current user block size */
516 IDE_AFLAG_DETECT_BS = (1 << 26),
517 /* Currently on a filemark */
518 IDE_AFLAG_FILEMARK = (1 << 27),
519 /* 0 = no tape is loaded, so we don't rewind after ejecting */
520 IDE_AFLAG_MEDIUM_PRESENT = (1 << 28),
521
522 IDE_AFLAG_NO_AUTOCLOSE = (1 << 29),
523 };
524
525 /* device flags */
526 enum {
527 /* restore settings after device reset */
528 IDE_DFLAG_KEEP_SETTINGS = (1 << 0),
529 /* device is using DMA for read/write */
530 IDE_DFLAG_USING_DMA = (1 << 1),
531 /* okay to unmask other IRQs */
532 IDE_DFLAG_UNMASK = (1 << 2),
533 /* don't attempt flushes */
534 IDE_DFLAG_NOFLUSH = (1 << 3),
535 /* DSC overlap */
536 IDE_DFLAG_DSC_OVERLAP = (1 << 4),
537 /* give potential excess bandwidth */
538 IDE_DFLAG_NICE1 = (1 << 5),
539 /* device is physically present */
540 IDE_DFLAG_PRESENT = (1 << 6),
541 /* device ejected hint */
542 IDE_DFLAG_DEAD = (1 << 7),
543 /* id read from device (synthetic if not set) */
544 IDE_DFLAG_ID_READ = (1 << 8),
545 IDE_DFLAG_NOPROBE = (1 << 9),
546 /* need to do check_media_change() */
547 IDE_DFLAG_REMOVABLE = (1 << 10),
548 /* needed for removable devices */
549 IDE_DFLAG_ATTACH = (1 << 11),
550 IDE_DFLAG_FORCED_GEOM = (1 << 12),
551 /* disallow setting unmask bit */
552 IDE_DFLAG_NO_UNMASK = (1 << 13),
553 /* disallow enabling 32-bit I/O */
554 IDE_DFLAG_NO_IO_32BIT = (1 << 14),
555 /* for removable only: door lock/unlock works */
556 IDE_DFLAG_DOORLOCKING = (1 << 15),
557 /* disallow DMA */
558 IDE_DFLAG_NODMA = (1 << 16),
559 /* powermanagment told us not to do anything, so sleep nicely */
560 IDE_DFLAG_BLOCKED = (1 << 17),
561 /* ide-scsi emulation */
562 IDE_DFLAG_SCSI = (1 << 18),
563 /* sleeping & sleep field valid */
564 IDE_DFLAG_SLEEPING = (1 << 19),
565 IDE_DFLAG_POST_RESET = (1 << 20),
566 IDE_DFLAG_UDMA33_WARNED = (1 << 21),
567 IDE_DFLAG_LBA48 = (1 << 22),
568 /* status of write cache */
569 IDE_DFLAG_WCACHE = (1 << 23),
570 /* used for ignoring ATA_DF */
571 IDE_DFLAG_NOWERR = (1 << 24),
572 /* retrying in PIO */
573 IDE_DFLAG_DMA_PIO_RETRY = (1 << 25),
574 IDE_DFLAG_LBA = (1 << 26),
575 /* don't unload heads */
576 IDE_DFLAG_NO_UNLOAD = (1 << 27),
577 /* heads unloaded, please don't reset port */
578 IDE_DFLAG_PARKED = (1 << 28),
579 IDE_DFLAG_MEDIA_CHANGED = (1 << 29),
580 /* write protect */
581 IDE_DFLAG_WP = (1 << 30),
582 IDE_DFLAG_FORMAT_IN_PROGRESS = (1 << 31),
583 };
584
585 struct ide_drive_s {
586 char name[4]; /* drive name, such as "hda" */
587 char driver_req[10]; /* requests specific driver */
588
589 struct request_queue *queue; /* request queue */
590
591 struct request *rq; /* current request */
592 struct ide_drive_s *next; /* circular list of hwgroup drives */
593 void *driver_data; /* extra driver data */
594 u16 *id; /* identification info */
595 #ifdef CONFIG_IDE_PROC_FS
596 struct proc_dir_entry *proc; /* /proc/ide/ directory entry */
597 const struct ide_proc_devset *settings; /* /proc/ide/ drive settings */
598 #endif
599 struct hwif_s *hwif; /* actually (ide_hwif_t *) */
600
601 const struct ide_disk_ops *disk_ops;
602
603 unsigned long dev_flags;
604
605 unsigned long sleep; /* sleep until this time */
606 unsigned long service_start; /* time we started last request */
607 unsigned long service_time; /* service time of last request */
608 unsigned long timeout; /* max time to wait for irq */
609
610 special_t special; /* special action flags */
611
612 u8 select; /* basic drive/head select reg value */
613 u8 retry_pio; /* retrying dma capable host in pio */
614 u8 waiting_for_dma; /* dma currently in progress */
615 u8 dma; /* atapi dma flag */
616
617 u8 quirk_list; /* considered quirky, set for a specific host */
618 u8 init_speed; /* transfer rate set at boot */
619 u8 current_speed; /* current transfer rate set */
620 u8 desired_speed; /* desired transfer rate set */
621 u8 dn; /* now wide spread use */
622 u8 acoustic; /* acoustic management */
623 u8 media; /* disk, cdrom, tape, floppy, ... */
624 u8 ready_stat; /* min status value for drive ready */
625 u8 mult_count; /* current multiple sector setting */
626 u8 mult_req; /* requested multiple sector setting */
627 u8 io_32bit; /* 0=16-bit, 1=32-bit, 2/3=32bit+sync */
628 u8 bad_wstat; /* used for ignoring ATA_DF */
629 u8 head; /* "real" number of heads */
630 u8 sect; /* "real" sectors per track */
631 u8 bios_head; /* BIOS/fdisk/LILO number of heads */
632 u8 bios_sect; /* BIOS/fdisk/LILO sectors per track */
633
634 /* delay this long before sending packet command */
635 u8 pc_delay;
636
637 unsigned int bios_cyl; /* BIOS/fdisk/LILO number of cyls */
638 unsigned int cyl; /* "real" number of cyls */
639 unsigned int drive_data; /* used by set_pio_mode/selectproc */
640 unsigned int failures; /* current failure count */
641 unsigned int max_failures; /* maximum allowed failure count */
642 u64 probed_capacity;/* initial reported media capacity (ide-cd only currently) */
643
644 u64 capacity64; /* total number of sectors */
645
646 int lun; /* logical unit */
647 int crc_count; /* crc counter to reduce drive speed */
648
649 unsigned long debug_mask; /* debugging levels switch */
650
651 #ifdef CONFIG_BLK_DEV_IDEACPI
652 struct ide_acpi_drive_link *acpidata;
653 #endif
654 struct list_head list;
655 struct device gendev;
656 struct completion gendev_rel_comp; /* to deal with device release() */
657
658 /* current packet command */
659 struct ide_atapi_pc *pc;
660
661 /* callback for packet commands */
662 void (*pc_callback)(struct ide_drive_s *, int);
663
664 void (*pc_update_buffers)(struct ide_drive_s *, struct ide_atapi_pc *);
665 int (*pc_io_buffers)(struct ide_drive_s *, struct ide_atapi_pc *,
666 unsigned int, int);
667
668 unsigned long atapi_flags;
669
670 struct ide_atapi_pc request_sense_pc;
671 struct request request_sense_rq;
672 };
673
674 typedef struct ide_drive_s ide_drive_t;
675
676 #define to_ide_device(dev) container_of(dev, ide_drive_t, gendev)
677
678 #define to_ide_drv(obj, cont_type) \
679 container_of(obj, struct cont_type, kref)
680
681 #define ide_drv_g(disk, cont_type) \
682 container_of((disk)->private_data, struct cont_type, driver)
683
684 struct ide_port_info;
685
686 struct ide_tp_ops {
687 void (*exec_command)(struct hwif_s *, u8);
688 u8 (*read_status)(struct hwif_s *);
689 u8 (*read_altstatus)(struct hwif_s *);
690 u8 (*read_sff_dma_status)(struct hwif_s *);
691
692 void (*set_irq)(struct hwif_s *, int);
693
694 void (*tf_load)(ide_drive_t *, struct ide_task_s *);
695 void (*tf_read)(ide_drive_t *, struct ide_task_s *);
696
697 void (*input_data)(ide_drive_t *, struct request *, void *,
698 unsigned int);
699 void (*output_data)(ide_drive_t *, struct request *, void *,
700 unsigned int);
701 };
702
703 extern const struct ide_tp_ops default_tp_ops;
704
705 /**
706 * struct ide_port_ops - IDE port operations
707 *
708 * @init_dev: host specific initialization of a device
709 * @set_pio_mode: routine to program host for PIO mode
710 * @set_dma_mode: routine to program host for DMA mode
711 * @selectproc: tweaks hardware to select drive
712 * @reset_poll: chipset polling based on hba specifics
713 * @pre_reset: chipset specific changes to default for device-hba resets
714 * @resetproc: routine to reset controller after a disk reset
715 * @maskproc: special host masking for drive selection
716 * @quirkproc: check host's drive quirk list
717 * @clear_irq: clear IRQ
718 *
719 * @mdma_filter: filter MDMA modes
720 * @udma_filter: filter UDMA modes
721 *
722 * @cable_detect: detect cable type
723 */
724 struct ide_port_ops {
725 void (*init_dev)(ide_drive_t *);
726 void (*set_pio_mode)(ide_drive_t *, const u8);
727 void (*set_dma_mode)(ide_drive_t *, const u8);
728 void (*selectproc)(ide_drive_t *);
729 int (*reset_poll)(ide_drive_t *);
730 void (*pre_reset)(ide_drive_t *);
731 void (*resetproc)(ide_drive_t *);
732 void (*maskproc)(ide_drive_t *, int);
733 void (*quirkproc)(ide_drive_t *);
734 void (*clear_irq)(ide_drive_t *);
735
736 u8 (*mdma_filter)(ide_drive_t *);
737 u8 (*udma_filter)(ide_drive_t *);
738
739 u8 (*cable_detect)(struct hwif_s *);
740 };
741
742 struct ide_dma_ops {
743 void (*dma_host_set)(struct ide_drive_s *, int);
744 int (*dma_setup)(struct ide_drive_s *);
745 void (*dma_exec_cmd)(struct ide_drive_s *, u8);
746 void (*dma_start)(struct ide_drive_s *);
747 int (*dma_end)(struct ide_drive_s *);
748 int (*dma_test_irq)(struct ide_drive_s *);
749 void (*dma_lost_irq)(struct ide_drive_s *);
750 void (*dma_timeout)(struct ide_drive_s *);
751 };
752
753 struct ide_host;
754
755 typedef struct hwif_s {
756 struct hwif_s *next; /* for linked-list in ide_hwgroup_t */
757 struct hwif_s *mate; /* other hwif from same PCI chip */
758 struct hwgroup_s *hwgroup; /* actually (ide_hwgroup_t *) */
759 struct proc_dir_entry *proc; /* /proc/ide/ directory entry */
760
761 struct ide_host *host;
762
763 char name[6]; /* name of interface, eg. "ide0" */
764
765 struct ide_io_ports io_ports;
766
767 unsigned long sata_scr[SATA_NR_PORTS];
768
769 ide_drive_t drives[MAX_DRIVES]; /* drive info */
770
771 u8 major; /* our major number */
772 u8 index; /* 0 for ide0; 1 for ide1; ... */
773 u8 channel; /* for dual-port chips: 0=primary, 1=secondary */
774
775 u32 host_flags;
776
777 u8 pio_mask;
778
779 u8 ultra_mask;
780 u8 mwdma_mask;
781 u8 swdma_mask;
782
783 u8 cbl; /* cable type */
784
785 hwif_chipset_t chipset; /* sub-module for tuning.. */
786
787 struct device *dev;
788
789 ide_ack_intr_t *ack_intr;
790
791 void (*rw_disk)(ide_drive_t *, struct request *);
792
793 const struct ide_tp_ops *tp_ops;
794 const struct ide_port_ops *port_ops;
795 const struct ide_dma_ops *dma_ops;
796
797 /* dma physical region descriptor table (cpu view) */
798 unsigned int *dmatable_cpu;
799 /* dma physical region descriptor table (dma view) */
800 dma_addr_t dmatable_dma;
801
802 /* maximum number of PRD table entries */
803 int prd_max_nents;
804 /* PRD entry size in bytes */
805 int prd_ent_size;
806
807 /* Scatter-gather list used to build the above */
808 struct scatterlist *sg_table;
809 int sg_max_nents; /* Maximum number of entries in it */
810 int sg_nents; /* Current number of entries in it */
811 int sg_dma_direction; /* dma transfer direction */
812
813 /* data phase of the active command (currently only valid for PIO/DMA) */
814 int data_phase;
815
816 struct ide_task_s task; /* current command */
817
818 unsigned int nsect;
819 unsigned int nleft;
820 struct scatterlist *cursg;
821 unsigned int cursg_ofs;
822
823 int rqsize; /* max sectors per request */
824 int irq; /* our irq number */
825
826 unsigned long dma_base; /* base addr for dma ports */
827
828 unsigned long config_data; /* for use by chipset-specific code */
829 unsigned long select_data; /* for use by chipset-specific code */
830
831 unsigned long extra_base; /* extra addr for dma ports */
832 unsigned extra_ports; /* number of extra dma ports */
833
834 unsigned present : 1; /* this interface exists */
835 unsigned sg_mapped : 1; /* sg_table and sg_nents are ready */
836
837 struct device gendev;
838 struct device *portdev;
839
840 struct completion gendev_rel_comp; /* To deal with device release() */
841
842 void *hwif_data; /* extra hwif data */
843
844 #ifdef CONFIG_BLK_DEV_IDEACPI
845 struct ide_acpi_hwif_link *acpidata;
846 #endif
847 } ____cacheline_internodealigned_in_smp ide_hwif_t;
848
849 #define MAX_HOST_PORTS 4
850
851 struct ide_host {
852 ide_hwif_t *ports[MAX_HOST_PORTS];
853 unsigned int n_ports;
854 struct device *dev[2];
855 unsigned int (*init_chipset)(struct pci_dev *);
856 unsigned long host_flags;
857 void *host_priv;
858 };
859
860 /*
861 * internal ide interrupt handler type
862 */
863 typedef ide_startstop_t (ide_handler_t)(ide_drive_t *);
864 typedef int (ide_expiry_t)(ide_drive_t *);
865
866 /* used by ide-cd, ide-floppy, etc. */
867 typedef void (xfer_func_t)(ide_drive_t *, struct request *rq, void *, unsigned);
868
869 typedef struct hwgroup_s {
870 /* irq handler, if active */
871 ide_startstop_t (*handler)(ide_drive_t *);
872
873 /* BOOL: protects all fields below */
874 volatile int busy;
875 /* BOOL: wake us up on timer expiry */
876 unsigned int sleeping : 1;
877 /* BOOL: polling active & poll_timeout field valid */
878 unsigned int polling : 1;
879
880 /* current drive */
881 ide_drive_t *drive;
882 /* ptr to current hwif in linked-list */
883 ide_hwif_t *hwif;
884
885 /* current request */
886 struct request *rq;
887
888 /* failsafe timer */
889 struct timer_list timer;
890 /* timeout value during long polls */
891 unsigned long poll_timeout;
892 /* queried upon timeouts */
893 int (*expiry)(ide_drive_t *);
894
895 int req_gen;
896 int req_gen_timer;
897
898 spinlock_t lock;
899 } ide_hwgroup_t;
900
901 typedef struct ide_driver_s ide_driver_t;
902
903 extern struct mutex ide_setting_mtx;
904
905 /*
906 * configurable drive settings
907 */
908
909 #define DS_SYNC (1 << 0)
910
911 struct ide_devset {
912 int (*get)(ide_drive_t *);
913 int (*set)(ide_drive_t *, int);
914 unsigned int flags;
915 };
916
917 #define __DEVSET(_flags, _get, _set) { \
918 .flags = _flags, \
919 .get = _get, \
920 .set = _set, \
921 }
922
923 #define ide_devset_get(name, field) \
924 static int get_##name(ide_drive_t *drive) \
925 { \
926 return drive->field; \
927 }
928
929 #define ide_devset_set(name, field) \
930 static int set_##name(ide_drive_t *drive, int arg) \
931 { \
932 drive->field = arg; \
933 return 0; \
934 }
935
936 #define ide_devset_get_flag(name, flag) \
937 static int get_##name(ide_drive_t *drive) \
938 { \
939 return !!(drive->dev_flags & flag); \
940 }
941
942 #define ide_devset_set_flag(name, flag) \
943 static int set_##name(ide_drive_t *drive, int arg) \
944 { \
945 if (arg) \
946 drive->dev_flags |= flag; \
947 else \
948 drive->dev_flags &= ~flag; \
949 return 0; \
950 }
951
952 #define __IDE_DEVSET(_name, _flags, _get, _set) \
953 const struct ide_devset ide_devset_##_name = \
954 __DEVSET(_flags, _get, _set)
955
956 #define IDE_DEVSET(_name, _flags, _get, _set) \
957 static __IDE_DEVSET(_name, _flags, _get, _set)
958
959 #define ide_devset_rw(_name, _func) \
960 IDE_DEVSET(_name, 0, get_##_func, set_##_func)
961
962 #define ide_devset_w(_name, _func) \
963 IDE_DEVSET(_name, 0, NULL, set_##_func)
964
965 #define ide_ext_devset_rw(_name, _func) \
966 __IDE_DEVSET(_name, 0, get_##_func, set_##_func)
967
968 #define ide_ext_devset_rw_sync(_name, _func) \
969 __IDE_DEVSET(_name, DS_SYNC, get_##_func, set_##_func)
970
971 #define ide_decl_devset(_name) \
972 extern const struct ide_devset ide_devset_##_name
973
974 ide_decl_devset(io_32bit);
975 ide_decl_devset(keepsettings);
976 ide_decl_devset(pio_mode);
977 ide_decl_devset(unmaskirq);
978 ide_decl_devset(using_dma);
979
980 #ifdef CONFIG_IDE_PROC_FS
981 /*
982 * /proc/ide interface
983 */
984
985 #define ide_devset_rw_field(_name, _field) \
986 ide_devset_get(_name, _field); \
987 ide_devset_set(_name, _field); \
988 IDE_DEVSET(_name, DS_SYNC, get_##_name, set_##_name)
989
990 #define ide_devset_rw_flag(_name, _field) \
991 ide_devset_get_flag(_name, _field); \
992 ide_devset_set_flag(_name, _field); \
993 IDE_DEVSET(_name, DS_SYNC, get_##_name, set_##_name)
994
995 struct ide_proc_devset {
996 const char *name;
997 const struct ide_devset *setting;
998 int min, max;
999 int (*mulf)(ide_drive_t *);
1000 int (*divf)(ide_drive_t *);
1001 };
1002
1003 #define __IDE_PROC_DEVSET(_name, _min, _max, _mulf, _divf) { \
1004 .name = __stringify(_name), \
1005 .setting = &ide_devset_##_name, \
1006 .min = _min, \
1007 .max = _max, \
1008 .mulf = _mulf, \
1009 .divf = _divf, \
1010 }
1011
1012 #define IDE_PROC_DEVSET(_name, _min, _max) \
1013 __IDE_PROC_DEVSET(_name, _min, _max, NULL, NULL)
1014
1015 typedef struct {
1016 const char *name;
1017 mode_t mode;
1018 read_proc_t *read_proc;
1019 write_proc_t *write_proc;
1020 } ide_proc_entry_t;
1021
1022 void proc_ide_create(void);
1023 void proc_ide_destroy(void);
1024 void ide_proc_register_port(ide_hwif_t *);
1025 void ide_proc_port_register_devices(ide_hwif_t *);
1026 void ide_proc_unregister_device(ide_drive_t *);
1027 void ide_proc_unregister_port(ide_hwif_t *);
1028 void ide_proc_register_driver(ide_drive_t *, ide_driver_t *);
1029 void ide_proc_unregister_driver(ide_drive_t *, ide_driver_t *);
1030
1031 read_proc_t proc_ide_read_capacity;
1032 read_proc_t proc_ide_read_geometry;
1033
1034 /*
1035 * Standard exit stuff:
1036 */
1037 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) \
1038 { \
1039 len -= off; \
1040 if (len < count) { \
1041 *eof = 1; \
1042 if (len <= 0) \
1043 return 0; \
1044 } else \
1045 len = count; \
1046 *start = page + off; \
1047 return len; \
1048 }
1049 #else
1050 static inline void proc_ide_create(void) { ; }
1051 static inline void proc_ide_destroy(void) { ; }
1052 static inline void ide_proc_register_port(ide_hwif_t *hwif) { ; }
1053 static inline void ide_proc_port_register_devices(ide_hwif_t *hwif) { ; }
1054 static inline void ide_proc_unregister_device(ide_drive_t *drive) { ; }
1055 static inline void ide_proc_unregister_port(ide_hwif_t *hwif) { ; }
1056 static inline void ide_proc_register_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
1057 static inline void ide_proc_unregister_driver(ide_drive_t *drive, ide_driver_t *driver) { ; }
1058 #define PROC_IDE_READ_RETURN(page,start,off,count,eof,len) return 0;
1059 #endif
1060
1061 enum {
1062 /* enter/exit functions */
1063 IDE_DBG_FUNC = (1 << 0),
1064 /* sense key/asc handling */
1065 IDE_DBG_SENSE = (1 << 1),
1066 /* packet commands handling */
1067 IDE_DBG_PC = (1 << 2),
1068 /* request handling */
1069 IDE_DBG_RQ = (1 << 3),
1070 /* driver probing/setup */
1071 IDE_DBG_PROBE = (1 << 4),
1072 };
1073
1074 /* DRV_NAME has to be defined in the driver before using the macro below */
1075 #define __ide_debug_log(lvl, fmt, args...) \
1076 { \
1077 if (unlikely(drive->debug_mask & lvl)) \
1078 printk(KERN_INFO DRV_NAME ": " fmt, ## args); \
1079 }
1080
1081 /*
1082 * Power Management state machine (rq->pm->pm_step).
1083 *
1084 * For each step, the core calls ide_start_power_step() first.
1085 * This can return:
1086 * - ide_stopped : In this case, the core calls us back again unless
1087 * step have been set to ide_power_state_completed.
1088 * - ide_started : In this case, the channel is left busy until an
1089 * async event (interrupt) occurs.
1090 * Typically, ide_start_power_step() will issue a taskfile request with
1091 * do_rw_taskfile().
1092 *
1093 * Upon reception of the interrupt, the core will call ide_complete_power_step()
1094 * with the error code if any. This routine should update the step value
1095 * and return. It should not start a new request. The core will call
1096 * ide_start_power_step() for the new step value, unless step have been
1097 * set to IDE_PM_COMPLETED.
1098 */
1099 enum {
1100 IDE_PM_START_SUSPEND,
1101 IDE_PM_FLUSH_CACHE = IDE_PM_START_SUSPEND,
1102 IDE_PM_STANDBY,
1103
1104 IDE_PM_START_RESUME,
1105 IDE_PM_RESTORE_PIO = IDE_PM_START_RESUME,
1106 IDE_PM_IDLE,
1107 IDE_PM_RESTORE_DMA,
1108
1109 IDE_PM_COMPLETED,
1110 };
1111
1112 int generic_ide_suspend(struct device *, pm_message_t);
1113 int generic_ide_resume(struct device *);
1114
1115 void ide_complete_power_step(ide_drive_t *, struct request *);
1116 ide_startstop_t ide_start_power_step(ide_drive_t *, struct request *);
1117 void ide_complete_pm_request(ide_drive_t *, struct request *);
1118 void ide_check_pm_state(ide_drive_t *, struct request *);
1119
1120 /*
1121 * Subdrivers support.
1122 *
1123 * The gendriver.owner field should be set to the module owner of this driver.
1124 * The gendriver.name field should be set to the name of this driver
1125 */
1126 struct ide_driver_s {
1127 const char *version;
1128 ide_startstop_t (*do_request)(ide_drive_t *, struct request *, sector_t);
1129 int (*end_request)(ide_drive_t *, int, int);
1130 ide_startstop_t (*error)(ide_drive_t *, struct request *rq, u8, u8);
1131 struct device_driver gen_driver;
1132 int (*probe)(ide_drive_t *);
1133 void (*remove)(ide_drive_t *);
1134 void (*resume)(ide_drive_t *);
1135 void (*shutdown)(ide_drive_t *);
1136 #ifdef CONFIG_IDE_PROC_FS
1137 ide_proc_entry_t * (*proc_entries)(ide_drive_t *);
1138 const struct ide_proc_devset * (*proc_devsets)(ide_drive_t *);
1139 #endif
1140 };
1141
1142 #define to_ide_driver(drv) container_of(drv, ide_driver_t, gen_driver)
1143
1144 int ide_device_get(ide_drive_t *);
1145 void ide_device_put(ide_drive_t *);
1146
1147 struct ide_ioctl_devset {
1148 unsigned int get_ioctl;
1149 unsigned int set_ioctl;
1150 const struct ide_devset *setting;
1151 };
1152
1153 int ide_setting_ioctl(ide_drive_t *, struct block_device *, unsigned int,
1154 unsigned long, const struct ide_ioctl_devset *);
1155
1156 int generic_ide_ioctl(ide_drive_t *, struct block_device *, unsigned, unsigned long);
1157
1158 extern int ide_vlb_clk;
1159 extern int ide_pci_clk;
1160
1161 extern int ide_end_request (ide_drive_t *drive, int uptodate, int nrsecs);
1162 int ide_end_dequeued_request(ide_drive_t *drive, struct request *rq,
1163 int uptodate, int nr_sectors);
1164
1165 extern void ide_set_handler (ide_drive_t *drive, ide_handler_t *handler, unsigned int timeout, ide_expiry_t *expiry);
1166
1167 void ide_execute_command(ide_drive_t *, u8, ide_handler_t *, unsigned int,
1168 ide_expiry_t *);
1169
1170 void ide_execute_pkt_cmd(ide_drive_t *);
1171
1172 void ide_pad_transfer(ide_drive_t *, int, int);
1173
1174 ide_startstop_t __ide_error(ide_drive_t *, struct request *, u8, u8);
1175
1176 ide_startstop_t ide_error (ide_drive_t *drive, const char *msg, byte stat);
1177
1178 void ide_fix_driveid(u16 *);
1179
1180 extern void ide_fixstring(u8 *, const int, const int);
1181
1182 int ide_busy_sleep(ide_hwif_t *, unsigned long, int);
1183
1184 int ide_wait_stat(ide_startstop_t *, ide_drive_t *, u8, u8, unsigned long);
1185
1186 extern ide_startstop_t ide_do_reset (ide_drive_t *);
1187
1188 extern int ide_devset_execute(ide_drive_t *drive,
1189 const struct ide_devset *setting, int arg);
1190
1191 extern void ide_do_drive_cmd(ide_drive_t *, struct request *);
1192
1193 extern void ide_end_drive_cmd(ide_drive_t *, u8, u8);
1194
1195 void ide_tf_dump(const char *, struct ide_taskfile *);
1196
1197 void ide_exec_command(ide_hwif_t *, u8);
1198 u8 ide_read_status(ide_hwif_t *);
1199 u8 ide_read_altstatus(ide_hwif_t *);
1200 u8 ide_read_sff_dma_status(ide_hwif_t *);
1201
1202 void ide_set_irq(ide_hwif_t *, int);
1203
1204 void ide_tf_load(ide_drive_t *, ide_task_t *);
1205 void ide_tf_read(ide_drive_t *, ide_task_t *);
1206
1207 void ide_input_data(ide_drive_t *, struct request *, void *, unsigned int);
1208 void ide_output_data(ide_drive_t *, struct request *, void *, unsigned int);
1209
1210 int ide_io_buffers(ide_drive_t *, struct ide_atapi_pc *, unsigned int, int);
1211
1212 extern void SELECT_DRIVE(ide_drive_t *);
1213 void SELECT_MASK(ide_drive_t *, int);
1214
1215 u8 ide_read_error(ide_drive_t *);
1216 void ide_read_bcount_and_ireason(ide_drive_t *, u16 *, u8 *);
1217
1218 extern int drive_is_ready(ide_drive_t *);
1219
1220 void ide_pktcmd_tf_load(ide_drive_t *, u32, u16, u8);
1221
1222 int ide_check_atapi_device(ide_drive_t *, const char *);
1223
1224 void ide_init_pc(struct ide_atapi_pc *);
1225
1226 /* Disk head parking */
1227 extern wait_queue_head_t ide_park_wq;
1228 ssize_t ide_park_show(struct device *dev, struct device_attribute *attr,
1229 char *buf);
1230 ssize_t ide_park_store(struct device *dev, struct device_attribute *attr,
1231 const char *buf, size_t len);
1232
1233 /*
1234 * Special requests for ide-tape block device strategy routine.
1235 *
1236 * In order to service a character device command, we add special requests to
1237 * the tail of our block device request queue and wait for their completion.
1238 */
1239 enum {
1240 REQ_IDETAPE_PC1 = (1 << 0), /* packet command (first stage) */
1241 REQ_IDETAPE_PC2 = (1 << 1), /* packet command (second stage) */
1242 REQ_IDETAPE_READ = (1 << 2),
1243 REQ_IDETAPE_WRITE = (1 << 3),
1244 };
1245
1246 int ide_queue_pc_tail(ide_drive_t *, struct gendisk *, struct ide_atapi_pc *);
1247
1248 int ide_do_test_unit_ready(ide_drive_t *, struct gendisk *);
1249 int ide_do_start_stop(ide_drive_t *, struct gendisk *, int);
1250 int ide_set_media_lock(ide_drive_t *, struct gendisk *, int);
1251 void ide_create_request_sense_cmd(ide_drive_t *, struct ide_atapi_pc *);
1252 void ide_retry_pc(ide_drive_t *, struct gendisk *);
1253
1254 static inline unsigned long ide_scsi_get_timeout(struct ide_atapi_pc *pc)
1255 {
1256 return max_t(unsigned long, WAIT_CMD, pc->timeout - jiffies);
1257 }
1258
1259 int ide_scsi_expiry(ide_drive_t *);
1260
1261 ide_startstop_t ide_issue_pc(ide_drive_t *, unsigned int, ide_expiry_t *);
1262
1263 ide_startstop_t do_rw_taskfile(ide_drive_t *, ide_task_t *);
1264
1265 void task_end_request(ide_drive_t *, struct request *, u8);
1266
1267 int ide_raw_taskfile(ide_drive_t *, ide_task_t *, u8 *, u16);
1268 int ide_no_data_taskfile(ide_drive_t *, ide_task_t *);
1269
1270 int ide_taskfile_ioctl(ide_drive_t *, unsigned int, unsigned long);
1271
1272 extern int ide_driveid_update(ide_drive_t *);
1273 extern int ide_config_drive_speed(ide_drive_t *, u8);
1274 extern u8 eighty_ninty_three (ide_drive_t *);
1275 extern int taskfile_lib_get_identify(ide_drive_t *drive, u8 *);
1276
1277 extern int ide_wait_not_busy(ide_hwif_t *hwif, unsigned long timeout);
1278
1279 extern void ide_stall_queue(ide_drive_t *drive, unsigned long timeout);
1280
1281 extern void ide_timer_expiry(unsigned long);
1282 extern irqreturn_t ide_intr(int irq, void *dev_id);
1283
1284 static inline int ide_lock_hwgroup(ide_hwgroup_t *hwgroup)
1285 {
1286 if (hwgroup->busy)
1287 return 1;
1288
1289 hwgroup->busy = 1;
1290 /* for atari only */
1291 ide_get_lock(ide_intr, hwgroup);
1292
1293 return 0;
1294 }
1295
1296 static inline void ide_unlock_hwgroup(ide_hwgroup_t *hwgroup)
1297 {
1298 /* for atari only */
1299 ide_release_lock();
1300 hwgroup->busy = 0;
1301 }
1302
1303 extern void do_ide_request(struct request_queue *);
1304
1305 void ide_init_disk(struct gendisk *, ide_drive_t *);
1306
1307 #ifdef CONFIG_IDEPCI_PCIBUS_ORDER
1308 extern int __ide_pci_register_driver(struct pci_driver *driver, struct module *owner, const char *mod_name);
1309 #define ide_pci_register_driver(d) __ide_pci_register_driver(d, THIS_MODULE, KBUILD_MODNAME)
1310 #else
1311 #define ide_pci_register_driver(d) pci_register_driver(d)
1312 #endif
1313
1314 static inline int ide_pci_is_in_compatibility_mode(struct pci_dev *dev)
1315 {
1316 if ((dev->class >> 8) == PCI_CLASS_STORAGE_IDE && (dev->class & 5) != 5)
1317 return 1;
1318 return 0;
1319 }
1320
1321 void ide_pci_setup_ports(struct pci_dev *, const struct ide_port_info *, int,
1322 hw_regs_t *, hw_regs_t **);
1323 void ide_setup_pci_noise(struct pci_dev *, const struct ide_port_info *);
1324
1325 #ifdef CONFIG_BLK_DEV_IDEDMA_PCI
1326 int ide_pci_set_master(struct pci_dev *, const char *);
1327 unsigned long ide_pci_dma_base(ide_hwif_t *, const struct ide_port_info *);
1328 int ide_pci_check_simplex(ide_hwif_t *, const struct ide_port_info *);
1329 int ide_hwif_setup_dma(ide_hwif_t *, const struct ide_port_info *);
1330 #else
1331 static inline int ide_hwif_setup_dma(ide_hwif_t *hwif,
1332 const struct ide_port_info *d)
1333 {
1334 return -EINVAL;
1335 }
1336 #endif
1337
1338 typedef struct ide_pci_enablebit_s {
1339 u8 reg; /* byte pci reg holding the enable-bit */
1340 u8 mask; /* mask to isolate the enable-bit */
1341 u8 val; /* value of masked reg when "enabled" */
1342 } ide_pci_enablebit_t;
1343
1344 enum {
1345 /* Uses ISA control ports not PCI ones. */
1346 IDE_HFLAG_ISA_PORTS = (1 << 0),
1347 /* single port device */
1348 IDE_HFLAG_SINGLE = (1 << 1),
1349 /* don't use legacy PIO blacklist */
1350 IDE_HFLAG_PIO_NO_BLACKLIST = (1 << 2),
1351 /* set for the second port of QD65xx */
1352 IDE_HFLAG_QD_2ND_PORT = (1 << 3),
1353 /* use PIO8/9 for prefetch off/on */
1354 IDE_HFLAG_ABUSE_PREFETCH = (1 << 4),
1355 /* use PIO6/7 for fast-devsel off/on */
1356 IDE_HFLAG_ABUSE_FAST_DEVSEL = (1 << 5),
1357 /* use 100-102 and 200-202 PIO values to set DMA modes */
1358 IDE_HFLAG_ABUSE_DMA_MODES = (1 << 6),
1359 /*
1360 * keep DMA setting when programming PIO mode, may be used only
1361 * for hosts which have separate PIO and DMA timings (ie. PMAC)
1362 */
1363 IDE_HFLAG_SET_PIO_MODE_KEEP_DMA = (1 << 7),
1364 /* program host for the transfer mode after programming device */
1365 IDE_HFLAG_POST_SET_MODE = (1 << 8),
1366 /* don't program host/device for the transfer mode ("smart" hosts) */
1367 IDE_HFLAG_NO_SET_MODE = (1 << 9),
1368 /* trust BIOS for programming chipset/device for DMA */
1369 IDE_HFLAG_TRUST_BIOS_FOR_DMA = (1 << 10),
1370 /* host is CS5510/CS5520 */
1371 IDE_HFLAG_CS5520 = (1 << 11),
1372 /* ATAPI DMA is unsupported */
1373 IDE_HFLAG_NO_ATAPI_DMA = (1 << 12),
1374 /* set if host is a "non-bootable" controller */
1375 IDE_HFLAG_NON_BOOTABLE = (1 << 13),
1376 /* host doesn't support DMA */
1377 IDE_HFLAG_NO_DMA = (1 << 14),
1378 /* check if host is PCI IDE device before allowing DMA */
1379 IDE_HFLAG_NO_AUTODMA = (1 << 15),
1380 /* host uses MMIO */
1381 IDE_HFLAG_MMIO = (1 << 16),
1382 /* no LBA48 */
1383 IDE_HFLAG_NO_LBA48 = (1 << 17),
1384 /* no LBA48 DMA */
1385 IDE_HFLAG_NO_LBA48_DMA = (1 << 18),
1386 /* data FIFO is cleared by an error */
1387 IDE_HFLAG_ERROR_STOPS_FIFO = (1 << 19),
1388 /* serialize ports */
1389 IDE_HFLAG_SERIALIZE = (1 << 20),
1390 /* use legacy IRQs */
1391 IDE_HFLAG_LEGACY_IRQS = (1 << 21),
1392 /* force use of legacy IRQs */
1393 IDE_HFLAG_FORCE_LEGACY_IRQS = (1 << 22),
1394 /* host is TRM290 */
1395 IDE_HFLAG_TRM290 = (1 << 23),
1396 /* use 32-bit I/O ops */
1397 IDE_HFLAG_IO_32BIT = (1 << 24),
1398 /* unmask IRQs */
1399 IDE_HFLAG_UNMASK_IRQS = (1 << 25),
1400 IDE_HFLAG_BROKEN_ALTSTATUS = (1 << 26),
1401 /* serialize ports if DMA is possible (for sl82c105) */
1402 IDE_HFLAG_SERIALIZE_DMA = (1 << 27),
1403 /* force host out of "simplex" mode */
1404 IDE_HFLAG_CLEAR_SIMPLEX = (1 << 28),
1405 /* DSC overlap is unsupported */
1406 IDE_HFLAG_NO_DSC = (1 << 29),
1407 /* never use 32-bit I/O ops */
1408 IDE_HFLAG_NO_IO_32BIT = (1 << 30),
1409 /* never unmask IRQs */
1410 IDE_HFLAG_NO_UNMASK_IRQS = (1 << 31),
1411 };
1412
1413 #ifdef CONFIG_BLK_DEV_OFFBOARD
1414 # define IDE_HFLAG_OFF_BOARD 0
1415 #else
1416 # define IDE_HFLAG_OFF_BOARD IDE_HFLAG_NON_BOOTABLE
1417 #endif
1418
1419 struct ide_port_info {
1420 char *name;
1421 unsigned int (*init_chipset)(struct pci_dev *);
1422 void (*init_iops)(ide_hwif_t *);
1423 void (*init_hwif)(ide_hwif_t *);
1424 int (*init_dma)(ide_hwif_t *,
1425 const struct ide_port_info *);
1426
1427 const struct ide_tp_ops *tp_ops;
1428 const struct ide_port_ops *port_ops;
1429 const struct ide_dma_ops *dma_ops;
1430
1431 ide_pci_enablebit_t enablebits[2];
1432 hwif_chipset_t chipset;
1433
1434 u16 max_sectors; /* if < than the default one */
1435
1436 u32 host_flags;
1437 u8 pio_mask;
1438 u8 swdma_mask;
1439 u8 mwdma_mask;
1440 u8 udma_mask;
1441 };
1442
1443 int ide_pci_init_one(struct pci_dev *, const struct ide_port_info *, void *);
1444 int ide_pci_init_two(struct pci_dev *, struct pci_dev *,
1445 const struct ide_port_info *, void *);
1446 void ide_pci_remove(struct pci_dev *);
1447
1448 #ifdef CONFIG_PM
1449 int ide_pci_suspend(struct pci_dev *, pm_message_t);
1450 int ide_pci_resume(struct pci_dev *);
1451 #else
1452 #define ide_pci_suspend NULL
1453 #define ide_pci_resume NULL
1454 #endif
1455
1456 void ide_map_sg(ide_drive_t *, struct request *);
1457 void ide_init_sg_cmd(ide_drive_t *, struct request *);
1458
1459 #define BAD_DMA_DRIVE 0
1460 #define GOOD_DMA_DRIVE 1
1461
1462 struct drive_list_entry {
1463 const char *id_model;
1464 const char *id_firmware;
1465 };
1466
1467 int ide_in_drive_list(u16 *, const struct drive_list_entry *);
1468
1469 #ifdef CONFIG_BLK_DEV_IDEDMA
1470 int ide_dma_good_drive(ide_drive_t *);
1471 int __ide_dma_bad_drive(ide_drive_t *);
1472 int ide_id_dma_bug(ide_drive_t *);
1473
1474 u8 ide_find_dma_mode(ide_drive_t *, u8);
1475
1476 static inline u8 ide_max_dma_mode(ide_drive_t *drive)
1477 {
1478 return ide_find_dma_mode(drive, XFER_UDMA_6);
1479 }
1480
1481 void ide_dma_off_quietly(ide_drive_t *);
1482 void ide_dma_off(ide_drive_t *);
1483 void ide_dma_on(ide_drive_t *);
1484 int ide_set_dma(ide_drive_t *);
1485 void ide_check_dma_crc(ide_drive_t *);
1486 ide_startstop_t ide_dma_intr(ide_drive_t *);
1487
1488 int ide_allocate_dma_engine(ide_hwif_t *);
1489 void ide_release_dma_engine(ide_hwif_t *);
1490
1491 int ide_build_sglist(ide_drive_t *, struct request *);
1492 void ide_destroy_dmatable(ide_drive_t *);
1493
1494 #ifdef CONFIG_BLK_DEV_IDEDMA_SFF
1495 int config_drive_for_dma(ide_drive_t *);
1496 extern int ide_build_dmatable(ide_drive_t *, struct request *);
1497 void ide_dma_host_set(ide_drive_t *, int);
1498 extern int ide_dma_setup(ide_drive_t *);
1499 void ide_dma_exec_cmd(ide_drive_t *, u8);
1500 extern void ide_dma_start(ide_drive_t *);
1501 int ide_dma_end(ide_drive_t *);
1502 int ide_dma_test_irq(ide_drive_t *);
1503 extern const struct ide_dma_ops sff_dma_ops;
1504 #else
1505 static inline int config_drive_for_dma(ide_drive_t *drive) { return 0; }
1506 #endif /* CONFIG_BLK_DEV_IDEDMA_SFF */
1507
1508 void ide_dma_lost_irq(ide_drive_t *);
1509 void ide_dma_timeout(ide_drive_t *);
1510
1511 #else
1512 static inline int ide_id_dma_bug(ide_drive_t *drive) { return 0; }
1513 static inline u8 ide_find_dma_mode(ide_drive_t *drive, u8 speed) { return 0; }
1514 static inline u8 ide_max_dma_mode(ide_drive_t *drive) { return 0; }
1515 static inline void ide_dma_off_quietly(ide_drive_t *drive) { ; }
1516 static inline void ide_dma_off(ide_drive_t *drive) { ; }
1517 static inline void ide_dma_on(ide_drive_t *drive) { ; }
1518 static inline void ide_dma_verbose(ide_drive_t *drive) { ; }
1519 static inline int ide_set_dma(ide_drive_t *drive) { return 1; }
1520 static inline void ide_check_dma_crc(ide_drive_t *drive) { ; }
1521 static inline void ide_release_dma_engine(ide_hwif_t *hwif) { ; }
1522 #endif /* CONFIG_BLK_DEV_IDEDMA */
1523
1524 #ifdef CONFIG_BLK_DEV_IDEACPI
1525 extern int ide_acpi_exec_tfs(ide_drive_t *drive);
1526 extern void ide_acpi_get_timing(ide_hwif_t *hwif);
1527 extern void ide_acpi_push_timing(ide_hwif_t *hwif);
1528 extern void ide_acpi_init(ide_hwif_t *hwif);
1529 void ide_acpi_port_init_devices(ide_hwif_t *);
1530 extern void ide_acpi_set_state(ide_hwif_t *hwif, int on);
1531 #else
1532 static inline int ide_acpi_exec_tfs(ide_drive_t *drive) { return 0; }
1533 static inline void ide_acpi_get_timing(ide_hwif_t *hwif) { ; }
1534 static inline void ide_acpi_push_timing(ide_hwif_t *hwif) { ; }
1535 static inline void ide_acpi_init(ide_hwif_t *hwif) { ; }
1536 static inline void ide_acpi_port_init_devices(ide_hwif_t *hwif) { ; }
1537 static inline void ide_acpi_set_state(ide_hwif_t *hwif, int on) {}
1538 #endif
1539
1540 void ide_remove_port_from_hwgroup(ide_hwif_t *);
1541 void ide_unregister(ide_hwif_t *);
1542
1543 void ide_register_region(struct gendisk *);
1544 void ide_unregister_region(struct gendisk *);
1545
1546 void ide_undecoded_slave(ide_drive_t *);
1547
1548 void ide_port_apply_params(ide_hwif_t *);
1549 int ide_sysfs_register_port(ide_hwif_t *);
1550
1551 struct ide_host *ide_host_alloc(const struct ide_port_info *, hw_regs_t **);
1552 void ide_host_free(struct ide_host *);
1553 int ide_host_register(struct ide_host *, const struct ide_port_info *,
1554 hw_regs_t **);
1555 int ide_host_add(const struct ide_port_info *, hw_regs_t **,
1556 struct ide_host **);
1557 void ide_host_remove(struct ide_host *);
1558 int ide_legacy_device_add(const struct ide_port_info *, unsigned long);
1559 void ide_port_unregister_devices(ide_hwif_t *);
1560 void ide_port_scan(ide_hwif_t *);
1561
1562 static inline void *ide_get_hwifdata (ide_hwif_t * hwif)
1563 {
1564 return hwif->hwif_data;
1565 }
1566
1567 static inline void ide_set_hwifdata (ide_hwif_t * hwif, void *data)
1568 {
1569 hwif->hwif_data = data;
1570 }
1571
1572 const char *ide_xfer_verbose(u8 mode);
1573 extern void ide_toggle_bounce(ide_drive_t *drive, int on);
1574 extern int ide_set_xfer_rate(ide_drive_t *drive, u8 rate);
1575
1576 u64 ide_get_lba_addr(struct ide_taskfile *, int);
1577 u8 ide_dump_status(ide_drive_t *, const char *, u8);
1578
1579 struct ide_timing {
1580 u8 mode;
1581 u8 setup; /* t1 */
1582 u16 act8b; /* t2 for 8-bit io */
1583 u16 rec8b; /* t2i for 8-bit io */
1584 u16 cyc8b; /* t0 for 8-bit io */
1585 u16 active; /* t2 or tD */
1586 u16 recover; /* t2i or tK */
1587 u16 cycle; /* t0 */
1588 u16 udma; /* t2CYCTYP/2 */
1589 };
1590
1591 enum {
1592 IDE_TIMING_SETUP = (1 << 0),
1593 IDE_TIMING_ACT8B = (1 << 1),
1594 IDE_TIMING_REC8B = (1 << 2),
1595 IDE_TIMING_CYC8B = (1 << 3),
1596 IDE_TIMING_8BIT = IDE_TIMING_ACT8B | IDE_TIMING_REC8B |
1597 IDE_TIMING_CYC8B,
1598 IDE_TIMING_ACTIVE = (1 << 4),
1599 IDE_TIMING_RECOVER = (1 << 5),
1600 IDE_TIMING_CYCLE = (1 << 6),
1601 IDE_TIMING_UDMA = (1 << 7),
1602 IDE_TIMING_ALL = IDE_TIMING_SETUP | IDE_TIMING_8BIT |
1603 IDE_TIMING_ACTIVE | IDE_TIMING_RECOVER |
1604 IDE_TIMING_CYCLE | IDE_TIMING_UDMA,
1605 };
1606
1607 struct ide_timing *ide_timing_find_mode(u8);
1608 u16 ide_pio_cycle_time(ide_drive_t *, u8);
1609 void ide_timing_merge(struct ide_timing *, struct ide_timing *,
1610 struct ide_timing *, unsigned int);
1611 int ide_timing_compute(ide_drive_t *, u8, struct ide_timing *, int, int);
1612
1613 int ide_scan_pio_blacklist(char *);
1614
1615 u8 ide_get_best_pio_mode(ide_drive_t *, u8, u8);
1616
1617 int ide_set_pio_mode(ide_drive_t *, u8);
1618 int ide_set_dma_mode(ide_drive_t *, u8);
1619
1620 void ide_set_pio(ide_drive_t *, u8);
1621
1622 static inline void ide_set_max_pio(ide_drive_t *drive)
1623 {
1624 ide_set_pio(drive, 255);
1625 }
1626
1627 extern spinlock_t ide_lock;
1628 extern struct mutex ide_cfg_mtx;
1629 /*
1630 * Structure locking:
1631 *
1632 * ide_cfg_mtx and hwgroup->lock together protect changes to
1633 * ide_hwif_t->next
1634 * ide_drive_t->next
1635 *
1636 * ide_hwgroup_t->busy: hwgroup->lock
1637 * ide_hwgroup_t->hwif: hwgroup->lock
1638 * ide_hwif_t->{hwgroup,mate}: constant, no locking
1639 * ide_drive_t->hwif: constant, no locking
1640 */
1641
1642 #define local_irq_set(flags) do { local_save_flags((flags)); local_irq_enable_in_hardirq(); } while (0)
1643
1644 char *ide_media_string(ide_drive_t *);
1645
1646 extern struct device_attribute ide_dev_attrs[];
1647 extern struct bus_type ide_bus_type;
1648 extern struct class *ide_port_class;
1649
1650 static inline void ide_dump_identify(u8 *id)
1651 {
1652 print_hex_dump(KERN_INFO, "", DUMP_PREFIX_NONE, 16, 2, id, 512, 0);
1653 }
1654
1655 static inline int hwif_to_node(ide_hwif_t *hwif)
1656 {
1657 return hwif->dev ? dev_to_node(hwif->dev) : -1;
1658 }
1659
1660 static inline ide_drive_t *ide_get_pair_dev(ide_drive_t *drive)
1661 {
1662 ide_drive_t *peer = &drive->hwif->drives[(drive->dn ^ 1) & 1];
1663
1664 return (peer->dev_flags & IDE_DFLAG_PRESENT) ? peer : NULL;
1665 }
1666 #endif /* _IDE_H */
Linux 2.6 libata-dev (mirror)