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