Commit | Line | Data |
---|---|---|
b04b65ab PW |
1 | /* |
2 | * omap_device implementation | |
3 | * | |
4 | * Copyright (C) 2009 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> | |
85 | ||
ce491cf8 TL |
86 | #include <plat/omap_device.h> |
87 | #include <plat/omap_hwmod.h> | |
b04b65ab PW |
88 | |
89 | /* These parameters are passed to _omap_device_{de,}activate() */ | |
90 | #define USE_WAKEUP_LAT 0 | |
91 | #define IGNORE_WAKEUP_LAT 1 | |
92 | ||
b04b65ab | 93 | |
0007122a KH |
94 | #define OMAP_DEVICE_MAGIC 0xf00dcafe |
95 | ||
b04b65ab PW |
96 | /* Private functions */ |
97 | ||
b04b65ab PW |
98 | /** |
99 | * _omap_device_activate - increase device readiness | |
100 | * @od: struct omap_device * | |
101 | * @ignore_lat: increase to latency target (0) or full readiness (1)? | |
102 | * | |
103 | * Increase readiness of omap_device @od (thus decreasing device | |
104 | * wakeup latency, but consuming more power). If @ignore_lat is | |
105 | * IGNORE_WAKEUP_LAT, make the omap_device fully active. Otherwise, | |
106 | * if @ignore_lat is USE_WAKEUP_LAT, and the device's maximum wakeup | |
107 | * latency is greater than the requested maximum wakeup latency, step | |
108 | * backwards in the omap_device_pm_latency table to ensure the | |
109 | * device's maximum wakeup latency is less than or equal to the | |
110 | * requested maximum wakeup latency. Returns 0. | |
111 | */ | |
112 | static int _omap_device_activate(struct omap_device *od, u8 ignore_lat) | |
113 | { | |
f059429e | 114 | struct timespec a, b, c; |
b04b65ab PW |
115 | |
116 | pr_debug("omap_device: %s: activating\n", od->pdev.name); | |
117 | ||
118 | while (od->pm_lat_level > 0) { | |
119 | struct omap_device_pm_latency *odpl; | |
f059429e | 120 | unsigned long long act_lat = 0; |
b04b65ab PW |
121 | |
122 | od->pm_lat_level--; | |
123 | ||
124 | odpl = od->pm_lats + od->pm_lat_level; | |
125 | ||
126 | if (!ignore_lat && | |
127 | (od->dev_wakeup_lat <= od->_dev_wakeup_lat_limit)) | |
128 | break; | |
129 | ||
d2292667 | 130 | read_persistent_clock(&a); |
b04b65ab PW |
131 | |
132 | /* XXX check return code */ | |
133 | odpl->activate_func(od); | |
134 | ||
d2292667 | 135 | read_persistent_clock(&b); |
b04b65ab | 136 | |
f059429e | 137 | c = timespec_sub(b, a); |
0d93d8bb | 138 | act_lat = timespec_to_ns(&c); |
b04b65ab PW |
139 | |
140 | pr_debug("omap_device: %s: pm_lat %d: activate: elapsed time " | |
0d93d8bb | 141 | "%llu nsec\n", od->pdev.name, od->pm_lat_level, |
f059429e | 142 | act_lat); |
b04b65ab | 143 | |
9799aca2 KH |
144 | if (act_lat > odpl->activate_lat) { |
145 | odpl->activate_lat_worst = act_lat; | |
146 | if (odpl->flags & OMAP_DEVICE_LATENCY_AUTO_ADJUST) { | |
147 | odpl->activate_lat = act_lat; | |
148 | pr_warning("omap_device: %s.%d: new worst case " | |
149 | "activate latency %d: %llu\n", | |
150 | od->pdev.name, od->pdev.id, | |
151 | od->pm_lat_level, act_lat); | |
152 | } else | |
153 | pr_warning("omap_device: %s.%d: activate " | |
154 | "latency %d higher than exptected. " | |
155 | "(%llu > %d)\n", | |
156 | od->pdev.name, od->pdev.id, | |
157 | od->pm_lat_level, act_lat, | |
158 | odpl->activate_lat); | |
159 | } | |
b04b65ab PW |
160 | |
161 | od->dev_wakeup_lat -= odpl->activate_lat; | |
162 | } | |
163 | ||
164 | return 0; | |
165 | } | |
166 | ||
167 | /** | |
168 | * _omap_device_deactivate - decrease device readiness | |
169 | * @od: struct omap_device * | |
170 | * @ignore_lat: decrease to latency target (0) or full inactivity (1)? | |
171 | * | |
172 | * Decrease readiness of omap_device @od (thus increasing device | |
173 | * wakeup latency, but conserving power). If @ignore_lat is | |
174 | * IGNORE_WAKEUP_LAT, make the omap_device fully inactive. Otherwise, | |
175 | * if @ignore_lat is USE_WAKEUP_LAT, and the device's maximum wakeup | |
176 | * latency is less than the requested maximum wakeup latency, step | |
177 | * forwards in the omap_device_pm_latency table to ensure the device's | |
178 | * maximum wakeup latency is less than or equal to the requested | |
179 | * maximum wakeup latency. Returns 0. | |
180 | */ | |
181 | static int _omap_device_deactivate(struct omap_device *od, u8 ignore_lat) | |
182 | { | |
f059429e | 183 | struct timespec a, b, c; |
b04b65ab PW |
184 | |
185 | pr_debug("omap_device: %s: deactivating\n", od->pdev.name); | |
186 | ||
187 | while (od->pm_lat_level < od->pm_lats_cnt) { | |
188 | struct omap_device_pm_latency *odpl; | |
f059429e | 189 | unsigned long long deact_lat = 0; |
b04b65ab PW |
190 | |
191 | odpl = od->pm_lats + od->pm_lat_level; | |
192 | ||
193 | if (!ignore_lat && | |
194 | ((od->dev_wakeup_lat + odpl->activate_lat) > | |
195 | od->_dev_wakeup_lat_limit)) | |
196 | break; | |
197 | ||
d2292667 | 198 | read_persistent_clock(&a); |
b04b65ab PW |
199 | |
200 | /* XXX check return code */ | |
201 | odpl->deactivate_func(od); | |
202 | ||
d2292667 | 203 | read_persistent_clock(&b); |
b04b65ab | 204 | |
f059429e | 205 | c = timespec_sub(b, a); |
0d93d8bb | 206 | deact_lat = timespec_to_ns(&c); |
b04b65ab PW |
207 | |
208 | pr_debug("omap_device: %s: pm_lat %d: deactivate: elapsed time " | |
0d93d8bb | 209 | "%llu nsec\n", od->pdev.name, od->pm_lat_level, |
b04b65ab PW |
210 | deact_lat); |
211 | ||
9799aca2 KH |
212 | if (deact_lat > odpl->deactivate_lat) { |
213 | odpl->deactivate_lat_worst = deact_lat; | |
214 | if (odpl->flags & OMAP_DEVICE_LATENCY_AUTO_ADJUST) { | |
215 | odpl->deactivate_lat = deact_lat; | |
216 | pr_warning("omap_device: %s.%d: new worst case " | |
217 | "deactivate latency %d: %llu\n", | |
218 | od->pdev.name, od->pdev.id, | |
219 | od->pm_lat_level, deact_lat); | |
220 | } else | |
221 | pr_warning("omap_device: %s.%d: deactivate " | |
222 | "latency %d higher than exptected. " | |
223 | "(%llu > %d)\n", | |
224 | od->pdev.name, od->pdev.id, | |
225 | od->pm_lat_level, deact_lat, | |
226 | odpl->deactivate_lat); | |
227 | } | |
228 | ||
b04b65ab PW |
229 | |
230 | od->dev_wakeup_lat += odpl->activate_lat; | |
231 | ||
232 | od->pm_lat_level++; | |
233 | } | |
234 | ||
235 | return 0; | |
236 | } | |
237 | ||
238 | static inline struct omap_device *_find_by_pdev(struct platform_device *pdev) | |
239 | { | |
240 | return container_of(pdev, struct omap_device, pdev); | |
241 | } | |
242 | ||
243 | ||
244 | /* Public functions for use by core code */ | |
245 | ||
246 | /** | |
247 | * omap_device_count_resources - count number of struct resource entries needed | |
248 | * @od: struct omap_device * | |
249 | * | |
250 | * Count the number of struct resource entries needed for this | |
251 | * omap_device @od. Used by omap_device_build_ss() to determine how | |
252 | * much memory to allocate before calling | |
253 | * omap_device_fill_resources(). Returns the count. | |
254 | */ | |
255 | int omap_device_count_resources(struct omap_device *od) | |
256 | { | |
257 | struct omap_hwmod *oh; | |
258 | int c = 0; | |
259 | int i; | |
260 | ||
261 | for (i = 0, oh = *od->hwmods; i < od->hwmods_cnt; i++, oh++) | |
262 | c += omap_hwmod_count_resources(oh); | |
263 | ||
264 | pr_debug("omap_device: %s: counted %d total resources across %d " | |
265 | "hwmods\n", od->pdev.name, c, od->hwmods_cnt); | |
266 | ||
267 | return c; | |
268 | } | |
269 | ||
270 | /** | |
271 | * omap_device_fill_resources - fill in array of struct resource | |
272 | * @od: struct omap_device * | |
273 | * @res: pointer to an array of struct resource to be filled in | |
274 | * | |
275 | * Populate one or more empty struct resource pointed to by @res with | |
276 | * the resource data for this omap_device @od. Used by | |
277 | * omap_device_build_ss() after calling omap_device_count_resources(). | |
278 | * Ideally this function would not be needed at all. If omap_device | |
279 | * replaces platform_device, then we can specify our own | |
280 | * get_resource()/ get_irq()/etc functions that use the underlying | |
281 | * omap_hwmod information. Or if platform_device is extended to use | |
282 | * subarchitecture-specific function pointers, the various | |
283 | * platform_device functions can simply call omap_device internal | |
284 | * functions to get device resources. Hacking around the existing | |
285 | * platform_device code wastes memory. Returns 0. | |
286 | */ | |
287 | int omap_device_fill_resources(struct omap_device *od, struct resource *res) | |
288 | { | |
289 | struct omap_hwmod *oh; | |
290 | int c = 0; | |
291 | int i, r; | |
292 | ||
293 | for (i = 0, oh = *od->hwmods; i < od->hwmods_cnt; i++, oh++) { | |
294 | r = omap_hwmod_fill_resources(oh, res); | |
295 | res += r; | |
296 | c += r; | |
297 | } | |
298 | ||
299 | return 0; | |
300 | } | |
301 | ||
302 | /** | |
303 | * omap_device_build - build and register an omap_device with one omap_hwmod | |
304 | * @pdev_name: name of the platform_device driver to use | |
305 | * @pdev_id: this platform_device's connection ID | |
306 | * @oh: ptr to the single omap_hwmod that backs this omap_device | |
307 | * @pdata: platform_data ptr to associate with the platform_device | |
308 | * @pdata_len: amount of memory pointed to by @pdata | |
309 | * @pm_lats: pointer to a omap_device_pm_latency array for this device | |
310 | * @pm_lats_cnt: ARRAY_SIZE() of @pm_lats | |
c23a97d3 | 311 | * @is_early_device: should the device be registered as an early device or not |
b04b65ab PW |
312 | * |
313 | * Convenience function for building and registering a single | |
314 | * omap_device record, which in turn builds and registers a | |
315 | * platform_device record. See omap_device_build_ss() for more | |
316 | * information. Returns ERR_PTR(-EINVAL) if @oh is NULL; otherwise, | |
317 | * passes along the return value of omap_device_build_ss(). | |
318 | */ | |
319 | struct omap_device *omap_device_build(const char *pdev_name, int pdev_id, | |
320 | struct omap_hwmod *oh, void *pdata, | |
321 | int pdata_len, | |
322 | struct omap_device_pm_latency *pm_lats, | |
c23a97d3 | 323 | int pm_lats_cnt, int is_early_device) |
b04b65ab PW |
324 | { |
325 | struct omap_hwmod *ohs[] = { oh }; | |
326 | ||
327 | if (!oh) | |
328 | return ERR_PTR(-EINVAL); | |
329 | ||
330 | return omap_device_build_ss(pdev_name, pdev_id, ohs, 1, pdata, | |
c23a97d3 TG |
331 | pdata_len, pm_lats, pm_lats_cnt, |
332 | is_early_device); | |
b04b65ab PW |
333 | } |
334 | ||
335 | /** | |
336 | * omap_device_build_ss - build and register an omap_device with multiple hwmods | |
337 | * @pdev_name: name of the platform_device driver to use | |
338 | * @pdev_id: this platform_device's connection ID | |
339 | * @oh: ptr to the single omap_hwmod that backs this omap_device | |
340 | * @pdata: platform_data ptr to associate with the platform_device | |
341 | * @pdata_len: amount of memory pointed to by @pdata | |
342 | * @pm_lats: pointer to a omap_device_pm_latency array for this device | |
343 | * @pm_lats_cnt: ARRAY_SIZE() of @pm_lats | |
c23a97d3 | 344 | * @is_early_device: should the device be registered as an early device or not |
b04b65ab PW |
345 | * |
346 | * Convenience function for building and registering an omap_device | |
347 | * subsystem record. Subsystem records consist of multiple | |
348 | * omap_hwmods. This function in turn builds and registers a | |
349 | * platform_device record. Returns an ERR_PTR() on error, or passes | |
350 | * along the return value of omap_device_register(). | |
351 | */ | |
352 | struct omap_device *omap_device_build_ss(const char *pdev_name, int pdev_id, | |
353 | struct omap_hwmod **ohs, int oh_cnt, | |
354 | void *pdata, int pdata_len, | |
355 | struct omap_device_pm_latency *pm_lats, | |
c23a97d3 | 356 | int pm_lats_cnt, int is_early_device) |
b04b65ab PW |
357 | { |
358 | int ret = -ENOMEM; | |
359 | struct omap_device *od; | |
360 | char *pdev_name2; | |
361 | struct resource *res = NULL; | |
362 | int res_count; | |
363 | struct omap_hwmod **hwmods; | |
364 | ||
365 | if (!ohs || oh_cnt == 0 || !pdev_name) | |
366 | return ERR_PTR(-EINVAL); | |
367 | ||
368 | if (!pdata && pdata_len > 0) | |
369 | return ERR_PTR(-EINVAL); | |
370 | ||
371 | pr_debug("omap_device: %s: building with %d hwmods\n", pdev_name, | |
372 | oh_cnt); | |
373 | ||
374 | od = kzalloc(sizeof(struct omap_device), GFP_KERNEL); | |
375 | if (!od) | |
376 | return ERR_PTR(-ENOMEM); | |
377 | ||
378 | od->hwmods_cnt = oh_cnt; | |
379 | ||
380 | hwmods = kzalloc(sizeof(struct omap_hwmod *) * oh_cnt, | |
381 | GFP_KERNEL); | |
382 | if (!hwmods) | |
383 | goto odbs_exit1; | |
384 | ||
385 | memcpy(hwmods, ohs, sizeof(struct omap_hwmod *) * oh_cnt); | |
386 | od->hwmods = hwmods; | |
387 | ||
388 | pdev_name2 = kzalloc(strlen(pdev_name) + 1, GFP_KERNEL); | |
389 | if (!pdev_name2) | |
390 | goto odbs_exit2; | |
391 | strcpy(pdev_name2, pdev_name); | |
392 | ||
393 | od->pdev.name = pdev_name2; | |
394 | od->pdev.id = pdev_id; | |
395 | ||
396 | res_count = omap_device_count_resources(od); | |
397 | if (res_count > 0) { | |
398 | res = kzalloc(sizeof(struct resource) * res_count, GFP_KERNEL); | |
399 | if (!res) | |
400 | goto odbs_exit3; | |
401 | } | |
402 | omap_device_fill_resources(od, res); | |
403 | ||
404 | od->pdev.num_resources = res_count; | |
405 | od->pdev.resource = res; | |
406 | ||
407 | platform_device_add_data(&od->pdev, pdata, pdata_len); | |
408 | ||
409 | od->pm_lats = pm_lats; | |
410 | od->pm_lats_cnt = pm_lats_cnt; | |
411 | ||
0007122a KH |
412 | od->magic = OMAP_DEVICE_MAGIC; |
413 | ||
c23a97d3 TG |
414 | if (is_early_device) |
415 | ret = omap_early_device_register(od); | |
416 | else | |
417 | ret = omap_device_register(od); | |
418 | ||
b04b65ab PW |
419 | if (ret) |
420 | goto odbs_exit4; | |
421 | ||
422 | return od; | |
423 | ||
424 | odbs_exit4: | |
425 | kfree(res); | |
426 | odbs_exit3: | |
427 | kfree(pdev_name2); | |
428 | odbs_exit2: | |
429 | kfree(hwmods); | |
430 | odbs_exit1: | |
431 | kfree(od); | |
432 | ||
433 | pr_err("omap_device: %s: build failed (%d)\n", pdev_name, ret); | |
434 | ||
435 | return ERR_PTR(ret); | |
436 | } | |
437 | ||
c23a97d3 TG |
438 | /** |
439 | * omap_early_device_register - register an omap_device as an early platform | |
440 | * device. | |
441 | * @od: struct omap_device * to register | |
442 | * | |
443 | * Register the omap_device structure. This currently just calls | |
444 | * platform_early_add_device() on the underlying platform_device. | |
445 | * Returns 0 by default. | |
446 | */ | |
447 | int omap_early_device_register(struct omap_device *od) | |
448 | { | |
449 | struct platform_device *devices[1]; | |
450 | ||
451 | devices[0] = &(od->pdev); | |
452 | early_platform_add_devices(devices, 1); | |
453 | return 0; | |
454 | } | |
455 | ||
b04b65ab PW |
456 | /** |
457 | * omap_device_register - register an omap_device with one omap_hwmod | |
458 | * @od: struct omap_device * to register | |
459 | * | |
460 | * Register the omap_device structure. This currently just calls | |
461 | * platform_device_register() on the underlying platform_device. | |
462 | * Returns the return value of platform_device_register(). | |
463 | */ | |
464 | int omap_device_register(struct omap_device *od) | |
465 | { | |
466 | pr_debug("omap_device: %s: registering\n", od->pdev.name); | |
467 | ||
468 | return platform_device_register(&od->pdev); | |
469 | } | |
470 | ||
471 | ||
472 | /* Public functions for use by device drivers through struct platform_data */ | |
473 | ||
474 | /** | |
475 | * omap_device_enable - fully activate an omap_device | |
476 | * @od: struct omap_device * to activate | |
477 | * | |
478 | * Do whatever is necessary for the hwmods underlying omap_device @od | |
479 | * to be accessible and ready to operate. This generally involves | |
480 | * enabling clocks, setting SYSCONFIG registers; and in the future may | |
481 | * involve remuxing pins. Device drivers should call this function | |
482 | * (through platform_data function pointers) where they would normally | |
483 | * enable clocks, etc. Returns -EINVAL if called when the omap_device | |
484 | * is already enabled, or passes along the return value of | |
485 | * _omap_device_activate(). | |
486 | */ | |
487 | int omap_device_enable(struct platform_device *pdev) | |
488 | { | |
489 | int ret; | |
490 | struct omap_device *od; | |
491 | ||
492 | od = _find_by_pdev(pdev); | |
493 | ||
494 | if (od->_state == OMAP_DEVICE_STATE_ENABLED) { | |
24d82e34 KH |
495 | WARN(1, "omap_device: %s.%d: %s() called from invalid state %d\n", |
496 | od->pdev.name, od->pdev.id, __func__, od->_state); | |
b04b65ab PW |
497 | return -EINVAL; |
498 | } | |
499 | ||
500 | /* Enable everything if we're enabling this device from scratch */ | |
501 | if (od->_state == OMAP_DEVICE_STATE_UNKNOWN) | |
502 | od->pm_lat_level = od->pm_lats_cnt; | |
503 | ||
504 | ret = _omap_device_activate(od, IGNORE_WAKEUP_LAT); | |
505 | ||
506 | od->dev_wakeup_lat = 0; | |
5f1b6ef7 | 507 | od->_dev_wakeup_lat_limit = UINT_MAX; |
b04b65ab PW |
508 | od->_state = OMAP_DEVICE_STATE_ENABLED; |
509 | ||
510 | return ret; | |
511 | } | |
512 | ||
513 | /** | |
514 | * omap_device_idle - idle an omap_device | |
515 | * @od: struct omap_device * to idle | |
516 | * | |
517 | * Idle omap_device @od by calling as many .deactivate_func() entries | |
518 | * in the omap_device's pm_lats table as is possible without exceeding | |
519 | * the device's maximum wakeup latency limit, pm_lat_limit. Device | |
520 | * drivers should call this function (through platform_data function | |
521 | * pointers) where they would normally disable clocks after operations | |
522 | * complete, etc.. Returns -EINVAL if the omap_device is not | |
523 | * currently enabled, or passes along the return value of | |
524 | * _omap_device_deactivate(). | |
525 | */ | |
526 | int omap_device_idle(struct platform_device *pdev) | |
527 | { | |
528 | int ret; | |
529 | struct omap_device *od; | |
530 | ||
531 | od = _find_by_pdev(pdev); | |
532 | ||
533 | if (od->_state != OMAP_DEVICE_STATE_ENABLED) { | |
24d82e34 KH |
534 | WARN(1, "omap_device: %s.%d: %s() called from invalid state %d\n", |
535 | od->pdev.name, od->pdev.id, __func__, od->_state); | |
b04b65ab PW |
536 | return -EINVAL; |
537 | } | |
538 | ||
539 | ret = _omap_device_deactivate(od, USE_WAKEUP_LAT); | |
540 | ||
541 | od->_state = OMAP_DEVICE_STATE_IDLE; | |
542 | ||
543 | return ret; | |
544 | } | |
545 | ||
546 | /** | |
547 | * omap_device_shutdown - shut down an omap_device | |
548 | * @od: struct omap_device * to shut down | |
549 | * | |
550 | * Shut down omap_device @od by calling all .deactivate_func() entries | |
551 | * in the omap_device's pm_lats table and then shutting down all of | |
552 | * the underlying omap_hwmods. Used when a device is being "removed" | |
553 | * or a device driver is being unloaded. Returns -EINVAL if the | |
554 | * omap_device is not currently enabled or idle, or passes along the | |
555 | * return value of _omap_device_deactivate(). | |
556 | */ | |
557 | int omap_device_shutdown(struct platform_device *pdev) | |
558 | { | |
559 | int ret, i; | |
560 | struct omap_device *od; | |
561 | struct omap_hwmod *oh; | |
562 | ||
563 | od = _find_by_pdev(pdev); | |
564 | ||
565 | if (od->_state != OMAP_DEVICE_STATE_ENABLED && | |
566 | od->_state != OMAP_DEVICE_STATE_IDLE) { | |
24d82e34 KH |
567 | WARN(1, "omap_device: %s.%d: %s() called from invalid state %d\n", |
568 | od->pdev.name, od->pdev.id, __func__, od->_state); | |
b04b65ab PW |
569 | return -EINVAL; |
570 | } | |
571 | ||
572 | ret = _omap_device_deactivate(od, IGNORE_WAKEUP_LAT); | |
573 | ||
574 | for (i = 0, oh = *od->hwmods; i < od->hwmods_cnt; i++, oh++) | |
575 | omap_hwmod_shutdown(oh); | |
576 | ||
577 | od->_state = OMAP_DEVICE_STATE_SHUTDOWN; | |
578 | ||
579 | return ret; | |
580 | } | |
581 | ||
582 | /** | |
583 | * omap_device_align_pm_lat - activate/deactivate device to match wakeup lat lim | |
584 | * @od: struct omap_device * | |
585 | * | |
586 | * When a device's maximum wakeup latency limit changes, call some of | |
587 | * the .activate_func or .deactivate_func function pointers in the | |
588 | * omap_device's pm_lats array to ensure that the device's maximum | |
589 | * wakeup latency is less than or equal to the new latency limit. | |
590 | * Intended to be called by OMAP PM code whenever a device's maximum | |
591 | * wakeup latency limit changes (e.g., via | |
592 | * omap_pm_set_dev_wakeup_lat()). Returns 0 if nothing needs to be | |
593 | * done (e.g., if the omap_device is not currently idle, or if the | |
594 | * wakeup latency is already current with the new limit) or passes | |
595 | * along the return value of _omap_device_deactivate() or | |
596 | * _omap_device_activate(). | |
597 | */ | |
598 | int omap_device_align_pm_lat(struct platform_device *pdev, | |
599 | u32 new_wakeup_lat_limit) | |
600 | { | |
601 | int ret = -EINVAL; | |
602 | struct omap_device *od; | |
603 | ||
604 | od = _find_by_pdev(pdev); | |
605 | ||
606 | if (new_wakeup_lat_limit == od->dev_wakeup_lat) | |
607 | return 0; | |
608 | ||
609 | od->_dev_wakeup_lat_limit = new_wakeup_lat_limit; | |
610 | ||
611 | if (od->_state != OMAP_DEVICE_STATE_IDLE) | |
612 | return 0; | |
613 | else if (new_wakeup_lat_limit > od->dev_wakeup_lat) | |
614 | ret = _omap_device_deactivate(od, USE_WAKEUP_LAT); | |
615 | else if (new_wakeup_lat_limit < od->dev_wakeup_lat) | |
616 | ret = _omap_device_activate(od, USE_WAKEUP_LAT); | |
617 | ||
618 | return ret; | |
619 | } | |
620 | ||
0007122a KH |
621 | /** |
622 | * omap_device_is_valid - Check if pointer is a valid omap_device | |
623 | * @od: struct omap_device * | |
624 | * | |
625 | * Return whether struct omap_device pointer @od points to a valid | |
626 | * omap_device. | |
627 | */ | |
628 | bool omap_device_is_valid(struct omap_device *od) | |
629 | { | |
630 | return (od && od->magic == OMAP_DEVICE_MAGIC); | |
631 | } | |
632 | ||
b04b65ab PW |
633 | /** |
634 | * omap_device_get_pwrdm - return the powerdomain * associated with @od | |
635 | * @od: struct omap_device * | |
636 | * | |
637 | * Return the powerdomain associated with the first underlying | |
638 | * omap_hwmod for this omap_device. Intended for use by core OMAP PM | |
639 | * code. Returns NULL on error or a struct powerdomain * upon | |
640 | * success. | |
641 | */ | |
642 | struct powerdomain *omap_device_get_pwrdm(struct omap_device *od) | |
643 | { | |
644 | /* | |
645 | * XXX Assumes that all omap_hwmod powerdomains are identical. | |
646 | * This may not necessarily be true. There should be a sanity | |
647 | * check in here to WARN() if any difference appears. | |
648 | */ | |
649 | if (!od->hwmods_cnt) | |
650 | return NULL; | |
651 | ||
652 | return omap_hwmod_get_pwrdm(od->hwmods[0]); | |
653 | } | |
654 | ||
655 | /* | |
656 | * Public functions intended for use in omap_device_pm_latency | |
657 | * .activate_func and .deactivate_func function pointers | |
658 | */ | |
659 | ||
660 | /** | |
661 | * omap_device_enable_hwmods - call omap_hwmod_enable() on all hwmods | |
662 | * @od: struct omap_device *od | |
663 | * | |
664 | * Enable all underlying hwmods. Returns 0. | |
665 | */ | |
666 | int omap_device_enable_hwmods(struct omap_device *od) | |
667 | { | |
668 | struct omap_hwmod *oh; | |
669 | int i; | |
670 | ||
671 | for (i = 0, oh = *od->hwmods; i < od->hwmods_cnt; i++, oh++) | |
672 | omap_hwmod_enable(oh); | |
673 | ||
674 | /* XXX pass along return value here? */ | |
675 | return 0; | |
676 | } | |
677 | ||
678 | /** | |
679 | * omap_device_idle_hwmods - call omap_hwmod_idle() on all hwmods | |
680 | * @od: struct omap_device *od | |
681 | * | |
682 | * Idle all underlying hwmods. Returns 0. | |
683 | */ | |
684 | int omap_device_idle_hwmods(struct omap_device *od) | |
685 | { | |
686 | struct omap_hwmod *oh; | |
687 | int i; | |
688 | ||
689 | for (i = 0, oh = *od->hwmods; i < od->hwmods_cnt; i++, oh++) | |
690 | omap_hwmod_idle(oh); | |
691 | ||
692 | /* XXX pass along return value here? */ | |
693 | return 0; | |
694 | } | |
695 | ||
696 | /** | |
697 | * omap_device_disable_clocks - disable all main and interface clocks | |
698 | * @od: struct omap_device *od | |
699 | * | |
700 | * Disable the main functional clock and interface clock for all of the | |
701 | * omap_hwmods associated with the omap_device. Returns 0. | |
702 | */ | |
703 | int omap_device_disable_clocks(struct omap_device *od) | |
704 | { | |
705 | struct omap_hwmod *oh; | |
706 | int i; | |
707 | ||
708 | for (i = 0, oh = *od->hwmods; i < od->hwmods_cnt; i++, oh++) | |
709 | omap_hwmod_disable_clocks(oh); | |
710 | ||
711 | /* XXX pass along return value here? */ | |
712 | return 0; | |
713 | } | |
714 | ||
715 | /** | |
716 | * omap_device_enable_clocks - enable all main and interface clocks | |
717 | * @od: struct omap_device *od | |
718 | * | |
719 | * Enable the main functional clock and interface clock for all of the | |
720 | * omap_hwmods associated with the omap_device. Returns 0. | |
721 | */ | |
722 | int omap_device_enable_clocks(struct omap_device *od) | |
723 | { | |
724 | struct omap_hwmod *oh; | |
725 | int i; | |
726 | ||
727 | for (i = 0, oh = *od->hwmods; i < od->hwmods_cnt; i++, oh++) | |
728 | omap_hwmod_enable_clocks(oh); | |
729 | ||
730 | /* XXX pass along return value here? */ | |
731 | return 0; | |
732 | } |