2 * omap_device implementation
4 * Copyright (C) 2009-2010 Nokia Corporation
5 * Paul Walmsley, Kevin Hilman
7 * Developed in collaboration with (alphabetical order): Benoit
8 * Cousson, Thara Gopinath, Tony Lindgren, Rajendra Nayak, Vikram
9 * Pandita, Sakari Poussa, Anand Sawant, Santosh Shilimkar, Richard
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License version 2 as
14 * published by the Free Software Foundation.
16 * This code provides a consistent interface for OMAP device drivers
17 * to control power management and interconnect properties of their
20 * In the medium- to long-term, this code should be implemented as a
21 * proper omap_bus/omap_device in Linux, no more platform_data func
28 #include <linux/kernel.h>
29 #include <linux/platform_device.h>
30 #include <linux/slab.h>
31 #include <linux/err.h>
33 #include <linux/clk.h>
34 #include <linux/clkdev.h>
35 #include <linux/pm_domain.h>
36 #include <linux/pm_runtime.h>
38 #include <linux/of_address.h>
39 #include <linux/of_irq.h>
40 #include <linux/notifier.h>
44 #include "omap_device.h"
45 #include "omap_hwmod.h"
47 /* Private functions */
49 static void _add_clkdev(struct omap_device *od, const char *clk_alias,
55 if (!clk_alias || !clk_name)
58 dev_dbg(&od->pdev->dev, "Creating %s -> %s\n", clk_alias, clk_name);
60 r = clk_get_sys(dev_name(&od->pdev->dev), clk_alias);
62 dev_dbg(&od->pdev->dev,
63 "alias %s already exists\n", clk_alias);
68 r = clk_get_sys(NULL, clk_name);
71 struct of_phandle_args clkspec;
73 clkspec.np = of_find_node_by_name(NULL, clk_name);
75 r = of_clk_get_from_provider(&clkspec);
77 rc = clk_register_clkdev(r, clk_alias,
78 dev_name(&od->pdev->dev));
80 rc = clk_add_alias(clk_alias, dev_name(&od->pdev->dev),
85 if (rc == -ENODEV || rc == -ENOMEM)
86 dev_err(&od->pdev->dev,
87 "clkdev_alloc for %s failed\n", clk_alias);
89 dev_err(&od->pdev->dev,
90 "clk_get for %s failed\n", clk_name);
95 * _add_hwmod_clocks_clkdev - Add clkdev entry for hwmod optional clocks
97 * @od: struct omap_device *od
98 * @oh: struct omap_hwmod *oh
100 * For the main clock and every optional clock present per hwmod per
101 * omap_device, this function adds an entry in the clkdev table of the
102 * form <dev-id=dev_name, con-id=role> if it does not exist already.
104 * The function is called from inside omap_device_build_ss(), after
105 * omap_device_register.
107 * This allows drivers to get a pointer to its optional clocks based on its role
108 * by calling clk_get(<dev*>, <role>).
109 * In the case of the main clock, a "fck" alias is used.
113 static void _add_hwmod_clocks_clkdev(struct omap_device *od,
114 struct omap_hwmod *oh)
118 _add_clkdev(od, "fck", oh->main_clk);
120 for (i = 0; i < oh->opt_clks_cnt; i++)
121 _add_clkdev(od, oh->opt_clks[i].role, oh->opt_clks[i].clk);
126 * omap_device_build_from_dt - build an omap_device with multiple hwmods
127 * @pdev_name: name of the platform_device driver to use
128 * @pdev_id: this platform_device's connection ID
129 * @oh: ptr to the single omap_hwmod that backs this omap_device
130 * @pdata: platform_data ptr to associate with the platform_device
131 * @pdata_len: amount of memory pointed to by @pdata
133 * Function for building an omap_device already registered from device-tree
135 * Returns 0 or PTR_ERR() on error.
137 static int omap_device_build_from_dt(struct platform_device *pdev)
139 struct omap_hwmod **hwmods;
140 struct omap_device *od;
141 struct omap_hwmod *oh;
142 struct device_node *node = pdev->dev.of_node;
145 int oh_cnt, i, ret = 0;
146 bool device_active = false, skip_pm_domain = false;
148 oh_cnt = of_property_count_strings(node, "ti,hwmods");
150 dev_dbg(&pdev->dev, "No 'hwmods' to build omap_device\n");
154 /* SDMA still needs special handling for omap_device_build() */
155 ret = of_property_read_string_index(node, "ti,hwmods", 0, &oh_name);
156 if (!ret && (!strncmp("dma_system", oh_name, 10) ||
157 !strncmp("dma", oh_name, 3)))
158 skip_pm_domain = true;
160 /* Use ti-sysc driver instead of omap_device? */
161 if (!skip_pm_domain &&
162 !omap_hwmod_parse_module_range(NULL, node, &res))
165 hwmods = kcalloc(oh_cnt, sizeof(struct omap_hwmod *), GFP_KERNEL);
171 for (i = 0; i < oh_cnt; i++) {
172 of_property_read_string_index(node, "ti,hwmods", i, &oh_name);
173 oh = omap_hwmod_lookup(oh_name);
175 dev_err(&pdev->dev, "Cannot lookup hwmod '%s'\n",
181 if (oh->flags & HWMOD_INIT_NO_IDLE)
182 device_active = true;
185 od = omap_device_alloc(pdev, hwmods, oh_cnt);
187 dev_err(&pdev->dev, "Cannot allocate omap_device for :%s\n",
193 /* Fix up missing resource names */
194 for (i = 0; i < pdev->num_resources; i++) {
195 struct resource *r = &pdev->resource[i];
198 r->name = dev_name(&pdev->dev);
201 if (!skip_pm_domain) {
202 dev_pm_domain_set(&pdev->dev, &omap_device_pm_domain);
204 omap_device_enable(pdev);
205 pm_runtime_set_active(&pdev->dev);
212 /* if data/we are at fault.. load up a fail handler */
214 dev_pm_domain_set(&pdev->dev, &omap_device_fail_pm_domain);
219 static int _omap_device_notifier_call(struct notifier_block *nb,
220 unsigned long event, void *dev)
222 struct platform_device *pdev = to_platform_device(dev);
223 struct omap_device *od;
227 case BUS_NOTIFY_REMOVED_DEVICE:
228 if (pdev->archdata.od)
229 omap_device_delete(pdev->archdata.od);
231 case BUS_NOTIFY_UNBOUND_DRIVER:
232 od = to_omap_device(pdev);
233 if (od && (od->_state == OMAP_DEVICE_STATE_ENABLED)) {
234 dev_info(dev, "enabled after unload, idling\n");
235 err = omap_device_idle(pdev);
237 dev_err(dev, "failed to idle\n");
240 case BUS_NOTIFY_BIND_DRIVER:
241 od = to_omap_device(pdev);
243 od->_driver_status = BUS_NOTIFY_BIND_DRIVER;
244 if (od->_state == OMAP_DEVICE_STATE_ENABLED &&
245 pm_runtime_status_suspended(dev)) {
246 pm_runtime_set_active(dev);
250 case BUS_NOTIFY_ADD_DEVICE:
251 if (pdev->dev.of_node)
252 omap_device_build_from_dt(pdev);
253 omap_auxdata_legacy_init(dev);
256 od = to_omap_device(pdev);
258 od->_driver_status = event;
265 * _omap_device_enable_hwmods - call omap_hwmod_enable() on all hwmods
266 * @od: struct omap_device *od
268 * Enable all underlying hwmods. Returns 0.
270 static int _omap_device_enable_hwmods(struct omap_device *od)
275 for (i = 0; i < od->hwmods_cnt; i++)
276 ret |= omap_hwmod_enable(od->hwmods[i]);
282 * _omap_device_idle_hwmods - call omap_hwmod_idle() on all hwmods
283 * @od: struct omap_device *od
285 * Idle all underlying hwmods. Returns 0.
287 static int _omap_device_idle_hwmods(struct omap_device *od)
292 for (i = 0; i < od->hwmods_cnt; i++)
293 ret |= omap_hwmod_idle(od->hwmods[i]);
298 /* Public functions for use by core code */
301 * omap_device_get_context_loss_count - get lost context count
302 * @od: struct omap_device *
304 * Using the primary hwmod, query the context loss count for this
307 * Callers should consider context for this device lost any time this
308 * function returns a value different than the value the caller got
309 * the last time it called this function.
311 * If any hwmods exist for the omap_device associated with @pdev,
312 * return the context loss counter for that hwmod, otherwise return
315 int omap_device_get_context_loss_count(struct platform_device *pdev)
317 struct omap_device *od;
320 od = to_omap_device(pdev);
323 ret = omap_hwmod_get_context_loss_count(od->hwmods[0]);
329 * omap_device_alloc - allocate an omap_device
330 * @pdev: platform_device that will be included in this omap_device
331 * @oh: ptr to the single omap_hwmod that backs this omap_device
332 * @pdata: platform_data ptr to associate with the platform_device
333 * @pdata_len: amount of memory pointed to by @pdata
335 * Convenience function for allocating an omap_device structure and filling
336 * hwmods, and resources.
338 * Returns an struct omap_device pointer or ERR_PTR() on error;
340 struct omap_device *omap_device_alloc(struct platform_device *pdev,
341 struct omap_hwmod **ohs, int oh_cnt)
344 struct omap_device *od;
346 struct omap_hwmod **hwmods;
348 od = kzalloc(sizeof(struct omap_device), GFP_KERNEL);
353 od->hwmods_cnt = oh_cnt;
355 hwmods = kmemdup(ohs, sizeof(struct omap_hwmod *) * oh_cnt, GFP_KERNEL);
361 pdev->archdata.od = od;
363 for (i = 0; i < oh_cnt; i++) {
365 _add_hwmod_clocks_clkdev(od, hwmods[i]);
373 dev_err(&pdev->dev, "omap_device: build failed (%d)\n", ret);
378 void omap_device_delete(struct omap_device *od)
383 od->pdev->archdata.od = NULL;
389 * omap_device_copy_resources - Add legacy IO and IRQ resources
390 * @oh: interconnect target module
391 * @pdev: platform device to copy resources to
393 * We still have legacy DMA and smartreflex needing resources.
394 * Let's populate what they need until we can eventually just
395 * remove this function. Note that there should be no need to
396 * call this from omap_device_build_from_dt(), nor should there
397 * be any need to call it for other devices.
400 omap_device_copy_resources(struct omap_hwmod *oh,
401 struct platform_device *pdev)
403 struct device_node *np, *child;
404 struct property *prop;
405 struct resource *res;
409 if (!oh || !oh->od || !oh->od->pdev)
412 np = oh->od->pdev->dev.of_node;
418 res = kcalloc(2, sizeof(*res), GFP_KERNEL);
422 /* Do we have a dts range for the interconnect target module? */
423 error = omap_hwmod_parse_module_range(oh, np, res);
425 /* No ranges, rely on device reg entry */
427 error = of_address_to_resource(np, 0, res);
431 /* SmartReflex needs first IO resource name to be "mpu" */
435 * We may have a configured "ti,sysc" interconnect target with a
436 * dts child with the interrupt. If so use the first child's
437 * first interrupt for "ti-hwmods" legacy support.
439 of_property_for_each_string(np, "compatible", prop, name)
440 if (!strncmp("ti,sysc-", name, 8))
443 child = of_get_next_available_child(np, NULL);
446 irq = irq_of_parse_and_map(child, 0);
448 irq = irq_of_parse_and_map(np, 0);
454 /* Legacy DMA code needs interrupt name to be "0" */
457 res[1].flags = IORESOURCE_IRQ;
460 error = platform_device_add_resources(pdev, res, 2);
466 WARN(error, "%s: %s device %s failed: %i\n",
467 __func__, oh->name, dev_name(&pdev->dev),
474 * omap_device_build - build and register an omap_device with one omap_hwmod
475 * @pdev_name: name of the platform_device driver to use
476 * @pdev_id: this platform_device's connection ID
477 * @oh: ptr to the single omap_hwmod that backs this omap_device
478 * @pdata: platform_data ptr to associate with the platform_device
479 * @pdata_len: amount of memory pointed to by @pdata
481 * Convenience function for building and registering a single
482 * omap_device record, which in turn builds and registers a
483 * platform_device record. See omap_device_build_ss() for more
484 * information. Returns ERR_PTR(-EINVAL) if @oh is NULL; otherwise,
485 * passes along the return value of omap_device_build_ss().
487 struct platform_device __init *omap_device_build(const char *pdev_name,
489 struct omap_hwmod *oh,
490 void *pdata, int pdata_len)
493 struct platform_device *pdev;
494 struct omap_device *od;
496 if (!oh || !pdev_name)
497 return ERR_PTR(-EINVAL);
499 if (!pdata && pdata_len > 0)
500 return ERR_PTR(-EINVAL);
502 if (strncmp(oh->name, "smartreflex", 11) &&
503 strncmp(oh->name, "dma", 3)) {
504 pr_warn("%s need to update %s to probe with dt\na",
505 __func__, pdev_name);
510 pdev = platform_device_alloc(pdev_name, pdev_id);
516 /* Set the dev_name early to allow dev_xxx in omap_device_alloc */
518 dev_set_name(&pdev->dev, "%s.%d", pdev->name, pdev->id);
520 dev_set_name(&pdev->dev, "%s", pdev->name);
523 * Must be called before omap_device_alloc() as oh->od
524 * only contains the currently registered omap_device
525 * and will get overwritten by omap_device_alloc().
527 ret = omap_device_copy_resources(oh, pdev);
531 od = omap_device_alloc(pdev, &oh, 1);
537 ret = platform_device_add_data(pdev, pdata, pdata_len);
541 ret = omap_device_register(pdev);
548 omap_device_delete(od);
550 platform_device_put(pdev);
553 pr_err("omap_device: %s: build failed (%d)\n", pdev_name, ret);
559 static int _od_runtime_suspend(struct device *dev)
561 struct platform_device *pdev = to_platform_device(dev);
564 ret = pm_generic_runtime_suspend(dev);
568 return omap_device_idle(pdev);
571 static int _od_runtime_resume(struct device *dev)
573 struct platform_device *pdev = to_platform_device(dev);
576 ret = omap_device_enable(pdev);
578 dev_err(dev, "use pm_runtime_put_sync_suspend() in driver?\n");
582 return pm_generic_runtime_resume(dev);
585 static int _od_fail_runtime_suspend(struct device *dev)
587 dev_warn(dev, "%s: FIXME: missing hwmod/omap_dev info\n", __func__);
591 static int _od_fail_runtime_resume(struct device *dev)
593 dev_warn(dev, "%s: FIXME: missing hwmod/omap_dev info\n", __func__);
599 #ifdef CONFIG_SUSPEND
600 static int _od_suspend_noirq(struct device *dev)
602 struct platform_device *pdev = to_platform_device(dev);
603 struct omap_device *od = to_omap_device(pdev);
606 /* Don't attempt late suspend on a driver that is not bound */
607 if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER)
610 ret = pm_generic_suspend_noirq(dev);
612 if (!ret && !pm_runtime_status_suspended(dev)) {
613 if (pm_generic_runtime_suspend(dev) == 0) {
614 omap_device_idle(pdev);
615 od->flags |= OMAP_DEVICE_SUSPENDED;
622 static int _od_resume_noirq(struct device *dev)
624 struct platform_device *pdev = to_platform_device(dev);
625 struct omap_device *od = to_omap_device(pdev);
627 if (od->flags & OMAP_DEVICE_SUSPENDED) {
628 od->flags &= ~OMAP_DEVICE_SUSPENDED;
629 omap_device_enable(pdev);
630 pm_generic_runtime_resume(dev);
633 return pm_generic_resume_noirq(dev);
636 #define _od_suspend_noirq NULL
637 #define _od_resume_noirq NULL
640 struct dev_pm_domain omap_device_fail_pm_domain = {
642 SET_RUNTIME_PM_OPS(_od_fail_runtime_suspend,
643 _od_fail_runtime_resume, NULL)
647 struct dev_pm_domain omap_device_pm_domain = {
649 SET_RUNTIME_PM_OPS(_od_runtime_suspend, _od_runtime_resume,
651 USE_PLATFORM_PM_SLEEP_OPS
652 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(_od_suspend_noirq,
658 * omap_device_register - register an omap_device with one omap_hwmod
659 * @od: struct omap_device * to register
661 * Register the omap_device structure. This currently just calls
662 * platform_device_register() on the underlying platform_device.
663 * Returns the return value of platform_device_register().
665 int omap_device_register(struct platform_device *pdev)
667 pr_debug("omap_device: %s: registering\n", pdev->name);
669 dev_pm_domain_set(&pdev->dev, &omap_device_pm_domain);
670 return platform_device_add(pdev);
674 /* Public functions for use by device drivers through struct platform_data */
677 * omap_device_enable - fully activate an omap_device
678 * @od: struct omap_device * to activate
680 * Do whatever is necessary for the hwmods underlying omap_device @od
681 * to be accessible and ready to operate. This generally involves
682 * enabling clocks, setting SYSCONFIG registers; and in the future may
683 * involve remuxing pins. Device drivers should call this function
684 * indirectly via pm_runtime_get*(). Returns -EINVAL if called when
685 * the omap_device is already enabled, or passes along the return
686 * value of _omap_device_enable_hwmods().
688 int omap_device_enable(struct platform_device *pdev)
691 struct omap_device *od;
693 od = to_omap_device(pdev);
695 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
697 "omap_device: %s() called from invalid state %d\n",
698 __func__, od->_state);
702 ret = _omap_device_enable_hwmods(od);
705 od->_state = OMAP_DEVICE_STATE_ENABLED;
711 * omap_device_idle - idle an omap_device
712 * @od: struct omap_device * to idle
714 * Idle omap_device @od. Device drivers call this function indirectly
715 * via pm_runtime_put*(). Returns -EINVAL if the omap_device is not
716 * currently enabled, or passes along the return value of
717 * _omap_device_idle_hwmods().
719 int omap_device_idle(struct platform_device *pdev)
722 struct omap_device *od;
724 od = to_omap_device(pdev);
726 if (od->_state != OMAP_DEVICE_STATE_ENABLED) {
728 "omap_device: %s() called from invalid state %d\n",
729 __func__, od->_state);
733 ret = _omap_device_idle_hwmods(od);
736 od->_state = OMAP_DEVICE_STATE_IDLE;
742 * omap_device_assert_hardreset - set a device's hardreset line
743 * @pdev: struct platform_device * to reset
744 * @name: const char * name of the reset line
746 * Set the hardreset line identified by @name on the IP blocks
747 * associated with the hwmods backing the platform_device @pdev. All
748 * of the hwmods associated with @pdev must have the same hardreset
749 * line linked to them for this to work. Passes along the return value
750 * of omap_hwmod_assert_hardreset() in the event of any failure, or
751 * returns 0 upon success.
753 int omap_device_assert_hardreset(struct platform_device *pdev, const char *name)
755 struct omap_device *od = to_omap_device(pdev);
759 for (i = 0; i < od->hwmods_cnt; i++) {
760 ret = omap_hwmod_assert_hardreset(od->hwmods[i], name);
769 * omap_device_deassert_hardreset - release a device's hardreset line
770 * @pdev: struct platform_device * to reset
771 * @name: const char * name of the reset line
773 * Release the hardreset line identified by @name on the IP blocks
774 * associated with the hwmods backing the platform_device @pdev. All
775 * of the hwmods associated with @pdev must have the same hardreset
776 * line linked to them for this to work. Passes along the return
777 * value of omap_hwmod_deassert_hardreset() in the event of any
778 * failure, or returns 0 upon success.
780 int omap_device_deassert_hardreset(struct platform_device *pdev,
783 struct omap_device *od = to_omap_device(pdev);
787 for (i = 0; i < od->hwmods_cnt; i++) {
788 ret = omap_hwmod_deassert_hardreset(od->hwmods[i], name);
797 * omap_device_get_by_hwmod_name() - convert a hwmod name to
799 * @oh_name: name of the hwmod device
801 * Returns back a struct device * pointer associated with a hwmod
802 * device represented by a hwmod_name
804 struct device *omap_device_get_by_hwmod_name(const char *oh_name)
806 struct omap_hwmod *oh;
809 WARN(1, "%s: no hwmod name!\n", __func__);
810 return ERR_PTR(-EINVAL);
813 oh = omap_hwmod_lookup(oh_name);
815 WARN(1, "%s: no hwmod for %s\n", __func__,
817 return ERR_PTR(-ENODEV);
820 WARN(1, "%s: no omap_device for %s\n", __func__,
822 return ERR_PTR(-ENODEV);
825 return &oh->od->pdev->dev;
828 static struct notifier_block platform_nb = {
829 .notifier_call = _omap_device_notifier_call,
832 static int __init omap_device_init(void)
834 bus_register_notifier(&platform_bus_type, &platform_nb);
837 omap_postcore_initcall(omap_device_init);
840 * omap_device_late_idle - idle devices without drivers
841 * @dev: struct device * associated with omap_device
844 * Check the driver bound status of this device, and idle it
845 * if there is no driver attached.
847 static int __init omap_device_late_idle(struct device *dev, void *data)
849 struct platform_device *pdev = to_platform_device(dev);
850 struct omap_device *od = to_omap_device(pdev);
857 * If omap_device state is enabled, but has no driver bound,
862 * Some devices (like memory controllers) are always kept
863 * enabled, and should not be idled even with no drivers.
865 for (i = 0; i < od->hwmods_cnt; i++)
866 if (od->hwmods[i]->flags & HWMOD_INIT_NO_IDLE)
869 if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER &&
870 od->_driver_status != BUS_NOTIFY_BIND_DRIVER) {
871 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
872 dev_warn(dev, "%s: enabled but no driver. Idling\n",
874 omap_device_idle(pdev);
881 static int __init omap_device_late_init(void)
883 bus_for_each_dev(&platform_bus_type, NULL, NULL, omap_device_late_idle);
887 omap_late_initcall_sync(omap_device_late_init);