Merge remote branches 'remotes/origin/pwrdm_clkdm_b_2.6.39', 'remotes/origin/pwrdm_ad...
[pandora-kernel.git] / arch / arm / mach-omap2 / omap_hwmod.c
1 /*
2  * omap_hwmod implementation for OMAP2/3/4
3  *
4  * Copyright (C) 2009-2011 Nokia Corporation
5  *
6  * Paul Walmsley, BenoĆ®t Cousson, Kevin Hilman
7  *
8  * Created in collaboration with (alphabetical order): Thara Gopinath,
9  * Tony Lindgren, Rajendra Nayak, Vikram Pandita, Sakari Poussa, Anand
10  * Sawant, Santosh Shilimkar, Richard 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  * Introduction
17  * ------------
18  * One way to view an OMAP SoC is as a collection of largely unrelated
19  * IP blocks connected by interconnects.  The IP blocks include
20  * devices such as ARM processors, audio serial interfaces, UARTs,
21  * etc.  Some of these devices, like the DSP, are created by TI;
22  * others, like the SGX, largely originate from external vendors.  In
23  * TI's documentation, on-chip devices are referred to as "OMAP
24  * modules."  Some of these IP blocks are identical across several
25  * OMAP versions.  Others are revised frequently.
26  *
27  * These OMAP modules are tied together by various interconnects.
28  * Most of the address and data flow between modules is via OCP-based
29  * interconnects such as the L3 and L4 buses; but there are other
30  * interconnects that distribute the hardware clock tree, handle idle
31  * and reset signaling, supply power, and connect the modules to
32  * various pads or balls on the OMAP package.
33  *
34  * OMAP hwmod provides a consistent way to describe the on-chip
35  * hardware blocks and their integration into the rest of the chip.
36  * This description can be automatically generated from the TI
37  * hardware database.  OMAP hwmod provides a standard, consistent API
38  * to reset, enable, idle, and disable these hardware blocks.  And
39  * hwmod provides a way for other core code, such as the Linux device
40  * code or the OMAP power management and address space mapping code,
41  * to query the hardware database.
42  *
43  * Using hwmod
44  * -----------
45  * Drivers won't call hwmod functions directly.  That is done by the
46  * omap_device code, and in rare occasions, by custom integration code
47  * in arch/arm/ *omap*.  The omap_device code includes functions to
48  * build a struct platform_device using omap_hwmod data, and that is
49  * currently how hwmod data is communicated to drivers and to the
50  * Linux driver model.  Most drivers will call omap_hwmod functions only
51  * indirectly, via pm_runtime*() functions.
52  *
53  * From a layering perspective, here is where the OMAP hwmod code
54  * fits into the kernel software stack:
55  *
56  *            +-------------------------------+
57  *            |      Device driver code       |
58  *            |      (e.g., drivers/)         |
59  *            +-------------------------------+
60  *            |      Linux driver model       |
61  *            |     (platform_device /        |
62  *            |  platform_driver data/code)   |
63  *            +-------------------------------+
64  *            | OMAP core-driver integration  |
65  *            |(arch/arm/mach-omap2/devices.c)|
66  *            +-------------------------------+
67  *            |      omap_device code         |
68  *            | (../plat-omap/omap_device.c)  |
69  *            +-------------------------------+
70  *   ---->    |    omap_hwmod code/data       |    <-----
71  *            | (../mach-omap2/omap_hwmod*)   |
72  *            +-------------------------------+
73  *            | OMAP clock/PRCM/register fns  |
74  *            | (__raw_{read,write}l, clk*)   |
75  *            +-------------------------------+
76  *
77  * Device drivers should not contain any OMAP-specific code or data in
78  * them.  They should only contain code to operate the IP block that
79  * the driver is responsible for.  This is because these IP blocks can
80  * also appear in other SoCs, either from TI (such as DaVinci) or from
81  * other manufacturers; and drivers should be reusable across other
82  * platforms.
83  *
84  * The OMAP hwmod code also will attempt to reset and idle all on-chip
85  * devices upon boot.  The goal here is for the kernel to be
86  * completely self-reliant and independent from bootloaders.  This is
87  * to ensure a repeatable configuration, both to ensure consistent
88  * runtime behavior, and to make it easier for others to reproduce
89  * bugs.
90  *
91  * OMAP module activity states
92  * ---------------------------
93  * The hwmod code considers modules to be in one of several activity
94  * states.  IP blocks start out in an UNKNOWN state, then once they
95  * are registered via the hwmod code, proceed to the REGISTERED state.
96  * Once their clock names are resolved to clock pointers, the module
97  * enters the CLKS_INITED state; and finally, once the module has been
98  * reset and the integration registers programmed, the INITIALIZED state
99  * is entered.  The hwmod code will then place the module into either
100  * the IDLE state to save power, or in the case of a critical system
101  * module, the ENABLED state.
102  *
103  * OMAP core integration code can then call omap_hwmod*() functions
104  * directly to move the module between the IDLE, ENABLED, and DISABLED
105  * states, as needed.  This is done during both the PM idle loop, and
106  * in the OMAP core integration code's implementation of the PM runtime
107  * functions.
108  *
109  * References
110  * ----------
111  * This is a partial list.
112  * - OMAP2420 Multimedia Processor Silicon Revision 2.1.1, 2.2 (SWPU064)
113  * - OMAP2430 Multimedia Device POP Silicon Revision 2.1 (SWPU090)
114  * - OMAP34xx Multimedia Device Silicon Revision 3.1 (SWPU108)
115  * - OMAP4430 Multimedia Device Silicon Revision 1.0 (SWPU140)
116  * - Open Core Protocol Specification 2.2
117  *
118  * To do:
119  * - handle IO mapping
120  * - bus throughput & module latency measurement code
121  *
122  * XXX add tests at the beginning of each function to ensure the hwmod is
123  * in the appropriate state
124  * XXX error return values should be checked to ensure that they are
125  * appropriate
126  */
127 #undef DEBUG
128
129 #include <linux/kernel.h>
130 #include <linux/errno.h>
131 #include <linux/io.h>
132 #include <linux/clk.h>
133 #include <linux/delay.h>
134 #include <linux/err.h>
135 #include <linux/list.h>
136 #include <linux/mutex.h>
137 #include <linux/spinlock.h>
138
139 #include <plat/common.h>
140 #include <plat/cpu.h>
141 #include "clockdomain.h"
142 #include "powerdomain.h"
143 #include <plat/clock.h>
144 #include <plat/omap_hwmod.h>
145 #include <plat/prcm.h>
146
147 #include "cm2xxx_3xxx.h"
148 #include "cm44xx.h"
149 #include "prm2xxx_3xxx.h"
150 #include "prm44xx.h"
151 #include "mux.h"
152
153 /* Maximum microseconds to wait for OMAP module to softreset */
154 #define MAX_MODULE_SOFTRESET_WAIT       10000
155
156 /* Name of the OMAP hwmod for the MPU */
157 #define MPU_INITIATOR_NAME              "mpu"
158
159 /* omap_hwmod_list contains all registered struct omap_hwmods */
160 static LIST_HEAD(omap_hwmod_list);
161
162 /* mpu_oh: used to add/remove MPU initiator from sleepdep list */
163 static struct omap_hwmod *mpu_oh;
164
165
166 /* Private functions */
167
168 /**
169  * _update_sysc_cache - return the module OCP_SYSCONFIG register, keep copy
170  * @oh: struct omap_hwmod *
171  *
172  * Load the current value of the hwmod OCP_SYSCONFIG register into the
173  * struct omap_hwmod for later use.  Returns -EINVAL if the hwmod has no
174  * OCP_SYSCONFIG register or 0 upon success.
175  */
176 static int _update_sysc_cache(struct omap_hwmod *oh)
177 {
178         if (!oh->class->sysc) {
179                 WARN(1, "omap_hwmod: %s: cannot read OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
180                 return -EINVAL;
181         }
182
183         /* XXX ensure module interface clock is up */
184
185         oh->_sysc_cache = omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
186
187         if (!(oh->class->sysc->sysc_flags & SYSC_NO_CACHE))
188                 oh->_int_flags |= _HWMOD_SYSCONFIG_LOADED;
189
190         return 0;
191 }
192
193 /**
194  * _write_sysconfig - write a value to the module's OCP_SYSCONFIG register
195  * @v: OCP_SYSCONFIG value to write
196  * @oh: struct omap_hwmod *
197  *
198  * Write @v into the module class' OCP_SYSCONFIG register, if it has
199  * one.  No return value.
200  */
201 static void _write_sysconfig(u32 v, struct omap_hwmod *oh)
202 {
203         if (!oh->class->sysc) {
204                 WARN(1, "omap_hwmod: %s: cannot write OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
205                 return;
206         }
207
208         /* XXX ensure module interface clock is up */
209
210         /* Module might have lost context, always update cache and register */
211         oh->_sysc_cache = v;
212         omap_hwmod_write(v, oh, oh->class->sysc->sysc_offs);
213 }
214
215 /**
216  * _set_master_standbymode: set the OCP_SYSCONFIG MIDLEMODE field in @v
217  * @oh: struct omap_hwmod *
218  * @standbymode: MIDLEMODE field bits
219  * @v: pointer to register contents to modify
220  *
221  * Update the master standby mode bits in @v to be @standbymode for
222  * the @oh hwmod.  Does not write to the hardware.  Returns -EINVAL
223  * upon error or 0 upon success.
224  */
225 static int _set_master_standbymode(struct omap_hwmod *oh, u8 standbymode,
226                                    u32 *v)
227 {
228         u32 mstandby_mask;
229         u8 mstandby_shift;
230
231         if (!oh->class->sysc ||
232             !(oh->class->sysc->sysc_flags & SYSC_HAS_MIDLEMODE))
233                 return -EINVAL;
234
235         if (!oh->class->sysc->sysc_fields) {
236                 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
237                 return -EINVAL;
238         }
239
240         mstandby_shift = oh->class->sysc->sysc_fields->midle_shift;
241         mstandby_mask = (0x3 << mstandby_shift);
242
243         *v &= ~mstandby_mask;
244         *v |= __ffs(standbymode) << mstandby_shift;
245
246         return 0;
247 }
248
249 /**
250  * _set_slave_idlemode: set the OCP_SYSCONFIG SIDLEMODE field in @v
251  * @oh: struct omap_hwmod *
252  * @idlemode: SIDLEMODE field bits
253  * @v: pointer to register contents to modify
254  *
255  * Update the slave idle mode bits in @v to be @idlemode for the @oh
256  * hwmod.  Does not write to the hardware.  Returns -EINVAL upon error
257  * or 0 upon success.
258  */
259 static int _set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode, u32 *v)
260 {
261         u32 sidle_mask;
262         u8 sidle_shift;
263
264         if (!oh->class->sysc ||
265             !(oh->class->sysc->sysc_flags & SYSC_HAS_SIDLEMODE))
266                 return -EINVAL;
267
268         if (!oh->class->sysc->sysc_fields) {
269                 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
270                 return -EINVAL;
271         }
272
273         sidle_shift = oh->class->sysc->sysc_fields->sidle_shift;
274         sidle_mask = (0x3 << sidle_shift);
275
276         *v &= ~sidle_mask;
277         *v |= __ffs(idlemode) << sidle_shift;
278
279         return 0;
280 }
281
282 /**
283  * _set_clockactivity: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
284  * @oh: struct omap_hwmod *
285  * @clockact: CLOCKACTIVITY field bits
286  * @v: pointer to register contents to modify
287  *
288  * Update the clockactivity mode bits in @v to be @clockact for the
289  * @oh hwmod.  Used for additional powersaving on some modules.  Does
290  * not write to the hardware.  Returns -EINVAL upon error or 0 upon
291  * success.
292  */
293 static int _set_clockactivity(struct omap_hwmod *oh, u8 clockact, u32 *v)
294 {
295         u32 clkact_mask;
296         u8  clkact_shift;
297
298         if (!oh->class->sysc ||
299             !(oh->class->sysc->sysc_flags & SYSC_HAS_CLOCKACTIVITY))
300                 return -EINVAL;
301
302         if (!oh->class->sysc->sysc_fields) {
303                 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
304                 return -EINVAL;
305         }
306
307         clkact_shift = oh->class->sysc->sysc_fields->clkact_shift;
308         clkact_mask = (0x3 << clkact_shift);
309
310         *v &= ~clkact_mask;
311         *v |= clockact << clkact_shift;
312
313         return 0;
314 }
315
316 /**
317  * _set_softreset: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
318  * @oh: struct omap_hwmod *
319  * @v: pointer to register contents to modify
320  *
321  * Set the SOFTRESET bit in @v for hwmod @oh.  Returns -EINVAL upon
322  * error or 0 upon success.
323  */
324 static int _set_softreset(struct omap_hwmod *oh, u32 *v)
325 {
326         u32 softrst_mask;
327
328         if (!oh->class->sysc ||
329             !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
330                 return -EINVAL;
331
332         if (!oh->class->sysc->sysc_fields) {
333                 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
334                 return -EINVAL;
335         }
336
337         softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
338
339         *v |= softrst_mask;
340
341         return 0;
342 }
343
344 /**
345  * _set_module_autoidle: set the OCP_SYSCONFIG AUTOIDLE field in @v
346  * @oh: struct omap_hwmod *
347  * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
348  * @v: pointer to register contents to modify
349  *
350  * Update the module autoidle bit in @v to be @autoidle for the @oh
351  * hwmod.  The autoidle bit controls whether the module can gate
352  * internal clocks automatically when it isn't doing anything; the
353  * exact function of this bit varies on a per-module basis.  This
354  * function does not write to the hardware.  Returns -EINVAL upon
355  * error or 0 upon success.
356  */
357 static int _set_module_autoidle(struct omap_hwmod *oh, u8 autoidle,
358                                 u32 *v)
359 {
360         u32 autoidle_mask;
361         u8 autoidle_shift;
362
363         if (!oh->class->sysc ||
364             !(oh->class->sysc->sysc_flags & SYSC_HAS_AUTOIDLE))
365                 return -EINVAL;
366
367         if (!oh->class->sysc->sysc_fields) {
368                 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
369                 return -EINVAL;
370         }
371
372         autoidle_shift = oh->class->sysc->sysc_fields->autoidle_shift;
373         autoidle_mask = (0x3 << autoidle_shift);
374
375         *v &= ~autoidle_mask;
376         *v |= autoidle << autoidle_shift;
377
378         return 0;
379 }
380
381 /**
382  * _enable_wakeup: set OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
383  * @oh: struct omap_hwmod *
384  *
385  * Allow the hardware module @oh to send wakeups.  Returns -EINVAL
386  * upon error or 0 upon success.
387  */
388 static int _enable_wakeup(struct omap_hwmod *oh, u32 *v)
389 {
390         u32 wakeup_mask;
391
392         if (!oh->class->sysc ||
393             !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
394               (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)))
395                 return -EINVAL;
396
397         if (!oh->class->sysc->sysc_fields) {
398                 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
399                 return -EINVAL;
400         }
401
402         wakeup_mask = (0x1 << oh->class->sysc->sysc_fields->enwkup_shift);
403
404         *v |= wakeup_mask;
405
406         if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
407                 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
408
409         /* XXX test pwrdm_get_wken for this hwmod's subsystem */
410
411         oh->_int_flags |= _HWMOD_WAKEUP_ENABLED;
412
413         return 0;
414 }
415
416 /**
417  * _disable_wakeup: clear OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
418  * @oh: struct omap_hwmod *
419  *
420  * Prevent the hardware module @oh to send wakeups.  Returns -EINVAL
421  * upon error or 0 upon success.
422  */
423 static int _disable_wakeup(struct omap_hwmod *oh, u32 *v)
424 {
425         u32 wakeup_mask;
426
427         if (!oh->class->sysc ||
428             !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
429               (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)))
430                 return -EINVAL;
431
432         if (!oh->class->sysc->sysc_fields) {
433                 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
434                 return -EINVAL;
435         }
436
437         wakeup_mask = (0x1 << oh->class->sysc->sysc_fields->enwkup_shift);
438
439         *v &= ~wakeup_mask;
440
441         if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
442                 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART, v);
443
444         /* XXX test pwrdm_get_wken for this hwmod's subsystem */
445
446         oh->_int_flags &= ~_HWMOD_WAKEUP_ENABLED;
447
448         return 0;
449 }
450
451 /**
452  * _add_initiator_dep: prevent @oh from smart-idling while @init_oh is active
453  * @oh: struct omap_hwmod *
454  *
455  * Prevent the hardware module @oh from entering idle while the
456  * hardare module initiator @init_oh is active.  Useful when a module
457  * will be accessed by a particular initiator (e.g., if a module will
458  * be accessed by the IVA, there should be a sleepdep between the IVA
459  * initiator and the module).  Only applies to modules in smart-idle
460  * mode.  If the clockdomain is marked as not needing autodeps, return
461  * 0 without doing anything.  Otherwise, returns -EINVAL upon error or
462  * passes along clkdm_add_sleepdep() value upon success.
463  */
464 static int _add_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
465 {
466         if (!oh->_clk)
467                 return -EINVAL;
468
469         if (oh->_clk->clkdm && oh->_clk->clkdm->flags & CLKDM_NO_AUTODEPS)
470                 return 0;
471
472         return clkdm_add_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
473 }
474
475 /**
476  * _del_initiator_dep: allow @oh to smart-idle even if @init_oh is active
477  * @oh: struct omap_hwmod *
478  *
479  * Allow the hardware module @oh to enter idle while the hardare
480  * module initiator @init_oh is active.  Useful when a module will not
481  * be accessed by a particular initiator (e.g., if a module will not
482  * be accessed by the IVA, there should be no sleepdep between the IVA
483  * initiator and the module).  Only applies to modules in smart-idle
484  * mode.  If the clockdomain is marked as not needing autodeps, return
485  * 0 without doing anything.  Returns -EINVAL upon error or passes
486  * along clkdm_del_sleepdep() value upon success.
487  */
488 static int _del_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
489 {
490         if (!oh->_clk)
491                 return -EINVAL;
492
493         if (oh->_clk->clkdm && oh->_clk->clkdm->flags & CLKDM_NO_AUTODEPS)
494                 return 0;
495
496         return clkdm_del_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
497 }
498
499 /**
500  * _init_main_clk - get a struct clk * for the the hwmod's main functional clk
501  * @oh: struct omap_hwmod *
502  *
503  * Called from _init_clocks().  Populates the @oh _clk (main
504  * functional clock pointer) if a main_clk is present.  Returns 0 on
505  * success or -EINVAL on error.
506  */
507 static int _init_main_clk(struct omap_hwmod *oh)
508 {
509         int ret = 0;
510
511         if (!oh->main_clk)
512                 return 0;
513
514         oh->_clk = omap_clk_get_by_name(oh->main_clk);
515         if (!oh->_clk) {
516                 pr_warning("omap_hwmod: %s: cannot clk_get main_clk %s\n",
517                            oh->name, oh->main_clk);
518                 return -EINVAL;
519         }
520
521         if (!oh->_clk->clkdm)
522                 pr_warning("omap_hwmod: %s: missing clockdomain for %s.\n",
523                            oh->main_clk, oh->_clk->name);
524
525         return ret;
526 }
527
528 /**
529  * _init_interface_clks - get a struct clk * for the the hwmod's interface clks
530  * @oh: struct omap_hwmod *
531  *
532  * Called from _init_clocks().  Populates the @oh OCP slave interface
533  * clock pointers.  Returns 0 on success or -EINVAL on error.
534  */
535 static int _init_interface_clks(struct omap_hwmod *oh)
536 {
537         struct clk *c;
538         int i;
539         int ret = 0;
540
541         if (oh->slaves_cnt == 0)
542                 return 0;
543
544         for (i = 0; i < oh->slaves_cnt; i++) {
545                 struct omap_hwmod_ocp_if *os = oh->slaves[i];
546
547                 if (!os->clk)
548                         continue;
549
550                 c = omap_clk_get_by_name(os->clk);
551                 if (!c) {
552                         pr_warning("omap_hwmod: %s: cannot clk_get interface_clk %s\n",
553                                    oh->name, os->clk);
554                         ret = -EINVAL;
555                 }
556                 os->_clk = c;
557         }
558
559         return ret;
560 }
561
562 /**
563  * _init_opt_clk - get a struct clk * for the the hwmod's optional clocks
564  * @oh: struct omap_hwmod *
565  *
566  * Called from _init_clocks().  Populates the @oh omap_hwmod_opt_clk
567  * clock pointers.  Returns 0 on success or -EINVAL on error.
568  */
569 static int _init_opt_clks(struct omap_hwmod *oh)
570 {
571         struct omap_hwmod_opt_clk *oc;
572         struct clk *c;
573         int i;
574         int ret = 0;
575
576         for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++) {
577                 c = omap_clk_get_by_name(oc->clk);
578                 if (!c) {
579                         pr_warning("omap_hwmod: %s: cannot clk_get opt_clk %s\n",
580                                    oh->name, oc->clk);
581                         ret = -EINVAL;
582                 }
583                 oc->_clk = c;
584         }
585
586         return ret;
587 }
588
589 /**
590  * _enable_clocks - enable hwmod main clock and interface clocks
591  * @oh: struct omap_hwmod *
592  *
593  * Enables all clocks necessary for register reads and writes to succeed
594  * on the hwmod @oh.  Returns 0.
595  */
596 static int _enable_clocks(struct omap_hwmod *oh)
597 {
598         int i;
599
600         pr_debug("omap_hwmod: %s: enabling clocks\n", oh->name);
601
602         if (oh->_clk)
603                 clk_enable(oh->_clk);
604
605         if (oh->slaves_cnt > 0) {
606                 for (i = 0; i < oh->slaves_cnt; i++) {
607                         struct omap_hwmod_ocp_if *os = oh->slaves[i];
608                         struct clk *c = os->_clk;
609
610                         if (c && (os->flags & OCPIF_SWSUP_IDLE))
611                                 clk_enable(c);
612                 }
613         }
614
615         /* The opt clocks are controlled by the device driver. */
616
617         return 0;
618 }
619
620 /**
621  * _disable_clocks - disable hwmod main clock and interface clocks
622  * @oh: struct omap_hwmod *
623  *
624  * Disables the hwmod @oh main functional and interface clocks.  Returns 0.
625  */
626 static int _disable_clocks(struct omap_hwmod *oh)
627 {
628         int i;
629
630         pr_debug("omap_hwmod: %s: disabling clocks\n", oh->name);
631
632         if (oh->_clk)
633                 clk_disable(oh->_clk);
634
635         if (oh->slaves_cnt > 0) {
636                 for (i = 0; i < oh->slaves_cnt; i++) {
637                         struct omap_hwmod_ocp_if *os = oh->slaves[i];
638                         struct clk *c = os->_clk;
639
640                         if (c && (os->flags & OCPIF_SWSUP_IDLE))
641                                 clk_disable(c);
642                 }
643         }
644
645         /* The opt clocks are controlled by the device driver. */
646
647         return 0;
648 }
649
650 static void _enable_optional_clocks(struct omap_hwmod *oh)
651 {
652         struct omap_hwmod_opt_clk *oc;
653         int i;
654
655         pr_debug("omap_hwmod: %s: enabling optional clocks\n", oh->name);
656
657         for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
658                 if (oc->_clk) {
659                         pr_debug("omap_hwmod: enable %s:%s\n", oc->role,
660                                  oc->_clk->name);
661                         clk_enable(oc->_clk);
662                 }
663 }
664
665 static void _disable_optional_clocks(struct omap_hwmod *oh)
666 {
667         struct omap_hwmod_opt_clk *oc;
668         int i;
669
670         pr_debug("omap_hwmod: %s: disabling optional clocks\n", oh->name);
671
672         for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
673                 if (oc->_clk) {
674                         pr_debug("omap_hwmod: disable %s:%s\n", oc->role,
675                                  oc->_clk->name);
676                         clk_disable(oc->_clk);
677                 }
678 }
679
680 /**
681  * _find_mpu_port_index - find hwmod OCP slave port ID intended for MPU use
682  * @oh: struct omap_hwmod *
683  *
684  * Returns the array index of the OCP slave port that the MPU
685  * addresses the device on, or -EINVAL upon error or not found.
686  */
687 static int __init _find_mpu_port_index(struct omap_hwmod *oh)
688 {
689         int i;
690         int found = 0;
691
692         if (!oh || oh->slaves_cnt == 0)
693                 return -EINVAL;
694
695         for (i = 0; i < oh->slaves_cnt; i++) {
696                 struct omap_hwmod_ocp_if *os = oh->slaves[i];
697
698                 if (os->user & OCP_USER_MPU) {
699                         found = 1;
700                         break;
701                 }
702         }
703
704         if (found)
705                 pr_debug("omap_hwmod: %s: MPU OCP slave port ID  %d\n",
706                          oh->name, i);
707         else
708                 pr_debug("omap_hwmod: %s: no MPU OCP slave port found\n",
709                          oh->name);
710
711         return (found) ? i : -EINVAL;
712 }
713
714 /**
715  * _find_mpu_rt_base - find hwmod register target base addr accessible by MPU
716  * @oh: struct omap_hwmod *
717  *
718  * Return the virtual address of the base of the register target of
719  * device @oh, or NULL on error.
720  */
721 static void __iomem * __init _find_mpu_rt_base(struct omap_hwmod *oh, u8 index)
722 {
723         struct omap_hwmod_ocp_if *os;
724         struct omap_hwmod_addr_space *mem;
725         int i;
726         int found = 0;
727         void __iomem *va_start;
728
729         if (!oh || oh->slaves_cnt == 0)
730                 return NULL;
731
732         os = oh->slaves[index];
733
734         for (i = 0, mem = os->addr; i < os->addr_cnt; i++, mem++) {
735                 if (mem->flags & ADDR_TYPE_RT) {
736                         found = 1;
737                         break;
738                 }
739         }
740
741         if (found) {
742                 va_start = ioremap(mem->pa_start, mem->pa_end - mem->pa_start);
743                 if (!va_start) {
744                         pr_err("omap_hwmod: %s: Could not ioremap\n", oh->name);
745                         return NULL;
746                 }
747                 pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
748                          oh->name, va_start);
749         } else {
750                 pr_debug("omap_hwmod: %s: no MPU register target found\n",
751                          oh->name);
752         }
753
754         return (found) ? va_start : NULL;
755 }
756
757 /**
758  * _enable_sysc - try to bring a module out of idle via OCP_SYSCONFIG
759  * @oh: struct omap_hwmod *
760  *
761  * If module is marked as SWSUP_SIDLE, force the module out of slave
762  * idle; otherwise, configure it for smart-idle.  If module is marked
763  * as SWSUP_MSUSPEND, force the module out of master standby;
764  * otherwise, configure it for smart-standby.  No return value.
765  */
766 static void _enable_sysc(struct omap_hwmod *oh)
767 {
768         u8 idlemode, sf;
769         u32 v;
770
771         if (!oh->class->sysc)
772                 return;
773
774         v = oh->_sysc_cache;
775         sf = oh->class->sysc->sysc_flags;
776
777         if (sf & SYSC_HAS_SIDLEMODE) {
778                 idlemode = (oh->flags & HWMOD_SWSUP_SIDLE) ?
779                         HWMOD_IDLEMODE_NO : HWMOD_IDLEMODE_SMART;
780                 _set_slave_idlemode(oh, idlemode, &v);
781         }
782
783         if (sf & SYSC_HAS_MIDLEMODE) {
784                 idlemode = (oh->flags & HWMOD_SWSUP_MSTANDBY) ?
785                         HWMOD_IDLEMODE_NO : HWMOD_IDLEMODE_SMART;
786                 _set_master_standbymode(oh, idlemode, &v);
787         }
788
789         /*
790          * XXX The clock framework should handle this, by
791          * calling into this code.  But this must wait until the
792          * clock structures are tagged with omap_hwmod entries
793          */
794         if ((oh->flags & HWMOD_SET_DEFAULT_CLOCKACT) &&
795             (sf & SYSC_HAS_CLOCKACTIVITY))
796                 _set_clockactivity(oh, oh->class->sysc->clockact, &v);
797
798         /* If slave is in SMARTIDLE, also enable wakeup */
799         if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
800                 _enable_wakeup(oh, &v);
801
802         _write_sysconfig(v, oh);
803
804         /*
805          * Set the autoidle bit only after setting the smartidle bit
806          * Setting this will not have any impact on the other modules.
807          */
808         if (sf & SYSC_HAS_AUTOIDLE) {
809                 idlemode = (oh->flags & HWMOD_NO_OCP_AUTOIDLE) ?
810                         0 : 1;
811                 _set_module_autoidle(oh, idlemode, &v);
812                 _write_sysconfig(v, oh);
813         }
814 }
815
816 /**
817  * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
818  * @oh: struct omap_hwmod *
819  *
820  * If module is marked as SWSUP_SIDLE, force the module into slave
821  * idle; otherwise, configure it for smart-idle.  If module is marked
822  * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
823  * configure it for smart-standby.  No return value.
824  */
825 static void _idle_sysc(struct omap_hwmod *oh)
826 {
827         u8 idlemode, sf;
828         u32 v;
829
830         if (!oh->class->sysc)
831                 return;
832
833         v = oh->_sysc_cache;
834         sf = oh->class->sysc->sysc_flags;
835
836         if (sf & SYSC_HAS_SIDLEMODE) {
837                 idlemode = (oh->flags & HWMOD_SWSUP_SIDLE) ?
838                         HWMOD_IDLEMODE_FORCE : HWMOD_IDLEMODE_SMART;
839                 _set_slave_idlemode(oh, idlemode, &v);
840         }
841
842         if (sf & SYSC_HAS_MIDLEMODE) {
843                 idlemode = (oh->flags & HWMOD_SWSUP_MSTANDBY) ?
844                         HWMOD_IDLEMODE_FORCE : HWMOD_IDLEMODE_SMART;
845                 _set_master_standbymode(oh, idlemode, &v);
846         }
847
848         /* If slave is in SMARTIDLE, also enable wakeup */
849         if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
850                 _enable_wakeup(oh, &v);
851
852         _write_sysconfig(v, oh);
853 }
854
855 /**
856  * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
857  * @oh: struct omap_hwmod *
858  *
859  * Force the module into slave idle and master suspend. No return
860  * value.
861  */
862 static void _shutdown_sysc(struct omap_hwmod *oh)
863 {
864         u32 v;
865         u8 sf;
866
867         if (!oh->class->sysc)
868                 return;
869
870         v = oh->_sysc_cache;
871         sf = oh->class->sysc->sysc_flags;
872
873         if (sf & SYSC_HAS_SIDLEMODE)
874                 _set_slave_idlemode(oh, HWMOD_IDLEMODE_FORCE, &v);
875
876         if (sf & SYSC_HAS_MIDLEMODE)
877                 _set_master_standbymode(oh, HWMOD_IDLEMODE_FORCE, &v);
878
879         if (sf & SYSC_HAS_AUTOIDLE)
880                 _set_module_autoidle(oh, 1, &v);
881
882         _write_sysconfig(v, oh);
883 }
884
885 /**
886  * _lookup - find an omap_hwmod by name
887  * @name: find an omap_hwmod by name
888  *
889  * Return a pointer to an omap_hwmod by name, or NULL if not found.
890  */
891 static struct omap_hwmod *_lookup(const char *name)
892 {
893         struct omap_hwmod *oh, *temp_oh;
894
895         oh = NULL;
896
897         list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
898                 if (!strcmp(name, temp_oh->name)) {
899                         oh = temp_oh;
900                         break;
901                 }
902         }
903
904         return oh;
905 }
906
907 /**
908  * _init_clocks - clk_get() all clocks associated with this hwmod
909  * @oh: struct omap_hwmod *
910  * @data: not used; pass NULL
911  *
912  * Called by omap_hwmod_setup_*() (after omap2_clk_init()).
913  * Resolves all clock names embedded in the hwmod.  Returns 0 on
914  * success, or a negative error code on failure.
915  */
916 static int _init_clocks(struct omap_hwmod *oh, void *data)
917 {
918         int ret = 0;
919
920         if (oh->_state != _HWMOD_STATE_REGISTERED)
921                 return 0;
922
923         pr_debug("omap_hwmod: %s: looking up clocks\n", oh->name);
924
925         ret |= _init_main_clk(oh);
926         ret |= _init_interface_clks(oh);
927         ret |= _init_opt_clks(oh);
928
929         if (!ret)
930                 oh->_state = _HWMOD_STATE_CLKS_INITED;
931
932         return 0;
933 }
934
935 /**
936  * _wait_target_ready - wait for a module to leave slave idle
937  * @oh: struct omap_hwmod *
938  *
939  * Wait for a module @oh to leave slave idle.  Returns 0 if the module
940  * does not have an IDLEST bit or if the module successfully leaves
941  * slave idle; otherwise, pass along the return value of the
942  * appropriate *_cm_wait_module_ready() function.
943  */
944 static int _wait_target_ready(struct omap_hwmod *oh)
945 {
946         struct omap_hwmod_ocp_if *os;
947         int ret;
948
949         if (!oh)
950                 return -EINVAL;
951
952         if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
953                 return 0;
954
955         os = oh->slaves[oh->_mpu_port_index];
956
957         if (oh->flags & HWMOD_NO_IDLEST)
958                 return 0;
959
960         /* XXX check module SIDLEMODE */
961
962         /* XXX check clock enable states */
963
964         if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
965                 ret = omap2_cm_wait_module_ready(oh->prcm.omap2.module_offs,
966                                                  oh->prcm.omap2.idlest_reg_id,
967                                                  oh->prcm.omap2.idlest_idle_bit);
968         } else if (cpu_is_omap44xx()) {
969                 ret = omap4_cm_wait_module_ready(oh->prcm.omap4.clkctrl_reg);
970         } else {
971                 BUG();
972         };
973
974         return ret;
975 }
976
977 /**
978  * _lookup_hardreset - return the register bit shift for this hwmod/reset line
979  * @oh: struct omap_hwmod *
980  * @name: name of the reset line in the context of this hwmod
981  *
982  * Return the bit position of the reset line that match the
983  * input name. Return -ENOENT if not found.
984  */
985 static u8 _lookup_hardreset(struct omap_hwmod *oh, const char *name)
986 {
987         int i;
988
989         for (i = 0; i < oh->rst_lines_cnt; i++) {
990                 const char *rst_line = oh->rst_lines[i].name;
991                 if (!strcmp(rst_line, name)) {
992                         u8 shift = oh->rst_lines[i].rst_shift;
993                         pr_debug("omap_hwmod: %s: _lookup_hardreset: %s: %d\n",
994                                  oh->name, rst_line, shift);
995
996                         return shift;
997                 }
998         }
999
1000         return -ENOENT;
1001 }
1002
1003 /**
1004  * _assert_hardreset - assert the HW reset line of submodules
1005  * contained in the hwmod module.
1006  * @oh: struct omap_hwmod *
1007  * @name: name of the reset line to lookup and assert
1008  *
1009  * Some IP like dsp, ipu or iva contain processor that require
1010  * an HW reset line to be assert / deassert in order to enable fully
1011  * the IP.
1012  */
1013 static int _assert_hardreset(struct omap_hwmod *oh, const char *name)
1014 {
1015         u8 shift;
1016
1017         if (!oh)
1018                 return -EINVAL;
1019
1020         shift = _lookup_hardreset(oh, name);
1021         if (IS_ERR_VALUE(shift))
1022                 return shift;
1023
1024         if (cpu_is_omap24xx() || cpu_is_omap34xx())
1025                 return omap2_prm_assert_hardreset(oh->prcm.omap2.module_offs,
1026                                                   shift);
1027         else if (cpu_is_omap44xx())
1028                 return omap4_prm_assert_hardreset(oh->prcm.omap4.rstctrl_reg,
1029                                                   shift);
1030         else
1031                 return -EINVAL;
1032 }
1033
1034 /**
1035  * _deassert_hardreset - deassert the HW reset line of submodules contained
1036  * in the hwmod module.
1037  * @oh: struct omap_hwmod *
1038  * @name: name of the reset line to look up and deassert
1039  *
1040  * Some IP like dsp, ipu or iva contain processor that require
1041  * an HW reset line to be assert / deassert in order to enable fully
1042  * the IP.
1043  */
1044 static int _deassert_hardreset(struct omap_hwmod *oh, const char *name)
1045 {
1046         u8 shift;
1047         int r;
1048
1049         if (!oh)
1050                 return -EINVAL;
1051
1052         shift = _lookup_hardreset(oh, name);
1053         if (IS_ERR_VALUE(shift))
1054                 return shift;
1055
1056         if (cpu_is_omap24xx() || cpu_is_omap34xx())
1057                 r = omap2_prm_deassert_hardreset(oh->prcm.omap2.module_offs,
1058                                                  shift);
1059         else if (cpu_is_omap44xx())
1060                 r = omap4_prm_deassert_hardreset(oh->prcm.omap4.rstctrl_reg,
1061                                                  shift);
1062         else
1063                 return -EINVAL;
1064
1065         if (r == -EBUSY)
1066                 pr_warning("omap_hwmod: %s: failed to hardreset\n", oh->name);
1067
1068         return r;
1069 }
1070
1071 /**
1072  * _read_hardreset - read the HW reset line state of submodules
1073  * contained in the hwmod module
1074  * @oh: struct omap_hwmod *
1075  * @name: name of the reset line to look up and read
1076  *
1077  * Return the state of the reset line.
1078  */
1079 static int _read_hardreset(struct omap_hwmod *oh, const char *name)
1080 {
1081         u8 shift;
1082
1083         if (!oh)
1084                 return -EINVAL;
1085
1086         shift = _lookup_hardreset(oh, name);
1087         if (IS_ERR_VALUE(shift))
1088                 return shift;
1089
1090         if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1091                 return omap2_prm_is_hardreset_asserted(oh->prcm.omap2.module_offs,
1092                                                        shift);
1093         } else if (cpu_is_omap44xx()) {
1094                 return omap4_prm_is_hardreset_asserted(oh->prcm.omap4.rstctrl_reg,
1095                                                        shift);
1096         } else {
1097                 return -EINVAL;
1098         }
1099 }
1100
1101 /**
1102  * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1103  * @oh: struct omap_hwmod *
1104  *
1105  * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit.  hwmod must be
1106  * enabled for this to work.  Returns -EINVAL if the hwmod cannot be
1107  * reset this way or if the hwmod is in the wrong state, -ETIMEDOUT if
1108  * the module did not reset in time, or 0 upon success.
1109  *
1110  * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1111  * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1112  * use the SYSCONFIG softreset bit to provide the status.
1113  *
1114  * Note that some IP like McBSP do have reset control but don't have
1115  * reset status.
1116  */
1117 static int _ocp_softreset(struct omap_hwmod *oh)
1118 {
1119         u32 v;
1120         int c = 0;
1121         int ret = 0;
1122
1123         if (!oh->class->sysc ||
1124             !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
1125                 return -EINVAL;
1126
1127         /* clocks must be on for this operation */
1128         if (oh->_state != _HWMOD_STATE_ENABLED) {
1129                 pr_warning("omap_hwmod: %s: reset can only be entered from "
1130                            "enabled state\n", oh->name);
1131                 return -EINVAL;
1132         }
1133
1134         /* For some modules, all optionnal clocks need to be enabled as well */
1135         if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1136                 _enable_optional_clocks(oh);
1137
1138         pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh->name);
1139
1140         v = oh->_sysc_cache;
1141         ret = _set_softreset(oh, &v);
1142         if (ret)
1143                 goto dis_opt_clks;
1144         _write_sysconfig(v, oh);
1145
1146         if (oh->class->sysc->sysc_flags & SYSS_HAS_RESET_STATUS)
1147                 omap_test_timeout((omap_hwmod_read(oh,
1148                                                     oh->class->sysc->syss_offs)
1149                                    & SYSS_RESETDONE_MASK),
1150                                   MAX_MODULE_SOFTRESET_WAIT, c);
1151         else if (oh->class->sysc->sysc_flags & SYSC_HAS_RESET_STATUS)
1152                 omap_test_timeout(!(omap_hwmod_read(oh,
1153                                                      oh->class->sysc->sysc_offs)
1154                                    & SYSC_TYPE2_SOFTRESET_MASK),
1155                                   MAX_MODULE_SOFTRESET_WAIT, c);
1156
1157         if (c == MAX_MODULE_SOFTRESET_WAIT)
1158                 pr_warning("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1159                            oh->name, MAX_MODULE_SOFTRESET_WAIT);
1160         else
1161                 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh->name, c);
1162
1163         /*
1164          * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1165          * _wait_target_ready() or _reset()
1166          */
1167
1168         ret = (c == MAX_MODULE_SOFTRESET_WAIT) ? -ETIMEDOUT : 0;
1169
1170 dis_opt_clks:
1171         if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1172                 _disable_optional_clocks(oh);
1173
1174         return ret;
1175 }
1176
1177 /**
1178  * _reset - reset an omap_hwmod
1179  * @oh: struct omap_hwmod *
1180  *
1181  * Resets an omap_hwmod @oh.  The default software reset mechanism for
1182  * most OMAP IP blocks is triggered via the OCP_SYSCONFIG.SOFTRESET
1183  * bit.  However, some hwmods cannot be reset via this method: some
1184  * are not targets and therefore have no OCP header registers to
1185  * access; others (like the IVA) have idiosyncratic reset sequences.
1186  * So for these relatively rare cases, custom reset code can be
1187  * supplied in the struct omap_hwmod_class .reset function pointer.
1188  * Passes along the return value from either _reset() or the custom
1189  * reset function - these must return -EINVAL if the hwmod cannot be
1190  * reset this way or if the hwmod is in the wrong state, -ETIMEDOUT if
1191  * the module did not reset in time, or 0 upon success.
1192  */
1193 static int _reset(struct omap_hwmod *oh)
1194 {
1195         int ret;
1196
1197         pr_debug("omap_hwmod: %s: resetting\n", oh->name);
1198
1199         ret = (oh->class->reset) ? oh->class->reset(oh) : _ocp_softreset(oh);
1200
1201         return ret;
1202 }
1203
1204 /**
1205  * _enable - enable an omap_hwmod
1206  * @oh: struct omap_hwmod *
1207  *
1208  * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
1209  * register target.  Returns -EINVAL if the hwmod is in the wrong
1210  * state or passes along the return value of _wait_target_ready().
1211  */
1212 static int _enable(struct omap_hwmod *oh)
1213 {
1214         int r;
1215
1216         if (oh->_state != _HWMOD_STATE_INITIALIZED &&
1217             oh->_state != _HWMOD_STATE_IDLE &&
1218             oh->_state != _HWMOD_STATE_DISABLED) {
1219                 WARN(1, "omap_hwmod: %s: enabled state can only be entered "
1220                      "from initialized, idle, or disabled state\n", oh->name);
1221                 return -EINVAL;
1222         }
1223
1224         pr_debug("omap_hwmod: %s: enabling\n", oh->name);
1225
1226         /*
1227          * If an IP contains only one HW reset line, then de-assert it in order
1228          * to allow to enable the clocks. Otherwise the PRCM will return
1229          * Intransition status, and the init will failed.
1230          */
1231         if ((oh->_state == _HWMOD_STATE_INITIALIZED ||
1232              oh->_state == _HWMOD_STATE_DISABLED) && oh->rst_lines_cnt == 1)
1233                 _deassert_hardreset(oh, oh->rst_lines[0].name);
1234
1235         /* Mux pins for device runtime if populated */
1236         if (oh->mux)
1237                 omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
1238
1239         _add_initiator_dep(oh, mpu_oh);
1240         _enable_clocks(oh);
1241
1242         r = _wait_target_ready(oh);
1243         if (!r) {
1244                 oh->_state = _HWMOD_STATE_ENABLED;
1245
1246                 /* Access the sysconfig only if the target is ready */
1247                 if (oh->class->sysc) {
1248                         if (!(oh->_int_flags & _HWMOD_SYSCONFIG_LOADED))
1249                                 _update_sysc_cache(oh);
1250                         _enable_sysc(oh);
1251                 }
1252         } else {
1253                 _disable_clocks(oh);
1254                 pr_debug("omap_hwmod: %s: _wait_target_ready: %d\n",
1255                          oh->name, r);
1256         }
1257
1258         return r;
1259 }
1260
1261 /**
1262  * _idle - idle an omap_hwmod
1263  * @oh: struct omap_hwmod *
1264  *
1265  * Idles an omap_hwmod @oh.  This should be called once the hwmod has
1266  * no further work.  Returns -EINVAL if the hwmod is in the wrong
1267  * state or returns 0.
1268  */
1269 static int _idle(struct omap_hwmod *oh)
1270 {
1271         if (oh->_state != _HWMOD_STATE_ENABLED) {
1272                 WARN(1, "omap_hwmod: %s: idle state can only be entered from "
1273                      "enabled state\n", oh->name);
1274                 return -EINVAL;
1275         }
1276
1277         pr_debug("omap_hwmod: %s: idling\n", oh->name);
1278
1279         if (oh->class->sysc)
1280                 _idle_sysc(oh);
1281         _del_initiator_dep(oh, mpu_oh);
1282         _disable_clocks(oh);
1283
1284         /* Mux pins for device idle if populated */
1285         if (oh->mux)
1286                 omap_hwmod_mux(oh->mux, _HWMOD_STATE_IDLE);
1287
1288         oh->_state = _HWMOD_STATE_IDLE;
1289
1290         return 0;
1291 }
1292
1293 /**
1294  * omap_hwmod_set_ocp_autoidle - set the hwmod's OCP autoidle bit
1295  * @oh: struct omap_hwmod *
1296  * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
1297  *
1298  * Sets the IP block's OCP autoidle bit in hardware, and updates our
1299  * local copy. Intended to be used by drivers that require
1300  * direct manipulation of the AUTOIDLE bits.
1301  * Returns -EINVAL if @oh is null or is not in the ENABLED state, or passes
1302  * along the return value from _set_module_autoidle().
1303  *
1304  * Any users of this function should be scrutinized carefully.
1305  */
1306 int omap_hwmod_set_ocp_autoidle(struct omap_hwmod *oh, u8 autoidle)
1307 {
1308         u32 v;
1309         int retval = 0;
1310         unsigned long flags;
1311
1312         if (!oh || oh->_state != _HWMOD_STATE_ENABLED)
1313                 return -EINVAL;
1314
1315         spin_lock_irqsave(&oh->_lock, flags);
1316
1317         v = oh->_sysc_cache;
1318
1319         retval = _set_module_autoidle(oh, autoidle, &v);
1320
1321         if (!retval)
1322                 _write_sysconfig(v, oh);
1323
1324         spin_unlock_irqrestore(&oh->_lock, flags);
1325
1326         return retval;
1327 }
1328
1329 /**
1330  * _shutdown - shutdown an omap_hwmod
1331  * @oh: struct omap_hwmod *
1332  *
1333  * Shut down an omap_hwmod @oh.  This should be called when the driver
1334  * used for the hwmod is removed or unloaded or if the driver is not
1335  * used by the system.  Returns -EINVAL if the hwmod is in the wrong
1336  * state or returns 0.
1337  */
1338 static int _shutdown(struct omap_hwmod *oh)
1339 {
1340         int ret;
1341         u8 prev_state;
1342
1343         if (oh->_state != _HWMOD_STATE_IDLE &&
1344             oh->_state != _HWMOD_STATE_ENABLED) {
1345                 WARN(1, "omap_hwmod: %s: disabled state can only be entered "
1346                      "from idle, or enabled state\n", oh->name);
1347                 return -EINVAL;
1348         }
1349
1350         pr_debug("omap_hwmod: %s: disabling\n", oh->name);
1351
1352         if (oh->class->pre_shutdown) {
1353                 prev_state = oh->_state;
1354                 if (oh->_state == _HWMOD_STATE_IDLE)
1355                         _enable(oh);
1356                 ret = oh->class->pre_shutdown(oh);
1357                 if (ret) {
1358                         if (prev_state == _HWMOD_STATE_IDLE)
1359                                 _idle(oh);
1360                         return ret;
1361                 }
1362         }
1363
1364         if (oh->class->sysc)
1365                 _shutdown_sysc(oh);
1366
1367         /*
1368          * If an IP contains only one HW reset line, then assert it
1369          * before disabling the clocks and shutting down the IP.
1370          */
1371         if (oh->rst_lines_cnt == 1)
1372                 _assert_hardreset(oh, oh->rst_lines[0].name);
1373
1374         /* clocks and deps are already disabled in idle */
1375         if (oh->_state == _HWMOD_STATE_ENABLED) {
1376                 _del_initiator_dep(oh, mpu_oh);
1377                 /* XXX what about the other system initiators here? dma, dsp */
1378                 _disable_clocks(oh);
1379         }
1380         /* XXX Should this code also force-disable the optional clocks? */
1381
1382         /* Mux pins to safe mode or use populated off mode values */
1383         if (oh->mux)
1384                 omap_hwmod_mux(oh->mux, _HWMOD_STATE_DISABLED);
1385
1386         oh->_state = _HWMOD_STATE_DISABLED;
1387
1388         return 0;
1389 }
1390
1391 /**
1392  * _setup - do initial configuration of omap_hwmod
1393  * @oh: struct omap_hwmod *
1394  *
1395  * Writes the CLOCKACTIVITY bits @clockact to the hwmod @oh
1396  * OCP_SYSCONFIG register.  Returns 0.
1397  */
1398 static int _setup(struct omap_hwmod *oh, void *data)
1399 {
1400         int i, r;
1401         u8 postsetup_state;
1402
1403         if (oh->_state != _HWMOD_STATE_CLKS_INITED)
1404                 return 0;
1405
1406         /* Set iclk autoidle mode */
1407         if (oh->slaves_cnt > 0) {
1408                 for (i = 0; i < oh->slaves_cnt; i++) {
1409                         struct omap_hwmod_ocp_if *os = oh->slaves[i];
1410                         struct clk *c = os->_clk;
1411
1412                         if (!c)
1413                                 continue;
1414
1415                         if (os->flags & OCPIF_SWSUP_IDLE) {
1416                                 /* XXX omap_iclk_deny_idle(c); */
1417                         } else {
1418                                 /* XXX omap_iclk_allow_idle(c); */
1419                                 clk_enable(c);
1420                         }
1421                 }
1422         }
1423
1424         oh->_state = _HWMOD_STATE_INITIALIZED;
1425
1426         /*
1427          * In the case of hwmod with hardreset that should not be
1428          * de-assert at boot time, we have to keep the module
1429          * initialized, because we cannot enable it properly with the
1430          * reset asserted. Exit without warning because that behavior is
1431          * expected.
1432          */
1433         if ((oh->flags & HWMOD_INIT_NO_RESET) && oh->rst_lines_cnt == 1)
1434                 return 0;
1435
1436         r = _enable(oh);
1437         if (r) {
1438                 pr_warning("omap_hwmod: %s: cannot be enabled (%d)\n",
1439                            oh->name, oh->_state);
1440                 return 0;
1441         }
1442
1443         if (!(oh->flags & HWMOD_INIT_NO_RESET)) {
1444                 _reset(oh);
1445
1446                 /*
1447                  * OCP_SYSCONFIG bits need to be reprogrammed after a softreset.
1448                  * The _enable() function should be split to
1449                  * avoid the rewrite of the OCP_SYSCONFIG register.
1450                  */
1451                 if (oh->class->sysc) {
1452                         _update_sysc_cache(oh);
1453                         _enable_sysc(oh);
1454                 }
1455         }
1456
1457         postsetup_state = oh->_postsetup_state;
1458         if (postsetup_state == _HWMOD_STATE_UNKNOWN)
1459                 postsetup_state = _HWMOD_STATE_ENABLED;
1460
1461         /*
1462          * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
1463          * it should be set by the core code as a runtime flag during startup
1464          */
1465         if ((oh->flags & HWMOD_INIT_NO_IDLE) &&
1466             (postsetup_state == _HWMOD_STATE_IDLE))
1467                 postsetup_state = _HWMOD_STATE_ENABLED;
1468
1469         if (postsetup_state == _HWMOD_STATE_IDLE)
1470                 _idle(oh);
1471         else if (postsetup_state == _HWMOD_STATE_DISABLED)
1472                 _shutdown(oh);
1473         else if (postsetup_state != _HWMOD_STATE_ENABLED)
1474                 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
1475                      oh->name, postsetup_state);
1476
1477         return 0;
1478 }
1479
1480 /**
1481  * _register - register a struct omap_hwmod
1482  * @oh: struct omap_hwmod *
1483  *
1484  * Registers the omap_hwmod @oh.  Returns -EEXIST if an omap_hwmod
1485  * already has been registered by the same name; -EINVAL if the
1486  * omap_hwmod is in the wrong state, if @oh is NULL, if the
1487  * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
1488  * name, or if the omap_hwmod's class is missing a name; or 0 upon
1489  * success.
1490  *
1491  * XXX The data should be copied into bootmem, so the original data
1492  * should be marked __initdata and freed after init.  This would allow
1493  * unneeded omap_hwmods to be freed on multi-OMAP configurations.  Note
1494  * that the copy process would be relatively complex due to the large number
1495  * of substructures.
1496  */
1497 static int __init _register(struct omap_hwmod *oh)
1498 {
1499         int ms_id;
1500
1501         if (!oh || !oh->name || !oh->class || !oh->class->name ||
1502             (oh->_state != _HWMOD_STATE_UNKNOWN))
1503                 return -EINVAL;
1504
1505         pr_debug("omap_hwmod: %s: registering\n", oh->name);
1506
1507         if (_lookup(oh->name))
1508                 return -EEXIST;
1509
1510         ms_id = _find_mpu_port_index(oh);
1511         if (!IS_ERR_VALUE(ms_id))
1512                 oh->_mpu_port_index = ms_id;
1513         else
1514                 oh->_int_flags |= _HWMOD_NO_MPU_PORT;
1515
1516         list_add_tail(&oh->node, &omap_hwmod_list);
1517
1518         spin_lock_init(&oh->_lock);
1519
1520         oh->_state = _HWMOD_STATE_REGISTERED;
1521
1522         /*
1523          * XXX Rather than doing a strcmp(), this should test a flag
1524          * set in the hwmod data, inserted by the autogenerator code.
1525          */
1526         if (!strcmp(oh->name, MPU_INITIATOR_NAME))
1527                 mpu_oh = oh;
1528
1529         return 0;
1530 }
1531
1532
1533 /* Public functions */
1534
1535 u32 omap_hwmod_read(struct omap_hwmod *oh, u16 reg_offs)
1536 {
1537         if (oh->flags & HWMOD_16BIT_REG)
1538                 return __raw_readw(oh->_mpu_rt_va + reg_offs);
1539         else
1540                 return __raw_readl(oh->_mpu_rt_va + reg_offs);
1541 }
1542
1543 void omap_hwmod_write(u32 v, struct omap_hwmod *oh, u16 reg_offs)
1544 {
1545         if (oh->flags & HWMOD_16BIT_REG)
1546                 __raw_writew(v, oh->_mpu_rt_va + reg_offs);
1547         else
1548                 __raw_writel(v, oh->_mpu_rt_va + reg_offs);
1549 }
1550
1551 /**
1552  * omap_hwmod_set_slave_idlemode - set the hwmod's OCP slave idlemode
1553  * @oh: struct omap_hwmod *
1554  * @idlemode: SIDLEMODE field bits (shifted to bit 0)
1555  *
1556  * Sets the IP block's OCP slave idlemode in hardware, and updates our
1557  * local copy.  Intended to be used by drivers that have some erratum
1558  * that requires direct manipulation of the SIDLEMODE bits.  Returns
1559  * -EINVAL if @oh is null, or passes along the return value from
1560  * _set_slave_idlemode().
1561  *
1562  * XXX Does this function have any current users?  If not, we should
1563  * remove it; it is better to let the rest of the hwmod code handle this.
1564  * Any users of this function should be scrutinized carefully.
1565  */
1566 int omap_hwmod_set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode)
1567 {
1568         u32 v;
1569         int retval = 0;
1570
1571         if (!oh)
1572                 return -EINVAL;
1573
1574         v = oh->_sysc_cache;
1575
1576         retval = _set_slave_idlemode(oh, idlemode, &v);
1577         if (!retval)
1578                 _write_sysconfig(v, oh);
1579
1580         return retval;
1581 }
1582
1583 /**
1584  * omap_hwmod_lookup - look up a registered omap_hwmod by name
1585  * @name: name of the omap_hwmod to look up
1586  *
1587  * Given a @name of an omap_hwmod, return a pointer to the registered
1588  * struct omap_hwmod *, or NULL upon error.
1589  */
1590 struct omap_hwmod *omap_hwmod_lookup(const char *name)
1591 {
1592         struct omap_hwmod *oh;
1593
1594         if (!name)
1595                 return NULL;
1596
1597         oh = _lookup(name);
1598
1599         return oh;
1600 }
1601
1602 /**
1603  * omap_hwmod_for_each - call function for each registered omap_hwmod
1604  * @fn: pointer to a callback function
1605  * @data: void * data to pass to callback function
1606  *
1607  * Call @fn for each registered omap_hwmod, passing @data to each
1608  * function.  @fn must return 0 for success or any other value for
1609  * failure.  If @fn returns non-zero, the iteration across omap_hwmods
1610  * will stop and the non-zero return value will be passed to the
1611  * caller of omap_hwmod_for_each().  @fn is called with
1612  * omap_hwmod_for_each() held.
1613  */
1614 int omap_hwmod_for_each(int (*fn)(struct omap_hwmod *oh, void *data),
1615                         void *data)
1616 {
1617         struct omap_hwmod *temp_oh;
1618         int ret;
1619
1620         if (!fn)
1621                 return -EINVAL;
1622
1623         list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1624                 ret = (*fn)(temp_oh, data);
1625                 if (ret)
1626                         break;
1627         }
1628
1629         return ret;
1630 }
1631
1632 /**
1633  * omap_hwmod_register - register an array of hwmods
1634  * @ohs: pointer to an array of omap_hwmods to register
1635  *
1636  * Intended to be called early in boot before the clock framework is
1637  * initialized.  If @ohs is not null, will register all omap_hwmods
1638  * listed in @ohs that are valid for this chip.  Returns 0.
1639  */
1640 int __init omap_hwmod_register(struct omap_hwmod **ohs)
1641 {
1642         int r, i;
1643
1644         if (!ohs)
1645                 return 0;
1646
1647         i = 0;
1648         do {
1649                 if (!omap_chip_is(ohs[i]->omap_chip))
1650                         continue;
1651
1652                 r = _register(ohs[i]);
1653                 WARN(r, "omap_hwmod: %s: _register returned %d\n", ohs[i]->name,
1654                      r);
1655         } while (ohs[++i]);
1656
1657         return 0;
1658 }
1659
1660 /*
1661  * _populate_mpu_rt_base - populate the virtual address for a hwmod
1662  *
1663  * Must be called only from omap_hwmod_setup_*() so ioremap works properly.
1664  * Assumes the caller takes care of locking if needed.
1665  */
1666 static int __init _populate_mpu_rt_base(struct omap_hwmod *oh, void *data)
1667 {
1668         if (oh->_state != _HWMOD_STATE_REGISTERED)
1669                 return 0;
1670
1671         if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
1672                 return 0;
1673
1674         oh->_mpu_rt_va = _find_mpu_rt_base(oh, oh->_mpu_port_index);
1675         if (!oh->_mpu_rt_va)
1676                 pr_warning("omap_hwmod: %s found no _mpu_rt_va for %s\n",
1677                                 __func__, oh->name);
1678
1679         return 0;
1680 }
1681
1682 /**
1683  * omap_hwmod_setup_one - set up a single hwmod
1684  * @oh_name: const char * name of the already-registered hwmod to set up
1685  *
1686  * Must be called after omap2_clk_init().  Resolves the struct clk
1687  * names to struct clk pointers for each registered omap_hwmod.  Also
1688  * calls _setup() on each hwmod.  Returns -EINVAL upon error or 0 upon
1689  * success.
1690  */
1691 int __init omap_hwmod_setup_one(const char *oh_name)
1692 {
1693         struct omap_hwmod *oh;
1694         int r;
1695
1696         pr_debug("omap_hwmod: %s: %s\n", oh_name, __func__);
1697
1698         if (!mpu_oh) {
1699                 pr_err("omap_hwmod: %s: cannot setup_one: MPU initiator hwmod %s not yet registered\n",
1700                        oh_name, MPU_INITIATOR_NAME);
1701                 return -EINVAL;
1702         }
1703
1704         oh = _lookup(oh_name);
1705         if (!oh) {
1706                 WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name);
1707                 return -EINVAL;
1708         }
1709
1710         if (mpu_oh->_state == _HWMOD_STATE_REGISTERED && oh != mpu_oh)
1711                 omap_hwmod_setup_one(MPU_INITIATOR_NAME);
1712
1713         r = _populate_mpu_rt_base(oh, NULL);
1714         if (IS_ERR_VALUE(r)) {
1715                 WARN(1, "omap_hwmod: %s: couldn't set mpu_rt_base\n", oh_name);
1716                 return -EINVAL;
1717         }
1718
1719         r = _init_clocks(oh, NULL);
1720         if (IS_ERR_VALUE(r)) {
1721                 WARN(1, "omap_hwmod: %s: couldn't init clocks\n", oh_name);
1722                 return -EINVAL;
1723         }
1724
1725         _setup(oh, NULL);
1726
1727         return 0;
1728 }
1729
1730 /**
1731  * omap_hwmod_setup - do some post-clock framework initialization
1732  *
1733  * Must be called after omap2_clk_init().  Resolves the struct clk names
1734  * to struct clk pointers for each registered omap_hwmod.  Also calls
1735  * _setup() on each hwmod.  Returns 0 upon success.
1736  */
1737 static int __init omap_hwmod_setup_all(void)
1738 {
1739         int r;
1740
1741         if (!mpu_oh) {
1742                 pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",
1743                        __func__, MPU_INITIATOR_NAME);
1744                 return -EINVAL;
1745         }
1746
1747         r = omap_hwmod_for_each(_populate_mpu_rt_base, NULL);
1748
1749         r = omap_hwmod_for_each(_init_clocks, NULL);
1750         WARN(IS_ERR_VALUE(r),
1751              "omap_hwmod: %s: _init_clocks failed\n", __func__);
1752
1753         omap_hwmod_for_each(_setup, NULL);
1754
1755         return 0;
1756 }
1757 core_initcall(omap_hwmod_setup_all);
1758
1759 /**
1760  * omap_hwmod_enable - enable an omap_hwmod
1761  * @oh: struct omap_hwmod *
1762  *
1763  * Enable an omap_hwmod @oh.  Intended to be called by omap_device_enable().
1764  * Returns -EINVAL on error or passes along the return value from _enable().
1765  */
1766 int omap_hwmod_enable(struct omap_hwmod *oh)
1767 {
1768         int r;
1769         unsigned long flags;
1770
1771         if (!oh)
1772                 return -EINVAL;
1773
1774         spin_lock_irqsave(&oh->_lock, flags);
1775         r = _enable(oh);
1776         spin_unlock_irqrestore(&oh->_lock, flags);
1777
1778         return r;
1779 }
1780
1781 /**
1782  * omap_hwmod_idle - idle an omap_hwmod
1783  * @oh: struct omap_hwmod *
1784  *
1785  * Idle an omap_hwmod @oh.  Intended to be called by omap_device_idle().
1786  * Returns -EINVAL on error or passes along the return value from _idle().
1787  */
1788 int omap_hwmod_idle(struct omap_hwmod *oh)
1789 {
1790         unsigned long flags;
1791
1792         if (!oh)
1793                 return -EINVAL;
1794
1795         spin_lock_irqsave(&oh->_lock, flags);
1796         _idle(oh);
1797         spin_unlock_irqrestore(&oh->_lock, flags);
1798
1799         return 0;
1800 }
1801
1802 /**
1803  * omap_hwmod_shutdown - shutdown an omap_hwmod
1804  * @oh: struct omap_hwmod *
1805  *
1806  * Shutdown an omap_hwmod @oh.  Intended to be called by
1807  * omap_device_shutdown().  Returns -EINVAL on error or passes along
1808  * the return value from _shutdown().
1809  */
1810 int omap_hwmod_shutdown(struct omap_hwmod *oh)
1811 {
1812         unsigned long flags;
1813
1814         if (!oh)
1815                 return -EINVAL;
1816
1817         spin_lock_irqsave(&oh->_lock, flags);
1818         _shutdown(oh);
1819         spin_unlock_irqrestore(&oh->_lock, flags);
1820
1821         return 0;
1822 }
1823
1824 /**
1825  * omap_hwmod_enable_clocks - enable main_clk, all interface clocks
1826  * @oh: struct omap_hwmod *oh
1827  *
1828  * Intended to be called by the omap_device code.
1829  */
1830 int omap_hwmod_enable_clocks(struct omap_hwmod *oh)
1831 {
1832         unsigned long flags;
1833
1834         spin_lock_irqsave(&oh->_lock, flags);
1835         _enable_clocks(oh);
1836         spin_unlock_irqrestore(&oh->_lock, flags);
1837
1838         return 0;
1839 }
1840
1841 /**
1842  * omap_hwmod_disable_clocks - disable main_clk, all interface clocks
1843  * @oh: struct omap_hwmod *oh
1844  *
1845  * Intended to be called by the omap_device code.
1846  */
1847 int omap_hwmod_disable_clocks(struct omap_hwmod *oh)
1848 {
1849         unsigned long flags;
1850
1851         spin_lock_irqsave(&oh->_lock, flags);
1852         _disable_clocks(oh);
1853         spin_unlock_irqrestore(&oh->_lock, flags);
1854
1855         return 0;
1856 }
1857
1858 /**
1859  * omap_hwmod_ocp_barrier - wait for posted writes against the hwmod to complete
1860  * @oh: struct omap_hwmod *oh
1861  *
1862  * Intended to be called by drivers and core code when all posted
1863  * writes to a device must complete before continuing further
1864  * execution (for example, after clearing some device IRQSTATUS
1865  * register bits)
1866  *
1867  * XXX what about targets with multiple OCP threads?
1868  */
1869 void omap_hwmod_ocp_barrier(struct omap_hwmod *oh)
1870 {
1871         BUG_ON(!oh);
1872
1873         if (!oh->class->sysc || !oh->class->sysc->sysc_flags) {
1874                 WARN(1, "omap_device: %s: OCP barrier impossible due to "
1875                       "device configuration\n", oh->name);
1876                 return;
1877         }
1878
1879         /*
1880          * Forces posted writes to complete on the OCP thread handling
1881          * register writes
1882          */
1883         omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
1884 }
1885
1886 /**
1887  * omap_hwmod_reset - reset the hwmod
1888  * @oh: struct omap_hwmod *
1889  *
1890  * Under some conditions, a driver may wish to reset the entire device.
1891  * Called from omap_device code.  Returns -EINVAL on error or passes along
1892  * the return value from _reset().
1893  */
1894 int omap_hwmod_reset(struct omap_hwmod *oh)
1895 {
1896         int r;
1897         unsigned long flags;
1898
1899         if (!oh)
1900                 return -EINVAL;
1901
1902         spin_lock_irqsave(&oh->_lock, flags);
1903         r = _reset(oh);
1904         spin_unlock_irqrestore(&oh->_lock, flags);
1905
1906         return r;
1907 }
1908
1909 /**
1910  * omap_hwmod_count_resources - count number of struct resources needed by hwmod
1911  * @oh: struct omap_hwmod *
1912  * @res: pointer to the first element of an array of struct resource to fill
1913  *
1914  * Count the number of struct resource array elements necessary to
1915  * contain omap_hwmod @oh resources.  Intended to be called by code
1916  * that registers omap_devices.  Intended to be used to determine the
1917  * size of a dynamically-allocated struct resource array, before
1918  * calling omap_hwmod_fill_resources().  Returns the number of struct
1919  * resource array elements needed.
1920  *
1921  * XXX This code is not optimized.  It could attempt to merge adjacent
1922  * resource IDs.
1923  *
1924  */
1925 int omap_hwmod_count_resources(struct omap_hwmod *oh)
1926 {
1927         int ret, i;
1928
1929         ret = oh->mpu_irqs_cnt + oh->sdma_reqs_cnt;
1930
1931         for (i = 0; i < oh->slaves_cnt; i++)
1932                 ret += oh->slaves[i]->addr_cnt;
1933
1934         return ret;
1935 }
1936
1937 /**
1938  * omap_hwmod_fill_resources - fill struct resource array with hwmod data
1939  * @oh: struct omap_hwmod *
1940  * @res: pointer to the first element of an array of struct resource to fill
1941  *
1942  * Fill the struct resource array @res with resource data from the
1943  * omap_hwmod @oh.  Intended to be called by code that registers
1944  * omap_devices.  See also omap_hwmod_count_resources().  Returns the
1945  * number of array elements filled.
1946  */
1947 int omap_hwmod_fill_resources(struct omap_hwmod *oh, struct resource *res)
1948 {
1949         int i, j;
1950         int r = 0;
1951
1952         /* For each IRQ, DMA, memory area, fill in array.*/
1953
1954         for (i = 0; i < oh->mpu_irqs_cnt; i++) {
1955                 (res + r)->name = (oh->mpu_irqs + i)->name;
1956                 (res + r)->start = (oh->mpu_irqs + i)->irq;
1957                 (res + r)->end = (oh->mpu_irqs + i)->irq;
1958                 (res + r)->flags = IORESOURCE_IRQ;
1959                 r++;
1960         }
1961
1962         for (i = 0; i < oh->sdma_reqs_cnt; i++) {
1963                 (res + r)->name = (oh->sdma_reqs + i)->name;
1964                 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
1965                 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
1966                 (res + r)->flags = IORESOURCE_DMA;
1967                 r++;
1968         }
1969
1970         for (i = 0; i < oh->slaves_cnt; i++) {
1971                 struct omap_hwmod_ocp_if *os;
1972
1973                 os = oh->slaves[i];
1974
1975                 for (j = 0; j < os->addr_cnt; j++) {
1976                         (res + r)->name = (os->addr + j)->name;
1977                         (res + r)->start = (os->addr + j)->pa_start;
1978                         (res + r)->end = (os->addr + j)->pa_end;
1979                         (res + r)->flags = IORESOURCE_MEM;
1980                         r++;
1981                 }
1982         }
1983
1984         return r;
1985 }
1986
1987 /**
1988  * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
1989  * @oh: struct omap_hwmod *
1990  *
1991  * Return the powerdomain pointer associated with the OMAP module
1992  * @oh's main clock.  If @oh does not have a main clk, return the
1993  * powerdomain associated with the interface clock associated with the
1994  * module's MPU port. (XXX Perhaps this should use the SDMA port
1995  * instead?)  Returns NULL on error, or a struct powerdomain * on
1996  * success.
1997  */
1998 struct powerdomain *omap_hwmod_get_pwrdm(struct omap_hwmod *oh)
1999 {
2000         struct clk *c;
2001
2002         if (!oh)
2003                 return NULL;
2004
2005         if (oh->_clk) {
2006                 c = oh->_clk;
2007         } else {
2008                 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2009                         return NULL;
2010                 c = oh->slaves[oh->_mpu_port_index]->_clk;
2011         }
2012
2013         if (!c->clkdm)
2014                 return NULL;
2015
2016         return c->clkdm->pwrdm.ptr;
2017
2018 }
2019
2020 /**
2021  * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
2022  * @oh: struct omap_hwmod *
2023  *
2024  * Returns the virtual address corresponding to the beginning of the
2025  * module's register target, in the address range that is intended to
2026  * be used by the MPU.  Returns the virtual address upon success or NULL
2027  * upon error.
2028  */
2029 void __iomem *omap_hwmod_get_mpu_rt_va(struct omap_hwmod *oh)
2030 {
2031         if (!oh)
2032                 return NULL;
2033
2034         if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2035                 return NULL;
2036
2037         if (oh->_state == _HWMOD_STATE_UNKNOWN)
2038                 return NULL;
2039
2040         return oh->_mpu_rt_va;
2041 }
2042
2043 /**
2044  * omap_hwmod_add_initiator_dep - add sleepdep from @init_oh to @oh
2045  * @oh: struct omap_hwmod *
2046  * @init_oh: struct omap_hwmod * (initiator)
2047  *
2048  * Add a sleep dependency between the initiator @init_oh and @oh.
2049  * Intended to be called by DSP/Bridge code via platform_data for the
2050  * DSP case; and by the DMA code in the sDMA case.  DMA code, *Bridge
2051  * code needs to add/del initiator dependencies dynamically
2052  * before/after accessing a device.  Returns the return value from
2053  * _add_initiator_dep().
2054  *
2055  * XXX Keep a usecount in the clockdomain code
2056  */
2057 int omap_hwmod_add_initiator_dep(struct omap_hwmod *oh,
2058                                  struct omap_hwmod *init_oh)
2059 {
2060         return _add_initiator_dep(oh, init_oh);
2061 }
2062
2063 /*
2064  * XXX what about functions for drivers to save/restore ocp_sysconfig
2065  * for context save/restore operations?
2066  */
2067
2068 /**
2069  * omap_hwmod_del_initiator_dep - remove sleepdep from @init_oh to @oh
2070  * @oh: struct omap_hwmod *
2071  * @init_oh: struct omap_hwmod * (initiator)
2072  *
2073  * Remove a sleep dependency between the initiator @init_oh and @oh.
2074  * Intended to be called by DSP/Bridge code via platform_data for the
2075  * DSP case; and by the DMA code in the sDMA case.  DMA code, *Bridge
2076  * code needs to add/del initiator dependencies dynamically
2077  * before/after accessing a device.  Returns the return value from
2078  * _del_initiator_dep().
2079  *
2080  * XXX Keep a usecount in the clockdomain code
2081  */
2082 int omap_hwmod_del_initiator_dep(struct omap_hwmod *oh,
2083                                  struct omap_hwmod *init_oh)
2084 {
2085         return _del_initiator_dep(oh, init_oh);
2086 }
2087
2088 /**
2089  * omap_hwmod_enable_wakeup - allow device to wake up the system
2090  * @oh: struct omap_hwmod *
2091  *
2092  * Sets the module OCP socket ENAWAKEUP bit to allow the module to
2093  * send wakeups to the PRCM.  Eventually this should sets PRCM wakeup
2094  * registers to cause the PRCM to receive wakeup events from the
2095  * module.  Does not set any wakeup routing registers beyond this
2096  * point - if the module is to wake up any other module or subsystem,
2097  * that must be set separately.  Called by omap_device code.  Returns
2098  * -EINVAL on error or 0 upon success.
2099  */
2100 int omap_hwmod_enable_wakeup(struct omap_hwmod *oh)
2101 {
2102         unsigned long flags;
2103         u32 v;
2104
2105         if (!oh->class->sysc ||
2106             !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
2107                 return -EINVAL;
2108
2109         spin_lock_irqsave(&oh->_lock, flags);
2110         v = oh->_sysc_cache;
2111         _enable_wakeup(oh, &v);
2112         _write_sysconfig(v, oh);
2113         spin_unlock_irqrestore(&oh->_lock, flags);
2114
2115         return 0;
2116 }
2117
2118 /**
2119  * omap_hwmod_disable_wakeup - prevent device from waking the system
2120  * @oh: struct omap_hwmod *
2121  *
2122  * Clears the module OCP socket ENAWAKEUP bit to prevent the module
2123  * from sending wakeups to the PRCM.  Eventually this should clear
2124  * PRCM wakeup registers to cause the PRCM to ignore wakeup events
2125  * from the module.  Does not set any wakeup routing registers beyond
2126  * this point - if the module is to wake up any other module or
2127  * subsystem, that must be set separately.  Called by omap_device
2128  * code.  Returns -EINVAL on error or 0 upon success.
2129  */
2130 int omap_hwmod_disable_wakeup(struct omap_hwmod *oh)
2131 {
2132         unsigned long flags;
2133         u32 v;
2134
2135         if (!oh->class->sysc ||
2136             !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
2137                 return -EINVAL;
2138
2139         spin_lock_irqsave(&oh->_lock, flags);
2140         v = oh->_sysc_cache;
2141         _disable_wakeup(oh, &v);
2142         _write_sysconfig(v, oh);
2143         spin_unlock_irqrestore(&oh->_lock, flags);
2144
2145         return 0;
2146 }
2147
2148 /**
2149  * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
2150  * contained in the hwmod module.
2151  * @oh: struct omap_hwmod *
2152  * @name: name of the reset line to lookup and assert
2153  *
2154  * Some IP like dsp, ipu or iva contain processor that require
2155  * an HW reset line to be assert / deassert in order to enable fully
2156  * the IP.  Returns -EINVAL if @oh is null or if the operation is not
2157  * yet supported on this OMAP; otherwise, passes along the return value
2158  * from _assert_hardreset().
2159  */
2160 int omap_hwmod_assert_hardreset(struct omap_hwmod *oh, const char *name)
2161 {
2162         int ret;
2163         unsigned long flags;
2164
2165         if (!oh)
2166                 return -EINVAL;
2167
2168         spin_lock_irqsave(&oh->_lock, flags);
2169         ret = _assert_hardreset(oh, name);
2170         spin_unlock_irqrestore(&oh->_lock, flags);
2171
2172         return ret;
2173 }
2174
2175 /**
2176  * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
2177  * contained in the hwmod module.
2178  * @oh: struct omap_hwmod *
2179  * @name: name of the reset line to look up and deassert
2180  *
2181  * Some IP like dsp, ipu or iva contain processor that require
2182  * an HW reset line to be assert / deassert in order to enable fully
2183  * the IP.  Returns -EINVAL if @oh is null or if the operation is not
2184  * yet supported on this OMAP; otherwise, passes along the return value
2185  * from _deassert_hardreset().
2186  */
2187 int omap_hwmod_deassert_hardreset(struct omap_hwmod *oh, const char *name)
2188 {
2189         int ret;
2190         unsigned long flags;
2191
2192         if (!oh)
2193                 return -EINVAL;
2194
2195         spin_lock_irqsave(&oh->_lock, flags);
2196         ret = _deassert_hardreset(oh, name);
2197         spin_unlock_irqrestore(&oh->_lock, flags);
2198
2199         return ret;
2200 }
2201
2202 /**
2203  * omap_hwmod_read_hardreset - read the HW reset line state of submodules
2204  * contained in the hwmod module
2205  * @oh: struct omap_hwmod *
2206  * @name: name of the reset line to look up and read
2207  *
2208  * Return the current state of the hwmod @oh's reset line named @name:
2209  * returns -EINVAL upon parameter error or if this operation
2210  * is unsupported on the current OMAP; otherwise, passes along the return
2211  * value from _read_hardreset().
2212  */
2213 int omap_hwmod_read_hardreset(struct omap_hwmod *oh, const char *name)
2214 {
2215         int ret;
2216         unsigned long flags;
2217
2218         if (!oh)
2219                 return -EINVAL;
2220
2221         spin_lock_irqsave(&oh->_lock, flags);
2222         ret = _read_hardreset(oh, name);
2223         spin_unlock_irqrestore(&oh->_lock, flags);
2224
2225         return ret;
2226 }
2227
2228
2229 /**
2230  * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
2231  * @classname: struct omap_hwmod_class name to search for
2232  * @fn: callback function pointer to call for each hwmod in class @classname
2233  * @user: arbitrary context data to pass to the callback function
2234  *
2235  * For each omap_hwmod of class @classname, call @fn.
2236  * If the callback function returns something other than
2237  * zero, the iterator is terminated, and the callback function's return
2238  * value is passed back to the caller.  Returns 0 upon success, -EINVAL
2239  * if @classname or @fn are NULL, or passes back the error code from @fn.
2240  */
2241 int omap_hwmod_for_each_by_class(const char *classname,
2242                                  int (*fn)(struct omap_hwmod *oh,
2243                                            void *user),
2244                                  void *user)
2245 {
2246         struct omap_hwmod *temp_oh;
2247         int ret = 0;
2248
2249         if (!classname || !fn)
2250                 return -EINVAL;
2251
2252         pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
2253                  __func__, classname);
2254
2255         list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
2256                 if (!strcmp(temp_oh->class->name, classname)) {
2257                         pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
2258                                  __func__, temp_oh->name);
2259                         ret = (*fn)(temp_oh, user);
2260                         if (ret)
2261                                 break;
2262                 }
2263         }
2264
2265         if (ret)
2266                 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
2267                          __func__, ret);
2268
2269         return ret;
2270 }
2271
2272 /**
2273  * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
2274  * @oh: struct omap_hwmod *
2275  * @state: state that _setup() should leave the hwmod in
2276  *
2277  * Sets the hwmod state that @oh will enter at the end of _setup()
2278  * (called by omap_hwmod_setup_*()).  Only valid to call between
2279  * calling omap_hwmod_register() and omap_hwmod_setup_*().  Returns
2280  * 0 upon success or -EINVAL if there is a problem with the arguments
2281  * or if the hwmod is in the wrong state.
2282  */
2283 int omap_hwmod_set_postsetup_state(struct omap_hwmod *oh, u8 state)
2284 {
2285         int ret;
2286         unsigned long flags;
2287
2288         if (!oh)
2289                 return -EINVAL;
2290
2291         if (state != _HWMOD_STATE_DISABLED &&
2292             state != _HWMOD_STATE_ENABLED &&
2293             state != _HWMOD_STATE_IDLE)
2294                 return -EINVAL;
2295
2296         spin_lock_irqsave(&oh->_lock, flags);
2297
2298         if (oh->_state != _HWMOD_STATE_REGISTERED) {
2299                 ret = -EINVAL;
2300                 goto ohsps_unlock;
2301         }
2302
2303         oh->_postsetup_state = state;
2304         ret = 0;
2305
2306 ohsps_unlock:
2307         spin_unlock_irqrestore(&oh->_lock, flags);
2308
2309         return ret;
2310 }
2311
2312 /**
2313  * omap_hwmod_get_context_loss_count - get lost context count
2314  * @oh: struct omap_hwmod *
2315  *
2316  * Query the powerdomain of of @oh to get the context loss
2317  * count for this device.
2318  *
2319  * Returns the context loss count of the powerdomain assocated with @oh
2320  * upon success, or zero if no powerdomain exists for @oh.
2321  */
2322 u32 omap_hwmod_get_context_loss_count(struct omap_hwmod *oh)
2323 {
2324         struct powerdomain *pwrdm;
2325         int ret = 0;
2326
2327         pwrdm = omap_hwmod_get_pwrdm(oh);
2328         if (pwrdm)
2329                 ret = pwrdm_get_context_loss_count(pwrdm);
2330
2331         return ret;
2332 }
2333
2334 /**
2335  * omap_hwmod_no_setup_reset - prevent a hwmod from being reset upon setup
2336  * @oh: struct omap_hwmod *
2337  *
2338  * Prevent the hwmod @oh from being reset during the setup process.
2339  * Intended for use by board-*.c files on boards with devices that
2340  * cannot tolerate being reset.  Must be called before the hwmod has
2341  * been set up.  Returns 0 upon success or negative error code upon
2342  * failure.
2343  */
2344 int omap_hwmod_no_setup_reset(struct omap_hwmod *oh)
2345 {
2346         if (!oh)
2347                 return -EINVAL;
2348
2349         if (oh->_state != _HWMOD_STATE_REGISTERED) {
2350                 pr_err("omap_hwmod: %s: cannot prevent setup reset; in wrong state\n",
2351                         oh->name);
2352                 return -EINVAL;
2353         }
2354
2355         oh->flags |= HWMOD_INIT_NO_RESET;
2356
2357         return 0;
2358 }