2 * omap_hwmod implementation for OMAP2/3/4
4 * Copyright (C) 2009-2011 Nokia Corporation
5 * Copyright (C) 2011 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 * | (__raw_{read,write}l, 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/delay.h>
135 #include <linux/err.h>
136 #include <linux/list.h>
137 #include <linux/mutex.h>
138 #include <linux/spinlock.h>
141 #include <plat/cpu.h>
142 #include "clockdomain.h"
143 #include "powerdomain.h"
144 #include <plat/clock.h>
145 #include <plat/omap_hwmod.h>
146 #include <plat/prcm.h>
148 #include "cm2xxx_3xxx.h"
149 #include "cminst44xx.h"
150 #include "prm2xxx_3xxx.h"
152 #include "prminst44xx.h"
155 /* Maximum microseconds to wait for OMAP module to softreset */
156 #define MAX_MODULE_SOFTRESET_WAIT 10000
158 /* Name of the OMAP hwmod for the MPU */
159 #define MPU_INITIATOR_NAME "mpu"
161 /* omap_hwmod_list contains all registered struct omap_hwmods */
162 static LIST_HEAD(omap_hwmod_list);
164 /* mpu_oh: used to add/remove MPU initiator from sleepdep list */
165 static struct omap_hwmod *mpu_oh;
168 /* Private functions */
171 * _update_sysc_cache - return the module OCP_SYSCONFIG register, keep copy
172 * @oh: struct omap_hwmod *
174 * Load the current value of the hwmod OCP_SYSCONFIG register into the
175 * struct omap_hwmod for later use. Returns -EINVAL if the hwmod has no
176 * OCP_SYSCONFIG register or 0 upon success.
178 static int _update_sysc_cache(struct omap_hwmod *oh)
180 if (!oh->class->sysc) {
181 WARN(1, "omap_hwmod: %s: cannot read OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
185 /* XXX ensure module interface clock is up */
187 oh->_sysc_cache = omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
189 if (!(oh->class->sysc->sysc_flags & SYSC_NO_CACHE))
190 oh->_int_flags |= _HWMOD_SYSCONFIG_LOADED;
196 * _write_sysconfig - write a value to the module's OCP_SYSCONFIG register
197 * @v: OCP_SYSCONFIG value to write
198 * @oh: struct omap_hwmod *
200 * Write @v into the module class' OCP_SYSCONFIG register, if it has
201 * one. No return value.
203 static void _write_sysconfig(u32 v, struct omap_hwmod *oh)
205 if (!oh->class->sysc) {
206 WARN(1, "omap_hwmod: %s: cannot write OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
210 /* XXX ensure module interface clock is up */
212 /* Module might have lost context, always update cache and register */
214 omap_hwmod_write(v, oh, oh->class->sysc->sysc_offs);
218 * _set_master_standbymode: set the OCP_SYSCONFIG MIDLEMODE field in @v
219 * @oh: struct omap_hwmod *
220 * @standbymode: MIDLEMODE field bits
221 * @v: pointer to register contents to modify
223 * Update the master standby mode bits in @v to be @standbymode for
224 * the @oh hwmod. Does not write to the hardware. Returns -EINVAL
225 * upon error or 0 upon success.
227 static int _set_master_standbymode(struct omap_hwmod *oh, u8 standbymode,
233 if (!oh->class->sysc ||
234 !(oh->class->sysc->sysc_flags & SYSC_HAS_MIDLEMODE))
237 if (!oh->class->sysc->sysc_fields) {
238 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
242 mstandby_shift = oh->class->sysc->sysc_fields->midle_shift;
243 mstandby_mask = (0x3 << mstandby_shift);
245 *v &= ~mstandby_mask;
246 *v |= __ffs(standbymode) << mstandby_shift;
252 * _set_slave_idlemode: set the OCP_SYSCONFIG SIDLEMODE field in @v
253 * @oh: struct omap_hwmod *
254 * @idlemode: SIDLEMODE field bits
255 * @v: pointer to register contents to modify
257 * Update the slave idle mode bits in @v to be @idlemode for the @oh
258 * hwmod. Does not write to the hardware. Returns -EINVAL upon error
261 static int _set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode, u32 *v)
266 if (!oh->class->sysc ||
267 !(oh->class->sysc->sysc_flags & SYSC_HAS_SIDLEMODE))
270 if (!oh->class->sysc->sysc_fields) {
271 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
275 sidle_shift = oh->class->sysc->sysc_fields->sidle_shift;
276 sidle_mask = (0x3 << sidle_shift);
279 *v |= __ffs(idlemode) << sidle_shift;
285 * _set_clockactivity: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
286 * @oh: struct omap_hwmod *
287 * @clockact: CLOCKACTIVITY field bits
288 * @v: pointer to register contents to modify
290 * Update the clockactivity mode bits in @v to be @clockact for the
291 * @oh hwmod. Used for additional powersaving on some modules. Does
292 * not write to the hardware. Returns -EINVAL upon error or 0 upon
295 static int _set_clockactivity(struct omap_hwmod *oh, u8 clockact, u32 *v)
300 if (!oh->class->sysc ||
301 !(oh->class->sysc->sysc_flags & SYSC_HAS_CLOCKACTIVITY))
304 if (!oh->class->sysc->sysc_fields) {
305 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
309 clkact_shift = oh->class->sysc->sysc_fields->clkact_shift;
310 clkact_mask = (0x3 << clkact_shift);
313 *v |= clockact << clkact_shift;
319 * _set_softreset: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
320 * @oh: struct omap_hwmod *
321 * @v: pointer to register contents to modify
323 * Set the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
324 * error or 0 upon success.
326 static int _set_softreset(struct omap_hwmod *oh, u32 *v)
330 if (!oh->class->sysc ||
331 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
334 if (!oh->class->sysc->sysc_fields) {
335 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
339 softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
347 * _set_module_autoidle: set the OCP_SYSCONFIG AUTOIDLE field in @v
348 * @oh: struct omap_hwmod *
349 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
350 * @v: pointer to register contents to modify
352 * Update the module autoidle bit in @v to be @autoidle for the @oh
353 * hwmod. The autoidle bit controls whether the module can gate
354 * internal clocks automatically when it isn't doing anything; the
355 * exact function of this bit varies on a per-module basis. This
356 * function does not write to the hardware. Returns -EINVAL upon
357 * error or 0 upon success.
359 static int _set_module_autoidle(struct omap_hwmod *oh, u8 autoidle,
365 if (!oh->class->sysc ||
366 !(oh->class->sysc->sysc_flags & SYSC_HAS_AUTOIDLE))
369 if (!oh->class->sysc->sysc_fields) {
370 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
374 autoidle_shift = oh->class->sysc->sysc_fields->autoidle_shift;
375 autoidle_mask = (0x1 << autoidle_shift);
377 *v &= ~autoidle_mask;
378 *v |= autoidle << autoidle_shift;
384 * _enable_wakeup: set OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
385 * @oh: struct omap_hwmod *
387 * Allow the hardware module @oh to send wakeups. Returns -EINVAL
388 * upon error or 0 upon success.
390 static int _enable_wakeup(struct omap_hwmod *oh, u32 *v)
392 if (!oh->class->sysc ||
393 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
394 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
395 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
398 if (!oh->class->sysc->sysc_fields) {
399 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
403 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
404 *v |= 0x1 << oh->class->sysc->sysc_fields->enwkup_shift;
406 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
407 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
408 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
409 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
411 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
413 oh->_int_flags |= _HWMOD_WAKEUP_ENABLED;
419 * _disable_wakeup: clear OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
420 * @oh: struct omap_hwmod *
422 * Prevent the hardware module @oh to send wakeups. Returns -EINVAL
423 * upon error or 0 upon success.
425 static int _disable_wakeup(struct omap_hwmod *oh, u32 *v)
427 if (!oh->class->sysc ||
428 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
429 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
430 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
433 if (!oh->class->sysc->sysc_fields) {
434 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
438 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
439 *v &= ~(0x1 << oh->class->sysc->sysc_fields->enwkup_shift);
441 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
442 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART, v);
443 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
444 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
446 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
448 oh->_int_flags &= ~_HWMOD_WAKEUP_ENABLED;
454 * _add_initiator_dep: prevent @oh from smart-idling while @init_oh is active
455 * @oh: struct omap_hwmod *
457 * Prevent the hardware module @oh from entering idle while the
458 * hardare module initiator @init_oh is active. Useful when a module
459 * will be accessed by a particular initiator (e.g., if a module will
460 * be accessed by the IVA, there should be a sleepdep between the IVA
461 * initiator and the module). Only applies to modules in smart-idle
462 * mode. If the clockdomain is marked as not needing autodeps, return
463 * 0 without doing anything. Otherwise, returns -EINVAL upon error or
464 * passes along clkdm_add_sleepdep() value upon success.
466 static int _add_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
471 if (oh->_clk->clkdm && oh->_clk->clkdm->flags & CLKDM_NO_AUTODEPS)
474 return clkdm_add_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
478 * _del_initiator_dep: allow @oh to smart-idle even if @init_oh is active
479 * @oh: struct omap_hwmod *
481 * Allow the hardware module @oh to enter idle while the hardare
482 * module initiator @init_oh is active. Useful when a module will not
483 * be accessed by a particular initiator (e.g., if a module will not
484 * be accessed by the IVA, there should be no sleepdep between the IVA
485 * initiator and the module). Only applies to modules in smart-idle
486 * mode. If the clockdomain is marked as not needing autodeps, return
487 * 0 without doing anything. Returns -EINVAL upon error or passes
488 * along clkdm_del_sleepdep() value upon success.
490 static int _del_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
495 if (oh->_clk->clkdm && oh->_clk->clkdm->flags & CLKDM_NO_AUTODEPS)
498 return clkdm_del_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
502 * _init_main_clk - get a struct clk * for the the hwmod's main functional clk
503 * @oh: struct omap_hwmod *
505 * Called from _init_clocks(). Populates the @oh _clk (main
506 * functional clock pointer) if a main_clk is present. Returns 0 on
507 * success or -EINVAL on error.
509 static int _init_main_clk(struct omap_hwmod *oh)
516 oh->_clk = omap_clk_get_by_name(oh->main_clk);
518 pr_warning("omap_hwmod: %s: cannot clk_get main_clk %s\n",
519 oh->name, oh->main_clk);
523 if (!oh->_clk->clkdm)
524 pr_warning("omap_hwmod: %s: missing clockdomain for %s.\n",
525 oh->main_clk, oh->_clk->name);
531 * _init_interface_clks - get a struct clk * for the the hwmod's interface clks
532 * @oh: struct omap_hwmod *
534 * Called from _init_clocks(). Populates the @oh OCP slave interface
535 * clock pointers. Returns 0 on success or -EINVAL on error.
537 static int _init_interface_clks(struct omap_hwmod *oh)
543 if (oh->slaves_cnt == 0)
546 for (i = 0; i < oh->slaves_cnt; i++) {
547 struct omap_hwmod_ocp_if *os = oh->slaves[i];
552 c = omap_clk_get_by_name(os->clk);
554 pr_warning("omap_hwmod: %s: cannot clk_get interface_clk %s\n",
565 * _init_opt_clk - get a struct clk * for the the hwmod's optional clocks
566 * @oh: struct omap_hwmod *
568 * Called from _init_clocks(). Populates the @oh omap_hwmod_opt_clk
569 * clock pointers. Returns 0 on success or -EINVAL on error.
571 static int _init_opt_clks(struct omap_hwmod *oh)
573 struct omap_hwmod_opt_clk *oc;
578 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++) {
579 c = omap_clk_get_by_name(oc->clk);
581 pr_warning("omap_hwmod: %s: cannot clk_get opt_clk %s\n",
592 * _enable_clocks - enable hwmod main clock and interface clocks
593 * @oh: struct omap_hwmod *
595 * Enables all clocks necessary for register reads and writes to succeed
596 * on the hwmod @oh. Returns 0.
598 static int _enable_clocks(struct omap_hwmod *oh)
602 pr_debug("omap_hwmod: %s: enabling clocks\n", oh->name);
605 clk_enable(oh->_clk);
607 if (oh->slaves_cnt > 0) {
608 for (i = 0; i < oh->slaves_cnt; i++) {
609 struct omap_hwmod_ocp_if *os = oh->slaves[i];
610 struct clk *c = os->_clk;
612 if (c && (os->flags & OCPIF_SWSUP_IDLE))
617 /* The opt clocks are controlled by the device driver. */
623 * _disable_clocks - disable hwmod main clock and interface clocks
624 * @oh: struct omap_hwmod *
626 * Disables the hwmod @oh main functional and interface clocks. Returns 0.
628 static int _disable_clocks(struct omap_hwmod *oh)
632 pr_debug("omap_hwmod: %s: disabling clocks\n", oh->name);
635 clk_disable(oh->_clk);
637 if (oh->slaves_cnt > 0) {
638 for (i = 0; i < oh->slaves_cnt; i++) {
639 struct omap_hwmod_ocp_if *os = oh->slaves[i];
640 struct clk *c = os->_clk;
642 if (c && (os->flags & OCPIF_SWSUP_IDLE))
647 /* The opt clocks are controlled by the device driver. */
652 static void _enable_optional_clocks(struct omap_hwmod *oh)
654 struct omap_hwmod_opt_clk *oc;
657 pr_debug("omap_hwmod: %s: enabling optional clocks\n", oh->name);
659 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
661 pr_debug("omap_hwmod: enable %s:%s\n", oc->role,
663 clk_enable(oc->_clk);
667 static void _disable_optional_clocks(struct omap_hwmod *oh)
669 struct omap_hwmod_opt_clk *oc;
672 pr_debug("omap_hwmod: %s: disabling optional clocks\n", oh->name);
674 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
676 pr_debug("omap_hwmod: disable %s:%s\n", oc->role,
678 clk_disable(oc->_clk);
683 * _enable_module - enable CLKCTRL modulemode on OMAP4
684 * @oh: struct omap_hwmod *
686 * Enables the PRCM module mode related to the hwmod @oh.
689 static void _enable_module(struct omap_hwmod *oh)
691 /* The module mode does not exist prior OMAP4 */
692 if (cpu_is_omap24xx() || cpu_is_omap34xx())
695 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
698 pr_debug("omap_hwmod: %s: _enable_module: %d\n",
699 oh->name, oh->prcm.omap4.modulemode);
701 omap4_cminst_module_enable(oh->prcm.omap4.modulemode,
702 oh->clkdm->prcm_partition,
704 oh->clkdm->clkdm_offs,
705 oh->prcm.omap4.clkctrl_offs);
709 * _disable_module - enable CLKCTRL modulemode on OMAP4
710 * @oh: struct omap_hwmod *
712 * Disable the PRCM module mode related to the hwmod @oh.
715 static void _disable_module(struct omap_hwmod *oh)
717 /* The module mode does not exist prior OMAP4 */
718 if (cpu_is_omap24xx() || cpu_is_omap34xx())
721 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
724 pr_debug("omap_hwmod: %s: _disable_module\n", oh->name);
726 omap4_cminst_module_disable(oh->clkdm->prcm_partition,
728 oh->clkdm->clkdm_offs,
729 oh->prcm.omap4.clkctrl_offs);
733 * _count_mpu_irqs - count the number of MPU IRQ lines associated with @oh
734 * @oh: struct omap_hwmod *oh
736 * Count and return the number of MPU IRQs associated with the hwmod
737 * @oh. Used to allocate struct resource data. Returns 0 if @oh is
740 static int _count_mpu_irqs(struct omap_hwmod *oh)
742 struct omap_hwmod_irq_info *ohii;
745 if (!oh || !oh->mpu_irqs)
749 ohii = &oh->mpu_irqs[i++];
750 } while (ohii->irq != -1);
756 * _count_sdma_reqs - count the number of SDMA request lines associated with @oh
757 * @oh: struct omap_hwmod *oh
759 * Count and return the number of SDMA request lines associated with
760 * the hwmod @oh. Used to allocate struct resource data. Returns 0
763 static int _count_sdma_reqs(struct omap_hwmod *oh)
765 struct omap_hwmod_dma_info *ohdi;
768 if (!oh || !oh->sdma_reqs)
772 ohdi = &oh->sdma_reqs[i++];
773 } while (ohdi->dma_req != -1);
779 * _count_ocp_if_addr_spaces - count the number of address space entries for @oh
780 * @oh: struct omap_hwmod *oh
782 * Count and return the number of address space ranges associated with
783 * the hwmod @oh. Used to allocate struct resource data. Returns 0
786 static int _count_ocp_if_addr_spaces(struct omap_hwmod_ocp_if *os)
788 struct omap_hwmod_addr_space *mem;
791 if (!os || !os->addr)
795 mem = &os->addr[i++];
796 } while (mem->pa_start != mem->pa_end);
802 * _find_mpu_port_index - find hwmod OCP slave port ID intended for MPU use
803 * @oh: struct omap_hwmod *
805 * Returns the array index of the OCP slave port that the MPU
806 * addresses the device on, or -EINVAL upon error or not found.
808 static int __init _find_mpu_port_index(struct omap_hwmod *oh)
813 if (!oh || oh->slaves_cnt == 0)
816 for (i = 0; i < oh->slaves_cnt; i++) {
817 struct omap_hwmod_ocp_if *os = oh->slaves[i];
819 if (os->user & OCP_USER_MPU) {
826 pr_debug("omap_hwmod: %s: MPU OCP slave port ID %d\n",
829 pr_debug("omap_hwmod: %s: no MPU OCP slave port found\n",
832 return (found) ? i : -EINVAL;
836 * _find_mpu_rt_base - find hwmod register target base addr accessible by MPU
837 * @oh: struct omap_hwmod *
839 * Return the virtual address of the base of the register target of
840 * device @oh, or NULL on error.
842 static void __iomem * __init _find_mpu_rt_base(struct omap_hwmod *oh, u8 index)
844 struct omap_hwmod_ocp_if *os;
845 struct omap_hwmod_addr_space *mem;
846 int i = 0, found = 0;
847 void __iomem *va_start;
849 if (!oh || oh->slaves_cnt == 0)
852 os = oh->slaves[index];
858 mem = &os->addr[i++];
859 if (mem->flags & ADDR_TYPE_RT)
861 } while (!found && mem->pa_start != mem->pa_end);
864 va_start = ioremap(mem->pa_start, mem->pa_end - mem->pa_start);
866 pr_err("omap_hwmod: %s: Could not ioremap\n", oh->name);
869 pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
872 pr_debug("omap_hwmod: %s: no MPU register target found\n",
876 return (found) ? va_start : NULL;
880 * _enable_sysc - try to bring a module out of idle via OCP_SYSCONFIG
881 * @oh: struct omap_hwmod *
883 * If module is marked as SWSUP_SIDLE, force the module out of slave
884 * idle; otherwise, configure it for smart-idle. If module is marked
885 * as SWSUP_MSUSPEND, force the module out of master standby;
886 * otherwise, configure it for smart-standby. No return value.
888 static void _enable_sysc(struct omap_hwmod *oh)
893 if (!oh->class->sysc)
897 sf = oh->class->sysc->sysc_flags;
899 if (sf & SYSC_HAS_SIDLEMODE) {
900 idlemode = (oh->flags & HWMOD_SWSUP_SIDLE) ?
901 HWMOD_IDLEMODE_NO : HWMOD_IDLEMODE_SMART;
902 _set_slave_idlemode(oh, idlemode, &v);
905 if (sf & SYSC_HAS_MIDLEMODE) {
906 if (oh->flags & HWMOD_SWSUP_MSTANDBY) {
907 idlemode = HWMOD_IDLEMODE_NO;
909 if (sf & SYSC_HAS_ENAWAKEUP)
910 _enable_wakeup(oh, &v);
911 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
912 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
914 idlemode = HWMOD_IDLEMODE_SMART;
916 _set_master_standbymode(oh, idlemode, &v);
920 * XXX The clock framework should handle this, by
921 * calling into this code. But this must wait until the
922 * clock structures are tagged with omap_hwmod entries
924 if ((oh->flags & HWMOD_SET_DEFAULT_CLOCKACT) &&
925 (sf & SYSC_HAS_CLOCKACTIVITY))
926 _set_clockactivity(oh, oh->class->sysc->clockact, &v);
928 /* If slave is in SMARTIDLE, also enable wakeup */
929 if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
930 _enable_wakeup(oh, &v);
932 _write_sysconfig(v, oh);
935 * Set the autoidle bit only after setting the smartidle bit
936 * Setting this will not have any impact on the other modules.
938 if (sf & SYSC_HAS_AUTOIDLE) {
939 idlemode = (oh->flags & HWMOD_NO_OCP_AUTOIDLE) ?
941 _set_module_autoidle(oh, idlemode, &v);
942 _write_sysconfig(v, oh);
947 * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
948 * @oh: struct omap_hwmod *
950 * If module is marked as SWSUP_SIDLE, force the module into slave
951 * idle; otherwise, configure it for smart-idle. If module is marked
952 * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
953 * configure it for smart-standby. No return value.
955 static void _idle_sysc(struct omap_hwmod *oh)
960 if (!oh->class->sysc)
964 sf = oh->class->sysc->sysc_flags;
966 if (sf & SYSC_HAS_SIDLEMODE) {
967 idlemode = (oh->flags & HWMOD_SWSUP_SIDLE) ?
968 HWMOD_IDLEMODE_FORCE : HWMOD_IDLEMODE_SMART;
969 _set_slave_idlemode(oh, idlemode, &v);
972 if (sf & SYSC_HAS_MIDLEMODE) {
973 if (oh->flags & HWMOD_SWSUP_MSTANDBY) {
974 idlemode = HWMOD_IDLEMODE_FORCE;
976 if (sf & SYSC_HAS_ENAWAKEUP)
977 _enable_wakeup(oh, &v);
978 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
979 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
981 idlemode = HWMOD_IDLEMODE_SMART;
983 _set_master_standbymode(oh, idlemode, &v);
986 /* If slave is in SMARTIDLE, also enable wakeup */
987 if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
988 _enable_wakeup(oh, &v);
990 _write_sysconfig(v, oh);
994 * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
995 * @oh: struct omap_hwmod *
997 * Force the module into slave idle and master suspend. No return
1000 static void _shutdown_sysc(struct omap_hwmod *oh)
1005 if (!oh->class->sysc)
1008 v = oh->_sysc_cache;
1009 sf = oh->class->sysc->sysc_flags;
1011 if (sf & SYSC_HAS_SIDLEMODE)
1012 _set_slave_idlemode(oh, HWMOD_IDLEMODE_FORCE, &v);
1014 if (sf & SYSC_HAS_MIDLEMODE)
1015 _set_master_standbymode(oh, HWMOD_IDLEMODE_FORCE, &v);
1017 if (sf & SYSC_HAS_AUTOIDLE)
1018 _set_module_autoidle(oh, 1, &v);
1020 _write_sysconfig(v, oh);
1024 * _lookup - find an omap_hwmod by name
1025 * @name: find an omap_hwmod by name
1027 * Return a pointer to an omap_hwmod by name, or NULL if not found.
1029 static struct omap_hwmod *_lookup(const char *name)
1031 struct omap_hwmod *oh, *temp_oh;
1035 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1036 if (!strcmp(name, temp_oh->name)) {
1045 * _init_clkdm - look up a clockdomain name, store pointer in omap_hwmod
1046 * @oh: struct omap_hwmod *
1048 * Convert a clockdomain name stored in a struct omap_hwmod into a
1049 * clockdomain pointer, and save it into the struct omap_hwmod.
1050 * return -EINVAL if clkdm_name does not exist or if the lookup failed.
1052 static int _init_clkdm(struct omap_hwmod *oh)
1054 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1057 if (!oh->clkdm_name) {
1058 pr_warning("omap_hwmod: %s: no clkdm_name\n", oh->name);
1062 oh->clkdm = clkdm_lookup(oh->clkdm_name);
1064 pr_warning("omap_hwmod: %s: could not associate to clkdm %s\n",
1065 oh->name, oh->clkdm_name);
1069 pr_debug("omap_hwmod: %s: associated to clkdm %s\n",
1070 oh->name, oh->clkdm_name);
1076 * _init_clocks - clk_get() all clocks associated with this hwmod. Retrieve as
1077 * well the clockdomain.
1078 * @oh: struct omap_hwmod *
1079 * @data: not used; pass NULL
1081 * Called by omap_hwmod_setup_*() (after omap2_clk_init()).
1082 * Resolves all clock names embedded in the hwmod. Returns 0 on
1083 * success, or a negative error code on failure.
1085 static int _init_clocks(struct omap_hwmod *oh, void *data)
1089 if (oh->_state != _HWMOD_STATE_REGISTERED)
1092 pr_debug("omap_hwmod: %s: looking up clocks\n", oh->name);
1094 ret |= _init_main_clk(oh);
1095 ret |= _init_interface_clks(oh);
1096 ret |= _init_opt_clks(oh);
1097 ret |= _init_clkdm(oh);
1100 oh->_state = _HWMOD_STATE_CLKS_INITED;
1102 pr_warning("omap_hwmod: %s: cannot _init_clocks\n", oh->name);
1108 * _wait_target_ready - wait for a module to leave slave idle
1109 * @oh: struct omap_hwmod *
1111 * Wait for a module @oh to leave slave idle. Returns 0 if the module
1112 * does not have an IDLEST bit or if the module successfully leaves
1113 * slave idle; otherwise, pass along the return value of the
1114 * appropriate *_cm*_wait_module_ready() function.
1116 static int _wait_target_ready(struct omap_hwmod *oh)
1118 struct omap_hwmod_ocp_if *os;
1124 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
1127 os = oh->slaves[oh->_mpu_port_index];
1129 if (oh->flags & HWMOD_NO_IDLEST)
1132 /* XXX check module SIDLEMODE */
1134 /* XXX check clock enable states */
1136 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1137 ret = omap2_cm_wait_module_ready(oh->prcm.omap2.module_offs,
1138 oh->prcm.omap2.idlest_reg_id,
1139 oh->prcm.omap2.idlest_idle_bit);
1140 } else if (cpu_is_omap44xx()) {
1144 ret = omap4_cminst_wait_module_ready(oh->clkdm->prcm_partition,
1146 oh->clkdm->clkdm_offs,
1147 oh->prcm.omap4.clkctrl_offs);
1156 * _wait_target_disable - wait for a module to be disabled
1157 * @oh: struct omap_hwmod *
1159 * Wait for a module @oh to enter slave idle. Returns 0 if the module
1160 * does not have an IDLEST bit or if the module successfully enters
1161 * slave idle; otherwise, pass along the return value of the
1162 * appropriate *_cm*_wait_module_idle() function.
1164 static int _wait_target_disable(struct omap_hwmod *oh)
1166 /* TODO: For now just handle OMAP4+ */
1167 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1173 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
1176 if (oh->flags & HWMOD_NO_IDLEST)
1179 return omap4_cminst_wait_module_idle(oh->clkdm->prcm_partition,
1181 oh->clkdm->clkdm_offs,
1182 oh->prcm.omap4.clkctrl_offs);
1186 * _lookup_hardreset - fill register bit info for this hwmod/reset line
1187 * @oh: struct omap_hwmod *
1188 * @name: name of the reset line in the context of this hwmod
1189 * @ohri: struct omap_hwmod_rst_info * that this function will fill in
1191 * Return the bit position of the reset line that match the
1192 * input name. Return -ENOENT if not found.
1194 static u8 _lookup_hardreset(struct omap_hwmod *oh, const char *name,
1195 struct omap_hwmod_rst_info *ohri)
1199 for (i = 0; i < oh->rst_lines_cnt; i++) {
1200 const char *rst_line = oh->rst_lines[i].name;
1201 if (!strcmp(rst_line, name)) {
1202 ohri->rst_shift = oh->rst_lines[i].rst_shift;
1203 ohri->st_shift = oh->rst_lines[i].st_shift;
1204 pr_debug("omap_hwmod: %s: %s: %s: rst %d st %d\n",
1205 oh->name, __func__, rst_line, ohri->rst_shift,
1216 * _assert_hardreset - assert the HW reset line of submodules
1217 * contained in the hwmod module.
1218 * @oh: struct omap_hwmod *
1219 * @name: name of the reset line to lookup and assert
1221 * Some IP like dsp, ipu or iva contain processor that require
1222 * an HW reset line to be assert / deassert in order to enable fully
1225 static int _assert_hardreset(struct omap_hwmod *oh, const char *name)
1227 struct omap_hwmod_rst_info ohri;
1233 ret = _lookup_hardreset(oh, name, &ohri);
1234 if (IS_ERR_VALUE(ret))
1237 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1238 return omap2_prm_assert_hardreset(oh->prcm.omap2.module_offs,
1240 else if (cpu_is_omap44xx())
1241 return omap4_prminst_assert_hardreset(ohri.rst_shift,
1242 oh->clkdm->pwrdm.ptr->prcm_partition,
1243 oh->clkdm->pwrdm.ptr->prcm_offs,
1244 oh->prcm.omap4.rstctrl_offs);
1250 * _deassert_hardreset - deassert the HW reset line of submodules contained
1251 * in the hwmod module.
1252 * @oh: struct omap_hwmod *
1253 * @name: name of the reset line to look up and deassert
1255 * Some IP like dsp, ipu or iva contain processor that require
1256 * an HW reset line to be assert / deassert in order to enable fully
1259 static int _deassert_hardreset(struct omap_hwmod *oh, const char *name)
1261 struct omap_hwmod_rst_info ohri;
1267 ret = _lookup_hardreset(oh, name, &ohri);
1268 if (IS_ERR_VALUE(ret))
1271 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1272 ret = omap2_prm_deassert_hardreset(oh->prcm.omap2.module_offs,
1275 } else if (cpu_is_omap44xx()) {
1277 pr_err("omap_hwmod: %s: %s: hwmod data error: OMAP4 does not support st_shift\n",
1279 ret = omap4_prminst_deassert_hardreset(ohri.rst_shift,
1280 oh->clkdm->pwrdm.ptr->prcm_partition,
1281 oh->clkdm->pwrdm.ptr->prcm_offs,
1282 oh->prcm.omap4.rstctrl_offs);
1288 pr_warning("omap_hwmod: %s: failed to hardreset\n", oh->name);
1294 * _read_hardreset - read the HW reset line state of submodules
1295 * contained in the hwmod module
1296 * @oh: struct omap_hwmod *
1297 * @name: name of the reset line to look up and read
1299 * Return the state of the reset line.
1301 static int _read_hardreset(struct omap_hwmod *oh, const char *name)
1303 struct omap_hwmod_rst_info ohri;
1309 ret = _lookup_hardreset(oh, name, &ohri);
1310 if (IS_ERR_VALUE(ret))
1313 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1314 return omap2_prm_is_hardreset_asserted(oh->prcm.omap2.module_offs,
1316 } else if (cpu_is_omap44xx()) {
1317 return omap4_prminst_is_hardreset_asserted(ohri.rst_shift,
1318 oh->clkdm->pwrdm.ptr->prcm_partition,
1319 oh->clkdm->pwrdm.ptr->prcm_offs,
1320 oh->prcm.omap4.rstctrl_offs);
1327 * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1328 * @oh: struct omap_hwmod *
1330 * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit. hwmod must be
1331 * enabled for this to work. Returns -EINVAL if the hwmod cannot be
1332 * reset this way or if the hwmod is in the wrong state, -ETIMEDOUT if
1333 * the module did not reset in time, or 0 upon success.
1335 * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1336 * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1337 * use the SYSCONFIG softreset bit to provide the status.
1339 * Note that some IP like McBSP do have reset control but don't have
1342 static int _ocp_softreset(struct omap_hwmod *oh)
1348 if (!oh->class->sysc ||
1349 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
1352 /* clocks must be on for this operation */
1353 if (oh->_state != _HWMOD_STATE_ENABLED) {
1354 pr_warning("omap_hwmod: %s: reset can only be entered from "
1355 "enabled state\n", oh->name);
1359 /* For some modules, all optionnal clocks need to be enabled as well */
1360 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1361 _enable_optional_clocks(oh);
1363 pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh->name);
1365 v = oh->_sysc_cache;
1366 ret = _set_softreset(oh, &v);
1369 _write_sysconfig(v, oh);
1371 if (oh->class->sysc->sysc_flags & SYSS_HAS_RESET_STATUS)
1372 omap_test_timeout((omap_hwmod_read(oh,
1373 oh->class->sysc->syss_offs)
1374 & SYSS_RESETDONE_MASK),
1375 MAX_MODULE_SOFTRESET_WAIT, c);
1376 else if (oh->class->sysc->sysc_flags & SYSC_HAS_RESET_STATUS)
1377 omap_test_timeout(!(omap_hwmod_read(oh,
1378 oh->class->sysc->sysc_offs)
1379 & SYSC_TYPE2_SOFTRESET_MASK),
1380 MAX_MODULE_SOFTRESET_WAIT, c);
1382 if (c == MAX_MODULE_SOFTRESET_WAIT)
1383 pr_warning("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1384 oh->name, MAX_MODULE_SOFTRESET_WAIT);
1386 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh->name, c);
1389 * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1390 * _wait_target_ready() or _reset()
1393 ret = (c == MAX_MODULE_SOFTRESET_WAIT) ? -ETIMEDOUT : 0;
1396 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1397 _disable_optional_clocks(oh);
1403 * _reset - reset an omap_hwmod
1404 * @oh: struct omap_hwmod *
1406 * Resets an omap_hwmod @oh. The default software reset mechanism for
1407 * most OMAP IP blocks is triggered via the OCP_SYSCONFIG.SOFTRESET
1408 * bit. However, some hwmods cannot be reset via this method: some
1409 * are not targets and therefore have no OCP header registers to
1410 * access; others (like the IVA) have idiosyncratic reset sequences.
1411 * So for these relatively rare cases, custom reset code can be
1412 * supplied in the struct omap_hwmod_class .reset function pointer.
1413 * Passes along the return value from either _reset() or the custom
1414 * reset function - these must return -EINVAL if the hwmod cannot be
1415 * reset this way or if the hwmod is in the wrong state, -ETIMEDOUT if
1416 * the module did not reset in time, or 0 upon success.
1418 static int _reset(struct omap_hwmod *oh)
1422 pr_debug("omap_hwmod: %s: resetting\n", oh->name);
1424 ret = (oh->class->reset) ? oh->class->reset(oh) : _ocp_softreset(oh);
1430 * _enable - enable an omap_hwmod
1431 * @oh: struct omap_hwmod *
1433 * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
1434 * register target. Returns -EINVAL if the hwmod is in the wrong
1435 * state or passes along the return value of _wait_target_ready().
1437 static int _enable(struct omap_hwmod *oh)
1442 pr_debug("omap_hwmod: %s: enabling\n", oh->name);
1445 * hwmods with HWMOD_INIT_NO_IDLE flag set are left
1446 * in enabled state at init.
1447 * Now that someone is really trying to enable them,
1448 * just ensure that the hwmod mux is set.
1450 if (oh->_int_flags & _HWMOD_SKIP_ENABLE) {
1452 * If the caller has mux data populated, do the mux'ing
1453 * which wouldn't have been done as part of the _enable()
1454 * done during setup.
1457 omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
1459 oh->_int_flags &= ~_HWMOD_SKIP_ENABLE;
1463 if (oh->_state != _HWMOD_STATE_INITIALIZED &&
1464 oh->_state != _HWMOD_STATE_IDLE &&
1465 oh->_state != _HWMOD_STATE_DISABLED) {
1466 WARN(1, "omap_hwmod: %s: enabled state can only be entered "
1467 "from initialized, idle, or disabled state\n", oh->name);
1473 * If an IP contains only one HW reset line, then de-assert it in order
1474 * to allow the module state transition. Otherwise the PRCM will return
1475 * Intransition status, and the init will failed.
1477 if ((oh->_state == _HWMOD_STATE_INITIALIZED ||
1478 oh->_state == _HWMOD_STATE_DISABLED) && oh->rst_lines_cnt == 1)
1479 _deassert_hardreset(oh, oh->rst_lines[0].name);
1481 /* Mux pins for device runtime if populated */
1482 if (oh->mux && (!oh->mux->enabled ||
1483 ((oh->_state == _HWMOD_STATE_IDLE) &&
1484 oh->mux->pads_dynamic)))
1485 omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
1487 _add_initiator_dep(oh, mpu_oh);
1491 * A clockdomain must be in SW_SUP before enabling
1492 * completely the module. The clockdomain can be set
1493 * in HW_AUTO only when the module become ready.
1495 hwsup = clkdm_in_hwsup(oh->clkdm);
1496 r = clkdm_hwmod_enable(oh->clkdm, oh);
1498 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1499 oh->name, oh->clkdm->name, r);
1507 r = _wait_target_ready(oh);
1510 * Set the clockdomain to HW_AUTO only if the target is ready,
1511 * assuming that the previous state was HW_AUTO
1513 if (oh->clkdm && hwsup)
1514 clkdm_allow_idle(oh->clkdm);
1516 oh->_state = _HWMOD_STATE_ENABLED;
1518 /* Access the sysconfig only if the target is ready */
1519 if (oh->class->sysc) {
1520 if (!(oh->_int_flags & _HWMOD_SYSCONFIG_LOADED))
1521 _update_sysc_cache(oh);
1525 _disable_clocks(oh);
1526 pr_debug("omap_hwmod: %s: _wait_target_ready: %d\n",
1530 clkdm_hwmod_disable(oh->clkdm, oh);
1537 * _idle - idle an omap_hwmod
1538 * @oh: struct omap_hwmod *
1540 * Idles an omap_hwmod @oh. This should be called once the hwmod has
1541 * no further work. Returns -EINVAL if the hwmod is in the wrong
1542 * state or returns 0.
1544 static int _idle(struct omap_hwmod *oh)
1548 pr_debug("omap_hwmod: %s: idling\n", oh->name);
1550 if (oh->_state != _HWMOD_STATE_ENABLED) {
1551 WARN(1, "omap_hwmod: %s: idle state can only be entered from "
1552 "enabled state\n", oh->name);
1556 if (oh->class->sysc)
1558 _del_initiator_dep(oh, mpu_oh);
1559 _disable_module(oh);
1560 ret = _wait_target_disable(oh);
1562 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1565 * The module must be in idle mode before disabling any parents
1566 * clocks. Otherwise, the parent clock might be disabled before
1567 * the module transition is done, and thus will prevent the
1568 * transition to complete properly.
1570 _disable_clocks(oh);
1572 clkdm_hwmod_disable(oh->clkdm, oh);
1574 /* Mux pins for device idle if populated */
1575 if (oh->mux && oh->mux->pads_dynamic)
1576 omap_hwmod_mux(oh->mux, _HWMOD_STATE_IDLE);
1578 oh->_state = _HWMOD_STATE_IDLE;
1584 * omap_hwmod_set_ocp_autoidle - set the hwmod's OCP autoidle bit
1585 * @oh: struct omap_hwmod *
1586 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
1588 * Sets the IP block's OCP autoidle bit in hardware, and updates our
1589 * local copy. Intended to be used by drivers that require
1590 * direct manipulation of the AUTOIDLE bits.
1591 * Returns -EINVAL if @oh is null or is not in the ENABLED state, or passes
1592 * along the return value from _set_module_autoidle().
1594 * Any users of this function should be scrutinized carefully.
1596 int omap_hwmod_set_ocp_autoidle(struct omap_hwmod *oh, u8 autoidle)
1600 unsigned long flags;
1602 if (!oh || oh->_state != _HWMOD_STATE_ENABLED)
1605 spin_lock_irqsave(&oh->_lock, flags);
1607 v = oh->_sysc_cache;
1609 retval = _set_module_autoidle(oh, autoidle, &v);
1612 _write_sysconfig(v, oh);
1614 spin_unlock_irqrestore(&oh->_lock, flags);
1620 * _shutdown - shutdown an omap_hwmod
1621 * @oh: struct omap_hwmod *
1623 * Shut down an omap_hwmod @oh. This should be called when the driver
1624 * used for the hwmod is removed or unloaded or if the driver is not
1625 * used by the system. Returns -EINVAL if the hwmod is in the wrong
1626 * state or returns 0.
1628 static int _shutdown(struct omap_hwmod *oh)
1633 if (oh->_state != _HWMOD_STATE_IDLE &&
1634 oh->_state != _HWMOD_STATE_ENABLED) {
1635 WARN(1, "omap_hwmod: %s: disabled state can only be entered "
1636 "from idle, or enabled state\n", oh->name);
1640 pr_debug("omap_hwmod: %s: disabling\n", oh->name);
1642 if (oh->class->pre_shutdown) {
1643 prev_state = oh->_state;
1644 if (oh->_state == _HWMOD_STATE_IDLE)
1646 ret = oh->class->pre_shutdown(oh);
1648 if (prev_state == _HWMOD_STATE_IDLE)
1654 if (oh->class->sysc) {
1655 if (oh->_state == _HWMOD_STATE_IDLE)
1660 /* clocks and deps are already disabled in idle */
1661 if (oh->_state == _HWMOD_STATE_ENABLED) {
1662 _del_initiator_dep(oh, mpu_oh);
1663 /* XXX what about the other system initiators here? dma, dsp */
1664 _disable_module(oh);
1665 ret = _wait_target_disable(oh);
1667 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1669 _disable_clocks(oh);
1671 clkdm_hwmod_disable(oh->clkdm, oh);
1673 /* XXX Should this code also force-disable the optional clocks? */
1676 * If an IP contains only one HW reset line, then assert it
1677 * after disabling the clocks and before shutting down the IP.
1679 if (oh->rst_lines_cnt == 1)
1680 _assert_hardreset(oh, oh->rst_lines[0].name);
1682 /* Mux pins to safe mode or use populated off mode values */
1684 omap_hwmod_mux(oh->mux, _HWMOD_STATE_DISABLED);
1686 oh->_state = _HWMOD_STATE_DISABLED;
1692 * _setup - do initial configuration of omap_hwmod
1693 * @oh: struct omap_hwmod *
1695 * Writes the CLOCKACTIVITY bits @clockact to the hwmod @oh
1696 * OCP_SYSCONFIG register. Returns 0.
1698 static int _setup(struct omap_hwmod *oh, void *data)
1703 if (oh->_state != _HWMOD_STATE_CLKS_INITED)
1706 /* Set iclk autoidle mode */
1707 if (oh->slaves_cnt > 0) {
1708 for (i = 0; i < oh->slaves_cnt; i++) {
1709 struct omap_hwmod_ocp_if *os = oh->slaves[i];
1710 struct clk *c = os->_clk;
1715 if (os->flags & OCPIF_SWSUP_IDLE) {
1716 /* XXX omap_iclk_deny_idle(c); */
1718 /* XXX omap_iclk_allow_idle(c); */
1724 oh->_state = _HWMOD_STATE_INITIALIZED;
1727 * In the case of hwmod with hardreset that should not be
1728 * de-assert at boot time, we have to keep the module
1729 * initialized, because we cannot enable it properly with the
1730 * reset asserted. Exit without warning because that behavior is
1733 if ((oh->flags & HWMOD_INIT_NO_RESET) && oh->rst_lines_cnt == 1)
1738 pr_warning("omap_hwmod: %s: cannot be enabled (%d)\n",
1739 oh->name, oh->_state);
1743 if (!(oh->flags & HWMOD_INIT_NO_RESET)) {
1747 * OCP_SYSCONFIG bits need to be reprogrammed after a softreset.
1748 * The _enable() function should be split to
1749 * avoid the rewrite of the OCP_SYSCONFIG register.
1751 if (oh->class->sysc) {
1752 _update_sysc_cache(oh);
1757 postsetup_state = oh->_postsetup_state;
1758 if (postsetup_state == _HWMOD_STATE_UNKNOWN)
1759 postsetup_state = _HWMOD_STATE_ENABLED;
1762 * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
1763 * it should be set by the core code as a runtime flag during startup
1765 if ((oh->flags & HWMOD_INIT_NO_IDLE) &&
1766 (postsetup_state == _HWMOD_STATE_IDLE)) {
1767 oh->_int_flags |= _HWMOD_SKIP_ENABLE;
1768 postsetup_state = _HWMOD_STATE_ENABLED;
1771 if (postsetup_state == _HWMOD_STATE_IDLE)
1773 else if (postsetup_state == _HWMOD_STATE_DISABLED)
1775 else if (postsetup_state != _HWMOD_STATE_ENABLED)
1776 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
1777 oh->name, postsetup_state);
1783 * _register - register a struct omap_hwmod
1784 * @oh: struct omap_hwmod *
1786 * Registers the omap_hwmod @oh. Returns -EEXIST if an omap_hwmod
1787 * already has been registered by the same name; -EINVAL if the
1788 * omap_hwmod is in the wrong state, if @oh is NULL, if the
1789 * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
1790 * name, or if the omap_hwmod's class is missing a name; or 0 upon
1793 * XXX The data should be copied into bootmem, so the original data
1794 * should be marked __initdata and freed after init. This would allow
1795 * unneeded omap_hwmods to be freed on multi-OMAP configurations. Note
1796 * that the copy process would be relatively complex due to the large number
1799 static int __init _register(struct omap_hwmod *oh)
1803 if (!oh || !oh->name || !oh->class || !oh->class->name ||
1804 (oh->_state != _HWMOD_STATE_UNKNOWN))
1807 pr_debug("omap_hwmod: %s: registering\n", oh->name);
1809 if (_lookup(oh->name))
1812 ms_id = _find_mpu_port_index(oh);
1813 if (!IS_ERR_VALUE(ms_id))
1814 oh->_mpu_port_index = ms_id;
1816 oh->_int_flags |= _HWMOD_NO_MPU_PORT;
1818 list_add_tail(&oh->node, &omap_hwmod_list);
1820 spin_lock_init(&oh->_lock);
1822 oh->_state = _HWMOD_STATE_REGISTERED;
1825 * XXX Rather than doing a strcmp(), this should test a flag
1826 * set in the hwmod data, inserted by the autogenerator code.
1828 if (!strcmp(oh->name, MPU_INITIATOR_NAME))
1835 /* Public functions */
1837 u32 omap_hwmod_read(struct omap_hwmod *oh, u16 reg_offs)
1839 if (oh->flags & HWMOD_16BIT_REG)
1840 return __raw_readw(oh->_mpu_rt_va + reg_offs);
1842 return __raw_readl(oh->_mpu_rt_va + reg_offs);
1845 void omap_hwmod_write(u32 v, struct omap_hwmod *oh, u16 reg_offs)
1847 if (oh->flags & HWMOD_16BIT_REG)
1848 __raw_writew(v, oh->_mpu_rt_va + reg_offs);
1850 __raw_writel(v, oh->_mpu_rt_va + reg_offs);
1854 * omap_hwmod_softreset - reset a module via SYSCONFIG.SOFTRESET bit
1855 * @oh: struct omap_hwmod *
1857 * This is a public function exposed to drivers. Some drivers may need to do
1858 * some settings before and after resetting the device. Those drivers after
1859 * doing the necessary settings could use this function to start a reset by
1860 * setting the SYSCONFIG.SOFTRESET bit.
1862 int omap_hwmod_softreset(struct omap_hwmod *oh)
1867 if (!oh || !(oh->_sysc_cache))
1870 v = oh->_sysc_cache;
1871 ret = _set_softreset(oh, &v);
1874 _write_sysconfig(v, oh);
1881 * omap_hwmod_set_slave_idlemode - set the hwmod's OCP slave idlemode
1882 * @oh: struct omap_hwmod *
1883 * @idlemode: SIDLEMODE field bits (shifted to bit 0)
1885 * Sets the IP block's OCP slave idlemode in hardware, and updates our
1886 * local copy. Intended to be used by drivers that have some erratum
1887 * that requires direct manipulation of the SIDLEMODE bits. Returns
1888 * -EINVAL if @oh is null, or passes along the return value from
1889 * _set_slave_idlemode().
1891 * XXX Does this function have any current users? If not, we should
1892 * remove it; it is better to let the rest of the hwmod code handle this.
1893 * Any users of this function should be scrutinized carefully.
1895 int omap_hwmod_set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode)
1903 v = oh->_sysc_cache;
1905 retval = _set_slave_idlemode(oh, idlemode, &v);
1907 _write_sysconfig(v, oh);
1913 * omap_hwmod_lookup - look up a registered omap_hwmod by name
1914 * @name: name of the omap_hwmod to look up
1916 * Given a @name of an omap_hwmod, return a pointer to the registered
1917 * struct omap_hwmod *, or NULL upon error.
1919 struct omap_hwmod *omap_hwmod_lookup(const char *name)
1921 struct omap_hwmod *oh;
1932 * omap_hwmod_for_each - call function for each registered omap_hwmod
1933 * @fn: pointer to a callback function
1934 * @data: void * data to pass to callback function
1936 * Call @fn for each registered omap_hwmod, passing @data to each
1937 * function. @fn must return 0 for success or any other value for
1938 * failure. If @fn returns non-zero, the iteration across omap_hwmods
1939 * will stop and the non-zero return value will be passed to the
1940 * caller of omap_hwmod_for_each(). @fn is called with
1941 * omap_hwmod_for_each() held.
1943 int omap_hwmod_for_each(int (*fn)(struct omap_hwmod *oh, void *data),
1946 struct omap_hwmod *temp_oh;
1952 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1953 ret = (*fn)(temp_oh, data);
1962 * omap_hwmod_register - register an array of hwmods
1963 * @ohs: pointer to an array of omap_hwmods to register
1965 * Intended to be called early in boot before the clock framework is
1966 * initialized. If @ohs is not null, will register all omap_hwmods
1967 * listed in @ohs that are valid for this chip. Returns 0.
1969 int __init omap_hwmod_register(struct omap_hwmod **ohs)
1978 r = _register(ohs[i]);
1979 WARN(r, "omap_hwmod: %s: _register returned %d\n", ohs[i]->name,
1987 * _populate_mpu_rt_base - populate the virtual address for a hwmod
1989 * Must be called only from omap_hwmod_setup_*() so ioremap works properly.
1990 * Assumes the caller takes care of locking if needed.
1992 static int __init _populate_mpu_rt_base(struct omap_hwmod *oh, void *data)
1994 if (oh->_state != _HWMOD_STATE_REGISTERED)
1997 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2000 oh->_mpu_rt_va = _find_mpu_rt_base(oh, oh->_mpu_port_index);
2006 * omap_hwmod_setup_one - set up a single hwmod
2007 * @oh_name: const char * name of the already-registered hwmod to set up
2009 * Must be called after omap2_clk_init(). Resolves the struct clk
2010 * names to struct clk pointers for each registered omap_hwmod. Also
2011 * calls _setup() on each hwmod. Returns -EINVAL upon error or 0 upon
2014 int __init omap_hwmod_setup_one(const char *oh_name)
2016 struct omap_hwmod *oh;
2019 pr_debug("omap_hwmod: %s: %s\n", oh_name, __func__);
2022 pr_err("omap_hwmod: %s: cannot setup_one: MPU initiator hwmod %s not yet registered\n",
2023 oh_name, MPU_INITIATOR_NAME);
2027 oh = _lookup(oh_name);
2029 WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name);
2033 if (mpu_oh->_state == _HWMOD_STATE_REGISTERED && oh != mpu_oh)
2034 omap_hwmod_setup_one(MPU_INITIATOR_NAME);
2036 r = _populate_mpu_rt_base(oh, NULL);
2037 if (IS_ERR_VALUE(r)) {
2038 WARN(1, "omap_hwmod: %s: couldn't set mpu_rt_base\n", oh_name);
2042 r = _init_clocks(oh, NULL);
2043 if (IS_ERR_VALUE(r)) {
2044 WARN(1, "omap_hwmod: %s: couldn't init clocks\n", oh_name);
2054 * omap_hwmod_setup - do some post-clock framework initialization
2056 * Must be called after omap2_clk_init(). Resolves the struct clk names
2057 * to struct clk pointers for each registered omap_hwmod. Also calls
2058 * _setup() on each hwmod. Returns 0 upon success.
2060 static int __init omap_hwmod_setup_all(void)
2065 pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",
2066 __func__, MPU_INITIATOR_NAME);
2070 r = omap_hwmod_for_each(_populate_mpu_rt_base, NULL);
2072 r = omap_hwmod_for_each(_init_clocks, NULL);
2073 WARN(IS_ERR_VALUE(r),
2074 "omap_hwmod: %s: _init_clocks failed\n", __func__);
2076 omap_hwmod_for_each(_setup, NULL);
2080 core_initcall(omap_hwmod_setup_all);
2083 * omap_hwmod_enable - enable an omap_hwmod
2084 * @oh: struct omap_hwmod *
2086 * Enable an omap_hwmod @oh. Intended to be called by omap_device_enable().
2087 * Returns -EINVAL on error or passes along the return value from _enable().
2089 int omap_hwmod_enable(struct omap_hwmod *oh)
2092 unsigned long flags;
2097 spin_lock_irqsave(&oh->_lock, flags);
2099 spin_unlock_irqrestore(&oh->_lock, flags);
2105 * omap_hwmod_idle - idle an omap_hwmod
2106 * @oh: struct omap_hwmod *
2108 * Idle an omap_hwmod @oh. Intended to be called by omap_device_idle().
2109 * Returns -EINVAL on error or passes along the return value from _idle().
2111 int omap_hwmod_idle(struct omap_hwmod *oh)
2113 unsigned long flags;
2118 spin_lock_irqsave(&oh->_lock, flags);
2120 spin_unlock_irqrestore(&oh->_lock, flags);
2126 * omap_hwmod_shutdown - shutdown an omap_hwmod
2127 * @oh: struct omap_hwmod *
2129 * Shutdown an omap_hwmod @oh. Intended to be called by
2130 * omap_device_shutdown(). Returns -EINVAL on error or passes along
2131 * the return value from _shutdown().
2133 int omap_hwmod_shutdown(struct omap_hwmod *oh)
2135 unsigned long flags;
2140 spin_lock_irqsave(&oh->_lock, flags);
2142 spin_unlock_irqrestore(&oh->_lock, flags);
2148 * omap_hwmod_enable_clocks - enable main_clk, all interface clocks
2149 * @oh: struct omap_hwmod *oh
2151 * Intended to be called by the omap_device code.
2153 int omap_hwmod_enable_clocks(struct omap_hwmod *oh)
2155 unsigned long flags;
2157 spin_lock_irqsave(&oh->_lock, flags);
2159 spin_unlock_irqrestore(&oh->_lock, flags);
2165 * omap_hwmod_disable_clocks - disable main_clk, all interface clocks
2166 * @oh: struct omap_hwmod *oh
2168 * Intended to be called by the omap_device code.
2170 int omap_hwmod_disable_clocks(struct omap_hwmod *oh)
2172 unsigned long flags;
2174 spin_lock_irqsave(&oh->_lock, flags);
2175 _disable_clocks(oh);
2176 spin_unlock_irqrestore(&oh->_lock, flags);
2182 * omap_hwmod_ocp_barrier - wait for posted writes against the hwmod to complete
2183 * @oh: struct omap_hwmod *oh
2185 * Intended to be called by drivers and core code when all posted
2186 * writes to a device must complete before continuing further
2187 * execution (for example, after clearing some device IRQSTATUS
2190 * XXX what about targets with multiple OCP threads?
2192 void omap_hwmod_ocp_barrier(struct omap_hwmod *oh)
2196 if (!oh->class->sysc || !oh->class->sysc->sysc_flags) {
2197 WARN(1, "omap_device: %s: OCP barrier impossible due to "
2198 "device configuration\n", oh->name);
2203 * Forces posted writes to complete on the OCP thread handling
2206 omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
2210 * omap_hwmod_reset - reset the hwmod
2211 * @oh: struct omap_hwmod *
2213 * Under some conditions, a driver may wish to reset the entire device.
2214 * Called from omap_device code. Returns -EINVAL on error or passes along
2215 * the return value from _reset().
2217 int omap_hwmod_reset(struct omap_hwmod *oh)
2220 unsigned long flags;
2225 spin_lock_irqsave(&oh->_lock, flags);
2227 spin_unlock_irqrestore(&oh->_lock, flags);
2233 * omap_hwmod_count_resources - count number of struct resources needed by hwmod
2234 * @oh: struct omap_hwmod *
2235 * @res: pointer to the first element of an array of struct resource to fill
2237 * Count the number of struct resource array elements necessary to
2238 * contain omap_hwmod @oh resources. Intended to be called by code
2239 * that registers omap_devices. Intended to be used to determine the
2240 * size of a dynamically-allocated struct resource array, before
2241 * calling omap_hwmod_fill_resources(). Returns the number of struct
2242 * resource array elements needed.
2244 * XXX This code is not optimized. It could attempt to merge adjacent
2248 int omap_hwmod_count_resources(struct omap_hwmod *oh)
2252 ret = _count_mpu_irqs(oh) + _count_sdma_reqs(oh);
2254 for (i = 0; i < oh->slaves_cnt; i++)
2255 ret += _count_ocp_if_addr_spaces(oh->slaves[i]);
2261 * omap_hwmod_fill_resources - fill struct resource array with hwmod data
2262 * @oh: struct omap_hwmod *
2263 * @res: pointer to the first element of an array of struct resource to fill
2265 * Fill the struct resource array @res with resource data from the
2266 * omap_hwmod @oh. Intended to be called by code that registers
2267 * omap_devices. See also omap_hwmod_count_resources(). Returns the
2268 * number of array elements filled.
2270 int omap_hwmod_fill_resources(struct omap_hwmod *oh, struct resource *res)
2272 int i, j, mpu_irqs_cnt, sdma_reqs_cnt;
2275 /* For each IRQ, DMA, memory area, fill in array.*/
2277 mpu_irqs_cnt = _count_mpu_irqs(oh);
2278 for (i = 0; i < mpu_irqs_cnt; i++) {
2279 (res + r)->name = (oh->mpu_irqs + i)->name;
2280 (res + r)->start = (oh->mpu_irqs + i)->irq;
2281 (res + r)->end = (oh->mpu_irqs + i)->irq;
2282 (res + r)->flags = IORESOURCE_IRQ;
2286 sdma_reqs_cnt = _count_sdma_reqs(oh);
2287 for (i = 0; i < sdma_reqs_cnt; i++) {
2288 (res + r)->name = (oh->sdma_reqs + i)->name;
2289 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
2290 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
2291 (res + r)->flags = IORESOURCE_DMA;
2295 for (i = 0; i < oh->slaves_cnt; i++) {
2296 struct omap_hwmod_ocp_if *os;
2300 addr_cnt = _count_ocp_if_addr_spaces(os);
2302 for (j = 0; j < addr_cnt; j++) {
2303 (res + r)->name = (os->addr + j)->name;
2304 (res + r)->start = (os->addr + j)->pa_start;
2305 (res + r)->end = (os->addr + j)->pa_end;
2306 (res + r)->flags = IORESOURCE_MEM;
2315 * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
2316 * @oh: struct omap_hwmod *
2318 * Return the powerdomain pointer associated with the OMAP module
2319 * @oh's main clock. If @oh does not have a main clk, return the
2320 * powerdomain associated with the interface clock associated with the
2321 * module's MPU port. (XXX Perhaps this should use the SDMA port
2322 * instead?) Returns NULL on error, or a struct powerdomain * on
2325 struct powerdomain *omap_hwmod_get_pwrdm(struct omap_hwmod *oh)
2335 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2337 c = oh->slaves[oh->_mpu_port_index]->_clk;
2343 return c->clkdm->pwrdm.ptr;
2348 * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
2349 * @oh: struct omap_hwmod *
2351 * Returns the virtual address corresponding to the beginning of the
2352 * module's register target, in the address range that is intended to
2353 * be used by the MPU. Returns the virtual address upon success or NULL
2356 void __iomem *omap_hwmod_get_mpu_rt_va(struct omap_hwmod *oh)
2361 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2364 if (oh->_state == _HWMOD_STATE_UNKNOWN)
2367 return oh->_mpu_rt_va;
2371 * omap_hwmod_add_initiator_dep - add sleepdep from @init_oh to @oh
2372 * @oh: struct omap_hwmod *
2373 * @init_oh: struct omap_hwmod * (initiator)
2375 * Add a sleep dependency between the initiator @init_oh and @oh.
2376 * Intended to be called by DSP/Bridge code via platform_data for the
2377 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
2378 * code needs to add/del initiator dependencies dynamically
2379 * before/after accessing a device. Returns the return value from
2380 * _add_initiator_dep().
2382 * XXX Keep a usecount in the clockdomain code
2384 int omap_hwmod_add_initiator_dep(struct omap_hwmod *oh,
2385 struct omap_hwmod *init_oh)
2387 return _add_initiator_dep(oh, init_oh);
2391 * XXX what about functions for drivers to save/restore ocp_sysconfig
2392 * for context save/restore operations?
2396 * omap_hwmod_del_initiator_dep - remove sleepdep from @init_oh to @oh
2397 * @oh: struct omap_hwmod *
2398 * @init_oh: struct omap_hwmod * (initiator)
2400 * Remove a sleep dependency between the initiator @init_oh and @oh.
2401 * Intended to be called by DSP/Bridge code via platform_data for the
2402 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
2403 * code needs to add/del initiator dependencies dynamically
2404 * before/after accessing a device. Returns the return value from
2405 * _del_initiator_dep().
2407 * XXX Keep a usecount in the clockdomain code
2409 int omap_hwmod_del_initiator_dep(struct omap_hwmod *oh,
2410 struct omap_hwmod *init_oh)
2412 return _del_initiator_dep(oh, init_oh);
2416 * omap_hwmod_enable_wakeup - allow device to wake up the system
2417 * @oh: struct omap_hwmod *
2419 * Sets the module OCP socket ENAWAKEUP bit to allow the module to
2420 * send wakeups to the PRCM. Eventually this should sets PRCM wakeup
2421 * registers to cause the PRCM to receive wakeup events from the
2422 * module. Does not set any wakeup routing registers beyond this
2423 * point - if the module is to wake up any other module or subsystem,
2424 * that must be set separately. Called by omap_device code. Returns
2425 * -EINVAL on error or 0 upon success.
2427 int omap_hwmod_enable_wakeup(struct omap_hwmod *oh)
2429 unsigned long flags;
2432 if (!oh->class->sysc ||
2433 !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
2436 spin_lock_irqsave(&oh->_lock, flags);
2437 v = oh->_sysc_cache;
2438 _enable_wakeup(oh, &v);
2439 _write_sysconfig(v, oh);
2440 spin_unlock_irqrestore(&oh->_lock, flags);
2446 * omap_hwmod_disable_wakeup - prevent device from waking the system
2447 * @oh: struct omap_hwmod *
2449 * Clears the module OCP socket ENAWAKEUP bit to prevent the module
2450 * from sending wakeups to the PRCM. Eventually this should clear
2451 * PRCM wakeup registers to cause the PRCM to ignore wakeup events
2452 * from the module. Does not set any wakeup routing registers beyond
2453 * this point - if the module is to wake up any other module or
2454 * subsystem, that must be set separately. Called by omap_device
2455 * code. Returns -EINVAL on error or 0 upon success.
2457 int omap_hwmod_disable_wakeup(struct omap_hwmod *oh)
2459 unsigned long flags;
2462 if (!oh->class->sysc ||
2463 !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
2466 spin_lock_irqsave(&oh->_lock, flags);
2467 v = oh->_sysc_cache;
2468 _disable_wakeup(oh, &v);
2469 _write_sysconfig(v, oh);
2470 spin_unlock_irqrestore(&oh->_lock, flags);
2476 * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
2477 * contained in the hwmod module.
2478 * @oh: struct omap_hwmod *
2479 * @name: name of the reset line to lookup and assert
2481 * Some IP like dsp, ipu or iva contain processor that require
2482 * an HW reset line to be assert / deassert in order to enable fully
2483 * the IP. Returns -EINVAL if @oh is null or if the operation is not
2484 * yet supported on this OMAP; otherwise, passes along the return value
2485 * from _assert_hardreset().
2487 int omap_hwmod_assert_hardreset(struct omap_hwmod *oh, const char *name)
2490 unsigned long flags;
2495 spin_lock_irqsave(&oh->_lock, flags);
2496 ret = _assert_hardreset(oh, name);
2497 spin_unlock_irqrestore(&oh->_lock, flags);
2503 * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
2504 * contained in the hwmod module.
2505 * @oh: struct omap_hwmod *
2506 * @name: name of the reset line to look up and deassert
2508 * Some IP like dsp, ipu or iva contain processor that require
2509 * an HW reset line to be assert / deassert in order to enable fully
2510 * the IP. Returns -EINVAL if @oh is null or if the operation is not
2511 * yet supported on this OMAP; otherwise, passes along the return value
2512 * from _deassert_hardreset().
2514 int omap_hwmod_deassert_hardreset(struct omap_hwmod *oh, const char *name)
2517 unsigned long flags;
2522 spin_lock_irqsave(&oh->_lock, flags);
2523 ret = _deassert_hardreset(oh, name);
2524 spin_unlock_irqrestore(&oh->_lock, flags);
2530 * omap_hwmod_read_hardreset - read the HW reset line state of submodules
2531 * contained in the hwmod module
2532 * @oh: struct omap_hwmod *
2533 * @name: name of the reset line to look up and read
2535 * Return the current state of the hwmod @oh's reset line named @name:
2536 * returns -EINVAL upon parameter error or if this operation
2537 * is unsupported on the current OMAP; otherwise, passes along the return
2538 * value from _read_hardreset().
2540 int omap_hwmod_read_hardreset(struct omap_hwmod *oh, const char *name)
2543 unsigned long flags;
2548 spin_lock_irqsave(&oh->_lock, flags);
2549 ret = _read_hardreset(oh, name);
2550 spin_unlock_irqrestore(&oh->_lock, flags);
2557 * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
2558 * @classname: struct omap_hwmod_class name to search for
2559 * @fn: callback function pointer to call for each hwmod in class @classname
2560 * @user: arbitrary context data to pass to the callback function
2562 * For each omap_hwmod of class @classname, call @fn.
2563 * If the callback function returns something other than
2564 * zero, the iterator is terminated, and the callback function's return
2565 * value is passed back to the caller. Returns 0 upon success, -EINVAL
2566 * if @classname or @fn are NULL, or passes back the error code from @fn.
2568 int omap_hwmod_for_each_by_class(const char *classname,
2569 int (*fn)(struct omap_hwmod *oh,
2573 struct omap_hwmod *temp_oh;
2576 if (!classname || !fn)
2579 pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
2580 __func__, classname);
2582 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
2583 if (!strcmp(temp_oh->class->name, classname)) {
2584 pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
2585 __func__, temp_oh->name);
2586 ret = (*fn)(temp_oh, user);
2593 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
2600 * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
2601 * @oh: struct omap_hwmod *
2602 * @state: state that _setup() should leave the hwmod in
2604 * Sets the hwmod state that @oh will enter at the end of _setup()
2605 * (called by omap_hwmod_setup_*()). Only valid to call between
2606 * calling omap_hwmod_register() and omap_hwmod_setup_*(). Returns
2607 * 0 upon success or -EINVAL if there is a problem with the arguments
2608 * or if the hwmod is in the wrong state.
2610 int omap_hwmod_set_postsetup_state(struct omap_hwmod *oh, u8 state)
2613 unsigned long flags;
2618 if (state != _HWMOD_STATE_DISABLED &&
2619 state != _HWMOD_STATE_ENABLED &&
2620 state != _HWMOD_STATE_IDLE)
2623 spin_lock_irqsave(&oh->_lock, flags);
2625 if (oh->_state != _HWMOD_STATE_REGISTERED) {
2630 oh->_postsetup_state = state;
2634 spin_unlock_irqrestore(&oh->_lock, flags);
2640 * omap_hwmod_get_context_loss_count - get lost context count
2641 * @oh: struct omap_hwmod *
2643 * Query the powerdomain of of @oh to get the context loss
2644 * count for this device.
2646 * Returns the context loss count of the powerdomain assocated with @oh
2647 * upon success, or zero if no powerdomain exists for @oh.
2649 int omap_hwmod_get_context_loss_count(struct omap_hwmod *oh)
2651 struct powerdomain *pwrdm;
2654 pwrdm = omap_hwmod_get_pwrdm(oh);
2656 ret = pwrdm_get_context_loss_count(pwrdm);
2662 * omap_hwmod_no_setup_reset - prevent a hwmod from being reset upon setup
2663 * @oh: struct omap_hwmod *
2665 * Prevent the hwmod @oh from being reset during the setup process.
2666 * Intended for use by board-*.c files on boards with devices that
2667 * cannot tolerate being reset. Must be called before the hwmod has
2668 * been set up. Returns 0 upon success or negative error code upon
2671 int omap_hwmod_no_setup_reset(struct omap_hwmod *oh)
2676 if (oh->_state != _HWMOD_STATE_REGISTERED) {
2677 pr_err("omap_hwmod: %s: cannot prevent setup reset; in wrong state\n",
2682 oh->flags |= HWMOD_INIT_NO_RESET;