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 * The function is called from inside omap_device_build_ss(), after
100 * omap_device_register.
102 * This allows drivers to get a pointer to its optional clocks based on its role
103 * by calling clk_get(<dev*>, <role>).
104 * In the case of the main clock, a "fck" alias is used.
108 static void _add_hwmod_clocks_clkdev(struct omap_device *od,
109 struct omap_hwmod *oh)
113 _add_clkdev(od, "fck", oh->main_clk);
115 for (i = 0; i < oh->opt_clks_cnt; i++)
116 _add_clkdev(od, oh->opt_clks[i].role, oh->opt_clks[i].clk);
121 * omap_device_build_from_dt - build an omap_device with multiple hwmods
122 * @pdev: The platform device to update.
124 * Function for building an omap_device already registered from device-tree
126 * Returns 0 or PTR_ERR() on error.
128 static int omap_device_build_from_dt(struct platform_device *pdev)
130 struct omap_hwmod **hwmods;
131 struct omap_device *od;
132 struct omap_hwmod *oh;
133 struct device_node *node = pdev->dev.of_node;
136 int oh_cnt, i, ret = 0;
137 bool device_active = false, skip_pm_domain = false;
139 oh_cnt = of_property_count_strings(node, "ti,hwmods");
141 dev_dbg(&pdev->dev, "No 'hwmods' to build omap_device\n");
145 /* SDMA still needs special handling for omap_device_build() */
146 ret = of_property_read_string_index(node, "ti,hwmods", 0, &oh_name);
147 if (!ret && (!strncmp("dma_system", oh_name, 10) ||
148 !strncmp("dma", oh_name, 3)))
149 skip_pm_domain = true;
151 /* Use ti-sysc driver instead of omap_device? */
152 if (!skip_pm_domain &&
153 !omap_hwmod_parse_module_range(NULL, node, &res))
156 hwmods = kcalloc(oh_cnt, sizeof(struct omap_hwmod *), GFP_KERNEL);
162 for (i = 0; i < oh_cnt; i++) {
163 of_property_read_string_index(node, "ti,hwmods", i, &oh_name);
164 oh = omap_hwmod_lookup(oh_name);
166 dev_err(&pdev->dev, "Cannot lookup hwmod '%s'\n",
172 if (oh->flags & HWMOD_INIT_NO_IDLE)
173 device_active = true;
176 od = omap_device_alloc(pdev, hwmods, oh_cnt);
178 dev_err(&pdev->dev, "Cannot allocate omap_device for :%s\n",
184 /* Fix up missing resource names */
185 for (i = 0; i < pdev->num_resources; i++) {
186 struct resource *r = &pdev->resource[i];
189 r->name = dev_name(&pdev->dev);
192 if (!skip_pm_domain) {
193 dev_pm_domain_set(&pdev->dev, &omap_device_pm_domain);
195 omap_device_enable(pdev);
196 pm_runtime_set_active(&pdev->dev);
203 /* if data/we are at fault.. load up a fail handler */
205 dev_pm_domain_set(&pdev->dev, &omap_device_fail_pm_domain);
210 static int _omap_device_notifier_call(struct notifier_block *nb,
211 unsigned long event, void *dev)
213 struct platform_device *pdev = to_platform_device(dev);
214 struct omap_device *od;
218 case BUS_NOTIFY_REMOVED_DEVICE:
219 if (pdev->archdata.od)
220 omap_device_delete(pdev->archdata.od);
222 case BUS_NOTIFY_UNBOUND_DRIVER:
223 od = to_omap_device(pdev);
224 if (od && (od->_state == OMAP_DEVICE_STATE_ENABLED)) {
225 dev_info(dev, "enabled after unload, idling\n");
226 err = omap_device_idle(pdev);
228 dev_err(dev, "failed to idle\n");
231 case BUS_NOTIFY_BIND_DRIVER:
232 od = to_omap_device(pdev);
234 od->_driver_status = BUS_NOTIFY_BIND_DRIVER;
235 if (od->_state == OMAP_DEVICE_STATE_ENABLED &&
236 pm_runtime_status_suspended(dev)) {
237 pm_runtime_set_active(dev);
241 case BUS_NOTIFY_ADD_DEVICE:
242 if (pdev->dev.of_node)
243 omap_device_build_from_dt(pdev);
244 omap_auxdata_legacy_init(dev);
247 od = to_omap_device(pdev);
249 od->_driver_status = event;
256 * _omap_device_enable_hwmods - call omap_hwmod_enable() on all hwmods
257 * @od: struct omap_device *od
259 * Enable all underlying hwmods. Returns 0.
261 static int _omap_device_enable_hwmods(struct omap_device *od)
266 for (i = 0; i < od->hwmods_cnt; i++)
267 ret |= omap_hwmod_enable(od->hwmods[i]);
273 * _omap_device_idle_hwmods - call omap_hwmod_idle() on all hwmods
274 * @od: struct omap_device *od
276 * Idle all underlying hwmods. Returns 0.
278 static int _omap_device_idle_hwmods(struct omap_device *od)
283 for (i = 0; i < od->hwmods_cnt; i++)
284 ret |= omap_hwmod_idle(od->hwmods[i]);
289 /* Public functions for use by core code */
292 * omap_device_get_context_loss_count - get lost context count
293 * @pdev: The platform device to update.
295 * Using the primary hwmod, query the context loss count for this
298 * Callers should consider context for this device lost any time this
299 * function returns a value different than the value the caller got
300 * the last time it called this function.
302 * If any hwmods exist for the omap_device associated with @pdev,
303 * return the context loss counter for that hwmod, otherwise return
306 int omap_device_get_context_loss_count(struct platform_device *pdev)
308 struct omap_device *od;
311 od = to_omap_device(pdev);
314 ret = omap_hwmod_get_context_loss_count(od->hwmods[0]);
320 * omap_device_alloc - allocate an omap_device
321 * @pdev: platform_device that will be included in this omap_device
322 * @ohs: ptr to the omap_hwmod for this omap_device
323 * @oh_cnt: the size of the ohs list
325 * Convenience function for allocating an omap_device structure and filling
326 * hwmods, and resources.
328 * Returns an struct omap_device pointer or ERR_PTR() on error;
330 struct omap_device *omap_device_alloc(struct platform_device *pdev,
331 struct omap_hwmod **ohs, int oh_cnt)
334 struct omap_device *od;
336 struct omap_hwmod **hwmods;
338 od = kzalloc(sizeof(struct omap_device), GFP_KERNEL);
342 od->hwmods_cnt = oh_cnt;
344 hwmods = kmemdup(ohs, sizeof(struct omap_hwmod *) * oh_cnt, GFP_KERNEL);
350 pdev->archdata.od = od;
352 for (i = 0; i < oh_cnt; i++) {
354 _add_hwmod_clocks_clkdev(od, hwmods[i]);
362 dev_err(&pdev->dev, "omap_device: build failed (%d)\n", ret);
367 void omap_device_delete(struct omap_device *od)
372 od->pdev->archdata.od = NULL;
378 static int _od_runtime_suspend(struct device *dev)
380 struct platform_device *pdev = to_platform_device(dev);
383 ret = pm_generic_runtime_suspend(dev);
387 return omap_device_idle(pdev);
390 static int _od_runtime_resume(struct device *dev)
392 struct platform_device *pdev = to_platform_device(dev);
395 ret = omap_device_enable(pdev);
397 dev_err(dev, "use pm_runtime_put_sync_suspend() in driver?\n");
401 return pm_generic_runtime_resume(dev);
404 static int _od_fail_runtime_suspend(struct device *dev)
406 dev_warn(dev, "%s: FIXME: missing hwmod/omap_dev info\n", __func__);
410 static int _od_fail_runtime_resume(struct device *dev)
412 dev_warn(dev, "%s: FIXME: missing hwmod/omap_dev info\n", __func__);
418 #ifdef CONFIG_SUSPEND
419 static int _od_suspend_noirq(struct device *dev)
421 struct platform_device *pdev = to_platform_device(dev);
422 struct omap_device *od = to_omap_device(pdev);
425 /* Don't attempt late suspend on a driver that is not bound */
426 if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER)
429 ret = pm_generic_suspend_noirq(dev);
431 if (!ret && !pm_runtime_status_suspended(dev)) {
432 if (pm_generic_runtime_suspend(dev) == 0) {
433 omap_device_idle(pdev);
434 od->flags |= OMAP_DEVICE_SUSPENDED;
441 static int _od_resume_noirq(struct device *dev)
443 struct platform_device *pdev = to_platform_device(dev);
444 struct omap_device *od = to_omap_device(pdev);
446 if (od->flags & OMAP_DEVICE_SUSPENDED) {
447 od->flags &= ~OMAP_DEVICE_SUSPENDED;
448 omap_device_enable(pdev);
449 pm_generic_runtime_resume(dev);
452 return pm_generic_resume_noirq(dev);
455 #define _od_suspend_noirq NULL
456 #define _od_resume_noirq NULL
459 struct dev_pm_domain omap_device_fail_pm_domain = {
461 SET_RUNTIME_PM_OPS(_od_fail_runtime_suspend,
462 _od_fail_runtime_resume, NULL)
466 struct dev_pm_domain omap_device_pm_domain = {
468 SET_RUNTIME_PM_OPS(_od_runtime_suspend, _od_runtime_resume,
470 USE_PLATFORM_PM_SLEEP_OPS
471 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(_od_suspend_noirq,
477 * omap_device_register - register an omap_device with one omap_hwmod
478 * @pdev: the platform device (omap_device) to register.
480 * Register the omap_device structure. This currently just calls
481 * platform_device_register() on the underlying platform_device.
482 * Returns the return value of platform_device_register().
484 int omap_device_register(struct platform_device *pdev)
486 pr_debug("omap_device: %s: registering\n", pdev->name);
488 dev_pm_domain_set(&pdev->dev, &omap_device_pm_domain);
489 return platform_device_add(pdev);
493 /* Public functions for use by device drivers through struct platform_data */
496 * omap_device_enable - fully activate an omap_device
497 * @pdev: the platform device to activate
499 * Do whatever is necessary for the hwmods underlying omap_device @od
500 * to be accessible and ready to operate. This generally involves
501 * enabling clocks, setting SYSCONFIG registers; and in the future may
502 * involve remuxing pins. Device drivers should call this function
503 * indirectly via pm_runtime_get*(). Returns -EINVAL if called when
504 * the omap_device is already enabled, or passes along the return
505 * value of _omap_device_enable_hwmods().
507 int omap_device_enable(struct platform_device *pdev)
510 struct omap_device *od;
512 od = to_omap_device(pdev);
514 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
516 "omap_device: %s() called from invalid state %d\n",
517 __func__, od->_state);
521 ret = _omap_device_enable_hwmods(od);
524 od->_state = OMAP_DEVICE_STATE_ENABLED;
530 * omap_device_idle - idle an omap_device
531 * @pdev: The platform_device (omap_device) to idle
533 * Idle omap_device @od. Device drivers call this function indirectly
534 * via pm_runtime_put*(). Returns -EINVAL if the omap_device is not
535 * currently enabled, or passes along the return value of
536 * _omap_device_idle_hwmods().
538 int omap_device_idle(struct platform_device *pdev)
541 struct omap_device *od;
543 od = to_omap_device(pdev);
545 if (od->_state != OMAP_DEVICE_STATE_ENABLED) {
547 "omap_device: %s() called from invalid state %d\n",
548 __func__, od->_state);
552 ret = _omap_device_idle_hwmods(od);
555 od->_state = OMAP_DEVICE_STATE_IDLE;
561 * omap_device_assert_hardreset - set a device's hardreset line
562 * @pdev: struct platform_device * to reset
563 * @name: const char * name of the reset line
565 * Set the hardreset line identified by @name on the IP blocks
566 * associated with the hwmods backing the platform_device @pdev. All
567 * of the hwmods associated with @pdev must have the same hardreset
568 * line linked to them for this to work. Passes along the return value
569 * of omap_hwmod_assert_hardreset() in the event of any failure, or
570 * returns 0 upon success.
572 int omap_device_assert_hardreset(struct platform_device *pdev, const char *name)
574 struct omap_device *od = to_omap_device(pdev);
578 for (i = 0; i < od->hwmods_cnt; i++) {
579 ret = omap_hwmod_assert_hardreset(od->hwmods[i], name);
588 * omap_device_deassert_hardreset - release a device's hardreset line
589 * @pdev: struct platform_device * to reset
590 * @name: const char * name of the reset line
592 * Release the hardreset line identified by @name on the IP blocks
593 * associated with the hwmods backing the platform_device @pdev. All
594 * of the hwmods associated with @pdev must have the same hardreset
595 * line linked to them for this to work. Passes along the return
596 * value of omap_hwmod_deassert_hardreset() in the event of any
597 * failure, or returns 0 upon success.
599 int omap_device_deassert_hardreset(struct platform_device *pdev,
602 struct omap_device *od = to_omap_device(pdev);
606 for (i = 0; i < od->hwmods_cnt; i++) {
607 ret = omap_hwmod_deassert_hardreset(od->hwmods[i], name);
616 * omap_device_get_by_hwmod_name() - convert a hwmod name to
618 * @oh_name: name of the hwmod device
620 * Returns back a struct device * pointer associated with a hwmod
621 * device represented by a hwmod_name
623 struct device *omap_device_get_by_hwmod_name(const char *oh_name)
625 struct omap_hwmod *oh;
628 WARN(1, "%s: no hwmod name!\n", __func__);
629 return ERR_PTR(-EINVAL);
632 oh = omap_hwmod_lookup(oh_name);
634 WARN(1, "%s: no hwmod for %s\n", __func__,
636 return ERR_PTR(-ENODEV);
639 WARN(1, "%s: no omap_device for %s\n", __func__,
641 return ERR_PTR(-ENODEV);
644 return &oh->od->pdev->dev;
647 static struct notifier_block platform_nb = {
648 .notifier_call = _omap_device_notifier_call,
651 static int __init omap_device_init(void)
653 bus_register_notifier(&platform_bus_type, &platform_nb);
656 omap_postcore_initcall(omap_device_init);
659 * omap_device_late_idle - idle devices without drivers
660 * @dev: struct device * associated with omap_device
663 * Check the driver bound status of this device, and idle it
664 * if there is no driver attached.
666 static int __init omap_device_late_idle(struct device *dev, void *data)
668 struct platform_device *pdev = to_platform_device(dev);
669 struct omap_device *od = to_omap_device(pdev);
676 * If omap_device state is enabled, but has no driver bound,
681 * Some devices (like memory controllers) are always kept
682 * enabled, and should not be idled even with no drivers.
684 for (i = 0; i < od->hwmods_cnt; i++)
685 if (od->hwmods[i]->flags & HWMOD_INIT_NO_IDLE)
688 if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER &&
689 od->_driver_status != BUS_NOTIFY_BIND_DRIVER) {
690 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
691 dev_warn(dev, "%s: enabled but no driver. Idling\n",
693 omap_device_idle(pdev);
700 static int __init omap_device_late_init(void)
702 bus_for_each_dev(&platform_bus_type, NULL, NULL, omap_device_late_idle);
706 omap_late_initcall_sync(omap_device_late_init);