1 // SPDX-License-Identifier: GPL-2.0-only
3 * omap_device implementation
5 * Copyright (C) 2009-2010 Nokia Corporation
6 * Paul Walmsley, Kevin Hilman
8 * Developed in collaboration with (alphabetical order): Benoit
9 * Cousson, Thara Gopinath, Tony Lindgren, Rajendra Nayak, Vikram
10 * Pandita, Sakari Poussa, Anand Sawant, Santosh Shilimkar, Richard
13 * This code provides a consistent interface for OMAP device drivers
14 * to control power management and interconnect properties of their
17 * In the medium- to long-term, this code should be implemented as a
18 * proper omap_bus/omap_device in Linux, no more platform_data func
23 #include <linux/kernel.h>
24 #include <linux/platform_device.h>
25 #include <linux/slab.h>
26 #include <linux/err.h>
28 #include <linux/clk.h>
29 #include <linux/clkdev.h>
30 #include <linux/pm_domain.h>
31 #include <linux/pm_runtime.h>
33 #include <linux/of_address.h>
34 #include <linux/of_irq.h>
35 #include <linux/notifier.h>
39 #include "omap_device.h"
40 #include "omap_hwmod.h"
42 /* Private functions */
44 static void _add_clkdev(struct omap_device *od, const char *clk_alias,
50 if (!clk_alias || !clk_name)
53 dev_dbg(&od->pdev->dev, "Creating %s -> %s\n", clk_alias, clk_name);
55 r = clk_get_sys(dev_name(&od->pdev->dev), clk_alias);
57 dev_dbg(&od->pdev->dev,
58 "alias %s already exists\n", clk_alias);
63 r = clk_get_sys(NULL, clk_name);
66 struct of_phandle_args clkspec;
68 clkspec.np = of_find_node_by_name(NULL, clk_name);
70 r = of_clk_get_from_provider(&clkspec);
72 rc = clk_register_clkdev(r, clk_alias,
73 dev_name(&od->pdev->dev));
75 rc = clk_add_alias(clk_alias, dev_name(&od->pdev->dev),
80 if (rc == -ENODEV || rc == -ENOMEM)
81 dev_err(&od->pdev->dev,
82 "clkdev_alloc for %s failed\n", clk_alias);
84 dev_err(&od->pdev->dev,
85 "clk_get for %s failed\n", clk_name);
90 * _add_hwmod_clocks_clkdev - Add clkdev entry for hwmod optional clocks
92 * @od: struct omap_device *od
93 * @oh: struct omap_hwmod *oh
95 * For the main clock and every optional clock present per hwmod per
96 * omap_device, this function adds an entry in the clkdev table of the
97 * form <dev-id=dev_name, con-id=role> if it does not exist already.
99 * This allows drivers to get a pointer to its optional clocks based on its role
100 * by calling clk_get(<dev*>, <role>).
101 * In the case of the main clock, a "fck" alias is used.
105 static void _add_hwmod_clocks_clkdev(struct omap_device *od,
106 struct omap_hwmod *oh)
110 _add_clkdev(od, "fck", oh->main_clk);
112 for (i = 0; i < oh->opt_clks_cnt; i++)
113 _add_clkdev(od, oh->opt_clks[i].role, oh->opt_clks[i].clk);
118 * omap_device_build_from_dt - build an omap_device with multiple hwmods
119 * @pdev: The platform device to update.
121 * Function for building an omap_device already registered from device-tree
123 * Returns 0 or PTR_ERR() on error.
125 static int omap_device_build_from_dt(struct platform_device *pdev)
127 struct omap_hwmod **hwmods;
128 struct omap_device *od;
129 struct omap_hwmod *oh;
130 struct device_node *node = pdev->dev.of_node;
133 int oh_cnt, i, ret = 0;
134 bool device_active = false, skip_pm_domain = false;
136 oh_cnt = of_property_count_strings(node, "ti,hwmods");
138 dev_dbg(&pdev->dev, "No 'hwmods' to build omap_device\n");
142 /* SDMA still needs special handling for omap_device_build() */
143 ret = of_property_read_string_index(node, "ti,hwmods", 0, &oh_name);
144 if (!ret && (!strncmp("dma_system", oh_name, 10) ||
145 !strncmp("dma", oh_name, 3)))
146 skip_pm_domain = true;
148 /* Use ti-sysc driver instead of omap_device? */
149 if (!skip_pm_domain &&
150 !omap_hwmod_parse_module_range(NULL, node, &res))
153 hwmods = kcalloc(oh_cnt, sizeof(struct omap_hwmod *), GFP_KERNEL);
159 for (i = 0; i < oh_cnt; i++) {
160 of_property_read_string_index(node, "ti,hwmods", i, &oh_name);
161 oh = omap_hwmod_lookup(oh_name);
163 dev_err(&pdev->dev, "Cannot lookup hwmod '%s'\n",
169 if (oh->flags & HWMOD_INIT_NO_IDLE)
170 device_active = true;
173 od = omap_device_alloc(pdev, hwmods, oh_cnt);
175 dev_err(&pdev->dev, "Cannot allocate omap_device for :%s\n",
181 /* Fix up missing resource names */
182 for (i = 0; i < pdev->num_resources; i++) {
183 struct resource *r = &pdev->resource[i];
186 r->name = dev_name(&pdev->dev);
189 if (!skip_pm_domain) {
190 dev_pm_domain_set(&pdev->dev, &omap_device_pm_domain);
192 omap_device_enable(pdev);
193 pm_runtime_set_active(&pdev->dev);
200 /* if data/we are at fault.. load up a fail handler */
202 dev_pm_domain_set(&pdev->dev, &omap_device_fail_pm_domain);
207 static int _omap_device_notifier_call(struct notifier_block *nb,
208 unsigned long event, void *dev)
210 struct platform_device *pdev = to_platform_device(dev);
211 struct omap_device *od;
215 case BUS_NOTIFY_REMOVED_DEVICE:
216 if (pdev->archdata.od)
217 omap_device_delete(pdev->archdata.od);
219 case BUS_NOTIFY_UNBOUND_DRIVER:
220 od = to_omap_device(pdev);
221 if (od && (od->_state == OMAP_DEVICE_STATE_ENABLED)) {
222 dev_info(dev, "enabled after unload, idling\n");
223 err = omap_device_idle(pdev);
225 dev_err(dev, "failed to idle\n");
228 case BUS_NOTIFY_BIND_DRIVER:
229 od = to_omap_device(pdev);
231 od->_driver_status = BUS_NOTIFY_BIND_DRIVER;
232 if (od->_state == OMAP_DEVICE_STATE_ENABLED &&
233 pm_runtime_status_suspended(dev)) {
234 pm_runtime_set_active(dev);
238 case BUS_NOTIFY_ADD_DEVICE:
239 if (pdev->dev.of_node)
240 omap_device_build_from_dt(pdev);
241 omap_auxdata_legacy_init(dev);
244 od = to_omap_device(pdev);
246 od->_driver_status = event;
253 * _omap_device_enable_hwmods - call omap_hwmod_enable() on all hwmods
254 * @od: struct omap_device *od
256 * Enable all underlying hwmods. Returns 0.
258 static int _omap_device_enable_hwmods(struct omap_device *od)
263 for (i = 0; i < od->hwmods_cnt; i++)
264 ret |= omap_hwmod_enable(od->hwmods[i]);
270 * _omap_device_idle_hwmods - call omap_hwmod_idle() on all hwmods
271 * @od: struct omap_device *od
273 * Idle all underlying hwmods. Returns 0.
275 static int _omap_device_idle_hwmods(struct omap_device *od)
280 for (i = 0; i < od->hwmods_cnt; i++)
281 ret |= omap_hwmod_idle(od->hwmods[i]);
286 /* Public functions for use by core code */
289 * omap_device_get_context_loss_count - get lost context count
290 * @pdev: The platform device to update.
292 * Using the primary hwmod, query the context loss count for this
295 * Callers should consider context for this device lost any time this
296 * function returns a value different than the value the caller got
297 * the last time it called this function.
299 * If any hwmods exist for the omap_device associated with @pdev,
300 * return the context loss counter for that hwmod, otherwise return
303 int omap_device_get_context_loss_count(struct platform_device *pdev)
305 struct omap_device *od;
308 od = to_omap_device(pdev);
311 ret = omap_hwmod_get_context_loss_count(od->hwmods[0]);
317 * omap_device_alloc - allocate an omap_device
318 * @pdev: platform_device that will be included in this omap_device
319 * @ohs: ptr to the omap_hwmod for this omap_device
320 * @oh_cnt: the size of the ohs list
322 * Convenience function for allocating an omap_device structure and filling
323 * hwmods, and resources.
325 * Returns an struct omap_device pointer or ERR_PTR() on error;
327 struct omap_device *omap_device_alloc(struct platform_device *pdev,
328 struct omap_hwmod **ohs, int oh_cnt)
331 struct omap_device *od;
333 struct omap_hwmod **hwmods;
335 od = kzalloc(sizeof(struct omap_device), GFP_KERNEL);
339 od->hwmods_cnt = oh_cnt;
341 hwmods = kmemdup(ohs, sizeof(struct omap_hwmod *) * oh_cnt, GFP_KERNEL);
347 pdev->archdata.od = od;
349 for (i = 0; i < oh_cnt; i++) {
351 _add_hwmod_clocks_clkdev(od, hwmods[i]);
359 dev_err(&pdev->dev, "omap_device: build failed (%d)\n", ret);
364 void omap_device_delete(struct omap_device *od)
369 od->pdev->archdata.od = NULL;
375 static int _od_runtime_suspend(struct device *dev)
377 struct platform_device *pdev = to_platform_device(dev);
380 ret = pm_generic_runtime_suspend(dev);
384 return omap_device_idle(pdev);
387 static int _od_runtime_resume(struct device *dev)
389 struct platform_device *pdev = to_platform_device(dev);
392 ret = omap_device_enable(pdev);
394 dev_err(dev, "use pm_runtime_put_sync_suspend() in driver?\n");
398 return pm_generic_runtime_resume(dev);
401 static int _od_fail_runtime_suspend(struct device *dev)
403 dev_warn(dev, "%s: FIXME: missing hwmod/omap_dev info\n", __func__);
407 static int _od_fail_runtime_resume(struct device *dev)
409 dev_warn(dev, "%s: FIXME: missing hwmod/omap_dev info\n", __func__);
415 #ifdef CONFIG_SUSPEND
416 static int _od_suspend_noirq(struct device *dev)
418 struct platform_device *pdev = to_platform_device(dev);
419 struct omap_device *od = to_omap_device(pdev);
422 /* Don't attempt late suspend on a driver that is not bound */
423 if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER)
426 ret = pm_generic_suspend_noirq(dev);
428 if (!ret && !pm_runtime_status_suspended(dev)) {
429 if (pm_generic_runtime_suspend(dev) == 0) {
430 omap_device_idle(pdev);
431 od->flags |= OMAP_DEVICE_SUSPENDED;
438 static int _od_resume_noirq(struct device *dev)
440 struct platform_device *pdev = to_platform_device(dev);
441 struct omap_device *od = to_omap_device(pdev);
443 if (od->flags & OMAP_DEVICE_SUSPENDED) {
444 od->flags &= ~OMAP_DEVICE_SUSPENDED;
445 omap_device_enable(pdev);
446 pm_generic_runtime_resume(dev);
449 return pm_generic_resume_noirq(dev);
452 #define _od_suspend_noirq NULL
453 #define _od_resume_noirq NULL
456 struct dev_pm_domain omap_device_fail_pm_domain = {
458 SET_RUNTIME_PM_OPS(_od_fail_runtime_suspend,
459 _od_fail_runtime_resume, NULL)
463 struct dev_pm_domain omap_device_pm_domain = {
465 SET_RUNTIME_PM_OPS(_od_runtime_suspend, _od_runtime_resume,
467 USE_PLATFORM_PM_SLEEP_OPS
468 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(_od_suspend_noirq,
473 /* Public functions for use by device drivers through struct platform_data */
476 * omap_device_enable - fully activate an omap_device
477 * @pdev: the platform device to activate
479 * Do whatever is necessary for the hwmods underlying omap_device @od
480 * to be accessible and ready to operate. This generally involves
481 * enabling clocks, setting SYSCONFIG registers; and in the future may
482 * involve remuxing pins. Device drivers should call this function
483 * indirectly via pm_runtime_get*(). Returns -EINVAL if called when
484 * the omap_device is already enabled, or passes along the return
485 * value of _omap_device_enable_hwmods().
487 int omap_device_enable(struct platform_device *pdev)
490 struct omap_device *od;
492 od = to_omap_device(pdev);
494 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
496 "omap_device: %s() called from invalid state %d\n",
497 __func__, od->_state);
501 ret = _omap_device_enable_hwmods(od);
504 od->_state = OMAP_DEVICE_STATE_ENABLED;
510 * omap_device_idle - idle an omap_device
511 * @pdev: The platform_device (omap_device) to idle
513 * Idle omap_device @od. Device drivers call this function indirectly
514 * via pm_runtime_put*(). Returns -EINVAL if the omap_device is not
515 * currently enabled, or passes along the return value of
516 * _omap_device_idle_hwmods().
518 int omap_device_idle(struct platform_device *pdev)
521 struct omap_device *od;
523 od = to_omap_device(pdev);
525 if (od->_state != OMAP_DEVICE_STATE_ENABLED) {
527 "omap_device: %s() called from invalid state %d\n",
528 __func__, od->_state);
532 ret = _omap_device_idle_hwmods(od);
535 od->_state = OMAP_DEVICE_STATE_IDLE;
541 * omap_device_assert_hardreset - set a device's hardreset line
542 * @pdev: struct platform_device * to reset
543 * @name: const char * name of the reset line
545 * Set the hardreset line identified by @name on the IP blocks
546 * associated with the hwmods backing the platform_device @pdev. All
547 * of the hwmods associated with @pdev must have the same hardreset
548 * line linked to them for this to work. Passes along the return value
549 * of omap_hwmod_assert_hardreset() in the event of any failure, or
550 * returns 0 upon success.
552 int omap_device_assert_hardreset(struct platform_device *pdev, const char *name)
554 struct omap_device *od = to_omap_device(pdev);
558 for (i = 0; i < od->hwmods_cnt; i++) {
559 ret = omap_hwmod_assert_hardreset(od->hwmods[i], name);
568 * omap_device_deassert_hardreset - release a device's hardreset line
569 * @pdev: struct platform_device * to reset
570 * @name: const char * name of the reset line
572 * Release the hardreset line identified by @name on the IP blocks
573 * associated with the hwmods backing the platform_device @pdev. All
574 * of the hwmods associated with @pdev must have the same hardreset
575 * line linked to them for this to work. Passes along the return
576 * value of omap_hwmod_deassert_hardreset() in the event of any
577 * failure, or returns 0 upon success.
579 int omap_device_deassert_hardreset(struct platform_device *pdev,
582 struct omap_device *od = to_omap_device(pdev);
586 for (i = 0; i < od->hwmods_cnt; i++) {
587 ret = omap_hwmod_deassert_hardreset(od->hwmods[i], name);
596 * omap_device_get_by_hwmod_name() - convert a hwmod name to
598 * @oh_name: name of the hwmod device
600 * Returns back a struct device * pointer associated with a hwmod
601 * device represented by a hwmod_name
603 struct device *omap_device_get_by_hwmod_name(const char *oh_name)
605 struct omap_hwmod *oh;
608 WARN(1, "%s: no hwmod name!\n", __func__);
609 return ERR_PTR(-EINVAL);
612 oh = omap_hwmod_lookup(oh_name);
614 WARN(1, "%s: no hwmod for %s\n", __func__,
616 return ERR_PTR(-ENODEV);
619 WARN(1, "%s: no omap_device for %s\n", __func__,
621 return ERR_PTR(-ENODEV);
624 return &oh->od->pdev->dev;
627 static struct notifier_block platform_nb = {
628 .notifier_call = _omap_device_notifier_call,
631 static int __init omap_device_init(void)
633 bus_register_notifier(&platform_bus_type, &platform_nb);
636 omap_postcore_initcall(omap_device_init);
639 * omap_device_late_idle - idle devices without drivers
640 * @dev: struct device * associated with omap_device
643 * Check the driver bound status of this device, and idle it
644 * if there is no driver attached.
646 static int __init omap_device_late_idle(struct device *dev, void *data)
648 struct platform_device *pdev = to_platform_device(dev);
649 struct omap_device *od = to_omap_device(pdev);
656 * If omap_device state is enabled, but has no driver bound,
661 * Some devices (like memory controllers) are always kept
662 * enabled, and should not be idled even with no drivers.
664 for (i = 0; i < od->hwmods_cnt; i++)
665 if (od->hwmods[i]->flags & HWMOD_INIT_NO_IDLE)
668 if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER &&
669 od->_driver_status != BUS_NOTIFY_BIND_DRIVER) {
670 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
671 dev_warn(dev, "%s: enabled but no driver. Idling\n",
673 omap_device_idle(pdev);
680 static int __init omap_device_late_init(void)
682 bus_for_each_dev(&platform_bus_type, NULL, NULL, omap_device_late_idle);
686 omap_late_initcall_sync(omap_device_late_init);