Merge tag 'omap-for-v4.21/soc-signed' of git://git.kernel.org/pub/scm/linux/kernel...
[muen/linux.git] / arch / arm / mach-omap2 / omap_hwmod.c
1 /*
2  * omap_hwmod implementation for OMAP2/3/4
3  *
4  * Copyright (C) 2009-2011 Nokia Corporation
5  * Copyright (C) 2011-2012 Texas Instruments, Inc.
6  *
7  * Paul Walmsley, BenoĆ®t Cousson, Kevin Hilman
8  *
9  * Created in collaboration with (alphabetical order): Thara Gopinath,
10  * Tony Lindgren, Rajendra Nayak, Vikram Pandita, Sakari Poussa, Anand
11  * Sawant, Santosh Shilimkar, Richard Woodruff
12  *
13  * This program is free software; you can redistribute it and/or modify
14  * it under the terms of the GNU General Public License version 2 as
15  * published by the Free Software Foundation.
16  *
17  * Introduction
18  * ------------
19  * One way to view an OMAP SoC is as a collection of largely unrelated
20  * IP blocks connected by interconnects.  The IP blocks include
21  * devices such as ARM processors, audio serial interfaces, UARTs,
22  * etc.  Some of these devices, like the DSP, are created by TI;
23  * others, like the SGX, largely originate from external vendors.  In
24  * TI's documentation, on-chip devices are referred to as "OMAP
25  * modules."  Some of these IP blocks are identical across several
26  * OMAP versions.  Others are revised frequently.
27  *
28  * These OMAP modules are tied together by various interconnects.
29  * Most of the address and data flow between modules is via OCP-based
30  * interconnects such as the L3 and L4 buses; but there are other
31  * interconnects that distribute the hardware clock tree, handle idle
32  * and reset signaling, supply power, and connect the modules to
33  * various pads or balls on the OMAP package.
34  *
35  * OMAP hwmod provides a consistent way to describe the on-chip
36  * hardware blocks and their integration into the rest of the chip.
37  * This description can be automatically generated from the TI
38  * hardware database.  OMAP hwmod provides a standard, consistent API
39  * to reset, enable, idle, and disable these hardware blocks.  And
40  * hwmod provides a way for other core code, such as the Linux device
41  * code or the OMAP power management and address space mapping code,
42  * to query the hardware database.
43  *
44  * Using hwmod
45  * -----------
46  * Drivers won't call hwmod functions directly.  That is done by the
47  * omap_device code, and in rare occasions, by custom integration code
48  * in arch/arm/ *omap*.  The omap_device code includes functions to
49  * build a struct platform_device using omap_hwmod data, and that is
50  * currently how hwmod data is communicated to drivers and to the
51  * Linux driver model.  Most drivers will call omap_hwmod functions only
52  * indirectly, via pm_runtime*() functions.
53  *
54  * From a layering perspective, here is where the OMAP hwmod code
55  * fits into the kernel software stack:
56  *
57  *            +-------------------------------+
58  *            |      Device driver code       |
59  *            |      (e.g., drivers/)         |
60  *            +-------------------------------+
61  *            |      Linux driver model       |
62  *            |     (platform_device /        |
63  *            |  platform_driver data/code)   |
64  *            +-------------------------------+
65  *            | OMAP core-driver integration  |
66  *            |(arch/arm/mach-omap2/devices.c)|
67  *            +-------------------------------+
68  *            |      omap_device code         |
69  *            | (../plat-omap/omap_device.c)  |
70  *            +-------------------------------+
71  *   ---->    |    omap_hwmod code/data       |    <-----
72  *            | (../mach-omap2/omap_hwmod*)   |
73  *            +-------------------------------+
74  *            | OMAP clock/PRCM/register fns  |
75  *            | ({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/memblock.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  * @num_addrs: number of base address ranges for the provider
192  * @addr: base address(es) for the provider
193  * @size: size(s) of the provider address space(s)
194  * @node: device node associated with the provider
195  * @link: list link
196  */
197 struct clkctrl_provider {
198         int                     num_addrs;
199         u32                     *addr;
200         u32                     *size;
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         int i;
728
729         provider = memblock_alloc(sizeof(*provider), SMP_CACHE_BYTES);
730         if (!provider)
731                 return -ENOMEM;
732
733         provider->node = np;
734
735         provider->num_addrs =
736                 of_property_count_elems_of_size(np, "reg", sizeof(u32)) / 2;
737
738         provider->addr =
739                 memblock_alloc(sizeof(void *) * provider->num_addrs,
740                                SMP_CACHE_BYTES);
741         if (!provider->addr)
742                 return -ENOMEM;
743
744         provider->size =
745                 memblock_alloc(sizeof(u32) * provider->num_addrs,
746                                SMP_CACHE_BYTES);
747         if (!provider->size)
748                 return -ENOMEM;
749
750         for (i = 0; i < provider->num_addrs; i++) {
751                 addrp = of_get_address(np, i, &size, NULL);
752                 provider->addr[i] = (u32)of_translate_address(np, addrp);
753                 provider->size[i] = size;
754                 pr_debug("%s: %pOF: %x...%x\n", __func__, np, provider->addr[i],
755                          provider->addr[i] + provider->size[i]);
756         }
757
758         list_add(&provider->link, &clkctrl_providers);
759
760         return 0;
761 }
762
763 static int __init _init_clkctrl_providers(void)
764 {
765         struct device_node *np;
766         int ret = 0;
767
768         for_each_matching_node(np, ti_clkctrl_match_table) {
769                 ret = _setup_clkctrl_provider(np);
770                 if (ret)
771                         break;
772         }
773
774         return ret;
775 }
776
777 static u32 _omap4_xlate_clkctrl(struct omap_hwmod *oh)
778 {
779         if (!oh->prcm.omap4.modulemode)
780                 return 0;
781
782         return omap_cm_xlate_clkctrl(oh->clkdm->prcm_partition,
783                                      oh->clkdm->cm_inst,
784                                      oh->prcm.omap4.clkctrl_offs);
785 }
786
787 static struct clk *_lookup_clkctrl_clk(struct omap_hwmod *oh)
788 {
789         struct clkctrl_provider *provider;
790         struct clk *clk;
791         u32 addr;
792
793         if (!soc_ops.xlate_clkctrl)
794                 return NULL;
795
796         addr = soc_ops.xlate_clkctrl(oh);
797         if (!addr)
798                 return NULL;
799
800         pr_debug("%s: %s: addr=%x\n", __func__, oh->name, addr);
801
802         list_for_each_entry(provider, &clkctrl_providers, link) {
803                 int i;
804
805                 for (i = 0; i < provider->num_addrs; i++) {
806                         if (provider->addr[i] <= addr &&
807                             provider->addr[i] + provider->size[i] > addr) {
808                                 struct of_phandle_args clkspec;
809
810                                 clkspec.np = provider->node;
811                                 clkspec.args_count = 2;
812                                 clkspec.args[0] = addr - provider->addr[0];
813                                 clkspec.args[1] = 0;
814
815                                 clk = of_clk_get_from_provider(&clkspec);
816
817                                 pr_debug("%s: %s got %p (offset=%x, provider=%pOF)\n",
818                                          __func__, oh->name, clk,
819                                          clkspec.args[0], provider->node);
820
821                                 return clk;
822                         }
823                 }
824         }
825
826         return NULL;
827 }
828
829 /**
830  * _init_main_clk - get a struct clk * for the the hwmod's main functional clk
831  * @oh: struct omap_hwmod *
832  *
833  * Called from _init_clocks().  Populates the @oh _clk (main
834  * functional clock pointer) if a clock matching the hwmod name is found,
835  * or a main_clk is present.  Returns 0 on success or -EINVAL on error.
836  */
837 static int _init_main_clk(struct omap_hwmod *oh)
838 {
839         int ret = 0;
840         struct clk *clk = NULL;
841
842         clk = _lookup_clkctrl_clk(oh);
843
844         if (!IS_ERR_OR_NULL(clk)) {
845                 pr_debug("%s: mapped main_clk %s for %s\n", __func__,
846                          __clk_get_name(clk), oh->name);
847                 oh->main_clk = __clk_get_name(clk);
848                 oh->_clk = clk;
849                 soc_ops.disable_direct_prcm(oh);
850         } else {
851                 if (!oh->main_clk)
852                         return 0;
853
854                 oh->_clk = clk_get(NULL, oh->main_clk);
855         }
856
857         if (IS_ERR(oh->_clk)) {
858                 pr_warn("omap_hwmod: %s: cannot clk_get main_clk %s\n",
859                         oh->name, oh->main_clk);
860                 return -EINVAL;
861         }
862         /*
863          * HACK: This needs a re-visit once clk_prepare() is implemented
864          * to do something meaningful. Today its just a no-op.
865          * If clk_prepare() is used at some point to do things like
866          * voltage scaling etc, then this would have to be moved to
867          * some point where subsystems like i2c and pmic become
868          * available.
869          */
870         clk_prepare(oh->_clk);
871
872         if (!_get_clkdm(oh))
873                 pr_debug("omap_hwmod: %s: missing clockdomain for %s.\n",
874                            oh->name, oh->main_clk);
875
876         return ret;
877 }
878
879 /**
880  * _init_interface_clks - get a struct clk * for the the hwmod's interface clks
881  * @oh: struct omap_hwmod *
882  *
883  * Called from _init_clocks().  Populates the @oh OCP slave interface
884  * clock pointers.  Returns 0 on success or -EINVAL on error.
885  */
886 static int _init_interface_clks(struct omap_hwmod *oh)
887 {
888         struct omap_hwmod_ocp_if *os;
889         struct clk *c;
890         int ret = 0;
891
892         list_for_each_entry(os, &oh->slave_ports, node) {
893                 if (!os->clk)
894                         continue;
895
896                 c = clk_get(NULL, os->clk);
897                 if (IS_ERR(c)) {
898                         pr_warn("omap_hwmod: %s: cannot clk_get interface_clk %s\n",
899                                 oh->name, os->clk);
900                         ret = -EINVAL;
901                         continue;
902                 }
903                 os->_clk = c;
904                 /*
905                  * HACK: This needs a re-visit once clk_prepare() is implemented
906                  * to do something meaningful. Today its just a no-op.
907                  * If clk_prepare() is used at some point to do things like
908                  * voltage scaling etc, then this would have to be moved to
909                  * some point where subsystems like i2c and pmic become
910                  * available.
911                  */
912                 clk_prepare(os->_clk);
913         }
914
915         return ret;
916 }
917
918 /**
919  * _init_opt_clk - get a struct clk * for the the hwmod's optional clocks
920  * @oh: struct omap_hwmod *
921  *
922  * Called from _init_clocks().  Populates the @oh omap_hwmod_opt_clk
923  * clock pointers.  Returns 0 on success or -EINVAL on error.
924  */
925 static int _init_opt_clks(struct omap_hwmod *oh)
926 {
927         struct omap_hwmod_opt_clk *oc;
928         struct clk *c;
929         int i;
930         int ret = 0;
931
932         for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++) {
933                 c = clk_get(NULL, oc->clk);
934                 if (IS_ERR(c)) {
935                         pr_warn("omap_hwmod: %s: cannot clk_get opt_clk %s\n",
936                                 oh->name, oc->clk);
937                         ret = -EINVAL;
938                         continue;
939                 }
940                 oc->_clk = c;
941                 /*
942                  * HACK: This needs a re-visit once clk_prepare() is implemented
943                  * to do something meaningful. Today its just a no-op.
944                  * If clk_prepare() is used at some point to do things like
945                  * voltage scaling etc, then this would have to be moved to
946                  * some point where subsystems like i2c and pmic become
947                  * available.
948                  */
949                 clk_prepare(oc->_clk);
950         }
951
952         return ret;
953 }
954
955 static void _enable_optional_clocks(struct omap_hwmod *oh)
956 {
957         struct omap_hwmod_opt_clk *oc;
958         int i;
959
960         pr_debug("omap_hwmod: %s: enabling optional clocks\n", oh->name);
961
962         for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
963                 if (oc->_clk) {
964                         pr_debug("omap_hwmod: enable %s:%s\n", oc->role,
965                                  __clk_get_name(oc->_clk));
966                         clk_enable(oc->_clk);
967                 }
968 }
969
970 static void _disable_optional_clocks(struct omap_hwmod *oh)
971 {
972         struct omap_hwmod_opt_clk *oc;
973         int i;
974
975         pr_debug("omap_hwmod: %s: disabling optional clocks\n", oh->name);
976
977         for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
978                 if (oc->_clk) {
979                         pr_debug("omap_hwmod: disable %s:%s\n", oc->role,
980                                  __clk_get_name(oc->_clk));
981                         clk_disable(oc->_clk);
982                 }
983 }
984
985 /**
986  * _enable_clocks - enable hwmod main clock and interface clocks
987  * @oh: struct omap_hwmod *
988  *
989  * Enables all clocks necessary for register reads and writes to succeed
990  * on the hwmod @oh.  Returns 0.
991  */
992 static int _enable_clocks(struct omap_hwmod *oh)
993 {
994         struct omap_hwmod_ocp_if *os;
995
996         pr_debug("omap_hwmod: %s: enabling clocks\n", oh->name);
997
998         if (oh->flags & HWMOD_OPT_CLKS_NEEDED)
999                 _enable_optional_clocks(oh);
1000
1001         if (oh->_clk)
1002                 clk_enable(oh->_clk);
1003
1004         list_for_each_entry(os, &oh->slave_ports, node) {
1005                 if (os->_clk && (os->flags & OCPIF_SWSUP_IDLE))
1006                         clk_enable(os->_clk);
1007         }
1008
1009         /* The opt clocks are controlled by the device driver. */
1010
1011         return 0;
1012 }
1013
1014 /**
1015  * _omap4_clkctrl_managed_by_clkfwk - true if clkctrl managed by clock framework
1016  * @oh: struct omap_hwmod *
1017  */
1018 static bool _omap4_clkctrl_managed_by_clkfwk(struct omap_hwmod *oh)
1019 {
1020         if (oh->prcm.omap4.flags & HWMOD_OMAP4_CLKFWK_CLKCTR_CLOCK)
1021                 return true;
1022
1023         return false;
1024 }
1025
1026 /**
1027  * _omap4_has_clkctrl_clock - returns true if a module has clkctrl clock
1028  * @oh: struct omap_hwmod *
1029  */
1030 static bool _omap4_has_clkctrl_clock(struct omap_hwmod *oh)
1031 {
1032         if (oh->prcm.omap4.clkctrl_offs)
1033                 return true;
1034
1035         if (!oh->prcm.omap4.clkctrl_offs &&
1036             oh->prcm.omap4.flags & HWMOD_OMAP4_ZERO_CLKCTRL_OFFSET)
1037                 return true;
1038
1039         return false;
1040 }
1041
1042 /**
1043  * _disable_clocks - disable hwmod main clock and interface clocks
1044  * @oh: struct omap_hwmod *
1045  *
1046  * Disables the hwmod @oh main functional and interface clocks.  Returns 0.
1047  */
1048 static int _disable_clocks(struct omap_hwmod *oh)
1049 {
1050         struct omap_hwmod_ocp_if *os;
1051
1052         pr_debug("omap_hwmod: %s: disabling clocks\n", oh->name);
1053
1054         if (oh->_clk)
1055                 clk_disable(oh->_clk);
1056
1057         list_for_each_entry(os, &oh->slave_ports, node) {
1058                 if (os->_clk && (os->flags & OCPIF_SWSUP_IDLE))
1059                         clk_disable(os->_clk);
1060         }
1061
1062         if (oh->flags & HWMOD_OPT_CLKS_NEEDED)
1063                 _disable_optional_clocks(oh);
1064
1065         /* The opt clocks are controlled by the device driver. */
1066
1067         return 0;
1068 }
1069
1070 /**
1071  * _omap4_enable_module - enable CLKCTRL modulemode on OMAP4
1072  * @oh: struct omap_hwmod *
1073  *
1074  * Enables the PRCM module mode related to the hwmod @oh.
1075  * No return value.
1076  */
1077 static void _omap4_enable_module(struct omap_hwmod *oh)
1078 {
1079         if (!oh->clkdm || !oh->prcm.omap4.modulemode ||
1080             _omap4_clkctrl_managed_by_clkfwk(oh))
1081                 return;
1082
1083         pr_debug("omap_hwmod: %s: %s: %d\n",
1084                  oh->name, __func__, oh->prcm.omap4.modulemode);
1085
1086         omap_cm_module_enable(oh->prcm.omap4.modulemode,
1087                               oh->clkdm->prcm_partition,
1088                               oh->clkdm->cm_inst, oh->prcm.omap4.clkctrl_offs);
1089 }
1090
1091 /**
1092  * _omap4_wait_target_disable - wait for a module to be disabled on OMAP4
1093  * @oh: struct omap_hwmod *
1094  *
1095  * Wait for a module @oh to enter slave idle.  Returns 0 if the module
1096  * does not have an IDLEST bit or if the module successfully enters
1097  * slave idle; otherwise, pass along the return value of the
1098  * appropriate *_cm*_wait_module_idle() function.
1099  */
1100 static int _omap4_wait_target_disable(struct omap_hwmod *oh)
1101 {
1102         if (!oh)
1103                 return -EINVAL;
1104
1105         if (oh->_int_flags & _HWMOD_NO_MPU_PORT || !oh->clkdm)
1106                 return 0;
1107
1108         if (oh->flags & HWMOD_NO_IDLEST)
1109                 return 0;
1110
1111         if (_omap4_clkctrl_managed_by_clkfwk(oh))
1112                 return 0;
1113
1114         if (!_omap4_has_clkctrl_clock(oh))
1115                 return 0;
1116
1117         return omap_cm_wait_module_idle(oh->clkdm->prcm_partition,
1118                                         oh->clkdm->cm_inst,
1119                                         oh->prcm.omap4.clkctrl_offs, 0);
1120 }
1121
1122 /**
1123  * _save_mpu_port_index - find and save the index to @oh's MPU port
1124  * @oh: struct omap_hwmod *
1125  *
1126  * Determines the array index of the OCP slave port that the MPU uses
1127  * to address the device, and saves it into the struct omap_hwmod.
1128  * Intended to be called during hwmod registration only. No return
1129  * value.
1130  */
1131 static void __init _save_mpu_port_index(struct omap_hwmod *oh)
1132 {
1133         struct omap_hwmod_ocp_if *os = NULL;
1134
1135         if (!oh)
1136                 return;
1137
1138         oh->_int_flags |= _HWMOD_NO_MPU_PORT;
1139
1140         list_for_each_entry(os, &oh->slave_ports, node) {
1141                 if (os->user & OCP_USER_MPU) {
1142                         oh->_mpu_port = os;
1143                         oh->_int_flags &= ~_HWMOD_NO_MPU_PORT;
1144                         break;
1145                 }
1146         }
1147
1148         return;
1149 }
1150
1151 /**
1152  * _find_mpu_rt_port - return omap_hwmod_ocp_if accessible by the MPU
1153  * @oh: struct omap_hwmod *
1154  *
1155  * Given a pointer to a struct omap_hwmod record @oh, return a pointer
1156  * to the struct omap_hwmod_ocp_if record that is used by the MPU to
1157  * communicate with the IP block.  This interface need not be directly
1158  * connected to the MPU (and almost certainly is not), but is directly
1159  * connected to the IP block represented by @oh.  Returns a pointer
1160  * to the struct omap_hwmod_ocp_if * upon success, or returns NULL upon
1161  * error or if there does not appear to be a path from the MPU to this
1162  * IP block.
1163  */
1164 static struct omap_hwmod_ocp_if *_find_mpu_rt_port(struct omap_hwmod *oh)
1165 {
1166         if (!oh || oh->_int_flags & _HWMOD_NO_MPU_PORT || oh->slaves_cnt == 0)
1167                 return NULL;
1168
1169         return oh->_mpu_port;
1170 };
1171
1172 /**
1173  * _enable_sysc - try to bring a module out of idle via OCP_SYSCONFIG
1174  * @oh: struct omap_hwmod *
1175  *
1176  * Ensure that the OCP_SYSCONFIG register for the IP block represented
1177  * by @oh is set to indicate to the PRCM that the IP block is active.
1178  * Usually this means placing the module into smart-idle mode and
1179  * smart-standby, but if there is a bug in the automatic idle handling
1180  * for the IP block, it may need to be placed into the force-idle or
1181  * no-idle variants of these modes.  No return value.
1182  */
1183 static void _enable_sysc(struct omap_hwmod *oh)
1184 {
1185         u8 idlemode, sf;
1186         u32 v;
1187         bool clkdm_act;
1188         struct clockdomain *clkdm;
1189
1190         if (!oh->class->sysc)
1191                 return;
1192
1193         /*
1194          * Wait until reset has completed, this is needed as the IP
1195          * block is reset automatically by hardware in some cases
1196          * (off-mode for example), and the drivers require the
1197          * IP to be ready when they access it
1198          */
1199         if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1200                 _enable_optional_clocks(oh);
1201         _wait_softreset_complete(oh);
1202         if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1203                 _disable_optional_clocks(oh);
1204
1205         v = oh->_sysc_cache;
1206         sf = oh->class->sysc->sysc_flags;
1207
1208         clkdm = _get_clkdm(oh);
1209         if (sf & SYSC_HAS_SIDLEMODE) {
1210                 if (oh->flags & HWMOD_SWSUP_SIDLE ||
1211                     oh->flags & HWMOD_SWSUP_SIDLE_ACT) {
1212                         idlemode = HWMOD_IDLEMODE_NO;
1213                 } else {
1214                         if (sf & SYSC_HAS_ENAWAKEUP)
1215                                 _enable_wakeup(oh, &v);
1216                         if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
1217                                 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1218                         else
1219                                 idlemode = HWMOD_IDLEMODE_SMART;
1220                 }
1221
1222                 /*
1223                  * This is special handling for some IPs like
1224                  * 32k sync timer. Force them to idle!
1225                  */
1226                 clkdm_act = (clkdm && clkdm->flags & CLKDM_ACTIVE_WITH_MPU);
1227                 if (clkdm_act && !(oh->class->sysc->idlemodes &
1228                                    (SIDLE_SMART | SIDLE_SMART_WKUP)))
1229                         idlemode = HWMOD_IDLEMODE_FORCE;
1230
1231                 _set_slave_idlemode(oh, idlemode, &v);
1232         }
1233
1234         if (sf & SYSC_HAS_MIDLEMODE) {
1235                 if (oh->flags & HWMOD_FORCE_MSTANDBY) {
1236                         idlemode = HWMOD_IDLEMODE_FORCE;
1237                 } else if (oh->flags & HWMOD_SWSUP_MSTANDBY) {
1238                         idlemode = HWMOD_IDLEMODE_NO;
1239                 } else {
1240                         if (sf & SYSC_HAS_ENAWAKEUP)
1241                                 _enable_wakeup(oh, &v);
1242                         if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1243                                 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1244                         else
1245                                 idlemode = HWMOD_IDLEMODE_SMART;
1246                 }
1247                 _set_master_standbymode(oh, idlemode, &v);
1248         }
1249
1250         /*
1251          * XXX The clock framework should handle this, by
1252          * calling into this code.  But this must wait until the
1253          * clock structures are tagged with omap_hwmod entries
1254          */
1255         if ((oh->flags & HWMOD_SET_DEFAULT_CLOCKACT) &&
1256             (sf & SYSC_HAS_CLOCKACTIVITY))
1257                 _set_clockactivity(oh, CLOCKACT_TEST_ICLK, &v);
1258
1259         _write_sysconfig(v, oh);
1260
1261         /*
1262          * Set the autoidle bit only after setting the smartidle bit
1263          * Setting this will not have any impact on the other modules.
1264          */
1265         if (sf & SYSC_HAS_AUTOIDLE) {
1266                 idlemode = (oh->flags & HWMOD_NO_OCP_AUTOIDLE) ?
1267                         0 : 1;
1268                 _set_module_autoidle(oh, idlemode, &v);
1269                 _write_sysconfig(v, oh);
1270         }
1271 }
1272
1273 /**
1274  * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
1275  * @oh: struct omap_hwmod *
1276  *
1277  * If module is marked as SWSUP_SIDLE, force the module into slave
1278  * idle; otherwise, configure it for smart-idle.  If module is marked
1279  * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
1280  * configure it for smart-standby.  No return value.
1281  */
1282 static void _idle_sysc(struct omap_hwmod *oh)
1283 {
1284         u8 idlemode, sf;
1285         u32 v;
1286
1287         if (!oh->class->sysc)
1288                 return;
1289
1290         v = oh->_sysc_cache;
1291         sf = oh->class->sysc->sysc_flags;
1292
1293         if (sf & SYSC_HAS_SIDLEMODE) {
1294                 if (oh->flags & HWMOD_SWSUP_SIDLE) {
1295                         idlemode = HWMOD_IDLEMODE_FORCE;
1296                 } else {
1297                         if (sf & SYSC_HAS_ENAWAKEUP)
1298                                 _enable_wakeup(oh, &v);
1299                         if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
1300                                 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1301                         else
1302                                 idlemode = HWMOD_IDLEMODE_SMART;
1303                 }
1304                 _set_slave_idlemode(oh, idlemode, &v);
1305         }
1306
1307         if (sf & SYSC_HAS_MIDLEMODE) {
1308                 if ((oh->flags & HWMOD_SWSUP_MSTANDBY) ||
1309                     (oh->flags & HWMOD_FORCE_MSTANDBY)) {
1310                         idlemode = HWMOD_IDLEMODE_FORCE;
1311                 } else {
1312                         if (sf & SYSC_HAS_ENAWAKEUP)
1313                                 _enable_wakeup(oh, &v);
1314                         if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1315                                 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1316                         else
1317                                 idlemode = HWMOD_IDLEMODE_SMART;
1318                 }
1319                 _set_master_standbymode(oh, idlemode, &v);
1320         }
1321
1322         /* If the cached value is the same as the new value, skip the write */
1323         if (oh->_sysc_cache != v)
1324                 _write_sysconfig(v, oh);
1325 }
1326
1327 /**
1328  * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
1329  * @oh: struct omap_hwmod *
1330  *
1331  * Force the module into slave idle and master suspend. No return
1332  * value.
1333  */
1334 static void _shutdown_sysc(struct omap_hwmod *oh)
1335 {
1336         u32 v;
1337         u8 sf;
1338
1339         if (!oh->class->sysc)
1340                 return;
1341
1342         v = oh->_sysc_cache;
1343         sf = oh->class->sysc->sysc_flags;
1344
1345         if (sf & SYSC_HAS_SIDLEMODE)
1346                 _set_slave_idlemode(oh, HWMOD_IDLEMODE_FORCE, &v);
1347
1348         if (sf & SYSC_HAS_MIDLEMODE)
1349                 _set_master_standbymode(oh, HWMOD_IDLEMODE_FORCE, &v);
1350
1351         if (sf & SYSC_HAS_AUTOIDLE)
1352                 _set_module_autoidle(oh, 1, &v);
1353
1354         _write_sysconfig(v, oh);
1355 }
1356
1357 /**
1358  * _lookup - find an omap_hwmod by name
1359  * @name: find an omap_hwmod by name
1360  *
1361  * Return a pointer to an omap_hwmod by name, or NULL if not found.
1362  */
1363 static struct omap_hwmod *_lookup(const char *name)
1364 {
1365         struct omap_hwmod *oh, *temp_oh;
1366
1367         oh = NULL;
1368
1369         list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1370                 if (!strcmp(name, temp_oh->name)) {
1371                         oh = temp_oh;
1372                         break;
1373                 }
1374         }
1375
1376         return oh;
1377 }
1378
1379 /**
1380  * _init_clkdm - look up a clockdomain name, store pointer in omap_hwmod
1381  * @oh: struct omap_hwmod *
1382  *
1383  * Convert a clockdomain name stored in a struct omap_hwmod into a
1384  * clockdomain pointer, and save it into the struct omap_hwmod.
1385  * Return -EINVAL if the clkdm_name lookup failed.
1386  */
1387 static int _init_clkdm(struct omap_hwmod *oh)
1388 {
1389         if (!oh->clkdm_name) {
1390                 pr_debug("omap_hwmod: %s: missing clockdomain\n", oh->name);
1391                 return 0;
1392         }
1393
1394         oh->clkdm = clkdm_lookup(oh->clkdm_name);
1395         if (!oh->clkdm) {
1396                 pr_warn("omap_hwmod: %s: could not associate to clkdm %s\n",
1397                         oh->name, oh->clkdm_name);
1398                 return 0;
1399         }
1400
1401         pr_debug("omap_hwmod: %s: associated to clkdm %s\n",
1402                 oh->name, oh->clkdm_name);
1403
1404         return 0;
1405 }
1406
1407 /**
1408  * _init_clocks - clk_get() all clocks associated with this hwmod. Retrieve as
1409  * well the clockdomain.
1410  * @oh: struct omap_hwmod *
1411  * @np: device_node mapped to this hwmod
1412  *
1413  * Called by omap_hwmod_setup_*() (after omap2_clk_init()).
1414  * Resolves all clock names embedded in the hwmod.  Returns 0 on
1415  * success, or a negative error code on failure.
1416  */
1417 static int _init_clocks(struct omap_hwmod *oh, struct device_node *np)
1418 {
1419         int ret = 0;
1420
1421         if (oh->_state != _HWMOD_STATE_REGISTERED)
1422                 return 0;
1423
1424         pr_debug("omap_hwmod: %s: looking up clocks\n", oh->name);
1425
1426         if (soc_ops.init_clkdm)
1427                 ret |= soc_ops.init_clkdm(oh);
1428
1429         ret |= _init_main_clk(oh);
1430         ret |= _init_interface_clks(oh);
1431         ret |= _init_opt_clks(oh);
1432
1433         if (!ret)
1434                 oh->_state = _HWMOD_STATE_CLKS_INITED;
1435         else
1436                 pr_warn("omap_hwmod: %s: cannot _init_clocks\n", oh->name);
1437
1438         return ret;
1439 }
1440
1441 /**
1442  * _lookup_hardreset - fill register bit info for this hwmod/reset line
1443  * @oh: struct omap_hwmod *
1444  * @name: name of the reset line in the context of this hwmod
1445  * @ohri: struct omap_hwmod_rst_info * that this function will fill in
1446  *
1447  * Return the bit position of the reset line that match the
1448  * input name. Return -ENOENT if not found.
1449  */
1450 static int _lookup_hardreset(struct omap_hwmod *oh, const char *name,
1451                              struct omap_hwmod_rst_info *ohri)
1452 {
1453         int i;
1454
1455         for (i = 0; i < oh->rst_lines_cnt; i++) {
1456                 const char *rst_line = oh->rst_lines[i].name;
1457                 if (!strcmp(rst_line, name)) {
1458                         ohri->rst_shift = oh->rst_lines[i].rst_shift;
1459                         ohri->st_shift = oh->rst_lines[i].st_shift;
1460                         pr_debug("omap_hwmod: %s: %s: %s: rst %d st %d\n",
1461                                  oh->name, __func__, rst_line, ohri->rst_shift,
1462                                  ohri->st_shift);
1463
1464                         return 0;
1465                 }
1466         }
1467
1468         return -ENOENT;
1469 }
1470
1471 /**
1472  * _assert_hardreset - assert the HW reset line of submodules
1473  * contained in the hwmod module.
1474  * @oh: struct omap_hwmod *
1475  * @name: name of the reset line to lookup and assert
1476  *
1477  * Some IP like dsp, ipu or iva contain processor that require an HW
1478  * reset line to be assert / deassert in order to enable fully the IP.
1479  * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1480  * asserting the hardreset line on the currently-booted SoC, or passes
1481  * along the return value from _lookup_hardreset() or the SoC's
1482  * assert_hardreset code.
1483  */
1484 static int _assert_hardreset(struct omap_hwmod *oh, const char *name)
1485 {
1486         struct omap_hwmod_rst_info ohri;
1487         int ret = -EINVAL;
1488
1489         if (!oh)
1490                 return -EINVAL;
1491
1492         if (!soc_ops.assert_hardreset)
1493                 return -ENOSYS;
1494
1495         ret = _lookup_hardreset(oh, name, &ohri);
1496         if (ret < 0)
1497                 return ret;
1498
1499         ret = soc_ops.assert_hardreset(oh, &ohri);
1500
1501         return ret;
1502 }
1503
1504 /**
1505  * _deassert_hardreset - deassert the HW reset line of submodules contained
1506  * in the hwmod module.
1507  * @oh: struct omap_hwmod *
1508  * @name: name of the reset line to look up and deassert
1509  *
1510  * Some IP like dsp, ipu or iva contain processor that require an HW
1511  * reset line to be assert / deassert in order to enable fully the IP.
1512  * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1513  * deasserting the hardreset line on the currently-booted SoC, or passes
1514  * along the return value from _lookup_hardreset() or the SoC's
1515  * deassert_hardreset code.
1516  */
1517 static int _deassert_hardreset(struct omap_hwmod *oh, const char *name)
1518 {
1519         struct omap_hwmod_rst_info ohri;
1520         int ret = -EINVAL;
1521
1522         if (!oh)
1523                 return -EINVAL;
1524
1525         if (!soc_ops.deassert_hardreset)
1526                 return -ENOSYS;
1527
1528         ret = _lookup_hardreset(oh, name, &ohri);
1529         if (ret < 0)
1530                 return ret;
1531
1532         if (oh->clkdm) {
1533                 /*
1534                  * A clockdomain must be in SW_SUP otherwise reset
1535                  * might not be completed. The clockdomain can be set
1536                  * in HW_AUTO only when the module become ready.
1537                  */
1538                 clkdm_deny_idle(oh->clkdm);
1539                 ret = clkdm_hwmod_enable(oh->clkdm, oh);
1540                 if (ret) {
1541                         WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1542                              oh->name, oh->clkdm->name, ret);
1543                         return ret;
1544                 }
1545         }
1546
1547         _enable_clocks(oh);
1548         if (soc_ops.enable_module)
1549                 soc_ops.enable_module(oh);
1550
1551         ret = soc_ops.deassert_hardreset(oh, &ohri);
1552
1553         if (soc_ops.disable_module)
1554                 soc_ops.disable_module(oh);
1555         _disable_clocks(oh);
1556
1557         if (ret == -EBUSY)
1558                 pr_warn("omap_hwmod: %s: failed to hardreset\n", oh->name);
1559
1560         if (oh->clkdm) {
1561                 /*
1562                  * Set the clockdomain to HW_AUTO, assuming that the
1563                  * previous state was HW_AUTO.
1564                  */
1565                 clkdm_allow_idle(oh->clkdm);
1566
1567                 clkdm_hwmod_disable(oh->clkdm, oh);
1568         }
1569
1570         return ret;
1571 }
1572
1573 /**
1574  * _read_hardreset - read the HW reset line state of submodules
1575  * contained in the hwmod module
1576  * @oh: struct omap_hwmod *
1577  * @name: name of the reset line to look up and read
1578  *
1579  * Return the state of the reset line.  Returns -EINVAL if @oh is
1580  * null, -ENOSYS if we have no way of reading the hardreset line
1581  * status on the currently-booted SoC, or passes along the return
1582  * value from _lookup_hardreset() or the SoC's is_hardreset_asserted
1583  * code.
1584  */
1585 static int _read_hardreset(struct omap_hwmod *oh, const char *name)
1586 {
1587         struct omap_hwmod_rst_info ohri;
1588         int ret = -EINVAL;
1589
1590         if (!oh)
1591                 return -EINVAL;
1592
1593         if (!soc_ops.is_hardreset_asserted)
1594                 return -ENOSYS;
1595
1596         ret = _lookup_hardreset(oh, name, &ohri);
1597         if (ret < 0)
1598                 return ret;
1599
1600         return soc_ops.is_hardreset_asserted(oh, &ohri);
1601 }
1602
1603 /**
1604  * _are_all_hardreset_lines_asserted - return true if the @oh is hard-reset
1605  * @oh: struct omap_hwmod *
1606  *
1607  * If all hardreset lines associated with @oh are asserted, then return true.
1608  * Otherwise, if part of @oh is out hardreset or if no hardreset lines
1609  * associated with @oh are asserted, then return false.
1610  * This function is used to avoid executing some parts of the IP block
1611  * enable/disable sequence if its hardreset line is set.
1612  */
1613 static bool _are_all_hardreset_lines_asserted(struct omap_hwmod *oh)
1614 {
1615         int i, rst_cnt = 0;
1616
1617         if (oh->rst_lines_cnt == 0)
1618                 return false;
1619
1620         for (i = 0; i < oh->rst_lines_cnt; i++)
1621                 if (_read_hardreset(oh, oh->rst_lines[i].name) > 0)
1622                         rst_cnt++;
1623
1624         if (oh->rst_lines_cnt == rst_cnt)
1625                 return true;
1626
1627         return false;
1628 }
1629
1630 /**
1631  * _are_any_hardreset_lines_asserted - return true if any part of @oh is
1632  * hard-reset
1633  * @oh: struct omap_hwmod *
1634  *
1635  * If any hardreset lines associated with @oh are asserted, then
1636  * return true.  Otherwise, if no hardreset lines associated with @oh
1637  * are asserted, or if @oh has no hardreset lines, then return false.
1638  * This function is used to avoid executing some parts of the IP block
1639  * enable/disable sequence if any hardreset line is set.
1640  */
1641 static bool _are_any_hardreset_lines_asserted(struct omap_hwmod *oh)
1642 {
1643         int rst_cnt = 0;
1644         int i;
1645
1646         for (i = 0; i < oh->rst_lines_cnt && rst_cnt == 0; i++)
1647                 if (_read_hardreset(oh, oh->rst_lines[i].name) > 0)
1648                         rst_cnt++;
1649
1650         return (rst_cnt) ? true : false;
1651 }
1652
1653 /**
1654  * _omap4_disable_module - enable CLKCTRL modulemode on OMAP4
1655  * @oh: struct omap_hwmod *
1656  *
1657  * Disable the PRCM module mode related to the hwmod @oh.
1658  * Return EINVAL if the modulemode is not supported and 0 in case of success.
1659  */
1660 static int _omap4_disable_module(struct omap_hwmod *oh)
1661 {
1662         int v;
1663
1664         if (!oh->clkdm || !oh->prcm.omap4.modulemode ||
1665             _omap4_clkctrl_managed_by_clkfwk(oh))
1666                 return -EINVAL;
1667
1668         /*
1669          * Since integration code might still be doing something, only
1670          * disable if all lines are under hardreset.
1671          */
1672         if (_are_any_hardreset_lines_asserted(oh))
1673                 return 0;
1674
1675         pr_debug("omap_hwmod: %s: %s\n", oh->name, __func__);
1676
1677         omap_cm_module_disable(oh->clkdm->prcm_partition, oh->clkdm->cm_inst,
1678                                oh->prcm.omap4.clkctrl_offs);
1679
1680         v = _omap4_wait_target_disable(oh);
1681         if (v)
1682                 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1683                         oh->name);
1684
1685         return 0;
1686 }
1687
1688 /**
1689  * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1690  * @oh: struct omap_hwmod *
1691  *
1692  * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit.  hwmod must be
1693  * enabled for this to work.  Returns -ENOENT if the hwmod cannot be
1694  * reset this way, -EINVAL if the hwmod is in the wrong state,
1695  * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1696  *
1697  * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1698  * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1699  * use the SYSCONFIG softreset bit to provide the status.
1700  *
1701  * Note that some IP like McBSP do have reset control but don't have
1702  * reset status.
1703  */
1704 static int _ocp_softreset(struct omap_hwmod *oh)
1705 {
1706         u32 v;
1707         int c = 0;
1708         int ret = 0;
1709
1710         if (!oh->class->sysc ||
1711             !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
1712                 return -ENOENT;
1713
1714         /* clocks must be on for this operation */
1715         if (oh->_state != _HWMOD_STATE_ENABLED) {
1716                 pr_warn("omap_hwmod: %s: reset can only be entered from enabled state\n",
1717                         oh->name);
1718                 return -EINVAL;
1719         }
1720
1721         /* For some modules, all optionnal clocks need to be enabled as well */
1722         if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1723                 _enable_optional_clocks(oh);
1724
1725         pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh->name);
1726
1727         v = oh->_sysc_cache;
1728         ret = _set_softreset(oh, &v);
1729         if (ret)
1730                 goto dis_opt_clks;
1731
1732         _write_sysconfig(v, oh);
1733
1734         if (oh->class->sysc->srst_udelay)
1735                 udelay(oh->class->sysc->srst_udelay);
1736
1737         c = _wait_softreset_complete(oh);
1738         if (c == MAX_MODULE_SOFTRESET_WAIT) {
1739                 pr_warn("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1740                         oh->name, MAX_MODULE_SOFTRESET_WAIT);
1741                 ret = -ETIMEDOUT;
1742                 goto dis_opt_clks;
1743         } else {
1744                 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh->name, c);
1745         }
1746
1747         ret = _clear_softreset(oh, &v);
1748         if (ret)
1749                 goto dis_opt_clks;
1750
1751         _write_sysconfig(v, oh);
1752
1753         /*
1754          * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1755          * _wait_target_ready() or _reset()
1756          */
1757
1758 dis_opt_clks:
1759         if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1760                 _disable_optional_clocks(oh);
1761
1762         return ret;
1763 }
1764
1765 /**
1766  * _reset - reset an omap_hwmod
1767  * @oh: struct omap_hwmod *
1768  *
1769  * Resets an omap_hwmod @oh.  If the module has a custom reset
1770  * function pointer defined, then call it to reset the IP block, and
1771  * pass along its return value to the caller.  Otherwise, if the IP
1772  * block has an OCP_SYSCONFIG register with a SOFTRESET bitfield
1773  * associated with it, call a function to reset the IP block via that
1774  * method, and pass along the return value to the caller.  Finally, if
1775  * the IP block has some hardreset lines associated with it, assert
1776  * all of those, but do _not_ deassert them. (This is because driver
1777  * authors have expressed an apparent requirement to control the
1778  * deassertion of the hardreset lines themselves.)
1779  *
1780  * The default software reset mechanism for most OMAP IP blocks is
1781  * triggered via the OCP_SYSCONFIG.SOFTRESET bit.  However, some
1782  * hwmods cannot be reset via this method.  Some are not targets and
1783  * therefore have no OCP header registers to access.  Others (like the
1784  * IVA) have idiosyncratic reset sequences.  So for these relatively
1785  * rare cases, custom reset code can be supplied in the struct
1786  * omap_hwmod_class .reset function pointer.
1787  *
1788  * _set_dmadisable() is called to set the DMADISABLE bit so that it
1789  * does not prevent idling of the system. This is necessary for cases
1790  * where ROMCODE/BOOTLOADER uses dma and transfers control to the
1791  * kernel without disabling dma.
1792  *
1793  * Passes along the return value from either _ocp_softreset() or the
1794  * custom reset function - these must return -EINVAL if the hwmod
1795  * cannot be reset this way or if the hwmod is in the wrong state,
1796  * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1797  */
1798 static int _reset(struct omap_hwmod *oh)
1799 {
1800         int i, r;
1801
1802         pr_debug("omap_hwmod: %s: resetting\n", oh->name);
1803
1804         if (oh->class->reset) {
1805                 r = oh->class->reset(oh);
1806         } else {
1807                 if (oh->rst_lines_cnt > 0) {
1808                         for (i = 0; i < oh->rst_lines_cnt; i++)
1809                                 _assert_hardreset(oh, oh->rst_lines[i].name);
1810                         return 0;
1811                 } else {
1812                         r = _ocp_softreset(oh);
1813                         if (r == -ENOENT)
1814                                 r = 0;
1815                 }
1816         }
1817
1818         _set_dmadisable(oh);
1819
1820         /*
1821          * OCP_SYSCONFIG bits need to be reprogrammed after a
1822          * softreset.  The _enable() function should be split to avoid
1823          * the rewrite of the OCP_SYSCONFIG register.
1824          */
1825         if (oh->class->sysc) {
1826                 _update_sysc_cache(oh);
1827                 _enable_sysc(oh);
1828         }
1829
1830         return r;
1831 }
1832
1833 /**
1834  * _omap4_update_context_lost - increment hwmod context loss counter if
1835  * hwmod context was lost, and clear hardware context loss reg
1836  * @oh: hwmod to check for context loss
1837  *
1838  * If the PRCM indicates that the hwmod @oh lost context, increment
1839  * our in-memory context loss counter, and clear the RM_*_CONTEXT
1840  * bits. No return value.
1841  */
1842 static void _omap4_update_context_lost(struct omap_hwmod *oh)
1843 {
1844         if (oh->prcm.omap4.flags & HWMOD_OMAP4_NO_CONTEXT_LOSS_BIT)
1845                 return;
1846
1847         if (!prm_was_any_context_lost_old(oh->clkdm->pwrdm.ptr->prcm_partition,
1848                                           oh->clkdm->pwrdm.ptr->prcm_offs,
1849                                           oh->prcm.omap4.context_offs))
1850                 return;
1851
1852         oh->prcm.omap4.context_lost_counter++;
1853         prm_clear_context_loss_flags_old(oh->clkdm->pwrdm.ptr->prcm_partition,
1854                                          oh->clkdm->pwrdm.ptr->prcm_offs,
1855                                          oh->prcm.omap4.context_offs);
1856 }
1857
1858 /**
1859  * _omap4_get_context_lost - get context loss counter for a hwmod
1860  * @oh: hwmod to get context loss counter for
1861  *
1862  * Returns the in-memory context loss counter for a hwmod.
1863  */
1864 static int _omap4_get_context_lost(struct omap_hwmod *oh)
1865 {
1866         return oh->prcm.omap4.context_lost_counter;
1867 }
1868
1869 /**
1870  * _enable_preprogram - Pre-program an IP block during the _enable() process
1871  * @oh: struct omap_hwmod *
1872  *
1873  * Some IP blocks (such as AESS) require some additional programming
1874  * after enable before they can enter idle.  If a function pointer to
1875  * do so is present in the hwmod data, then call it and pass along the
1876  * return value; otherwise, return 0.
1877  */
1878 static int _enable_preprogram(struct omap_hwmod *oh)
1879 {
1880         if (!oh->class->enable_preprogram)
1881                 return 0;
1882
1883         return oh->class->enable_preprogram(oh);
1884 }
1885
1886 /**
1887  * _enable - enable an omap_hwmod
1888  * @oh: struct omap_hwmod *
1889  *
1890  * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
1891  * register target.  Returns -EINVAL if the hwmod is in the wrong
1892  * state or passes along the return value of _wait_target_ready().
1893  */
1894 static int _enable(struct omap_hwmod *oh)
1895 {
1896         int r;
1897
1898         pr_debug("omap_hwmod: %s: enabling\n", oh->name);
1899
1900         /*
1901          * hwmods with HWMOD_INIT_NO_IDLE flag set are left in enabled
1902          * state at init.
1903          */
1904         if (oh->_int_flags & _HWMOD_SKIP_ENABLE) {
1905                 oh->_int_flags &= ~_HWMOD_SKIP_ENABLE;
1906                 return 0;
1907         }
1908
1909         if (oh->_state != _HWMOD_STATE_INITIALIZED &&
1910             oh->_state != _HWMOD_STATE_IDLE &&
1911             oh->_state != _HWMOD_STATE_DISABLED) {
1912                 WARN(1, "omap_hwmod: %s: enabled state can only be entered from initialized, idle, or disabled state\n",
1913                         oh->name);
1914                 return -EINVAL;
1915         }
1916
1917         /*
1918          * If an IP block contains HW reset lines and all of them are
1919          * asserted, we let integration code associated with that
1920          * block handle the enable.  We've received very little
1921          * information on what those driver authors need, and until
1922          * detailed information is provided and the driver code is
1923          * posted to the public lists, this is probably the best we
1924          * can do.
1925          */
1926         if (_are_all_hardreset_lines_asserted(oh))
1927                 return 0;
1928
1929         _add_initiator_dep(oh, mpu_oh);
1930
1931         if (oh->clkdm) {
1932                 /*
1933                  * A clockdomain must be in SW_SUP before enabling
1934                  * completely the module. The clockdomain can be set
1935                  * in HW_AUTO only when the module become ready.
1936                  */
1937                 clkdm_deny_idle(oh->clkdm);
1938                 r = clkdm_hwmod_enable(oh->clkdm, oh);
1939                 if (r) {
1940                         WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1941                              oh->name, oh->clkdm->name, r);
1942                         return r;
1943                 }
1944         }
1945
1946         _enable_clocks(oh);
1947         if (soc_ops.enable_module)
1948                 soc_ops.enable_module(oh);
1949         if (oh->flags & HWMOD_BLOCK_WFI)
1950                 cpu_idle_poll_ctrl(true);
1951
1952         if (soc_ops.update_context_lost)
1953                 soc_ops.update_context_lost(oh);
1954
1955         r = (soc_ops.wait_target_ready) ? soc_ops.wait_target_ready(oh) :
1956                 -EINVAL;
1957         if (oh->clkdm && !(oh->flags & HWMOD_CLKDM_NOAUTO))
1958                 clkdm_allow_idle(oh->clkdm);
1959
1960         if (!r) {
1961                 oh->_state = _HWMOD_STATE_ENABLED;
1962
1963                 /* Access the sysconfig only if the target is ready */
1964                 if (oh->class->sysc) {
1965                         if (!(oh->_int_flags & _HWMOD_SYSCONFIG_LOADED))
1966                                 _update_sysc_cache(oh);
1967                         _enable_sysc(oh);
1968                 }
1969                 r = _enable_preprogram(oh);
1970         } else {
1971                 if (soc_ops.disable_module)
1972                         soc_ops.disable_module(oh);
1973                 _disable_clocks(oh);
1974                 pr_err("omap_hwmod: %s: _wait_target_ready failed: %d\n",
1975                        oh->name, r);
1976
1977                 if (oh->clkdm)
1978                         clkdm_hwmod_disable(oh->clkdm, oh);
1979         }
1980
1981         return r;
1982 }
1983
1984 /**
1985  * _idle - idle an omap_hwmod
1986  * @oh: struct omap_hwmod *
1987  *
1988  * Idles an omap_hwmod @oh.  This should be called once the hwmod has
1989  * no further work.  Returns -EINVAL if the hwmod is in the wrong
1990  * state or returns 0.
1991  */
1992 static int _idle(struct omap_hwmod *oh)
1993 {
1994         if (oh->flags & HWMOD_NO_IDLE) {
1995                 oh->_int_flags |= _HWMOD_SKIP_ENABLE;
1996                 return 0;
1997         }
1998
1999         pr_debug("omap_hwmod: %s: idling\n", oh->name);
2000
2001         if (_are_all_hardreset_lines_asserted(oh))
2002                 return 0;
2003
2004         if (oh->_state != _HWMOD_STATE_ENABLED) {
2005                 WARN(1, "omap_hwmod: %s: idle state can only be entered from enabled state\n",
2006                         oh->name);
2007                 return -EINVAL;
2008         }
2009
2010         if (oh->class->sysc)
2011                 _idle_sysc(oh);
2012         _del_initiator_dep(oh, mpu_oh);
2013
2014         /*
2015          * If HWMOD_CLKDM_NOAUTO is set then we don't
2016          * deny idle the clkdm again since idle was already denied
2017          * in _enable()
2018          */
2019         if (oh->clkdm && !(oh->flags & HWMOD_CLKDM_NOAUTO))
2020                 clkdm_deny_idle(oh->clkdm);
2021
2022         if (oh->flags & HWMOD_BLOCK_WFI)
2023                 cpu_idle_poll_ctrl(false);
2024         if (soc_ops.disable_module)
2025                 soc_ops.disable_module(oh);
2026
2027         /*
2028          * The module must be in idle mode before disabling any parents
2029          * clocks. Otherwise, the parent clock might be disabled before
2030          * the module transition is done, and thus will prevent the
2031          * transition to complete properly.
2032          */
2033         _disable_clocks(oh);
2034         if (oh->clkdm) {
2035                 clkdm_allow_idle(oh->clkdm);
2036                 clkdm_hwmod_disable(oh->clkdm, oh);
2037         }
2038
2039         oh->_state = _HWMOD_STATE_IDLE;
2040
2041         return 0;
2042 }
2043
2044 /**
2045  * _shutdown - shutdown an omap_hwmod
2046  * @oh: struct omap_hwmod *
2047  *
2048  * Shut down an omap_hwmod @oh.  This should be called when the driver
2049  * used for the hwmod is removed or unloaded or if the driver is not
2050  * used by the system.  Returns -EINVAL if the hwmod is in the wrong
2051  * state or returns 0.
2052  */
2053 static int _shutdown(struct omap_hwmod *oh)
2054 {
2055         int ret, i;
2056         u8 prev_state;
2057
2058         if (_are_all_hardreset_lines_asserted(oh))
2059                 return 0;
2060
2061         if (oh->_state != _HWMOD_STATE_IDLE &&
2062             oh->_state != _HWMOD_STATE_ENABLED) {
2063                 WARN(1, "omap_hwmod: %s: disabled state can only be entered from idle, or enabled state\n",
2064                         oh->name);
2065                 return -EINVAL;
2066         }
2067
2068         pr_debug("omap_hwmod: %s: disabling\n", oh->name);
2069
2070         if (oh->class->pre_shutdown) {
2071                 prev_state = oh->_state;
2072                 if (oh->_state == _HWMOD_STATE_IDLE)
2073                         _enable(oh);
2074                 ret = oh->class->pre_shutdown(oh);
2075                 if (ret) {
2076                         if (prev_state == _HWMOD_STATE_IDLE)
2077                                 _idle(oh);
2078                         return ret;
2079                 }
2080         }
2081
2082         if (oh->class->sysc) {
2083                 if (oh->_state == _HWMOD_STATE_IDLE)
2084                         _enable(oh);
2085                 _shutdown_sysc(oh);
2086         }
2087
2088         /* clocks and deps are already disabled in idle */
2089         if (oh->_state == _HWMOD_STATE_ENABLED) {
2090                 _del_initiator_dep(oh, mpu_oh);
2091                 /* XXX what about the other system initiators here? dma, dsp */
2092                 if (oh->flags & HWMOD_BLOCK_WFI)
2093                         cpu_idle_poll_ctrl(false);
2094                 if (soc_ops.disable_module)
2095                         soc_ops.disable_module(oh);
2096                 _disable_clocks(oh);
2097                 if (oh->clkdm)
2098                         clkdm_hwmod_disable(oh->clkdm, oh);
2099         }
2100         /* XXX Should this code also force-disable the optional clocks? */
2101
2102         for (i = 0; i < oh->rst_lines_cnt; i++)
2103                 _assert_hardreset(oh, oh->rst_lines[i].name);
2104
2105         oh->_state = _HWMOD_STATE_DISABLED;
2106
2107         return 0;
2108 }
2109
2110 static int of_dev_find_hwmod(struct device_node *np,
2111                              struct omap_hwmod *oh)
2112 {
2113         int count, i, res;
2114         const char *p;
2115
2116         count = of_property_count_strings(np, "ti,hwmods");
2117         if (count < 1)
2118                 return -ENODEV;
2119
2120         for (i = 0; i < count; i++) {
2121                 res = of_property_read_string_index(np, "ti,hwmods",
2122                                                     i, &p);
2123                 if (res)
2124                         continue;
2125                 if (!strcmp(p, oh->name)) {
2126                         pr_debug("omap_hwmod: dt %pOFn[%i] uses hwmod %s\n",
2127                                  np, i, oh->name);
2128                         return i;
2129                 }
2130         }
2131
2132         return -ENODEV;
2133 }
2134
2135 /**
2136  * of_dev_hwmod_lookup - look up needed hwmod from dt blob
2137  * @np: struct device_node *
2138  * @oh: struct omap_hwmod *
2139  * @index: index of the entry found
2140  * @found: struct device_node * found or NULL
2141  *
2142  * Parse the dt blob and find out needed hwmod. Recursive function is
2143  * implemented to take care hierarchical dt blob parsing.
2144  * Return: Returns 0 on success, -ENODEV when not found.
2145  */
2146 static int of_dev_hwmod_lookup(struct device_node *np,
2147                                struct omap_hwmod *oh,
2148                                int *index,
2149                                struct device_node **found)
2150 {
2151         struct device_node *np0 = NULL;
2152         int res;
2153
2154         res = of_dev_find_hwmod(np, oh);
2155         if (res >= 0) {
2156                 *found = np;
2157                 *index = res;
2158                 return 0;
2159         }
2160
2161         for_each_child_of_node(np, np0) {
2162                 struct device_node *fc;
2163                 int i;
2164
2165                 res = of_dev_hwmod_lookup(np0, oh, &i, &fc);
2166                 if (res == 0) {
2167                         *found = fc;
2168                         *index = i;
2169                         return 0;
2170                 }
2171         }
2172
2173         *found = NULL;
2174         *index = 0;
2175
2176         return -ENODEV;
2177 }
2178
2179 /**
2180  * omap_hwmod_fix_mpu_rt_idx - fix up mpu_rt_idx register offsets
2181  *
2182  * @oh: struct omap_hwmod *
2183  * @np: struct device_node *
2184  *
2185  * Fix up module register offsets for modules with mpu_rt_idx.
2186  * Only needed for cpsw with interconnect target module defined
2187  * in device tree while still using legacy hwmod platform data
2188  * for rev, sysc and syss registers.
2189  *
2190  * Can be removed when all cpsw hwmod platform data has been
2191  * dropped.
2192  */
2193 static void omap_hwmod_fix_mpu_rt_idx(struct omap_hwmod *oh,
2194                                       struct device_node *np,
2195                                       struct resource *res)
2196 {
2197         struct device_node *child = NULL;
2198         int error;
2199
2200         child = of_get_next_child(np, child);
2201         if (!child)
2202                 return;
2203
2204         error = of_address_to_resource(child, oh->mpu_rt_idx, res);
2205         if (error)
2206                 pr_err("%s: error mapping mpu_rt_idx: %i\n",
2207                        __func__, error);
2208 }
2209
2210 /**
2211  * omap_hwmod_parse_module_range - map module IO range from device tree
2212  * @oh: struct omap_hwmod *
2213  * @np: struct device_node *
2214  *
2215  * Parse the device tree range an interconnect target module provides
2216  * for it's child device IP blocks. This way we can support the old
2217  * "ti,hwmods" property with just dts data without a need for platform
2218  * data for IO resources. And we don't need all the child IP device
2219  * nodes available in the dts.
2220  */
2221 int omap_hwmod_parse_module_range(struct omap_hwmod *oh,
2222                                   struct device_node *np,
2223                                   struct resource *res)
2224 {
2225         struct property *prop;
2226         const __be32 *ranges;
2227         const char *name;
2228         u32 nr_addr, nr_size;
2229         u64 base, size;
2230         int len, error;
2231
2232         if (!res)
2233                 return -EINVAL;
2234
2235         ranges = of_get_property(np, "ranges", &len);
2236         if (!ranges)
2237                 return -ENOENT;
2238
2239         len /= sizeof(*ranges);
2240
2241         if (len < 3)
2242                 return -EINVAL;
2243
2244         of_property_for_each_string(np, "compatible", prop, name)
2245                 if (!strncmp("ti,sysc-", name, 8))
2246                         break;
2247
2248         if (!name)
2249                 return -ENOENT;
2250
2251         error = of_property_read_u32(np, "#address-cells", &nr_addr);
2252         if (error)
2253                 return -ENOENT;
2254
2255         error = of_property_read_u32(np, "#size-cells", &nr_size);
2256         if (error)
2257                 return -ENOENT;
2258
2259         if (nr_addr != 1 || nr_size != 1) {
2260                 pr_err("%s: invalid range for %s->%pOFn\n", __func__,
2261                        oh->name, np);
2262                 return -EINVAL;
2263         }
2264
2265         ranges++;
2266         base = of_translate_address(np, ranges++);
2267         size = be32_to_cpup(ranges);
2268
2269         pr_debug("omap_hwmod: %s %pOFn at 0x%llx size 0x%llx\n",
2270                  oh->name, np, base, size);
2271
2272         if (oh && oh->mpu_rt_idx) {
2273                 omap_hwmod_fix_mpu_rt_idx(oh, np, res);
2274
2275                 return 0;
2276         }
2277
2278         res->start = base;
2279         res->end = base + size - 1;
2280         res->flags = IORESOURCE_MEM;
2281
2282         return 0;
2283 }
2284
2285 /**
2286  * _init_mpu_rt_base - populate the virtual address for a hwmod
2287  * @oh: struct omap_hwmod * to locate the virtual address
2288  * @data: (unused, caller should pass NULL)
2289  * @index: index of the reg entry iospace in device tree
2290  * @np: struct device_node * of the IP block's device node in the DT data
2291  *
2292  * Cache the virtual address used by the MPU to access this IP block's
2293  * registers.  This address is needed early so the OCP registers that
2294  * are part of the device's address space can be ioremapped properly.
2295  *
2296  * If SYSC access is not needed, the registers will not be remapped
2297  * and non-availability of MPU access is not treated as an error.
2298  *
2299  * Returns 0 on success, -EINVAL if an invalid hwmod is passed, and
2300  * -ENXIO on absent or invalid register target address space.
2301  */
2302 static int __init _init_mpu_rt_base(struct omap_hwmod *oh, void *data,
2303                                     int index, struct device_node *np)
2304 {
2305         void __iomem *va_start = NULL;
2306         struct resource res;
2307         int error;
2308
2309         if (!oh)
2310                 return -EINVAL;
2311
2312         _save_mpu_port_index(oh);
2313
2314         /* if we don't need sysc access we don't need to ioremap */
2315         if (!oh->class->sysc)
2316                 return 0;
2317
2318         /* we can't continue without MPU PORT if we need sysc access */
2319         if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2320                 return -ENXIO;
2321
2322         if (!np) {
2323                 pr_err("omap_hwmod: %s: no dt node\n", oh->name);
2324                 return -ENXIO;
2325         }
2326
2327         /* Do we have a dts range for the interconnect target module? */
2328         error = omap_hwmod_parse_module_range(oh, np, &res);
2329         if (!error)
2330                 va_start = ioremap(res.start, resource_size(&res));
2331
2332         /* No ranges, rely on device reg entry */
2333         if (!va_start)
2334                 va_start = of_iomap(np, index + oh->mpu_rt_idx);
2335         if (!va_start) {
2336                 pr_err("omap_hwmod: %s: Missing dt reg%i for %pOF\n",
2337                        oh->name, index, np);
2338                 return -ENXIO;
2339         }
2340
2341         pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
2342                  oh->name, va_start);
2343
2344         oh->_mpu_rt_va = va_start;
2345         return 0;
2346 }
2347
2348 /**
2349  * _init - initialize internal data for the hwmod @oh
2350  * @oh: struct omap_hwmod *
2351  * @n: (unused)
2352  *
2353  * Look up the clocks and the address space used by the MPU to access
2354  * registers belonging to the hwmod @oh.  @oh must already be
2355  * registered at this point.  This is the first of two phases for
2356  * hwmod initialization.  Code called here does not touch any hardware
2357  * registers, it simply prepares internal data structures.  Returns 0
2358  * upon success or if the hwmod isn't registered or if the hwmod's
2359  * address space is not defined, or -EINVAL upon failure.
2360  */
2361 static int __init _init(struct omap_hwmod *oh, void *data)
2362 {
2363         int r, index;
2364         struct device_node *np = NULL;
2365         struct device_node *bus;
2366
2367         if (oh->_state != _HWMOD_STATE_REGISTERED)
2368                 return 0;
2369
2370         bus = of_find_node_by_name(NULL, "ocp");
2371         if (!bus)
2372                 return -ENODEV;
2373
2374         r = of_dev_hwmod_lookup(bus, oh, &index, &np);
2375         if (r)
2376                 pr_debug("omap_hwmod: %s missing dt data\n", oh->name);
2377         else if (np && index)
2378                 pr_warn("omap_hwmod: %s using broken dt data from %pOFn\n",
2379                         oh->name, np);
2380
2381         r = _init_mpu_rt_base(oh, NULL, index, np);
2382         if (r < 0) {
2383                 WARN(1, "omap_hwmod: %s: doesn't have mpu register target base\n",
2384                      oh->name);
2385                 return 0;
2386         }
2387
2388         r = _init_clocks(oh, np);
2389         if (r < 0) {
2390                 WARN(1, "omap_hwmod: %s: couldn't init clocks\n", oh->name);
2391                 return -EINVAL;
2392         }
2393
2394         if (np) {
2395                 if (of_find_property(np, "ti,no-reset-on-init", NULL))
2396                         oh->flags |= HWMOD_INIT_NO_RESET;
2397                 if (of_find_property(np, "ti,no-idle-on-init", NULL))
2398                         oh->flags |= HWMOD_INIT_NO_IDLE;
2399                 if (of_find_property(np, "ti,no-idle", NULL))
2400                         oh->flags |= HWMOD_NO_IDLE;
2401         }
2402
2403         oh->_state = _HWMOD_STATE_INITIALIZED;
2404
2405         return 0;
2406 }
2407
2408 /**
2409  * _setup_iclk_autoidle - configure an IP block's interface clocks
2410  * @oh: struct omap_hwmod *
2411  *
2412  * Set up the module's interface clocks.  XXX This function is still mostly
2413  * a stub; implementing this properly requires iclk autoidle usecounting in
2414  * the clock code.   No return value.
2415  */
2416 static void _setup_iclk_autoidle(struct omap_hwmod *oh)
2417 {
2418         struct omap_hwmod_ocp_if *os;
2419
2420         if (oh->_state != _HWMOD_STATE_INITIALIZED)
2421                 return;
2422
2423         list_for_each_entry(os, &oh->slave_ports, node) {
2424                 if (!os->_clk)
2425                         continue;
2426
2427                 if (os->flags & OCPIF_SWSUP_IDLE) {
2428                         /* XXX omap_iclk_deny_idle(c); */
2429                 } else {
2430                         /* XXX omap_iclk_allow_idle(c); */
2431                         clk_enable(os->_clk);
2432                 }
2433         }
2434
2435         return;
2436 }
2437
2438 /**
2439  * _setup_reset - reset an IP block during the setup process
2440  * @oh: struct omap_hwmod *
2441  *
2442  * Reset the IP block corresponding to the hwmod @oh during the setup
2443  * process.  The IP block is first enabled so it can be successfully
2444  * reset.  Returns 0 upon success or a negative error code upon
2445  * failure.
2446  */
2447 static int _setup_reset(struct omap_hwmod *oh)
2448 {
2449         int r;
2450
2451         if (oh->_state != _HWMOD_STATE_INITIALIZED)
2452                 return -EINVAL;
2453
2454         if (oh->flags & HWMOD_EXT_OPT_MAIN_CLK)
2455                 return -EPERM;
2456
2457         if (oh->rst_lines_cnt == 0) {
2458                 r = _enable(oh);
2459                 if (r) {
2460                         pr_warn("omap_hwmod: %s: cannot be enabled for reset (%d)\n",
2461                                 oh->name, oh->_state);
2462                         return -EINVAL;
2463                 }
2464         }
2465
2466         if (!(oh->flags & HWMOD_INIT_NO_RESET))
2467                 r = _reset(oh);
2468
2469         return r;
2470 }
2471
2472 /**
2473  * _setup_postsetup - transition to the appropriate state after _setup
2474  * @oh: struct omap_hwmod *
2475  *
2476  * Place an IP block represented by @oh into a "post-setup" state --
2477  * either IDLE, ENABLED, or DISABLED.  ("post-setup" simply means that
2478  * this function is called at the end of _setup().)  The postsetup
2479  * state for an IP block can be changed by calling
2480  * omap_hwmod_enter_postsetup_state() early in the boot process,
2481  * before one of the omap_hwmod_setup*() functions are called for the
2482  * IP block.
2483  *
2484  * The IP block stays in this state until a PM runtime-based driver is
2485  * loaded for that IP block.  A post-setup state of IDLE is
2486  * appropriate for almost all IP blocks with runtime PM-enabled
2487  * drivers, since those drivers are able to enable the IP block.  A
2488  * post-setup state of ENABLED is appropriate for kernels with PM
2489  * runtime disabled.  The DISABLED state is appropriate for unusual IP
2490  * blocks such as the MPU WDTIMER on kernels without WDTIMER drivers
2491  * included, since the WDTIMER starts running on reset and will reset
2492  * the MPU if left active.
2493  *
2494  * This post-setup mechanism is deprecated.  Once all of the OMAP
2495  * drivers have been converted to use PM runtime, and all of the IP
2496  * block data and interconnect data is available to the hwmod code, it
2497  * should be possible to replace this mechanism with a "lazy reset"
2498  * arrangement.  In a "lazy reset" setup, each IP block is enabled
2499  * when the driver first probes, then all remaining IP blocks without
2500  * drivers are either shut down or enabled after the drivers have
2501  * loaded.  However, this cannot take place until the above
2502  * preconditions have been met, since otherwise the late reset code
2503  * has no way of knowing which IP blocks are in use by drivers, and
2504  * which ones are unused.
2505  *
2506  * No return value.
2507  */
2508 static void _setup_postsetup(struct omap_hwmod *oh)
2509 {
2510         u8 postsetup_state;
2511
2512         if (oh->rst_lines_cnt > 0)
2513                 return;
2514
2515         postsetup_state = oh->_postsetup_state;
2516         if (postsetup_state == _HWMOD_STATE_UNKNOWN)
2517                 postsetup_state = _HWMOD_STATE_ENABLED;
2518
2519         /*
2520          * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
2521          * it should be set by the core code as a runtime flag during startup
2522          */
2523         if ((oh->flags & (HWMOD_INIT_NO_IDLE | HWMOD_NO_IDLE)) &&
2524             (postsetup_state == _HWMOD_STATE_IDLE)) {
2525                 oh->_int_flags |= _HWMOD_SKIP_ENABLE;
2526                 postsetup_state = _HWMOD_STATE_ENABLED;
2527         }
2528
2529         if (postsetup_state == _HWMOD_STATE_IDLE)
2530                 _idle(oh);
2531         else if (postsetup_state == _HWMOD_STATE_DISABLED)
2532                 _shutdown(oh);
2533         else if (postsetup_state != _HWMOD_STATE_ENABLED)
2534                 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
2535                      oh->name, postsetup_state);
2536
2537         return;
2538 }
2539
2540 /**
2541  * _setup - prepare IP block hardware for use
2542  * @oh: struct omap_hwmod *
2543  * @n: (unused, pass NULL)
2544  *
2545  * Configure the IP block represented by @oh.  This may include
2546  * enabling the IP block, resetting it, and placing it into a
2547  * post-setup state, depending on the type of IP block and applicable
2548  * flags.  IP blocks are reset to prevent any previous configuration
2549  * by the bootloader or previous operating system from interfering
2550  * with power management or other parts of the system.  The reset can
2551  * be avoided; see omap_hwmod_no_setup_reset().  This is the second of
2552  * two phases for hwmod initialization.  Code called here generally
2553  * affects the IP block hardware, or system integration hardware
2554  * associated with the IP block.  Returns 0.
2555  */
2556 static int _setup(struct omap_hwmod *oh, void *data)
2557 {
2558         if (oh->_state != _HWMOD_STATE_INITIALIZED)
2559                 return 0;
2560
2561         if (oh->parent_hwmod) {
2562                 int r;
2563
2564                 r = _enable(oh->parent_hwmod);
2565                 WARN(r, "hwmod: %s: setup: failed to enable parent hwmod %s\n",
2566                      oh->name, oh->parent_hwmod->name);
2567         }
2568
2569         _setup_iclk_autoidle(oh);
2570
2571         if (!_setup_reset(oh))
2572                 _setup_postsetup(oh);
2573
2574         if (oh->parent_hwmod) {
2575                 u8 postsetup_state;
2576
2577                 postsetup_state = oh->parent_hwmod->_postsetup_state;
2578
2579                 if (postsetup_state == _HWMOD_STATE_IDLE)
2580                         _idle(oh->parent_hwmod);
2581                 else if (postsetup_state == _HWMOD_STATE_DISABLED)
2582                         _shutdown(oh->parent_hwmod);
2583                 else if (postsetup_state != _HWMOD_STATE_ENABLED)
2584                         WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
2585                              oh->parent_hwmod->name, postsetup_state);
2586         }
2587
2588         return 0;
2589 }
2590
2591 /**
2592  * _register - register a struct omap_hwmod
2593  * @oh: struct omap_hwmod *
2594  *
2595  * Registers the omap_hwmod @oh.  Returns -EEXIST if an omap_hwmod
2596  * already has been registered by the same name; -EINVAL if the
2597  * omap_hwmod is in the wrong state, if @oh is NULL, if the
2598  * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
2599  * name, or if the omap_hwmod's class is missing a name; or 0 upon
2600  * success.
2601  *
2602  * XXX The data should be copied into bootmem, so the original data
2603  * should be marked __initdata and freed after init.  This would allow
2604  * unneeded omap_hwmods to be freed on multi-OMAP configurations.  Note
2605  * that the copy process would be relatively complex due to the large number
2606  * of substructures.
2607  */
2608 static int __init _register(struct omap_hwmod *oh)
2609 {
2610         if (!oh || !oh->name || !oh->class || !oh->class->name ||
2611             (oh->_state != _HWMOD_STATE_UNKNOWN))
2612                 return -EINVAL;
2613
2614         pr_debug("omap_hwmod: %s: registering\n", oh->name);
2615
2616         if (_lookup(oh->name))
2617                 return -EEXIST;
2618
2619         list_add_tail(&oh->node, &omap_hwmod_list);
2620
2621         INIT_LIST_HEAD(&oh->slave_ports);
2622         spin_lock_init(&oh->_lock);
2623         lockdep_set_class(&oh->_lock, &oh->hwmod_key);
2624
2625         oh->_state = _HWMOD_STATE_REGISTERED;
2626
2627         /*
2628          * XXX Rather than doing a strcmp(), this should test a flag
2629          * set in the hwmod data, inserted by the autogenerator code.
2630          */
2631         if (!strcmp(oh->name, MPU_INITIATOR_NAME))
2632                 mpu_oh = oh;
2633
2634         return 0;
2635 }
2636
2637 /**
2638  * _add_link - add an interconnect between two IP blocks
2639  * @oi: pointer to a struct omap_hwmod_ocp_if record
2640  *
2641  * Add struct omap_hwmod_link records connecting the slave IP block
2642  * specified in @oi->slave to @oi.  This code is assumed to run before
2643  * preemption or SMP has been enabled, thus avoiding the need for
2644  * locking in this code.  Changes to this assumption will require
2645  * additional locking.  Returns 0.
2646  */
2647 static int __init _add_link(struct omap_hwmod_ocp_if *oi)
2648 {
2649         pr_debug("omap_hwmod: %s -> %s: adding link\n", oi->master->name,
2650                  oi->slave->name);
2651
2652         list_add(&oi->node, &oi->slave->slave_ports);
2653         oi->slave->slaves_cnt++;
2654
2655         return 0;
2656 }
2657
2658 /**
2659  * _register_link - register a struct omap_hwmod_ocp_if
2660  * @oi: struct omap_hwmod_ocp_if *
2661  *
2662  * Registers the omap_hwmod_ocp_if record @oi.  Returns -EEXIST if it
2663  * has already been registered; -EINVAL if @oi is NULL or if the
2664  * record pointed to by @oi is missing required fields; or 0 upon
2665  * success.
2666  *
2667  * XXX The data should be copied into bootmem, so the original data
2668  * should be marked __initdata and freed after init.  This would allow
2669  * unneeded omap_hwmods to be freed on multi-OMAP configurations.
2670  */
2671 static int __init _register_link(struct omap_hwmod_ocp_if *oi)
2672 {
2673         if (!oi || !oi->master || !oi->slave || !oi->user)
2674                 return -EINVAL;
2675
2676         if (oi->_int_flags & _OCPIF_INT_FLAGS_REGISTERED)
2677                 return -EEXIST;
2678
2679         pr_debug("omap_hwmod: registering link from %s to %s\n",
2680                  oi->master->name, oi->slave->name);
2681
2682         /*
2683          * Register the connected hwmods, if they haven't been
2684          * registered already
2685          */
2686         if (oi->master->_state != _HWMOD_STATE_REGISTERED)
2687                 _register(oi->master);
2688
2689         if (oi->slave->_state != _HWMOD_STATE_REGISTERED)
2690                 _register(oi->slave);
2691
2692         _add_link(oi);
2693
2694         oi->_int_flags |= _OCPIF_INT_FLAGS_REGISTERED;
2695
2696         return 0;
2697 }
2698
2699 /* Static functions intended only for use in soc_ops field function pointers */
2700
2701 /**
2702  * _omap2xxx_3xxx_wait_target_ready - wait for a module to leave slave idle
2703  * @oh: struct omap_hwmod *
2704  *
2705  * Wait for a module @oh to leave slave idle.  Returns 0 if the module
2706  * does not have an IDLEST bit or if the module successfully leaves
2707  * slave idle; otherwise, pass along the return value of the
2708  * appropriate *_cm*_wait_module_ready() function.
2709  */
2710 static int _omap2xxx_3xxx_wait_target_ready(struct omap_hwmod *oh)
2711 {
2712         if (!oh)
2713                 return -EINVAL;
2714
2715         if (oh->flags & HWMOD_NO_IDLEST)
2716                 return 0;
2717
2718         if (!_find_mpu_rt_port(oh))
2719                 return 0;
2720
2721         /* XXX check module SIDLEMODE, hardreset status, enabled clocks */
2722
2723         return omap_cm_wait_module_ready(0, oh->prcm.omap2.module_offs,
2724                                          oh->prcm.omap2.idlest_reg_id,
2725                                          oh->prcm.omap2.idlest_idle_bit);
2726 }
2727
2728 /**
2729  * _omap4_wait_target_ready - wait for a module to leave slave idle
2730  * @oh: struct omap_hwmod *
2731  *
2732  * Wait for a module @oh to leave slave idle.  Returns 0 if the module
2733  * does not have an IDLEST bit or if the module successfully leaves
2734  * slave idle; otherwise, pass along the return value of the
2735  * appropriate *_cm*_wait_module_ready() function.
2736  */
2737 static int _omap4_wait_target_ready(struct omap_hwmod *oh)
2738 {
2739         if (!oh)
2740                 return -EINVAL;
2741
2742         if (oh->flags & HWMOD_NO_IDLEST || !oh->clkdm)
2743                 return 0;
2744
2745         if (!_find_mpu_rt_port(oh))
2746                 return 0;
2747
2748         if (_omap4_clkctrl_managed_by_clkfwk(oh))
2749                 return 0;
2750
2751         if (!_omap4_has_clkctrl_clock(oh))
2752                 return 0;
2753
2754         /* XXX check module SIDLEMODE, hardreset status */
2755
2756         return omap_cm_wait_module_ready(oh->clkdm->prcm_partition,
2757                                          oh->clkdm->cm_inst,
2758                                          oh->prcm.omap4.clkctrl_offs, 0);
2759 }
2760
2761 /**
2762  * _omap2_assert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2763  * @oh: struct omap_hwmod * to assert hardreset
2764  * @ohri: hardreset line data
2765  *
2766  * Call omap2_prm_assert_hardreset() with parameters extracted from
2767  * the hwmod @oh and the hardreset line data @ohri.  Only intended for
2768  * use as an soc_ops function pointer.  Passes along the return value
2769  * from omap2_prm_assert_hardreset().  XXX This function is scheduled
2770  * for removal when the PRM code is moved into drivers/.
2771  */
2772 static int _omap2_assert_hardreset(struct omap_hwmod *oh,
2773                                    struct omap_hwmod_rst_info *ohri)
2774 {
2775         return omap_prm_assert_hardreset(ohri->rst_shift, 0,
2776                                          oh->prcm.omap2.module_offs, 0);
2777 }
2778
2779 /**
2780  * _omap2_deassert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2781  * @oh: struct omap_hwmod * to deassert hardreset
2782  * @ohri: hardreset line data
2783  *
2784  * Call omap2_prm_deassert_hardreset() with parameters extracted from
2785  * the hwmod @oh and the hardreset line data @ohri.  Only intended for
2786  * use as an soc_ops function pointer.  Passes along the return value
2787  * from omap2_prm_deassert_hardreset().  XXX This function is
2788  * scheduled for removal when the PRM code is moved into drivers/.
2789  */
2790 static int _omap2_deassert_hardreset(struct omap_hwmod *oh,
2791                                      struct omap_hwmod_rst_info *ohri)
2792 {
2793         return omap_prm_deassert_hardreset(ohri->rst_shift, ohri->st_shift, 0,
2794                                            oh->prcm.omap2.module_offs, 0, 0);
2795 }
2796
2797 /**
2798  * _omap2_is_hardreset_asserted - call OMAP2 PRM hardreset fn with hwmod args
2799  * @oh: struct omap_hwmod * to test hardreset
2800  * @ohri: hardreset line data
2801  *
2802  * Call omap2_prm_is_hardreset_asserted() with parameters extracted
2803  * from the hwmod @oh and the hardreset line data @ohri.  Only
2804  * intended for use as an soc_ops function pointer.  Passes along the
2805  * return value from omap2_prm_is_hardreset_asserted().  XXX This
2806  * function is scheduled for removal when the PRM code is moved into
2807  * drivers/.
2808  */
2809 static int _omap2_is_hardreset_asserted(struct omap_hwmod *oh,
2810                                         struct omap_hwmod_rst_info *ohri)
2811 {
2812         return omap_prm_is_hardreset_asserted(ohri->st_shift, 0,
2813                                               oh->prcm.omap2.module_offs, 0);
2814 }
2815
2816 /**
2817  * _omap4_assert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
2818  * @oh: struct omap_hwmod * to assert hardreset
2819  * @ohri: hardreset line data
2820  *
2821  * Call omap4_prminst_assert_hardreset() with parameters extracted
2822  * from the hwmod @oh and the hardreset line data @ohri.  Only
2823  * intended for use as an soc_ops function pointer.  Passes along the
2824  * return value from omap4_prminst_assert_hardreset().  XXX This
2825  * function is scheduled for removal when the PRM code is moved into
2826  * drivers/.
2827  */
2828 static int _omap4_assert_hardreset(struct omap_hwmod *oh,
2829                                    struct omap_hwmod_rst_info *ohri)
2830 {
2831         if (!oh->clkdm)
2832                 return -EINVAL;
2833
2834         return omap_prm_assert_hardreset(ohri->rst_shift,
2835                                          oh->clkdm->pwrdm.ptr->prcm_partition,
2836                                          oh->clkdm->pwrdm.ptr->prcm_offs,
2837                                          oh->prcm.omap4.rstctrl_offs);
2838 }
2839
2840 /**
2841  * _omap4_deassert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
2842  * @oh: struct omap_hwmod * to deassert hardreset
2843  * @ohri: hardreset line data
2844  *
2845  * Call omap4_prminst_deassert_hardreset() with parameters extracted
2846  * from the hwmod @oh and the hardreset line data @ohri.  Only
2847  * intended for use as an soc_ops function pointer.  Passes along the
2848  * return value from omap4_prminst_deassert_hardreset().  XXX This
2849  * function is scheduled for removal when the PRM code is moved into
2850  * drivers/.
2851  */
2852 static int _omap4_deassert_hardreset(struct omap_hwmod *oh,
2853                                      struct omap_hwmod_rst_info *ohri)
2854 {
2855         if (!oh->clkdm)
2856                 return -EINVAL;
2857
2858         if (ohri->st_shift)
2859                 pr_err("omap_hwmod: %s: %s: hwmod data error: OMAP4 does not support st_shift\n",
2860                        oh->name, ohri->name);
2861         return omap_prm_deassert_hardreset(ohri->rst_shift, ohri->rst_shift,
2862                                            oh->clkdm->pwrdm.ptr->prcm_partition,
2863                                            oh->clkdm->pwrdm.ptr->prcm_offs,
2864                                            oh->prcm.omap4.rstctrl_offs,
2865                                            oh->prcm.omap4.rstctrl_offs +
2866                                            OMAP4_RST_CTRL_ST_OFFSET);
2867 }
2868
2869 /**
2870  * _omap4_is_hardreset_asserted - call OMAP4 PRM hardreset fn with hwmod args
2871  * @oh: struct omap_hwmod * to test hardreset
2872  * @ohri: hardreset line data
2873  *
2874  * Call omap4_prminst_is_hardreset_asserted() with parameters
2875  * extracted from the hwmod @oh and the hardreset line data @ohri.
2876  * Only intended for use as an soc_ops function pointer.  Passes along
2877  * the return value from omap4_prminst_is_hardreset_asserted().  XXX
2878  * This function is scheduled for removal when the PRM code is moved
2879  * into drivers/.
2880  */
2881 static int _omap4_is_hardreset_asserted(struct omap_hwmod *oh,
2882                                         struct omap_hwmod_rst_info *ohri)
2883 {
2884         if (!oh->clkdm)
2885                 return -EINVAL;
2886
2887         return omap_prm_is_hardreset_asserted(ohri->rst_shift,
2888                                               oh->clkdm->pwrdm.ptr->
2889                                               prcm_partition,
2890                                               oh->clkdm->pwrdm.ptr->prcm_offs,
2891                                               oh->prcm.omap4.rstctrl_offs);
2892 }
2893
2894 /**
2895  * _omap4_disable_direct_prcm - disable direct PRCM control for hwmod
2896  * @oh: struct omap_hwmod * to disable control for
2897  *
2898  * Disables direct PRCM clkctrl done by hwmod core. Instead, the hwmod
2899  * will be using its main_clk to enable/disable the module. Returns
2900  * 0 if successful.
2901  */
2902 static int _omap4_disable_direct_prcm(struct omap_hwmod *oh)
2903 {
2904         if (!oh)
2905                 return -EINVAL;
2906
2907         oh->prcm.omap4.flags |= HWMOD_OMAP4_CLKFWK_CLKCTR_CLOCK;
2908
2909         return 0;
2910 }
2911
2912 /**
2913  * _am33xx_deassert_hardreset - call AM33XX PRM hardreset fn with hwmod args
2914  * @oh: struct omap_hwmod * to deassert hardreset
2915  * @ohri: hardreset line data
2916  *
2917  * Call am33xx_prminst_deassert_hardreset() with parameters extracted
2918  * from the hwmod @oh and the hardreset line data @ohri.  Only
2919  * intended for use as an soc_ops function pointer.  Passes along the
2920  * return value from am33xx_prminst_deassert_hardreset().  XXX This
2921  * function is scheduled for removal when the PRM code is moved into
2922  * drivers/.
2923  */
2924 static int _am33xx_deassert_hardreset(struct omap_hwmod *oh,
2925                                      struct omap_hwmod_rst_info *ohri)
2926 {
2927         return omap_prm_deassert_hardreset(ohri->rst_shift, ohri->st_shift,
2928                                            oh->clkdm->pwrdm.ptr->prcm_partition,
2929                                            oh->clkdm->pwrdm.ptr->prcm_offs,
2930                                            oh->prcm.omap4.rstctrl_offs,
2931                                            oh->prcm.omap4.rstst_offs);
2932 }
2933
2934 /* Public functions */
2935
2936 u32 omap_hwmod_read(struct omap_hwmod *oh, u16 reg_offs)
2937 {
2938         if (oh->flags & HWMOD_16BIT_REG)
2939                 return readw_relaxed(oh->_mpu_rt_va + reg_offs);
2940         else
2941                 return readl_relaxed(oh->_mpu_rt_va + reg_offs);
2942 }
2943
2944 void omap_hwmod_write(u32 v, struct omap_hwmod *oh, u16 reg_offs)
2945 {
2946         if (oh->flags & HWMOD_16BIT_REG)
2947                 writew_relaxed(v, oh->_mpu_rt_va + reg_offs);
2948         else
2949                 writel_relaxed(v, oh->_mpu_rt_va + reg_offs);
2950 }
2951
2952 /**
2953  * omap_hwmod_softreset - reset a module via SYSCONFIG.SOFTRESET bit
2954  * @oh: struct omap_hwmod *
2955  *
2956  * This is a public function exposed to drivers. Some drivers may need to do
2957  * some settings before and after resetting the device.  Those drivers after
2958  * doing the necessary settings could use this function to start a reset by
2959  * setting the SYSCONFIG.SOFTRESET bit.
2960  */
2961 int omap_hwmod_softreset(struct omap_hwmod *oh)
2962 {
2963         u32 v;
2964         int ret;
2965
2966         if (!oh || !(oh->_sysc_cache))
2967                 return -EINVAL;
2968
2969         v = oh->_sysc_cache;
2970         ret = _set_softreset(oh, &v);
2971         if (ret)
2972                 goto error;
2973         _write_sysconfig(v, oh);
2974
2975         ret = _clear_softreset(oh, &v);
2976         if (ret)
2977                 goto error;
2978         _write_sysconfig(v, oh);
2979
2980 error:
2981         return ret;
2982 }
2983
2984 /**
2985  * omap_hwmod_lookup - look up a registered omap_hwmod by name
2986  * @name: name of the omap_hwmod to look up
2987  *
2988  * Given a @name of an omap_hwmod, return a pointer to the registered
2989  * struct omap_hwmod *, or NULL upon error.
2990  */
2991 struct omap_hwmod *omap_hwmod_lookup(const char *name)
2992 {
2993         struct omap_hwmod *oh;
2994
2995         if (!name)
2996                 return NULL;
2997
2998         oh = _lookup(name);
2999
3000         return oh;
3001 }
3002
3003 /**
3004  * omap_hwmod_for_each - call function for each registered omap_hwmod
3005  * @fn: pointer to a callback function
3006  * @data: void * data to pass to callback function
3007  *
3008  * Call @fn for each registered omap_hwmod, passing @data to each
3009  * function.  @fn must return 0 for success or any other value for
3010  * failure.  If @fn returns non-zero, the iteration across omap_hwmods
3011  * will stop and the non-zero return value will be passed to the
3012  * caller of omap_hwmod_for_each().  @fn is called with
3013  * omap_hwmod_for_each() held.
3014  */
3015 int omap_hwmod_for_each(int (*fn)(struct omap_hwmod *oh, void *data),
3016                         void *data)
3017 {
3018         struct omap_hwmod *temp_oh;
3019         int ret = 0;
3020
3021         if (!fn)
3022                 return -EINVAL;
3023
3024         list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
3025                 ret = (*fn)(temp_oh, data);
3026                 if (ret)
3027                         break;
3028         }
3029
3030         return ret;
3031 }
3032
3033 /**
3034  * omap_hwmod_register_links - register an array of hwmod links
3035  * @ois: pointer to an array of omap_hwmod_ocp_if to register
3036  *
3037  * Intended to be called early in boot before the clock framework is
3038  * initialized.  If @ois is not null, will register all omap_hwmods
3039  * listed in @ois that are valid for this chip.  Returns -EINVAL if
3040  * omap_hwmod_init() hasn't been called before calling this function,
3041  * -ENOMEM if the link memory area can't be allocated, or 0 upon
3042  * success.
3043  */
3044 int __init omap_hwmod_register_links(struct omap_hwmod_ocp_if **ois)
3045 {
3046         int r, i;
3047
3048         if (!inited)
3049                 return -EINVAL;
3050
3051         if (!ois)
3052                 return 0;
3053
3054         if (ois[0] == NULL) /* Empty list */
3055                 return 0;
3056
3057         i = 0;
3058         do {
3059                 r = _register_link(ois[i]);
3060                 WARN(r && r != -EEXIST,
3061                      "omap_hwmod: _register_link(%s -> %s) returned %d\n",
3062                      ois[i]->master->name, ois[i]->slave->name, r);
3063         } while (ois[++i]);
3064
3065         return 0;
3066 }
3067
3068 /**
3069  * _ensure_mpu_hwmod_is_setup - ensure the MPU SS hwmod is init'ed and set up
3070  * @oh: pointer to the hwmod currently being set up (usually not the MPU)
3071  *
3072  * If the hwmod data corresponding to the MPU subsystem IP block
3073  * hasn't been initialized and set up yet, do so now.  This must be
3074  * done first since sleep dependencies may be added from other hwmods
3075  * to the MPU.  Intended to be called only by omap_hwmod_setup*().  No
3076  * return value.
3077  */
3078 static void __init _ensure_mpu_hwmod_is_setup(struct omap_hwmod *oh)
3079 {
3080         if (!mpu_oh || mpu_oh->_state == _HWMOD_STATE_UNKNOWN)
3081                 pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",
3082                        __func__, MPU_INITIATOR_NAME);
3083         else if (mpu_oh->_state == _HWMOD_STATE_REGISTERED && oh != mpu_oh)
3084                 omap_hwmod_setup_one(MPU_INITIATOR_NAME);
3085 }
3086
3087 /**
3088  * omap_hwmod_setup_one - set up a single hwmod
3089  * @oh_name: const char * name of the already-registered hwmod to set up
3090  *
3091  * Initialize and set up a single hwmod.  Intended to be used for a
3092  * small number of early devices, such as the timer IP blocks used for
3093  * the scheduler clock.  Must be called after omap2_clk_init().
3094  * Resolves the struct clk names to struct clk pointers for each
3095  * registered omap_hwmod.  Also calls _setup() on each hwmod.  Returns
3096  * -EINVAL upon error or 0 upon success.
3097  */
3098 int __init omap_hwmod_setup_one(const char *oh_name)
3099 {
3100         struct omap_hwmod *oh;
3101
3102         pr_debug("omap_hwmod: %s: %s\n", oh_name, __func__);
3103
3104         oh = _lookup(oh_name);
3105         if (!oh) {
3106                 WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name);
3107                 return -EINVAL;
3108         }
3109
3110         _ensure_mpu_hwmod_is_setup(oh);
3111
3112         _init(oh, NULL);
3113         _setup(oh, NULL);
3114
3115         return 0;
3116 }
3117
3118 static void omap_hwmod_check_one(struct device *dev,
3119                                  const char *name, s8 v1, u8 v2)
3120 {
3121         if (v1 < 0)
3122                 return;
3123
3124         if (v1 != v2)
3125                 dev_warn(dev, "%s %d != %d\n", name, v1, v2);
3126 }
3127
3128 /**
3129  * omap_hwmod_check_sysc - check sysc against platform sysc
3130  * @dev: struct device
3131  * @data: module data
3132  * @sysc_fields: new sysc configuration
3133  */
3134 static int omap_hwmod_check_sysc(struct device *dev,
3135                                  const struct ti_sysc_module_data *data,
3136                                  struct sysc_regbits *sysc_fields)
3137 {
3138         const struct sysc_regbits *regbits = data->cap->regbits;
3139
3140         omap_hwmod_check_one(dev, "dmadisable_shift",
3141                              regbits->dmadisable_shift,
3142                              sysc_fields->dmadisable_shift);
3143         omap_hwmod_check_one(dev, "midle_shift",
3144                              regbits->midle_shift,
3145                              sysc_fields->midle_shift);
3146         omap_hwmod_check_one(dev, "sidle_shift",
3147                              regbits->sidle_shift,
3148                              sysc_fields->sidle_shift);
3149         omap_hwmod_check_one(dev, "clkact_shift",
3150                              regbits->clkact_shift,
3151                              sysc_fields->clkact_shift);
3152         omap_hwmod_check_one(dev, "enwkup_shift",
3153                              regbits->enwkup_shift,
3154                              sysc_fields->enwkup_shift);
3155         omap_hwmod_check_one(dev, "srst_shift",
3156                              regbits->srst_shift,
3157                              sysc_fields->srst_shift);
3158         omap_hwmod_check_one(dev, "autoidle_shift",
3159                              regbits->autoidle_shift,
3160                              sysc_fields->autoidle_shift);
3161
3162         return 0;
3163 }
3164
3165 /**
3166  * omap_hwmod_init_regbits - init sysconfig specific register bits
3167  * @dev: struct device
3168  * @data: module data
3169  * @sysc_fields: new sysc configuration
3170  */
3171 static int omap_hwmod_init_regbits(struct device *dev,
3172                                    const struct ti_sysc_module_data *data,
3173                                    struct sysc_regbits **sysc_fields)
3174 {
3175         *sysc_fields = NULL;
3176
3177         switch (data->cap->type) {
3178         case TI_SYSC_OMAP2:
3179         case TI_SYSC_OMAP2_TIMER:
3180                 *sysc_fields = &omap_hwmod_sysc_type1;
3181                 break;
3182         case TI_SYSC_OMAP3_SHAM:
3183                 *sysc_fields = &omap3_sham_sysc_fields;
3184                 break;
3185         case TI_SYSC_OMAP3_AES:
3186                 *sysc_fields = &omap3xxx_aes_sysc_fields;
3187                 break;
3188         case TI_SYSC_OMAP4:
3189         case TI_SYSC_OMAP4_TIMER:
3190                 *sysc_fields = &omap_hwmod_sysc_type2;
3191                 break;
3192         case TI_SYSC_OMAP4_SIMPLE:
3193                 *sysc_fields = &omap_hwmod_sysc_type3;
3194                 break;
3195         case TI_SYSC_OMAP34XX_SR:
3196                 *sysc_fields = &omap34xx_sr_sysc_fields;
3197                 break;
3198         case TI_SYSC_OMAP36XX_SR:
3199                 *sysc_fields = &omap36xx_sr_sysc_fields;
3200                 break;
3201         case TI_SYSC_OMAP4_SR:
3202                 *sysc_fields = &omap36xx_sr_sysc_fields;
3203                 break;
3204         case TI_SYSC_OMAP4_MCASP:
3205                 *sysc_fields = &omap_hwmod_sysc_type_mcasp;
3206                 break;
3207         case TI_SYSC_OMAP4_USB_HOST_FS:
3208                 *sysc_fields = &omap_hwmod_sysc_type_usb_host_fs;
3209                 break;
3210         default:
3211                 return -EINVAL;
3212         }
3213
3214         return omap_hwmod_check_sysc(dev, data, *sysc_fields);
3215 }
3216
3217 /**
3218  * omap_hwmod_init_reg_offs - initialize sysconfig register offsets
3219  * @dev: struct device
3220  * @data: module data
3221  * @rev_offs: revision register offset
3222  * @sysc_offs: sysc register offset
3223  * @syss_offs: syss register offset
3224  */
3225 int omap_hwmod_init_reg_offs(struct device *dev,
3226                              const struct ti_sysc_module_data *data,
3227                              s32 *rev_offs, s32 *sysc_offs, s32 *syss_offs)
3228 {
3229         *rev_offs = -ENODEV;
3230         *sysc_offs = 0;
3231         *syss_offs = 0;
3232
3233         if (data->offsets[SYSC_REVISION] >= 0)
3234                 *rev_offs = data->offsets[SYSC_REVISION];
3235
3236         if (data->offsets[SYSC_SYSCONFIG] >= 0)
3237                 *sysc_offs = data->offsets[SYSC_SYSCONFIG];
3238
3239         if (data->offsets[SYSC_SYSSTATUS] >= 0)
3240                 *syss_offs = data->offsets[SYSC_SYSSTATUS];
3241
3242         return 0;
3243 }
3244
3245 /**
3246  * omap_hwmod_init_sysc_flags - initialize sysconfig features
3247  * @dev: struct device
3248  * @data: module data
3249  * @sysc_flags: module configuration
3250  */
3251 int omap_hwmod_init_sysc_flags(struct device *dev,
3252                                const struct ti_sysc_module_data *data,
3253                                u32 *sysc_flags)
3254 {
3255         *sysc_flags = 0;
3256
3257         switch (data->cap->type) {
3258         case TI_SYSC_OMAP2:
3259         case TI_SYSC_OMAP2_TIMER:
3260                 /* See SYSC_OMAP2_* in include/dt-bindings/bus/ti-sysc.h */
3261                 if (data->cfg->sysc_val & SYSC_OMAP2_CLOCKACTIVITY)
3262                         *sysc_flags |= SYSC_HAS_CLOCKACTIVITY;
3263                 if (data->cfg->sysc_val & SYSC_OMAP2_EMUFREE)
3264                         *sysc_flags |= SYSC_HAS_EMUFREE;
3265                 if (data->cfg->sysc_val & SYSC_OMAP2_ENAWAKEUP)
3266                         *sysc_flags |= SYSC_HAS_ENAWAKEUP;
3267                 if (data->cfg->sysc_val & SYSC_OMAP2_SOFTRESET)
3268                         *sysc_flags |= SYSC_HAS_SOFTRESET;
3269                 if (data->cfg->sysc_val & SYSC_OMAP2_AUTOIDLE)
3270                         *sysc_flags |= SYSC_HAS_AUTOIDLE;
3271                 break;
3272         case TI_SYSC_OMAP4:
3273         case TI_SYSC_OMAP4_TIMER:
3274                 /* See SYSC_OMAP4_* in include/dt-bindings/bus/ti-sysc.h */
3275                 if (data->cfg->sysc_val & SYSC_OMAP4_DMADISABLE)
3276                         *sysc_flags |= SYSC_HAS_DMADISABLE;
3277                 if (data->cfg->sysc_val & SYSC_OMAP4_FREEEMU)
3278                         *sysc_flags |= SYSC_HAS_EMUFREE;
3279                 if (data->cfg->sysc_val & SYSC_OMAP4_SOFTRESET)
3280                         *sysc_flags |= SYSC_HAS_SOFTRESET;
3281                 break;
3282         case TI_SYSC_OMAP34XX_SR:
3283         case TI_SYSC_OMAP36XX_SR:
3284                 /* See SYSC_OMAP3_SR_* in include/dt-bindings/bus/ti-sysc.h */
3285                 if (data->cfg->sysc_val & SYSC_OMAP3_SR_ENAWAKEUP)
3286                         *sysc_flags |= SYSC_HAS_ENAWAKEUP;
3287                 break;
3288         default:
3289                 if (data->cap->regbits->emufree_shift >= 0)
3290                         *sysc_flags |= SYSC_HAS_EMUFREE;
3291                 if (data->cap->regbits->enwkup_shift >= 0)
3292                         *sysc_flags |= SYSC_HAS_ENAWAKEUP;
3293                 if (data->cap->regbits->srst_shift >= 0)
3294                         *sysc_flags |= SYSC_HAS_SOFTRESET;
3295                 if (data->cap->regbits->autoidle_shift >= 0)
3296                         *sysc_flags |= SYSC_HAS_AUTOIDLE;
3297                 break;
3298         }
3299
3300         if (data->cap->regbits->midle_shift >= 0 &&
3301             data->cfg->midlemodes)
3302                 *sysc_flags |= SYSC_HAS_MIDLEMODE;
3303
3304         if (data->cap->regbits->sidle_shift >= 0 &&
3305             data->cfg->sidlemodes)
3306                 *sysc_flags |= SYSC_HAS_SIDLEMODE;
3307
3308         if (data->cfg->quirks & SYSC_QUIRK_UNCACHED)
3309                 *sysc_flags |= SYSC_NO_CACHE;
3310         if (data->cfg->quirks & SYSC_QUIRK_RESET_STATUS)
3311                 *sysc_flags |= SYSC_HAS_RESET_STATUS;
3312
3313         if (data->cfg->syss_mask & 1)
3314                 *sysc_flags |= SYSS_HAS_RESET_STATUS;
3315
3316         return 0;
3317 }
3318
3319 /**
3320  * omap_hwmod_init_idlemodes - initialize module idle modes
3321  * @dev: struct device
3322  * @data: module data
3323  * @idlemodes: module supported idle modes
3324  */
3325 int omap_hwmod_init_idlemodes(struct device *dev,
3326                               const struct ti_sysc_module_data *data,
3327                               u32 *idlemodes)
3328 {
3329         *idlemodes = 0;
3330
3331         if (data->cfg->midlemodes & BIT(SYSC_IDLE_FORCE))
3332                 *idlemodes |= MSTANDBY_FORCE;
3333         if (data->cfg->midlemodes & BIT(SYSC_IDLE_NO))
3334                 *idlemodes |= MSTANDBY_NO;
3335         if (data->cfg->midlemodes & BIT(SYSC_IDLE_SMART))
3336                 *idlemodes |= MSTANDBY_SMART;
3337         if (data->cfg->midlemodes & BIT(SYSC_IDLE_SMART_WKUP))
3338                 *idlemodes |= MSTANDBY_SMART_WKUP;
3339
3340         if (data->cfg->sidlemodes & BIT(SYSC_IDLE_FORCE))
3341                 *idlemodes |= SIDLE_FORCE;
3342         if (data->cfg->sidlemodes & BIT(SYSC_IDLE_NO))
3343                 *idlemodes |= SIDLE_NO;
3344         if (data->cfg->sidlemodes & BIT(SYSC_IDLE_SMART))
3345                 *idlemodes |= SIDLE_SMART;
3346         if (data->cfg->sidlemodes & BIT(SYSC_IDLE_SMART_WKUP))
3347                 *idlemodes |= SIDLE_SMART_WKUP;
3348
3349         return 0;
3350 }
3351
3352 /**
3353  * omap_hwmod_check_module - check new module against platform data
3354  * @dev: struct device
3355  * @oh: module
3356  * @data: new module data
3357  * @sysc_fields: sysc register bits
3358  * @rev_offs: revision register offset
3359  * @sysc_offs: sysconfig register offset
3360  * @syss_offs: sysstatus register offset
3361  * @sysc_flags: sysc specific flags
3362  * @idlemodes: sysc supported idlemodes
3363  */
3364 static int omap_hwmod_check_module(struct device *dev,
3365                                    struct omap_hwmod *oh,
3366                                    const struct ti_sysc_module_data *data,
3367                                    struct sysc_regbits *sysc_fields,
3368                                    s32 rev_offs, s32 sysc_offs,
3369                                    s32 syss_offs, u32 sysc_flags,
3370                                    u32 idlemodes)
3371 {
3372         if (!oh->class->sysc)
3373                 return -ENODEV;
3374
3375         if (sysc_fields != oh->class->sysc->sysc_fields)
3376                 dev_warn(dev, "sysc_fields %p != %p\n", sysc_fields,
3377                          oh->class->sysc->sysc_fields);
3378
3379         if (rev_offs != oh->class->sysc->rev_offs)
3380                 dev_warn(dev, "rev_offs %08x != %08x\n", rev_offs,
3381                          oh->class->sysc->rev_offs);
3382         if (sysc_offs != oh->class->sysc->sysc_offs)
3383                 dev_warn(dev, "sysc_offs %08x != %08x\n", sysc_offs,
3384                          oh->class->sysc->sysc_offs);
3385         if (syss_offs != oh->class->sysc->syss_offs)
3386                 dev_warn(dev, "syss_offs %08x != %08x\n", syss_offs,
3387                          oh->class->sysc->syss_offs);
3388
3389         if (sysc_flags != oh->class->sysc->sysc_flags)
3390                 dev_warn(dev, "sysc_flags %08x != %08x\n", sysc_flags,
3391                          oh->class->sysc->sysc_flags);
3392
3393         if (idlemodes != oh->class->sysc->idlemodes)
3394                 dev_warn(dev, "idlemodes %08x != %08x\n", idlemodes,
3395                          oh->class->sysc->idlemodes);
3396
3397         if (data->cfg->srst_udelay != oh->class->sysc->srst_udelay)
3398                 dev_warn(dev, "srst_udelay %i != %i\n",
3399                          data->cfg->srst_udelay,
3400                          oh->class->sysc->srst_udelay);
3401
3402         return 0;