2 * Copyright (C) 1994-1998 Linus Torvalds & authors (see below)
3 * Copyright (C) 2003-2005, 2007 Bartlomiej Zolnierkiewicz
7 * Mostly written by Mark Lord <mlord@pobox.com>
8 * and Gadi Oxman <gadio@netvision.net.il>
9 * and Andre Hedrick <andre@linux-ide.org>
11 * See linux/MAINTAINERS for address of current maintainer.
13 * This is the multiple IDE interface driver, as evolved from hd.c.
14 * It supports up to MAX_HWIFS IDE interfaces, on one or more IRQs
16 * There can be up to two drives per interface, as per the ATA-2 spec.
22 * | It traverses the request-list, using interrupts to jump between functions.
23 * | As nearly all functions can be called within interrupts, we may not sleep.
24 * | Special care is recommended. Have Fun!
26 * | modified by Drew Eckhardt to check nr of hd's from the CMOS.
28 * | Thanks to Branko Lankester, lankeste@fwi.uva.nl, who found a bug
29 * | in the early extended-partition checks and added DM partitions.
31 * | Early work on error handling by Mika Liljeberg (liljeber@cs.Helsinki.FI).
33 * | IRQ-unmask, drive-id, multiple-mode, support for ">16 heads",
34 * | and general streamlining by Mark Lord (mlord@pobox.com).
36 * October, 1994 -- Complete line-by-line overhaul for linux 1.1.x, by:
38 * Mark Lord (mlord@pobox.com) (IDE Perf.Pkg)
39 * Delman Lee (delman@ieee.org) ("Mr. atdisk2")
40 * Scott Snyder (snyder@fnald0.fnal.gov) (ATAPI IDE cd-rom)
42 * This was a rewrite of just about everything from hd.c, though some original
43 * code is still sprinkled about. Think of it as a major evolution, with
44 * inspiration from lots of linux users, esp. hamish@zot.apana.org.au
47 #include <linux/module.h>
48 #include <linux/types.h>
49 #include <linux/string.h>
50 #include <linux/kernel.h>
51 #include <linux/interrupt.h>
52 #include <linux/major.h>
53 #include <linux/errno.h>
54 #include <linux/genhd.h>
55 #include <linux/slab.h>
56 #include <linux/init.h>
57 #include <linux/pci.h>
58 #include <linux/ide.h>
59 #include <linux/hdreg.h>
60 #include <linux/completion.h>
61 #include <linux/device.h>
64 /* default maximum number of failures */
65 #define IDE_DEFAULT_MAX_FAILURES 1
67 struct class *ide_port_class;
69 static const u8 ide_hwif_to_major[] = { IDE0_MAJOR, IDE1_MAJOR,
70 IDE2_MAJOR, IDE3_MAJOR,
71 IDE4_MAJOR, IDE5_MAJOR,
72 IDE6_MAJOR, IDE7_MAJOR,
73 IDE8_MAJOR, IDE9_MAJOR };
75 DEFINE_MUTEX(ide_cfg_mtx);
77 __cacheline_aligned_in_smp DEFINE_SPINLOCK(ide_lock);
78 EXPORT_SYMBOL(ide_lock);
80 static void ide_port_init_devices_data(ide_hwif_t *);
83 * Do not even *think* about calling this!
85 void ide_init_port_data(ide_hwif_t *hwif, unsigned int index)
87 /* bulk initialize hwif & drive info with zeros */
88 memset(hwif, 0, sizeof(ide_hwif_t));
90 /* fill in any non-zero initial values */
92 hwif->major = ide_hwif_to_major[index];
97 hwif->name[3] = '0' + index;
99 init_completion(&hwif->gendev_rel_comp);
101 hwif->tp_ops = &default_tp_ops;
103 ide_port_init_devices_data(hwif);
106 static void ide_port_init_devices_data(ide_hwif_t *hwif)
110 for (unit = 0; unit < MAX_DRIVES; ++unit) {
111 ide_drive_t *drive = &hwif->drives[unit];
112 u8 j = (hwif->index * MAX_DRIVES) + unit;
114 memset(drive, 0, sizeof(*drive));
116 drive->media = ide_disk;
117 drive->select.all = (unit<<4)|0xa0;
119 drive->ready_stat = ATA_DRDY;
120 drive->bad_wstat = BAD_W_STAT;
121 drive->special.b.recalibrate = 1;
122 drive->special.b.set_geometry = 1;
123 drive->name[0] = 'h';
124 drive->name[1] = 'd';
125 drive->name[2] = 'a' + j;
126 drive->max_failures = IDE_DEFAULT_MAX_FAILURES;
128 INIT_LIST_HEAD(&drive->list);
129 init_completion(&drive->gendev_rel_comp);
133 /* Called with ide_lock held. */
134 static void __ide_port_unregister_devices(ide_hwif_t *hwif)
138 for (i = 0; i < MAX_DRIVES; i++) {
139 ide_drive_t *drive = &hwif->drives[i];
141 if (drive->present) {
142 spin_unlock_irq(&ide_lock);
143 device_unregister(&drive->gendev);
144 wait_for_completion(&drive->gendev_rel_comp);
145 spin_lock_irq(&ide_lock);
150 void ide_port_unregister_devices(ide_hwif_t *hwif)
152 mutex_lock(&ide_cfg_mtx);
153 spin_lock_irq(&ide_lock);
154 __ide_port_unregister_devices(hwif);
156 ide_port_init_devices_data(hwif);
157 spin_unlock_irq(&ide_lock);
158 mutex_unlock(&ide_cfg_mtx);
160 EXPORT_SYMBOL_GPL(ide_port_unregister_devices);
163 * ide_unregister - free an IDE interface
164 * @hwif: IDE interface
166 * Perform the final unregister of an IDE interface. At the moment
167 * we don't refcount interfaces so this will also get split up.
170 * The caller must not hold the IDE locks
171 * The drive present/vanishing is not yet properly locked
172 * Take care with the callbacks. These have been split to avoid
173 * deadlocking the IDE layer. The shutdown callback is called
174 * before we take the lock and free resources. It is up to the
175 * caller to be sure there is no pending I/O here, and that
176 * the interface will not be reopened (present/vanishing locking
177 * isn't yet done BTW). After we commit to the final kill we
178 * call the cleanup callback with the ide locks held.
180 * Unregister restores the hwif structures to the default state.
181 * This is raving bonkers.
184 void ide_unregister(ide_hwif_t *hwif)
187 ide_hwgroup_t *hwgroup;
190 BUG_ON(in_interrupt());
191 BUG_ON(irqs_disabled());
193 mutex_lock(&ide_cfg_mtx);
195 spin_lock_irq(&ide_lock);
197 __ide_port_unregister_devices(hwif);
200 spin_unlock_irq(&ide_lock);
202 ide_proc_unregister_port(hwif);
204 hwgroup = hwif->hwgroup;
206 * free the irq if we were the only hwif using it
210 if (g->irq == hwif->irq)
213 } while (g != hwgroup->hwif);
215 free_irq(hwif->irq, hwgroup);
217 ide_remove_port_from_hwgroup(hwif);
219 device_unregister(hwif->portdev);
220 device_unregister(&hwif->gendev);
221 wait_for_completion(&hwif->gendev_rel_comp);
224 * Remove us from the kernel's knowledge
226 blk_unregister_region(MKDEV(hwif->major, 0), MAX_DRIVES<<PARTN_BITS);
227 kfree(hwif->sg_table);
228 unregister_blkdev(hwif->major, hwif->name);
231 ide_release_dma_engine(hwif);
233 mutex_unlock(&ide_cfg_mtx);
236 void ide_init_port_hw(ide_hwif_t *hwif, hw_regs_t *hw)
238 memcpy(&hwif->io_ports, &hw->io_ports, sizeof(hwif->io_ports));
240 hwif->chipset = hw->chipset;
242 hwif->gendev.parent = hw->parent ? hw->parent : hw->dev;
243 hwif->ack_intr = hw->ack_intr;
244 hwif->config_data = hw->config;
248 * Locks for IDE setting functionality
251 DEFINE_MUTEX(ide_setting_mtx);
254 * ide_spin_wait_hwgroup - wait for group
255 * @drive: drive in the group
257 * Wait for an IDE device group to go non busy and then return
258 * holding the ide_lock which guards the hwgroup->busy status
259 * and right to use it.
262 int ide_spin_wait_hwgroup (ide_drive_t *drive)
264 ide_hwgroup_t *hwgroup = HWGROUP(drive);
265 unsigned long timeout = jiffies + (3 * HZ);
267 spin_lock_irq(&ide_lock);
269 while (hwgroup->busy) {
270 unsigned long lflags;
271 spin_unlock_irq(&ide_lock);
272 local_irq_set(lflags);
273 if (time_after(jiffies, timeout)) {
274 local_irq_restore(lflags);
275 printk(KERN_ERR "%s: channel busy\n", drive->name);
278 local_irq_restore(lflags);
279 spin_lock_irq(&ide_lock);
284 EXPORT_SYMBOL(ide_spin_wait_hwgroup);
286 ide_devset_get(io_32bit, io_32bit);
288 int set_io_32bit(ide_drive_t *drive, int arg)
290 if (drive->no_io_32bit)
293 if (arg < 0 || arg > 1 + (SUPPORT_VLB_SYNC << 1))
296 if (ide_spin_wait_hwgroup(drive))
299 drive->io_32bit = arg;
301 spin_unlock_irq(&ide_lock);
306 ide_devset_get(ksettings, keep_settings);
308 int set_ksettings(ide_drive_t *drive, int arg)
310 if (arg < 0 || arg > 1)
313 if (ide_spin_wait_hwgroup(drive))
315 drive->keep_settings = arg;
316 spin_unlock_irq(&ide_lock);
321 ide_devset_get(using_dma, using_dma);
323 int set_using_dma(ide_drive_t *drive, int arg)
325 #ifdef CONFIG_BLK_DEV_IDEDMA
326 ide_hwif_t *hwif = drive->hwif;
329 if (arg < 0 || arg > 1)
332 if (ata_id_has_dma(drive->id) == 0)
335 if (hwif->dma_ops == NULL)
339 if (ide_spin_wait_hwgroup(drive))
342 * set ->busy flag, unlock and let it ride
344 hwif->hwgroup->busy = 1;
345 spin_unlock_irq(&ide_lock);
350 if (ide_set_dma(drive))
356 * lock, clear ->busy flag and unlock before leaving
358 spin_lock_irq(&ide_lock);
359 hwif->hwgroup->busy = 0;
360 spin_unlock_irq(&ide_lock);
364 if (arg < 0 || arg > 1)
371 int set_pio_mode(ide_drive_t *drive, int arg)
374 ide_hwif_t *hwif = drive->hwif;
375 const struct ide_port_ops *port_ops = hwif->port_ops;
377 if (arg < 0 || arg > 255)
380 if (port_ops == NULL || port_ops->set_pio_mode == NULL ||
381 (hwif->host_flags & IDE_HFLAG_NO_SET_MODE))
384 if (drive->special.b.set_tune)
387 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
388 rq->cmd_type = REQ_TYPE_ATA_TASKFILE;
390 drive->tune_req = (u8) arg;
391 drive->special.b.set_tune = 1;
393 blk_execute_rq(drive->queue, NULL, rq, 0);
399 ide_devset_get(unmaskirq, unmask);
401 int set_unmaskirq(ide_drive_t *drive, int arg)
403 if (drive->no_unmask)
406 if (arg < 0 || arg > 1)
409 if (ide_spin_wait_hwgroup(drive))
412 spin_unlock_irq(&ide_lock);
417 static int generic_ide_suspend(struct device *dev, pm_message_t mesg)
419 ide_drive_t *drive = dev->driver_data;
420 ide_hwif_t *hwif = HWIF(drive);
422 struct request_pm_state rqpm;
426 /* Call ACPI _GTM only once */
427 if (!(drive->dn % 2))
428 ide_acpi_get_timing(hwif);
430 memset(&rqpm, 0, sizeof(rqpm));
431 memset(&args, 0, sizeof(args));
432 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
433 rq->cmd_type = REQ_TYPE_PM_SUSPEND;
436 rqpm.pm_step = ide_pm_state_start_suspend;
437 if (mesg.event == PM_EVENT_PRETHAW)
438 mesg.event = PM_EVENT_FREEZE;
439 rqpm.pm_state = mesg.event;
441 ret = blk_execute_rq(drive->queue, NULL, rq, 0);
443 /* only call ACPI _PS3 after both drivers are suspended */
444 if (!ret && (((drive->dn % 2) && hwif->drives[0].present
445 && hwif->drives[1].present)
446 || !hwif->drives[0].present
447 || !hwif->drives[1].present))
448 ide_acpi_set_state(hwif, 0);
452 static int generic_ide_resume(struct device *dev)
454 ide_drive_t *drive = dev->driver_data;
455 ide_hwif_t *hwif = HWIF(drive);
457 struct request_pm_state rqpm;
461 /* Call ACPI _STM only once */
462 if (!(drive->dn % 2)) {
463 ide_acpi_set_state(hwif, 1);
464 ide_acpi_push_timing(hwif);
467 ide_acpi_exec_tfs(drive);
469 memset(&rqpm, 0, sizeof(rqpm));
470 memset(&args, 0, sizeof(args));
471 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
472 rq->cmd_type = REQ_TYPE_PM_RESUME;
473 rq->cmd_flags |= REQ_PREEMPT;
476 rqpm.pm_step = ide_pm_state_start_resume;
477 rqpm.pm_state = PM_EVENT_ON;
479 err = blk_execute_rq(drive->queue, NULL, rq, 1);
482 if (err == 0 && dev->driver) {
483 ide_driver_t *drv = to_ide_driver(dev->driver);
493 * ide_device_get - get an additional reference to a ide_drive_t
494 * @drive: device to get a reference to
496 * Gets a reference to the ide_drive_t and increments the use count of the
497 * underlying LLDD module.
499 int ide_device_get(ide_drive_t *drive)
501 struct device *host_dev;
502 struct module *module;
504 if (!get_device(&drive->gendev))
507 host_dev = drive->hwif->host->dev[0];
508 module = host_dev ? host_dev->driver->owner : NULL;
510 if (module && !try_module_get(module)) {
511 put_device(&drive->gendev);
517 EXPORT_SYMBOL_GPL(ide_device_get);
520 * ide_device_put - release a reference to a ide_drive_t
521 * @drive: device to release a reference on
523 * Release a reference to the ide_drive_t and decrements the use count of
524 * the underlying LLDD module.
526 void ide_device_put(ide_drive_t *drive)
528 #ifdef CONFIG_MODULE_UNLOAD
529 struct device *host_dev = drive->hwif->host->dev[0];
530 struct module *module = host_dev ? host_dev->driver->owner : NULL;
535 put_device(&drive->gendev);
537 EXPORT_SYMBOL_GPL(ide_device_put);
539 static int ide_bus_match(struct device *dev, struct device_driver *drv)
544 static char *media_string(ide_drive_t *drive)
546 switch (drive->media) {
562 static ssize_t media_show(struct device *dev, struct device_attribute *attr, char *buf)
564 ide_drive_t *drive = to_ide_device(dev);
565 return sprintf(buf, "%s\n", media_string(drive));
568 static ssize_t drivename_show(struct device *dev, struct device_attribute *attr, char *buf)
570 ide_drive_t *drive = to_ide_device(dev);
571 return sprintf(buf, "%s\n", drive->name);
574 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr, char *buf)
576 ide_drive_t *drive = to_ide_device(dev);
577 return sprintf(buf, "ide:m-%s\n", media_string(drive));
580 static ssize_t model_show(struct device *dev, struct device_attribute *attr,
583 ide_drive_t *drive = to_ide_device(dev);
584 return sprintf(buf, "%s\n", (char *)&drive->id[ATA_ID_PROD]);
587 static ssize_t firmware_show(struct device *dev, struct device_attribute *attr,
590 ide_drive_t *drive = to_ide_device(dev);
591 return sprintf(buf, "%s\n", (char *)&drive->id[ATA_ID_FW_REV]);
594 static ssize_t serial_show(struct device *dev, struct device_attribute *attr,
597 ide_drive_t *drive = to_ide_device(dev);
598 return sprintf(buf, "%s\n", (char *)&drive->id[ATA_ID_SERNO]);
601 static struct device_attribute ide_dev_attrs[] = {
603 __ATTR_RO(drivename),
607 __ATTR(serial, 0400, serial_show, NULL),
611 static int ide_uevent(struct device *dev, struct kobj_uevent_env *env)
613 ide_drive_t *drive = to_ide_device(dev);
615 add_uevent_var(env, "MEDIA=%s", media_string(drive));
616 add_uevent_var(env, "DRIVENAME=%s", drive->name);
617 add_uevent_var(env, "MODALIAS=ide:m-%s", media_string(drive));
621 static int generic_ide_probe(struct device *dev)
623 ide_drive_t *drive = to_ide_device(dev);
624 ide_driver_t *drv = to_ide_driver(dev->driver);
626 return drv->probe ? drv->probe(drive) : -ENODEV;
629 static int generic_ide_remove(struct device *dev)
631 ide_drive_t *drive = to_ide_device(dev);
632 ide_driver_t *drv = to_ide_driver(dev->driver);
640 static void generic_ide_shutdown(struct device *dev)
642 ide_drive_t *drive = to_ide_device(dev);
643 ide_driver_t *drv = to_ide_driver(dev->driver);
645 if (dev->driver && drv->shutdown)
646 drv->shutdown(drive);
649 struct bus_type ide_bus_type = {
651 .match = ide_bus_match,
652 .uevent = ide_uevent,
653 .probe = generic_ide_probe,
654 .remove = generic_ide_remove,
655 .shutdown = generic_ide_shutdown,
656 .dev_attrs = ide_dev_attrs,
657 .suspend = generic_ide_suspend,
658 .resume = generic_ide_resume,
661 EXPORT_SYMBOL_GPL(ide_bus_type);
664 EXPORT_SYMBOL_GPL(ide_vlb_clk);
666 module_param_named(vlb_clock, ide_vlb_clk, int, 0);
667 MODULE_PARM_DESC(vlb_clock, "VLB clock frequency (in MHz)");
670 EXPORT_SYMBOL_GPL(ide_pci_clk);
672 module_param_named(pci_clock, ide_pci_clk, int, 0);
673 MODULE_PARM_DESC(pci_clock, "PCI bus clock frequency (in MHz)");
675 static int ide_set_dev_param_mask(const char *s, struct kernel_param *kp)
678 unsigned int *dev_param_mask = (unsigned int *)kp->arg;
680 if (sscanf(s, "%d.%d:%d", &a, &b, &j) != 3 &&
681 sscanf(s, "%d.%d", &a, &b) != 2)
684 i = a * MAX_DRIVES + b;
686 if (i >= MAX_HWIFS * MAX_DRIVES || j < 0 || j > 1)
690 *dev_param_mask |= (1 << i);
692 *dev_param_mask &= (1 << i);
697 static unsigned int ide_nodma;
699 module_param_call(nodma, ide_set_dev_param_mask, NULL, &ide_nodma, 0);
700 MODULE_PARM_DESC(nodma, "disallow DMA for a device");
702 static unsigned int ide_noflush;
704 module_param_call(noflush, ide_set_dev_param_mask, NULL, &ide_noflush, 0);
705 MODULE_PARM_DESC(noflush, "disable flush requests for a device");
707 static unsigned int ide_noprobe;
709 module_param_call(noprobe, ide_set_dev_param_mask, NULL, &ide_noprobe, 0);
710 MODULE_PARM_DESC(noprobe, "skip probing for a device");
712 static unsigned int ide_nowerr;
714 module_param_call(nowerr, ide_set_dev_param_mask, NULL, &ide_nowerr, 0);
715 MODULE_PARM_DESC(nowerr, "ignore the ATA_DF bit for a device");
717 static unsigned int ide_cdroms;
719 module_param_call(cdrom, ide_set_dev_param_mask, NULL, &ide_cdroms, 0);
720 MODULE_PARM_DESC(cdrom, "force device as a CD-ROM");
728 static unsigned int ide_disks;
729 static struct chs_geom ide_disks_chs[MAX_HWIFS * MAX_DRIVES];
731 static int ide_set_disk_chs(const char *str, struct kernel_param *kp)
733 int a, b, c = 0, h = 0, s = 0, i, j = 1;
735 if (sscanf(str, "%d.%d:%d,%d,%d", &a, &b, &c, &h, &s) != 5 &&
736 sscanf(str, "%d.%d:%d", &a, &b, &j) != 3)
739 i = a * MAX_DRIVES + b;
741 if (i >= MAX_HWIFS * MAX_DRIVES || j < 0 || j > 1)
744 if (c > INT_MAX || h > 255 || s > 255)
748 ide_disks |= (1 << i);
750 ide_disks &= (1 << i);
752 ide_disks_chs[i].cyl = c;
753 ide_disks_chs[i].head = h;
754 ide_disks_chs[i].sect = s;
759 module_param_call(chs, ide_set_disk_chs, NULL, NULL, 0);
760 MODULE_PARM_DESC(chs, "force device as a disk (using CHS)");
762 static void ide_dev_apply_params(ide_drive_t *drive)
764 int i = drive->hwif->index * MAX_DRIVES + drive->select.b.unit;
766 if (ide_nodma & (1 << i)) {
767 printk(KERN_INFO "ide: disallowing DMA for %s\n", drive->name);
770 if (ide_noflush & (1 << i)) {
771 printk(KERN_INFO "ide: disabling flush requests for %s\n",
775 if (ide_noprobe & (1 << i)) {
776 printk(KERN_INFO "ide: skipping probe for %s\n", drive->name);
779 if (ide_nowerr & (1 << i)) {
780 printk(KERN_INFO "ide: ignoring the ATA_DF bit for %s\n",
782 drive->bad_wstat = BAD_R_STAT;
784 if (ide_cdroms & (1 << i)) {
785 printk(KERN_INFO "ide: forcing %s as a CD-ROM\n", drive->name);
787 drive->media = ide_cdrom;
788 /* an ATAPI device ignores DRDY */
789 drive->ready_stat = 0;
791 if (ide_disks & (1 << i)) {
792 drive->cyl = drive->bios_cyl = ide_disks_chs[i].cyl;
793 drive->head = drive->bios_head = ide_disks_chs[i].head;
794 drive->sect = drive->bios_sect = ide_disks_chs[i].sect;
795 drive->forced_geom = 1;
796 printk(KERN_INFO "ide: forcing %s as a disk (%d/%d/%d)\n",
798 drive->cyl, drive->head, drive->sect);
800 drive->media = ide_disk;
801 drive->ready_stat = ATA_DRDY;
805 static unsigned int ide_ignore_cable;
807 static int ide_set_ignore_cable(const char *s, struct kernel_param *kp)
811 if (sscanf(s, "%d:%d", &i, &j) != 2 && sscanf(s, "%d", &i) != 1)
814 if (i >= MAX_HWIFS || j < 0 || j > 1)
818 ide_ignore_cable |= (1 << i);
820 ide_ignore_cable &= (1 << i);
825 module_param_call(ignore_cable, ide_set_ignore_cable, NULL, NULL, 0);
826 MODULE_PARM_DESC(ignore_cable, "ignore cable detection");
828 void ide_port_apply_params(ide_hwif_t *hwif)
832 if (ide_ignore_cable & (1 << hwif->index)) {
833 printk(KERN_INFO "ide: ignoring cable detection for %s\n",
835 hwif->cbl = ATA_CBL_PATA40_SHORT;
838 for (i = 0; i < MAX_DRIVES; i++)
839 ide_dev_apply_params(&hwif->drives[i]);
843 * This is gets invoked once during initialization, to set *everything* up
845 static int __init ide_init(void)
849 printk(KERN_INFO "Uniform Multi-Platform E-IDE driver\n");
851 ret = bus_register(&ide_bus_type);
853 printk(KERN_WARNING "IDE: bus_register error: %d\n", ret);
857 ide_port_class = class_create(THIS_MODULE, "ide_port");
858 if (IS_ERR(ide_port_class)) {
859 ret = PTR_ERR(ide_port_class);
868 bus_unregister(&ide_bus_type);
873 static void __exit ide_exit(void)
877 class_destroy(ide_port_class);
879 bus_unregister(&ide_bus_type);
882 module_init(ide_init);
883 module_exit(ide_exit);
885 MODULE_LICENSE("GPL");