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