[SCSI] bnx2i: Fixed the endian on TTT for NOP out transmission
[linux-2.6.git] / arch / arm / plat-omap / omap_device.c
1 /*
2  * omap_device implementation
3  *
4  * Copyright (C) 2009-2010 Nokia Corporation
5  * Paul Walmsley, Kevin Hilman
6  *
7  * Developed in collaboration with (alphabetical order): Benoit
8  * Cousson, Thara Gopinath, 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/slab.h>
83 #include <linux/err.h>
84 #include <linux/io.h>
85 #include <linux/clk.h>
86 #include <linux/clkdev.h>
87 #include <linux/pm_runtime.h>
88
89 #include <plat/omap_device.h>
90 #include <plat/omap_hwmod.h>
91 #include <plat/clock.h>
92
93 /* These parameters are passed to _omap_device_{de,}activate() */
94 #define USE_WAKEUP_LAT                  0
95 #define IGNORE_WAKEUP_LAT               1
96
97 /* Private functions */
98
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 {
115         struct timespec a, b, c;
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;
121                 unsigned long long act_lat = 0;
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
131                 read_persistent_clock(&a);
132
133                 /* XXX check return code */
134                 odpl->activate_func(od);
135
136                 read_persistent_clock(&b);
137
138                 c = timespec_sub(b, a);
139                 act_lat = timespec_to_ns(&c);
140
141                 pr_debug("omap_device: %s: pm_lat %d: activate: elapsed time "
142                          "%llu nsec\n", od->pdev.name, od->pm_lat_level,
143                          act_lat);
144
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                 }
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 {
184         struct timespec a, b, c;
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;
190                 unsigned long long deact_lat = 0;
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
199                 read_persistent_clock(&a);
200
201                 /* XXX check return code */
202                 odpl->deactivate_func(od);
203
204                 read_persistent_clock(&b);
205
206                 c = timespec_sub(b, a);
207                 deact_lat = timespec_to_ns(&c);
208
209                 pr_debug("omap_device: %s: pm_lat %d: deactivate: elapsed time "
210                          "%llu nsec\n", od->pdev.name, od->pm_lat_level,
211                          deact_lat);
212
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
230
231                 od->dev_wakeup_lat += odpl->activate_lat;
232
233                 od->pm_lat_level++;
234         }
235
236         return 0;
237 }
238
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
276 /**
277  * _add_hwmod_clocks_clkdev - Add clkdev entry for hwmod optional clocks
278  * and main clock
279  * @od: struct omap_device *od
280  * @oh: struct omap_hwmod *oh
281  *
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.
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>).
291  * In the case of the main clock, a "fck" alias is used.
292  *
293  * No return value.
294  */
295 static void _add_hwmod_clocks_clkdev(struct omap_device *od,
296                                      struct omap_hwmod *oh)
297 {
298         int i;
299
300         _add_clkdev(od, "fck", oh->main_clk);
301
302         for (i = 0; i < oh->opt_clks_cnt; i++)
303                 _add_clkdev(od, oh->opt_clks[i].role, oh->opt_clks[i].clk);
304 }
305
306
307 /* Public functions for use by core code */
308
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
329         od = to_omap_device(pdev);
330
331         if (od->hwmods_cnt)
332                 ret = omap_hwmod_get_context_loss_count(od->hwmods[0]);
333
334         return ret;
335 }
336
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 {
348         int c = 0;
349         int i;
350
351         for (i = 0; i < od->hwmods_cnt; i++)
352                 c += omap_hwmod_count_resources(od->hwmods[i]);
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 {
379         int c = 0;
380         int i, r;
381
382         for (i = 0; i < od->hwmods_cnt; i++) {
383                 r = omap_hwmod_fill_resources(od->hwmods[i], res);
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
400  * @is_early_device: should the device be registered as an early device or not
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,
412                                       int pm_lats_cnt, int is_early_device)
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,
420                                     pdata_len, pm_lats, pm_lats_cnt,
421                                     is_early_device);
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
433  * @is_early_device: should the device be registered as an early device or not
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,
445                                          int pm_lats_cnt, int is_early_device)
446 {
447         int ret = -ENOMEM;
448         struct omap_device *od;
449         char *pdev_name2;
450         struct resource *res = NULL;
451         int i, res_count;
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
496         ret = platform_device_add_data(&od->pdev, pdata, pdata_len);
497         if (ret)
498                 goto odbs_exit4;
499
500         od->pm_lats = pm_lats;
501         od->pm_lats_cnt = pm_lats_cnt;
502
503         if (is_early_device)
504                 ret = omap_early_device_register(od);
505         else
506                 ret = omap_device_register(od);
507
508         for (i = 0; i < oh_cnt; i++) {
509                 hwmods[i]->od = od;
510                 _add_hwmod_clocks_clkdev(od, hwmods[i]);
511         }
512
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
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
550 #ifdef CONFIG_PM_RUNTIME
551 static int _od_runtime_suspend(struct device *dev)
552 {
553         struct platform_device *pdev = to_platform_device(dev);
554         int ret;
555
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);
567 }
568
569 static int _od_runtime_resume(struct device *dev)
570 {
571         struct platform_device *pdev = to_platform_device(dev);
572
573         omap_device_enable(pdev);
574
575         return pm_generic_runtime_resume(dev);
576 }
577 #endif
578
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
586         if (od->flags & OMAP_DEVICE_NO_IDLE_ON_SUSPEND)
587                 return pm_generic_suspend_noirq(dev);
588
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
606         if (od->flags & OMAP_DEVICE_NO_IDLE_ON_SUSPEND)
607                 return pm_generic_resume_noirq(dev);
608
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
620 static struct dev_pm_domain omap_device_pm_domain = {
621         .ops = {
622                 SET_RUNTIME_PM_OPS(_od_runtime_suspend, _od_runtime_resume,
623                                    _od_runtime_idle)
624                 USE_PLATFORM_PM_SLEEP_OPS
625                 SET_SYSTEM_SLEEP_PM_OPS(_od_suspend_noirq, _od_resume_noirq)
626         }
627 };
628
629 /**
630  * omap_device_register - register an omap_device with one omap_hwmod
631  * @od: struct omap_device * to register
632  *
633  * Register the omap_device structure.  This currently just calls
634  * platform_device_register() on the underlying platform_device.
635  * Returns the return value of platform_device_register().
636  */
637 int omap_device_register(struct omap_device *od)
638 {
639         pr_debug("omap_device: %s: registering\n", od->pdev.name);
640
641         od->pdev.dev.parent = &omap_device_parent;
642         od->pdev.dev.pm_domain = &omap_device_pm_domain;
643         return platform_device_register(&od->pdev);
644 }
645
646
647 /* Public functions for use by device drivers through struct platform_data */
648
649 /**
650  * omap_device_enable - fully activate an omap_device
651  * @od: struct omap_device * to activate
652  *
653  * Do whatever is necessary for the hwmods underlying omap_device @od
654  * to be accessible and ready to operate.  This generally involves
655  * enabling clocks, setting SYSCONFIG registers; and in the future may
656  * involve remuxing pins.  Device drivers should call this function
657  * (through platform_data function pointers) where they would normally
658  * enable clocks, etc.  Returns -EINVAL if called when the omap_device
659  * is already enabled, or passes along the return value of
660  * _omap_device_activate().
661  */
662 int omap_device_enable(struct platform_device *pdev)
663 {
664         int ret;
665         struct omap_device *od;
666
667         od = to_omap_device(pdev);
668
669         if (od->_state == OMAP_DEVICE_STATE_ENABLED) {
670                 WARN(1, "omap_device: %s.%d: %s() called from invalid state %d\n",
671                      od->pdev.name, od->pdev.id, __func__, od->_state);
672                 return -EINVAL;
673         }
674
675         /* Enable everything if we're enabling this device from scratch */
676         if (od->_state == OMAP_DEVICE_STATE_UNKNOWN)
677                 od->pm_lat_level = od->pm_lats_cnt;
678
679         ret = _omap_device_activate(od, IGNORE_WAKEUP_LAT);
680
681         od->dev_wakeup_lat = 0;
682         od->_dev_wakeup_lat_limit = UINT_MAX;
683         od->_state = OMAP_DEVICE_STATE_ENABLED;
684
685         return ret;
686 }
687
688 /**
689  * omap_device_idle - idle an omap_device
690  * @od: struct omap_device * to idle
691  *
692  * Idle omap_device @od by calling as many .deactivate_func() entries
693  * in the omap_device's pm_lats table as is possible without exceeding
694  * the device's maximum wakeup latency limit, pm_lat_limit.  Device
695  * drivers should call this function (through platform_data function
696  * pointers) where they would normally disable clocks after operations
697  * complete, etc..  Returns -EINVAL if the omap_device is not
698  * currently enabled, or passes along the return value of
699  * _omap_device_deactivate().
700  */
701 int omap_device_idle(struct platform_device *pdev)
702 {
703         int ret;
704         struct omap_device *od;
705
706         od = to_omap_device(pdev);
707
708         if (od->_state != OMAP_DEVICE_STATE_ENABLED) {
709                 WARN(1, "omap_device: %s.%d: %s() called from invalid state %d\n",
710                      od->pdev.name, od->pdev.id, __func__, od->_state);
711                 return -EINVAL;
712         }
713
714         ret = _omap_device_deactivate(od, USE_WAKEUP_LAT);
715
716         od->_state = OMAP_DEVICE_STATE_IDLE;
717
718         return ret;
719 }
720
721 /**
722  * omap_device_shutdown - shut down an omap_device
723  * @od: struct omap_device * to shut down
724  *
725  * Shut down omap_device @od by calling all .deactivate_func() entries
726  * in the omap_device's pm_lats table and then shutting down all of
727  * the underlying omap_hwmods.  Used when a device is being "removed"
728  * or a device driver is being unloaded.  Returns -EINVAL if the
729  * omap_device is not currently enabled or idle, or passes along the
730  * return value of _omap_device_deactivate().
731  */
732 int omap_device_shutdown(struct platform_device *pdev)
733 {
734         int ret, i;
735         struct omap_device *od;
736
737         od = to_omap_device(pdev);
738
739         if (od->_state != OMAP_DEVICE_STATE_ENABLED &&
740             od->_state != OMAP_DEVICE_STATE_IDLE) {
741                 WARN(1, "omap_device: %s.%d: %s() called from invalid state %d\n",
742                      od->pdev.name, od->pdev.id, __func__, od->_state);
743                 return -EINVAL;
744         }
745
746         ret = _omap_device_deactivate(od, IGNORE_WAKEUP_LAT);
747
748         for (i = 0; i < od->hwmods_cnt; i++)
749                 omap_hwmod_shutdown(od->hwmods[i]);
750
751         od->_state = OMAP_DEVICE_STATE_SHUTDOWN;
752
753         return ret;
754 }
755
756 /**
757  * omap_device_align_pm_lat - activate/deactivate device to match wakeup lat lim
758  * @od: struct omap_device *
759  *
760  * When a device's maximum wakeup latency limit changes, call some of
761  * the .activate_func or .deactivate_func function pointers in the
762  * omap_device's pm_lats array to ensure that the device's maximum
763  * wakeup latency is less than or equal to the new latency limit.
764  * Intended to be called by OMAP PM code whenever a device's maximum
765  * wakeup latency limit changes (e.g., via
766  * omap_pm_set_dev_wakeup_lat()).  Returns 0 if nothing needs to be
767  * done (e.g., if the omap_device is not currently idle, or if the
768  * wakeup latency is already current with the new limit) or passes
769  * along the return value of _omap_device_deactivate() or
770  * _omap_device_activate().
771  */
772 int omap_device_align_pm_lat(struct platform_device *pdev,
773                              u32 new_wakeup_lat_limit)
774 {
775         int ret = -EINVAL;
776         struct omap_device *od;
777
778         od = to_omap_device(pdev);
779
780         if (new_wakeup_lat_limit == od->dev_wakeup_lat)
781                 return 0;
782
783         od->_dev_wakeup_lat_limit = new_wakeup_lat_limit;
784
785         if (od->_state != OMAP_DEVICE_STATE_IDLE)
786                 return 0;
787         else if (new_wakeup_lat_limit > od->dev_wakeup_lat)
788                 ret = _omap_device_deactivate(od, USE_WAKEUP_LAT);
789         else if (new_wakeup_lat_limit < od->dev_wakeup_lat)
790                 ret = _omap_device_activate(od, USE_WAKEUP_LAT);
791
792         return ret;
793 }
794
795 /**
796  * omap_device_get_pwrdm - return the powerdomain * associated with @od
797  * @od: struct omap_device *
798  *
799  * Return the powerdomain associated with the first underlying
800  * omap_hwmod for this omap_device.  Intended for use by core OMAP PM
801  * code.  Returns NULL on error or a struct powerdomain * upon
802  * success.
803  */
804 struct powerdomain *omap_device_get_pwrdm(struct omap_device *od)
805 {
806         /*
807          * XXX Assumes that all omap_hwmod powerdomains are identical.
808          * This may not necessarily be true.  There should be a sanity
809          * check in here to WARN() if any difference appears.
810          */
811         if (!od->hwmods_cnt)
812                 return NULL;
813
814         return omap_hwmod_get_pwrdm(od->hwmods[0]);
815 }
816
817 /**
818  * omap_device_get_mpu_rt_va - return the MPU's virtual addr for the hwmod base
819  * @od: struct omap_device *
820  *
821  * Return the MPU's virtual address for the base of the hwmod, from
822  * the ioremap() that the hwmod code does.  Only valid if there is one
823  * hwmod associated with this device.  Returns NULL if there are zero
824  * or more than one hwmods associated with this omap_device;
825  * otherwise, passes along the return value from
826  * omap_hwmod_get_mpu_rt_va().
827  */
828 void __iomem *omap_device_get_rt_va(struct omap_device *od)
829 {
830         if (od->hwmods_cnt != 1)
831                 return NULL;
832
833         return omap_hwmod_get_mpu_rt_va(od->hwmods[0]);
834 }
835
836 /*
837  * Public functions intended for use in omap_device_pm_latency
838  * .activate_func and .deactivate_func function pointers
839  */
840
841 /**
842  * omap_device_enable_hwmods - call omap_hwmod_enable() on all hwmods
843  * @od: struct omap_device *od
844  *
845  * Enable all underlying hwmods.  Returns 0.
846  */
847 int omap_device_enable_hwmods(struct omap_device *od)
848 {
849         int i;
850
851         for (i = 0; i < od->hwmods_cnt; i++)
852                 omap_hwmod_enable(od->hwmods[i]);
853
854         /* XXX pass along return value here? */
855         return 0;
856 }
857
858 /**
859  * omap_device_idle_hwmods - call omap_hwmod_idle() on all hwmods
860  * @od: struct omap_device *od
861  *
862  * Idle all underlying hwmods.  Returns 0.
863  */
864 int omap_device_idle_hwmods(struct omap_device *od)
865 {
866         int i;
867
868         for (i = 0; i < od->hwmods_cnt; i++)
869                 omap_hwmod_idle(od->hwmods[i]);
870
871         /* XXX pass along return value here? */
872         return 0;
873 }
874
875 /**
876  * omap_device_disable_clocks - disable all main and interface clocks
877  * @od: struct omap_device *od
878  *
879  * Disable the main functional clock and interface clock for all of the
880  * omap_hwmods associated with the omap_device.  Returns 0.
881  */
882 int omap_device_disable_clocks(struct omap_device *od)
883 {
884         int i;
885
886         for (i = 0; i < od->hwmods_cnt; i++)
887                 omap_hwmod_disable_clocks(od->hwmods[i]);
888
889         /* XXX pass along return value here? */
890         return 0;
891 }
892
893 /**
894  * omap_device_enable_clocks - enable all main and interface clocks
895  * @od: struct omap_device *od
896  *
897  * Enable the main functional clock and interface clock for all of the
898  * omap_hwmods associated with the omap_device.  Returns 0.
899  */
900 int omap_device_enable_clocks(struct omap_device *od)
901 {
902         int i;
903
904         for (i = 0; i < od->hwmods_cnt; i++)
905                 omap_hwmod_enable_clocks(od->hwmods[i]);
906
907         /* XXX pass along return value here? */
908         return 0;
909 }
910
911 struct device omap_device_parent = {
912         .init_name      = "omap",
913         .parent         = &platform_bus,
914 };
915
916 static int __init omap_device_init(void)
917 {
918         return device_register(&omap_device_parent);
919 }
920 core_initcall(omap_device_init);