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 "omap_device.h"
93 #include "omap_hwmod.h"
95 /* These parameters are passed to _omap_device_{de,}activate() */
96 #define USE_WAKEUP_LAT 0
97 #define IGNORE_WAKEUP_LAT 1
99 static int omap_early_device_register(struct platform_device *pdev);
101 static struct omap_device_pm_latency omap_default_latency[] = {
103 .deactivate_func = omap_device_idle_hwmods,
104 .activate_func = omap_device_enable_hwmods,
105 .flags = OMAP_DEVICE_LATENCY_AUTO_ADJUST,
109 /* Private functions */
112 * _omap_device_activate - increase device readiness
113 * @od: struct omap_device *
114 * @ignore_lat: increase to latency target (0) or full readiness (1)?
116 * Increase readiness of omap_device @od (thus decreasing device
117 * wakeup latency, but consuming more power). If @ignore_lat is
118 * IGNORE_WAKEUP_LAT, make the omap_device fully active. Otherwise,
119 * if @ignore_lat is USE_WAKEUP_LAT, and the device's maximum wakeup
120 * latency is greater than the requested maximum wakeup latency, step
121 * backwards in the omap_device_pm_latency table to ensure the
122 * device's maximum wakeup latency is less than or equal to the
123 * requested maximum wakeup latency. Returns 0.
125 static int _omap_device_activate(struct omap_device *od, u8 ignore_lat)
127 struct timespec a, b, c;
129 dev_dbg(&od->pdev->dev, "omap_device: activating\n");
131 while (od->pm_lat_level > 0) {
132 struct omap_device_pm_latency *odpl;
133 unsigned long long act_lat = 0;
137 odpl = od->pm_lats + od->pm_lat_level;
140 (od->dev_wakeup_lat <= od->_dev_wakeup_lat_limit))
143 read_persistent_clock(&a);
145 /* XXX check return code */
146 odpl->activate_func(od);
148 read_persistent_clock(&b);
150 c = timespec_sub(b, a);
151 act_lat = timespec_to_ns(&c);
153 dev_dbg(&od->pdev->dev,
154 "omap_device: pm_lat %d: activate: elapsed time %llu nsec\n",
155 od->pm_lat_level, act_lat);
157 if (act_lat > odpl->activate_lat) {
158 odpl->activate_lat_worst = act_lat;
159 if (odpl->flags & OMAP_DEVICE_LATENCY_AUTO_ADJUST) {
160 odpl->activate_lat = act_lat;
161 dev_dbg(&od->pdev->dev,
162 "new worst case activate latency %d: %llu\n",
163 od->pm_lat_level, act_lat);
165 dev_warn(&od->pdev->dev,
166 "activate latency %d higher than expected. (%llu > %d)\n",
167 od->pm_lat_level, act_lat,
171 od->dev_wakeup_lat -= odpl->activate_lat;
178 * _omap_device_deactivate - decrease device readiness
179 * @od: struct omap_device *
180 * @ignore_lat: decrease to latency target (0) or full inactivity (1)?
182 * Decrease readiness of omap_device @od (thus increasing device
183 * wakeup latency, but conserving power). If @ignore_lat is
184 * IGNORE_WAKEUP_LAT, make the omap_device fully inactive. Otherwise,
185 * if @ignore_lat is USE_WAKEUP_LAT, and the device's maximum wakeup
186 * latency is less than the requested maximum wakeup latency, step
187 * forwards in the omap_device_pm_latency table to ensure the device's
188 * maximum wakeup latency is less than or equal to the requested
189 * maximum wakeup latency. Returns 0.
191 static int _omap_device_deactivate(struct omap_device *od, u8 ignore_lat)
193 struct timespec a, b, c;
195 dev_dbg(&od->pdev->dev, "omap_device: deactivating\n");
197 while (od->pm_lat_level < od->pm_lats_cnt) {
198 struct omap_device_pm_latency *odpl;
199 unsigned long long deact_lat = 0;
201 odpl = od->pm_lats + od->pm_lat_level;
204 ((od->dev_wakeup_lat + odpl->activate_lat) >
205 od->_dev_wakeup_lat_limit))
208 read_persistent_clock(&a);
210 /* XXX check return code */
211 odpl->deactivate_func(od);
213 read_persistent_clock(&b);
215 c = timespec_sub(b, a);
216 deact_lat = timespec_to_ns(&c);
218 dev_dbg(&od->pdev->dev,
219 "omap_device: pm_lat %d: deactivate: elapsed time %llu nsec\n",
220 od->pm_lat_level, deact_lat);
222 if (deact_lat > odpl->deactivate_lat) {
223 odpl->deactivate_lat_worst = deact_lat;
224 if (odpl->flags & OMAP_DEVICE_LATENCY_AUTO_ADJUST) {
225 odpl->deactivate_lat = deact_lat;
226 dev_dbg(&od->pdev->dev,
227 "new worst case deactivate latency %d: %llu\n",
228 od->pm_lat_level, deact_lat);
230 dev_warn(&od->pdev->dev,
231 "deactivate latency %d higher than expected. (%llu > %d)\n",
232 od->pm_lat_level, deact_lat,
233 odpl->deactivate_lat);
236 od->dev_wakeup_lat += odpl->activate_lat;
244 static void _add_clkdev(struct omap_device *od, const char *clk_alias,
245 const char *clk_name)
248 struct clk_lookup *l;
250 if (!clk_alias || !clk_name)
253 dev_dbg(&od->pdev->dev, "Creating %s -> %s\n", clk_alias, clk_name);
255 r = clk_get_sys(dev_name(&od->pdev->dev), clk_alias);
257 dev_warn(&od->pdev->dev,
258 "alias %s already exists\n", clk_alias);
263 r = clk_get(NULL, clk_name);
265 dev_err(&od->pdev->dev,
266 "clk_get for %s failed\n", clk_name);
270 l = clkdev_alloc(r, clk_alias, dev_name(&od->pdev->dev));
272 dev_err(&od->pdev->dev,
273 "clkdev_alloc for %s failed\n", clk_alias);
281 * _add_hwmod_clocks_clkdev - Add clkdev entry for hwmod optional clocks
283 * @od: struct omap_device *od
284 * @oh: struct omap_hwmod *oh
286 * For the main clock and every optional clock present per hwmod per
287 * omap_device, this function adds an entry in the clkdev table of the
288 * form <dev-id=dev_name, con-id=role> if it does not exist already.
290 * The function is called from inside omap_device_build_ss(), after
291 * omap_device_register.
293 * This allows drivers to get a pointer to its optional clocks based on its role
294 * by calling clk_get(<dev*>, <role>).
295 * In the case of the main clock, a "fck" alias is used.
299 static void _add_hwmod_clocks_clkdev(struct omap_device *od,
300 struct omap_hwmod *oh)
304 _add_clkdev(od, "fck", oh->main_clk);
306 for (i = 0; i < oh->opt_clks_cnt; i++)
307 _add_clkdev(od, oh->opt_clks[i].role, oh->opt_clks[i].clk);
312 * omap_device_build_from_dt - build an omap_device with multiple hwmods
313 * @pdev_name: name of the platform_device driver to use
314 * @pdev_id: this platform_device's connection ID
315 * @oh: ptr to the single omap_hwmod that backs this omap_device
316 * @pdata: platform_data ptr to associate with the platform_device
317 * @pdata_len: amount of memory pointed to by @pdata
318 * @pm_lats: pointer to a omap_device_pm_latency array for this device
319 * @pm_lats_cnt: ARRAY_SIZE() of @pm_lats
320 * @is_early_device: should the device be registered as an early device or not
322 * Function for building an omap_device already registered from device-tree
324 * Returns 0 or PTR_ERR() on error.
326 static int omap_device_build_from_dt(struct platform_device *pdev)
328 struct omap_hwmod **hwmods;
329 struct omap_device *od;
330 struct omap_hwmod *oh;
331 struct device_node *node = pdev->dev.of_node;
333 int oh_cnt, i, ret = 0;
335 oh_cnt = of_property_count_strings(node, "ti,hwmods");
336 if (!oh_cnt || IS_ERR_VALUE(oh_cnt)) {
337 dev_dbg(&pdev->dev, "No 'hwmods' to build omap_device\n");
341 hwmods = kzalloc(sizeof(struct omap_hwmod *) * oh_cnt, GFP_KERNEL);
347 for (i = 0; i < oh_cnt; i++) {
348 of_property_read_string_index(node, "ti,hwmods", i, &oh_name);
349 oh = omap_hwmod_lookup(oh_name);
351 dev_err(&pdev->dev, "Cannot lookup hwmod '%s'\n",
359 od = omap_device_alloc(pdev, hwmods, oh_cnt, NULL, 0);
361 dev_err(&pdev->dev, "Cannot allocate omap_device for :%s\n",
367 /* Fix up missing resource names */
368 for (i = 0; i < pdev->num_resources; i++) {
369 struct resource *r = &pdev->resource[i];
372 r->name = dev_name(&pdev->dev);
375 if (of_get_property(node, "ti,no_idle_on_suspend", NULL))
376 omap_device_disable_idle_on_suspend(pdev);
378 pdev->dev.pm_domain = &omap_device_pm_domain;
386 static int _omap_device_notifier_call(struct notifier_block *nb,
387 unsigned long event, void *dev)
389 struct platform_device *pdev = to_platform_device(dev);
390 struct omap_device *od;
393 case BUS_NOTIFY_DEL_DEVICE:
394 if (pdev->archdata.od)
395 omap_device_delete(pdev->archdata.od);
397 case BUS_NOTIFY_ADD_DEVICE:
398 if (pdev->dev.of_node)
399 omap_device_build_from_dt(pdev);
402 od = to_omap_device(pdev);
404 od->_driver_status = event;
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 hwmods\n",
459 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)
486 for (i = 0; i < od->hwmods_cnt; i++) {
487 r = omap_hwmod_fill_resources(od->hwmods[i], res);
495 * _od_fill_dma_resources - fill in array of struct resource with dma resources
496 * @od: struct omap_device *
497 * @res: pointer to an array of struct resource to be filled in
499 * Populate one or more empty struct resource pointed to by @res with
500 * the dma resource data for this omap_device @od. Used by
501 * omap_device_alloc() after calling omap_device_count_resources().
503 * Ideally this function would not be needed at all. If we have
504 * mechanism to get dma resources from DT.
508 static int _od_fill_dma_resources(struct omap_device *od,
509 struct resource *res)
513 for (i = 0; i < od->hwmods_cnt; i++) {
514 r = omap_hwmod_fill_dma_resources(od->hwmods[i], res);
522 * omap_device_alloc - allocate an omap_device
523 * @pdev: platform_device that will be included in this omap_device
524 * @oh: ptr to the single omap_hwmod that backs this omap_device
525 * @pdata: platform_data ptr to associate with the platform_device
526 * @pdata_len: amount of memory pointed to by @pdata
527 * @pm_lats: pointer to a omap_device_pm_latency array for this device
528 * @pm_lats_cnt: ARRAY_SIZE() of @pm_lats
530 * Convenience function for allocating an omap_device structure and filling
531 * hwmods, resources and pm_latency attributes.
533 * Returns an struct omap_device pointer or ERR_PTR() on error;
535 struct omap_device *omap_device_alloc(struct platform_device *pdev,
536 struct omap_hwmod **ohs, int oh_cnt,
537 struct omap_device_pm_latency *pm_lats,
541 struct omap_device *od;
542 struct resource *res = NULL;
544 struct omap_hwmod **hwmods;
546 od = kzalloc(sizeof(struct omap_device), GFP_KERNEL);
551 od->hwmods_cnt = oh_cnt;
553 hwmods = kmemdup(ohs, sizeof(struct omap_hwmod *) * oh_cnt, GFP_KERNEL);
560 res_count = omap_device_count_resources(od);
563 * OF framework will construct the resource structure (currently
564 * does for MEM & IRQ resource) and we should respect/use these
565 * resources, killing hwmod dependency.
566 * If pdev->num_resources > 0, we assume that MEM & IRQ resources
567 * have been allocated by OF layer already (through DTB).
570 * Here, pdev->num_resources = 0, and we should get all the
571 * resources from hwmod.
573 * TODO: Once DMA resource is available from OF layer, we should
574 * kill filling any resources from hwmod.
576 if (res_count > pdev->num_resources) {
577 /* Allocate resources memory to account for new resources */
578 res = kzalloc(sizeof(struct resource) * res_count, GFP_KERNEL);
583 * If pdev->num_resources > 0, then assume that,
584 * MEM and IRQ resources will only come from DT and only
585 * fill DMA resource from hwmod layer.
587 if (pdev->num_resources && pdev->resource) {
588 dev_dbg(&pdev->dev, "%s(): resources already allocated %d\n",
589 __func__, res_count);
590 memcpy(res, pdev->resource,
591 sizeof(struct resource) * pdev->num_resources);
592 _od_fill_dma_resources(od, &res[pdev->num_resources]);
594 dev_dbg(&pdev->dev, "%s(): using resources from hwmod %d\n",
595 __func__, res_count);
596 omap_device_fill_resources(od, res);
599 ret = platform_device_add_resources(pdev, res, res_count);
607 pm_lats = omap_default_latency;
608 pm_lats_cnt = ARRAY_SIZE(omap_default_latency);
611 od->pm_lats_cnt = pm_lats_cnt;
612 od->pm_lats = kmemdup(pm_lats,
613 sizeof(struct omap_device_pm_latency) * pm_lats_cnt,
618 pdev->archdata.od = od;
620 for (i = 0; i < oh_cnt; i++) {
622 _add_hwmod_clocks_clkdev(od, hwmods[i]);
632 dev_err(&pdev->dev, "omap_device: build failed (%d)\n", ret);
637 void omap_device_delete(struct omap_device *od)
642 od->pdev->archdata.od = NULL;
649 * omap_device_build - build and register an omap_device with one omap_hwmod
650 * @pdev_name: name of the platform_device driver to use
651 * @pdev_id: this platform_device's connection ID
652 * @oh: ptr to the single omap_hwmod that backs this omap_device
653 * @pdata: platform_data ptr to associate with the platform_device
654 * @pdata_len: amount of memory pointed to by @pdata
655 * @pm_lats: pointer to a omap_device_pm_latency array for this device
656 * @pm_lats_cnt: ARRAY_SIZE() of @pm_lats
657 * @is_early_device: should the device be registered as an early device or not
659 * Convenience function for building and registering a single
660 * omap_device record, which in turn builds and registers a
661 * platform_device record. See omap_device_build_ss() for more
662 * information. Returns ERR_PTR(-EINVAL) if @oh is NULL; otherwise,
663 * passes along the return value of omap_device_build_ss().
665 struct platform_device __init *omap_device_build(const char *pdev_name, int pdev_id,
666 struct omap_hwmod *oh, void *pdata,
668 struct omap_device_pm_latency *pm_lats,
669 int pm_lats_cnt, int is_early_device)
671 struct omap_hwmod *ohs[] = { oh };
674 return ERR_PTR(-EINVAL);
676 return omap_device_build_ss(pdev_name, pdev_id, ohs, 1, pdata,
677 pdata_len, pm_lats, pm_lats_cnt,
682 * omap_device_build_ss - build and register an omap_device with multiple hwmods
683 * @pdev_name: name of the platform_device driver to use
684 * @pdev_id: this platform_device's connection ID
685 * @oh: ptr to the single omap_hwmod that backs this omap_device
686 * @pdata: platform_data ptr to associate with the platform_device
687 * @pdata_len: amount of memory pointed to by @pdata
688 * @pm_lats: pointer to a omap_device_pm_latency array for this device
689 * @pm_lats_cnt: ARRAY_SIZE() of @pm_lats
690 * @is_early_device: should the device be registered as an early device or not
692 * Convenience function for building and registering an omap_device
693 * subsystem record. Subsystem records consist of multiple
694 * omap_hwmods. This function in turn builds and registers a
695 * platform_device record. Returns an ERR_PTR() on error, or passes
696 * along the return value of omap_device_register().
698 struct platform_device __init *omap_device_build_ss(const char *pdev_name, int pdev_id,
699 struct omap_hwmod **ohs, int oh_cnt,
700 void *pdata, int pdata_len,
701 struct omap_device_pm_latency *pm_lats,
702 int pm_lats_cnt, int is_early_device)
705 struct platform_device *pdev;
706 struct omap_device *od;
708 if (!ohs || oh_cnt == 0 || !pdev_name)
709 return ERR_PTR(-EINVAL);
711 if (!pdata && pdata_len > 0)
712 return ERR_PTR(-EINVAL);
714 pdev = platform_device_alloc(pdev_name, pdev_id);
720 /* Set the dev_name early to allow dev_xxx in omap_device_alloc */
722 dev_set_name(&pdev->dev, "%s.%d", pdev->name, pdev->id);
724 dev_set_name(&pdev->dev, "%s", pdev->name);
726 od = omap_device_alloc(pdev, ohs, oh_cnt, pm_lats, pm_lats_cnt);
730 ret = platform_device_add_data(pdev, pdata, pdata_len);
735 ret = omap_early_device_register(pdev);
737 ret = omap_device_register(pdev);
744 omap_device_delete(od);
746 platform_device_put(pdev);
749 pr_err("omap_device: %s: build failed (%d)\n", pdev_name, ret);
755 * omap_early_device_register - register an omap_device as an early platform
757 * @od: struct omap_device * to register
759 * Register the omap_device structure. This currently just calls
760 * platform_early_add_device() on the underlying platform_device.
761 * Returns 0 by default.
763 static int __init omap_early_device_register(struct platform_device *pdev)
765 struct platform_device *devices[1];
768 early_platform_add_devices(devices, 1);
772 #ifdef CONFIG_PM_RUNTIME
773 static int _od_runtime_suspend(struct device *dev)
775 struct platform_device *pdev = to_platform_device(dev);
778 ret = pm_generic_runtime_suspend(dev);
781 omap_device_idle(pdev);
786 static int _od_runtime_idle(struct device *dev)
788 return pm_generic_runtime_idle(dev);
791 static int _od_runtime_resume(struct device *dev)
793 struct platform_device *pdev = to_platform_device(dev);
795 omap_device_enable(pdev);
797 return pm_generic_runtime_resume(dev);
801 #ifdef CONFIG_SUSPEND
802 static int _od_suspend_noirq(struct device *dev)
804 struct platform_device *pdev = to_platform_device(dev);
805 struct omap_device *od = to_omap_device(pdev);
808 /* Don't attempt late suspend on a driver that is not bound */
809 if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER)
812 ret = pm_generic_suspend_noirq(dev);
814 if (!ret && !pm_runtime_status_suspended(dev)) {
815 if (pm_generic_runtime_suspend(dev) == 0) {
816 if (!(od->flags & OMAP_DEVICE_NO_IDLE_ON_SUSPEND))
817 omap_device_idle(pdev);
818 od->flags |= OMAP_DEVICE_SUSPENDED;
825 static int _od_resume_noirq(struct device *dev)
827 struct platform_device *pdev = to_platform_device(dev);
828 struct omap_device *od = to_omap_device(pdev);
830 if ((od->flags & OMAP_DEVICE_SUSPENDED) &&
831 !pm_runtime_status_suspended(dev)) {
832 od->flags &= ~OMAP_DEVICE_SUSPENDED;
833 if (!(od->flags & OMAP_DEVICE_NO_IDLE_ON_SUSPEND))
834 omap_device_enable(pdev);
835 pm_generic_runtime_resume(dev);
838 return pm_generic_resume_noirq(dev);
841 #define _od_suspend_noirq NULL
842 #define _od_resume_noirq NULL
845 struct dev_pm_domain omap_device_pm_domain = {
847 SET_RUNTIME_PM_OPS(_od_runtime_suspend, _od_runtime_resume,
849 USE_PLATFORM_PM_SLEEP_OPS
850 .suspend_noirq = _od_suspend_noirq,
851 .resume_noirq = _od_resume_noirq,
856 * omap_device_register - register an omap_device with one omap_hwmod
857 * @od: struct omap_device * to register
859 * Register the omap_device structure. This currently just calls
860 * platform_device_register() on the underlying platform_device.
861 * Returns the return value of platform_device_register().
863 int omap_device_register(struct platform_device *pdev)
865 pr_debug("omap_device: %s: registering\n", pdev->name);
867 pdev->dev.pm_domain = &omap_device_pm_domain;
868 return platform_device_add(pdev);
872 /* Public functions for use by device drivers through struct platform_data */
875 * omap_device_enable - fully activate an omap_device
876 * @od: struct omap_device * to activate
878 * Do whatever is necessary for the hwmods underlying omap_device @od
879 * to be accessible and ready to operate. This generally involves
880 * enabling clocks, setting SYSCONFIG registers; and in the future may
881 * involve remuxing pins. Device drivers should call this function
882 * (through platform_data function pointers) where they would normally
883 * enable clocks, etc. Returns -EINVAL if called when the omap_device
884 * is already enabled, or passes along the return value of
885 * _omap_device_activate().
887 int omap_device_enable(struct platform_device *pdev)
890 struct omap_device *od;
892 od = to_omap_device(pdev);
894 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
896 "omap_device: %s() called from invalid state %d\n",
897 __func__, od->_state);
901 /* Enable everything if we're enabling this device from scratch */
902 if (od->_state == OMAP_DEVICE_STATE_UNKNOWN)
903 od->pm_lat_level = od->pm_lats_cnt;
905 ret = _omap_device_activate(od, IGNORE_WAKEUP_LAT);
907 od->dev_wakeup_lat = 0;
908 od->_dev_wakeup_lat_limit = UINT_MAX;
909 od->_state = OMAP_DEVICE_STATE_ENABLED;
915 * omap_device_idle - idle an omap_device
916 * @od: struct omap_device * to idle
918 * Idle omap_device @od by calling as many .deactivate_func() entries
919 * in the omap_device's pm_lats table as is possible without exceeding
920 * the device's maximum wakeup latency limit, pm_lat_limit. Device
921 * drivers should call this function (through platform_data function
922 * pointers) where they would normally disable clocks after operations
923 * complete, etc.. Returns -EINVAL if the omap_device is not
924 * currently enabled, or passes along the return value of
925 * _omap_device_deactivate().
927 int omap_device_idle(struct platform_device *pdev)
930 struct omap_device *od;
932 od = to_omap_device(pdev);
934 if (od->_state != OMAP_DEVICE_STATE_ENABLED) {
936 "omap_device: %s() called from invalid state %d\n",
937 __func__, od->_state);
941 ret = _omap_device_deactivate(od, USE_WAKEUP_LAT);
943 od->_state = OMAP_DEVICE_STATE_IDLE;
949 * omap_device_shutdown - shut down an omap_device
950 * @od: struct omap_device * to shut down
952 * Shut down omap_device @od by calling all .deactivate_func() entries
953 * in the omap_device's pm_lats table and then shutting down all of
954 * the underlying omap_hwmods. Used when a device is being "removed"
955 * or a device driver is being unloaded. Returns -EINVAL if the
956 * omap_device is not currently enabled or idle, or passes along the
957 * return value of _omap_device_deactivate().
959 int omap_device_shutdown(struct platform_device *pdev)
962 struct omap_device *od;
964 od = to_omap_device(pdev);
966 if (od->_state != OMAP_DEVICE_STATE_ENABLED &&
967 od->_state != OMAP_DEVICE_STATE_IDLE) {
969 "omap_device: %s() called from invalid state %d\n",
970 __func__, od->_state);
974 ret = _omap_device_deactivate(od, IGNORE_WAKEUP_LAT);
976 for (i = 0; i < od->hwmods_cnt; i++)
977 omap_hwmod_shutdown(od->hwmods[i]);
979 od->_state = OMAP_DEVICE_STATE_SHUTDOWN;
985 * omap_device_assert_hardreset - set a device's hardreset line
986 * @pdev: struct platform_device * to reset
987 * @name: const char * name of the reset line
989 * Set the hardreset line identified by @name on the IP blocks
990 * associated with the hwmods backing the platform_device @pdev. All
991 * of the hwmods associated with @pdev must have the same hardreset
992 * line linked to them for this to work. Passes along the return value
993 * of omap_hwmod_assert_hardreset() in the event of any failure, or
994 * returns 0 upon success.
996 int omap_device_assert_hardreset(struct platform_device *pdev, const char *name)
998 struct omap_device *od = to_omap_device(pdev);
1002 for (i = 0; i < od->hwmods_cnt; i++) {
1003 ret = omap_hwmod_assert_hardreset(od->hwmods[i], name);
1012 * omap_device_deassert_hardreset - release a device's hardreset line
1013 * @pdev: struct platform_device * to reset
1014 * @name: const char * name of the reset line
1016 * Release the hardreset line identified by @name on the IP blocks
1017 * associated with the hwmods backing the platform_device @pdev. All
1018 * of the hwmods associated with @pdev must have the same hardreset
1019 * line linked to them for this to work. Passes along the return
1020 * value of omap_hwmod_deassert_hardreset() in the event of any
1021 * failure, or returns 0 upon success.
1023 int omap_device_deassert_hardreset(struct platform_device *pdev,
1026 struct omap_device *od = to_omap_device(pdev);
1030 for (i = 0; i < od->hwmods_cnt; i++) {
1031 ret = omap_hwmod_deassert_hardreset(od->hwmods[i], name);
1040 * omap_device_align_pm_lat - activate/deactivate device to match wakeup lat lim
1041 * @od: struct omap_device *
1043 * When a device's maximum wakeup latency limit changes, call some of
1044 * the .activate_func or .deactivate_func function pointers in the
1045 * omap_device's pm_lats array to ensure that the device's maximum
1046 * wakeup latency is less than or equal to the new latency limit.
1047 * Intended to be called by OMAP PM code whenever a device's maximum
1048 * wakeup latency limit changes (e.g., via
1049 * omap_pm_set_dev_wakeup_lat()). Returns 0 if nothing needs to be
1050 * done (e.g., if the omap_device is not currently idle, or if the
1051 * wakeup latency is already current with the new limit) or passes
1052 * along the return value of _omap_device_deactivate() or
1053 * _omap_device_activate().
1055 int omap_device_align_pm_lat(struct platform_device *pdev,
1056 u32 new_wakeup_lat_limit)
1059 struct omap_device *od;
1061 od = to_omap_device(pdev);
1063 if (new_wakeup_lat_limit == od->dev_wakeup_lat)
1066 od->_dev_wakeup_lat_limit = new_wakeup_lat_limit;
1068 if (od->_state != OMAP_DEVICE_STATE_IDLE)
1070 else if (new_wakeup_lat_limit > od->dev_wakeup_lat)
1071 ret = _omap_device_deactivate(od, USE_WAKEUP_LAT);
1072 else if (new_wakeup_lat_limit < od->dev_wakeup_lat)
1073 ret = _omap_device_activate(od, USE_WAKEUP_LAT);
1079 * omap_device_get_pwrdm - return the powerdomain * associated with @od
1080 * @od: struct omap_device *
1082 * Return the powerdomain associated with the first underlying
1083 * omap_hwmod for this omap_device. Intended for use by core OMAP PM
1084 * code. Returns NULL on error or a struct powerdomain * upon
1087 struct powerdomain *omap_device_get_pwrdm(struct omap_device *od)
1090 * XXX Assumes that all omap_hwmod powerdomains are identical.
1091 * This may not necessarily be true. There should be a sanity
1092 * check in here to WARN() if any difference appears.
1094 if (!od->hwmods_cnt)
1097 return omap_hwmod_get_pwrdm(od->hwmods[0]);
1101 * omap_device_get_mpu_rt_va - return the MPU's virtual addr for the hwmod base
1102 * @od: struct omap_device *
1104 * Return the MPU's virtual address for the base of the hwmod, from
1105 * the ioremap() that the hwmod code does. Only valid if there is one
1106 * hwmod associated with this device. Returns NULL if there are zero
1107 * or more than one hwmods associated with this omap_device;
1108 * otherwise, passes along the return value from
1109 * omap_hwmod_get_mpu_rt_va().
1111 void __iomem *omap_device_get_rt_va(struct omap_device *od)
1113 if (od->hwmods_cnt != 1)
1116 return omap_hwmod_get_mpu_rt_va(od->hwmods[0]);
1120 * omap_device_get_by_hwmod_name() - convert a hwmod name to
1122 * @oh_name: name of the hwmod device
1124 * Returns back a struct device * pointer associated with a hwmod
1125 * device represented by a hwmod_name
1127 struct device *omap_device_get_by_hwmod_name(const char *oh_name)
1129 struct omap_hwmod *oh;
1132 WARN(1, "%s: no hwmod name!\n", __func__);
1133 return ERR_PTR(-EINVAL);
1136 oh = omap_hwmod_lookup(oh_name);
1137 if (IS_ERR_OR_NULL(oh)) {
1138 WARN(1, "%s: no hwmod for %s\n", __func__,
1140 return ERR_PTR(oh ? PTR_ERR(oh) : -ENODEV);
1142 if (IS_ERR_OR_NULL(oh->od)) {
1143 WARN(1, "%s: no omap_device for %s\n", __func__,
1145 return ERR_PTR(oh->od ? PTR_ERR(oh->od) : -ENODEV);
1148 if (IS_ERR_OR_NULL(oh->od->pdev))
1149 return ERR_PTR(oh->od->pdev ? PTR_ERR(oh->od->pdev) : -ENODEV);
1151 return &oh->od->pdev->dev;
1153 EXPORT_SYMBOL(omap_device_get_by_hwmod_name);
1156 * Public functions intended for use in omap_device_pm_latency
1157 * .activate_func and .deactivate_func function pointers
1161 * omap_device_enable_hwmods - call omap_hwmod_enable() on all hwmods
1162 * @od: struct omap_device *od
1164 * Enable all underlying hwmods. Returns 0.
1166 int omap_device_enable_hwmods(struct omap_device *od)
1170 for (i = 0; i < od->hwmods_cnt; i++)
1171 omap_hwmod_enable(od->hwmods[i]);
1173 /* XXX pass along return value here? */
1178 * omap_device_idle_hwmods - call omap_hwmod_idle() on all hwmods
1179 * @od: struct omap_device *od
1181 * Idle all underlying hwmods. Returns 0.
1183 int omap_device_idle_hwmods(struct omap_device *od)
1187 for (i = 0; i < od->hwmods_cnt; i++)
1188 omap_hwmod_idle(od->hwmods[i]);
1190 /* XXX pass along return value here? */
1195 * omap_device_disable_clocks - disable all main and interface clocks
1196 * @od: struct omap_device *od
1198 * Disable the main functional clock and interface clock for all of the
1199 * omap_hwmods associated with the omap_device. Returns 0.
1201 int omap_device_disable_clocks(struct omap_device *od)
1205 for (i = 0; i < od->hwmods_cnt; i++)
1206 omap_hwmod_disable_clocks(od->hwmods[i]);
1208 /* XXX pass along return value here? */
1213 * omap_device_enable_clocks - enable all main and interface clocks
1214 * @od: struct omap_device *od
1216 * Enable the main functional clock and interface clock for all of the
1217 * omap_hwmods associated with the omap_device. Returns 0.
1219 int omap_device_enable_clocks(struct omap_device *od)
1223 for (i = 0; i < od->hwmods_cnt; i++)
1224 omap_hwmod_enable_clocks(od->hwmods[i]);
1226 /* XXX pass along return value here? */
1230 static struct notifier_block platform_nb = {
1231 .notifier_call = _omap_device_notifier_call,
1234 static int __init omap_device_init(void)
1236 bus_register_notifier(&platform_bus_type, &platform_nb);
1239 core_initcall(omap_device_init);
1242 * omap_device_late_idle - idle devices without drivers
1243 * @dev: struct device * associated with omap_device
1246 * Check the driver bound status of this device, and idle it
1247 * if there is no driver attached.
1249 static int __init omap_device_late_idle(struct device *dev, void *data)
1251 struct platform_device *pdev = to_platform_device(dev);
1252 struct omap_device *od = to_omap_device(pdev);
1258 * If omap_device state is enabled, but has no driver bound,
1261 if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER) {
1262 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
1263 dev_warn(dev, "%s: enabled but no driver. Idling\n",
1265 omap_device_idle(pdev);
1272 static int __init omap_device_late_init(void)
1274 bus_for_each_dev(&platform_bus_type, NULL, NULL, omap_device_late_idle);
1277 late_initcall(omap_device_late_init);