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);
253 ide_devset_get(io_32bit, io_32bit);
255 static int set_io_32bit(ide_drive_t *drive, int arg)
257 if (drive->no_io_32bit)
260 if (arg < 0 || arg > 1 + (SUPPORT_VLB_SYNC << 1))
263 drive->io_32bit = arg;
268 ide_devset_get(ksettings, keep_settings);
270 static int set_ksettings(ide_drive_t *drive, int arg)
272 if (arg < 0 || arg > 1)
275 drive->keep_settings = arg;
280 ide_devset_get(using_dma, using_dma);
282 static int set_using_dma(ide_drive_t *drive, int arg)
284 #ifdef CONFIG_BLK_DEV_IDEDMA
287 if (arg < 0 || arg > 1)
290 if (ata_id_has_dma(drive->id) == 0)
293 if (drive->hwif->dma_ops == NULL)
299 if (ide_set_dma(drive))
307 if (arg < 0 || arg > 1)
314 static int set_pio_mode(ide_drive_t *drive, int arg)
317 ide_hwif_t *hwif = drive->hwif;
318 const struct ide_port_ops *port_ops = hwif->port_ops;
320 if (arg < 0 || arg > 255)
323 if (port_ops == NULL || port_ops->set_pio_mode == NULL ||
324 (hwif->host_flags & IDE_HFLAG_NO_SET_MODE))
327 if (drive->special.b.set_tune)
330 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
331 rq->cmd_type = REQ_TYPE_ATA_TASKFILE;
333 drive->tune_req = (u8) arg;
334 drive->special.b.set_tune = 1;
336 blk_execute_rq(drive->queue, NULL, rq, 0);
342 ide_devset_get(unmaskirq, unmask);
344 static int set_unmaskirq(ide_drive_t *drive, int arg)
346 if (drive->no_unmask)
349 if (arg < 0 || arg > 1)
357 #define ide_gen_devset_rw(_name, _func) \
358 __IDE_DEVSET(_name, DS_SYNC, get_##_func, set_##_func)
360 ide_gen_devset_rw(io_32bit, io_32bit);
361 ide_gen_devset_rw(keepsettings, ksettings);
362 ide_gen_devset_rw(unmaskirq, unmaskirq);
363 ide_gen_devset_rw(using_dma, using_dma);
364 __IDE_DEVSET(pio_mode, 0, NULL, set_pio_mode);
366 static int generic_ide_suspend(struct device *dev, pm_message_t mesg)
368 ide_drive_t *drive = dev->driver_data, *pair = ide_get_pair_dev(drive);
369 ide_hwif_t *hwif = HWIF(drive);
371 struct request_pm_state rqpm;
375 /* call ACPI _GTM only once */
376 if ((drive->dn & 1) == 0 || pair == NULL)
377 ide_acpi_get_timing(hwif);
379 memset(&rqpm, 0, sizeof(rqpm));
380 memset(&args, 0, sizeof(args));
381 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
382 rq->cmd_type = REQ_TYPE_PM_SUSPEND;
385 rqpm.pm_step = ide_pm_state_start_suspend;
386 if (mesg.event == PM_EVENT_PRETHAW)
387 mesg.event = PM_EVENT_FREEZE;
388 rqpm.pm_state = mesg.event;
390 ret = blk_execute_rq(drive->queue, NULL, rq, 0);
393 /* call ACPI _PS3 only after both devices are suspended */
394 if (ret == 0 && ((drive->dn & 1) || pair == NULL))
395 ide_acpi_set_state(hwif, 0);
400 static int generic_ide_resume(struct device *dev)
402 ide_drive_t *drive = dev->driver_data, *pair = ide_get_pair_dev(drive);
403 ide_hwif_t *hwif = HWIF(drive);
405 struct request_pm_state rqpm;
409 /* call ACPI _PS0 / _STM only once */
410 if ((drive->dn & 1) == 0 || pair == NULL) {
411 ide_acpi_set_state(hwif, 1);
412 ide_acpi_push_timing(hwif);
415 ide_acpi_exec_tfs(drive);
417 memset(&rqpm, 0, sizeof(rqpm));
418 memset(&args, 0, sizeof(args));
419 rq = blk_get_request(drive->queue, READ, __GFP_WAIT);
420 rq->cmd_type = REQ_TYPE_PM_RESUME;
421 rq->cmd_flags |= REQ_PREEMPT;
424 rqpm.pm_step = ide_pm_state_start_resume;
425 rqpm.pm_state = PM_EVENT_ON;
427 err = blk_execute_rq(drive->queue, NULL, rq, 1);
430 if (err == 0 && dev->driver) {
431 ide_driver_t *drv = to_ide_driver(dev->driver);
441 * ide_device_get - get an additional reference to a ide_drive_t
442 * @drive: device to get a reference to
444 * Gets a reference to the ide_drive_t and increments the use count of the
445 * underlying LLDD module.
447 int ide_device_get(ide_drive_t *drive)
449 struct device *host_dev;
450 struct module *module;
452 if (!get_device(&drive->gendev))
455 host_dev = drive->hwif->host->dev[0];
456 module = host_dev ? host_dev->driver->owner : NULL;
458 if (module && !try_module_get(module)) {
459 put_device(&drive->gendev);
465 EXPORT_SYMBOL_GPL(ide_device_get);
468 * ide_device_put - release a reference to a ide_drive_t
469 * @drive: device to release a reference on
471 * Release a reference to the ide_drive_t and decrements the use count of
472 * the underlying LLDD module.
474 void ide_device_put(ide_drive_t *drive)
476 #ifdef CONFIG_MODULE_UNLOAD
477 struct device *host_dev = drive->hwif->host->dev[0];
478 struct module *module = host_dev ? host_dev->driver->owner : NULL;
483 put_device(&drive->gendev);
485 EXPORT_SYMBOL_GPL(ide_device_put);
487 static int ide_bus_match(struct device *dev, struct device_driver *drv)
492 static char *media_string(ide_drive_t *drive)
494 switch (drive->media) {
510 static ssize_t media_show(struct device *dev, struct device_attribute *attr, char *buf)
512 ide_drive_t *drive = to_ide_device(dev);
513 return sprintf(buf, "%s\n", media_string(drive));
516 static ssize_t drivename_show(struct device *dev, struct device_attribute *attr, char *buf)
518 ide_drive_t *drive = to_ide_device(dev);
519 return sprintf(buf, "%s\n", drive->name);
522 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr, char *buf)
524 ide_drive_t *drive = to_ide_device(dev);
525 return sprintf(buf, "ide:m-%s\n", media_string(drive));
528 static ssize_t model_show(struct device *dev, struct device_attribute *attr,
531 ide_drive_t *drive = to_ide_device(dev);
532 return sprintf(buf, "%s\n", (char *)&drive->id[ATA_ID_PROD]);
535 static ssize_t firmware_show(struct device *dev, struct device_attribute *attr,
538 ide_drive_t *drive = to_ide_device(dev);
539 return sprintf(buf, "%s\n", (char *)&drive->id[ATA_ID_FW_REV]);
542 static ssize_t serial_show(struct device *dev, struct device_attribute *attr,
545 ide_drive_t *drive = to_ide_device(dev);
546 return sprintf(buf, "%s\n", (char *)&drive->id[ATA_ID_SERNO]);
549 static struct device_attribute ide_dev_attrs[] = {
551 __ATTR_RO(drivename),
555 __ATTR(serial, 0400, serial_show, NULL),
559 static int ide_uevent(struct device *dev, struct kobj_uevent_env *env)
561 ide_drive_t *drive = to_ide_device(dev);
563 add_uevent_var(env, "MEDIA=%s", media_string(drive));
564 add_uevent_var(env, "DRIVENAME=%s", drive->name);
565 add_uevent_var(env, "MODALIAS=ide:m-%s", media_string(drive));
569 static int generic_ide_probe(struct device *dev)
571 ide_drive_t *drive = to_ide_device(dev);
572 ide_driver_t *drv = to_ide_driver(dev->driver);
574 return drv->probe ? drv->probe(drive) : -ENODEV;
577 static int generic_ide_remove(struct device *dev)
579 ide_drive_t *drive = to_ide_device(dev);
580 ide_driver_t *drv = to_ide_driver(dev->driver);
588 static void generic_ide_shutdown(struct device *dev)
590 ide_drive_t *drive = to_ide_device(dev);
591 ide_driver_t *drv = to_ide_driver(dev->driver);
593 if (dev->driver && drv->shutdown)
594 drv->shutdown(drive);
597 struct bus_type ide_bus_type = {
599 .match = ide_bus_match,
600 .uevent = ide_uevent,
601 .probe = generic_ide_probe,
602 .remove = generic_ide_remove,
603 .shutdown = generic_ide_shutdown,
604 .dev_attrs = ide_dev_attrs,
605 .suspend = generic_ide_suspend,
606 .resume = generic_ide_resume,
609 EXPORT_SYMBOL_GPL(ide_bus_type);
612 EXPORT_SYMBOL_GPL(ide_vlb_clk);
614 module_param_named(vlb_clock, ide_vlb_clk, int, 0);
615 MODULE_PARM_DESC(vlb_clock, "VLB clock frequency (in MHz)");
618 EXPORT_SYMBOL_GPL(ide_pci_clk);
620 module_param_named(pci_clock, ide_pci_clk, int, 0);
621 MODULE_PARM_DESC(pci_clock, "PCI bus clock frequency (in MHz)");
623 static int ide_set_dev_param_mask(const char *s, struct kernel_param *kp)
626 unsigned int *dev_param_mask = (unsigned int *)kp->arg;
628 if (sscanf(s, "%d.%d:%d", &a, &b, &j) != 3 &&
629 sscanf(s, "%d.%d", &a, &b) != 2)
632 i = a * MAX_DRIVES + b;
634 if (i >= MAX_HWIFS * MAX_DRIVES || j < 0 || j > 1)
638 *dev_param_mask |= (1 << i);
640 *dev_param_mask &= (1 << i);
645 static unsigned int ide_nodma;
647 module_param_call(nodma, ide_set_dev_param_mask, NULL, &ide_nodma, 0);
648 MODULE_PARM_DESC(nodma, "disallow DMA for a device");
650 static unsigned int ide_noflush;
652 module_param_call(noflush, ide_set_dev_param_mask, NULL, &ide_noflush, 0);
653 MODULE_PARM_DESC(noflush, "disable flush requests for a device");
655 static unsigned int ide_noprobe;
657 module_param_call(noprobe, ide_set_dev_param_mask, NULL, &ide_noprobe, 0);
658 MODULE_PARM_DESC(noprobe, "skip probing for a device");
660 static unsigned int ide_nowerr;
662 module_param_call(nowerr, ide_set_dev_param_mask, NULL, &ide_nowerr, 0);
663 MODULE_PARM_DESC(nowerr, "ignore the ATA_DF bit for a device");
665 static unsigned int ide_cdroms;
667 module_param_call(cdrom, ide_set_dev_param_mask, NULL, &ide_cdroms, 0);
668 MODULE_PARM_DESC(cdrom, "force device as a CD-ROM");
676 static unsigned int ide_disks;
677 static struct chs_geom ide_disks_chs[MAX_HWIFS * MAX_DRIVES];
679 static int ide_set_disk_chs(const char *str, struct kernel_param *kp)
681 int a, b, c = 0, h = 0, s = 0, i, j = 1;
683 if (sscanf(str, "%d.%d:%d,%d,%d", &a, &b, &c, &h, &s) != 5 &&
684 sscanf(str, "%d.%d:%d", &a, &b, &j) != 3)
687 i = a * MAX_DRIVES + b;
689 if (i >= MAX_HWIFS * MAX_DRIVES || j < 0 || j > 1)
692 if (c > INT_MAX || h > 255 || s > 255)
696 ide_disks |= (1 << i);
698 ide_disks &= (1 << i);
700 ide_disks_chs[i].cyl = c;
701 ide_disks_chs[i].head = h;
702 ide_disks_chs[i].sect = s;
707 module_param_call(chs, ide_set_disk_chs, NULL, NULL, 0);
708 MODULE_PARM_DESC(chs, "force device as a disk (using CHS)");
710 static void ide_dev_apply_params(ide_drive_t *drive)
712 int i = drive->hwif->index * MAX_DRIVES + drive->select.b.unit;
714 if (ide_nodma & (1 << i)) {
715 printk(KERN_INFO "ide: disallowing DMA for %s\n", drive->name);
718 if (ide_noflush & (1 << i)) {
719 printk(KERN_INFO "ide: disabling flush requests for %s\n",
723 if (ide_noprobe & (1 << i)) {
724 printk(KERN_INFO "ide: skipping probe for %s\n", drive->name);
727 if (ide_nowerr & (1 << i)) {
728 printk(KERN_INFO "ide: ignoring the ATA_DF bit for %s\n",
730 drive->bad_wstat = BAD_R_STAT;
732 if (ide_cdroms & (1 << i)) {
733 printk(KERN_INFO "ide: forcing %s as a CD-ROM\n", drive->name);
735 drive->media = ide_cdrom;
736 /* an ATAPI device ignores DRDY */
737 drive->ready_stat = 0;
739 if (ide_disks & (1 << i)) {
740 drive->cyl = drive->bios_cyl = ide_disks_chs[i].cyl;
741 drive->head = drive->bios_head = ide_disks_chs[i].head;
742 drive->sect = drive->bios_sect = ide_disks_chs[i].sect;
743 drive->forced_geom = 1;
744 printk(KERN_INFO "ide: forcing %s as a disk (%d/%d/%d)\n",
746 drive->cyl, drive->head, drive->sect);
748 drive->media = ide_disk;
749 drive->ready_stat = ATA_DRDY;
753 static unsigned int ide_ignore_cable;
755 static int ide_set_ignore_cable(const char *s, struct kernel_param *kp)
759 if (sscanf(s, "%d:%d", &i, &j) != 2 && sscanf(s, "%d", &i) != 1)
762 if (i >= MAX_HWIFS || j < 0 || j > 1)
766 ide_ignore_cable |= (1 << i);
768 ide_ignore_cable &= (1 << i);
773 module_param_call(ignore_cable, ide_set_ignore_cable, NULL, NULL, 0);
774 MODULE_PARM_DESC(ignore_cable, "ignore cable detection");
776 void ide_port_apply_params(ide_hwif_t *hwif)
780 if (ide_ignore_cable & (1 << hwif->index)) {
781 printk(KERN_INFO "ide: ignoring cable detection for %s\n",
783 hwif->cbl = ATA_CBL_PATA40_SHORT;
786 for (i = 0; i < MAX_DRIVES; i++)
787 ide_dev_apply_params(&hwif->drives[i]);
791 * This is gets invoked once during initialization, to set *everything* up
793 static int __init ide_init(void)
797 printk(KERN_INFO "Uniform Multi-Platform E-IDE driver\n");
799 ret = bus_register(&ide_bus_type);
801 printk(KERN_WARNING "IDE: bus_register error: %d\n", ret);
805 ide_port_class = class_create(THIS_MODULE, "ide_port");
806 if (IS_ERR(ide_port_class)) {
807 ret = PTR_ERR(ide_port_class);
816 bus_unregister(&ide_bus_type);
821 static void __exit ide_exit(void)
825 class_destroy(ide_port_class);
827 bus_unregister(&ide_bus_type);
830 module_init(ide_init);
831 module_exit(ide_exit);
833 MODULE_LICENSE("GPL");