2 * omap_device implementation
4 * Copyright (C) 2009-2010 Nokia Corporation
5 * Paul Walmsley, Kevin Hilman
7 * Developed in collaboration with (alphabetical order): Benoit
8 * Cousson, Thara Gopinath, Tony Lindgren, Rajendra Nayak, Vikram
9 * Pandita, Sakari Poussa, Anand Sawant, Santosh Shilimkar, Richard
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License version 2 as
14 * published by the Free Software Foundation.
16 * This code provides a consistent interface for OMAP device drivers
17 * to control power management and interconnect properties of their
20 * In the medium- to long-term, this code should be implemented as a
21 * proper omap_bus/omap_device in Linux, no more platform_data func
28 #include <linux/kernel.h>
29 #include <linux/platform_device.h>
30 #include <linux/slab.h>
31 #include <linux/err.h>
33 #include <linux/clk.h>
34 #include <linux/clkdev.h>
35 #include <linux/pm_runtime.h>
37 #include <linux/notifier.h>
40 #include "omap_device.h"
41 #include "omap_hwmod.h"
43 /* Private functions */
45 static void _add_clkdev(struct omap_device *od, const char *clk_alias,
51 if (!clk_alias || !clk_name)
54 dev_dbg(&od->pdev->dev, "Creating %s -> %s\n", clk_alias, clk_name);
56 r = clk_get_sys(dev_name(&od->pdev->dev), clk_alias);
58 dev_warn(&od->pdev->dev,
59 "alias %s already exists\n", clk_alias);
64 r = clk_get(NULL, clk_name);
66 dev_err(&od->pdev->dev,
67 "clk_get for %s failed\n", clk_name);
71 l = clkdev_alloc(r, clk_alias, dev_name(&od->pdev->dev));
73 dev_err(&od->pdev->dev,
74 "clkdev_alloc for %s failed\n", clk_alias);
82 * _add_hwmod_clocks_clkdev - Add clkdev entry for hwmod optional clocks
84 * @od: struct omap_device *od
85 * @oh: struct omap_hwmod *oh
87 * For the main clock and every optional clock present per hwmod per
88 * omap_device, this function adds an entry in the clkdev table of the
89 * form <dev-id=dev_name, con-id=role> if it does not exist already.
91 * The function is called from inside omap_device_build_ss(), after
92 * omap_device_register.
94 * This allows drivers to get a pointer to its optional clocks based on its role
95 * by calling clk_get(<dev*>, <role>).
96 * In the case of the main clock, a "fck" alias is used.
100 static void _add_hwmod_clocks_clkdev(struct omap_device *od,
101 struct omap_hwmod *oh)
105 _add_clkdev(od, "fck", oh->main_clk);
107 for (i = 0; i < oh->opt_clks_cnt; i++)
108 _add_clkdev(od, oh->opt_clks[i].role, oh->opt_clks[i].clk);
113 * omap_device_build_from_dt - build an omap_device with multiple hwmods
114 * @pdev_name: name of the platform_device driver to use
115 * @pdev_id: this platform_device's connection ID
116 * @oh: ptr to the single omap_hwmod that backs this omap_device
117 * @pdata: platform_data ptr to associate with the platform_device
118 * @pdata_len: amount of memory pointed to by @pdata
120 * Function for building an omap_device already registered from device-tree
122 * Returns 0 or PTR_ERR() on error.
124 static int omap_device_build_from_dt(struct platform_device *pdev)
126 struct omap_hwmod **hwmods;
127 struct omap_device *od;
128 struct omap_hwmod *oh;
129 struct device_node *node = pdev->dev.of_node;
131 int oh_cnt, i, ret = 0;
132 bool device_active = false;
134 oh_cnt = of_property_count_strings(node, "ti,hwmods");
136 dev_dbg(&pdev->dev, "No 'hwmods' to build omap_device\n");
140 hwmods = kzalloc(sizeof(struct omap_hwmod *) * oh_cnt, GFP_KERNEL);
146 for (i = 0; i < oh_cnt; i++) {
147 of_property_read_string_index(node, "ti,hwmods", i, &oh_name);
148 oh = omap_hwmod_lookup(oh_name);
150 dev_err(&pdev->dev, "Cannot lookup hwmod '%s'\n",
156 if (oh->flags & HWMOD_INIT_NO_IDLE)
157 device_active = true;
160 od = omap_device_alloc(pdev, hwmods, oh_cnt);
162 dev_err(&pdev->dev, "Cannot allocate omap_device for :%s\n",
168 /* Fix up missing resource names */
169 for (i = 0; i < pdev->num_resources; i++) {
170 struct resource *r = &pdev->resource[i];
173 r->name = dev_name(&pdev->dev);
176 pdev->dev.pm_domain = &omap_device_pm_domain;
179 omap_device_enable(pdev);
180 pm_runtime_set_active(&pdev->dev);
189 static int _omap_device_notifier_call(struct notifier_block *nb,
190 unsigned long event, void *dev)
192 struct platform_device *pdev = to_platform_device(dev);
193 struct omap_device *od;
196 case BUS_NOTIFY_DEL_DEVICE:
197 if (pdev->archdata.od)
198 omap_device_delete(pdev->archdata.od);
200 case BUS_NOTIFY_ADD_DEVICE:
201 if (pdev->dev.of_node)
202 omap_device_build_from_dt(pdev);
205 od = to_omap_device(pdev);
207 od->_driver_status = event;
214 * _omap_device_enable_hwmods - call omap_hwmod_enable() on all hwmods
215 * @od: struct omap_device *od
217 * Enable all underlying hwmods. Returns 0.
219 static int _omap_device_enable_hwmods(struct omap_device *od)
223 for (i = 0; i < od->hwmods_cnt; i++)
224 omap_hwmod_enable(od->hwmods[i]);
226 /* XXX pass along return value here? */
231 * _omap_device_idle_hwmods - call omap_hwmod_idle() on all hwmods
232 * @od: struct omap_device *od
234 * Idle all underlying hwmods. Returns 0.
236 static int _omap_device_idle_hwmods(struct omap_device *od)
240 for (i = 0; i < od->hwmods_cnt; i++)
241 omap_hwmod_idle(od->hwmods[i]);
243 /* XXX pass along return value here? */
247 /* Public functions for use by core code */
250 * omap_device_get_context_loss_count - get lost context count
251 * @od: struct omap_device *
253 * Using the primary hwmod, query the context loss count for this
256 * Callers should consider context for this device lost any time this
257 * function returns a value different than the value the caller got
258 * the last time it called this function.
260 * If any hwmods exist for the omap_device assoiated with @pdev,
261 * return the context loss counter for that hwmod, otherwise return
264 int omap_device_get_context_loss_count(struct platform_device *pdev)
266 struct omap_device *od;
269 od = to_omap_device(pdev);
272 ret = omap_hwmod_get_context_loss_count(od->hwmods[0]);
278 * omap_device_count_resources - count number of struct resource entries needed
279 * @od: struct omap_device *
280 * @flags: Type of resources to include when counting (IRQ/DMA/MEM)
282 * Count the number of struct resource entries needed for this
283 * omap_device @od. Used by omap_device_build_ss() to determine how
284 * much memory to allocate before calling
285 * omap_device_fill_resources(). Returns the count.
287 static int omap_device_count_resources(struct omap_device *od,
293 for (i = 0; i < od->hwmods_cnt; i++)
294 c += omap_hwmod_count_resources(od->hwmods[i], flags);
296 pr_debug("omap_device: %s: counted %d total resources across %d hwmods\n",
297 od->pdev->name, c, od->hwmods_cnt);
303 * omap_device_fill_resources - fill in array of struct resource
304 * @od: struct omap_device *
305 * @res: pointer to an array of struct resource to be filled in
307 * Populate one or more empty struct resource pointed to by @res with
308 * the resource data for this omap_device @od. Used by
309 * omap_device_build_ss() after calling omap_device_count_resources().
310 * Ideally this function would not be needed at all. If omap_device
311 * replaces platform_device, then we can specify our own
312 * get_resource()/ get_irq()/etc functions that use the underlying
313 * omap_hwmod information. Or if platform_device is extended to use
314 * subarchitecture-specific function pointers, the various
315 * platform_device functions can simply call omap_device internal
316 * functions to get device resources. Hacking around the existing
317 * platform_device code wastes memory. Returns 0.
319 static int omap_device_fill_resources(struct omap_device *od,
320 struct resource *res)
324 for (i = 0; i < od->hwmods_cnt; i++) {
325 r = omap_hwmod_fill_resources(od->hwmods[i], res);
333 * _od_fill_dma_resources - fill in array of struct resource with dma resources
334 * @od: struct omap_device *
335 * @res: pointer to an array of struct resource to be filled in
337 * Populate one or more empty struct resource pointed to by @res with
338 * the dma resource data for this omap_device @od. Used by
339 * omap_device_alloc() after calling omap_device_count_resources().
341 * Ideally this function would not be needed at all. If we have
342 * mechanism to get dma resources from DT.
346 static int _od_fill_dma_resources(struct omap_device *od,
347 struct resource *res)
351 for (i = 0; i < od->hwmods_cnt; i++) {
352 r = omap_hwmod_fill_dma_resources(od->hwmods[i], res);
360 * omap_device_alloc - allocate an omap_device
361 * @pdev: platform_device that will be included in this omap_device
362 * @oh: ptr to the single omap_hwmod that backs this omap_device
363 * @pdata: platform_data ptr to associate with the platform_device
364 * @pdata_len: amount of memory pointed to by @pdata
366 * Convenience function for allocating an omap_device structure and filling
367 * hwmods, and resources.
369 * Returns an struct omap_device pointer or ERR_PTR() on error;
371 struct omap_device *omap_device_alloc(struct platform_device *pdev,
372 struct omap_hwmod **ohs, int oh_cnt)
375 struct omap_device *od;
376 struct resource *res = NULL;
378 struct omap_hwmod **hwmods;
380 od = kzalloc(sizeof(struct omap_device), GFP_KERNEL);
385 od->hwmods_cnt = oh_cnt;
387 hwmods = kmemdup(ohs, sizeof(struct omap_hwmod *) * oh_cnt, GFP_KERNEL);
396 * Here, pdev->num_resources = 0, and we should get all the
397 * resources from hwmod.
400 * OF framework will construct the resource structure (currently
401 * does for MEM & IRQ resource) and we should respect/use these
402 * resources, killing hwmod dependency.
403 * If pdev->num_resources > 0, we assume that MEM & IRQ resources
404 * have been allocated by OF layer already (through DTB).
405 * As preparation for the future we examine the OF provided resources
406 * to see if we have DMA resources provided already. In this case
407 * there is no need to update the resources for the device, we use the
410 * TODO: Once DMA resource is available from OF layer, we should
411 * kill filling any resources from hwmod.
413 if (!pdev->num_resources) {
414 /* Count all resources for the device */
415 res_count = omap_device_count_resources(od, IORESOURCE_IRQ |
419 /* Take a look if we already have DMA resource via DT */
420 for (i = 0; i < pdev->num_resources; i++) {
421 struct resource *r = &pdev->resource[i];
423 /* We have it, no need to touch the resources */
424 if (r->flags == IORESOURCE_DMA)
425 goto have_everything;
427 /* Count only DMA resources for the device */
428 res_count = omap_device_count_resources(od, IORESOURCE_DMA);
429 /* The device has no DMA resource, no need for update */
431 goto have_everything;
433 res_count += pdev->num_resources;
436 /* Allocate resources memory to account for new resources */
437 res = kzalloc(sizeof(struct resource) * res_count, GFP_KERNEL);
441 if (!pdev->num_resources) {
442 dev_dbg(&pdev->dev, "%s: using %d resources from hwmod\n",
443 __func__, res_count);
444 omap_device_fill_resources(od, res);
447 "%s: appending %d DMA resources from hwmod\n",
448 __func__, res_count - pdev->num_resources);
449 memcpy(res, pdev->resource,
450 sizeof(struct resource) * pdev->num_resources);
451 _od_fill_dma_resources(od, &res[pdev->num_resources]);
454 ret = platform_device_add_resources(pdev, res, res_count);
461 pdev->archdata.od = od;
463 for (i = 0; i < oh_cnt; i++) {
465 _add_hwmod_clocks_clkdev(od, hwmods[i]);
475 dev_err(&pdev->dev, "omap_device: build failed (%d)\n", ret);
480 void omap_device_delete(struct omap_device *od)
485 od->pdev->archdata.od = NULL;
491 * omap_device_build - build and register an omap_device with one omap_hwmod
492 * @pdev_name: name of the platform_device driver to use
493 * @pdev_id: this platform_device's connection ID
494 * @oh: ptr to the single omap_hwmod that backs this omap_device
495 * @pdata: platform_data ptr to associate with the platform_device
496 * @pdata_len: amount of memory pointed to by @pdata
498 * Convenience function for building and registering a single
499 * omap_device record, which in turn builds and registers a
500 * platform_device record. See omap_device_build_ss() for more
501 * information. Returns ERR_PTR(-EINVAL) if @oh is NULL; otherwise,
502 * passes along the return value of omap_device_build_ss().
504 struct platform_device __init *omap_device_build(const char *pdev_name,
506 struct omap_hwmod *oh,
507 void *pdata, int pdata_len)
509 struct omap_hwmod *ohs[] = { oh };
512 return ERR_PTR(-EINVAL);
514 return omap_device_build_ss(pdev_name, pdev_id, ohs, 1, pdata,
519 * omap_device_build_ss - build and register an omap_device with multiple hwmods
520 * @pdev_name: name of the platform_device driver to use
521 * @pdev_id: this platform_device's connection ID
522 * @oh: ptr to the single omap_hwmod that backs this omap_device
523 * @pdata: platform_data ptr to associate with the platform_device
524 * @pdata_len: amount of memory pointed to by @pdata
526 * Convenience function for building and registering an omap_device
527 * subsystem record. Subsystem records consist of multiple
528 * omap_hwmods. This function in turn builds and registers a
529 * platform_device record. Returns an ERR_PTR() on error, or passes
530 * along the return value of omap_device_register().
532 struct platform_device __init *omap_device_build_ss(const char *pdev_name,
534 struct omap_hwmod **ohs,
535 int oh_cnt, void *pdata,
539 struct platform_device *pdev;
540 struct omap_device *od;
542 if (!ohs || oh_cnt == 0 || !pdev_name)
543 return ERR_PTR(-EINVAL);
545 if (!pdata && pdata_len > 0)
546 return ERR_PTR(-EINVAL);
548 pdev = platform_device_alloc(pdev_name, pdev_id);
554 /* Set the dev_name early to allow dev_xxx in omap_device_alloc */
556 dev_set_name(&pdev->dev, "%s.%d", pdev->name, pdev->id);
558 dev_set_name(&pdev->dev, "%s", pdev->name);
560 od = omap_device_alloc(pdev, ohs, oh_cnt);
564 ret = platform_device_add_data(pdev, pdata, pdata_len);
568 ret = omap_device_register(pdev);
575 omap_device_delete(od);
577 platform_device_put(pdev);
580 pr_err("omap_device: %s: build failed (%d)\n", pdev_name, ret);
585 #ifdef CONFIG_PM_RUNTIME
586 static int _od_runtime_suspend(struct device *dev)
588 struct platform_device *pdev = to_platform_device(dev);
591 ret = pm_generic_runtime_suspend(dev);
594 omap_device_idle(pdev);
599 static int _od_runtime_resume(struct device *dev)
601 struct platform_device *pdev = to_platform_device(dev);
603 omap_device_enable(pdev);
605 return pm_generic_runtime_resume(dev);
609 #ifdef CONFIG_SUSPEND
610 static int _od_suspend_noirq(struct device *dev)
612 struct platform_device *pdev = to_platform_device(dev);
613 struct omap_device *od = to_omap_device(pdev);
616 /* Don't attempt late suspend on a driver that is not bound */
617 if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER)
620 ret = pm_generic_suspend_noirq(dev);
622 if (!ret && !pm_runtime_status_suspended(dev)) {
623 if (pm_generic_runtime_suspend(dev) == 0) {
624 omap_device_idle(pdev);
625 od->flags |= OMAP_DEVICE_SUSPENDED;
632 static int _od_resume_noirq(struct device *dev)
634 struct platform_device *pdev = to_platform_device(dev);
635 struct omap_device *od = to_omap_device(pdev);
637 if ((od->flags & OMAP_DEVICE_SUSPENDED) &&
638 !pm_runtime_status_suspended(dev)) {
639 od->flags &= ~OMAP_DEVICE_SUSPENDED;
640 omap_device_enable(pdev);
641 pm_generic_runtime_resume(dev);
644 return pm_generic_resume_noirq(dev);
647 #define _od_suspend_noirq NULL
648 #define _od_resume_noirq NULL
651 struct dev_pm_domain omap_device_pm_domain = {
653 SET_RUNTIME_PM_OPS(_od_runtime_suspend, _od_runtime_resume,
655 USE_PLATFORM_PM_SLEEP_OPS
656 .suspend_noirq = _od_suspend_noirq,
657 .resume_noirq = _od_resume_noirq,
662 * omap_device_register - register an omap_device with one omap_hwmod
663 * @od: struct omap_device * to register
665 * Register the omap_device structure. This currently just calls
666 * platform_device_register() on the underlying platform_device.
667 * Returns the return value of platform_device_register().
669 int omap_device_register(struct platform_device *pdev)
671 pr_debug("omap_device: %s: registering\n", pdev->name);
673 pdev->dev.pm_domain = &omap_device_pm_domain;
674 return platform_device_add(pdev);
678 /* Public functions for use by device drivers through struct platform_data */
681 * omap_device_enable - fully activate an omap_device
682 * @od: struct omap_device * to activate
684 * Do whatever is necessary for the hwmods underlying omap_device @od
685 * to be accessible and ready to operate. This generally involves
686 * enabling clocks, setting SYSCONFIG registers; and in the future may
687 * involve remuxing pins. Device drivers should call this function
688 * indirectly via pm_runtime_get*(). Returns -EINVAL if called when
689 * the omap_device is already enabled, or passes along the return
690 * value of _omap_device_enable_hwmods().
692 int omap_device_enable(struct platform_device *pdev)
695 struct omap_device *od;
697 od = to_omap_device(pdev);
699 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
701 "omap_device: %s() called from invalid state %d\n",
702 __func__, od->_state);
706 ret = _omap_device_enable_hwmods(od);
708 od->_state = OMAP_DEVICE_STATE_ENABLED;
714 * omap_device_idle - idle an omap_device
715 * @od: struct omap_device * to idle
717 * Idle omap_device @od. Device drivers call this function indirectly
718 * via pm_runtime_put*(). Returns -EINVAL if the omap_device is not
719 * currently enabled, or passes along the return value of
720 * _omap_device_idle_hwmods().
722 int omap_device_idle(struct platform_device *pdev)
725 struct omap_device *od;
727 od = to_omap_device(pdev);
729 if (od->_state != OMAP_DEVICE_STATE_ENABLED) {
731 "omap_device: %s() called from invalid state %d\n",
732 __func__, od->_state);
736 ret = _omap_device_idle_hwmods(od);
738 od->_state = OMAP_DEVICE_STATE_IDLE;
744 * omap_device_assert_hardreset - set a device's hardreset line
745 * @pdev: struct platform_device * to reset
746 * @name: const char * name of the reset line
748 * Set the hardreset line identified by @name on the IP blocks
749 * associated with the hwmods backing the platform_device @pdev. All
750 * of the hwmods associated with @pdev must have the same hardreset
751 * line linked to them for this to work. Passes along the return value
752 * of omap_hwmod_assert_hardreset() in the event of any failure, or
753 * returns 0 upon success.
755 int omap_device_assert_hardreset(struct platform_device *pdev, const char *name)
757 struct omap_device *od = to_omap_device(pdev);
761 for (i = 0; i < od->hwmods_cnt; i++) {
762 ret = omap_hwmod_assert_hardreset(od->hwmods[i], name);
771 * omap_device_deassert_hardreset - release a device's hardreset line
772 * @pdev: struct platform_device * to reset
773 * @name: const char * name of the reset line
775 * Release the hardreset line identified by @name on the IP blocks
776 * associated with the hwmods backing the platform_device @pdev. All
777 * of the hwmods associated with @pdev must have the same hardreset
778 * line linked to them for this to work. Passes along the return
779 * value of omap_hwmod_deassert_hardreset() in the event of any
780 * failure, or returns 0 upon success.
782 int omap_device_deassert_hardreset(struct platform_device *pdev,
785 struct omap_device *od = to_omap_device(pdev);
789 for (i = 0; i < od->hwmods_cnt; i++) {
790 ret = omap_hwmod_deassert_hardreset(od->hwmods[i], name);
799 * omap_device_get_by_hwmod_name() - convert a hwmod name to
801 * @oh_name: name of the hwmod device
803 * Returns back a struct device * pointer associated with a hwmod
804 * device represented by a hwmod_name
806 struct device *omap_device_get_by_hwmod_name(const char *oh_name)
808 struct omap_hwmod *oh;
811 WARN(1, "%s: no hwmod name!\n", __func__);
812 return ERR_PTR(-EINVAL);
815 oh = omap_hwmod_lookup(oh_name);
817 WARN(1, "%s: no hwmod for %s\n", __func__,
819 return ERR_PTR(-ENODEV);
822 WARN(1, "%s: no omap_device for %s\n", __func__,
824 return ERR_PTR(-ENODEV);
827 return &oh->od->pdev->dev;
830 static struct notifier_block platform_nb = {
831 .notifier_call = _omap_device_notifier_call,
834 static int __init omap_device_init(void)
836 bus_register_notifier(&platform_bus_type, &platform_nb);
839 omap_core_initcall(omap_device_init);
842 * omap_device_late_idle - idle devices without drivers
843 * @dev: struct device * associated with omap_device
846 * Check the driver bound status of this device, and idle it
847 * if there is no driver attached.
849 static int __init omap_device_late_idle(struct device *dev, void *data)
851 struct platform_device *pdev = to_platform_device(dev);
852 struct omap_device *od = to_omap_device(pdev);
859 * If omap_device state is enabled, but has no driver bound,
864 * Some devices (like memory controllers) are always kept
865 * enabled, and should not be idled even with no drivers.
867 for (i = 0; i < od->hwmods_cnt; i++)
868 if (od->hwmods[i]->flags & HWMOD_INIT_NO_IDLE)
871 if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER) {
872 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
873 dev_warn(dev, "%s: enabled but no driver. Idling\n",
875 omap_device_idle(pdev);
882 static int __init omap_device_late_init(void)
884 bus_for_each_dev(&platform_bus_type, NULL, NULL, omap_device_late_idle);
887 omap_late_initcall_sync(omap_device_late_init);