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