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 either be
21 * a) implemented via arch-specific pointers in platform_data
23 * b) implemented as a proper omap_bus/omap_device in Linux, no more
24 * platform_data func pointers
27 * Guidelines for usage by driver authors:
29 * 1. These functions are intended to be used by device drivers via
30 * function pointers in struct platform_data. As an example,
31 * omap_device_enable() should be passed to the driver as
33 * struct foo_driver_platform_data {
35 * int (*device_enable)(struct platform_device *pdev);
39 * Note that the generic "device_enable" name is used, rather than
40 * "omap_device_enable". This is so other architectures can pass in their
41 * own enable/disable functions here.
43 * This should be populated during device setup:
46 * pdata->device_enable = omap_device_enable;
49 * 2. Drivers should first check to ensure the function pointer is not null
50 * before calling it, as in:
52 * if (pdata->device_enable)
53 * pdata->device_enable(pdev);
55 * This allows other architectures that don't use similar device_enable()/
56 * device_shutdown() functions to execute normally.
60 * Suggested usage by device drivers:
62 * During device initialization:
66 * (save remaining device context if necessary)
69 * During device resume:
71 * (restore context if necessary)
73 * During device shutdown:
75 * (device must be reinitialized at this point to use it again)
80 #include <linux/kernel.h>
81 #include <linux/export.h>
82 #include <linux/platform_device.h>
83 #include <linux/slab.h>
84 #include <linux/err.h>
86 #include <linux/clk.h>
87 #include <linux/clkdev.h>
88 #include <linux/pm_runtime.h>
90 #include <linux/notifier.h>
92 #include <plat/omap_device.h>
93 #include <plat/omap_hwmod.h>
94 #include <plat/clock.h>
96 /* These parameters are passed to _omap_device_{de,}activate() */
97 #define USE_WAKEUP_LAT 0
98 #define IGNORE_WAKEUP_LAT 1
100 static int omap_early_device_register(struct platform_device *pdev);
102 static struct omap_device_pm_latency omap_default_latency[] = {
104 .deactivate_func = omap_device_idle_hwmods,
105 .activate_func = omap_device_enable_hwmods,
106 .flags = OMAP_DEVICE_LATENCY_AUTO_ADJUST,
110 /* Private functions */
113 * _omap_device_activate - increase device readiness
114 * @od: struct omap_device *
115 * @ignore_lat: increase to latency target (0) or full readiness (1)?
117 * Increase readiness of omap_device @od (thus decreasing device
118 * wakeup latency, but consuming more power). If @ignore_lat is
119 * IGNORE_WAKEUP_LAT, make the omap_device fully active. Otherwise,
120 * if @ignore_lat is USE_WAKEUP_LAT, and the device's maximum wakeup
121 * latency is greater than the requested maximum wakeup latency, step
122 * backwards in the omap_device_pm_latency table to ensure the
123 * device's maximum wakeup latency is less than or equal to the
124 * requested maximum wakeup latency. Returns 0.
126 static int _omap_device_activate(struct omap_device *od, u8 ignore_lat)
128 struct timespec a, b, c;
130 dev_dbg(&od->pdev->dev, "omap_device: activating\n");
132 while (od->pm_lat_level > 0) {
133 struct omap_device_pm_latency *odpl;
134 unsigned long long act_lat = 0;
138 odpl = od->pm_lats + od->pm_lat_level;
141 (od->dev_wakeup_lat <= od->_dev_wakeup_lat_limit))
144 read_persistent_clock(&a);
146 /* XXX check return code */
147 odpl->activate_func(od);
149 read_persistent_clock(&b);
151 c = timespec_sub(b, a);
152 act_lat = timespec_to_ns(&c);
154 dev_dbg(&od->pdev->dev,
155 "omap_device: pm_lat %d: activate: elapsed time %llu nsec\n",
156 od->pm_lat_level, act_lat);
158 if (act_lat > odpl->activate_lat) {
159 odpl->activate_lat_worst = act_lat;
160 if (odpl->flags & OMAP_DEVICE_LATENCY_AUTO_ADJUST) {
161 odpl->activate_lat = act_lat;
162 dev_dbg(&od->pdev->dev,
163 "new worst case activate latency %d: %llu\n",
164 od->pm_lat_level, act_lat);
166 dev_warn(&od->pdev->dev,
167 "activate latency %d higher than expected. (%llu > %d)\n",
168 od->pm_lat_level, act_lat,
172 od->dev_wakeup_lat -= odpl->activate_lat;
179 * _omap_device_deactivate - decrease device readiness
180 * @od: struct omap_device *
181 * @ignore_lat: decrease to latency target (0) or full inactivity (1)?
183 * Decrease readiness of omap_device @od (thus increasing device
184 * wakeup latency, but conserving power). If @ignore_lat is
185 * IGNORE_WAKEUP_LAT, make the omap_device fully inactive. Otherwise,
186 * if @ignore_lat is USE_WAKEUP_LAT, and the device's maximum wakeup
187 * latency is less than the requested maximum wakeup latency, step
188 * forwards in the omap_device_pm_latency table to ensure the device's
189 * maximum wakeup latency is less than or equal to the requested
190 * maximum wakeup latency. Returns 0.
192 static int _omap_device_deactivate(struct omap_device *od, u8 ignore_lat)
194 struct timespec a, b, c;
196 dev_dbg(&od->pdev->dev, "omap_device: deactivating\n");
198 while (od->pm_lat_level < od->pm_lats_cnt) {
199 struct omap_device_pm_latency *odpl;
200 unsigned long long deact_lat = 0;
202 odpl = od->pm_lats + od->pm_lat_level;
205 ((od->dev_wakeup_lat + odpl->activate_lat) >
206 od->_dev_wakeup_lat_limit))
209 read_persistent_clock(&a);
211 /* XXX check return code */
212 odpl->deactivate_func(od);
214 read_persistent_clock(&b);
216 c = timespec_sub(b, a);
217 deact_lat = timespec_to_ns(&c);
219 dev_dbg(&od->pdev->dev,
220 "omap_device: pm_lat %d: deactivate: elapsed time %llu nsec\n",
221 od->pm_lat_level, deact_lat);
223 if (deact_lat > odpl->deactivate_lat) {
224 odpl->deactivate_lat_worst = deact_lat;
225 if (odpl->flags & OMAP_DEVICE_LATENCY_AUTO_ADJUST) {
226 odpl->deactivate_lat = deact_lat;
227 dev_dbg(&od->pdev->dev,
228 "new worst case deactivate latency %d: %llu\n",
229 od->pm_lat_level, deact_lat);
231 dev_warn(&od->pdev->dev,
232 "deactivate latency %d higher than expected. (%llu > %d)\n",
233 od->pm_lat_level, deact_lat,
234 odpl->deactivate_lat);
237 od->dev_wakeup_lat += odpl->activate_lat;
245 static void _add_clkdev(struct omap_device *od, const char *clk_alias,
246 const char *clk_name)
249 struct clk_lookup *l;
251 if (!clk_alias || !clk_name)
254 dev_dbg(&od->pdev->dev, "Creating %s -> %s\n", clk_alias, clk_name);
256 r = clk_get_sys(dev_name(&od->pdev->dev), clk_alias);
258 dev_warn(&od->pdev->dev,
259 "alias %s already exists\n", clk_alias);
264 r = clk_get(NULL, clk_name);
266 dev_err(&od->pdev->dev,
267 "clk_get for %s failed\n", clk_name);
271 l = clkdev_alloc(r, clk_alias, dev_name(&od->pdev->dev));
273 dev_err(&od->pdev->dev,
274 "clkdev_alloc for %s failed\n", clk_alias);
282 * _add_hwmod_clocks_clkdev - Add clkdev entry for hwmod optional clocks
284 * @od: struct omap_device *od
285 * @oh: struct omap_hwmod *oh
287 * For the main clock and every optional clock present per hwmod per
288 * omap_device, this function adds an entry in the clkdev table of the
289 * form <dev-id=dev_name, con-id=role> if it does not exist already.
291 * The function is called from inside omap_device_build_ss(), after
292 * omap_device_register.
294 * This allows drivers to get a pointer to its optional clocks based on its role
295 * by calling clk_get(<dev*>, <role>).
296 * In the case of the main clock, a "fck" alias is used.
300 static void _add_hwmod_clocks_clkdev(struct omap_device *od,
301 struct omap_hwmod *oh)
305 _add_clkdev(od, "fck", oh->main_clk);
307 for (i = 0; i < oh->opt_clks_cnt; i++)
308 _add_clkdev(od, oh->opt_clks[i].role, oh->opt_clks[i].clk);
313 * omap_device_build_from_dt - build an omap_device with multiple hwmods
314 * @pdev_name: name of the platform_device driver to use
315 * @pdev_id: this platform_device's connection ID
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
319 * @pm_lats: pointer to a omap_device_pm_latency array for this device
320 * @pm_lats_cnt: ARRAY_SIZE() of @pm_lats
321 * @is_early_device: should the device be registered as an early device or not
323 * Function for building an omap_device already registered from device-tree
325 * Returns 0 or PTR_ERR() on error.
327 static int omap_device_build_from_dt(struct platform_device *pdev)
329 struct omap_hwmod **hwmods;
330 struct omap_device *od;
331 struct omap_hwmod *oh;
332 struct device_node *node = pdev->dev.of_node;
334 int oh_cnt, i, ret = 0;
336 oh_cnt = of_property_count_strings(node, "ti,hwmods");
337 if (!oh_cnt || IS_ERR_VALUE(oh_cnt)) {
338 dev_dbg(&pdev->dev, "No 'hwmods' to build omap_device\n");
342 hwmods = kzalloc(sizeof(struct omap_hwmod *) * oh_cnt, GFP_KERNEL);
348 for (i = 0; i < oh_cnt; i++) {
349 of_property_read_string_index(node, "ti,hwmods", i, &oh_name);
350 oh = omap_hwmod_lookup(oh_name);
352 dev_err(&pdev->dev, "Cannot lookup hwmod '%s'\n",
360 od = omap_device_alloc(pdev, hwmods, oh_cnt, NULL, 0);
362 dev_err(&pdev->dev, "Cannot allocate omap_device for :%s\n",
368 if (of_get_property(node, "ti,no_idle_on_suspend", NULL))
369 omap_device_disable_idle_on_suspend(pdev);
371 pdev->dev.pm_domain = &omap_device_pm_domain;
379 static int _omap_device_notifier_call(struct notifier_block *nb,
380 unsigned long event, void *dev)
382 struct platform_device *pdev = to_platform_device(dev);
385 case BUS_NOTIFY_ADD_DEVICE:
386 if (pdev->dev.of_node)
387 omap_device_build_from_dt(pdev);
390 case BUS_NOTIFY_DEL_DEVICE:
391 if (pdev->archdata.od)
392 omap_device_delete(pdev->archdata.od);
400 /* Public functions for use by core code */
403 * omap_device_get_context_loss_count - get lost context count
404 * @od: struct omap_device *
406 * Using the primary hwmod, query the context loss count for this
409 * Callers should consider context for this device lost any time this
410 * function returns a value different than the value the caller got
411 * the last time it called this function.
413 * If any hwmods exist for the omap_device assoiated with @pdev,
414 * return the context loss counter for that hwmod, otherwise return
417 int omap_device_get_context_loss_count(struct platform_device *pdev)
419 struct omap_device *od;
422 od = to_omap_device(pdev);
425 ret = omap_hwmod_get_context_loss_count(od->hwmods[0]);
431 * omap_device_count_resources - count number of struct resource entries needed
432 * @od: struct omap_device *
434 * Count the number of struct resource entries needed for this
435 * omap_device @od. Used by omap_device_build_ss() to determine how
436 * much memory to allocate before calling
437 * omap_device_fill_resources(). Returns the count.
439 static int omap_device_count_resources(struct omap_device *od)
444 for (i = 0; i < od->hwmods_cnt; i++)
445 c += omap_hwmod_count_resources(od->hwmods[i]);
447 pr_debug("omap_device: %s: counted %d total resources across %d hwmods\n",
448 od->pdev->name, c, od->hwmods_cnt);
454 * omap_device_fill_resources - fill in array of struct resource
455 * @od: struct omap_device *
456 * @res: pointer to an array of struct resource to be filled in
458 * Populate one or more empty struct resource pointed to by @res with
459 * the resource data for this omap_device @od. Used by
460 * omap_device_build_ss() after calling omap_device_count_resources().
461 * Ideally this function would not be needed at all. If omap_device
462 * replaces platform_device, then we can specify our own
463 * get_resource()/ get_irq()/etc functions that use the underlying
464 * omap_hwmod information. Or if platform_device is extended to use
465 * subarchitecture-specific function pointers, the various
466 * platform_device functions can simply call omap_device internal
467 * functions to get device resources. Hacking around the existing
468 * platform_device code wastes memory. Returns 0.
470 static int omap_device_fill_resources(struct omap_device *od,
471 struct resource *res)
475 for (i = 0; i < od->hwmods_cnt; i++) {
476 r = omap_hwmod_fill_resources(od->hwmods[i], res);
484 * omap_device_alloc - allocate an omap_device
485 * @pdev: platform_device that will be included in this omap_device
486 * @oh: ptr to the single omap_hwmod that backs this omap_device
487 * @pdata: platform_data ptr to associate with the platform_device
488 * @pdata_len: amount of memory pointed to by @pdata
489 * @pm_lats: pointer to a omap_device_pm_latency array for this device
490 * @pm_lats_cnt: ARRAY_SIZE() of @pm_lats
492 * Convenience function for allocating an omap_device structure and filling
493 * hwmods, resources and pm_latency attributes.
495 * Returns an struct omap_device pointer or ERR_PTR() on error;
497 struct omap_device *omap_device_alloc(struct platform_device *pdev,
498 struct omap_hwmod **ohs, int oh_cnt,
499 struct omap_device_pm_latency *pm_lats,
503 struct omap_device *od;
504 struct resource *res = NULL;
506 struct omap_hwmod **hwmods;
508 od = kzalloc(sizeof(struct omap_device), GFP_KERNEL);
513 od->hwmods_cnt = oh_cnt;
515 hwmods = kmemdup(ohs, sizeof(struct omap_hwmod *) * oh_cnt, GFP_KERNEL);
523 * HACK: Ideally the resources from DT should match, and hwmod
524 * should just add the missing ones. Since the name is not
525 * properly populated by DT, stick to hwmod resources only.
527 if (pdev->num_resources && pdev->resource)
528 dev_warn(&pdev->dev, "%s(): resources already allocated %d\n",
529 __func__, pdev->num_resources);
531 res_count = omap_device_count_resources(od);
533 dev_dbg(&pdev->dev, "%s(): resources allocated from hwmod %d\n",
534 __func__, res_count);
535 res = kzalloc(sizeof(struct resource) * res_count, GFP_KERNEL);
539 omap_device_fill_resources(od, res);
541 ret = platform_device_add_resources(pdev, res, res_count);
549 pm_lats = omap_default_latency;
550 pm_lats_cnt = ARRAY_SIZE(omap_default_latency);
553 od->pm_lats_cnt = pm_lats_cnt;
554 od->pm_lats = kmemdup(pm_lats,
555 sizeof(struct omap_device_pm_latency) * pm_lats_cnt,
560 pdev->archdata.od = od;
562 for (i = 0; i < oh_cnt; i++) {
564 _add_hwmod_clocks_clkdev(od, hwmods[i]);
574 dev_err(&pdev->dev, "omap_device: build failed (%d)\n", ret);
579 void omap_device_delete(struct omap_device *od)
584 od->pdev->archdata.od = NULL;
591 * omap_device_build - build and register an omap_device with one omap_hwmod
592 * @pdev_name: name of the platform_device driver to use
593 * @pdev_id: this platform_device's connection ID
594 * @oh: ptr to the single omap_hwmod that backs this omap_device
595 * @pdata: platform_data ptr to associate with the platform_device
596 * @pdata_len: amount of memory pointed to by @pdata
597 * @pm_lats: pointer to a omap_device_pm_latency array for this device
598 * @pm_lats_cnt: ARRAY_SIZE() of @pm_lats
599 * @is_early_device: should the device be registered as an early device or not
601 * Convenience function for building and registering a single
602 * omap_device record, which in turn builds and registers a
603 * platform_device record. See omap_device_build_ss() for more
604 * information. Returns ERR_PTR(-EINVAL) if @oh is NULL; otherwise,
605 * passes along the return value of omap_device_build_ss().
607 struct platform_device __init *omap_device_build(const char *pdev_name, int pdev_id,
608 struct omap_hwmod *oh, void *pdata,
610 struct omap_device_pm_latency *pm_lats,
611 int pm_lats_cnt, int is_early_device)
613 struct omap_hwmod *ohs[] = { oh };
616 return ERR_PTR(-EINVAL);
618 return omap_device_build_ss(pdev_name, pdev_id, ohs, 1, pdata,
619 pdata_len, pm_lats, pm_lats_cnt,
624 * omap_device_build_ss - build and register an omap_device with multiple hwmods
625 * @pdev_name: name of the platform_device driver to use
626 * @pdev_id: this platform_device's connection ID
627 * @oh: ptr to the single omap_hwmod that backs this omap_device
628 * @pdata: platform_data ptr to associate with the platform_device
629 * @pdata_len: amount of memory pointed to by @pdata
630 * @pm_lats: pointer to a omap_device_pm_latency array for this device
631 * @pm_lats_cnt: ARRAY_SIZE() of @pm_lats
632 * @is_early_device: should the device be registered as an early device or not
634 * Convenience function for building and registering an omap_device
635 * subsystem record. Subsystem records consist of multiple
636 * omap_hwmods. This function in turn builds and registers a
637 * platform_device record. Returns an ERR_PTR() on error, or passes
638 * along the return value of omap_device_register().
640 struct platform_device __init *omap_device_build_ss(const char *pdev_name, int pdev_id,
641 struct omap_hwmod **ohs, int oh_cnt,
642 void *pdata, int pdata_len,
643 struct omap_device_pm_latency *pm_lats,
644 int pm_lats_cnt, int is_early_device)
647 struct platform_device *pdev;
648 struct omap_device *od;
650 if (!ohs || oh_cnt == 0 || !pdev_name)
651 return ERR_PTR(-EINVAL);
653 if (!pdata && pdata_len > 0)
654 return ERR_PTR(-EINVAL);
656 pdev = platform_device_alloc(pdev_name, pdev_id);
662 /* Set the dev_name early to allow dev_xxx in omap_device_alloc */
664 dev_set_name(&pdev->dev, "%s.%d", pdev->name, pdev->id);
666 dev_set_name(&pdev->dev, "%s", pdev->name);
668 od = omap_device_alloc(pdev, ohs, oh_cnt, pm_lats, pm_lats_cnt);
672 ret = platform_device_add_data(pdev, pdata, pdata_len);
677 ret = omap_early_device_register(pdev);
679 ret = omap_device_register(pdev);
686 omap_device_delete(od);
688 platform_device_put(pdev);
691 pr_err("omap_device: %s: build failed (%d)\n", pdev_name, ret);
697 * omap_early_device_register - register an omap_device as an early platform
699 * @od: struct omap_device * to register
701 * Register the omap_device structure. This currently just calls
702 * platform_early_add_device() on the underlying platform_device.
703 * Returns 0 by default.
705 static int __init omap_early_device_register(struct platform_device *pdev)
707 struct platform_device *devices[1];
710 early_platform_add_devices(devices, 1);
714 #ifdef CONFIG_PM_RUNTIME
715 static int _od_runtime_suspend(struct device *dev)
717 struct platform_device *pdev = to_platform_device(dev);
720 ret = pm_generic_runtime_suspend(dev);
723 omap_device_idle(pdev);
728 static int _od_runtime_idle(struct device *dev)
730 return pm_generic_runtime_idle(dev);
733 static int _od_runtime_resume(struct device *dev)
735 struct platform_device *pdev = to_platform_device(dev);
737 omap_device_enable(pdev);
739 return pm_generic_runtime_resume(dev);
743 #ifdef CONFIG_SUSPEND
744 static int _od_suspend_noirq(struct device *dev)
746 struct platform_device *pdev = to_platform_device(dev);
747 struct omap_device *od = to_omap_device(pdev);
750 ret = pm_generic_suspend_noirq(dev);
752 if (!ret && !pm_runtime_status_suspended(dev)) {
753 if (pm_generic_runtime_suspend(dev) == 0) {
754 if (!(od->flags & OMAP_DEVICE_NO_IDLE_ON_SUSPEND))
755 omap_device_idle(pdev);
756 od->flags |= OMAP_DEVICE_SUSPENDED;
763 static int _od_resume_noirq(struct device *dev)
765 struct platform_device *pdev = to_platform_device(dev);
766 struct omap_device *od = to_omap_device(pdev);
768 if ((od->flags & OMAP_DEVICE_SUSPENDED) &&
769 !pm_runtime_status_suspended(dev)) {
770 od->flags &= ~OMAP_DEVICE_SUSPENDED;
771 if (!(od->flags & OMAP_DEVICE_NO_IDLE_ON_SUSPEND))
772 omap_device_enable(pdev);
773 pm_generic_runtime_resume(dev);
776 return pm_generic_resume_noirq(dev);
779 #define _od_suspend_noirq NULL
780 #define _od_resume_noirq NULL
783 struct dev_pm_domain omap_device_pm_domain = {
785 SET_RUNTIME_PM_OPS(_od_runtime_suspend, _od_runtime_resume,
787 USE_PLATFORM_PM_SLEEP_OPS
788 .suspend_noirq = _od_suspend_noirq,
789 .resume_noirq = _od_resume_noirq,
794 * omap_device_register - register an omap_device with one omap_hwmod
795 * @od: struct omap_device * to register
797 * Register the omap_device structure. This currently just calls
798 * platform_device_register() on the underlying platform_device.
799 * Returns the return value of platform_device_register().
801 int omap_device_register(struct platform_device *pdev)
803 pr_debug("omap_device: %s: registering\n", pdev->name);
805 pdev->dev.pm_domain = &omap_device_pm_domain;
806 return platform_device_add(pdev);
810 /* Public functions for use by device drivers through struct platform_data */
813 * omap_device_enable - fully activate an omap_device
814 * @od: struct omap_device * to activate
816 * Do whatever is necessary for the hwmods underlying omap_device @od
817 * to be accessible and ready to operate. This generally involves
818 * enabling clocks, setting SYSCONFIG registers; and in the future may
819 * involve remuxing pins. Device drivers should call this function
820 * (through platform_data function pointers) where they would normally
821 * enable clocks, etc. Returns -EINVAL if called when the omap_device
822 * is already enabled, or passes along the return value of
823 * _omap_device_activate().
825 int omap_device_enable(struct platform_device *pdev)
828 struct omap_device *od;
830 od = to_omap_device(pdev);
832 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
834 "omap_device: %s() called from invalid state %d\n",
835 __func__, od->_state);
839 /* Enable everything if we're enabling this device from scratch */
840 if (od->_state == OMAP_DEVICE_STATE_UNKNOWN)
841 od->pm_lat_level = od->pm_lats_cnt;
843 ret = _omap_device_activate(od, IGNORE_WAKEUP_LAT);
845 od->dev_wakeup_lat = 0;
846 od->_dev_wakeup_lat_limit = UINT_MAX;
847 od->_state = OMAP_DEVICE_STATE_ENABLED;
853 * omap_device_idle - idle an omap_device
854 * @od: struct omap_device * to idle
856 * Idle omap_device @od by calling as many .deactivate_func() entries
857 * in the omap_device's pm_lats table as is possible without exceeding
858 * the device's maximum wakeup latency limit, pm_lat_limit. Device
859 * drivers should call this function (through platform_data function
860 * pointers) where they would normally disable clocks after operations
861 * complete, etc.. Returns -EINVAL if the omap_device is not
862 * currently enabled, or passes along the return value of
863 * _omap_device_deactivate().
865 int omap_device_idle(struct platform_device *pdev)
868 struct omap_device *od;
870 od = to_omap_device(pdev);
872 if (od->_state != OMAP_DEVICE_STATE_ENABLED) {
874 "omap_device: %s() called from invalid state %d\n",
875 __func__, od->_state);
879 ret = _omap_device_deactivate(od, USE_WAKEUP_LAT);
881 od->_state = OMAP_DEVICE_STATE_IDLE;
887 * omap_device_shutdown - shut down an omap_device
888 * @od: struct omap_device * to shut down
890 * Shut down omap_device @od by calling all .deactivate_func() entries
891 * in the omap_device's pm_lats table and then shutting down all of
892 * the underlying omap_hwmods. Used when a device is being "removed"
893 * or a device driver is being unloaded. Returns -EINVAL if the
894 * omap_device is not currently enabled or idle, or passes along the
895 * return value of _omap_device_deactivate().
897 int omap_device_shutdown(struct platform_device *pdev)
900 struct omap_device *od;
902 od = to_omap_device(pdev);
904 if (od->_state != OMAP_DEVICE_STATE_ENABLED &&
905 od->_state != OMAP_DEVICE_STATE_IDLE) {
907 "omap_device: %s() called from invalid state %d\n",
908 __func__, od->_state);
912 ret = _omap_device_deactivate(od, IGNORE_WAKEUP_LAT);
914 for (i = 0; i < od->hwmods_cnt; i++)
915 omap_hwmod_shutdown(od->hwmods[i]);
917 od->_state = OMAP_DEVICE_STATE_SHUTDOWN;
923 * omap_device_assert_hardreset - set a device's hardreset line
924 * @pdev: struct platform_device * to reset
925 * @name: const char * name of the reset line
927 * Set the hardreset line identified by @name on the IP blocks
928 * associated with the hwmods backing the platform_device @pdev. All
929 * of the hwmods associated with @pdev must have the same hardreset
930 * line linked to them for this to work. Passes along the return value
931 * of omap_hwmod_assert_hardreset() in the event of any failure, or
932 * returns 0 upon success.
934 int omap_device_assert_hardreset(struct platform_device *pdev, const char *name)
936 struct omap_device *od = to_omap_device(pdev);
940 for (i = 0; i < od->hwmods_cnt; i++) {
941 ret = omap_hwmod_assert_hardreset(od->hwmods[i], name);
950 * omap_device_deassert_hardreset - release a device's hardreset line
951 * @pdev: struct platform_device * to reset
952 * @name: const char * name of the reset line
954 * Release the hardreset line identified by @name on the IP blocks
955 * associated with the hwmods backing the platform_device @pdev. All
956 * of the hwmods associated with @pdev must have the same hardreset
957 * line linked to them for this to work. Passes along the return
958 * value of omap_hwmod_deassert_hardreset() in the event of any
959 * failure, or returns 0 upon success.
961 int omap_device_deassert_hardreset(struct platform_device *pdev,
964 struct omap_device *od = to_omap_device(pdev);
968 for (i = 0; i < od->hwmods_cnt; i++) {
969 ret = omap_hwmod_deassert_hardreset(od->hwmods[i], name);
978 * omap_device_align_pm_lat - activate/deactivate device to match wakeup lat lim
979 * @od: struct omap_device *
981 * When a device's maximum wakeup latency limit changes, call some of
982 * the .activate_func or .deactivate_func function pointers in the
983 * omap_device's pm_lats array to ensure that the device's maximum
984 * wakeup latency is less than or equal to the new latency limit.
985 * Intended to be called by OMAP PM code whenever a device's maximum
986 * wakeup latency limit changes (e.g., via
987 * omap_pm_set_dev_wakeup_lat()). Returns 0 if nothing needs to be
988 * done (e.g., if the omap_device is not currently idle, or if the
989 * wakeup latency is already current with the new limit) or passes
990 * along the return value of _omap_device_deactivate() or
991 * _omap_device_activate().
993 int omap_device_align_pm_lat(struct platform_device *pdev,
994 u32 new_wakeup_lat_limit)
997 struct omap_device *od;
999 od = to_omap_device(pdev);
1001 if (new_wakeup_lat_limit == od->dev_wakeup_lat)
1004 od->_dev_wakeup_lat_limit = new_wakeup_lat_limit;
1006 if (od->_state != OMAP_DEVICE_STATE_IDLE)
1008 else if (new_wakeup_lat_limit > od->dev_wakeup_lat)
1009 ret = _omap_device_deactivate(od, USE_WAKEUP_LAT);
1010 else if (new_wakeup_lat_limit < od->dev_wakeup_lat)
1011 ret = _omap_device_activate(od, USE_WAKEUP_LAT);
1017 * omap_device_get_pwrdm - return the powerdomain * associated with @od
1018 * @od: struct omap_device *
1020 * Return the powerdomain associated with the first underlying
1021 * omap_hwmod for this omap_device. Intended for use by core OMAP PM
1022 * code. Returns NULL on error or a struct powerdomain * upon
1025 struct powerdomain *omap_device_get_pwrdm(struct omap_device *od)
1028 * XXX Assumes that all omap_hwmod powerdomains are identical.
1029 * This may not necessarily be true. There should be a sanity
1030 * check in here to WARN() if any difference appears.
1032 if (!od->hwmods_cnt)
1035 return omap_hwmod_get_pwrdm(od->hwmods[0]);
1039 * omap_device_get_mpu_rt_va - return the MPU's virtual addr for the hwmod base
1040 * @od: struct omap_device *
1042 * Return the MPU's virtual address for the base of the hwmod, from
1043 * the ioremap() that the hwmod code does. Only valid if there is one
1044 * hwmod associated with this device. Returns NULL if there are zero
1045 * or more than one hwmods associated with this omap_device;
1046 * otherwise, passes along the return value from
1047 * omap_hwmod_get_mpu_rt_va().
1049 void __iomem *omap_device_get_rt_va(struct omap_device *od)
1051 if (od->hwmods_cnt != 1)
1054 return omap_hwmod_get_mpu_rt_va(od->hwmods[0]);
1058 * omap_device_get_by_hwmod_name() - convert a hwmod name to
1060 * @oh_name: name of the hwmod device
1062 * Returns back a struct device * pointer associated with a hwmod
1063 * device represented by a hwmod_name
1065 struct device *omap_device_get_by_hwmod_name(const char *oh_name)
1067 struct omap_hwmod *oh;
1070 WARN(1, "%s: no hwmod name!\n", __func__);
1071 return ERR_PTR(-EINVAL);
1074 oh = omap_hwmod_lookup(oh_name);
1075 if (IS_ERR_OR_NULL(oh)) {
1076 WARN(1, "%s: no hwmod for %s\n", __func__,
1078 return ERR_PTR(oh ? PTR_ERR(oh) : -ENODEV);
1080 if (IS_ERR_OR_NULL(oh->od)) {
1081 WARN(1, "%s: no omap_device for %s\n", __func__,
1083 return ERR_PTR(oh->od ? PTR_ERR(oh->od) : -ENODEV);
1086 if (IS_ERR_OR_NULL(oh->od->pdev))
1087 return ERR_PTR(oh->od->pdev ? PTR_ERR(oh->od->pdev) : -ENODEV);
1089 return &oh->od->pdev->dev;
1091 EXPORT_SYMBOL(omap_device_get_by_hwmod_name);
1094 * Public functions intended for use in omap_device_pm_latency
1095 * .activate_func and .deactivate_func function pointers
1099 * omap_device_enable_hwmods - call omap_hwmod_enable() on all hwmods
1100 * @od: struct omap_device *od
1102 * Enable all underlying hwmods. Returns 0.
1104 int omap_device_enable_hwmods(struct omap_device *od)
1108 for (i = 0; i < od->hwmods_cnt; i++)
1109 omap_hwmod_enable(od->hwmods[i]);
1111 /* XXX pass along return value here? */
1116 * omap_device_idle_hwmods - call omap_hwmod_idle() on all hwmods
1117 * @od: struct omap_device *od
1119 * Idle all underlying hwmods. Returns 0.
1121 int omap_device_idle_hwmods(struct omap_device *od)
1125 for (i = 0; i < od->hwmods_cnt; i++)
1126 omap_hwmod_idle(od->hwmods[i]);
1128 /* XXX pass along return value here? */
1133 * omap_device_disable_clocks - disable all main and interface clocks
1134 * @od: struct omap_device *od
1136 * Disable the main functional clock and interface clock for all of the
1137 * omap_hwmods associated with the omap_device. Returns 0.
1139 int omap_device_disable_clocks(struct omap_device *od)
1143 for (i = 0; i < od->hwmods_cnt; i++)
1144 omap_hwmod_disable_clocks(od->hwmods[i]);
1146 /* XXX pass along return value here? */
1151 * omap_device_enable_clocks - enable all main and interface clocks
1152 * @od: struct omap_device *od
1154 * Enable the main functional clock and interface clock for all of the
1155 * omap_hwmods associated with the omap_device. Returns 0.
1157 int omap_device_enable_clocks(struct omap_device *od)
1161 for (i = 0; i < od->hwmods_cnt; i++)
1162 omap_hwmod_enable_clocks(od->hwmods[i]);
1164 /* XXX pass along return value here? */
1168 static struct notifier_block platform_nb = {
1169 .notifier_call = _omap_device_notifier_call,
1172 static int __init omap_device_init(void)
1174 bus_register_notifier(&platform_bus_type, &platform_nb);
1177 core_initcall(omap_device_init);