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>
139 #include <linux/slab.h>
141 #include <plat/common.h>
142 #include <plat/cpu.h>
143 #include "clockdomain.h"
144 #include "powerdomain.h"
145 #include <plat/clock.h>
146 #include <plat/omap_hwmod.h>
147 #include <plat/prcm.h>
149 #include "cm2xxx_3xxx.h"
150 #include "cminst44xx.h"
151 #include "prm2xxx_3xxx.h"
153 #include "prminst44xx.h"
156 /* Maximum microseconds to wait for OMAP module to softreset */
157 #define MAX_MODULE_SOFTRESET_WAIT 10000
159 /* Name of the OMAP hwmod for the MPU */
160 #define MPU_INITIATOR_NAME "mpu"
162 /* omap_hwmod_list contains all registered struct omap_hwmods */
163 static LIST_HEAD(omap_hwmod_list);
165 /* mpu_oh: used to add/remove MPU initiator from sleepdep list */
166 static struct omap_hwmod *mpu_oh;
169 /* Private functions */
172 * _update_sysc_cache - return the module OCP_SYSCONFIG register, keep copy
173 * @oh: struct omap_hwmod *
175 * Load the current value of the hwmod OCP_SYSCONFIG register into the
176 * struct omap_hwmod for later use. Returns -EINVAL if the hwmod has no
177 * OCP_SYSCONFIG register or 0 upon success.
179 static int _update_sysc_cache(struct omap_hwmod *oh)
181 if (!oh->class->sysc) {
182 WARN(1, "omap_hwmod: %s: cannot read OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
186 /* XXX ensure module interface clock is up */
188 oh->_sysc_cache = omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
190 if (!(oh->class->sysc->sysc_flags & SYSC_NO_CACHE))
191 oh->_int_flags |= _HWMOD_SYSCONFIG_LOADED;
197 * _write_sysconfig - write a value to the module's OCP_SYSCONFIG register
198 * @v: OCP_SYSCONFIG value to write
199 * @oh: struct omap_hwmod *
201 * Write @v into the module class' OCP_SYSCONFIG register, if it has
202 * one. No return value.
204 static void _write_sysconfig(u32 v, struct omap_hwmod *oh)
206 if (!oh->class->sysc) {
207 WARN(1, "omap_hwmod: %s: cannot write OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
211 /* XXX ensure module interface clock is up */
213 /* Module might have lost context, always update cache and register */
215 omap_hwmod_write(v, oh, oh->class->sysc->sysc_offs);
219 * _set_master_standbymode: set the OCP_SYSCONFIG MIDLEMODE field in @v
220 * @oh: struct omap_hwmod *
221 * @standbymode: MIDLEMODE field bits
222 * @v: pointer to register contents to modify
224 * Update the master standby mode bits in @v to be @standbymode for
225 * the @oh hwmod. Does not write to the hardware. Returns -EINVAL
226 * upon error or 0 upon success.
228 static int _set_master_standbymode(struct omap_hwmod *oh, u8 standbymode,
234 if (!oh->class->sysc ||
235 !(oh->class->sysc->sysc_flags & SYSC_HAS_MIDLEMODE))
238 if (!oh->class->sysc->sysc_fields) {
239 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
243 mstandby_shift = oh->class->sysc->sysc_fields->midle_shift;
244 mstandby_mask = (0x3 << mstandby_shift);
246 *v &= ~mstandby_mask;
247 *v |= __ffs(standbymode) << mstandby_shift;
253 * _set_slave_idlemode: set the OCP_SYSCONFIG SIDLEMODE field in @v
254 * @oh: struct omap_hwmod *
255 * @idlemode: SIDLEMODE field bits
256 * @v: pointer to register contents to modify
258 * Update the slave idle mode bits in @v to be @idlemode for the @oh
259 * hwmod. Does not write to the hardware. Returns -EINVAL upon error
262 static int _set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode, u32 *v)
267 if (!oh->class->sysc ||
268 !(oh->class->sysc->sysc_flags & SYSC_HAS_SIDLEMODE))
271 if (!oh->class->sysc->sysc_fields) {
272 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
276 sidle_shift = oh->class->sysc->sysc_fields->sidle_shift;
277 sidle_mask = (0x3 << sidle_shift);
280 *v |= __ffs(idlemode) << sidle_shift;
286 * _set_clockactivity: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
287 * @oh: struct omap_hwmod *
288 * @clockact: CLOCKACTIVITY field bits
289 * @v: pointer to register contents to modify
291 * Update the clockactivity mode bits in @v to be @clockact for the
292 * @oh hwmod. Used for additional powersaving on some modules. Does
293 * not write to the hardware. Returns -EINVAL upon error or 0 upon
296 static int _set_clockactivity(struct omap_hwmod *oh, u8 clockact, u32 *v)
301 if (!oh->class->sysc ||
302 !(oh->class->sysc->sysc_flags & SYSC_HAS_CLOCKACTIVITY))
305 if (!oh->class->sysc->sysc_fields) {
306 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
310 clkact_shift = oh->class->sysc->sysc_fields->clkact_shift;
311 clkact_mask = (0x3 << clkact_shift);
314 *v |= clockact << clkact_shift;
320 * _set_softreset: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
321 * @oh: struct omap_hwmod *
322 * @v: pointer to register contents to modify
324 * Set the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
325 * error or 0 upon success.
327 static int _set_softreset(struct omap_hwmod *oh, u32 *v)
331 if (!oh->class->sysc ||
332 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
335 if (!oh->class->sysc->sysc_fields) {
336 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
340 softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
348 * _set_module_autoidle: set the OCP_SYSCONFIG AUTOIDLE field in @v
349 * @oh: struct omap_hwmod *
350 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
351 * @v: pointer to register contents to modify
353 * Update the module autoidle bit in @v to be @autoidle for the @oh
354 * hwmod. The autoidle bit controls whether the module can gate
355 * internal clocks automatically when it isn't doing anything; the
356 * exact function of this bit varies on a per-module basis. This
357 * function does not write to the hardware. Returns -EINVAL upon
358 * error or 0 upon success.
360 static int _set_module_autoidle(struct omap_hwmod *oh, u8 autoidle,
366 if (!oh->class->sysc ||
367 !(oh->class->sysc->sysc_flags & SYSC_HAS_AUTOIDLE))
370 if (!oh->class->sysc->sysc_fields) {
371 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
375 autoidle_shift = oh->class->sysc->sysc_fields->autoidle_shift;
376 autoidle_mask = (0x1 << autoidle_shift);
378 *v &= ~autoidle_mask;
379 *v |= autoidle << autoidle_shift;
385 * _set_idle_ioring_wakeup - enable/disable IO pad wakeup on hwmod idle for mux
386 * @oh: struct omap_hwmod *
387 * @set_wake: bool value indicating to set (true) or clear (false) wakeup enable
389 * Set or clear the I/O pad wakeup flag in the mux entries for the
390 * hwmod @oh. This function changes the @oh->mux->pads_dynamic array
391 * in memory. If the hwmod is currently idled, and the new idle
392 * values don't match the previous ones, this function will also
393 * update the SCM PADCTRL registers. Otherwise, if the hwmod is not
394 * currently idled, this function won't touch the hardware: the new
395 * mux settings are written to the SCM PADCTRL registers when the
396 * hwmod is idled. No return value.
398 static void _set_idle_ioring_wakeup(struct omap_hwmod *oh, bool set_wake)
400 struct omap_device_pad *pad;
405 if (!oh->mux || !oh->mux->enabled)
408 for (j = 0; j < oh->mux->nr_pads_dynamic; j++) {
409 pad = oh->mux->pads_dynamic[j];
411 if (!(pad->flags & OMAP_DEVICE_PAD_WAKEUP))
414 prev_idle = pad->idle;
417 pad->idle |= OMAP_WAKEUP_EN;
419 pad->idle &= ~OMAP_WAKEUP_EN;
421 if (prev_idle != pad->idle)
425 if (change && oh->_state == _HWMOD_STATE_IDLE)
426 omap_hwmod_mux(oh->mux, _HWMOD_STATE_IDLE);
430 * _enable_wakeup: set OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
431 * @oh: struct omap_hwmod *
433 * Allow the hardware module @oh to send wakeups. Returns -EINVAL
434 * upon error or 0 upon success.
436 static int _enable_wakeup(struct omap_hwmod *oh, u32 *v)
438 if (!oh->class->sysc ||
439 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
440 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
441 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
444 if (!oh->class->sysc->sysc_fields) {
445 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
449 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
450 *v |= 0x1 << oh->class->sysc->sysc_fields->enwkup_shift;
452 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
453 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
454 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
455 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
457 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
459 oh->_int_flags |= _HWMOD_WAKEUP_ENABLED;
465 * _disable_wakeup: clear OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
466 * @oh: struct omap_hwmod *
468 * Prevent the hardware module @oh to send wakeups. Returns -EINVAL
469 * upon error or 0 upon success.
471 static int _disable_wakeup(struct omap_hwmod *oh, u32 *v)
473 if (!oh->class->sysc ||
474 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
475 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
476 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
479 if (!oh->class->sysc->sysc_fields) {
480 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
484 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
485 *v &= ~(0x1 << oh->class->sysc->sysc_fields->enwkup_shift);
487 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
488 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART, v);
489 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
490 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
492 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
494 oh->_int_flags &= ~_HWMOD_WAKEUP_ENABLED;
500 * _add_initiator_dep: prevent @oh from smart-idling while @init_oh is active
501 * @oh: struct omap_hwmod *
503 * Prevent the hardware module @oh from entering idle while the
504 * hardare module initiator @init_oh is active. Useful when a module
505 * will be accessed by a particular initiator (e.g., if a module will
506 * be accessed by the IVA, there should be a sleepdep between the IVA
507 * initiator and the module). Only applies to modules in smart-idle
508 * mode. If the clockdomain is marked as not needing autodeps, return
509 * 0 without doing anything. Otherwise, returns -EINVAL upon error or
510 * passes along clkdm_add_sleepdep() value upon success.
512 static int _add_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
517 if (oh->_clk->clkdm && oh->_clk->clkdm->flags & CLKDM_NO_AUTODEPS)
520 return clkdm_add_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
524 * _del_initiator_dep: allow @oh to smart-idle even if @init_oh is active
525 * @oh: struct omap_hwmod *
527 * Allow the hardware module @oh to enter idle while the hardare
528 * module initiator @init_oh is active. Useful when a module will not
529 * be accessed by a particular initiator (e.g., if a module will not
530 * be accessed by the IVA, there should be no sleepdep between the IVA
531 * initiator and the module). Only applies to modules in smart-idle
532 * mode. If the clockdomain is marked as not needing autodeps, return
533 * 0 without doing anything. Returns -EINVAL upon error or passes
534 * along clkdm_del_sleepdep() value upon success.
536 static int _del_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
541 if (oh->_clk->clkdm && oh->_clk->clkdm->flags & CLKDM_NO_AUTODEPS)
544 return clkdm_del_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
548 * _init_main_clk - get a struct clk * for the the hwmod's main functional clk
549 * @oh: struct omap_hwmod *
551 * Called from _init_clocks(). Populates the @oh _clk (main
552 * functional clock pointer) if a main_clk is present. Returns 0 on
553 * success or -EINVAL on error.
555 static int _init_main_clk(struct omap_hwmod *oh)
562 oh->_clk = omap_clk_get_by_name(oh->main_clk);
564 pr_warning("omap_hwmod: %s: cannot clk_get main_clk %s\n",
565 oh->name, oh->main_clk);
569 if (!oh->_clk->clkdm)
570 pr_warning("omap_hwmod: %s: missing clockdomain for %s.\n",
571 oh->main_clk, oh->_clk->name);
577 * _init_interface_clks - get a struct clk * for the the hwmod's interface clks
578 * @oh: struct omap_hwmod *
580 * Called from _init_clocks(). Populates the @oh OCP slave interface
581 * clock pointers. Returns 0 on success or -EINVAL on error.
583 static int _init_interface_clks(struct omap_hwmod *oh)
589 if (oh->slaves_cnt == 0)
592 for (i = 0; i < oh->slaves_cnt; i++) {
593 struct omap_hwmod_ocp_if *os = oh->slaves[i];
598 c = omap_clk_get_by_name(os->clk);
600 pr_warning("omap_hwmod: %s: cannot clk_get interface_clk %s\n",
611 * _init_opt_clk - get a struct clk * for the the hwmod's optional clocks
612 * @oh: struct omap_hwmod *
614 * Called from _init_clocks(). Populates the @oh omap_hwmod_opt_clk
615 * clock pointers. Returns 0 on success or -EINVAL on error.
617 static int _init_opt_clks(struct omap_hwmod *oh)
619 struct omap_hwmod_opt_clk *oc;
624 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++) {
625 c = omap_clk_get_by_name(oc->clk);
627 pr_warning("omap_hwmod: %s: cannot clk_get opt_clk %s\n",
638 * _enable_clocks - enable hwmod main clock and interface clocks
639 * @oh: struct omap_hwmod *
641 * Enables all clocks necessary for register reads and writes to succeed
642 * on the hwmod @oh. Returns 0.
644 static int _enable_clocks(struct omap_hwmod *oh)
648 pr_debug("omap_hwmod: %s: enabling clocks\n", oh->name);
651 clk_enable(oh->_clk);
653 if (oh->slaves_cnt > 0) {
654 for (i = 0; i < oh->slaves_cnt; i++) {
655 struct omap_hwmod_ocp_if *os = oh->slaves[i];
656 struct clk *c = os->_clk;
658 if (c && (os->flags & OCPIF_SWSUP_IDLE))
663 /* The opt clocks are controlled by the device driver. */
669 * _disable_clocks - disable hwmod main clock and interface clocks
670 * @oh: struct omap_hwmod *
672 * Disables the hwmod @oh main functional and interface clocks. Returns 0.
674 static int _disable_clocks(struct omap_hwmod *oh)
678 pr_debug("omap_hwmod: %s: disabling clocks\n", oh->name);
681 clk_disable(oh->_clk);
683 if (oh->slaves_cnt > 0) {
684 for (i = 0; i < oh->slaves_cnt; i++) {
685 struct omap_hwmod_ocp_if *os = oh->slaves[i];
686 struct clk *c = os->_clk;
688 if (c && (os->flags & OCPIF_SWSUP_IDLE))
693 /* The opt clocks are controlled by the device driver. */
698 static void _enable_optional_clocks(struct omap_hwmod *oh)
700 struct omap_hwmod_opt_clk *oc;
703 pr_debug("omap_hwmod: %s: enabling optional clocks\n", oh->name);
705 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
707 pr_debug("omap_hwmod: enable %s:%s\n", oc->role,
709 clk_enable(oc->_clk);
713 static void _disable_optional_clocks(struct omap_hwmod *oh)
715 struct omap_hwmod_opt_clk *oc;
718 pr_debug("omap_hwmod: %s: disabling optional clocks\n", oh->name);
720 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
722 pr_debug("omap_hwmod: disable %s:%s\n", oc->role,
724 clk_disable(oc->_clk);
729 * _enable_module - enable CLKCTRL modulemode on OMAP4
730 * @oh: struct omap_hwmod *
732 * Enables the PRCM module mode related to the hwmod @oh.
735 static void _enable_module(struct omap_hwmod *oh)
737 /* The module mode does not exist prior OMAP4 */
738 if (cpu_is_omap24xx() || cpu_is_omap34xx())
741 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
744 pr_debug("omap_hwmod: %s: _enable_module: %d\n",
745 oh->name, oh->prcm.omap4.modulemode);
747 omap4_cminst_module_enable(oh->prcm.omap4.modulemode,
748 oh->clkdm->prcm_partition,
750 oh->clkdm->clkdm_offs,
751 oh->prcm.omap4.clkctrl_offs);
755 * _disable_module - enable CLKCTRL modulemode on OMAP4
756 * @oh: struct omap_hwmod *
758 * Disable the PRCM module mode related to the hwmod @oh.
761 static void _disable_module(struct omap_hwmod *oh)
763 /* The module mode does not exist prior OMAP4 */
764 if (cpu_is_omap24xx() || cpu_is_omap34xx())
767 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
770 pr_debug("omap_hwmod: %s: _disable_module\n", oh->name);
772 omap4_cminst_module_disable(oh->clkdm->prcm_partition,
774 oh->clkdm->clkdm_offs,
775 oh->prcm.omap4.clkctrl_offs);
779 * _count_mpu_irqs - count the number of MPU IRQ lines associated with @oh
780 * @oh: struct omap_hwmod *oh
782 * Count and return the number of MPU IRQs associated with the hwmod
783 * @oh. Used to allocate struct resource data. Returns 0 if @oh is
786 static int _count_mpu_irqs(struct omap_hwmod *oh)
788 struct omap_hwmod_irq_info *ohii;
791 if (!oh || !oh->mpu_irqs)
795 ohii = &oh->mpu_irqs[i++];
796 } while (ohii->irq != -1);
802 * _count_sdma_reqs - count the number of SDMA request lines associated with @oh
803 * @oh: struct omap_hwmod *oh
805 * Count and return the number of SDMA request lines associated with
806 * the hwmod @oh. Used to allocate struct resource data. Returns 0
809 static int _count_sdma_reqs(struct omap_hwmod *oh)
811 struct omap_hwmod_dma_info *ohdi;
814 if (!oh || !oh->sdma_reqs)
818 ohdi = &oh->sdma_reqs[i++];
819 } while (ohdi->dma_req != -1);
825 * _count_ocp_if_addr_spaces - count the number of address space entries for @oh
826 * @oh: struct omap_hwmod *oh
828 * Count and return the number of address space ranges associated with
829 * the hwmod @oh. Used to allocate struct resource data. Returns 0
832 static int _count_ocp_if_addr_spaces(struct omap_hwmod_ocp_if *os)
834 struct omap_hwmod_addr_space *mem;
837 if (!os || !os->addr)
841 mem = &os->addr[i++];
842 } while (mem->pa_start != mem->pa_end);
848 * _find_mpu_port_index - find hwmod OCP slave port ID intended for MPU use
849 * @oh: struct omap_hwmod *
851 * Returns the array index of the OCP slave port that the MPU
852 * addresses the device on, or -EINVAL upon error or not found.
854 static int __init _find_mpu_port_index(struct omap_hwmod *oh)
859 if (!oh || oh->slaves_cnt == 0)
862 for (i = 0; i < oh->slaves_cnt; i++) {
863 struct omap_hwmod_ocp_if *os = oh->slaves[i];
865 if (os->user & OCP_USER_MPU) {
872 pr_debug("omap_hwmod: %s: MPU OCP slave port ID %d\n",
875 pr_debug("omap_hwmod: %s: no MPU OCP slave port found\n",
878 return (found) ? i : -EINVAL;
882 * _find_mpu_rt_base - find hwmod register target base addr accessible by MPU
883 * @oh: struct omap_hwmod *
885 * Return the virtual address of the base of the register target of
886 * device @oh, or NULL on error.
888 static void __iomem * __init _find_mpu_rt_base(struct omap_hwmod *oh, u8 index)
890 struct omap_hwmod_ocp_if *os;
891 struct omap_hwmod_addr_space *mem;
892 int i = 0, found = 0;
893 void __iomem *va_start;
895 if (!oh || oh->slaves_cnt == 0)
898 os = oh->slaves[index];
904 mem = &os->addr[i++];
905 if (mem->flags & ADDR_TYPE_RT)
907 } while (!found && mem->pa_start != mem->pa_end);
910 va_start = ioremap(mem->pa_start, mem->pa_end - mem->pa_start);
912 pr_err("omap_hwmod: %s: Could not ioremap\n", oh->name);
915 pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
918 pr_debug("omap_hwmod: %s: no MPU register target found\n",
922 return (found) ? va_start : NULL;
926 * _enable_sysc - try to bring a module out of idle via OCP_SYSCONFIG
927 * @oh: struct omap_hwmod *
929 * If module is marked as SWSUP_SIDLE, force the module out of slave
930 * idle; otherwise, configure it for smart-idle. If module is marked
931 * as SWSUP_MSUSPEND, force the module out of master standby;
932 * otherwise, configure it for smart-standby. No return value.
934 static void _enable_sysc(struct omap_hwmod *oh)
939 if (!oh->class->sysc)
943 sf = oh->class->sysc->sysc_flags;
945 if (sf & SYSC_HAS_SIDLEMODE) {
946 idlemode = (oh->flags & HWMOD_SWSUP_SIDLE) ?
947 HWMOD_IDLEMODE_NO : HWMOD_IDLEMODE_SMART;
948 _set_slave_idlemode(oh, idlemode, &v);
951 if (sf & SYSC_HAS_MIDLEMODE) {
952 if (oh->flags & HWMOD_SWSUP_MSTANDBY) {
953 idlemode = HWMOD_IDLEMODE_NO;
955 if (sf & SYSC_HAS_ENAWAKEUP)
956 _enable_wakeup(oh, &v);
957 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
958 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
960 idlemode = HWMOD_IDLEMODE_SMART;
962 _set_master_standbymode(oh, idlemode, &v);
966 * XXX The clock framework should handle this, by
967 * calling into this code. But this must wait until the
968 * clock structures are tagged with omap_hwmod entries
970 if ((oh->flags & HWMOD_SET_DEFAULT_CLOCKACT) &&
971 (sf & SYSC_HAS_CLOCKACTIVITY))
972 _set_clockactivity(oh, oh->class->sysc->clockact, &v);
974 /* If slave is in SMARTIDLE, also enable wakeup */
975 if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
976 _enable_wakeup(oh, &v);
978 _write_sysconfig(v, oh);
981 * Set the autoidle bit only after setting the smartidle bit
982 * Setting this will not have any impact on the other modules.
984 if (sf & SYSC_HAS_AUTOIDLE) {
985 idlemode = (oh->flags & HWMOD_NO_OCP_AUTOIDLE) ?
987 _set_module_autoidle(oh, idlemode, &v);
988 _write_sysconfig(v, oh);
993 * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
994 * @oh: struct omap_hwmod *
996 * If module is marked as SWSUP_SIDLE, force the module into slave
997 * idle; otherwise, configure it for smart-idle. If module is marked
998 * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
999 * configure it for smart-standby. No return value.
1001 static void _idle_sysc(struct omap_hwmod *oh)
1006 if (!oh->class->sysc)
1009 v = oh->_sysc_cache;
1010 sf = oh->class->sysc->sysc_flags;
1012 if (sf & SYSC_HAS_SIDLEMODE) {
1013 idlemode = (oh->flags & HWMOD_SWSUP_SIDLE) ?
1014 HWMOD_IDLEMODE_FORCE : HWMOD_IDLEMODE_SMART;
1015 _set_slave_idlemode(oh, idlemode, &v);
1018 if (sf & SYSC_HAS_MIDLEMODE) {
1019 if (oh->flags & HWMOD_SWSUP_MSTANDBY) {
1020 idlemode = HWMOD_IDLEMODE_FORCE;
1022 if (sf & SYSC_HAS_ENAWAKEUP)
1023 _enable_wakeup(oh, &v);
1024 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1025 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1027 idlemode = HWMOD_IDLEMODE_SMART;
1029 _set_master_standbymode(oh, idlemode, &v);
1032 /* If slave is in SMARTIDLE, also enable wakeup */
1033 if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
1034 _enable_wakeup(oh, &v);
1036 _write_sysconfig(v, oh);
1040 * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
1041 * @oh: struct omap_hwmod *
1043 * Force the module into slave idle and master suspend. No return
1046 static void _shutdown_sysc(struct omap_hwmod *oh)
1051 if (!oh->class->sysc)
1054 v = oh->_sysc_cache;
1055 sf = oh->class->sysc->sysc_flags;
1057 if (sf & SYSC_HAS_SIDLEMODE)
1058 _set_slave_idlemode(oh, HWMOD_IDLEMODE_FORCE, &v);
1060 if (sf & SYSC_HAS_MIDLEMODE)
1061 _set_master_standbymode(oh, HWMOD_IDLEMODE_FORCE, &v);
1063 if (sf & SYSC_HAS_AUTOIDLE)
1064 _set_module_autoidle(oh, 1, &v);
1066 _write_sysconfig(v, oh);
1070 * _lookup - find an omap_hwmod by name
1071 * @name: find an omap_hwmod by name
1073 * Return a pointer to an omap_hwmod by name, or NULL if not found.
1075 static struct omap_hwmod *_lookup(const char *name)
1077 struct omap_hwmod *oh, *temp_oh;
1081 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1082 if (!strcmp(name, temp_oh->name)) {
1091 * _init_clkdm - look up a clockdomain name, store pointer in omap_hwmod
1092 * @oh: struct omap_hwmod *
1094 * Convert a clockdomain name stored in a struct omap_hwmod into a
1095 * clockdomain pointer, and save it into the struct omap_hwmod.
1096 * return -EINVAL if clkdm_name does not exist or if the lookup failed.
1098 static int _init_clkdm(struct omap_hwmod *oh)
1100 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1103 if (!oh->clkdm_name) {
1104 pr_warning("omap_hwmod: %s: no clkdm_name\n", oh->name);
1108 oh->clkdm = clkdm_lookup(oh->clkdm_name);
1110 pr_warning("omap_hwmod: %s: could not associate to clkdm %s\n",
1111 oh->name, oh->clkdm_name);
1115 pr_debug("omap_hwmod: %s: associated to clkdm %s\n",
1116 oh->name, oh->clkdm_name);
1122 * _init_clocks - clk_get() all clocks associated with this hwmod. Retrieve as
1123 * well the clockdomain.
1124 * @oh: struct omap_hwmod *
1125 * @data: not used; pass NULL
1127 * Called by omap_hwmod_setup_*() (after omap2_clk_init()).
1128 * Resolves all clock names embedded in the hwmod. Returns 0 on
1129 * success, or a negative error code on failure.
1131 static int _init_clocks(struct omap_hwmod *oh, void *data)
1135 if (oh->_state != _HWMOD_STATE_REGISTERED)
1138 pr_debug("omap_hwmod: %s: looking up clocks\n", oh->name);
1140 ret |= _init_main_clk(oh);
1141 ret |= _init_interface_clks(oh);
1142 ret |= _init_opt_clks(oh);
1143 ret |= _init_clkdm(oh);
1146 oh->_state = _HWMOD_STATE_CLKS_INITED;
1148 pr_warning("omap_hwmod: %s: cannot _init_clocks\n", oh->name);
1154 * _wait_target_ready - wait for a module to leave slave idle
1155 * @oh: struct omap_hwmod *
1157 * Wait for a module @oh to leave slave idle. Returns 0 if the module
1158 * does not have an IDLEST bit or if the module successfully leaves
1159 * slave idle; otherwise, pass along the return value of the
1160 * appropriate *_cm*_wait_module_ready() function.
1162 static int _wait_target_ready(struct omap_hwmod *oh)
1164 struct omap_hwmod_ocp_if *os;
1170 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
1173 os = oh->slaves[oh->_mpu_port_index];
1175 if (oh->flags & HWMOD_NO_IDLEST)
1178 /* XXX check module SIDLEMODE */
1180 /* XXX check clock enable states */
1182 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1183 ret = omap2_cm_wait_module_ready(oh->prcm.omap2.module_offs,
1184 oh->prcm.omap2.idlest_reg_id,
1185 oh->prcm.omap2.idlest_idle_bit);
1186 } else if (cpu_is_omap44xx()) {
1190 ret = omap4_cminst_wait_module_ready(oh->clkdm->prcm_partition,
1192 oh->clkdm->clkdm_offs,
1193 oh->prcm.omap4.clkctrl_offs);
1202 * _wait_target_disable - wait for a module to be disabled
1203 * @oh: struct omap_hwmod *
1205 * Wait for a module @oh to enter slave idle. Returns 0 if the module
1206 * does not have an IDLEST bit or if the module successfully enters
1207 * slave idle; otherwise, pass along the return value of the
1208 * appropriate *_cm*_wait_module_idle() function.
1210 static int _wait_target_disable(struct omap_hwmod *oh)
1212 /* TODO: For now just handle OMAP4+ */
1213 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1219 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
1222 if (oh->flags & HWMOD_NO_IDLEST)
1225 return omap4_cminst_wait_module_idle(oh->clkdm->prcm_partition,
1227 oh->clkdm->clkdm_offs,
1228 oh->prcm.omap4.clkctrl_offs);
1232 * _lookup_hardreset - fill register bit info for this hwmod/reset line
1233 * @oh: struct omap_hwmod *
1234 * @name: name of the reset line in the context of this hwmod
1235 * @ohri: struct omap_hwmod_rst_info * that this function will fill in
1237 * Return the bit position of the reset line that match the
1238 * input name. Return -ENOENT if not found.
1240 static u8 _lookup_hardreset(struct omap_hwmod *oh, const char *name,
1241 struct omap_hwmod_rst_info *ohri)
1245 for (i = 0; i < oh->rst_lines_cnt; i++) {
1246 const char *rst_line = oh->rst_lines[i].name;
1247 if (!strcmp(rst_line, name)) {
1248 ohri->rst_shift = oh->rst_lines[i].rst_shift;
1249 ohri->st_shift = oh->rst_lines[i].st_shift;
1250 pr_debug("omap_hwmod: %s: %s: %s: rst %d st %d\n",
1251 oh->name, __func__, rst_line, ohri->rst_shift,
1262 * _assert_hardreset - assert the HW reset line of submodules
1263 * contained in the hwmod module.
1264 * @oh: struct omap_hwmod *
1265 * @name: name of the reset line to lookup and assert
1267 * Some IP like dsp, ipu or iva contain processor that require
1268 * an HW reset line to be assert / deassert in order to enable fully
1271 static int _assert_hardreset(struct omap_hwmod *oh, const char *name)
1273 struct omap_hwmod_rst_info ohri;
1279 ret = _lookup_hardreset(oh, name, &ohri);
1280 if (IS_ERR_VALUE(ret))
1283 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1284 return omap2_prm_assert_hardreset(oh->prcm.omap2.module_offs,
1286 else if (cpu_is_omap44xx())
1287 return omap4_prminst_assert_hardreset(ohri.rst_shift,
1288 oh->clkdm->pwrdm.ptr->prcm_partition,
1289 oh->clkdm->pwrdm.ptr->prcm_offs,
1290 oh->prcm.omap4.rstctrl_offs);
1296 * _deassert_hardreset - deassert the HW reset line of submodules contained
1297 * in the hwmod module.
1298 * @oh: struct omap_hwmod *
1299 * @name: name of the reset line to look up and deassert
1301 * Some IP like dsp, ipu or iva contain processor that require
1302 * an HW reset line to be assert / deassert in order to enable fully
1305 static int _deassert_hardreset(struct omap_hwmod *oh, const char *name)
1307 struct omap_hwmod_rst_info ohri;
1313 ret = _lookup_hardreset(oh, name, &ohri);
1314 if (IS_ERR_VALUE(ret))
1317 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1318 ret = omap2_prm_deassert_hardreset(oh->prcm.omap2.module_offs,
1321 } else if (cpu_is_omap44xx()) {
1323 pr_err("omap_hwmod: %s: %s: hwmod data error: OMAP4 does not support st_shift\n",
1325 ret = omap4_prminst_deassert_hardreset(ohri.rst_shift,
1326 oh->clkdm->pwrdm.ptr->prcm_partition,
1327 oh->clkdm->pwrdm.ptr->prcm_offs,
1328 oh->prcm.omap4.rstctrl_offs);
1334 pr_warning("omap_hwmod: %s: failed to hardreset\n", oh->name);
1340 * _read_hardreset - read the HW reset line state of submodules
1341 * contained in the hwmod module
1342 * @oh: struct omap_hwmod *
1343 * @name: name of the reset line to look up and read
1345 * Return the state of the reset line.
1347 static int _read_hardreset(struct omap_hwmod *oh, const char *name)
1349 struct omap_hwmod_rst_info ohri;
1355 ret = _lookup_hardreset(oh, name, &ohri);
1356 if (IS_ERR_VALUE(ret))
1359 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1360 return omap2_prm_is_hardreset_asserted(oh->prcm.omap2.module_offs,
1362 } else if (cpu_is_omap44xx()) {
1363 return omap4_prminst_is_hardreset_asserted(ohri.rst_shift,
1364 oh->clkdm->pwrdm.ptr->prcm_partition,
1365 oh->clkdm->pwrdm.ptr->prcm_offs,
1366 oh->prcm.omap4.rstctrl_offs);
1373 * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1374 * @oh: struct omap_hwmod *
1376 * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit. hwmod must be
1377 * enabled for this to work. Returns -EINVAL if the hwmod cannot be
1378 * reset this way or if the hwmod is in the wrong state, -ETIMEDOUT if
1379 * the module did not reset in time, or 0 upon success.
1381 * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1382 * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1383 * use the SYSCONFIG softreset bit to provide the status.
1385 * Note that some IP like McBSP do have reset control but don't have
1388 static int _ocp_softreset(struct omap_hwmod *oh)
1394 if (!oh->class->sysc ||
1395 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
1398 /* clocks must be on for this operation */
1399 if (oh->_state != _HWMOD_STATE_ENABLED) {
1400 pr_warning("omap_hwmod: %s: reset can only be entered from "
1401 "enabled state\n", oh->name);
1405 /* For some modules, all optionnal clocks need to be enabled as well */
1406 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1407 _enable_optional_clocks(oh);
1409 pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh->name);
1411 v = oh->_sysc_cache;
1412 ret = _set_softreset(oh, &v);
1415 _write_sysconfig(v, oh);
1417 if (oh->class->sysc->sysc_flags & SYSS_HAS_RESET_STATUS)
1418 omap_test_timeout((omap_hwmod_read(oh,
1419 oh->class->sysc->syss_offs)
1420 & SYSS_RESETDONE_MASK),
1421 MAX_MODULE_SOFTRESET_WAIT, c);
1422 else if (oh->class->sysc->sysc_flags & SYSC_HAS_RESET_STATUS)
1423 omap_test_timeout(!(omap_hwmod_read(oh,
1424 oh->class->sysc->sysc_offs)
1425 & SYSC_TYPE2_SOFTRESET_MASK),
1426 MAX_MODULE_SOFTRESET_WAIT, c);
1428 if (c == MAX_MODULE_SOFTRESET_WAIT)
1429 pr_warning("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1430 oh->name, MAX_MODULE_SOFTRESET_WAIT);
1432 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh->name, c);
1435 * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1436 * _wait_target_ready() or _reset()
1439 ret = (c == MAX_MODULE_SOFTRESET_WAIT) ? -ETIMEDOUT : 0;
1442 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1443 _disable_optional_clocks(oh);
1449 * _reset - reset an omap_hwmod
1450 * @oh: struct omap_hwmod *
1452 * Resets an omap_hwmod @oh. The default software reset mechanism for
1453 * most OMAP IP blocks is triggered via the OCP_SYSCONFIG.SOFTRESET
1454 * bit. However, some hwmods cannot be reset via this method: some
1455 * are not targets and therefore have no OCP header registers to
1456 * access; others (like the IVA) have idiosyncratic reset sequences.
1457 * So for these relatively rare cases, custom reset code can be
1458 * supplied in the struct omap_hwmod_class .reset function pointer.
1459 * Passes along the return value from either _reset() or the custom
1460 * reset function - these must return -EINVAL if the hwmod cannot be
1461 * reset this way or if the hwmod is in the wrong state, -ETIMEDOUT if
1462 * the module did not reset in time, or 0 upon success.
1464 static int _reset(struct omap_hwmod *oh)
1468 pr_debug("omap_hwmod: %s: resetting\n", oh->name);
1470 ret = (oh->class->reset) ? oh->class->reset(oh) : _ocp_softreset(oh);
1476 * _enable - enable an omap_hwmod
1477 * @oh: struct omap_hwmod *
1479 * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
1480 * register target. Returns -EINVAL if the hwmod is in the wrong
1481 * state or passes along the return value of _wait_target_ready().
1483 static int _enable(struct omap_hwmod *oh)
1488 pr_debug("omap_hwmod: %s: enabling\n", oh->name);
1490 if (oh->_state != _HWMOD_STATE_INITIALIZED &&
1491 oh->_state != _HWMOD_STATE_IDLE &&
1492 oh->_state != _HWMOD_STATE_DISABLED) {
1493 WARN(1, "omap_hwmod: %s: enabled state can only be entered "
1494 "from initialized, idle, or disabled state\n", oh->name);
1500 * If an IP contains only one HW reset line, then de-assert it in order
1501 * to allow the module state transition. Otherwise the PRCM will return
1502 * Intransition status, and the init will failed.
1504 if ((oh->_state == _HWMOD_STATE_INITIALIZED ||
1505 oh->_state == _HWMOD_STATE_DISABLED) && oh->rst_lines_cnt == 1)
1506 _deassert_hardreset(oh, oh->rst_lines[0].name);
1508 /* Mux pins for device runtime if populated */
1509 if (oh->mux && (!oh->mux->enabled ||
1510 ((oh->_state == _HWMOD_STATE_IDLE) &&
1511 oh->mux->pads_dynamic)))
1512 omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
1514 _add_initiator_dep(oh, mpu_oh);
1518 * A clockdomain must be in SW_SUP before enabling
1519 * completely the module. The clockdomain can be set
1520 * in HW_AUTO only when the module become ready.
1522 hwsup = clkdm_in_hwsup(oh->clkdm);
1523 r = clkdm_hwmod_enable(oh->clkdm, oh);
1525 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1526 oh->name, oh->clkdm->name, r);
1534 r = _wait_target_ready(oh);
1537 * Set the clockdomain to HW_AUTO only if the target is ready,
1538 * assuming that the previous state was HW_AUTO
1540 if (oh->clkdm && hwsup)
1541 clkdm_allow_idle(oh->clkdm);
1543 oh->_state = _HWMOD_STATE_ENABLED;
1545 /* Access the sysconfig only if the target is ready */
1546 if (oh->class->sysc) {
1547 if (!(oh->_int_flags & _HWMOD_SYSCONFIG_LOADED))
1548 _update_sysc_cache(oh);
1552 _disable_clocks(oh);
1553 pr_debug("omap_hwmod: %s: _wait_target_ready: %d\n",
1557 clkdm_hwmod_disable(oh->clkdm, oh);
1564 * _idle - idle an omap_hwmod
1565 * @oh: struct omap_hwmod *
1567 * Idles an omap_hwmod @oh. This should be called once the hwmod has
1568 * no further work. Returns -EINVAL if the hwmod is in the wrong
1569 * state or returns 0.
1571 static int _idle(struct omap_hwmod *oh)
1575 pr_debug("omap_hwmod: %s: idling\n", oh->name);
1577 if (oh->_state != _HWMOD_STATE_ENABLED) {
1578 WARN(1, "omap_hwmod: %s: idle state can only be entered from "
1579 "enabled state\n", oh->name);
1583 if (oh->class->sysc)
1585 _del_initiator_dep(oh, mpu_oh);
1586 _disable_module(oh);
1587 ret = _wait_target_disable(oh);
1589 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1592 * The module must be in idle mode before disabling any parents
1593 * clocks. Otherwise, the parent clock might be disabled before
1594 * the module transition is done, and thus will prevent the
1595 * transition to complete properly.
1597 _disable_clocks(oh);
1599 clkdm_hwmod_disable(oh->clkdm, oh);
1601 /* Mux pins for device idle if populated */
1602 if (oh->mux && oh->mux->pads_dynamic)
1603 omap_hwmod_mux(oh->mux, _HWMOD_STATE_IDLE);
1605 oh->_state = _HWMOD_STATE_IDLE;
1611 * omap_hwmod_set_ocp_autoidle - set the hwmod's OCP autoidle bit
1612 * @oh: struct omap_hwmod *
1613 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
1615 * Sets the IP block's OCP autoidle bit in hardware, and updates our
1616 * local copy. Intended to be used by drivers that require
1617 * direct manipulation of the AUTOIDLE bits.
1618 * Returns -EINVAL if @oh is null or is not in the ENABLED state, or passes
1619 * along the return value from _set_module_autoidle().
1621 * Any users of this function should be scrutinized carefully.
1623 int omap_hwmod_set_ocp_autoidle(struct omap_hwmod *oh, u8 autoidle)
1627 unsigned long flags;
1629 if (!oh || oh->_state != _HWMOD_STATE_ENABLED)
1632 spin_lock_irqsave(&oh->_lock, flags);
1634 v = oh->_sysc_cache;
1636 retval = _set_module_autoidle(oh, autoidle, &v);
1639 _write_sysconfig(v, oh);
1641 spin_unlock_irqrestore(&oh->_lock, flags);
1647 * _shutdown - shutdown an omap_hwmod
1648 * @oh: struct omap_hwmod *
1650 * Shut down an omap_hwmod @oh. This should be called when the driver
1651 * used for the hwmod is removed or unloaded or if the driver is not
1652 * used by the system. Returns -EINVAL if the hwmod is in the wrong
1653 * state or returns 0.
1655 static int _shutdown(struct omap_hwmod *oh)
1660 if (oh->_state != _HWMOD_STATE_IDLE &&
1661 oh->_state != _HWMOD_STATE_ENABLED) {
1662 WARN(1, "omap_hwmod: %s: disabled state can only be entered "
1663 "from idle, or enabled state\n", oh->name);
1667 pr_debug("omap_hwmod: %s: disabling\n", oh->name);
1669 if (oh->class->pre_shutdown) {
1670 prev_state = oh->_state;
1671 if (oh->_state == _HWMOD_STATE_IDLE)
1673 ret = oh->class->pre_shutdown(oh);
1675 if (prev_state == _HWMOD_STATE_IDLE)
1681 if (oh->class->sysc) {
1682 if (oh->_state == _HWMOD_STATE_IDLE)
1687 /* clocks and deps are already disabled in idle */
1688 if (oh->_state == _HWMOD_STATE_ENABLED) {
1689 _del_initiator_dep(oh, mpu_oh);
1690 /* XXX what about the other system initiators here? dma, dsp */
1691 _disable_module(oh);
1692 ret = _wait_target_disable(oh);
1694 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1696 _disable_clocks(oh);
1698 clkdm_hwmod_disable(oh->clkdm, oh);
1700 /* XXX Should this code also force-disable the optional clocks? */
1703 * If an IP contains only one HW reset line, then assert it
1704 * after disabling the clocks and before shutting down the IP.
1706 if (oh->rst_lines_cnt == 1)
1707 _assert_hardreset(oh, oh->rst_lines[0].name);
1709 /* Mux pins to safe mode or use populated off mode values */
1711 omap_hwmod_mux(oh->mux, _HWMOD_STATE_DISABLED);
1713 oh->_state = _HWMOD_STATE_DISABLED;
1719 * _setup - do initial configuration of omap_hwmod
1720 * @oh: struct omap_hwmod *
1722 * Writes the CLOCKACTIVITY bits @clockact to the hwmod @oh
1723 * OCP_SYSCONFIG register. Returns 0.
1725 static int _setup(struct omap_hwmod *oh, void *data)
1730 if (oh->_state != _HWMOD_STATE_CLKS_INITED)
1733 /* Set iclk autoidle mode */
1734 if (oh->slaves_cnt > 0) {
1735 for (i = 0; i < oh->slaves_cnt; i++) {
1736 struct omap_hwmod_ocp_if *os = oh->slaves[i];
1737 struct clk *c = os->_clk;
1742 if (os->flags & OCPIF_SWSUP_IDLE) {
1743 /* XXX omap_iclk_deny_idle(c); */
1745 /* XXX omap_iclk_allow_idle(c); */
1751 oh->_state = _HWMOD_STATE_INITIALIZED;
1754 * In the case of hwmod with hardreset that should not be
1755 * de-assert at boot time, we have to keep the module
1756 * initialized, because we cannot enable it properly with the
1757 * reset asserted. Exit without warning because that behavior is
1760 if ((oh->flags & HWMOD_INIT_NO_RESET) && oh->rst_lines_cnt == 1)
1765 pr_warning("omap_hwmod: %s: cannot be enabled (%d)\n",
1766 oh->name, oh->_state);
1770 if (!(oh->flags & HWMOD_INIT_NO_RESET)) {
1774 * OCP_SYSCONFIG bits need to be reprogrammed after a softreset.
1775 * The _enable() function should be split to
1776 * avoid the rewrite of the OCP_SYSCONFIG register.
1778 if (oh->class->sysc) {
1779 _update_sysc_cache(oh);
1784 postsetup_state = oh->_postsetup_state;
1785 if (postsetup_state == _HWMOD_STATE_UNKNOWN)
1786 postsetup_state = _HWMOD_STATE_ENABLED;
1789 * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
1790 * it should be set by the core code as a runtime flag during startup
1792 if ((oh->flags & HWMOD_INIT_NO_IDLE) &&
1793 (postsetup_state == _HWMOD_STATE_IDLE))
1794 postsetup_state = _HWMOD_STATE_ENABLED;
1796 if (postsetup_state == _HWMOD_STATE_IDLE)
1798 else if (postsetup_state == _HWMOD_STATE_DISABLED)
1800 else if (postsetup_state != _HWMOD_STATE_ENABLED)
1801 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
1802 oh->name, postsetup_state);
1808 * _register - register a struct omap_hwmod
1809 * @oh: struct omap_hwmod *
1811 * Registers the omap_hwmod @oh. Returns -EEXIST if an omap_hwmod
1812 * already has been registered by the same name; -EINVAL if the
1813 * omap_hwmod is in the wrong state, if @oh is NULL, if the
1814 * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
1815 * name, or if the omap_hwmod's class is missing a name; or 0 upon
1818 * XXX The data should be copied into bootmem, so the original data
1819 * should be marked __initdata and freed after init. This would allow
1820 * unneeded omap_hwmods to be freed on multi-OMAP configurations. Note
1821 * that the copy process would be relatively complex due to the large number
1824 static int __init _register(struct omap_hwmod *oh)
1828 if (!oh || !oh->name || !oh->class || !oh->class->name ||
1829 (oh->_state != _HWMOD_STATE_UNKNOWN))
1832 pr_debug("omap_hwmod: %s: registering\n", oh->name);
1834 if (_lookup(oh->name))
1837 ms_id = _find_mpu_port_index(oh);
1838 if (!IS_ERR_VALUE(ms_id))
1839 oh->_mpu_port_index = ms_id;
1841 oh->_int_flags |= _HWMOD_NO_MPU_PORT;
1843 list_add_tail(&oh->node, &omap_hwmod_list);
1845 spin_lock_init(&oh->_lock);
1847 oh->_state = _HWMOD_STATE_REGISTERED;
1850 * XXX Rather than doing a strcmp(), this should test a flag
1851 * set in the hwmod data, inserted by the autogenerator code.
1853 if (!strcmp(oh->name, MPU_INITIATOR_NAME))
1860 /* Public functions */
1862 u32 omap_hwmod_read(struct omap_hwmod *oh, u16 reg_offs)
1864 if (oh->flags & HWMOD_16BIT_REG)
1865 return __raw_readw(oh->_mpu_rt_va + reg_offs);
1867 return __raw_readl(oh->_mpu_rt_va + reg_offs);
1870 void omap_hwmod_write(u32 v, struct omap_hwmod *oh, u16 reg_offs)
1872 if (oh->flags & HWMOD_16BIT_REG)
1873 __raw_writew(v, oh->_mpu_rt_va + reg_offs);
1875 __raw_writel(v, oh->_mpu_rt_va + reg_offs);
1879 * omap_hwmod_softreset - reset a module via SYSCONFIG.SOFTRESET bit
1880 * @oh: struct omap_hwmod *
1882 * This is a public function exposed to drivers. Some drivers may need to do
1883 * some settings before and after resetting the device. Those drivers after
1884 * doing the necessary settings could use this function to start a reset by
1885 * setting the SYSCONFIG.SOFTRESET bit.
1887 int omap_hwmod_softreset(struct omap_hwmod *oh)
1892 if (!oh || !(oh->_sysc_cache))
1895 v = oh->_sysc_cache;
1896 ret = _set_softreset(oh, &v);
1899 _write_sysconfig(v, oh);
1906 * omap_hwmod_set_slave_idlemode - set the hwmod's OCP slave idlemode
1907 * @oh: struct omap_hwmod *
1908 * @idlemode: SIDLEMODE field bits (shifted to bit 0)
1910 * Sets the IP block's OCP slave idlemode in hardware, and updates our
1911 * local copy. Intended to be used by drivers that have some erratum
1912 * that requires direct manipulation of the SIDLEMODE bits. Returns
1913 * -EINVAL if @oh is null, or passes along the return value from
1914 * _set_slave_idlemode().
1916 * XXX Does this function have any current users? If not, we should
1917 * remove it; it is better to let the rest of the hwmod code handle this.
1918 * Any users of this function should be scrutinized carefully.
1920 int omap_hwmod_set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode)
1928 v = oh->_sysc_cache;
1930 retval = _set_slave_idlemode(oh, idlemode, &v);
1932 _write_sysconfig(v, oh);
1938 * omap_hwmod_lookup - look up a registered omap_hwmod by name
1939 * @name: name of the omap_hwmod to look up
1941 * Given a @name of an omap_hwmod, return a pointer to the registered
1942 * struct omap_hwmod *, or NULL upon error.
1944 struct omap_hwmod *omap_hwmod_lookup(const char *name)
1946 struct omap_hwmod *oh;
1957 * omap_hwmod_for_each - call function for each registered omap_hwmod
1958 * @fn: pointer to a callback function
1959 * @data: void * data to pass to callback function
1961 * Call @fn for each registered omap_hwmod, passing @data to each
1962 * function. @fn must return 0 for success or any other value for
1963 * failure. If @fn returns non-zero, the iteration across omap_hwmods
1964 * will stop and the non-zero return value will be passed to the
1965 * caller of omap_hwmod_for_each(). @fn is called with
1966 * omap_hwmod_for_each() held.
1968 int omap_hwmod_for_each(int (*fn)(struct omap_hwmod *oh, void *data),
1971 struct omap_hwmod *temp_oh;
1977 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1978 ret = (*fn)(temp_oh, data);
1987 * omap_hwmod_register - register an array of hwmods
1988 * @ohs: pointer to an array of omap_hwmods to register
1990 * Intended to be called early in boot before the clock framework is
1991 * initialized. If @ohs is not null, will register all omap_hwmods
1992 * listed in @ohs that are valid for this chip. Returns 0.
1994 int __init omap_hwmod_register(struct omap_hwmod **ohs)
2003 r = _register(ohs[i]);
2004 WARN(r, "omap_hwmod: %s: _register returned %d\n", ohs[i]->name,
2012 * _populate_mpu_rt_base - populate the virtual address for a hwmod
2014 * Must be called only from omap_hwmod_setup_*() so ioremap works properly.
2015 * Assumes the caller takes care of locking if needed.
2017 static int __init _populate_mpu_rt_base(struct omap_hwmod *oh, void *data)
2019 if (oh->_state != _HWMOD_STATE_REGISTERED)
2022 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2025 oh->_mpu_rt_va = _find_mpu_rt_base(oh, oh->_mpu_port_index);
2031 * omap_hwmod_setup_one - set up a single hwmod
2032 * @oh_name: const char * name of the already-registered hwmod to set up
2034 * Must be called after omap2_clk_init(). Resolves the struct clk
2035 * names to struct clk pointers for each registered omap_hwmod. Also
2036 * calls _setup() on each hwmod. Returns -EINVAL upon error or 0 upon
2039 int __init omap_hwmod_setup_one(const char *oh_name)
2041 struct omap_hwmod *oh;
2044 pr_debug("omap_hwmod: %s: %s\n", oh_name, __func__);
2047 pr_err("omap_hwmod: %s: cannot setup_one: MPU initiator hwmod %s not yet registered\n",
2048 oh_name, MPU_INITIATOR_NAME);
2052 oh = _lookup(oh_name);
2054 WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name);
2058 if (mpu_oh->_state == _HWMOD_STATE_REGISTERED && oh != mpu_oh)
2059 omap_hwmod_setup_one(MPU_INITIATOR_NAME);
2061 r = _populate_mpu_rt_base(oh, NULL);
2062 if (IS_ERR_VALUE(r)) {
2063 WARN(1, "omap_hwmod: %s: couldn't set mpu_rt_base\n", oh_name);
2067 r = _init_clocks(oh, NULL);
2068 if (IS_ERR_VALUE(r)) {
2069 WARN(1, "omap_hwmod: %s: couldn't init clocks\n", oh_name);
2079 * omap_hwmod_setup - do some post-clock framework initialization
2081 * Must be called after omap2_clk_init(). Resolves the struct clk names
2082 * to struct clk pointers for each registered omap_hwmod. Also calls
2083 * _setup() on each hwmod. Returns 0 upon success.
2085 static int __init omap_hwmod_setup_all(void)
2090 pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",
2091 __func__, MPU_INITIATOR_NAME);
2095 r = omap_hwmod_for_each(_populate_mpu_rt_base, NULL);
2097 r = omap_hwmod_for_each(_init_clocks, NULL);
2098 WARN(IS_ERR_VALUE(r),
2099 "omap_hwmod: %s: _init_clocks failed\n", __func__);
2101 omap_hwmod_for_each(_setup, NULL);
2105 core_initcall(omap_hwmod_setup_all);
2108 * omap_hwmod_enable - enable an omap_hwmod
2109 * @oh: struct omap_hwmod *
2111 * Enable an omap_hwmod @oh. Intended to be called by omap_device_enable().
2112 * Returns -EINVAL on error or passes along the return value from _enable().
2114 int omap_hwmod_enable(struct omap_hwmod *oh)
2117 unsigned long flags;
2122 spin_lock_irqsave(&oh->_lock, flags);
2124 spin_unlock_irqrestore(&oh->_lock, flags);
2130 * omap_hwmod_idle - idle an omap_hwmod
2131 * @oh: struct omap_hwmod *
2133 * Idle an omap_hwmod @oh. Intended to be called by omap_device_idle().
2134 * Returns -EINVAL on error or passes along the return value from _idle().
2136 int omap_hwmod_idle(struct omap_hwmod *oh)
2138 unsigned long flags;
2143 spin_lock_irqsave(&oh->_lock, flags);
2145 spin_unlock_irqrestore(&oh->_lock, flags);
2151 * omap_hwmod_shutdown - shutdown an omap_hwmod
2152 * @oh: struct omap_hwmod *
2154 * Shutdown an omap_hwmod @oh. Intended to be called by
2155 * omap_device_shutdown(). Returns -EINVAL on error or passes along
2156 * the return value from _shutdown().
2158 int omap_hwmod_shutdown(struct omap_hwmod *oh)
2160 unsigned long flags;
2165 spin_lock_irqsave(&oh->_lock, flags);
2167 spin_unlock_irqrestore(&oh->_lock, flags);
2173 * omap_hwmod_enable_clocks - enable main_clk, all interface clocks
2174 * @oh: struct omap_hwmod *oh
2176 * Intended to be called by the omap_device code.
2178 int omap_hwmod_enable_clocks(struct omap_hwmod *oh)
2180 unsigned long flags;
2182 spin_lock_irqsave(&oh->_lock, flags);
2184 spin_unlock_irqrestore(&oh->_lock, flags);
2190 * omap_hwmod_disable_clocks - disable main_clk, all interface clocks
2191 * @oh: struct omap_hwmod *oh
2193 * Intended to be called by the omap_device code.
2195 int omap_hwmod_disable_clocks(struct omap_hwmod *oh)
2197 unsigned long flags;
2199 spin_lock_irqsave(&oh->_lock, flags);
2200 _disable_clocks(oh);
2201 spin_unlock_irqrestore(&oh->_lock, flags);
2207 * omap_hwmod_ocp_barrier - wait for posted writes against the hwmod to complete
2208 * @oh: struct omap_hwmod *oh
2210 * Intended to be called by drivers and core code when all posted
2211 * writes to a device must complete before continuing further
2212 * execution (for example, after clearing some device IRQSTATUS
2215 * XXX what about targets with multiple OCP threads?
2217 void omap_hwmod_ocp_barrier(struct omap_hwmod *oh)
2221 if (!oh->class->sysc || !oh->class->sysc->sysc_flags) {
2222 WARN(1, "omap_device: %s: OCP barrier impossible due to "
2223 "device configuration\n", oh->name);
2228 * Forces posted writes to complete on the OCP thread handling
2231 omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
2235 * omap_hwmod_reset - reset the hwmod
2236 * @oh: struct omap_hwmod *
2238 * Under some conditions, a driver may wish to reset the entire device.
2239 * Called from omap_device code. Returns -EINVAL on error or passes along
2240 * the return value from _reset().
2242 int omap_hwmod_reset(struct omap_hwmod *oh)
2245 unsigned long flags;
2250 spin_lock_irqsave(&oh->_lock, flags);
2252 spin_unlock_irqrestore(&oh->_lock, flags);
2258 * omap_hwmod_count_resources - count number of struct resources needed by hwmod
2259 * @oh: struct omap_hwmod *
2260 * @res: pointer to the first element of an array of struct resource to fill
2262 * Count the number of struct resource array elements necessary to
2263 * contain omap_hwmod @oh resources. Intended to be called by code
2264 * that registers omap_devices. Intended to be used to determine the
2265 * size of a dynamically-allocated struct resource array, before
2266 * calling omap_hwmod_fill_resources(). Returns the number of struct
2267 * resource array elements needed.
2269 * XXX This code is not optimized. It could attempt to merge adjacent
2273 int omap_hwmod_count_resources(struct omap_hwmod *oh)
2277 ret = _count_mpu_irqs(oh) + _count_sdma_reqs(oh);
2279 for (i = 0; i < oh->slaves_cnt; i++)
2280 ret += _count_ocp_if_addr_spaces(oh->slaves[i]);
2286 * omap_hwmod_fill_resources - fill struct resource array with hwmod data
2287 * @oh: struct omap_hwmod *
2288 * @res: pointer to the first element of an array of struct resource to fill
2290 * Fill the struct resource array @res with resource data from the
2291 * omap_hwmod @oh. Intended to be called by code that registers
2292 * omap_devices. See also omap_hwmod_count_resources(). Returns the
2293 * number of array elements filled.
2295 int omap_hwmod_fill_resources(struct omap_hwmod *oh, struct resource *res)
2297 int i, j, mpu_irqs_cnt, sdma_reqs_cnt;
2300 /* For each IRQ, DMA, memory area, fill in array.*/
2302 mpu_irqs_cnt = _count_mpu_irqs(oh);
2303 for (i = 0; i < mpu_irqs_cnt; i++) {
2304 (res + r)->name = (oh->mpu_irqs + i)->name;
2305 (res + r)->start = (oh->mpu_irqs + i)->irq;
2306 (res + r)->end = (oh->mpu_irqs + i)->irq;
2307 (res + r)->flags = IORESOURCE_IRQ;
2311 sdma_reqs_cnt = _count_sdma_reqs(oh);
2312 for (i = 0; i < sdma_reqs_cnt; i++) {
2313 (res + r)->name = (oh->sdma_reqs + i)->name;
2314 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
2315 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
2316 (res + r)->flags = IORESOURCE_DMA;
2320 for (i = 0; i < oh->slaves_cnt; i++) {
2321 struct omap_hwmod_ocp_if *os;
2325 addr_cnt = _count_ocp_if_addr_spaces(os);
2327 for (j = 0; j < addr_cnt; j++) {
2328 (res + r)->name = (os->addr + j)->name;
2329 (res + r)->start = (os->addr + j)->pa_start;
2330 (res + r)->end = (os->addr + j)->pa_end;
2331 (res + r)->flags = IORESOURCE_MEM;
2340 * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
2341 * @oh: struct omap_hwmod *
2343 * Return the powerdomain pointer associated with the OMAP module
2344 * @oh's main clock. If @oh does not have a main clk, return the
2345 * powerdomain associated with the interface clock associated with the
2346 * module's MPU port. (XXX Perhaps this should use the SDMA port
2347 * instead?) Returns NULL on error, or a struct powerdomain * on
2350 struct powerdomain *omap_hwmod_get_pwrdm(struct omap_hwmod *oh)
2360 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2362 c = oh->slaves[oh->_mpu_port_index]->_clk;
2368 return c->clkdm->pwrdm.ptr;
2373 * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
2374 * @oh: struct omap_hwmod *
2376 * Returns the virtual address corresponding to the beginning of the
2377 * module's register target, in the address range that is intended to
2378 * be used by the MPU. Returns the virtual address upon success or NULL
2381 void __iomem *omap_hwmod_get_mpu_rt_va(struct omap_hwmod *oh)
2386 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2389 if (oh->_state == _HWMOD_STATE_UNKNOWN)
2392 return oh->_mpu_rt_va;
2396 * omap_hwmod_add_initiator_dep - add sleepdep from @init_oh to @oh
2397 * @oh: struct omap_hwmod *
2398 * @init_oh: struct omap_hwmod * (initiator)
2400 * Add a sleep dependency between the initiator @init_oh and @oh.
2401 * Intended to be called by DSP/Bridge code via platform_data for the
2402 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
2403 * code needs to add/del initiator dependencies dynamically
2404 * before/after accessing a device. Returns the return value from
2405 * _add_initiator_dep().
2407 * XXX Keep a usecount in the clockdomain code
2409 int omap_hwmod_add_initiator_dep(struct omap_hwmod *oh,
2410 struct omap_hwmod *init_oh)
2412 return _add_initiator_dep(oh, init_oh);
2416 * XXX what about functions for drivers to save/restore ocp_sysconfig
2417 * for context save/restore operations?
2421 * omap_hwmod_del_initiator_dep - remove sleepdep from @init_oh to @oh
2422 * @oh: struct omap_hwmod *
2423 * @init_oh: struct omap_hwmod * (initiator)
2425 * Remove a sleep dependency between the initiator @init_oh and @oh.
2426 * Intended to be called by DSP/Bridge code via platform_data for the
2427 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
2428 * code needs to add/del initiator dependencies dynamically
2429 * before/after accessing a device. Returns the return value from
2430 * _del_initiator_dep().
2432 * XXX Keep a usecount in the clockdomain code
2434 int omap_hwmod_del_initiator_dep(struct omap_hwmod *oh,
2435 struct omap_hwmod *init_oh)
2437 return _del_initiator_dep(oh, init_oh);
2441 * omap_hwmod_enable_wakeup - allow device to wake up the system
2442 * @oh: struct omap_hwmod *
2444 * Sets the module OCP socket ENAWAKEUP bit to allow the module to
2445 * send wakeups to the PRCM. Eventually this should sets PRCM wakeup
2446 * registers to cause the PRCM to receive wakeup events from the
2447 * module. Does not set any wakeup routing registers beyond this
2448 * point - if the module is to wake up any other module or subsystem,
2449 * that must be set separately. Called by omap_device code. Returns
2450 * -EINVAL on error or 0 upon success.
2452 int omap_hwmod_enable_wakeup(struct omap_hwmod *oh)
2454 unsigned long flags;
2457 if (!oh->class->sysc ||
2458 !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
2461 spin_lock_irqsave(&oh->_lock, flags);
2462 v = oh->_sysc_cache;
2463 _enable_wakeup(oh, &v);
2464 _write_sysconfig(v, oh);
2465 _set_idle_ioring_wakeup(oh, true);
2466 spin_unlock_irqrestore(&oh->_lock, flags);
2472 * omap_hwmod_disable_wakeup - prevent device from waking the system
2473 * @oh: struct omap_hwmod *
2475 * Clears the module OCP socket ENAWAKEUP bit to prevent the module
2476 * from sending wakeups to the PRCM. Eventually this should clear
2477 * PRCM wakeup registers to cause the PRCM to ignore wakeup events
2478 * from the module. Does not set any wakeup routing registers beyond
2479 * this point - if the module is to wake up any other module or
2480 * subsystem, that must be set separately. Called by omap_device
2481 * code. Returns -EINVAL on error or 0 upon success.
2483 int omap_hwmod_disable_wakeup(struct omap_hwmod *oh)
2485 unsigned long flags;
2488 if (!oh->class->sysc ||
2489 !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
2492 spin_lock_irqsave(&oh->_lock, flags);
2493 v = oh->_sysc_cache;
2494 _disable_wakeup(oh, &v);
2495 _write_sysconfig(v, oh);
2496 _set_idle_ioring_wakeup(oh, false);
2497 spin_unlock_irqrestore(&oh->_lock, flags);
2503 * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
2504 * contained in the hwmod module.
2505 * @oh: struct omap_hwmod *
2506 * @name: name of the reset line to lookup and assert
2508 * Some IP like dsp, ipu or iva contain processor that require
2509 * an HW reset line to be assert / deassert in order to enable fully
2510 * the IP. Returns -EINVAL if @oh is null or if the operation is not
2511 * yet supported on this OMAP; otherwise, passes along the return value
2512 * from _assert_hardreset().
2514 int omap_hwmod_assert_hardreset(struct omap_hwmod *oh, const char *name)
2517 unsigned long flags;
2522 spin_lock_irqsave(&oh->_lock, flags);
2523 ret = _assert_hardreset(oh, name);
2524 spin_unlock_irqrestore(&oh->_lock, flags);
2530 * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
2531 * contained in the hwmod module.
2532 * @oh: struct omap_hwmod *
2533 * @name: name of the reset line to look up and deassert
2535 * Some IP like dsp, ipu or iva contain processor that require
2536 * an HW reset line to be assert / deassert in order to enable fully
2537 * the IP. Returns -EINVAL if @oh is null or if the operation is not
2538 * yet supported on this OMAP; otherwise, passes along the return value
2539 * from _deassert_hardreset().
2541 int omap_hwmod_deassert_hardreset(struct omap_hwmod *oh, const char *name)
2544 unsigned long flags;
2549 spin_lock_irqsave(&oh->_lock, flags);
2550 ret = _deassert_hardreset(oh, name);
2551 spin_unlock_irqrestore(&oh->_lock, flags);
2557 * omap_hwmod_read_hardreset - read the HW reset line state of submodules
2558 * contained in the hwmod module
2559 * @oh: struct omap_hwmod *
2560 * @name: name of the reset line to look up and read
2562 * Return the current state of the hwmod @oh's reset line named @name:
2563 * returns -EINVAL upon parameter error or if this operation
2564 * is unsupported on the current OMAP; otherwise, passes along the return
2565 * value from _read_hardreset().
2567 int omap_hwmod_read_hardreset(struct omap_hwmod *oh, const char *name)
2570 unsigned long flags;
2575 spin_lock_irqsave(&oh->_lock, flags);
2576 ret = _read_hardreset(oh, name);
2577 spin_unlock_irqrestore(&oh->_lock, flags);
2584 * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
2585 * @classname: struct omap_hwmod_class name to search for
2586 * @fn: callback function pointer to call for each hwmod in class @classname
2587 * @user: arbitrary context data to pass to the callback function
2589 * For each omap_hwmod of class @classname, call @fn.
2590 * If the callback function returns something other than
2591 * zero, the iterator is terminated, and the callback function's return
2592 * value is passed back to the caller. Returns 0 upon success, -EINVAL
2593 * if @classname or @fn are NULL, or passes back the error code from @fn.
2595 int omap_hwmod_for_each_by_class(const char *classname,
2596 int (*fn)(struct omap_hwmod *oh,
2600 struct omap_hwmod *temp_oh;
2603 if (!classname || !fn)
2606 pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
2607 __func__, classname);
2609 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
2610 if (!strcmp(temp_oh->class->name, classname)) {
2611 pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
2612 __func__, temp_oh->name);
2613 ret = (*fn)(temp_oh, user);
2620 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
2627 * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
2628 * @oh: struct omap_hwmod *
2629 * @state: state that _setup() should leave the hwmod in
2631 * Sets the hwmod state that @oh will enter at the end of _setup()
2632 * (called by omap_hwmod_setup_*()). Only valid to call between
2633 * calling omap_hwmod_register() and omap_hwmod_setup_*(). Returns
2634 * 0 upon success or -EINVAL if there is a problem with the arguments
2635 * or if the hwmod is in the wrong state.
2637 int omap_hwmod_set_postsetup_state(struct omap_hwmod *oh, u8 state)
2640 unsigned long flags;
2645 if (state != _HWMOD_STATE_DISABLED &&
2646 state != _HWMOD_STATE_ENABLED &&
2647 state != _HWMOD_STATE_IDLE)
2650 spin_lock_irqsave(&oh->_lock, flags);
2652 if (oh->_state != _HWMOD_STATE_REGISTERED) {
2657 oh->_postsetup_state = state;
2661 spin_unlock_irqrestore(&oh->_lock, flags);
2667 * omap_hwmod_get_context_loss_count - get lost context count
2668 * @oh: struct omap_hwmod *
2670 * Query the powerdomain of of @oh to get the context loss
2671 * count for this device.
2673 * Returns the context loss count of the powerdomain assocated with @oh
2674 * upon success, or zero if no powerdomain exists for @oh.
2676 int omap_hwmod_get_context_loss_count(struct omap_hwmod *oh)
2678 struct powerdomain *pwrdm;
2681 pwrdm = omap_hwmod_get_pwrdm(oh);
2683 ret = pwrdm_get_context_loss_count(pwrdm);
2689 * omap_hwmod_no_setup_reset - prevent a hwmod from being reset upon setup
2690 * @oh: struct omap_hwmod *
2692 * Prevent the hwmod @oh from being reset during the setup process.
2693 * Intended for use by board-*.c files on boards with devices that
2694 * cannot tolerate being reset. Must be called before the hwmod has
2695 * been set up. Returns 0 upon success or negative error code upon
2698 int omap_hwmod_no_setup_reset(struct omap_hwmod *oh)
2703 if (oh->_state != _HWMOD_STATE_REGISTERED) {
2704 pr_err("omap_hwmod: %s: cannot prevent setup reset; in wrong state\n",
2709 oh->flags |= HWMOD_INIT_NO_RESET;
2715 * omap_hwmod_pad_route_irq - route an I/O pad wakeup to a particular MPU IRQ
2716 * @oh: struct omap_hwmod * containing hwmod mux entries
2717 * @pad_idx: array index in oh->mux of the hwmod mux entry to route wakeup
2718 * @irq_idx: the hwmod mpu_irqs array index of the IRQ to trigger on wakeup
2720 * When an I/O pad wakeup arrives for the dynamic or wakeup hwmod mux
2721 * entry number @pad_idx for the hwmod @oh, trigger the interrupt
2722 * service routine for the hwmod's mpu_irqs array index @irq_idx. If
2723 * this function is not called for a given pad_idx, then the ISR
2724 * associated with @oh's first MPU IRQ will be triggered when an I/O
2725 * pad wakeup occurs on that pad. Note that @pad_idx is the index of
2726 * the _dynamic or wakeup_ entry: if there are other entries not
2727 * marked with OMAP_DEVICE_PAD_WAKEUP or OMAP_DEVICE_PAD_REMUX, these
2728 * entries are NOT COUNTED in the dynamic pad index. This function
2729 * must be called separately for each pad that requires its interrupt
2730 * to be re-routed this way. Returns -EINVAL if there is an argument
2731 * problem or if @oh does not have hwmod mux entries or MPU IRQs;
2732 * returns -ENOMEM if memory cannot be allocated; or 0 upon success.
2734 * XXX This function interface is fragile. Rather than using array
2735 * indexes, which are subject to unpredictable change, it should be
2736 * using hwmod IRQ names, and some other stable key for the hwmod mux
2739 int omap_hwmod_pad_route_irq(struct omap_hwmod *oh, int pad_idx, int irq_idx)
2745 if (!oh || !oh->mux || !oh->mpu_irqs || pad_idx < 0 ||
2746 pad_idx >= oh->mux->nr_pads_dynamic)
2749 /* Check the number of available mpu_irqs */
2750 for (nr_irqs = 0; oh->mpu_irqs[nr_irqs].irq >= 0; nr_irqs++)
2753 if (irq_idx >= nr_irqs)
2756 if (!oh->mux->irqs) {
2757 /* XXX What frees this? */
2758 oh->mux->irqs = kzalloc(sizeof(int) * oh->mux->nr_pads_dynamic,
2763 oh->mux->irqs[pad_idx] = irq_idx;