]> git.karo-electronics.de Git - karo-tx-linux.git/blob - arch/arm/mach-omap2/omap_hwmod.c
Merge branch 'for-john' of git://git.kernel.org/pub/scm/linux/kernel/git/iwlwifi...
[karo-tx-linux.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-2012 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-provider.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 #include <linux/slab.h>
140 #include <linux/bootmem.h>
141
142 #include <asm/system_misc.h>
143
144 #include "clock.h"
145 #include "omap_hwmod.h"
146
147 #include "soc.h"
148 #include "common.h"
149 #include "clockdomain.h"
150 #include "powerdomain.h"
151 #include "cm2xxx.h"
152 #include "cm3xxx.h"
153 #include "cminst44xx.h"
154 #include "cm33xx.h"
155 #include "prm.h"
156 #include "prm3xxx.h"
157 #include "prm44xx.h"
158 #include "prm33xx.h"
159 #include "prminst44xx.h"
160 #include "mux.h"
161 #include "pm.h"
162
163 /* Name of the OMAP hwmod for the MPU */
164 #define MPU_INITIATOR_NAME              "mpu"
165
166 /*
167  * Number of struct omap_hwmod_link records per struct
168  * omap_hwmod_ocp_if record (master->slave and slave->master)
169  */
170 #define LINKS_PER_OCP_IF                2
171
172 /**
173  * struct omap_hwmod_soc_ops - fn ptrs for some SoC-specific operations
174  * @enable_module: function to enable a module (via MODULEMODE)
175  * @disable_module: function to disable a module (via MODULEMODE)
176  *
177  * XXX Eventually this functionality will be hidden inside the PRM/CM
178  * device drivers.  Until then, this should avoid huge blocks of cpu_is_*()
179  * conditionals in this code.
180  */
181 struct omap_hwmod_soc_ops {
182         void (*enable_module)(struct omap_hwmod *oh);
183         int (*disable_module)(struct omap_hwmod *oh);
184         int (*wait_target_ready)(struct omap_hwmod *oh);
185         int (*assert_hardreset)(struct omap_hwmod *oh,
186                                 struct omap_hwmod_rst_info *ohri);
187         int (*deassert_hardreset)(struct omap_hwmod *oh,
188                                   struct omap_hwmod_rst_info *ohri);
189         int (*is_hardreset_asserted)(struct omap_hwmod *oh,
190                                      struct omap_hwmod_rst_info *ohri);
191         int (*init_clkdm)(struct omap_hwmod *oh);
192         void (*update_context_lost)(struct omap_hwmod *oh);
193         int (*get_context_lost)(struct omap_hwmod *oh);
194 };
195
196 /* soc_ops: adapts the omap_hwmod code to the currently-booted SoC */
197 static struct omap_hwmod_soc_ops soc_ops;
198
199 /* omap_hwmod_list contains all registered struct omap_hwmods */
200 static LIST_HEAD(omap_hwmod_list);
201
202 /* mpu_oh: used to add/remove MPU initiator from sleepdep list */
203 static struct omap_hwmod *mpu_oh;
204
205 /* io_chain_lock: used to serialize reconfigurations of the I/O chain */
206 static DEFINE_SPINLOCK(io_chain_lock);
207
208 /*
209  * linkspace: ptr to a buffer that struct omap_hwmod_link records are
210  * allocated from - used to reduce the number of small memory
211  * allocations, which has a significant impact on performance
212  */
213 static struct omap_hwmod_link *linkspace;
214
215 /*
216  * free_ls, max_ls: array indexes into linkspace; representing the
217  * next free struct omap_hwmod_link index, and the maximum number of
218  * struct omap_hwmod_link records allocated (respectively)
219  */
220 static unsigned short free_ls, max_ls, ls_supp;
221
222 /* inited: set to true once the hwmod code is initialized */
223 static bool inited;
224
225 /* Private functions */
226
227 /**
228  * _fetch_next_ocp_if - return the next OCP interface in a list
229  * @p: ptr to a ptr to the list_head inside the ocp_if to return
230  * @i: pointer to the index of the element pointed to by @p in the list
231  *
232  * Return a pointer to the struct omap_hwmod_ocp_if record
233  * containing the struct list_head pointed to by @p, and increment
234  * @p such that a future call to this routine will return the next
235  * record.
236  */
237 static struct omap_hwmod_ocp_if *_fetch_next_ocp_if(struct list_head **p,
238                                                     int *i)
239 {
240         struct omap_hwmod_ocp_if *oi;
241
242         oi = list_entry(*p, struct omap_hwmod_link, node)->ocp_if;
243         *p = (*p)->next;
244
245         *i = *i + 1;
246
247         return oi;
248 }
249
250 /**
251  * _update_sysc_cache - return the module OCP_SYSCONFIG register, keep copy
252  * @oh: struct omap_hwmod *
253  *
254  * Load the current value of the hwmod OCP_SYSCONFIG register into the
255  * struct omap_hwmod for later use.  Returns -EINVAL if the hwmod has no
256  * OCP_SYSCONFIG register or 0 upon success.
257  */
258 static int _update_sysc_cache(struct omap_hwmod *oh)
259 {
260         if (!oh->class->sysc) {
261                 WARN(1, "omap_hwmod: %s: cannot read OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
262                 return -EINVAL;
263         }
264
265         /* XXX ensure module interface clock is up */
266
267         oh->_sysc_cache = omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
268
269         if (!(oh->class->sysc->sysc_flags & SYSC_NO_CACHE))
270                 oh->_int_flags |= _HWMOD_SYSCONFIG_LOADED;
271
272         return 0;
273 }
274
275 /**
276  * _write_sysconfig - write a value to the module's OCP_SYSCONFIG register
277  * @v: OCP_SYSCONFIG value to write
278  * @oh: struct omap_hwmod *
279  *
280  * Write @v into the module class' OCP_SYSCONFIG register, if it has
281  * one.  No return value.
282  */
283 static void _write_sysconfig(u32 v, struct omap_hwmod *oh)
284 {
285         if (!oh->class->sysc) {
286                 WARN(1, "omap_hwmod: %s: cannot write OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
287                 return;
288         }
289
290         /* XXX ensure module interface clock is up */
291
292         /* Module might have lost context, always update cache and register */
293         oh->_sysc_cache = v;
294         omap_hwmod_write(v, oh, oh->class->sysc->sysc_offs);
295 }
296
297 /**
298  * _set_master_standbymode: set the OCP_SYSCONFIG MIDLEMODE field in @v
299  * @oh: struct omap_hwmod *
300  * @standbymode: MIDLEMODE field bits
301  * @v: pointer to register contents to modify
302  *
303  * Update the master standby mode bits in @v to be @standbymode for
304  * the @oh hwmod.  Does not write to the hardware.  Returns -EINVAL
305  * upon error or 0 upon success.
306  */
307 static int _set_master_standbymode(struct omap_hwmod *oh, u8 standbymode,
308                                    u32 *v)
309 {
310         u32 mstandby_mask;
311         u8 mstandby_shift;
312
313         if (!oh->class->sysc ||
314             !(oh->class->sysc->sysc_flags & SYSC_HAS_MIDLEMODE))
315                 return -EINVAL;
316
317         if (!oh->class->sysc->sysc_fields) {
318                 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
319                 return -EINVAL;
320         }
321
322         mstandby_shift = oh->class->sysc->sysc_fields->midle_shift;
323         mstandby_mask = (0x3 << mstandby_shift);
324
325         *v &= ~mstandby_mask;
326         *v |= __ffs(standbymode) << mstandby_shift;
327
328         return 0;
329 }
330
331 /**
332  * _set_slave_idlemode: set the OCP_SYSCONFIG SIDLEMODE field in @v
333  * @oh: struct omap_hwmod *
334  * @idlemode: SIDLEMODE field bits
335  * @v: pointer to register contents to modify
336  *
337  * Update the slave idle mode bits in @v to be @idlemode for the @oh
338  * hwmod.  Does not write to the hardware.  Returns -EINVAL upon error
339  * or 0 upon success.
340  */
341 static int _set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode, u32 *v)
342 {
343         u32 sidle_mask;
344         u8 sidle_shift;
345
346         if (!oh->class->sysc ||
347             !(oh->class->sysc->sysc_flags & SYSC_HAS_SIDLEMODE))
348                 return -EINVAL;
349
350         if (!oh->class->sysc->sysc_fields) {
351                 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
352                 return -EINVAL;
353         }
354
355         sidle_shift = oh->class->sysc->sysc_fields->sidle_shift;
356         sidle_mask = (0x3 << sidle_shift);
357
358         *v &= ~sidle_mask;
359         *v |= __ffs(idlemode) << sidle_shift;
360
361         return 0;
362 }
363
364 /**
365  * _set_clockactivity: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
366  * @oh: struct omap_hwmod *
367  * @clockact: CLOCKACTIVITY field bits
368  * @v: pointer to register contents to modify
369  *
370  * Update the clockactivity mode bits in @v to be @clockact for the
371  * @oh hwmod.  Used for additional powersaving on some modules.  Does
372  * not write to the hardware.  Returns -EINVAL upon error or 0 upon
373  * success.
374  */
375 static int _set_clockactivity(struct omap_hwmod *oh, u8 clockact, u32 *v)
376 {
377         u32 clkact_mask;
378         u8  clkact_shift;
379
380         if (!oh->class->sysc ||
381             !(oh->class->sysc->sysc_flags & SYSC_HAS_CLOCKACTIVITY))
382                 return -EINVAL;
383
384         if (!oh->class->sysc->sysc_fields) {
385                 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
386                 return -EINVAL;
387         }
388
389         clkact_shift = oh->class->sysc->sysc_fields->clkact_shift;
390         clkact_mask = (0x3 << clkact_shift);
391
392         *v &= ~clkact_mask;
393         *v |= clockact << clkact_shift;
394
395         return 0;
396 }
397
398 /**
399  * _set_softreset: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
400  * @oh: struct omap_hwmod *
401  * @v: pointer to register contents to modify
402  *
403  * Set the SOFTRESET bit in @v for hwmod @oh.  Returns -EINVAL upon
404  * error or 0 upon success.
405  */
406 static int _set_softreset(struct omap_hwmod *oh, u32 *v)
407 {
408         u32 softrst_mask;
409
410         if (!oh->class->sysc ||
411             !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
412                 return -EINVAL;
413
414         if (!oh->class->sysc->sysc_fields) {
415                 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
416                 return -EINVAL;
417         }
418
419         softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
420
421         *v |= softrst_mask;
422
423         return 0;
424 }
425
426 /**
427  * _wait_softreset_complete - wait for an OCP softreset to complete
428  * @oh: struct omap_hwmod * to wait on
429  *
430  * Wait until the IP block represented by @oh reports that its OCP
431  * softreset is complete.  This can be triggered by software (see
432  * _ocp_softreset()) or by hardware upon returning from off-mode (one
433  * example is HSMMC).  Waits for up to MAX_MODULE_SOFTRESET_WAIT
434  * microseconds.  Returns the number of microseconds waited.
435  */
436 static int _wait_softreset_complete(struct omap_hwmod *oh)
437 {
438         struct omap_hwmod_class_sysconfig *sysc;
439         u32 softrst_mask;
440         int c = 0;
441
442         sysc = oh->class->sysc;
443
444         if (sysc->sysc_flags & SYSS_HAS_RESET_STATUS)
445                 omap_test_timeout((omap_hwmod_read(oh, sysc->syss_offs)
446                                    & SYSS_RESETDONE_MASK),
447                                   MAX_MODULE_SOFTRESET_WAIT, c);
448         else if (sysc->sysc_flags & SYSC_HAS_RESET_STATUS) {
449                 softrst_mask = (0x1 << sysc->sysc_fields->srst_shift);
450                 omap_test_timeout(!(omap_hwmod_read(oh, sysc->sysc_offs)
451                                     & softrst_mask),
452                                   MAX_MODULE_SOFTRESET_WAIT, c);
453         }
454
455         return c;
456 }
457
458 /**
459  * _set_dmadisable: set OCP_SYSCONFIG.DMADISABLE bit in @v
460  * @oh: struct omap_hwmod *
461  *
462  * The DMADISABLE bit is a semi-automatic bit present in sysconfig register
463  * of some modules. When the DMA must perform read/write accesses, the
464  * DMADISABLE bit is cleared by the hardware. But when the DMA must stop
465  * for power management, software must set the DMADISABLE bit back to 1.
466  *
467  * Set the DMADISABLE bit in @v for hwmod @oh.  Returns -EINVAL upon
468  * error or 0 upon success.
469  */
470 static int _set_dmadisable(struct omap_hwmod *oh)
471 {
472         u32 v;
473         u32 dmadisable_mask;
474
475         if (!oh->class->sysc ||
476             !(oh->class->sysc->sysc_flags & SYSC_HAS_DMADISABLE))
477                 return -EINVAL;
478
479         if (!oh->class->sysc->sysc_fields) {
480                 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
481                 return -EINVAL;
482         }
483
484         /* clocks must be on for this operation */
485         if (oh->_state != _HWMOD_STATE_ENABLED) {
486                 pr_warn("omap_hwmod: %s: dma can be disabled only from enabled state\n", oh->name);
487                 return -EINVAL;
488         }
489
490         pr_debug("omap_hwmod: %s: setting DMADISABLE\n", oh->name);
491
492         v = oh->_sysc_cache;
493         dmadisable_mask =
494                 (0x1 << oh->class->sysc->sysc_fields->dmadisable_shift);
495         v |= dmadisable_mask;
496         _write_sysconfig(v, oh);
497
498         return 0;
499 }
500
501 /**
502  * _set_module_autoidle: set the OCP_SYSCONFIG AUTOIDLE field in @v
503  * @oh: struct omap_hwmod *
504  * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
505  * @v: pointer to register contents to modify
506  *
507  * Update the module autoidle bit in @v to be @autoidle for the @oh
508  * hwmod.  The autoidle bit controls whether the module can gate
509  * internal clocks automatically when it isn't doing anything; the
510  * exact function of this bit varies on a per-module basis.  This
511  * function does not write to the hardware.  Returns -EINVAL upon
512  * error or 0 upon success.
513  */
514 static int _set_module_autoidle(struct omap_hwmod *oh, u8 autoidle,
515                                 u32 *v)
516 {
517         u32 autoidle_mask;
518         u8 autoidle_shift;
519
520         if (!oh->class->sysc ||
521             !(oh->class->sysc->sysc_flags & SYSC_HAS_AUTOIDLE))
522                 return -EINVAL;
523
524         if (!oh->class->sysc->sysc_fields) {
525                 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
526                 return -EINVAL;
527         }
528
529         autoidle_shift = oh->class->sysc->sysc_fields->autoidle_shift;
530         autoidle_mask = (0x1 << autoidle_shift);
531
532         *v &= ~autoidle_mask;
533         *v |= autoidle << autoidle_shift;
534
535         return 0;
536 }
537
538 /**
539  * _set_idle_ioring_wakeup - enable/disable IO pad wakeup on hwmod idle for mux
540  * @oh: struct omap_hwmod *
541  * @set_wake: bool value indicating to set (true) or clear (false) wakeup enable
542  *
543  * Set or clear the I/O pad wakeup flag in the mux entries for the
544  * hwmod @oh.  This function changes the @oh->mux->pads_dynamic array
545  * in memory.  If the hwmod is currently idled, and the new idle
546  * values don't match the previous ones, this function will also
547  * update the SCM PADCTRL registers.  Otherwise, if the hwmod is not
548  * currently idled, this function won't touch the hardware: the new
549  * mux settings are written to the SCM PADCTRL registers when the
550  * hwmod is idled.  No return value.
551  */
552 static void _set_idle_ioring_wakeup(struct omap_hwmod *oh, bool set_wake)
553 {
554         struct omap_device_pad *pad;
555         bool change = false;
556         u16 prev_idle;
557         int j;
558
559         if (!oh->mux || !oh->mux->enabled)
560                 return;
561
562         for (j = 0; j < oh->mux->nr_pads_dynamic; j++) {
563                 pad = oh->mux->pads_dynamic[j];
564
565                 if (!(pad->flags & OMAP_DEVICE_PAD_WAKEUP))
566                         continue;
567
568                 prev_idle = pad->idle;
569
570                 if (set_wake)
571                         pad->idle |= OMAP_WAKEUP_EN;
572                 else
573                         pad->idle &= ~OMAP_WAKEUP_EN;
574
575                 if (prev_idle != pad->idle)
576                         change = true;
577         }
578
579         if (change && oh->_state == _HWMOD_STATE_IDLE)
580                 omap_hwmod_mux(oh->mux, _HWMOD_STATE_IDLE);
581 }
582
583 /**
584  * _enable_wakeup: set OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
585  * @oh: struct omap_hwmod *
586  *
587  * Allow the hardware module @oh to send wakeups.  Returns -EINVAL
588  * upon error or 0 upon success.
589  */
590 static int _enable_wakeup(struct omap_hwmod *oh, u32 *v)
591 {
592         if (!oh->class->sysc ||
593             !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
594               (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
595               (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
596                 return -EINVAL;
597
598         if (!oh->class->sysc->sysc_fields) {
599                 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
600                 return -EINVAL;
601         }
602
603         if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
604                 *v |= 0x1 << oh->class->sysc->sysc_fields->enwkup_shift;
605
606         if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
607                 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
608         if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
609                 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
610
611         /* XXX test pwrdm_get_wken for this hwmod's subsystem */
612
613         oh->_int_flags |= _HWMOD_WAKEUP_ENABLED;
614
615         return 0;
616 }
617
618 /**
619  * _disable_wakeup: clear OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
620  * @oh: struct omap_hwmod *
621  *
622  * Prevent the hardware module @oh to send wakeups.  Returns -EINVAL
623  * upon error or 0 upon success.
624  */
625 static int _disable_wakeup(struct omap_hwmod *oh, u32 *v)
626 {
627         if (!oh->class->sysc ||
628             !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
629               (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
630               (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
631                 return -EINVAL;
632
633         if (!oh->class->sysc->sysc_fields) {
634                 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
635                 return -EINVAL;
636         }
637
638         if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
639                 *v &= ~(0x1 << oh->class->sysc->sysc_fields->enwkup_shift);
640
641         if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
642                 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART, v);
643         if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
644                 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART, v);
645
646         /* XXX test pwrdm_get_wken for this hwmod's subsystem */
647
648         oh->_int_flags &= ~_HWMOD_WAKEUP_ENABLED;
649
650         return 0;
651 }
652
653 static struct clockdomain *_get_clkdm(struct omap_hwmod *oh)
654 {
655         struct clk_hw_omap *clk;
656
657         if (oh->clkdm) {
658                 return oh->clkdm;
659         } else if (oh->_clk) {
660                 clk = to_clk_hw_omap(__clk_get_hw(oh->_clk));
661                 return  clk->clkdm;
662         }
663         return NULL;
664 }
665
666 /**
667  * _add_initiator_dep: prevent @oh from smart-idling while @init_oh is active
668  * @oh: struct omap_hwmod *
669  *
670  * Prevent the hardware module @oh from entering idle while the
671  * hardare module initiator @init_oh is active.  Useful when a module
672  * will be accessed by a particular initiator (e.g., if a module will
673  * be accessed by the IVA, there should be a sleepdep between the IVA
674  * initiator and the module).  Only applies to modules in smart-idle
675  * mode.  If the clockdomain is marked as not needing autodeps, return
676  * 0 without doing anything.  Otherwise, returns -EINVAL upon error or
677  * passes along clkdm_add_sleepdep() value upon success.
678  */
679 static int _add_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
680 {
681         struct clockdomain *clkdm, *init_clkdm;
682
683         clkdm = _get_clkdm(oh);
684         init_clkdm = _get_clkdm(init_oh);
685
686         if (!clkdm || !init_clkdm)
687                 return -EINVAL;
688
689         if (clkdm && clkdm->flags & CLKDM_NO_AUTODEPS)
690                 return 0;
691
692         return clkdm_add_sleepdep(clkdm, init_clkdm);
693 }
694
695 /**
696  * _del_initiator_dep: allow @oh to smart-idle even if @init_oh is active
697  * @oh: struct omap_hwmod *
698  *
699  * Allow the hardware module @oh to enter idle while the hardare
700  * module initiator @init_oh is active.  Useful when a module will not
701  * be accessed by a particular initiator (e.g., if a module will not
702  * be accessed by the IVA, there should be no sleepdep between the IVA
703  * initiator and the module).  Only applies to modules in smart-idle
704  * mode.  If the clockdomain is marked as not needing autodeps, return
705  * 0 without doing anything.  Returns -EINVAL upon error or passes
706  * along clkdm_del_sleepdep() value upon success.
707  */
708 static int _del_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
709 {
710         struct clockdomain *clkdm, *init_clkdm;
711
712         clkdm = _get_clkdm(oh);
713         init_clkdm = _get_clkdm(init_oh);
714
715         if (!clkdm || !init_clkdm)
716                 return -EINVAL;
717
718         if (clkdm && clkdm->flags & CLKDM_NO_AUTODEPS)
719                 return 0;
720
721         return clkdm_del_sleepdep(clkdm, init_clkdm);
722 }
723
724 /**
725  * _init_main_clk - get a struct clk * for the the hwmod's main functional clk
726  * @oh: struct omap_hwmod *
727  *
728  * Called from _init_clocks().  Populates the @oh _clk (main
729  * functional clock pointer) if a main_clk is present.  Returns 0 on
730  * success or -EINVAL on error.
731  */
732 static int _init_main_clk(struct omap_hwmod *oh)
733 {
734         int ret = 0;
735
736         if (!oh->main_clk)
737                 return 0;
738
739         oh->_clk = clk_get(NULL, oh->main_clk);
740         if (IS_ERR(oh->_clk)) {
741                 pr_warning("omap_hwmod: %s: cannot clk_get main_clk %s\n",
742                            oh->name, oh->main_clk);
743                 return -EINVAL;
744         }
745         /*
746          * HACK: This needs a re-visit once clk_prepare() is implemented
747          * to do something meaningful. Today its just a no-op.
748          * If clk_prepare() is used at some point to do things like
749          * voltage scaling etc, then this would have to be moved to
750          * some point where subsystems like i2c and pmic become
751          * available.
752          */
753         clk_prepare(oh->_clk);
754
755         if (!_get_clkdm(oh))
756                 pr_debug("omap_hwmod: %s: missing clockdomain for %s.\n",
757                            oh->name, oh->main_clk);
758
759         return ret;
760 }
761
762 /**
763  * _init_interface_clks - get a struct clk * for the the hwmod's interface clks
764  * @oh: struct omap_hwmod *
765  *
766  * Called from _init_clocks().  Populates the @oh OCP slave interface
767  * clock pointers.  Returns 0 on success or -EINVAL on error.
768  */
769 static int _init_interface_clks(struct omap_hwmod *oh)
770 {
771         struct omap_hwmod_ocp_if *os;
772         struct list_head *p;
773         struct clk *c;
774         int i = 0;
775         int ret = 0;
776
777         p = oh->slave_ports.next;
778
779         while (i < oh->slaves_cnt) {
780                 os = _fetch_next_ocp_if(&p, &i);
781                 if (!os->clk)
782                         continue;
783
784                 c = clk_get(NULL, os->clk);
785                 if (IS_ERR(c)) {
786                         pr_warning("omap_hwmod: %s: cannot clk_get interface_clk %s\n",
787                                    oh->name, os->clk);
788                         ret = -EINVAL;
789                 }
790                 os->_clk = c;
791                 /*
792                  * HACK: This needs a re-visit once clk_prepare() is implemented
793                  * to do something meaningful. Today its just a no-op.
794                  * If clk_prepare() is used at some point to do things like
795                  * voltage scaling etc, then this would have to be moved to
796                  * some point where subsystems like i2c and pmic become
797                  * available.
798                  */
799                 clk_prepare(os->_clk);
800         }
801
802         return ret;
803 }
804
805 /**
806  * _init_opt_clk - get a struct clk * for the the hwmod's optional clocks
807  * @oh: struct omap_hwmod *
808  *
809  * Called from _init_clocks().  Populates the @oh omap_hwmod_opt_clk
810  * clock pointers.  Returns 0 on success or -EINVAL on error.
811  */
812 static int _init_opt_clks(struct omap_hwmod *oh)
813 {
814         struct omap_hwmod_opt_clk *oc;
815         struct clk *c;
816         int i;
817         int ret = 0;
818
819         for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++) {
820                 c = clk_get(NULL, oc->clk);
821                 if (IS_ERR(c)) {
822                         pr_warning("omap_hwmod: %s: cannot clk_get opt_clk %s\n",
823                                    oh->name, oc->clk);
824                         ret = -EINVAL;
825                 }
826                 oc->_clk = c;
827                 /*
828                  * HACK: This needs a re-visit once clk_prepare() is implemented
829                  * to do something meaningful. Today its just a no-op.
830                  * If clk_prepare() is used at some point to do things like
831                  * voltage scaling etc, then this would have to be moved to
832                  * some point where subsystems like i2c and pmic become
833                  * available.
834                  */
835                 clk_prepare(oc->_clk);
836         }
837
838         return ret;
839 }
840
841 /**
842  * _enable_clocks - enable hwmod main clock and interface clocks
843  * @oh: struct omap_hwmod *
844  *
845  * Enables all clocks necessary for register reads and writes to succeed
846  * on the hwmod @oh.  Returns 0.
847  */
848 static int _enable_clocks(struct omap_hwmod *oh)
849 {
850         struct omap_hwmod_ocp_if *os;
851         struct list_head *p;
852         int i = 0;
853
854         pr_debug("omap_hwmod: %s: enabling clocks\n", oh->name);
855
856         if (oh->_clk)
857                 clk_enable(oh->_clk);
858
859         p = oh->slave_ports.next;
860
861         while (i < oh->slaves_cnt) {
862                 os = _fetch_next_ocp_if(&p, &i);
863
864                 if (os->_clk && (os->flags & OCPIF_SWSUP_IDLE))
865                         clk_enable(os->_clk);
866         }
867
868         /* The opt clocks are controlled by the device driver. */
869
870         return 0;
871 }
872
873 /**
874  * _disable_clocks - disable hwmod main clock and interface clocks
875  * @oh: struct omap_hwmod *
876  *
877  * Disables the hwmod @oh main functional and interface clocks.  Returns 0.
878  */
879 static int _disable_clocks(struct omap_hwmod *oh)
880 {
881         struct omap_hwmod_ocp_if *os;
882         struct list_head *p;
883         int i = 0;
884
885         pr_debug("omap_hwmod: %s: disabling clocks\n", oh->name);
886
887         if (oh->_clk)
888                 clk_disable(oh->_clk);
889
890         p = oh->slave_ports.next;
891
892         while (i < oh->slaves_cnt) {
893                 os = _fetch_next_ocp_if(&p, &i);
894
895                 if (os->_clk && (os->flags & OCPIF_SWSUP_IDLE))
896                         clk_disable(os->_clk);
897         }
898
899         /* The opt clocks are controlled by the device driver. */
900
901         return 0;
902 }
903
904 static void _enable_optional_clocks(struct omap_hwmod *oh)
905 {
906         struct omap_hwmod_opt_clk *oc;
907         int i;
908
909         pr_debug("omap_hwmod: %s: enabling optional clocks\n", oh->name);
910
911         for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
912                 if (oc->_clk) {
913                         pr_debug("omap_hwmod: enable %s:%s\n", oc->role,
914                                  __clk_get_name(oc->_clk));
915                         clk_enable(oc->_clk);
916                 }
917 }
918
919 static void _disable_optional_clocks(struct omap_hwmod *oh)
920 {
921         struct omap_hwmod_opt_clk *oc;
922         int i;
923
924         pr_debug("omap_hwmod: %s: disabling optional clocks\n", oh->name);
925
926         for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
927                 if (oc->_clk) {
928                         pr_debug("omap_hwmod: disable %s:%s\n", oc->role,
929                                  __clk_get_name(oc->_clk));
930                         clk_disable(oc->_clk);
931                 }
932 }
933
934 /**
935  * _omap4_enable_module - enable CLKCTRL modulemode on OMAP4
936  * @oh: struct omap_hwmod *
937  *
938  * Enables the PRCM module mode related to the hwmod @oh.
939  * No return value.
940  */
941 static void _omap4_enable_module(struct omap_hwmod *oh)
942 {
943         if (!oh->clkdm || !oh->prcm.omap4.modulemode)
944                 return;
945
946         pr_debug("omap_hwmod: %s: %s: %d\n",
947                  oh->name, __func__, oh->prcm.omap4.modulemode);
948
949         omap4_cminst_module_enable(oh->prcm.omap4.modulemode,
950                                    oh->clkdm->prcm_partition,
951                                    oh->clkdm->cm_inst,
952                                    oh->clkdm->clkdm_offs,
953                                    oh->prcm.omap4.clkctrl_offs);
954 }
955
956 /**
957  * _am33xx_enable_module - enable CLKCTRL modulemode on AM33XX
958  * @oh: struct omap_hwmod *
959  *
960  * Enables the PRCM module mode related to the hwmod @oh.
961  * No return value.
962  */
963 static void _am33xx_enable_module(struct omap_hwmod *oh)
964 {
965         if (!oh->clkdm || !oh->prcm.omap4.modulemode)
966                 return;
967
968         pr_debug("omap_hwmod: %s: %s: %d\n",
969                  oh->name, __func__, oh->prcm.omap4.modulemode);
970
971         am33xx_cm_module_enable(oh->prcm.omap4.modulemode, oh->clkdm->cm_inst,
972                                 oh->clkdm->clkdm_offs,
973                                 oh->prcm.omap4.clkctrl_offs);
974 }
975
976 /**
977  * _omap4_wait_target_disable - wait for a module to be disabled on OMAP4
978  * @oh: struct omap_hwmod *
979  *
980  * Wait for a module @oh to enter slave idle.  Returns 0 if the module
981  * does not have an IDLEST bit or if the module successfully enters
982  * slave idle; otherwise, pass along the return value of the
983  * appropriate *_cm*_wait_module_idle() function.
984  */
985 static int _omap4_wait_target_disable(struct omap_hwmod *oh)
986 {
987         if (!oh)
988                 return -EINVAL;
989
990         if (oh->_int_flags & _HWMOD_NO_MPU_PORT || !oh->clkdm)
991                 return 0;
992
993         if (oh->flags & HWMOD_NO_IDLEST)
994                 return 0;
995
996         return omap4_cminst_wait_module_idle(oh->clkdm->prcm_partition,
997                                              oh->clkdm->cm_inst,
998                                              oh->clkdm->clkdm_offs,
999                                              oh->prcm.omap4.clkctrl_offs);
1000 }
1001
1002 /**
1003  * _am33xx_wait_target_disable - wait for a module to be disabled on AM33XX
1004  * @oh: struct omap_hwmod *
1005  *
1006  * Wait for a module @oh to enter slave idle.  Returns 0 if the module
1007  * does not have an IDLEST bit or if the module successfully enters
1008  * slave idle; otherwise, pass along the return value of the
1009  * appropriate *_cm*_wait_module_idle() function.
1010  */
1011 static int _am33xx_wait_target_disable(struct omap_hwmod *oh)
1012 {
1013         if (!oh)
1014                 return -EINVAL;
1015
1016         if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
1017                 return 0;
1018
1019         if (oh->flags & HWMOD_NO_IDLEST)
1020                 return 0;
1021
1022         return am33xx_cm_wait_module_idle(oh->clkdm->cm_inst,
1023                                              oh->clkdm->clkdm_offs,
1024                                              oh->prcm.omap4.clkctrl_offs);
1025 }
1026
1027 /**
1028  * _count_mpu_irqs - count the number of MPU IRQ lines associated with @oh
1029  * @oh: struct omap_hwmod *oh
1030  *
1031  * Count and return the number of MPU IRQs associated with the hwmod
1032  * @oh.  Used to allocate struct resource data.  Returns 0 if @oh is
1033  * NULL.
1034  */
1035 static int _count_mpu_irqs(struct omap_hwmod *oh)
1036 {
1037         struct omap_hwmod_irq_info *ohii;
1038         int i = 0;
1039
1040         if (!oh || !oh->mpu_irqs)
1041                 return 0;
1042
1043         do {
1044                 ohii = &oh->mpu_irqs[i++];
1045         } while (ohii->irq != -1);
1046
1047         return i-1;
1048 }
1049
1050 /**
1051  * _count_sdma_reqs - count the number of SDMA request lines associated with @oh
1052  * @oh: struct omap_hwmod *oh
1053  *
1054  * Count and return the number of SDMA request lines associated with
1055  * the hwmod @oh.  Used to allocate struct resource data.  Returns 0
1056  * if @oh is NULL.
1057  */
1058 static int _count_sdma_reqs(struct omap_hwmod *oh)
1059 {
1060         struct omap_hwmod_dma_info *ohdi;
1061         int i = 0;
1062
1063         if (!oh || !oh->sdma_reqs)
1064                 return 0;
1065
1066         do {
1067                 ohdi = &oh->sdma_reqs[i++];
1068         } while (ohdi->dma_req != -1);
1069
1070         return i-1;
1071 }
1072
1073 /**
1074  * _count_ocp_if_addr_spaces - count the number of address space entries for @oh
1075  * @oh: struct omap_hwmod *oh
1076  *
1077  * Count and return the number of address space ranges associated with
1078  * the hwmod @oh.  Used to allocate struct resource data.  Returns 0
1079  * if @oh is NULL.
1080  */
1081 static int _count_ocp_if_addr_spaces(struct omap_hwmod_ocp_if *os)
1082 {
1083         struct omap_hwmod_addr_space *mem;
1084         int i = 0;
1085
1086         if (!os || !os->addr)
1087                 return 0;
1088
1089         do {
1090                 mem = &os->addr[i++];
1091         } while (mem->pa_start != mem->pa_end);
1092
1093         return i-1;
1094 }
1095
1096 /**
1097  * _get_mpu_irq_by_name - fetch MPU interrupt line number by name
1098  * @oh: struct omap_hwmod * to operate on
1099  * @name: pointer to the name of the MPU interrupt number to fetch (optional)
1100  * @irq: pointer to an unsigned int to store the MPU IRQ number to
1101  *
1102  * Retrieve a MPU hardware IRQ line number named by @name associated
1103  * with the IP block pointed to by @oh.  The IRQ number will be filled
1104  * into the address pointed to by @dma.  When @name is non-null, the
1105  * IRQ line number associated with the named entry will be returned.
1106  * If @name is null, the first matching entry will be returned.  Data
1107  * order is not meaningful in hwmod data, so callers are strongly
1108  * encouraged to use a non-null @name whenever possible to avoid
1109  * unpredictable effects if hwmod data is later added that causes data
1110  * ordering to change.  Returns 0 upon success or a negative error
1111  * code upon error.
1112  */
1113 static int _get_mpu_irq_by_name(struct omap_hwmod *oh, const char *name,
1114                                 unsigned int *irq)
1115 {
1116         int i;
1117         bool found = false;
1118
1119         if (!oh->mpu_irqs)
1120                 return -ENOENT;
1121
1122         i = 0;
1123         while (oh->mpu_irqs[i].irq != -1) {
1124                 if (name == oh->mpu_irqs[i].name ||
1125                     !strcmp(name, oh->mpu_irqs[i].name)) {
1126                         found = true;
1127                         break;
1128                 }
1129                 i++;
1130         }
1131
1132         if (!found)
1133                 return -ENOENT;
1134
1135         *irq = oh->mpu_irqs[i].irq;
1136
1137         return 0;
1138 }
1139
1140 /**
1141  * _get_sdma_req_by_name - fetch SDMA request line ID by name
1142  * @oh: struct omap_hwmod * to operate on
1143  * @name: pointer to the name of the SDMA request line to fetch (optional)
1144  * @dma: pointer to an unsigned int to store the request line ID to
1145  *
1146  * Retrieve an SDMA request line ID named by @name on the IP block
1147  * pointed to by @oh.  The ID will be filled into the address pointed
1148  * to by @dma.  When @name is non-null, the request line ID associated
1149  * with the named entry will be returned.  If @name is null, the first
1150  * matching entry will be returned.  Data order is not meaningful in
1151  * hwmod data, so callers are strongly encouraged to use a non-null
1152  * @name whenever possible to avoid unpredictable effects if hwmod
1153  * data is later added that causes data ordering to change.  Returns 0
1154  * upon success or a negative error code upon error.
1155  */
1156 static int _get_sdma_req_by_name(struct omap_hwmod *oh, const char *name,
1157                                  unsigned int *dma)
1158 {
1159         int i;
1160         bool found = false;
1161
1162         if (!oh->sdma_reqs)
1163                 return -ENOENT;
1164
1165         i = 0;
1166         while (oh->sdma_reqs[i].dma_req != -1) {
1167                 if (name == oh->sdma_reqs[i].name ||
1168                     !strcmp(name, oh->sdma_reqs[i].name)) {
1169                         found = true;
1170                         break;
1171                 }
1172                 i++;
1173         }
1174
1175         if (!found)
1176                 return -ENOENT;
1177
1178         *dma = oh->sdma_reqs[i].dma_req;
1179
1180         return 0;
1181 }
1182
1183 /**
1184  * _get_addr_space_by_name - fetch address space start & end by name
1185  * @oh: struct omap_hwmod * to operate on
1186  * @name: pointer to the name of the address space to fetch (optional)
1187  * @pa_start: pointer to a u32 to store the starting address to
1188  * @pa_end: pointer to a u32 to store the ending address to
1189  *
1190  * Retrieve address space start and end addresses for the IP block
1191  * pointed to by @oh.  The data will be filled into the addresses
1192  * pointed to by @pa_start and @pa_end.  When @name is non-null, the
1193  * address space data associated with the named entry will be
1194  * returned.  If @name is null, the first matching entry will be
1195  * returned.  Data order is not meaningful in hwmod data, so callers
1196  * are strongly encouraged to use a non-null @name whenever possible
1197  * to avoid unpredictable effects if hwmod data is later added that
1198  * causes data ordering to change.  Returns 0 upon success or a
1199  * negative error code upon error.
1200  */
1201 static int _get_addr_space_by_name(struct omap_hwmod *oh, const char *name,
1202                                    u32 *pa_start, u32 *pa_end)
1203 {
1204         int i, j;
1205         struct omap_hwmod_ocp_if *os;
1206         struct list_head *p = NULL;
1207         bool found = false;
1208
1209         p = oh->slave_ports.next;
1210
1211         i = 0;
1212         while (i < oh->slaves_cnt) {
1213                 os = _fetch_next_ocp_if(&p, &i);
1214
1215                 if (!os->addr)
1216                         return -ENOENT;
1217
1218                 j = 0;
1219                 while (os->addr[j].pa_start != os->addr[j].pa_end) {
1220                         if (name == os->addr[j].name ||
1221                             !strcmp(name, os->addr[j].name)) {
1222                                 found = true;
1223                                 break;
1224                         }
1225                         j++;
1226                 }
1227
1228                 if (found)
1229                         break;
1230         }
1231
1232         if (!found)
1233                 return -ENOENT;
1234
1235         *pa_start = os->addr[j].pa_start;
1236         *pa_end = os->addr[j].pa_end;
1237
1238         return 0;
1239 }
1240
1241 /**
1242  * _save_mpu_port_index - find and save the index to @oh's MPU port
1243  * @oh: struct omap_hwmod *
1244  *
1245  * Determines the array index of the OCP slave port that the MPU uses
1246  * to address the device, and saves it into the struct omap_hwmod.
1247  * Intended to be called during hwmod registration only. No return
1248  * value.
1249  */
1250 static void __init _save_mpu_port_index(struct omap_hwmod *oh)
1251 {
1252         struct omap_hwmod_ocp_if *os = NULL;
1253         struct list_head *p;
1254         int i = 0;
1255
1256         if (!oh)
1257                 return;
1258
1259         oh->_int_flags |= _HWMOD_NO_MPU_PORT;
1260
1261         p = oh->slave_ports.next;
1262
1263         while (i < oh->slaves_cnt) {
1264                 os = _fetch_next_ocp_if(&p, &i);
1265                 if (os->user & OCP_USER_MPU) {
1266                         oh->_mpu_port = os;
1267                         oh->_int_flags &= ~_HWMOD_NO_MPU_PORT;
1268                         break;
1269                 }
1270         }
1271
1272         return;
1273 }
1274
1275 /**
1276  * _find_mpu_rt_port - return omap_hwmod_ocp_if accessible by the MPU
1277  * @oh: struct omap_hwmod *
1278  *
1279  * Given a pointer to a struct omap_hwmod record @oh, return a pointer
1280  * to the struct omap_hwmod_ocp_if record that is used by the MPU to
1281  * communicate with the IP block.  This interface need not be directly
1282  * connected to the MPU (and almost certainly is not), but is directly
1283  * connected to the IP block represented by @oh.  Returns a pointer
1284  * to the struct omap_hwmod_ocp_if * upon success, or returns NULL upon
1285  * error or if there does not appear to be a path from the MPU to this
1286  * IP block.
1287  */
1288 static struct omap_hwmod_ocp_if *_find_mpu_rt_port(struct omap_hwmod *oh)
1289 {
1290         if (!oh || oh->_int_flags & _HWMOD_NO_MPU_PORT || oh->slaves_cnt == 0)
1291                 return NULL;
1292
1293         return oh->_mpu_port;
1294 };
1295
1296 /**
1297  * _find_mpu_rt_addr_space - return MPU register target address space for @oh
1298  * @oh: struct omap_hwmod *
1299  *
1300  * Returns a pointer to the struct omap_hwmod_addr_space record representing
1301  * the register target MPU address space; or returns NULL upon error.
1302  */
1303 static struct omap_hwmod_addr_space * __init _find_mpu_rt_addr_space(struct omap_hwmod *oh)
1304 {
1305         struct omap_hwmod_ocp_if *os;
1306         struct omap_hwmod_addr_space *mem;
1307         int found = 0, i = 0;
1308
1309         os = _find_mpu_rt_port(oh);
1310         if (!os || !os->addr)
1311                 return NULL;
1312
1313         do {
1314                 mem = &os->addr[i++];
1315                 if (mem->flags & ADDR_TYPE_RT)
1316                         found = 1;
1317         } while (!found && mem->pa_start != mem->pa_end);
1318
1319         return (found) ? mem : NULL;
1320 }
1321
1322 /**
1323  * _enable_sysc - try to bring a module out of idle via OCP_SYSCONFIG
1324  * @oh: struct omap_hwmod *
1325  *
1326  * Ensure that the OCP_SYSCONFIG register for the IP block represented
1327  * by @oh is set to indicate to the PRCM that the IP block is active.
1328  * Usually this means placing the module into smart-idle mode and
1329  * smart-standby, but if there is a bug in the automatic idle handling
1330  * for the IP block, it may need to be placed into the force-idle or
1331  * no-idle variants of these modes.  No return value.
1332  */
1333 static void _enable_sysc(struct omap_hwmod *oh)
1334 {
1335         u8 idlemode, sf;
1336         u32 v;
1337         bool clkdm_act;
1338         struct clockdomain *clkdm;
1339
1340         if (!oh->class->sysc)
1341                 return;
1342
1343         /*
1344          * Wait until reset has completed, this is needed as the IP
1345          * block is reset automatically by hardware in some cases
1346          * (off-mode for example), and the drivers require the
1347          * IP to be ready when they access it
1348          */
1349         if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1350                 _enable_optional_clocks(oh);
1351         _wait_softreset_complete(oh);
1352         if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1353                 _disable_optional_clocks(oh);
1354
1355         v = oh->_sysc_cache;
1356         sf = oh->class->sysc->sysc_flags;
1357
1358         clkdm = _get_clkdm(oh);
1359         if (sf & SYSC_HAS_SIDLEMODE) {
1360                 clkdm_act = (clkdm && clkdm->flags & CLKDM_ACTIVE_WITH_MPU);
1361                 if (clkdm_act && !(oh->class->sysc->idlemodes &
1362                                    (SIDLE_SMART | SIDLE_SMART_WKUP)))
1363                         idlemode = HWMOD_IDLEMODE_FORCE;
1364                 else
1365                         idlemode = (oh->flags & HWMOD_SWSUP_SIDLE) ?
1366                                 HWMOD_IDLEMODE_NO : HWMOD_IDLEMODE_SMART;
1367                 _set_slave_idlemode(oh, idlemode, &v);
1368         }
1369
1370         if (sf & SYSC_HAS_MIDLEMODE) {
1371                 if (oh->flags & HWMOD_SWSUP_MSTANDBY) {
1372                         idlemode = HWMOD_IDLEMODE_NO;
1373                 } else {
1374                         if (sf & SYSC_HAS_ENAWAKEUP)
1375                                 _enable_wakeup(oh, &v);
1376                         if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1377                                 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1378                         else
1379                                 idlemode = HWMOD_IDLEMODE_SMART;
1380                 }
1381                 _set_master_standbymode(oh, idlemode, &v);
1382         }
1383
1384         /*
1385          * XXX The clock framework should handle this, by
1386          * calling into this code.  But this must wait until the
1387          * clock structures are tagged with omap_hwmod entries
1388          */
1389         if ((oh->flags & HWMOD_SET_DEFAULT_CLOCKACT) &&
1390             (sf & SYSC_HAS_CLOCKACTIVITY))
1391                 _set_clockactivity(oh, oh->class->sysc->clockact, &v);
1392
1393         /* If slave is in SMARTIDLE, also enable wakeup */
1394         if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
1395                 _enable_wakeup(oh, &v);
1396
1397         _write_sysconfig(v, oh);
1398
1399         /*
1400          * Set the autoidle bit only after setting the smartidle bit
1401          * Setting this will not have any impact on the other modules.
1402          */
1403         if (sf & SYSC_HAS_AUTOIDLE) {
1404                 idlemode = (oh->flags & HWMOD_NO_OCP_AUTOIDLE) ?
1405                         0 : 1;
1406                 _set_module_autoidle(oh, idlemode, &v);
1407                 _write_sysconfig(v, oh);
1408         }
1409 }
1410
1411 /**
1412  * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
1413  * @oh: struct omap_hwmod *
1414  *
1415  * If module is marked as SWSUP_SIDLE, force the module into slave
1416  * idle; otherwise, configure it for smart-idle.  If module is marked
1417  * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
1418  * configure it for smart-standby.  No return value.
1419  */
1420 static void _idle_sysc(struct omap_hwmod *oh)
1421 {
1422         u8 idlemode, sf;
1423         u32 v;
1424
1425         if (!oh->class->sysc)
1426                 return;
1427
1428         v = oh->_sysc_cache;
1429         sf = oh->class->sysc->sysc_flags;
1430
1431         if (sf & SYSC_HAS_SIDLEMODE) {
1432                 /* XXX What about HWMOD_IDLEMODE_SMART_WKUP? */
1433                 if (oh->flags & HWMOD_SWSUP_SIDLE ||
1434                     !(oh->class->sysc->idlemodes &
1435                       (SIDLE_SMART | SIDLE_SMART_WKUP)))
1436                         idlemode = HWMOD_IDLEMODE_FORCE;
1437                 else
1438                         idlemode = HWMOD_IDLEMODE_SMART;
1439                 _set_slave_idlemode(oh, idlemode, &v);
1440         }
1441
1442         if (sf & SYSC_HAS_MIDLEMODE) {
1443                 if (oh->flags & HWMOD_SWSUP_MSTANDBY) {
1444                         idlemode = HWMOD_IDLEMODE_FORCE;
1445                 } else {
1446                         if (sf & SYSC_HAS_ENAWAKEUP)
1447                                 _enable_wakeup(oh, &v);
1448                         if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1449                                 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1450                         else
1451                                 idlemode = HWMOD_IDLEMODE_SMART;
1452                 }
1453                 _set_master_standbymode(oh, idlemode, &v);
1454         }
1455
1456         /* If slave is in SMARTIDLE, also enable wakeup */
1457         if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
1458                 _enable_wakeup(oh, &v);
1459
1460         _write_sysconfig(v, oh);
1461 }
1462
1463 /**
1464  * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
1465  * @oh: struct omap_hwmod *
1466  *
1467  * Force the module into slave idle and master suspend. No return
1468  * value.
1469  */
1470 static void _shutdown_sysc(struct omap_hwmod *oh)
1471 {
1472         u32 v;
1473         u8 sf;
1474
1475         if (!oh->class->sysc)
1476                 return;
1477
1478         v = oh->_sysc_cache;
1479         sf = oh->class->sysc->sysc_flags;
1480
1481         if (sf & SYSC_HAS_SIDLEMODE)
1482                 _set_slave_idlemode(oh, HWMOD_IDLEMODE_FORCE, &v);
1483
1484         if (sf & SYSC_HAS_MIDLEMODE)
1485                 _set_master_standbymode(oh, HWMOD_IDLEMODE_FORCE, &v);
1486
1487         if (sf & SYSC_HAS_AUTOIDLE)
1488                 _set_module_autoidle(oh, 1, &v);
1489
1490         _write_sysconfig(v, oh);
1491 }
1492
1493 /**
1494  * _lookup - find an omap_hwmod by name
1495  * @name: find an omap_hwmod by name
1496  *
1497  * Return a pointer to an omap_hwmod by name, or NULL if not found.
1498  */
1499 static struct omap_hwmod *_lookup(const char *name)
1500 {
1501         struct omap_hwmod *oh, *temp_oh;
1502
1503         oh = NULL;
1504
1505         list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1506                 if (!strcmp(name, temp_oh->name)) {
1507                         oh = temp_oh;
1508                         break;
1509                 }
1510         }
1511
1512         return oh;
1513 }
1514
1515 /**
1516  * _init_clkdm - look up a clockdomain name, store pointer in omap_hwmod
1517  * @oh: struct omap_hwmod *
1518  *
1519  * Convert a clockdomain name stored in a struct omap_hwmod into a
1520  * clockdomain pointer, and save it into the struct omap_hwmod.
1521  * Return -EINVAL if the clkdm_name lookup failed.
1522  */
1523 static int _init_clkdm(struct omap_hwmod *oh)
1524 {
1525         if (!oh->clkdm_name) {
1526                 pr_debug("omap_hwmod: %s: missing clockdomain\n", oh->name);
1527                 return 0;
1528         }
1529
1530         oh->clkdm = clkdm_lookup(oh->clkdm_name);
1531         if (!oh->clkdm) {
1532                 pr_warning("omap_hwmod: %s: could not associate to clkdm %s\n",
1533                         oh->name, oh->clkdm_name);
1534                 return -EINVAL;
1535         }
1536
1537         pr_debug("omap_hwmod: %s: associated to clkdm %s\n",
1538                 oh->name, oh->clkdm_name);
1539
1540         return 0;
1541 }
1542
1543 /**
1544  * _init_clocks - clk_get() all clocks associated with this hwmod. Retrieve as
1545  * well the clockdomain.
1546  * @oh: struct omap_hwmod *
1547  * @data: not used; pass NULL
1548  *
1549  * Called by omap_hwmod_setup_*() (after omap2_clk_init()).
1550  * Resolves all clock names embedded in the hwmod.  Returns 0 on
1551  * success, or a negative error code on failure.
1552  */
1553 static int _init_clocks(struct omap_hwmod *oh, void *data)
1554 {
1555         int ret = 0;
1556
1557         if (oh->_state != _HWMOD_STATE_REGISTERED)
1558                 return 0;
1559
1560         pr_debug("omap_hwmod: %s: looking up clocks\n", oh->name);
1561
1562         if (soc_ops.init_clkdm)
1563                 ret |= soc_ops.init_clkdm(oh);
1564
1565         ret |= _init_main_clk(oh);
1566         ret |= _init_interface_clks(oh);
1567         ret |= _init_opt_clks(oh);
1568
1569         if (!ret)
1570                 oh->_state = _HWMOD_STATE_CLKS_INITED;
1571         else
1572                 pr_warning("omap_hwmod: %s: cannot _init_clocks\n", oh->name);
1573
1574         return ret;
1575 }
1576
1577 /**
1578  * _lookup_hardreset - fill register bit info for this hwmod/reset line
1579  * @oh: struct omap_hwmod *
1580  * @name: name of the reset line in the context of this hwmod
1581  * @ohri: struct omap_hwmod_rst_info * that this function will fill in
1582  *
1583  * Return the bit position of the reset line that match the
1584  * input name. Return -ENOENT if not found.
1585  */
1586 static int _lookup_hardreset(struct omap_hwmod *oh, const char *name,
1587                              struct omap_hwmod_rst_info *ohri)
1588 {
1589         int i;
1590
1591         for (i = 0; i < oh->rst_lines_cnt; i++) {
1592                 const char *rst_line = oh->rst_lines[i].name;
1593                 if (!strcmp(rst_line, name)) {
1594                         ohri->rst_shift = oh->rst_lines[i].rst_shift;
1595                         ohri->st_shift = oh->rst_lines[i].st_shift;
1596                         pr_debug("omap_hwmod: %s: %s: %s: rst %d st %d\n",
1597                                  oh->name, __func__, rst_line, ohri->rst_shift,
1598                                  ohri->st_shift);
1599
1600                         return 0;
1601                 }
1602         }
1603
1604         return -ENOENT;
1605 }
1606
1607 /**
1608  * _assert_hardreset - assert the HW reset line of submodules
1609  * contained in the hwmod module.
1610  * @oh: struct omap_hwmod *
1611  * @name: name of the reset line to lookup and assert
1612  *
1613  * Some IP like dsp, ipu or iva contain processor that require an HW
1614  * reset line to be assert / deassert in order to enable fully the IP.
1615  * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1616  * asserting the hardreset line on the currently-booted SoC, or passes
1617  * along the return value from _lookup_hardreset() or the SoC's
1618  * assert_hardreset code.
1619  */
1620 static int _assert_hardreset(struct omap_hwmod *oh, const char *name)
1621 {
1622         struct omap_hwmod_rst_info ohri;
1623         int ret = -EINVAL;
1624
1625         if (!oh)
1626                 return -EINVAL;
1627
1628         if (!soc_ops.assert_hardreset)
1629                 return -ENOSYS;
1630
1631         ret = _lookup_hardreset(oh, name, &ohri);
1632         if (ret < 0)
1633                 return ret;
1634
1635         ret = soc_ops.assert_hardreset(oh, &ohri);
1636
1637         return ret;
1638 }
1639
1640 /**
1641  * _deassert_hardreset - deassert the HW reset line of submodules contained
1642  * in the hwmod module.
1643  * @oh: struct omap_hwmod *
1644  * @name: name of the reset line to look up and deassert
1645  *
1646  * Some IP like dsp, ipu or iva contain processor that require an HW
1647  * reset line to be assert / deassert in order to enable fully the IP.
1648  * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1649  * deasserting the hardreset line on the currently-booted SoC, or passes
1650  * along the return value from _lookup_hardreset() or the SoC's
1651  * deassert_hardreset code.
1652  */
1653 static int _deassert_hardreset(struct omap_hwmod *oh, const char *name)
1654 {
1655         struct omap_hwmod_rst_info ohri;
1656         int ret = -EINVAL;
1657         int hwsup = 0;
1658
1659         if (!oh)
1660                 return -EINVAL;
1661
1662         if (!soc_ops.deassert_hardreset)
1663                 return -ENOSYS;
1664
1665         ret = _lookup_hardreset(oh, name, &ohri);
1666         if (IS_ERR_VALUE(ret))
1667                 return ret;
1668
1669         if (oh->clkdm) {
1670                 /*
1671                  * A clockdomain must be in SW_SUP otherwise reset
1672                  * might not be completed. The clockdomain can be set
1673                  * in HW_AUTO only when the module become ready.
1674                  */
1675                 hwsup = clkdm_in_hwsup(oh->clkdm);
1676                 ret = clkdm_hwmod_enable(oh->clkdm, oh);
1677                 if (ret) {
1678                         WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1679                              oh->name, oh->clkdm->name, ret);
1680                         return ret;
1681                 }
1682         }
1683
1684         _enable_clocks(oh);
1685         if (soc_ops.enable_module)
1686                 soc_ops.enable_module(oh);
1687
1688         ret = soc_ops.deassert_hardreset(oh, &ohri);
1689
1690         if (soc_ops.disable_module)
1691                 soc_ops.disable_module(oh);
1692         _disable_clocks(oh);
1693
1694         if (ret == -EBUSY)
1695                 pr_warning("omap_hwmod: %s: failed to hardreset\n", oh->name);
1696
1697         if (!ret) {
1698                 /*
1699                  * Set the clockdomain to HW_AUTO, assuming that the
1700                  * previous state was HW_AUTO.
1701                  */
1702                 if (oh->clkdm && hwsup)
1703                         clkdm_allow_idle(oh->clkdm);
1704         } else {
1705                 if (oh->clkdm)
1706                         clkdm_hwmod_disable(oh->clkdm, oh);
1707         }
1708
1709         return ret;
1710 }
1711
1712 /**
1713  * _read_hardreset - read the HW reset line state of submodules
1714  * contained in the hwmod module
1715  * @oh: struct omap_hwmod *
1716  * @name: name of the reset line to look up and read
1717  *
1718  * Return the state of the reset line.  Returns -EINVAL if @oh is
1719  * null, -ENOSYS if we have no way of reading the hardreset line
1720  * status on the currently-booted SoC, or passes along the return
1721  * value from _lookup_hardreset() or the SoC's is_hardreset_asserted
1722  * code.
1723  */
1724 static int _read_hardreset(struct omap_hwmod *oh, const char *name)
1725 {
1726         struct omap_hwmod_rst_info ohri;
1727         int ret = -EINVAL;
1728
1729         if (!oh)
1730                 return -EINVAL;
1731
1732         if (!soc_ops.is_hardreset_asserted)
1733                 return -ENOSYS;
1734
1735         ret = _lookup_hardreset(oh, name, &ohri);
1736         if (ret < 0)
1737                 return ret;
1738
1739         return soc_ops.is_hardreset_asserted(oh, &ohri);
1740 }
1741
1742 /**
1743  * _are_all_hardreset_lines_asserted - return true if the @oh is hard-reset
1744  * @oh: struct omap_hwmod *
1745  *
1746  * If all hardreset lines associated with @oh are asserted, then return true.
1747  * Otherwise, if part of @oh is out hardreset or if no hardreset lines
1748  * associated with @oh are asserted, then return false.
1749  * This function is used to avoid executing some parts of the IP block
1750  * enable/disable sequence if its hardreset line is set.
1751  */
1752 static bool _are_all_hardreset_lines_asserted(struct omap_hwmod *oh)
1753 {
1754         int i, rst_cnt = 0;
1755
1756         if (oh->rst_lines_cnt == 0)
1757                 return false;
1758
1759         for (i = 0; i < oh->rst_lines_cnt; i++)
1760                 if (_read_hardreset(oh, oh->rst_lines[i].name) > 0)
1761                         rst_cnt++;
1762
1763         if (oh->rst_lines_cnt == rst_cnt)
1764                 return true;
1765
1766         return false;
1767 }
1768
1769 /**
1770  * _are_any_hardreset_lines_asserted - return true if any part of @oh is
1771  * hard-reset
1772  * @oh: struct omap_hwmod *
1773  *
1774  * If any hardreset lines associated with @oh are asserted, then
1775  * return true.  Otherwise, if no hardreset lines associated with @oh
1776  * are asserted, or if @oh has no hardreset lines, then return false.
1777  * This function is used to avoid executing some parts of the IP block
1778  * enable/disable sequence if any hardreset line is set.
1779  */
1780 static bool _are_any_hardreset_lines_asserted(struct omap_hwmod *oh)
1781 {
1782         int rst_cnt = 0;
1783         int i;
1784
1785         for (i = 0; i < oh->rst_lines_cnt && rst_cnt == 0; i++)
1786                 if (_read_hardreset(oh, oh->rst_lines[i].name) > 0)
1787                         rst_cnt++;
1788
1789         return (rst_cnt) ? true : false;
1790 }
1791
1792 /**
1793  * _omap4_disable_module - enable CLKCTRL modulemode on OMAP4
1794  * @oh: struct omap_hwmod *
1795  *
1796  * Disable the PRCM module mode related to the hwmod @oh.
1797  * Return EINVAL if the modulemode is not supported and 0 in case of success.
1798  */
1799 static int _omap4_disable_module(struct omap_hwmod *oh)
1800 {
1801         int v;
1802
1803         if (!oh->clkdm || !oh->prcm.omap4.modulemode)
1804                 return -EINVAL;
1805
1806         /*
1807          * Since integration code might still be doing something, only
1808          * disable if all lines are under hardreset.
1809          */
1810         if (_are_any_hardreset_lines_asserted(oh))
1811                 return 0;
1812
1813         pr_debug("omap_hwmod: %s: %s\n", oh->name, __func__);
1814
1815         omap4_cminst_module_disable(oh->clkdm->prcm_partition,
1816                                     oh->clkdm->cm_inst,
1817                                     oh->clkdm->clkdm_offs,
1818                                     oh->prcm.omap4.clkctrl_offs);
1819
1820         v = _omap4_wait_target_disable(oh);
1821         if (v)
1822                 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1823                         oh->name);
1824
1825         return 0;
1826 }
1827
1828 /**
1829  * _am33xx_disable_module - enable CLKCTRL modulemode on AM33XX
1830  * @oh: struct omap_hwmod *
1831  *
1832  * Disable the PRCM module mode related to the hwmod @oh.
1833  * Return EINVAL if the modulemode is not supported and 0 in case of success.
1834  */
1835 static int _am33xx_disable_module(struct omap_hwmod *oh)
1836 {
1837         int v;
1838
1839         if (!oh->clkdm || !oh->prcm.omap4.modulemode)
1840                 return -EINVAL;
1841
1842         pr_debug("omap_hwmod: %s: %s\n", oh->name, __func__);
1843
1844         if (_are_any_hardreset_lines_asserted(oh))
1845                 return 0;
1846
1847         am33xx_cm_module_disable(oh->clkdm->cm_inst, oh->clkdm->clkdm_offs,
1848                                  oh->prcm.omap4.clkctrl_offs);
1849
1850         v = _am33xx_wait_target_disable(oh);
1851         if (v)
1852                 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1853                         oh->name);
1854
1855         return 0;
1856 }
1857
1858 /**
1859  * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1860  * @oh: struct omap_hwmod *
1861  *
1862  * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit.  hwmod must be
1863  * enabled for this to work.  Returns -ENOENT if the hwmod cannot be
1864  * reset this way, -EINVAL if the hwmod is in the wrong state,
1865  * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1866  *
1867  * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1868  * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1869  * use the SYSCONFIG softreset bit to provide the status.
1870  *
1871  * Note that some IP like McBSP do have reset control but don't have
1872  * reset status.
1873  */
1874 static int _ocp_softreset(struct omap_hwmod *oh)
1875 {
1876         u32 v;
1877         int c = 0;
1878         int ret = 0;
1879
1880         if (!oh->class->sysc ||
1881             !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
1882                 return -ENOENT;
1883
1884         /* clocks must be on for this operation */
1885         if (oh->_state != _HWMOD_STATE_ENABLED) {
1886                 pr_warn("omap_hwmod: %s: reset can only be entered from enabled state\n",
1887                         oh->name);
1888                 return -EINVAL;
1889         }
1890
1891         /* For some modules, all optionnal clocks need to be enabled as well */
1892         if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1893                 _enable_optional_clocks(oh);
1894
1895         pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh->name);
1896
1897         v = oh->_sysc_cache;
1898         ret = _set_softreset(oh, &v);
1899         if (ret)
1900                 goto dis_opt_clks;
1901         _write_sysconfig(v, oh);
1902
1903         if (oh->class->sysc->srst_udelay)
1904                 udelay(oh->class->sysc->srst_udelay);
1905
1906         c = _wait_softreset_complete(oh);
1907         if (c == MAX_MODULE_SOFTRESET_WAIT)
1908                 pr_warning("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1909                            oh->name, MAX_MODULE_SOFTRESET_WAIT);
1910         else
1911                 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh->name, c);
1912
1913         /*
1914          * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1915          * _wait_target_ready() or _reset()
1916          */
1917
1918         ret = (c == MAX_MODULE_SOFTRESET_WAIT) ? -ETIMEDOUT : 0;
1919
1920 dis_opt_clks:
1921         if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1922                 _disable_optional_clocks(oh);
1923
1924         return ret;
1925 }
1926
1927 /**
1928  * _reset - reset an omap_hwmod
1929  * @oh: struct omap_hwmod *
1930  *
1931  * Resets an omap_hwmod @oh.  If the module has a custom reset
1932  * function pointer defined, then call it to reset the IP block, and
1933  * pass along its return value to the caller.  Otherwise, if the IP
1934  * block has an OCP_SYSCONFIG register with a SOFTRESET bitfield
1935  * associated with it, call a function to reset the IP block via that
1936  * method, and pass along the return value to the caller.  Finally, if
1937  * the IP block has some hardreset lines associated with it, assert
1938  * all of those, but do _not_ deassert them. (This is because driver
1939  * authors have expressed an apparent requirement to control the
1940  * deassertion of the hardreset lines themselves.)
1941  *
1942  * The default software reset mechanism for most OMAP IP blocks is
1943  * triggered via the OCP_SYSCONFIG.SOFTRESET bit.  However, some
1944  * hwmods cannot be reset via this method.  Some are not targets and
1945  * therefore have no OCP header registers to access.  Others (like the
1946  * IVA) have idiosyncratic reset sequences.  So for these relatively
1947  * rare cases, custom reset code can be supplied in the struct
1948  * omap_hwmod_class .reset function pointer.
1949  *
1950  * _set_dmadisable() is called to set the DMADISABLE bit so that it
1951  * does not prevent idling of the system. This is necessary for cases
1952  * where ROMCODE/BOOTLOADER uses dma and transfers control to the
1953  * kernel without disabling dma.
1954  *
1955  * Passes along the return value from either _ocp_softreset() or the
1956  * custom reset function - these must return -EINVAL if the hwmod
1957  * cannot be reset this way or if the hwmod is in the wrong state,
1958  * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1959  */
1960 static int _reset(struct omap_hwmod *oh)
1961 {
1962         int i, r;
1963
1964         pr_debug("omap_hwmod: %s: resetting\n", oh->name);
1965
1966         if (oh->class->reset) {
1967                 r = oh->class->reset(oh);
1968         } else {
1969                 if (oh->rst_lines_cnt > 0) {
1970                         for (i = 0; i < oh->rst_lines_cnt; i++)
1971                                 _assert_hardreset(oh, oh->rst_lines[i].name);
1972                         return 0;
1973                 } else {
1974                         r = _ocp_softreset(oh);
1975                         if (r == -ENOENT)
1976                                 r = 0;
1977                 }
1978         }
1979
1980         _set_dmadisable(oh);
1981
1982         /*
1983          * OCP_SYSCONFIG bits need to be reprogrammed after a
1984          * softreset.  The _enable() function should be split to avoid
1985          * the rewrite of the OCP_SYSCONFIG register.
1986          */
1987         if (oh->class->sysc) {
1988                 _update_sysc_cache(oh);
1989                 _enable_sysc(oh);
1990         }
1991
1992         return r;
1993 }
1994
1995 /**
1996  * _reconfigure_io_chain - clear any I/O chain wakeups and reconfigure chain
1997  *
1998  * Call the appropriate PRM function to clear any logged I/O chain
1999  * wakeups and to reconfigure the chain.  This apparently needs to be
2000  * done upon every mux change.  Since hwmods can be concurrently
2001  * enabled and idled, hold a spinlock around the I/O chain
2002  * reconfiguration sequence.  No return value.
2003  *
2004  * XXX When the PRM code is moved to drivers, this function can be removed,
2005  * as the PRM infrastructure should abstract this.
2006  */
2007 static void _reconfigure_io_chain(void)
2008 {
2009         unsigned long flags;
2010
2011         spin_lock_irqsave(&io_chain_lock, flags);
2012
2013         if (cpu_is_omap34xx() && omap3_has_io_chain_ctrl())
2014                 omap3xxx_prm_reconfigure_io_chain();
2015         else if (cpu_is_omap44xx())
2016                 omap44xx_prm_reconfigure_io_chain();
2017
2018         spin_unlock_irqrestore(&io_chain_lock, flags);
2019 }
2020
2021 /**
2022  * _omap4_update_context_lost - increment hwmod context loss counter if
2023  * hwmod context was lost, and clear hardware context loss reg
2024  * @oh: hwmod to check for context loss
2025  *
2026  * If the PRCM indicates that the hwmod @oh lost context, increment
2027  * our in-memory context loss counter, and clear the RM_*_CONTEXT
2028  * bits. No return value.
2029  */
2030 static void _omap4_update_context_lost(struct omap_hwmod *oh)
2031 {
2032         if (oh->prcm.omap4.flags & HWMOD_OMAP4_NO_CONTEXT_LOSS_BIT)
2033                 return;
2034
2035         if (!prm_was_any_context_lost_old(oh->clkdm->pwrdm.ptr->prcm_partition,
2036                                           oh->clkdm->pwrdm.ptr->prcm_offs,
2037                                           oh->prcm.omap4.context_offs))
2038                 return;
2039
2040         oh->prcm.omap4.context_lost_counter++;
2041         prm_clear_context_loss_flags_old(oh->clkdm->pwrdm.ptr->prcm_partition,
2042                                          oh->clkdm->pwrdm.ptr->prcm_offs,
2043                                          oh->prcm.omap4.context_offs);
2044 }
2045
2046 /**
2047  * _omap4_get_context_lost - get context loss counter for a hwmod
2048  * @oh: hwmod to get context loss counter for
2049  *
2050  * Returns the in-memory context loss counter for a hwmod.
2051  */
2052 static int _omap4_get_context_lost(struct omap_hwmod *oh)
2053 {
2054         return oh->prcm.omap4.context_lost_counter;
2055 }
2056
2057 /**
2058  * _enable_preprogram - Pre-program an IP block during the _enable() process
2059  * @oh: struct omap_hwmod *
2060  *
2061  * Some IP blocks (such as AESS) require some additional programming
2062  * after enable before they can enter idle.  If a function pointer to
2063  * do so is present in the hwmod data, then call it and pass along the
2064  * return value; otherwise, return 0.
2065  */
2066 static int __init _enable_preprogram(struct omap_hwmod *oh)
2067 {
2068         if (!oh->class->enable_preprogram)
2069                 return 0;
2070
2071         return oh->class->enable_preprogram(oh);
2072 }
2073
2074 /**
2075  * _enable - enable an omap_hwmod
2076  * @oh: struct omap_hwmod *
2077  *
2078  * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
2079  * register target.  Returns -EINVAL if the hwmod is in the wrong
2080  * state or passes along the return value of _wait_target_ready().
2081  */
2082 static int _enable(struct omap_hwmod *oh)
2083 {
2084         int r;
2085         int hwsup = 0;
2086
2087         pr_debug("omap_hwmod: %s: enabling\n", oh->name);
2088
2089         /*
2090          * hwmods with HWMOD_INIT_NO_IDLE flag set are left in enabled
2091          * state at init.  Now that someone is really trying to enable
2092          * them, just ensure that the hwmod mux is set.
2093          */
2094         if (oh->_int_flags & _HWMOD_SKIP_ENABLE) {
2095                 /*
2096                  * If the caller has mux data populated, do the mux'ing
2097                  * which wouldn't have been done as part of the _enable()
2098                  * done during setup.
2099                  */
2100                 if (oh->mux)
2101                         omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
2102
2103                 oh->_int_flags &= ~_HWMOD_SKIP_ENABLE;
2104                 return 0;
2105         }
2106
2107         if (oh->_state != _HWMOD_STATE_INITIALIZED &&
2108             oh->_state != _HWMOD_STATE_IDLE &&
2109             oh->_state != _HWMOD_STATE_DISABLED) {
2110                 WARN(1, "omap_hwmod: %s: enabled state can only be entered from initialized, idle, or disabled state\n",
2111                         oh->name);
2112                 return -EINVAL;
2113         }
2114
2115         /*
2116          * If an IP block contains HW reset lines and all of them are
2117          * asserted, we let integration code associated with that
2118          * block handle the enable.  We've received very little
2119          * information on what those driver authors need, and until
2120          * detailed information is provided and the driver code is
2121          * posted to the public lists, this is probably the best we
2122          * can do.
2123          */
2124         if (_are_all_hardreset_lines_asserted(oh))
2125                 return 0;
2126
2127         /* Mux pins for device runtime if populated */
2128         if (oh->mux && (!oh->mux->enabled ||
2129                         ((oh->_state == _HWMOD_STATE_IDLE) &&
2130                          oh->mux->pads_dynamic))) {
2131                 omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
2132                 _reconfigure_io_chain();
2133         }
2134
2135         _add_initiator_dep(oh, mpu_oh);
2136
2137         if (oh->clkdm) {
2138                 /*
2139                  * A clockdomain must be in SW_SUP before enabling
2140                  * completely the module. The clockdomain can be set
2141                  * in HW_AUTO only when the module become ready.
2142                  */
2143                 hwsup = clkdm_in_hwsup(oh->clkdm) &&
2144                         !clkdm_missing_idle_reporting(oh->clkdm);
2145                 r = clkdm_hwmod_enable(oh->clkdm, oh);
2146                 if (r) {
2147                         WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
2148                              oh->name, oh->clkdm->name, r);
2149                         return r;
2150                 }
2151         }
2152
2153         _enable_clocks(oh);
2154         if (soc_ops.enable_module)
2155                 soc_ops.enable_module(oh);
2156         if (oh->flags & HWMOD_BLOCK_WFI)
2157                 disable_hlt();
2158
2159         if (soc_ops.update_context_lost)
2160                 soc_ops.update_context_lost(oh);
2161
2162         r = (soc_ops.wait_target_ready) ? soc_ops.wait_target_ready(oh) :
2163                 -EINVAL;
2164         if (!r) {
2165                 /*
2166                  * Set the clockdomain to HW_AUTO only if the target is ready,
2167                  * assuming that the previous state was HW_AUTO
2168                  */
2169                 if (oh->clkdm && hwsup)
2170                         clkdm_allow_idle(oh->clkdm);
2171
2172                 oh->_state = _HWMOD_STATE_ENABLED;
2173
2174                 /* Access the sysconfig only if the target is ready */
2175                 if (oh->class->sysc) {
2176                         if (!(oh->_int_flags & _HWMOD_SYSCONFIG_LOADED))
2177                                 _update_sysc_cache(oh);
2178                         _enable_sysc(oh);
2179                 }
2180                 r = _enable_preprogram(oh);
2181         } else {
2182                 if (soc_ops.disable_module)
2183                         soc_ops.disable_module(oh);
2184                 _disable_clocks(oh);
2185                 pr_debug("omap_hwmod: %s: _wait_target_ready: %d\n",
2186                          oh->name, r);
2187
2188                 if (oh->clkdm)
2189                         clkdm_hwmod_disable(oh->clkdm, oh);
2190         }
2191
2192         return r;
2193 }
2194
2195 /**
2196  * _idle - idle an omap_hwmod
2197  * @oh: struct omap_hwmod *
2198  *
2199  * Idles an omap_hwmod @oh.  This should be called once the hwmod has
2200  * no further work.  Returns -EINVAL if the hwmod is in the wrong
2201  * state or returns 0.
2202  */
2203 static int _idle(struct omap_hwmod *oh)
2204 {
2205         pr_debug("omap_hwmod: %s: idling\n", oh->name);
2206
2207         if (oh->_state != _HWMOD_STATE_ENABLED) {
2208                 WARN(1, "omap_hwmod: %s: idle state can only be entered from enabled state\n",
2209                         oh->name);
2210                 return -EINVAL;
2211         }
2212
2213         if (_are_all_hardreset_lines_asserted(oh))
2214                 return 0;
2215
2216         if (oh->class->sysc)
2217                 _idle_sysc(oh);
2218         _del_initiator_dep(oh, mpu_oh);
2219
2220         if (oh->flags & HWMOD_BLOCK_WFI)
2221                 enable_hlt();
2222         if (soc_ops.disable_module)
2223                 soc_ops.disable_module(oh);
2224
2225         /*
2226          * The module must be in idle mode before disabling any parents
2227          * clocks. Otherwise, the parent clock might be disabled before
2228          * the module transition is done, and thus will prevent the
2229          * transition to complete properly.
2230          */
2231         _disable_clocks(oh);
2232         if (oh->clkdm)
2233                 clkdm_hwmod_disable(oh->clkdm, oh);
2234
2235         /* Mux pins for device idle if populated */
2236         if (oh->mux && oh->mux->pads_dynamic) {
2237                 omap_hwmod_mux(oh->mux, _HWMOD_STATE_IDLE);
2238                 _reconfigure_io_chain();
2239         }
2240
2241         oh->_state = _HWMOD_STATE_IDLE;
2242
2243         return 0;
2244 }
2245
2246 /**
2247  * omap_hwmod_set_ocp_autoidle - set the hwmod's OCP autoidle bit
2248  * @oh: struct omap_hwmod *
2249  * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
2250  *
2251  * Sets the IP block's OCP autoidle bit in hardware, and updates our
2252  * local copy. Intended to be used by drivers that require
2253  * direct manipulation of the AUTOIDLE bits.
2254  * Returns -EINVAL if @oh is null or is not in the ENABLED state, or passes
2255  * along the return value from _set_module_autoidle().
2256  *
2257  * Any users of this function should be scrutinized carefully.
2258  */
2259 int omap_hwmod_set_ocp_autoidle(struct omap_hwmod *oh, u8 autoidle)
2260 {
2261         u32 v;
2262         int retval = 0;
2263         unsigned long flags;
2264
2265         if (!oh || oh->_state != _HWMOD_STATE_ENABLED)
2266                 return -EINVAL;
2267
2268         spin_lock_irqsave(&oh->_lock, flags);
2269
2270         v = oh->_sysc_cache;
2271
2272         retval = _set_module_autoidle(oh, autoidle, &v);
2273
2274         if (!retval)
2275                 _write_sysconfig(v, oh);
2276
2277         spin_unlock_irqrestore(&oh->_lock, flags);
2278
2279         return retval;
2280 }
2281
2282 /**
2283  * _shutdown - shutdown an omap_hwmod
2284  * @oh: struct omap_hwmod *
2285  *
2286  * Shut down an omap_hwmod @oh.  This should be called when the driver
2287  * used for the hwmod is removed or unloaded or if the driver is not
2288  * used by the system.  Returns -EINVAL if the hwmod is in the wrong
2289  * state or returns 0.
2290  */
2291 static int _shutdown(struct omap_hwmod *oh)
2292 {
2293         int ret, i;
2294         u8 prev_state;
2295
2296         if (oh->_state != _HWMOD_STATE_IDLE &&
2297             oh->_state != _HWMOD_STATE_ENABLED) {
2298                 WARN(1, "omap_hwmod: %s: disabled state can only be entered from idle, or enabled state\n",
2299                         oh->name);
2300                 return -EINVAL;
2301         }
2302
2303         if (_are_all_hardreset_lines_asserted(oh))
2304                 return 0;
2305
2306         pr_debug("omap_hwmod: %s: disabling\n", oh->name);
2307
2308         if (oh->class->pre_shutdown) {
2309                 prev_state = oh->_state;
2310                 if (oh->_state == _HWMOD_STATE_IDLE)
2311                         _enable(oh);
2312                 ret = oh->class->pre_shutdown(oh);
2313                 if (ret) {
2314                         if (prev_state == _HWMOD_STATE_IDLE)
2315                                 _idle(oh);
2316                         return ret;
2317                 }
2318         }
2319
2320         if (oh->class->sysc) {
2321                 if (oh->_state == _HWMOD_STATE_IDLE)
2322                         _enable(oh);
2323                 _shutdown_sysc(oh);
2324         }
2325
2326         /* clocks and deps are already disabled in idle */
2327         if (oh->_state == _HWMOD_STATE_ENABLED) {
2328                 _del_initiator_dep(oh, mpu_oh);
2329                 /* XXX what about the other system initiators here? dma, dsp */
2330                 if (oh->flags & HWMOD_BLOCK_WFI)
2331                         enable_hlt();
2332                 if (soc_ops.disable_module)
2333                         soc_ops.disable_module(oh);
2334                 _disable_clocks(oh);
2335                 if (oh->clkdm)
2336                         clkdm_hwmod_disable(oh->clkdm, oh);
2337         }
2338         /* XXX Should this code also force-disable the optional clocks? */
2339
2340         for (i = 0; i < oh->rst_lines_cnt; i++)
2341                 _assert_hardreset(oh, oh->rst_lines[i].name);
2342
2343         /* Mux pins to safe mode or use populated off mode values */
2344         if (oh->mux)
2345                 omap_hwmod_mux(oh->mux, _HWMOD_STATE_DISABLED);
2346
2347         oh->_state = _HWMOD_STATE_DISABLED;
2348
2349         return 0;
2350 }
2351
2352 /**
2353  * _init_mpu_rt_base - populate the virtual address for a hwmod
2354  * @oh: struct omap_hwmod * to locate the virtual address
2355  *
2356  * Cache the virtual address used by the MPU to access this IP block's
2357  * registers.  This address is needed early so the OCP registers that
2358  * are part of the device's address space can be ioremapped properly.
2359  * No return value.
2360  */
2361 static void __init _init_mpu_rt_base(struct omap_hwmod *oh, void *data)
2362 {
2363         struct omap_hwmod_addr_space *mem;
2364         void __iomem *va_start;
2365
2366         if (!oh)
2367                 return;
2368
2369         _save_mpu_port_index(oh);
2370
2371         if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2372                 return;
2373
2374         mem = _find_mpu_rt_addr_space(oh);
2375         if (!mem) {
2376                 pr_debug("omap_hwmod: %s: no MPU register target found\n",
2377                          oh->name);
2378                 return;
2379         }
2380
2381         va_start = ioremap(mem->pa_start, mem->pa_end - mem->pa_start);
2382         if (!va_start) {
2383                 pr_err("omap_hwmod: %s: Could not ioremap\n", oh->name);
2384                 return;
2385         }
2386
2387         pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
2388                  oh->name, va_start);
2389
2390         oh->_mpu_rt_va = va_start;
2391 }
2392
2393 /**
2394  * _init - initialize internal data for the hwmod @oh
2395  * @oh: struct omap_hwmod *
2396  * @n: (unused)
2397  *
2398  * Look up the clocks and the address space used by the MPU to access
2399  * registers belonging to the hwmod @oh.  @oh must already be
2400  * registered at this point.  This is the first of two phases for
2401  * hwmod initialization.  Code called here does not touch any hardware
2402  * registers, it simply prepares internal data structures.  Returns 0
2403  * upon success or if the hwmod isn't registered, or -EINVAL upon
2404  * failure.
2405  */
2406 static int __init _init(struct omap_hwmod *oh, void *data)
2407 {
2408         int r;
2409
2410         if (oh->_state != _HWMOD_STATE_REGISTERED)
2411                 return 0;
2412
2413         _init_mpu_rt_base(oh, NULL);
2414
2415         r = _init_clocks(oh, NULL);
2416         if (IS_ERR_VALUE(r)) {
2417                 WARN(1, "omap_hwmod: %s: couldn't init clocks\n", oh->name);
2418                 return -EINVAL;
2419         }
2420
2421         oh->_state = _HWMOD_STATE_INITIALIZED;
2422
2423         return 0;
2424 }
2425
2426 /**
2427  * _setup_iclk_autoidle - configure an IP block's interface clocks
2428  * @oh: struct omap_hwmod *
2429  *
2430  * Set up the module's interface clocks.  XXX This function is still mostly
2431  * a stub; implementing this properly requires iclk autoidle usecounting in
2432  * the clock code.   No return value.
2433  */
2434 static void __init _setup_iclk_autoidle(struct omap_hwmod *oh)
2435 {
2436         struct omap_hwmod_ocp_if *os;
2437         struct list_head *p;
2438         int i = 0;
2439         if (oh->_state != _HWMOD_STATE_INITIALIZED)
2440                 return;
2441
2442         p = oh->slave_ports.next;
2443
2444         while (i < oh->slaves_cnt) {
2445                 os = _fetch_next_ocp_if(&p, &i);
2446                 if (!os->_clk)
2447                         continue;
2448
2449                 if (os->flags & OCPIF_SWSUP_IDLE) {
2450                         /* XXX omap_iclk_deny_idle(c); */
2451                 } else {
2452                         /* XXX omap_iclk_allow_idle(c); */
2453                         clk_enable(os->_clk);
2454                 }
2455         }
2456
2457         return;
2458 }
2459
2460 /**
2461  * _setup_reset - reset an IP block during the setup process
2462  * @oh: struct omap_hwmod *
2463  *
2464  * Reset the IP block corresponding to the hwmod @oh during the setup
2465  * process.  The IP block is first enabled so it can be successfully
2466  * reset.  Returns 0 upon success or a negative error code upon
2467  * failure.
2468  */
2469 static int __init _setup_reset(struct omap_hwmod *oh)
2470 {
2471         int r;
2472
2473         if (oh->_state != _HWMOD_STATE_INITIALIZED)
2474                 return -EINVAL;
2475
2476         if (oh->flags & HWMOD_EXT_OPT_MAIN_CLK)
2477                 return -EPERM;
2478
2479         if (oh->rst_lines_cnt == 0) {
2480                 r = _enable(oh);
2481                 if (r) {
2482                         pr_warning("omap_hwmod: %s: cannot be enabled for reset (%d)\n",
2483                                    oh->name, oh->_state);
2484                         return -EINVAL;
2485                 }
2486         }
2487
2488         if (!(oh->flags & HWMOD_INIT_NO_RESET))
2489                 r = _reset(oh);
2490
2491         return r;
2492 }
2493
2494 /**
2495  * _setup_postsetup - transition to the appropriate state after _setup
2496  * @oh: struct omap_hwmod *
2497  *
2498  * Place an IP block represented by @oh into a "post-setup" state --
2499  * either IDLE, ENABLED, or DISABLED.  ("post-setup" simply means that
2500  * this function is called at the end of _setup().)  The postsetup
2501  * state for an IP block can be changed by calling
2502  * omap_hwmod_enter_postsetup_state() early in the boot process,
2503  * before one of the omap_hwmod_setup*() functions are called for the
2504  * IP block.
2505  *
2506  * The IP block stays in this state until a PM runtime-based driver is
2507  * loaded for that IP block.  A post-setup state of IDLE is
2508  * appropriate for almost all IP blocks with runtime PM-enabled
2509  * drivers, since those drivers are able to enable the IP block.  A
2510  * post-setup state of ENABLED is appropriate for kernels with PM
2511  * runtime disabled.  The DISABLED state is appropriate for unusual IP
2512  * blocks such as the MPU WDTIMER on kernels without WDTIMER drivers
2513  * included, since the WDTIMER starts running on reset and will reset
2514  * the MPU if left active.
2515  *
2516  * This post-setup mechanism is deprecated.  Once all of the OMAP
2517  * drivers have been converted to use PM runtime, and all of the IP
2518  * block data and interconnect data is available to the hwmod code, it
2519  * should be possible to replace this mechanism with a "lazy reset"
2520  * arrangement.  In a "lazy reset" setup, each IP block is enabled
2521  * when the driver first probes, then all remaining IP blocks without
2522  * drivers are either shut down or enabled after the drivers have
2523  * loaded.  However, this cannot take place until the above
2524  * preconditions have been met, since otherwise the late reset code
2525  * has no way of knowing which IP blocks are in use by drivers, and
2526  * which ones are unused.
2527  *
2528  * No return value.
2529  */
2530 static void __init _setup_postsetup(struct omap_hwmod *oh)
2531 {
2532         u8 postsetup_state;
2533
2534         if (oh->rst_lines_cnt > 0)
2535                 return;
2536
2537         postsetup_state = oh->_postsetup_state;
2538         if (postsetup_state == _HWMOD_STATE_UNKNOWN)
2539                 postsetup_state = _HWMOD_STATE_ENABLED;
2540
2541         /*
2542          * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
2543          * it should be set by the core code as a runtime flag during startup
2544          */
2545         if ((oh->flags & HWMOD_INIT_NO_IDLE) &&
2546             (postsetup_state == _HWMOD_STATE_IDLE)) {
2547                 oh->_int_flags |= _HWMOD_SKIP_ENABLE;
2548                 postsetup_state = _HWMOD_STATE_ENABLED;
2549         }
2550
2551         if (postsetup_state == _HWMOD_STATE_IDLE)
2552                 _idle(oh);
2553         else if (postsetup_state == _HWMOD_STATE_DISABLED)
2554                 _shutdown(oh);
2555         else if (postsetup_state != _HWMOD_STATE_ENABLED)
2556                 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
2557                      oh->name, postsetup_state);
2558
2559         return;
2560 }
2561
2562 /**
2563  * _setup - prepare IP block hardware for use
2564  * @oh: struct omap_hwmod *
2565  * @n: (unused, pass NULL)
2566  *
2567  * Configure the IP block represented by @oh.  This may include
2568  * enabling the IP block, resetting it, and placing it into a
2569  * post-setup state, depending on the type of IP block and applicable
2570  * flags.  IP blocks are reset to prevent any previous configuration
2571  * by the bootloader or previous operating system from interfering
2572  * with power management or other parts of the system.  The reset can
2573  * be avoided; see omap_hwmod_no_setup_reset().  This is the second of
2574  * two phases for hwmod initialization.  Code called here generally
2575  * affects the IP block hardware, or system integration hardware
2576  * associated with the IP block.  Returns 0.
2577  */
2578 static int __init _setup(struct omap_hwmod *oh, void *data)
2579 {
2580         if (oh->_state != _HWMOD_STATE_INITIALIZED)
2581                 return 0;
2582
2583         _setup_iclk_autoidle(oh);
2584
2585         if (!_setup_reset(oh))
2586                 _setup_postsetup(oh);
2587
2588         return 0;
2589 }
2590
2591 /**
2592  * _register - register a struct omap_hwmod
2593  * @oh: struct omap_hwmod *
2594  *
2595  * Registers the omap_hwmod @oh.  Returns -EEXIST if an omap_hwmod
2596  * already has been registered by the same name; -EINVAL if the
2597  * omap_hwmod is in the wrong state, if @oh is NULL, if the
2598  * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
2599  * name, or if the omap_hwmod's class is missing a name; or 0 upon
2600  * success.
2601  *
2602  * XXX The data should be copied into bootmem, so the original data
2603  * should be marked __initdata and freed after init.  This would allow
2604  * unneeded omap_hwmods to be freed on multi-OMAP configurations.  Note
2605  * that the copy process would be relatively complex due to the large number
2606  * of substructures.
2607  */
2608 static int __init _register(struct omap_hwmod *oh)
2609 {
2610         if (!oh || !oh->name || !oh->class || !oh->class->name ||
2611             (oh->_state != _HWMOD_STATE_UNKNOWN))
2612                 return -EINVAL;
2613
2614         pr_debug("omap_hwmod: %s: registering\n", oh->name);
2615
2616         if (_lookup(oh->name))
2617                 return -EEXIST;
2618
2619         list_add_tail(&oh->node, &omap_hwmod_list);
2620
2621         INIT_LIST_HEAD(&oh->master_ports);
2622         INIT_LIST_HEAD(&oh->slave_ports);
2623         spin_lock_init(&oh->_lock);
2624
2625         oh->_state = _HWMOD_STATE_REGISTERED;
2626
2627         /*
2628          * XXX Rather than doing a strcmp(), this should test a flag
2629          * set in the hwmod data, inserted by the autogenerator code.
2630          */
2631         if (!strcmp(oh->name, MPU_INITIATOR_NAME))
2632                 mpu_oh = oh;
2633
2634         return 0;
2635 }
2636
2637 /**
2638  * _alloc_links - return allocated memory for hwmod links
2639  * @ml: pointer to a struct omap_hwmod_link * for the master link
2640  * @sl: pointer to a struct omap_hwmod_link * for the slave link
2641  *
2642  * Return pointers to two struct omap_hwmod_link records, via the
2643  * addresses pointed to by @ml and @sl.  Will first attempt to return
2644  * memory allocated as part of a large initial block, but if that has
2645  * been exhausted, will allocate memory itself.  Since ideally this
2646  * second allocation path will never occur, the number of these
2647  * 'supplemental' allocations will be logged when debugging is
2648  * enabled.  Returns 0.
2649  */
2650 static int __init _alloc_links(struct omap_hwmod_link **ml,
2651                                struct omap_hwmod_link **sl)
2652 {
2653         unsigned int sz;
2654
2655         if ((free_ls + LINKS_PER_OCP_IF) <= max_ls) {
2656                 *ml = &linkspace[free_ls++];
2657                 *sl = &linkspace[free_ls++];
2658                 return 0;
2659         }
2660
2661         sz = sizeof(struct omap_hwmod_link) * LINKS_PER_OCP_IF;
2662
2663         *sl = NULL;
2664         *ml = alloc_bootmem(sz);
2665
2666         memset(*ml, 0, sz);
2667
2668         *sl = (void *)(*ml) + sizeof(struct omap_hwmod_link);
2669
2670         ls_supp++;
2671         pr_debug("omap_hwmod: supplemental link allocations needed: %d\n",
2672                  ls_supp * LINKS_PER_OCP_IF);
2673
2674         return 0;
2675 };
2676
2677 /**
2678  * _add_link - add an interconnect between two IP blocks
2679  * @oi: pointer to a struct omap_hwmod_ocp_if record
2680  *
2681  * Add struct omap_hwmod_link records connecting the master IP block
2682  * specified in @oi->master to @oi, and connecting the slave IP block
2683  * specified in @oi->slave to @oi.  This code is assumed to run before
2684  * preemption or SMP has been enabled, thus avoiding the need for
2685  * locking in this code.  Changes to this assumption will require
2686  * additional locking.  Returns 0.
2687  */
2688 static int __init _add_link(struct omap_hwmod_ocp_if *oi)
2689 {
2690         struct omap_hwmod_link *ml, *sl;
2691
2692         pr_debug("omap_hwmod: %s -> %s: adding link\n", oi->master->name,
2693                  oi->slave->name);
2694
2695         _alloc_links(&ml, &sl);
2696
2697         ml->ocp_if = oi;
2698         INIT_LIST_HEAD(&ml->node);
2699         list_add(&ml->node, &oi->master->master_ports);
2700         oi->master->masters_cnt++;
2701
2702         sl->ocp_if = oi;
2703         INIT_LIST_HEAD(&sl->node);
2704         list_add(&sl->node, &oi->slave->slave_ports);
2705         oi->slave->slaves_cnt++;
2706
2707         return 0;
2708 }
2709
2710 /**
2711  * _register_link - register a struct omap_hwmod_ocp_if
2712  * @oi: struct omap_hwmod_ocp_if *
2713  *
2714  * Registers the omap_hwmod_ocp_if record @oi.  Returns -EEXIST if it
2715  * has already been registered; -EINVAL if @oi is NULL or if the
2716  * record pointed to by @oi is missing required fields; or 0 upon
2717  * success.
2718  *
2719  * XXX The data should be copied into bootmem, so the original data
2720  * should be marked __initdata and freed after init.  This would allow
2721  * unneeded omap_hwmods to be freed on multi-OMAP configurations.
2722  */
2723 static int __init _register_link(struct omap_hwmod_ocp_if *oi)
2724 {
2725         if (!oi || !oi->master || !oi->slave || !oi->user)
2726                 return -EINVAL;
2727
2728         if (oi->_int_flags & _OCPIF_INT_FLAGS_REGISTERED)
2729                 return -EEXIST;
2730
2731         pr_debug("omap_hwmod: registering link from %s to %s\n",
2732                  oi->master->name, oi->slave->name);
2733
2734         /*
2735          * Register the connected hwmods, if they haven't been
2736          * registered already
2737          */
2738         if (oi->master->_state != _HWMOD_STATE_REGISTERED)
2739                 _register(oi->master);
2740
2741         if (oi->slave->_state != _HWMOD_STATE_REGISTERED)
2742                 _register(oi->slave);
2743
2744         _add_link(oi);
2745
2746         oi->_int_flags |= _OCPIF_INT_FLAGS_REGISTERED;
2747
2748         return 0;
2749 }
2750
2751 /**
2752  * _alloc_linkspace - allocate large block of hwmod links
2753  * @ois: pointer to an array of struct omap_hwmod_ocp_if records to count
2754  *
2755  * Allocate a large block of struct omap_hwmod_link records.  This
2756  * improves boot time significantly by avoiding the need to allocate
2757  * individual records one by one.  If the number of records to
2758  * allocate in the block hasn't been manually specified, this function
2759  * will count the number of struct omap_hwmod_ocp_if records in @ois
2760  * and use that to determine the allocation size.  For SoC families
2761  * that require multiple list registrations, such as OMAP3xxx, this
2762  * estimation process isn't optimal, so manual estimation is advised
2763  * in those cases.  Returns -EEXIST if the allocation has already occurred
2764  * or 0 upon success.
2765  */
2766 static int __init _alloc_linkspace(struct omap_hwmod_ocp_if **ois)
2767 {
2768         unsigned int i = 0;
2769         unsigned int sz;
2770
2771         if (linkspace) {
2772                 WARN(1, "linkspace already allocated\n");
2773                 return -EEXIST;
2774         }
2775
2776         if (max_ls == 0)
2777                 while (ois[i++])
2778                         max_ls += LINKS_PER_OCP_IF;
2779
2780         sz = sizeof(struct omap_hwmod_link) * max_ls;
2781
2782         pr_debug("omap_hwmod: %s: allocating %d byte linkspace (%d links)\n",
2783                  __func__, sz, max_ls);
2784
2785         linkspace = alloc_bootmem(sz);
2786
2787         memset(linkspace, 0, sz);
2788
2789         return 0;
2790 }
2791
2792 /* Static functions intended only for use in soc_ops field function pointers */
2793
2794 /**
2795  * _omap2xxx_wait_target_ready - wait for a module to leave slave idle
2796  * @oh: struct omap_hwmod *
2797  *
2798  * Wait for a module @oh to leave slave idle.  Returns 0 if the module
2799  * does not have an IDLEST bit or if the module successfully leaves
2800  * slave idle; otherwise, pass along the return value of the
2801  * appropriate *_cm*_wait_module_ready() function.
2802  */
2803 static int _omap2xxx_wait_target_ready(struct omap_hwmod *oh)
2804 {
2805         if (!oh)
2806                 return -EINVAL;
2807
2808         if (oh->flags & HWMOD_NO_IDLEST)
2809                 return 0;
2810
2811         if (!_find_mpu_rt_port(oh))
2812                 return 0;
2813
2814         /* XXX check module SIDLEMODE, hardreset status, enabled clocks */
2815
2816         return omap2xxx_cm_wait_module_ready(oh->prcm.omap2.module_offs,
2817                                              oh->prcm.omap2.idlest_reg_id,
2818                                              oh->prcm.omap2.idlest_idle_bit);
2819 }
2820
2821 /**
2822  * _omap3xxx_wait_target_ready - wait for a module to leave slave idle
2823  * @oh: struct omap_hwmod *
2824  *
2825  * Wait for a module @oh to leave slave idle.  Returns 0 if the module
2826  * does not have an IDLEST bit or if the module successfully leaves
2827  * slave idle; otherwise, pass along the return value of the
2828  * appropriate *_cm*_wait_module_ready() function.
2829  */
2830 static int _omap3xxx_wait_target_ready(struct omap_hwmod *oh)
2831 {
2832         if (!oh)
2833                 return -EINVAL;
2834
2835         if (oh->flags & HWMOD_NO_IDLEST)
2836                 return 0;
2837
2838         if (!_find_mpu_rt_port(oh))
2839                 return 0;
2840
2841         /* XXX check module SIDLEMODE, hardreset status, enabled clocks */
2842
2843         return omap3xxx_cm_wait_module_ready(oh->prcm.omap2.module_offs,
2844                                              oh->prcm.omap2.idlest_reg_id,
2845                                              oh->prcm.omap2.idlest_idle_bit);
2846 }
2847
2848 /**
2849  * _omap4_wait_target_ready - wait for a module to leave slave idle
2850  * @oh: struct omap_hwmod *
2851  *
2852  * Wait for a module @oh to leave slave idle.  Returns 0 if the module
2853  * does not have an IDLEST bit or if the module successfully leaves
2854  * slave idle; otherwise, pass along the return value of the
2855  * appropriate *_cm*_wait_module_ready() function.
2856  */
2857 static int _omap4_wait_target_ready(struct omap_hwmod *oh)
2858 {
2859         if (!oh)
2860                 return -EINVAL;
2861
2862         if (oh->flags & HWMOD_NO_IDLEST || !oh->clkdm)
2863                 return 0;
2864
2865         if (!_find_mpu_rt_port(oh))
2866                 return 0;
2867
2868         /* XXX check module SIDLEMODE, hardreset status */
2869
2870         return omap4_cminst_wait_module_ready(oh->clkdm->prcm_partition,
2871                                               oh->clkdm->cm_inst,
2872                                               oh->clkdm->clkdm_offs,
2873                                               oh->prcm.omap4.clkctrl_offs);
2874 }
2875
2876 /**
2877  * _am33xx_wait_target_ready - wait for a module to leave slave idle
2878  * @oh: struct omap_hwmod *
2879  *
2880  * Wait for a module @oh to leave slave idle.  Returns 0 if the module
2881  * does not have an IDLEST bit or if the module successfully leaves
2882  * slave idle; otherwise, pass along the return value of the
2883  * appropriate *_cm*_wait_module_ready() function.
2884  */
2885 static int _am33xx_wait_target_ready(struct omap_hwmod *oh)
2886 {
2887         if (!oh || !oh->clkdm)
2888                 return -EINVAL;
2889
2890         if (oh->flags & HWMOD_NO_IDLEST)
2891                 return 0;
2892
2893         if (!_find_mpu_rt_port(oh))
2894                 return 0;
2895
2896         /* XXX check module SIDLEMODE, hardreset status */
2897
2898         return am33xx_cm_wait_module_ready(oh->clkdm->cm_inst,
2899                                               oh->clkdm->clkdm_offs,
2900                                               oh->prcm.omap4.clkctrl_offs);
2901 }
2902
2903 /**
2904  * _omap2_assert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2905  * @oh: struct omap_hwmod * to assert hardreset
2906  * @ohri: hardreset line data
2907  *
2908  * Call omap2_prm_assert_hardreset() with parameters extracted from
2909  * the hwmod @oh and the hardreset line data @ohri.  Only intended for
2910  * use as an soc_ops function pointer.  Passes along the return value
2911  * from omap2_prm_assert_hardreset().  XXX This function is scheduled
2912  * for removal when the PRM code is moved into drivers/.
2913  */
2914 static int _omap2_assert_hardreset(struct omap_hwmod *oh,
2915                                    struct omap_hwmod_rst_info *ohri)
2916 {
2917         return omap2_prm_assert_hardreset(oh->prcm.omap2.module_offs,
2918                                           ohri->rst_shift);
2919 }
2920
2921 /**
2922  * _omap2_deassert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2923  * @oh: struct omap_hwmod * to deassert hardreset
2924  * @ohri: hardreset line data
2925  *
2926  * Call omap2_prm_deassert_hardreset() with parameters extracted from
2927  * the hwmod @oh and the hardreset line data @ohri.  Only intended for
2928  * use as an soc_ops function pointer.  Passes along the return value
2929  * from omap2_prm_deassert_hardreset().  XXX This function is
2930  * scheduled for removal when the PRM code is moved into drivers/.
2931  */
2932 static int _omap2_deassert_hardreset(struct omap_hwmod *oh,
2933                                      struct omap_hwmod_rst_info *ohri)
2934 {
2935         return omap2_prm_deassert_hardreset(oh->prcm.omap2.module_offs,
2936                                             ohri->rst_shift,
2937                                             ohri->st_shift);
2938 }
2939
2940 /**
2941  * _omap2_is_hardreset_asserted - call OMAP2 PRM hardreset fn with hwmod args
2942  * @oh: struct omap_hwmod * to test hardreset
2943  * @ohri: hardreset line data
2944  *
2945  * Call omap2_prm_is_hardreset_asserted() with parameters extracted
2946  * from the hwmod @oh and the hardreset line data @ohri.  Only
2947  * intended for use as an soc_ops function pointer.  Passes along the
2948  * return value from omap2_prm_is_hardreset_asserted().  XXX This
2949  * function is scheduled for removal when the PRM code is moved into
2950  * drivers/.
2951  */
2952 static int _omap2_is_hardreset_asserted(struct omap_hwmod *oh,
2953                                         struct omap_hwmod_rst_info *ohri)
2954 {
2955         return omap2_prm_is_hardreset_asserted(oh->prcm.omap2.module_offs,
2956                                                ohri->st_shift);
2957 }
2958
2959 /**
2960  * _omap4_assert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
2961  * @oh: struct omap_hwmod * to assert hardreset
2962  * @ohri: hardreset line data
2963  *
2964  * Call omap4_prminst_assert_hardreset() with parameters extracted
2965  * from the hwmod @oh and the hardreset line data @ohri.  Only
2966  * intended for use as an soc_ops function pointer.  Passes along the
2967  * return value from omap4_prminst_assert_hardreset().  XXX This
2968  * function is scheduled for removal when the PRM code is moved into
2969  * drivers/.
2970  */
2971 static int _omap4_assert_hardreset(struct omap_hwmod *oh,
2972                                    struct omap_hwmod_rst_info *ohri)
2973 {
2974         if (!oh->clkdm)
2975                 return -EINVAL;
2976
2977         return omap4_prminst_assert_hardreset(ohri->rst_shift,
2978                                 oh->clkdm->pwrdm.ptr->prcm_partition,
2979                                 oh->clkdm->pwrdm.ptr->prcm_offs,
2980                                 oh->prcm.omap4.rstctrl_offs);
2981 }
2982
2983 /**
2984  * _omap4_deassert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
2985  * @oh: struct omap_hwmod * to deassert hardreset
2986  * @ohri: hardreset line data
2987  *
2988  * Call omap4_prminst_deassert_hardreset() with parameters extracted
2989  * from the hwmod @oh and the hardreset line data @ohri.  Only
2990  * intended for use as an soc_ops function pointer.  Passes along the
2991  * return value from omap4_prminst_deassert_hardreset().  XXX This
2992  * function is scheduled for removal when the PRM code is moved into
2993  * drivers/.
2994  */
2995 static int _omap4_deassert_hardreset(struct omap_hwmod *oh,
2996                                      struct omap_hwmod_rst_info *ohri)
2997 {
2998         if (!oh->clkdm)
2999                 return -EINVAL;
3000
3001         if (ohri->st_shift)
3002                 pr_err("omap_hwmod: %s: %s: hwmod data error: OMAP4 does not support st_shift\n",
3003                        oh->name, ohri->name);
3004         return omap4_prminst_deassert_hardreset(ohri->rst_shift,
3005                                 oh->clkdm->pwrdm.ptr->prcm_partition,
3006                                 oh->clkdm->pwrdm.ptr->prcm_offs,
3007                                 oh->prcm.omap4.rstctrl_offs);
3008 }
3009
3010 /**
3011  * _omap4_is_hardreset_asserted - call OMAP4 PRM hardreset fn with hwmod args
3012  * @oh: struct omap_hwmod * to test hardreset
3013  * @ohri: hardreset line data
3014  *
3015  * Call omap4_prminst_is_hardreset_asserted() with parameters
3016  * extracted from the hwmod @oh and the hardreset line data @ohri.
3017  * Only intended for use as an soc_ops function pointer.  Passes along
3018  * the return value from omap4_prminst_is_hardreset_asserted().  XXX
3019  * This function is scheduled for removal when the PRM code is moved
3020  * into drivers/.
3021  */
3022 static int _omap4_is_hardreset_asserted(struct omap_hwmod *oh,
3023                                         struct omap_hwmod_rst_info *ohri)
3024 {
3025         if (!oh->clkdm)
3026                 return -EINVAL;
3027
3028         return omap4_prminst_is_hardreset_asserted(ohri->rst_shift,
3029                                 oh->clkdm->pwrdm.ptr->prcm_partition,
3030                                 oh->clkdm->pwrdm.ptr->prcm_offs,
3031                                 oh->prcm.omap4.rstctrl_offs);
3032 }
3033
3034 /**
3035  * _am33xx_assert_hardreset - call AM33XX PRM hardreset fn with hwmod args
3036  * @oh: struct omap_hwmod * to assert hardreset
3037  * @ohri: hardreset line data
3038  *
3039  * Call am33xx_prminst_assert_hardreset() with parameters extracted
3040  * from the hwmod @oh and the hardreset line data @ohri.  Only
3041  * intended for use as an soc_ops function pointer.  Passes along the
3042  * return value from am33xx_prminst_assert_hardreset().  XXX This
3043  * function is scheduled for removal when the PRM code is moved into
3044  * drivers/.
3045  */
3046 static int _am33xx_assert_hardreset(struct omap_hwmod *oh,
3047                                    struct omap_hwmod_rst_info *ohri)
3048
3049 {
3050         return am33xx_prm_assert_hardreset(ohri->rst_shift,
3051                                 oh->clkdm->pwrdm.ptr->prcm_offs,
3052                                 oh->prcm.omap4.rstctrl_offs);
3053 }
3054
3055 /**
3056  * _am33xx_deassert_hardreset - call AM33XX PRM hardreset fn with hwmod args
3057  * @oh: struct omap_hwmod * to deassert hardreset
3058  * @ohri: hardreset line data
3059  *
3060  * Call am33xx_prminst_deassert_hardreset() with parameters extracted
3061  * from the hwmod @oh and the hardreset line data @ohri.  Only
3062  * intended for use as an soc_ops function pointer.  Passes along the
3063  * return value from am33xx_prminst_deassert_hardreset().  XXX This
3064  * function is scheduled for removal when the PRM code is moved into
3065  * drivers/.
3066  */
3067 static int _am33xx_deassert_hardreset(struct omap_hwmod *oh,
3068                                      struct omap_hwmod_rst_info *ohri)
3069 {
3070         return am33xx_prm_deassert_hardreset(ohri->rst_shift,
3071                                 ohri->st_shift,
3072                                 oh->clkdm->pwrdm.ptr->prcm_offs,
3073                                 oh->prcm.omap4.rstctrl_offs,
3074                                 oh->prcm.omap4.rstst_offs);
3075 }
3076
3077 /**
3078  * _am33xx_is_hardreset_asserted - call AM33XX PRM hardreset fn with hwmod args
3079  * @oh: struct omap_hwmod * to test hardreset
3080  * @ohri: hardreset line data
3081  *
3082  * Call am33xx_prminst_is_hardreset_asserted() with parameters
3083  * extracted from the hwmod @oh and the hardreset line data @ohri.
3084  * Only intended for use as an soc_ops function pointer.  Passes along
3085  * the return value from am33xx_prminst_is_hardreset_asserted().  XXX
3086  * This function is scheduled for removal when the PRM code is moved
3087  * into drivers/.
3088  */
3089 static int _am33xx_is_hardreset_asserted(struct omap_hwmod *oh,
3090                                         struct omap_hwmod_rst_info *ohri)
3091 {
3092         return am33xx_prm_is_hardreset_asserted(ohri->rst_shift,
3093                                 oh->clkdm->pwrdm.ptr->prcm_offs,
3094                                 oh->prcm.omap4.rstctrl_offs);
3095 }
3096
3097 /* Public functions */
3098
3099 u32 omap_hwmod_read(struct omap_hwmod *oh, u16 reg_offs)
3100 {
3101         if (oh->flags & HWMOD_16BIT_REG)
3102                 return __raw_readw(oh->_mpu_rt_va + reg_offs);
3103         else
3104                 return __raw_readl(oh->_mpu_rt_va + reg_offs);
3105 }
3106
3107 void omap_hwmod_write(u32 v, struct omap_hwmod *oh, u16 reg_offs)
3108 {
3109         if (oh->flags & HWMOD_16BIT_REG)
3110                 __raw_writew(v, oh->_mpu_rt_va + reg_offs);
3111         else
3112                 __raw_writel(v, oh->_mpu_rt_va + reg_offs);
3113 }
3114
3115 /**
3116  * omap_hwmod_softreset - reset a module via SYSCONFIG.SOFTRESET bit
3117  * @oh: struct omap_hwmod *
3118  *
3119  * This is a public function exposed to drivers. Some drivers may need to do
3120  * some settings before and after resetting the device.  Those drivers after
3121  * doing the necessary settings could use this function to start a reset by
3122  * setting the SYSCONFIG.SOFTRESET bit.
3123  */
3124 int omap_hwmod_softreset(struct omap_hwmod *oh)
3125 {
3126         u32 v;
3127         int ret;
3128
3129         if (!oh || !(oh->_sysc_cache))
3130                 return -EINVAL;
3131
3132         v = oh->_sysc_cache;
3133         ret = _set_softreset(oh, &v);
3134         if (ret)
3135                 goto error;
3136         _write_sysconfig(v, oh);
3137
3138 error:
3139         return ret;
3140 }
3141
3142 /**
3143  * omap_hwmod_set_slave_idlemode - set the hwmod's OCP slave idlemode
3144  * @oh: struct omap_hwmod *
3145  * @idlemode: SIDLEMODE field bits (shifted to bit 0)
3146  *
3147  * Sets the IP block's OCP slave idlemode in hardware, and updates our
3148  * local copy.  Intended to be used by drivers that have some erratum
3149  * that requires direct manipulation of the SIDLEMODE bits.  Returns
3150  * -EINVAL if @oh is null, or passes along the return value from
3151  * _set_slave_idlemode().
3152  *
3153  * XXX Does this function have any current users?  If not, we should
3154  * remove it; it is better to let the rest of the hwmod code handle this.
3155  * Any users of this function should be scrutinized carefully.
3156  */
3157 int omap_hwmod_set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode)
3158 {
3159         u32 v;
3160         int retval = 0;
3161
3162         if (!oh)
3163                 return -EINVAL;
3164
3165         v = oh->_sysc_cache;
3166
3167         retval = _set_slave_idlemode(oh, idlemode, &v);
3168         if (!retval)
3169                 _write_sysconfig(v, oh);
3170
3171         return retval;
3172 }
3173
3174 /**
3175  * omap_hwmod_lookup - look up a registered omap_hwmod by name
3176  * @name: name of the omap_hwmod to look up
3177  *
3178  * Given a @name of an omap_hwmod, return a pointer to the registered
3179  * struct omap_hwmod *, or NULL upon error.
3180  */
3181 struct omap_hwmod *omap_hwmod_lookup(const char *name)
3182 {
3183         struct omap_hwmod *oh;
3184
3185         if (!name)
3186                 return NULL;
3187
3188         oh = _lookup(name);
3189
3190         return oh;
3191 }
3192
3193 /**
3194  * omap_hwmod_for_each - call function for each registered omap_hwmod
3195  * @fn: pointer to a callback function
3196  * @data: void * data to pass to callback function
3197  *
3198  * Call @fn for each registered omap_hwmod, passing @data to each
3199  * function.  @fn must return 0 for success or any other value for
3200  * failure.  If @fn returns non-zero, the iteration across omap_hwmods
3201  * will stop and the non-zero return value will be passed to the
3202  * caller of omap_hwmod_for_each().  @fn is called with
3203  * omap_hwmod_for_each() held.
3204  */
3205 int omap_hwmod_for_each(int (*fn)(struct omap_hwmod *oh, void *data),
3206                         void *data)
3207 {
3208         struct omap_hwmod *temp_oh;
3209         int ret = 0;
3210
3211         if (!fn)
3212                 return -EINVAL;
3213
3214         list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
3215                 ret = (*fn)(temp_oh, data);
3216                 if (ret)
3217                         break;
3218         }
3219
3220         return ret;
3221 }
3222
3223 /**
3224  * omap_hwmod_register_links - register an array of hwmod links
3225  * @ois: pointer to an array of omap_hwmod_ocp_if to register
3226  *
3227  * Intended to be called early in boot before the clock framework is
3228  * initialized.  If @ois is not null, will register all omap_hwmods
3229  * listed in @ois that are valid for this chip.  Returns -EINVAL if
3230  * omap_hwmod_init() hasn't been called before calling this function,
3231  * -ENOMEM if the link memory area can't be allocated, or 0 upon
3232  * success.
3233  */
3234 int __init omap_hwmod_register_links(struct omap_hwmod_ocp_if **ois)
3235 {
3236         int r, i;
3237
3238         if (!inited)
3239                 return -EINVAL;
3240
3241         if (!ois)
3242                 return 0;
3243
3244         if (!linkspace) {
3245                 if (_alloc_linkspace(ois)) {
3246                         pr_err("omap_hwmod: could not allocate link space\n");
3247                         return -ENOMEM;
3248                 }
3249         }
3250
3251         i = 0;
3252         do {
3253                 r = _register_link(ois[i]);
3254                 WARN(r && r != -EEXIST,
3255                      "omap_hwmod: _register_link(%s -> %s) returned %d\n",
3256                      ois[i]->master->name, ois[i]->slave->name, r);
3257         } while (ois[++i]);
3258
3259         return 0;
3260 }
3261
3262 /**
3263  * _ensure_mpu_hwmod_is_setup - ensure the MPU SS hwmod is init'ed and set up
3264  * @oh: pointer to the hwmod currently being set up (usually not the MPU)
3265  *
3266  * If the hwmod data corresponding to the MPU subsystem IP block
3267  * hasn't been initialized and set up yet, do so now.  This must be
3268  * done first since sleep dependencies may be added from other hwmods
3269  * to the MPU.  Intended to be called only by omap_hwmod_setup*().  No
3270  * return value.
3271  */
3272 static void __init _ensure_mpu_hwmod_is_setup(struct omap_hwmod *oh)
3273 {
3274         if (!mpu_oh || mpu_oh->_state == _HWMOD_STATE_UNKNOWN)
3275                 pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",
3276                        __func__, MPU_INITIATOR_NAME);
3277         else if (mpu_oh->_state == _HWMOD_STATE_REGISTERED && oh != mpu_oh)
3278                 omap_hwmod_setup_one(MPU_INITIATOR_NAME);
3279 }
3280
3281 /**
3282  * omap_hwmod_setup_one - set up a single hwmod
3283  * @oh_name: const char * name of the already-registered hwmod to set up
3284  *
3285  * Initialize and set up a single hwmod.  Intended to be used for a
3286  * small number of early devices, such as the timer IP blocks used for
3287  * the scheduler clock.  Must be called after omap2_clk_init().
3288  * Resolves the struct clk names to struct clk pointers for each
3289  * registered omap_hwmod.  Also calls _setup() on each hwmod.  Returns
3290  * -EINVAL upon error or 0 upon success.
3291  */
3292 int __init omap_hwmod_setup_one(const char *oh_name)
3293 {
3294         struct omap_hwmod *oh;
3295
3296         pr_debug("omap_hwmod: %s: %s\n", oh_name, __func__);
3297
3298         oh = _lookup(oh_name);
3299         if (!oh) {
3300                 WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name);
3301                 return -EINVAL;
3302         }
3303
3304         _ensure_mpu_hwmod_is_setup(oh);
3305
3306         _init(oh, NULL);
3307         _setup(oh, NULL);
3308
3309         return 0;
3310 }
3311
3312 /**
3313  * omap_hwmod_setup_all - set up all registered IP blocks
3314  *
3315  * Initialize and set up all IP blocks registered with the hwmod code.
3316  * Must be called after omap2_clk_init().  Resolves the struct clk
3317  * names to struct clk pointers for each registered omap_hwmod.  Also
3318  * calls _setup() on each hwmod.  Returns 0 upon success.
3319  */
3320 static int __init omap_hwmod_setup_all(void)
3321 {
3322         _ensure_mpu_hwmod_is_setup(NULL);
3323
3324         omap_hwmod_for_each(_init, NULL);
3325         omap_hwmod_for_each(_setup, NULL);
3326
3327         return 0;
3328 }
3329 omap_core_initcall(omap_hwmod_setup_all);
3330
3331 /**
3332  * omap_hwmod_enable - enable an omap_hwmod
3333  * @oh: struct omap_hwmod *
3334  *
3335  * Enable an omap_hwmod @oh.  Intended to be called by omap_device_enable().
3336  * Returns -EINVAL on error or passes along the return value from _enable().
3337  */
3338 int omap_hwmod_enable(struct omap_hwmod *oh)
3339 {
3340         int r;
3341         unsigned long flags;
3342
3343         if (!oh)
3344                 return -EINVAL;
3345
3346         spin_lock_irqsave(&oh->_lock, flags);
3347         r = _enable(oh);
3348         spin_unlock_irqrestore(&oh->_lock, flags);
3349
3350         return r;
3351 }
3352
3353 /**
3354  * omap_hwmod_idle - idle an omap_hwmod
3355  * @oh: struct omap_hwmod *
3356  *
3357  * Idle an omap_hwmod @oh.  Intended to be called by omap_device_idle().
3358  * Returns -EINVAL on error or passes along the return value from _idle().
3359  */
3360 int omap_hwmod_idle(struct omap_hwmod *oh)
3361 {
3362         unsigned long flags;
3363
3364         if (!oh)
3365                 return -EINVAL;
3366
3367         spin_lock_irqsave(&oh->_lock, flags);
3368         _idle(oh);
3369         spin_unlock_irqrestore(&oh->_lock, flags);
3370
3371         return 0;
3372 }
3373
3374 /**
3375  * omap_hwmod_shutdown - shutdown an omap_hwmod
3376  * @oh: struct omap_hwmod *
3377  *
3378  * Shutdown an omap_hwmod @oh.  Intended to be called by
3379  * omap_device_shutdown().  Returns -EINVAL on error or passes along
3380  * the return value from _shutdown().
3381  */
3382 int omap_hwmod_shutdown(struct omap_hwmod *oh)
3383 {
3384         unsigned long flags;
3385
3386         if (!oh)
3387                 return -EINVAL;
3388
3389         spin_lock_irqsave(&oh->_lock, flags);
3390         _shutdown(oh);
3391         spin_unlock_irqrestore(&oh->_lock, flags);
3392
3393         return 0;
3394 }
3395
3396 /**
3397  * omap_hwmod_enable_clocks - enable main_clk, all interface clocks
3398  * @oh: struct omap_hwmod *oh
3399  *
3400  * Intended to be called by the omap_device code.
3401  */
3402 int omap_hwmod_enable_clocks(struct omap_hwmod *oh)
3403 {
3404         unsigned long flags;
3405
3406         spin_lock_irqsave(&oh->_lock, flags);
3407         _enable_clocks(oh);
3408         spin_unlock_irqrestore(&oh->_lock, flags);
3409
3410         return 0;
3411 }
3412
3413 /**
3414  * omap_hwmod_disable_clocks - disable main_clk, all interface clocks
3415  * @oh: struct omap_hwmod *oh
3416  *
3417  * Intended to be called by the omap_device code.
3418  */
3419 int omap_hwmod_disable_clocks(struct omap_hwmod *oh)
3420 {
3421         unsigned long flags;
3422
3423         spin_lock_irqsave(&oh->_lock, flags);
3424         _disable_clocks(oh);
3425         spin_unlock_irqrestore(&oh->_lock, flags);
3426
3427         return 0;
3428 }
3429
3430 /**
3431  * omap_hwmod_ocp_barrier - wait for posted writes against the hwmod to complete
3432  * @oh: struct omap_hwmod *oh
3433  *
3434  * Intended to be called by drivers and core code when all posted
3435  * writes to a device must complete before continuing further
3436  * execution (for example, after clearing some device IRQSTATUS
3437  * register bits)
3438  *
3439  * XXX what about targets with multiple OCP threads?
3440  */
3441 void omap_hwmod_ocp_barrier(struct omap_hwmod *oh)
3442 {
3443         BUG_ON(!oh);
3444
3445         if (!oh->class->sysc || !oh->class->sysc->sysc_flags) {
3446                 WARN(1, "omap_device: %s: OCP barrier impossible due to device configuration\n",
3447                         oh->name);
3448                 return;
3449         }
3450
3451         /*
3452          * Forces posted writes to complete on the OCP thread handling
3453          * register writes
3454          */
3455         omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
3456 }
3457
3458 /**
3459  * omap_hwmod_reset - reset the hwmod
3460  * @oh: struct omap_hwmod *
3461  *
3462  * Under some conditions, a driver may wish to reset the entire device.
3463  * Called from omap_device code.  Returns -EINVAL on error or passes along
3464  * the return value from _reset().
3465  */
3466 int omap_hwmod_reset(struct omap_hwmod *oh)
3467 {
3468         int r;
3469         unsigned long flags;
3470
3471         if (!oh)
3472                 return -EINVAL;
3473
3474         spin_lock_irqsave(&oh->_lock, flags);
3475         r = _reset(oh);
3476         spin_unlock_irqrestore(&oh->_lock, flags);
3477
3478         return r;
3479 }
3480
3481 /*
3482  * IP block data retrieval functions
3483  */
3484
3485 /**
3486  * omap_hwmod_count_resources - count number of struct resources needed by hwmod
3487  * @oh: struct omap_hwmod *
3488  * @flags: Type of resources to include when counting (IRQ/DMA/MEM)
3489  *
3490  * Count the number of struct resource array elements necessary to
3491  * contain omap_hwmod @oh resources.  Intended to be called by code
3492  * that registers omap_devices.  Intended to be used to determine the
3493  * size of a dynamically-allocated struct resource array, before
3494  * calling omap_hwmod_fill_resources().  Returns the number of struct
3495  * resource array elements needed.
3496  *
3497  * XXX This code is not optimized.  It could attempt to merge adjacent
3498  * resource IDs.
3499  *
3500  */
3501 int omap_hwmod_count_resources(struct omap_hwmod *oh, unsigned long flags)
3502 {
3503         int ret = 0;
3504
3505         if (flags & IORESOURCE_IRQ)
3506                 ret += _count_mpu_irqs(oh);
3507
3508         if (flags & IORESOURCE_DMA)
3509                 ret += _count_sdma_reqs(oh);
3510
3511         if (flags & IORESOURCE_MEM) {
3512                 int i = 0;
3513                 struct omap_hwmod_ocp_if *os;
3514                 struct list_head *p = oh->slave_ports.next;
3515
3516                 while (i < oh->slaves_cnt) {
3517                         os = _fetch_next_ocp_if(&p, &i);
3518                         ret += _count_ocp_if_addr_spaces(os);
3519                 }
3520         }
3521
3522         return ret;
3523 }
3524
3525 /**
3526  * omap_hwmod_fill_resources - fill struct resource array with hwmod data
3527  * @oh: struct omap_hwmod *
3528  * @res: pointer to the first element of an array of struct resource to fill
3529  *
3530  * Fill the struct resource array @res with resource data from the
3531  * omap_hwmod @oh.  Intended to be called by code that registers
3532  * omap_devices.  See also omap_hwmod_count_resources().  Returns the
3533  * number of array elements filled.
3534  */
3535 int omap_hwmod_fill_resources(struct omap_hwmod *oh, struct resource *res)
3536 {
3537         struct omap_hwmod_ocp_if *os;
3538         struct list_head *p;
3539         int i, j, mpu_irqs_cnt, sdma_reqs_cnt, addr_cnt;
3540         int r = 0;
3541
3542         /* For each IRQ, DMA, memory area, fill in array.*/
3543
3544         mpu_irqs_cnt = _count_mpu_irqs(oh);
3545         for (i = 0; i < mpu_irqs_cnt; i++) {
3546                 (res + r)->name = (oh->mpu_irqs + i)->name;
3547                 (res + r)->start = (oh->mpu_irqs + i)->irq;
3548                 (res + r)->end = (oh->mpu_irqs + i)->irq;
3549                 (res + r)->flags = IORESOURCE_IRQ;
3550                 r++;
3551         }
3552
3553         sdma_reqs_cnt = _count_sdma_reqs(oh);
3554         for (i = 0; i < sdma_reqs_cnt; i++) {
3555                 (res + r)->name = (oh->sdma_reqs + i)->name;
3556                 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
3557                 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
3558                 (res + r)->flags = IORESOURCE_DMA;
3559                 r++;
3560         }
3561
3562         p = oh->slave_ports.next;
3563
3564         i = 0;
3565         while (i < oh->slaves_cnt) {
3566                 os = _fetch_next_ocp_if(&p, &i);
3567                 addr_cnt = _count_ocp_if_addr_spaces(os);
3568
3569                 for (j = 0; j < addr_cnt; j++) {
3570                         (res + r)->name = (os->addr + j)->name;
3571                         (res + r)->start = (os->addr + j)->pa_start;
3572                         (res + r)->end = (os->addr + j)->pa_end;
3573                         (res + r)->flags = IORESOURCE_MEM;
3574                         r++;
3575                 }
3576         }
3577
3578         return r;
3579 }
3580
3581 /**
3582  * omap_hwmod_fill_dma_resources - fill struct resource array with dma data
3583  * @oh: struct omap_hwmod *
3584  * @res: pointer to the array of struct resource to fill
3585  *
3586  * Fill the struct resource array @res with dma resource data from the
3587  * omap_hwmod @oh.  Intended to be called by code that registers
3588  * omap_devices.  See also omap_hwmod_count_resources().  Returns the
3589  * number of array elements filled.
3590  */
3591 int omap_hwmod_fill_dma_resources(struct omap_hwmod *oh, struct resource *res)
3592 {
3593         int i, sdma_reqs_cnt;
3594         int r = 0;
3595
3596         sdma_reqs_cnt = _count_sdma_reqs(oh);
3597         for (i = 0; i < sdma_reqs_cnt; i++) {
3598                 (res + r)->name = (oh->sdma_reqs + i)->name;
3599                 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
3600                 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
3601                 (res + r)->flags = IORESOURCE_DMA;
3602                 r++;
3603         }
3604
3605         return r;
3606 }
3607
3608 /**
3609  * omap_hwmod_get_resource_byname - fetch IP block integration data by name
3610  * @oh: struct omap_hwmod * to operate on
3611  * @type: one of the IORESOURCE_* constants from include/linux/ioport.h
3612  * @name: pointer to the name of the data to fetch (optional)
3613  * @rsrc: pointer to a struct resource, allocated by the caller
3614  *
3615  * Retrieve MPU IRQ, SDMA request line, or address space start/end
3616  * data for the IP block pointed to by @oh.  The data will be filled
3617  * into a struct resource record pointed to by @rsrc.  The struct
3618  * resource must be allocated by the caller.  When @name is non-null,
3619  * the data associated with the matching entry in the IRQ/SDMA/address
3620  * space hwmod data arrays will be returned.  If @name is null, the
3621  * first array entry will be returned.  Data order is not meaningful
3622  * in hwmod data, so callers are strongly encouraged to use a non-null
3623  * @name whenever possible to avoid unpredictable effects if hwmod
3624  * data is later added that causes data ordering to change.  This
3625  * function is only intended for use by OMAP core code.  Device
3626  * drivers should not call this function - the appropriate bus-related
3627  * data accessor functions should be used instead.  Returns 0 upon
3628  * success or a negative error code upon error.
3629  */
3630 int omap_hwmod_get_resource_byname(struct omap_hwmod *oh, unsigned int type,
3631                                    const char *name, struct resource *rsrc)
3632 {
3633         int r;
3634         unsigned int irq, dma;
3635         u32 pa_start, pa_end;
3636
3637         if (!oh || !rsrc)
3638                 return -EINVAL;
3639
3640         if (type == IORESOURCE_IRQ) {
3641                 r = _get_mpu_irq_by_name(oh, name, &irq);
3642                 if (r)
3643                         return r;
3644
3645                 rsrc->start = irq;
3646                 rsrc->end = irq;
3647         } else if (type == IORESOURCE_DMA) {
3648                 r = _get_sdma_req_by_name(oh, name, &dma);
3649                 if (r)
3650                         return r;
3651
3652                 rsrc->start = dma;
3653                 rsrc->end = dma;
3654         } else if (type == IORESOURCE_MEM) {
3655                 r = _get_addr_space_by_name(oh, name, &pa_start, &pa_end);
3656                 if (r)
3657                         return r;
3658
3659                 rsrc->start = pa_start;
3660                 rsrc->end = pa_end;
3661         } else {
3662                 return -EINVAL;
3663         }
3664
3665         rsrc->flags = type;
3666         rsrc->name = name;
3667
3668         return 0;
3669 }
3670
3671 /**
3672  * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
3673  * @oh: struct omap_hwmod *
3674  *
3675  * Return the powerdomain pointer associated with the OMAP module
3676  * @oh's main clock.  If @oh does not have a main clk, return the
3677  * powerdomain associated with the interface clock associated with the
3678  * module's MPU port. (XXX Perhaps this should use the SDMA port
3679  * instead?)  Returns NULL on error, or a struct powerdomain * on
3680  * success.
3681  */
3682 struct powerdomain *omap_hwmod_get_pwrdm(struct omap_hwmod *oh)
3683 {
3684         struct clk *c;
3685         struct omap_hwmod_ocp_if *oi;
3686         struct clockdomain *clkdm;
3687         struct clk_hw_omap *clk;
3688
3689         if (!oh)
3690                 return NULL;
3691
3692         if (oh->clkdm)
3693                 return oh->clkdm->pwrdm.ptr;
3694
3695         if (oh->_clk) {
3696                 c = oh->_clk;
3697         } else {
3698                 oi = _find_mpu_rt_port(oh);
3699                 if (!oi)
3700                         return NULL;
3701                 c = oi->_clk;
3702         }
3703
3704         clk = to_clk_hw_omap(__clk_get_hw(c));
3705         clkdm = clk->clkdm;
3706         if (!clkdm)
3707                 return NULL;
3708
3709         return clkdm->pwrdm.ptr;
3710 }
3711
3712 /**
3713  * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
3714  * @oh: struct omap_hwmod *
3715  *
3716  * Returns the virtual address corresponding to the beginning of the
3717  * module's register target, in the address range that is intended to
3718  * be used by the MPU.  Returns the virtual address upon success or NULL
3719  * upon error.
3720  */
3721 void __iomem *omap_hwmod_get_mpu_rt_va(struct omap_hwmod *oh)
3722 {
3723         if (!oh)
3724                 return NULL;
3725
3726         if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
3727                 return NULL;
3728
3729         if (oh->_state == _HWMOD_STATE_UNKNOWN)
3730                 return NULL;
3731
3732         return oh->_mpu_rt_va;
3733 }
3734
3735 /**
3736  * omap_hwmod_add_initiator_dep - add sleepdep from @init_oh to @oh
3737  * @oh: struct omap_hwmod *
3738  * @init_oh: struct omap_hwmod * (initiator)
3739  *
3740  * Add a sleep dependency between the initiator @init_oh and @oh.
3741  * Intended to be called by DSP/Bridge code via platform_data for the
3742  * DSP case; and by the DMA code in the sDMA case.  DMA code, *Bridge
3743  * code needs to add/del initiator dependencies dynamically
3744  * before/after accessing a device.  Returns the return value from
3745  * _add_initiator_dep().
3746  *
3747  * XXX Keep a usecount in the clockdomain code
3748  */
3749 int omap_hwmod_add_initiator_dep(struct omap_hwmod *oh,
3750                                  struct omap_hwmod *init_oh)
3751 {
3752         return _add_initiator_dep(oh, init_oh);
3753 }
3754
3755 /*
3756  * XXX what about functions for drivers to save/restore ocp_sysconfig
3757  * for context save/restore operations?
3758  */
3759
3760 /**
3761  * omap_hwmod_del_initiator_dep - remove sleepdep from @init_oh to @oh
3762  * @oh: struct omap_hwmod *
3763  * @init_oh: struct omap_hwmod * (initiator)
3764  *
3765  * Remove a sleep dependency between the initiator @init_oh and @oh.
3766  * Intended to be called by DSP/Bridge code via platform_data for the
3767  * DSP case; and by the DMA code in the sDMA case.  DMA code, *Bridge
3768  * code needs to add/del initiator dependencies dynamically
3769  * before/after accessing a device.  Returns the return value from
3770  * _del_initiator_dep().
3771  *
3772  * XXX Keep a usecount in the clockdomain code
3773  */
3774 int omap_hwmod_del_initiator_dep(struct omap_hwmod *oh,
3775                                  struct omap_hwmod *init_oh)
3776 {
3777         return _del_initiator_dep(oh, init_oh);
3778 }
3779
3780 /**
3781  * omap_hwmod_enable_wakeup - allow device to wake up the system
3782  * @oh: struct omap_hwmod *
3783  *
3784  * Sets the module OCP socket ENAWAKEUP bit to allow the module to
3785  * send wakeups to the PRCM, and enable I/O ring wakeup events for
3786  * this IP block if it has dynamic mux entries.  Eventually this
3787  * should set PRCM wakeup registers to cause the PRCM to receive
3788  * wakeup events from the module.  Does not set any wakeup routing
3789  * registers beyond this point - if the module is to wake up any other
3790  * module or subsystem, that must be set separately.  Called by
3791  * omap_device code.  Returns -EINVAL on error or 0 upon success.
3792  */
3793 int omap_hwmod_enable_wakeup(struct omap_hwmod *oh)
3794 {
3795         unsigned long flags;
3796         u32 v;
3797
3798         spin_lock_irqsave(&oh->_lock, flags);
3799
3800         if (oh->class->sysc &&
3801             (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)) {
3802                 v = oh->_sysc_cache;
3803                 _enable_wakeup(oh, &v);
3804                 _write_sysconfig(v, oh);
3805         }
3806
3807         _set_idle_ioring_wakeup(oh, true);
3808         spin_unlock_irqrestore(&oh->_lock, flags);
3809
3810         return 0;
3811 }
3812
3813 /**
3814  * omap_hwmod_disable_wakeup - prevent device from waking the system
3815  * @oh: struct omap_hwmod *
3816  *
3817  * Clears the module OCP socket ENAWAKEUP bit to prevent the module
3818  * from sending wakeups to the PRCM, and disable I/O ring wakeup
3819  * events for this IP block if it has dynamic mux entries.  Eventually
3820  * this should clear PRCM wakeup registers to cause the PRCM to ignore
3821  * wakeup events from the module.  Does not set any wakeup routing
3822  * registers beyond this point - if the module is to wake up any other
3823  * module or subsystem, that must be set separately.  Called by
3824  * omap_device code.  Returns -EINVAL on error or 0 upon success.
3825  */
3826 int omap_hwmod_disable_wakeup(struct omap_hwmod *oh)
3827 {
3828         unsigned long flags;
3829         u32 v;
3830
3831         spin_lock_irqsave(&oh->_lock, flags);
3832
3833         if (oh->class->sysc &&
3834             (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)) {
3835                 v = oh->_sysc_cache;
3836                 _disable_wakeup(oh, &v);
3837                 _write_sysconfig(v, oh);
3838         }
3839
3840         _set_idle_ioring_wakeup(oh, false);
3841         spin_unlock_irqrestore(&oh->_lock, flags);
3842
3843         return 0;
3844 }
3845
3846 /**
3847  * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
3848  * contained in the hwmod module.
3849  * @oh: struct omap_hwmod *
3850  * @name: name of the reset line to lookup and assert
3851  *
3852  * Some IP like dsp, ipu or iva contain processor that require
3853  * an HW reset line to be assert / deassert in order to enable fully
3854  * the IP.  Returns -EINVAL if @oh is null or if the operation is not
3855  * yet supported on this OMAP; otherwise, passes along the return value
3856  * from _assert_hardreset().
3857  */
3858 int omap_hwmod_assert_hardreset(struct omap_hwmod *oh, const char *name)
3859 {
3860         int ret;
3861         unsigned long flags;
3862
3863         if (!oh)
3864                 return -EINVAL;
3865
3866         spin_lock_irqsave(&oh->_lock, flags);
3867         ret = _assert_hardreset(oh, name);
3868         spin_unlock_irqrestore(&oh->_lock, flags);
3869
3870         return ret;
3871 }
3872
3873 /**
3874  * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
3875  * contained in the hwmod module.
3876  * @oh: struct omap_hwmod *
3877  * @name: name of the reset line to look up and deassert
3878  *
3879  * Some IP like dsp, ipu or iva contain processor that require
3880  * an HW reset line to be assert / deassert in order to enable fully
3881  * the IP.  Returns -EINVAL if @oh is null or if the operation is not
3882  * yet supported on this OMAP; otherwise, passes along the return value
3883  * from _deassert_hardreset().
3884  */
3885 int omap_hwmod_deassert_hardreset(struct omap_hwmod *oh, const char *name)
3886 {
3887         int ret;
3888         unsigned long flags;
3889
3890         if (!oh)
3891                 return -EINVAL;
3892
3893         spin_lock_irqsave(&oh->_lock, flags);
3894         ret = _deassert_hardreset(oh, name);
3895         spin_unlock_irqrestore(&oh->_lock, flags);
3896
3897         return ret;
3898 }
3899
3900 /**
3901  * omap_hwmod_read_hardreset - read the HW reset line state of submodules
3902  * contained in the hwmod module
3903  * @oh: struct omap_hwmod *
3904  * @name: name of the reset line to look up and read
3905  *
3906  * Return the current state of the hwmod @oh's reset line named @name:
3907  * returns -EINVAL upon parameter error or if this operation
3908  * is unsupported on the current OMAP; otherwise, passes along the return
3909  * value from _read_hardreset().
3910  */
3911 int omap_hwmod_read_hardreset(struct omap_hwmod *oh, const char *name)
3912 {
3913         int ret;
3914         unsigned long flags;
3915
3916         if (!oh)
3917                 return -EINVAL;
3918
3919         spin_lock_irqsave(&oh->_lock, flags);
3920         ret = _read_hardreset(oh, name);
3921         spin_unlock_irqrestore(&oh->_lock, flags);
3922
3923         return ret;
3924 }
3925
3926
3927 /**
3928  * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
3929  * @classname: struct omap_hwmod_class name to search for
3930  * @fn: callback function pointer to call for each hwmod in class @classname
3931  * @user: arbitrary context data to pass to the callback function
3932  *
3933  * For each omap_hwmod of class @classname, call @fn.
3934  * If the callback function returns something other than
3935  * zero, the iterator is terminated, and the callback function's return
3936  * value is passed back to the caller.  Returns 0 upon success, -EINVAL
3937  * if @classname or @fn are NULL, or passes back the error code from @fn.
3938  */
3939 int omap_hwmod_for_each_by_class(const char *classname,
3940                                  int (*fn)(struct omap_hwmod *oh,
3941                                            void *user),
3942                                  void *user)
3943 {
3944         struct omap_hwmod *temp_oh;
3945         int ret = 0;
3946
3947         if (!classname || !fn)
3948                 return -EINVAL;
3949
3950         pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
3951                  __func__, classname);
3952
3953         list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
3954                 if (!strcmp(temp_oh->class->name, classname)) {
3955                         pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
3956                                  __func__, temp_oh->name);
3957                         ret = (*fn)(temp_oh, user);
3958                         if (ret)
3959                                 break;
3960                 }
3961         }
3962
3963         if (ret)
3964                 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
3965                          __func__, ret);
3966
3967         return ret;
3968 }
3969
3970 /**
3971  * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
3972  * @oh: struct omap_hwmod *
3973  * @state: state that _setup() should leave the hwmod in
3974  *
3975  * Sets the hwmod state that @oh will enter at the end of _setup()
3976  * (called by omap_hwmod_setup_*()).  See also the documentation
3977  * for _setup_postsetup(), above.  Returns 0 upon success or
3978  * -EINVAL if there is a problem with the arguments or if the hwmod is
3979  * in the wrong state.
3980  */
3981 int omap_hwmod_set_postsetup_state(struct omap_hwmod *oh, u8 state)
3982 {
3983         int ret;
3984         unsigned long flags;
3985
3986         if (!oh)
3987                 return -EINVAL;
3988
3989         if (state != _HWMOD_STATE_DISABLED &&
3990             state != _HWMOD_STATE_ENABLED &&
3991             state != _HWMOD_STATE_IDLE)
3992                 return -EINVAL;
3993
3994         spin_lock_irqsave(&oh->_lock, flags);
3995
3996         if (oh->_state != _HWMOD_STATE_REGISTERED) {
3997                 ret = -EINVAL;
3998                 goto ohsps_unlock;
3999         }
4000
4001         oh->_postsetup_state = state;
4002         ret = 0;
4003
4004 ohsps_unlock:
4005         spin_unlock_irqrestore(&oh->_lock, flags);
4006
4007         return ret;
4008 }
4009
4010 /**
4011  * omap_hwmod_get_context_loss_count - get lost context count
4012  * @oh: struct omap_hwmod *
4013  *
4014  * Returns the context loss count of associated @oh
4015  * upon success, or zero if no context loss data is available.
4016  *
4017  * On OMAP4, this queries the per-hwmod context loss register,
4018  * assuming one exists.  If not, or on OMAP2/3, this queries the
4019  * enclosing powerdomain context loss count.
4020  */
4021 int omap_hwmod_get_context_loss_count(struct omap_hwmod *oh)
4022 {
4023         struct powerdomain *pwrdm;
4024         int ret = 0;
4025
4026         if (soc_ops.get_context_lost)
4027                 return soc_ops.get_context_lost(oh);
4028
4029         pwrdm = omap_hwmod_get_pwrdm(oh);
4030         if (pwrdm)
4031                 ret = pwrdm_get_context_loss_count(pwrdm);
4032
4033         return ret;
4034 }
4035
4036 /**
4037  * omap_hwmod_no_setup_reset - prevent a hwmod from being reset upon setup
4038  * @oh: struct omap_hwmod *
4039  *
4040  * Prevent the hwmod @oh from being reset during the setup process.
4041  * Intended for use by board-*.c files on boards with devices that
4042  * cannot tolerate being reset.  Must be called before the hwmod has
4043  * been set up.  Returns 0 upon success or negative error code upon
4044  * failure.
4045  */
4046 int omap_hwmod_no_setup_reset(struct omap_hwmod *oh)
4047 {
4048         if (!oh)
4049                 return -EINVAL;
4050
4051         if (oh->_state != _HWMOD_STATE_REGISTERED) {
4052                 pr_err("omap_hwmod: %s: cannot prevent setup reset; in wrong state\n",
4053                         oh->name);
4054                 return -EINVAL;
4055         }
4056
4057         oh->flags |= HWMOD_INIT_NO_RESET;
4058
4059         return 0;
4060 }
4061
4062 /**
4063  * omap_hwmod_pad_route_irq - route an I/O pad wakeup to a particular MPU IRQ
4064  * @oh: struct omap_hwmod * containing hwmod mux entries
4065  * @pad_idx: array index in oh->mux of the hwmod mux entry to route wakeup
4066  * @irq_idx: the hwmod mpu_irqs array index of the IRQ to trigger on wakeup
4067  *
4068  * When an I/O pad wakeup arrives for the dynamic or wakeup hwmod mux
4069  * entry number @pad_idx for the hwmod @oh, trigger the interrupt
4070  * service routine for the hwmod's mpu_irqs array index @irq_idx.  If
4071  * this function is not called for a given pad_idx, then the ISR
4072  * associated with @oh's first MPU IRQ will be triggered when an I/O
4073  * pad wakeup occurs on that pad.  Note that @pad_idx is the index of
4074  * the _dynamic or wakeup_ entry: if there are other entries not
4075  * marked with OMAP_DEVICE_PAD_WAKEUP or OMAP_DEVICE_PAD_REMUX, these
4076  * entries are NOT COUNTED in the dynamic pad index.  This function
4077  * must be called separately for each pad that requires its interrupt
4078  * to be re-routed this way.  Returns -EINVAL if there is an argument
4079  * problem or if @oh does not have hwmod mux entries or MPU IRQs;
4080  * returns -ENOMEM if memory cannot be allocated; or 0 upon success.
4081  *
4082  * XXX This function interface is fragile.  Rather than using array
4083  * indexes, which are subject to unpredictable change, it should be
4084  * using hwmod IRQ names, and some other stable key for the hwmod mux
4085  * pad records.
4086  */
4087 int omap_hwmod_pad_route_irq(struct omap_hwmod *oh, int pad_idx, int irq_idx)
4088 {
4089         int nr_irqs;
4090
4091         might_sleep();
4092
4093         if (!oh || !oh->mux || !oh->mpu_irqs || pad_idx < 0 ||
4094             pad_idx >= oh->mux->nr_pads_dynamic)
4095                 return -EINVAL;
4096
4097         /* Check the number of available mpu_irqs */
4098         for (nr_irqs = 0; oh->mpu_irqs[nr_irqs].irq >= 0; nr_irqs++)
4099                 ;
4100
4101         if (irq_idx >= nr_irqs)
4102                 return -EINVAL;
4103
4104         if (!oh->mux->irqs) {
4105                 /* XXX What frees this? */
4106                 oh->mux->irqs = kzalloc(sizeof(int) * oh->mux->nr_pads_dynamic,
4107                         GFP_KERNEL);
4108                 if (!oh->mux->irqs)
4109                         return -ENOMEM;
4110         }
4111         oh->mux->irqs[pad_idx] = irq_idx;
4112
4113         return 0;
4114 }
4115
4116 /**
4117  * omap_hwmod_init - initialize the hwmod code
4118  *
4119  * Sets up some function pointers needed by the hwmod code to operate on the
4120  * currently-booted SoC.  Intended to be called once during kernel init
4121  * before any hwmods are registered.  No return value.
4122  */
4123 void __init omap_hwmod_init(void)
4124 {
4125         if (cpu_is_omap24xx()) {
4126                 soc_ops.wait_target_ready = _omap2xxx_wait_target_ready;
4127                 soc_ops.assert_hardreset = _omap2_assert_hardreset;
4128                 soc_ops.deassert_hardreset = _omap2_deassert_hardreset;
4129                 soc_ops.is_hardreset_asserted = _omap2_is_hardreset_asserted;
4130         } else if (cpu_is_omap34xx()) {
4131                 soc_ops.wait_target_ready = _omap3xxx_wait_target_ready;
4132                 soc_ops.assert_hardreset = _omap2_assert_hardreset;
4133                 soc_ops.deassert_hardreset = _omap2_deassert_hardreset;
4134                 soc_ops.is_hardreset_asserted = _omap2_is_hardreset_asserted;
4135         } else if (cpu_is_omap44xx() || soc_is_omap54xx()) {
4136                 soc_ops.enable_module = _omap4_enable_module;
4137                 soc_ops.disable_module = _omap4_disable_module;
4138                 soc_ops.wait_target_ready = _omap4_wait_target_ready;
4139                 soc_ops.assert_hardreset = _omap4_assert_hardreset;
4140                 soc_ops.deassert_hardreset = _omap4_deassert_hardreset;
4141                 soc_ops.is_hardreset_asserted = _omap4_is_hardreset_asserted;
4142                 soc_ops.init_clkdm = _init_clkdm;
4143                 soc_ops.update_context_lost = _omap4_update_context_lost;
4144                 soc_ops.get_context_lost = _omap4_get_context_lost;
4145         } else if (soc_is_am33xx()) {
4146                 soc_ops.enable_module = _am33xx_enable_module;
4147                 soc_ops.disable_module = _am33xx_disable_module;
4148                 soc_ops.wait_target_ready = _am33xx_wait_target_ready;
4149                 soc_ops.assert_hardreset = _am33xx_assert_hardreset;
4150                 soc_ops.deassert_hardreset = _am33xx_deassert_hardreset;
4151                 soc_ops.is_hardreset_asserted = _am33xx_is_hardreset_asserted;
4152                 soc_ops.init_clkdm = _init_clkdm;
4153         } else {
4154                 WARN(1, "omap_hwmod: unknown SoC type\n");
4155         }
4156
4157         inited = true;
4158 }
4159
4160 /**
4161  * omap_hwmod_get_main_clk - get pointer to main clock name
4162  * @oh: struct omap_hwmod *
4163  *
4164  * Returns the main clock name assocated with @oh upon success,
4165  * or NULL if @oh is NULL.
4166  */
4167 const char *omap_hwmod_get_main_clk(struct omap_hwmod *oh)
4168 {
4169         if (!oh)
4170                 return NULL;
4171
4172         return oh->main_clk;
4173 }