2 * linux/arch/arm/common/amba.c
4 * Copyright (C) 2003 Deep Blue Solutions Ltd, All Rights Reserved.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
10 #include <linux/module.h>
11 #include <linux/init.h>
12 #include <linux/device.h>
13 #include <linux/string.h>
14 #include <linux/slab.h>
17 #include <linux/pm_runtime.h>
18 #include <linux/amba/bus.h>
21 #include <asm/sizes.h>
23 #define to_amba_driver(d) container_of(d, struct amba_driver, drv)
25 static const struct amba_id *
26 amba_lookup(const struct amba_id *table, struct amba_device *dev)
31 ret = (dev->periphid & table->mask) == table->id;
37 return ret ? table : NULL;
40 static int amba_match(struct device *dev, struct device_driver *drv)
42 struct amba_device *pcdev = to_amba_device(dev);
43 struct amba_driver *pcdrv = to_amba_driver(drv);
45 return amba_lookup(pcdrv->id_table, pcdev) != NULL;
49 static int amba_uevent(struct device *dev, struct kobj_uevent_env *env)
51 struct amba_device *pcdev = to_amba_device(dev);
54 retval = add_uevent_var(env, "AMBA_ID=%08x", pcdev->periphid);
58 #define amba_uevent NULL
61 #define amba_attr_func(name,fmt,arg...) \
62 static ssize_t name##_show(struct device *_dev, \
63 struct device_attribute *attr, char *buf) \
65 struct amba_device *dev = to_amba_device(_dev); \
66 return sprintf(buf, fmt, arg); \
69 #define amba_attr(name,fmt,arg...) \
70 amba_attr_func(name,fmt,arg) \
71 static DEVICE_ATTR(name, S_IRUGO, name##_show, NULL)
73 amba_attr_func(id, "%08x\n", dev->periphid);
74 amba_attr(irq0, "%u\n", dev->irq[0]);
75 amba_attr(irq1, "%u\n", dev->irq[1]);
76 amba_attr_func(resource, "\t%016llx\t%016llx\t%016lx\n",
77 (unsigned long long)dev->res.start, (unsigned long long)dev->res.end,
80 static struct device_attribute amba_dev_attrs[] = {
86 #ifdef CONFIG_PM_SLEEP
88 static int amba_legacy_suspend(struct device *dev, pm_message_t mesg)
90 struct amba_driver *adrv = to_amba_driver(dev->driver);
91 struct amba_device *adev = to_amba_device(dev);
94 if (dev->driver && adrv->suspend)
95 ret = adrv->suspend(adev, mesg);
100 static int amba_legacy_resume(struct device *dev)
102 struct amba_driver *adrv = to_amba_driver(dev->driver);
103 struct amba_device *adev = to_amba_device(dev);
106 if (dev->driver && adrv->resume)
107 ret = adrv->resume(adev);
112 static int amba_pm_prepare(struct device *dev)
114 struct device_driver *drv = dev->driver;
117 if (drv && drv->pm && drv->pm->prepare)
118 ret = drv->pm->prepare(dev);
123 static void amba_pm_complete(struct device *dev)
125 struct device_driver *drv = dev->driver;
127 if (drv && drv->pm && drv->pm->complete)
128 drv->pm->complete(dev);
131 #else /* !CONFIG_PM_SLEEP */
133 #define amba_pm_prepare NULL
134 #define amba_pm_complete NULL
136 #endif /* !CONFIG_PM_SLEEP */
138 #ifdef CONFIG_SUSPEND
140 static int amba_pm_suspend(struct device *dev)
142 struct device_driver *drv = dev->driver;
149 if (drv->pm->suspend)
150 ret = drv->pm->suspend(dev);
152 ret = amba_legacy_suspend(dev, PMSG_SUSPEND);
158 static int amba_pm_suspend_noirq(struct device *dev)
160 struct device_driver *drv = dev->driver;
167 if (drv->pm->suspend_noirq)
168 ret = drv->pm->suspend_noirq(dev);
174 static int amba_pm_resume(struct device *dev)
176 struct device_driver *drv = dev->driver;
184 ret = drv->pm->resume(dev);
186 ret = amba_legacy_resume(dev);
192 static int amba_pm_resume_noirq(struct device *dev)
194 struct device_driver *drv = dev->driver;
201 if (drv->pm->resume_noirq)
202 ret = drv->pm->resume_noirq(dev);
208 #else /* !CONFIG_SUSPEND */
210 #define amba_pm_suspend NULL
211 #define amba_pm_resume NULL
212 #define amba_pm_suspend_noirq NULL
213 #define amba_pm_resume_noirq NULL
215 #endif /* !CONFIG_SUSPEND */
217 #ifdef CONFIG_HIBERNATE_CALLBACKS
219 static int amba_pm_freeze(struct device *dev)
221 struct device_driver *drv = dev->driver;
229 ret = drv->pm->freeze(dev);
231 ret = amba_legacy_suspend(dev, PMSG_FREEZE);
237 static int amba_pm_freeze_noirq(struct device *dev)
239 struct device_driver *drv = dev->driver;
246 if (drv->pm->freeze_noirq)
247 ret = drv->pm->freeze_noirq(dev);
253 static int amba_pm_thaw(struct device *dev)
255 struct device_driver *drv = dev->driver;
263 ret = drv->pm->thaw(dev);
265 ret = amba_legacy_resume(dev);
271 static int amba_pm_thaw_noirq(struct device *dev)
273 struct device_driver *drv = dev->driver;
280 if (drv->pm->thaw_noirq)
281 ret = drv->pm->thaw_noirq(dev);
287 static int amba_pm_poweroff(struct device *dev)
289 struct device_driver *drv = dev->driver;
296 if (drv->pm->poweroff)
297 ret = drv->pm->poweroff(dev);
299 ret = amba_legacy_suspend(dev, PMSG_HIBERNATE);
305 static int amba_pm_poweroff_noirq(struct device *dev)
307 struct device_driver *drv = dev->driver;
314 if (drv->pm->poweroff_noirq)
315 ret = drv->pm->poweroff_noirq(dev);
321 static int amba_pm_restore(struct device *dev)
323 struct device_driver *drv = dev->driver;
330 if (drv->pm->restore)
331 ret = drv->pm->restore(dev);
333 ret = amba_legacy_resume(dev);
339 static int amba_pm_restore_noirq(struct device *dev)
341 struct device_driver *drv = dev->driver;
348 if (drv->pm->restore_noirq)
349 ret = drv->pm->restore_noirq(dev);
355 #else /* !CONFIG_HIBERNATE_CALLBACKS */
357 #define amba_pm_freeze NULL
358 #define amba_pm_thaw NULL
359 #define amba_pm_poweroff NULL
360 #define amba_pm_restore NULL
361 #define amba_pm_freeze_noirq NULL
362 #define amba_pm_thaw_noirq NULL
363 #define amba_pm_poweroff_noirq NULL
364 #define amba_pm_restore_noirq NULL
366 #endif /* !CONFIG_HIBERNATE_CALLBACKS */
368 #ifdef CONFIG_PM_RUNTIME
370 * Hooks to provide runtime PM of the pclk (bus clock). It is safe to
371 * enable/disable the bus clock at runtime PM suspend/resume as this
372 * does not result in loss of context. However, disabling vcore power
373 * would do, so we leave that to the driver.
375 static int amba_pm_runtime_suspend(struct device *dev)
377 struct amba_device *pcdev = to_amba_device(dev);
378 int ret = pm_generic_runtime_suspend(dev);
380 if (ret == 0 && dev->driver)
381 clk_disable(pcdev->pclk);
386 static int amba_pm_runtime_resume(struct device *dev)
388 struct amba_device *pcdev = to_amba_device(dev);
392 ret = clk_enable(pcdev->pclk);
393 /* Failure is probably fatal to the system, but... */
398 return pm_generic_runtime_resume(dev);
404 static const struct dev_pm_ops amba_pm = {
405 .prepare = amba_pm_prepare,
406 .complete = amba_pm_complete,
407 .suspend = amba_pm_suspend,
408 .resume = amba_pm_resume,
409 .freeze = amba_pm_freeze,
410 .thaw = amba_pm_thaw,
411 .poweroff = amba_pm_poweroff,
412 .restore = amba_pm_restore,
413 .suspend_noirq = amba_pm_suspend_noirq,
414 .resume_noirq = amba_pm_resume_noirq,
415 .freeze_noirq = amba_pm_freeze_noirq,
416 .thaw_noirq = amba_pm_thaw_noirq,
417 .poweroff_noirq = amba_pm_poweroff_noirq,
418 .restore_noirq = amba_pm_restore_noirq,
420 amba_pm_runtime_suspend,
421 amba_pm_runtime_resume,
422 pm_generic_runtime_idle
426 #define AMBA_PM (&amba_pm)
428 #else /* !CONFIG_PM */
432 #endif /* !CONFIG_PM */
435 * Primecells are part of the Advanced Microcontroller Bus Architecture,
436 * so we call the bus "amba".
438 struct bus_type amba_bustype = {
440 .dev_attrs = amba_dev_attrs,
442 .uevent = amba_uevent,
446 static int __init amba_init(void)
448 return bus_register(&amba_bustype);
451 postcore_initcall(amba_init);
453 static int amba_get_enable_pclk(struct amba_device *pcdev)
455 struct clk *pclk = clk_get(&pcdev->dev, "apb_pclk");
461 return PTR_ERR(pclk);
463 ret = clk_prepare(pclk);
469 ret = clk_enable(pclk);
478 static void amba_put_disable_pclk(struct amba_device *pcdev)
480 struct clk *pclk = pcdev->pclk;
487 static int amba_get_enable_vcore(struct amba_device *pcdev)
489 struct regulator *vcore = regulator_get(&pcdev->dev, "vcore");
492 pcdev->vcore = vcore;
495 /* It is OK not to supply a vcore regulator */
496 if (PTR_ERR(vcore) == -ENODEV)
498 return PTR_ERR(vcore);
501 ret = regulator_enable(vcore);
503 regulator_put(vcore);
504 pcdev->vcore = ERR_PTR(-ENODEV);
510 static void amba_put_disable_vcore(struct amba_device *pcdev)
512 struct regulator *vcore = pcdev->vcore;
514 if (!IS_ERR(vcore)) {
515 regulator_disable(vcore);
516 regulator_put(vcore);
521 * These are the device model conversion veneers; they convert the
522 * device model structures to our more specific structures.
524 static int amba_probe(struct device *dev)
526 struct amba_device *pcdev = to_amba_device(dev);
527 struct amba_driver *pcdrv = to_amba_driver(dev->driver);
528 const struct amba_id *id = amba_lookup(pcdrv->id_table, pcdev);
532 ret = amba_get_enable_vcore(pcdev);
536 ret = amba_get_enable_pclk(pcdev);
540 pm_runtime_get_noresume(dev);
541 pm_runtime_set_active(dev);
542 pm_runtime_enable(dev);
544 ret = pcdrv->probe(pcdev, id);
548 pm_runtime_disable(dev);
549 pm_runtime_set_suspended(dev);
550 pm_runtime_put_noidle(dev);
552 amba_put_disable_pclk(pcdev);
553 amba_put_disable_vcore(pcdev);
559 static int amba_remove(struct device *dev)
561 struct amba_device *pcdev = to_amba_device(dev);
562 struct amba_driver *drv = to_amba_driver(dev->driver);
565 pm_runtime_get_sync(dev);
566 ret = drv->remove(pcdev);
567 pm_runtime_put_noidle(dev);
569 /* Undo the runtime PM settings in amba_probe() */
570 pm_runtime_disable(dev);
571 pm_runtime_set_suspended(dev);
572 pm_runtime_put_noidle(dev);
574 amba_put_disable_pclk(pcdev);
575 amba_put_disable_vcore(pcdev);
580 static void amba_shutdown(struct device *dev)
582 struct amba_driver *drv = to_amba_driver(dev->driver);
583 drv->shutdown(to_amba_device(dev));
587 * amba_driver_register - register an AMBA device driver
588 * @drv: amba device driver structure
590 * Register an AMBA device driver with the Linux device model
591 * core. If devices pre-exist, the drivers probe function will
594 int amba_driver_register(struct amba_driver *drv)
596 drv->drv.bus = &amba_bustype;
598 #define SETFN(fn) if (drv->fn) drv->drv.fn = amba_##fn
603 return driver_register(&drv->drv);
607 * amba_driver_unregister - remove an AMBA device driver
608 * @drv: AMBA device driver structure to remove
610 * Unregister an AMBA device driver from the Linux device
611 * model. The device model will call the drivers remove function
612 * for each device the device driver is currently handling.
614 void amba_driver_unregister(struct amba_driver *drv)
616 driver_unregister(&drv->drv);
620 static void amba_device_release(struct device *dev)
622 struct amba_device *d = to_amba_device(dev);
625 release_resource(&d->res);
630 * amba_device_register - register an AMBA device
631 * @dev: AMBA device to register
632 * @parent: parent memory resource
634 * Setup the AMBA device, reading the cell ID if present.
635 * Claim the resource, and register the AMBA device with
636 * the Linux device manager.
638 int amba_device_register(struct amba_device *dev, struct resource *parent)
644 device_initialize(&dev->dev);
647 * Copy from device_add
649 if (dev->dev.init_name) {
650 dev_set_name(&dev->dev, "%s", dev->dev.init_name);
651 dev->dev.init_name = NULL;
654 dev->dev.release = amba_device_release;
655 dev->dev.bus = &amba_bustype;
656 dev->dev.dma_mask = &dev->dma_mask;
657 dev->res.name = dev_name(&dev->dev);
659 if (!dev->dev.coherent_dma_mask && dev->dma_mask)
660 dev_warn(&dev->dev, "coherent dma mask is unset\n");
662 ret = request_resource(parent, &dev->res);
666 /* Hard-coded primecell ID instead of plug-n-play */
667 if (dev->periphid != 0)
671 * Dynamically calculate the size of the resource
672 * and use this for iomap
674 size = resource_size(&dev->res);
675 tmp = ioremap(dev->res.start, size);
681 ret = amba_get_enable_pclk(dev);
686 * Read pid and cid based on size of resource
687 * they are located at end of region
689 for (pid = 0, i = 0; i < 4; i++)
690 pid |= (readl(tmp + size - 0x20 + 4 * i) & 255) <<
692 for (cid = 0, i = 0; i < 4; i++)
693 cid |= (readl(tmp + size - 0x10 + 4 * i) & 255) <<
696 amba_put_disable_pclk(dev);
711 ret = device_add(&dev->dev);
715 if (dev->irq[0] != NO_IRQ)
716 ret = device_create_file(&dev->dev, &dev_attr_irq0);
717 if (ret == 0 && dev->irq[1] != NO_IRQ)
718 ret = device_create_file(&dev->dev, &dev_attr_irq1);
722 device_unregister(&dev->dev);
725 release_resource(&dev->res);
731 * amba_device_unregister - unregister an AMBA device
732 * @dev: AMBA device to remove
734 * Remove the specified AMBA device from the Linux device
735 * manager. All files associated with this object will be
736 * destroyed, and device drivers notified that the device has
737 * been removed. The AMBA device's resources including
738 * the amba_device structure will be freed once all
739 * references to it have been dropped.
741 void amba_device_unregister(struct amba_device *dev)
743 device_unregister(&dev->dev);
748 struct amba_device *dev;
749 struct device *parent;
755 static int amba_find_match(struct device *dev, void *data)
757 struct find_data *d = data;
758 struct amba_device *pcdev = to_amba_device(dev);
761 r = (pcdev->periphid & d->mask) == d->id;
763 r &= d->parent == dev->parent;
765 r &= strcmp(dev_name(dev), d->busid) == 0;
776 * amba_find_device - locate an AMBA device given a bus id
777 * @busid: bus id for device (or NULL)
778 * @parent: parent device (or NULL)
779 * @id: peripheral ID (or 0)
780 * @mask: peripheral ID mask (or 0)
782 * Return the AMBA device corresponding to the supplied parameters.
783 * If no device matches, returns NULL.
785 * NOTE: When a valid device is found, its refcount is
786 * incremented, and must be decremented before the returned
790 amba_find_device(const char *busid, struct device *parent, unsigned int id,
793 struct find_data data;
796 data.parent = parent;
801 bus_for_each_dev(&amba_bustype, NULL, &data, amba_find_match);
807 * amba_request_regions - request all mem regions associated with device
808 * @dev: amba_device structure for device
809 * @name: name, or NULL to use driver name
811 int amba_request_regions(struct amba_device *dev, const char *name)
817 name = dev->dev.driver->name;
819 size = resource_size(&dev->res);
821 if (!request_mem_region(dev->res.start, size, name))
828 * amba_release_regions - release mem regions associated with device
829 * @dev: amba_device structure for device
831 * Release regions claimed by a successful call to amba_request_regions.
833 void amba_release_regions(struct amba_device *dev)
837 size = resource_size(&dev->res);
838 release_mem_region(dev->res.start, size);
841 EXPORT_SYMBOL(amba_driver_register);
842 EXPORT_SYMBOL(amba_driver_unregister);
843 EXPORT_SYMBOL(amba_device_register);
844 EXPORT_SYMBOL(amba_device_unregister);
845 EXPORT_SYMBOL(amba_find_device);
846 EXPORT_SYMBOL(amba_request_regions);
847 EXPORT_SYMBOL(amba_release_regions);