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 program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License version 2 as
15 * published by the Free Software Foundation.
17 * This code provides a consistent interface for OMAP device drivers
18 * to control power management and interconnect properties of their
21 * In the medium- to long-term, this code should either be
22 * a) implemented via arch-specific pointers in platform_data
24 * b) implemented as a proper omap_bus/omap_device in Linux, no more
25 * platform_data func pointers
28 * Guidelines for usage by driver authors:
30 * 1. These functions are intended to be used by device drivers via
31 * function pointers in struct platform_data. As an example,
32 * omap_device_enable() should be passed to the driver as
34 * struct foo_driver_platform_data {
36 * int (*device_enable)(struct platform_device *pdev);
40 * Note that the generic "device_enable" name is used, rather than
41 * "omap_device_enable". This is so other architectures can pass in their
42 * own enable/disable functions here.
44 * This should be populated during device setup:
47 * pdata->device_enable = omap_device_enable;
50 * 2. Drivers should first check to ensure the function pointer is not null
51 * before calling it, as in:
53 * if (pdata->device_enable)
54 * pdata->device_enable(pdev);
56 * This allows other architectures that don't use similar device_enable()/
57 * device_shutdown() functions to execute normally.
61 * Suggested usage by device drivers:
63 * During device initialization:
67 * (save remaining device context if necessary)
70 * During device resume:
72 * (restore context if necessary)
74 * During device shutdown:
76 * (device must be reinitialized at this point to use it again)
81 #include <linux/kernel.h>
82 #include <linux/export.h>
83 #include <linux/platform_device.h>
84 #include <linux/slab.h>
85 #include <linux/err.h>
87 #include <linux/clk.h>
88 #include <linux/clkdev.h>
89 #include <linux/pm_runtime.h>
91 #include <linux/notifier.h>
93 #include <plat/omap_device.h>
94 #include <plat/omap_hwmod.h>
95 #include <plat/clock.h>
97 /* These parameters are passed to _omap_device_{de,}activate() */
98 #define USE_WAKEUP_LAT 0
99 #define IGNORE_WAKEUP_LAT 1
101 static int omap_early_device_register(struct platform_device
*pdev
);
103 static struct omap_device_pm_latency omap_default_latency
[] = {
105 .deactivate_func
= omap_device_idle_hwmods
,
106 .activate_func
= omap_device_enable_hwmods
,
107 .flags
= OMAP_DEVICE_LATENCY_AUTO_ADJUST
,
111 /* Private functions */
114 * _omap_device_activate - increase device readiness
115 * @od: struct omap_device *
116 * @ignore_lat: increase to latency target (0) or full readiness (1)?
118 * Increase readiness of omap_device @od (thus decreasing device
119 * wakeup latency, but consuming more power). If @ignore_lat is
120 * IGNORE_WAKEUP_LAT, make the omap_device fully active. Otherwise,
121 * if @ignore_lat is USE_WAKEUP_LAT, and the device's maximum wakeup
122 * latency is greater than the requested maximum wakeup latency, step
123 * backwards in the omap_device_pm_latency table to ensure the
124 * device's maximum wakeup latency is less than or equal to the
125 * requested maximum wakeup latency. Returns 0.
127 static int _omap_device_activate(struct omap_device
*od
, u8 ignore_lat
)
129 struct timespec a
, b
, c
;
131 dev_dbg(&od
->pdev
->dev
, "omap_device: activating\n");
133 while (od
->pm_lat_level
> 0) {
134 struct omap_device_pm_latency
*odpl
;
135 unsigned long long act_lat
= 0;
139 odpl
= od
->pm_lats
+ od
->pm_lat_level
;
142 (od
->dev_wakeup_lat
<= od
->_dev_wakeup_lat_limit
))
145 read_persistent_clock(&a
);
147 /* XXX check return code */
148 odpl
->activate_func(od
);
150 read_persistent_clock(&b
);
152 c
= timespec_sub(b
, a
);
153 act_lat
= timespec_to_ns(&c
);
155 dev_dbg(&od
->pdev
->dev
,
156 "omap_device: pm_lat %d: activate: elapsed time "
157 "%llu nsec\n", od
->pm_lat_level
, act_lat
);
159 if (act_lat
> odpl
->activate_lat
) {
160 odpl
->activate_lat_worst
= act_lat
;
161 if (odpl
->flags
& OMAP_DEVICE_LATENCY_AUTO_ADJUST
) {
162 odpl
->activate_lat
= act_lat
;
163 dev_dbg(&od
->pdev
->dev
,
164 "new worst case activate latency "
166 od
->pm_lat_level
, act_lat
);
168 dev_warn(&od
->pdev
->dev
,
169 "activate latency %d "
170 "higher than exptected. (%llu > %d)\n",
171 od
->pm_lat_level
, act_lat
,
175 od
->dev_wakeup_lat
-= odpl
->activate_lat
;
182 * _omap_device_deactivate - decrease device readiness
183 * @od: struct omap_device *
184 * @ignore_lat: decrease to latency target (0) or full inactivity (1)?
186 * Decrease readiness of omap_device @od (thus increasing device
187 * wakeup latency, but conserving power). If @ignore_lat is
188 * IGNORE_WAKEUP_LAT, make the omap_device fully inactive. Otherwise,
189 * if @ignore_lat is USE_WAKEUP_LAT, and the device's maximum wakeup
190 * latency is less than the requested maximum wakeup latency, step
191 * forwards in the omap_device_pm_latency table to ensure the device's
192 * maximum wakeup latency is less than or equal to the requested
193 * maximum wakeup latency. Returns 0.
195 static int _omap_device_deactivate(struct omap_device
*od
, u8 ignore_lat
)
197 struct timespec a
, b
, c
;
199 dev_dbg(&od
->pdev
->dev
, "omap_device: deactivating\n");
201 while (od
->pm_lat_level
< od
->pm_lats_cnt
) {
202 struct omap_device_pm_latency
*odpl
;
203 unsigned long long deact_lat
= 0;
205 odpl
= od
->pm_lats
+ od
->pm_lat_level
;
208 ((od
->dev_wakeup_lat
+ odpl
->activate_lat
) >
209 od
->_dev_wakeup_lat_limit
))
212 read_persistent_clock(&a
);
214 /* XXX check return code */
215 odpl
->deactivate_func(od
);
217 read_persistent_clock(&b
);
219 c
= timespec_sub(b
, a
);
220 deact_lat
= timespec_to_ns(&c
);
222 dev_dbg(&od
->pdev
->dev
,
223 "omap_device: pm_lat %d: deactivate: elapsed time "
224 "%llu nsec\n", od
->pm_lat_level
, deact_lat
);
226 if (deact_lat
> odpl
->deactivate_lat
) {
227 odpl
->deactivate_lat_worst
= deact_lat
;
228 if (odpl
->flags
& OMAP_DEVICE_LATENCY_AUTO_ADJUST
) {
229 odpl
->deactivate_lat
= deact_lat
;
230 dev_dbg(&od
->pdev
->dev
,
231 "new worst case deactivate latency "
233 od
->pm_lat_level
, deact_lat
);
235 dev_warn(&od
->pdev
->dev
,
236 "deactivate latency %d "
237 "higher than exptected. (%llu > %d)\n",
238 od
->pm_lat_level
, deact_lat
,
239 odpl
->deactivate_lat
);
242 od
->dev_wakeup_lat
+= odpl
->activate_lat
;
250 static void _add_clkdev(struct omap_device
*od
, const char *clk_alias
,
251 const char *clk_name
)
254 struct clk_lookup
*l
;
256 if (!clk_alias
|| !clk_name
)
259 dev_dbg(&od
->pdev
->dev
, "Creating %s -> %s\n", clk_alias
, clk_name
);
261 r
= clk_get_sys(dev_name(&od
->pdev
->dev
), clk_alias
);
263 dev_warn(&od
->pdev
->dev
,
264 "alias %s already exists\n", clk_alias
);
269 r
= omap_clk_get_by_name(clk_name
);
271 dev_err(&od
->pdev
->dev
,
272 "omap_clk_get_by_name for %s failed\n", clk_name
);
276 l
= clkdev_alloc(r
, clk_alias
, dev_name(&od
->pdev
->dev
));
278 dev_err(&od
->pdev
->dev
,
279 "clkdev_alloc for %s failed\n", clk_alias
);
287 * _add_hwmod_clocks_clkdev - Add clkdev entry for hwmod optional clocks
289 * @od: struct omap_device *od
290 * @oh: struct omap_hwmod *oh
292 * For the main clock and every optional clock present per hwmod per
293 * omap_device, this function adds an entry in the clkdev table of the
294 * form <dev-id=dev_name, con-id=role> if it does not exist already.
296 * The function is called from inside omap_device_build_ss(), after
297 * omap_device_register.
299 * This allows drivers to get a pointer to its optional clocks based on its role
300 * by calling clk_get(<dev*>, <role>).
301 * In the case of the main clock, a "fck" alias is used.
305 static void _add_hwmod_clocks_clkdev(struct omap_device
*od
,
306 struct omap_hwmod
*oh
)
310 _add_clkdev(od
, "fck", oh
->main_clk
);
312 for (i
= 0; i
< oh
->opt_clks_cnt
; i
++)
313 _add_clkdev(od
, oh
->opt_clks
[i
].role
, oh
->opt_clks
[i
].clk
);
318 * omap_device_build_from_dt - build an omap_device with multiple hwmods
319 * @pdev_name: name of the platform_device driver to use
320 * @pdev_id: this platform_device's connection ID
321 * @oh: ptr to the single omap_hwmod that backs this omap_device
322 * @pdata: platform_data ptr to associate with the platform_device
323 * @pdata_len: amount of memory pointed to by @pdata
324 * @pm_lats: pointer to a omap_device_pm_latency array for this device
325 * @pm_lats_cnt: ARRAY_SIZE() of @pm_lats
326 * @is_early_device: should the device be registered as an early device or not
328 * Function for building an omap_device already registered from device-tree
330 * Returns 0 or PTR_ERR() on error.
332 static int omap_device_build_from_dt(struct platform_device
*pdev
)
334 struct omap_hwmod
**hwmods
;
335 struct omap_device
*od
;
336 struct omap_hwmod
*oh
;
337 struct device_node
*node
= pdev
->dev
.of_node
;
339 int oh_cnt
, i
, ret
= 0;
341 oh_cnt
= of_property_count_strings(node
, "ti,hwmods");
342 if (!oh_cnt
|| IS_ERR_VALUE(oh_cnt
)) {
343 dev_warn(&pdev
->dev
, "No 'hwmods' to build omap_device\n");
347 hwmods
= kzalloc(sizeof(struct omap_hwmod
*) * oh_cnt
, GFP_KERNEL
);
353 for (i
= 0; i
< oh_cnt
; i
++) {
354 of_property_read_string_index(node
, "ti,hwmods", i
, &oh_name
);
355 oh
= omap_hwmod_lookup(oh_name
);
357 dev_err(&pdev
->dev
, "Cannot lookup hwmod '%s'\n",
365 od
= omap_device_alloc(pdev
, hwmods
, oh_cnt
, NULL
, 0);
367 dev_err(&pdev
->dev
, "Cannot allocate omap_device for :%s\n",
373 if (of_get_property(node
, "ti,no_idle_on_suspend", NULL
))
374 omap_device_disable_idle_on_suspend(pdev
);
376 pdev
->dev
.pm_domain
= &omap_device_pm_domain
;
384 static int _omap_device_notifier_call(struct notifier_block
*nb
,
385 unsigned long event
, void *dev
)
387 struct platform_device
*pdev
= to_platform_device(dev
);
390 case BUS_NOTIFY_ADD_DEVICE
:
391 if (pdev
->dev
.of_node
)
392 omap_device_build_from_dt(pdev
);
395 case BUS_NOTIFY_DEL_DEVICE
:
396 if (pdev
->archdata
.od
)
397 omap_device_delete(pdev
->archdata
.od
);
405 /* Public functions for use by core code */
408 * omap_device_get_context_loss_count - get lost context count
409 * @od: struct omap_device *
411 * Using the primary hwmod, query the context loss count for this
414 * Callers should consider context for this device lost any time this
415 * function returns a value different than the value the caller got
416 * the last time it called this function.
418 * If any hwmods exist for the omap_device assoiated with @pdev,
419 * return the context loss counter for that hwmod, otherwise return
422 int omap_device_get_context_loss_count(struct platform_device
*pdev
)
424 struct omap_device
*od
;
427 od
= to_omap_device(pdev
);
430 ret
= omap_hwmod_get_context_loss_count(od
->hwmods
[0]);
436 * omap_device_count_resources - count number of struct resource entries needed
437 * @od: struct omap_device *
439 * Count the number of struct resource entries needed for this
440 * omap_device @od. Used by omap_device_build_ss() to determine how
441 * much memory to allocate before calling
442 * omap_device_fill_resources(). Returns the count.
444 static int omap_device_count_resources(struct omap_device
*od
)
449 for (i
= 0; i
< od
->hwmods_cnt
; i
++)
450 c
+= omap_hwmod_count_resources(od
->hwmods
[i
]);
452 pr_debug("omap_device: %s: counted %d total resources across %d "
453 "hwmods\n", od
->pdev
->name
, c
, od
->hwmods_cnt
);
459 * omap_device_fill_resources - fill in array of struct resource
460 * @od: struct omap_device *
461 * @res: pointer to an array of struct resource to be filled in
463 * Populate one or more empty struct resource pointed to by @res with
464 * the resource data for this omap_device @od. Used by
465 * omap_device_build_ss() after calling omap_device_count_resources().
466 * Ideally this function would not be needed at all. If omap_device
467 * replaces platform_device, then we can specify our own
468 * get_resource()/ get_irq()/etc functions that use the underlying
469 * omap_hwmod information. Or if platform_device is extended to use
470 * subarchitecture-specific function pointers, the various
471 * platform_device functions can simply call omap_device internal
472 * functions to get device resources. Hacking around the existing
473 * platform_device code wastes memory. Returns 0.
475 static int omap_device_fill_resources(struct omap_device
*od
,
476 struct resource
*res
)
481 for (i
= 0; i
< od
->hwmods_cnt
; i
++) {
482 r
= omap_hwmod_fill_resources(od
->hwmods
[i
], res
);
491 * omap_device_alloc - allocate an omap_device
492 * @pdev: platform_device that will be included in this omap_device
493 * @oh: ptr to the single omap_hwmod that backs this omap_device
494 * @pdata: platform_data ptr to associate with the platform_device
495 * @pdata_len: amount of memory pointed to by @pdata
496 * @pm_lats: pointer to a omap_device_pm_latency array for this device
497 * @pm_lats_cnt: ARRAY_SIZE() of @pm_lats
499 * Convenience function for allocating an omap_device structure and filling
500 * hwmods, resources and pm_latency attributes.
502 * Returns an struct omap_device pointer or ERR_PTR() on error;
504 struct omap_device
*omap_device_alloc(struct platform_device
*pdev
,
505 struct omap_hwmod
**ohs
, int oh_cnt
,
506 struct omap_device_pm_latency
*pm_lats
,
510 struct omap_device
*od
;
511 struct resource
*res
= NULL
;
513 struct omap_hwmod
**hwmods
;
515 od
= kzalloc(sizeof(struct omap_device
), GFP_KERNEL
);
520 od
->hwmods_cnt
= oh_cnt
;
522 hwmods
= kmemdup(ohs
, sizeof(struct omap_hwmod
*) * oh_cnt
, GFP_KERNEL
);
530 * HACK: Ideally the resources from DT should match, and hwmod
531 * should just add the missing ones. Since the name is not
532 * properly populated by DT, stick to hwmod resources only.
534 if (pdev
->num_resources
&& pdev
->resource
)
535 dev_warn(&pdev
->dev
, "%s(): resources already allocated %d\n",
536 __func__
, pdev
->num_resources
);
538 res_count
= omap_device_count_resources(od
);
540 dev_dbg(&pdev
->dev
, "%s(): resources allocated from hwmod %d\n",
541 __func__
, res_count
);
542 res
= kzalloc(sizeof(struct resource
) * res_count
, GFP_KERNEL
);
546 omap_device_fill_resources(od
, res
);
548 ret
= platform_device_add_resources(pdev
, res
, res_count
);
556 pm_lats
= omap_default_latency
;
557 pm_lats_cnt
= ARRAY_SIZE(omap_default_latency
);
560 od
->pm_lats_cnt
= pm_lats_cnt
;
561 od
->pm_lats
= kmemdup(pm_lats
,
562 sizeof(struct omap_device_pm_latency
) * pm_lats_cnt
,
567 pdev
->archdata
.od
= od
;
569 for (i
= 0; i
< oh_cnt
; i
++) {
571 _add_hwmod_clocks_clkdev(od
, hwmods
[i
]);
581 dev_err(&pdev
->dev
, "omap_device: build failed (%d)\n", ret
);
586 void omap_device_delete(struct omap_device
*od
)
591 od
->pdev
->archdata
.od
= NULL
;
598 * omap_device_build - build and register an omap_device with one omap_hwmod
599 * @pdev_name: name of the platform_device driver to use
600 * @pdev_id: this platform_device's connection ID
601 * @oh: ptr to the single omap_hwmod that backs this omap_device
602 * @pdata: platform_data ptr to associate with the platform_device
603 * @pdata_len: amount of memory pointed to by @pdata
604 * @pm_lats: pointer to a omap_device_pm_latency array for this device
605 * @pm_lats_cnt: ARRAY_SIZE() of @pm_lats
606 * @is_early_device: should the device be registered as an early device or not
608 * Convenience function for building and registering a single
609 * omap_device record, which in turn builds and registers a
610 * platform_device record. See omap_device_build_ss() for more
611 * information. Returns ERR_PTR(-EINVAL) if @oh is NULL; otherwise,
612 * passes along the return value of omap_device_build_ss().
614 struct platform_device __init
*omap_device_build(const char *pdev_name
, int pdev_id
,
615 struct omap_hwmod
*oh
, void *pdata
,
617 struct omap_device_pm_latency
*pm_lats
,
618 int pm_lats_cnt
, int is_early_device
)
620 struct omap_hwmod
*ohs
[] = { oh
};
623 return ERR_PTR(-EINVAL
);
625 return omap_device_build_ss(pdev_name
, pdev_id
, ohs
, 1, pdata
,
626 pdata_len
, pm_lats
, pm_lats_cnt
,
631 * omap_device_build_ss - build and register an omap_device with multiple hwmods
632 * @pdev_name: name of the platform_device driver to use
633 * @pdev_id: this platform_device's connection ID
634 * @oh: ptr to the single omap_hwmod that backs this omap_device
635 * @pdata: platform_data ptr to associate with the platform_device
636 * @pdata_len: amount of memory pointed to by @pdata
637 * @pm_lats: pointer to a omap_device_pm_latency array for this device
638 * @pm_lats_cnt: ARRAY_SIZE() of @pm_lats
639 * @is_early_device: should the device be registered as an early device or not
641 * Convenience function for building and registering an omap_device
642 * subsystem record. Subsystem records consist of multiple
643 * omap_hwmods. This function in turn builds and registers a
644 * platform_device record. Returns an ERR_PTR() on error, or passes
645 * along the return value of omap_device_register().
647 struct platform_device __init
*omap_device_build_ss(const char *pdev_name
, int pdev_id
,
648 struct omap_hwmod
**ohs
, int oh_cnt
,
649 void *pdata
, int pdata_len
,
650 struct omap_device_pm_latency
*pm_lats
,
651 int pm_lats_cnt
, int is_early_device
)
654 struct platform_device
*pdev
;
655 struct omap_device
*od
;
657 if (!ohs
|| oh_cnt
== 0 || !pdev_name
)
658 return ERR_PTR(-EINVAL
);
660 if (!pdata
&& pdata_len
> 0)
661 return ERR_PTR(-EINVAL
);
663 pdev
= platform_device_alloc(pdev_name
, pdev_id
);
669 /* Set the dev_name early to allow dev_xxx in omap_device_alloc */
671 dev_set_name(&pdev
->dev
, "%s.%d", pdev
->name
, pdev
->id
);
673 dev_set_name(&pdev
->dev
, "%s", pdev
->name
);
675 od
= omap_device_alloc(pdev
, ohs
, oh_cnt
, pm_lats
, pm_lats_cnt
);
679 ret
= platform_device_add_data(pdev
, pdata
, pdata_len
);
684 ret
= omap_early_device_register(pdev
);
686 ret
= omap_device_register(pdev
);
693 omap_device_delete(od
);
695 platform_device_put(pdev
);
698 pr_err("omap_device: %s: build failed (%d)\n", pdev_name
, ret
);
704 * omap_early_device_register - register an omap_device as an early platform
706 * @od: struct omap_device * to register
708 * Register the omap_device structure. This currently just calls
709 * platform_early_add_device() on the underlying platform_device.
710 * Returns 0 by default.
712 static int __init
omap_early_device_register(struct platform_device
*pdev
)
714 struct platform_device
*devices
[1];
717 early_platform_add_devices(devices
, 1);
721 #ifdef CONFIG_PM_RUNTIME
722 static int _od_runtime_suspend(struct device
*dev
)
724 struct platform_device
*pdev
= to_platform_device(dev
);
727 ret
= pm_generic_runtime_suspend(dev
);
730 omap_device_idle(pdev
);
735 static int _od_runtime_idle(struct device
*dev
)
737 return pm_generic_runtime_idle(dev
);
740 static int _od_runtime_resume(struct device
*dev
)
742 struct platform_device
*pdev
= to_platform_device(dev
);
744 omap_device_enable(pdev
);
746 return pm_generic_runtime_resume(dev
);
750 #ifdef CONFIG_SUSPEND
751 static int _od_suspend_noirq(struct device
*dev
)
753 struct platform_device
*pdev
= to_platform_device(dev
);
754 struct omap_device
*od
= to_omap_device(pdev
);
757 if (od
->flags
& OMAP_DEVICE_NO_IDLE_ON_SUSPEND
)
758 return pm_generic_suspend_noirq(dev
);
760 ret
= pm_generic_suspend_noirq(dev
);
762 if (!ret
&& !pm_runtime_status_suspended(dev
)) {
763 if (pm_generic_runtime_suspend(dev
) == 0) {
764 omap_device_idle(pdev
);
765 od
->flags
|= OMAP_DEVICE_SUSPENDED
;
772 static int _od_resume_noirq(struct device
*dev
)
774 struct platform_device
*pdev
= to_platform_device(dev
);
775 struct omap_device
*od
= to_omap_device(pdev
);
777 if (od
->flags
& OMAP_DEVICE_NO_IDLE_ON_SUSPEND
)
778 return pm_generic_resume_noirq(dev
);
780 if ((od
->flags
& OMAP_DEVICE_SUSPENDED
) &&
781 !pm_runtime_status_suspended(dev
)) {
782 od
->flags
&= ~OMAP_DEVICE_SUSPENDED
;
783 omap_device_enable(pdev
);
784 pm_generic_runtime_resume(dev
);
787 return pm_generic_resume_noirq(dev
);
790 #define _od_suspend_noirq NULL
791 #define _od_resume_noirq NULL
794 struct dev_pm_domain omap_device_pm_domain
= {
796 SET_RUNTIME_PM_OPS(_od_runtime_suspend
, _od_runtime_resume
,
798 USE_PLATFORM_PM_SLEEP_OPS
799 .suspend_noirq
= _od_suspend_noirq
,
800 .resume_noirq
= _od_resume_noirq
,
805 * omap_device_register - register an omap_device with one omap_hwmod
806 * @od: struct omap_device * to register
808 * Register the omap_device structure. This currently just calls
809 * platform_device_register() on the underlying platform_device.
810 * Returns the return value of platform_device_register().
812 int omap_device_register(struct platform_device
*pdev
)
814 pr_debug("omap_device: %s: registering\n", pdev
->name
);
816 pdev
->dev
.pm_domain
= &omap_device_pm_domain
;
817 return platform_device_add(pdev
);
821 /* Public functions for use by device drivers through struct platform_data */
824 * omap_device_enable - fully activate an omap_device
825 * @od: struct omap_device * to activate
827 * Do whatever is necessary for the hwmods underlying omap_device @od
828 * to be accessible and ready to operate. This generally involves
829 * enabling clocks, setting SYSCONFIG registers; and in the future may
830 * involve remuxing pins. Device drivers should call this function
831 * (through platform_data function pointers) where they would normally
832 * enable clocks, etc. Returns -EINVAL if called when the omap_device
833 * is already enabled, or passes along the return value of
834 * _omap_device_activate().
836 int omap_device_enable(struct platform_device
*pdev
)
839 struct omap_device
*od
;
841 od
= to_omap_device(pdev
);
843 if (od
->_state
== OMAP_DEVICE_STATE_ENABLED
) {
845 "omap_device: %s() called from invalid state %d\n",
846 __func__
, od
->_state
);
850 /* Enable everything if we're enabling this device from scratch */
851 if (od
->_state
== OMAP_DEVICE_STATE_UNKNOWN
)
852 od
->pm_lat_level
= od
->pm_lats_cnt
;
854 ret
= _omap_device_activate(od
, IGNORE_WAKEUP_LAT
);
856 od
->dev_wakeup_lat
= 0;
857 od
->_dev_wakeup_lat_limit
= UINT_MAX
;
858 od
->_state
= OMAP_DEVICE_STATE_ENABLED
;
864 * omap_device_idle - idle an omap_device
865 * @od: struct omap_device * to idle
867 * Idle omap_device @od by calling as many .deactivate_func() entries
868 * in the omap_device's pm_lats table as is possible without exceeding
869 * the device's maximum wakeup latency limit, pm_lat_limit. Device
870 * drivers should call this function (through platform_data function
871 * pointers) where they would normally disable clocks after operations
872 * complete, etc.. Returns -EINVAL if the omap_device is not
873 * currently enabled, or passes along the return value of
874 * _omap_device_deactivate().
876 int omap_device_idle(struct platform_device
*pdev
)
879 struct omap_device
*od
;
881 od
= to_omap_device(pdev
);
883 if (od
->_state
!= OMAP_DEVICE_STATE_ENABLED
) {
885 "omap_device: %s() called from invalid state %d\n",
886 __func__
, od
->_state
);
890 ret
= _omap_device_deactivate(od
, USE_WAKEUP_LAT
);
892 od
->_state
= OMAP_DEVICE_STATE_IDLE
;
898 * omap_device_shutdown - shut down an omap_device
899 * @od: struct omap_device * to shut down
901 * Shut down omap_device @od by calling all .deactivate_func() entries
902 * in the omap_device's pm_lats table and then shutting down all of
903 * the underlying omap_hwmods. Used when a device is being "removed"
904 * or a device driver is being unloaded. Returns -EINVAL if the
905 * omap_device is not currently enabled or idle, or passes along the
906 * return value of _omap_device_deactivate().
908 int omap_device_shutdown(struct platform_device
*pdev
)
911 struct omap_device
*od
;
913 od
= to_omap_device(pdev
);
915 if (od
->_state
!= OMAP_DEVICE_STATE_ENABLED
&&
916 od
->_state
!= OMAP_DEVICE_STATE_IDLE
) {
918 "omap_device: %s() called from invalid state %d\n",
919 __func__
, od
->_state
);
923 ret
= _omap_device_deactivate(od
, IGNORE_WAKEUP_LAT
);
925 for (i
= 0; i
< od
->hwmods_cnt
; i
++)
926 omap_hwmod_shutdown(od
->hwmods
[i
]);
928 od
->_state
= OMAP_DEVICE_STATE_SHUTDOWN
;
934 * omap_device_align_pm_lat - activate/deactivate device to match wakeup lat lim
935 * @od: struct omap_device *
937 * When a device's maximum wakeup latency limit changes, call some of
938 * the .activate_func or .deactivate_func function pointers in the
939 * omap_device's pm_lats array to ensure that the device's maximum
940 * wakeup latency is less than or equal to the new latency limit.
941 * Intended to be called by OMAP PM code whenever a device's maximum
942 * wakeup latency limit changes (e.g., via
943 * omap_pm_set_dev_wakeup_lat()). Returns 0 if nothing needs to be
944 * done (e.g., if the omap_device is not currently idle, or if the
945 * wakeup latency is already current with the new limit) or passes
946 * along the return value of _omap_device_deactivate() or
947 * _omap_device_activate().
949 int omap_device_align_pm_lat(struct platform_device
*pdev
,
950 u32 new_wakeup_lat_limit
)
953 struct omap_device
*od
;
955 od
= to_omap_device(pdev
);
957 if (new_wakeup_lat_limit
== od
->dev_wakeup_lat
)
960 od
->_dev_wakeup_lat_limit
= new_wakeup_lat_limit
;
962 if (od
->_state
!= OMAP_DEVICE_STATE_IDLE
)
964 else if (new_wakeup_lat_limit
> od
->dev_wakeup_lat
)
965 ret
= _omap_device_deactivate(od
, USE_WAKEUP_LAT
);
966 else if (new_wakeup_lat_limit
< od
->dev_wakeup_lat
)
967 ret
= _omap_device_activate(od
, USE_WAKEUP_LAT
);
973 * omap_device_get_pwrdm - return the powerdomain * associated with @od
974 * @od: struct omap_device *
976 * Return the powerdomain associated with the first underlying
977 * omap_hwmod for this omap_device. Intended for use by core OMAP PM
978 * code. Returns NULL on error or a struct powerdomain * upon
981 struct powerdomain
*omap_device_get_pwrdm(struct omap_device
*od
)
984 * XXX Assumes that all omap_hwmod powerdomains are identical.
985 * This may not necessarily be true. There should be a sanity
986 * check in here to WARN() if any difference appears.
991 return omap_hwmod_get_pwrdm(od
->hwmods
[0]);
995 * omap_device_get_mpu_rt_va - return the MPU's virtual addr for the hwmod base
996 * @od: struct omap_device *
998 * Return the MPU's virtual address for the base of the hwmod, from
999 * the ioremap() that the hwmod code does. Only valid if there is one
1000 * hwmod associated with this device. Returns NULL if there are zero
1001 * or more than one hwmods associated with this omap_device;
1002 * otherwise, passes along the return value from
1003 * omap_hwmod_get_mpu_rt_va().
1005 void __iomem
*omap_device_get_rt_va(struct omap_device
*od
)
1007 if (od
->hwmods_cnt
!= 1)
1010 return omap_hwmod_get_mpu_rt_va(od
->hwmods
[0]);
1014 * omap_device_get_by_hwmod_name() - convert a hwmod name to
1016 * @oh_name: name of the hwmod device
1018 * Returns back a struct device * pointer associated with a hwmod
1019 * device represented by a hwmod_name
1021 struct device
*omap_device_get_by_hwmod_name(const char *oh_name
)
1023 struct omap_hwmod
*oh
;
1026 WARN(1, "%s: no hwmod name!\n", __func__
);
1027 return ERR_PTR(-EINVAL
);
1030 oh
= omap_hwmod_lookup(oh_name
);
1031 if (IS_ERR_OR_NULL(oh
)) {
1032 WARN(1, "%s: no hwmod for %s\n", __func__
,
1034 return ERR_PTR(oh
? PTR_ERR(oh
) : -ENODEV
);
1036 if (IS_ERR_OR_NULL(oh
->od
)) {
1037 WARN(1, "%s: no omap_device for %s\n", __func__
,
1039 return ERR_PTR(oh
->od
? PTR_ERR(oh
->od
) : -ENODEV
);
1042 if (IS_ERR_OR_NULL(oh
->od
->pdev
))
1043 return ERR_PTR(oh
->od
->pdev
? PTR_ERR(oh
->od
->pdev
) : -ENODEV
);
1045 return &oh
->od
->pdev
->dev
;
1047 EXPORT_SYMBOL(omap_device_get_by_hwmod_name
);
1050 * Public functions intended for use in omap_device_pm_latency
1051 * .activate_func and .deactivate_func function pointers
1055 * omap_device_enable_hwmods - call omap_hwmod_enable() on all hwmods
1056 * @od: struct omap_device *od
1058 * Enable all underlying hwmods. Returns 0.
1060 int omap_device_enable_hwmods(struct omap_device
*od
)
1064 for (i
= 0; i
< od
->hwmods_cnt
; i
++)
1065 omap_hwmod_enable(od
->hwmods
[i
]);
1067 /* XXX pass along return value here? */
1072 * omap_device_idle_hwmods - call omap_hwmod_idle() on all hwmods
1073 * @od: struct omap_device *od
1075 * Idle all underlying hwmods. Returns 0.
1077 int omap_device_idle_hwmods(struct omap_device
*od
)
1081 for (i
= 0; i
< od
->hwmods_cnt
; i
++)
1082 omap_hwmod_idle(od
->hwmods
[i
]);
1084 /* XXX pass along return value here? */
1089 * omap_device_disable_clocks - disable all main and interface clocks
1090 * @od: struct omap_device *od
1092 * Disable the main functional clock and interface clock for all of the
1093 * omap_hwmods associated with the omap_device. Returns 0.
1095 int omap_device_disable_clocks(struct omap_device
*od
)
1099 for (i
= 0; i
< od
->hwmods_cnt
; i
++)
1100 omap_hwmod_disable_clocks(od
->hwmods
[i
]);
1102 /* XXX pass along return value here? */
1107 * omap_device_enable_clocks - enable all main and interface clocks
1108 * @od: struct omap_device *od
1110 * Enable the main functional clock and interface clock for all of the
1111 * omap_hwmods associated with the omap_device. Returns 0.
1113 int omap_device_enable_clocks(struct omap_device
*od
)
1117 for (i
= 0; i
< od
->hwmods_cnt
; i
++)
1118 omap_hwmod_enable_clocks(od
->hwmods
[i
]);
1120 /* XXX pass along return value here? */
1124 static struct notifier_block platform_nb
= {
1125 .notifier_call
= _omap_device_notifier_call
,
1128 static int __init
omap_device_init(void)
1130 bus_register_notifier(&platform_bus_type
, &platform_nb
);
1133 core_initcall(omap_device_init
);