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>
140 #include <plat/common.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.SOFTRESET bit 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 * _clear_softreset: clear OCP_SYSCONFIG.SOFTRESET bit in @v
348 * @oh: struct omap_hwmod *
349 * @v: pointer to register contents to modify
351 * Clear the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
352 * error or 0 upon success.
354 static int _clear_softreset(struct omap_hwmod *oh, u32 *v)
358 if (!oh->class->sysc ||
359 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
362 if (!oh->class->sysc->sysc_fields) {
364 "omap_hwmod: %s: sysc_fields absent for sysconfig class\n",
369 softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
377 * _set_module_autoidle: set the OCP_SYSCONFIG AUTOIDLE field in @v
378 * @oh: struct omap_hwmod *
379 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
380 * @v: pointer to register contents to modify
382 * Update the module autoidle bit in @v to be @autoidle for the @oh
383 * hwmod. The autoidle bit controls whether the module can gate
384 * internal clocks automatically when it isn't doing anything; the
385 * exact function of this bit varies on a per-module basis. This
386 * function does not write to the hardware. Returns -EINVAL upon
387 * error or 0 upon success.
389 static int _set_module_autoidle(struct omap_hwmod *oh, u8 autoidle,
395 if (!oh->class->sysc ||
396 !(oh->class->sysc->sysc_flags & SYSC_HAS_AUTOIDLE))
399 if (!oh->class->sysc->sysc_fields) {
400 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
404 autoidle_shift = oh->class->sysc->sysc_fields->autoidle_shift;
405 autoidle_mask = (0x1 << autoidle_shift);
407 *v &= ~autoidle_mask;
408 *v |= autoidle << autoidle_shift;
414 * _enable_wakeup: set OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
415 * @oh: struct omap_hwmod *
417 * Allow the hardware module @oh to send wakeups. Returns -EINVAL
418 * upon error or 0 upon success.
420 static int _enable_wakeup(struct omap_hwmod *oh, u32 *v)
422 if (!oh->class->sysc ||
423 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
424 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
425 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
428 if (!oh->class->sysc->sysc_fields) {
429 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
433 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
434 *v |= 0x1 << oh->class->sysc->sysc_fields->enwkup_shift;
436 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
437 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
438 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
439 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
441 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
443 oh->_int_flags |= _HWMOD_WAKEUP_ENABLED;
449 * _disable_wakeup: clear OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
450 * @oh: struct omap_hwmod *
452 * Prevent the hardware module @oh to send wakeups. Returns -EINVAL
453 * upon error or 0 upon success.
455 static int _disable_wakeup(struct omap_hwmod *oh, u32 *v)
457 if (!oh->class->sysc ||
458 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
459 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
460 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
463 if (!oh->class->sysc->sysc_fields) {
464 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
468 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
469 *v &= ~(0x1 << oh->class->sysc->sysc_fields->enwkup_shift);
471 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
472 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART, v);
473 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
474 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
476 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
478 oh->_int_flags &= ~_HWMOD_WAKEUP_ENABLED;
484 * _add_initiator_dep: prevent @oh from smart-idling while @init_oh is active
485 * @oh: struct omap_hwmod *
487 * Prevent the hardware module @oh from entering idle while the
488 * hardare module initiator @init_oh is active. Useful when a module
489 * will be accessed by a particular initiator (e.g., if a module will
490 * be accessed by the IVA, there should be a sleepdep between the IVA
491 * initiator and the module). Only applies to modules in smart-idle
492 * mode. If the clockdomain is marked as not needing autodeps, return
493 * 0 without doing anything. Otherwise, returns -EINVAL upon error or
494 * passes along clkdm_add_sleepdep() value upon success.
496 static int _add_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
501 if (oh->_clk->clkdm && oh->_clk->clkdm->flags & CLKDM_NO_AUTODEPS)
504 return clkdm_add_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
508 * _del_initiator_dep: allow @oh to smart-idle even if @init_oh is active
509 * @oh: struct omap_hwmod *
511 * Allow the hardware module @oh to enter idle while the hardare
512 * module initiator @init_oh is active. Useful when a module will not
513 * be accessed by a particular initiator (e.g., if a module will not
514 * be accessed by the IVA, there should be no sleepdep between the IVA
515 * initiator and the module). Only applies to modules in smart-idle
516 * mode. If the clockdomain is marked as not needing autodeps, return
517 * 0 without doing anything. Returns -EINVAL upon error or passes
518 * along clkdm_del_sleepdep() value upon success.
520 static int _del_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
525 if (oh->_clk->clkdm && oh->_clk->clkdm->flags & CLKDM_NO_AUTODEPS)
528 return clkdm_del_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
532 * _init_main_clk - get a struct clk * for the the hwmod's main functional clk
533 * @oh: struct omap_hwmod *
535 * Called from _init_clocks(). Populates the @oh _clk (main
536 * functional clock pointer) if a main_clk is present. Returns 0 on
537 * success or -EINVAL on error.
539 static int _init_main_clk(struct omap_hwmod *oh)
546 oh->_clk = omap_clk_get_by_name(oh->main_clk);
548 pr_warning("omap_hwmod: %s: cannot clk_get main_clk %s\n",
549 oh->name, oh->main_clk);
553 if (!oh->_clk->clkdm)
554 pr_warning("omap_hwmod: %s: missing clockdomain for %s.\n",
555 oh->main_clk, oh->_clk->name);
561 * _init_interface_clks - get a struct clk * for the the hwmod's interface clks
562 * @oh: struct omap_hwmod *
564 * Called from _init_clocks(). Populates the @oh OCP slave interface
565 * clock pointers. Returns 0 on success or -EINVAL on error.
567 static int _init_interface_clks(struct omap_hwmod *oh)
573 if (oh->slaves_cnt == 0)
576 for (i = 0; i < oh->slaves_cnt; i++) {
577 struct omap_hwmod_ocp_if *os = oh->slaves[i];
582 c = omap_clk_get_by_name(os->clk);
584 pr_warning("omap_hwmod: %s: cannot clk_get interface_clk %s\n",
595 * _init_opt_clk - get a struct clk * for the the hwmod's optional clocks
596 * @oh: struct omap_hwmod *
598 * Called from _init_clocks(). Populates the @oh omap_hwmod_opt_clk
599 * clock pointers. Returns 0 on success or -EINVAL on error.
601 static int _init_opt_clks(struct omap_hwmod *oh)
603 struct omap_hwmod_opt_clk *oc;
608 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++) {
609 c = omap_clk_get_by_name(oc->clk);
611 pr_warning("omap_hwmod: %s: cannot clk_get opt_clk %s\n",
622 * _enable_clocks - enable hwmod main clock and interface clocks
623 * @oh: struct omap_hwmod *
625 * Enables all clocks necessary for register reads and writes to succeed
626 * on the hwmod @oh. Returns 0.
628 static int _enable_clocks(struct omap_hwmod *oh)
632 pr_debug("omap_hwmod: %s: enabling clocks\n", oh->name);
635 clk_enable(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. */
653 * _disable_clocks - disable hwmod main clock and interface clocks
654 * @oh: struct omap_hwmod *
656 * Disables the hwmod @oh main functional and interface clocks. Returns 0.
658 static int _disable_clocks(struct omap_hwmod *oh)
662 pr_debug("omap_hwmod: %s: disabling clocks\n", oh->name);
665 clk_disable(oh->_clk);
667 if (oh->slaves_cnt > 0) {
668 for (i = 0; i < oh->slaves_cnt; i++) {
669 struct omap_hwmod_ocp_if *os = oh->slaves[i];
670 struct clk *c = os->_clk;
672 if (c && (os->flags & OCPIF_SWSUP_IDLE))
677 /* The opt clocks are controlled by the device driver. */
682 static void _enable_optional_clocks(struct omap_hwmod *oh)
684 struct omap_hwmod_opt_clk *oc;
687 pr_debug("omap_hwmod: %s: enabling optional clocks\n", oh->name);
689 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
691 pr_debug("omap_hwmod: enable %s:%s\n", oc->role,
693 clk_enable(oc->_clk);
697 static void _disable_optional_clocks(struct omap_hwmod *oh)
699 struct omap_hwmod_opt_clk *oc;
702 pr_debug("omap_hwmod: %s: disabling optional clocks\n", oh->name);
704 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
706 pr_debug("omap_hwmod: disable %s:%s\n", oc->role,
708 clk_disable(oc->_clk);
713 * _enable_module - enable CLKCTRL modulemode on OMAP4
714 * @oh: struct omap_hwmod *
716 * Enables the PRCM module mode related to the hwmod @oh.
719 static void _enable_module(struct omap_hwmod *oh)
721 /* The module mode does not exist prior OMAP4 */
722 if (cpu_is_omap24xx() || cpu_is_omap34xx())
725 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
728 pr_debug("omap_hwmod: %s: _enable_module: %d\n",
729 oh->name, oh->prcm.omap4.modulemode);
731 omap4_cminst_module_enable(oh->prcm.omap4.modulemode,
732 oh->clkdm->prcm_partition,
734 oh->clkdm->clkdm_offs,
735 oh->prcm.omap4.clkctrl_offs);
739 * _disable_module - enable CLKCTRL modulemode on OMAP4
740 * @oh: struct omap_hwmod *
742 * Disable the PRCM module mode related to the hwmod @oh.
745 static void _disable_module(struct omap_hwmod *oh)
747 /* The module mode does not exist prior OMAP4 */
748 if (cpu_is_omap24xx() || cpu_is_omap34xx())
751 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
754 pr_debug("omap_hwmod: %s: _disable_module\n", oh->name);
756 omap4_cminst_module_disable(oh->clkdm->prcm_partition,
758 oh->clkdm->clkdm_offs,
759 oh->prcm.omap4.clkctrl_offs);
763 * _count_mpu_irqs - count the number of MPU IRQ lines associated with @oh
764 * @oh: struct omap_hwmod *oh
766 * Count and return the number of MPU IRQs associated with the hwmod
767 * @oh. Used to allocate struct resource data. Returns 0 if @oh is
770 static int _count_mpu_irqs(struct omap_hwmod *oh)
772 struct omap_hwmod_irq_info *ohii;
775 if (!oh || !oh->mpu_irqs)
779 ohii = &oh->mpu_irqs[i++];
780 } while (ohii->irq != -1);
786 * _count_sdma_reqs - count the number of SDMA request lines associated with @oh
787 * @oh: struct omap_hwmod *oh
789 * Count and return the number of SDMA request lines associated with
790 * the hwmod @oh. Used to allocate struct resource data. Returns 0
793 static int _count_sdma_reqs(struct omap_hwmod *oh)
795 struct omap_hwmod_dma_info *ohdi;
798 if (!oh || !oh->sdma_reqs)
802 ohdi = &oh->sdma_reqs[i++];
803 } while (ohdi->dma_req != -1);
809 * _count_ocp_if_addr_spaces - count the number of address space entries for @oh
810 * @oh: struct omap_hwmod *oh
812 * Count and return the number of address space ranges associated with
813 * the hwmod @oh. Used to allocate struct resource data. Returns 0
816 static int _count_ocp_if_addr_spaces(struct omap_hwmod_ocp_if *os)
818 struct omap_hwmod_addr_space *mem;
821 if (!os || !os->addr)
825 mem = &os->addr[i++];
826 } while (mem->pa_start != mem->pa_end);
832 * _find_mpu_port_index - find hwmod OCP slave port ID intended for MPU use
833 * @oh: struct omap_hwmod *
835 * Returns the array index of the OCP slave port that the MPU
836 * addresses the device on, or -EINVAL upon error or not found.
838 static int __init _find_mpu_port_index(struct omap_hwmod *oh)
843 if (!oh || oh->slaves_cnt == 0)
846 for (i = 0; i < oh->slaves_cnt; i++) {
847 struct omap_hwmod_ocp_if *os = oh->slaves[i];
849 if (os->user & OCP_USER_MPU) {
856 pr_debug("omap_hwmod: %s: MPU OCP slave port ID %d\n",
859 pr_debug("omap_hwmod: %s: no MPU OCP slave port found\n",
862 return (found) ? i : -EINVAL;
866 * _find_mpu_rt_base - find hwmod register target base addr accessible by MPU
867 * @oh: struct omap_hwmod *
869 * Return the virtual address of the base of the register target of
870 * device @oh, or NULL on error.
872 static void __iomem * __init _find_mpu_rt_base(struct omap_hwmod *oh, u8 index)
874 struct omap_hwmod_ocp_if *os;
875 struct omap_hwmod_addr_space *mem;
876 int i = 0, found = 0;
877 void __iomem *va_start;
879 if (!oh || oh->slaves_cnt == 0)
882 os = oh->slaves[index];
888 mem = &os->addr[i++];
889 if (mem->flags & ADDR_TYPE_RT)
891 } while (!found && mem->pa_start != mem->pa_end);
894 va_start = ioremap(mem->pa_start, mem->pa_end - mem->pa_start);
896 pr_err("omap_hwmod: %s: Could not ioremap\n", oh->name);
899 pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
902 pr_debug("omap_hwmod: %s: no MPU register target found\n",
906 return (found) ? va_start : NULL;
910 * _enable_sysc - try to bring a module out of idle via OCP_SYSCONFIG
911 * @oh: struct omap_hwmod *
913 * If module is marked as SWSUP_SIDLE, force the module out of slave
914 * idle; otherwise, configure it for smart-idle. If module is marked
915 * as SWSUP_MSUSPEND, force the module out of master standby;
916 * otherwise, configure it for smart-standby. No return value.
918 static void _enable_sysc(struct omap_hwmod *oh)
923 if (!oh->class->sysc)
927 sf = oh->class->sysc->sysc_flags;
929 if (sf & SYSC_HAS_SIDLEMODE) {
930 idlemode = (oh->flags & HWMOD_SWSUP_SIDLE) ?
931 HWMOD_IDLEMODE_NO : HWMOD_IDLEMODE_SMART;
932 _set_slave_idlemode(oh, idlemode, &v);
935 if (sf & SYSC_HAS_MIDLEMODE) {
936 if (oh->flags & HWMOD_FORCE_MSTANDBY) {
937 idlemode = HWMOD_IDLEMODE_FORCE;
938 } else if (oh->flags & HWMOD_SWSUP_MSTANDBY) {
939 idlemode = HWMOD_IDLEMODE_NO;
941 if (sf & SYSC_HAS_ENAWAKEUP)
942 _enable_wakeup(oh, &v);
943 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
944 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
946 idlemode = HWMOD_IDLEMODE_SMART;
948 _set_master_standbymode(oh, idlemode, &v);
952 * XXX The clock framework should handle this, by
953 * calling into this code. But this must wait until the
954 * clock structures are tagged with omap_hwmod entries
956 if ((oh->flags & HWMOD_SET_DEFAULT_CLOCKACT) &&
957 (sf & SYSC_HAS_CLOCKACTIVITY))
958 _set_clockactivity(oh, oh->class->sysc->clockact, &v);
960 /* If slave is in SMARTIDLE, also enable wakeup */
961 if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
962 _enable_wakeup(oh, &v);
964 _write_sysconfig(v, oh);
967 * Set the autoidle bit only after setting the smartidle bit
968 * Setting this will not have any impact on the other modules.
970 if (sf & SYSC_HAS_AUTOIDLE) {
971 idlemode = (oh->flags & HWMOD_NO_OCP_AUTOIDLE) ?
973 _set_module_autoidle(oh, idlemode, &v);
974 _write_sysconfig(v, oh);
979 * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
980 * @oh: struct omap_hwmod *
982 * If module is marked as SWSUP_SIDLE, force the module into slave
983 * idle; otherwise, configure it for smart-idle. If module is marked
984 * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
985 * configure it for smart-standby. No return value.
987 static void _idle_sysc(struct omap_hwmod *oh)
992 if (!oh->class->sysc)
996 sf = oh->class->sysc->sysc_flags;
998 if (sf & SYSC_HAS_SIDLEMODE) {
999 idlemode = (oh->flags & HWMOD_SWSUP_SIDLE) ?
1000 HWMOD_IDLEMODE_FORCE : HWMOD_IDLEMODE_SMART;
1001 _set_slave_idlemode(oh, idlemode, &v);
1004 if (sf & SYSC_HAS_MIDLEMODE) {
1005 if ((oh->flags & HWMOD_SWSUP_MSTANDBY) ||
1006 (oh->flags & HWMOD_FORCE_MSTANDBY)) {
1007 idlemode = HWMOD_IDLEMODE_FORCE;
1009 if (sf & SYSC_HAS_ENAWAKEUP)
1010 _enable_wakeup(oh, &v);
1011 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1012 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1014 idlemode = HWMOD_IDLEMODE_SMART;
1016 _set_master_standbymode(oh, idlemode, &v);
1019 /* If slave is in SMARTIDLE, also enable wakeup */
1020 if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
1021 _enable_wakeup(oh, &v);
1023 _write_sysconfig(v, oh);
1027 * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
1028 * @oh: struct omap_hwmod *
1030 * Force the module into slave idle and master suspend. No return
1033 static void _shutdown_sysc(struct omap_hwmod *oh)
1038 if (!oh->class->sysc)
1041 v = oh->_sysc_cache;
1042 sf = oh->class->sysc->sysc_flags;
1044 if (sf & SYSC_HAS_SIDLEMODE)
1045 _set_slave_idlemode(oh, HWMOD_IDLEMODE_FORCE, &v);
1047 if (sf & SYSC_HAS_MIDLEMODE)
1048 _set_master_standbymode(oh, HWMOD_IDLEMODE_FORCE, &v);
1050 if (sf & SYSC_HAS_AUTOIDLE)
1051 _set_module_autoidle(oh, 1, &v);
1053 _write_sysconfig(v, oh);
1057 * _lookup - find an omap_hwmod by name
1058 * @name: find an omap_hwmod by name
1060 * Return a pointer to an omap_hwmod by name, or NULL if not found.
1062 static struct omap_hwmod *_lookup(const char *name)
1064 struct omap_hwmod *oh, *temp_oh;
1068 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1069 if (!strcmp(name, temp_oh->name)) {
1078 * _init_clkdm - look up a clockdomain name, store pointer in omap_hwmod
1079 * @oh: struct omap_hwmod *
1081 * Convert a clockdomain name stored in a struct omap_hwmod into a
1082 * clockdomain pointer, and save it into the struct omap_hwmod.
1083 * return -EINVAL if clkdm_name does not exist or if the lookup failed.
1085 static int _init_clkdm(struct omap_hwmod *oh)
1087 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1090 if (!oh->clkdm_name) {
1091 pr_warning("omap_hwmod: %s: no clkdm_name\n", oh->name);
1095 oh->clkdm = clkdm_lookup(oh->clkdm_name);
1097 pr_warning("omap_hwmod: %s: could not associate to clkdm %s\n",
1098 oh->name, oh->clkdm_name);
1102 pr_debug("omap_hwmod: %s: associated to clkdm %s\n",
1103 oh->name, oh->clkdm_name);
1109 * _init_clocks - clk_get() all clocks associated with this hwmod. Retrieve as
1110 * well the clockdomain.
1111 * @oh: struct omap_hwmod *
1112 * @data: not used; pass NULL
1114 * Called by omap_hwmod_setup_*() (after omap2_clk_init()).
1115 * Resolves all clock names embedded in the hwmod. Returns 0 on
1116 * success, or a negative error code on failure.
1118 static int _init_clocks(struct omap_hwmod *oh, void *data)
1122 if (oh->_state != _HWMOD_STATE_REGISTERED)
1125 pr_debug("omap_hwmod: %s: looking up clocks\n", oh->name);
1127 ret |= _init_main_clk(oh);
1128 ret |= _init_interface_clks(oh);
1129 ret |= _init_opt_clks(oh);
1130 ret |= _init_clkdm(oh);
1133 oh->_state = _HWMOD_STATE_CLKS_INITED;
1135 pr_warning("omap_hwmod: %s: cannot _init_clocks\n", oh->name);
1141 * _wait_target_ready - wait for a module to leave slave idle
1142 * @oh: struct omap_hwmod *
1144 * Wait for a module @oh to leave slave idle. Returns 0 if the module
1145 * does not have an IDLEST bit or if the module successfully leaves
1146 * slave idle; otherwise, pass along the return value of the
1147 * appropriate *_cm*_wait_module_ready() function.
1149 static int _wait_target_ready(struct omap_hwmod *oh)
1151 struct omap_hwmod_ocp_if *os;
1157 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
1160 os = oh->slaves[oh->_mpu_port_index];
1162 if (oh->flags & HWMOD_NO_IDLEST)
1165 /* XXX check module SIDLEMODE */
1167 /* XXX check clock enable states */
1169 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1170 ret = omap2_cm_wait_module_ready(oh->prcm.omap2.module_offs,
1171 oh->prcm.omap2.idlest_reg_id,
1172 oh->prcm.omap2.idlest_idle_bit);
1173 } else if (cpu_is_omap44xx()) {
1177 ret = omap4_cminst_wait_module_ready(oh->clkdm->prcm_partition,
1179 oh->clkdm->clkdm_offs,
1180 oh->prcm.omap4.clkctrl_offs);
1189 * _wait_target_disable - wait for a module to be disabled
1190 * @oh: struct omap_hwmod *
1192 * Wait for a module @oh to enter slave idle. Returns 0 if the module
1193 * does not have an IDLEST bit or if the module successfully enters
1194 * slave idle; otherwise, pass along the return value of the
1195 * appropriate *_cm*_wait_module_idle() function.
1197 static int _wait_target_disable(struct omap_hwmod *oh)
1199 /* TODO: For now just handle OMAP4+ */
1200 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1206 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
1209 if (oh->flags & HWMOD_NO_IDLEST)
1212 return omap4_cminst_wait_module_idle(oh->clkdm->prcm_partition,
1214 oh->clkdm->clkdm_offs,
1215 oh->prcm.omap4.clkctrl_offs);
1219 * _lookup_hardreset - fill register bit info for this hwmod/reset line
1220 * @oh: struct omap_hwmod *
1221 * @name: name of the reset line in the context of this hwmod
1222 * @ohri: struct omap_hwmod_rst_info * that this function will fill in
1224 * Return the bit position of the reset line that match the
1225 * input name. Return -ENOENT if not found.
1227 static u8 _lookup_hardreset(struct omap_hwmod *oh, const char *name,
1228 struct omap_hwmod_rst_info *ohri)
1232 for (i = 0; i < oh->rst_lines_cnt; i++) {
1233 const char *rst_line = oh->rst_lines[i].name;
1234 if (!strcmp(rst_line, name)) {
1235 ohri->rst_shift = oh->rst_lines[i].rst_shift;
1236 ohri->st_shift = oh->rst_lines[i].st_shift;
1237 pr_debug("omap_hwmod: %s: %s: %s: rst %d st %d\n",
1238 oh->name, __func__, rst_line, ohri->rst_shift,
1249 * _assert_hardreset - assert the HW reset line of submodules
1250 * contained in the hwmod module.
1251 * @oh: struct omap_hwmod *
1252 * @name: name of the reset line to lookup and assert
1254 * Some IP like dsp, ipu or iva contain processor that require
1255 * an HW reset line to be assert / deassert in order to enable fully
1258 static int _assert_hardreset(struct omap_hwmod *oh, const char *name)
1260 struct omap_hwmod_rst_info ohri;
1266 ret = _lookup_hardreset(oh, name, &ohri);
1267 if (IS_ERR_VALUE(ret))
1270 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1271 return omap2_prm_assert_hardreset(oh->prcm.omap2.module_offs,
1273 else if (cpu_is_omap44xx())
1274 return omap4_prminst_assert_hardreset(ohri.rst_shift,
1275 oh->clkdm->pwrdm.ptr->prcm_partition,
1276 oh->clkdm->pwrdm.ptr->prcm_offs,
1277 oh->prcm.omap4.rstctrl_offs);
1283 * _deassert_hardreset - deassert the HW reset line of submodules contained
1284 * in the hwmod module.
1285 * @oh: struct omap_hwmod *
1286 * @name: name of the reset line to look up and deassert
1288 * Some IP like dsp, ipu or iva contain processor that require
1289 * an HW reset line to be assert / deassert in order to enable fully
1292 static int _deassert_hardreset(struct omap_hwmod *oh, const char *name)
1294 struct omap_hwmod_rst_info ohri;
1300 ret = _lookup_hardreset(oh, name, &ohri);
1301 if (IS_ERR_VALUE(ret))
1304 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1305 ret = omap2_prm_deassert_hardreset(oh->prcm.omap2.module_offs,
1308 } else if (cpu_is_omap44xx()) {
1310 pr_err("omap_hwmod: %s: %s: hwmod data error: OMAP4 does not support st_shift\n",
1312 ret = omap4_prminst_deassert_hardreset(ohri.rst_shift,
1313 oh->clkdm->pwrdm.ptr->prcm_partition,
1314 oh->clkdm->pwrdm.ptr->prcm_offs,
1315 oh->prcm.omap4.rstctrl_offs);
1321 pr_warning("omap_hwmod: %s: failed to hardreset\n", oh->name);
1327 * _read_hardreset - read the HW reset line state of submodules
1328 * contained in the hwmod module
1329 * @oh: struct omap_hwmod *
1330 * @name: name of the reset line to look up and read
1332 * Return the state of the reset line.
1334 static int _read_hardreset(struct omap_hwmod *oh, const char *name)
1336 struct omap_hwmod_rst_info ohri;
1342 ret = _lookup_hardreset(oh, name, &ohri);
1343 if (IS_ERR_VALUE(ret))
1346 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1347 return omap2_prm_is_hardreset_asserted(oh->prcm.omap2.module_offs,
1349 } else if (cpu_is_omap44xx()) {
1350 return omap4_prminst_is_hardreset_asserted(ohri.rst_shift,
1351 oh->clkdm->pwrdm.ptr->prcm_partition,
1352 oh->clkdm->pwrdm.ptr->prcm_offs,
1353 oh->prcm.omap4.rstctrl_offs);
1360 * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1361 * @oh: struct omap_hwmod *
1363 * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit. hwmod must be
1364 * enabled for this to work. Returns -EINVAL if the hwmod cannot be
1365 * reset this way or if the hwmod is in the wrong state, -ETIMEDOUT if
1366 * the module did not reset in time, or 0 upon success.
1368 * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1369 * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1370 * use the SYSCONFIG softreset bit to provide the status.
1372 * Note that some IP like McBSP do have reset control but don't have
1375 static int _ocp_softreset(struct omap_hwmod *oh)
1381 if (!oh->class->sysc ||
1382 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
1385 /* clocks must be on for this operation */
1386 if (oh->_state != _HWMOD_STATE_ENABLED) {
1387 pr_warning("omap_hwmod: %s: reset can only be entered from "
1388 "enabled state\n", oh->name);
1392 /* For some modules, all optionnal clocks need to be enabled as well */
1393 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1394 _enable_optional_clocks(oh);
1396 pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh->name);
1398 v = oh->_sysc_cache;
1399 ret = _set_softreset(oh, &v);
1403 _write_sysconfig(v, oh);
1404 ret = _clear_softreset(oh, &v);
1408 _write_sysconfig(v, oh);
1410 if (oh->class->sysc->sysc_flags & SYSS_HAS_RESET_STATUS)
1411 omap_test_timeout((omap_hwmod_read(oh,
1412 oh->class->sysc->syss_offs)
1413 & SYSS_RESETDONE_MASK),
1414 MAX_MODULE_SOFTRESET_WAIT, c);
1415 else if (oh->class->sysc->sysc_flags & SYSC_HAS_RESET_STATUS)
1416 omap_test_timeout(!(omap_hwmod_read(oh,
1417 oh->class->sysc->sysc_offs)
1418 & SYSC_TYPE2_SOFTRESET_MASK),
1419 MAX_MODULE_SOFTRESET_WAIT, c);
1421 if (c == MAX_MODULE_SOFTRESET_WAIT)
1422 pr_warning("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1423 oh->name, MAX_MODULE_SOFTRESET_WAIT);
1425 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh->name, c);
1428 * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1429 * _wait_target_ready() or _reset()
1432 ret = (c == MAX_MODULE_SOFTRESET_WAIT) ? -ETIMEDOUT : 0;
1435 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1436 _disable_optional_clocks(oh);
1442 * _reset - reset an omap_hwmod
1443 * @oh: struct omap_hwmod *
1445 * Resets an omap_hwmod @oh. The default software reset mechanism for
1446 * most OMAP IP blocks is triggered via the OCP_SYSCONFIG.SOFTRESET
1447 * bit. However, some hwmods cannot be reset via this method: some
1448 * are not targets and therefore have no OCP header registers to
1449 * access; others (like the IVA) have idiosyncratic reset sequences.
1450 * So for these relatively rare cases, custom reset code can be
1451 * supplied in the struct omap_hwmod_class .reset function pointer.
1452 * Passes along the return value from either _reset() or the custom
1453 * reset function - these must return -EINVAL if the hwmod cannot be
1454 * reset this way or if the hwmod is in the wrong state, -ETIMEDOUT if
1455 * the module did not reset in time, or 0 upon success.
1457 static int _reset(struct omap_hwmod *oh)
1461 pr_debug("omap_hwmod: %s: resetting\n", oh->name);
1463 ret = (oh->class->reset) ? oh->class->reset(oh) : _ocp_softreset(oh);
1469 * _enable - enable an omap_hwmod
1470 * @oh: struct omap_hwmod *
1472 * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
1473 * register target. Returns -EINVAL if the hwmod is in the wrong
1474 * state or passes along the return value of _wait_target_ready().
1476 static int _enable(struct omap_hwmod *oh)
1481 pr_debug("omap_hwmod: %s: enabling\n", oh->name);
1483 if (oh->_state != _HWMOD_STATE_INITIALIZED &&
1484 oh->_state != _HWMOD_STATE_IDLE &&
1485 oh->_state != _HWMOD_STATE_DISABLED) {
1486 WARN(1, "omap_hwmod: %s: enabled state can only be entered "
1487 "from initialized, idle, or disabled state\n", oh->name);
1493 * If an IP contains only one HW reset line, then de-assert it in order
1494 * to allow the module state transition. Otherwise the PRCM will return
1495 * Intransition status, and the init will failed.
1497 if ((oh->_state == _HWMOD_STATE_INITIALIZED ||
1498 oh->_state == _HWMOD_STATE_DISABLED) && oh->rst_lines_cnt == 1)
1499 _deassert_hardreset(oh, oh->rst_lines[0].name);
1501 /* Mux pins for device runtime if populated */
1502 if (oh->mux && (!oh->mux->enabled ||
1503 ((oh->_state == _HWMOD_STATE_IDLE) &&
1504 oh->mux->pads_dynamic)))
1505 omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
1507 _add_initiator_dep(oh, mpu_oh);
1511 * A clockdomain must be in SW_SUP before enabling
1512 * completely the module. The clockdomain can be set
1513 * in HW_AUTO only when the module become ready.
1515 hwsup = clkdm_in_hwsup(oh->clkdm);
1516 r = clkdm_hwmod_enable(oh->clkdm, oh);
1518 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1519 oh->name, oh->clkdm->name, r);
1527 r = _wait_target_ready(oh);
1530 * Set the clockdomain to HW_AUTO only if the target is ready,
1531 * assuming that the previous state was HW_AUTO
1533 if (oh->clkdm && hwsup)
1534 clkdm_allow_idle(oh->clkdm);
1536 oh->_state = _HWMOD_STATE_ENABLED;
1538 /* Access the sysconfig only if the target is ready */
1539 if (oh->class->sysc) {
1540 if (!(oh->_int_flags & _HWMOD_SYSCONFIG_LOADED))
1541 _update_sysc_cache(oh);
1545 _disable_clocks(oh);
1546 pr_debug("omap_hwmod: %s: _wait_target_ready: %d\n",
1550 clkdm_hwmod_disable(oh->clkdm, oh);
1557 * _idle - idle an omap_hwmod
1558 * @oh: struct omap_hwmod *
1560 * Idles an omap_hwmod @oh. This should be called once the hwmod has
1561 * no further work. Returns -EINVAL if the hwmod is in the wrong
1562 * state or returns 0.
1564 static int _idle(struct omap_hwmod *oh)
1568 pr_debug("omap_hwmod: %s: idling\n", oh->name);
1570 if (oh->_state != _HWMOD_STATE_ENABLED) {
1571 WARN(1, "omap_hwmod: %s: idle state can only be entered from "
1572 "enabled state\n", oh->name);
1576 if (oh->class->sysc)
1578 _del_initiator_dep(oh, mpu_oh);
1579 _disable_module(oh);
1580 ret = _wait_target_disable(oh);
1582 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1585 * The module must be in idle mode before disabling any parents
1586 * clocks. Otherwise, the parent clock might be disabled before
1587 * the module transition is done, and thus will prevent the
1588 * transition to complete properly.
1590 _disable_clocks(oh);
1592 clkdm_hwmod_disable(oh->clkdm, oh);
1594 /* Mux pins for device idle if populated */
1595 if (oh->mux && oh->mux->pads_dynamic)
1596 omap_hwmod_mux(oh->mux, _HWMOD_STATE_IDLE);
1598 oh->_state = _HWMOD_STATE_IDLE;
1604 * omap_hwmod_set_ocp_autoidle - set the hwmod's OCP autoidle bit
1605 * @oh: struct omap_hwmod *
1606 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
1608 * Sets the IP block's OCP autoidle bit in hardware, and updates our
1609 * local copy. Intended to be used by drivers that require
1610 * direct manipulation of the AUTOIDLE bits.
1611 * Returns -EINVAL if @oh is null or is not in the ENABLED state, or passes
1612 * along the return value from _set_module_autoidle().
1614 * Any users of this function should be scrutinized carefully.
1616 int omap_hwmod_set_ocp_autoidle(struct omap_hwmod *oh, u8 autoidle)
1620 unsigned long flags;
1622 if (!oh || oh->_state != _HWMOD_STATE_ENABLED)
1625 spin_lock_irqsave(&oh->_lock, flags);
1627 v = oh->_sysc_cache;
1629 retval = _set_module_autoidle(oh, autoidle, &v);
1632 _write_sysconfig(v, oh);
1634 spin_unlock_irqrestore(&oh->_lock, flags);
1640 * _shutdown - shutdown an omap_hwmod
1641 * @oh: struct omap_hwmod *
1643 * Shut down an omap_hwmod @oh. This should be called when the driver
1644 * used for the hwmod is removed or unloaded or if the driver is not
1645 * used by the system. Returns -EINVAL if the hwmod is in the wrong
1646 * state or returns 0.
1648 static int _shutdown(struct omap_hwmod *oh)
1653 if (oh->_state != _HWMOD_STATE_IDLE &&
1654 oh->_state != _HWMOD_STATE_ENABLED) {
1655 WARN(1, "omap_hwmod: %s: disabled state can only be entered "
1656 "from idle, or enabled state\n", oh->name);
1660 pr_debug("omap_hwmod: %s: disabling\n", oh->name);
1662 if (oh->class->pre_shutdown) {
1663 prev_state = oh->_state;
1664 if (oh->_state == _HWMOD_STATE_IDLE)
1666 ret = oh->class->pre_shutdown(oh);
1668 if (prev_state == _HWMOD_STATE_IDLE)
1674 if (oh->class->sysc) {
1675 if (oh->_state == _HWMOD_STATE_IDLE)
1680 /* clocks and deps are already disabled in idle */
1681 if (oh->_state == _HWMOD_STATE_ENABLED) {
1682 _del_initiator_dep(oh, mpu_oh);
1683 /* XXX what about the other system initiators here? dma, dsp */
1684 _disable_module(oh);
1685 ret = _wait_target_disable(oh);
1687 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1689 _disable_clocks(oh);
1691 clkdm_hwmod_disable(oh->clkdm, oh);
1693 /* XXX Should this code also force-disable the optional clocks? */
1696 * If an IP contains only one HW reset line, then assert it
1697 * after disabling the clocks and before shutting down the IP.
1699 if (oh->rst_lines_cnt == 1)
1700 _assert_hardreset(oh, oh->rst_lines[0].name);
1702 /* Mux pins to safe mode or use populated off mode values */
1704 omap_hwmod_mux(oh->mux, _HWMOD_STATE_DISABLED);
1706 oh->_state = _HWMOD_STATE_DISABLED;
1712 * _setup - do initial configuration of omap_hwmod
1713 * @oh: struct omap_hwmod *
1715 * Writes the CLOCKACTIVITY bits @clockact to the hwmod @oh
1716 * OCP_SYSCONFIG register. Returns 0.
1718 static int _setup(struct omap_hwmod *oh, void *data)
1723 if (oh->_state != _HWMOD_STATE_CLKS_INITED)
1726 /* Set iclk autoidle mode */
1727 if (oh->slaves_cnt > 0) {
1728 for (i = 0; i < oh->slaves_cnt; i++) {
1729 struct omap_hwmod_ocp_if *os = oh->slaves[i];
1730 struct clk *c = os->_clk;
1735 if (os->flags & OCPIF_SWSUP_IDLE) {
1736 /* XXX omap_iclk_deny_idle(c); */
1738 /* XXX omap_iclk_allow_idle(c); */
1744 oh->_state = _HWMOD_STATE_INITIALIZED;
1747 * In the case of hwmod with hardreset that should not be
1748 * de-assert at boot time, we have to keep the module
1749 * initialized, because we cannot enable it properly with the
1750 * reset asserted. Exit without warning because that behavior is
1753 if ((oh->flags & HWMOD_INIT_NO_RESET) && oh->rst_lines_cnt == 1)
1758 pr_warning("omap_hwmod: %s: cannot be enabled (%d)\n",
1759 oh->name, oh->_state);
1763 if (!(oh->flags & HWMOD_INIT_NO_RESET)) {
1767 * OCP_SYSCONFIG bits need to be reprogrammed after a softreset.
1768 * The _enable() function should be split to
1769 * avoid the rewrite of the OCP_SYSCONFIG register.
1771 if (oh->class->sysc) {
1772 _update_sysc_cache(oh);
1777 postsetup_state = oh->_postsetup_state;
1778 if (postsetup_state == _HWMOD_STATE_UNKNOWN)
1779 postsetup_state = _HWMOD_STATE_ENABLED;
1782 * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
1783 * it should be set by the core code as a runtime flag during startup
1785 if ((oh->flags & HWMOD_INIT_NO_IDLE) &&
1786 (postsetup_state == _HWMOD_STATE_IDLE))
1787 postsetup_state = _HWMOD_STATE_ENABLED;
1789 if (postsetup_state == _HWMOD_STATE_IDLE)
1791 else if (postsetup_state == _HWMOD_STATE_DISABLED)
1793 else if (postsetup_state != _HWMOD_STATE_ENABLED)
1794 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
1795 oh->name, postsetup_state);
1801 * _register - register a struct omap_hwmod
1802 * @oh: struct omap_hwmod *
1804 * Registers the omap_hwmod @oh. Returns -EEXIST if an omap_hwmod
1805 * already has been registered by the same name; -EINVAL if the
1806 * omap_hwmod is in the wrong state, if @oh is NULL, if the
1807 * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
1808 * name, or if the omap_hwmod's class is missing a name; or 0 upon
1811 * XXX The data should be copied into bootmem, so the original data
1812 * should be marked __initdata and freed after init. This would allow
1813 * unneeded omap_hwmods to be freed on multi-OMAP configurations. Note
1814 * that the copy process would be relatively complex due to the large number
1817 static int __init _register(struct omap_hwmod *oh)
1821 if (!oh || !oh->name || !oh->class || !oh->class->name ||
1822 (oh->_state != _HWMOD_STATE_UNKNOWN))
1825 pr_debug("omap_hwmod: %s: registering\n", oh->name);
1827 if (_lookup(oh->name))
1830 ms_id = _find_mpu_port_index(oh);
1831 if (!IS_ERR_VALUE(ms_id))
1832 oh->_mpu_port_index = ms_id;
1834 oh->_int_flags |= _HWMOD_NO_MPU_PORT;
1836 list_add_tail(&oh->node, &omap_hwmod_list);
1838 spin_lock_init(&oh->_lock);
1840 oh->_state = _HWMOD_STATE_REGISTERED;
1843 * XXX Rather than doing a strcmp(), this should test a flag
1844 * set in the hwmod data, inserted by the autogenerator code.
1846 if (!strcmp(oh->name, MPU_INITIATOR_NAME))
1853 /* Public functions */
1855 u32 omap_hwmod_read(struct omap_hwmod *oh, u16 reg_offs)
1857 if (oh->flags & HWMOD_16BIT_REG)
1858 return __raw_readw(oh->_mpu_rt_va + reg_offs);
1860 return __raw_readl(oh->_mpu_rt_va + reg_offs);
1863 void omap_hwmod_write(u32 v, struct omap_hwmod *oh, u16 reg_offs)
1865 if (oh->flags & HWMOD_16BIT_REG)
1866 __raw_writew(v, oh->_mpu_rt_va + reg_offs);
1868 __raw_writel(v, oh->_mpu_rt_va + reg_offs);
1872 * omap_hwmod_softreset - reset a module via SYSCONFIG.SOFTRESET bit
1873 * @oh: struct omap_hwmod *
1875 * This is a public function exposed to drivers. Some drivers may need to do
1876 * some settings before and after resetting the device. Those drivers after
1877 * doing the necessary settings could use this function to start a reset by
1878 * setting the SYSCONFIG.SOFTRESET bit.
1880 int omap_hwmod_softreset(struct omap_hwmod *oh)
1885 if (!oh || !(oh->_sysc_cache))
1888 v = oh->_sysc_cache;
1889 ret = _set_softreset(oh, &v);
1892 _write_sysconfig(v, oh);
1894 ret = _clear_softreset(oh, &v);
1897 _write_sysconfig(v, oh);
1904 * omap_hwmod_set_slave_idlemode - set the hwmod's OCP slave idlemode
1905 * @oh: struct omap_hwmod *
1906 * @idlemode: SIDLEMODE field bits (shifted to bit 0)
1908 * Sets the IP block's OCP slave idlemode in hardware, and updates our
1909 * local copy. Intended to be used by drivers that have some erratum
1910 * that requires direct manipulation of the SIDLEMODE bits. Returns
1911 * -EINVAL if @oh is null, or passes along the return value from
1912 * _set_slave_idlemode().
1914 * XXX Does this function have any current users? If not, we should
1915 * remove it; it is better to let the rest of the hwmod code handle this.
1916 * Any users of this function should be scrutinized carefully.
1918 int omap_hwmod_set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode)
1926 v = oh->_sysc_cache;
1928 retval = _set_slave_idlemode(oh, idlemode, &v);
1930 _write_sysconfig(v, oh);
1936 * omap_hwmod_lookup - look up a registered omap_hwmod by name
1937 * @name: name of the omap_hwmod to look up
1939 * Given a @name of an omap_hwmod, return a pointer to the registered
1940 * struct omap_hwmod *, or NULL upon error.
1942 struct omap_hwmod *omap_hwmod_lookup(const char *name)
1944 struct omap_hwmod *oh;
1955 * omap_hwmod_for_each - call function for each registered omap_hwmod
1956 * @fn: pointer to a callback function
1957 * @data: void * data to pass to callback function
1959 * Call @fn for each registered omap_hwmod, passing @data to each
1960 * function. @fn must return 0 for success or any other value for
1961 * failure. If @fn returns non-zero, the iteration across omap_hwmods
1962 * will stop and the non-zero return value will be passed to the
1963 * caller of omap_hwmod_for_each(). @fn is called with
1964 * omap_hwmod_for_each() held.
1966 int omap_hwmod_for_each(int (*fn)(struct omap_hwmod *oh, void *data),
1969 struct omap_hwmod *temp_oh;
1975 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1976 ret = (*fn)(temp_oh, data);
1985 * omap_hwmod_register - register an array of hwmods
1986 * @ohs: pointer to an array of omap_hwmods to register
1988 * Intended to be called early in boot before the clock framework is
1989 * initialized. If @ohs is not null, will register all omap_hwmods
1990 * listed in @ohs that are valid for this chip. Returns 0.
1992 int __init omap_hwmod_register(struct omap_hwmod **ohs)
2001 r = _register(ohs[i]);
2002 WARN(r, "omap_hwmod: %s: _register returned %d\n", ohs[i]->name,
2010 * _populate_mpu_rt_base - populate the virtual address for a hwmod
2012 * Must be called only from omap_hwmod_setup_*() so ioremap works properly.
2013 * Assumes the caller takes care of locking if needed.
2015 static int __init _populate_mpu_rt_base(struct omap_hwmod *oh, void *data)
2017 if (oh->_state != _HWMOD_STATE_REGISTERED)
2020 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2023 oh->_mpu_rt_va = _find_mpu_rt_base(oh, oh->_mpu_port_index);
2029 * omap_hwmod_setup_one - set up a single hwmod
2030 * @oh_name: const char * name of the already-registered hwmod to set up
2032 * Must be called after omap2_clk_init(). Resolves the struct clk
2033 * names to struct clk pointers for each registered omap_hwmod. Also
2034 * calls _setup() on each hwmod. Returns -EINVAL upon error or 0 upon
2037 int __init omap_hwmod_setup_one(const char *oh_name)
2039 struct omap_hwmod *oh;
2042 pr_debug("omap_hwmod: %s: %s\n", oh_name, __func__);
2045 pr_err("omap_hwmod: %s: cannot setup_one: MPU initiator hwmod %s not yet registered\n",
2046 oh_name, MPU_INITIATOR_NAME);
2050 oh = _lookup(oh_name);
2052 WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name);
2056 if (mpu_oh->_state == _HWMOD_STATE_REGISTERED && oh != mpu_oh)
2057 omap_hwmod_setup_one(MPU_INITIATOR_NAME);
2059 r = _populate_mpu_rt_base(oh, NULL);
2060 if (IS_ERR_VALUE(r)) {
2061 WARN(1, "omap_hwmod: %s: couldn't set mpu_rt_base\n", oh_name);
2065 r = _init_clocks(oh, NULL);
2066 if (IS_ERR_VALUE(r)) {
2067 WARN(1, "omap_hwmod: %s: couldn't init clocks\n", oh_name);
2077 * omap_hwmod_setup - do some post-clock framework initialization
2079 * Must be called after omap2_clk_init(). Resolves the struct clk names
2080 * to struct clk pointers for each registered omap_hwmod. Also calls
2081 * _setup() on each hwmod. Returns 0 upon success.
2083 static int __init omap_hwmod_setup_all(void)
2088 pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",
2089 __func__, MPU_INITIATOR_NAME);
2093 r = omap_hwmod_for_each(_populate_mpu_rt_base, NULL);
2095 r = omap_hwmod_for_each(_init_clocks, NULL);
2096 WARN(IS_ERR_VALUE(r),
2097 "omap_hwmod: %s: _init_clocks failed\n", __func__);
2099 omap_hwmod_for_each(_setup, NULL);
2103 core_initcall(omap_hwmod_setup_all);
2106 * omap_hwmod_enable - enable an omap_hwmod
2107 * @oh: struct omap_hwmod *
2109 * Enable an omap_hwmod @oh. Intended to be called by omap_device_enable().
2110 * Returns -EINVAL on error or passes along the return value from _enable().
2112 int omap_hwmod_enable(struct omap_hwmod *oh)
2115 unsigned long flags;
2120 spin_lock_irqsave(&oh->_lock, flags);
2122 spin_unlock_irqrestore(&oh->_lock, flags);
2128 * omap_hwmod_idle - idle an omap_hwmod
2129 * @oh: struct omap_hwmod *
2131 * Idle an omap_hwmod @oh. Intended to be called by omap_device_idle().
2132 * Returns -EINVAL on error or passes along the return value from _idle().
2134 int omap_hwmod_idle(struct omap_hwmod *oh)
2136 unsigned long flags;
2141 spin_lock_irqsave(&oh->_lock, flags);
2143 spin_unlock_irqrestore(&oh->_lock, flags);
2149 * omap_hwmod_shutdown - shutdown an omap_hwmod
2150 * @oh: struct omap_hwmod *
2152 * Shutdown an omap_hwmod @oh. Intended to be called by
2153 * omap_device_shutdown(). Returns -EINVAL on error or passes along
2154 * the return value from _shutdown().
2156 int omap_hwmod_shutdown(struct omap_hwmod *oh)
2158 unsigned long flags;
2163 spin_lock_irqsave(&oh->_lock, flags);
2165 spin_unlock_irqrestore(&oh->_lock, flags);
2171 * omap_hwmod_enable_clocks - enable main_clk, all interface clocks
2172 * @oh: struct omap_hwmod *oh
2174 * Intended to be called by the omap_device code.
2176 int omap_hwmod_enable_clocks(struct omap_hwmod *oh)
2178 unsigned long flags;
2180 spin_lock_irqsave(&oh->_lock, flags);
2182 spin_unlock_irqrestore(&oh->_lock, flags);
2188 * omap_hwmod_disable_clocks - disable main_clk, all interface clocks
2189 * @oh: struct omap_hwmod *oh
2191 * Intended to be called by the omap_device code.
2193 int omap_hwmod_disable_clocks(struct omap_hwmod *oh)
2195 unsigned long flags;
2197 spin_lock_irqsave(&oh->_lock, flags);
2198 _disable_clocks(oh);
2199 spin_unlock_irqrestore(&oh->_lock, flags);
2205 * omap_hwmod_ocp_barrier - wait for posted writes against the hwmod to complete
2206 * @oh: struct omap_hwmod *oh
2208 * Intended to be called by drivers and core code when all posted
2209 * writes to a device must complete before continuing further
2210 * execution (for example, after clearing some device IRQSTATUS
2213 * XXX what about targets with multiple OCP threads?
2215 void omap_hwmod_ocp_barrier(struct omap_hwmod *oh)
2219 if (!oh->class->sysc || !oh->class->sysc->sysc_flags) {
2220 WARN(1, "omap_device: %s: OCP barrier impossible due to "
2221 "device configuration\n", oh->name);
2226 * Forces posted writes to complete on the OCP thread handling
2229 omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
2233 * omap_hwmod_reset - reset the hwmod
2234 * @oh: struct omap_hwmod *
2236 * Under some conditions, a driver may wish to reset the entire device.
2237 * Called from omap_device code. Returns -EINVAL on error or passes along
2238 * the return value from _reset().
2240 int omap_hwmod_reset(struct omap_hwmod *oh)
2243 unsigned long flags;
2248 spin_lock_irqsave(&oh->_lock, flags);
2250 spin_unlock_irqrestore(&oh->_lock, flags);
2256 * omap_hwmod_count_resources - count number of struct resources needed by hwmod
2257 * @oh: struct omap_hwmod *
2258 * @res: pointer to the first element of an array of struct resource to fill
2260 * Count the number of struct resource array elements necessary to
2261 * contain omap_hwmod @oh resources. Intended to be called by code
2262 * that registers omap_devices. Intended to be used to determine the
2263 * size of a dynamically-allocated struct resource array, before
2264 * calling omap_hwmod_fill_resources(). Returns the number of struct
2265 * resource array elements needed.
2267 * XXX This code is not optimized. It could attempt to merge adjacent
2271 int omap_hwmod_count_resources(struct omap_hwmod *oh)
2275 ret = _count_mpu_irqs(oh) + _count_sdma_reqs(oh);
2277 for (i = 0; i < oh->slaves_cnt; i++)
2278 ret += _count_ocp_if_addr_spaces(oh->slaves[i]);
2284 * omap_hwmod_fill_resources - fill struct resource array with hwmod data
2285 * @oh: struct omap_hwmod *
2286 * @res: pointer to the first element of an array of struct resource to fill
2288 * Fill the struct resource array @res with resource data from the
2289 * omap_hwmod @oh. Intended to be called by code that registers
2290 * omap_devices. See also omap_hwmod_count_resources(). Returns the
2291 * number of array elements filled.
2293 int omap_hwmod_fill_resources(struct omap_hwmod *oh, struct resource *res)
2295 int i, j, mpu_irqs_cnt, sdma_reqs_cnt;
2298 /* For each IRQ, DMA, memory area, fill in array.*/
2300 mpu_irqs_cnt = _count_mpu_irqs(oh);
2301 for (i = 0; i < mpu_irqs_cnt; i++) {
2302 (res + r)->name = (oh->mpu_irqs + i)->name;
2303 (res + r)->start = (oh->mpu_irqs + i)->irq;
2304 (res + r)->end = (oh->mpu_irqs + i)->irq;
2305 (res + r)->flags = IORESOURCE_IRQ;
2309 sdma_reqs_cnt = _count_sdma_reqs(oh);
2310 for (i = 0; i < sdma_reqs_cnt; i++) {
2311 (res + r)->name = (oh->sdma_reqs + i)->name;
2312 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
2313 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
2314 (res + r)->flags = IORESOURCE_DMA;
2318 for (i = 0; i < oh->slaves_cnt; i++) {
2319 struct omap_hwmod_ocp_if *os;
2323 addr_cnt = _count_ocp_if_addr_spaces(os);
2325 for (j = 0; j < addr_cnt; j++) {
2326 (res + r)->name = (os->addr + j)->name;
2327 (res + r)->start = (os->addr + j)->pa_start;
2328 (res + r)->end = (os->addr + j)->pa_end;
2329 (res + r)->flags = IORESOURCE_MEM;
2338 * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
2339 * @oh: struct omap_hwmod *
2341 * Return the powerdomain pointer associated with the OMAP module
2342 * @oh's main clock. If @oh does not have a main clk, return the
2343 * powerdomain associated with the interface clock associated with the
2344 * module's MPU port. (XXX Perhaps this should use the SDMA port
2345 * instead?) Returns NULL on error, or a struct powerdomain * on
2348 struct powerdomain *omap_hwmod_get_pwrdm(struct omap_hwmod *oh)
2358 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2360 c = oh->slaves[oh->_mpu_port_index]->_clk;
2366 return c->clkdm->pwrdm.ptr;
2371 * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
2372 * @oh: struct omap_hwmod *
2374 * Returns the virtual address corresponding to the beginning of the
2375 * module's register target, in the address range that is intended to
2376 * be used by the MPU. Returns the virtual address upon success or NULL
2379 void __iomem *omap_hwmod_get_mpu_rt_va(struct omap_hwmod *oh)
2384 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2387 if (oh->_state == _HWMOD_STATE_UNKNOWN)
2390 return oh->_mpu_rt_va;
2394 * omap_hwmod_add_initiator_dep - add sleepdep from @init_oh to @oh
2395 * @oh: struct omap_hwmod *
2396 * @init_oh: struct omap_hwmod * (initiator)
2398 * Add a sleep dependency between the initiator @init_oh and @oh.
2399 * Intended to be called by DSP/Bridge code via platform_data for the
2400 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
2401 * code needs to add/del initiator dependencies dynamically
2402 * before/after accessing a device. Returns the return value from
2403 * _add_initiator_dep().
2405 * XXX Keep a usecount in the clockdomain code
2407 int omap_hwmod_add_initiator_dep(struct omap_hwmod *oh,
2408 struct omap_hwmod *init_oh)
2410 return _add_initiator_dep(oh, init_oh);
2414 * XXX what about functions for drivers to save/restore ocp_sysconfig
2415 * for context save/restore operations?
2419 * omap_hwmod_del_initiator_dep - remove sleepdep from @init_oh to @oh
2420 * @oh: struct omap_hwmod *
2421 * @init_oh: struct omap_hwmod * (initiator)
2423 * Remove a sleep dependency between the initiator @init_oh and @oh.
2424 * Intended to be called by DSP/Bridge code via platform_data for the
2425 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
2426 * code needs to add/del initiator dependencies dynamically
2427 * before/after accessing a device. Returns the return value from
2428 * _del_initiator_dep().
2430 * XXX Keep a usecount in the clockdomain code
2432 int omap_hwmod_del_initiator_dep(struct omap_hwmod *oh,
2433 struct omap_hwmod *init_oh)
2435 return _del_initiator_dep(oh, init_oh);
2439 * omap_hwmod_enable_wakeup - allow device to wake up the system
2440 * @oh: struct omap_hwmod *
2442 * Sets the module OCP socket ENAWAKEUP bit to allow the module to
2443 * send wakeups to the PRCM. Eventually this should sets PRCM wakeup
2444 * registers to cause the PRCM to receive wakeup events from the
2445 * module. Does not set any wakeup routing registers beyond this
2446 * point - if the module is to wake up any other module or subsystem,
2447 * that must be set separately. Called by omap_device code. Returns
2448 * -EINVAL on error or 0 upon success.
2450 int omap_hwmod_enable_wakeup(struct omap_hwmod *oh)
2452 unsigned long flags;
2455 if (!oh->class->sysc ||
2456 !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
2459 spin_lock_irqsave(&oh->_lock, flags);
2460 v = oh->_sysc_cache;
2461 _enable_wakeup(oh, &v);
2462 _write_sysconfig(v, oh);
2463 spin_unlock_irqrestore(&oh->_lock, flags);
2469 * omap_hwmod_disable_wakeup - prevent device from waking the system
2470 * @oh: struct omap_hwmod *
2472 * Clears the module OCP socket ENAWAKEUP bit to prevent the module
2473 * from sending wakeups to the PRCM. Eventually this should clear
2474 * PRCM wakeup registers to cause the PRCM to ignore wakeup events
2475 * from the module. Does not set any wakeup routing registers beyond
2476 * this point - if the module is to wake up any other module or
2477 * subsystem, that must be set separately. Called by omap_device
2478 * code. Returns -EINVAL on error or 0 upon success.
2480 int omap_hwmod_disable_wakeup(struct omap_hwmod *oh)
2482 unsigned long flags;
2485 if (!oh->class->sysc ||
2486 !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
2489 spin_lock_irqsave(&oh->_lock, flags);
2490 v = oh->_sysc_cache;
2491 _disable_wakeup(oh, &v);
2492 _write_sysconfig(v, oh);
2493 spin_unlock_irqrestore(&oh->_lock, flags);
2499 * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
2500 * contained in the hwmod module.
2501 * @oh: struct omap_hwmod *
2502 * @name: name of the reset line to lookup and assert
2504 * Some IP like dsp, ipu or iva contain processor that require
2505 * an HW reset line to be assert / deassert in order to enable fully
2506 * the IP. Returns -EINVAL if @oh is null or if the operation is not
2507 * yet supported on this OMAP; otherwise, passes along the return value
2508 * from _assert_hardreset().
2510 int omap_hwmod_assert_hardreset(struct omap_hwmod *oh, const char *name)
2513 unsigned long flags;
2518 spin_lock_irqsave(&oh->_lock, flags);
2519 ret = _assert_hardreset(oh, name);
2520 spin_unlock_irqrestore(&oh->_lock, flags);
2526 * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
2527 * contained in the hwmod module.
2528 * @oh: struct omap_hwmod *
2529 * @name: name of the reset line to look up and deassert
2531 * Some IP like dsp, ipu or iva contain processor that require
2532 * an HW reset line to be assert / deassert in order to enable fully
2533 * the IP. Returns -EINVAL if @oh is null or if the operation is not
2534 * yet supported on this OMAP; otherwise, passes along the return value
2535 * from _deassert_hardreset().
2537 int omap_hwmod_deassert_hardreset(struct omap_hwmod *oh, const char *name)
2540 unsigned long flags;
2545 spin_lock_irqsave(&oh->_lock, flags);
2546 ret = _deassert_hardreset(oh, name);
2547 spin_unlock_irqrestore(&oh->_lock, flags);
2553 * omap_hwmod_read_hardreset - read the HW reset line state of submodules
2554 * contained in the hwmod module
2555 * @oh: struct omap_hwmod *
2556 * @name: name of the reset line to look up and read
2558 * Return the current state of the hwmod @oh's reset line named @name:
2559 * returns -EINVAL upon parameter error or if this operation
2560 * is unsupported on the current OMAP; otherwise, passes along the return
2561 * value from _read_hardreset().
2563 int omap_hwmod_read_hardreset(struct omap_hwmod *oh, const char *name)
2566 unsigned long flags;
2571 spin_lock_irqsave(&oh->_lock, flags);
2572 ret = _read_hardreset(oh, name);
2573 spin_unlock_irqrestore(&oh->_lock, flags);
2580 * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
2581 * @classname: struct omap_hwmod_class name to search for
2582 * @fn: callback function pointer to call for each hwmod in class @classname
2583 * @user: arbitrary context data to pass to the callback function
2585 * For each omap_hwmod of class @classname, call @fn.
2586 * If the callback function returns something other than
2587 * zero, the iterator is terminated, and the callback function's return
2588 * value is passed back to the caller. Returns 0 upon success, -EINVAL
2589 * if @classname or @fn are NULL, or passes back the error code from @fn.
2591 int omap_hwmod_for_each_by_class(const char *classname,
2592 int (*fn)(struct omap_hwmod *oh,
2596 struct omap_hwmod *temp_oh;
2599 if (!classname || !fn)
2602 pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
2603 __func__, classname);
2605 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
2606 if (!strcmp(temp_oh->class->name, classname)) {
2607 pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
2608 __func__, temp_oh->name);
2609 ret = (*fn)(temp_oh, user);
2616 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
2623 * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
2624 * @oh: struct omap_hwmod *
2625 * @state: state that _setup() should leave the hwmod in
2627 * Sets the hwmod state that @oh will enter at the end of _setup()
2628 * (called by omap_hwmod_setup_*()). Only valid to call between
2629 * calling omap_hwmod_register() and omap_hwmod_setup_*(). Returns
2630 * 0 upon success or -EINVAL if there is a problem with the arguments
2631 * or if the hwmod is in the wrong state.
2633 int omap_hwmod_set_postsetup_state(struct omap_hwmod *oh, u8 state)
2636 unsigned long flags;
2641 if (state != _HWMOD_STATE_DISABLED &&
2642 state != _HWMOD_STATE_ENABLED &&
2643 state != _HWMOD_STATE_IDLE)
2646 spin_lock_irqsave(&oh->_lock, flags);
2648 if (oh->_state != _HWMOD_STATE_REGISTERED) {
2653 oh->_postsetup_state = state;
2657 spin_unlock_irqrestore(&oh->_lock, flags);
2663 * omap_hwmod_get_context_loss_count - get lost context count
2664 * @oh: struct omap_hwmod *
2666 * Query the powerdomain of of @oh to get the context loss
2667 * count for this device.
2669 * Returns the context loss count of the powerdomain assocated with @oh
2670 * upon success, or zero if no powerdomain exists for @oh.
2672 int omap_hwmod_get_context_loss_count(struct omap_hwmod *oh)
2674 struct powerdomain *pwrdm;
2677 pwrdm = omap_hwmod_get_pwrdm(oh);
2679 ret = pwrdm_get_context_loss_count(pwrdm);
2685 * omap_hwmod_no_setup_reset - prevent a hwmod from being reset upon setup
2686 * @oh: struct omap_hwmod *
2688 * Prevent the hwmod @oh from being reset during the setup process.
2689 * Intended for use by board-*.c files on boards with devices that
2690 * cannot tolerate being reset. Must be called before the hwmod has
2691 * been set up. Returns 0 upon success or negative error code upon
2694 int omap_hwmod_no_setup_reset(struct omap_hwmod *oh)
2699 if (oh->_state != _HWMOD_STATE_REGISTERED) {
2700 pr_err("omap_hwmod: %s: cannot prevent setup reset; in wrong state\n",
2705 oh->flags |= HWMOD_INIT_NO_RESET;