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
;
144 int oh_cnt
, i
, ret
= 0;
145 bool device_active
= false;
147 oh_cnt
= of_property_count_strings(node
, "ti,hwmods");
149 dev_dbg(&pdev
->dev
, "No 'hwmods' to build omap_device\n");
153 hwmods
= kzalloc(sizeof(struct omap_hwmod
*) * oh_cnt
, 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 dev_pm_domain_set(&pdev
->dev
, &omap_device_pm_domain
);
192 omap_device_enable(pdev
);
193 pm_runtime_set_active(&pdev
->dev
);
199 /* if data/we are at fault.. load up a fail handler */
201 dev_pm_domain_set(&pdev
->dev
, &omap_device_fail_pm_domain
);
206 static int _omap_device_notifier_call(struct notifier_block
*nb
,
207 unsigned long event
, void *dev
)
209 struct platform_device
*pdev
= to_platform_device(dev
);
210 struct omap_device
*od
;
214 case BUS_NOTIFY_REMOVED_DEVICE
:
215 if (pdev
->archdata
.od
)
216 omap_device_delete(pdev
->archdata
.od
);
218 case BUS_NOTIFY_UNBOUND_DRIVER
:
219 od
= to_omap_device(pdev
);
220 if (od
&& (od
->_state
== OMAP_DEVICE_STATE_ENABLED
)) {
221 dev_info(dev
, "enabled after unload, idling\n");
222 err
= omap_device_idle(pdev
);
224 dev_err(dev
, "failed to idle\n");
227 case BUS_NOTIFY_BIND_DRIVER
:
228 od
= to_omap_device(pdev
);
229 if (od
&& (od
->_state
== OMAP_DEVICE_STATE_ENABLED
) &&
230 pm_runtime_status_suspended(dev
)) {
231 od
->_driver_status
= BUS_NOTIFY_BIND_DRIVER
;
232 pm_runtime_set_active(dev
);
235 case BUS_NOTIFY_ADD_DEVICE
:
236 if (pdev
->dev
.of_node
)
237 omap_device_build_from_dt(pdev
);
238 omap_auxdata_legacy_init(dev
);
241 od
= to_omap_device(pdev
);
243 od
->_driver_status
= event
;
250 * _omap_device_enable_hwmods - call omap_hwmod_enable() on all hwmods
251 * @od: struct omap_device *od
253 * Enable all underlying hwmods. Returns 0.
255 static int _omap_device_enable_hwmods(struct omap_device
*od
)
260 for (i
= 0; i
< od
->hwmods_cnt
; i
++)
261 ret
|= omap_hwmod_enable(od
->hwmods
[i
]);
267 * _omap_device_idle_hwmods - call omap_hwmod_idle() on all hwmods
268 * @od: struct omap_device *od
270 * Idle all underlying hwmods. Returns 0.
272 static int _omap_device_idle_hwmods(struct omap_device
*od
)
277 for (i
= 0; i
< od
->hwmods_cnt
; i
++)
278 ret
|= omap_hwmod_idle(od
->hwmods
[i
]);
283 /* Public functions for use by core code */
286 * omap_device_get_context_loss_count - get lost context count
287 * @od: struct omap_device *
289 * Using the primary hwmod, query the context loss count for this
292 * Callers should consider context for this device lost any time this
293 * function returns a value different than the value the caller got
294 * the last time it called this function.
296 * If any hwmods exist for the omap_device associated with @pdev,
297 * return the context loss counter for that hwmod, otherwise return
300 int omap_device_get_context_loss_count(struct platform_device
*pdev
)
302 struct omap_device
*od
;
305 od
= to_omap_device(pdev
);
308 ret
= omap_hwmod_get_context_loss_count(od
->hwmods
[0]);
314 * omap_device_alloc - allocate an omap_device
315 * @pdev: platform_device that will be included in this omap_device
316 * @oh: ptr to the single omap_hwmod that backs this omap_device
317 * @pdata: platform_data ptr to associate with the platform_device
318 * @pdata_len: amount of memory pointed to by @pdata
320 * Convenience function for allocating an omap_device structure and filling
321 * hwmods, and resources.
323 * Returns an struct omap_device pointer or ERR_PTR() on error;
325 struct omap_device
*omap_device_alloc(struct platform_device
*pdev
,
326 struct omap_hwmod
**ohs
, int oh_cnt
)
329 struct omap_device
*od
;
331 struct omap_hwmod
**hwmods
;
333 od
= kzalloc(sizeof(struct omap_device
), GFP_KERNEL
);
338 od
->hwmods_cnt
= oh_cnt
;
340 hwmods
= kmemdup(ohs
, sizeof(struct omap_hwmod
*) * oh_cnt
, GFP_KERNEL
);
346 pdev
->archdata
.od
= od
;
348 for (i
= 0; i
< oh_cnt
; i
++) {
350 _add_hwmod_clocks_clkdev(od
, hwmods
[i
]);
358 dev_err(&pdev
->dev
, "omap_device: build failed (%d)\n", ret
);
363 void omap_device_delete(struct omap_device
*od
)
368 od
->pdev
->archdata
.od
= NULL
;
374 * omap_device_copy_resources - Add legacy IO and IRQ resources
375 * @oh: interconnect target module
376 * @pdev: platform device to copy resources to
378 * We still have legacy DMA and smartreflex needing resources.
379 * Let's populate what they need until we can eventually just
380 * remove this function. Note that there should be no need to
381 * call this from omap_device_build_from_dt(), nor should there
382 * be any need to call it for other devices.
385 omap_device_copy_resources(struct omap_hwmod
*oh
,
386 struct platform_device
*pdev
)
388 struct device_node
*np
, *child
;
389 struct property
*prop
;
390 struct resource
*res
;
394 if (!oh
|| !oh
->od
|| !oh
->od
->pdev
)
397 np
= oh
->od
->pdev
->dev
.of_node
;
403 res
= kzalloc(sizeof(*res
) * 2, GFP_KERNEL
);
407 /* Do we have a dts range for the interconnect target module? */
408 error
= omap_hwmod_parse_module_range(oh
, np
, res
);
410 /* No ranges, rely on device reg entry */
412 error
= of_address_to_resource(np
, 0, res
);
416 /* SmartReflex needs first IO resource name to be "mpu" */
420 * We may have a configured "ti,sysc" interconnect target with a
421 * dts child with the interrupt. If so use the first child's
422 * first interrupt for "ti-hwmods" legacy support.
424 of_property_for_each_string(np
, "compatible", prop
, name
)
425 if (!strncmp("ti,sysc-", name
, 8))
428 child
= of_get_next_available_child(np
, NULL
);
431 irq
= irq_of_parse_and_map(child
, 0);
433 irq
= irq_of_parse_and_map(np
, 0);
439 /* Legacy DMA code needs interrupt name to be "0" */
442 res
[1].flags
= IORESOURCE_IRQ
;
445 error
= platform_device_add_resources(pdev
, res
, 2);
451 WARN(error
, "%s: %s device %s failed: %i\n",
452 __func__
, oh
->name
, dev_name(&pdev
->dev
),
459 * omap_device_build - build and register an omap_device with one omap_hwmod
460 * @pdev_name: name of the platform_device driver to use
461 * @pdev_id: this platform_device's connection ID
462 * @oh: ptr to the single omap_hwmod that backs this omap_device
463 * @pdata: platform_data ptr to associate with the platform_device
464 * @pdata_len: amount of memory pointed to by @pdata
466 * Convenience function for building and registering a single
467 * omap_device record, which in turn builds and registers a
468 * platform_device record. See omap_device_build_ss() for more
469 * information. Returns ERR_PTR(-EINVAL) if @oh is NULL; otherwise,
470 * passes along the return value of omap_device_build_ss().
472 struct platform_device __init
*omap_device_build(const char *pdev_name
,
474 struct omap_hwmod
*oh
,
475 void *pdata
, int pdata_len
)
478 struct platform_device
*pdev
;
479 struct omap_device
*od
;
481 if (!oh
|| !pdev_name
)
482 return ERR_PTR(-EINVAL
);
484 if (!pdata
&& pdata_len
> 0)
485 return ERR_PTR(-EINVAL
);
487 if (strncmp(oh
->name
, "smartreflex", 11) &&
488 strncmp(oh
->name
, "dma", 3)) {
489 pr_warn("%s need to update %s to probe with dt\na",
490 __func__
, pdev_name
);
495 pdev
= platform_device_alloc(pdev_name
, pdev_id
);
501 /* Set the dev_name early to allow dev_xxx in omap_device_alloc */
503 dev_set_name(&pdev
->dev
, "%s.%d", pdev
->name
, pdev
->id
);
505 dev_set_name(&pdev
->dev
, "%s", pdev
->name
);
508 * Must be called before omap_device_alloc() as oh->od
509 * only contains the currently registered omap_device
510 * and will get overwritten by omap_device_alloc().
512 ret
= omap_device_copy_resources(oh
, pdev
);
516 od
= omap_device_alloc(pdev
, &oh
, 1);
522 ret
= platform_device_add_data(pdev
, pdata
, pdata_len
);
526 ret
= omap_device_register(pdev
);
533 omap_device_delete(od
);
535 platform_device_put(pdev
);
538 pr_err("omap_device: %s: build failed (%d)\n", pdev_name
, ret
);
544 static int _od_runtime_suspend(struct device
*dev
)
546 struct platform_device
*pdev
= to_platform_device(dev
);
549 ret
= pm_generic_runtime_suspend(dev
);
553 return omap_device_idle(pdev
);
556 static int _od_runtime_resume(struct device
*dev
)
558 struct platform_device
*pdev
= to_platform_device(dev
);
561 ret
= omap_device_enable(pdev
);
563 dev_err(dev
, "use pm_runtime_put_sync_suspend() in driver?\n");
567 return pm_generic_runtime_resume(dev
);
570 static int _od_fail_runtime_suspend(struct device
*dev
)
572 dev_warn(dev
, "%s: FIXME: missing hwmod/omap_dev info\n", __func__
);
576 static int _od_fail_runtime_resume(struct device
*dev
)
578 dev_warn(dev
, "%s: FIXME: missing hwmod/omap_dev info\n", __func__
);
584 #ifdef CONFIG_SUSPEND
585 static int _od_suspend_noirq(struct device
*dev
)
587 struct platform_device
*pdev
= to_platform_device(dev
);
588 struct omap_device
*od
= to_omap_device(pdev
);
591 /* Don't attempt late suspend on a driver that is not bound */
592 if (od
->_driver_status
!= BUS_NOTIFY_BOUND_DRIVER
)
595 ret
= pm_generic_suspend_noirq(dev
);
597 if (!ret
&& !pm_runtime_status_suspended(dev
)) {
598 if (pm_generic_runtime_suspend(dev
) == 0) {
599 omap_device_idle(pdev
);
600 od
->flags
|= OMAP_DEVICE_SUSPENDED
;
607 static int _od_resume_noirq(struct device
*dev
)
609 struct platform_device
*pdev
= to_platform_device(dev
);
610 struct omap_device
*od
= to_omap_device(pdev
);
612 if (od
->flags
& OMAP_DEVICE_SUSPENDED
) {
613 od
->flags
&= ~OMAP_DEVICE_SUSPENDED
;
614 omap_device_enable(pdev
);
615 pm_generic_runtime_resume(dev
);
618 return pm_generic_resume_noirq(dev
);
621 #define _od_suspend_noirq NULL
622 #define _od_resume_noirq NULL
625 struct dev_pm_domain omap_device_fail_pm_domain
= {
627 SET_RUNTIME_PM_OPS(_od_fail_runtime_suspend
,
628 _od_fail_runtime_resume
, NULL
)
632 struct dev_pm_domain omap_device_pm_domain
= {
634 SET_RUNTIME_PM_OPS(_od_runtime_suspend
, _od_runtime_resume
,
636 USE_PLATFORM_PM_SLEEP_OPS
637 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(_od_suspend_noirq
,
643 * omap_device_register - register an omap_device with one omap_hwmod
644 * @od: struct omap_device * to register
646 * Register the omap_device structure. This currently just calls
647 * platform_device_register() on the underlying platform_device.
648 * Returns the return value of platform_device_register().
650 int omap_device_register(struct platform_device
*pdev
)
652 pr_debug("omap_device: %s: registering\n", pdev
->name
);
654 dev_pm_domain_set(&pdev
->dev
, &omap_device_pm_domain
);
655 return platform_device_add(pdev
);
659 /* Public functions for use by device drivers through struct platform_data */
662 * omap_device_enable - fully activate an omap_device
663 * @od: struct omap_device * to activate
665 * Do whatever is necessary for the hwmods underlying omap_device @od
666 * to be accessible and ready to operate. This generally involves
667 * enabling clocks, setting SYSCONFIG registers; and in the future may
668 * involve remuxing pins. Device drivers should call this function
669 * indirectly via pm_runtime_get*(). Returns -EINVAL if called when
670 * the omap_device is already enabled, or passes along the return
671 * value of _omap_device_enable_hwmods().
673 int omap_device_enable(struct platform_device
*pdev
)
676 struct omap_device
*od
;
678 od
= to_omap_device(pdev
);
680 if (od
->_state
== OMAP_DEVICE_STATE_ENABLED
) {
682 "omap_device: %s() called from invalid state %d\n",
683 __func__
, od
->_state
);
687 ret
= _omap_device_enable_hwmods(od
);
690 od
->_state
= OMAP_DEVICE_STATE_ENABLED
;
696 * omap_device_idle - idle an omap_device
697 * @od: struct omap_device * to idle
699 * Idle omap_device @od. Device drivers call this function indirectly
700 * via pm_runtime_put*(). Returns -EINVAL if the omap_device is not
701 * currently enabled, or passes along the return value of
702 * _omap_device_idle_hwmods().
704 int omap_device_idle(struct platform_device
*pdev
)
707 struct omap_device
*od
;
709 od
= to_omap_device(pdev
);
711 if (od
->_state
!= OMAP_DEVICE_STATE_ENABLED
) {
713 "omap_device: %s() called from invalid state %d\n",
714 __func__
, od
->_state
);
718 ret
= _omap_device_idle_hwmods(od
);
721 od
->_state
= OMAP_DEVICE_STATE_IDLE
;
727 * omap_device_assert_hardreset - set a device's hardreset line
728 * @pdev: struct platform_device * to reset
729 * @name: const char * name of the reset line
731 * Set the hardreset line identified by @name on the IP blocks
732 * associated with the hwmods backing the platform_device @pdev. All
733 * of the hwmods associated with @pdev must have the same hardreset
734 * line linked to them for this to work. Passes along the return value
735 * of omap_hwmod_assert_hardreset() in the event of any failure, or
736 * returns 0 upon success.
738 int omap_device_assert_hardreset(struct platform_device
*pdev
, const char *name
)
740 struct omap_device
*od
= to_omap_device(pdev
);
744 for (i
= 0; i
< od
->hwmods_cnt
; i
++) {
745 ret
= omap_hwmod_assert_hardreset(od
->hwmods
[i
], name
);
754 * omap_device_deassert_hardreset - release a device's hardreset line
755 * @pdev: struct platform_device * to reset
756 * @name: const char * name of the reset line
758 * Release the hardreset line identified by @name on the IP blocks
759 * associated with the hwmods backing the platform_device @pdev. All
760 * of the hwmods associated with @pdev must have the same hardreset
761 * line linked to them for this to work. Passes along the return
762 * value of omap_hwmod_deassert_hardreset() in the event of any
763 * failure, or returns 0 upon success.
765 int omap_device_deassert_hardreset(struct platform_device
*pdev
,
768 struct omap_device
*od
= to_omap_device(pdev
);
772 for (i
= 0; i
< od
->hwmods_cnt
; i
++) {
773 ret
= omap_hwmod_deassert_hardreset(od
->hwmods
[i
], name
);
782 * omap_device_get_by_hwmod_name() - convert a hwmod name to
784 * @oh_name: name of the hwmod device
786 * Returns back a struct device * pointer associated with a hwmod
787 * device represented by a hwmod_name
789 struct device
*omap_device_get_by_hwmod_name(const char *oh_name
)
791 struct omap_hwmod
*oh
;
794 WARN(1, "%s: no hwmod name!\n", __func__
);
795 return ERR_PTR(-EINVAL
);
798 oh
= omap_hwmod_lookup(oh_name
);
800 WARN(1, "%s: no hwmod for %s\n", __func__
,
802 return ERR_PTR(-ENODEV
);
805 WARN(1, "%s: no omap_device for %s\n", __func__
,
807 return ERR_PTR(-ENODEV
);
810 return &oh
->od
->pdev
->dev
;
813 static struct notifier_block platform_nb
= {
814 .notifier_call
= _omap_device_notifier_call
,
817 static int __init
omap_device_init(void)
819 bus_register_notifier(&platform_bus_type
, &platform_nb
);
822 omap_postcore_initcall(omap_device_init
);
825 * omap_device_late_idle - idle devices without drivers
826 * @dev: struct device * associated with omap_device
829 * Check the driver bound status of this device, and idle it
830 * if there is no driver attached.
832 static int __init
omap_device_late_idle(struct device
*dev
, void *data
)
834 struct platform_device
*pdev
= to_platform_device(dev
);
835 struct omap_device
*od
= to_omap_device(pdev
);
842 * If omap_device state is enabled, but has no driver bound,
847 * Some devices (like memory controllers) are always kept
848 * enabled, and should not be idled even with no drivers.
850 for (i
= 0; i
< od
->hwmods_cnt
; i
++)
851 if (od
->hwmods
[i
]->flags
& HWMOD_INIT_NO_IDLE
)
854 if (od
->_driver_status
!= BUS_NOTIFY_BOUND_DRIVER
&&
855 od
->_driver_status
!= BUS_NOTIFY_BIND_DRIVER
) {
856 if (od
->_state
== OMAP_DEVICE_STATE_ENABLED
) {
857 dev_warn(dev
, "%s: enabled but no driver. Idling\n",
859 omap_device_idle(pdev
);
866 static int __init
omap_device_late_init(void)
868 bus_for_each_dev(&platform_bus_type
, NULL
, NULL
, omap_device_late_idle
);
872 omap_late_initcall_sync(omap_device_late_init
);