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