]> git.karo-electronics.de Git - karo-tx-linux.git/blob - arch/arm/mach-omap2/omap_hwmod.c
Merge branch 'drm-nouveau-fixes-3.9' of git://anongit.freedesktop.org/git/nouveau...
[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_FORCE_MSTANDBY) {
1372                         idlemode = HWMOD_IDLEMODE_FORCE;
1373                 } else if (oh->flags & HWMOD_SWSUP_MSTANDBY) {
1374                         idlemode = HWMOD_IDLEMODE_NO;
1375                 } else {
1376                         if (sf & SYSC_HAS_ENAWAKEUP)
1377                                 _enable_wakeup(oh, &v);
1378                         if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1379                                 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1380                         else
1381                                 idlemode = HWMOD_IDLEMODE_SMART;
1382                 }
1383                 _set_master_standbymode(oh, idlemode, &v);
1384         }
1385
1386         /*
1387          * XXX The clock framework should handle this, by
1388          * calling into this code.  But this must wait until the
1389          * clock structures are tagged with omap_hwmod entries
1390          */
1391         if ((oh->flags & HWMOD_SET_DEFAULT_CLOCKACT) &&
1392             (sf & SYSC_HAS_CLOCKACTIVITY))
1393                 _set_clockactivity(oh, oh->class->sysc->clockact, &v);
1394
1395         /* If slave is in SMARTIDLE, also enable wakeup */
1396         if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
1397                 _enable_wakeup(oh, &v);
1398
1399         _write_sysconfig(v, oh);
1400
1401         /*
1402          * Set the autoidle bit only after setting the smartidle bit
1403          * Setting this will not have any impact on the other modules.
1404          */
1405         if (sf & SYSC_HAS_AUTOIDLE) {
1406                 idlemode = (oh->flags & HWMOD_NO_OCP_AUTOIDLE) ?
1407                         0 : 1;
1408                 _set_module_autoidle(oh, idlemode, &v);
1409                 _write_sysconfig(v, oh);
1410         }
1411 }
1412
1413 /**
1414  * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
1415  * @oh: struct omap_hwmod *
1416  *
1417  * If module is marked as SWSUP_SIDLE, force the module into slave
1418  * idle; otherwise, configure it for smart-idle.  If module is marked
1419  * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
1420  * configure it for smart-standby.  No return value.
1421  */
1422 static void _idle_sysc(struct omap_hwmod *oh)
1423 {
1424         u8 idlemode, sf;
1425         u32 v;
1426
1427         if (!oh->class->sysc)
1428                 return;
1429
1430         v = oh->_sysc_cache;
1431         sf = oh->class->sysc->sysc_flags;
1432
1433         if (sf & SYSC_HAS_SIDLEMODE) {
1434                 /* XXX What about HWMOD_IDLEMODE_SMART_WKUP? */
1435                 if (oh->flags & HWMOD_SWSUP_SIDLE ||
1436                     !(oh->class->sysc->idlemodes &
1437                       (SIDLE_SMART | SIDLE_SMART_WKUP)))
1438                         idlemode = HWMOD_IDLEMODE_FORCE;
1439                 else
1440                         idlemode = HWMOD_IDLEMODE_SMART;
1441                 _set_slave_idlemode(oh, idlemode, &v);
1442         }
1443
1444         if (sf & SYSC_HAS_MIDLEMODE) {
1445                 if ((oh->flags & HWMOD_SWSUP_MSTANDBY) ||
1446                     (oh->flags & HWMOD_FORCE_MSTANDBY)) {
1447                         idlemode = HWMOD_IDLEMODE_FORCE;
1448                 } else {
1449                         if (sf & SYSC_HAS_ENAWAKEUP)
1450                                 _enable_wakeup(oh, &v);
1451                         if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1452                                 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1453                         else
1454                                 idlemode = HWMOD_IDLEMODE_SMART;
1455                 }
1456                 _set_master_standbymode(oh, idlemode, &v);
1457         }
1458
1459         /* If slave is in SMARTIDLE, also enable wakeup */
1460         if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
1461                 _enable_wakeup(oh, &v);
1462
1463         _write_sysconfig(v, oh);
1464 }
1465
1466 /**
1467  * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
1468  * @oh: struct omap_hwmod *
1469  *
1470  * Force the module into slave idle and master suspend. No return
1471  * value.
1472  */
1473 static void _shutdown_sysc(struct omap_hwmod *oh)
1474 {
1475         u32 v;
1476         u8 sf;
1477
1478         if (!oh->class->sysc)
1479                 return;
1480
1481         v = oh->_sysc_cache;
1482         sf = oh->class->sysc->sysc_flags;
1483
1484         if (sf & SYSC_HAS_SIDLEMODE)
1485                 _set_slave_idlemode(oh, HWMOD_IDLEMODE_FORCE, &v);
1486
1487         if (sf & SYSC_HAS_MIDLEMODE)
1488                 _set_master_standbymode(oh, HWMOD_IDLEMODE_FORCE, &v);
1489
1490         if (sf & SYSC_HAS_AUTOIDLE)
1491                 _set_module_autoidle(oh, 1, &v);
1492
1493         _write_sysconfig(v, oh);
1494 }
1495
1496 /**
1497  * _lookup - find an omap_hwmod by name
1498  * @name: find an omap_hwmod by name
1499  *
1500  * Return a pointer to an omap_hwmod by name, or NULL if not found.
1501  */
1502 static struct omap_hwmod *_lookup(const char *name)
1503 {
1504         struct omap_hwmod *oh, *temp_oh;
1505
1506         oh = NULL;
1507
1508         list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1509                 if (!strcmp(name, temp_oh->name)) {
1510                         oh = temp_oh;
1511                         break;
1512                 }
1513         }
1514
1515         return oh;
1516 }
1517
1518 /**
1519  * _init_clkdm - look up a clockdomain name, store pointer in omap_hwmod
1520  * @oh: struct omap_hwmod *
1521  *
1522  * Convert a clockdomain name stored in a struct omap_hwmod into a
1523  * clockdomain pointer, and save it into the struct omap_hwmod.
1524  * Return -EINVAL if the clkdm_name lookup failed.
1525  */
1526 static int _init_clkdm(struct omap_hwmod *oh)
1527 {
1528         if (!oh->clkdm_name) {
1529                 pr_debug("omap_hwmod: %s: missing clockdomain\n", oh->name);
1530                 return 0;
1531         }
1532
1533         oh->clkdm = clkdm_lookup(oh->clkdm_name);
1534         if (!oh->clkdm) {
1535                 pr_warning("omap_hwmod: %s: could not associate to clkdm %s\n",
1536                         oh->name, oh->clkdm_name);
1537                 return -EINVAL;
1538         }
1539
1540         pr_debug("omap_hwmod: %s: associated to clkdm %s\n",
1541                 oh->name, oh->clkdm_name);
1542
1543         return 0;
1544 }
1545
1546 /**
1547  * _init_clocks - clk_get() all clocks associated with this hwmod. Retrieve as
1548  * well the clockdomain.
1549  * @oh: struct omap_hwmod *
1550  * @data: not used; pass NULL
1551  *
1552  * Called by omap_hwmod_setup_*() (after omap2_clk_init()).
1553  * Resolves all clock names embedded in the hwmod.  Returns 0 on
1554  * success, or a negative error code on failure.
1555  */
1556 static int _init_clocks(struct omap_hwmod *oh, void *data)
1557 {
1558         int ret = 0;
1559
1560         if (oh->_state != _HWMOD_STATE_REGISTERED)
1561                 return 0;
1562
1563         pr_debug("omap_hwmod: %s: looking up clocks\n", oh->name);
1564
1565         if (soc_ops.init_clkdm)
1566                 ret |= soc_ops.init_clkdm(oh);
1567
1568         ret |= _init_main_clk(oh);
1569         ret |= _init_interface_clks(oh);
1570         ret |= _init_opt_clks(oh);
1571
1572         if (!ret)
1573                 oh->_state = _HWMOD_STATE_CLKS_INITED;
1574         else
1575                 pr_warning("omap_hwmod: %s: cannot _init_clocks\n", oh->name);
1576
1577         return ret;
1578 }
1579
1580 /**
1581  * _lookup_hardreset - fill register bit info for this hwmod/reset line
1582  * @oh: struct omap_hwmod *
1583  * @name: name of the reset line in the context of this hwmod
1584  * @ohri: struct omap_hwmod_rst_info * that this function will fill in
1585  *
1586  * Return the bit position of the reset line that match the
1587  * input name. Return -ENOENT if not found.
1588  */
1589 static int _lookup_hardreset(struct omap_hwmod *oh, const char *name,
1590                              struct omap_hwmod_rst_info *ohri)
1591 {
1592         int i;
1593
1594         for (i = 0; i < oh->rst_lines_cnt; i++) {
1595                 const char *rst_line = oh->rst_lines[i].name;
1596                 if (!strcmp(rst_line, name)) {
1597                         ohri->rst_shift = oh->rst_lines[i].rst_shift;
1598                         ohri->st_shift = oh->rst_lines[i].st_shift;
1599                         pr_debug("omap_hwmod: %s: %s: %s: rst %d st %d\n",
1600                                  oh->name, __func__, rst_line, ohri->rst_shift,
1601                                  ohri->st_shift);
1602
1603                         return 0;
1604                 }
1605         }
1606
1607         return -ENOENT;
1608 }
1609
1610 /**
1611  * _assert_hardreset - assert the HW reset line of submodules
1612  * contained in the hwmod module.
1613  * @oh: struct omap_hwmod *
1614  * @name: name of the reset line to lookup and assert
1615  *
1616  * Some IP like dsp, ipu or iva contain processor that require an HW
1617  * reset line to be assert / deassert in order to enable fully the IP.
1618  * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1619  * asserting the hardreset line on the currently-booted SoC, or passes
1620  * along the return value from _lookup_hardreset() or the SoC's
1621  * assert_hardreset code.
1622  */
1623 static int _assert_hardreset(struct omap_hwmod *oh, const char *name)
1624 {
1625         struct omap_hwmod_rst_info ohri;
1626         int ret = -EINVAL;
1627
1628         if (!oh)
1629                 return -EINVAL;
1630
1631         if (!soc_ops.assert_hardreset)
1632                 return -ENOSYS;
1633
1634         ret = _lookup_hardreset(oh, name, &ohri);
1635         if (ret < 0)
1636                 return ret;
1637
1638         ret = soc_ops.assert_hardreset(oh, &ohri);
1639
1640         return ret;
1641 }
1642
1643 /**
1644  * _deassert_hardreset - deassert the HW reset line of submodules contained
1645  * in the hwmod module.
1646  * @oh: struct omap_hwmod *
1647  * @name: name of the reset line to look up and deassert
1648  *
1649  * Some IP like dsp, ipu or iva contain processor that require an HW
1650  * reset line to be assert / deassert in order to enable fully the IP.
1651  * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1652  * deasserting the hardreset line on the currently-booted SoC, or passes
1653  * along the return value from _lookup_hardreset() or the SoC's
1654  * deassert_hardreset code.
1655  */
1656 static int _deassert_hardreset(struct omap_hwmod *oh, const char *name)
1657 {
1658         struct omap_hwmod_rst_info ohri;
1659         int ret = -EINVAL;
1660         int hwsup = 0;
1661
1662         if (!oh)
1663                 return -EINVAL;
1664
1665         if (!soc_ops.deassert_hardreset)
1666                 return -ENOSYS;
1667
1668         ret = _lookup_hardreset(oh, name, &ohri);
1669         if (IS_ERR_VALUE(ret))
1670                 return ret;
1671
1672         if (oh->clkdm) {
1673                 /*
1674                  * A clockdomain must be in SW_SUP otherwise reset
1675                  * might not be completed. The clockdomain can be set
1676                  * in HW_AUTO only when the module become ready.
1677                  */
1678                 hwsup = clkdm_in_hwsup(oh->clkdm);
1679                 ret = clkdm_hwmod_enable(oh->clkdm, oh);
1680                 if (ret) {
1681                         WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1682                              oh->name, oh->clkdm->name, ret);
1683                         return ret;
1684                 }
1685         }
1686
1687         _enable_clocks(oh);
1688         if (soc_ops.enable_module)
1689                 soc_ops.enable_module(oh);
1690
1691         ret = soc_ops.deassert_hardreset(oh, &ohri);
1692
1693         if (soc_ops.disable_module)
1694                 soc_ops.disable_module(oh);
1695         _disable_clocks(oh);
1696
1697         if (ret == -EBUSY)
1698                 pr_warning("omap_hwmod: %s: failed to hardreset\n", oh->name);
1699
1700         if (!ret) {
1701                 /*
1702                  * Set the clockdomain to HW_AUTO, assuming that the
1703                  * previous state was HW_AUTO.
1704                  */
1705                 if (oh->clkdm && hwsup)
1706                         clkdm_allow_idle(oh->clkdm);
1707         } else {
1708                 if (oh->clkdm)
1709                         clkdm_hwmod_disable(oh->clkdm, oh);
1710         }
1711
1712         return ret;
1713 }
1714
1715 /**
1716  * _read_hardreset - read the HW reset line state of submodules
1717  * contained in the hwmod module
1718  * @oh: struct omap_hwmod *
1719  * @name: name of the reset line to look up and read
1720  *
1721  * Return the state of the reset line.  Returns -EINVAL if @oh is
1722  * null, -ENOSYS if we have no way of reading the hardreset line
1723  * status on the currently-booted SoC, or passes along the return
1724  * value from _lookup_hardreset() or the SoC's is_hardreset_asserted
1725  * code.
1726  */
1727 static int _read_hardreset(struct omap_hwmod *oh, const char *name)
1728 {
1729         struct omap_hwmod_rst_info ohri;
1730         int ret = -EINVAL;
1731
1732         if (!oh)
1733                 return -EINVAL;
1734
1735         if (!soc_ops.is_hardreset_asserted)
1736                 return -ENOSYS;
1737
1738         ret = _lookup_hardreset(oh, name, &ohri);
1739         if (ret < 0)
1740                 return ret;
1741
1742         return soc_ops.is_hardreset_asserted(oh, &ohri);
1743 }
1744
1745 /**
1746  * _are_all_hardreset_lines_asserted - return true if the @oh is hard-reset
1747  * @oh: struct omap_hwmod *
1748  *
1749  * If all hardreset lines associated with @oh are asserted, then return true.
1750  * Otherwise, if part of @oh is out hardreset or if no hardreset lines
1751  * associated with @oh are asserted, then return false.
1752  * This function is used to avoid executing some parts of the IP block
1753  * enable/disable sequence if its hardreset line is set.
1754  */
1755 static bool _are_all_hardreset_lines_asserted(struct omap_hwmod *oh)
1756 {
1757         int i, rst_cnt = 0;
1758
1759         if (oh->rst_lines_cnt == 0)
1760                 return false;
1761
1762         for (i = 0; i < oh->rst_lines_cnt; i++)
1763                 if (_read_hardreset(oh, oh->rst_lines[i].name) > 0)
1764                         rst_cnt++;
1765
1766         if (oh->rst_lines_cnt == rst_cnt)
1767                 return true;
1768
1769         return false;
1770 }
1771
1772 /**
1773  * _are_any_hardreset_lines_asserted - return true if any part of @oh is
1774  * hard-reset
1775  * @oh: struct omap_hwmod *
1776  *
1777  * If any hardreset lines associated with @oh are asserted, then
1778  * return true.  Otherwise, if no hardreset lines associated with @oh
1779  * are asserted, or if @oh has no hardreset lines, then return false.
1780  * This function is used to avoid executing some parts of the IP block
1781  * enable/disable sequence if any hardreset line is set.
1782  */
1783 static bool _are_any_hardreset_lines_asserted(struct omap_hwmod *oh)
1784 {
1785         int rst_cnt = 0;
1786         int i;
1787
1788         for (i = 0; i < oh->rst_lines_cnt && rst_cnt == 0; i++)
1789                 if (_read_hardreset(oh, oh->rst_lines[i].name) > 0)
1790                         rst_cnt++;
1791
1792         return (rst_cnt) ? true : false;
1793 }
1794
1795 /**
1796  * _omap4_disable_module - enable CLKCTRL modulemode on OMAP4
1797  * @oh: struct omap_hwmod *
1798  *
1799  * Disable the PRCM module mode related to the hwmod @oh.
1800  * Return EINVAL if the modulemode is not supported and 0 in case of success.
1801  */
1802 static int _omap4_disable_module(struct omap_hwmod *oh)
1803 {
1804         int v;
1805
1806         if (!oh->clkdm || !oh->prcm.omap4.modulemode)
1807                 return -EINVAL;
1808
1809         /*
1810          * Since integration code might still be doing something, only
1811          * disable if all lines are under hardreset.
1812          */
1813         if (_are_any_hardreset_lines_asserted(oh))
1814                 return 0;
1815
1816         pr_debug("omap_hwmod: %s: %s\n", oh->name, __func__);
1817
1818         omap4_cminst_module_disable(oh->clkdm->prcm_partition,
1819                                     oh->clkdm->cm_inst,
1820                                     oh->clkdm->clkdm_offs,
1821                                     oh->prcm.omap4.clkctrl_offs);
1822
1823         v = _omap4_wait_target_disable(oh);
1824         if (v)
1825                 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1826                         oh->name);
1827
1828         return 0;
1829 }
1830
1831 /**
1832  * _am33xx_disable_module - enable CLKCTRL modulemode on AM33XX
1833  * @oh: struct omap_hwmod *
1834  *
1835  * Disable the PRCM module mode related to the hwmod @oh.
1836  * Return EINVAL if the modulemode is not supported and 0 in case of success.
1837  */
1838 static int _am33xx_disable_module(struct omap_hwmod *oh)
1839 {
1840         int v;
1841
1842         if (!oh->clkdm || !oh->prcm.omap4.modulemode)
1843                 return -EINVAL;
1844
1845         pr_debug("omap_hwmod: %s: %s\n", oh->name, __func__);
1846
1847         if (_are_any_hardreset_lines_asserted(oh))
1848                 return 0;
1849
1850         am33xx_cm_module_disable(oh->clkdm->cm_inst, oh->clkdm->clkdm_offs,
1851                                  oh->prcm.omap4.clkctrl_offs);
1852
1853         v = _am33xx_wait_target_disable(oh);
1854         if (v)
1855                 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1856                         oh->name);
1857
1858         return 0;
1859 }
1860
1861 /**
1862  * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1863  * @oh: struct omap_hwmod *
1864  *
1865  * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit.  hwmod must be
1866  * enabled for this to work.  Returns -ENOENT if the hwmod cannot be
1867  * reset this way, -EINVAL if the hwmod is in the wrong state,
1868  * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1869  *
1870  * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1871  * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1872  * use the SYSCONFIG softreset bit to provide the status.
1873  *
1874  * Note that some IP like McBSP do have reset control but don't have
1875  * reset status.
1876  */
1877 static int _ocp_softreset(struct omap_hwmod *oh)
1878 {
1879         u32 v;
1880         int c = 0;
1881         int ret = 0;
1882
1883         if (!oh->class->sysc ||
1884             !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
1885                 return -ENOENT;
1886
1887         /* clocks must be on for this operation */
1888         if (oh->_state != _HWMOD_STATE_ENABLED) {
1889                 pr_warn("omap_hwmod: %s: reset can only be entered from enabled state\n",
1890                         oh->name);
1891                 return -EINVAL;
1892         }
1893
1894         /* For some modules, all optionnal clocks need to be enabled as well */
1895         if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1896                 _enable_optional_clocks(oh);
1897
1898         pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh->name);
1899
1900         v = oh->_sysc_cache;
1901         ret = _set_softreset(oh, &v);
1902         if (ret)
1903                 goto dis_opt_clks;
1904         _write_sysconfig(v, oh);
1905
1906         if (oh->class->sysc->srst_udelay)
1907                 udelay(oh->class->sysc->srst_udelay);
1908
1909         c = _wait_softreset_complete(oh);
1910         if (c == MAX_MODULE_SOFTRESET_WAIT)
1911                 pr_warning("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1912                            oh->name, MAX_MODULE_SOFTRESET_WAIT);
1913         else
1914                 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh->name, c);
1915
1916         /*
1917          * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1918          * _wait_target_ready() or _reset()
1919          */
1920
1921         ret = (c == MAX_MODULE_SOFTRESET_WAIT) ? -ETIMEDOUT : 0;
1922
1923 dis_opt_clks:
1924         if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1925                 _disable_optional_clocks(oh);
1926
1927         return ret;
1928 }
1929
1930 /**
1931  * _reset - reset an omap_hwmod
1932  * @oh: struct omap_hwmod *
1933  *
1934  * Resets an omap_hwmod @oh.  If the module has a custom reset
1935  * function pointer defined, then call it to reset the IP block, and
1936  * pass along its return value to the caller.  Otherwise, if the IP
1937  * block has an OCP_SYSCONFIG register with a SOFTRESET bitfield
1938  * associated with it, call a function to reset the IP block via that
1939  * method, and pass along the return value to the caller.  Finally, if
1940  * the IP block has some hardreset lines associated with it, assert
1941  * all of those, but do _not_ deassert them. (This is because driver
1942  * authors have expressed an apparent requirement to control the
1943  * deassertion of the hardreset lines themselves.)
1944  *
1945  * The default software reset mechanism for most OMAP IP blocks is
1946  * triggered via the OCP_SYSCONFIG.SOFTRESET bit.  However, some
1947  * hwmods cannot be reset via this method.  Some are not targets and
1948  * therefore have no OCP header registers to access.  Others (like the
1949  * IVA) have idiosyncratic reset sequences.  So for these relatively
1950  * rare cases, custom reset code can be supplied in the struct
1951  * omap_hwmod_class .reset function pointer.
1952  *
1953  * _set_dmadisable() is called to set the DMADISABLE bit so that it
1954  * does not prevent idling of the system. This is necessary for cases
1955  * where ROMCODE/BOOTLOADER uses dma and transfers control to the
1956  * kernel without disabling dma.
1957  *
1958  * Passes along the return value from either _ocp_softreset() or the
1959  * custom reset function - these must return -EINVAL if the hwmod
1960  * cannot be reset this way or if the hwmod is in the wrong state,
1961  * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1962  */
1963 static int _reset(struct omap_hwmod *oh)
1964 {
1965         int i, r;
1966
1967         pr_debug("omap_hwmod: %s: resetting\n", oh->name);
1968
1969         if (oh->class->reset) {
1970                 r = oh->class->reset(oh);
1971         } else {
1972                 if (oh->rst_lines_cnt > 0) {
1973                         for (i = 0; i < oh->rst_lines_cnt; i++)
1974                                 _assert_hardreset(oh, oh->rst_lines[i].name);
1975                         return 0;
1976                 } else {
1977                         r = _ocp_softreset(oh);
1978                         if (r == -ENOENT)
1979                                 r = 0;
1980                 }
1981         }
1982
1983         _set_dmadisable(oh);
1984
1985         /*
1986          * OCP_SYSCONFIG bits need to be reprogrammed after a
1987          * softreset.  The _enable() function should be split to avoid
1988          * the rewrite of the OCP_SYSCONFIG register.
1989          */
1990         if (oh->class->sysc) {
1991                 _update_sysc_cache(oh);
1992                 _enable_sysc(oh);
1993         }
1994
1995         return r;
1996 }
1997
1998 /**
1999  * _reconfigure_io_chain - clear any I/O chain wakeups and reconfigure chain
2000  *
2001  * Call the appropriate PRM function to clear any logged I/O chain
2002  * wakeups and to reconfigure the chain.  This apparently needs to be
2003  * done upon every mux change.  Since hwmods can be concurrently
2004  * enabled and idled, hold a spinlock around the I/O chain
2005  * reconfiguration sequence.  No return value.
2006  *
2007  * XXX When the PRM code is moved to drivers, this function can be removed,
2008  * as the PRM infrastructure should abstract this.
2009  */
2010 static void _reconfigure_io_chain(void)
2011 {
2012         unsigned long flags;
2013
2014         spin_lock_irqsave(&io_chain_lock, flags);
2015
2016         if (cpu_is_omap34xx() && omap3_has_io_chain_ctrl())
2017                 omap3xxx_prm_reconfigure_io_chain();
2018         else if (cpu_is_omap44xx())
2019                 omap44xx_prm_reconfigure_io_chain();
2020
2021         spin_unlock_irqrestore(&io_chain_lock, flags);
2022 }
2023
2024 /**
2025  * _omap4_update_context_lost - increment hwmod context loss counter if
2026  * hwmod context was lost, and clear hardware context loss reg
2027  * @oh: hwmod to check for context loss
2028  *
2029  * If the PRCM indicates that the hwmod @oh lost context, increment
2030  * our in-memory context loss counter, and clear the RM_*_CONTEXT
2031  * bits. No return value.
2032  */
2033 static void _omap4_update_context_lost(struct omap_hwmod *oh)
2034 {
2035         if (oh->prcm.omap4.flags & HWMOD_OMAP4_NO_CONTEXT_LOSS_BIT)
2036                 return;
2037
2038         if (!prm_was_any_context_lost_old(oh->clkdm->pwrdm.ptr->prcm_partition,
2039                                           oh->clkdm->pwrdm.ptr->prcm_offs,
2040                                           oh->prcm.omap4.context_offs))
2041                 return;
2042
2043         oh->prcm.omap4.context_lost_counter++;
2044         prm_clear_context_loss_flags_old(oh->clkdm->pwrdm.ptr->prcm_partition,
2045                                          oh->clkdm->pwrdm.ptr->prcm_offs,
2046                                          oh->prcm.omap4.context_offs);
2047 }
2048
2049 /**
2050  * _omap4_get_context_lost - get context loss counter for a hwmod
2051  * @oh: hwmod to get context loss counter for
2052  *
2053  * Returns the in-memory context loss counter for a hwmod.
2054  */
2055 static int _omap4_get_context_lost(struct omap_hwmod *oh)
2056 {
2057         return oh->prcm.omap4.context_lost_counter;
2058 }
2059
2060 /**
2061  * _enable_preprogram - Pre-program an IP block during the _enable() process
2062  * @oh: struct omap_hwmod *
2063  *
2064  * Some IP blocks (such as AESS) require some additional programming
2065  * after enable before they can enter idle.  If a function pointer to
2066  * do so is present in the hwmod data, then call it and pass along the
2067  * return value; otherwise, return 0.
2068  */
2069 static int __init _enable_preprogram(struct omap_hwmod *oh)
2070 {
2071         if (!oh->class->enable_preprogram)
2072                 return 0;
2073
2074         return oh->class->enable_preprogram(oh);
2075 }
2076
2077 /**
2078  * _enable - enable an omap_hwmod
2079  * @oh: struct omap_hwmod *
2080  *
2081  * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
2082  * register target.  Returns -EINVAL if the hwmod is in the wrong
2083  * state or passes along the return value of _wait_target_ready().
2084  */
2085 static int _enable(struct omap_hwmod *oh)
2086 {
2087         int r;
2088         int hwsup = 0;
2089
2090         pr_debug("omap_hwmod: %s: enabling\n", oh->name);
2091
2092         /*
2093          * hwmods with HWMOD_INIT_NO_IDLE flag set are left in enabled
2094          * state at init.  Now that someone is really trying to enable
2095          * them, just ensure that the hwmod mux is set.
2096          */
2097         if (oh->_int_flags & _HWMOD_SKIP_ENABLE) {
2098                 /*
2099                  * If the caller has mux data populated, do the mux'ing
2100                  * which wouldn't have been done as part of the _enable()
2101                  * done during setup.
2102                  */
2103                 if (oh->mux)
2104                         omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
2105
2106                 oh->_int_flags &= ~_HWMOD_SKIP_ENABLE;
2107                 return 0;
2108         }
2109
2110         if (oh->_state != _HWMOD_STATE_INITIALIZED &&
2111             oh->_state != _HWMOD_STATE_IDLE &&
2112             oh->_state != _HWMOD_STATE_DISABLED) {
2113                 WARN(1, "omap_hwmod: %s: enabled state can only be entered from initialized, idle, or disabled state\n",
2114                         oh->name);
2115                 return -EINVAL;
2116         }
2117
2118         /*
2119          * If an IP block contains HW reset lines and all of them are
2120          * asserted, we let integration code associated with that
2121          * block handle the enable.  We've received very little
2122          * information on what those driver authors need, and until
2123          * detailed information is provided and the driver code is
2124          * posted to the public lists, this is probably the best we
2125          * can do.
2126          */
2127         if (_are_all_hardreset_lines_asserted(oh))
2128                 return 0;
2129
2130         /* Mux pins for device runtime if populated */
2131         if (oh->mux && (!oh->mux->enabled ||
2132                         ((oh->_state == _HWMOD_STATE_IDLE) &&
2133                          oh->mux->pads_dynamic))) {
2134                 omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
2135                 _reconfigure_io_chain();
2136         }
2137
2138         _add_initiator_dep(oh, mpu_oh);
2139
2140         if (oh->clkdm) {
2141                 /*
2142                  * A clockdomain must be in SW_SUP before enabling
2143                  * completely the module. The clockdomain can be set
2144                  * in HW_AUTO only when the module become ready.
2145                  */
2146                 hwsup = clkdm_in_hwsup(oh->clkdm) &&
2147                         !clkdm_missing_idle_reporting(oh->clkdm);
2148                 r = clkdm_hwmod_enable(oh->clkdm, oh);
2149                 if (r) {
2150                         WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
2151                              oh->name, oh->clkdm->name, r);
2152                         return r;
2153                 }
2154         }
2155
2156         _enable_clocks(oh);
2157         if (soc_ops.enable_module)
2158                 soc_ops.enable_module(oh);
2159         if (oh->flags & HWMOD_BLOCK_WFI)
2160                 disable_hlt();
2161
2162         if (soc_ops.update_context_lost)
2163                 soc_ops.update_context_lost(oh);
2164
2165         r = (soc_ops.wait_target_ready) ? soc_ops.wait_target_ready(oh) :
2166                 -EINVAL;
2167         if (!r) {
2168                 /*
2169                  * Set the clockdomain to HW_AUTO only if the target is ready,
2170                  * assuming that the previous state was HW_AUTO
2171                  */
2172                 if (oh->clkdm && hwsup)
2173                         clkdm_allow_idle(oh->clkdm);
2174
2175                 oh->_state = _HWMOD_STATE_ENABLED;
2176
2177                 /* Access the sysconfig only if the target is ready */
2178                 if (oh->class->sysc) {
2179                         if (!(oh->_int_flags & _HWMOD_SYSCONFIG_LOADED))
2180                                 _update_sysc_cache(oh);
2181                         _enable_sysc(oh);
2182                 }
2183                 r = _enable_preprogram(oh);
2184         } else {
2185                 if (soc_ops.disable_module)
2186                         soc_ops.disable_module(oh);
2187                 _disable_clocks(oh);
2188                 pr_debug("omap_hwmod: %s: _wait_target_ready: %d\n",
2189                          oh->name, r);
2190
2191                 if (oh->clkdm)
2192                         clkdm_hwmod_disable(oh->clkdm, oh);
2193         }
2194
2195         return r;
2196 }
2197
2198 /**
2199  * _idle - idle an omap_hwmod
2200  * @oh: struct omap_hwmod *
2201  *
2202  * Idles an omap_hwmod @oh.  This should be called once the hwmod has
2203  * no further work.  Returns -EINVAL if the hwmod is in the wrong
2204  * state or returns 0.
2205  */
2206 static int _idle(struct omap_hwmod *oh)
2207 {
2208         pr_debug("omap_hwmod: %s: idling\n", oh->name);
2209
2210         if (oh->_state != _HWMOD_STATE_ENABLED) {
2211                 WARN(1, "omap_hwmod: %s: idle state can only be entered from enabled state\n",
2212                         oh->name);
2213                 return -EINVAL;
2214         }
2215
2216         if (_are_all_hardreset_lines_asserted(oh))
2217                 return 0;
2218
2219         if (oh->class->sysc)
2220                 _idle_sysc(oh);
2221         _del_initiator_dep(oh, mpu_oh);
2222
2223         if (oh->flags & HWMOD_BLOCK_WFI)
2224                 enable_hlt();
2225         if (soc_ops.disable_module)
2226                 soc_ops.disable_module(oh);
2227
2228         /*
2229          * The module must be in idle mode before disabling any parents
2230          * clocks. Otherwise, the parent clock might be disabled before
2231          * the module transition is done, and thus will prevent the
2232          * transition to complete properly.
2233          */
2234         _disable_clocks(oh);
2235         if (oh->clkdm)
2236                 clkdm_hwmod_disable(oh->clkdm, oh);
2237
2238         /* Mux pins for device idle if populated */
2239         if (oh->mux && oh->mux->pads_dynamic) {
2240                 omap_hwmod_mux(oh->mux, _HWMOD_STATE_IDLE);
2241                 _reconfigure_io_chain();
2242         }
2243
2244         oh->_state = _HWMOD_STATE_IDLE;
2245
2246         return 0;
2247 }
2248
2249 /**
2250  * omap_hwmod_set_ocp_autoidle - set the hwmod's OCP autoidle bit
2251  * @oh: struct omap_hwmod *
2252  * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
2253  *
2254  * Sets the IP block's OCP autoidle bit in hardware, and updates our
2255  * local copy. Intended to be used by drivers that require
2256  * direct manipulation of the AUTOIDLE bits.
2257  * Returns -EINVAL if @oh is null or is not in the ENABLED state, or passes
2258  * along the return value from _set_module_autoidle().
2259  *
2260  * Any users of this function should be scrutinized carefully.
2261  */
2262 int omap_hwmod_set_ocp_autoidle(struct omap_hwmod *oh, u8 autoidle)
2263 {
2264         u32 v;
2265         int retval = 0;
2266         unsigned long flags;
2267
2268         if (!oh || oh->_state != _HWMOD_STATE_ENABLED)
2269                 return -EINVAL;
2270
2271         spin_lock_irqsave(&oh->_lock, flags);
2272
2273         v = oh->_sysc_cache;
2274
2275         retval = _set_module_autoidle(oh, autoidle, &v);
2276
2277         if (!retval)
2278                 _write_sysconfig(v, oh);
2279
2280         spin_unlock_irqrestore(&oh->_lock, flags);
2281
2282         return retval;
2283 }
2284
2285 /**
2286  * _shutdown - shutdown an omap_hwmod
2287  * @oh: struct omap_hwmod *
2288  *
2289  * Shut down an omap_hwmod @oh.  This should be called when the driver
2290  * used for the hwmod is removed or unloaded or if the driver is not
2291  * used by the system.  Returns -EINVAL if the hwmod is in the wrong
2292  * state or returns 0.
2293  */
2294 static int _shutdown(struct omap_hwmod *oh)
2295 {
2296         int ret, i;
2297         u8 prev_state;
2298
2299         if (oh->_state != _HWMOD_STATE_IDLE &&
2300             oh->_state != _HWMOD_STATE_ENABLED) {
2301                 WARN(1, "omap_hwmod: %s: disabled state can only be entered from idle, or enabled state\n",
2302                         oh->name);
2303                 return -EINVAL;
2304         }
2305
2306         if (_are_all_hardreset_lines_asserted(oh))
2307                 return 0;
2308
2309         pr_debug("omap_hwmod: %s: disabling\n", oh->name);
2310
2311         if (oh->class->pre_shutdown) {
2312                 prev_state = oh->_state;
2313                 if (oh->_state == _HWMOD_STATE_IDLE)
2314                         _enable(oh);
2315                 ret = oh->class->pre_shutdown(oh);
2316                 if (ret) {
2317                         if (prev_state == _HWMOD_STATE_IDLE)
2318                                 _idle(oh);
2319                         return ret;
2320                 }
2321         }
2322
2323         if (oh->class->sysc) {
2324                 if (oh->_state == _HWMOD_STATE_IDLE)
2325                         _enable(oh);
2326                 _shutdown_sysc(oh);
2327         }
2328
2329         /* clocks and deps are already disabled in idle */
2330         if (oh->_state == _HWMOD_STATE_ENABLED) {
2331                 _del_initiator_dep(oh, mpu_oh);
2332                 /* XXX what about the other system initiators here? dma, dsp */
2333                 if (oh->flags & HWMOD_BLOCK_WFI)
2334                         enable_hlt();
2335                 if (soc_ops.disable_module)
2336                         soc_ops.disable_module(oh);
2337                 _disable_clocks(oh);
2338                 if (oh->clkdm)
2339                         clkdm_hwmod_disable(oh->clkdm, oh);
2340         }
2341         /* XXX Should this code also force-disable the optional clocks? */
2342
2343         for (i = 0; i < oh->rst_lines_cnt; i++)
2344                 _assert_hardreset(oh, oh->rst_lines[i].name);
2345
2346         /* Mux pins to safe mode or use populated off mode values */
2347         if (oh->mux)
2348                 omap_hwmod_mux(oh->mux, _HWMOD_STATE_DISABLED);
2349
2350         oh->_state = _HWMOD_STATE_DISABLED;
2351
2352         return 0;
2353 }
2354
2355 /**
2356  * _init_mpu_rt_base - populate the virtual address for a hwmod
2357  * @oh: struct omap_hwmod * to locate the virtual address
2358  *
2359  * Cache the virtual address used by the MPU to access this IP block's
2360  * registers.  This address is needed early so the OCP registers that
2361  * are part of the device's address space can be ioremapped properly.
2362  * No return value.
2363  */
2364 static void __init _init_mpu_rt_base(struct omap_hwmod *oh, void *data)
2365 {
2366         struct omap_hwmod_addr_space *mem;
2367         void __iomem *va_start;
2368
2369         if (!oh)
2370                 return;
2371
2372         _save_mpu_port_index(oh);
2373
2374         if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2375                 return;
2376
2377         mem = _find_mpu_rt_addr_space(oh);
2378         if (!mem) {
2379                 pr_debug("omap_hwmod: %s: no MPU register target found\n",
2380                          oh->name);
2381                 return;
2382         }
2383
2384         va_start = ioremap(mem->pa_start, mem->pa_end - mem->pa_start);
2385         if (!va_start) {
2386                 pr_err("omap_hwmod: %s: Could not ioremap\n", oh->name);
2387                 return;
2388         }
2389
2390         pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
2391                  oh->name, va_start);
2392
2393         oh->_mpu_rt_va = va_start;
2394 }
2395
2396 /**
2397  * _init - initialize internal data for the hwmod @oh
2398  * @oh: struct omap_hwmod *
2399  * @n: (unused)
2400  *
2401  * Look up the clocks and the address space used by the MPU to access
2402  * registers belonging to the hwmod @oh.  @oh must already be
2403  * registered at this point.  This is the first of two phases for
2404  * hwmod initialization.  Code called here does not touch any hardware
2405  * registers, it simply prepares internal data structures.  Returns 0
2406  * upon success or if the hwmod isn't registered, or -EINVAL upon
2407  * failure.
2408  */
2409 static int __init _init(struct omap_hwmod *oh, void *data)
2410 {
2411         int r;
2412
2413         if (oh->_state != _HWMOD_STATE_REGISTERED)
2414                 return 0;
2415
2416         _init_mpu_rt_base(oh, NULL);
2417
2418         r = _init_clocks(oh, NULL);
2419         if (IS_ERR_VALUE(r)) {
2420                 WARN(1, "omap_hwmod: %s: couldn't init clocks\n", oh->name);
2421                 return -EINVAL;
2422         }
2423
2424         oh->_state = _HWMOD_STATE_INITIALIZED;
2425
2426         return 0;
2427 }
2428
2429 /**
2430  * _setup_iclk_autoidle - configure an IP block's interface clocks
2431  * @oh: struct omap_hwmod *
2432  *
2433  * Set up the module's interface clocks.  XXX This function is still mostly
2434  * a stub; implementing this properly requires iclk autoidle usecounting in
2435  * the clock code.   No return value.
2436  */
2437 static void __init _setup_iclk_autoidle(struct omap_hwmod *oh)
2438 {
2439         struct omap_hwmod_ocp_if *os;
2440         struct list_head *p;
2441         int i = 0;
2442         if (oh->_state != _HWMOD_STATE_INITIALIZED)
2443                 return;
2444
2445         p = oh->slave_ports.next;
2446
2447         while (i < oh->slaves_cnt) {
2448                 os = _fetch_next_ocp_if(&p, &i);
2449                 if (!os->_clk)
2450                         continue;
2451
2452                 if (os->flags & OCPIF_SWSUP_IDLE) {
2453                         /* XXX omap_iclk_deny_idle(c); */
2454                 } else {
2455                         /* XXX omap_iclk_allow_idle(c); */
2456                         clk_enable(os->_clk);
2457                 }
2458         }
2459
2460         return;
2461 }
2462
2463 /**
2464  * _setup_reset - reset an IP block during the setup process
2465  * @oh: struct omap_hwmod *
2466  *
2467  * Reset the IP block corresponding to the hwmod @oh during the setup
2468  * process.  The IP block is first enabled so it can be successfully
2469  * reset.  Returns 0 upon success or a negative error code upon
2470  * failure.
2471  */
2472 static int __init _setup_reset(struct omap_hwmod *oh)
2473 {
2474         int r;
2475
2476         if (oh->_state != _HWMOD_STATE_INITIALIZED)
2477                 return -EINVAL;
2478
2479         if (oh->flags & HWMOD_EXT_OPT_MAIN_CLK)
2480                 return -EPERM;
2481
2482         if (oh->rst_lines_cnt == 0) {
2483                 r = _enable(oh);
2484                 if (r) {
2485                         pr_warning("omap_hwmod: %s: cannot be enabled for reset (%d)\n",
2486                                    oh->name, oh->_state);
2487                         return -EINVAL;
2488                 }
2489         }
2490
2491         if (!(oh->flags & HWMOD_INIT_NO_RESET))
2492                 r = _reset(oh);
2493
2494         return r;
2495 }
2496
2497 /**
2498  * _setup_postsetup - transition to the appropriate state after _setup
2499  * @oh: struct omap_hwmod *
2500  *
2501  * Place an IP block represented by @oh into a "post-setup" state --
2502  * either IDLE, ENABLED, or DISABLED.  ("post-setup" simply means that
2503  * this function is called at the end of _setup().)  The postsetup
2504  * state for an IP block can be changed by calling
2505  * omap_hwmod_enter_postsetup_state() early in the boot process,
2506  * before one of the omap_hwmod_setup*() functions are called for the
2507  * IP block.
2508  *
2509  * The IP block stays in this state until a PM runtime-based driver is
2510  * loaded for that IP block.  A post-setup state of IDLE is
2511  * appropriate for almost all IP blocks with runtime PM-enabled
2512  * drivers, since those drivers are able to enable the IP block.  A
2513  * post-setup state of ENABLED is appropriate for kernels with PM
2514  * runtime disabled.  The DISABLED state is appropriate for unusual IP
2515  * blocks such as the MPU WDTIMER on kernels without WDTIMER drivers
2516  * included, since the WDTIMER starts running on reset and will reset
2517  * the MPU if left active.
2518  *
2519  * This post-setup mechanism is deprecated.  Once all of the OMAP
2520  * drivers have been converted to use PM runtime, and all of the IP
2521  * block data and interconnect data is available to the hwmod code, it
2522  * should be possible to replace this mechanism with a "lazy reset"
2523  * arrangement.  In a "lazy reset" setup, each IP block is enabled
2524  * when the driver first probes, then all remaining IP blocks without
2525  * drivers are either shut down or enabled after the drivers have
2526  * loaded.  However, this cannot take place until the above
2527  * preconditions have been met, since otherwise the late reset code
2528  * has no way of knowing which IP blocks are in use by drivers, and
2529  * which ones are unused.
2530  *
2531  * No return value.
2532  */
2533 static void __init _setup_postsetup(struct omap_hwmod *oh)
2534 {
2535         u8 postsetup_state;
2536
2537         if (oh->rst_lines_cnt > 0)
2538                 return;
2539
2540         postsetup_state = oh->_postsetup_state;
2541         if (postsetup_state == _HWMOD_STATE_UNKNOWN)
2542                 postsetup_state = _HWMOD_STATE_ENABLED;
2543
2544         /*
2545          * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
2546          * it should be set by the core code as a runtime flag during startup
2547          */
2548         if ((oh->flags & HWMOD_INIT_NO_IDLE) &&
2549             (postsetup_state == _HWMOD_STATE_IDLE)) {
2550                 oh->_int_flags |= _HWMOD_SKIP_ENABLE;
2551                 postsetup_state = _HWMOD_STATE_ENABLED;
2552         }
2553
2554         if (postsetup_state == _HWMOD_STATE_IDLE)
2555                 _idle(oh);
2556         else if (postsetup_state == _HWMOD_STATE_DISABLED)
2557                 _shutdown(oh);
2558         else if (postsetup_state != _HWMOD_STATE_ENABLED)
2559                 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
2560                      oh->name, postsetup_state);
2561
2562         return;
2563 }
2564
2565 /**
2566  * _setup - prepare IP block hardware for use
2567  * @oh: struct omap_hwmod *
2568  * @n: (unused, pass NULL)
2569  *
2570  * Configure the IP block represented by @oh.  This may include
2571  * enabling the IP block, resetting it, and placing it into a
2572  * post-setup state, depending on the type of IP block and applicable
2573  * flags.  IP blocks are reset to prevent any previous configuration
2574  * by the bootloader or previous operating system from interfering
2575  * with power management or other parts of the system.  The reset can
2576  * be avoided; see omap_hwmod_no_setup_reset().  This is the second of
2577  * two phases for hwmod initialization.  Code called here generally
2578  * affects the IP block hardware, or system integration hardware
2579  * associated with the IP block.  Returns 0.
2580  */
2581 static int __init _setup(struct omap_hwmod *oh, void *data)
2582 {
2583         if (oh->_state != _HWMOD_STATE_INITIALIZED)
2584                 return 0;
2585
2586         _setup_iclk_autoidle(oh);
2587
2588         if (!_setup_reset(oh))
2589                 _setup_postsetup(oh);
2590
2591         return 0;
2592 }
2593
2594 /**
2595  * _register - register a struct omap_hwmod
2596  * @oh: struct omap_hwmod *
2597  *
2598  * Registers the omap_hwmod @oh.  Returns -EEXIST if an omap_hwmod
2599  * already has been registered by the same name; -EINVAL if the
2600  * omap_hwmod is in the wrong state, if @oh is NULL, if the
2601  * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
2602  * name, or if the omap_hwmod's class is missing a name; or 0 upon
2603  * success.
2604  *
2605  * XXX The data should be copied into bootmem, so the original data
2606  * should be marked __initdata and freed after init.  This would allow
2607  * unneeded omap_hwmods to be freed on multi-OMAP configurations.  Note
2608  * that the copy process would be relatively complex due to the large number
2609  * of substructures.
2610  */
2611 static int __init _register(struct omap_hwmod *oh)
2612 {
2613         if (!oh || !oh->name || !oh->class || !oh->class->name ||
2614             (oh->_state != _HWMOD_STATE_UNKNOWN))
2615                 return -EINVAL;
2616
2617         pr_debug("omap_hwmod: %s: registering\n", oh->name);
2618
2619         if (_lookup(oh->name))
2620                 return -EEXIST;
2621
2622         list_add_tail(&oh->node, &omap_hwmod_list);
2623
2624         INIT_LIST_HEAD(&oh->master_ports);
2625         INIT_LIST_HEAD(&oh->slave_ports);
2626         spin_lock_init(&oh->_lock);
2627
2628         oh->_state = _HWMOD_STATE_REGISTERED;
2629
2630         /*
2631          * XXX Rather than doing a strcmp(), this should test a flag
2632          * set in the hwmod data, inserted by the autogenerator code.
2633          */
2634         if (!strcmp(oh->name, MPU_INITIATOR_NAME))
2635                 mpu_oh = oh;
2636
2637         return 0;
2638 }
2639
2640 /**
2641  * _alloc_links - return allocated memory for hwmod links
2642  * @ml: pointer to a struct omap_hwmod_link * for the master link
2643  * @sl: pointer to a struct omap_hwmod_link * for the slave link
2644  *
2645  * Return pointers to two struct omap_hwmod_link records, via the
2646  * addresses pointed to by @ml and @sl.  Will first attempt to return
2647  * memory allocated as part of a large initial block, but if that has
2648  * been exhausted, will allocate memory itself.  Since ideally this
2649  * second allocation path will never occur, the number of these
2650  * 'supplemental' allocations will be logged when debugging is
2651  * enabled.  Returns 0.
2652  */
2653 static int __init _alloc_links(struct omap_hwmod_link **ml,
2654                                struct omap_hwmod_link **sl)
2655 {
2656         unsigned int sz;
2657
2658         if ((free_ls + LINKS_PER_OCP_IF) <= max_ls) {
2659                 *ml = &linkspace[free_ls++];
2660                 *sl = &linkspace[free_ls++];
2661                 return 0;
2662         }
2663
2664         sz = sizeof(struct omap_hwmod_link) * LINKS_PER_OCP_IF;
2665
2666         *sl = NULL;
2667         *ml = alloc_bootmem(sz);
2668
2669         memset(*ml, 0, sz);
2670
2671         *sl = (void *)(*ml) + sizeof(struct omap_hwmod_link);
2672
2673         ls_supp++;
2674         pr_debug("omap_hwmod: supplemental link allocations needed: %d\n",
2675                  ls_supp * LINKS_PER_OCP_IF);
2676
2677         return 0;
2678 };
2679
2680 /**
2681  * _add_link - add an interconnect between two IP blocks
2682  * @oi: pointer to a struct omap_hwmod_ocp_if record
2683  *
2684  * Add struct omap_hwmod_link records connecting the master IP block
2685  * specified in @oi->master to @oi, and connecting the slave IP block
2686  * specified in @oi->slave to @oi.  This code is assumed to run before
2687  * preemption or SMP has been enabled, thus avoiding the need for
2688  * locking in this code.  Changes to this assumption will require
2689  * additional locking.  Returns 0.
2690  */
2691 static int __init _add_link(struct omap_hwmod_ocp_if *oi)
2692 {
2693         struct omap_hwmod_link *ml, *sl;
2694
2695         pr_debug("omap_hwmod: %s -> %s: adding link\n", oi->master->name,
2696                  oi->slave->name);
2697
2698         _alloc_links(&ml, &sl);
2699
2700         ml->ocp_if = oi;
2701         INIT_LIST_HEAD(&ml->node);
2702         list_add(&ml->node, &oi->master->master_ports);
2703         oi->master->masters_cnt++;
2704
2705         sl->ocp_if = oi;
2706         INIT_LIST_HEAD(&sl->node);
2707         list_add(&sl->node, &oi->slave->slave_ports);
2708         oi->slave->slaves_cnt++;
2709
2710         return 0;
2711 }
2712
2713 /**
2714  * _register_link - register a struct omap_hwmod_ocp_if
2715  * @oi: struct omap_hwmod_ocp_if *
2716  *
2717  * Registers the omap_hwmod_ocp_if record @oi.  Returns -EEXIST if it
2718  * has already been registered; -EINVAL if @oi is NULL or if the
2719  * record pointed to by @oi is missing required fields; or 0 upon
2720  * success.
2721  *
2722  * XXX The data should be copied into bootmem, so the original data
2723  * should be marked __initdata and freed after init.  This would allow
2724  * unneeded omap_hwmods to be freed on multi-OMAP configurations.
2725  */
2726 static int __init _register_link(struct omap_hwmod_ocp_if *oi)
2727 {
2728         if (!oi || !oi->master || !oi->slave || !oi->user)
2729                 return -EINVAL;
2730
2731         if (oi->_int_flags & _OCPIF_INT_FLAGS_REGISTERED)
2732                 return -EEXIST;
2733
2734         pr_debug("omap_hwmod: registering link from %s to %s\n",
2735                  oi->master->name, oi->slave->name);
2736
2737         /*
2738          * Register the connected hwmods, if they haven't been
2739          * registered already
2740          */
2741         if (oi->master->_state != _HWMOD_STATE_REGISTERED)
2742                 _register(oi->master);
2743
2744         if (oi->slave->_state != _HWMOD_STATE_REGISTERED)
2745                 _register(oi->slave);
2746
2747         _add_link(oi);
2748
2749         oi->_int_flags |= _OCPIF_INT_FLAGS_REGISTERED;
2750
2751         return 0;
2752 }
2753
2754 /**
2755  * _alloc_linkspace - allocate large block of hwmod links
2756  * @ois: pointer to an array of struct omap_hwmod_ocp_if records to count
2757  *
2758  * Allocate a large block of struct omap_hwmod_link records.  This
2759  * improves boot time significantly by avoiding the need to allocate
2760  * individual records one by one.  If the number of records to
2761  * allocate in the block hasn't been manually specified, this function
2762  * will count the number of struct omap_hwmod_ocp_if records in @ois
2763  * and use that to determine the allocation size.  For SoC families
2764  * that require multiple list registrations, such as OMAP3xxx, this
2765  * estimation process isn't optimal, so manual estimation is advised
2766  * in those cases.  Returns -EEXIST if the allocation has already occurred
2767  * or 0 upon success.
2768  */
2769 static int __init _alloc_linkspace(struct omap_hwmod_ocp_if **ois)
2770 {
2771         unsigned int i = 0;
2772         unsigned int sz;
2773
2774         if (linkspace) {
2775                 WARN(1, "linkspace already allocated\n");
2776                 return -EEXIST;
2777         }
2778
2779         if (max_ls == 0)
2780                 while (ois[i++])
2781                         max_ls += LINKS_PER_OCP_IF;
2782
2783         sz = sizeof(struct omap_hwmod_link) * max_ls;
2784
2785         pr_debug("omap_hwmod: %s: allocating %d byte linkspace (%d links)\n",
2786                  __func__, sz, max_ls);
2787
2788         linkspace = alloc_bootmem(sz);
2789
2790         memset(linkspace, 0, sz);
2791
2792         return 0;
2793 }
2794
2795 /* Static functions intended only for use in soc_ops field function pointers */
2796
2797 /**
2798  * _omap2xxx_wait_target_ready - wait for a module to leave slave idle
2799  * @oh: struct omap_hwmod *
2800  *
2801  * Wait for a module @oh to leave slave idle.  Returns 0 if the module
2802  * does not have an IDLEST bit or if the module successfully leaves
2803  * slave idle; otherwise, pass along the return value of the
2804  * appropriate *_cm*_wait_module_ready() function.
2805  */
2806 static int _omap2xxx_wait_target_ready(struct omap_hwmod *oh)
2807 {
2808         if (!oh)
2809                 return -EINVAL;
2810
2811         if (oh->flags & HWMOD_NO_IDLEST)
2812                 return 0;
2813
2814         if (!_find_mpu_rt_port(oh))
2815                 return 0;
2816
2817         /* XXX check module SIDLEMODE, hardreset status, enabled clocks */
2818
2819         return omap2xxx_cm_wait_module_ready(oh->prcm.omap2.module_offs,
2820                                              oh->prcm.omap2.idlest_reg_id,
2821                                              oh->prcm.omap2.idlest_idle_bit);
2822 }
2823
2824 /**
2825  * _omap3xxx_wait_target_ready - wait for a module to leave slave idle
2826  * @oh: struct omap_hwmod *
2827  *
2828  * Wait for a module @oh to leave slave idle.  Returns 0 if the module
2829  * does not have an IDLEST bit or if the module successfully leaves
2830  * slave idle; otherwise, pass along the return value of the
2831  * appropriate *_cm*_wait_module_ready() function.
2832  */
2833 static int _omap3xxx_wait_target_ready(struct omap_hwmod *oh)
2834 {
2835         if (!oh)
2836                 return -EINVAL;
2837
2838         if (oh->flags & HWMOD_NO_IDLEST)
2839                 return 0;
2840
2841         if (!_find_mpu_rt_port(oh))
2842                 return 0;
2843
2844         /* XXX check module SIDLEMODE, hardreset status, enabled clocks */
2845
2846         return omap3xxx_cm_wait_module_ready(oh->prcm.omap2.module_offs,
2847                                              oh->prcm.omap2.idlest_reg_id,
2848                                              oh->prcm.omap2.idlest_idle_bit);
2849 }
2850
2851 /**
2852  * _omap4_wait_target_ready - wait for a module to leave slave idle
2853  * @oh: struct omap_hwmod *
2854  *
2855  * Wait for a module @oh to leave slave idle.  Returns 0 if the module
2856  * does not have an IDLEST bit or if the module successfully leaves
2857  * slave idle; otherwise, pass along the return value of the
2858  * appropriate *_cm*_wait_module_ready() function.
2859  */
2860 static int _omap4_wait_target_ready(struct omap_hwmod *oh)
2861 {
2862         if (!oh)
2863                 return -EINVAL;
2864
2865         if (oh->flags & HWMOD_NO_IDLEST || !oh->clkdm)
2866                 return 0;
2867
2868         if (!_find_mpu_rt_port(oh))
2869                 return 0;
2870
2871         /* XXX check module SIDLEMODE, hardreset status */
2872
2873         return omap4_cminst_wait_module_ready(oh->clkdm->prcm_partition,
2874                                               oh->clkdm->cm_inst,
2875                                               oh->clkdm->clkdm_offs,
2876                                               oh->prcm.omap4.clkctrl_offs);
2877 }
2878
2879 /**
2880  * _am33xx_wait_target_ready - wait for a module to leave slave idle
2881  * @oh: struct omap_hwmod *
2882  *
2883  * Wait for a module @oh to leave slave idle.  Returns 0 if the module
2884  * does not have an IDLEST bit or if the module successfully leaves
2885  * slave idle; otherwise, pass along the return value of the
2886  * appropriate *_cm*_wait_module_ready() function.
2887  */
2888 static int _am33xx_wait_target_ready(struct omap_hwmod *oh)
2889 {
2890         if (!oh || !oh->clkdm)
2891                 return -EINVAL;
2892
2893         if (oh->flags & HWMOD_NO_IDLEST)
2894                 return 0;
2895
2896         if (!_find_mpu_rt_port(oh))
2897                 return 0;
2898
2899         /* XXX check module SIDLEMODE, hardreset status */
2900
2901         return am33xx_cm_wait_module_ready(oh->clkdm->cm_inst,
2902                                               oh->clkdm->clkdm_offs,
2903                                               oh->prcm.omap4.clkctrl_offs);
2904 }
2905
2906 /**
2907  * _omap2_assert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2908  * @oh: struct omap_hwmod * to assert hardreset
2909  * @ohri: hardreset line data
2910  *
2911  * Call omap2_prm_assert_hardreset() with parameters extracted from
2912  * the hwmod @oh and the hardreset line data @ohri.  Only intended for
2913  * use as an soc_ops function pointer.  Passes along the return value
2914  * from omap2_prm_assert_hardreset().  XXX This function is scheduled
2915  * for removal when the PRM code is moved into drivers/.
2916  */
2917 static int _omap2_assert_hardreset(struct omap_hwmod *oh,
2918                                    struct omap_hwmod_rst_info *ohri)
2919 {
2920         return omap2_prm_assert_hardreset(oh->prcm.omap2.module_offs,
2921                                           ohri->rst_shift);
2922 }
2923
2924 /**
2925  * _omap2_deassert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2926  * @oh: struct omap_hwmod * to deassert hardreset
2927  * @ohri: hardreset line data
2928  *
2929  * Call omap2_prm_deassert_hardreset() with parameters extracted from
2930  * the hwmod @oh and the hardreset line data @ohri.  Only intended for
2931  * use as an soc_ops function pointer.  Passes along the return value
2932  * from omap2_prm_deassert_hardreset().  XXX This function is
2933  * scheduled for removal when the PRM code is moved into drivers/.
2934  */
2935 static int _omap2_deassert_hardreset(struct omap_hwmod *oh,
2936                                      struct omap_hwmod_rst_info *ohri)
2937 {
2938         return omap2_prm_deassert_hardreset(oh->prcm.omap2.module_offs,
2939                                             ohri->rst_shift,
2940                                             ohri->st_shift);
2941 }
2942
2943 /**
2944  * _omap2_is_hardreset_asserted - call OMAP2 PRM hardreset fn with hwmod args
2945  * @oh: struct omap_hwmod * to test hardreset
2946  * @ohri: hardreset line data
2947  *
2948  * Call omap2_prm_is_hardreset_asserted() with parameters extracted
2949  * from the hwmod @oh and the hardreset line data @ohri.  Only
2950  * intended for use as an soc_ops function pointer.  Passes along the
2951  * return value from omap2_prm_is_hardreset_asserted().  XXX This
2952  * function is scheduled for removal when the PRM code is moved into
2953  * drivers/.
2954  */
2955 static int _omap2_is_hardreset_asserted(struct omap_hwmod *oh,
2956                                         struct omap_hwmod_rst_info *ohri)
2957 {
2958         return omap2_prm_is_hardreset_asserted(oh->prcm.omap2.module_offs,
2959                                                ohri->st_shift);
2960 }
2961
2962 /**
2963  * _omap4_assert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
2964  * @oh: struct omap_hwmod * to assert hardreset
2965  * @ohri: hardreset line data
2966  *
2967  * Call omap4_prminst_assert_hardreset() with parameters extracted
2968  * from the hwmod @oh and the hardreset line data @ohri.  Only
2969  * intended for use as an soc_ops function pointer.  Passes along the
2970  * return value from omap4_prminst_assert_hardreset().  XXX This
2971  * function is scheduled for removal when the PRM code is moved into
2972  * drivers/.
2973  */
2974 static int _omap4_assert_hardreset(struct omap_hwmod *oh,
2975                                    struct omap_hwmod_rst_info *ohri)
2976 {
2977         if (!oh->clkdm)
2978                 return -EINVAL;
2979
2980         return omap4_prminst_assert_hardreset(ohri->rst_shift,
2981                                 oh->clkdm->pwrdm.ptr->prcm_partition,
2982                                 oh->clkdm->pwrdm.ptr->prcm_offs,
2983                                 oh->prcm.omap4.rstctrl_offs);
2984 }
2985
2986 /**
2987  * _omap4_deassert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
2988  * @oh: struct omap_hwmod * to deassert hardreset
2989  * @ohri: hardreset line data
2990  *
2991  * Call omap4_prminst_deassert_hardreset() with parameters extracted
2992  * from the hwmod @oh and the hardreset line data @ohri.  Only
2993  * intended for use as an soc_ops function pointer.  Passes along the
2994  * return value from omap4_prminst_deassert_hardreset().  XXX This
2995  * function is scheduled for removal when the PRM code is moved into
2996  * drivers/.
2997  */
2998 static int _omap4_deassert_hardreset(struct omap_hwmod *oh,
2999                                      struct omap_hwmod_rst_info *ohri)
3000 {
3001         if (!oh->clkdm)
3002                 return -EINVAL;
3003
3004         if (ohri->st_shift)
3005                 pr_err("omap_hwmod: %s: %s: hwmod data error: OMAP4 does not support st_shift\n",
3006                        oh->name, ohri->name);
3007         return omap4_prminst_deassert_hardreset(ohri->rst_shift,
3008                                 oh->clkdm->pwrdm.ptr->prcm_partition,
3009                                 oh->clkdm->pwrdm.ptr->prcm_offs,
3010                                 oh->prcm.omap4.rstctrl_offs);
3011 }
3012
3013 /**
3014  * _omap4_is_hardreset_asserted - call OMAP4 PRM hardreset fn with hwmod args
3015  * @oh: struct omap_hwmod * to test hardreset
3016  * @ohri: hardreset line data
3017  *
3018  * Call omap4_prminst_is_hardreset_asserted() with parameters
3019  * extracted from the hwmod @oh and the hardreset line data @ohri.
3020  * Only intended for use as an soc_ops function pointer.  Passes along
3021  * the return value from omap4_prminst_is_hardreset_asserted().  XXX
3022  * This function is scheduled for removal when the PRM code is moved
3023  * into drivers/.
3024  */
3025 static int _omap4_is_hardreset_asserted(struct omap_hwmod *oh,
3026                                         struct omap_hwmod_rst_info *ohri)
3027 {
3028         if (!oh->clkdm)
3029                 return -EINVAL;
3030
3031         return omap4_prminst_is_hardreset_asserted(ohri->rst_shift,
3032                                 oh->clkdm->pwrdm.ptr->prcm_partition,
3033                                 oh->clkdm->pwrdm.ptr->prcm_offs,
3034                                 oh->prcm.omap4.rstctrl_offs);
3035 }
3036
3037 /**
3038  * _am33xx_assert_hardreset - call AM33XX PRM hardreset fn with hwmod args
3039  * @oh: struct omap_hwmod * to assert hardreset
3040  * @ohri: hardreset line data
3041  *
3042  * Call am33xx_prminst_assert_hardreset() with parameters extracted
3043  * from the hwmod @oh and the hardreset line data @ohri.  Only
3044  * intended for use as an soc_ops function pointer.  Passes along the
3045  * return value from am33xx_prminst_assert_hardreset().  XXX This
3046  * function is scheduled for removal when the PRM code is moved into
3047  * drivers/.
3048  */
3049 static int _am33xx_assert_hardreset(struct omap_hwmod *oh,
3050                                    struct omap_hwmod_rst_info *ohri)
3051
3052 {
3053         return am33xx_prm_assert_hardreset(ohri->rst_shift,
3054                                 oh->clkdm->pwrdm.ptr->prcm_offs,
3055                                 oh->prcm.omap4.rstctrl_offs);
3056 }
3057
3058 /**
3059  * _am33xx_deassert_hardreset - call AM33XX PRM hardreset fn with hwmod args
3060  * @oh: struct omap_hwmod * to deassert hardreset
3061  * @ohri: hardreset line data
3062  *
3063  * Call am33xx_prminst_deassert_hardreset() with parameters extracted
3064  * from the hwmod @oh and the hardreset line data @ohri.  Only
3065  * intended for use as an soc_ops function pointer.  Passes along the
3066  * return value from am33xx_prminst_deassert_hardreset().  XXX This
3067  * function is scheduled for removal when the PRM code is moved into
3068  * drivers/.
3069  */
3070 static int _am33xx_deassert_hardreset(struct omap_hwmod *oh,
3071                                      struct omap_hwmod_rst_info *ohri)
3072 {
3073         return am33xx_prm_deassert_hardreset(ohri->rst_shift,
3074                                 ohri->st_shift,
3075                                 oh->clkdm->pwrdm.ptr->prcm_offs,
3076                                 oh->prcm.omap4.rstctrl_offs,
3077                                 oh->prcm.omap4.rstst_offs);
3078 }
3079
3080 /**
3081  * _am33xx_is_hardreset_asserted - call AM33XX PRM hardreset fn with hwmod args
3082  * @oh: struct omap_hwmod * to test hardreset
3083  * @ohri: hardreset line data
3084  *
3085  * Call am33xx_prminst_is_hardreset_asserted() with parameters
3086  * extracted from the hwmod @oh and the hardreset line data @ohri.
3087  * Only intended for use as an soc_ops function pointer.  Passes along
3088  * the return value from am33xx_prminst_is_hardreset_asserted().  XXX
3089  * This function is scheduled for removal when the PRM code is moved
3090  * into drivers/.
3091  */
3092 static int _am33xx_is_hardreset_asserted(struct omap_hwmod *oh,
3093                                         struct omap_hwmod_rst_info *ohri)
3094 {
3095         return am33xx_prm_is_hardreset_asserted(ohri->rst_shift,
3096                                 oh->clkdm->pwrdm.ptr->prcm_offs,
3097                                 oh->prcm.omap4.rstctrl_offs);
3098 }
3099
3100 /* Public functions */
3101
3102 u32 omap_hwmod_read(struct omap_hwmod *oh, u16 reg_offs)
3103 {
3104         if (oh->flags & HWMOD_16BIT_REG)
3105                 return __raw_readw(oh->_mpu_rt_va + reg_offs);
3106         else
3107                 return __raw_readl(oh->_mpu_rt_va + reg_offs);
3108 }
3109
3110 void omap_hwmod_write(u32 v, struct omap_hwmod *oh, u16 reg_offs)
3111 {
3112         if (oh->flags & HWMOD_16BIT_REG)
3113                 __raw_writew(v, oh->_mpu_rt_va + reg_offs);
3114         else
3115                 __raw_writel(v, oh->_mpu_rt_va + reg_offs);
3116 }
3117
3118 /**
3119  * omap_hwmod_softreset - reset a module via SYSCONFIG.SOFTRESET bit
3120  * @oh: struct omap_hwmod *
3121  *
3122  * This is a public function exposed to drivers. Some drivers may need to do
3123  * some settings before and after resetting the device.  Those drivers after
3124  * doing the necessary settings could use this function to start a reset by
3125  * setting the SYSCONFIG.SOFTRESET bit.
3126  */
3127 int omap_hwmod_softreset(struct omap_hwmod *oh)
3128 {
3129         u32 v;
3130         int ret;
3131
3132         if (!oh || !(oh->_sysc_cache))
3133                 return -EINVAL;
3134
3135         v = oh->_sysc_cache;
3136         ret = _set_softreset(oh, &v);
3137         if (ret)
3138                 goto error;
3139         _write_sysconfig(v, oh);
3140
3141 error:
3142         return ret;
3143 }
3144
3145 /**
3146  * omap_hwmod_set_slave_idlemode - set the hwmod's OCP slave idlemode
3147  * @oh: struct omap_hwmod *
3148  * @idlemode: SIDLEMODE field bits (shifted to bit 0)
3149  *
3150  * Sets the IP block's OCP slave idlemode in hardware, and updates our
3151  * local copy.  Intended to be used by drivers that have some erratum
3152  * that requires direct manipulation of the SIDLEMODE bits.  Returns
3153  * -EINVAL if @oh is null, or passes along the return value from
3154  * _set_slave_idlemode().
3155  *
3156  * XXX Does this function have any current users?  If not, we should
3157  * remove it; it is better to let the rest of the hwmod code handle this.
3158  * Any users of this function should be scrutinized carefully.
3159  */
3160 int omap_hwmod_set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode)
3161 {
3162         u32 v;
3163         int retval = 0;
3164
3165         if (!oh)
3166                 return -EINVAL;
3167
3168         v = oh->_sysc_cache;
3169
3170         retval = _set_slave_idlemode(oh, idlemode, &v);
3171         if (!retval)
3172                 _write_sysconfig(v, oh);
3173
3174         return retval;
3175 }
3176
3177 /**
3178  * omap_hwmod_lookup - look up a registered omap_hwmod by name
3179  * @name: name of the omap_hwmod to look up
3180  *
3181  * Given a @name of an omap_hwmod, return a pointer to the registered
3182  * struct omap_hwmod *, or NULL upon error.
3183  */
3184 struct omap_hwmod *omap_hwmod_lookup(const char *name)
3185 {
3186         struct omap_hwmod *oh;
3187
3188         if (!name)
3189                 return NULL;
3190
3191         oh = _lookup(name);
3192
3193         return oh;
3194 }
3195
3196 /**
3197  * omap_hwmod_for_each - call function for each registered omap_hwmod
3198  * @fn: pointer to a callback function
3199  * @data: void * data to pass to callback function
3200  *
3201  * Call @fn for each registered omap_hwmod, passing @data to each
3202  * function.  @fn must return 0 for success or any other value for
3203  * failure.  If @fn returns non-zero, the iteration across omap_hwmods
3204  * will stop and the non-zero return value will be passed to the
3205  * caller of omap_hwmod_for_each().  @fn is called with
3206  * omap_hwmod_for_each() held.
3207  */
3208 int omap_hwmod_for_each(int (*fn)(struct omap_hwmod *oh, void *data),
3209                         void *data)
3210 {
3211         struct omap_hwmod *temp_oh;
3212         int ret = 0;
3213
3214         if (!fn)
3215                 return -EINVAL;
3216
3217         list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
3218                 ret = (*fn)(temp_oh, data);
3219                 if (ret)
3220                         break;
3221         }
3222
3223         return ret;
3224 }
3225
3226 /**
3227  * omap_hwmod_register_links - register an array of hwmod links
3228  * @ois: pointer to an array of omap_hwmod_ocp_if to register
3229  *
3230  * Intended to be called early in boot before the clock framework is
3231  * initialized.  If @ois is not null, will register all omap_hwmods
3232  * listed in @ois that are valid for this chip.  Returns -EINVAL if
3233  * omap_hwmod_init() hasn't been called before calling this function,
3234  * -ENOMEM if the link memory area can't be allocated, or 0 upon
3235  * success.
3236  */
3237 int __init omap_hwmod_register_links(struct omap_hwmod_ocp_if **ois)
3238 {
3239         int r, i;
3240
3241         if (!inited)
3242                 return -EINVAL;
3243
3244         if (!ois)
3245                 return 0;
3246
3247         if (!linkspace) {
3248                 if (_alloc_linkspace(ois)) {
3249                         pr_err("omap_hwmod: could not allocate link space\n");
3250                         return -ENOMEM;
3251                 }
3252         }
3253
3254         i = 0;
3255         do {
3256                 r = _register_link(ois[i]);
3257                 WARN(r && r != -EEXIST,
3258                      "omap_hwmod: _register_link(%s -> %s) returned %d\n",
3259                      ois[i]->master->name, ois[i]->slave->name, r);
3260         } while (ois[++i]);
3261
3262         return 0;
3263 }
3264
3265 /**
3266  * _ensure_mpu_hwmod_is_setup - ensure the MPU SS hwmod is init'ed and set up
3267  * @oh: pointer to the hwmod currently being set up (usually not the MPU)
3268  *
3269  * If the hwmod data corresponding to the MPU subsystem IP block
3270  * hasn't been initialized and set up yet, do so now.  This must be
3271  * done first since sleep dependencies may be added from other hwmods
3272  * to the MPU.  Intended to be called only by omap_hwmod_setup*().  No
3273  * return value.
3274  */
3275 static void __init _ensure_mpu_hwmod_is_setup(struct omap_hwmod *oh)
3276 {
3277         if (!mpu_oh || mpu_oh->_state == _HWMOD_STATE_UNKNOWN)
3278                 pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",
3279                        __func__, MPU_INITIATOR_NAME);
3280         else if (mpu_oh->_state == _HWMOD_STATE_REGISTERED && oh != mpu_oh)
3281                 omap_hwmod_setup_one(MPU_INITIATOR_NAME);
3282 }
3283
3284 /**
3285  * omap_hwmod_setup_one - set up a single hwmod
3286  * @oh_name: const char * name of the already-registered hwmod to set up
3287  *
3288  * Initialize and set up a single hwmod.  Intended to be used for a
3289  * small number of early devices, such as the timer IP blocks used for
3290  * the scheduler clock.  Must be called after omap2_clk_init().
3291  * Resolves the struct clk names to struct clk pointers for each
3292  * registered omap_hwmod.  Also calls _setup() on each hwmod.  Returns
3293  * -EINVAL upon error or 0 upon success.
3294  */
3295 int __init omap_hwmod_setup_one(const char *oh_name)
3296 {
3297         struct omap_hwmod *oh;
3298
3299         pr_debug("omap_hwmod: %s: %s\n", oh_name, __func__);
3300
3301         oh = _lookup(oh_name);
3302         if (!oh) {
3303                 WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name);
3304                 return -EINVAL;
3305         }
3306
3307         _ensure_mpu_hwmod_is_setup(oh);
3308
3309         _init(oh, NULL);
3310         _setup(oh, NULL);
3311
3312         return 0;
3313 }
3314
3315 /**
3316  * omap_hwmod_setup_all - set up all registered IP blocks
3317  *
3318  * Initialize and set up all IP blocks registered with the hwmod code.
3319  * Must be called after omap2_clk_init().  Resolves the struct clk
3320  * names to struct clk pointers for each registered omap_hwmod.  Also
3321  * calls _setup() on each hwmod.  Returns 0 upon success.
3322  */
3323 static int __init omap_hwmod_setup_all(void)
3324 {
3325         _ensure_mpu_hwmod_is_setup(NULL);
3326
3327         omap_hwmod_for_each(_init, NULL);
3328         omap_hwmod_for_each(_setup, NULL);
3329
3330         return 0;
3331 }
3332 omap_core_initcall(omap_hwmod_setup_all);
3333
3334 /**
3335  * omap_hwmod_enable - enable an omap_hwmod
3336  * @oh: struct omap_hwmod *
3337  *
3338  * Enable an omap_hwmod @oh.  Intended to be called by omap_device_enable().
3339  * Returns -EINVAL on error or passes along the return value from _enable().
3340  */
3341 int omap_hwmod_enable(struct omap_hwmod *oh)
3342 {
3343         int r;
3344         unsigned long flags;
3345
3346         if (!oh)
3347                 return -EINVAL;
3348
3349         spin_lock_irqsave(&oh->_lock, flags);
3350         r = _enable(oh);
3351         spin_unlock_irqrestore(&oh->_lock, flags);
3352
3353         return r;
3354 }
3355
3356 /**
3357  * omap_hwmod_idle - idle an omap_hwmod
3358  * @oh: struct omap_hwmod *
3359  *
3360  * Idle an omap_hwmod @oh.  Intended to be called by omap_device_idle().
3361  * Returns -EINVAL on error or passes along the return value from _idle().
3362  */
3363 int omap_hwmod_idle(struct omap_hwmod *oh)
3364 {
3365         unsigned long flags;
3366
3367         if (!oh)
3368                 return -EINVAL;
3369
3370         spin_lock_irqsave(&oh->_lock, flags);
3371         _idle(oh);
3372         spin_unlock_irqrestore(&oh->_lock, flags);
3373
3374         return 0;
3375 }
3376
3377 /**
3378  * omap_hwmod_shutdown - shutdown an omap_hwmod
3379  * @oh: struct omap_hwmod *
3380  *
3381  * Shutdown an omap_hwmod @oh.  Intended to be called by
3382  * omap_device_shutdown().  Returns -EINVAL on error or passes along
3383  * the return value from _shutdown().
3384  */
3385 int omap_hwmod_shutdown(struct omap_hwmod *oh)
3386 {
3387         unsigned long flags;
3388
3389         if (!oh)
3390                 return -EINVAL;
3391
3392         spin_lock_irqsave(&oh->_lock, flags);
3393         _shutdown(oh);
3394         spin_unlock_irqrestore(&oh->_lock, flags);
3395
3396         return 0;
3397 }
3398
3399 /**
3400  * omap_hwmod_enable_clocks - enable main_clk, all interface clocks
3401  * @oh: struct omap_hwmod *oh
3402  *
3403  * Intended to be called by the omap_device code.
3404  */
3405 int omap_hwmod_enable_clocks(struct omap_hwmod *oh)
3406 {
3407         unsigned long flags;
3408
3409         spin_lock_irqsave(&oh->_lock, flags);
3410         _enable_clocks(oh);
3411         spin_unlock_irqrestore(&oh->_lock, flags);
3412
3413         return 0;
3414 }
3415
3416 /**
3417  * omap_hwmod_disable_clocks - disable main_clk, all interface clocks
3418  * @oh: struct omap_hwmod *oh
3419  *
3420  * Intended to be called by the omap_device code.
3421  */
3422 int omap_hwmod_disable_clocks(struct omap_hwmod *oh)
3423 {
3424         unsigned long flags;
3425
3426         spin_lock_irqsave(&oh->_lock, flags);
3427         _disable_clocks(oh);
3428         spin_unlock_irqrestore(&oh->_lock, flags);
3429
3430         return 0;
3431 }
3432
3433 /**
3434  * omap_hwmod_ocp_barrier - wait for posted writes against the hwmod to complete
3435  * @oh: struct omap_hwmod *oh
3436  *
3437  * Intended to be called by drivers and core code when all posted
3438  * writes to a device must complete before continuing further
3439  * execution (for example, after clearing some device IRQSTATUS
3440  * register bits)
3441  *
3442  * XXX what about targets with multiple OCP threads?
3443  */
3444 void omap_hwmod_ocp_barrier(struct omap_hwmod *oh)
3445 {
3446         BUG_ON(!oh);
3447
3448         if (!oh->class->sysc || !oh->class->sysc->sysc_flags) {
3449                 WARN(1, "omap_device: %s: OCP barrier impossible due to device configuration\n",
3450                         oh->name);
3451                 return;
3452         }
3453
3454         /*
3455          * Forces posted writes to complete on the OCP thread handling
3456          * register writes
3457          */
3458         omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
3459 }
3460
3461 /**
3462  * omap_hwmod_reset - reset the hwmod
3463  * @oh: struct omap_hwmod *
3464  *
3465  * Under some conditions, a driver may wish to reset the entire device.
3466  * Called from omap_device code.  Returns -EINVAL on error or passes along
3467  * the return value from _reset().
3468  */
3469 int omap_hwmod_reset(struct omap_hwmod *oh)
3470 {
3471         int r;
3472         unsigned long flags;
3473
3474         if (!oh)
3475                 return -EINVAL;
3476
3477         spin_lock_irqsave(&oh->_lock, flags);
3478         r = _reset(oh);
3479         spin_unlock_irqrestore(&oh->_lock, flags);
3480
3481         return r;
3482 }
3483
3484 /*
3485  * IP block data retrieval functions
3486  */
3487
3488 /**
3489  * omap_hwmod_count_resources - count number of struct resources needed by hwmod
3490  * @oh: struct omap_hwmod *
3491  * @flags: Type of resources to include when counting (IRQ/DMA/MEM)
3492  *
3493  * Count the number of struct resource array elements necessary to
3494  * contain omap_hwmod @oh resources.  Intended to be called by code
3495  * that registers omap_devices.  Intended to be used to determine the
3496  * size of a dynamically-allocated struct resource array, before
3497  * calling omap_hwmod_fill_resources().  Returns the number of struct
3498  * resource array elements needed.
3499  *
3500  * XXX This code is not optimized.  It could attempt to merge adjacent
3501  * resource IDs.
3502  *
3503  */
3504 int omap_hwmod_count_resources(struct omap_hwmod *oh, unsigned long flags)
3505 {
3506         int ret = 0;
3507
3508         if (flags & IORESOURCE_IRQ)
3509                 ret += _count_mpu_irqs(oh);
3510
3511         if (flags & IORESOURCE_DMA)
3512                 ret += _count_sdma_reqs(oh);
3513
3514         if (flags & IORESOURCE_MEM) {
3515                 int i = 0;
3516                 struct omap_hwmod_ocp_if *os;
3517                 struct list_head *p = oh->slave_ports.next;
3518
3519                 while (i < oh->slaves_cnt) {
3520                         os = _fetch_next_ocp_if(&p, &i);
3521                         ret += _count_ocp_if_addr_spaces(os);
3522                 }
3523         }
3524
3525         return ret;
3526 }
3527
3528 /**
3529  * omap_hwmod_fill_resources - fill struct resource array with hwmod data
3530  * @oh: struct omap_hwmod *
3531  * @res: pointer to the first element of an array of struct resource to fill
3532  *
3533  * Fill the struct resource array @res with resource data from the
3534  * omap_hwmod @oh.  Intended to be called by code that registers
3535  * omap_devices.  See also omap_hwmod_count_resources().  Returns the
3536  * number of array elements filled.
3537  */
3538 int omap_hwmod_fill_resources(struct omap_hwmod *oh, struct resource *res)
3539 {
3540         struct omap_hwmod_ocp_if *os;
3541         struct list_head *p;
3542         int i, j, mpu_irqs_cnt, sdma_reqs_cnt, addr_cnt;
3543         int r = 0;
3544
3545         /* For each IRQ, DMA, memory area, fill in array.*/
3546
3547         mpu_irqs_cnt = _count_mpu_irqs(oh);
3548         for (i = 0; i < mpu_irqs_cnt; i++) {
3549                 (res + r)->name = (oh->mpu_irqs + i)->name;
3550                 (res + r)->start = (oh->mpu_irqs + i)->irq;
3551                 (res + r)->end = (oh->mpu_irqs + i)->irq;
3552                 (res + r)->flags = IORESOURCE_IRQ;
3553                 r++;
3554         }
3555
3556         sdma_reqs_cnt = _count_sdma_reqs(oh);
3557         for (i = 0; i < sdma_reqs_cnt; i++) {
3558                 (res + r)->name = (oh->sdma_reqs + i)->name;
3559                 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
3560                 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
3561                 (res + r)->flags = IORESOURCE_DMA;
3562                 r++;
3563         }
3564
3565         p = oh->slave_ports.next;
3566
3567         i = 0;
3568         while (i < oh->slaves_cnt) {
3569                 os = _fetch_next_ocp_if(&p, &i);
3570                 addr_cnt = _count_ocp_if_addr_spaces(os);
3571
3572                 for (j = 0; j < addr_cnt; j++) {
3573                         (res + r)->name = (os->addr + j)->name;
3574                         (res + r)->start = (os->addr + j)->pa_start;
3575                         (res + r)->end = (os->addr + j)->pa_end;
3576                         (res + r)->flags = IORESOURCE_MEM;
3577                         r++;
3578                 }
3579         }
3580
3581         return r;
3582 }
3583
3584 /**
3585  * omap_hwmod_fill_dma_resources - fill struct resource array with dma data
3586  * @oh: struct omap_hwmod *
3587  * @res: pointer to the array of struct resource to fill
3588  *
3589  * Fill the struct resource array @res with dma resource data from the
3590  * omap_hwmod @oh.  Intended to be called by code that registers
3591  * omap_devices.  See also omap_hwmod_count_resources().  Returns the
3592  * number of array elements filled.
3593  */
3594 int omap_hwmod_fill_dma_resources(struct omap_hwmod *oh, struct resource *res)
3595 {
3596         int i, sdma_reqs_cnt;
3597         int r = 0;
3598
3599         sdma_reqs_cnt = _count_sdma_reqs(oh);
3600         for (i = 0; i < sdma_reqs_cnt; i++) {
3601                 (res + r)->name = (oh->sdma_reqs + i)->name;
3602                 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
3603                 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
3604                 (res + r)->flags = IORESOURCE_DMA;
3605                 r++;
3606         }
3607
3608         return r;
3609 }
3610
3611 /**
3612  * omap_hwmod_get_resource_byname - fetch IP block integration data by name
3613  * @oh: struct omap_hwmod * to operate on
3614  * @type: one of the IORESOURCE_* constants from include/linux/ioport.h
3615  * @name: pointer to the name of the data to fetch (optional)
3616  * @rsrc: pointer to a struct resource, allocated by the caller
3617  *
3618  * Retrieve MPU IRQ, SDMA request line, or address space start/end
3619  * data for the IP block pointed to by @oh.  The data will be filled
3620  * into a struct resource record pointed to by @rsrc.  The struct
3621  * resource must be allocated by the caller.  When @name is non-null,
3622  * the data associated with the matching entry in the IRQ/SDMA/address
3623  * space hwmod data arrays will be returned.  If @name is null, the
3624  * first array entry will be returned.  Data order is not meaningful
3625  * in hwmod data, so callers are strongly encouraged to use a non-null
3626  * @name whenever possible to avoid unpredictable effects if hwmod
3627  * data is later added that causes data ordering to change.  This
3628  * function is only intended for use by OMAP core code.  Device
3629  * drivers should not call this function - the appropriate bus-related
3630  * data accessor functions should be used instead.  Returns 0 upon
3631  * success or a negative error code upon error.
3632  */
3633 int omap_hwmod_get_resource_byname(struct omap_hwmod *oh, unsigned int type,
3634                                    const char *name, struct resource *rsrc)
3635 {
3636         int r;
3637         unsigned int irq, dma;
3638         u32 pa_start, pa_end;
3639
3640         if (!oh || !rsrc)
3641                 return -EINVAL;
3642
3643         if (type == IORESOURCE_IRQ) {
3644                 r = _get_mpu_irq_by_name(oh, name, &irq);
3645                 if (r)
3646                         return r;
3647
3648                 rsrc->start = irq;
3649                 rsrc->end = irq;
3650         } else if (type == IORESOURCE_DMA) {
3651                 r = _get_sdma_req_by_name(oh, name, &dma);
3652                 if (r)
3653                         return r;
3654
3655                 rsrc->start = dma;
3656                 rsrc->end = dma;
3657         } else if (type == IORESOURCE_MEM) {
3658                 r = _get_addr_space_by_name(oh, name, &pa_start, &pa_end);
3659                 if (r)
3660                         return r;
3661
3662                 rsrc->start = pa_start;
3663                 rsrc->end = pa_end;
3664         } else {
3665                 return -EINVAL;
3666         }
3667
3668         rsrc->flags = type;
3669         rsrc->name = name;
3670
3671         return 0;
3672 }
3673
3674 /**
3675  * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
3676  * @oh: struct omap_hwmod *
3677  *
3678  * Return the powerdomain pointer associated with the OMAP module
3679  * @oh's main clock.  If @oh does not have a main clk, return the
3680  * powerdomain associated with the interface clock associated with the
3681  * module's MPU port. (XXX Perhaps this should use the SDMA port
3682  * instead?)  Returns NULL on error, or a struct powerdomain * on
3683  * success.
3684  */
3685 struct powerdomain *omap_hwmod_get_pwrdm(struct omap_hwmod *oh)
3686 {
3687         struct clk *c;
3688         struct omap_hwmod_ocp_if *oi;
3689         struct clockdomain *clkdm;
3690         struct clk_hw_omap *clk;
3691
3692         if (!oh)
3693                 return NULL;
3694
3695         if (oh->clkdm)
3696                 return oh->clkdm->pwrdm.ptr;
3697
3698         if (oh->_clk) {
3699                 c = oh->_clk;
3700         } else {
3701                 oi = _find_mpu_rt_port(oh);
3702                 if (!oi)
3703                         return NULL;
3704                 c = oi->_clk;
3705         }
3706
3707         clk = to_clk_hw_omap(__clk_get_hw(c));
3708         clkdm = clk->clkdm;
3709         if (!clkdm)
3710                 return NULL;
3711
3712         return clkdm->pwrdm.ptr;
3713 }
3714
3715 /**
3716  * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
3717  * @oh: struct omap_hwmod *
3718  *
3719  * Returns the virtual address corresponding to the beginning of the
3720  * module's register target, in the address range that is intended to
3721  * be used by the MPU.  Returns the virtual address upon success or NULL
3722  * upon error.
3723  */
3724 void __iomem *omap_hwmod_get_mpu_rt_va(struct omap_hwmod *oh)
3725 {
3726         if (!oh)
3727                 return NULL;
3728
3729         if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
3730                 return NULL;
3731
3732         if (oh->_state == _HWMOD_STATE_UNKNOWN)
3733                 return NULL;
3734
3735         return oh->_mpu_rt_va;
3736 }
3737
3738 /**
3739  * omap_hwmod_add_initiator_dep - add sleepdep from @init_oh to @oh
3740  * @oh: struct omap_hwmod *
3741  * @init_oh: struct omap_hwmod * (initiator)
3742  *
3743  * Add a sleep dependency between the initiator @init_oh and @oh.
3744  * Intended to be called by DSP/Bridge code via platform_data for the
3745  * DSP case; and by the DMA code in the sDMA case.  DMA code, *Bridge
3746  * code needs to add/del initiator dependencies dynamically
3747  * before/after accessing a device.  Returns the return value from
3748  * _add_initiator_dep().
3749  *
3750  * XXX Keep a usecount in the clockdomain code
3751  */
3752 int omap_hwmod_add_initiator_dep(struct omap_hwmod *oh,
3753                                  struct omap_hwmod *init_oh)
3754 {
3755         return _add_initiator_dep(oh, init_oh);
3756 }
3757
3758 /*
3759  * XXX what about functions for drivers to save/restore ocp_sysconfig
3760  * for context save/restore operations?
3761  */
3762
3763 /**
3764  * omap_hwmod_del_initiator_dep - remove sleepdep from @init_oh to @oh
3765  * @oh: struct omap_hwmod *
3766  * @init_oh: struct omap_hwmod * (initiator)
3767  *
3768  * Remove a sleep dependency between the initiator @init_oh and @oh.
3769  * Intended to be called by DSP/Bridge code via platform_data for the
3770  * DSP case; and by the DMA code in the sDMA case.  DMA code, *Bridge
3771  * code needs to add/del initiator dependencies dynamically
3772  * before/after accessing a device.  Returns the return value from
3773  * _del_initiator_dep().
3774  *
3775  * XXX Keep a usecount in the clockdomain code
3776  */
3777 int omap_hwmod_del_initiator_dep(struct omap_hwmod *oh,
3778                                  struct omap_hwmod *init_oh)
3779 {
3780         return _del_initiator_dep(oh, init_oh);
3781 }
3782
3783 /**
3784  * omap_hwmod_enable_wakeup - allow device to wake up the system
3785  * @oh: struct omap_hwmod *
3786  *
3787  * Sets the module OCP socket ENAWAKEUP bit to allow the module to
3788  * send wakeups to the PRCM, and enable I/O ring wakeup events for
3789  * this IP block if it has dynamic mux entries.  Eventually this
3790  * should set PRCM wakeup registers to cause the PRCM to receive
3791  * wakeup events from the module.  Does not set any wakeup routing
3792  * registers beyond this point - if the module is to wake up any other
3793  * module or subsystem, that must be set separately.  Called by
3794  * omap_device code.  Returns -EINVAL on error or 0 upon success.
3795  */
3796 int omap_hwmod_enable_wakeup(struct omap_hwmod *oh)
3797 {
3798         unsigned long flags;
3799         u32 v;
3800
3801         spin_lock_irqsave(&oh->_lock, flags);
3802
3803         if (oh->class->sysc &&
3804             (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)) {
3805                 v = oh->_sysc_cache;
3806                 _enable_wakeup(oh, &v);
3807                 _write_sysconfig(v, oh);
3808         }
3809
3810         _set_idle_ioring_wakeup(oh, true);
3811         spin_unlock_irqrestore(&oh->_lock, flags);
3812
3813         return 0;
3814 }
3815
3816 /**
3817  * omap_hwmod_disable_wakeup - prevent device from waking the system
3818  * @oh: struct omap_hwmod *
3819  *
3820  * Clears the module OCP socket ENAWAKEUP bit to prevent the module
3821  * from sending wakeups to the PRCM, and disable I/O ring wakeup
3822  * events for this IP block if it has dynamic mux entries.  Eventually
3823  * this should clear PRCM wakeup registers to cause the PRCM to ignore
3824  * wakeup events from the module.  Does not set any wakeup routing
3825  * registers beyond this point - if the module is to wake up any other
3826  * module or subsystem, that must be set separately.  Called by
3827  * omap_device code.  Returns -EINVAL on error or 0 upon success.
3828  */
3829 int omap_hwmod_disable_wakeup(struct omap_hwmod *oh)
3830 {
3831         unsigned long flags;
3832         u32 v;
3833
3834         spin_lock_irqsave(&oh->_lock, flags);
3835
3836         if (oh->class->sysc &&
3837             (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)) {
3838                 v = oh->_sysc_cache;
3839                 _disable_wakeup(oh, &v);
3840                 _write_sysconfig(v, oh);
3841         }
3842
3843         _set_idle_ioring_wakeup(oh, false);
3844         spin_unlock_irqrestore(&oh->_lock, flags);
3845
3846         return 0;
3847 }
3848
3849 /**
3850  * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
3851  * contained in the hwmod module.
3852  * @oh: struct omap_hwmod *
3853  * @name: name of the reset line to lookup and assert
3854  *
3855  * Some IP like dsp, ipu or iva contain processor that require
3856  * an HW reset line to be assert / deassert in order to enable fully
3857  * the IP.  Returns -EINVAL if @oh is null or if the operation is not
3858  * yet supported on this OMAP; otherwise, passes along the return value
3859  * from _assert_hardreset().
3860  */
3861 int omap_hwmod_assert_hardreset(struct omap_hwmod *oh, const char *name)
3862 {
3863         int ret;
3864         unsigned long flags;
3865
3866         if (!oh)
3867                 return -EINVAL;
3868
3869         spin_lock_irqsave(&oh->_lock, flags);
3870         ret = _assert_hardreset(oh, name);
3871         spin_unlock_irqrestore(&oh->_lock, flags);
3872
3873         return ret;
3874 }
3875
3876 /**
3877  * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
3878  * contained in the hwmod module.
3879  * @oh: struct omap_hwmod *
3880  * @name: name of the reset line to look up and deassert
3881  *
3882  * Some IP like dsp, ipu or iva contain processor that require
3883  * an HW reset line to be assert / deassert in order to enable fully
3884  * the IP.  Returns -EINVAL if @oh is null or if the operation is not
3885  * yet supported on this OMAP; otherwise, passes along the return value
3886  * from _deassert_hardreset().
3887  */
3888 int omap_hwmod_deassert_hardreset(struct omap_hwmod *oh, const char *name)
3889 {
3890         int ret;
3891         unsigned long flags;
3892
3893         if (!oh)
3894                 return -EINVAL;
3895
3896         spin_lock_irqsave(&oh->_lock, flags);
3897         ret = _deassert_hardreset(oh, name);
3898         spin_unlock_irqrestore(&oh->_lock, flags);
3899
3900         return ret;
3901 }
3902
3903 /**
3904  * omap_hwmod_read_hardreset - read the HW reset line state of submodules
3905  * contained in the hwmod module
3906  * @oh: struct omap_hwmod *
3907  * @name: name of the reset line to look up and read
3908  *
3909  * Return the current state of the hwmod @oh's reset line named @name:
3910  * returns -EINVAL upon parameter error or if this operation
3911  * is unsupported on the current OMAP; otherwise, passes along the return
3912  * value from _read_hardreset().
3913  */
3914 int omap_hwmod_read_hardreset(struct omap_hwmod *oh, const char *name)
3915 {
3916         int ret;
3917         unsigned long flags;
3918
3919         if (!oh)
3920                 return -EINVAL;
3921
3922         spin_lock_irqsave(&oh->_lock, flags);
3923         ret = _read_hardreset(oh, name);
3924         spin_unlock_irqrestore(&oh->_lock, flags);
3925
3926         return ret;
3927 }
3928
3929
3930 /**
3931  * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
3932  * @classname: struct omap_hwmod_class name to search for
3933  * @fn: callback function pointer to call for each hwmod in class @classname
3934  * @user: arbitrary context data to pass to the callback function
3935  *
3936  * For each omap_hwmod of class @classname, call @fn.
3937  * If the callback function returns something other than
3938  * zero, the iterator is terminated, and the callback function's return
3939  * value is passed back to the caller.  Returns 0 upon success, -EINVAL
3940  * if @classname or @fn are NULL, or passes back the error code from @fn.
3941  */
3942 int omap_hwmod_for_each_by_class(const char *classname,
3943                                  int (*fn)(struct omap_hwmod *oh,
3944                                            void *user),
3945                                  void *user)
3946 {
3947         struct omap_hwmod *temp_oh;
3948         int ret = 0;
3949
3950         if (!classname || !fn)
3951                 return -EINVAL;
3952
3953         pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
3954                  __func__, classname);
3955
3956         list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
3957                 if (!strcmp(temp_oh->class->name, classname)) {
3958                         pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
3959                                  __func__, temp_oh->name);
3960                         ret = (*fn)(temp_oh, user);
3961                         if (ret)
3962                                 break;
3963                 }
3964         }
3965
3966         if (ret)
3967                 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
3968                          __func__, ret);
3969
3970         return ret;
3971 }
3972
3973 /**
3974  * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
3975  * @oh: struct omap_hwmod *
3976  * @state: state that _setup() should leave the hwmod in
3977  *
3978  * Sets the hwmod state that @oh will enter at the end of _setup()
3979  * (called by omap_hwmod_setup_*()).  See also the documentation
3980  * for _setup_postsetup(), above.  Returns 0 upon success or
3981  * -EINVAL if there is a problem with the arguments or if the hwmod is
3982  * in the wrong state.
3983  */
3984 int omap_hwmod_set_postsetup_state(struct omap_hwmod *oh, u8 state)
3985 {
3986         int ret;
3987         unsigned long flags;
3988
3989         if (!oh)
3990                 return -EINVAL;
3991
3992         if (state != _HWMOD_STATE_DISABLED &&
3993             state != _HWMOD_STATE_ENABLED &&
3994             state != _HWMOD_STATE_IDLE)
3995                 return -EINVAL;
3996
3997         spin_lock_irqsave(&oh->_lock, flags);
3998
3999         if (oh->_state != _HWMOD_STATE_REGISTERED) {
4000                 ret = -EINVAL;
4001                 goto ohsps_unlock;
4002         }
4003
4004         oh->_postsetup_state = state;
4005         ret = 0;
4006
4007 ohsps_unlock:
4008         spin_unlock_irqrestore(&oh->_lock, flags);
4009
4010         return ret;
4011 }
4012
4013 /**
4014  * omap_hwmod_get_context_loss_count - get lost context count
4015  * @oh: struct omap_hwmod *
4016  *
4017  * Returns the context loss count of associated @oh
4018  * upon success, or zero if no context loss data is available.
4019  *
4020  * On OMAP4, this queries the per-hwmod context loss register,
4021  * assuming one exists.  If not, or on OMAP2/3, this queries the
4022  * enclosing powerdomain context loss count.
4023  */
4024 int omap_hwmod_get_context_loss_count(struct omap_hwmod *oh)
4025 {
4026         struct powerdomain *pwrdm;
4027         int ret = 0;
4028
4029         if (soc_ops.get_context_lost)
4030                 return soc_ops.get_context_lost(oh);
4031
4032         pwrdm = omap_hwmod_get_pwrdm(oh);
4033         if (pwrdm)
4034                 ret = pwrdm_get_context_loss_count(pwrdm);
4035
4036         return ret;
4037 }
4038
4039 /**
4040  * omap_hwmod_no_setup_reset - prevent a hwmod from being reset upon setup
4041  * @oh: struct omap_hwmod *
4042  *
4043  * Prevent the hwmod @oh from being reset during the setup process.
4044  * Intended for use by board-*.c files on boards with devices that
4045  * cannot tolerate being reset.  Must be called before the hwmod has
4046  * been set up.  Returns 0 upon success or negative error code upon
4047  * failure.
4048  */
4049 int omap_hwmod_no_setup_reset(struct omap_hwmod *oh)
4050 {
4051         if (!oh)
4052                 return -EINVAL;
4053
4054         if (oh->_state != _HWMOD_STATE_REGISTERED) {
4055                 pr_err("omap_hwmod: %s: cannot prevent setup reset; in wrong state\n",
4056                         oh->name);
4057                 return -EINVAL;
4058         }
4059
4060         oh->flags |= HWMOD_INIT_NO_RESET;
4061
4062         return 0;
4063 }
4064
4065 /**
4066  * omap_hwmod_pad_route_irq - route an I/O pad wakeup to a particular MPU IRQ
4067  * @oh: struct omap_hwmod * containing hwmod mux entries
4068  * @pad_idx: array index in oh->mux of the hwmod mux entry to route wakeup
4069  * @irq_idx: the hwmod mpu_irqs array index of the IRQ to trigger on wakeup
4070  *
4071  * When an I/O pad wakeup arrives for the dynamic or wakeup hwmod mux
4072  * entry number @pad_idx for the hwmod @oh, trigger the interrupt
4073  * service routine for the hwmod's mpu_irqs array index @irq_idx.  If
4074  * this function is not called for a given pad_idx, then the ISR
4075  * associated with @oh's first MPU IRQ will be triggered when an I/O
4076  * pad wakeup occurs on that pad.  Note that @pad_idx is the index of
4077  * the _dynamic or wakeup_ entry: if there are other entries not
4078  * marked with OMAP_DEVICE_PAD_WAKEUP or OMAP_DEVICE_PAD_REMUX, these
4079  * entries are NOT COUNTED in the dynamic pad index.  This function
4080  * must be called separately for each pad that requires its interrupt
4081  * to be re-routed this way.  Returns -EINVAL if there is an argument
4082  * problem or if @oh does not have hwmod mux entries or MPU IRQs;
4083  * returns -ENOMEM if memory cannot be allocated; or 0 upon success.
4084  *
4085  * XXX This function interface is fragile.  Rather than using array
4086  * indexes, which are subject to unpredictable change, it should be
4087  * using hwmod IRQ names, and some other stable key for the hwmod mux
4088  * pad records.
4089  */
4090 int omap_hwmod_pad_route_irq(struct omap_hwmod *oh, int pad_idx, int irq_idx)
4091 {
4092         int nr_irqs;
4093
4094         might_sleep();
4095
4096         if (!oh || !oh->mux || !oh->mpu_irqs || pad_idx < 0 ||
4097             pad_idx >= oh->mux->nr_pads_dynamic)
4098                 return -EINVAL;
4099
4100         /* Check the number of available mpu_irqs */
4101         for (nr_irqs = 0; oh->mpu_irqs[nr_irqs].irq >= 0; nr_irqs++)
4102                 ;
4103
4104         if (irq_idx >= nr_irqs)
4105                 return -EINVAL;
4106
4107         if (!oh->mux->irqs) {
4108                 /* XXX What frees this? */
4109                 oh->mux->irqs = kzalloc(sizeof(int) * oh->mux->nr_pads_dynamic,
4110                         GFP_KERNEL);
4111                 if (!oh->mux->irqs)
4112                         return -ENOMEM;
4113         }
4114         oh->mux->irqs[pad_idx] = irq_idx;
4115
4116         return 0;
4117 }
4118
4119 /**
4120  * omap_hwmod_init - initialize the hwmod code
4121  *
4122  * Sets up some function pointers needed by the hwmod code to operate on the
4123  * currently-booted SoC.  Intended to be called once during kernel init
4124  * before any hwmods are registered.  No return value.
4125  */
4126 void __init omap_hwmod_init(void)
4127 {
4128         if (cpu_is_omap24xx()) {
4129                 soc_ops.wait_target_ready = _omap2xxx_wait_target_ready;
4130                 soc_ops.assert_hardreset = _omap2_assert_hardreset;
4131                 soc_ops.deassert_hardreset = _omap2_deassert_hardreset;
4132                 soc_ops.is_hardreset_asserted = _omap2_is_hardreset_asserted;
4133         } else if (cpu_is_omap34xx()) {
4134                 soc_ops.wait_target_ready = _omap3xxx_wait_target_ready;
4135                 soc_ops.assert_hardreset = _omap2_assert_hardreset;
4136                 soc_ops.deassert_hardreset = _omap2_deassert_hardreset;
4137                 soc_ops.is_hardreset_asserted = _omap2_is_hardreset_asserted;
4138         } else if (cpu_is_omap44xx() || soc_is_omap54xx()) {
4139                 soc_ops.enable_module = _omap4_enable_module;
4140                 soc_ops.disable_module = _omap4_disable_module;
4141                 soc_ops.wait_target_ready = _omap4_wait_target_ready;
4142                 soc_ops.assert_hardreset = _omap4_assert_hardreset;
4143                 soc_ops.deassert_hardreset = _omap4_deassert_hardreset;
4144                 soc_ops.is_hardreset_asserted = _omap4_is_hardreset_asserted;
4145                 soc_ops.init_clkdm = _init_clkdm;
4146                 soc_ops.update_context_lost = _omap4_update_context_lost;
4147                 soc_ops.get_context_lost = _omap4_get_context_lost;
4148         } else if (soc_is_am33xx()) {
4149                 soc_ops.enable_module = _am33xx_enable_module;
4150                 soc_ops.disable_module = _am33xx_disable_module;
4151                 soc_ops.wait_target_ready = _am33xx_wait_target_ready;
4152                 soc_ops.assert_hardreset = _am33xx_assert_hardreset;
4153                 soc_ops.deassert_hardreset = _am33xx_deassert_hardreset;
4154                 soc_ops.is_hardreset_asserted = _am33xx_is_hardreset_asserted;
4155                 soc_ops.init_clkdm = _init_clkdm;
4156         } else {
4157                 WARN(1, "omap_hwmod: unknown SoC type\n");
4158         }
4159
4160         inited = true;
4161 }
4162
4163 /**
4164  * omap_hwmod_get_main_clk - get pointer to main clock name
4165  * @oh: struct omap_hwmod *
4166  *
4167  * Returns the main clock name assocated with @oh upon success,
4168  * or NULL if @oh is NULL.
4169  */
4170 const char *omap_hwmod_get_main_clk(struct omap_hwmod *oh)
4171 {
4172         if (!oh)
4173                 return NULL;
4174
4175         return oh->main_clk;
4176 }