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);
186 /* if data/we are at fault.. load up a fail handler */
188 pdev->dev.pm_domain = &omap_device_fail_pm_domain;
193 static int _omap_device_notifier_call(struct notifier_block *nb,
194 unsigned long event, void *dev)
196 struct platform_device *pdev = to_platform_device(dev);
197 struct omap_device *od;
200 case BUS_NOTIFY_DEL_DEVICE:
201 if (pdev->archdata.od)
202 omap_device_delete(pdev->archdata.od);
204 case BUS_NOTIFY_ADD_DEVICE:
205 if (pdev->dev.of_node)
206 omap_device_build_from_dt(pdev);
209 od = to_omap_device(pdev);
211 od->_driver_status = event;
218 * _omap_device_enable_hwmods - call omap_hwmod_enable() on all hwmods
219 * @od: struct omap_device *od
221 * Enable all underlying hwmods. Returns 0.
223 static int _omap_device_enable_hwmods(struct omap_device *od)
227 for (i = 0; i < od->hwmods_cnt; i++)
228 omap_hwmod_enable(od->hwmods[i]);
230 /* XXX pass along return value here? */
235 * _omap_device_idle_hwmods - call omap_hwmod_idle() on all hwmods
236 * @od: struct omap_device *od
238 * Idle all underlying hwmods. Returns 0.
240 static int _omap_device_idle_hwmods(struct omap_device *od)
244 for (i = 0; i < od->hwmods_cnt; i++)
245 omap_hwmod_idle(od->hwmods[i]);
247 /* XXX pass along return value here? */
251 /* Public functions for use by core code */
254 * omap_device_get_context_loss_count - get lost context count
255 * @od: struct omap_device *
257 * Using the primary hwmod, query the context loss count for this
260 * Callers should consider context for this device lost any time this
261 * function returns a value different than the value the caller got
262 * the last time it called this function.
264 * If any hwmods exist for the omap_device assoiated with @pdev,
265 * return the context loss counter for that hwmod, otherwise return
268 int omap_device_get_context_loss_count(struct platform_device *pdev)
270 struct omap_device *od;
273 od = to_omap_device(pdev);
276 ret = omap_hwmod_get_context_loss_count(od->hwmods[0]);
282 * omap_device_count_resources - count number of struct resource entries needed
283 * @od: struct omap_device *
284 * @flags: Type of resources to include when counting (IRQ/DMA/MEM)
286 * Count the number of struct resource entries needed for this
287 * omap_device @od. Used by omap_device_build_ss() to determine how
288 * much memory to allocate before calling
289 * omap_device_fill_resources(). Returns the count.
291 static int omap_device_count_resources(struct omap_device *od,
297 for (i = 0; i < od->hwmods_cnt; i++)
298 c += omap_hwmod_count_resources(od->hwmods[i], flags);
300 pr_debug("omap_device: %s: counted %d total resources across %d hwmods\n",
301 od->pdev->name, c, od->hwmods_cnt);
307 * omap_device_fill_resources - fill in array of struct resource
308 * @od: struct omap_device *
309 * @res: pointer to an array of struct resource to be filled in
311 * Populate one or more empty struct resource pointed to by @res with
312 * the resource data for this omap_device @od. Used by
313 * omap_device_build_ss() after calling omap_device_count_resources().
314 * Ideally this function would not be needed at all. If omap_device
315 * replaces platform_device, then we can specify our own
316 * get_resource()/ get_irq()/etc functions that use the underlying
317 * omap_hwmod information. Or if platform_device is extended to use
318 * subarchitecture-specific function pointers, the various
319 * platform_device functions can simply call omap_device internal
320 * functions to get device resources. Hacking around the existing
321 * platform_device code wastes memory. Returns 0.
323 static int omap_device_fill_resources(struct omap_device *od,
324 struct resource *res)
328 for (i = 0; i < od->hwmods_cnt; i++) {
329 r = omap_hwmod_fill_resources(od->hwmods[i], res);
337 * _od_fill_dma_resources - fill in array of struct resource with dma resources
338 * @od: struct omap_device *
339 * @res: pointer to an array of struct resource to be filled in
341 * Populate one or more empty struct resource pointed to by @res with
342 * the dma resource data for this omap_device @od. Used by
343 * omap_device_alloc() after calling omap_device_count_resources().
345 * Ideally this function would not be needed at all. If we have
346 * mechanism to get dma resources from DT.
350 static int _od_fill_dma_resources(struct omap_device *od,
351 struct resource *res)
355 for (i = 0; i < od->hwmods_cnt; i++) {
356 r = omap_hwmod_fill_dma_resources(od->hwmods[i], res);
364 * omap_device_alloc - allocate an omap_device
365 * @pdev: platform_device that will be included in this omap_device
366 * @oh: ptr to the single omap_hwmod that backs this omap_device
367 * @pdata: platform_data ptr to associate with the platform_device
368 * @pdata_len: amount of memory pointed to by @pdata
370 * Convenience function for allocating an omap_device structure and filling
371 * hwmods, and resources.
373 * Returns an struct omap_device pointer or ERR_PTR() on error;
375 struct omap_device *omap_device_alloc(struct platform_device *pdev,
376 struct omap_hwmod **ohs, int oh_cnt)
379 struct omap_device *od;
380 struct resource *res = NULL;
382 struct omap_hwmod **hwmods;
384 od = kzalloc(sizeof(struct omap_device), GFP_KERNEL);
389 od->hwmods_cnt = oh_cnt;
391 hwmods = kmemdup(ohs, sizeof(struct omap_hwmod *) * oh_cnt, GFP_KERNEL);
400 * Here, pdev->num_resources = 0, and we should get all the
401 * resources from hwmod.
404 * OF framework will construct the resource structure (currently
405 * does for MEM & IRQ resource) and we should respect/use these
406 * resources, killing hwmod dependency.
407 * If pdev->num_resources > 0, we assume that MEM & IRQ resources
408 * have been allocated by OF layer already (through DTB).
409 * As preparation for the future we examine the OF provided resources
410 * to see if we have DMA resources provided already. In this case
411 * there is no need to update the resources for the device, we use the
414 * TODO: Once DMA resource is available from OF layer, we should
415 * kill filling any resources from hwmod.
417 if (!pdev->num_resources) {
418 /* Count all resources for the device */
419 res_count = omap_device_count_resources(od, IORESOURCE_IRQ |
423 /* Take a look if we already have DMA resource via DT */
424 for (i = 0; i < pdev->num_resources; i++) {
425 struct resource *r = &pdev->resource[i];
427 /* We have it, no need to touch the resources */
428 if (r->flags == IORESOURCE_DMA)
429 goto have_everything;
431 /* Count only DMA resources for the device */
432 res_count = omap_device_count_resources(od, IORESOURCE_DMA);
433 /* The device has no DMA resource, no need for update */
435 goto have_everything;
437 res_count += pdev->num_resources;
440 /* Allocate resources memory to account for new resources */
441 res = kzalloc(sizeof(struct resource) * res_count, GFP_KERNEL);
445 if (!pdev->num_resources) {
446 dev_dbg(&pdev->dev, "%s: using %d resources from hwmod\n",
447 __func__, res_count);
448 omap_device_fill_resources(od, res);
451 "%s: appending %d DMA resources from hwmod\n",
452 __func__, res_count - pdev->num_resources);
453 memcpy(res, pdev->resource,
454 sizeof(struct resource) * pdev->num_resources);
455 _od_fill_dma_resources(od, &res[pdev->num_resources]);
458 ret = platform_device_add_resources(pdev, res, res_count);
465 pdev->archdata.od = od;
467 for (i = 0; i < oh_cnt; i++) {
469 _add_hwmod_clocks_clkdev(od, hwmods[i]);
479 dev_err(&pdev->dev, "omap_device: build failed (%d)\n", ret);
484 void omap_device_delete(struct omap_device *od)
489 od->pdev->archdata.od = NULL;
495 * omap_device_build - build and register an omap_device with one omap_hwmod
496 * @pdev_name: name of the platform_device driver to use
497 * @pdev_id: this platform_device's connection ID
498 * @oh: ptr to the single omap_hwmod that backs this omap_device
499 * @pdata: platform_data ptr to associate with the platform_device
500 * @pdata_len: amount of memory pointed to by @pdata
502 * Convenience function for building and registering a single
503 * omap_device record, which in turn builds and registers a
504 * platform_device record. See omap_device_build_ss() for more
505 * information. Returns ERR_PTR(-EINVAL) if @oh is NULL; otherwise,
506 * passes along the return value of omap_device_build_ss().
508 struct platform_device __init *omap_device_build(const char *pdev_name,
510 struct omap_hwmod *oh,
511 void *pdata, int pdata_len)
513 struct omap_hwmod *ohs[] = { oh };
516 return ERR_PTR(-EINVAL);
518 return omap_device_build_ss(pdev_name, pdev_id, ohs, 1, pdata,
523 * omap_device_build_ss - build and register an omap_device with multiple hwmods
524 * @pdev_name: name of the platform_device driver to use
525 * @pdev_id: this platform_device's connection ID
526 * @oh: ptr to the single omap_hwmod that backs this omap_device
527 * @pdata: platform_data ptr to associate with the platform_device
528 * @pdata_len: amount of memory pointed to by @pdata
530 * Convenience function for building and registering an omap_device
531 * subsystem record. Subsystem records consist of multiple
532 * omap_hwmods. This function in turn builds and registers a
533 * platform_device record. Returns an ERR_PTR() on error, or passes
534 * along the return value of omap_device_register().
536 struct platform_device __init *omap_device_build_ss(const char *pdev_name,
538 struct omap_hwmod **ohs,
539 int oh_cnt, void *pdata,
543 struct platform_device *pdev;
544 struct omap_device *od;
546 if (!ohs || oh_cnt == 0 || !pdev_name)
547 return ERR_PTR(-EINVAL);
549 if (!pdata && pdata_len > 0)
550 return ERR_PTR(-EINVAL);
552 pdev = platform_device_alloc(pdev_name, pdev_id);
558 /* Set the dev_name early to allow dev_xxx in omap_device_alloc */
560 dev_set_name(&pdev->dev, "%s.%d", pdev->name, pdev->id);
562 dev_set_name(&pdev->dev, "%s", pdev->name);
564 od = omap_device_alloc(pdev, ohs, oh_cnt);
568 ret = platform_device_add_data(pdev, pdata, pdata_len);
572 ret = omap_device_register(pdev);
579 omap_device_delete(od);
581 platform_device_put(pdev);
584 pr_err("omap_device: %s: build failed (%d)\n", pdev_name, ret);
589 #ifdef CONFIG_PM_RUNTIME
590 static int _od_runtime_suspend(struct device *dev)
592 struct platform_device *pdev = to_platform_device(dev);
595 ret = pm_generic_runtime_suspend(dev);
598 omap_device_idle(pdev);
603 static int _od_runtime_resume(struct device *dev)
605 struct platform_device *pdev = to_platform_device(dev);
607 omap_device_enable(pdev);
609 return pm_generic_runtime_resume(dev);
612 static int _od_fail_runtime_suspend(struct device *dev)
614 dev_warn(dev, "%s: FIXME: missing hwmod/omap_dev info\n", __func__);
618 static int _od_fail_runtime_resume(struct device *dev)
620 dev_warn(dev, "%s: FIXME: missing hwmod/omap_dev info\n", __func__);
626 #ifdef CONFIG_SUSPEND
627 static int _od_suspend_noirq(struct device *dev)
629 struct platform_device *pdev = to_platform_device(dev);
630 struct omap_device *od = to_omap_device(pdev);
633 /* Don't attempt late suspend on a driver that is not bound */
634 if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER)
637 ret = pm_generic_suspend_noirq(dev);
639 if (!ret && !pm_runtime_status_suspended(dev)) {
640 if (pm_generic_runtime_suspend(dev) == 0) {
641 pm_runtime_set_suspended(dev);
642 omap_device_idle(pdev);
643 od->flags |= OMAP_DEVICE_SUSPENDED;
650 static int _od_resume_noirq(struct device *dev)
652 struct platform_device *pdev = to_platform_device(dev);
653 struct omap_device *od = to_omap_device(pdev);
655 if (od->flags & OMAP_DEVICE_SUSPENDED) {
656 od->flags &= ~OMAP_DEVICE_SUSPENDED;
657 omap_device_enable(pdev);
659 * XXX: we run before core runtime pm has resumed itself. At
660 * this point in time, we just restore the runtime pm state and
661 * considering symmetric operations in resume, we donot expect
662 * to fail. If we failed, something changed in core runtime_pm
663 * framework OR some device driver messed things up, hence, WARN
665 WARN(pm_runtime_set_active(dev),
666 "Could not set %s runtime state active\n", dev_name(dev));
667 pm_generic_runtime_resume(dev);
670 return pm_generic_resume_noirq(dev);
673 #define _od_suspend_noirq NULL
674 #define _od_resume_noirq NULL
677 struct dev_pm_domain omap_device_fail_pm_domain = {
679 SET_RUNTIME_PM_OPS(_od_fail_runtime_suspend,
680 _od_fail_runtime_resume, NULL)
684 struct dev_pm_domain omap_device_pm_domain = {
686 SET_RUNTIME_PM_OPS(_od_runtime_suspend, _od_runtime_resume,
688 USE_PLATFORM_PM_SLEEP_OPS
689 .suspend_noirq = _od_suspend_noirq,
690 .resume_noirq = _od_resume_noirq,
695 * omap_device_register - register an omap_device with one omap_hwmod
696 * @od: struct omap_device * to register
698 * Register the omap_device structure. This currently just calls
699 * platform_device_register() on the underlying platform_device.
700 * Returns the return value of platform_device_register().
702 int omap_device_register(struct platform_device *pdev)
704 pr_debug("omap_device: %s: registering\n", pdev->name);
706 pdev->dev.pm_domain = &omap_device_pm_domain;
707 return platform_device_add(pdev);
711 /* Public functions for use by device drivers through struct platform_data */
714 * omap_device_enable - fully activate an omap_device
715 * @od: struct omap_device * to activate
717 * Do whatever is necessary for the hwmods underlying omap_device @od
718 * to be accessible and ready to operate. This generally involves
719 * enabling clocks, setting SYSCONFIG registers; and in the future may
720 * involve remuxing pins. Device drivers should call this function
721 * indirectly via pm_runtime_get*(). Returns -EINVAL if called when
722 * the omap_device is already enabled, or passes along the return
723 * value of _omap_device_enable_hwmods().
725 int omap_device_enable(struct platform_device *pdev)
728 struct omap_device *od;
730 od = to_omap_device(pdev);
732 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
734 "omap_device: %s() called from invalid state %d\n",
735 __func__, od->_state);
739 ret = _omap_device_enable_hwmods(od);
741 od->_state = OMAP_DEVICE_STATE_ENABLED;
747 * omap_device_idle - idle an omap_device
748 * @od: struct omap_device * to idle
750 * Idle omap_device @od. Device drivers call this function indirectly
751 * via pm_runtime_put*(). Returns -EINVAL if the omap_device is not
752 * currently enabled, or passes along the return value of
753 * _omap_device_idle_hwmods().
755 int omap_device_idle(struct platform_device *pdev)
758 struct omap_device *od;
760 od = to_omap_device(pdev);
762 if (od->_state != OMAP_DEVICE_STATE_ENABLED) {
764 "omap_device: %s() called from invalid state %d\n",
765 __func__, od->_state);
769 ret = _omap_device_idle_hwmods(od);
771 od->_state = OMAP_DEVICE_STATE_IDLE;
777 * omap_device_assert_hardreset - set a device's hardreset line
778 * @pdev: struct platform_device * to reset
779 * @name: const char * name of the reset line
781 * Set the hardreset line identified by @name on the IP blocks
782 * associated with the hwmods backing the platform_device @pdev. All
783 * of the hwmods associated with @pdev must have the same hardreset
784 * line linked to them for this to work. Passes along the return value
785 * of omap_hwmod_assert_hardreset() in the event of any failure, or
786 * returns 0 upon success.
788 int omap_device_assert_hardreset(struct platform_device *pdev, const char *name)
790 struct omap_device *od = to_omap_device(pdev);
794 for (i = 0; i < od->hwmods_cnt; i++) {
795 ret = omap_hwmod_assert_hardreset(od->hwmods[i], name);
804 * omap_device_deassert_hardreset - release a device's hardreset line
805 * @pdev: struct platform_device * to reset
806 * @name: const char * name of the reset line
808 * Release the hardreset line identified by @name on the IP blocks
809 * associated with the hwmods backing the platform_device @pdev. All
810 * of the hwmods associated with @pdev must have the same hardreset
811 * line linked to them for this to work. Passes along the return
812 * value of omap_hwmod_deassert_hardreset() in the event of any
813 * failure, or returns 0 upon success.
815 int omap_device_deassert_hardreset(struct platform_device *pdev,
818 struct omap_device *od = to_omap_device(pdev);
822 for (i = 0; i < od->hwmods_cnt; i++) {
823 ret = omap_hwmod_deassert_hardreset(od->hwmods[i], name);
832 * omap_device_get_by_hwmod_name() - convert a hwmod name to
834 * @oh_name: name of the hwmod device
836 * Returns back a struct device * pointer associated with a hwmod
837 * device represented by a hwmod_name
839 struct device *omap_device_get_by_hwmod_name(const char *oh_name)
841 struct omap_hwmod *oh;
844 WARN(1, "%s: no hwmod name!\n", __func__);
845 return ERR_PTR(-EINVAL);
848 oh = omap_hwmod_lookup(oh_name);
850 WARN(1, "%s: no hwmod for %s\n", __func__,
852 return ERR_PTR(-ENODEV);
855 WARN(1, "%s: no omap_device for %s\n", __func__,
857 return ERR_PTR(-ENODEV);
860 return &oh->od->pdev->dev;
863 static struct notifier_block platform_nb = {
864 .notifier_call = _omap_device_notifier_call,
867 static int __init omap_device_init(void)
869 bus_register_notifier(&platform_bus_type, &platform_nb);
872 omap_core_initcall(omap_device_init);
875 * omap_device_late_idle - idle devices without drivers
876 * @dev: struct device * associated with omap_device
879 * Check the driver bound status of this device, and idle it
880 * if there is no driver attached.
882 static int __init omap_device_late_idle(struct device *dev, void *data)
884 struct platform_device *pdev = to_platform_device(dev);
885 struct omap_device *od = to_omap_device(pdev);
892 * If omap_device state is enabled, but has no driver bound,
897 * Some devices (like memory controllers) are always kept
898 * enabled, and should not be idled even with no drivers.
900 for (i = 0; i < od->hwmods_cnt; i++)
901 if (od->hwmods[i]->flags & HWMOD_INIT_NO_IDLE)
904 if (od->_driver_status != BUS_NOTIFY_BOUND_DRIVER) {
905 if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
906 dev_warn(dev, "%s: enabled but no driver. Idling\n",
908 omap_device_idle(pdev);
915 static int __init omap_device_late_init(void)
917 bus_for_each_dev(&platform_bus_type, NULL, NULL, omap_device_late_idle);
920 omap_late_initcall_sync(omap_device_late_init);