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_device_register(struct platform_device *pdev);
101 static int omap_early_device_register(struct platform_device *pdev);
102 static struct omap_device *omap_device_alloc(struct platform_device *pdev,
103 struct omap_hwmod **ohs, int oh_cnt,
104 struct omap_device_pm_latency *pm_lats,
106 static void omap_device_delete(struct omap_device *od);
109 static struct omap_device_pm_latency omap_default_latency[] = {
111 .deactivate_func = omap_device_idle_hwmods,
112 .activate_func = omap_device_enable_hwmods,
113 .flags = OMAP_DEVICE_LATENCY_AUTO_ADJUST,
117 /* Private functions */
120 * _omap_device_activate - increase device readiness
121 * @od: struct omap_device *
122 * @ignore_lat: increase to latency target (0) or full readiness (1)?
124 * Increase readiness of omap_device @od (thus decreasing device
125 * wakeup latency, but consuming more power). If @ignore_lat is
126 * IGNORE_WAKEUP_LAT, make the omap_device fully active. Otherwise,
127 * if @ignore_lat is USE_WAKEUP_LAT, and the device's maximum wakeup
128 * latency is greater than the requested maximum wakeup latency, step
129 * backwards in the omap_device_pm_latency table to ensure the
130 * device's maximum wakeup latency is less than or equal to the
131 * requested maximum wakeup latency. Returns 0.
133 static int _omap_device_activate(struct omap_device *od, u8 ignore_lat)
135 struct timespec a, b, c;
137 dev_dbg(&od->pdev->dev, "omap_device: activating\n");
139 while (od->pm_lat_level > 0) {
140 struct omap_device_pm_latency *odpl;
141 unsigned long long act_lat = 0;
145 odpl = od->pm_lats + od->pm_lat_level;
148 (od->dev_wakeup_lat <= od->_dev_wakeup_lat_limit))
151 read_persistent_clock(&a);
153 /* XXX check return code */
154 odpl->activate_func(od);
156 read_persistent_clock(&b);
158 c = timespec_sub(b, a);
159 act_lat = timespec_to_ns(&c);
161 dev_dbg(&od->pdev->dev,
162 "omap_device: pm_lat %d: activate: elapsed time "
163 "%llu nsec\n", od->pm_lat_level, act_lat);
165 if (act_lat > odpl->activate_lat) {
166 odpl->activate_lat_worst = act_lat;
167 if (odpl->flags & OMAP_DEVICE_LATENCY_AUTO_ADJUST) {
168 odpl->activate_lat = act_lat;
169 dev_dbg(&od->pdev->dev,
170 "new worst case activate latency "
172 od->pm_lat_level, act_lat);
174 dev_warn(&od->pdev->dev,
175 "activate latency %d "
176 "higher than exptected. (%llu > %d)\n",
177 od->pm_lat_level, act_lat,
181 od->dev_wakeup_lat -= odpl->activate_lat;
188 * _omap_device_deactivate - decrease device readiness
189 * @od: struct omap_device *
190 * @ignore_lat: decrease to latency target (0) or full inactivity (1)?
192 * Decrease readiness of omap_device @od (thus increasing device
193 * wakeup latency, but conserving power). If @ignore_lat is
194 * IGNORE_WAKEUP_LAT, make the omap_device fully inactive. Otherwise,
195 * if @ignore_lat is USE_WAKEUP_LAT, and the device's maximum wakeup
196 * latency is less than the requested maximum wakeup latency, step
197 * forwards in the omap_device_pm_latency table to ensure the device's
198 * maximum wakeup latency is less than or equal to the requested
199 * maximum wakeup latency. Returns 0.
201 static int _omap_device_deactivate(struct omap_device *od, u8 ignore_lat)
203 struct timespec a, b, c;
205 dev_dbg(&od->pdev->dev, "omap_device: deactivating\n");
207 while (od->pm_lat_level < od->pm_lats_cnt) {
208 struct omap_device_pm_latency *odpl;
209 unsigned long long deact_lat = 0;
211 odpl = od->pm_lats + od->pm_lat_level;
214 ((od->dev_wakeup_lat + odpl->activate_lat) >
215 od->_dev_wakeup_lat_limit))
218 read_persistent_clock(&a);
220 /* XXX check return code */
221 odpl->deactivate_func(od);
223 read_persistent_clock(&b);
225 c = timespec_sub(b, a);
226 deact_lat = timespec_to_ns(&c);
228 dev_dbg(&od->pdev->dev,
229 "omap_device: pm_lat %d: deactivate: elapsed time "
230 "%llu nsec\n", od->pm_lat_level, deact_lat);
232 if (deact_lat > odpl->deactivate_lat) {
233 odpl->deactivate_lat_worst = deact_lat;
234 if (odpl->flags & OMAP_DEVICE_LATENCY_AUTO_ADJUST) {
235 odpl->deactivate_lat = deact_lat;
236 dev_dbg(&od->pdev->dev,
237 "new worst case deactivate latency "
239 od->pm_lat_level, deact_lat);
241 dev_warn(&od->pdev->dev,
242 "deactivate latency %d "
243 "higher than exptected. (%llu > %d)\n",
244 od->pm_lat_level, deact_lat,
245 odpl->deactivate_lat);
248 od->dev_wakeup_lat += odpl->activate_lat;
256 static void _add_clkdev(struct omap_device *od, const char *clk_alias,
257 const char *clk_name)
260 struct clk_lookup *l;
262 if (!clk_alias || !clk_name)
265 dev_dbg(&od->pdev->dev, "Creating %s -> %s\n", clk_alias, clk_name);
267 r = clk_get_sys(dev_name(&od->pdev->dev), clk_alias);
269 dev_warn(&od->pdev->dev,
270 "alias %s already exists\n", clk_alias);
275 r = omap_clk_get_by_name(clk_name);
277 dev_err(&od->pdev->dev,
278 "omap_clk_get_by_name for %s failed\n", clk_name);
282 l = clkdev_alloc(r, clk_alias, dev_name(&od->pdev->dev));
284 dev_err(&od->pdev->dev,
285 "clkdev_alloc for %s failed\n", clk_alias);
293 * _add_hwmod_clocks_clkdev - Add clkdev entry for hwmod optional clocks
295 * @od: struct omap_device *od
296 * @oh: struct omap_hwmod *oh
298 * For the main clock and every optional clock present per hwmod per
299 * omap_device, this function adds an entry in the clkdev table of the
300 * form <dev-id=dev_name, con-id=role> if it does not exist already.
302 * The function is called from inside omap_device_build_ss(), after
303 * omap_device_register.
305 * This allows drivers to get a pointer to its optional clocks based on its role
306 * by calling clk_get(<dev*>, <role>).
307 * In the case of the main clock, a "fck" alias is used.
311 static void _add_hwmod_clocks_clkdev(struct omap_device *od,
312 struct omap_hwmod *oh)
316 _add_clkdev(od, "fck", oh->main_clk);
318 for (i = 0; i < oh->opt_clks_cnt; i++)
319 _add_clkdev(od, oh->opt_clks[i].role, oh->opt_clks[i].clk);
324 * omap_device_build_from_dt - build an omap_device with multiple hwmods
325 * @pdev_name: name of the platform_device driver to use
326 * @pdev_id: this platform_device's connection ID
327 * @oh: ptr to the single omap_hwmod that backs this omap_device
328 * @pdata: platform_data ptr to associate with the platform_device
329 * @pdata_len: amount of memory pointed to by @pdata
330 * @pm_lats: pointer to a omap_device_pm_latency array for this device
331 * @pm_lats_cnt: ARRAY_SIZE() of @pm_lats
332 * @is_early_device: should the device be registered as an early device or not
334 * Function for building an omap_device already registered from device-tree
336 * Returns 0 or PTR_ERR() on error.
338 static int omap_device_build_from_dt(struct platform_device *pdev)
340 struct omap_hwmod **hwmods;
341 struct omap_device *od;
342 struct omap_hwmod *oh;
343 struct device_node *node = pdev->dev.of_node;
345 int oh_cnt, i, ret = 0;
347 oh_cnt = of_property_count_strings(node, "ti,hwmods");
348 if (!oh_cnt || IS_ERR_VALUE(oh_cnt)) {
349 dev_warn(&pdev->dev, "No 'hwmods' to build omap_device\n");
353 hwmods = kzalloc(sizeof(struct omap_hwmod *) * oh_cnt, GFP_KERNEL);
359 for (i = 0; i < oh_cnt; i++) {
360 of_property_read_string_index(node, "ti,hwmods", i, &oh_name);
361 oh = omap_hwmod_lookup(oh_name);
363 dev_err(&pdev->dev, "Cannot lookup hwmod '%s'\n",
371 od = omap_device_alloc(pdev, hwmods, oh_cnt, NULL, 0);
373 dev_err(&pdev->dev, "Cannot allocate omap_device for :%s\n",
379 if (of_get_property(node, "ti,no_idle_on_suspend", NULL))
380 omap_device_disable_idle_on_suspend(pdev);
382 pdev->dev.pm_domain = &omap_device_pm_domain;
390 static int _omap_device_notifier_call(struct notifier_block *nb,
391 unsigned long event, void *dev)
393 struct platform_device *pdev = to_platform_device(dev);
396 case BUS_NOTIFY_ADD_DEVICE:
397 if (pdev->dev.of_node)
398 omap_device_build_from_dt(pdev);
401 case BUS_NOTIFY_DEL_DEVICE:
402 if (pdev->archdata.od)
403 omap_device_delete(pdev->archdata.od);
411 /* Public functions for use by core code */
414 * omap_device_get_context_loss_count - get lost context count
415 * @od: struct omap_device *
417 * Using the primary hwmod, query the context loss count for this
420 * Callers should consider context for this device lost any time this
421 * function returns a value different than the value the caller got
422 * the last time it called this function.
424 * If any hwmods exist for the omap_device assoiated with @pdev,
425 * return the context loss counter for that hwmod, otherwise return
428 int omap_device_get_context_loss_count(struct platform_device *pdev)
430 struct omap_device *od;
433 od = to_omap_device(pdev);
436 ret = omap_hwmod_get_context_loss_count(od->hwmods[0]);
442 * omap_device_count_resources - count number of struct resource entries needed
443 * @od: struct omap_device *
445 * Count the number of struct resource entries needed for this
446 * omap_device @od. Used by omap_device_build_ss() to determine how
447 * much memory to allocate before calling
448 * omap_device_fill_resources(). Returns the count.
450 static int omap_device_count_resources(struct omap_device *od)
455 for (i = 0; i < od->hwmods_cnt; i++)
456 c += omap_hwmod_count_resources(od->hwmods[i]);
458 pr_debug("omap_device: %s: counted %d total resources across %d "
459 "hwmods\n", od->pdev->name, c, od->hwmods_cnt);
465 * omap_device_fill_resources - fill in array of struct resource
466 * @od: struct omap_device *
467 * @res: pointer to an array of struct resource to be filled in
469 * Populate one or more empty struct resource pointed to by @res with
470 * the resource data for this omap_device @od. Used by
471 * omap_device_build_ss() after calling omap_device_count_resources().
472 * Ideally this function would not be needed at all. If omap_device
473 * replaces platform_device, then we can specify our own
474 * get_resource()/ get_irq()/etc functions that use the underlying
475 * omap_hwmod information. Or if platform_device is extended to use
476 * subarchitecture-specific function pointers, the various
477 * platform_device functions can simply call omap_device internal
478 * functions to get device resources. Hacking around the existing
479 * platform_device code wastes memory. Returns 0.
481 static int omap_device_fill_resources(struct omap_device *od,
482 struct resource *res)
487 for (i = 0; i < od->hwmods_cnt; i++) {
488 r = omap_hwmod_fill_resources(od->hwmods[i], res);
497 * omap_device_alloc - allocate an omap_device
498 * @pdev: platform_device that will be included in this omap_device
499 * @oh: ptr to the single omap_hwmod that backs this omap_device
500 * @pdata: platform_data ptr to associate with the platform_device
501 * @pdata_len: amount of memory pointed to by @pdata
502 * @pm_lats: pointer to a omap_device_pm_latency array for this device
503 * @pm_lats_cnt: ARRAY_SIZE() of @pm_lats
505 * Convenience function for allocating an omap_device structure and filling
506 * hwmods, resources and pm_latency attributes.
508 * Returns an struct omap_device pointer or ERR_PTR() on error;
510 static struct omap_device *omap_device_alloc(struct platform_device *pdev,
511 struct omap_hwmod **ohs, int oh_cnt,
512 struct omap_device_pm_latency *pm_lats,
516 struct omap_device *od;
517 struct resource *res = NULL;
519 struct omap_hwmod **hwmods;
521 od = kzalloc(sizeof(struct omap_device), GFP_KERNEL);
526 od->hwmods_cnt = oh_cnt;
528 hwmods = kmemdup(ohs, sizeof(struct omap_hwmod *) * oh_cnt, GFP_KERNEL);
536 * HACK: Ideally the resources from DT should match, and hwmod
537 * should just add the missing ones. Since the name is not
538 * properly populated by DT, stick to hwmod resources only.
540 if (pdev->num_resources && pdev->resource)
541 dev_warn(&pdev->dev, "%s(): resources already allocated %d\n",
542 __func__, pdev->num_resources);
544 res_count = omap_device_count_resources(od);
546 dev_dbg(&pdev->dev, "%s(): resources allocated from hwmod %d\n",
547 __func__, res_count);
548 res = kzalloc(sizeof(struct resource) * res_count, GFP_KERNEL);
552 omap_device_fill_resources(od, res);
554 ret = platform_device_add_resources(pdev, res, res_count);
562 pm_lats = omap_default_latency;
563 pm_lats_cnt = ARRAY_SIZE(omap_default_latency);
566 od->pm_lats_cnt = pm_lats_cnt;
567 od->pm_lats = kmemdup(pm_lats,
568 sizeof(struct omap_device_pm_latency) * pm_lats_cnt,
573 pdev->archdata.od = od;
575 for (i = 0; i < oh_cnt; i++) {
577 _add_hwmod_clocks_clkdev(od, hwmods[i]);
587 dev_err(&pdev->dev, "omap_device: build failed (%d)\n", ret);
592 static void omap_device_delete(struct omap_device *od)
597 od->pdev->archdata.od = NULL;
604 * omap_device_build - build and register an omap_device with one omap_hwmod
605 * @pdev_name: name of the platform_device driver to use
606 * @pdev_id: this platform_device's connection ID
607 * @oh: ptr to the single omap_hwmod that backs this omap_device
608 * @pdata: platform_data ptr to associate with the platform_device
609 * @pdata_len: amount of memory pointed to by @pdata
610 * @pm_lats: pointer to a omap_device_pm_latency array for this device
611 * @pm_lats_cnt: ARRAY_SIZE() of @pm_lats
612 * @is_early_device: should the device be registered as an early device or not
614 * Convenience function for building and registering a single
615 * omap_device record, which in turn builds and registers a
616 * platform_device record. See omap_device_build_ss() for more
617 * information. Returns ERR_PTR(-EINVAL) if @oh is NULL; otherwise,
618 * passes along the return value of omap_device_build_ss().
620 struct platform_device *omap_device_build(const char *pdev_name, int pdev_id,
621 struct omap_hwmod *oh, void *pdata,
623 struct omap_device_pm_latency *pm_lats,
624 int pm_lats_cnt, int is_early_device)
626 struct omap_hwmod *ohs[] = { oh };
629 return ERR_PTR(-EINVAL);
631 return omap_device_build_ss(pdev_name, pdev_id, ohs, 1, pdata,
632 pdata_len, pm_lats, pm_lats_cnt,
637 * omap_device_build_ss - build and register an omap_device with multiple hwmods
638 * @pdev_name: name of the platform_device driver to use
639 * @pdev_id: this platform_device's connection ID
640 * @oh: ptr to the single omap_hwmod that backs this omap_device
641 * @pdata: platform_data ptr to associate with the platform_device
642 * @pdata_len: amount of memory pointed to by @pdata
643 * @pm_lats: pointer to a omap_device_pm_latency array for this device
644 * @pm_lats_cnt: ARRAY_SIZE() of @pm_lats
645 * @is_early_device: should the device be registered as an early device or not
647 * Convenience function for building and registering an omap_device
648 * subsystem record. Subsystem records consist of multiple
649 * omap_hwmods. This function in turn builds and registers a
650 * platform_device record. Returns an ERR_PTR() on error, or passes
651 * along the return value of omap_device_register().
653 struct platform_device *omap_device_build_ss(const char *pdev_name, int pdev_id,
654 struct omap_hwmod **ohs, int oh_cnt,
655 void *pdata, int pdata_len,
656 struct omap_device_pm_latency *pm_lats,
657 int pm_lats_cnt, int is_early_device)
660 struct platform_device *pdev;
661 struct omap_device *od;
663 if (!ohs || oh_cnt == 0 || !pdev_name)
664 return ERR_PTR(-EINVAL);
666 if (!pdata && pdata_len > 0)
667 return ERR_PTR(-EINVAL);
669 pdev = platform_device_alloc(pdev_name, pdev_id);
675 /* Set the dev_name early to allow dev_xxx in omap_device_alloc */
677 dev_set_name(&pdev->dev, "%s.%d", pdev->name, pdev->id);
679 dev_set_name(&pdev->dev, "%s", pdev->name);
681 od = omap_device_alloc(pdev, ohs, oh_cnt, pm_lats, pm_lats_cnt);
685 ret = platform_device_add_data(pdev, pdata, pdata_len);
690 ret = omap_early_device_register(pdev);
692 ret = omap_device_register(pdev);
699 omap_device_delete(od);
701 platform_device_put(pdev);
704 pr_err("omap_device: %s: build failed (%d)\n", pdev_name, ret);
710 * omap_early_device_register - register an omap_device as an early platform
712 * @od: struct omap_device * to register
714 * Register the omap_device structure. This currently just calls
715 * platform_early_add_device() on the underlying platform_device.
716 * Returns 0 by default.
718 static int omap_early_device_register(struct platform_device *pdev)
720 struct platform_device *devices[1];
723 early_platform_add_devices(devices, 1);
727 #ifdef CONFIG_PM_RUNTIME
728 static int _od_runtime_suspend(struct device *dev)
730 struct platform_device *pdev = to_platform_device(dev);
733 ret = pm_generic_runtime_suspend(dev);
736 omap_device_idle(pdev);
741 static int _od_runtime_idle(struct device *dev)
743 return pm_generic_runtime_idle(dev);
746 static int _od_runtime_resume(struct device *dev)
748 struct platform_device *pdev = to_platform_device(dev);
750 omap_device_enable(pdev);
752 return pm_generic_runtime_resume(dev);
756 #ifdef CONFIG_SUSPEND
757 static int _od_suspend_noirq(struct device *dev)
759 struct platform_device *pdev = to_platform_device(dev);
760 struct omap_device *od = to_omap_device(pdev);
763 if (od->flags & OMAP_DEVICE_NO_IDLE_ON_SUSPEND)
764 return pm_generic_suspend_noirq(dev);
766 ret = pm_generic_suspend_noirq(dev);
768 if (!ret && !pm_runtime_status_suspended(dev)) {
769 if (pm_generic_runtime_suspend(dev) == 0) {
770 omap_device_idle(pdev);
771 od->flags |= OMAP_DEVICE_SUSPENDED;
778 static int _od_resume_noirq(struct device *dev)
780 struct platform_device *pdev = to_platform_device(dev);
781 struct omap_device *od = to_omap_device(pdev);
783 if (od->flags & OMAP_DEVICE_NO_IDLE_ON_SUSPEND)
784 return pm_generic_resume_noirq(dev);
786 if ((od->flags & OMAP_DEVICE_SUSPENDED) &&
787 !pm_runtime_status_suspended(dev)) {
788 od->flags &= ~OMAP_DEVICE_SUSPENDED;
789 omap_device_enable(pdev);
790 pm_generic_runtime_resume(dev);
793 return pm_generic_resume_noirq(dev);
796 #define _od_suspend_noirq NULL
797 #define _od_resume_noirq NULL
800 struct dev_pm_domain omap_device_pm_domain = {
802 SET_RUNTIME_PM_OPS(_od_runtime_suspend, _od_runtime_resume,
804 USE_PLATFORM_PM_SLEEP_OPS
805 .suspend_noirq = _od_suspend_noirq,
806 .resume_noirq = _od_resume_noirq,
811 * omap_device_register - register an omap_device with one omap_hwmod
812 * @od: struct omap_device * to register
814 * Register the omap_device structure. This currently just calls
815 * platform_device_register() on the underlying platform_device.
816 * Returns the return value of platform_device_register().
818 static int omap_device_register(struct platform_device *pdev)
820 pr_debug("omap_device: %s: registering\n", pdev->name);
822 pdev->dev.pm_domain = &omap_device_pm_domain;
823 return platform_device_add(pdev);
827 /* Public functions for use by device drivers through struct platform_data */
830 * omap_device_enable - fully activate an omap_device
831 * @od: struct omap_device * to activate
833 * Do whatever is necessary for the hwmods underlying omap_device @od
834 * to be accessible and ready to operate. This generally involves
835 * enabling clocks, setting SYSCONFIG registers; and in the future may
836 * involve remuxing pins. Device drivers should call this function
837 * (through platform_data function pointers) where they would normally
838 * enable clocks, etc. Returns -EINVAL if called when the omap_device
839 * is already enabled, or passes along the return value of
840 * _omap_device_activate().
842 int omap_device_enable(struct platform_device *pdev)
845 struct omap_device *od;
847 od = to_omap_device(pdev);
849 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
851 "omap_device: %s() called from invalid state %d\n",
852 __func__, od->_state);
856 /* Enable everything if we're enabling this device from scratch */
857 if (od->_state == OMAP_DEVICE_STATE_UNKNOWN)
858 od->pm_lat_level = od->pm_lats_cnt;
860 ret = _omap_device_activate(od, IGNORE_WAKEUP_LAT);
862 od->dev_wakeup_lat = 0;
863 od->_dev_wakeup_lat_limit = UINT_MAX;
864 od->_state = OMAP_DEVICE_STATE_ENABLED;
870 * omap_device_idle - idle an omap_device
871 * @od: struct omap_device * to idle
873 * Idle omap_device @od by calling as many .deactivate_func() entries
874 * in the omap_device's pm_lats table as is possible without exceeding
875 * the device's maximum wakeup latency limit, pm_lat_limit. Device
876 * drivers should call this function (through platform_data function
877 * pointers) where they would normally disable clocks after operations
878 * complete, etc.. Returns -EINVAL if the omap_device is not
879 * currently enabled, or passes along the return value of
880 * _omap_device_deactivate().
882 int omap_device_idle(struct platform_device *pdev)
885 struct omap_device *od;
887 od = to_omap_device(pdev);
889 if (od->_state != OMAP_DEVICE_STATE_ENABLED) {
891 "omap_device: %s() called from invalid state %d\n",
892 __func__, od->_state);
896 ret = _omap_device_deactivate(od, USE_WAKEUP_LAT);
898 od->_state = OMAP_DEVICE_STATE_IDLE;
904 * omap_device_shutdown - shut down an omap_device
905 * @od: struct omap_device * to shut down
907 * Shut down omap_device @od by calling all .deactivate_func() entries
908 * in the omap_device's pm_lats table and then shutting down all of
909 * the underlying omap_hwmods. Used when a device is being "removed"
910 * or a device driver is being unloaded. Returns -EINVAL if the
911 * omap_device is not currently enabled or idle, or passes along the
912 * return value of _omap_device_deactivate().
914 int omap_device_shutdown(struct platform_device *pdev)
917 struct omap_device *od;
919 od = to_omap_device(pdev);
921 if (od->_state != OMAP_DEVICE_STATE_ENABLED &&
922 od->_state != OMAP_DEVICE_STATE_IDLE) {
924 "omap_device: %s() called from invalid state %d\n",
925 __func__, od->_state);
929 ret = _omap_device_deactivate(od, IGNORE_WAKEUP_LAT);
931 for (i = 0; i < od->hwmods_cnt; i++)
932 omap_hwmod_shutdown(od->hwmods[i]);
934 od->_state = OMAP_DEVICE_STATE_SHUTDOWN;
940 * omap_device_align_pm_lat - activate/deactivate device to match wakeup lat lim
941 * @od: struct omap_device *
943 * When a device's maximum wakeup latency limit changes, call some of
944 * the .activate_func or .deactivate_func function pointers in the
945 * omap_device's pm_lats array to ensure that the device's maximum
946 * wakeup latency is less than or equal to the new latency limit.
947 * Intended to be called by OMAP PM code whenever a device's maximum
948 * wakeup latency limit changes (e.g., via
949 * omap_pm_set_dev_wakeup_lat()). Returns 0 if nothing needs to be
950 * done (e.g., if the omap_device is not currently idle, or if the
951 * wakeup latency is already current with the new limit) or passes
952 * along the return value of _omap_device_deactivate() or
953 * _omap_device_activate().
955 int omap_device_align_pm_lat(struct platform_device *pdev,
956 u32 new_wakeup_lat_limit)
959 struct omap_device *od;
961 od = to_omap_device(pdev);
963 if (new_wakeup_lat_limit == od->dev_wakeup_lat)
966 od->_dev_wakeup_lat_limit = new_wakeup_lat_limit;
968 if (od->_state != OMAP_DEVICE_STATE_IDLE)
970 else if (new_wakeup_lat_limit > od->dev_wakeup_lat)
971 ret = _omap_device_deactivate(od, USE_WAKEUP_LAT);
972 else if (new_wakeup_lat_limit < od->dev_wakeup_lat)
973 ret = _omap_device_activate(od, USE_WAKEUP_LAT);
979 * omap_device_get_pwrdm - return the powerdomain * associated with @od
980 * @od: struct omap_device *
982 * Return the powerdomain associated with the first underlying
983 * omap_hwmod for this omap_device. Intended for use by core OMAP PM
984 * code. Returns NULL on error or a struct powerdomain * upon
987 struct powerdomain *omap_device_get_pwrdm(struct omap_device *od)
990 * XXX Assumes that all omap_hwmod powerdomains are identical.
991 * This may not necessarily be true. There should be a sanity
992 * check in here to WARN() if any difference appears.
997 return omap_hwmod_get_pwrdm(od->hwmods[0]);
1001 * omap_device_get_mpu_rt_va - return the MPU's virtual addr for the hwmod base
1002 * @od: struct omap_device *
1004 * Return the MPU's virtual address for the base of the hwmod, from
1005 * the ioremap() that the hwmod code does. Only valid if there is one
1006 * hwmod associated with this device. Returns NULL if there are zero
1007 * or more than one hwmods associated with this omap_device;
1008 * otherwise, passes along the return value from
1009 * omap_hwmod_get_mpu_rt_va().
1011 void __iomem *omap_device_get_rt_va(struct omap_device *od)
1013 if (od->hwmods_cnt != 1)
1016 return omap_hwmod_get_mpu_rt_va(od->hwmods[0]);
1020 * omap_device_get_by_hwmod_name() - convert a hwmod name to
1022 * @oh_name: name of the hwmod device
1024 * Returns back a struct device * pointer associated with a hwmod
1025 * device represented by a hwmod_name
1027 struct device *omap_device_get_by_hwmod_name(const char *oh_name)
1029 struct omap_hwmod *oh;
1032 WARN(1, "%s: no hwmod name!\n", __func__);
1033 return ERR_PTR(-EINVAL);
1036 oh = omap_hwmod_lookup(oh_name);
1037 if (IS_ERR_OR_NULL(oh)) {
1038 WARN(1, "%s: no hwmod for %s\n", __func__,
1040 return ERR_PTR(oh ? PTR_ERR(oh) : -ENODEV);
1042 if (IS_ERR_OR_NULL(oh->od)) {
1043 WARN(1, "%s: no omap_device for %s\n", __func__,
1045 return ERR_PTR(oh->od ? PTR_ERR(oh->od) : -ENODEV);
1048 if (IS_ERR_OR_NULL(oh->od->pdev))
1049 return ERR_PTR(oh->od->pdev ? PTR_ERR(oh->od->pdev) : -ENODEV);
1051 return &oh->od->pdev->dev;
1053 EXPORT_SYMBOL(omap_device_get_by_hwmod_name);
1056 * Public functions intended for use in omap_device_pm_latency
1057 * .activate_func and .deactivate_func function pointers
1061 * omap_device_enable_hwmods - call omap_hwmod_enable() on all hwmods
1062 * @od: struct omap_device *od
1064 * Enable all underlying hwmods. Returns 0.
1066 int omap_device_enable_hwmods(struct omap_device *od)
1070 for (i = 0; i < od->hwmods_cnt; i++)
1071 omap_hwmod_enable(od->hwmods[i]);
1073 /* XXX pass along return value here? */
1078 * omap_device_idle_hwmods - call omap_hwmod_idle() on all hwmods
1079 * @od: struct omap_device *od
1081 * Idle all underlying hwmods. Returns 0.
1083 int omap_device_idle_hwmods(struct omap_device *od)
1087 for (i = 0; i < od->hwmods_cnt; i++)
1088 omap_hwmod_idle(od->hwmods[i]);
1090 /* XXX pass along return value here? */
1095 * omap_device_disable_clocks - disable all main and interface clocks
1096 * @od: struct omap_device *od
1098 * Disable the main functional clock and interface clock for all of the
1099 * omap_hwmods associated with the omap_device. Returns 0.
1101 int omap_device_disable_clocks(struct omap_device *od)
1105 for (i = 0; i < od->hwmods_cnt; i++)
1106 omap_hwmod_disable_clocks(od->hwmods[i]);
1108 /* XXX pass along return value here? */
1113 * omap_device_enable_clocks - enable all main and interface clocks
1114 * @od: struct omap_device *od
1116 * Enable the main functional clock and interface clock for all of the
1117 * omap_hwmods associated with the omap_device. Returns 0.
1119 int omap_device_enable_clocks(struct omap_device *od)
1123 for (i = 0; i < od->hwmods_cnt; i++)
1124 omap_hwmod_enable_clocks(od->hwmods[i]);
1126 /* XXX pass along return value here? */
1130 static struct notifier_block platform_nb = {
1131 .notifier_call = _omap_device_notifier_call,
1134 static int __init omap_device_init(void)
1136 bus_register_notifier(&platform_bus_type, &platform_nb);
1139 core_initcall(omap_device_init);