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
);
233 if (od
&& (od
->_state
== OMAP_DEVICE_STATE_ENABLED
) &&
234 pm_runtime_status_suspended(dev
)) {
235 od
->_driver_status
= BUS_NOTIFY_BIND_DRIVER
;
236 pm_runtime_set_active(dev
);
239 case BUS_NOTIFY_ADD_DEVICE
:
240 if (pdev
->dev
.of_node
)
241 omap_device_build_from_dt(pdev
);
242 omap_auxdata_legacy_init(dev
);
245 od
= to_omap_device(pdev
);
247 od
->_driver_status
= event
;
254 * _omap_device_enable_hwmods - call omap_hwmod_enable() on all hwmods
255 * @od: struct omap_device *od
257 * Enable all underlying hwmods. Returns 0.
259 static int _omap_device_enable_hwmods(struct omap_device
*od
)
264 for (i
= 0; i
< od
->hwmods_cnt
; i
++)
265 ret
|= omap_hwmod_enable(od
->hwmods
[i
]);
271 * _omap_device_idle_hwmods - call omap_hwmod_idle() on all hwmods
272 * @od: struct omap_device *od
274 * Idle all underlying hwmods. Returns 0.
276 static int _omap_device_idle_hwmods(struct omap_device
*od
)
281 for (i
= 0; i
< od
->hwmods_cnt
; i
++)
282 ret
|= omap_hwmod_idle(od
->hwmods
[i
]);
287 /* Public functions for use by core code */
290 * omap_device_get_context_loss_count - get lost context count
291 * @pdev: The platform device to update.
293 * Using the primary hwmod, query the context loss count for this
296 * Callers should consider context for this device lost any time this
297 * function returns a value different than the value the caller got
298 * the last time it called this function.
300 * If any hwmods exist for the omap_device associated with @pdev,
301 * return the context loss counter for that hwmod, otherwise return
304 int omap_device_get_context_loss_count(struct platform_device
*pdev
)
306 struct omap_device
*od
;
309 od
= to_omap_device(pdev
);
312 ret
= omap_hwmod_get_context_loss_count(od
->hwmods
[0]);
318 * omap_device_alloc - allocate an omap_device
319 * @pdev: platform_device that will be included in this omap_device
320 * @ohs: ptr to the omap_hwmod for this omap_device
321 * @oh_cnt: the size of the ohs list
323 * Convenience function for allocating an omap_device structure and filling
324 * hwmods, and resources.
326 * Returns an struct omap_device pointer or ERR_PTR() on error;
328 struct omap_device
*omap_device_alloc(struct platform_device
*pdev
,
329 struct omap_hwmod
**ohs
, int oh_cnt
)
332 struct omap_device
*od
;
334 struct omap_hwmod
**hwmods
;
336 od
= kzalloc(sizeof(struct omap_device
), GFP_KERNEL
);
341 od
->hwmods_cnt
= oh_cnt
;
343 hwmods
= kmemdup(ohs
, sizeof(struct omap_hwmod
*) * oh_cnt
, GFP_KERNEL
);
349 pdev
->archdata
.od
= od
;
351 for (i
= 0; i
< oh_cnt
; i
++) {
353 _add_hwmod_clocks_clkdev(od
, hwmods
[i
]);
361 dev_err(&pdev
->dev
, "omap_device: build failed (%d)\n", ret
);
366 void omap_device_delete(struct omap_device
*od
)
371 od
->pdev
->archdata
.od
= NULL
;
377 * omap_device_copy_resources - Add legacy IO and IRQ resources
378 * @oh: interconnect target module
379 * @pdev: platform device to copy resources to
381 * We still have legacy DMA and smartreflex needing resources.
382 * Let's populate what they need until we can eventually just
383 * remove this function. Note that there should be no need to
384 * call this from omap_device_build_from_dt(), nor should there
385 * be any need to call it for other devices.
388 omap_device_copy_resources(struct omap_hwmod
*oh
,
389 struct platform_device
*pdev
)
391 struct device_node
*np
, *child
;
392 struct property
*prop
;
393 struct resource
*res
;
397 if (!oh
|| !oh
->od
|| !oh
->od
->pdev
)
400 np
= oh
->od
->pdev
->dev
.of_node
;
406 res
= kcalloc(2, sizeof(*res
), GFP_KERNEL
);
410 /* Do we have a dts range for the interconnect target module? */
411 error
= omap_hwmod_parse_module_range(oh
, np
, res
);
413 /* No ranges, rely on device reg entry */
415 error
= of_address_to_resource(np
, 0, res
);
419 /* SmartReflex needs first IO resource name to be "mpu" */
423 * We may have a configured "ti,sysc" interconnect target with a
424 * dts child with the interrupt. If so use the first child's
425 * first interrupt for "ti-hwmods" legacy support.
427 of_property_for_each_string(np
, "compatible", prop
, name
)
428 if (!strncmp("ti,sysc-", name
, 8))
431 child
= of_get_next_available_child(np
, NULL
);
434 irq
= irq_of_parse_and_map(child
, 0);
436 irq
= irq_of_parse_and_map(np
, 0);
442 /* Legacy DMA code needs interrupt name to be "0" */
445 res
[1].flags
= IORESOURCE_IRQ
;
448 error
= platform_device_add_resources(pdev
, res
, 2);
454 WARN(error
, "%s: %s device %s failed: %i\n",
455 __func__
, oh
->name
, dev_name(&pdev
->dev
),
462 * omap_device_build - build and register an omap_device with one omap_hwmod
463 * @pdev_name: name of the platform_device driver to use
464 * @pdev_id: this platform_device's connection ID
465 * @oh: ptr to the single omap_hwmod that backs this omap_device
466 * @pdata: platform_data ptr to associate with the platform_device
467 * @pdata_len: amount of memory pointed to by @pdata
469 * Convenience function for building and registering a single
470 * omap_device record, which in turn builds and registers a
471 * platform_device record. See omap_device_build_ss() for more
472 * information. Returns ERR_PTR(-EINVAL) if @oh is NULL; otherwise,
473 * passes along the return value of omap_device_build_ss().
475 struct platform_device __init
*omap_device_build(const char *pdev_name
,
477 struct omap_hwmod
*oh
,
478 void *pdata
, int pdata_len
)
481 struct platform_device
*pdev
;
482 struct omap_device
*od
;
484 if (!oh
|| !pdev_name
)
485 return ERR_PTR(-EINVAL
);
487 if (!pdata
&& pdata_len
> 0)
488 return ERR_PTR(-EINVAL
);
490 if (strncmp(oh
->name
, "smartreflex", 11) &&
491 strncmp(oh
->name
, "dma", 3)) {
492 pr_warn("%s need to update %s to probe with dt\na",
493 __func__
, pdev_name
);
498 pdev
= platform_device_alloc(pdev_name
, pdev_id
);
504 /* Set the dev_name early to allow dev_xxx in omap_device_alloc */
506 dev_set_name(&pdev
->dev
, "%s.%d", pdev
->name
, pdev
->id
);
508 dev_set_name(&pdev
->dev
, "%s", pdev
->name
);
511 * Must be called before omap_device_alloc() as oh->od
512 * only contains the currently registered omap_device
513 * and will get overwritten by omap_device_alloc().
515 ret
= omap_device_copy_resources(oh
, pdev
);
519 od
= omap_device_alloc(pdev
, &oh
, 1);
525 ret
= platform_device_add_data(pdev
, pdata
, pdata_len
);
529 ret
= omap_device_register(pdev
);
536 omap_device_delete(od
);
538 platform_device_put(pdev
);
541 pr_err("omap_device: %s: build failed (%d)\n", pdev_name
, ret
);
547 static int _od_runtime_suspend(struct device
*dev
)
549 struct platform_device
*pdev
= to_platform_device(dev
);
552 ret
= pm_generic_runtime_suspend(dev
);
556 return omap_device_idle(pdev
);
559 static int _od_runtime_resume(struct device
*dev
)
561 struct platform_device
*pdev
= to_platform_device(dev
);
564 ret
= omap_device_enable(pdev
);
566 dev_err(dev
, "use pm_runtime_put_sync_suspend() in driver?\n");
570 return pm_generic_runtime_resume(dev
);
573 static int _od_fail_runtime_suspend(struct device
*dev
)
575 dev_warn(dev
, "%s: FIXME: missing hwmod/omap_dev info\n", __func__
);
579 static int _od_fail_runtime_resume(struct device
*dev
)
581 dev_warn(dev
, "%s: FIXME: missing hwmod/omap_dev info\n", __func__
);
587 #ifdef CONFIG_SUSPEND
588 static int _od_suspend_noirq(struct device
*dev
)
590 struct platform_device
*pdev
= to_platform_device(dev
);
591 struct omap_device
*od
= to_omap_device(pdev
);
594 /* Don't attempt late suspend on a driver that is not bound */
595 if (od
->_driver_status
!= BUS_NOTIFY_BOUND_DRIVER
)
598 ret
= pm_generic_suspend_noirq(dev
);
600 if (!ret
&& !pm_runtime_status_suspended(dev
)) {
601 if (pm_generic_runtime_suspend(dev
) == 0) {
602 omap_device_idle(pdev
);
603 od
->flags
|= OMAP_DEVICE_SUSPENDED
;
610 static int _od_resume_noirq(struct device
*dev
)
612 struct platform_device
*pdev
= to_platform_device(dev
);
613 struct omap_device
*od
= to_omap_device(pdev
);
615 if (od
->flags
& OMAP_DEVICE_SUSPENDED
) {
616 od
->flags
&= ~OMAP_DEVICE_SUSPENDED
;
617 omap_device_enable(pdev
);
618 pm_generic_runtime_resume(dev
);
621 return pm_generic_resume_noirq(dev
);
624 #define _od_suspend_noirq NULL
625 #define _od_resume_noirq NULL
628 struct dev_pm_domain omap_device_fail_pm_domain
= {
630 SET_RUNTIME_PM_OPS(_od_fail_runtime_suspend
,
631 _od_fail_runtime_resume
, NULL
)
635 struct dev_pm_domain omap_device_pm_domain
= {
637 SET_RUNTIME_PM_OPS(_od_runtime_suspend
, _od_runtime_resume
,
639 USE_PLATFORM_PM_SLEEP_OPS
640 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(_od_suspend_noirq
,
646 * omap_device_register - register an omap_device with one omap_hwmod
647 * @pdev: the platform device (omap_device) to register.
649 * Register the omap_device structure. This currently just calls
650 * platform_device_register() on the underlying platform_device.
651 * Returns the return value of platform_device_register().
653 int omap_device_register(struct platform_device
*pdev
)
655 pr_debug("omap_device: %s: registering\n", pdev
->name
);
657 dev_pm_domain_set(&pdev
->dev
, &omap_device_pm_domain
);
658 return platform_device_add(pdev
);
662 /* Public functions for use by device drivers through struct platform_data */
665 * omap_device_enable - fully activate an omap_device
666 * @pdev: the platform device to activate
668 * Do whatever is necessary for the hwmods underlying omap_device @od
669 * to be accessible and ready to operate. This generally involves
670 * enabling clocks, setting SYSCONFIG registers; and in the future may
671 * involve remuxing pins. Device drivers should call this function
672 * indirectly via pm_runtime_get*(). Returns -EINVAL if called when
673 * the omap_device is already enabled, or passes along the return
674 * value of _omap_device_enable_hwmods().
676 int omap_device_enable(struct platform_device
*pdev
)
679 struct omap_device
*od
;
681 od
= to_omap_device(pdev
);
683 if (od
->_state
== OMAP_DEVICE_STATE_ENABLED
) {
685 "omap_device: %s() called from invalid state %d\n",
686 __func__
, od
->_state
);
690 ret
= _omap_device_enable_hwmods(od
);
693 od
->_state
= OMAP_DEVICE_STATE_ENABLED
;
699 * omap_device_idle - idle an omap_device
700 * @pdev: The platform_device (omap_device) to idle
702 * Idle omap_device @od. Device drivers call this function indirectly
703 * via pm_runtime_put*(). Returns -EINVAL if the omap_device is not
704 * currently enabled, or passes along the return value of
705 * _omap_device_idle_hwmods().
707 int omap_device_idle(struct platform_device
*pdev
)
710 struct omap_device
*od
;
712 od
= to_omap_device(pdev
);
714 if (od
->_state
!= OMAP_DEVICE_STATE_ENABLED
) {
716 "omap_device: %s() called from invalid state %d\n",
717 __func__
, od
->_state
);
721 ret
= _omap_device_idle_hwmods(od
);
724 od
->_state
= OMAP_DEVICE_STATE_IDLE
;
730 * omap_device_assert_hardreset - set a device's hardreset line
731 * @pdev: struct platform_device * to reset
732 * @name: const char * name of the reset line
734 * Set the hardreset line identified by @name on the IP blocks
735 * associated with the hwmods backing the platform_device @pdev. All
736 * of the hwmods associated with @pdev must have the same hardreset
737 * line linked to them for this to work. Passes along the return value
738 * of omap_hwmod_assert_hardreset() in the event of any failure, or
739 * returns 0 upon success.
741 int omap_device_assert_hardreset(struct platform_device
*pdev
, const char *name
)
743 struct omap_device
*od
= to_omap_device(pdev
);
747 for (i
= 0; i
< od
->hwmods_cnt
; i
++) {
748 ret
= omap_hwmod_assert_hardreset(od
->hwmods
[i
], name
);
757 * omap_device_deassert_hardreset - release a device's hardreset line
758 * @pdev: struct platform_device * to reset
759 * @name: const char * name of the reset line
761 * Release the hardreset line identified by @name on the IP blocks
762 * associated with the hwmods backing the platform_device @pdev. All
763 * of the hwmods associated with @pdev must have the same hardreset
764 * line linked to them for this to work. Passes along the return
765 * value of omap_hwmod_deassert_hardreset() in the event of any
766 * failure, or returns 0 upon success.
768 int omap_device_deassert_hardreset(struct platform_device
*pdev
,
771 struct omap_device
*od
= to_omap_device(pdev
);
775 for (i
= 0; i
< od
->hwmods_cnt
; i
++) {
776 ret
= omap_hwmod_deassert_hardreset(od
->hwmods
[i
], name
);
785 * omap_device_get_by_hwmod_name() - convert a hwmod name to
787 * @oh_name: name of the hwmod device
789 * Returns back a struct device * pointer associated with a hwmod
790 * device represented by a hwmod_name
792 struct device
*omap_device_get_by_hwmod_name(const char *oh_name
)
794 struct omap_hwmod
*oh
;
797 WARN(1, "%s: no hwmod name!\n", __func__
);
798 return ERR_PTR(-EINVAL
);
801 oh
= omap_hwmod_lookup(oh_name
);
803 WARN(1, "%s: no hwmod for %s\n", __func__
,
805 return ERR_PTR(-ENODEV
);
808 WARN(1, "%s: no omap_device for %s\n", __func__
,
810 return ERR_PTR(-ENODEV
);
813 return &oh
->od
->pdev
->dev
;
816 static struct notifier_block platform_nb
= {
817 .notifier_call
= _omap_device_notifier_call
,
820 static int __init
omap_device_init(void)
822 bus_register_notifier(&platform_bus_type
, &platform_nb
);
825 omap_postcore_initcall(omap_device_init
);
828 * omap_device_late_idle - idle devices without drivers
829 * @dev: struct device * associated with omap_device
832 * Check the driver bound status of this device, and idle it
833 * if there is no driver attached.
835 static int __init
omap_device_late_idle(struct device
*dev
, void *data
)
837 struct platform_device
*pdev
= to_platform_device(dev
);
838 struct omap_device
*od
= to_omap_device(pdev
);
845 * If omap_device state is enabled, but has no driver bound,
850 * Some devices (like memory controllers) are always kept
851 * enabled, and should not be idled even with no drivers.
853 for (i
= 0; i
< od
->hwmods_cnt
; i
++)
854 if (od
->hwmods
[i
]->flags
& HWMOD_INIT_NO_IDLE
)
857 if (od
->_driver_status
!= BUS_NOTIFY_BOUND_DRIVER
&&
858 od
->_driver_status
!= BUS_NOTIFY_BIND_DRIVER
) {
859 if (od
->_state
== OMAP_DEVICE_STATE_ENABLED
) {
860 dev_warn(dev
, "%s: enabled but no driver. Idling\n",
862 omap_device_idle(pdev
);
869 static int __init
omap_device_late_init(void)
871 bus_for_each_dev(&platform_bus_type
, NULL
, NULL
, omap_device_late_idle
);
875 omap_late_initcall_sync(omap_device_late_init
);