2 * omap_hwmod implementation for OMAP2/3/4
4 * Copyright (C) 2009-2011 Nokia Corporation
5 * Copyright (C) 2011-2012 Texas Instruments, Inc.
7 * Paul Walmsley, BenoƮt Cousson, Kevin Hilman
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
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.
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.
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.
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.
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.
54 * From a layering perspective, here is where the OMAP hwmod code
55 * fits into the kernel software stack:
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 * +-------------------------------+
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
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
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.
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
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
120 * - handle IO mapping
121 * - bus throughput & module latency measurement code
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
130 #include <linux/kernel.h>
131 #include <linux/errno.h>
132 #include <linux/io.h>
133 #include <linux/clk.h>
134 #include <linux/clk-provider.h>
135 #include <linux/delay.h>
136 #include <linux/err.h>
137 #include <linux/list.h>
138 #include <linux/mutex.h>
139 #include <linux/spinlock.h>
140 #include <linux/slab.h>
141 #include <linux/cpu.h>
142 #include <linux/of.h>
143 #include <linux/of_address.h>
144 #include <linux/bootmem.h>
146 #include <asm/system_misc.h>
149 #include "omap_hwmod.h"
153 #include "clockdomain.h"
154 #include "powerdomain.h"
162 #include "prminst44xx.h"
165 /* Name of the OMAP hwmod for the MPU */
166 #define MPU_INITIATOR_NAME "mpu"
169 * Number of struct omap_hwmod_link records per struct
170 * omap_hwmod_ocp_if record (master->slave and slave->master)
172 #define LINKS_PER_OCP_IF 2
175 * Address offset (in bytes) between the reset control and the reset
176 * status registers: 4 bytes on OMAP4
178 #define OMAP4_RST_CTRL_ST_OFFSET 4
181 * Maximum length for module clock handle names
183 #define MOD_CLK_MAX_NAME_LEN 32
186 * struct clkctrl_provider - clkctrl provider mapping data
187 * @addr: base address for the provider
188 * @offset: base offset for the provider
189 * @clkdm: base clockdomain for provider
190 * @node: device node associated with the provider
193 struct clkctrl_provider {
196 struct clockdomain *clkdm;
197 struct device_node *node;
198 struct list_head link;
201 static LIST_HEAD(clkctrl_providers);
204 * struct omap_hwmod_soc_ops - fn ptrs for some SoC-specific operations
205 * @enable_module: function to enable a module (via MODULEMODE)
206 * @disable_module: function to disable a module (via MODULEMODE)
208 * XXX Eventually this functionality will be hidden inside the PRM/CM
209 * device drivers. Until then, this should avoid huge blocks of cpu_is_*()
210 * conditionals in this code.
212 struct omap_hwmod_soc_ops {
213 void (*enable_module)(struct omap_hwmod *oh);
214 int (*disable_module)(struct omap_hwmod *oh);
215 int (*wait_target_ready)(struct omap_hwmod *oh);
216 int (*assert_hardreset)(struct omap_hwmod *oh,
217 struct omap_hwmod_rst_info *ohri);
218 int (*deassert_hardreset)(struct omap_hwmod *oh,
219 struct omap_hwmod_rst_info *ohri);
220 int (*is_hardreset_asserted)(struct omap_hwmod *oh,
221 struct omap_hwmod_rst_info *ohri);
222 int (*init_clkdm)(struct omap_hwmod *oh);
223 void (*update_context_lost)(struct omap_hwmod *oh);
224 int (*get_context_lost)(struct omap_hwmod *oh);
225 int (*disable_direct_prcm)(struct omap_hwmod *oh);
226 u32 (*xlate_clkctrl)(struct omap_hwmod *oh,
227 struct clkctrl_provider *provider);
230 /* soc_ops: adapts the omap_hwmod code to the currently-booted SoC */
231 static struct omap_hwmod_soc_ops soc_ops;
233 /* omap_hwmod_list contains all registered struct omap_hwmods */
234 static LIST_HEAD(omap_hwmod_list);
236 /* mpu_oh: used to add/remove MPU initiator from sleepdep list */
237 static struct omap_hwmod *mpu_oh;
239 /* inited: set to true once the hwmod code is initialized */
242 /* Private functions */
245 * _update_sysc_cache - return the module OCP_SYSCONFIG register, keep copy
246 * @oh: struct omap_hwmod *
248 * Load the current value of the hwmod OCP_SYSCONFIG register into the
249 * struct omap_hwmod for later use. Returns -EINVAL if the hwmod has no
250 * OCP_SYSCONFIG register or 0 upon success.
252 static int _update_sysc_cache(struct omap_hwmod *oh)
254 if (!oh->class->sysc) {
255 WARN(1, "omap_hwmod: %s: cannot read OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
259 /* XXX ensure module interface clock is up */
261 oh->_sysc_cache = omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
263 if (!(oh->class->sysc->sysc_flags & SYSC_NO_CACHE))
264 oh->_int_flags |= _HWMOD_SYSCONFIG_LOADED;
270 * _write_sysconfig - write a value to the module's OCP_SYSCONFIG register
271 * @v: OCP_SYSCONFIG value to write
272 * @oh: struct omap_hwmod *
274 * Write @v into the module class' OCP_SYSCONFIG register, if it has
275 * one. No return value.
277 static void _write_sysconfig(u32 v, struct omap_hwmod *oh)
279 if (!oh->class->sysc) {
280 WARN(1, "omap_hwmod: %s: cannot write OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
284 /* XXX ensure module interface clock is up */
286 /* Module might have lost context, always update cache and register */
290 * Some IP blocks (such as RTC) require unlocking of IP before
291 * accessing its registers. If a function pointer is present
292 * to unlock, then call it before accessing sysconfig and
293 * call lock after writing sysconfig.
295 if (oh->class->unlock)
296 oh->class->unlock(oh);
298 omap_hwmod_write(v, oh, oh->class->sysc->sysc_offs);
305 * _set_master_standbymode: set the OCP_SYSCONFIG MIDLEMODE field in @v
306 * @oh: struct omap_hwmod *
307 * @standbymode: MIDLEMODE field bits
308 * @v: pointer to register contents to modify
310 * Update the master standby mode bits in @v to be @standbymode for
311 * the @oh hwmod. Does not write to the hardware. Returns -EINVAL
312 * upon error or 0 upon success.
314 static int _set_master_standbymode(struct omap_hwmod *oh, u8 standbymode,
320 if (!oh->class->sysc ||
321 !(oh->class->sysc->sysc_flags & SYSC_HAS_MIDLEMODE))
324 if (!oh->class->sysc->sysc_fields) {
325 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
329 mstandby_shift = oh->class->sysc->sysc_fields->midle_shift;
330 mstandby_mask = (0x3 << mstandby_shift);
332 *v &= ~mstandby_mask;
333 *v |= __ffs(standbymode) << mstandby_shift;
339 * _set_slave_idlemode: set the OCP_SYSCONFIG SIDLEMODE field in @v
340 * @oh: struct omap_hwmod *
341 * @idlemode: SIDLEMODE field bits
342 * @v: pointer to register contents to modify
344 * Update the slave idle mode bits in @v to be @idlemode for the @oh
345 * hwmod. Does not write to the hardware. Returns -EINVAL upon error
348 static int _set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode, u32 *v)
353 if (!oh->class->sysc ||
354 !(oh->class->sysc->sysc_flags & SYSC_HAS_SIDLEMODE))
357 if (!oh->class->sysc->sysc_fields) {
358 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
362 sidle_shift = oh->class->sysc->sysc_fields->sidle_shift;
363 sidle_mask = (0x3 << sidle_shift);
366 *v |= __ffs(idlemode) << sidle_shift;
372 * _set_clockactivity: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
373 * @oh: struct omap_hwmod *
374 * @clockact: CLOCKACTIVITY field bits
375 * @v: pointer to register contents to modify
377 * Update the clockactivity mode bits in @v to be @clockact for the
378 * @oh hwmod. Used for additional powersaving on some modules. Does
379 * not write to the hardware. Returns -EINVAL upon error or 0 upon
382 static int _set_clockactivity(struct omap_hwmod *oh, u8 clockact, u32 *v)
387 if (!oh->class->sysc ||
388 !(oh->class->sysc->sysc_flags & SYSC_HAS_CLOCKACTIVITY))
391 if (!oh->class->sysc->sysc_fields) {
392 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
396 clkact_shift = oh->class->sysc->sysc_fields->clkact_shift;
397 clkact_mask = (0x3 << clkact_shift);
400 *v |= clockact << clkact_shift;
406 * _set_softreset: set OCP_SYSCONFIG.SOFTRESET bit in @v
407 * @oh: struct omap_hwmod *
408 * @v: pointer to register contents to modify
410 * Set the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
411 * error or 0 upon success.
413 static int _set_softreset(struct omap_hwmod *oh, u32 *v)
417 if (!oh->class->sysc ||
418 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
421 if (!oh->class->sysc->sysc_fields) {
422 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
426 softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
434 * _clear_softreset: clear OCP_SYSCONFIG.SOFTRESET bit in @v
435 * @oh: struct omap_hwmod *
436 * @v: pointer to register contents to modify
438 * Clear the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
439 * error or 0 upon success.
441 static int _clear_softreset(struct omap_hwmod *oh, u32 *v)
445 if (!oh->class->sysc ||
446 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
449 if (!oh->class->sysc->sysc_fields) {
451 "omap_hwmod: %s: sysc_fields absent for sysconfig class\n",
456 softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
464 * _wait_softreset_complete - wait for an OCP softreset to complete
465 * @oh: struct omap_hwmod * to wait on
467 * Wait until the IP block represented by @oh reports that its OCP
468 * softreset is complete. This can be triggered by software (see
469 * _ocp_softreset()) or by hardware upon returning from off-mode (one
470 * example is HSMMC). Waits for up to MAX_MODULE_SOFTRESET_WAIT
471 * microseconds. Returns the number of microseconds waited.
473 static int _wait_softreset_complete(struct omap_hwmod *oh)
475 struct omap_hwmod_class_sysconfig *sysc;
479 sysc = oh->class->sysc;
481 if (sysc->sysc_flags & SYSS_HAS_RESET_STATUS)
482 omap_test_timeout((omap_hwmod_read(oh, sysc->syss_offs)
483 & SYSS_RESETDONE_MASK),
484 MAX_MODULE_SOFTRESET_WAIT, c);
485 else if (sysc->sysc_flags & SYSC_HAS_RESET_STATUS) {
486 softrst_mask = (0x1 << sysc->sysc_fields->srst_shift);
487 omap_test_timeout(!(omap_hwmod_read(oh, sysc->sysc_offs)
489 MAX_MODULE_SOFTRESET_WAIT, c);
496 * _set_dmadisable: set OCP_SYSCONFIG.DMADISABLE bit in @v
497 * @oh: struct omap_hwmod *
499 * The DMADISABLE bit is a semi-automatic bit present in sysconfig register
500 * of some modules. When the DMA must perform read/write accesses, the
501 * DMADISABLE bit is cleared by the hardware. But when the DMA must stop
502 * for power management, software must set the DMADISABLE bit back to 1.
504 * Set the DMADISABLE bit in @v for hwmod @oh. Returns -EINVAL upon
505 * error or 0 upon success.
507 static int _set_dmadisable(struct omap_hwmod *oh)
512 if (!oh->class->sysc ||
513 !(oh->class->sysc->sysc_flags & SYSC_HAS_DMADISABLE))
516 if (!oh->class->sysc->sysc_fields) {
517 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
521 /* clocks must be on for this operation */
522 if (oh->_state != _HWMOD_STATE_ENABLED) {
523 pr_warn("omap_hwmod: %s: dma can be disabled only from enabled state\n", oh->name);
527 pr_debug("omap_hwmod: %s: setting DMADISABLE\n", oh->name);
531 (0x1 << oh->class->sysc->sysc_fields->dmadisable_shift);
532 v |= dmadisable_mask;
533 _write_sysconfig(v, oh);
539 * _set_module_autoidle: set the OCP_SYSCONFIG AUTOIDLE field in @v
540 * @oh: struct omap_hwmod *
541 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
542 * @v: pointer to register contents to modify
544 * Update the module autoidle bit in @v to be @autoidle for the @oh
545 * hwmod. The autoidle bit controls whether the module can gate
546 * internal clocks automatically when it isn't doing anything; the
547 * exact function of this bit varies on a per-module basis. This
548 * function does not write to the hardware. Returns -EINVAL upon
549 * error or 0 upon success.
551 static int _set_module_autoidle(struct omap_hwmod *oh, u8 autoidle,
557 if (!oh->class->sysc ||
558 !(oh->class->sysc->sysc_flags & SYSC_HAS_AUTOIDLE))
561 if (!oh->class->sysc->sysc_fields) {
562 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
566 autoidle_shift = oh->class->sysc->sysc_fields->autoidle_shift;
567 autoidle_mask = (0x1 << autoidle_shift);
569 *v &= ~autoidle_mask;
570 *v |= autoidle << autoidle_shift;
576 * _enable_wakeup: set OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
577 * @oh: struct omap_hwmod *
579 * Allow the hardware module @oh to send wakeups. Returns -EINVAL
580 * upon error or 0 upon success.
582 static int _enable_wakeup(struct omap_hwmod *oh, u32 *v)
584 if (!oh->class->sysc ||
585 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
586 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
587 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
590 if (!oh->class->sysc->sysc_fields) {
591 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
595 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
596 *v |= 0x1 << oh->class->sysc->sysc_fields->enwkup_shift;
598 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
599 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
600 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
601 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
603 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
609 * _disable_wakeup: clear OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
610 * @oh: struct omap_hwmod *
612 * Prevent the hardware module @oh to send wakeups. Returns -EINVAL
613 * upon error or 0 upon success.
615 static int _disable_wakeup(struct omap_hwmod *oh, u32 *v)
617 if (!oh->class->sysc ||
618 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
619 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
620 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
623 if (!oh->class->sysc->sysc_fields) {
624 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
628 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
629 *v &= ~(0x1 << oh->class->sysc->sysc_fields->enwkup_shift);
631 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
632 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART, v);
633 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
634 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART, v);
636 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
641 static struct clockdomain *_get_clkdm(struct omap_hwmod *oh)
643 struct clk_hw_omap *clk;
647 } else if (oh->_clk) {
648 if (__clk_get_flags(oh->_clk) & CLK_IS_BASIC)
650 clk = to_clk_hw_omap(__clk_get_hw(oh->_clk));
657 * _add_initiator_dep: prevent @oh from smart-idling while @init_oh is active
658 * @oh: struct omap_hwmod *
660 * Prevent the hardware module @oh from entering idle while the
661 * hardare module initiator @init_oh is active. Useful when a module
662 * will be accessed by a particular initiator (e.g., if a module will
663 * be accessed by the IVA, there should be a sleepdep between the IVA
664 * initiator and the module). Only applies to modules in smart-idle
665 * mode. If the clockdomain is marked as not needing autodeps, return
666 * 0 without doing anything. Otherwise, returns -EINVAL upon error or
667 * passes along clkdm_add_sleepdep() value upon success.
669 static int _add_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
671 struct clockdomain *clkdm, *init_clkdm;
673 clkdm = _get_clkdm(oh);
674 init_clkdm = _get_clkdm(init_oh);
676 if (!clkdm || !init_clkdm)
679 if (clkdm && clkdm->flags & CLKDM_NO_AUTODEPS)
682 return clkdm_add_sleepdep(clkdm, init_clkdm);
686 * _del_initiator_dep: allow @oh to smart-idle even if @init_oh is active
687 * @oh: struct omap_hwmod *
689 * Allow the hardware module @oh to enter idle while the hardare
690 * module initiator @init_oh is active. Useful when a module will not
691 * be accessed by a particular initiator (e.g., if a module will not
692 * be accessed by the IVA, there should be no sleepdep between the IVA
693 * initiator and the module). Only applies to modules in smart-idle
694 * mode. If the clockdomain is marked as not needing autodeps, return
695 * 0 without doing anything. Returns -EINVAL upon error or passes
696 * along clkdm_del_sleepdep() value upon success.
698 static int _del_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
700 struct clockdomain *clkdm, *init_clkdm;
702 clkdm = _get_clkdm(oh);
703 init_clkdm = _get_clkdm(init_oh);
705 if (!clkdm || !init_clkdm)
708 if (clkdm && clkdm->flags & CLKDM_NO_AUTODEPS)
711 return clkdm_del_sleepdep(clkdm, init_clkdm);
714 static const struct of_device_id ti_clkctrl_match_table[] __initconst = {
715 { .compatible = "ti,clkctrl" },
719 static int _match_clkdm(struct clockdomain *clkdm, void *user)
721 struct clkctrl_provider *provider = user;
723 if (clkdm_xlate_address(clkdm) == provider->addr) {
724 pr_debug("%s: Matched clkdm %s for addr %x (%s)\n", __func__,
725 clkdm->name, provider->addr,
726 provider->node->parent->name);
727 provider->clkdm = clkdm;
735 static int _setup_clkctrl_provider(struct device_node *np)
738 struct clkctrl_provider *provider;
740 provider = memblock_virt_alloc(sizeof(*provider), 0);
744 addrp = of_get_address(np, 0, NULL, NULL);
745 provider->addr = (u32)of_translate_address(np, addrp);
746 provider->offset = provider->addr & 0xff;
747 provider->addr &= ~0xff;
750 clkdm_for_each(_match_clkdm, provider);
752 if (!provider->clkdm) {
753 pr_err("%s: nothing matched for node %s (%x)\n",
754 __func__, np->parent->name, provider->addr);
755 memblock_free_early(__pa(provider), sizeof(*provider));
759 list_add(&provider->link, &clkctrl_providers);
764 static int _init_clkctrl_providers(void)
766 struct device_node *np;
769 for_each_matching_node(np, ti_clkctrl_match_table) {
770 ret = _setup_clkctrl_provider(np);
780 static u32 _omap4_xlate_clkctrl(struct omap_hwmod *oh,
781 struct clkctrl_provider *provider)
783 return oh->prcm.omap4.clkctrl_offs -
784 provider->offset - provider->clkdm->clkdm_offs;
787 static struct clk *_lookup_clkctrl_clk(struct omap_hwmod *oh)
789 struct clkctrl_provider *provider;
792 if (!soc_ops.xlate_clkctrl)
795 list_for_each_entry(provider, &clkctrl_providers, link) {
796 if (provider->clkdm == oh->clkdm) {
797 struct of_phandle_args clkspec;
799 clkspec.np = provider->node;
800 clkspec.args_count = 2;
801 clkspec.args[0] = soc_ops.xlate_clkctrl(oh, provider);
804 clk = of_clk_get_from_provider(&clkspec);
814 * _init_main_clk - get a struct clk * for the the hwmod's main functional clk
815 * @oh: struct omap_hwmod *
817 * Called from _init_clocks(). Populates the @oh _clk (main
818 * functional clock pointer) if a clock matching the hwmod name is found,
819 * or a main_clk is present. Returns 0 on success or -EINVAL on error.
821 static int _init_main_clk(struct omap_hwmod *oh)
824 struct clk *clk = NULL;
826 clk = _lookup_clkctrl_clk(oh);
828 if (!IS_ERR_OR_NULL(clk)) {
829 pr_debug("%s: mapped main_clk %s for %s\n", __func__,
830 __clk_get_name(clk), oh->name);
831 oh->main_clk = __clk_get_name(clk);
833 soc_ops.disable_direct_prcm(oh);
838 oh->_clk = clk_get(NULL, oh->main_clk);
841 if (IS_ERR(oh->_clk)) {
842 pr_warn("omap_hwmod: %s: cannot clk_get main_clk %s\n",
843 oh->name, oh->main_clk);
847 * HACK: This needs a re-visit once clk_prepare() is implemented
848 * to do something meaningful. Today its just a no-op.
849 * If clk_prepare() is used at some point to do things like
850 * voltage scaling etc, then this would have to be moved to
851 * some point where subsystems like i2c and pmic become
854 clk_prepare(oh->_clk);
857 pr_debug("omap_hwmod: %s: missing clockdomain for %s.\n",
858 oh->name, oh->main_clk);
864 * _init_interface_clks - get a struct clk * for the the hwmod's interface clks
865 * @oh: struct omap_hwmod *
867 * Called from _init_clocks(). Populates the @oh OCP slave interface
868 * clock pointers. Returns 0 on success or -EINVAL on error.
870 static int _init_interface_clks(struct omap_hwmod *oh)
872 struct omap_hwmod_ocp_if *os;
876 list_for_each_entry(os, &oh->slave_ports, node) {
880 c = clk_get(NULL, os->clk);
882 pr_warn("omap_hwmod: %s: cannot clk_get interface_clk %s\n",
889 * HACK: This needs a re-visit once clk_prepare() is implemented
890 * to do something meaningful. Today its just a no-op.
891 * If clk_prepare() is used at some point to do things like
892 * voltage scaling etc, then this would have to be moved to
893 * some point where subsystems like i2c and pmic become
896 clk_prepare(os->_clk);
903 * _init_opt_clk - get a struct clk * for the the hwmod's optional clocks
904 * @oh: struct omap_hwmod *
906 * Called from _init_clocks(). Populates the @oh omap_hwmod_opt_clk
907 * clock pointers. Returns 0 on success or -EINVAL on error.
909 static int _init_opt_clks(struct omap_hwmod *oh)
911 struct omap_hwmod_opt_clk *oc;
916 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++) {
917 c = clk_get(NULL, oc->clk);
919 pr_warn("omap_hwmod: %s: cannot clk_get opt_clk %s\n",
926 * HACK: This needs a re-visit once clk_prepare() is implemented
927 * to do something meaningful. Today its just a no-op.
928 * If clk_prepare() is used at some point to do things like
929 * voltage scaling etc, then this would have to be moved to
930 * some point where subsystems like i2c and pmic become
933 clk_prepare(oc->_clk);
939 static void _enable_optional_clocks(struct omap_hwmod *oh)
941 struct omap_hwmod_opt_clk *oc;
944 pr_debug("omap_hwmod: %s: enabling optional clocks\n", oh->name);
946 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
948 pr_debug("omap_hwmod: enable %s:%s\n", oc->role,
949 __clk_get_name(oc->_clk));
950 clk_enable(oc->_clk);
954 static void _disable_optional_clocks(struct omap_hwmod *oh)
956 struct omap_hwmod_opt_clk *oc;
959 pr_debug("omap_hwmod: %s: disabling optional clocks\n", oh->name);
961 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
963 pr_debug("omap_hwmod: disable %s:%s\n", oc->role,
964 __clk_get_name(oc->_clk));
965 clk_disable(oc->_clk);
970 * _enable_clocks - enable hwmod main clock and interface clocks
971 * @oh: struct omap_hwmod *
973 * Enables all clocks necessary for register reads and writes to succeed
974 * on the hwmod @oh. Returns 0.
976 static int _enable_clocks(struct omap_hwmod *oh)
978 struct omap_hwmod_ocp_if *os;
980 pr_debug("omap_hwmod: %s: enabling clocks\n", oh->name);
983 clk_enable(oh->_clk);
985 list_for_each_entry(os, &oh->slave_ports, node) {
986 if (os->_clk && (os->flags & OCPIF_SWSUP_IDLE))
987 clk_enable(os->_clk);
990 if (oh->flags & HWMOD_OPT_CLKS_NEEDED)
991 _enable_optional_clocks(oh);
993 /* The opt clocks are controlled by the device driver. */
999 * _disable_clocks - disable hwmod main clock and interface clocks
1000 * @oh: struct omap_hwmod *
1002 * Disables the hwmod @oh main functional and interface clocks. Returns 0.
1004 static int _disable_clocks(struct omap_hwmod *oh)
1006 struct omap_hwmod_ocp_if *os;
1008 pr_debug("omap_hwmod: %s: disabling clocks\n", oh->name);
1011 clk_disable(oh->_clk);
1013 list_for_each_entry(os, &oh->slave_ports, node) {
1014 if (os->_clk && (os->flags & OCPIF_SWSUP_IDLE))
1015 clk_disable(os->_clk);
1018 if (oh->flags & HWMOD_OPT_CLKS_NEEDED)
1019 _disable_optional_clocks(oh);
1021 /* The opt clocks are controlled by the device driver. */
1027 * _omap4_enable_module - enable CLKCTRL modulemode on OMAP4
1028 * @oh: struct omap_hwmod *
1030 * Enables the PRCM module mode related to the hwmod @oh.
1033 static void _omap4_enable_module(struct omap_hwmod *oh)
1035 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
1038 pr_debug("omap_hwmod: %s: %s: %d\n",
1039 oh->name, __func__, oh->prcm.omap4.modulemode);
1041 omap_cm_module_enable(oh->prcm.omap4.modulemode,
1042 oh->clkdm->prcm_partition,
1043 oh->clkdm->cm_inst, oh->prcm.omap4.clkctrl_offs);
1047 * _omap4_wait_target_disable - wait for a module to be disabled on OMAP4
1048 * @oh: struct omap_hwmod *
1050 * Wait for a module @oh to enter slave idle. Returns 0 if the module
1051 * does not have an IDLEST bit or if the module successfully enters
1052 * slave idle; otherwise, pass along the return value of the
1053 * appropriate *_cm*_wait_module_idle() function.
1055 static int _omap4_wait_target_disable(struct omap_hwmod *oh)
1060 if (oh->_int_flags & _HWMOD_NO_MPU_PORT || !oh->clkdm)
1063 if (oh->flags & HWMOD_NO_IDLEST)
1066 if (!oh->prcm.omap4.clkctrl_offs &&
1067 !(oh->prcm.omap4.flags & HWMOD_OMAP4_ZERO_CLKCTRL_OFFSET))
1070 return omap_cm_wait_module_idle(oh->clkdm->prcm_partition,
1072 oh->prcm.omap4.clkctrl_offs, 0);
1076 * _count_mpu_irqs - count the number of MPU IRQ lines associated with @oh
1077 * @oh: struct omap_hwmod *oh
1079 * Count and return the number of MPU IRQs associated with the hwmod
1080 * @oh. Used to allocate struct resource data. Returns 0 if @oh is
1083 static int _count_mpu_irqs(struct omap_hwmod *oh)
1085 struct omap_hwmod_irq_info *ohii;
1088 if (!oh || !oh->mpu_irqs)
1092 ohii = &oh->mpu_irqs[i++];
1093 } while (ohii->irq != -1);
1099 * _count_sdma_reqs - count the number of SDMA request lines associated with @oh
1100 * @oh: struct omap_hwmod *oh
1102 * Count and return the number of SDMA request lines associated with
1103 * the hwmod @oh. Used to allocate struct resource data. Returns 0
1106 static int _count_sdma_reqs(struct omap_hwmod *oh)
1108 struct omap_hwmod_dma_info *ohdi;
1111 if (!oh || !oh->sdma_reqs)
1115 ohdi = &oh->sdma_reqs[i++];
1116 } while (ohdi->dma_req != -1);
1122 * _count_ocp_if_addr_spaces - count the number of address space entries for @oh
1123 * @oh: struct omap_hwmod *oh
1125 * Count and return the number of address space ranges associated with
1126 * the hwmod @oh. Used to allocate struct resource data. Returns 0
1129 static int _count_ocp_if_addr_spaces(struct omap_hwmod_ocp_if *os)
1131 struct omap_hwmod_addr_space *mem;
1134 if (!os || !os->addr)
1138 mem = &os->addr[i++];
1139 } while (mem->pa_start != mem->pa_end);
1145 * _get_mpu_irq_by_name - fetch MPU interrupt line number by name
1146 * @oh: struct omap_hwmod * to operate on
1147 * @name: pointer to the name of the MPU interrupt number to fetch (optional)
1148 * @irq: pointer to an unsigned int to store the MPU IRQ number to
1150 * Retrieve a MPU hardware IRQ line number named by @name associated
1151 * with the IP block pointed to by @oh. The IRQ number will be filled
1152 * into the address pointed to by @dma. When @name is non-null, the
1153 * IRQ line number associated with the named entry will be returned.
1154 * If @name is null, the first matching entry will be returned. Data
1155 * order is not meaningful in hwmod data, so callers are strongly
1156 * encouraged to use a non-null @name whenever possible to avoid
1157 * unpredictable effects if hwmod data is later added that causes data
1158 * ordering to change. Returns 0 upon success or a negative error
1161 static int _get_mpu_irq_by_name(struct omap_hwmod *oh, const char *name,
1171 while (oh->mpu_irqs[i].irq != -1) {
1172 if (name == oh->mpu_irqs[i].name ||
1173 !strcmp(name, oh->mpu_irqs[i].name)) {
1183 *irq = oh->mpu_irqs[i].irq;
1189 * _get_sdma_req_by_name - fetch SDMA request line ID by name
1190 * @oh: struct omap_hwmod * to operate on
1191 * @name: pointer to the name of the SDMA request line to fetch (optional)
1192 * @dma: pointer to an unsigned int to store the request line ID to
1194 * Retrieve an SDMA request line ID named by @name on the IP block
1195 * pointed to by @oh. The ID will be filled into the address pointed
1196 * to by @dma. When @name is non-null, the request line ID associated
1197 * with the named entry will be returned. If @name is null, the first
1198 * matching entry will be returned. Data order is not meaningful in
1199 * hwmod data, so callers are strongly encouraged to use a non-null
1200 * @name whenever possible to avoid unpredictable effects if hwmod
1201 * data is later added that causes data ordering to change. Returns 0
1202 * upon success or a negative error code upon error.
1204 static int _get_sdma_req_by_name(struct omap_hwmod *oh, const char *name,
1214 while (oh->sdma_reqs[i].dma_req != -1) {
1215 if (name == oh->sdma_reqs[i].name ||
1216 !strcmp(name, oh->sdma_reqs[i].name)) {
1226 *dma = oh->sdma_reqs[i].dma_req;
1232 * _get_addr_space_by_name - fetch address space start & end by name
1233 * @oh: struct omap_hwmod * to operate on
1234 * @name: pointer to the name of the address space to fetch (optional)
1235 * @pa_start: pointer to a u32 to store the starting address to
1236 * @pa_end: pointer to a u32 to store the ending address to
1238 * Retrieve address space start and end addresses for the IP block
1239 * pointed to by @oh. The data will be filled into the addresses
1240 * pointed to by @pa_start and @pa_end. When @name is non-null, the
1241 * address space data associated with the named entry will be
1242 * returned. If @name is null, the first matching entry will be
1243 * returned. Data order is not meaningful in hwmod data, so callers
1244 * are strongly encouraged to use a non-null @name whenever possible
1245 * to avoid unpredictable effects if hwmod data is later added that
1246 * causes data ordering to change. Returns 0 upon success or a
1247 * negative error code upon error.
1249 static int _get_addr_space_by_name(struct omap_hwmod *oh, const char *name,
1250 u32 *pa_start, u32 *pa_end)
1253 struct omap_hwmod_ocp_if *os;
1256 list_for_each_entry(os, &oh->slave_ports, node) {
1262 while (os->addr[j].pa_start != os->addr[j].pa_end) {
1263 if (name == os->addr[j].name ||
1264 !strcmp(name, os->addr[j].name)) {
1278 *pa_start = os->addr[j].pa_start;
1279 *pa_end = os->addr[j].pa_end;
1285 * _save_mpu_port_index - find and save the index to @oh's MPU port
1286 * @oh: struct omap_hwmod *
1288 * Determines the array index of the OCP slave port that the MPU uses
1289 * to address the device, and saves it into the struct omap_hwmod.
1290 * Intended to be called during hwmod registration only. No return
1293 static void __init _save_mpu_port_index(struct omap_hwmod *oh)
1295 struct omap_hwmod_ocp_if *os = NULL;
1300 oh->_int_flags |= _HWMOD_NO_MPU_PORT;
1302 list_for_each_entry(os, &oh->slave_ports, node) {
1303 if (os->user & OCP_USER_MPU) {
1305 oh->_int_flags &= ~_HWMOD_NO_MPU_PORT;
1314 * _find_mpu_rt_port - return omap_hwmod_ocp_if accessible by the MPU
1315 * @oh: struct omap_hwmod *
1317 * Given a pointer to a struct omap_hwmod record @oh, return a pointer
1318 * to the struct omap_hwmod_ocp_if record that is used by the MPU to
1319 * communicate with the IP block. This interface need not be directly
1320 * connected to the MPU (and almost certainly is not), but is directly
1321 * connected to the IP block represented by @oh. Returns a pointer
1322 * to the struct omap_hwmod_ocp_if * upon success, or returns NULL upon
1323 * error or if there does not appear to be a path from the MPU to this
1326 static struct omap_hwmod_ocp_if *_find_mpu_rt_port(struct omap_hwmod *oh)
1328 if (!oh || oh->_int_flags & _HWMOD_NO_MPU_PORT || oh->slaves_cnt == 0)
1331 return oh->_mpu_port;
1335 * _find_mpu_rt_addr_space - return MPU register target address space for @oh
1336 * @oh: struct omap_hwmod *
1338 * Returns a pointer to the struct omap_hwmod_addr_space record representing
1339 * the register target MPU address space; or returns NULL upon error.
1341 static struct omap_hwmod_addr_space * __init _find_mpu_rt_addr_space(struct omap_hwmod *oh)
1343 struct omap_hwmod_ocp_if *os;
1344 struct omap_hwmod_addr_space *mem;
1345 int found = 0, i = 0;
1347 os = _find_mpu_rt_port(oh);
1348 if (!os || !os->addr)
1352 mem = &os->addr[i++];
1353 if (mem->flags & ADDR_TYPE_RT)
1355 } while (!found && mem->pa_start != mem->pa_end);
1357 return (found) ? mem : NULL;
1361 * _enable_sysc - try to bring a module out of idle via OCP_SYSCONFIG
1362 * @oh: struct omap_hwmod *
1364 * Ensure that the OCP_SYSCONFIG register for the IP block represented
1365 * by @oh is set to indicate to the PRCM that the IP block is active.
1366 * Usually this means placing the module into smart-idle mode and
1367 * smart-standby, but if there is a bug in the automatic idle handling
1368 * for the IP block, it may need to be placed into the force-idle or
1369 * no-idle variants of these modes. No return value.
1371 static void _enable_sysc(struct omap_hwmod *oh)
1376 struct clockdomain *clkdm;
1378 if (!oh->class->sysc)
1382 * Wait until reset has completed, this is needed as the IP
1383 * block is reset automatically by hardware in some cases
1384 * (off-mode for example), and the drivers require the
1385 * IP to be ready when they access it
1387 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1388 _enable_optional_clocks(oh);
1389 _wait_softreset_complete(oh);
1390 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1391 _disable_optional_clocks(oh);
1393 v = oh->_sysc_cache;
1394 sf = oh->class->sysc->sysc_flags;
1396 clkdm = _get_clkdm(oh);
1397 if (sf & SYSC_HAS_SIDLEMODE) {
1398 if (oh->flags & HWMOD_SWSUP_SIDLE ||
1399 oh->flags & HWMOD_SWSUP_SIDLE_ACT) {
1400 idlemode = HWMOD_IDLEMODE_NO;
1402 if (sf & SYSC_HAS_ENAWAKEUP)
1403 _enable_wakeup(oh, &v);
1404 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
1405 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1407 idlemode = HWMOD_IDLEMODE_SMART;
1411 * This is special handling for some IPs like
1412 * 32k sync timer. Force them to idle!
1414 clkdm_act = (clkdm && clkdm->flags & CLKDM_ACTIVE_WITH_MPU);
1415 if (clkdm_act && !(oh->class->sysc->idlemodes &
1416 (SIDLE_SMART | SIDLE_SMART_WKUP)))
1417 idlemode = HWMOD_IDLEMODE_FORCE;
1419 _set_slave_idlemode(oh, idlemode, &v);
1422 if (sf & SYSC_HAS_MIDLEMODE) {
1423 if (oh->flags & HWMOD_FORCE_MSTANDBY) {
1424 idlemode = HWMOD_IDLEMODE_FORCE;
1425 } else if (oh->flags & HWMOD_SWSUP_MSTANDBY) {
1426 idlemode = HWMOD_IDLEMODE_NO;
1428 if (sf & SYSC_HAS_ENAWAKEUP)
1429 _enable_wakeup(oh, &v);
1430 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1431 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1433 idlemode = HWMOD_IDLEMODE_SMART;
1435 _set_master_standbymode(oh, idlemode, &v);
1439 * XXX The clock framework should handle this, by
1440 * calling into this code. But this must wait until the
1441 * clock structures are tagged with omap_hwmod entries
1443 if ((oh->flags & HWMOD_SET_DEFAULT_CLOCKACT) &&
1444 (sf & SYSC_HAS_CLOCKACTIVITY))
1445 _set_clockactivity(oh, CLOCKACT_TEST_ICLK, &v);
1447 _write_sysconfig(v, oh);
1450 * Set the autoidle bit only after setting the smartidle bit
1451 * Setting this will not have any impact on the other modules.
1453 if (sf & SYSC_HAS_AUTOIDLE) {
1454 idlemode = (oh->flags & HWMOD_NO_OCP_AUTOIDLE) ?
1456 _set_module_autoidle(oh, idlemode, &v);
1457 _write_sysconfig(v, oh);
1462 * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
1463 * @oh: struct omap_hwmod *
1465 * If module is marked as SWSUP_SIDLE, force the module into slave
1466 * idle; otherwise, configure it for smart-idle. If module is marked
1467 * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
1468 * configure it for smart-standby. No return value.
1470 static void _idle_sysc(struct omap_hwmod *oh)
1475 if (!oh->class->sysc)
1478 v = oh->_sysc_cache;
1479 sf = oh->class->sysc->sysc_flags;
1481 if (sf & SYSC_HAS_SIDLEMODE) {
1482 if (oh->flags & HWMOD_SWSUP_SIDLE) {
1483 idlemode = HWMOD_IDLEMODE_FORCE;
1485 if (sf & SYSC_HAS_ENAWAKEUP)
1486 _enable_wakeup(oh, &v);
1487 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
1488 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1490 idlemode = HWMOD_IDLEMODE_SMART;
1492 _set_slave_idlemode(oh, idlemode, &v);
1495 if (sf & SYSC_HAS_MIDLEMODE) {
1496 if ((oh->flags & HWMOD_SWSUP_MSTANDBY) ||
1497 (oh->flags & HWMOD_FORCE_MSTANDBY)) {
1498 idlemode = HWMOD_IDLEMODE_FORCE;
1500 if (sf & SYSC_HAS_ENAWAKEUP)
1501 _enable_wakeup(oh, &v);
1502 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1503 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1505 idlemode = HWMOD_IDLEMODE_SMART;
1507 _set_master_standbymode(oh, idlemode, &v);
1510 /* If the cached value is the same as the new value, skip the write */
1511 if (oh->_sysc_cache != v)
1512 _write_sysconfig(v, oh);
1516 * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
1517 * @oh: struct omap_hwmod *
1519 * Force the module into slave idle and master suspend. No return
1522 static void _shutdown_sysc(struct omap_hwmod *oh)
1527 if (!oh->class->sysc)
1530 v = oh->_sysc_cache;
1531 sf = oh->class->sysc->sysc_flags;
1533 if (sf & SYSC_HAS_SIDLEMODE)
1534 _set_slave_idlemode(oh, HWMOD_IDLEMODE_FORCE, &v);
1536 if (sf & SYSC_HAS_MIDLEMODE)
1537 _set_master_standbymode(oh, HWMOD_IDLEMODE_FORCE, &v);
1539 if (sf & SYSC_HAS_AUTOIDLE)
1540 _set_module_autoidle(oh, 1, &v);
1542 _write_sysconfig(v, oh);
1546 * _lookup - find an omap_hwmod by name
1547 * @name: find an omap_hwmod by name
1549 * Return a pointer to an omap_hwmod by name, or NULL if not found.
1551 static struct omap_hwmod *_lookup(const char *name)
1553 struct omap_hwmod *oh, *temp_oh;
1557 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1558 if (!strcmp(name, temp_oh->name)) {
1568 * _init_clkdm - look up a clockdomain name, store pointer in omap_hwmod
1569 * @oh: struct omap_hwmod *
1571 * Convert a clockdomain name stored in a struct omap_hwmod into a
1572 * clockdomain pointer, and save it into the struct omap_hwmod.
1573 * Return -EINVAL if the clkdm_name lookup failed.
1575 static int _init_clkdm(struct omap_hwmod *oh)
1577 if (!oh->clkdm_name) {
1578 pr_debug("omap_hwmod: %s: missing clockdomain\n", oh->name);
1582 oh->clkdm = clkdm_lookup(oh->clkdm_name);
1584 pr_warn("omap_hwmod: %s: could not associate to clkdm %s\n",
1585 oh->name, oh->clkdm_name);
1589 pr_debug("omap_hwmod: %s: associated to clkdm %s\n",
1590 oh->name, oh->clkdm_name);
1596 * _init_clocks - clk_get() all clocks associated with this hwmod. Retrieve as
1597 * well the clockdomain.
1598 * @oh: struct omap_hwmod *
1599 * @np: device_node mapped to this hwmod
1601 * Called by omap_hwmod_setup_*() (after omap2_clk_init()).
1602 * Resolves all clock names embedded in the hwmod. Returns 0 on
1603 * success, or a negative error code on failure.
1605 static int _init_clocks(struct omap_hwmod *oh, struct device_node *np)
1609 if (oh->_state != _HWMOD_STATE_REGISTERED)
1612 pr_debug("omap_hwmod: %s: looking up clocks\n", oh->name);
1614 if (soc_ops.init_clkdm)
1615 ret |= soc_ops.init_clkdm(oh);
1617 ret |= _init_main_clk(oh);
1618 ret |= _init_interface_clks(oh);
1619 ret |= _init_opt_clks(oh);
1622 oh->_state = _HWMOD_STATE_CLKS_INITED;
1624 pr_warn("omap_hwmod: %s: cannot _init_clocks\n", oh->name);
1630 * _lookup_hardreset - fill register bit info for this hwmod/reset line
1631 * @oh: struct omap_hwmod *
1632 * @name: name of the reset line in the context of this hwmod
1633 * @ohri: struct omap_hwmod_rst_info * that this function will fill in
1635 * Return the bit position of the reset line that match the
1636 * input name. Return -ENOENT if not found.
1638 static int _lookup_hardreset(struct omap_hwmod *oh, const char *name,
1639 struct omap_hwmod_rst_info *ohri)
1643 for (i = 0; i < oh->rst_lines_cnt; i++) {
1644 const char *rst_line = oh->rst_lines[i].name;
1645 if (!strcmp(rst_line, name)) {
1646 ohri->rst_shift = oh->rst_lines[i].rst_shift;
1647 ohri->st_shift = oh->rst_lines[i].st_shift;
1648 pr_debug("omap_hwmod: %s: %s: %s: rst %d st %d\n",
1649 oh->name, __func__, rst_line, ohri->rst_shift,
1660 * _assert_hardreset - assert the HW reset line of submodules
1661 * contained in the hwmod module.
1662 * @oh: struct omap_hwmod *
1663 * @name: name of the reset line to lookup and assert
1665 * Some IP like dsp, ipu or iva contain processor that require an HW
1666 * reset line to be assert / deassert in order to enable fully the IP.
1667 * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1668 * asserting the hardreset line on the currently-booted SoC, or passes
1669 * along the return value from _lookup_hardreset() or the SoC's
1670 * assert_hardreset code.
1672 static int _assert_hardreset(struct omap_hwmod *oh, const char *name)
1674 struct omap_hwmod_rst_info ohri;
1680 if (!soc_ops.assert_hardreset)
1683 ret = _lookup_hardreset(oh, name, &ohri);
1687 ret = soc_ops.assert_hardreset(oh, &ohri);
1693 * _deassert_hardreset - deassert the HW reset line of submodules contained
1694 * in the hwmod module.
1695 * @oh: struct omap_hwmod *
1696 * @name: name of the reset line to look up and deassert
1698 * Some IP like dsp, ipu or iva contain processor that require an HW
1699 * reset line to be assert / deassert in order to enable fully the IP.
1700 * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1701 * deasserting the hardreset line on the currently-booted SoC, or passes
1702 * along the return value from _lookup_hardreset() or the SoC's
1703 * deassert_hardreset code.
1705 static int _deassert_hardreset(struct omap_hwmod *oh, const char *name)
1707 struct omap_hwmod_rst_info ohri;
1713 if (!soc_ops.deassert_hardreset)
1716 ret = _lookup_hardreset(oh, name, &ohri);
1722 * A clockdomain must be in SW_SUP otherwise reset
1723 * might not be completed. The clockdomain can be set
1724 * in HW_AUTO only when the module become ready.
1726 clkdm_deny_idle(oh->clkdm);
1727 ret = clkdm_hwmod_enable(oh->clkdm, oh);
1729 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1730 oh->name, oh->clkdm->name, ret);
1736 if (soc_ops.enable_module)
1737 soc_ops.enable_module(oh);
1739 ret = soc_ops.deassert_hardreset(oh, &ohri);
1741 if (soc_ops.disable_module)
1742 soc_ops.disable_module(oh);
1743 _disable_clocks(oh);
1746 pr_warn("omap_hwmod: %s: failed to hardreset\n", oh->name);
1750 * Set the clockdomain to HW_AUTO, assuming that the
1751 * previous state was HW_AUTO.
1753 clkdm_allow_idle(oh->clkdm);
1755 clkdm_hwmod_disable(oh->clkdm, oh);
1762 * _read_hardreset - read the HW reset line state of submodules
1763 * contained in the hwmod module
1764 * @oh: struct omap_hwmod *
1765 * @name: name of the reset line to look up and read
1767 * Return the state of the reset line. Returns -EINVAL if @oh is
1768 * null, -ENOSYS if we have no way of reading the hardreset line
1769 * status on the currently-booted SoC, or passes along the return
1770 * value from _lookup_hardreset() or the SoC's is_hardreset_asserted
1773 static int _read_hardreset(struct omap_hwmod *oh, const char *name)
1775 struct omap_hwmod_rst_info ohri;
1781 if (!soc_ops.is_hardreset_asserted)
1784 ret = _lookup_hardreset(oh, name, &ohri);
1788 return soc_ops.is_hardreset_asserted(oh, &ohri);
1792 * _are_all_hardreset_lines_asserted - return true if the @oh is hard-reset
1793 * @oh: struct omap_hwmod *
1795 * If all hardreset lines associated with @oh are asserted, then return true.
1796 * Otherwise, if part of @oh is out hardreset or if no hardreset lines
1797 * associated with @oh are asserted, then return false.
1798 * This function is used to avoid executing some parts of the IP block
1799 * enable/disable sequence if its hardreset line is set.
1801 static bool _are_all_hardreset_lines_asserted(struct omap_hwmod *oh)
1805 if (oh->rst_lines_cnt == 0)
1808 for (i = 0; i < oh->rst_lines_cnt; i++)
1809 if (_read_hardreset(oh, oh->rst_lines[i].name) > 0)
1812 if (oh->rst_lines_cnt == rst_cnt)
1819 * _are_any_hardreset_lines_asserted - return true if any part of @oh is
1821 * @oh: struct omap_hwmod *
1823 * If any hardreset lines associated with @oh are asserted, then
1824 * return true. Otherwise, if no hardreset lines associated with @oh
1825 * are asserted, or if @oh has no hardreset lines, then return false.
1826 * This function is used to avoid executing some parts of the IP block
1827 * enable/disable sequence if any hardreset line is set.
1829 static bool _are_any_hardreset_lines_asserted(struct omap_hwmod *oh)
1834 for (i = 0; i < oh->rst_lines_cnt && rst_cnt == 0; i++)
1835 if (_read_hardreset(oh, oh->rst_lines[i].name) > 0)
1838 return (rst_cnt) ? true : false;
1842 * _omap4_disable_module - enable CLKCTRL modulemode on OMAP4
1843 * @oh: struct omap_hwmod *
1845 * Disable the PRCM module mode related to the hwmod @oh.
1846 * Return EINVAL if the modulemode is not supported and 0 in case of success.
1848 static int _omap4_disable_module(struct omap_hwmod *oh)
1852 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
1856 * Since integration code might still be doing something, only
1857 * disable if all lines are under hardreset.
1859 if (_are_any_hardreset_lines_asserted(oh))
1862 pr_debug("omap_hwmod: %s: %s\n", oh->name, __func__);
1864 omap_cm_module_disable(oh->clkdm->prcm_partition, oh->clkdm->cm_inst,
1865 oh->prcm.omap4.clkctrl_offs);
1867 v = _omap4_wait_target_disable(oh);
1869 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1876 * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1877 * @oh: struct omap_hwmod *
1879 * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit. hwmod must be
1880 * enabled for this to work. Returns -ENOENT if the hwmod cannot be
1881 * reset this way, -EINVAL if the hwmod is in the wrong state,
1882 * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1884 * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1885 * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1886 * use the SYSCONFIG softreset bit to provide the status.
1888 * Note that some IP like McBSP do have reset control but don't have
1891 static int _ocp_softreset(struct omap_hwmod *oh)
1897 if (!oh->class->sysc ||
1898 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
1901 /* clocks must be on for this operation */
1902 if (oh->_state != _HWMOD_STATE_ENABLED) {
1903 pr_warn("omap_hwmod: %s: reset can only be entered from enabled state\n",
1908 /* For some modules, all optionnal clocks need to be enabled as well */
1909 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1910 _enable_optional_clocks(oh);
1912 pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh->name);
1914 v = oh->_sysc_cache;
1915 ret = _set_softreset(oh, &v);
1919 _write_sysconfig(v, oh);
1921 if (oh->class->sysc->srst_udelay)
1922 udelay(oh->class->sysc->srst_udelay);
1924 c = _wait_softreset_complete(oh);
1925 if (c == MAX_MODULE_SOFTRESET_WAIT) {
1926 pr_warn("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1927 oh->name, MAX_MODULE_SOFTRESET_WAIT);
1931 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh->name, c);
1934 ret = _clear_softreset(oh, &v);
1938 _write_sysconfig(v, oh);
1941 * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1942 * _wait_target_ready() or _reset()
1946 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1947 _disable_optional_clocks(oh);
1953 * _reset - reset an omap_hwmod
1954 * @oh: struct omap_hwmod *
1956 * Resets an omap_hwmod @oh. If the module has a custom reset
1957 * function pointer defined, then call it to reset the IP block, and
1958 * pass along its return value to the caller. Otherwise, if the IP
1959 * block has an OCP_SYSCONFIG register with a SOFTRESET bitfield
1960 * associated with it, call a function to reset the IP block via that
1961 * method, and pass along the return value to the caller. Finally, if
1962 * the IP block has some hardreset lines associated with it, assert
1963 * all of those, but do _not_ deassert them. (This is because driver
1964 * authors have expressed an apparent requirement to control the
1965 * deassertion of the hardreset lines themselves.)
1967 * The default software reset mechanism for most OMAP IP blocks is
1968 * triggered via the OCP_SYSCONFIG.SOFTRESET bit. However, some
1969 * hwmods cannot be reset via this method. Some are not targets and
1970 * therefore have no OCP header registers to access. Others (like the
1971 * IVA) have idiosyncratic reset sequences. So for these relatively
1972 * rare cases, custom reset code can be supplied in the struct
1973 * omap_hwmod_class .reset function pointer.
1975 * _set_dmadisable() is called to set the DMADISABLE bit so that it
1976 * does not prevent idling of the system. This is necessary for cases
1977 * where ROMCODE/BOOTLOADER uses dma and transfers control to the
1978 * kernel without disabling dma.
1980 * Passes along the return value from either _ocp_softreset() or the
1981 * custom reset function - these must return -EINVAL if the hwmod
1982 * cannot be reset this way or if the hwmod is in the wrong state,
1983 * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1985 static int _reset(struct omap_hwmod *oh)
1989 pr_debug("omap_hwmod: %s: resetting\n", oh->name);
1991 if (oh->class->reset) {
1992 r = oh->class->reset(oh);
1994 if (oh->rst_lines_cnt > 0) {
1995 for (i = 0; i < oh->rst_lines_cnt; i++)
1996 _assert_hardreset(oh, oh->rst_lines[i].name);
1999 r = _ocp_softreset(oh);
2005 _set_dmadisable(oh);
2008 * OCP_SYSCONFIG bits need to be reprogrammed after a
2009 * softreset. The _enable() function should be split to avoid
2010 * the rewrite of the OCP_SYSCONFIG register.
2012 if (oh->class->sysc) {
2013 _update_sysc_cache(oh);
2021 * _omap4_update_context_lost - increment hwmod context loss counter if
2022 * hwmod context was lost, and clear hardware context loss reg
2023 * @oh: hwmod to check for context loss
2025 * If the PRCM indicates that the hwmod @oh lost context, increment
2026 * our in-memory context loss counter, and clear the RM_*_CONTEXT
2027 * bits. No return value.
2029 static void _omap4_update_context_lost(struct omap_hwmod *oh)
2031 if (oh->prcm.omap4.flags & HWMOD_OMAP4_NO_CONTEXT_LOSS_BIT)
2034 if (!prm_was_any_context_lost_old(oh->clkdm->pwrdm.ptr->prcm_partition,
2035 oh->clkdm->pwrdm.ptr->prcm_offs,
2036 oh->prcm.omap4.context_offs))
2039 oh->prcm.omap4.context_lost_counter++;
2040 prm_clear_context_loss_flags_old(oh->clkdm->pwrdm.ptr->prcm_partition,
2041 oh->clkdm->pwrdm.ptr->prcm_offs,
2042 oh->prcm.omap4.context_offs);
2046 * _omap4_get_context_lost - get context loss counter for a hwmod
2047 * @oh: hwmod to get context loss counter for
2049 * Returns the in-memory context loss counter for a hwmod.
2051 static int _omap4_get_context_lost(struct omap_hwmod *oh)
2053 return oh->prcm.omap4.context_lost_counter;
2057 * _enable_preprogram - Pre-program an IP block during the _enable() process
2058 * @oh: struct omap_hwmod *
2060 * Some IP blocks (such as AESS) require some additional programming
2061 * after enable before they can enter idle. If a function pointer to
2062 * do so is present in the hwmod data, then call it and pass along the
2063 * return value; otherwise, return 0.
2065 static int _enable_preprogram(struct omap_hwmod *oh)
2067 if (!oh->class->enable_preprogram)
2070 return oh->class->enable_preprogram(oh);
2074 * _enable - enable an omap_hwmod
2075 * @oh: struct omap_hwmod *
2077 * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
2078 * register target. Returns -EINVAL if the hwmod is in the wrong
2079 * state or passes along the return value of _wait_target_ready().
2081 static int _enable(struct omap_hwmod *oh)
2085 pr_debug("omap_hwmod: %s: enabling\n", oh->name);
2088 * hwmods with HWMOD_INIT_NO_IDLE flag set are left in enabled
2091 if (oh->_int_flags & _HWMOD_SKIP_ENABLE) {
2092 oh->_int_flags &= ~_HWMOD_SKIP_ENABLE;
2096 if (oh->_state != _HWMOD_STATE_INITIALIZED &&
2097 oh->_state != _HWMOD_STATE_IDLE &&
2098 oh->_state != _HWMOD_STATE_DISABLED) {
2099 WARN(1, "omap_hwmod: %s: enabled state can only be entered from initialized, idle, or disabled state\n",
2105 * If an IP block contains HW reset lines and all of them are
2106 * asserted, we let integration code associated with that
2107 * block handle the enable. We've received very little
2108 * information on what those driver authors need, and until
2109 * detailed information is provided and the driver code is
2110 * posted to the public lists, this is probably the best we
2113 if (_are_all_hardreset_lines_asserted(oh))
2116 _add_initiator_dep(oh, mpu_oh);
2120 * A clockdomain must be in SW_SUP before enabling
2121 * completely the module. The clockdomain can be set
2122 * in HW_AUTO only when the module become ready.
2124 clkdm_deny_idle(oh->clkdm);
2125 r = clkdm_hwmod_enable(oh->clkdm, oh);
2127 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
2128 oh->name, oh->clkdm->name, r);
2134 if (soc_ops.enable_module)
2135 soc_ops.enable_module(oh);
2136 if (oh->flags & HWMOD_BLOCK_WFI)
2137 cpu_idle_poll_ctrl(true);
2139 if (soc_ops.update_context_lost)
2140 soc_ops.update_context_lost(oh);
2142 r = (soc_ops.wait_target_ready) ? soc_ops.wait_target_ready(oh) :
2144 if (oh->clkdm && !(oh->flags & HWMOD_CLKDM_NOAUTO))
2145 clkdm_allow_idle(oh->clkdm);
2148 oh->_state = _HWMOD_STATE_ENABLED;
2150 /* Access the sysconfig only if the target is ready */
2151 if (oh->class->sysc) {
2152 if (!(oh->_int_flags & _HWMOD_SYSCONFIG_LOADED))
2153 _update_sysc_cache(oh);
2156 r = _enable_preprogram(oh);
2158 if (soc_ops.disable_module)
2159 soc_ops.disable_module(oh);
2160 _disable_clocks(oh);
2161 pr_err("omap_hwmod: %s: _wait_target_ready failed: %d\n",
2165 clkdm_hwmod_disable(oh->clkdm, oh);
2172 * _idle - idle an omap_hwmod
2173 * @oh: struct omap_hwmod *
2175 * Idles an omap_hwmod @oh. This should be called once the hwmod has
2176 * no further work. Returns -EINVAL if the hwmod is in the wrong
2177 * state or returns 0.
2179 static int _idle(struct omap_hwmod *oh)
2181 if (oh->flags & HWMOD_NO_IDLE) {
2182 oh->_int_flags |= _HWMOD_SKIP_ENABLE;
2186 pr_debug("omap_hwmod: %s: idling\n", oh->name);
2188 if (_are_all_hardreset_lines_asserted(oh))
2191 if (oh->_state != _HWMOD_STATE_ENABLED) {
2192 WARN(1, "omap_hwmod: %s: idle state can only be entered from enabled state\n",
2197 if (oh->class->sysc)
2199 _del_initiator_dep(oh, mpu_oh);
2202 * If HWMOD_CLKDM_NOAUTO is set then we don't
2203 * deny idle the clkdm again since idle was already denied
2206 if (oh->clkdm && !(oh->flags & HWMOD_CLKDM_NOAUTO))
2207 clkdm_deny_idle(oh->clkdm);
2209 if (oh->flags & HWMOD_BLOCK_WFI)
2210 cpu_idle_poll_ctrl(false);
2211 if (soc_ops.disable_module)
2212 soc_ops.disable_module(oh);
2215 * The module must be in idle mode before disabling any parents
2216 * clocks. Otherwise, the parent clock might be disabled before
2217 * the module transition is done, and thus will prevent the
2218 * transition to complete properly.
2220 _disable_clocks(oh);
2222 clkdm_allow_idle(oh->clkdm);
2223 clkdm_hwmod_disable(oh->clkdm, oh);
2226 oh->_state = _HWMOD_STATE_IDLE;
2232 * _shutdown - shutdown an omap_hwmod
2233 * @oh: struct omap_hwmod *
2235 * Shut down an omap_hwmod @oh. This should be called when the driver
2236 * used for the hwmod is removed or unloaded or if the driver is not
2237 * used by the system. Returns -EINVAL if the hwmod is in the wrong
2238 * state or returns 0.
2240 static int _shutdown(struct omap_hwmod *oh)
2245 if (_are_all_hardreset_lines_asserted(oh))
2248 if (oh->_state != _HWMOD_STATE_IDLE &&
2249 oh->_state != _HWMOD_STATE_ENABLED) {
2250 WARN(1, "omap_hwmod: %s: disabled state can only be entered from idle, or enabled state\n",
2255 pr_debug("omap_hwmod: %s: disabling\n", oh->name);
2257 if (oh->class->pre_shutdown) {
2258 prev_state = oh->_state;
2259 if (oh->_state == _HWMOD_STATE_IDLE)
2261 ret = oh->class->pre_shutdown(oh);
2263 if (prev_state == _HWMOD_STATE_IDLE)
2269 if (oh->class->sysc) {
2270 if (oh->_state == _HWMOD_STATE_IDLE)
2275 /* clocks and deps are already disabled in idle */
2276 if (oh->_state == _HWMOD_STATE_ENABLED) {
2277 _del_initiator_dep(oh, mpu_oh);
2278 /* XXX what about the other system initiators here? dma, dsp */
2279 if (oh->flags & HWMOD_BLOCK_WFI)
2280 cpu_idle_poll_ctrl(false);
2281 if (soc_ops.disable_module)
2282 soc_ops.disable_module(oh);
2283 _disable_clocks(oh);
2285 clkdm_hwmod_disable(oh->clkdm, oh);
2287 /* XXX Should this code also force-disable the optional clocks? */
2289 for (i = 0; i < oh->rst_lines_cnt; i++)
2290 _assert_hardreset(oh, oh->rst_lines[i].name);
2292 oh->_state = _HWMOD_STATE_DISABLED;
2297 static int of_dev_find_hwmod(struct device_node *np,
2298 struct omap_hwmod *oh)
2303 count = of_property_count_strings(np, "ti,hwmods");
2307 for (i = 0; i < count; i++) {
2308 res = of_property_read_string_index(np, "ti,hwmods",
2312 if (!strcmp(p, oh->name)) {
2313 pr_debug("omap_hwmod: dt %s[%i] uses hwmod %s\n",
2314 np->name, i, oh->name);
2323 * of_dev_hwmod_lookup - look up needed hwmod from dt blob
2324 * @np: struct device_node *
2325 * @oh: struct omap_hwmod *
2326 * @index: index of the entry found
2327 * @found: struct device_node * found or NULL
2329 * Parse the dt blob and find out needed hwmod. Recursive function is
2330 * implemented to take care hierarchical dt blob parsing.
2331 * Return: Returns 0 on success, -ENODEV when not found.
2333 static int of_dev_hwmod_lookup(struct device_node *np,
2334 struct omap_hwmod *oh,
2336 struct device_node **found)
2338 struct device_node *np0 = NULL;
2341 res = of_dev_find_hwmod(np, oh);
2348 for_each_child_of_node(np, np0) {
2349 struct device_node *fc;
2352 res = of_dev_hwmod_lookup(np0, oh, &i, &fc);
2367 * _init_mpu_rt_base - populate the virtual address for a hwmod
2368 * @oh: struct omap_hwmod * to locate the virtual address
2369 * @data: (unused, caller should pass NULL)
2370 * @index: index of the reg entry iospace in device tree
2371 * @np: struct device_node * of the IP block's device node in the DT data
2373 * Cache the virtual address used by the MPU to access this IP block's
2374 * registers. This address is needed early so the OCP registers that
2375 * are part of the device's address space can be ioremapped properly.
2377 * If SYSC access is not needed, the registers will not be remapped
2378 * and non-availability of MPU access is not treated as an error.
2380 * Returns 0 on success, -EINVAL if an invalid hwmod is passed, and
2381 * -ENXIO on absent or invalid register target address space.
2383 static int __init _init_mpu_rt_base(struct omap_hwmod *oh, void *data,
2384 int index, struct device_node *np)
2386 struct omap_hwmod_addr_space *mem;
2387 void __iomem *va_start = NULL;
2392 _save_mpu_port_index(oh);
2394 /* if we don't need sysc access we don't need to ioremap */
2395 if (!oh->class->sysc)
2398 /* we can't continue without MPU PORT if we need sysc access */
2399 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2402 mem = _find_mpu_rt_addr_space(oh);
2404 pr_debug("omap_hwmod: %s: no MPU register target found\n",
2407 /* Extract the IO space from device tree blob */
2409 pr_err("omap_hwmod: %s: no dt node\n", oh->name);
2413 va_start = of_iomap(np, index + oh->mpu_rt_idx);
2415 va_start = ioremap(mem->pa_start, mem->pa_end - mem->pa_start);
2420 pr_err("omap_hwmod: %s: Could not ioremap\n", oh->name);
2422 pr_err("omap_hwmod: %s: Missing dt reg%i for %pOF\n",
2423 oh->name, index, np);
2427 pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
2428 oh->name, va_start);
2430 oh->_mpu_rt_va = va_start;
2435 * _init - initialize internal data for the hwmod @oh
2436 * @oh: struct omap_hwmod *
2439 * Look up the clocks and the address space used by the MPU to access
2440 * registers belonging to the hwmod @oh. @oh must already be
2441 * registered at this point. This is the first of two phases for
2442 * hwmod initialization. Code called here does not touch any hardware
2443 * registers, it simply prepares internal data structures. Returns 0
2444 * upon success or if the hwmod isn't registered or if the hwmod's
2445 * address space is not defined, or -EINVAL upon failure.
2447 static int __init _init(struct omap_hwmod *oh, void *data)
2450 struct device_node *np = NULL;
2451 struct device_node *bus;
2453 if (oh->_state != _HWMOD_STATE_REGISTERED)
2456 bus = of_find_node_by_name(NULL, "ocp");
2460 r = of_dev_hwmod_lookup(bus, oh, &index, &np);
2462 pr_debug("omap_hwmod: %s missing dt data\n", oh->name);
2463 else if (np && index)
2464 pr_warn("omap_hwmod: %s using broken dt data from %s\n",
2465 oh->name, np->name);
2467 r = _init_mpu_rt_base(oh, NULL, index, np);
2469 WARN(1, "omap_hwmod: %s: doesn't have mpu register target base\n",
2474 r = _init_clocks(oh, np);
2476 WARN(1, "omap_hwmod: %s: couldn't init clocks\n", oh->name);
2481 if (of_find_property(np, "ti,no-reset-on-init", NULL))
2482 oh->flags |= HWMOD_INIT_NO_RESET;
2483 if (of_find_property(np, "ti,no-idle-on-init", NULL))
2484 oh->flags |= HWMOD_INIT_NO_IDLE;
2485 if (of_find_property(np, "ti,no-idle", NULL))
2486 oh->flags |= HWMOD_NO_IDLE;
2489 oh->_state = _HWMOD_STATE_INITIALIZED;
2495 * _setup_iclk_autoidle - configure an IP block's interface clocks
2496 * @oh: struct omap_hwmod *
2498 * Set up the module's interface clocks. XXX This function is still mostly
2499 * a stub; implementing this properly requires iclk autoidle usecounting in
2500 * the clock code. No return value.
2502 static void _setup_iclk_autoidle(struct omap_hwmod *oh)
2504 struct omap_hwmod_ocp_if *os;
2506 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2509 list_for_each_entry(os, &oh->slave_ports, node) {
2513 if (os->flags & OCPIF_SWSUP_IDLE) {
2514 /* XXX omap_iclk_deny_idle(c); */
2516 /* XXX omap_iclk_allow_idle(c); */
2517 clk_enable(os->_clk);
2525 * _setup_reset - reset an IP block during the setup process
2526 * @oh: struct omap_hwmod *
2528 * Reset the IP block corresponding to the hwmod @oh during the setup
2529 * process. The IP block is first enabled so it can be successfully
2530 * reset. Returns 0 upon success or a negative error code upon
2533 static int _setup_reset(struct omap_hwmod *oh)
2537 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2540 if (oh->flags & HWMOD_EXT_OPT_MAIN_CLK)
2543 if (oh->rst_lines_cnt == 0) {
2546 pr_warn("omap_hwmod: %s: cannot be enabled for reset (%d)\n",
2547 oh->name, oh->_state);
2552 if (!(oh->flags & HWMOD_INIT_NO_RESET))
2559 * _setup_postsetup - transition to the appropriate state after _setup
2560 * @oh: struct omap_hwmod *
2562 * Place an IP block represented by @oh into a "post-setup" state --
2563 * either IDLE, ENABLED, or DISABLED. ("post-setup" simply means that
2564 * this function is called at the end of _setup().) The postsetup
2565 * state for an IP block can be changed by calling
2566 * omap_hwmod_enter_postsetup_state() early in the boot process,
2567 * before one of the omap_hwmod_setup*() functions are called for the
2570 * The IP block stays in this state until a PM runtime-based driver is
2571 * loaded for that IP block. A post-setup state of IDLE is
2572 * appropriate for almost all IP blocks with runtime PM-enabled
2573 * drivers, since those drivers are able to enable the IP block. A
2574 * post-setup state of ENABLED is appropriate for kernels with PM
2575 * runtime disabled. The DISABLED state is appropriate for unusual IP
2576 * blocks such as the MPU WDTIMER on kernels without WDTIMER drivers
2577 * included, since the WDTIMER starts running on reset and will reset
2578 * the MPU if left active.
2580 * This post-setup mechanism is deprecated. Once all of the OMAP
2581 * drivers have been converted to use PM runtime, and all of the IP
2582 * block data and interconnect data is available to the hwmod code, it
2583 * should be possible to replace this mechanism with a "lazy reset"
2584 * arrangement. In a "lazy reset" setup, each IP block is enabled
2585 * when the driver first probes, then all remaining IP blocks without
2586 * drivers are either shut down or enabled after the drivers have
2587 * loaded. However, this cannot take place until the above
2588 * preconditions have been met, since otherwise the late reset code
2589 * has no way of knowing which IP blocks are in use by drivers, and
2590 * which ones are unused.
2594 static void _setup_postsetup(struct omap_hwmod *oh)
2598 if (oh->rst_lines_cnt > 0)
2601 postsetup_state = oh->_postsetup_state;
2602 if (postsetup_state == _HWMOD_STATE_UNKNOWN)
2603 postsetup_state = _HWMOD_STATE_ENABLED;
2606 * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
2607 * it should be set by the core code as a runtime flag during startup
2609 if ((oh->flags & (HWMOD_INIT_NO_IDLE | HWMOD_NO_IDLE)) &&
2610 (postsetup_state == _HWMOD_STATE_IDLE)) {
2611 oh->_int_flags |= _HWMOD_SKIP_ENABLE;
2612 postsetup_state = _HWMOD_STATE_ENABLED;
2615 if (postsetup_state == _HWMOD_STATE_IDLE)
2617 else if (postsetup_state == _HWMOD_STATE_DISABLED)
2619 else if (postsetup_state != _HWMOD_STATE_ENABLED)
2620 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
2621 oh->name, postsetup_state);
2627 * _setup - prepare IP block hardware for use
2628 * @oh: struct omap_hwmod *
2629 * @n: (unused, pass NULL)
2631 * Configure the IP block represented by @oh. This may include
2632 * enabling the IP block, resetting it, and placing it into a
2633 * post-setup state, depending on the type of IP block and applicable
2634 * flags. IP blocks are reset to prevent any previous configuration
2635 * by the bootloader or previous operating system from interfering
2636 * with power management or other parts of the system. The reset can
2637 * be avoided; see omap_hwmod_no_setup_reset(). This is the second of
2638 * two phases for hwmod initialization. Code called here generally
2639 * affects the IP block hardware, or system integration hardware
2640 * associated with the IP block. Returns 0.
2642 static int __init _setup(struct omap_hwmod *oh, void *data)
2644 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2647 if (oh->parent_hwmod) {
2650 r = _enable(oh->parent_hwmod);
2651 WARN(r, "hwmod: %s: setup: failed to enable parent hwmod %s\n",
2652 oh->name, oh->parent_hwmod->name);
2655 _setup_iclk_autoidle(oh);
2657 if (!_setup_reset(oh))
2658 _setup_postsetup(oh);
2660 if (oh->parent_hwmod) {
2663 postsetup_state = oh->parent_hwmod->_postsetup_state;
2665 if (postsetup_state == _HWMOD_STATE_IDLE)
2666 _idle(oh->parent_hwmod);
2667 else if (postsetup_state == _HWMOD_STATE_DISABLED)
2668 _shutdown(oh->parent_hwmod);
2669 else if (postsetup_state != _HWMOD_STATE_ENABLED)
2670 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
2671 oh->parent_hwmod->name, postsetup_state);
2678 * _register - register a struct omap_hwmod
2679 * @oh: struct omap_hwmod *
2681 * Registers the omap_hwmod @oh. Returns -EEXIST if an omap_hwmod
2682 * already has been registered by the same name; -EINVAL if the
2683 * omap_hwmod is in the wrong state, if @oh is NULL, if the
2684 * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
2685 * name, or if the omap_hwmod's class is missing a name; or 0 upon
2688 * XXX The data should be copied into bootmem, so the original data
2689 * should be marked __initdata and freed after init. This would allow
2690 * unneeded omap_hwmods to be freed on multi-OMAP configurations. Note
2691 * that the copy process would be relatively complex due to the large number
2694 static int __init _register(struct omap_hwmod *oh)
2696 if (!oh || !oh->name || !oh->class || !oh->class->name ||
2697 (oh->_state != _HWMOD_STATE_UNKNOWN))
2700 pr_debug("omap_hwmod: %s: registering\n", oh->name);
2702 if (_lookup(oh->name))
2705 list_add_tail(&oh->node, &omap_hwmod_list);
2707 INIT_LIST_HEAD(&oh->slave_ports);
2708 spin_lock_init(&oh->_lock);
2709 lockdep_set_class(&oh->_lock, &oh->hwmod_key);
2711 oh->_state = _HWMOD_STATE_REGISTERED;
2714 * XXX Rather than doing a strcmp(), this should test a flag
2715 * set in the hwmod data, inserted by the autogenerator code.
2717 if (!strcmp(oh->name, MPU_INITIATOR_NAME))
2724 * _add_link - add an interconnect between two IP blocks
2725 * @oi: pointer to a struct omap_hwmod_ocp_if record
2727 * Add struct omap_hwmod_link records connecting the slave IP block
2728 * specified in @oi->slave to @oi. This code is assumed to run before
2729 * preemption or SMP has been enabled, thus avoiding the need for
2730 * locking in this code. Changes to this assumption will require
2731 * additional locking. Returns 0.
2733 static int __init _add_link(struct omap_hwmod_ocp_if *oi)
2735 pr_debug("omap_hwmod: %s -> %s: adding link\n", oi->master->name,
2738 list_add(&oi->node, &oi->slave->slave_ports);
2739 oi->slave->slaves_cnt++;
2745 * _register_link - register a struct omap_hwmod_ocp_if
2746 * @oi: struct omap_hwmod_ocp_if *
2748 * Registers the omap_hwmod_ocp_if record @oi. Returns -EEXIST if it
2749 * has already been registered; -EINVAL if @oi is NULL or if the
2750 * record pointed to by @oi is missing required fields; or 0 upon
2753 * XXX The data should be copied into bootmem, so the original data
2754 * should be marked __initdata and freed after init. This would allow
2755 * unneeded omap_hwmods to be freed on multi-OMAP configurations.
2757 static int __init _register_link(struct omap_hwmod_ocp_if *oi)
2759 if (!oi || !oi->master || !oi->slave || !oi->user)
2762 if (oi->_int_flags & _OCPIF_INT_FLAGS_REGISTERED)
2765 pr_debug("omap_hwmod: registering link from %s to %s\n",
2766 oi->master->name, oi->slave->name);
2769 * Register the connected hwmods, if they haven't been
2770 * registered already
2772 if (oi->master->_state != _HWMOD_STATE_REGISTERED)
2773 _register(oi->master);
2775 if (oi->slave->_state != _HWMOD_STATE_REGISTERED)
2776 _register(oi->slave);
2780 oi->_int_flags |= _OCPIF_INT_FLAGS_REGISTERED;
2785 /* Static functions intended only for use in soc_ops field function pointers */
2788 * _omap2xxx_3xxx_wait_target_ready - wait for a module to leave slave idle
2789 * @oh: struct omap_hwmod *
2791 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2792 * does not have an IDLEST bit or if the module successfully leaves
2793 * slave idle; otherwise, pass along the return value of the
2794 * appropriate *_cm*_wait_module_ready() function.
2796 static int _omap2xxx_3xxx_wait_target_ready(struct omap_hwmod *oh)
2801 if (oh->flags & HWMOD_NO_IDLEST)
2804 if (!_find_mpu_rt_port(oh))
2807 /* XXX check module SIDLEMODE, hardreset status, enabled clocks */
2809 return omap_cm_wait_module_ready(0, oh->prcm.omap2.module_offs,
2810 oh->prcm.omap2.idlest_reg_id,
2811 oh->prcm.omap2.idlest_idle_bit);
2815 * _omap4_wait_target_ready - wait for a module to leave slave idle
2816 * @oh: struct omap_hwmod *
2818 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2819 * does not have an IDLEST bit or if the module successfully leaves
2820 * slave idle; otherwise, pass along the return value of the
2821 * appropriate *_cm*_wait_module_ready() function.
2823 static int _omap4_wait_target_ready(struct omap_hwmod *oh)
2828 if (oh->flags & HWMOD_NO_IDLEST || !oh->clkdm)
2831 if (!_find_mpu_rt_port(oh))
2834 if (!oh->prcm.omap4.clkctrl_offs &&
2835 !(oh->prcm.omap4.flags & HWMOD_OMAP4_ZERO_CLKCTRL_OFFSET))
2838 /* XXX check module SIDLEMODE, hardreset status */
2840 return omap_cm_wait_module_ready(oh->clkdm->prcm_partition,
2842 oh->prcm.omap4.clkctrl_offs, 0);
2846 * _omap2_assert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2847 * @oh: struct omap_hwmod * to assert hardreset
2848 * @ohri: hardreset line data
2850 * Call omap2_prm_assert_hardreset() with parameters extracted from
2851 * the hwmod @oh and the hardreset line data @ohri. Only intended for
2852 * use as an soc_ops function pointer. Passes along the return value
2853 * from omap2_prm_assert_hardreset(). XXX This function is scheduled
2854 * for removal when the PRM code is moved into drivers/.
2856 static int _omap2_assert_hardreset(struct omap_hwmod *oh,
2857 struct omap_hwmod_rst_info *ohri)
2859 return omap_prm_assert_hardreset(ohri->rst_shift, 0,
2860 oh->prcm.omap2.module_offs, 0);
2864 * _omap2_deassert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2865 * @oh: struct omap_hwmod * to deassert hardreset
2866 * @ohri: hardreset line data
2868 * Call omap2_prm_deassert_hardreset() with parameters extracted from
2869 * the hwmod @oh and the hardreset line data @ohri. Only intended for
2870 * use as an soc_ops function pointer. Passes along the return value
2871 * from omap2_prm_deassert_hardreset(). XXX This function is
2872 * scheduled for removal when the PRM code is moved into drivers/.
2874 static int _omap2_deassert_hardreset(struct omap_hwmod *oh,
2875 struct omap_hwmod_rst_info *ohri)
2877 return omap_prm_deassert_hardreset(ohri->rst_shift, ohri->st_shift, 0,
2878 oh->prcm.omap2.module_offs, 0, 0);
2882 * _omap2_is_hardreset_asserted - call OMAP2 PRM hardreset fn with hwmod args
2883 * @oh: struct omap_hwmod * to test hardreset
2884 * @ohri: hardreset line data
2886 * Call omap2_prm_is_hardreset_asserted() with parameters extracted
2887 * from the hwmod @oh and the hardreset line data @ohri. Only
2888 * intended for use as an soc_ops function pointer. Passes along the
2889 * return value from omap2_prm_is_hardreset_asserted(). XXX This
2890 * function is scheduled for removal when the PRM code is moved into
2893 static int _omap2_is_hardreset_asserted(struct omap_hwmod *oh,
2894 struct omap_hwmod_rst_info *ohri)
2896 return omap_prm_is_hardreset_asserted(ohri->st_shift, 0,
2897 oh->prcm.omap2.module_offs, 0);
2901 * _omap4_assert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
2902 * @oh: struct omap_hwmod * to assert hardreset
2903 * @ohri: hardreset line data
2905 * Call omap4_prminst_assert_hardreset() with parameters extracted
2906 * from the hwmod @oh and the hardreset line data @ohri. Only
2907 * intended for use as an soc_ops function pointer. Passes along the
2908 * return value from omap4_prminst_assert_hardreset(). XXX This
2909 * function is scheduled for removal when the PRM code is moved into
2912 static int _omap4_assert_hardreset(struct omap_hwmod *oh,
2913 struct omap_hwmod_rst_info *ohri)
2918 return omap_prm_assert_hardreset(ohri->rst_shift,
2919 oh->clkdm->pwrdm.ptr->prcm_partition,
2920 oh->clkdm->pwrdm.ptr->prcm_offs,
2921 oh->prcm.omap4.rstctrl_offs);
2925 * _omap4_deassert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
2926 * @oh: struct omap_hwmod * to deassert hardreset
2927 * @ohri: hardreset line data
2929 * Call omap4_prminst_deassert_hardreset() with parameters extracted
2930 * from the hwmod @oh and the hardreset line data @ohri. Only
2931 * intended for use as an soc_ops function pointer. Passes along the
2932 * return value from omap4_prminst_deassert_hardreset(). XXX This
2933 * function is scheduled for removal when the PRM code is moved into
2936 static int _omap4_deassert_hardreset(struct omap_hwmod *oh,
2937 struct omap_hwmod_rst_info *ohri)
2943 pr_err("omap_hwmod: %s: %s: hwmod data error: OMAP4 does not support st_shift\n",
2944 oh->name, ohri->name);
2945 return omap_prm_deassert_hardreset(ohri->rst_shift, ohri->rst_shift,
2946 oh->clkdm->pwrdm.ptr->prcm_partition,
2947 oh->clkdm->pwrdm.ptr->prcm_offs,
2948 oh->prcm.omap4.rstctrl_offs,
2949 oh->prcm.omap4.rstctrl_offs +
2950 OMAP4_RST_CTRL_ST_OFFSET);
2954 * _omap4_is_hardreset_asserted - call OMAP4 PRM hardreset fn with hwmod args
2955 * @oh: struct omap_hwmod * to test hardreset
2956 * @ohri: hardreset line data
2958 * Call omap4_prminst_is_hardreset_asserted() with parameters
2959 * extracted from the hwmod @oh and the hardreset line data @ohri.
2960 * Only intended for use as an soc_ops function pointer. Passes along
2961 * the return value from omap4_prminst_is_hardreset_asserted(). XXX
2962 * This function is scheduled for removal when the PRM code is moved
2965 static int _omap4_is_hardreset_asserted(struct omap_hwmod *oh,
2966 struct omap_hwmod_rst_info *ohri)
2971 return omap_prm_is_hardreset_asserted(ohri->rst_shift,
2972 oh->clkdm->pwrdm.ptr->
2974 oh->clkdm->pwrdm.ptr->prcm_offs,
2975 oh->prcm.omap4.rstctrl_offs);
2979 * _omap4_disable_direct_prcm - disable direct PRCM control for hwmod
2980 * @oh: struct omap_hwmod * to disable control for
2982 * Disables direct PRCM clkctrl done by hwmod core. Instead, the hwmod
2983 * will be using its main_clk to enable/disable the module. Returns
2986 static int _omap4_disable_direct_prcm(struct omap_hwmod *oh)
2991 oh->prcm.omap4.clkctrl_offs = 0;
2992 oh->prcm.omap4.modulemode = 0;
2998 * _am33xx_deassert_hardreset - call AM33XX PRM hardreset fn with hwmod args
2999 * @oh: struct omap_hwmod * to deassert hardreset
3000 * @ohri: hardreset line data
3002 * Call am33xx_prminst_deassert_hardreset() with parameters extracted
3003 * from the hwmod @oh and the hardreset line data @ohri. Only
3004 * intended for use as an soc_ops function pointer. Passes along the
3005 * return value from am33xx_prminst_deassert_hardreset(). XXX This
3006 * function is scheduled for removal when the PRM code is moved into
3009 static int _am33xx_deassert_hardreset(struct omap_hwmod *oh,
3010 struct omap_hwmod_rst_info *ohri)
3012 return omap_prm_deassert_hardreset(ohri->rst_shift, ohri->st_shift,
3013 oh->clkdm->pwrdm.ptr->prcm_partition,
3014 oh->clkdm->pwrdm.ptr->prcm_offs,
3015 oh->prcm.omap4.rstctrl_offs,
3016 oh->prcm.omap4.rstst_offs);
3019 /* Public functions */
3021 u32 omap_hwmod_read(struct omap_hwmod *oh, u16 reg_offs)
3023 if (oh->flags & HWMOD_16BIT_REG)
3024 return readw_relaxed(oh->_mpu_rt_va + reg_offs);
3026 return readl_relaxed(oh->_mpu_rt_va + reg_offs);
3029 void omap_hwmod_write(u32 v, struct omap_hwmod *oh, u16 reg_offs)
3031 if (oh->flags & HWMOD_16BIT_REG)
3032 writew_relaxed(v, oh->_mpu_rt_va + reg_offs);
3034 writel_relaxed(v, oh->_mpu_rt_va + reg_offs);
3038 * omap_hwmod_softreset - reset a module via SYSCONFIG.SOFTRESET bit
3039 * @oh: struct omap_hwmod *
3041 * This is a public function exposed to drivers. Some drivers may need to do
3042 * some settings before and after resetting the device. Those drivers after
3043 * doing the necessary settings could use this function to start a reset by
3044 * setting the SYSCONFIG.SOFTRESET bit.
3046 int omap_hwmod_softreset(struct omap_hwmod *oh)
3051 if (!oh || !(oh->_sysc_cache))
3054 v = oh->_sysc_cache;
3055 ret = _set_softreset(oh, &v);
3058 _write_sysconfig(v, oh);
3060 ret = _clear_softreset(oh, &v);
3063 _write_sysconfig(v, oh);
3070 * omap_hwmod_lookup - look up a registered omap_hwmod by name
3071 * @name: name of the omap_hwmod to look up
3073 * Given a @name of an omap_hwmod, return a pointer to the registered
3074 * struct omap_hwmod *, or NULL upon error.
3076 struct omap_hwmod *omap_hwmod_lookup(const char *name)
3078 struct omap_hwmod *oh;
3089 * omap_hwmod_for_each - call function for each registered omap_hwmod
3090 * @fn: pointer to a callback function
3091 * @data: void * data to pass to callback function
3093 * Call @fn for each registered omap_hwmod, passing @data to each
3094 * function. @fn must return 0 for success or any other value for
3095 * failure. If @fn returns non-zero, the iteration across omap_hwmods
3096 * will stop and the non-zero return value will be passed to the
3097 * caller of omap_hwmod_for_each(). @fn is called with
3098 * omap_hwmod_for_each() held.
3100 int omap_hwmod_for_each(int (*fn)(struct omap_hwmod *oh, void *data),
3103 struct omap_hwmod *temp_oh;
3109 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
3110 ret = (*fn)(temp_oh, data);
3119 * omap_hwmod_register_links - register an array of hwmod links
3120 * @ois: pointer to an array of omap_hwmod_ocp_if to register
3122 * Intended to be called early in boot before the clock framework is
3123 * initialized. If @ois is not null, will register all omap_hwmods
3124 * listed in @ois that are valid for this chip. Returns -EINVAL if
3125 * omap_hwmod_init() hasn't been called before calling this function,
3126 * -ENOMEM if the link memory area can't be allocated, or 0 upon
3129 int __init omap_hwmod_register_links(struct omap_hwmod_ocp_if **ois)
3139 if (ois[0] == NULL) /* Empty list */
3144 r = _register_link(ois[i]);
3145 WARN(r && r != -EEXIST,
3146 "omap_hwmod: _register_link(%s -> %s) returned %d\n",
3147 ois[i]->master->name, ois[i]->slave->name, r);
3154 * _ensure_mpu_hwmod_is_setup - ensure the MPU SS hwmod is init'ed and set up
3155 * @oh: pointer to the hwmod currently being set up (usually not the MPU)
3157 * If the hwmod data corresponding to the MPU subsystem IP block
3158 * hasn't been initialized and set up yet, do so now. This must be
3159 * done first since sleep dependencies may be added from other hwmods
3160 * to the MPU. Intended to be called only by omap_hwmod_setup*(). No
3163 static void __init _ensure_mpu_hwmod_is_setup(struct omap_hwmod *oh)
3165 if (!mpu_oh || mpu_oh->_state == _HWMOD_STATE_UNKNOWN)
3166 pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",
3167 __func__, MPU_INITIATOR_NAME);
3168 else if (mpu_oh->_state == _HWMOD_STATE_REGISTERED && oh != mpu_oh)
3169 omap_hwmod_setup_one(MPU_INITIATOR_NAME);
3173 * omap_hwmod_setup_one - set up a single hwmod
3174 * @oh_name: const char * name of the already-registered hwmod to set up
3176 * Initialize and set up a single hwmod. Intended to be used for a
3177 * small number of early devices, such as the timer IP blocks used for
3178 * the scheduler clock. Must be called after omap2_clk_init().
3179 * Resolves the struct clk names to struct clk pointers for each
3180 * registered omap_hwmod. Also calls _setup() on each hwmod. Returns
3181 * -EINVAL upon error or 0 upon success.
3183 int __init omap_hwmod_setup_one(const char *oh_name)
3185 struct omap_hwmod *oh;
3187 pr_debug("omap_hwmod: %s: %s\n", oh_name, __func__);
3189 oh = _lookup(oh_name);
3191 WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name);
3195 _ensure_mpu_hwmod_is_setup(oh);
3204 * omap_hwmod_setup_earlycon_flags - set up flags for early console
3206 * Enable DEBUG_OMAPUART_FLAGS for uart hwmod that is being used as
3207 * early concole so that hwmod core doesn't reset and keep it in idle
3208 * that specific uart.
3210 #ifdef CONFIG_SERIAL_EARLYCON
3211 static void __init omap_hwmod_setup_earlycon_flags(void)
3213 struct device_node *np;
3214 struct omap_hwmod *oh;
3217 np = of_find_node_by_path("/chosen");
3219 uart = of_get_property(np, "stdout-path", NULL);
3221 np = of_find_node_by_path(uart);
3223 uart = of_get_property(np, "ti,hwmods", NULL);
3224 oh = omap_hwmod_lookup(uart);
3226 oh->flags |= DEBUG_OMAPUART_FLAGS;
3234 * omap_hwmod_setup_all - set up all registered IP blocks
3236 * Initialize and set up all IP blocks registered with the hwmod code.
3237 * Must be called after omap2_clk_init(). Resolves the struct clk
3238 * names to struct clk pointers for each registered omap_hwmod. Also
3239 * calls _setup() on each hwmod. Returns 0 upon success.
3241 static int __init omap_hwmod_setup_all(void)
3243 _ensure_mpu_hwmod_is_setup(NULL);
3245 omap_hwmod_for_each(_init, NULL);
3246 #ifdef CONFIG_SERIAL_EARLYCON
3247 omap_hwmod_setup_earlycon_flags();
3249 omap_hwmod_for_each(_setup, NULL);
3253 omap_postcore_initcall(omap_hwmod_setup_all);
3256 * omap_hwmod_enable - enable an omap_hwmod
3257 * @oh: struct omap_hwmod *
3259 * Enable an omap_hwmod @oh. Intended to be called by omap_device_enable().
3260 * Returns -EINVAL on error or passes along the return value from _enable().
3262 int omap_hwmod_enable(struct omap_hwmod *oh)
3265 unsigned long flags;
3270 spin_lock_irqsave(&oh->_lock, flags);
3272 spin_unlock_irqrestore(&oh->_lock, flags);
3278 * omap_hwmod_idle - idle an omap_hwmod
3279 * @oh: struct omap_hwmod *
3281 * Idle an omap_hwmod @oh. Intended to be called by omap_device_idle().
3282 * Returns -EINVAL on error or passes along the return value from _idle().
3284 int omap_hwmod_idle(struct omap_hwmod *oh)
3287 unsigned long flags;
3292 spin_lock_irqsave(&oh->_lock, flags);
3294 spin_unlock_irqrestore(&oh->_lock, flags);
3300 * omap_hwmod_shutdown - shutdown an omap_hwmod
3301 * @oh: struct omap_hwmod *
3303 * Shutdown an omap_hwmod @oh. Intended to be called by
3304 * omap_device_shutdown(). Returns -EINVAL on error or passes along
3305 * the return value from _shutdown().
3307 int omap_hwmod_shutdown(struct omap_hwmod *oh)
3310 unsigned long flags;
3315 spin_lock_irqsave(&oh->_lock, flags);
3317 spin_unlock_irqrestore(&oh->_lock, flags);
3323 * IP block data retrieval functions
3327 * omap_hwmod_count_resources - count number of struct resources needed by hwmod
3328 * @oh: struct omap_hwmod *
3329 * @flags: Type of resources to include when counting (IRQ/DMA/MEM)
3331 * Count the number of struct resource array elements necessary to
3332 * contain omap_hwmod @oh resources. Intended to be called by code
3333 * that registers omap_devices. Intended to be used to determine the
3334 * size of a dynamically-allocated struct resource array, before
3335 * calling omap_hwmod_fill_resources(). Returns the number of struct
3336 * resource array elements needed.
3338 * XXX This code is not optimized. It could attempt to merge adjacent
3342 int omap_hwmod_count_resources(struct omap_hwmod *oh, unsigned long flags)
3346 if (flags & IORESOURCE_IRQ)
3347 ret += _count_mpu_irqs(oh);
3349 if (flags & IORESOURCE_DMA)
3350 ret += _count_sdma_reqs(oh);
3352 if (flags & IORESOURCE_MEM) {
3353 struct omap_hwmod_ocp_if *os;
3355 list_for_each_entry(os, &oh->slave_ports, node)
3356 ret += _count_ocp_if_addr_spaces(os);
3363 * omap_hwmod_fill_resources - fill struct resource array with hwmod data
3364 * @oh: struct omap_hwmod *
3365 * @res: pointer to the first element of an array of struct resource to fill
3367 * Fill the struct resource array @res with resource data from the
3368 * omap_hwmod @oh. Intended to be called by code that registers
3369 * omap_devices. See also omap_hwmod_count_resources(). Returns the
3370 * number of array elements filled.
3372 int omap_hwmod_fill_resources(struct omap_hwmod *oh, struct resource *res)
3374 struct omap_hwmod_ocp_if *os;
3375 int i, j, mpu_irqs_cnt, sdma_reqs_cnt, addr_cnt;
3378 /* For each IRQ, DMA, memory area, fill in array.*/
3380 mpu_irqs_cnt = _count_mpu_irqs(oh);
3381 for (i = 0; i < mpu_irqs_cnt; i++) {
3385 irq = oh->xlate_irq((oh->mpu_irqs + i)->irq);
3387 irq = (oh->mpu_irqs + i)->irq;
3388 (res + r)->name = (oh->mpu_irqs + i)->name;
3389 (res + r)->start = irq;
3390 (res + r)->end = irq;
3391 (res + r)->flags = IORESOURCE_IRQ;
3395 sdma_reqs_cnt = _count_sdma_reqs(oh);
3396 for (i = 0; i < sdma_reqs_cnt; i++) {
3397 (res + r)->name = (oh->sdma_reqs + i)->name;
3398 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
3399 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
3400 (res + r)->flags = IORESOURCE_DMA;
3404 list_for_each_entry(os, &oh->slave_ports, node) {
3405 addr_cnt = _count_ocp_if_addr_spaces(os);
3407 for (j = 0; j < addr_cnt; j++) {
3408 (res + r)->name = (os->addr + j)->name;
3409 (res + r)->start = (os->addr + j)->pa_start;
3410 (res + r)->end = (os->addr + j)->pa_end;
3411 (res + r)->flags = IORESOURCE_MEM;
3420 * omap_hwmod_fill_dma_resources - fill struct resource array with dma data
3421 * @oh: struct omap_hwmod *
3422 * @res: pointer to the array of struct resource to fill
3424 * Fill the struct resource array @res with dma resource data from the
3425 * omap_hwmod @oh. Intended to be called by code that registers
3426 * omap_devices. See also omap_hwmod_count_resources(). Returns the
3427 * number of array elements filled.
3429 int omap_hwmod_fill_dma_resources(struct omap_hwmod *oh, struct resource *res)
3431 int i, sdma_reqs_cnt;
3434 sdma_reqs_cnt = _count_sdma_reqs(oh);
3435 for (i = 0; i < sdma_reqs_cnt; i++) {
3436 (res + r)->name = (oh->sdma_reqs + i)->name;
3437 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
3438 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
3439 (res + r)->flags = IORESOURCE_DMA;
3447 * omap_hwmod_get_resource_byname - fetch IP block integration data by name
3448 * @oh: struct omap_hwmod * to operate on
3449 * @type: one of the IORESOURCE_* constants from include/linux/ioport.h
3450 * @name: pointer to the name of the data to fetch (optional)
3451 * @rsrc: pointer to a struct resource, allocated by the caller
3453 * Retrieve MPU IRQ, SDMA request line, or address space start/end
3454 * data for the IP block pointed to by @oh. The data will be filled
3455 * into a struct resource record pointed to by @rsrc. The struct
3456 * resource must be allocated by the caller. When @name is non-null,
3457 * the data associated with the matching entry in the IRQ/SDMA/address
3458 * space hwmod data arrays will be returned. If @name is null, the
3459 * first array entry will be returned. Data order is not meaningful
3460 * in hwmod data, so callers are strongly encouraged to use a non-null
3461 * @name whenever possible to avoid unpredictable effects if hwmod
3462 * data is later added that causes data ordering to change. This
3463 * function is only intended for use by OMAP core code. Device
3464 * drivers should not call this function - the appropriate bus-related
3465 * data accessor functions should be used instead. Returns 0 upon
3466 * success or a negative error code upon error.
3468 int omap_hwmod_get_resource_byname(struct omap_hwmod *oh, unsigned int type,
3469 const char *name, struct resource *rsrc)
3472 unsigned int irq, dma;
3473 u32 pa_start, pa_end;
3478 if (type == IORESOURCE_IRQ) {
3479 r = _get_mpu_irq_by_name(oh, name, &irq);
3485 } else if (type == IORESOURCE_DMA) {
3486 r = _get_sdma_req_by_name(oh, name, &dma);
3492 } else if (type == IORESOURCE_MEM) {
3493 r = _get_addr_space_by_name(oh, name, &pa_start, &pa_end);
3497 rsrc->start = pa_start;
3510 * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
3511 * @oh: struct omap_hwmod *
3513 * Return the powerdomain pointer associated with the OMAP module
3514 * @oh's main clock. If @oh does not have a main clk, return the
3515 * powerdomain associated with the interface clock associated with the
3516 * module's MPU port. (XXX Perhaps this should use the SDMA port
3517 * instead?) Returns NULL on error, or a struct powerdomain * on
3520 struct powerdomain *omap_hwmod_get_pwrdm(struct omap_hwmod *oh)
3523 struct omap_hwmod_ocp_if *oi;
3524 struct clockdomain *clkdm;
3525 struct clk_hw_omap *clk;
3531 return oh->clkdm->pwrdm.ptr;
3536 oi = _find_mpu_rt_port(oh);
3542 clk = to_clk_hw_omap(__clk_get_hw(c));
3547 return clkdm->pwrdm.ptr;
3551 * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
3552 * @oh: struct omap_hwmod *
3554 * Returns the virtual address corresponding to the beginning of the
3555 * module's register target, in the address range that is intended to
3556 * be used by the MPU. Returns the virtual address upon success or NULL
3559 void __iomem *omap_hwmod_get_mpu_rt_va(struct omap_hwmod *oh)
3564 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
3567 if (oh->_state == _HWMOD_STATE_UNKNOWN)
3570 return oh->_mpu_rt_va;
3574 * XXX what about functions for drivers to save/restore ocp_sysconfig
3575 * for context save/restore operations?
3579 * omap_hwmod_enable_wakeup - allow device to wake up the system
3580 * @oh: struct omap_hwmod *
3582 * Sets the module OCP socket ENAWAKEUP bit to allow the module to
3583 * send wakeups to the PRCM, and enable I/O ring wakeup events for
3584 * this IP block if it has dynamic mux entries. Eventually this
3585 * should set PRCM wakeup registers to cause the PRCM to receive
3586 * wakeup events from the module. Does not set any wakeup routing
3587 * registers beyond this point - if the module is to wake up any other
3588 * module or subsystem, that must be set separately. Called by
3589 * omap_device code. Returns -EINVAL on error or 0 upon success.
3591 int omap_hwmod_enable_wakeup(struct omap_hwmod *oh)
3593 unsigned long flags;
3596 spin_lock_irqsave(&oh->_lock, flags);
3598 if (oh->class->sysc &&
3599 (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)) {
3600 v = oh->_sysc_cache;
3601 _enable_wakeup(oh, &v);
3602 _write_sysconfig(v, oh);
3605 spin_unlock_irqrestore(&oh->_lock, flags);
3611 * omap_hwmod_disable_wakeup - prevent device from waking the system
3612 * @oh: struct omap_hwmod *
3614 * Clears the module OCP socket ENAWAKEUP bit to prevent the module
3615 * from sending wakeups to the PRCM, and disable I/O ring wakeup
3616 * events for this IP block if it has dynamic mux entries. Eventually
3617 * this should clear PRCM wakeup registers to cause the PRCM to ignore
3618 * wakeup events from the module. Does not set any wakeup routing
3619 * registers beyond this point - if the module is to wake up any other
3620 * module or subsystem, that must be set separately. Called by
3621 * omap_device code. Returns -EINVAL on error or 0 upon success.
3623 int omap_hwmod_disable_wakeup(struct omap_hwmod *oh)
3625 unsigned long flags;
3628 spin_lock_irqsave(&oh->_lock, flags);
3630 if (oh->class->sysc &&
3631 (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)) {
3632 v = oh->_sysc_cache;
3633 _disable_wakeup(oh, &v);
3634 _write_sysconfig(v, oh);
3637 spin_unlock_irqrestore(&oh->_lock, flags);
3643 * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
3644 * contained in the hwmod module.
3645 * @oh: struct omap_hwmod *
3646 * @name: name of the reset line to lookup and assert
3648 * Some IP like dsp, ipu or iva contain processor that require
3649 * an HW reset line to be assert / deassert in order to enable fully
3650 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3651 * yet supported on this OMAP; otherwise, passes along the return value
3652 * from _assert_hardreset().
3654 int omap_hwmod_assert_hardreset(struct omap_hwmod *oh, const char *name)
3657 unsigned long flags;
3662 spin_lock_irqsave(&oh->_lock, flags);
3663 ret = _assert_hardreset(oh, name);
3664 spin_unlock_irqrestore(&oh->_lock, flags);
3670 * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
3671 * contained in the hwmod module.
3672 * @oh: struct omap_hwmod *
3673 * @name: name of the reset line to look up and deassert
3675 * Some IP like dsp, ipu or iva contain processor that require
3676 * an HW reset line to be assert / deassert in order to enable fully
3677 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3678 * yet supported on this OMAP; otherwise, passes along the return value
3679 * from _deassert_hardreset().
3681 int omap_hwmod_deassert_hardreset(struct omap_hwmod *oh, const char *name)
3684 unsigned long flags;
3689 spin_lock_irqsave(&oh->_lock, flags);
3690 ret = _deassert_hardreset(oh, name);
3691 spin_unlock_irqrestore(&oh->_lock, flags);
3697 * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
3698 * @classname: struct omap_hwmod_class name to search for
3699 * @fn: callback function pointer to call for each hwmod in class @classname
3700 * @user: arbitrary context data to pass to the callback function
3702 * For each omap_hwmod of class @classname, call @fn.
3703 * If the callback function returns something other than
3704 * zero, the iterator is terminated, and the callback function's return
3705 * value is passed back to the caller. Returns 0 upon success, -EINVAL
3706 * if @classname or @fn are NULL, or passes back the error code from @fn.
3708 int omap_hwmod_for_each_by_class(const char *classname,
3709 int (*fn)(struct omap_hwmod *oh,
3713 struct omap_hwmod *temp_oh;
3716 if (!classname || !fn)
3719 pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
3720 __func__, classname);
3722 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
3723 if (!strcmp(temp_oh->class->name, classname)) {
3724 pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
3725 __func__, temp_oh->name);
3726 ret = (*fn)(temp_oh, user);
3733 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
3740 * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
3741 * @oh: struct omap_hwmod *
3742 * @state: state that _setup() should leave the hwmod in
3744 * Sets the hwmod state that @oh will enter at the end of _setup()
3745 * (called by omap_hwmod_setup_*()). See also the documentation
3746 * for _setup_postsetup(), above. Returns 0 upon success or
3747 * -EINVAL if there is a problem with the arguments or if the hwmod is
3748 * in the wrong state.
3750 int omap_hwmod_set_postsetup_state(struct omap_hwmod *oh, u8 state)
3753 unsigned long flags;
3758 if (state != _HWMOD_STATE_DISABLED &&
3759 state != _HWMOD_STATE_ENABLED &&
3760 state != _HWMOD_STATE_IDLE)
3763 spin_lock_irqsave(&oh->_lock, flags);
3765 if (oh->_state != _HWMOD_STATE_REGISTERED) {
3770 oh->_postsetup_state = state;
3774 spin_unlock_irqrestore(&oh->_lock, flags);
3780 * omap_hwmod_get_context_loss_count - get lost context count
3781 * @oh: struct omap_hwmod *
3783 * Returns the context loss count of associated @oh
3784 * upon success, or zero if no context loss data is available.
3786 * On OMAP4, this queries the per-hwmod context loss register,
3787 * assuming one exists. If not, or on OMAP2/3, this queries the
3788 * enclosing powerdomain context loss count.
3790 int omap_hwmod_get_context_loss_count(struct omap_hwmod *oh)
3792 struct powerdomain *pwrdm;
3795 if (soc_ops.get_context_lost)
3796 return soc_ops.get_context_lost(oh);
3798 pwrdm = omap_hwmod_get_pwrdm(oh);
3800 ret = pwrdm_get_context_loss_count(pwrdm);
3806 * omap_hwmod_init - initialize the hwmod code
3808 * Sets up some function pointers needed by the hwmod code to operate on the
3809 * currently-booted SoC. Intended to be called once during kernel init
3810 * before any hwmods are registered. No return value.
3812 void __init omap_hwmod_init(void)
3814 if (cpu_is_omap24xx()) {
3815 soc_ops.wait_target_ready = _omap2xxx_3xxx_wait_target_ready;
3816 soc_ops.assert_hardreset = _omap2_assert_hardreset;
3817 soc_ops.deassert_hardreset = _omap2_deassert_hardreset;
3818 soc_ops.is_hardreset_asserted = _omap2_is_hardreset_asserted;
3819 } else if (cpu_is_omap34xx()) {
3820 soc_ops.wait_target_ready = _omap2xxx_3xxx_wait_target_ready;
3821 soc_ops.assert_hardreset = _omap2_assert_hardreset;
3822 soc_ops.deassert_hardreset = _omap2_deassert_hardreset;
3823 soc_ops.is_hardreset_asserted = _omap2_is_hardreset_asserted;
3824 soc_ops.init_clkdm = _init_clkdm;
3825 } else if (cpu_is_omap44xx() || soc_is_omap54xx() || soc_is_dra7xx()) {
3826 soc_ops.enable_module = _omap4_enable_module;
3827 soc_ops.disable_module = _omap4_disable_module;
3828 soc_ops.wait_target_ready = _omap4_wait_target_ready;
3829 soc_ops.assert_hardreset = _omap4_assert_hardreset;
3830 soc_ops.deassert_hardreset = _omap4_deassert_hardreset;
3831 soc_ops.is_hardreset_asserted = _omap4_is_hardreset_asserted;
3832 soc_ops.init_clkdm = _init_clkdm;
3833 soc_ops.update_context_lost = _omap4_update_context_lost;
3834 soc_ops.get_context_lost = _omap4_get_context_lost;
3835 soc_ops.disable_direct_prcm = _omap4_disable_direct_prcm;
3836 soc_ops.xlate_clkctrl = _omap4_xlate_clkctrl;
3837 } else if (cpu_is_ti814x() || cpu_is_ti816x() || soc_is_am33xx() ||
3839 soc_ops.enable_module = _omap4_enable_module;
3840 soc_ops.disable_module = _omap4_disable_module;
3841 soc_ops.wait_target_ready = _omap4_wait_target_ready;
3842 soc_ops.assert_hardreset = _omap4_assert_hardreset;
3843 soc_ops.deassert_hardreset = _am33xx_deassert_hardreset;
3844 soc_ops.is_hardreset_asserted = _omap4_is_hardreset_asserted;
3845 soc_ops.init_clkdm = _init_clkdm;
3846 soc_ops.disable_direct_prcm = _omap4_disable_direct_prcm;
3848 WARN(1, "omap_hwmod: unknown SoC type\n");
3851 _init_clkctrl_providers();
3857 * omap_hwmod_get_main_clk - get pointer to main clock name
3858 * @oh: struct omap_hwmod *
3860 * Returns the main clock name assocated with @oh upon success,
3861 * or NULL if @oh is NULL.
3863 const char *omap_hwmod_get_main_clk(struct omap_hwmod *oh)
3868 return oh->main_clk;