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 * Ensure that the OCP_SYSCONFIG register for the IP block represented
914 * by @oh is set to indicate to the PRCM that the IP block is active.
915 * Usually this means placing the module into smart-idle mode and
916 * smart-standby, but if there is a bug in the automatic idle handling
917 * for the IP block, it may need to be placed into the force-idle or
918 * no-idle variants of these modes. No return value.
920 static void _enable_sysc(struct omap_hwmod *oh)
926 if (!oh->class->sysc)
930 sf = oh->class->sysc->sysc_flags;
932 if (sf & SYSC_HAS_SIDLEMODE) {
933 if (oh->flags & HWMOD_SWSUP_SIDLE) {
934 idlemode = HWMOD_IDLEMODE_NO;
936 if (sf & SYSC_HAS_ENAWAKEUP)
937 _enable_wakeup(oh, &v);
938 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
939 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
941 idlemode = HWMOD_IDLEMODE_SMART;
945 * This is special handling for some IPs like
946 * 32k sync timer. Force them to idle!
948 clkdm_act = ((oh->clkdm &&
949 oh->clkdm->flags & CLKDM_ACTIVE_WITH_MPU) ||
950 (oh->_clk && oh->_clk->clkdm &&
951 oh->_clk->clkdm->flags & CLKDM_ACTIVE_WITH_MPU));
952 if (clkdm_act && !(oh->class->sysc->idlemodes &
953 (SIDLE_SMART | SIDLE_SMART_WKUP)))
954 idlemode = HWMOD_IDLEMODE_FORCE;
956 _set_slave_idlemode(oh, idlemode, &v);
959 if (sf & SYSC_HAS_MIDLEMODE) {
960 if (oh->flags & HWMOD_FORCE_MSTANDBY) {
961 idlemode = HWMOD_IDLEMODE_FORCE;
962 } else if (oh->flags & HWMOD_SWSUP_MSTANDBY) {
963 idlemode = HWMOD_IDLEMODE_NO;
965 if (sf & SYSC_HAS_ENAWAKEUP)
966 _enable_wakeup(oh, &v);
967 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
968 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
970 idlemode = HWMOD_IDLEMODE_SMART;
972 _set_master_standbymode(oh, idlemode, &v);
976 * XXX The clock framework should handle this, by
977 * calling into this code. But this must wait until the
978 * clock structures are tagged with omap_hwmod entries
980 if ((oh->flags & HWMOD_SET_DEFAULT_CLOCKACT) &&
981 (sf & SYSC_HAS_CLOCKACTIVITY))
982 _set_clockactivity(oh, oh->class->sysc->clockact, &v);
984 /* If the cached value is the same as the new value, skip the write */
985 if (oh->_sysc_cache != v)
986 _write_sysconfig(v, oh);
989 * Set the autoidle bit only after setting the smartidle bit
990 * Setting this will not have any impact on the other modules.
992 if (sf & SYSC_HAS_AUTOIDLE) {
993 idlemode = (oh->flags & HWMOD_NO_OCP_AUTOIDLE) ?
995 _set_module_autoidle(oh, idlemode, &v);
996 _write_sysconfig(v, oh);
1001 * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
1002 * @oh: struct omap_hwmod *
1004 * If module is marked as SWSUP_SIDLE, force the module into slave
1005 * idle; otherwise, configure it for smart-idle. If module is marked
1006 * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
1007 * configure it for smart-standby. No return value.
1009 static void _idle_sysc(struct omap_hwmod *oh)
1014 if (!oh->class->sysc)
1017 v = oh->_sysc_cache;
1018 sf = oh->class->sysc->sysc_flags;
1020 if (sf & SYSC_HAS_SIDLEMODE) {
1021 if (oh->flags & HWMOD_SWSUP_SIDLE) {
1022 idlemode = HWMOD_IDLEMODE_FORCE;
1024 if (sf & SYSC_HAS_ENAWAKEUP)
1025 _enable_wakeup(oh, &v);
1026 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
1027 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1029 idlemode = HWMOD_IDLEMODE_SMART;
1031 _set_slave_idlemode(oh, idlemode, &v);
1034 if (sf & SYSC_HAS_MIDLEMODE) {
1035 if ((oh->flags & HWMOD_SWSUP_MSTANDBY) ||
1036 (oh->flags & HWMOD_FORCE_MSTANDBY)) {
1037 idlemode = HWMOD_IDLEMODE_FORCE;
1039 if (sf & SYSC_HAS_ENAWAKEUP)
1040 _enable_wakeup(oh, &v);
1041 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1042 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1044 idlemode = HWMOD_IDLEMODE_SMART;
1046 _set_master_standbymode(oh, idlemode, &v);
1049 _write_sysconfig(v, oh);
1053 * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
1054 * @oh: struct omap_hwmod *
1056 * Force the module into slave idle and master suspend. No return
1059 static void _shutdown_sysc(struct omap_hwmod *oh)
1064 if (!oh->class->sysc)
1067 v = oh->_sysc_cache;
1068 sf = oh->class->sysc->sysc_flags;
1070 if (sf & SYSC_HAS_SIDLEMODE)
1071 _set_slave_idlemode(oh, HWMOD_IDLEMODE_FORCE, &v);
1073 if (sf & SYSC_HAS_MIDLEMODE)
1074 _set_master_standbymode(oh, HWMOD_IDLEMODE_FORCE, &v);
1076 if (sf & SYSC_HAS_AUTOIDLE)
1077 _set_module_autoidle(oh, 1, &v);
1079 _write_sysconfig(v, oh);
1083 * _lookup - find an omap_hwmod by name
1084 * @name: find an omap_hwmod by name
1086 * Return a pointer to an omap_hwmod by name, or NULL if not found.
1088 static struct omap_hwmod *_lookup(const char *name)
1090 struct omap_hwmod *oh, *temp_oh;
1094 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1095 if (!strcmp(name, temp_oh->name)) {
1104 * _init_clkdm - look up a clockdomain name, store pointer in omap_hwmod
1105 * @oh: struct omap_hwmod *
1107 * Convert a clockdomain name stored in a struct omap_hwmod into a
1108 * clockdomain pointer, and save it into the struct omap_hwmod.
1109 * return -EINVAL if clkdm_name does not exist or if the lookup failed.
1111 static int _init_clkdm(struct omap_hwmod *oh)
1113 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1116 if (!oh->clkdm_name) {
1117 pr_warning("omap_hwmod: %s: no clkdm_name\n", oh->name);
1121 oh->clkdm = clkdm_lookup(oh->clkdm_name);
1123 pr_warning("omap_hwmod: %s: could not associate to clkdm %s\n",
1124 oh->name, oh->clkdm_name);
1128 pr_debug("omap_hwmod: %s: associated to clkdm %s\n",
1129 oh->name, oh->clkdm_name);
1135 * _init_clocks - clk_get() all clocks associated with this hwmod. Retrieve as
1136 * well the clockdomain.
1137 * @oh: struct omap_hwmod *
1138 * @data: not used; pass NULL
1140 * Called by omap_hwmod_setup_*() (after omap2_clk_init()).
1141 * Resolves all clock names embedded in the hwmod. Returns 0 on
1142 * success, or a negative error code on failure.
1144 static int _init_clocks(struct omap_hwmod *oh, void *data)
1148 if (oh->_state != _HWMOD_STATE_REGISTERED)
1151 pr_debug("omap_hwmod: %s: looking up clocks\n", oh->name);
1153 ret |= _init_main_clk(oh);
1154 ret |= _init_interface_clks(oh);
1155 ret |= _init_opt_clks(oh);
1156 ret |= _init_clkdm(oh);
1159 oh->_state = _HWMOD_STATE_CLKS_INITED;
1161 pr_warning("omap_hwmod: %s: cannot _init_clocks\n", oh->name);
1167 * _wait_target_ready - wait for a module to leave slave idle
1168 * @oh: struct omap_hwmod *
1170 * Wait for a module @oh to leave slave idle. Returns 0 if the module
1171 * does not have an IDLEST bit or if the module successfully leaves
1172 * slave idle; otherwise, pass along the return value of the
1173 * appropriate *_cm*_wait_module_ready() function.
1175 static int _wait_target_ready(struct omap_hwmod *oh)
1177 struct omap_hwmod_ocp_if *os;
1183 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
1186 os = oh->slaves[oh->_mpu_port_index];
1188 if (oh->flags & HWMOD_NO_IDLEST)
1191 /* XXX check module SIDLEMODE */
1193 /* XXX check clock enable states */
1195 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1196 ret = omap2_cm_wait_module_ready(oh->prcm.omap2.module_offs,
1197 oh->prcm.omap2.idlest_reg_id,
1198 oh->prcm.omap2.idlest_idle_bit);
1199 } else if (cpu_is_omap44xx()) {
1203 ret = omap4_cminst_wait_module_ready(oh->clkdm->prcm_partition,
1205 oh->clkdm->clkdm_offs,
1206 oh->prcm.omap4.clkctrl_offs);
1215 * _wait_target_disable - wait for a module to be disabled
1216 * @oh: struct omap_hwmod *
1218 * Wait for a module @oh to enter slave idle. Returns 0 if the module
1219 * does not have an IDLEST bit or if the module successfully enters
1220 * slave idle; otherwise, pass along the return value of the
1221 * appropriate *_cm*_wait_module_idle() function.
1223 static int _wait_target_disable(struct omap_hwmod *oh)
1225 /* TODO: For now just handle OMAP4+ */
1226 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1232 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
1235 if (oh->flags & HWMOD_NO_IDLEST)
1238 return omap4_cminst_wait_module_idle(oh->clkdm->prcm_partition,
1240 oh->clkdm->clkdm_offs,
1241 oh->prcm.omap4.clkctrl_offs);
1245 * _lookup_hardreset - fill register bit info for this hwmod/reset line
1246 * @oh: struct omap_hwmod *
1247 * @name: name of the reset line in the context of this hwmod
1248 * @ohri: struct omap_hwmod_rst_info * that this function will fill in
1250 * Return the bit position of the reset line that match the
1251 * input name. Return -ENOENT if not found.
1253 static u8 _lookup_hardreset(struct omap_hwmod *oh, const char *name,
1254 struct omap_hwmod_rst_info *ohri)
1258 for (i = 0; i < oh->rst_lines_cnt; i++) {
1259 const char *rst_line = oh->rst_lines[i].name;
1260 if (!strcmp(rst_line, name)) {
1261 ohri->rst_shift = oh->rst_lines[i].rst_shift;
1262 ohri->st_shift = oh->rst_lines[i].st_shift;
1263 pr_debug("omap_hwmod: %s: %s: %s: rst %d st %d\n",
1264 oh->name, __func__, rst_line, ohri->rst_shift,
1275 * _assert_hardreset - assert the HW reset line of submodules
1276 * contained in the hwmod module.
1277 * @oh: struct omap_hwmod *
1278 * @name: name of the reset line to lookup and assert
1280 * Some IP like dsp, ipu or iva contain processor that require
1281 * an HW reset line to be assert / deassert in order to enable fully
1284 static int _assert_hardreset(struct omap_hwmod *oh, const char *name)
1286 struct omap_hwmod_rst_info ohri;
1292 ret = _lookup_hardreset(oh, name, &ohri);
1293 if (IS_ERR_VALUE(ret))
1296 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1297 return omap2_prm_assert_hardreset(oh->prcm.omap2.module_offs,
1299 else if (cpu_is_omap44xx())
1300 return omap4_prminst_assert_hardreset(ohri.rst_shift,
1301 oh->clkdm->pwrdm.ptr->prcm_partition,
1302 oh->clkdm->pwrdm.ptr->prcm_offs,
1303 oh->prcm.omap4.rstctrl_offs);
1309 * _deassert_hardreset - deassert the HW reset line of submodules contained
1310 * in the hwmod module.
1311 * @oh: struct omap_hwmod *
1312 * @name: name of the reset line to look up and deassert
1314 * Some IP like dsp, ipu or iva contain processor that require
1315 * an HW reset line to be assert / deassert in order to enable fully
1318 static int _deassert_hardreset(struct omap_hwmod *oh, const char *name)
1320 struct omap_hwmod_rst_info ohri;
1326 ret = _lookup_hardreset(oh, name, &ohri);
1327 if (IS_ERR_VALUE(ret))
1330 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1331 ret = omap2_prm_deassert_hardreset(oh->prcm.omap2.module_offs,
1334 } else if (cpu_is_omap44xx()) {
1336 pr_err("omap_hwmod: %s: %s: hwmod data error: OMAP4 does not support st_shift\n",
1338 ret = omap4_prminst_deassert_hardreset(ohri.rst_shift,
1339 oh->clkdm->pwrdm.ptr->prcm_partition,
1340 oh->clkdm->pwrdm.ptr->prcm_offs,
1341 oh->prcm.omap4.rstctrl_offs);
1347 pr_warning("omap_hwmod: %s: failed to hardreset\n", oh->name);
1353 * _read_hardreset - read the HW reset line state of submodules
1354 * contained in the hwmod module
1355 * @oh: struct omap_hwmod *
1356 * @name: name of the reset line to look up and read
1358 * Return the state of the reset line.
1360 static int _read_hardreset(struct omap_hwmod *oh, const char *name)
1362 struct omap_hwmod_rst_info ohri;
1368 ret = _lookup_hardreset(oh, name, &ohri);
1369 if (IS_ERR_VALUE(ret))
1372 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1373 return omap2_prm_is_hardreset_asserted(oh->prcm.omap2.module_offs,
1375 } else if (cpu_is_omap44xx()) {
1376 return omap4_prminst_is_hardreset_asserted(ohri.rst_shift,
1377 oh->clkdm->pwrdm.ptr->prcm_partition,
1378 oh->clkdm->pwrdm.ptr->prcm_offs,
1379 oh->prcm.omap4.rstctrl_offs);
1386 * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1387 * @oh: struct omap_hwmod *
1389 * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit. hwmod must be
1390 * enabled for this to work. Returns -EINVAL if the hwmod cannot be
1391 * reset this way or if the hwmod is in the wrong state, -ETIMEDOUT if
1392 * the module did not reset in time, or 0 upon success.
1394 * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1395 * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1396 * use the SYSCONFIG softreset bit to provide the status.
1398 * Note that some IP like McBSP do have reset control but don't have
1401 static int _ocp_softreset(struct omap_hwmod *oh)
1407 if (!oh->class->sysc ||
1408 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
1411 /* clocks must be on for this operation */
1412 if (oh->_state != _HWMOD_STATE_ENABLED) {
1413 pr_warning("omap_hwmod: %s: reset can only be entered from "
1414 "enabled state\n", oh->name);
1418 /* For some modules, all optionnal clocks need to be enabled as well */
1419 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1420 _enable_optional_clocks(oh);
1422 pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh->name);
1424 v = oh->_sysc_cache;
1425 ret = _set_softreset(oh, &v);
1429 _write_sysconfig(v, oh);
1430 ret = _clear_softreset(oh, &v);
1434 _write_sysconfig(v, oh);
1436 if (oh->class->sysc->sysc_flags & SYSS_HAS_RESET_STATUS)
1437 omap_test_timeout((omap_hwmod_read(oh,
1438 oh->class->sysc->syss_offs)
1439 & SYSS_RESETDONE_MASK),
1440 MAX_MODULE_SOFTRESET_WAIT, c);
1441 else if (oh->class->sysc->sysc_flags & SYSC_HAS_RESET_STATUS)
1442 omap_test_timeout(!(omap_hwmod_read(oh,
1443 oh->class->sysc->sysc_offs)
1444 & SYSC_TYPE2_SOFTRESET_MASK),
1445 MAX_MODULE_SOFTRESET_WAIT, c);
1447 if (c == MAX_MODULE_SOFTRESET_WAIT)
1448 pr_warning("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1449 oh->name, MAX_MODULE_SOFTRESET_WAIT);
1451 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh->name, c);
1454 * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1455 * _wait_target_ready() or _reset()
1458 ret = (c == MAX_MODULE_SOFTRESET_WAIT) ? -ETIMEDOUT : 0;
1461 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1462 _disable_optional_clocks(oh);
1468 * _reset - reset an omap_hwmod
1469 * @oh: struct omap_hwmod *
1471 * Resets an omap_hwmod @oh. The default software reset mechanism for
1472 * most OMAP IP blocks is triggered via the OCP_SYSCONFIG.SOFTRESET
1473 * bit. However, some hwmods cannot be reset via this method: some
1474 * are not targets and therefore have no OCP header registers to
1475 * access; others (like the IVA) have idiosyncratic reset sequences.
1476 * So for these relatively rare cases, custom reset code can be
1477 * supplied in the struct omap_hwmod_class .reset function pointer.
1478 * Passes along the return value from either _reset() or the custom
1479 * reset function - these must return -EINVAL if the hwmod cannot be
1480 * reset this way or if the hwmod is in the wrong state, -ETIMEDOUT if
1481 * the module did not reset in time, or 0 upon success.
1483 static int _reset(struct omap_hwmod *oh)
1487 pr_debug("omap_hwmod: %s: resetting\n", oh->name);
1489 ret = (oh->class->reset) ? oh->class->reset(oh) : _ocp_softreset(oh);
1495 * _enable - enable an omap_hwmod
1496 * @oh: struct omap_hwmod *
1498 * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
1499 * register target. Returns -EINVAL if the hwmod is in the wrong
1500 * state or passes along the return value of _wait_target_ready().
1502 static int _enable(struct omap_hwmod *oh)
1507 pr_debug("omap_hwmod: %s: enabling\n", oh->name);
1509 if (oh->_state != _HWMOD_STATE_INITIALIZED &&
1510 oh->_state != _HWMOD_STATE_IDLE &&
1511 oh->_state != _HWMOD_STATE_DISABLED) {
1512 WARN(1, "omap_hwmod: %s: enabled state can only be entered "
1513 "from initialized, idle, or disabled state\n", oh->name);
1519 * If an IP contains only one HW reset line, then de-assert it in order
1520 * to allow the module state transition. Otherwise the PRCM will return
1521 * Intransition status, and the init will failed.
1523 if ((oh->_state == _HWMOD_STATE_INITIALIZED ||
1524 oh->_state == _HWMOD_STATE_DISABLED) && oh->rst_lines_cnt == 1)
1525 _deassert_hardreset(oh, oh->rst_lines[0].name);
1527 /* Mux pins for device runtime if populated */
1528 if (oh->mux && (!oh->mux->enabled ||
1529 ((oh->_state == _HWMOD_STATE_IDLE) &&
1530 oh->mux->pads_dynamic)))
1531 omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
1533 _add_initiator_dep(oh, mpu_oh);
1537 * A clockdomain must be in SW_SUP before enabling
1538 * completely the module. The clockdomain can be set
1539 * in HW_AUTO only when the module become ready.
1541 hwsup = clkdm_in_hwsup(oh->clkdm);
1542 r = clkdm_hwmod_enable(oh->clkdm, oh);
1544 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1545 oh->name, oh->clkdm->name, r);
1553 r = _wait_target_ready(oh);
1556 * Set the clockdomain to HW_AUTO only if the target is ready,
1557 * assuming that the previous state was HW_AUTO
1559 if (oh->clkdm && hwsup)
1560 clkdm_allow_idle(oh->clkdm);
1562 oh->_state = _HWMOD_STATE_ENABLED;
1564 /* Access the sysconfig only if the target is ready */
1565 if (oh->class->sysc) {
1566 if (!(oh->_int_flags & _HWMOD_SYSCONFIG_LOADED))
1567 _update_sysc_cache(oh);
1571 _disable_clocks(oh);
1572 pr_debug("omap_hwmod: %s: _wait_target_ready: %d\n",
1576 clkdm_hwmod_disable(oh->clkdm, oh);
1583 * _idle - idle an omap_hwmod
1584 * @oh: struct omap_hwmod *
1586 * Idles an omap_hwmod @oh. This should be called once the hwmod has
1587 * no further work. Returns -EINVAL if the hwmod is in the wrong
1588 * state or returns 0.
1590 static int _idle(struct omap_hwmod *oh)
1594 pr_debug("omap_hwmod: %s: idling\n", oh->name);
1596 if (oh->_state != _HWMOD_STATE_ENABLED) {
1597 WARN(1, "omap_hwmod: %s: idle state can only be entered from "
1598 "enabled state\n", oh->name);
1602 if (oh->class->sysc)
1604 _del_initiator_dep(oh, mpu_oh);
1605 _disable_module(oh);
1606 ret = _wait_target_disable(oh);
1608 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1611 * The module must be in idle mode before disabling any parents
1612 * clocks. Otherwise, the parent clock might be disabled before
1613 * the module transition is done, and thus will prevent the
1614 * transition to complete properly.
1616 _disable_clocks(oh);
1618 clkdm_hwmod_disable(oh->clkdm, oh);
1620 /* Mux pins for device idle if populated */
1621 if (oh->mux && oh->mux->pads_dynamic)
1622 omap_hwmod_mux(oh->mux, _HWMOD_STATE_IDLE);
1624 oh->_state = _HWMOD_STATE_IDLE;
1630 * omap_hwmod_set_ocp_autoidle - set the hwmod's OCP autoidle bit
1631 * @oh: struct omap_hwmod *
1632 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
1634 * Sets the IP block's OCP autoidle bit in hardware, and updates our
1635 * local copy. Intended to be used by drivers that require
1636 * direct manipulation of the AUTOIDLE bits.
1637 * Returns -EINVAL if @oh is null or is not in the ENABLED state, or passes
1638 * along the return value from _set_module_autoidle().
1640 * Any users of this function should be scrutinized carefully.
1642 int omap_hwmod_set_ocp_autoidle(struct omap_hwmod *oh, u8 autoidle)
1646 unsigned long flags;
1648 if (!oh || oh->_state != _HWMOD_STATE_ENABLED)
1651 spin_lock_irqsave(&oh->_lock, flags);
1653 v = oh->_sysc_cache;
1655 retval = _set_module_autoidle(oh, autoidle, &v);
1658 _write_sysconfig(v, oh);
1660 spin_unlock_irqrestore(&oh->_lock, flags);
1666 * _shutdown - shutdown an omap_hwmod
1667 * @oh: struct omap_hwmod *
1669 * Shut down an omap_hwmod @oh. This should be called when the driver
1670 * used for the hwmod is removed or unloaded or if the driver is not
1671 * used by the system. Returns -EINVAL if the hwmod is in the wrong
1672 * state or returns 0.
1674 static int _shutdown(struct omap_hwmod *oh)
1679 if (oh->_state != _HWMOD_STATE_IDLE &&
1680 oh->_state != _HWMOD_STATE_ENABLED) {
1681 WARN(1, "omap_hwmod: %s: disabled state can only be entered "
1682 "from idle, or enabled state\n", oh->name);
1686 pr_debug("omap_hwmod: %s: disabling\n", oh->name);
1688 if (oh->class->pre_shutdown) {
1689 prev_state = oh->_state;
1690 if (oh->_state == _HWMOD_STATE_IDLE)
1692 ret = oh->class->pre_shutdown(oh);
1694 if (prev_state == _HWMOD_STATE_IDLE)
1700 if (oh->class->sysc) {
1701 if (oh->_state == _HWMOD_STATE_IDLE)
1706 /* clocks and deps are already disabled in idle */
1707 if (oh->_state == _HWMOD_STATE_ENABLED) {
1708 _del_initiator_dep(oh, mpu_oh);
1709 /* XXX what about the other system initiators here? dma, dsp */
1710 _disable_module(oh);
1711 ret = _wait_target_disable(oh);
1713 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1715 _disable_clocks(oh);
1717 clkdm_hwmod_disable(oh->clkdm, oh);
1719 /* XXX Should this code also force-disable the optional clocks? */
1722 * If an IP contains only one HW reset line, then assert it
1723 * after disabling the clocks and before shutting down the IP.
1725 if (oh->rst_lines_cnt == 1)
1726 _assert_hardreset(oh, oh->rst_lines[0].name);
1728 /* Mux pins to safe mode or use populated off mode values */
1730 omap_hwmod_mux(oh->mux, _HWMOD_STATE_DISABLED);
1732 oh->_state = _HWMOD_STATE_DISABLED;
1738 * _setup - do initial configuration of omap_hwmod
1739 * @oh: struct omap_hwmod *
1741 * Writes the CLOCKACTIVITY bits @clockact to the hwmod @oh
1742 * OCP_SYSCONFIG register. Returns 0.
1744 static int _setup(struct omap_hwmod *oh, void *data)
1749 if (oh->_state != _HWMOD_STATE_CLKS_INITED)
1752 /* Set iclk autoidle mode */
1753 if (oh->slaves_cnt > 0) {
1754 for (i = 0; i < oh->slaves_cnt; i++) {
1755 struct omap_hwmod_ocp_if *os = oh->slaves[i];
1756 struct clk *c = os->_clk;
1761 if (os->flags & OCPIF_SWSUP_IDLE) {
1762 /* XXX omap_iclk_deny_idle(c); */
1764 /* XXX omap_iclk_allow_idle(c); */
1770 oh->_state = _HWMOD_STATE_INITIALIZED;
1773 * In the case of hwmod with hardreset that should not be
1774 * de-assert at boot time, we have to keep the module
1775 * initialized, because we cannot enable it properly with the
1776 * reset asserted. Exit without warning because that behavior is
1779 if ((oh->flags & HWMOD_INIT_NO_RESET) && oh->rst_lines_cnt == 1)
1784 pr_warning("omap_hwmod: %s: cannot be enabled (%d)\n",
1785 oh->name, oh->_state);
1789 if (!(oh->flags & HWMOD_INIT_NO_RESET)) {
1793 * OCP_SYSCONFIG bits need to be reprogrammed after a softreset.
1794 * The _enable() function should be split to
1795 * avoid the rewrite of the OCP_SYSCONFIG register.
1797 if (oh->class->sysc) {
1798 _update_sysc_cache(oh);
1803 postsetup_state = oh->_postsetup_state;
1804 if (postsetup_state == _HWMOD_STATE_UNKNOWN)
1805 postsetup_state = _HWMOD_STATE_ENABLED;
1808 * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
1809 * it should be set by the core code as a runtime flag during startup
1811 if ((oh->flags & HWMOD_INIT_NO_IDLE) &&
1812 (postsetup_state == _HWMOD_STATE_IDLE))
1813 postsetup_state = _HWMOD_STATE_ENABLED;
1815 if (postsetup_state == _HWMOD_STATE_IDLE)
1817 else if (postsetup_state == _HWMOD_STATE_DISABLED)
1819 else if (postsetup_state != _HWMOD_STATE_ENABLED)
1820 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
1821 oh->name, postsetup_state);
1827 * _register - register a struct omap_hwmod
1828 * @oh: struct omap_hwmod *
1830 * Registers the omap_hwmod @oh. Returns -EEXIST if an omap_hwmod
1831 * already has been registered by the same name; -EINVAL if the
1832 * omap_hwmod is in the wrong state, if @oh is NULL, if the
1833 * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
1834 * name, or if the omap_hwmod's class is missing a name; or 0 upon
1837 * XXX The data should be copied into bootmem, so the original data
1838 * should be marked __initdata and freed after init. This would allow
1839 * unneeded omap_hwmods to be freed on multi-OMAP configurations. Note
1840 * that the copy process would be relatively complex due to the large number
1843 static int __init _register(struct omap_hwmod *oh)
1847 if (!oh || !oh->name || !oh->class || !oh->class->name ||
1848 (oh->_state != _HWMOD_STATE_UNKNOWN))
1851 pr_debug("omap_hwmod: %s: registering\n", oh->name);
1853 if (_lookup(oh->name))
1856 ms_id = _find_mpu_port_index(oh);
1857 if (!IS_ERR_VALUE(ms_id))
1858 oh->_mpu_port_index = ms_id;
1860 oh->_int_flags |= _HWMOD_NO_MPU_PORT;
1862 list_add_tail(&oh->node, &omap_hwmod_list);
1864 spin_lock_init(&oh->_lock);
1866 oh->_state = _HWMOD_STATE_REGISTERED;
1869 * XXX Rather than doing a strcmp(), this should test a flag
1870 * set in the hwmod data, inserted by the autogenerator code.
1872 if (!strcmp(oh->name, MPU_INITIATOR_NAME))
1879 /* Public functions */
1881 u32 omap_hwmod_read(struct omap_hwmod *oh, u16 reg_offs)
1883 if (oh->flags & HWMOD_16BIT_REG)
1884 return __raw_readw(oh->_mpu_rt_va + reg_offs);
1886 return __raw_readl(oh->_mpu_rt_va + reg_offs);
1889 void omap_hwmod_write(u32 v, struct omap_hwmod *oh, u16 reg_offs)
1891 if (oh->flags & HWMOD_16BIT_REG)
1892 __raw_writew(v, oh->_mpu_rt_va + reg_offs);
1894 __raw_writel(v, oh->_mpu_rt_va + reg_offs);
1898 * omap_hwmod_softreset - reset a module via SYSCONFIG.SOFTRESET bit
1899 * @oh: struct omap_hwmod *
1901 * This is a public function exposed to drivers. Some drivers may need to do
1902 * some settings before and after resetting the device. Those drivers after
1903 * doing the necessary settings could use this function to start a reset by
1904 * setting the SYSCONFIG.SOFTRESET bit.
1906 int omap_hwmod_softreset(struct omap_hwmod *oh)
1911 if (!oh || !(oh->_sysc_cache))
1914 v = oh->_sysc_cache;
1915 ret = _set_softreset(oh, &v);
1918 _write_sysconfig(v, oh);
1920 ret = _clear_softreset(oh, &v);
1923 _write_sysconfig(v, oh);
1930 * omap_hwmod_set_slave_idlemode - set the hwmod's OCP slave idlemode
1931 * @oh: struct omap_hwmod *
1932 * @idlemode: SIDLEMODE field bits (shifted to bit 0)
1934 * Sets the IP block's OCP slave idlemode in hardware, and updates our
1935 * local copy. Intended to be used by drivers that have some erratum
1936 * that requires direct manipulation of the SIDLEMODE bits. Returns
1937 * -EINVAL if @oh is null, or passes along the return value from
1938 * _set_slave_idlemode().
1940 * XXX Does this function have any current users? If not, we should
1941 * remove it; it is better to let the rest of the hwmod code handle this.
1942 * Any users of this function should be scrutinized carefully.
1944 int omap_hwmod_set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode)
1952 v = oh->_sysc_cache;
1954 retval = _set_slave_idlemode(oh, idlemode, &v);
1956 _write_sysconfig(v, oh);
1962 * omap_hwmod_lookup - look up a registered omap_hwmod by name
1963 * @name: name of the omap_hwmod to look up
1965 * Given a @name of an omap_hwmod, return a pointer to the registered
1966 * struct omap_hwmod *, or NULL upon error.
1968 struct omap_hwmod *omap_hwmod_lookup(const char *name)
1970 struct omap_hwmod *oh;
1981 * omap_hwmod_for_each - call function for each registered omap_hwmod
1982 * @fn: pointer to a callback function
1983 * @data: void * data to pass to callback function
1985 * Call @fn for each registered omap_hwmod, passing @data to each
1986 * function. @fn must return 0 for success or any other value for
1987 * failure. If @fn returns non-zero, the iteration across omap_hwmods
1988 * will stop and the non-zero return value will be passed to the
1989 * caller of omap_hwmod_for_each(). @fn is called with
1990 * omap_hwmod_for_each() held.
1992 int omap_hwmod_for_each(int (*fn)(struct omap_hwmod *oh, void *data),
1995 struct omap_hwmod *temp_oh;
2001 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
2002 ret = (*fn)(temp_oh, data);
2011 * omap_hwmod_register - register an array of hwmods
2012 * @ohs: pointer to an array of omap_hwmods to register
2014 * Intended to be called early in boot before the clock framework is
2015 * initialized. If @ohs is not null, will register all omap_hwmods
2016 * listed in @ohs that are valid for this chip. Returns 0.
2018 int __init omap_hwmod_register(struct omap_hwmod **ohs)
2027 r = _register(ohs[i]);
2028 WARN(r, "omap_hwmod: %s: _register returned %d\n", ohs[i]->name,
2036 * _populate_mpu_rt_base - populate the virtual address for a hwmod
2038 * Must be called only from omap_hwmod_setup_*() so ioremap works properly.
2039 * Assumes the caller takes care of locking if needed.
2041 static int __init _populate_mpu_rt_base(struct omap_hwmod *oh, void *data)
2043 if (oh->_state != _HWMOD_STATE_REGISTERED)
2046 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2049 oh->_mpu_rt_va = _find_mpu_rt_base(oh, oh->_mpu_port_index);
2055 * omap_hwmod_setup_one - set up a single hwmod
2056 * @oh_name: const char * name of the already-registered hwmod to set up
2058 * Must be called after omap2_clk_init(). Resolves the struct clk
2059 * names to struct clk pointers for each registered omap_hwmod. Also
2060 * calls _setup() on each hwmod. Returns -EINVAL upon error or 0 upon
2063 int __init omap_hwmod_setup_one(const char *oh_name)
2065 struct omap_hwmod *oh;
2068 pr_debug("omap_hwmod: %s: %s\n", oh_name, __func__);
2071 pr_err("omap_hwmod: %s: cannot setup_one: MPU initiator hwmod %s not yet registered\n",
2072 oh_name, MPU_INITIATOR_NAME);
2076 oh = _lookup(oh_name);
2078 WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name);
2082 if (mpu_oh->_state == _HWMOD_STATE_REGISTERED && oh != mpu_oh)
2083 omap_hwmod_setup_one(MPU_INITIATOR_NAME);
2085 r = _populate_mpu_rt_base(oh, NULL);
2086 if (IS_ERR_VALUE(r)) {
2087 WARN(1, "omap_hwmod: %s: couldn't set mpu_rt_base\n", oh_name);
2091 r = _init_clocks(oh, NULL);
2092 if (IS_ERR_VALUE(r)) {
2093 WARN(1, "omap_hwmod: %s: couldn't init clocks\n", oh_name);
2103 * omap_hwmod_setup - do some post-clock framework initialization
2105 * Must be called after omap2_clk_init(). Resolves the struct clk names
2106 * to struct clk pointers for each registered omap_hwmod. Also calls
2107 * _setup() on each hwmod. Returns 0 upon success.
2109 static int __init omap_hwmod_setup_all(void)
2114 pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",
2115 __func__, MPU_INITIATOR_NAME);
2119 r = omap_hwmod_for_each(_populate_mpu_rt_base, NULL);
2121 r = omap_hwmod_for_each(_init_clocks, NULL);
2122 WARN(IS_ERR_VALUE(r),
2123 "omap_hwmod: %s: _init_clocks failed\n", __func__);
2125 omap_hwmod_for_each(_setup, NULL);
2129 core_initcall(omap_hwmod_setup_all);
2132 * omap_hwmod_enable - enable an omap_hwmod
2133 * @oh: struct omap_hwmod *
2135 * Enable an omap_hwmod @oh. Intended to be called by omap_device_enable().
2136 * Returns -EINVAL on error or passes along the return value from _enable().
2138 int omap_hwmod_enable(struct omap_hwmod *oh)
2141 unsigned long flags;
2146 spin_lock_irqsave(&oh->_lock, flags);
2148 spin_unlock_irqrestore(&oh->_lock, flags);
2154 * omap_hwmod_idle - idle an omap_hwmod
2155 * @oh: struct omap_hwmod *
2157 * Idle an omap_hwmod @oh. Intended to be called by omap_device_idle().
2158 * Returns -EINVAL on error or passes along the return value from _idle().
2160 int omap_hwmod_idle(struct omap_hwmod *oh)
2162 unsigned long flags;
2167 spin_lock_irqsave(&oh->_lock, flags);
2169 spin_unlock_irqrestore(&oh->_lock, flags);
2175 * omap_hwmod_shutdown - shutdown an omap_hwmod
2176 * @oh: struct omap_hwmod *
2178 * Shutdown an omap_hwmod @oh. Intended to be called by
2179 * omap_device_shutdown(). Returns -EINVAL on error or passes along
2180 * the return value from _shutdown().
2182 int omap_hwmod_shutdown(struct omap_hwmod *oh)
2184 unsigned long flags;
2189 spin_lock_irqsave(&oh->_lock, flags);
2191 spin_unlock_irqrestore(&oh->_lock, flags);
2197 * omap_hwmod_enable_clocks - enable main_clk, all interface clocks
2198 * @oh: struct omap_hwmod *oh
2200 * Intended to be called by the omap_device code.
2202 int omap_hwmod_enable_clocks(struct omap_hwmod *oh)
2204 unsigned long flags;
2206 spin_lock_irqsave(&oh->_lock, flags);
2208 spin_unlock_irqrestore(&oh->_lock, flags);
2214 * omap_hwmod_disable_clocks - disable main_clk, all interface clocks
2215 * @oh: struct omap_hwmod *oh
2217 * Intended to be called by the omap_device code.
2219 int omap_hwmod_disable_clocks(struct omap_hwmod *oh)
2221 unsigned long flags;
2223 spin_lock_irqsave(&oh->_lock, flags);
2224 _disable_clocks(oh);
2225 spin_unlock_irqrestore(&oh->_lock, flags);
2231 * omap_hwmod_ocp_barrier - wait for posted writes against the hwmod to complete
2232 * @oh: struct omap_hwmod *oh
2234 * Intended to be called by drivers and core code when all posted
2235 * writes to a device must complete before continuing further
2236 * execution (for example, after clearing some device IRQSTATUS
2239 * XXX what about targets with multiple OCP threads?
2241 void omap_hwmod_ocp_barrier(struct omap_hwmod *oh)
2245 if (!oh->class->sysc || !oh->class->sysc->sysc_flags) {
2246 WARN(1, "omap_device: %s: OCP barrier impossible due to "
2247 "device configuration\n", oh->name);
2252 * Forces posted writes to complete on the OCP thread handling
2255 omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
2259 * omap_hwmod_reset - reset the hwmod
2260 * @oh: struct omap_hwmod *
2262 * Under some conditions, a driver may wish to reset the entire device.
2263 * Called from omap_device code. Returns -EINVAL on error or passes along
2264 * the return value from _reset().
2266 int omap_hwmod_reset(struct omap_hwmod *oh)
2269 unsigned long flags;
2274 spin_lock_irqsave(&oh->_lock, flags);
2276 spin_unlock_irqrestore(&oh->_lock, flags);
2282 * omap_hwmod_count_resources - count number of struct resources needed by hwmod
2283 * @oh: struct omap_hwmod *
2284 * @res: pointer to the first element of an array of struct resource to fill
2286 * Count the number of struct resource array elements necessary to
2287 * contain omap_hwmod @oh resources. Intended to be called by code
2288 * that registers omap_devices. Intended to be used to determine the
2289 * size of a dynamically-allocated struct resource array, before
2290 * calling omap_hwmod_fill_resources(). Returns the number of struct
2291 * resource array elements needed.
2293 * XXX This code is not optimized. It could attempt to merge adjacent
2297 int omap_hwmod_count_resources(struct omap_hwmod *oh)
2301 ret = _count_mpu_irqs(oh) + _count_sdma_reqs(oh);
2303 for (i = 0; i < oh->slaves_cnt; i++)
2304 ret += _count_ocp_if_addr_spaces(oh->slaves[i]);
2310 * omap_hwmod_fill_resources - fill struct resource array with hwmod data
2311 * @oh: struct omap_hwmod *
2312 * @res: pointer to the first element of an array of struct resource to fill
2314 * Fill the struct resource array @res with resource data from the
2315 * omap_hwmod @oh. Intended to be called by code that registers
2316 * omap_devices. See also omap_hwmod_count_resources(). Returns the
2317 * number of array elements filled.
2319 int omap_hwmod_fill_resources(struct omap_hwmod *oh, struct resource *res)
2321 int i, j, mpu_irqs_cnt, sdma_reqs_cnt;
2324 /* For each IRQ, DMA, memory area, fill in array.*/
2326 mpu_irqs_cnt = _count_mpu_irqs(oh);
2327 for (i = 0; i < mpu_irqs_cnt; i++) {
2328 (res + r)->name = (oh->mpu_irqs + i)->name;
2329 (res + r)->start = (oh->mpu_irqs + i)->irq;
2330 (res + r)->end = (oh->mpu_irqs + i)->irq;
2331 (res + r)->flags = IORESOURCE_IRQ;
2335 sdma_reqs_cnt = _count_sdma_reqs(oh);
2336 for (i = 0; i < sdma_reqs_cnt; i++) {
2337 (res + r)->name = (oh->sdma_reqs + i)->name;
2338 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
2339 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
2340 (res + r)->flags = IORESOURCE_DMA;
2344 for (i = 0; i < oh->slaves_cnt; i++) {
2345 struct omap_hwmod_ocp_if *os;
2349 addr_cnt = _count_ocp_if_addr_spaces(os);
2351 for (j = 0; j < addr_cnt; j++) {
2352 (res + r)->name = (os->addr + j)->name;
2353 (res + r)->start = (os->addr + j)->pa_start;
2354 (res + r)->end = (os->addr + j)->pa_end;
2355 (res + r)->flags = IORESOURCE_MEM;
2364 * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
2365 * @oh: struct omap_hwmod *
2367 * Return the powerdomain pointer associated with the OMAP module
2368 * @oh's main clock. If @oh does not have a main clk, return the
2369 * powerdomain associated with the interface clock associated with the
2370 * module's MPU port. (XXX Perhaps this should use the SDMA port
2371 * instead?) Returns NULL on error, or a struct powerdomain * on
2374 struct powerdomain *omap_hwmod_get_pwrdm(struct omap_hwmod *oh)
2384 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2386 c = oh->slaves[oh->_mpu_port_index]->_clk;
2392 return c->clkdm->pwrdm.ptr;
2397 * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
2398 * @oh: struct omap_hwmod *
2400 * Returns the virtual address corresponding to the beginning of the
2401 * module's register target, in the address range that is intended to
2402 * be used by the MPU. Returns the virtual address upon success or NULL
2405 void __iomem *omap_hwmod_get_mpu_rt_va(struct omap_hwmod *oh)
2410 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2413 if (oh->_state == _HWMOD_STATE_UNKNOWN)
2416 return oh->_mpu_rt_va;
2420 * omap_hwmod_add_initiator_dep - add sleepdep from @init_oh to @oh
2421 * @oh: struct omap_hwmod *
2422 * @init_oh: struct omap_hwmod * (initiator)
2424 * Add a sleep dependency between the initiator @init_oh and @oh.
2425 * Intended to be called by DSP/Bridge code via platform_data for the
2426 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
2427 * code needs to add/del initiator dependencies dynamically
2428 * before/after accessing a device. Returns the return value from
2429 * _add_initiator_dep().
2431 * XXX Keep a usecount in the clockdomain code
2433 int omap_hwmod_add_initiator_dep(struct omap_hwmod *oh,
2434 struct omap_hwmod *init_oh)
2436 return _add_initiator_dep(oh, init_oh);
2440 * XXX what about functions for drivers to save/restore ocp_sysconfig
2441 * for context save/restore operations?
2445 * omap_hwmod_del_initiator_dep - remove sleepdep from @init_oh to @oh
2446 * @oh: struct omap_hwmod *
2447 * @init_oh: struct omap_hwmod * (initiator)
2449 * Remove a sleep dependency between the initiator @init_oh and @oh.
2450 * Intended to be called by DSP/Bridge code via platform_data for the
2451 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
2452 * code needs to add/del initiator dependencies dynamically
2453 * before/after accessing a device. Returns the return value from
2454 * _del_initiator_dep().
2456 * XXX Keep a usecount in the clockdomain code
2458 int omap_hwmod_del_initiator_dep(struct omap_hwmod *oh,
2459 struct omap_hwmod *init_oh)
2461 return _del_initiator_dep(oh, init_oh);
2465 * omap_hwmod_enable_wakeup - allow device to wake up the system
2466 * @oh: struct omap_hwmod *
2468 * Sets the module OCP socket ENAWAKEUP bit to allow the module to
2469 * send wakeups to the PRCM. Eventually this should sets PRCM wakeup
2470 * registers to cause the PRCM to receive wakeup events from the
2471 * module. Does not set any wakeup routing registers beyond this
2472 * point - if the module is to wake up any other module or subsystem,
2473 * that must be set separately. Called by omap_device code. Returns
2474 * -EINVAL on error or 0 upon success.
2476 int omap_hwmod_enable_wakeup(struct omap_hwmod *oh)
2478 unsigned long flags;
2481 if (!oh->class->sysc ||
2482 !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
2485 spin_lock_irqsave(&oh->_lock, flags);
2486 v = oh->_sysc_cache;
2487 _enable_wakeup(oh, &v);
2488 _write_sysconfig(v, oh);
2489 spin_unlock_irqrestore(&oh->_lock, flags);
2495 * omap_hwmod_disable_wakeup - prevent device from waking the system
2496 * @oh: struct omap_hwmod *
2498 * Clears the module OCP socket ENAWAKEUP bit to prevent the module
2499 * from sending wakeups to the PRCM. Eventually this should clear
2500 * PRCM wakeup registers to cause the PRCM to ignore wakeup events
2501 * from the module. Does not set any wakeup routing registers beyond
2502 * this point - if the module is to wake up any other module or
2503 * subsystem, that must be set separately. Called by omap_device
2504 * code. Returns -EINVAL on error or 0 upon success.
2506 int omap_hwmod_disable_wakeup(struct omap_hwmod *oh)
2508 unsigned long flags;
2511 if (!oh->class->sysc ||
2512 !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
2515 spin_lock_irqsave(&oh->_lock, flags);
2516 v = oh->_sysc_cache;
2517 _disable_wakeup(oh, &v);
2518 _write_sysconfig(v, oh);
2519 spin_unlock_irqrestore(&oh->_lock, flags);
2525 * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
2526 * contained in the hwmod module.
2527 * @oh: struct omap_hwmod *
2528 * @name: name of the reset line to lookup and assert
2530 * Some IP like dsp, ipu or iva contain processor that require
2531 * an HW reset line to be assert / deassert in order to enable fully
2532 * the IP. Returns -EINVAL if @oh is null or if the operation is not
2533 * yet supported on this OMAP; otherwise, passes along the return value
2534 * from _assert_hardreset().
2536 int omap_hwmod_assert_hardreset(struct omap_hwmod *oh, const char *name)
2539 unsigned long flags;
2544 spin_lock_irqsave(&oh->_lock, flags);
2545 ret = _assert_hardreset(oh, name);
2546 spin_unlock_irqrestore(&oh->_lock, flags);
2552 * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
2553 * contained in the hwmod module.
2554 * @oh: struct omap_hwmod *
2555 * @name: name of the reset line to look up and deassert
2557 * Some IP like dsp, ipu or iva contain processor that require
2558 * an HW reset line to be assert / deassert in order to enable fully
2559 * the IP. Returns -EINVAL if @oh is null or if the operation is not
2560 * yet supported on this OMAP; otherwise, passes along the return value
2561 * from _deassert_hardreset().
2563 int omap_hwmod_deassert_hardreset(struct omap_hwmod *oh, const char *name)
2566 unsigned long flags;
2571 spin_lock_irqsave(&oh->_lock, flags);
2572 ret = _deassert_hardreset(oh, name);
2573 spin_unlock_irqrestore(&oh->_lock, flags);
2579 * omap_hwmod_read_hardreset - read the HW reset line state of submodules
2580 * contained in the hwmod module
2581 * @oh: struct omap_hwmod *
2582 * @name: name of the reset line to look up and read
2584 * Return the current state of the hwmod @oh's reset line named @name:
2585 * returns -EINVAL upon parameter error or if this operation
2586 * is unsupported on the current OMAP; otherwise, passes along the return
2587 * value from _read_hardreset().
2589 int omap_hwmod_read_hardreset(struct omap_hwmod *oh, const char *name)
2592 unsigned long flags;
2597 spin_lock_irqsave(&oh->_lock, flags);
2598 ret = _read_hardreset(oh, name);
2599 spin_unlock_irqrestore(&oh->_lock, flags);
2606 * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
2607 * @classname: struct omap_hwmod_class name to search for
2608 * @fn: callback function pointer to call for each hwmod in class @classname
2609 * @user: arbitrary context data to pass to the callback function
2611 * For each omap_hwmod of class @classname, call @fn.
2612 * If the callback function returns something other than
2613 * zero, the iterator is terminated, and the callback function's return
2614 * value is passed back to the caller. Returns 0 upon success, -EINVAL
2615 * if @classname or @fn are NULL, or passes back the error code from @fn.
2617 int omap_hwmod_for_each_by_class(const char *classname,
2618 int (*fn)(struct omap_hwmod *oh,
2622 struct omap_hwmod *temp_oh;
2625 if (!classname || !fn)
2628 pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
2629 __func__, classname);
2631 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
2632 if (!strcmp(temp_oh->class->name, classname)) {
2633 pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
2634 __func__, temp_oh->name);
2635 ret = (*fn)(temp_oh, user);
2642 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
2649 * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
2650 * @oh: struct omap_hwmod *
2651 * @state: state that _setup() should leave the hwmod in
2653 * Sets the hwmod state that @oh will enter at the end of _setup()
2654 * (called by omap_hwmod_setup_*()). Only valid to call between
2655 * calling omap_hwmod_register() and omap_hwmod_setup_*(). Returns
2656 * 0 upon success or -EINVAL if there is a problem with the arguments
2657 * or if the hwmod is in the wrong state.
2659 int omap_hwmod_set_postsetup_state(struct omap_hwmod *oh, u8 state)
2662 unsigned long flags;
2667 if (state != _HWMOD_STATE_DISABLED &&
2668 state != _HWMOD_STATE_ENABLED &&
2669 state != _HWMOD_STATE_IDLE)
2672 spin_lock_irqsave(&oh->_lock, flags);
2674 if (oh->_state != _HWMOD_STATE_REGISTERED) {
2679 oh->_postsetup_state = state;
2683 spin_unlock_irqrestore(&oh->_lock, flags);
2689 * omap_hwmod_get_context_loss_count - get lost context count
2690 * @oh: struct omap_hwmod *
2692 * Query the powerdomain of of @oh to get the context loss
2693 * count for this device.
2695 * Returns the context loss count of the powerdomain assocated with @oh
2696 * upon success, or zero if no powerdomain exists for @oh.
2698 int omap_hwmod_get_context_loss_count(struct omap_hwmod *oh)
2700 struct powerdomain *pwrdm;
2703 pwrdm = omap_hwmod_get_pwrdm(oh);
2705 ret = pwrdm_get_context_loss_count(pwrdm);
2711 * omap_hwmod_no_setup_reset - prevent a hwmod from being reset upon setup
2712 * @oh: struct omap_hwmod *
2714 * Prevent the hwmod @oh from being reset during the setup process.
2715 * Intended for use by board-*.c files on boards with devices that
2716 * cannot tolerate being reset. Must be called before the hwmod has
2717 * been set up. Returns 0 upon success or negative error code upon
2720 int omap_hwmod_no_setup_reset(struct omap_hwmod *oh)
2725 if (oh->_state != _HWMOD_STATE_REGISTERED) {
2726 pr_err("omap_hwmod: %s: cannot prevent setup reset; in wrong state\n",
2731 oh->flags |= HWMOD_INIT_NO_RESET;