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