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