Commit | Line | Data |
---|---|---|
b04b65ab PW |
1 | /* |
2 | * omap_device headers | |
3 | * | |
4 | * Copyright (C) 2009 Nokia Corporation | |
5 | * Paul Walmsley | |
6 | * | |
7 | * Developed in collaboration with (alphabetical order): Benoit | |
8 | * Cousson, Kevin Hilman, Tony Lindgren, Rajendra Nayak, Vikram | |
9 | * Pandita, Sakari Poussa, Anand Sawant, Santosh Shilimkar, Richard | |
10 | * Woodruff | |
11 | * | |
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. | |
15 | * | |
16 | * Eventually this type of functionality should either be | |
17 | * a) implemented via arch-specific pointers in platform_device | |
18 | * or | |
19 | * b) implemented as a proper omap_bus/omap_device in Linux, no more | |
20 | * platform_device | |
21 | * | |
22 | * omap_device differs from omap_hwmod in that it includes external | |
23 | * (e.g., board- and system-level) integration details. omap_hwmod | |
24 | * stores hardware data that is invariant for a given OMAP chip. | |
25 | * | |
26 | * To do: | |
27 | * - GPIO integration | |
28 | * - regulator integration | |
29 | * | |
30 | */ | |
31 | #ifndef __ARCH_ARM_PLAT_OMAP_INCLUDE_MACH_OMAP_DEVICE_H | |
32 | #define __ARCH_ARM_PLAT_OMAP_INCLUDE_MACH_OMAP_DEVICE_H | |
33 | ||
34 | #include <linux/kernel.h> | |
35 | #include <linux/platform_device.h> | |
36 | ||
ce491cf8 | 37 | #include <plat/omap_hwmod.h> |
b04b65ab | 38 | |
0d5e8252 KH |
39 | extern struct device omap_device_parent; |
40 | ||
b04b65ab PW |
41 | /* omap_device._state values */ |
42 | #define OMAP_DEVICE_STATE_UNKNOWN 0 | |
43 | #define OMAP_DEVICE_STATE_ENABLED 1 | |
44 | #define OMAP_DEVICE_STATE_IDLE 2 | |
45 | #define OMAP_DEVICE_STATE_SHUTDOWN 3 | |
46 | ||
c03f007a KH |
47 | /* omap_device.flags values */ |
48 | #define OMAP_DEVICE_SUSPENDED BIT(0) | |
80c6d1e6 | 49 | #define OMAP_DEVICE_NO_IDLE_ON_SUSPEND BIT(1) |
c03f007a | 50 | |
b04b65ab PW |
51 | /** |
52 | * struct omap_device - omap_device wrapper for platform_devices | |
53 | * @pdev: platform_device | |
54 | * @hwmods: (one .. many per omap_device) | |
55 | * @hwmods_cnt: ARRAY_SIZE() of @hwmods | |
56 | * @pm_lats: ptr to an omap_device_pm_latency table | |
57 | * @pm_lats_cnt: ARRAY_SIZE() of what is passed to @pm_lats | |
58 | * @pm_lat_level: array index of the last odpl entry executed - -1 if never | |
0d93d8bb KH |
59 | * @dev_wakeup_lat: dev wakeup latency in nanoseconds |
60 | * @_dev_wakeup_lat_limit: dev wakeup latency limit in nsec - set by OMAP PM | |
b04b65ab PW |
61 | * @_state: one of OMAP_DEVICE_STATE_* (see above) |
62 | * @flags: device flags | |
63 | * | |
64 | * Integrates omap_hwmod data into Linux platform_device. | |
65 | * | |
66 | * Field names beginning with underscores are for the internal use of | |
67 | * the omap_device code. | |
68 | * | |
69 | */ | |
70 | struct omap_device { | |
71 | struct platform_device pdev; | |
72 | struct omap_hwmod **hwmods; | |
73 | struct omap_device_pm_latency *pm_lats; | |
74 | u32 dev_wakeup_lat; | |
75 | u32 _dev_wakeup_lat_limit; | |
76 | u8 pm_lats_cnt; | |
77 | s8 pm_lat_level; | |
78 | u8 hwmods_cnt; | |
79 | u8 _state; | |
c03f007a | 80 | u8 flags; |
b04b65ab PW |
81 | }; |
82 | ||
83 | /* Device driver interface (call via platform_data fn ptrs) */ | |
84 | ||
85 | int omap_device_enable(struct platform_device *pdev); | |
86 | int omap_device_idle(struct platform_device *pdev); | |
87 | int omap_device_shutdown(struct platform_device *pdev); | |
88 | ||
89 | /* Core code interface */ | |
90 | ||
91 | int omap_device_count_resources(struct omap_device *od); | |
92 | int omap_device_fill_resources(struct omap_device *od, struct resource *res); | |
93 | ||
94 | struct omap_device *omap_device_build(const char *pdev_name, int pdev_id, | |
95 | struct omap_hwmod *oh, void *pdata, | |
96 | int pdata_len, | |
97 | struct omap_device_pm_latency *pm_lats, | |
c23a97d3 | 98 | int pm_lats_cnt, int is_early_device); |
b04b65ab PW |
99 | |
100 | struct omap_device *omap_device_build_ss(const char *pdev_name, int pdev_id, | |
101 | struct omap_hwmod **oh, int oh_cnt, | |
102 | void *pdata, int pdata_len, | |
103 | struct omap_device_pm_latency *pm_lats, | |
c23a97d3 | 104 | int pm_lats_cnt, int is_early_device); |
b04b65ab PW |
105 | |
106 | int omap_device_register(struct omap_device *od); | |
c23a97d3 | 107 | int omap_early_device_register(struct omap_device *od); |
b04b65ab | 108 | |
db2a60bf PW |
109 | void __iomem *omap_device_get_rt_va(struct omap_device *od); |
110 | ||
b04b65ab PW |
111 | /* OMAP PM interface */ |
112 | int omap_device_align_pm_lat(struct platform_device *pdev, | |
113 | u32 new_wakeup_lat_limit); | |
114 | struct powerdomain *omap_device_get_pwrdm(struct omap_device *od); | |
c80705aa | 115 | u32 omap_device_get_context_loss_count(struct platform_device *pdev); |
b04b65ab PW |
116 | |
117 | /* Other */ | |
118 | ||
119 | int omap_device_idle_hwmods(struct omap_device *od); | |
120 | int omap_device_enable_hwmods(struct omap_device *od); | |
121 | ||
122 | int omap_device_disable_clocks(struct omap_device *od); | |
123 | int omap_device_enable_clocks(struct omap_device *od); | |
124 | ||
80c6d1e6 KH |
125 | static inline void omap_device_disable_idle_on_suspend(struct omap_device *od) |
126 | { | |
127 | od->flags |= OMAP_DEVICE_NO_IDLE_ON_SUSPEND; | |
128 | } | |
b04b65ab PW |
129 | |
130 | /* | |
131 | * Entries should be kept in latency order ascending | |
132 | * | |
133 | * deact_lat is the maximum number of microseconds required to complete | |
134 | * deactivate_func() at the device's slowest OPP. | |
135 | * | |
136 | * act_lat is the maximum number of microseconds required to complete | |
137 | * activate_func() at the device's slowest OPP. | |
138 | * | |
139 | * This will result in some suboptimal power management decisions at fast | |
140 | * OPPs, but avoids having to recompute all device power management decisions | |
141 | * if the system shifts from a fast OPP to a slow OPP (in order to meet | |
142 | * latency requirements). | |
143 | * | |
144 | * XXX should deactivate_func/activate_func() take platform_device pointers | |
145 | * rather than omap_device pointers? | |
146 | */ | |
147 | struct omap_device_pm_latency { | |
148 | u32 deactivate_lat; | |
9799aca2 | 149 | u32 deactivate_lat_worst; |
b04b65ab PW |
150 | int (*deactivate_func)(struct omap_device *od); |
151 | u32 activate_lat; | |
9799aca2 | 152 | u32 activate_lat_worst; |
b04b65ab | 153 | int (*activate_func)(struct omap_device *od); |
9799aca2 | 154 | u32 flags; |
b04b65ab PW |
155 | }; |
156 | ||
9799aca2 | 157 | #define OMAP_DEVICE_LATENCY_AUTO_ADJUST BIT(1) |
b04b65ab | 158 | |
a470c42c KH |
159 | /* Get omap_device pointer from platform_device pointer */ |
160 | #define to_omap_device(x) container_of((x), struct omap_device, pdev) | |
b04b65ab | 161 | |
a470c42c | 162 | #endif |