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;
133 oh_cnt
= of_property_count_strings(node
, "ti,hwmods");
135 dev_dbg(&pdev
->dev
, "No 'hwmods' to build omap_device\n");
139 hwmods
= kzalloc(sizeof(struct omap_hwmod
*) * oh_cnt
, GFP_KERNEL
);
145 for (i
= 0; i
< oh_cnt
; i
++) {
146 of_property_read_string_index(node
, "ti,hwmods", i
, &oh_name
);
147 oh
= omap_hwmod_lookup(oh_name
);
149 dev_err(&pdev
->dev
, "Cannot lookup hwmod '%s'\n",
157 od
= omap_device_alloc(pdev
, hwmods
, oh_cnt
);
159 dev_err(&pdev
->dev
, "Cannot allocate omap_device for :%s\n",
165 /* Fix up missing resource names */
166 for (i
= 0; i
< pdev
->num_resources
; i
++) {
167 struct resource
*r
= &pdev
->resource
[i
];
170 r
->name
= dev_name(&pdev
->dev
);
173 pdev
->dev
.pm_domain
= &omap_device_pm_domain
;
181 static int _omap_device_notifier_call(struct notifier_block
*nb
,
182 unsigned long event
, void *dev
)
184 struct platform_device
*pdev
= to_platform_device(dev
);
185 struct omap_device
*od
;
188 case BUS_NOTIFY_DEL_DEVICE
:
189 if (pdev
->archdata
.od
)
190 omap_device_delete(pdev
->archdata
.od
);
192 case BUS_NOTIFY_ADD_DEVICE
:
193 if (pdev
->dev
.of_node
)
194 omap_device_build_from_dt(pdev
);
197 od
= to_omap_device(pdev
);
199 od
->_driver_status
= event
;
206 * _omap_device_enable_hwmods - call omap_hwmod_enable() on all hwmods
207 * @od: struct omap_device *od
209 * Enable all underlying hwmods. Returns 0.
211 static int _omap_device_enable_hwmods(struct omap_device
*od
)
215 for (i
= 0; i
< od
->hwmods_cnt
; i
++)
216 omap_hwmod_enable(od
->hwmods
[i
]);
218 /* XXX pass along return value here? */
223 * _omap_device_idle_hwmods - call omap_hwmod_idle() on all hwmods
224 * @od: struct omap_device *od
226 * Idle all underlying hwmods. Returns 0.
228 static int _omap_device_idle_hwmods(struct omap_device
*od
)
232 for (i
= 0; i
< od
->hwmods_cnt
; i
++)
233 omap_hwmod_idle(od
->hwmods
[i
]);
235 /* XXX pass along return value here? */
239 /* Public functions for use by core code */
242 * omap_device_get_context_loss_count - get lost context count
243 * @od: struct omap_device *
245 * Using the primary hwmod, query the context loss count for this
248 * Callers should consider context for this device lost any time this
249 * function returns a value different than the value the caller got
250 * the last time it called this function.
252 * If any hwmods exist for the omap_device assoiated with @pdev,
253 * return the context loss counter for that hwmod, otherwise return
256 int omap_device_get_context_loss_count(struct platform_device
*pdev
)
258 struct omap_device
*od
;
261 od
= to_omap_device(pdev
);
264 ret
= omap_hwmod_get_context_loss_count(od
->hwmods
[0]);
270 * omap_device_count_resources - count number of struct resource entries needed
271 * @od: struct omap_device *
272 * @flags: Type of resources to include when counting (IRQ/DMA/MEM)
274 * Count the number of struct resource entries needed for this
275 * omap_device @od. Used by omap_device_build_ss() to determine how
276 * much memory to allocate before calling
277 * omap_device_fill_resources(). Returns the count.
279 static int omap_device_count_resources(struct omap_device
*od
,
285 for (i
= 0; i
< od
->hwmods_cnt
; i
++)
286 c
+= omap_hwmod_count_resources(od
->hwmods
[i
], flags
);
288 pr_debug("omap_device: %s: counted %d total resources across %d hwmods\n",
289 od
->pdev
->name
, c
, od
->hwmods_cnt
);
295 * omap_device_fill_resources - fill in array of struct resource
296 * @od: struct omap_device *
297 * @res: pointer to an array of struct resource to be filled in
299 * Populate one or more empty struct resource pointed to by @res with
300 * the resource data for this omap_device @od. Used by
301 * omap_device_build_ss() after calling omap_device_count_resources().
302 * Ideally this function would not be needed at all. If omap_device
303 * replaces platform_device, then we can specify our own
304 * get_resource()/ get_irq()/etc functions that use the underlying
305 * omap_hwmod information. Or if platform_device is extended to use
306 * subarchitecture-specific function pointers, the various
307 * platform_device functions can simply call omap_device internal
308 * functions to get device resources. Hacking around the existing
309 * platform_device code wastes memory. Returns 0.
311 static int omap_device_fill_resources(struct omap_device
*od
,
312 struct resource
*res
)
316 for (i
= 0; i
< od
->hwmods_cnt
; i
++) {
317 r
= omap_hwmod_fill_resources(od
->hwmods
[i
], res
);
325 * _od_fill_dma_resources - fill in array of struct resource with dma resources
326 * @od: struct omap_device *
327 * @res: pointer to an array of struct resource to be filled in
329 * Populate one or more empty struct resource pointed to by @res with
330 * the dma resource data for this omap_device @od. Used by
331 * omap_device_alloc() after calling omap_device_count_resources().
333 * Ideally this function would not be needed at all. If we have
334 * mechanism to get dma resources from DT.
338 static int _od_fill_dma_resources(struct omap_device
*od
,
339 struct resource
*res
)
343 for (i
= 0; i
< od
->hwmods_cnt
; i
++) {
344 r
= omap_hwmod_fill_dma_resources(od
->hwmods
[i
], res
);
352 * omap_device_alloc - allocate an omap_device
353 * @pdev: platform_device that will be included in this omap_device
354 * @oh: ptr to the single omap_hwmod that backs this omap_device
355 * @pdata: platform_data ptr to associate with the platform_device
356 * @pdata_len: amount of memory pointed to by @pdata
358 * Convenience function for allocating an omap_device structure and filling
359 * hwmods, and resources.
361 * Returns an struct omap_device pointer or ERR_PTR() on error;
363 struct omap_device
*omap_device_alloc(struct platform_device
*pdev
,
364 struct omap_hwmod
**ohs
, int oh_cnt
)
367 struct omap_device
*od
;
368 struct resource
*res
= NULL
;
370 struct omap_hwmod
**hwmods
;
372 od
= kzalloc(sizeof(struct omap_device
), GFP_KERNEL
);
377 od
->hwmods_cnt
= oh_cnt
;
379 hwmods
= kmemdup(ohs
, sizeof(struct omap_hwmod
*) * oh_cnt
, GFP_KERNEL
);
388 * Here, pdev->num_resources = 0, and we should get all the
389 * resources from hwmod.
392 * OF framework will construct the resource structure (currently
393 * does for MEM & IRQ resource) and we should respect/use these
394 * resources, killing hwmod dependency.
395 * If pdev->num_resources > 0, we assume that MEM & IRQ resources
396 * have been allocated by OF layer already (through DTB).
397 * As preparation for the future we examine the OF provided resources
398 * to see if we have DMA resources provided already. In this case
399 * there is no need to update the resources for the device, we use the
402 * TODO: Once DMA resource is available from OF layer, we should
403 * kill filling any resources from hwmod.
405 if (!pdev
->num_resources
) {
406 /* Count all resources for the device */
407 res_count
= omap_device_count_resources(od
, IORESOURCE_IRQ
|
411 /* Take a look if we already have DMA resource via DT */
412 for (i
= 0; i
< pdev
->num_resources
; i
++) {
413 struct resource
*r
= &pdev
->resource
[i
];
415 /* We have it, no need to touch the resources */
416 if (r
->flags
== IORESOURCE_DMA
)
417 goto have_everything
;
419 /* Count only DMA resources for the device */
420 res_count
= omap_device_count_resources(od
, IORESOURCE_DMA
);
421 /* The device has no DMA resource, no need for update */
423 goto have_everything
;
425 res_count
+= pdev
->num_resources
;
428 /* Allocate resources memory to account for new resources */
429 res
= kzalloc(sizeof(struct resource
) * res_count
, GFP_KERNEL
);
433 if (!pdev
->num_resources
) {
434 dev_dbg(&pdev
->dev
, "%s: using %d resources from hwmod\n",
435 __func__
, res_count
);
436 omap_device_fill_resources(od
, res
);
439 "%s: appending %d DMA resources from hwmod\n",
440 __func__
, res_count
- pdev
->num_resources
);
441 memcpy(res
, pdev
->resource
,
442 sizeof(struct resource
) * pdev
->num_resources
);
443 _od_fill_dma_resources(od
, &res
[pdev
->num_resources
]);
446 ret
= platform_device_add_resources(pdev
, res
, res_count
);
453 pdev
->archdata
.od
= od
;
455 for (i
= 0; i
< oh_cnt
; i
++) {
457 _add_hwmod_clocks_clkdev(od
, hwmods
[i
]);
467 dev_err(&pdev
->dev
, "omap_device: build failed (%d)\n", ret
);
472 void omap_device_delete(struct omap_device
*od
)
477 od
->pdev
->archdata
.od
= NULL
;
483 * omap_device_build - build and register an omap_device with one omap_hwmod
484 * @pdev_name: name of the platform_device driver to use
485 * @pdev_id: this platform_device's connection ID
486 * @oh: ptr to the single omap_hwmod that backs this omap_device
487 * @pdata: platform_data ptr to associate with the platform_device
488 * @pdata_len: amount of memory pointed to by @pdata
490 * Convenience function for building and registering a single
491 * omap_device record, which in turn builds and registers a
492 * platform_device record. See omap_device_build_ss() for more
493 * information. Returns ERR_PTR(-EINVAL) if @oh is NULL; otherwise,
494 * passes along the return value of omap_device_build_ss().
496 struct platform_device __init
*omap_device_build(const char *pdev_name
,
498 struct omap_hwmod
*oh
,
499 void *pdata
, int pdata_len
)
501 struct omap_hwmod
*ohs
[] = { oh
};
504 return ERR_PTR(-EINVAL
);
506 return omap_device_build_ss(pdev_name
, pdev_id
, ohs
, 1, pdata
,
511 * omap_device_build_ss - build and register an omap_device with multiple hwmods
512 * @pdev_name: name of the platform_device driver to use
513 * @pdev_id: this platform_device's connection ID
514 * @oh: ptr to the single omap_hwmod that backs this omap_device
515 * @pdata: platform_data ptr to associate with the platform_device
516 * @pdata_len: amount of memory pointed to by @pdata
518 * Convenience function for building and registering an omap_device
519 * subsystem record. Subsystem records consist of multiple
520 * omap_hwmods. This function in turn builds and registers a
521 * platform_device record. Returns an ERR_PTR() on error, or passes
522 * along the return value of omap_device_register().
524 struct platform_device __init
*omap_device_build_ss(const char *pdev_name
,
526 struct omap_hwmod
**ohs
,
527 int oh_cnt
, void *pdata
,
531 struct platform_device
*pdev
;
532 struct omap_device
*od
;
534 if (!ohs
|| oh_cnt
== 0 || !pdev_name
)
535 return ERR_PTR(-EINVAL
);
537 if (!pdata
&& pdata_len
> 0)
538 return ERR_PTR(-EINVAL
);
540 pdev
= platform_device_alloc(pdev_name
, pdev_id
);
546 /* Set the dev_name early to allow dev_xxx in omap_device_alloc */
548 dev_set_name(&pdev
->dev
, "%s.%d", pdev
->name
, pdev
->id
);
550 dev_set_name(&pdev
->dev
, "%s", pdev
->name
);
552 od
= omap_device_alloc(pdev
, ohs
, oh_cnt
);
556 ret
= platform_device_add_data(pdev
, pdata
, pdata_len
);
560 ret
= omap_device_register(pdev
);
567 omap_device_delete(od
);
569 platform_device_put(pdev
);
572 pr_err("omap_device: %s: build failed (%d)\n", pdev_name
, ret
);
577 #ifdef CONFIG_PM_RUNTIME
578 static int _od_runtime_suspend(struct device
*dev
)
580 struct platform_device
*pdev
= to_platform_device(dev
);
583 ret
= pm_generic_runtime_suspend(dev
);
586 omap_device_idle(pdev
);
591 static int _od_runtime_resume(struct device
*dev
)
593 struct platform_device
*pdev
= to_platform_device(dev
);
595 omap_device_enable(pdev
);
597 return pm_generic_runtime_resume(dev
);
601 #ifdef CONFIG_SUSPEND
602 static int _od_suspend_noirq(struct device
*dev
)
604 struct platform_device
*pdev
= to_platform_device(dev
);
605 struct omap_device
*od
= to_omap_device(pdev
);
608 /* Don't attempt late suspend on a driver that is not bound */
609 if (od
->_driver_status
!= BUS_NOTIFY_BOUND_DRIVER
)
612 ret
= pm_generic_suspend_noirq(dev
);
614 if (!ret
&& !pm_runtime_status_suspended(dev
)) {
615 if (pm_generic_runtime_suspend(dev
) == 0) {
616 omap_device_idle(pdev
);
617 od
->flags
|= OMAP_DEVICE_SUSPENDED
;
624 static int _od_resume_noirq(struct device
*dev
)
626 struct platform_device
*pdev
= to_platform_device(dev
);
627 struct omap_device
*od
= to_omap_device(pdev
);
629 if ((od
->flags
& OMAP_DEVICE_SUSPENDED
) &&
630 !pm_runtime_status_suspended(dev
)) {
631 od
->flags
&= ~OMAP_DEVICE_SUSPENDED
;
632 omap_device_enable(pdev
);
633 pm_generic_runtime_resume(dev
);
636 return pm_generic_resume_noirq(dev
);
639 #define _od_suspend_noirq NULL
640 #define _od_resume_noirq NULL
643 struct dev_pm_domain omap_device_pm_domain
= {
645 SET_RUNTIME_PM_OPS(_od_runtime_suspend
, _od_runtime_resume
,
647 USE_PLATFORM_PM_SLEEP_OPS
648 .suspend_noirq
= _od_suspend_noirq
,
649 .resume_noirq
= _od_resume_noirq
,
654 * omap_device_register - register an omap_device with one omap_hwmod
655 * @od: struct omap_device * to register
657 * Register the omap_device structure. This currently just calls
658 * platform_device_register() on the underlying platform_device.
659 * Returns the return value of platform_device_register().
661 int omap_device_register(struct platform_device
*pdev
)
663 pr_debug("omap_device: %s: registering\n", pdev
->name
);
665 pdev
->dev
.pm_domain
= &omap_device_pm_domain
;
666 return platform_device_add(pdev
);
670 /* Public functions for use by device drivers through struct platform_data */
673 * omap_device_enable - fully activate an omap_device
674 * @od: struct omap_device * to activate
676 * Do whatever is necessary for the hwmods underlying omap_device @od
677 * to be accessible and ready to operate. This generally involves
678 * enabling clocks, setting SYSCONFIG registers; and in the future may
679 * involve remuxing pins. Device drivers should call this function
680 * indirectly via pm_runtime_get*(). Returns -EINVAL if called when
681 * the omap_device is already enabled, or passes along the return
682 * value of _omap_device_enable_hwmods().
684 int omap_device_enable(struct platform_device
*pdev
)
687 struct omap_device
*od
;
689 od
= to_omap_device(pdev
);
691 if (od
->_state
== OMAP_DEVICE_STATE_ENABLED
) {
693 "omap_device: %s() called from invalid state %d\n",
694 __func__
, od
->_state
);
698 ret
= _omap_device_enable_hwmods(od
);
700 od
->_state
= OMAP_DEVICE_STATE_ENABLED
;
706 * omap_device_idle - idle an omap_device
707 * @od: struct omap_device * to idle
709 * Idle omap_device @od. Device drivers call this function indirectly
710 * via pm_runtime_put*(). Returns -EINVAL if the omap_device is not
711 * currently enabled, or passes along the return value of
712 * _omap_device_idle_hwmods().
714 int omap_device_idle(struct platform_device
*pdev
)
717 struct omap_device
*od
;
719 od
= to_omap_device(pdev
);
721 if (od
->_state
!= OMAP_DEVICE_STATE_ENABLED
) {
723 "omap_device: %s() called from invalid state %d\n",
724 __func__
, od
->_state
);
728 ret
= _omap_device_idle_hwmods(od
);
730 od
->_state
= OMAP_DEVICE_STATE_IDLE
;
736 * omap_device_assert_hardreset - set a device's hardreset line
737 * @pdev: struct platform_device * to reset
738 * @name: const char * name of the reset line
740 * Set the hardreset line identified by @name on the IP blocks
741 * associated with the hwmods backing the platform_device @pdev. All
742 * of the hwmods associated with @pdev must have the same hardreset
743 * line linked to them for this to work. Passes along the return value
744 * of omap_hwmod_assert_hardreset() in the event of any failure, or
745 * returns 0 upon success.
747 int omap_device_assert_hardreset(struct platform_device
*pdev
, const char *name
)
749 struct omap_device
*od
= to_omap_device(pdev
);
753 for (i
= 0; i
< od
->hwmods_cnt
; i
++) {
754 ret
= omap_hwmod_assert_hardreset(od
->hwmods
[i
], name
);
763 * omap_device_deassert_hardreset - release a device's hardreset line
764 * @pdev: struct platform_device * to reset
765 * @name: const char * name of the reset line
767 * Release the hardreset line identified by @name on the IP blocks
768 * associated with the hwmods backing the platform_device @pdev. All
769 * of the hwmods associated with @pdev must have the same hardreset
770 * line linked to them for this to work. Passes along the return
771 * value of omap_hwmod_deassert_hardreset() in the event of any
772 * failure, or returns 0 upon success.
774 int omap_device_deassert_hardreset(struct platform_device
*pdev
,
777 struct omap_device
*od
= to_omap_device(pdev
);
781 for (i
= 0; i
< od
->hwmods_cnt
; i
++) {
782 ret
= omap_hwmod_deassert_hardreset(od
->hwmods
[i
], name
);
791 * omap_device_get_by_hwmod_name() - convert a hwmod name to
793 * @oh_name: name of the hwmod device
795 * Returns back a struct device * pointer associated with a hwmod
796 * device represented by a hwmod_name
798 struct device
*omap_device_get_by_hwmod_name(const char *oh_name
)
800 struct omap_hwmod
*oh
;
803 WARN(1, "%s: no hwmod name!\n", __func__
);
804 return ERR_PTR(-EINVAL
);
807 oh
= omap_hwmod_lookup(oh_name
);
809 WARN(1, "%s: no hwmod for %s\n", __func__
,
811 return ERR_PTR(-ENODEV
);
814 WARN(1, "%s: no omap_device for %s\n", __func__
,
816 return ERR_PTR(-ENODEV
);
819 return &oh
->od
->pdev
->dev
;
822 static struct notifier_block platform_nb
= {
823 .notifier_call
= _omap_device_notifier_call
,
826 static int __init
omap_device_init(void)
828 bus_register_notifier(&platform_bus_type
, &platform_nb
);
831 omap_core_initcall(omap_device_init
);
834 * omap_device_late_idle - idle devices without drivers
835 * @dev: struct device * associated with omap_device
838 * Check the driver bound status of this device, and idle it
839 * if there is no driver attached.
841 static int __init
omap_device_late_idle(struct device
*dev
, void *data
)
843 struct platform_device
*pdev
= to_platform_device(dev
);
844 struct omap_device
*od
= to_omap_device(pdev
);
850 * If omap_device state is enabled, but has no driver bound,
853 if (od
->_driver_status
!= BUS_NOTIFY_BOUND_DRIVER
) {
854 if (od
->_state
== OMAP_DEVICE_STATE_ENABLED
) {
855 dev_warn(dev
, "%s: enabled but no driver. Idling\n",
857 omap_device_idle(pdev
);
864 static int __init
omap_device_late_init(void)
866 bus_for_each_dev(&platform_bus_type
, NULL
, NULL
, omap_device_late_idle
);
869 omap_late_initcall_sync(omap_device_late_init
);