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 * @size: size of the provider address space
189 * @offset: offset of the provider from PRCM instance base
190 * @node: device node associated with the provider
193 struct clkctrl_provider {
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);
229 /* soc_ops: adapts the omap_hwmod code to the currently-booted SoC */
230 static struct omap_hwmod_soc_ops soc_ops;
232 /* omap_hwmod_list contains all registered struct omap_hwmods */
233 static LIST_HEAD(omap_hwmod_list);
235 /* mpu_oh: used to add/remove MPU initiator from sleepdep list */
236 static struct omap_hwmod *mpu_oh;
238 /* inited: set to true once the hwmod code is initialized */
241 /* Private functions */
244 * _update_sysc_cache - return the module OCP_SYSCONFIG register, keep copy
245 * @oh: struct omap_hwmod *
247 * Load the current value of the hwmod OCP_SYSCONFIG register into the
248 * struct omap_hwmod for later use. Returns -EINVAL if the hwmod has no
249 * OCP_SYSCONFIG register or 0 upon success.
251 static int _update_sysc_cache(struct omap_hwmod *oh)
253 if (!oh->class->sysc) {
254 WARN(1, "omap_hwmod: %s: cannot read OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
258 /* XXX ensure module interface clock is up */
260 oh->_sysc_cache = omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
262 if (!(oh->class->sysc->sysc_flags & SYSC_NO_CACHE))
263 oh->_int_flags |= _HWMOD_SYSCONFIG_LOADED;
269 * _write_sysconfig - write a value to the module's OCP_SYSCONFIG register
270 * @v: OCP_SYSCONFIG value to write
271 * @oh: struct omap_hwmod *
273 * Write @v into the module class' OCP_SYSCONFIG register, if it has
274 * one. No return value.
276 static void _write_sysconfig(u32 v, struct omap_hwmod *oh)
278 if (!oh->class->sysc) {
279 WARN(1, "omap_hwmod: %s: cannot write OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
283 /* XXX ensure module interface clock is up */
285 /* Module might have lost context, always update cache and register */
289 * Some IP blocks (such as RTC) require unlocking of IP before
290 * accessing its registers. If a function pointer is present
291 * to unlock, then call it before accessing sysconfig and
292 * call lock after writing sysconfig.
294 if (oh->class->unlock)
295 oh->class->unlock(oh);
297 omap_hwmod_write(v, oh, oh->class->sysc->sysc_offs);
304 * _set_master_standbymode: set the OCP_SYSCONFIG MIDLEMODE field in @v
305 * @oh: struct omap_hwmod *
306 * @standbymode: MIDLEMODE field bits
307 * @v: pointer to register contents to modify
309 * Update the master standby mode bits in @v to be @standbymode for
310 * the @oh hwmod. Does not write to the hardware. Returns -EINVAL
311 * upon error or 0 upon success.
313 static int _set_master_standbymode(struct omap_hwmod *oh, u8 standbymode,
319 if (!oh->class->sysc ||
320 !(oh->class->sysc->sysc_flags & SYSC_HAS_MIDLEMODE))
323 if (!oh->class->sysc->sysc_fields) {
324 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
328 mstandby_shift = oh->class->sysc->sysc_fields->midle_shift;
329 mstandby_mask = (0x3 << mstandby_shift);
331 *v &= ~mstandby_mask;
332 *v |= __ffs(standbymode) << mstandby_shift;
338 * _set_slave_idlemode: set the OCP_SYSCONFIG SIDLEMODE field in @v
339 * @oh: struct omap_hwmod *
340 * @idlemode: SIDLEMODE field bits
341 * @v: pointer to register contents to modify
343 * Update the slave idle mode bits in @v to be @idlemode for the @oh
344 * hwmod. Does not write to the hardware. Returns -EINVAL upon error
347 static int _set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode, u32 *v)
352 if (!oh->class->sysc ||
353 !(oh->class->sysc->sysc_flags & SYSC_HAS_SIDLEMODE))
356 if (!oh->class->sysc->sysc_fields) {
357 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
361 sidle_shift = oh->class->sysc->sysc_fields->sidle_shift;
362 sidle_mask = (0x3 << sidle_shift);
365 *v |= __ffs(idlemode) << sidle_shift;
371 * _set_clockactivity: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
372 * @oh: struct omap_hwmod *
373 * @clockact: CLOCKACTIVITY field bits
374 * @v: pointer to register contents to modify
376 * Update the clockactivity mode bits in @v to be @clockact for the
377 * @oh hwmod. Used for additional powersaving on some modules. Does
378 * not write to the hardware. Returns -EINVAL upon error or 0 upon
381 static int _set_clockactivity(struct omap_hwmod *oh, u8 clockact, u32 *v)
386 if (!oh->class->sysc ||
387 !(oh->class->sysc->sysc_flags & SYSC_HAS_CLOCKACTIVITY))
390 if (!oh->class->sysc->sysc_fields) {
391 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
395 clkact_shift = oh->class->sysc->sysc_fields->clkact_shift;
396 clkact_mask = (0x3 << clkact_shift);
399 *v |= clockact << clkact_shift;
405 * _set_softreset: set OCP_SYSCONFIG.SOFTRESET bit in @v
406 * @oh: struct omap_hwmod *
407 * @v: pointer to register contents to modify
409 * Set the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
410 * error or 0 upon success.
412 static int _set_softreset(struct omap_hwmod *oh, u32 *v)
416 if (!oh->class->sysc ||
417 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
420 if (!oh->class->sysc->sysc_fields) {
421 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
425 softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
433 * _clear_softreset: clear OCP_SYSCONFIG.SOFTRESET bit in @v
434 * @oh: struct omap_hwmod *
435 * @v: pointer to register contents to modify
437 * Clear the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
438 * error or 0 upon success.
440 static int _clear_softreset(struct omap_hwmod *oh, u32 *v)
444 if (!oh->class->sysc ||
445 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
448 if (!oh->class->sysc->sysc_fields) {
450 "omap_hwmod: %s: sysc_fields absent for sysconfig class\n",
455 softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
463 * _wait_softreset_complete - wait for an OCP softreset to complete
464 * @oh: struct omap_hwmod * to wait on
466 * Wait until the IP block represented by @oh reports that its OCP
467 * softreset is complete. This can be triggered by software (see
468 * _ocp_softreset()) or by hardware upon returning from off-mode (one
469 * example is HSMMC). Waits for up to MAX_MODULE_SOFTRESET_WAIT
470 * microseconds. Returns the number of microseconds waited.
472 static int _wait_softreset_complete(struct omap_hwmod *oh)
474 struct omap_hwmod_class_sysconfig *sysc;
478 sysc = oh->class->sysc;
480 if (sysc->sysc_flags & SYSS_HAS_RESET_STATUS)
481 omap_test_timeout((omap_hwmod_read(oh, sysc->syss_offs)
482 & SYSS_RESETDONE_MASK),
483 MAX_MODULE_SOFTRESET_WAIT, c);
484 else if (sysc->sysc_flags & SYSC_HAS_RESET_STATUS) {
485 softrst_mask = (0x1 << sysc->sysc_fields->srst_shift);
486 omap_test_timeout(!(omap_hwmod_read(oh, sysc->sysc_offs)
488 MAX_MODULE_SOFTRESET_WAIT, c);
495 * _set_dmadisable: set OCP_SYSCONFIG.DMADISABLE bit in @v
496 * @oh: struct omap_hwmod *
498 * The DMADISABLE bit is a semi-automatic bit present in sysconfig register
499 * of some modules. When the DMA must perform read/write accesses, the
500 * DMADISABLE bit is cleared by the hardware. But when the DMA must stop
501 * for power management, software must set the DMADISABLE bit back to 1.
503 * Set the DMADISABLE bit in @v for hwmod @oh. Returns -EINVAL upon
504 * error or 0 upon success.
506 static int _set_dmadisable(struct omap_hwmod *oh)
511 if (!oh->class->sysc ||
512 !(oh->class->sysc->sysc_flags & SYSC_HAS_DMADISABLE))
515 if (!oh->class->sysc->sysc_fields) {
516 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
520 /* clocks must be on for this operation */
521 if (oh->_state != _HWMOD_STATE_ENABLED) {
522 pr_warn("omap_hwmod: %s: dma can be disabled only from enabled state\n", oh->name);
526 pr_debug("omap_hwmod: %s: setting DMADISABLE\n", oh->name);
530 (0x1 << oh->class->sysc->sysc_fields->dmadisable_shift);
531 v |= dmadisable_mask;
532 _write_sysconfig(v, oh);
538 * _set_module_autoidle: set the OCP_SYSCONFIG AUTOIDLE field in @v
539 * @oh: struct omap_hwmod *
540 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
541 * @v: pointer to register contents to modify
543 * Update the module autoidle bit in @v to be @autoidle for the @oh
544 * hwmod. The autoidle bit controls whether the module can gate
545 * internal clocks automatically when it isn't doing anything; the
546 * exact function of this bit varies on a per-module basis. This
547 * function does not write to the hardware. Returns -EINVAL upon
548 * error or 0 upon success.
550 static int _set_module_autoidle(struct omap_hwmod *oh, u8 autoidle,
556 if (!oh->class->sysc ||
557 !(oh->class->sysc->sysc_flags & SYSC_HAS_AUTOIDLE))
560 if (!oh->class->sysc->sysc_fields) {
561 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
565 autoidle_shift = oh->class->sysc->sysc_fields->autoidle_shift;
566 autoidle_mask = (0x1 << autoidle_shift);
568 *v &= ~autoidle_mask;
569 *v |= autoidle << autoidle_shift;
575 * _enable_wakeup: set OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
576 * @oh: struct omap_hwmod *
578 * Allow the hardware module @oh to send wakeups. Returns -EINVAL
579 * upon error or 0 upon success.
581 static int _enable_wakeup(struct omap_hwmod *oh, u32 *v)
583 if (!oh->class->sysc ||
584 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
585 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
586 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
589 if (!oh->class->sysc->sysc_fields) {
590 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
594 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
595 *v |= 0x1 << oh->class->sysc->sysc_fields->enwkup_shift;
597 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
598 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
599 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
600 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
602 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
608 * _disable_wakeup: clear OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
609 * @oh: struct omap_hwmod *
611 * Prevent the hardware module @oh to send wakeups. Returns -EINVAL
612 * upon error or 0 upon success.
614 static int _disable_wakeup(struct omap_hwmod *oh, u32 *v)
616 if (!oh->class->sysc ||
617 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
618 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
619 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
622 if (!oh->class->sysc->sysc_fields) {
623 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
627 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
628 *v &= ~(0x1 << oh->class->sysc->sysc_fields->enwkup_shift);
630 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
631 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART, v);
632 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
633 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART, v);
635 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
640 static struct clockdomain *_get_clkdm(struct omap_hwmod *oh)
642 struct clk_hw_omap *clk;
646 } else if (oh->_clk) {
647 if (__clk_get_flags(oh->_clk) & CLK_IS_BASIC)
649 clk = to_clk_hw_omap(__clk_get_hw(oh->_clk));
656 * _add_initiator_dep: prevent @oh from smart-idling while @init_oh is active
657 * @oh: struct omap_hwmod *
659 * Prevent the hardware module @oh from entering idle while the
660 * hardare module initiator @init_oh is active. Useful when a module
661 * will be accessed by a particular initiator (e.g., if a module will
662 * be accessed by the IVA, there should be a sleepdep between the IVA
663 * initiator and the module). Only applies to modules in smart-idle
664 * mode. If the clockdomain is marked as not needing autodeps, return
665 * 0 without doing anything. Otherwise, returns -EINVAL upon error or
666 * passes along clkdm_add_sleepdep() value upon success.
668 static int _add_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
670 struct clockdomain *clkdm, *init_clkdm;
672 clkdm = _get_clkdm(oh);
673 init_clkdm = _get_clkdm(init_oh);
675 if (!clkdm || !init_clkdm)
678 if (clkdm && clkdm->flags & CLKDM_NO_AUTODEPS)
681 return clkdm_add_sleepdep(clkdm, init_clkdm);
685 * _del_initiator_dep: allow @oh to smart-idle even if @init_oh is active
686 * @oh: struct omap_hwmod *
688 * Allow the hardware module @oh to enter idle while the hardare
689 * module initiator @init_oh is active. Useful when a module will not
690 * be accessed by a particular initiator (e.g., if a module will not
691 * be accessed by the IVA, there should be no sleepdep between the IVA
692 * initiator and the module). Only applies to modules in smart-idle
693 * mode. If the clockdomain is marked as not needing autodeps, return
694 * 0 without doing anything. Returns -EINVAL upon error or passes
695 * along clkdm_del_sleepdep() value upon success.
697 static int _del_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
699 struct clockdomain *clkdm, *init_clkdm;
701 clkdm = _get_clkdm(oh);
702 init_clkdm = _get_clkdm(init_oh);
704 if (!clkdm || !init_clkdm)
707 if (clkdm && clkdm->flags & CLKDM_NO_AUTODEPS)
710 return clkdm_del_sleepdep(clkdm, init_clkdm);
713 static const struct of_device_id ti_clkctrl_match_table[] __initconst = {
714 { .compatible = "ti,clkctrl" },
718 static int _setup_clkctrl_provider(struct device_node *np)
721 struct clkctrl_provider *provider;
724 provider = memblock_virt_alloc(sizeof(*provider), 0);
728 addrp = of_get_address(np, 0, &size, NULL);
729 provider->addr = (u32)of_translate_address(np, addrp);
730 addrp = of_get_address(np->parent, 0, NULL, NULL);
731 provider->offset = provider->addr -
732 (u32)of_translate_address(np->parent, addrp);
733 provider->addr &= ~0xff;
734 provider->size = size | 0xff;
737 pr_debug("%s: %s: %x...%x [+%x]\n", __func__, np->parent->name,
738 provider->addr, provider->addr + provider->size,
741 list_add(&provider->link, &clkctrl_providers);
746 static int _init_clkctrl_providers(void)
748 struct device_node *np;
751 for_each_matching_node(np, ti_clkctrl_match_table) {
752 ret = _setup_clkctrl_provider(np);
760 static u32 _omap4_xlate_clkctrl(struct omap_hwmod *oh)
762 if (!oh->prcm.omap4.modulemode)
765 return omap_cm_xlate_clkctrl(oh->clkdm->prcm_partition,
767 oh->prcm.omap4.clkctrl_offs);
770 static struct clk *_lookup_clkctrl_clk(struct omap_hwmod *oh)
772 struct clkctrl_provider *provider;
776 if (!soc_ops.xlate_clkctrl)
779 addr = soc_ops.xlate_clkctrl(oh);
783 pr_debug("%s: %s: addr=%x\n", __func__, oh->name, addr);
785 list_for_each_entry(provider, &clkctrl_providers, link) {
786 if (provider->addr <= addr &&
787 provider->addr + provider->size >= addr) {
788 struct of_phandle_args clkspec;
790 clkspec.np = provider->node;
791 clkspec.args_count = 2;
792 clkspec.args[0] = addr - provider->addr -
796 clk = of_clk_get_from_provider(&clkspec);
798 pr_debug("%s: %s got %p (offset=%x, provider=%s)\n",
799 __func__, oh->name, clk, clkspec.args[0],
800 provider->node->parent->name);
810 * _init_main_clk - get a struct clk * for the the hwmod's main functional clk
811 * @oh: struct omap_hwmod *
813 * Called from _init_clocks(). Populates the @oh _clk (main
814 * functional clock pointer) if a clock matching the hwmod name is found,
815 * or a main_clk is present. Returns 0 on success or -EINVAL on error.
817 static int _init_main_clk(struct omap_hwmod *oh)
820 struct clk *clk = NULL;
822 clk = _lookup_clkctrl_clk(oh);
824 if (!IS_ERR_OR_NULL(clk)) {
825 pr_debug("%s: mapped main_clk %s for %s\n", __func__,
826 __clk_get_name(clk), oh->name);
827 oh->main_clk = __clk_get_name(clk);
829 soc_ops.disable_direct_prcm(oh);
834 oh->_clk = clk_get(NULL, oh->main_clk);
837 if (IS_ERR(oh->_clk)) {
838 pr_warn("omap_hwmod: %s: cannot clk_get main_clk %s\n",
839 oh->name, oh->main_clk);
843 * HACK: This needs a re-visit once clk_prepare() is implemented
844 * to do something meaningful. Today its just a no-op.
845 * If clk_prepare() is used at some point to do things like
846 * voltage scaling etc, then this would have to be moved to
847 * some point where subsystems like i2c and pmic become
850 clk_prepare(oh->_clk);
853 pr_debug("omap_hwmod: %s: missing clockdomain for %s.\n",
854 oh->name, oh->main_clk);
860 * _init_interface_clks - get a struct clk * for the the hwmod's interface clks
861 * @oh: struct omap_hwmod *
863 * Called from _init_clocks(). Populates the @oh OCP slave interface
864 * clock pointers. Returns 0 on success or -EINVAL on error.
866 static int _init_interface_clks(struct omap_hwmod *oh)
868 struct omap_hwmod_ocp_if *os;
872 list_for_each_entry(os, &oh->slave_ports, node) {
876 c = clk_get(NULL, os->clk);
878 pr_warn("omap_hwmod: %s: cannot clk_get interface_clk %s\n",
885 * HACK: This needs a re-visit once clk_prepare() is implemented
886 * to do something meaningful. Today its just a no-op.
887 * If clk_prepare() is used at some point to do things like
888 * voltage scaling etc, then this would have to be moved to
889 * some point where subsystems like i2c and pmic become
892 clk_prepare(os->_clk);
899 * _init_opt_clk - get a struct clk * for the the hwmod's optional clocks
900 * @oh: struct omap_hwmod *
902 * Called from _init_clocks(). Populates the @oh omap_hwmod_opt_clk
903 * clock pointers. Returns 0 on success or -EINVAL on error.
905 static int _init_opt_clks(struct omap_hwmod *oh)
907 struct omap_hwmod_opt_clk *oc;
912 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++) {
913 c = clk_get(NULL, oc->clk);
915 pr_warn("omap_hwmod: %s: cannot clk_get opt_clk %s\n",
922 * HACK: This needs a re-visit once clk_prepare() is implemented
923 * to do something meaningful. Today its just a no-op.
924 * If clk_prepare() is used at some point to do things like
925 * voltage scaling etc, then this would have to be moved to
926 * some point where subsystems like i2c and pmic become
929 clk_prepare(oc->_clk);
935 static void _enable_optional_clocks(struct omap_hwmod *oh)
937 struct omap_hwmod_opt_clk *oc;
940 pr_debug("omap_hwmod: %s: enabling optional clocks\n", oh->name);
942 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
944 pr_debug("omap_hwmod: enable %s:%s\n", oc->role,
945 __clk_get_name(oc->_clk));
946 clk_enable(oc->_clk);
950 static void _disable_optional_clocks(struct omap_hwmod *oh)
952 struct omap_hwmod_opt_clk *oc;
955 pr_debug("omap_hwmod: %s: disabling optional clocks\n", oh->name);
957 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
959 pr_debug("omap_hwmod: disable %s:%s\n", oc->role,
960 __clk_get_name(oc->_clk));
961 clk_disable(oc->_clk);
966 * _enable_clocks - enable hwmod main clock and interface clocks
967 * @oh: struct omap_hwmod *
969 * Enables all clocks necessary for register reads and writes to succeed
970 * on the hwmod @oh. Returns 0.
972 static int _enable_clocks(struct omap_hwmod *oh)
974 struct omap_hwmod_ocp_if *os;
976 pr_debug("omap_hwmod: %s: enabling clocks\n", oh->name);
979 clk_enable(oh->_clk);
981 list_for_each_entry(os, &oh->slave_ports, node) {
982 if (os->_clk && (os->flags & OCPIF_SWSUP_IDLE))
983 clk_enable(os->_clk);
986 if (oh->flags & HWMOD_OPT_CLKS_NEEDED)
987 _enable_optional_clocks(oh);
989 /* The opt clocks are controlled by the device driver. */
995 * _omap4_clkctrl_managed_by_clkfwk - true if clkctrl managed by clock framework
996 * @oh: struct omap_hwmod *
998 static bool _omap4_clkctrl_managed_by_clkfwk(struct omap_hwmod *oh)
1000 if (oh->prcm.omap4.flags & HWMOD_OMAP4_CLKFWK_CLKCTR_CLOCK)
1007 * _omap4_has_clkctrl_clock - returns true if a module has clkctrl clock
1008 * @oh: struct omap_hwmod *
1010 static bool _omap4_has_clkctrl_clock(struct omap_hwmod *oh)
1012 if (oh->prcm.omap4.clkctrl_offs)
1015 if (!oh->prcm.omap4.clkctrl_offs &&
1016 oh->prcm.omap4.flags & HWMOD_OMAP4_ZERO_CLKCTRL_OFFSET)
1023 * _disable_clocks - disable hwmod main clock and interface clocks
1024 * @oh: struct omap_hwmod *
1026 * Disables the hwmod @oh main functional and interface clocks. Returns 0.
1028 static int _disable_clocks(struct omap_hwmod *oh)
1030 struct omap_hwmod_ocp_if *os;
1032 pr_debug("omap_hwmod: %s: disabling clocks\n", oh->name);
1035 clk_disable(oh->_clk);
1037 list_for_each_entry(os, &oh->slave_ports, node) {
1038 if (os->_clk && (os->flags & OCPIF_SWSUP_IDLE))
1039 clk_disable(os->_clk);
1042 if (oh->flags & HWMOD_OPT_CLKS_NEEDED)
1043 _disable_optional_clocks(oh);
1045 /* The opt clocks are controlled by the device driver. */
1051 * _omap4_enable_module - enable CLKCTRL modulemode on OMAP4
1052 * @oh: struct omap_hwmod *
1054 * Enables the PRCM module mode related to the hwmod @oh.
1057 static void _omap4_enable_module(struct omap_hwmod *oh)
1059 if (!oh->clkdm || !oh->prcm.omap4.modulemode ||
1060 _omap4_clkctrl_managed_by_clkfwk(oh))
1063 pr_debug("omap_hwmod: %s: %s: %d\n",
1064 oh->name, __func__, oh->prcm.omap4.modulemode);
1066 omap_cm_module_enable(oh->prcm.omap4.modulemode,
1067 oh->clkdm->prcm_partition,
1068 oh->clkdm->cm_inst, oh->prcm.omap4.clkctrl_offs);
1072 * _omap4_wait_target_disable - wait for a module to be disabled on OMAP4
1073 * @oh: struct omap_hwmod *
1075 * Wait for a module @oh to enter slave idle. Returns 0 if the module
1076 * does not have an IDLEST bit or if the module successfully enters
1077 * slave idle; otherwise, pass along the return value of the
1078 * appropriate *_cm*_wait_module_idle() function.
1080 static int _omap4_wait_target_disable(struct omap_hwmod *oh)
1085 if (oh->_int_flags & _HWMOD_NO_MPU_PORT || !oh->clkdm)
1088 if (oh->flags & HWMOD_NO_IDLEST)
1091 if (_omap4_clkctrl_managed_by_clkfwk(oh))
1094 if (!_omap4_has_clkctrl_clock(oh))
1097 return omap_cm_wait_module_idle(oh->clkdm->prcm_partition,
1099 oh->prcm.omap4.clkctrl_offs, 0);
1103 * _save_mpu_port_index - find and save the index to @oh's MPU port
1104 * @oh: struct omap_hwmod *
1106 * Determines the array index of the OCP slave port that the MPU uses
1107 * to address the device, and saves it into the struct omap_hwmod.
1108 * Intended to be called during hwmod registration only. No return
1111 static void __init _save_mpu_port_index(struct omap_hwmod *oh)
1113 struct omap_hwmod_ocp_if *os = NULL;
1118 oh->_int_flags |= _HWMOD_NO_MPU_PORT;
1120 list_for_each_entry(os, &oh->slave_ports, node) {
1121 if (os->user & OCP_USER_MPU) {
1123 oh->_int_flags &= ~_HWMOD_NO_MPU_PORT;
1132 * _find_mpu_rt_port - return omap_hwmod_ocp_if accessible by the MPU
1133 * @oh: struct omap_hwmod *
1135 * Given a pointer to a struct omap_hwmod record @oh, return a pointer
1136 * to the struct omap_hwmod_ocp_if record that is used by the MPU to
1137 * communicate with the IP block. This interface need not be directly
1138 * connected to the MPU (and almost certainly is not), but is directly
1139 * connected to the IP block represented by @oh. Returns a pointer
1140 * to the struct omap_hwmod_ocp_if * upon success, or returns NULL upon
1141 * error or if there does not appear to be a path from the MPU to this
1144 static struct omap_hwmod_ocp_if *_find_mpu_rt_port(struct omap_hwmod *oh)
1146 if (!oh || oh->_int_flags & _HWMOD_NO_MPU_PORT || oh->slaves_cnt == 0)
1149 return oh->_mpu_port;
1153 * _enable_sysc - try to bring a module out of idle via OCP_SYSCONFIG
1154 * @oh: struct omap_hwmod *
1156 * Ensure that the OCP_SYSCONFIG register for the IP block represented
1157 * by @oh is set to indicate to the PRCM that the IP block is active.
1158 * Usually this means placing the module into smart-idle mode and
1159 * smart-standby, but if there is a bug in the automatic idle handling
1160 * for the IP block, it may need to be placed into the force-idle or
1161 * no-idle variants of these modes. No return value.
1163 static void _enable_sysc(struct omap_hwmod *oh)
1168 struct clockdomain *clkdm;
1170 if (!oh->class->sysc)
1174 * Wait until reset has completed, this is needed as the IP
1175 * block is reset automatically by hardware in some cases
1176 * (off-mode for example), and the drivers require the
1177 * IP to be ready when they access it
1179 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1180 _enable_optional_clocks(oh);
1181 _wait_softreset_complete(oh);
1182 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1183 _disable_optional_clocks(oh);
1185 v = oh->_sysc_cache;
1186 sf = oh->class->sysc->sysc_flags;
1188 clkdm = _get_clkdm(oh);
1189 if (sf & SYSC_HAS_SIDLEMODE) {
1190 if (oh->flags & HWMOD_SWSUP_SIDLE ||
1191 oh->flags & HWMOD_SWSUP_SIDLE_ACT) {
1192 idlemode = HWMOD_IDLEMODE_NO;
1194 if (sf & SYSC_HAS_ENAWAKEUP)
1195 _enable_wakeup(oh, &v);
1196 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
1197 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1199 idlemode = HWMOD_IDLEMODE_SMART;
1203 * This is special handling for some IPs like
1204 * 32k sync timer. Force them to idle!
1206 clkdm_act = (clkdm && clkdm->flags & CLKDM_ACTIVE_WITH_MPU);
1207 if (clkdm_act && !(oh->class->sysc->idlemodes &
1208 (SIDLE_SMART | SIDLE_SMART_WKUP)))
1209 idlemode = HWMOD_IDLEMODE_FORCE;
1211 _set_slave_idlemode(oh, idlemode, &v);
1214 if (sf & SYSC_HAS_MIDLEMODE) {
1215 if (oh->flags & HWMOD_FORCE_MSTANDBY) {
1216 idlemode = HWMOD_IDLEMODE_FORCE;
1217 } else if (oh->flags & HWMOD_SWSUP_MSTANDBY) {
1218 idlemode = HWMOD_IDLEMODE_NO;
1220 if (sf & SYSC_HAS_ENAWAKEUP)
1221 _enable_wakeup(oh, &v);
1222 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1223 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1225 idlemode = HWMOD_IDLEMODE_SMART;
1227 _set_master_standbymode(oh, idlemode, &v);
1231 * XXX The clock framework should handle this, by
1232 * calling into this code. But this must wait until the
1233 * clock structures are tagged with omap_hwmod entries
1235 if ((oh->flags & HWMOD_SET_DEFAULT_CLOCKACT) &&
1236 (sf & SYSC_HAS_CLOCKACTIVITY))
1237 _set_clockactivity(oh, CLOCKACT_TEST_ICLK, &v);
1239 _write_sysconfig(v, oh);
1242 * Set the autoidle bit only after setting the smartidle bit
1243 * Setting this will not have any impact on the other modules.
1245 if (sf & SYSC_HAS_AUTOIDLE) {
1246 idlemode = (oh->flags & HWMOD_NO_OCP_AUTOIDLE) ?
1248 _set_module_autoidle(oh, idlemode, &v);
1249 _write_sysconfig(v, oh);
1254 * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
1255 * @oh: struct omap_hwmod *
1257 * If module is marked as SWSUP_SIDLE, force the module into slave
1258 * idle; otherwise, configure it for smart-idle. If module is marked
1259 * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
1260 * configure it for smart-standby. No return value.
1262 static void _idle_sysc(struct omap_hwmod *oh)
1267 if (!oh->class->sysc)
1270 v = oh->_sysc_cache;
1271 sf = oh->class->sysc->sysc_flags;
1273 if (sf & SYSC_HAS_SIDLEMODE) {
1274 if (oh->flags & HWMOD_SWSUP_SIDLE) {
1275 idlemode = HWMOD_IDLEMODE_FORCE;
1277 if (sf & SYSC_HAS_ENAWAKEUP)
1278 _enable_wakeup(oh, &v);
1279 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
1280 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1282 idlemode = HWMOD_IDLEMODE_SMART;
1284 _set_slave_idlemode(oh, idlemode, &v);
1287 if (sf & SYSC_HAS_MIDLEMODE) {
1288 if ((oh->flags & HWMOD_SWSUP_MSTANDBY) ||
1289 (oh->flags & HWMOD_FORCE_MSTANDBY)) {
1290 idlemode = HWMOD_IDLEMODE_FORCE;
1292 if (sf & SYSC_HAS_ENAWAKEUP)
1293 _enable_wakeup(oh, &v);
1294 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1295 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1297 idlemode = HWMOD_IDLEMODE_SMART;
1299 _set_master_standbymode(oh, idlemode, &v);
1302 /* If the cached value is the same as the new value, skip the write */
1303 if (oh->_sysc_cache != v)
1304 _write_sysconfig(v, oh);
1308 * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
1309 * @oh: struct omap_hwmod *
1311 * Force the module into slave idle and master suspend. No return
1314 static void _shutdown_sysc(struct omap_hwmod *oh)
1319 if (!oh->class->sysc)
1322 v = oh->_sysc_cache;
1323 sf = oh->class->sysc->sysc_flags;
1325 if (sf & SYSC_HAS_SIDLEMODE)
1326 _set_slave_idlemode(oh, HWMOD_IDLEMODE_FORCE, &v);
1328 if (sf & SYSC_HAS_MIDLEMODE)
1329 _set_master_standbymode(oh, HWMOD_IDLEMODE_FORCE, &v);
1331 if (sf & SYSC_HAS_AUTOIDLE)
1332 _set_module_autoidle(oh, 1, &v);
1334 _write_sysconfig(v, oh);
1338 * _lookup - find an omap_hwmod by name
1339 * @name: find an omap_hwmod by name
1341 * Return a pointer to an omap_hwmod by name, or NULL if not found.
1343 static struct omap_hwmod *_lookup(const char *name)
1345 struct omap_hwmod *oh, *temp_oh;
1349 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1350 if (!strcmp(name, temp_oh->name)) {
1360 * _init_clkdm - look up a clockdomain name, store pointer in omap_hwmod
1361 * @oh: struct omap_hwmod *
1363 * Convert a clockdomain name stored in a struct omap_hwmod into a
1364 * clockdomain pointer, and save it into the struct omap_hwmod.
1365 * Return -EINVAL if the clkdm_name lookup failed.
1367 static int _init_clkdm(struct omap_hwmod *oh)
1369 if (!oh->clkdm_name) {
1370 pr_debug("omap_hwmod: %s: missing clockdomain\n", oh->name);
1374 oh->clkdm = clkdm_lookup(oh->clkdm_name);
1376 pr_warn("omap_hwmod: %s: could not associate to clkdm %s\n",
1377 oh->name, oh->clkdm_name);
1381 pr_debug("omap_hwmod: %s: associated to clkdm %s\n",
1382 oh->name, oh->clkdm_name);
1388 * _init_clocks - clk_get() all clocks associated with this hwmod. Retrieve as
1389 * well the clockdomain.
1390 * @oh: struct omap_hwmod *
1391 * @np: device_node mapped to this hwmod
1393 * Called by omap_hwmod_setup_*() (after omap2_clk_init()).
1394 * Resolves all clock names embedded in the hwmod. Returns 0 on
1395 * success, or a negative error code on failure.
1397 static int _init_clocks(struct omap_hwmod *oh, struct device_node *np)
1401 if (oh->_state != _HWMOD_STATE_REGISTERED)
1404 pr_debug("omap_hwmod: %s: looking up clocks\n", oh->name);
1406 if (soc_ops.init_clkdm)
1407 ret |= soc_ops.init_clkdm(oh);
1409 ret |= _init_main_clk(oh);
1410 ret |= _init_interface_clks(oh);
1411 ret |= _init_opt_clks(oh);
1414 oh->_state = _HWMOD_STATE_CLKS_INITED;
1416 pr_warn("omap_hwmod: %s: cannot _init_clocks\n", oh->name);
1422 * _lookup_hardreset - fill register bit info for this hwmod/reset line
1423 * @oh: struct omap_hwmod *
1424 * @name: name of the reset line in the context of this hwmod
1425 * @ohri: struct omap_hwmod_rst_info * that this function will fill in
1427 * Return the bit position of the reset line that match the
1428 * input name. Return -ENOENT if not found.
1430 static int _lookup_hardreset(struct omap_hwmod *oh, const char *name,
1431 struct omap_hwmod_rst_info *ohri)
1435 for (i = 0; i < oh->rst_lines_cnt; i++) {
1436 const char *rst_line = oh->rst_lines[i].name;
1437 if (!strcmp(rst_line, name)) {
1438 ohri->rst_shift = oh->rst_lines[i].rst_shift;
1439 ohri->st_shift = oh->rst_lines[i].st_shift;
1440 pr_debug("omap_hwmod: %s: %s: %s: rst %d st %d\n",
1441 oh->name, __func__, rst_line, ohri->rst_shift,
1452 * _assert_hardreset - assert the HW reset line of submodules
1453 * contained in the hwmod module.
1454 * @oh: struct omap_hwmod *
1455 * @name: name of the reset line to lookup and assert
1457 * Some IP like dsp, ipu or iva contain processor that require an HW
1458 * reset line to be assert / deassert in order to enable fully the IP.
1459 * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1460 * asserting the hardreset line on the currently-booted SoC, or passes
1461 * along the return value from _lookup_hardreset() or the SoC's
1462 * assert_hardreset code.
1464 static int _assert_hardreset(struct omap_hwmod *oh, const char *name)
1466 struct omap_hwmod_rst_info ohri;
1472 if (!soc_ops.assert_hardreset)
1475 ret = _lookup_hardreset(oh, name, &ohri);
1479 ret = soc_ops.assert_hardreset(oh, &ohri);
1485 * _deassert_hardreset - deassert the HW reset line of submodules contained
1486 * in the hwmod module.
1487 * @oh: struct omap_hwmod *
1488 * @name: name of the reset line to look up and deassert
1490 * Some IP like dsp, ipu or iva contain processor that require an HW
1491 * reset line to be assert / deassert in order to enable fully the IP.
1492 * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1493 * deasserting the hardreset line on the currently-booted SoC, or passes
1494 * along the return value from _lookup_hardreset() or the SoC's
1495 * deassert_hardreset code.
1497 static int _deassert_hardreset(struct omap_hwmod *oh, const char *name)
1499 struct omap_hwmod_rst_info ohri;
1505 if (!soc_ops.deassert_hardreset)
1508 ret = _lookup_hardreset(oh, name, &ohri);
1514 * A clockdomain must be in SW_SUP otherwise reset
1515 * might not be completed. The clockdomain can be set
1516 * in HW_AUTO only when the module become ready.
1518 clkdm_deny_idle(oh->clkdm);
1519 ret = clkdm_hwmod_enable(oh->clkdm, oh);
1521 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1522 oh->name, oh->clkdm->name, ret);
1528 if (soc_ops.enable_module)
1529 soc_ops.enable_module(oh);
1531 ret = soc_ops.deassert_hardreset(oh, &ohri);
1533 if (soc_ops.disable_module)
1534 soc_ops.disable_module(oh);
1535 _disable_clocks(oh);
1538 pr_warn("omap_hwmod: %s: failed to hardreset\n", oh->name);
1542 * Set the clockdomain to HW_AUTO, assuming that the
1543 * previous state was HW_AUTO.
1545 clkdm_allow_idle(oh->clkdm);
1547 clkdm_hwmod_disable(oh->clkdm, oh);
1554 * _read_hardreset - read the HW reset line state of submodules
1555 * contained in the hwmod module
1556 * @oh: struct omap_hwmod *
1557 * @name: name of the reset line to look up and read
1559 * Return the state of the reset line. Returns -EINVAL if @oh is
1560 * null, -ENOSYS if we have no way of reading the hardreset line
1561 * status on the currently-booted SoC, or passes along the return
1562 * value from _lookup_hardreset() or the SoC's is_hardreset_asserted
1565 static int _read_hardreset(struct omap_hwmod *oh, const char *name)
1567 struct omap_hwmod_rst_info ohri;
1573 if (!soc_ops.is_hardreset_asserted)
1576 ret = _lookup_hardreset(oh, name, &ohri);
1580 return soc_ops.is_hardreset_asserted(oh, &ohri);
1584 * _are_all_hardreset_lines_asserted - return true if the @oh is hard-reset
1585 * @oh: struct omap_hwmod *
1587 * If all hardreset lines associated with @oh are asserted, then return true.
1588 * Otherwise, if part of @oh is out hardreset or if no hardreset lines
1589 * associated with @oh are asserted, then return false.
1590 * This function is used to avoid executing some parts of the IP block
1591 * enable/disable sequence if its hardreset line is set.
1593 static bool _are_all_hardreset_lines_asserted(struct omap_hwmod *oh)
1597 if (oh->rst_lines_cnt == 0)
1600 for (i = 0; i < oh->rst_lines_cnt; i++)
1601 if (_read_hardreset(oh, oh->rst_lines[i].name) > 0)
1604 if (oh->rst_lines_cnt == rst_cnt)
1611 * _are_any_hardreset_lines_asserted - return true if any part of @oh is
1613 * @oh: struct omap_hwmod *
1615 * If any hardreset lines associated with @oh are asserted, then
1616 * return true. Otherwise, if no hardreset lines associated with @oh
1617 * are asserted, or if @oh has no hardreset lines, then return false.
1618 * This function is used to avoid executing some parts of the IP block
1619 * enable/disable sequence if any hardreset line is set.
1621 static bool _are_any_hardreset_lines_asserted(struct omap_hwmod *oh)
1626 for (i = 0; i < oh->rst_lines_cnt && rst_cnt == 0; i++)
1627 if (_read_hardreset(oh, oh->rst_lines[i].name) > 0)
1630 return (rst_cnt) ? true : false;
1634 * _omap4_disable_module - enable CLKCTRL modulemode on OMAP4
1635 * @oh: struct omap_hwmod *
1637 * Disable the PRCM module mode related to the hwmod @oh.
1638 * Return EINVAL if the modulemode is not supported and 0 in case of success.
1640 static int _omap4_disable_module(struct omap_hwmod *oh)
1644 if (!oh->clkdm || !oh->prcm.omap4.modulemode ||
1645 _omap4_clkctrl_managed_by_clkfwk(oh))
1649 * Since integration code might still be doing something, only
1650 * disable if all lines are under hardreset.
1652 if (_are_any_hardreset_lines_asserted(oh))
1655 pr_debug("omap_hwmod: %s: %s\n", oh->name, __func__);
1657 omap_cm_module_disable(oh->clkdm->prcm_partition, oh->clkdm->cm_inst,
1658 oh->prcm.omap4.clkctrl_offs);
1660 v = _omap4_wait_target_disable(oh);
1662 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1669 * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1670 * @oh: struct omap_hwmod *
1672 * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit. hwmod must be
1673 * enabled for this to work. Returns -ENOENT if the hwmod cannot be
1674 * reset this way, -EINVAL if the hwmod is in the wrong state,
1675 * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1677 * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1678 * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1679 * use the SYSCONFIG softreset bit to provide the status.
1681 * Note that some IP like McBSP do have reset control but don't have
1684 static int _ocp_softreset(struct omap_hwmod *oh)
1690 if (!oh->class->sysc ||
1691 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
1694 /* clocks must be on for this operation */
1695 if (oh->_state != _HWMOD_STATE_ENABLED) {
1696 pr_warn("omap_hwmod: %s: reset can only be entered from enabled state\n",
1701 /* For some modules, all optionnal clocks need to be enabled as well */
1702 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1703 _enable_optional_clocks(oh);
1705 pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh->name);
1707 v = oh->_sysc_cache;
1708 ret = _set_softreset(oh, &v);
1712 _write_sysconfig(v, oh);
1714 if (oh->class->sysc->srst_udelay)
1715 udelay(oh->class->sysc->srst_udelay);
1717 c = _wait_softreset_complete(oh);
1718 if (c == MAX_MODULE_SOFTRESET_WAIT) {
1719 pr_warn("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1720 oh->name, MAX_MODULE_SOFTRESET_WAIT);
1724 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh->name, c);
1727 ret = _clear_softreset(oh, &v);
1731 _write_sysconfig(v, oh);
1734 * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1735 * _wait_target_ready() or _reset()
1739 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1740 _disable_optional_clocks(oh);
1746 * _reset - reset an omap_hwmod
1747 * @oh: struct omap_hwmod *
1749 * Resets an omap_hwmod @oh. If the module has a custom reset
1750 * function pointer defined, then call it to reset the IP block, and
1751 * pass along its return value to the caller. Otherwise, if the IP
1752 * block has an OCP_SYSCONFIG register with a SOFTRESET bitfield
1753 * associated with it, call a function to reset the IP block via that
1754 * method, and pass along the return value to the caller. Finally, if
1755 * the IP block has some hardreset lines associated with it, assert
1756 * all of those, but do _not_ deassert them. (This is because driver
1757 * authors have expressed an apparent requirement to control the
1758 * deassertion of the hardreset lines themselves.)
1760 * The default software reset mechanism for most OMAP IP blocks is
1761 * triggered via the OCP_SYSCONFIG.SOFTRESET bit. However, some
1762 * hwmods cannot be reset via this method. Some are not targets and
1763 * therefore have no OCP header registers to access. Others (like the
1764 * IVA) have idiosyncratic reset sequences. So for these relatively
1765 * rare cases, custom reset code can be supplied in the struct
1766 * omap_hwmod_class .reset function pointer.
1768 * _set_dmadisable() is called to set the DMADISABLE bit so that it
1769 * does not prevent idling of the system. This is necessary for cases
1770 * where ROMCODE/BOOTLOADER uses dma and transfers control to the
1771 * kernel without disabling dma.
1773 * Passes along the return value from either _ocp_softreset() or the
1774 * custom reset function - these must return -EINVAL if the hwmod
1775 * cannot be reset this way or if the hwmod is in the wrong state,
1776 * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1778 static int _reset(struct omap_hwmod *oh)
1782 pr_debug("omap_hwmod: %s: resetting\n", oh->name);
1784 if (oh->class->reset) {
1785 r = oh->class->reset(oh);
1787 if (oh->rst_lines_cnt > 0) {
1788 for (i = 0; i < oh->rst_lines_cnt; i++)
1789 _assert_hardreset(oh, oh->rst_lines[i].name);
1792 r = _ocp_softreset(oh);
1798 _set_dmadisable(oh);
1801 * OCP_SYSCONFIG bits need to be reprogrammed after a
1802 * softreset. The _enable() function should be split to avoid
1803 * the rewrite of the OCP_SYSCONFIG register.
1805 if (oh->class->sysc) {
1806 _update_sysc_cache(oh);
1814 * _omap4_update_context_lost - increment hwmod context loss counter if
1815 * hwmod context was lost, and clear hardware context loss reg
1816 * @oh: hwmod to check for context loss
1818 * If the PRCM indicates that the hwmod @oh lost context, increment
1819 * our in-memory context loss counter, and clear the RM_*_CONTEXT
1820 * bits. No return value.
1822 static void _omap4_update_context_lost(struct omap_hwmod *oh)
1824 if (oh->prcm.omap4.flags & HWMOD_OMAP4_NO_CONTEXT_LOSS_BIT)
1827 if (!prm_was_any_context_lost_old(oh->clkdm->pwrdm.ptr->prcm_partition,
1828 oh->clkdm->pwrdm.ptr->prcm_offs,
1829 oh->prcm.omap4.context_offs))
1832 oh->prcm.omap4.context_lost_counter++;
1833 prm_clear_context_loss_flags_old(oh->clkdm->pwrdm.ptr->prcm_partition,
1834 oh->clkdm->pwrdm.ptr->prcm_offs,
1835 oh->prcm.omap4.context_offs);
1839 * _omap4_get_context_lost - get context loss counter for a hwmod
1840 * @oh: hwmod to get context loss counter for
1842 * Returns the in-memory context loss counter for a hwmod.
1844 static int _omap4_get_context_lost(struct omap_hwmod *oh)
1846 return oh->prcm.omap4.context_lost_counter;
1850 * _enable_preprogram - Pre-program an IP block during the _enable() process
1851 * @oh: struct omap_hwmod *
1853 * Some IP blocks (such as AESS) require some additional programming
1854 * after enable before they can enter idle. If a function pointer to
1855 * do so is present in the hwmod data, then call it and pass along the
1856 * return value; otherwise, return 0.
1858 static int _enable_preprogram(struct omap_hwmod *oh)
1860 if (!oh->class->enable_preprogram)
1863 return oh->class->enable_preprogram(oh);
1867 * _enable - enable an omap_hwmod
1868 * @oh: struct omap_hwmod *
1870 * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
1871 * register target. Returns -EINVAL if the hwmod is in the wrong
1872 * state or passes along the return value of _wait_target_ready().
1874 static int _enable(struct omap_hwmod *oh)
1878 pr_debug("omap_hwmod: %s: enabling\n", oh->name);
1881 * hwmods with HWMOD_INIT_NO_IDLE flag set are left in enabled
1884 if (oh->_int_flags & _HWMOD_SKIP_ENABLE) {
1885 oh->_int_flags &= ~_HWMOD_SKIP_ENABLE;
1889 if (oh->_state != _HWMOD_STATE_INITIALIZED &&
1890 oh->_state != _HWMOD_STATE_IDLE &&
1891 oh->_state != _HWMOD_STATE_DISABLED) {
1892 WARN(1, "omap_hwmod: %s: enabled state can only be entered from initialized, idle, or disabled state\n",
1898 * If an IP block contains HW reset lines and all of them are
1899 * asserted, we let integration code associated with that
1900 * block handle the enable. We've received very little
1901 * information on what those driver authors need, and until
1902 * detailed information is provided and the driver code is
1903 * posted to the public lists, this is probably the best we
1906 if (_are_all_hardreset_lines_asserted(oh))
1909 _add_initiator_dep(oh, mpu_oh);
1913 * A clockdomain must be in SW_SUP before enabling
1914 * completely the module. The clockdomain can be set
1915 * in HW_AUTO only when the module become ready.
1917 clkdm_deny_idle(oh->clkdm);
1918 r = clkdm_hwmod_enable(oh->clkdm, oh);
1920 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1921 oh->name, oh->clkdm->name, r);
1927 if (soc_ops.enable_module)
1928 soc_ops.enable_module(oh);
1929 if (oh->flags & HWMOD_BLOCK_WFI)
1930 cpu_idle_poll_ctrl(true);
1932 if (soc_ops.update_context_lost)
1933 soc_ops.update_context_lost(oh);
1935 r = (soc_ops.wait_target_ready) ? soc_ops.wait_target_ready(oh) :
1937 if (oh->clkdm && !(oh->flags & HWMOD_CLKDM_NOAUTO))
1938 clkdm_allow_idle(oh->clkdm);
1941 oh->_state = _HWMOD_STATE_ENABLED;
1943 /* Access the sysconfig only if the target is ready */
1944 if (oh->class->sysc) {
1945 if (!(oh->_int_flags & _HWMOD_SYSCONFIG_LOADED))
1946 _update_sysc_cache(oh);
1949 r = _enable_preprogram(oh);
1951 if (soc_ops.disable_module)
1952 soc_ops.disable_module(oh);
1953 _disable_clocks(oh);
1954 pr_err("omap_hwmod: %s: _wait_target_ready failed: %d\n",
1958 clkdm_hwmod_disable(oh->clkdm, oh);
1965 * _idle - idle an omap_hwmod
1966 * @oh: struct omap_hwmod *
1968 * Idles an omap_hwmod @oh. This should be called once the hwmod has
1969 * no further work. Returns -EINVAL if the hwmod is in the wrong
1970 * state or returns 0.
1972 static int _idle(struct omap_hwmod *oh)
1974 if (oh->flags & HWMOD_NO_IDLE) {
1975 oh->_int_flags |= _HWMOD_SKIP_ENABLE;
1979 pr_debug("omap_hwmod: %s: idling\n", oh->name);
1981 if (_are_all_hardreset_lines_asserted(oh))
1984 if (oh->_state != _HWMOD_STATE_ENABLED) {
1985 WARN(1, "omap_hwmod: %s: idle state can only be entered from enabled state\n",
1990 if (oh->class->sysc)
1992 _del_initiator_dep(oh, mpu_oh);
1995 * If HWMOD_CLKDM_NOAUTO is set then we don't
1996 * deny idle the clkdm again since idle was already denied
1999 if (oh->clkdm && !(oh->flags & HWMOD_CLKDM_NOAUTO))
2000 clkdm_deny_idle(oh->clkdm);
2002 if (oh->flags & HWMOD_BLOCK_WFI)
2003 cpu_idle_poll_ctrl(false);
2004 if (soc_ops.disable_module)
2005 soc_ops.disable_module(oh);
2008 * The module must be in idle mode before disabling any parents
2009 * clocks. Otherwise, the parent clock might be disabled before
2010 * the module transition is done, and thus will prevent the
2011 * transition to complete properly.
2013 _disable_clocks(oh);
2015 clkdm_allow_idle(oh->clkdm);
2016 clkdm_hwmod_disable(oh->clkdm, oh);
2019 oh->_state = _HWMOD_STATE_IDLE;
2025 * _shutdown - shutdown an omap_hwmod
2026 * @oh: struct omap_hwmod *
2028 * Shut down an omap_hwmod @oh. This should be called when the driver
2029 * used for the hwmod is removed or unloaded or if the driver is not
2030 * used by the system. Returns -EINVAL if the hwmod is in the wrong
2031 * state or returns 0.
2033 static int _shutdown(struct omap_hwmod *oh)
2038 if (_are_all_hardreset_lines_asserted(oh))
2041 if (oh->_state != _HWMOD_STATE_IDLE &&
2042 oh->_state != _HWMOD_STATE_ENABLED) {
2043 WARN(1, "omap_hwmod: %s: disabled state can only be entered from idle, or enabled state\n",
2048 pr_debug("omap_hwmod: %s: disabling\n", oh->name);
2050 if (oh->class->pre_shutdown) {
2051 prev_state = oh->_state;
2052 if (oh->_state == _HWMOD_STATE_IDLE)
2054 ret = oh->class->pre_shutdown(oh);
2056 if (prev_state == _HWMOD_STATE_IDLE)
2062 if (oh->class->sysc) {
2063 if (oh->_state == _HWMOD_STATE_IDLE)
2068 /* clocks and deps are already disabled in idle */
2069 if (oh->_state == _HWMOD_STATE_ENABLED) {
2070 _del_initiator_dep(oh, mpu_oh);
2071 /* XXX what about the other system initiators here? dma, dsp */
2072 if (oh->flags & HWMOD_BLOCK_WFI)
2073 cpu_idle_poll_ctrl(false);
2074 if (soc_ops.disable_module)
2075 soc_ops.disable_module(oh);
2076 _disable_clocks(oh);
2078 clkdm_hwmod_disable(oh->clkdm, oh);
2080 /* XXX Should this code also force-disable the optional clocks? */
2082 for (i = 0; i < oh->rst_lines_cnt; i++)
2083 _assert_hardreset(oh, oh->rst_lines[i].name);
2085 oh->_state = _HWMOD_STATE_DISABLED;
2090 static int of_dev_find_hwmod(struct device_node *np,
2091 struct omap_hwmod *oh)
2096 count = of_property_count_strings(np, "ti,hwmods");
2100 for (i = 0; i < count; i++) {
2101 res = of_property_read_string_index(np, "ti,hwmods",
2105 if (!strcmp(p, oh->name)) {
2106 pr_debug("omap_hwmod: dt %s[%i] uses hwmod %s\n",
2107 np->name, i, oh->name);
2116 * of_dev_hwmod_lookup - look up needed hwmod from dt blob
2117 * @np: struct device_node *
2118 * @oh: struct omap_hwmod *
2119 * @index: index of the entry found
2120 * @found: struct device_node * found or NULL
2122 * Parse the dt blob and find out needed hwmod. Recursive function is
2123 * implemented to take care hierarchical dt blob parsing.
2124 * Return: Returns 0 on success, -ENODEV when not found.
2126 static int of_dev_hwmod_lookup(struct device_node *np,
2127 struct omap_hwmod *oh,
2129 struct device_node **found)
2131 struct device_node *np0 = NULL;
2134 res = of_dev_find_hwmod(np, oh);
2141 for_each_child_of_node(np, np0) {
2142 struct device_node *fc;
2145 res = of_dev_hwmod_lookup(np0, oh, &i, &fc);
2160 * omap_hwmod_parse_module_range - map module IO range from device tree
2161 * @oh: struct omap_hwmod *
2162 * @np: struct device_node *
2164 * Parse the device tree range an interconnect target module provides
2165 * for it's child device IP blocks. This way we can support the old
2166 * "ti,hwmods" property with just dts data without a need for platform
2167 * data for IO resources. And we don't need all the child IP device
2168 * nodes available in the dts.
2170 int omap_hwmod_parse_module_range(struct omap_hwmod *oh,
2171 struct device_node *np,
2172 struct resource *res)
2174 struct property *prop;
2175 const __be32 *ranges;
2177 u32 nr_addr, nr_size;
2184 ranges = of_get_property(np, "ranges", &len);
2188 len /= sizeof(*ranges);
2193 of_property_for_each_string(np, "compatible", prop, name)
2194 if (!strncmp("ti,sysc-", name, 8))
2200 error = of_property_read_u32(np, "#address-cells", &nr_addr);
2204 error = of_property_read_u32(np, "#size-cells", &nr_size);
2208 if (nr_addr != 1 || nr_size != 1) {
2209 pr_err("%s: invalid range for %s->%s\n", __func__,
2210 oh->name, np->name);
2215 base = of_translate_address(np, ranges++);
2216 size = be32_to_cpup(ranges);
2218 pr_debug("omap_hwmod: %s %s at 0x%llx size 0x%llx\n",
2219 oh->name, np->name, base, size);
2222 res->end = base + size - 1;
2223 res->flags = IORESOURCE_MEM;
2229 * _init_mpu_rt_base - populate the virtual address for a hwmod
2230 * @oh: struct omap_hwmod * to locate the virtual address
2231 * @data: (unused, caller should pass NULL)
2232 * @index: index of the reg entry iospace in device tree
2233 * @np: struct device_node * of the IP block's device node in the DT data
2235 * Cache the virtual address used by the MPU to access this IP block's
2236 * registers. This address is needed early so the OCP registers that
2237 * are part of the device's address space can be ioremapped properly.
2239 * If SYSC access is not needed, the registers will not be remapped
2240 * and non-availability of MPU access is not treated as an error.
2242 * Returns 0 on success, -EINVAL if an invalid hwmod is passed, and
2243 * -ENXIO on absent or invalid register target address space.
2245 static int __init _init_mpu_rt_base(struct omap_hwmod *oh, void *data,
2246 int index, struct device_node *np)
2248 void __iomem *va_start = NULL;
2249 struct resource res;
2255 _save_mpu_port_index(oh);
2257 /* if we don't need sysc access we don't need to ioremap */
2258 if (!oh->class->sysc)
2261 /* we can't continue without MPU PORT if we need sysc access */
2262 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2266 pr_err("omap_hwmod: %s: no dt node\n", oh->name);
2270 /* Do we have a dts range for the interconnect target module? */
2271 error = omap_hwmod_parse_module_range(oh, np, &res);
2273 va_start = ioremap(res.start, resource_size(&res));
2275 /* No ranges, rely on device reg entry */
2277 va_start = of_iomap(np, index + oh->mpu_rt_idx);
2279 pr_err("omap_hwmod: %s: Missing dt reg%i for %pOF\n",
2280 oh->name, index, np);
2284 pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
2285 oh->name, va_start);
2287 oh->_mpu_rt_va = va_start;
2292 * _init - initialize internal data for the hwmod @oh
2293 * @oh: struct omap_hwmod *
2296 * Look up the clocks and the address space used by the MPU to access
2297 * registers belonging to the hwmod @oh. @oh must already be
2298 * registered at this point. This is the first of two phases for
2299 * hwmod initialization. Code called here does not touch any hardware
2300 * registers, it simply prepares internal data structures. Returns 0
2301 * upon success or if the hwmod isn't registered or if the hwmod's
2302 * address space is not defined, or -EINVAL upon failure.
2304 static int __init _init(struct omap_hwmod *oh, void *data)
2307 struct device_node *np = NULL;
2308 struct device_node *bus;
2310 if (oh->_state != _HWMOD_STATE_REGISTERED)
2313 bus = of_find_node_by_name(NULL, "ocp");
2317 r = of_dev_hwmod_lookup(bus, oh, &index, &np);
2319 pr_debug("omap_hwmod: %s missing dt data\n", oh->name);
2320 else if (np && index)
2321 pr_warn("omap_hwmod: %s using broken dt data from %s\n",
2322 oh->name, np->name);
2324 r = _init_mpu_rt_base(oh, NULL, index, np);
2326 WARN(1, "omap_hwmod: %s: doesn't have mpu register target base\n",
2331 r = _init_clocks(oh, np);
2333 WARN(1, "omap_hwmod: %s: couldn't init clocks\n", oh->name);
2338 if (of_find_property(np, "ti,no-reset-on-init", NULL))
2339 oh->flags |= HWMOD_INIT_NO_RESET;
2340 if (of_find_property(np, "ti,no-idle-on-init", NULL))
2341 oh->flags |= HWMOD_INIT_NO_IDLE;
2342 if (of_find_property(np, "ti,no-idle", NULL))
2343 oh->flags |= HWMOD_NO_IDLE;
2346 oh->_state = _HWMOD_STATE_INITIALIZED;
2352 * _setup_iclk_autoidle - configure an IP block's interface clocks
2353 * @oh: struct omap_hwmod *
2355 * Set up the module's interface clocks. XXX This function is still mostly
2356 * a stub; implementing this properly requires iclk autoidle usecounting in
2357 * the clock code. No return value.
2359 static void __init _setup_iclk_autoidle(struct omap_hwmod *oh)
2361 struct omap_hwmod_ocp_if *os;
2363 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2366 list_for_each_entry(os, &oh->slave_ports, node) {
2370 if (os->flags & OCPIF_SWSUP_IDLE) {
2371 /* XXX omap_iclk_deny_idle(c); */
2373 /* XXX omap_iclk_allow_idle(c); */
2374 clk_enable(os->_clk);
2382 * _setup_reset - reset an IP block during the setup process
2383 * @oh: struct omap_hwmod *
2385 * Reset the IP block corresponding to the hwmod @oh during the setup
2386 * process. The IP block is first enabled so it can be successfully
2387 * reset. Returns 0 upon success or a negative error code upon
2390 static int __init _setup_reset(struct omap_hwmod *oh)
2394 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2397 if (oh->flags & HWMOD_EXT_OPT_MAIN_CLK)
2400 if (oh->rst_lines_cnt == 0) {
2403 pr_warn("omap_hwmod: %s: cannot be enabled for reset (%d)\n",
2404 oh->name, oh->_state);
2409 if (!(oh->flags & HWMOD_INIT_NO_RESET))
2416 * _setup_postsetup - transition to the appropriate state after _setup
2417 * @oh: struct omap_hwmod *
2419 * Place an IP block represented by @oh into a "post-setup" state --
2420 * either IDLE, ENABLED, or DISABLED. ("post-setup" simply means that
2421 * this function is called at the end of _setup().) The postsetup
2422 * state for an IP block can be changed by calling
2423 * omap_hwmod_enter_postsetup_state() early in the boot process,
2424 * before one of the omap_hwmod_setup*() functions are called for the
2427 * The IP block stays in this state until a PM runtime-based driver is
2428 * loaded for that IP block. A post-setup state of IDLE is
2429 * appropriate for almost all IP blocks with runtime PM-enabled
2430 * drivers, since those drivers are able to enable the IP block. A
2431 * post-setup state of ENABLED is appropriate for kernels with PM
2432 * runtime disabled. The DISABLED state is appropriate for unusual IP
2433 * blocks such as the MPU WDTIMER on kernels without WDTIMER drivers
2434 * included, since the WDTIMER starts running on reset and will reset
2435 * the MPU if left active.
2437 * This post-setup mechanism is deprecated. Once all of the OMAP
2438 * drivers have been converted to use PM runtime, and all of the IP
2439 * block data and interconnect data is available to the hwmod code, it
2440 * should be possible to replace this mechanism with a "lazy reset"
2441 * arrangement. In a "lazy reset" setup, each IP block is enabled
2442 * when the driver first probes, then all remaining IP blocks without
2443 * drivers are either shut down or enabled after the drivers have
2444 * loaded. However, this cannot take place until the above
2445 * preconditions have been met, since otherwise the late reset code
2446 * has no way of knowing which IP blocks are in use by drivers, and
2447 * which ones are unused.
2451 static void __init _setup_postsetup(struct omap_hwmod *oh)
2455 if (oh->rst_lines_cnt > 0)
2458 postsetup_state = oh->_postsetup_state;
2459 if (postsetup_state == _HWMOD_STATE_UNKNOWN)
2460 postsetup_state = _HWMOD_STATE_ENABLED;
2463 * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
2464 * it should be set by the core code as a runtime flag during startup
2466 if ((oh->flags & (HWMOD_INIT_NO_IDLE | HWMOD_NO_IDLE)) &&
2467 (postsetup_state == _HWMOD_STATE_IDLE)) {
2468 oh->_int_flags |= _HWMOD_SKIP_ENABLE;
2469 postsetup_state = _HWMOD_STATE_ENABLED;
2472 if (postsetup_state == _HWMOD_STATE_IDLE)
2474 else if (postsetup_state == _HWMOD_STATE_DISABLED)
2476 else if (postsetup_state != _HWMOD_STATE_ENABLED)
2477 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
2478 oh->name, postsetup_state);
2484 * _setup - prepare IP block hardware for use
2485 * @oh: struct omap_hwmod *
2486 * @n: (unused, pass NULL)
2488 * Configure the IP block represented by @oh. This may include
2489 * enabling the IP block, resetting it, and placing it into a
2490 * post-setup state, depending on the type of IP block and applicable
2491 * flags. IP blocks are reset to prevent any previous configuration
2492 * by the bootloader or previous operating system from interfering
2493 * with power management or other parts of the system. The reset can
2494 * be avoided; see omap_hwmod_no_setup_reset(). This is the second of
2495 * two phases for hwmod initialization. Code called here generally
2496 * affects the IP block hardware, or system integration hardware
2497 * associated with the IP block. Returns 0.
2499 static int __init _setup(struct omap_hwmod *oh, void *data)
2501 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2504 if (oh->parent_hwmod) {
2507 r = _enable(oh->parent_hwmod);
2508 WARN(r, "hwmod: %s: setup: failed to enable parent hwmod %s\n",
2509 oh->name, oh->parent_hwmod->name);
2512 _setup_iclk_autoidle(oh);
2514 if (!_setup_reset(oh))
2515 _setup_postsetup(oh);
2517 if (oh->parent_hwmod) {
2520 postsetup_state = oh->parent_hwmod->_postsetup_state;
2522 if (postsetup_state == _HWMOD_STATE_IDLE)
2523 _idle(oh->parent_hwmod);
2524 else if (postsetup_state == _HWMOD_STATE_DISABLED)
2525 _shutdown(oh->parent_hwmod);
2526 else if (postsetup_state != _HWMOD_STATE_ENABLED)
2527 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
2528 oh->parent_hwmod->name, postsetup_state);
2535 * _register - register a struct omap_hwmod
2536 * @oh: struct omap_hwmod *
2538 * Registers the omap_hwmod @oh. Returns -EEXIST if an omap_hwmod
2539 * already has been registered by the same name; -EINVAL if the
2540 * omap_hwmod is in the wrong state, if @oh is NULL, if the
2541 * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
2542 * name, or if the omap_hwmod's class is missing a name; or 0 upon
2545 * XXX The data should be copied into bootmem, so the original data
2546 * should be marked __initdata and freed after init. This would allow
2547 * unneeded omap_hwmods to be freed on multi-OMAP configurations. Note
2548 * that the copy process would be relatively complex due to the large number
2551 static int __init _register(struct omap_hwmod *oh)
2553 if (!oh || !oh->name || !oh->class || !oh->class->name ||
2554 (oh->_state != _HWMOD_STATE_UNKNOWN))
2557 pr_debug("omap_hwmod: %s: registering\n", oh->name);
2559 if (_lookup(oh->name))
2562 list_add_tail(&oh->node, &omap_hwmod_list);
2564 INIT_LIST_HEAD(&oh->slave_ports);
2565 spin_lock_init(&oh->_lock);
2566 lockdep_set_class(&oh->_lock, &oh->hwmod_key);
2568 oh->_state = _HWMOD_STATE_REGISTERED;
2571 * XXX Rather than doing a strcmp(), this should test a flag
2572 * set in the hwmod data, inserted by the autogenerator code.
2574 if (!strcmp(oh->name, MPU_INITIATOR_NAME))
2581 * _add_link - add an interconnect between two IP blocks
2582 * @oi: pointer to a struct omap_hwmod_ocp_if record
2584 * Add struct omap_hwmod_link records connecting the slave IP block
2585 * specified in @oi->slave to @oi. This code is assumed to run before
2586 * preemption or SMP has been enabled, thus avoiding the need for
2587 * locking in this code. Changes to this assumption will require
2588 * additional locking. Returns 0.
2590 static int __init _add_link(struct omap_hwmod_ocp_if *oi)
2592 pr_debug("omap_hwmod: %s -> %s: adding link\n", oi->master->name,
2595 list_add(&oi->node, &oi->slave->slave_ports);
2596 oi->slave->slaves_cnt++;
2602 * _register_link - register a struct omap_hwmod_ocp_if
2603 * @oi: struct omap_hwmod_ocp_if *
2605 * Registers the omap_hwmod_ocp_if record @oi. Returns -EEXIST if it
2606 * has already been registered; -EINVAL if @oi is NULL or if the
2607 * record pointed to by @oi is missing required fields; or 0 upon
2610 * XXX The data should be copied into bootmem, so the original data
2611 * should be marked __initdata and freed after init. This would allow
2612 * unneeded omap_hwmods to be freed on multi-OMAP configurations.
2614 static int __init _register_link(struct omap_hwmod_ocp_if *oi)
2616 if (!oi || !oi->master || !oi->slave || !oi->user)
2619 if (oi->_int_flags & _OCPIF_INT_FLAGS_REGISTERED)
2622 pr_debug("omap_hwmod: registering link from %s to %s\n",
2623 oi->master->name, oi->slave->name);
2626 * Register the connected hwmods, if they haven't been
2627 * registered already
2629 if (oi->master->_state != _HWMOD_STATE_REGISTERED)
2630 _register(oi->master);
2632 if (oi->slave->_state != _HWMOD_STATE_REGISTERED)
2633 _register(oi->slave);
2637 oi->_int_flags |= _OCPIF_INT_FLAGS_REGISTERED;
2642 /* Static functions intended only for use in soc_ops field function pointers */
2645 * _omap2xxx_3xxx_wait_target_ready - wait for a module to leave slave idle
2646 * @oh: struct omap_hwmod *
2648 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2649 * does not have an IDLEST bit or if the module successfully leaves
2650 * slave idle; otherwise, pass along the return value of the
2651 * appropriate *_cm*_wait_module_ready() function.
2653 static int _omap2xxx_3xxx_wait_target_ready(struct omap_hwmod *oh)
2658 if (oh->flags & HWMOD_NO_IDLEST)
2661 if (!_find_mpu_rt_port(oh))
2664 /* XXX check module SIDLEMODE, hardreset status, enabled clocks */
2666 return omap_cm_wait_module_ready(0, oh->prcm.omap2.module_offs,
2667 oh->prcm.omap2.idlest_reg_id,
2668 oh->prcm.omap2.idlest_idle_bit);
2672 * _omap4_wait_target_ready - wait for a module to leave slave idle
2673 * @oh: struct omap_hwmod *
2675 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2676 * does not have an IDLEST bit or if the module successfully leaves
2677 * slave idle; otherwise, pass along the return value of the
2678 * appropriate *_cm*_wait_module_ready() function.
2680 static int _omap4_wait_target_ready(struct omap_hwmod *oh)
2685 if (oh->flags & HWMOD_NO_IDLEST || !oh->clkdm)
2688 if (!_find_mpu_rt_port(oh))
2691 if (_omap4_clkctrl_managed_by_clkfwk(oh))
2694 if (!_omap4_has_clkctrl_clock(oh))
2697 /* XXX check module SIDLEMODE, hardreset status */
2699 return omap_cm_wait_module_ready(oh->clkdm->prcm_partition,
2701 oh->prcm.omap4.clkctrl_offs, 0);
2705 * _omap2_assert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2706 * @oh: struct omap_hwmod * to assert hardreset
2707 * @ohri: hardreset line data
2709 * Call omap2_prm_assert_hardreset() with parameters extracted from
2710 * the hwmod @oh and the hardreset line data @ohri. Only intended for
2711 * use as an soc_ops function pointer. Passes along the return value
2712 * from omap2_prm_assert_hardreset(). XXX This function is scheduled
2713 * for removal when the PRM code is moved into drivers/.
2715 static int _omap2_assert_hardreset(struct omap_hwmod *oh,
2716 struct omap_hwmod_rst_info *ohri)
2718 return omap_prm_assert_hardreset(ohri->rst_shift, 0,
2719 oh->prcm.omap2.module_offs, 0);
2723 * _omap2_deassert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2724 * @oh: struct omap_hwmod * to deassert hardreset
2725 * @ohri: hardreset line data
2727 * Call omap2_prm_deassert_hardreset() with parameters extracted from
2728 * the hwmod @oh and the hardreset line data @ohri. Only intended for
2729 * use as an soc_ops function pointer. Passes along the return value
2730 * from omap2_prm_deassert_hardreset(). XXX This function is
2731 * scheduled for removal when the PRM code is moved into drivers/.
2733 static int _omap2_deassert_hardreset(struct omap_hwmod *oh,
2734 struct omap_hwmod_rst_info *ohri)
2736 return omap_prm_deassert_hardreset(ohri->rst_shift, ohri->st_shift, 0,
2737 oh->prcm.omap2.module_offs, 0, 0);
2741 * _omap2_is_hardreset_asserted - call OMAP2 PRM hardreset fn with hwmod args
2742 * @oh: struct omap_hwmod * to test hardreset
2743 * @ohri: hardreset line data
2745 * Call omap2_prm_is_hardreset_asserted() with parameters extracted
2746 * from the hwmod @oh and the hardreset line data @ohri. Only
2747 * intended for use as an soc_ops function pointer. Passes along the
2748 * return value from omap2_prm_is_hardreset_asserted(). XXX This
2749 * function is scheduled for removal when the PRM code is moved into
2752 static int _omap2_is_hardreset_asserted(struct omap_hwmod *oh,
2753 struct omap_hwmod_rst_info *ohri)
2755 return omap_prm_is_hardreset_asserted(ohri->st_shift, 0,
2756 oh->prcm.omap2.module_offs, 0);
2760 * _omap4_assert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
2761 * @oh: struct omap_hwmod * to assert hardreset
2762 * @ohri: hardreset line data
2764 * Call omap4_prminst_assert_hardreset() with parameters extracted
2765 * from the hwmod @oh and the hardreset line data @ohri. Only
2766 * intended for use as an soc_ops function pointer. Passes along the
2767 * return value from omap4_prminst_assert_hardreset(). XXX This
2768 * function is scheduled for removal when the PRM code is moved into
2771 static int _omap4_assert_hardreset(struct omap_hwmod *oh,
2772 struct omap_hwmod_rst_info *ohri)
2777 return omap_prm_assert_hardreset(ohri->rst_shift,
2778 oh->clkdm->pwrdm.ptr->prcm_partition,
2779 oh->clkdm->pwrdm.ptr->prcm_offs,
2780 oh->prcm.omap4.rstctrl_offs);
2784 * _omap4_deassert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
2785 * @oh: struct omap_hwmod * to deassert hardreset
2786 * @ohri: hardreset line data
2788 * Call omap4_prminst_deassert_hardreset() with parameters extracted
2789 * from the hwmod @oh and the hardreset line data @ohri. Only
2790 * intended for use as an soc_ops function pointer. Passes along the
2791 * return value from omap4_prminst_deassert_hardreset(). XXX This
2792 * function is scheduled for removal when the PRM code is moved into
2795 static int _omap4_deassert_hardreset(struct omap_hwmod *oh,
2796 struct omap_hwmod_rst_info *ohri)
2802 pr_err("omap_hwmod: %s: %s: hwmod data error: OMAP4 does not support st_shift\n",
2803 oh->name, ohri->name);
2804 return omap_prm_deassert_hardreset(ohri->rst_shift, ohri->rst_shift,
2805 oh->clkdm->pwrdm.ptr->prcm_partition,
2806 oh->clkdm->pwrdm.ptr->prcm_offs,
2807 oh->prcm.omap4.rstctrl_offs,
2808 oh->prcm.omap4.rstctrl_offs +
2809 OMAP4_RST_CTRL_ST_OFFSET);
2813 * _omap4_is_hardreset_asserted - call OMAP4 PRM hardreset fn with hwmod args
2814 * @oh: struct omap_hwmod * to test hardreset
2815 * @ohri: hardreset line data
2817 * Call omap4_prminst_is_hardreset_asserted() with parameters
2818 * extracted from the hwmod @oh and the hardreset line data @ohri.
2819 * Only intended for use as an soc_ops function pointer. Passes along
2820 * the return value from omap4_prminst_is_hardreset_asserted(). XXX
2821 * This function is scheduled for removal when the PRM code is moved
2824 static int _omap4_is_hardreset_asserted(struct omap_hwmod *oh,
2825 struct omap_hwmod_rst_info *ohri)
2830 return omap_prm_is_hardreset_asserted(ohri->rst_shift,
2831 oh->clkdm->pwrdm.ptr->
2833 oh->clkdm->pwrdm.ptr->prcm_offs,
2834 oh->prcm.omap4.rstctrl_offs);
2838 * _omap4_disable_direct_prcm - disable direct PRCM control for hwmod
2839 * @oh: struct omap_hwmod * to disable control for
2841 * Disables direct PRCM clkctrl done by hwmod core. Instead, the hwmod
2842 * will be using its main_clk to enable/disable the module. Returns
2845 static int _omap4_disable_direct_prcm(struct omap_hwmod *oh)
2850 oh->prcm.omap4.flags |= HWMOD_OMAP4_CLKFWK_CLKCTR_CLOCK;
2856 * _am33xx_deassert_hardreset - call AM33XX PRM hardreset fn with hwmod args
2857 * @oh: struct omap_hwmod * to deassert hardreset
2858 * @ohri: hardreset line data
2860 * Call am33xx_prminst_deassert_hardreset() with parameters extracted
2861 * from the hwmod @oh and the hardreset line data @ohri. Only
2862 * intended for use as an soc_ops function pointer. Passes along the
2863 * return value from am33xx_prminst_deassert_hardreset(). XXX This
2864 * function is scheduled for removal when the PRM code is moved into
2867 static int _am33xx_deassert_hardreset(struct omap_hwmod *oh,
2868 struct omap_hwmod_rst_info *ohri)
2870 return omap_prm_deassert_hardreset(ohri->rst_shift, ohri->st_shift,
2871 oh->clkdm->pwrdm.ptr->prcm_partition,
2872 oh->clkdm->pwrdm.ptr->prcm_offs,
2873 oh->prcm.omap4.rstctrl_offs,
2874 oh->prcm.omap4.rstst_offs);
2877 /* Public functions */
2879 u32 omap_hwmod_read(struct omap_hwmod *oh, u16 reg_offs)
2881 if (oh->flags & HWMOD_16BIT_REG)
2882 return readw_relaxed(oh->_mpu_rt_va + reg_offs);
2884 return readl_relaxed(oh->_mpu_rt_va + reg_offs);
2887 void omap_hwmod_write(u32 v, struct omap_hwmod *oh, u16 reg_offs)
2889 if (oh->flags & HWMOD_16BIT_REG)
2890 writew_relaxed(v, oh->_mpu_rt_va + reg_offs);
2892 writel_relaxed(v, oh->_mpu_rt_va + reg_offs);
2896 * omap_hwmod_softreset - reset a module via SYSCONFIG.SOFTRESET bit
2897 * @oh: struct omap_hwmod *
2899 * This is a public function exposed to drivers. Some drivers may need to do
2900 * some settings before and after resetting the device. Those drivers after
2901 * doing the necessary settings could use this function to start a reset by
2902 * setting the SYSCONFIG.SOFTRESET bit.
2904 int omap_hwmod_softreset(struct omap_hwmod *oh)
2909 if (!oh || !(oh->_sysc_cache))
2912 v = oh->_sysc_cache;
2913 ret = _set_softreset(oh, &v);
2916 _write_sysconfig(v, oh);
2918 ret = _clear_softreset(oh, &v);
2921 _write_sysconfig(v, oh);
2928 * omap_hwmod_lookup - look up a registered omap_hwmod by name
2929 * @name: name of the omap_hwmod to look up
2931 * Given a @name of an omap_hwmod, return a pointer to the registered
2932 * struct omap_hwmod *, or NULL upon error.
2934 struct omap_hwmod *omap_hwmod_lookup(const char *name)
2936 struct omap_hwmod *oh;
2947 * omap_hwmod_for_each - call function for each registered omap_hwmod
2948 * @fn: pointer to a callback function
2949 * @data: void * data to pass to callback function
2951 * Call @fn for each registered omap_hwmod, passing @data to each
2952 * function. @fn must return 0 for success or any other value for
2953 * failure. If @fn returns non-zero, the iteration across omap_hwmods
2954 * will stop and the non-zero return value will be passed to the
2955 * caller of omap_hwmod_for_each(). @fn is called with
2956 * omap_hwmod_for_each() held.
2958 int omap_hwmod_for_each(int (*fn)(struct omap_hwmod *oh, void *data),
2961 struct omap_hwmod *temp_oh;
2967 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
2968 ret = (*fn)(temp_oh, data);
2977 * omap_hwmod_register_links - register an array of hwmod links
2978 * @ois: pointer to an array of omap_hwmod_ocp_if to register
2980 * Intended to be called early in boot before the clock framework is
2981 * initialized. If @ois is not null, will register all omap_hwmods
2982 * listed in @ois that are valid for this chip. Returns -EINVAL if
2983 * omap_hwmod_init() hasn't been called before calling this function,
2984 * -ENOMEM if the link memory area can't be allocated, or 0 upon
2987 int __init omap_hwmod_register_links(struct omap_hwmod_ocp_if **ois)
2997 if (ois[0] == NULL) /* Empty list */
3002 r = _register_link(ois[i]);
3003 WARN(r && r != -EEXIST,
3004 "omap_hwmod: _register_link(%s -> %s) returned %d\n",
3005 ois[i]->master->name, ois[i]->slave->name, r);
3012 * _ensure_mpu_hwmod_is_setup - ensure the MPU SS hwmod is init'ed and set up
3013 * @oh: pointer to the hwmod currently being set up (usually not the MPU)
3015 * If the hwmod data corresponding to the MPU subsystem IP block
3016 * hasn't been initialized and set up yet, do so now. This must be
3017 * done first since sleep dependencies may be added from other hwmods
3018 * to the MPU. Intended to be called only by omap_hwmod_setup*(). No
3021 static void __init _ensure_mpu_hwmod_is_setup(struct omap_hwmod *oh)
3023 if (!mpu_oh || mpu_oh->_state == _HWMOD_STATE_UNKNOWN)
3024 pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",
3025 __func__, MPU_INITIATOR_NAME);
3026 else if (mpu_oh->_state == _HWMOD_STATE_REGISTERED && oh != mpu_oh)
3027 omap_hwmod_setup_one(MPU_INITIATOR_NAME);
3031 * omap_hwmod_setup_one - set up a single hwmod
3032 * @oh_name: const char * name of the already-registered hwmod to set up
3034 * Initialize and set up a single hwmod. Intended to be used for a
3035 * small number of early devices, such as the timer IP blocks used for
3036 * the scheduler clock. Must be called after omap2_clk_init().
3037 * Resolves the struct clk names to struct clk pointers for each
3038 * registered omap_hwmod. Also calls _setup() on each hwmod. Returns
3039 * -EINVAL upon error or 0 upon success.
3041 int __init omap_hwmod_setup_one(const char *oh_name)
3043 struct omap_hwmod *oh;
3045 pr_debug("omap_hwmod: %s: %s\n", oh_name, __func__);
3047 oh = _lookup(oh_name);
3049 WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name);
3053 _ensure_mpu_hwmod_is_setup(oh);
3062 * omap_hwmod_setup_earlycon_flags - set up flags for early console
3064 * Enable DEBUG_OMAPUART_FLAGS for uart hwmod that is being used as
3065 * early concole so that hwmod core doesn't reset and keep it in idle
3066 * that specific uart.
3068 #ifdef CONFIG_SERIAL_EARLYCON
3069 static void __init omap_hwmod_setup_earlycon_flags(void)
3071 struct device_node *np;
3072 struct omap_hwmod *oh;
3075 np = of_find_node_by_path("/chosen");
3077 uart = of_get_property(np, "stdout-path", NULL);
3079 np = of_find_node_by_path(uart);
3081 uart = of_get_property(np, "ti,hwmods", NULL);
3082 oh = omap_hwmod_lookup(uart);
3084 oh->flags |= DEBUG_OMAPUART_FLAGS;
3092 * omap_hwmod_setup_all - set up all registered IP blocks
3094 * Initialize and set up all IP blocks registered with the hwmod code.
3095 * Must be called after omap2_clk_init(). Resolves the struct clk
3096 * names to struct clk pointers for each registered omap_hwmod. Also
3097 * calls _setup() on each hwmod. Returns 0 upon success.
3099 static int __init omap_hwmod_setup_all(void)
3101 _ensure_mpu_hwmod_is_setup(NULL);
3103 omap_hwmod_for_each(_init, NULL);
3104 #ifdef CONFIG_SERIAL_EARLYCON
3105 omap_hwmod_setup_earlycon_flags();
3107 omap_hwmod_for_each(_setup, NULL);
3111 omap_postcore_initcall(omap_hwmod_setup_all);
3114 * omap_hwmod_enable - enable an omap_hwmod
3115 * @oh: struct omap_hwmod *
3117 * Enable an omap_hwmod @oh. Intended to be called by omap_device_enable().
3118 * Returns -EINVAL on error or passes along the return value from _enable().
3120 int omap_hwmod_enable(struct omap_hwmod *oh)
3123 unsigned long flags;
3128 spin_lock_irqsave(&oh->_lock, flags);
3130 spin_unlock_irqrestore(&oh->_lock, flags);
3136 * omap_hwmod_idle - idle an omap_hwmod
3137 * @oh: struct omap_hwmod *
3139 * Idle an omap_hwmod @oh. Intended to be called by omap_device_idle().
3140 * Returns -EINVAL on error or passes along the return value from _idle().
3142 int omap_hwmod_idle(struct omap_hwmod *oh)
3145 unsigned long flags;
3150 spin_lock_irqsave(&oh->_lock, flags);
3152 spin_unlock_irqrestore(&oh->_lock, flags);
3158 * omap_hwmod_shutdown - shutdown an omap_hwmod
3159 * @oh: struct omap_hwmod *
3161 * Shutdown an omap_hwmod @oh. Intended to be called by
3162 * omap_device_shutdown(). Returns -EINVAL on error or passes along
3163 * the return value from _shutdown().
3165 int omap_hwmod_shutdown(struct omap_hwmod *oh)
3168 unsigned long flags;
3173 spin_lock_irqsave(&oh->_lock, flags);
3175 spin_unlock_irqrestore(&oh->_lock, flags);
3181 * IP block data retrieval functions
3185 * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
3186 * @oh: struct omap_hwmod *
3188 * Return the powerdomain pointer associated with the OMAP module
3189 * @oh's main clock. If @oh does not have a main clk, return the
3190 * powerdomain associated with the interface clock associated with the
3191 * module's MPU port. (XXX Perhaps this should use the SDMA port
3192 * instead?) Returns NULL on error, or a struct powerdomain * on
3195 struct powerdomain *omap_hwmod_get_pwrdm(struct omap_hwmod *oh)
3198 struct omap_hwmod_ocp_if *oi;
3199 struct clockdomain *clkdm;
3200 struct clk_hw_omap *clk;
3206 return oh->clkdm->pwrdm.ptr;
3211 oi = _find_mpu_rt_port(oh);
3217 clk = to_clk_hw_omap(__clk_get_hw(c));
3222 return clkdm->pwrdm.ptr;
3226 * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
3227 * @oh: struct omap_hwmod *
3229 * Returns the virtual address corresponding to the beginning of the
3230 * module's register target, in the address range that is intended to
3231 * be used by the MPU. Returns the virtual address upon success or NULL
3234 void __iomem *omap_hwmod_get_mpu_rt_va(struct omap_hwmod *oh)
3239 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
3242 if (oh->_state == _HWMOD_STATE_UNKNOWN)
3245 return oh->_mpu_rt_va;
3249 * XXX what about functions for drivers to save/restore ocp_sysconfig
3250 * for context save/restore operations?
3254 * omap_hwmod_enable_wakeup - allow device to wake up the system
3255 * @oh: struct omap_hwmod *
3257 * Sets the module OCP socket ENAWAKEUP bit to allow the module to
3258 * send wakeups to the PRCM, and enable I/O ring wakeup events for
3259 * this IP block if it has dynamic mux entries. Eventually this
3260 * should set PRCM wakeup registers to cause the PRCM to receive
3261 * wakeup events from the module. Does not set any wakeup routing
3262 * registers beyond this point - if the module is to wake up any other
3263 * module or subsystem, that must be set separately. Called by
3264 * omap_device code. Returns -EINVAL on error or 0 upon success.
3266 int omap_hwmod_enable_wakeup(struct omap_hwmod *oh)
3268 unsigned long flags;
3271 spin_lock_irqsave(&oh->_lock, flags);
3273 if (oh->class->sysc &&
3274 (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)) {
3275 v = oh->_sysc_cache;
3276 _enable_wakeup(oh, &v);
3277 _write_sysconfig(v, oh);
3280 spin_unlock_irqrestore(&oh->_lock, flags);
3286 * omap_hwmod_disable_wakeup - prevent device from waking the system
3287 * @oh: struct omap_hwmod *
3289 * Clears the module OCP socket ENAWAKEUP bit to prevent the module
3290 * from sending wakeups to the PRCM, and disable I/O ring wakeup
3291 * events for this IP block if it has dynamic mux entries. Eventually
3292 * this should clear PRCM wakeup registers to cause the PRCM to ignore
3293 * wakeup events from the module. Does not set any wakeup routing
3294 * registers beyond this point - if the module is to wake up any other
3295 * module or subsystem, that must be set separately. Called by
3296 * omap_device code. Returns -EINVAL on error or 0 upon success.
3298 int omap_hwmod_disable_wakeup(struct omap_hwmod *oh)
3300 unsigned long flags;
3303 spin_lock_irqsave(&oh->_lock, flags);
3305 if (oh->class->sysc &&
3306 (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)) {
3307 v = oh->_sysc_cache;
3308 _disable_wakeup(oh, &v);
3309 _write_sysconfig(v, oh);
3312 spin_unlock_irqrestore(&oh->_lock, flags);
3318 * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
3319 * contained in the hwmod module.
3320 * @oh: struct omap_hwmod *
3321 * @name: name of the reset line to lookup and assert
3323 * Some IP like dsp, ipu or iva contain processor that require
3324 * an HW reset line to be assert / deassert in order to enable fully
3325 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3326 * yet supported on this OMAP; otherwise, passes along the return value
3327 * from _assert_hardreset().
3329 int omap_hwmod_assert_hardreset(struct omap_hwmod *oh, const char *name)
3332 unsigned long flags;
3337 spin_lock_irqsave(&oh->_lock, flags);
3338 ret = _assert_hardreset(oh, name);
3339 spin_unlock_irqrestore(&oh->_lock, flags);
3345 * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
3346 * contained in the hwmod module.
3347 * @oh: struct omap_hwmod *
3348 * @name: name of the reset line to look up and deassert
3350 * Some IP like dsp, ipu or iva contain processor that require
3351 * an HW reset line to be assert / deassert in order to enable fully
3352 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3353 * yet supported on this OMAP; otherwise, passes along the return value
3354 * from _deassert_hardreset().
3356 int omap_hwmod_deassert_hardreset(struct omap_hwmod *oh, const char *name)
3359 unsigned long flags;
3364 spin_lock_irqsave(&oh->_lock, flags);
3365 ret = _deassert_hardreset(oh, name);
3366 spin_unlock_irqrestore(&oh->_lock, flags);
3372 * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
3373 * @classname: struct omap_hwmod_class name to search for
3374 * @fn: callback function pointer to call for each hwmod in class @classname
3375 * @user: arbitrary context data to pass to the callback function
3377 * For each omap_hwmod of class @classname, call @fn.
3378 * If the callback function returns something other than
3379 * zero, the iterator is terminated, and the callback function's return
3380 * value is passed back to the caller. Returns 0 upon success, -EINVAL
3381 * if @classname or @fn are NULL, or passes back the error code from @fn.
3383 int omap_hwmod_for_each_by_class(const char *classname,
3384 int (*fn)(struct omap_hwmod *oh,
3388 struct omap_hwmod *temp_oh;
3391 if (!classname || !fn)
3394 pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
3395 __func__, classname);
3397 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
3398 if (!strcmp(temp_oh->class->name, classname)) {
3399 pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
3400 __func__, temp_oh->name);
3401 ret = (*fn)(temp_oh, user);
3408 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
3415 * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
3416 * @oh: struct omap_hwmod *
3417 * @state: state that _setup() should leave the hwmod in
3419 * Sets the hwmod state that @oh will enter at the end of _setup()
3420 * (called by omap_hwmod_setup_*()). See also the documentation
3421 * for _setup_postsetup(), above. Returns 0 upon success or
3422 * -EINVAL if there is a problem with the arguments or if the hwmod is
3423 * in the wrong state.
3425 int omap_hwmod_set_postsetup_state(struct omap_hwmod *oh, u8 state)
3428 unsigned long flags;
3433 if (state != _HWMOD_STATE_DISABLED &&
3434 state != _HWMOD_STATE_ENABLED &&
3435 state != _HWMOD_STATE_IDLE)
3438 spin_lock_irqsave(&oh->_lock, flags);
3440 if (oh->_state != _HWMOD_STATE_REGISTERED) {
3445 oh->_postsetup_state = state;
3449 spin_unlock_irqrestore(&oh->_lock, flags);
3455 * omap_hwmod_get_context_loss_count - get lost context count
3456 * @oh: struct omap_hwmod *
3458 * Returns the context loss count of associated @oh
3459 * upon success, or zero if no context loss data is available.
3461 * On OMAP4, this queries the per-hwmod context loss register,
3462 * assuming one exists. If not, or on OMAP2/3, this queries the
3463 * enclosing powerdomain context loss count.
3465 int omap_hwmod_get_context_loss_count(struct omap_hwmod *oh)
3467 struct powerdomain *pwrdm;
3470 if (soc_ops.get_context_lost)
3471 return soc_ops.get_context_lost(oh);
3473 pwrdm = omap_hwmod_get_pwrdm(oh);
3475 ret = pwrdm_get_context_loss_count(pwrdm);
3481 * omap_hwmod_init - initialize the hwmod code
3483 * Sets up some function pointers needed by the hwmod code to operate on the
3484 * currently-booted SoC. Intended to be called once during kernel init
3485 * before any hwmods are registered. No return value.
3487 void __init omap_hwmod_init(void)
3489 if (cpu_is_omap24xx()) {
3490 soc_ops.wait_target_ready = _omap2xxx_3xxx_wait_target_ready;
3491 soc_ops.assert_hardreset = _omap2_assert_hardreset;
3492 soc_ops.deassert_hardreset = _omap2_deassert_hardreset;
3493 soc_ops.is_hardreset_asserted = _omap2_is_hardreset_asserted;
3494 } else if (cpu_is_omap34xx()) {
3495 soc_ops.wait_target_ready = _omap2xxx_3xxx_wait_target_ready;
3496 soc_ops.assert_hardreset = _omap2_assert_hardreset;
3497 soc_ops.deassert_hardreset = _omap2_deassert_hardreset;
3498 soc_ops.is_hardreset_asserted = _omap2_is_hardreset_asserted;
3499 soc_ops.init_clkdm = _init_clkdm;
3500 } else if (cpu_is_omap44xx() || soc_is_omap54xx() || soc_is_dra7xx()) {
3501 soc_ops.enable_module = _omap4_enable_module;
3502 soc_ops.disable_module = _omap4_disable_module;
3503 soc_ops.wait_target_ready = _omap4_wait_target_ready;
3504 soc_ops.assert_hardreset = _omap4_assert_hardreset;
3505 soc_ops.deassert_hardreset = _omap4_deassert_hardreset;
3506 soc_ops.is_hardreset_asserted = _omap4_is_hardreset_asserted;
3507 soc_ops.init_clkdm = _init_clkdm;
3508 soc_ops.update_context_lost = _omap4_update_context_lost;
3509 soc_ops.get_context_lost = _omap4_get_context_lost;
3510 soc_ops.disable_direct_prcm = _omap4_disable_direct_prcm;
3511 soc_ops.xlate_clkctrl = _omap4_xlate_clkctrl;
3512 } else if (cpu_is_ti814x() || cpu_is_ti816x() || soc_is_am33xx() ||
3514 soc_ops.enable_module = _omap4_enable_module;
3515 soc_ops.disable_module = _omap4_disable_module;
3516 soc_ops.wait_target_ready = _omap4_wait_target_ready;
3517 soc_ops.assert_hardreset = _omap4_assert_hardreset;
3518 soc_ops.deassert_hardreset = _am33xx_deassert_hardreset;
3519 soc_ops.is_hardreset_asserted = _omap4_is_hardreset_asserted;
3520 soc_ops.init_clkdm = _init_clkdm;
3521 soc_ops.disable_direct_prcm = _omap4_disable_direct_prcm;
3522 soc_ops.xlate_clkctrl = _omap4_xlate_clkctrl;
3524 WARN(1, "omap_hwmod: unknown SoC type\n");
3527 _init_clkctrl_providers();
3533 * omap_hwmod_get_main_clk - get pointer to main clock name
3534 * @oh: struct omap_hwmod *
3536 * Returns the main clock name assocated with @oh upon success,
3537 * or NULL if @oh is NULL.
3539 const char *omap_hwmod_get_main_clk(struct omap_hwmod *oh)
3544 return oh->main_clk;