]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blob - include/linux/ide.h
projects / mirror_ubuntu-artful-kernel.git / blob
? search:


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