Commit | Line | Data |
---|---|---|
b04b65ab PW |
1 | /* |
2 | * omap_device implementation | |
3 | * | |
887adeac | 4 | * Copyright (C) 2009-2010 Nokia Corporation |
4788da26 | 5 | * Paul Walmsley, Kevin Hilman |
b04b65ab PW |
6 | * |
7 | * Developed in collaboration with (alphabetical order): Benoit | |
4788da26 | 8 | * Cousson, Thara Gopinath, Tony Lindgren, Rajendra Nayak, Vikram |
b04b65ab PW |
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 | * This code provides a consistent interface for OMAP device drivers | |
17 | * to control power management and interconnect properties of their | |
18 | * devices. | |
19 | * | |
20 | * In the medium- to long-term, this code should either be | |
21 | * a) implemented via arch-specific pointers in platform_data | |
22 | * or | |
23 | * b) implemented as a proper omap_bus/omap_device in Linux, no more | |
24 | * platform_data func pointers | |
25 | * | |
26 | * | |
27 | * Guidelines for usage by driver authors: | |
28 | * | |
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 | |
32 | * | |
33 | * struct foo_driver_platform_data { | |
34 | * ... | |
35 | * int (*device_enable)(struct platform_device *pdev); | |
36 | * ... | |
37 | * } | |
38 | * | |
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. | |
42 | * | |
43 | * This should be populated during device setup: | |
44 | * | |
45 | * ... | |
46 | * pdata->device_enable = omap_device_enable; | |
47 | * ... | |
48 | * | |
49 | * 2. Drivers should first check to ensure the function pointer is not null | |
50 | * before calling it, as in: | |
51 | * | |
52 | * if (pdata->device_enable) | |
53 | * pdata->device_enable(pdev); | |
54 | * | |
55 | * This allows other architectures that don't use similar device_enable()/ | |
56 | * device_shutdown() functions to execute normally. | |
57 | * | |
58 | * ... | |
59 | * | |
60 | * Suggested usage by device drivers: | |
61 | * | |
62 | * During device initialization: | |
63 | * device_enable() | |
64 | * | |
65 | * During device idle: | |
66 | * (save remaining device context if necessary) | |
67 | * device_idle(); | |
68 | * | |
69 | * During device resume: | |
70 | * device_enable(); | |
71 | * (restore context if necessary) | |
72 | * | |
73 | * During device shutdown: | |
74 | * device_shutdown() | |
75 | * (device must be reinitialized at this point to use it again) | |
76 | * | |
77 | */ | |
78 | #undef DEBUG | |
79 | ||
80 | #include <linux/kernel.h> | |
81 | #include <linux/platform_device.h> | |
5a0e3ad6 | 82 | #include <linux/slab.h> |
b04b65ab PW |
83 | #include <linux/err.h> |
84 | #include <linux/io.h> | |
4ef7aca8 | 85 | #include <linux/clk.h> |
da0653fe | 86 | #include <linux/clkdev.h> |
345f79b3 | 87 | #include <linux/pm_runtime.h> |
b04b65ab | 88 | |
ce491cf8 TL |
89 | #include <plat/omap_device.h> |
90 | #include <plat/omap_hwmod.h> | |
da0653fe | 91 | #include <plat/clock.h> |
b04b65ab PW |
92 | |
93 | /* These parameters are passed to _omap_device_{de,}activate() */ | |
94 | #define USE_WAKEUP_LAT 0 | |
95 | #define IGNORE_WAKEUP_LAT 1 | |
96 | ||
b04b65ab PW |
97 | /* Private functions */ |
98 | ||
b04b65ab PW |
99 | /** |
100 | * _omap_device_activate - increase device readiness | |
101 | * @od: struct omap_device * | |
102 | * @ignore_lat: increase to latency target (0) or full readiness (1)? | |
103 | * | |
104 | * Increase readiness of omap_device @od (thus decreasing device | |
105 | * wakeup latency, but consuming more power). If @ignore_lat is | |
106 | * IGNORE_WAKEUP_LAT, make the omap_device fully active. Otherwise, | |
107 | * if @ignore_lat is USE_WAKEUP_LAT, and the device's maximum wakeup | |
108 | * latency is greater than the requested maximum wakeup latency, step | |
109 | * backwards in the omap_device_pm_latency table to ensure the | |
110 | * device's maximum wakeup latency is less than or equal to the | |
111 | * requested maximum wakeup latency. Returns 0. | |
112 | */ | |
113 | static int _omap_device_activate(struct omap_device *od, u8 ignore_lat) | |
114 | { | |
f059429e | 115 | struct timespec a, b, c; |
b04b65ab PW |
116 | |
117 | pr_debug("omap_device: %s: activating\n", od->pdev.name); | |
118 | ||
119 | while (od->pm_lat_level > 0) { | |
120 | struct omap_device_pm_latency *odpl; | |
f059429e | 121 | unsigned long long act_lat = 0; |
b04b65ab PW |
122 | |
123 | od->pm_lat_level--; | |
124 | ||
125 | odpl = od->pm_lats + od->pm_lat_level; | |
126 | ||
127 | if (!ignore_lat && | |
128 | (od->dev_wakeup_lat <= od->_dev_wakeup_lat_limit)) | |
129 | break; | |
130 | ||
d2292667 | 131 | read_persistent_clock(&a); |
b04b65ab PW |
132 | |
133 | /* XXX check return code */ | |
134 | odpl->activate_func(od); | |
135 | ||
d2292667 | 136 | read_persistent_clock(&b); |
b04b65ab | 137 | |
f059429e | 138 | c = timespec_sub(b, a); |
0d93d8bb | 139 | act_lat = timespec_to_ns(&c); |
b04b65ab PW |
140 | |
141 | pr_debug("omap_device: %s: pm_lat %d: activate: elapsed time " | |
0d93d8bb | 142 | "%llu nsec\n", od->pdev.name, od->pm_lat_level, |
f059429e | 143 | act_lat); |
b04b65ab | 144 | |
9799aca2 KH |
145 | if (act_lat > odpl->activate_lat) { |
146 | odpl->activate_lat_worst = act_lat; | |
147 | if (odpl->flags & OMAP_DEVICE_LATENCY_AUTO_ADJUST) { | |
148 | odpl->activate_lat = act_lat; | |
149 | pr_warning("omap_device: %s.%d: new worst case " | |
150 | "activate latency %d: %llu\n", | |
151 | od->pdev.name, od->pdev.id, | |
152 | od->pm_lat_level, act_lat); | |
153 | } else | |
154 | pr_warning("omap_device: %s.%d: activate " | |
155 | "latency %d higher than exptected. " | |
156 | "(%llu > %d)\n", | |
157 | od->pdev.name, od->pdev.id, | |
158 | od->pm_lat_level, act_lat, | |
159 | odpl->activate_lat); | |
160 | } | |
b04b65ab PW |
161 | |
162 | od->dev_wakeup_lat -= odpl->activate_lat; | |
163 | } | |
164 | ||
165 | return 0; | |
166 | } | |
167 | ||
168 | /** | |
169 | * _omap_device_deactivate - decrease device readiness | |
170 | * @od: struct omap_device * | |
171 | * @ignore_lat: decrease to latency target (0) or full inactivity (1)? | |
172 | * | |
173 | * Decrease readiness of omap_device @od (thus increasing device | |
174 | * wakeup latency, but conserving power). If @ignore_lat is | |
175 | * IGNORE_WAKEUP_LAT, make the omap_device fully inactive. Otherwise, | |
176 | * if @ignore_lat is USE_WAKEUP_LAT, and the device's maximum wakeup | |
177 | * latency is less than the requested maximum wakeup latency, step | |
178 | * forwards in the omap_device_pm_latency table to ensure the device's | |
179 | * maximum wakeup latency is less than or equal to the requested | |
180 | * maximum wakeup latency. Returns 0. | |
181 | */ | |
182 | static int _omap_device_deactivate(struct omap_device *od, u8 ignore_lat) | |
183 | { | |
f059429e | 184 | struct timespec a, b, c; |
b04b65ab PW |
185 | |
186 | pr_debug("omap_device: %s: deactivating\n", od->pdev.name); | |
187 | ||
188 | while (od->pm_lat_level < od->pm_lats_cnt) { | |
189 | struct omap_device_pm_latency *odpl; | |
f059429e | 190 | unsigned long long deact_lat = 0; |
b04b65ab PW |
191 | |
192 | odpl = od->pm_lats + od->pm_lat_level; | |
193 | ||
194 | if (!ignore_lat && | |
195 | ((od->dev_wakeup_lat + odpl->activate_lat) > | |
196 | od->_dev_wakeup_lat_limit)) | |
197 | break; | |
198 | ||
d2292667 | 199 | read_persistent_clock(&a); |
b04b65ab PW |
200 | |
201 | /* XXX check return code */ | |
202 | odpl->deactivate_func(od); | |
203 | ||
d2292667 | 204 | read_persistent_clock(&b); |
b04b65ab | 205 | |
f059429e | 206 | c = timespec_sub(b, a); |
0d93d8bb | 207 | deact_lat = timespec_to_ns(&c); |
b04b65ab PW |
208 | |
209 | pr_debug("omap_device: %s: pm_lat %d: deactivate: elapsed time " | |
0d93d8bb | 210 | "%llu nsec\n", od->pdev.name, od->pm_lat_level, |
b04b65ab PW |
211 | deact_lat); |
212 | ||
9799aca2 KH |
213 | if (deact_lat > odpl->deactivate_lat) { |
214 | odpl->deactivate_lat_worst = deact_lat; | |
215 | if (odpl->flags & OMAP_DEVICE_LATENCY_AUTO_ADJUST) { | |
216 | odpl->deactivate_lat = deact_lat; | |
217 | pr_warning("omap_device: %s.%d: new worst case " | |
218 | "deactivate latency %d: %llu\n", | |
219 | od->pdev.name, od->pdev.id, | |
220 | od->pm_lat_level, deact_lat); | |
221 | } else | |
222 | pr_warning("omap_device: %s.%d: deactivate " | |
223 | "latency %d higher than exptected. " | |
224 | "(%llu > %d)\n", | |
225 | od->pdev.name, od->pdev.id, | |
226 | od->pm_lat_level, deact_lat, | |
227 | odpl->deactivate_lat); | |
228 | } | |
229 | ||
b04b65ab PW |
230 | |
231 | od->dev_wakeup_lat += odpl->activate_lat; | |
232 | ||
233 | od->pm_lat_level++; | |
234 | } | |
235 | ||
236 | return 0; | |
237 | } | |
238 | ||
bf1e0776 BC |
239 | static void _add_clkdev(struct omap_device *od, const char *clk_alias, |
240 | const char *clk_name) | |
241 | { | |
242 | struct clk *r; | |
243 | struct clk_lookup *l; | |
244 | ||
245 | if (!clk_alias || !clk_name) | |
246 | return; | |
247 | ||
248 | pr_debug("omap_device: %s: Creating %s -> %s\n", | |
249 | dev_name(&od->pdev.dev), clk_alias, clk_name); | |
250 | ||
251 | r = clk_get_sys(dev_name(&od->pdev.dev), clk_alias); | |
252 | if (!IS_ERR(r)) { | |
253 | pr_warning("omap_device: %s: alias %s already exists\n", | |
254 | dev_name(&od->pdev.dev), clk_alias); | |
255 | clk_put(r); | |
256 | return; | |
257 | } | |
258 | ||
259 | r = omap_clk_get_by_name(clk_name); | |
260 | if (IS_ERR(r)) { | |
261 | pr_err("omap_device: %s: omap_clk_get_by_name for %s failed\n", | |
262 | dev_name(&od->pdev.dev), clk_name); | |
263 | return; | |
264 | } | |
265 | ||
266 | l = clkdev_alloc(r, clk_alias, dev_name(&od->pdev.dev)); | |
267 | if (!l) { | |
268 | pr_err("omap_device: %s: clkdev_alloc for %s failed\n", | |
269 | dev_name(&od->pdev.dev), clk_alias); | |
270 | return; | |
271 | } | |
272 | ||
273 | clkdev_add(l); | |
274 | } | |
275 | ||
4ef7aca8 | 276 | /** |
bf1e0776 BC |
277 | * _add_hwmod_clocks_clkdev - Add clkdev entry for hwmod optional clocks |
278 | * and main clock | |
4ef7aca8 | 279 | * @od: struct omap_device *od |
bf1e0776 | 280 | * @oh: struct omap_hwmod *oh |
4ef7aca8 | 281 | * |
bf1e0776 BC |
282 | * For the main clock and every optional clock present per hwmod per |
283 | * omap_device, this function adds an entry in the clkdev table of the | |
284 | * form <dev-id=dev_name, con-id=role> if it does not exist already. | |
4ef7aca8 PB |
285 | * |
286 | * The function is called from inside omap_device_build_ss(), after | |
287 | * omap_device_register. | |
288 | * | |
289 | * This allows drivers to get a pointer to its optional clocks based on its role | |
290 | * by calling clk_get(<dev*>, <role>). | |
bf1e0776 | 291 | * In the case of the main clock, a "fck" alias is used. |
4ef7aca8 PB |
292 | * |
293 | * No return value. | |
294 | */ | |
bf1e0776 BC |
295 | static void _add_hwmod_clocks_clkdev(struct omap_device *od, |
296 | struct omap_hwmod *oh) | |
4ef7aca8 PB |
297 | { |
298 | int i; | |
299 | ||
bf1e0776 | 300 | _add_clkdev(od, "fck", oh->main_clk); |
da0653fe | 301 | |
bf1e0776 BC |
302 | for (i = 0; i < oh->opt_clks_cnt; i++) |
303 | _add_clkdev(od, oh->opt_clks[i].role, oh->opt_clks[i].clk); | |
4ef7aca8 PB |
304 | } |
305 | ||
b04b65ab PW |
306 | |
307 | /* Public functions for use by core code */ | |
308 | ||
c80705aa KH |
309 | /** |
310 | * omap_device_get_context_loss_count - get lost context count | |
311 | * @od: struct omap_device * | |
312 | * | |
313 | * Using the primary hwmod, query the context loss count for this | |
314 | * device. | |
315 | * | |
316 | * Callers should consider context for this device lost any time this | |
317 | * function returns a value different than the value the caller got | |
318 | * the last time it called this function. | |
319 | * | |
320 | * If any hwmods exist for the omap_device assoiated with @pdev, | |
321 | * return the context loss counter for that hwmod, otherwise return | |
322 | * zero. | |
323 | */ | |
324 | u32 omap_device_get_context_loss_count(struct platform_device *pdev) | |
325 | { | |
326 | struct omap_device *od; | |
327 | u32 ret = 0; | |
328 | ||
8f0d69de | 329 | od = to_omap_device(pdev); |
c80705aa KH |
330 | |
331 | if (od->hwmods_cnt) | |
332 | ret = omap_hwmod_get_context_loss_count(od->hwmods[0]); | |
333 | ||
334 | return ret; | |
335 | } | |
336 | ||
b04b65ab PW |
337 | /** |
338 | * omap_device_count_resources - count number of struct resource entries needed | |
339 | * @od: struct omap_device * | |
340 | * | |
341 | * Count the number of struct resource entries needed for this | |
342 | * omap_device @od. Used by omap_device_build_ss() to determine how | |
343 | * much memory to allocate before calling | |
344 | * omap_device_fill_resources(). Returns the count. | |
345 | */ | |
346 | int omap_device_count_resources(struct omap_device *od) | |
347 | { | |
b04b65ab PW |
348 | int c = 0; |
349 | int i; | |
350 | ||
f39f4898 KVA |
351 | for (i = 0; i < od->hwmods_cnt; i++) |
352 | c += omap_hwmod_count_resources(od->hwmods[i]); | |
b04b65ab PW |
353 | |
354 | pr_debug("omap_device: %s: counted %d total resources across %d " | |
355 | "hwmods\n", od->pdev.name, c, od->hwmods_cnt); | |
356 | ||
357 | return c; | |
358 | } | |
359 | ||
360 | /** | |
361 | * omap_device_fill_resources - fill in array of struct resource | |
362 | * @od: struct omap_device * | |
363 | * @res: pointer to an array of struct resource to be filled in | |
364 | * | |
365 | * Populate one or more empty struct resource pointed to by @res with | |
366 | * the resource data for this omap_device @od. Used by | |
367 | * omap_device_build_ss() after calling omap_device_count_resources(). | |
368 | * Ideally this function would not be needed at all. If omap_device | |
369 | * replaces platform_device, then we can specify our own | |
370 | * get_resource()/ get_irq()/etc functions that use the underlying | |
371 | * omap_hwmod information. Or if platform_device is extended to use | |
372 | * subarchitecture-specific function pointers, the various | |
373 | * platform_device functions can simply call omap_device internal | |
374 | * functions to get device resources. Hacking around the existing | |
375 | * platform_device code wastes memory. Returns 0. | |
376 | */ | |
377 | int omap_device_fill_resources(struct omap_device *od, struct resource *res) | |
378 | { | |
b04b65ab PW |
379 | int c = 0; |
380 | int i, r; | |
381 | ||
f39f4898 KVA |
382 | for (i = 0; i < od->hwmods_cnt; i++) { |
383 | r = omap_hwmod_fill_resources(od->hwmods[i], res); | |
b04b65ab PW |
384 | res += r; |
385 | c += r; | |
386 | } | |
387 | ||
388 | return 0; | |
389 | } | |
390 | ||
391 | /** | |
392 | * omap_device_build - build and register an omap_device with one omap_hwmod | |
393 | * @pdev_name: name of the platform_device driver to use | |
394 | * @pdev_id: this platform_device's connection ID | |
395 | * @oh: ptr to the single omap_hwmod that backs this omap_device | |
396 | * @pdata: platform_data ptr to associate with the platform_device | |
397 | * @pdata_len: amount of memory pointed to by @pdata | |
398 | * @pm_lats: pointer to a omap_device_pm_latency array for this device | |
399 | * @pm_lats_cnt: ARRAY_SIZE() of @pm_lats | |
c23a97d3 | 400 | * @is_early_device: should the device be registered as an early device or not |
b04b65ab PW |
401 | * |
402 | * Convenience function for building and registering a single | |
403 | * omap_device record, which in turn builds and registers a | |
404 | * platform_device record. See omap_device_build_ss() for more | |
405 | * information. Returns ERR_PTR(-EINVAL) if @oh is NULL; otherwise, | |
406 | * passes along the return value of omap_device_build_ss(). | |
407 | */ | |
408 | struct omap_device *omap_device_build(const char *pdev_name, int pdev_id, | |
409 | struct omap_hwmod *oh, void *pdata, | |
410 | int pdata_len, | |
411 | struct omap_device_pm_latency *pm_lats, | |
c23a97d3 | 412 | int pm_lats_cnt, int is_early_device) |
b04b65ab PW |
413 | { |
414 | struct omap_hwmod *ohs[] = { oh }; | |
415 | ||
416 | if (!oh) | |
417 | return ERR_PTR(-EINVAL); | |
418 | ||
419 | return omap_device_build_ss(pdev_name, pdev_id, ohs, 1, pdata, | |
c23a97d3 TG |
420 | pdata_len, pm_lats, pm_lats_cnt, |
421 | is_early_device); | |
b04b65ab PW |
422 | } |
423 | ||
424 | /** | |
425 | * omap_device_build_ss - build and register an omap_device with multiple hwmods | |
426 | * @pdev_name: name of the platform_device driver to use | |
427 | * @pdev_id: this platform_device's connection ID | |
428 | * @oh: ptr to the single omap_hwmod that backs this omap_device | |
429 | * @pdata: platform_data ptr to associate with the platform_device | |
430 | * @pdata_len: amount of memory pointed to by @pdata | |
431 | * @pm_lats: pointer to a omap_device_pm_latency array for this device | |
432 | * @pm_lats_cnt: ARRAY_SIZE() of @pm_lats | |
c23a97d3 | 433 | * @is_early_device: should the device be registered as an early device or not |
b04b65ab PW |
434 | * |
435 | * Convenience function for building and registering an omap_device | |
436 | * subsystem record. Subsystem records consist of multiple | |
437 | * omap_hwmods. This function in turn builds and registers a | |
438 | * platform_device record. Returns an ERR_PTR() on error, or passes | |
439 | * along the return value of omap_device_register(). | |
440 | */ | |
441 | struct omap_device *omap_device_build_ss(const char *pdev_name, int pdev_id, | |
442 | struct omap_hwmod **ohs, int oh_cnt, | |
443 | void *pdata, int pdata_len, | |
444 | struct omap_device_pm_latency *pm_lats, | |
c23a97d3 | 445 | int pm_lats_cnt, int is_early_device) |
b04b65ab PW |
446 | { |
447 | int ret = -ENOMEM; | |
448 | struct omap_device *od; | |
449 | char *pdev_name2; | |
450 | struct resource *res = NULL; | |
06563581 | 451 | int i, res_count; |
b04b65ab PW |
452 | struct omap_hwmod **hwmods; |
453 | ||
454 | if (!ohs || oh_cnt == 0 || !pdev_name) | |
455 | return ERR_PTR(-EINVAL); | |
456 | ||
457 | if (!pdata && pdata_len > 0) | |
458 | return ERR_PTR(-EINVAL); | |
459 | ||
460 | pr_debug("omap_device: %s: building with %d hwmods\n", pdev_name, | |
461 | oh_cnt); | |
462 | ||
463 | od = kzalloc(sizeof(struct omap_device), GFP_KERNEL); | |
464 | if (!od) | |
465 | return ERR_PTR(-ENOMEM); | |
466 | ||
467 | od->hwmods_cnt = oh_cnt; | |
468 | ||
469 | hwmods = kzalloc(sizeof(struct omap_hwmod *) * oh_cnt, | |
470 | GFP_KERNEL); | |
471 | if (!hwmods) | |
472 | goto odbs_exit1; | |
473 | ||
474 | memcpy(hwmods, ohs, sizeof(struct omap_hwmod *) * oh_cnt); | |
475 | od->hwmods = hwmods; | |
476 | ||
477 | pdev_name2 = kzalloc(strlen(pdev_name) + 1, GFP_KERNEL); | |
478 | if (!pdev_name2) | |
479 | goto odbs_exit2; | |
480 | strcpy(pdev_name2, pdev_name); | |
481 | ||
482 | od->pdev.name = pdev_name2; | |
483 | od->pdev.id = pdev_id; | |
484 | ||
485 | res_count = omap_device_count_resources(od); | |
486 | if (res_count > 0) { | |
487 | res = kzalloc(sizeof(struct resource) * res_count, GFP_KERNEL); | |
488 | if (!res) | |
489 | goto odbs_exit3; | |
490 | } | |
491 | omap_device_fill_resources(od, res); | |
492 | ||
493 | od->pdev.num_resources = res_count; | |
494 | od->pdev.resource = res; | |
495 | ||
49b368a6 AB |
496 | ret = platform_device_add_data(&od->pdev, pdata, pdata_len); |
497 | if (ret) | |
498 | goto odbs_exit4; | |
b04b65ab PW |
499 | |
500 | od->pm_lats = pm_lats; | |
501 | od->pm_lats_cnt = pm_lats_cnt; | |
502 | ||
c23a97d3 TG |
503 | if (is_early_device) |
504 | ret = omap_early_device_register(od); | |
505 | else | |
506 | ret = omap_device_register(od); | |
507 | ||
4ef7aca8 | 508 | for (i = 0; i < oh_cnt; i++) { |
06563581 | 509 | hwmods[i]->od = od; |
bf1e0776 | 510 | _add_hwmod_clocks_clkdev(od, hwmods[i]); |
4ef7aca8 | 511 | } |
06563581 | 512 | |
b04b65ab PW |
513 | if (ret) |
514 | goto odbs_exit4; | |
515 | ||
516 | return od; | |
517 | ||
518 | odbs_exit4: | |
519 | kfree(res); | |
520 | odbs_exit3: | |
521 | kfree(pdev_name2); | |
522 | odbs_exit2: | |
523 | kfree(hwmods); | |
524 | odbs_exit1: | |
525 | kfree(od); | |
526 | ||
527 | pr_err("omap_device: %s: build failed (%d)\n", pdev_name, ret); | |
528 | ||
529 | return ERR_PTR(ret); | |
530 | } | |
531 | ||
c23a97d3 TG |
532 | /** |
533 | * omap_early_device_register - register an omap_device as an early platform | |
534 | * device. | |
535 | * @od: struct omap_device * to register | |
536 | * | |
537 | * Register the omap_device structure. This currently just calls | |
538 | * platform_early_add_device() on the underlying platform_device. | |
539 | * Returns 0 by default. | |
540 | */ | |
541 | int omap_early_device_register(struct omap_device *od) | |
542 | { | |
543 | struct platform_device *devices[1]; | |
544 | ||
545 | devices[0] = &(od->pdev); | |
546 | early_platform_add_devices(devices, 1); | |
547 | return 0; | |
548 | } | |
549 | ||
256a5435 | 550 | #ifdef CONFIG_PM_RUNTIME |
638080c3 KH |
551 | static int _od_runtime_suspend(struct device *dev) |
552 | { | |
553 | struct platform_device *pdev = to_platform_device(dev); | |
345f79b3 | 554 | int ret; |
638080c3 | 555 | |
345f79b3 KH |
556 | ret = pm_generic_runtime_suspend(dev); |
557 | ||
558 | if (!ret) | |
559 | omap_device_idle(pdev); | |
560 | ||
561 | return ret; | |
562 | } | |
563 | ||
564 | static int _od_runtime_idle(struct device *dev) | |
565 | { | |
566 | return pm_generic_runtime_idle(dev); | |
638080c3 KH |
567 | } |
568 | ||
569 | static int _od_runtime_resume(struct device *dev) | |
570 | { | |
571 | struct platform_device *pdev = to_platform_device(dev); | |
572 | ||
345f79b3 KH |
573 | omap_device_enable(pdev); |
574 | ||
575 | return pm_generic_runtime_resume(dev); | |
638080c3 | 576 | } |
256a5435 | 577 | #endif |
638080c3 | 578 | |
c03f007a KH |
579 | #ifdef CONFIG_SUSPEND |
580 | static int _od_suspend_noirq(struct device *dev) | |
581 | { | |
582 | struct platform_device *pdev = to_platform_device(dev); | |
583 | struct omap_device *od = to_omap_device(pdev); | |
584 | int ret; | |
585 | ||
80c6d1e6 KH |
586 | if (od->flags & OMAP_DEVICE_NO_IDLE_ON_SUSPEND) |
587 | return pm_generic_suspend_noirq(dev); | |
588 | ||
c03f007a KH |
589 | ret = pm_generic_suspend_noirq(dev); |
590 | ||
591 | if (!ret && !pm_runtime_status_suspended(dev)) { | |
592 | if (pm_generic_runtime_suspend(dev) == 0) { | |
593 | omap_device_idle(pdev); | |
594 | od->flags |= OMAP_DEVICE_SUSPENDED; | |
595 | } | |
596 | } | |
597 | ||
598 | return ret; | |
599 | } | |
600 | ||
601 | static int _od_resume_noirq(struct device *dev) | |
602 | { | |
603 | struct platform_device *pdev = to_platform_device(dev); | |
604 | struct omap_device *od = to_omap_device(pdev); | |
605 | ||
80c6d1e6 KH |
606 | if (od->flags & OMAP_DEVICE_NO_IDLE_ON_SUSPEND) |
607 | return pm_generic_resume_noirq(dev); | |
608 | ||
c03f007a KH |
609 | if ((od->flags & OMAP_DEVICE_SUSPENDED) && |
610 | !pm_runtime_status_suspended(dev)) { | |
611 | od->flags &= ~OMAP_DEVICE_SUSPENDED; | |
612 | omap_device_enable(pdev); | |
613 | pm_generic_runtime_resume(dev); | |
614 | } | |
615 | ||
616 | return pm_generic_resume_noirq(dev); | |
617 | } | |
618 | #endif | |
619 | ||
564b905a | 620 | static struct dev_pm_domain omap_device_pm_domain = { |
638080c3 | 621 | .ops = { |
256a5435 KH |
622 | SET_RUNTIME_PM_OPS(_od_runtime_suspend, _od_runtime_resume, |
623 | _od_runtime_idle) | |
638080c3 | 624 | USE_PLATFORM_PM_SLEEP_OPS |
ff35336d KH |
625 | .suspend_noirq = _od_suspend_noirq, |
626 | .resume_noirq = _od_resume_noirq, | |
638080c3 KH |
627 | } |
628 | }; | |
629 | ||
b04b65ab PW |
630 | /** |
631 | * omap_device_register - register an omap_device with one omap_hwmod | |
632 | * @od: struct omap_device * to register | |
633 | * | |
634 | * Register the omap_device structure. This currently just calls | |
635 | * platform_device_register() on the underlying platform_device. | |
636 | * Returns the return value of platform_device_register(). | |
637 | */ | |
638 | int omap_device_register(struct omap_device *od) | |
639 | { | |
640 | pr_debug("omap_device: %s: registering\n", od->pdev.name); | |
641 | ||
0d5e8252 | 642 | od->pdev.dev.parent = &omap_device_parent; |
564b905a | 643 | od->pdev.dev.pm_domain = &omap_device_pm_domain; |
b04b65ab PW |
644 | return platform_device_register(&od->pdev); |
645 | } | |
646 | ||
647 | ||
648 | /* Public functions for use by device drivers through struct platform_data */ | |
649 | ||
650 | /** | |
651 | * omap_device_enable - fully activate an omap_device | |
652 | * @od: struct omap_device * to activate | |
653 | * | |
654 | * Do whatever is necessary for the hwmods underlying omap_device @od | |
655 | * to be accessible and ready to operate. This generally involves | |
656 | * enabling clocks, setting SYSCONFIG registers; and in the future may | |
657 | * involve remuxing pins. Device drivers should call this function | |
658 | * (through platform_data function pointers) where they would normally | |
659 | * enable clocks, etc. Returns -EINVAL if called when the omap_device | |
660 | * is already enabled, or passes along the return value of | |
661 | * _omap_device_activate(). | |
662 | */ | |
663 | int omap_device_enable(struct platform_device *pdev) | |
664 | { | |
665 | int ret; | |
666 | struct omap_device *od; | |
667 | ||
8f0d69de | 668 | od = to_omap_device(pdev); |
b04b65ab PW |
669 | |
670 | if (od->_state == OMAP_DEVICE_STATE_ENABLED) { | |
24d82e34 KH |
671 | WARN(1, "omap_device: %s.%d: %s() called from invalid state %d\n", |
672 | od->pdev.name, od->pdev.id, __func__, od->_state); | |
b04b65ab PW |
673 | return -EINVAL; |
674 | } | |
675 | ||
676 | /* Enable everything if we're enabling this device from scratch */ | |
677 | if (od->_state == OMAP_DEVICE_STATE_UNKNOWN) | |
678 | od->pm_lat_level = od->pm_lats_cnt; | |
679 | ||
680 | ret = _omap_device_activate(od, IGNORE_WAKEUP_LAT); | |
681 | ||
682 | od->dev_wakeup_lat = 0; | |
5f1b6ef7 | 683 | od->_dev_wakeup_lat_limit = UINT_MAX; |
b04b65ab PW |
684 | od->_state = OMAP_DEVICE_STATE_ENABLED; |
685 | ||
686 | return ret; | |
687 | } | |
688 | ||
689 | /** | |
690 | * omap_device_idle - idle an omap_device | |
691 | * @od: struct omap_device * to idle | |
692 | * | |
693 | * Idle omap_device @od by calling as many .deactivate_func() entries | |
694 | * in the omap_device's pm_lats table as is possible without exceeding | |
695 | * the device's maximum wakeup latency limit, pm_lat_limit. Device | |
696 | * drivers should call this function (through platform_data function | |
697 | * pointers) where they would normally disable clocks after operations | |
698 | * complete, etc.. Returns -EINVAL if the omap_device is not | |
699 | * currently enabled, or passes along the return value of | |
700 | * _omap_device_deactivate(). | |
701 | */ | |
702 | int omap_device_idle(struct platform_device *pdev) | |
703 | { | |
704 | int ret; | |
705 | struct omap_device *od; | |
706 | ||
8f0d69de | 707 | od = to_omap_device(pdev); |
b04b65ab PW |
708 | |
709 | if (od->_state != OMAP_DEVICE_STATE_ENABLED) { | |
24d82e34 KH |
710 | WARN(1, "omap_device: %s.%d: %s() called from invalid state %d\n", |
711 | od->pdev.name, od->pdev.id, __func__, od->_state); | |
b04b65ab PW |
712 | return -EINVAL; |
713 | } | |
714 | ||
715 | ret = _omap_device_deactivate(od, USE_WAKEUP_LAT); | |
716 | ||
717 | od->_state = OMAP_DEVICE_STATE_IDLE; | |
718 | ||
719 | return ret; | |
720 | } | |
721 | ||
722 | /** | |
723 | * omap_device_shutdown - shut down an omap_device | |
724 | * @od: struct omap_device * to shut down | |
725 | * | |
726 | * Shut down omap_device @od by calling all .deactivate_func() entries | |
727 | * in the omap_device's pm_lats table and then shutting down all of | |
728 | * the underlying omap_hwmods. Used when a device is being "removed" | |
729 | * or a device driver is being unloaded. Returns -EINVAL if the | |
730 | * omap_device is not currently enabled or idle, or passes along the | |
731 | * return value of _omap_device_deactivate(). | |
732 | */ | |
733 | int omap_device_shutdown(struct platform_device *pdev) | |
734 | { | |
735 | int ret, i; | |
736 | struct omap_device *od; | |
b04b65ab | 737 | |
8f0d69de | 738 | od = to_omap_device(pdev); |
b04b65ab PW |
739 | |
740 | if (od->_state != OMAP_DEVICE_STATE_ENABLED && | |
741 | od->_state != OMAP_DEVICE_STATE_IDLE) { | |
24d82e34 KH |
742 | WARN(1, "omap_device: %s.%d: %s() called from invalid state %d\n", |
743 | od->pdev.name, od->pdev.id, __func__, od->_state); | |
b04b65ab PW |
744 | return -EINVAL; |
745 | } | |
746 | ||
747 | ret = _omap_device_deactivate(od, IGNORE_WAKEUP_LAT); | |
748 | ||
f39f4898 KVA |
749 | for (i = 0; i < od->hwmods_cnt; i++) |
750 | omap_hwmod_shutdown(od->hwmods[i]); | |
b04b65ab PW |
751 | |
752 | od->_state = OMAP_DEVICE_STATE_SHUTDOWN; | |
753 | ||
754 | return ret; | |
755 | } | |
756 | ||
757 | /** | |
758 | * omap_device_align_pm_lat - activate/deactivate device to match wakeup lat lim | |
759 | * @od: struct omap_device * | |
760 | * | |
761 | * When a device's maximum wakeup latency limit changes, call some of | |
762 | * the .activate_func or .deactivate_func function pointers in the | |
763 | * omap_device's pm_lats array to ensure that the device's maximum | |
764 | * wakeup latency is less than or equal to the new latency limit. | |
765 | * Intended to be called by OMAP PM code whenever a device's maximum | |
766 | * wakeup latency limit changes (e.g., via | |
767 | * omap_pm_set_dev_wakeup_lat()). Returns 0 if nothing needs to be | |
768 | * done (e.g., if the omap_device is not currently idle, or if the | |
769 | * wakeup latency is already current with the new limit) or passes | |
770 | * along the return value of _omap_device_deactivate() or | |
771 | * _omap_device_activate(). | |
772 | */ | |
773 | int omap_device_align_pm_lat(struct platform_device *pdev, | |
774 | u32 new_wakeup_lat_limit) | |
775 | { | |
776 | int ret = -EINVAL; | |
777 | struct omap_device *od; | |
778 | ||
8f0d69de | 779 | od = to_omap_device(pdev); |
b04b65ab PW |
780 | |
781 | if (new_wakeup_lat_limit == od->dev_wakeup_lat) | |
782 | return 0; | |
783 | ||
784 | od->_dev_wakeup_lat_limit = new_wakeup_lat_limit; | |
785 | ||
786 | if (od->_state != OMAP_DEVICE_STATE_IDLE) | |
787 | return 0; | |
788 | else if (new_wakeup_lat_limit > od->dev_wakeup_lat) | |
789 | ret = _omap_device_deactivate(od, USE_WAKEUP_LAT); | |
790 | else if (new_wakeup_lat_limit < od->dev_wakeup_lat) | |
791 | ret = _omap_device_activate(od, USE_WAKEUP_LAT); | |
792 | ||
793 | return ret; | |
794 | } | |
795 | ||
796 | /** | |
797 | * omap_device_get_pwrdm - return the powerdomain * associated with @od | |
798 | * @od: struct omap_device * | |
799 | * | |
800 | * Return the powerdomain associated with the first underlying | |
801 | * omap_hwmod for this omap_device. Intended for use by core OMAP PM | |
802 | * code. Returns NULL on error or a struct powerdomain * upon | |
803 | * success. | |
804 | */ | |
805 | struct powerdomain *omap_device_get_pwrdm(struct omap_device *od) | |
806 | { | |
807 | /* | |
808 | * XXX Assumes that all omap_hwmod powerdomains are identical. | |
809 | * This may not necessarily be true. There should be a sanity | |
810 | * check in here to WARN() if any difference appears. | |
811 | */ | |
812 | if (!od->hwmods_cnt) | |
813 | return NULL; | |
814 | ||
815 | return omap_hwmod_get_pwrdm(od->hwmods[0]); | |
816 | } | |
817 | ||
db2a60bf PW |
818 | /** |
819 | * omap_device_get_mpu_rt_va - return the MPU's virtual addr for the hwmod base | |
820 | * @od: struct omap_device * | |
821 | * | |
822 | * Return the MPU's virtual address for the base of the hwmod, from | |
823 | * the ioremap() that the hwmod code does. Only valid if there is one | |
824 | * hwmod associated with this device. Returns NULL if there are zero | |
825 | * or more than one hwmods associated with this omap_device; | |
826 | * otherwise, passes along the return value from | |
827 | * omap_hwmod_get_mpu_rt_va(). | |
828 | */ | |
829 | void __iomem *omap_device_get_rt_va(struct omap_device *od) | |
830 | { | |
831 | if (od->hwmods_cnt != 1) | |
832 | return NULL; | |
833 | ||
834 | return omap_hwmod_get_mpu_rt_va(od->hwmods[0]); | |
835 | } | |
836 | ||
b04b65ab PW |
837 | /* |
838 | * Public functions intended for use in omap_device_pm_latency | |
839 | * .activate_func and .deactivate_func function pointers | |
840 | */ | |
841 | ||
842 | /** | |
843 | * omap_device_enable_hwmods - call omap_hwmod_enable() on all hwmods | |
844 | * @od: struct omap_device *od | |
845 | * | |
846 | * Enable all underlying hwmods. Returns 0. | |
847 | */ | |
848 | int omap_device_enable_hwmods(struct omap_device *od) | |
849 | { | |
b04b65ab PW |
850 | int i; |
851 | ||
f39f4898 KVA |
852 | for (i = 0; i < od->hwmods_cnt; i++) |
853 | omap_hwmod_enable(od->hwmods[i]); | |
b04b65ab PW |
854 | |
855 | /* XXX pass along return value here? */ | |
856 | return 0; | |
857 | } | |
858 | ||
859 | /** | |
860 | * omap_device_idle_hwmods - call omap_hwmod_idle() on all hwmods | |
861 | * @od: struct omap_device *od | |
862 | * | |
863 | * Idle all underlying hwmods. Returns 0. | |
864 | */ | |
865 | int omap_device_idle_hwmods(struct omap_device *od) | |
866 | { | |
b04b65ab PW |
867 | int i; |
868 | ||
f39f4898 KVA |
869 | for (i = 0; i < od->hwmods_cnt; i++) |
870 | omap_hwmod_idle(od->hwmods[i]); | |
b04b65ab PW |
871 | |
872 | /* XXX pass along return value here? */ | |
873 | return 0; | |
874 | } | |
875 | ||
876 | /** | |
877 | * omap_device_disable_clocks - disable all main and interface clocks | |
878 | * @od: struct omap_device *od | |
879 | * | |
880 | * Disable the main functional clock and interface clock for all of the | |
881 | * omap_hwmods associated with the omap_device. Returns 0. | |
882 | */ | |
883 | int omap_device_disable_clocks(struct omap_device *od) | |
884 | { | |
b04b65ab PW |
885 | int i; |
886 | ||
f39f4898 KVA |
887 | for (i = 0; i < od->hwmods_cnt; i++) |
888 | omap_hwmod_disable_clocks(od->hwmods[i]); | |
b04b65ab PW |
889 | |
890 | /* XXX pass along return value here? */ | |
891 | return 0; | |
892 | } | |
893 | ||
894 | /** | |
895 | * omap_device_enable_clocks - enable all main and interface clocks | |
896 | * @od: struct omap_device *od | |
897 | * | |
898 | * Enable the main functional clock and interface clock for all of the | |
899 | * omap_hwmods associated with the omap_device. Returns 0. | |
900 | */ | |
901 | int omap_device_enable_clocks(struct omap_device *od) | |
902 | { | |
b04b65ab PW |
903 | int i; |
904 | ||
f39f4898 KVA |
905 | for (i = 0; i < od->hwmods_cnt; i++) |
906 | omap_hwmod_enable_clocks(od->hwmods[i]); | |
b04b65ab PW |
907 | |
908 | /* XXX pass along return value here? */ | |
909 | return 0; | |
910 | } | |
0d5e8252 KH |
911 | |
912 | struct device omap_device_parent = { | |
913 | .init_name = "omap", | |
914 | .parent = &platform_bus, | |
915 | }; | |
916 | ||
917 | static int __init omap_device_init(void) | |
918 | { | |
919 | return device_register(&omap_device_parent); | |
920 | } | |
921 | core_initcall(omap_device_init); |