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 * _wait_softreset_complete - wait for an OCP softreset to complete
378 * @oh: struct omap_hwmod * to wait on
380 * Wait until the IP block represented by @oh reports that its OCP
381 * softreset is complete. This can be triggered by software (see
382 * _ocp_softreset()) or by hardware upon returning from off-mode (one
383 * example is HSMMC). Waits for up to MAX_MODULE_SOFTRESET_WAIT
384 * microseconds. Returns the number of microseconds waited.
386 static int _wait_softreset_complete(struct omap_hwmod *oh)
388 struct omap_hwmod_class_sysconfig *sysc;
392 sysc = oh->class->sysc;
394 if (sysc->sysc_flags & SYSS_HAS_RESET_STATUS)
395 omap_test_timeout((omap_hwmod_read(oh, sysc->syss_offs)
396 & SYSS_RESETDONE_MASK),
397 MAX_MODULE_SOFTRESET_WAIT, c);
398 else if (sysc->sysc_flags & SYSC_HAS_RESET_STATUS) {
399 softrst_mask = (0x1 << sysc->sysc_fields->srst_shift);
400 omap_test_timeout(!(omap_hwmod_read(oh, sysc->sysc_offs)
402 MAX_MODULE_SOFTRESET_WAIT, c);
409 * _set_module_autoidle: set the OCP_SYSCONFIG AUTOIDLE field in @v
410 * @oh: struct omap_hwmod *
411 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
412 * @v: pointer to register contents to modify
414 * Update the module autoidle bit in @v to be @autoidle for the @oh
415 * hwmod. The autoidle bit controls whether the module can gate
416 * internal clocks automatically when it isn't doing anything; the
417 * exact function of this bit varies on a per-module basis. This
418 * function does not write to the hardware. Returns -EINVAL upon
419 * error or 0 upon success.
421 static int _set_module_autoidle(struct omap_hwmod *oh, u8 autoidle,
427 if (!oh->class->sysc ||
428 !(oh->class->sysc->sysc_flags & SYSC_HAS_AUTOIDLE))
431 if (!oh->class->sysc->sysc_fields) {
432 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
436 autoidle_shift = oh->class->sysc->sysc_fields->autoidle_shift;
437 autoidle_mask = (0x1 << autoidle_shift);
439 *v &= ~autoidle_mask;
440 *v |= autoidle << autoidle_shift;
446 * _enable_wakeup: set OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
447 * @oh: struct omap_hwmod *
449 * Allow the hardware module @oh to send wakeups. Returns -EINVAL
450 * upon error or 0 upon success.
452 static int _enable_wakeup(struct omap_hwmod *oh, u32 *v)
454 if (!oh->class->sysc ||
455 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
456 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
457 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
460 if (!oh->class->sysc->sysc_fields) {
461 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
465 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
466 *v |= 0x1 << oh->class->sysc->sysc_fields->enwkup_shift;
468 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
469 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
470 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
471 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
473 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
475 oh->_int_flags |= _HWMOD_WAKEUP_ENABLED;
481 * _disable_wakeup: clear OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
482 * @oh: struct omap_hwmod *
484 * Prevent the hardware module @oh to send wakeups. Returns -EINVAL
485 * upon error or 0 upon success.
487 static int _disable_wakeup(struct omap_hwmod *oh, u32 *v)
489 if (!oh->class->sysc ||
490 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
491 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
492 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
495 if (!oh->class->sysc->sysc_fields) {
496 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
500 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
501 *v &= ~(0x1 << oh->class->sysc->sysc_fields->enwkup_shift);
503 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
504 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART, v);
505 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
506 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
508 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
510 oh->_int_flags &= ~_HWMOD_WAKEUP_ENABLED;
516 * _add_initiator_dep: prevent @oh from smart-idling while @init_oh is active
517 * @oh: struct omap_hwmod *
519 * Prevent the hardware module @oh from entering idle while the
520 * hardare module initiator @init_oh is active. Useful when a module
521 * will be accessed by a particular initiator (e.g., if a module will
522 * be accessed by the IVA, there should be a sleepdep between the IVA
523 * initiator and the module). Only applies to modules in smart-idle
524 * mode. If the clockdomain is marked as not needing autodeps, return
525 * 0 without doing anything. Otherwise, returns -EINVAL upon error or
526 * passes along clkdm_add_sleepdep() value upon success.
528 static int _add_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
533 if (oh->_clk->clkdm && oh->_clk->clkdm->flags & CLKDM_NO_AUTODEPS)
536 return clkdm_add_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
540 * _del_initiator_dep: allow @oh to smart-idle even if @init_oh is active
541 * @oh: struct omap_hwmod *
543 * Allow the hardware module @oh to enter idle while the hardare
544 * module initiator @init_oh is active. Useful when a module will not
545 * be accessed by a particular initiator (e.g., if a module will not
546 * be accessed by the IVA, there should be no sleepdep between the IVA
547 * initiator and the module). Only applies to modules in smart-idle
548 * mode. If the clockdomain is marked as not needing autodeps, return
549 * 0 without doing anything. Returns -EINVAL upon error or passes
550 * along clkdm_del_sleepdep() value upon success.
552 static int _del_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
557 if (oh->_clk->clkdm && oh->_clk->clkdm->flags & CLKDM_NO_AUTODEPS)
560 return clkdm_del_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
564 * _init_main_clk - get a struct clk * for the the hwmod's main functional clk
565 * @oh: struct omap_hwmod *
567 * Called from _init_clocks(). Populates the @oh _clk (main
568 * functional clock pointer) if a main_clk is present. Returns 0 on
569 * success or -EINVAL on error.
571 static int _init_main_clk(struct omap_hwmod *oh)
578 oh->_clk = omap_clk_get_by_name(oh->main_clk);
580 pr_warning("omap_hwmod: %s: cannot clk_get main_clk %s\n",
581 oh->name, oh->main_clk);
585 if (!oh->_clk->clkdm)
586 pr_warning("omap_hwmod: %s: missing clockdomain for %s.\n",
587 oh->main_clk, oh->_clk->name);
593 * _init_interface_clks - get a struct clk * for the the hwmod's interface clks
594 * @oh: struct omap_hwmod *
596 * Called from _init_clocks(). Populates the @oh OCP slave interface
597 * clock pointers. Returns 0 on success or -EINVAL on error.
599 static int _init_interface_clks(struct omap_hwmod *oh)
605 if (oh->slaves_cnt == 0)
608 for (i = 0; i < oh->slaves_cnt; i++) {
609 struct omap_hwmod_ocp_if *os = oh->slaves[i];
614 c = omap_clk_get_by_name(os->clk);
616 pr_warning("omap_hwmod: %s: cannot clk_get interface_clk %s\n",
627 * _init_opt_clk - get a struct clk * for the the hwmod's optional clocks
628 * @oh: struct omap_hwmod *
630 * Called from _init_clocks(). Populates the @oh omap_hwmod_opt_clk
631 * clock pointers. Returns 0 on success or -EINVAL on error.
633 static int _init_opt_clks(struct omap_hwmod *oh)
635 struct omap_hwmod_opt_clk *oc;
640 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++) {
641 c = omap_clk_get_by_name(oc->clk);
643 pr_warning("omap_hwmod: %s: cannot clk_get opt_clk %s\n",
654 * _enable_clocks - enable hwmod main clock and interface clocks
655 * @oh: struct omap_hwmod *
657 * Enables all clocks necessary for register reads and writes to succeed
658 * on the hwmod @oh. Returns 0.
660 static int _enable_clocks(struct omap_hwmod *oh)
664 pr_debug("omap_hwmod: %s: enabling clocks\n", oh->name);
667 clk_enable(oh->_clk);
669 if (oh->slaves_cnt > 0) {
670 for (i = 0; i < oh->slaves_cnt; i++) {
671 struct omap_hwmod_ocp_if *os = oh->slaves[i];
672 struct clk *c = os->_clk;
674 if (c && (os->flags & OCPIF_SWSUP_IDLE))
679 /* The opt clocks are controlled by the device driver. */
685 * _disable_clocks - disable hwmod main clock and interface clocks
686 * @oh: struct omap_hwmod *
688 * Disables the hwmod @oh main functional and interface clocks. Returns 0.
690 static int _disable_clocks(struct omap_hwmod *oh)
694 pr_debug("omap_hwmod: %s: disabling clocks\n", oh->name);
697 clk_disable(oh->_clk);
699 if (oh->slaves_cnt > 0) {
700 for (i = 0; i < oh->slaves_cnt; i++) {
701 struct omap_hwmod_ocp_if *os = oh->slaves[i];
702 struct clk *c = os->_clk;
704 if (c && (os->flags & OCPIF_SWSUP_IDLE))
709 /* The opt clocks are controlled by the device driver. */
714 static void _enable_optional_clocks(struct omap_hwmod *oh)
716 struct omap_hwmod_opt_clk *oc;
719 pr_debug("omap_hwmod: %s: enabling optional clocks\n", oh->name);
721 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
723 pr_debug("omap_hwmod: enable %s:%s\n", oc->role,
725 clk_enable(oc->_clk);
729 static void _disable_optional_clocks(struct omap_hwmod *oh)
731 struct omap_hwmod_opt_clk *oc;
734 pr_debug("omap_hwmod: %s: disabling optional clocks\n", oh->name);
736 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
738 pr_debug("omap_hwmod: disable %s:%s\n", oc->role,
740 clk_disable(oc->_clk);
745 * _enable_module - enable CLKCTRL modulemode on OMAP4
746 * @oh: struct omap_hwmod *
748 * Enables the PRCM module mode related to the hwmod @oh.
751 static void _enable_module(struct omap_hwmod *oh)
753 /* The module mode does not exist prior OMAP4 */
754 if (cpu_is_omap24xx() || cpu_is_omap34xx())
757 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
760 pr_debug("omap_hwmod: %s: _enable_module: %d\n",
761 oh->name, oh->prcm.omap4.modulemode);
763 omap4_cminst_module_enable(oh->prcm.omap4.modulemode,
764 oh->clkdm->prcm_partition,
766 oh->clkdm->clkdm_offs,
767 oh->prcm.omap4.clkctrl_offs);
771 * _disable_module - enable CLKCTRL modulemode on OMAP4
772 * @oh: struct omap_hwmod *
774 * Disable the PRCM module mode related to the hwmod @oh.
777 static void _disable_module(struct omap_hwmod *oh)
779 /* The module mode does not exist prior OMAP4 */
780 if (cpu_is_omap24xx() || cpu_is_omap34xx())
783 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
786 pr_debug("omap_hwmod: %s: _disable_module\n", oh->name);
788 omap4_cminst_module_disable(oh->clkdm->prcm_partition,
790 oh->clkdm->clkdm_offs,
791 oh->prcm.omap4.clkctrl_offs);
795 * _count_mpu_irqs - count the number of MPU IRQ lines associated with @oh
796 * @oh: struct omap_hwmod *oh
798 * Count and return the number of MPU IRQs associated with the hwmod
799 * @oh. Used to allocate struct resource data. Returns 0 if @oh is
802 static int _count_mpu_irqs(struct omap_hwmod *oh)
804 struct omap_hwmod_irq_info *ohii;
807 if (!oh || !oh->mpu_irqs)
811 ohii = &oh->mpu_irqs[i++];
812 } while (ohii->irq != -1);
818 * _count_sdma_reqs - count the number of SDMA request lines associated with @oh
819 * @oh: struct omap_hwmod *oh
821 * Count and return the number of SDMA request lines associated with
822 * the hwmod @oh. Used to allocate struct resource data. Returns 0
825 static int _count_sdma_reqs(struct omap_hwmod *oh)
827 struct omap_hwmod_dma_info *ohdi;
830 if (!oh || !oh->sdma_reqs)
834 ohdi = &oh->sdma_reqs[i++];
835 } while (ohdi->dma_req != -1);
841 * _count_ocp_if_addr_spaces - count the number of address space entries for @oh
842 * @oh: struct omap_hwmod *oh
844 * Count and return the number of address space ranges associated with
845 * the hwmod @oh. Used to allocate struct resource data. Returns 0
848 static int _count_ocp_if_addr_spaces(struct omap_hwmod_ocp_if *os)
850 struct omap_hwmod_addr_space *mem;
853 if (!os || !os->addr)
857 mem = &os->addr[i++];
858 } while (mem->pa_start != mem->pa_end);
864 * _find_mpu_port_index - find hwmod OCP slave port ID intended for MPU use
865 * @oh: struct omap_hwmod *
867 * Returns the array index of the OCP slave port that the MPU
868 * addresses the device on, or -EINVAL upon error or not found.
870 static int __init _find_mpu_port_index(struct omap_hwmod *oh)
875 if (!oh || oh->slaves_cnt == 0)
878 for (i = 0; i < oh->slaves_cnt; i++) {
879 struct omap_hwmod_ocp_if *os = oh->slaves[i];
881 if (os->user & OCP_USER_MPU) {
888 pr_debug("omap_hwmod: %s: MPU OCP slave port ID %d\n",
891 pr_debug("omap_hwmod: %s: no MPU OCP slave port found\n",
894 return (found) ? i : -EINVAL;
898 * _find_mpu_rt_base - find hwmod register target base addr accessible by MPU
899 * @oh: struct omap_hwmod *
901 * Return the virtual address of the base of the register target of
902 * device @oh, or NULL on error.
904 static void __iomem * __init _find_mpu_rt_base(struct omap_hwmod *oh, u8 index)
906 struct omap_hwmod_ocp_if *os;
907 struct omap_hwmod_addr_space *mem;
908 int i = 0, found = 0;
909 void __iomem *va_start;
911 if (!oh || oh->slaves_cnt == 0)
914 os = oh->slaves[index];
920 mem = &os->addr[i++];
921 if (mem->flags & ADDR_TYPE_RT)
923 } while (!found && mem->pa_start != mem->pa_end);
926 va_start = ioremap(mem->pa_start, mem->pa_end - mem->pa_start);
928 pr_err("omap_hwmod: %s: Could not ioremap\n", oh->name);
931 pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
934 pr_debug("omap_hwmod: %s: no MPU register target found\n",
938 return (found) ? va_start : NULL;
942 * _enable_sysc - try to bring a module out of idle via OCP_SYSCONFIG
943 * @oh: struct omap_hwmod *
945 * Ensure that the OCP_SYSCONFIG register for the IP block represented
946 * by @oh is set to indicate to the PRCM that the IP block is active.
947 * Usually this means placing the module into smart-idle mode and
948 * smart-standby, but if there is a bug in the automatic idle handling
949 * for the IP block, it may need to be placed into the force-idle or
950 * no-idle variants of these modes. No return value.
952 static void _enable_sysc(struct omap_hwmod *oh)
958 if (!oh->class->sysc)
961 #if 0 /* causes data abort on venc on 3.2 */
963 * Wait until reset has completed, this is needed as the IP
964 * block is reset automatically by hardware in some cases
965 * (off-mode for example), and the drivers require the
966 * IP to be ready when they access it
968 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
969 _enable_optional_clocks(oh);
970 _wait_softreset_complete(oh);
971 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
972 _disable_optional_clocks(oh);
976 sf = oh->class->sysc->sysc_flags;
978 if (sf & SYSC_HAS_SIDLEMODE) {
979 if (oh->flags & HWMOD_SWSUP_SIDLE) {
980 idlemode = HWMOD_IDLEMODE_NO;
982 if (sf & SYSC_HAS_ENAWAKEUP)
983 _enable_wakeup(oh, &v);
984 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
985 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
987 idlemode = HWMOD_IDLEMODE_SMART;
991 * This is special handling for some IPs like
992 * 32k sync timer. Force them to idle!
994 clkdm_act = ((oh->clkdm &&
995 oh->clkdm->flags & CLKDM_ACTIVE_WITH_MPU) ||
996 (oh->_clk && oh->_clk->clkdm &&
997 oh->_clk->clkdm->flags & CLKDM_ACTIVE_WITH_MPU));
998 if (clkdm_act && !(oh->class->sysc->idlemodes &
999 (SIDLE_SMART | SIDLE_SMART_WKUP)))
1000 idlemode = HWMOD_IDLEMODE_FORCE;
1002 _set_slave_idlemode(oh, idlemode, &v);
1005 if (sf & SYSC_HAS_MIDLEMODE) {
1006 if (oh->flags & HWMOD_FORCE_MSTANDBY) {
1007 idlemode = HWMOD_IDLEMODE_FORCE;
1008 } else if (oh->flags & HWMOD_SWSUP_MSTANDBY) {
1009 idlemode = HWMOD_IDLEMODE_NO;
1011 if (sf & SYSC_HAS_ENAWAKEUP)
1012 _enable_wakeup(oh, &v);
1013 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1014 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1016 idlemode = HWMOD_IDLEMODE_SMART;
1018 _set_master_standbymode(oh, idlemode, &v);
1022 * XXX The clock framework should handle this, by
1023 * calling into this code. But this must wait until the
1024 * clock structures are tagged with omap_hwmod entries
1026 if ((oh->flags & HWMOD_SET_DEFAULT_CLOCKACT) &&
1027 (sf & SYSC_HAS_CLOCKACTIVITY))
1028 _set_clockactivity(oh, oh->class->sysc->clockact, &v);
1030 /* If the cached value is the same as the new value, skip the write */
1031 if (oh->_sysc_cache != v)
1032 _write_sysconfig(v, oh);
1035 * Set the autoidle bit only after setting the smartidle bit
1036 * Setting this will not have any impact on the other modules.
1038 if (sf & SYSC_HAS_AUTOIDLE) {
1039 idlemode = (oh->flags & HWMOD_NO_OCP_AUTOIDLE) ?
1041 _set_module_autoidle(oh, idlemode, &v);
1042 _write_sysconfig(v, oh);
1047 * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
1048 * @oh: struct omap_hwmod *
1050 * If module is marked as SWSUP_SIDLE, force the module into slave
1051 * idle; otherwise, configure it for smart-idle. If module is marked
1052 * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
1053 * configure it for smart-standby. No return value.
1055 static void _idle_sysc(struct omap_hwmod *oh)
1060 if (!oh->class->sysc)
1063 v = oh->_sysc_cache;
1064 sf = oh->class->sysc->sysc_flags;
1066 if (sf & SYSC_HAS_SIDLEMODE) {
1067 if (oh->flags & HWMOD_SWSUP_SIDLE) {
1068 idlemode = HWMOD_IDLEMODE_FORCE;
1070 if (sf & SYSC_HAS_ENAWAKEUP)
1071 _enable_wakeup(oh, &v);
1072 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
1073 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1075 idlemode = HWMOD_IDLEMODE_SMART;
1077 _set_slave_idlemode(oh, idlemode, &v);
1080 if (sf & SYSC_HAS_MIDLEMODE) {
1081 if ((oh->flags & HWMOD_SWSUP_MSTANDBY) ||
1082 (oh->flags & HWMOD_FORCE_MSTANDBY)) {
1083 idlemode = HWMOD_IDLEMODE_FORCE;
1085 if (sf & SYSC_HAS_ENAWAKEUP)
1086 _enable_wakeup(oh, &v);
1087 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1088 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1090 idlemode = HWMOD_IDLEMODE_SMART;
1092 _set_master_standbymode(oh, idlemode, &v);
1095 _write_sysconfig(v, oh);
1099 * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
1100 * @oh: struct omap_hwmod *
1102 * Force the module into slave idle and master suspend. No return
1105 static void _shutdown_sysc(struct omap_hwmod *oh)
1110 if (!oh->class->sysc)
1113 v = oh->_sysc_cache;
1114 sf = oh->class->sysc->sysc_flags;
1116 if (sf & SYSC_HAS_SIDLEMODE)
1117 _set_slave_idlemode(oh, HWMOD_IDLEMODE_FORCE, &v);
1119 if (sf & SYSC_HAS_MIDLEMODE)
1120 _set_master_standbymode(oh, HWMOD_IDLEMODE_FORCE, &v);
1122 if (sf & SYSC_HAS_AUTOIDLE)
1123 _set_module_autoidle(oh, 1, &v);
1125 _write_sysconfig(v, oh);
1129 * _lookup - find an omap_hwmod by name
1130 * @name: find an omap_hwmod by name
1132 * Return a pointer to an omap_hwmod by name, or NULL if not found.
1134 static struct omap_hwmod *_lookup(const char *name)
1136 struct omap_hwmod *oh, *temp_oh;
1140 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1141 if (!strcmp(name, temp_oh->name)) {
1150 * _init_clkdm - look up a clockdomain name, store pointer in omap_hwmod
1151 * @oh: struct omap_hwmod *
1153 * Convert a clockdomain name stored in a struct omap_hwmod into a
1154 * clockdomain pointer, and save it into the struct omap_hwmod.
1155 * return -EINVAL if clkdm_name does not exist or if the lookup failed.
1157 static int _init_clkdm(struct omap_hwmod *oh)
1159 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1162 if (!oh->clkdm_name) {
1163 pr_warning("omap_hwmod: %s: no clkdm_name\n", oh->name);
1167 oh->clkdm = clkdm_lookup(oh->clkdm_name);
1169 pr_warning("omap_hwmod: %s: could not associate to clkdm %s\n",
1170 oh->name, oh->clkdm_name);
1174 pr_debug("omap_hwmod: %s: associated to clkdm %s\n",
1175 oh->name, oh->clkdm_name);
1181 * _init_clocks - clk_get() all clocks associated with this hwmod. Retrieve as
1182 * well the clockdomain.
1183 * @oh: struct omap_hwmod *
1184 * @data: not used; pass NULL
1186 * Called by omap_hwmod_setup_*() (after omap2_clk_init()).
1187 * Resolves all clock names embedded in the hwmod. Returns 0 on
1188 * success, or a negative error code on failure.
1190 static int _init_clocks(struct omap_hwmod *oh, void *data)
1194 if (oh->_state != _HWMOD_STATE_REGISTERED)
1197 pr_debug("omap_hwmod: %s: looking up clocks\n", oh->name);
1199 ret |= _init_main_clk(oh);
1200 ret |= _init_interface_clks(oh);
1201 ret |= _init_opt_clks(oh);
1202 ret |= _init_clkdm(oh);
1205 oh->_state = _HWMOD_STATE_CLKS_INITED;
1207 pr_warning("omap_hwmod: %s: cannot _init_clocks\n", oh->name);
1213 * _wait_target_ready - wait for a module to leave slave idle
1214 * @oh: struct omap_hwmod *
1216 * Wait for a module @oh to leave slave idle. Returns 0 if the module
1217 * does not have an IDLEST bit or if the module successfully leaves
1218 * slave idle; otherwise, pass along the return value of the
1219 * appropriate *_cm*_wait_module_ready() function.
1221 static int _wait_target_ready(struct omap_hwmod *oh)
1223 struct omap_hwmod_ocp_if *os;
1229 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
1232 os = oh->slaves[oh->_mpu_port_index];
1234 if (oh->flags & HWMOD_NO_IDLEST)
1237 /* XXX check module SIDLEMODE */
1239 /* XXX check clock enable states */
1241 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1242 ret = omap2_cm_wait_module_ready(oh->prcm.omap2.module_offs,
1243 oh->prcm.omap2.idlest_reg_id,
1244 oh->prcm.omap2.idlest_idle_bit);
1245 } else if (cpu_is_omap44xx()) {
1249 ret = omap4_cminst_wait_module_ready(oh->clkdm->prcm_partition,
1251 oh->clkdm->clkdm_offs,
1252 oh->prcm.omap4.clkctrl_offs);
1261 * _wait_target_disable - wait for a module to be disabled
1262 * @oh: struct omap_hwmod *
1264 * Wait for a module @oh to enter slave idle. Returns 0 if the module
1265 * does not have an IDLEST bit or if the module successfully enters
1266 * slave idle; otherwise, pass along the return value of the
1267 * appropriate *_cm*_wait_module_idle() function.
1269 static int _wait_target_disable(struct omap_hwmod *oh)
1271 /* TODO: For now just handle OMAP4+ */
1272 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1278 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
1281 if (oh->flags & HWMOD_NO_IDLEST)
1284 return omap4_cminst_wait_module_idle(oh->clkdm->prcm_partition,
1286 oh->clkdm->clkdm_offs,
1287 oh->prcm.omap4.clkctrl_offs);
1291 * _lookup_hardreset - fill register bit info for this hwmod/reset line
1292 * @oh: struct omap_hwmod *
1293 * @name: name of the reset line in the context of this hwmod
1294 * @ohri: struct omap_hwmod_rst_info * that this function will fill in
1296 * Return the bit position of the reset line that match the
1297 * input name. Return -ENOENT if not found.
1299 static u8 _lookup_hardreset(struct omap_hwmod *oh, const char *name,
1300 struct omap_hwmod_rst_info *ohri)
1304 for (i = 0; i < oh->rst_lines_cnt; i++) {
1305 const char *rst_line = oh->rst_lines[i].name;
1306 if (!strcmp(rst_line, name)) {
1307 ohri->rst_shift = oh->rst_lines[i].rst_shift;
1308 ohri->st_shift = oh->rst_lines[i].st_shift;
1309 pr_debug("omap_hwmod: %s: %s: %s: rst %d st %d\n",
1310 oh->name, __func__, rst_line, ohri->rst_shift,
1321 * _assert_hardreset - assert the HW reset line of submodules
1322 * contained in the hwmod module.
1323 * @oh: struct omap_hwmod *
1324 * @name: name of the reset line to lookup and assert
1326 * Some IP like dsp, ipu or iva contain processor that require
1327 * an HW reset line to be assert / deassert in order to enable fully
1330 static int _assert_hardreset(struct omap_hwmod *oh, const char *name)
1332 struct omap_hwmod_rst_info ohri;
1338 ret = _lookup_hardreset(oh, name, &ohri);
1339 if (IS_ERR_VALUE(ret))
1342 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1343 return omap2_prm_assert_hardreset(oh->prcm.omap2.module_offs,
1345 else if (cpu_is_omap44xx())
1346 return omap4_prminst_assert_hardreset(ohri.rst_shift,
1347 oh->clkdm->pwrdm.ptr->prcm_partition,
1348 oh->clkdm->pwrdm.ptr->prcm_offs,
1349 oh->prcm.omap4.rstctrl_offs);
1355 * _deassert_hardreset - deassert the HW reset line of submodules contained
1356 * in the hwmod module.
1357 * @oh: struct omap_hwmod *
1358 * @name: name of the reset line to look up and deassert
1360 * Some IP like dsp, ipu or iva contain processor that require
1361 * an HW reset line to be assert / deassert in order to enable fully
1364 static int _deassert_hardreset(struct omap_hwmod *oh, const char *name)
1366 struct omap_hwmod_rst_info ohri;
1372 ret = _lookup_hardreset(oh, name, &ohri);
1373 if (IS_ERR_VALUE(ret))
1376 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1377 ret = omap2_prm_deassert_hardreset(oh->prcm.omap2.module_offs,
1380 } else if (cpu_is_omap44xx()) {
1382 pr_err("omap_hwmod: %s: %s: hwmod data error: OMAP4 does not support st_shift\n",
1384 ret = omap4_prminst_deassert_hardreset(ohri.rst_shift,
1385 oh->clkdm->pwrdm.ptr->prcm_partition,
1386 oh->clkdm->pwrdm.ptr->prcm_offs,
1387 oh->prcm.omap4.rstctrl_offs);
1393 pr_warning("omap_hwmod: %s: failed to hardreset\n", oh->name);
1399 * _read_hardreset - read the HW reset line state of submodules
1400 * contained in the hwmod module
1401 * @oh: struct omap_hwmod *
1402 * @name: name of the reset line to look up and read
1404 * Return the state of the reset line.
1406 static int _read_hardreset(struct omap_hwmod *oh, const char *name)
1408 struct omap_hwmod_rst_info ohri;
1414 ret = _lookup_hardreset(oh, name, &ohri);
1415 if (IS_ERR_VALUE(ret))
1418 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1419 return omap2_prm_is_hardreset_asserted(oh->prcm.omap2.module_offs,
1421 } else if (cpu_is_omap44xx()) {
1422 return omap4_prminst_is_hardreset_asserted(ohri.rst_shift,
1423 oh->clkdm->pwrdm.ptr->prcm_partition,
1424 oh->clkdm->pwrdm.ptr->prcm_offs,
1425 oh->prcm.omap4.rstctrl_offs);
1432 * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1433 * @oh: struct omap_hwmod *
1435 * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit. hwmod must be
1436 * enabled for this to work. Returns -EINVAL if the hwmod cannot be
1437 * reset this way or if the hwmod is in the wrong state, -ETIMEDOUT if
1438 * the module did not reset in time, or 0 upon success.
1440 * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1441 * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1442 * use the SYSCONFIG softreset bit to provide the status.
1444 * Note that some IP like McBSP do have reset control but don't have
1447 static int _ocp_softreset(struct omap_hwmod *oh)
1453 if (!oh->class->sysc ||
1454 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
1457 /* clocks must be on for this operation */
1458 if (oh->_state != _HWMOD_STATE_ENABLED) {
1459 pr_warning("omap_hwmod: %s: reset can only be entered from "
1460 "enabled state\n", oh->name);
1464 /* For some modules, all optionnal clocks need to be enabled as well */
1465 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1466 _enable_optional_clocks(oh);
1468 pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh->name);
1470 v = oh->_sysc_cache;
1471 ret = _set_softreset(oh, &v);
1475 _write_sysconfig(v, oh);
1477 c = _wait_softreset_complete(oh);
1478 if (c == MAX_MODULE_SOFTRESET_WAIT) {
1479 pr_warning("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1480 oh->name, MAX_MODULE_SOFTRESET_WAIT);
1484 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh->name, c);
1487 ret = _clear_softreset(oh, &v);
1491 _write_sysconfig(v, oh);
1494 * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1495 * _wait_target_ready() or _reset()
1499 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1500 _disable_optional_clocks(oh);
1506 * _reset - reset an omap_hwmod
1507 * @oh: struct omap_hwmod *
1509 * Resets an omap_hwmod @oh. The default software reset mechanism for
1510 * most OMAP IP blocks is triggered via the OCP_SYSCONFIG.SOFTRESET
1511 * bit. However, some hwmods cannot be reset via this method: some
1512 * are not targets and therefore have no OCP header registers to
1513 * access; others (like the IVA) have idiosyncratic reset sequences.
1514 * So for these relatively rare cases, custom reset code can be
1515 * supplied in the struct omap_hwmod_class .reset function pointer.
1516 * Passes along the return value from either _reset() or the custom
1517 * reset function - these must return -EINVAL if the hwmod cannot be
1518 * reset this way or if the hwmod is in the wrong state, -ETIMEDOUT if
1519 * the module did not reset in time, or 0 upon success.
1521 static int _reset(struct omap_hwmod *oh)
1525 pr_debug("omap_hwmod: %s: resetting\n", oh->name);
1527 ret = (oh->class->reset) ? oh->class->reset(oh) : _ocp_softreset(oh);
1533 * _enable - enable an omap_hwmod
1534 * @oh: struct omap_hwmod *
1536 * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
1537 * register target. Returns -EINVAL if the hwmod is in the wrong
1538 * state or passes along the return value of _wait_target_ready().
1540 static int _enable(struct omap_hwmod *oh)
1545 pr_debug("omap_hwmod: %s: enabling\n", oh->name);
1547 if (oh->_state != _HWMOD_STATE_INITIALIZED &&
1548 oh->_state != _HWMOD_STATE_IDLE &&
1549 oh->_state != _HWMOD_STATE_DISABLED) {
1550 WARN(1, "omap_hwmod: %s: enabled state can only be entered "
1551 "from initialized, idle, or disabled state\n", oh->name);
1557 * If an IP contains only one HW reset line, then de-assert it in order
1558 * to allow the module state transition. Otherwise the PRCM will return
1559 * Intransition status, and the init will failed.
1561 if ((oh->_state == _HWMOD_STATE_INITIALIZED ||
1562 oh->_state == _HWMOD_STATE_DISABLED) && oh->rst_lines_cnt == 1)
1563 _deassert_hardreset(oh, oh->rst_lines[0].name);
1565 /* Mux pins for device runtime if populated */
1566 if (oh->mux && (!oh->mux->enabled ||
1567 ((oh->_state == _HWMOD_STATE_IDLE) &&
1568 oh->mux->pads_dynamic)))
1569 omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
1571 _add_initiator_dep(oh, mpu_oh);
1575 * A clockdomain must be in SW_SUP before enabling
1576 * completely the module. The clockdomain can be set
1577 * in HW_AUTO only when the module become ready.
1579 hwsup = clkdm_in_hwsup(oh->clkdm);
1580 r = clkdm_hwmod_enable(oh->clkdm, oh);
1582 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1583 oh->name, oh->clkdm->name, r);
1591 r = _wait_target_ready(oh);
1594 * Set the clockdomain to HW_AUTO only if the target is ready,
1595 * assuming that the previous state was HW_AUTO
1597 if (oh->clkdm && hwsup)
1598 clkdm_allow_idle(oh->clkdm);
1600 oh->_state = _HWMOD_STATE_ENABLED;
1602 /* Access the sysconfig only if the target is ready */
1603 if (oh->class->sysc) {
1604 if (!(oh->_int_flags & _HWMOD_SYSCONFIG_LOADED))
1605 _update_sysc_cache(oh);
1609 _disable_clocks(oh);
1610 pr_debug("omap_hwmod: %s: _wait_target_ready: %d\n",
1614 clkdm_hwmod_disable(oh->clkdm, oh);
1621 * _idle - idle an omap_hwmod
1622 * @oh: struct omap_hwmod *
1624 * Idles an omap_hwmod @oh. This should be called once the hwmod has
1625 * no further work. Returns -EINVAL if the hwmod is in the wrong
1626 * state or returns 0.
1628 static int _idle(struct omap_hwmod *oh)
1632 pr_debug("omap_hwmod: %s: idling\n", oh->name);
1634 if (oh->_state != _HWMOD_STATE_ENABLED) {
1635 WARN(1, "omap_hwmod: %s: idle state can only be entered from "
1636 "enabled state\n", oh->name);
1640 if (oh->class->sysc)
1642 _del_initiator_dep(oh, mpu_oh);
1643 _disable_module(oh);
1644 ret = _wait_target_disable(oh);
1646 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1649 * The module must be in idle mode before disabling any parents
1650 * clocks. Otherwise, the parent clock might be disabled before
1651 * the module transition is done, and thus will prevent the
1652 * transition to complete properly.
1654 _disable_clocks(oh);
1656 clkdm_hwmod_disable(oh->clkdm, oh);
1658 /* Mux pins for device idle if populated */
1659 if (oh->mux && oh->mux->pads_dynamic)
1660 omap_hwmod_mux(oh->mux, _HWMOD_STATE_IDLE);
1662 oh->_state = _HWMOD_STATE_IDLE;
1668 * omap_hwmod_set_ocp_autoidle - set the hwmod's OCP autoidle bit
1669 * @oh: struct omap_hwmod *
1670 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
1672 * Sets the IP block's OCP autoidle bit in hardware, and updates our
1673 * local copy. Intended to be used by drivers that require
1674 * direct manipulation of the AUTOIDLE bits.
1675 * Returns -EINVAL if @oh is null or is not in the ENABLED state, or passes
1676 * along the return value from _set_module_autoidle().
1678 * Any users of this function should be scrutinized carefully.
1680 int omap_hwmod_set_ocp_autoidle(struct omap_hwmod *oh, u8 autoidle)
1684 unsigned long flags;
1686 if (!oh || oh->_state != _HWMOD_STATE_ENABLED)
1689 spin_lock_irqsave(&oh->_lock, flags);
1691 v = oh->_sysc_cache;
1693 retval = _set_module_autoidle(oh, autoidle, &v);
1696 _write_sysconfig(v, oh);
1698 spin_unlock_irqrestore(&oh->_lock, flags);
1704 * _shutdown - shutdown an omap_hwmod
1705 * @oh: struct omap_hwmod *
1707 * Shut down an omap_hwmod @oh. This should be called when the driver
1708 * used for the hwmod is removed or unloaded or if the driver is not
1709 * used by the system. Returns -EINVAL if the hwmod is in the wrong
1710 * state or returns 0.
1712 static int _shutdown(struct omap_hwmod *oh)
1717 if (oh->_state != _HWMOD_STATE_IDLE &&
1718 oh->_state != _HWMOD_STATE_ENABLED) {
1719 WARN(1, "omap_hwmod: %s: disabled state can only be entered "
1720 "from idle, or enabled state\n", oh->name);
1724 pr_debug("omap_hwmod: %s: disabling\n", oh->name);
1726 if (oh->class->pre_shutdown) {
1727 prev_state = oh->_state;
1728 if (oh->_state == _HWMOD_STATE_IDLE)
1730 ret = oh->class->pre_shutdown(oh);
1732 if (prev_state == _HWMOD_STATE_IDLE)
1738 if (oh->class->sysc) {
1739 if (oh->_state == _HWMOD_STATE_IDLE)
1744 /* clocks and deps are already disabled in idle */
1745 if (oh->_state == _HWMOD_STATE_ENABLED) {
1746 _del_initiator_dep(oh, mpu_oh);
1747 /* XXX what about the other system initiators here? dma, dsp */
1748 _disable_module(oh);
1749 ret = _wait_target_disable(oh);
1751 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1753 _disable_clocks(oh);
1755 clkdm_hwmod_disable(oh->clkdm, oh);
1757 /* XXX Should this code also force-disable the optional clocks? */
1760 * If an IP contains only one HW reset line, then assert it
1761 * after disabling the clocks and before shutting down the IP.
1763 if (oh->rst_lines_cnt == 1)
1764 _assert_hardreset(oh, oh->rst_lines[0].name);
1766 /* Mux pins to safe mode or use populated off mode values */
1768 omap_hwmod_mux(oh->mux, _HWMOD_STATE_DISABLED);
1770 oh->_state = _HWMOD_STATE_DISABLED;
1776 * _setup - do initial configuration of omap_hwmod
1777 * @oh: struct omap_hwmod *
1779 * Writes the CLOCKACTIVITY bits @clockact to the hwmod @oh
1780 * OCP_SYSCONFIG register. Returns 0.
1782 static int _setup(struct omap_hwmod *oh, void *data)
1787 if (oh->_state != _HWMOD_STATE_CLKS_INITED)
1790 /* Set iclk autoidle mode */
1791 if (oh->slaves_cnt > 0) {
1792 for (i = 0; i < oh->slaves_cnt; i++) {
1793 struct omap_hwmod_ocp_if *os = oh->slaves[i];
1794 struct clk *c = os->_clk;
1799 if (os->flags & OCPIF_SWSUP_IDLE) {
1800 /* XXX omap_iclk_deny_idle(c); */
1802 /* XXX omap_iclk_allow_idle(c); */
1808 oh->_state = _HWMOD_STATE_INITIALIZED;
1811 * In the case of hwmod with hardreset that should not be
1812 * de-assert at boot time, we have to keep the module
1813 * initialized, because we cannot enable it properly with the
1814 * reset asserted. Exit without warning because that behavior is
1817 if ((oh->flags & HWMOD_INIT_NO_RESET) && oh->rst_lines_cnt == 1)
1822 pr_warning("omap_hwmod: %s: cannot be enabled (%d)\n",
1823 oh->name, oh->_state);
1827 if (!(oh->flags & HWMOD_INIT_NO_RESET)) {
1831 * OCP_SYSCONFIG bits need to be reprogrammed after a softreset.
1832 * The _enable() function should be split to
1833 * avoid the rewrite of the OCP_SYSCONFIG register.
1835 if (oh->class->sysc) {
1836 _update_sysc_cache(oh);
1841 postsetup_state = oh->_postsetup_state;
1842 if (postsetup_state == _HWMOD_STATE_UNKNOWN)
1843 postsetup_state = _HWMOD_STATE_ENABLED;
1846 * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
1847 * it should be set by the core code as a runtime flag during startup
1849 if ((oh->flags & HWMOD_INIT_NO_IDLE) &&
1850 (postsetup_state == _HWMOD_STATE_IDLE))
1851 postsetup_state = _HWMOD_STATE_ENABLED;
1853 if (postsetup_state == _HWMOD_STATE_IDLE)
1855 else if (postsetup_state == _HWMOD_STATE_DISABLED)
1857 else if (postsetup_state != _HWMOD_STATE_ENABLED)
1858 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
1859 oh->name, postsetup_state);
1865 * _register - register a struct omap_hwmod
1866 * @oh: struct omap_hwmod *
1868 * Registers the omap_hwmod @oh. Returns -EEXIST if an omap_hwmod
1869 * already has been registered by the same name; -EINVAL if the
1870 * omap_hwmod is in the wrong state, if @oh is NULL, if the
1871 * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
1872 * name, or if the omap_hwmod's class is missing a name; or 0 upon
1875 * XXX The data should be copied into bootmem, so the original data
1876 * should be marked __initdata and freed after init. This would allow
1877 * unneeded omap_hwmods to be freed on multi-OMAP configurations. Note
1878 * that the copy process would be relatively complex due to the large number
1881 static int __init _register(struct omap_hwmod *oh)
1885 if (!oh || !oh->name || !oh->class || !oh->class->name ||
1886 (oh->_state != _HWMOD_STATE_UNKNOWN))
1889 pr_debug("omap_hwmod: %s: registering\n", oh->name);
1891 if (_lookup(oh->name))
1894 ms_id = _find_mpu_port_index(oh);
1895 if (!IS_ERR_VALUE(ms_id))
1896 oh->_mpu_port_index = ms_id;
1898 oh->_int_flags |= _HWMOD_NO_MPU_PORT;
1900 list_add_tail(&oh->node, &omap_hwmod_list);
1902 spin_lock_init(&oh->_lock);
1904 oh->_state = _HWMOD_STATE_REGISTERED;
1907 * XXX Rather than doing a strcmp(), this should test a flag
1908 * set in the hwmod data, inserted by the autogenerator code.
1910 if (!strcmp(oh->name, MPU_INITIATOR_NAME))
1917 /* Public functions */
1919 u32 omap_hwmod_read(struct omap_hwmod *oh, u16 reg_offs)
1921 if (oh->flags & HWMOD_16BIT_REG)
1922 return __raw_readw(oh->_mpu_rt_va + reg_offs);
1924 return __raw_readl(oh->_mpu_rt_va + reg_offs);
1927 void omap_hwmod_write(u32 v, struct omap_hwmod *oh, u16 reg_offs)
1929 if (oh->flags & HWMOD_16BIT_REG)
1930 __raw_writew(v, oh->_mpu_rt_va + reg_offs);
1932 __raw_writel(v, oh->_mpu_rt_va + reg_offs);
1936 * omap_hwmod_softreset - reset a module via SYSCONFIG.SOFTRESET bit
1937 * @oh: struct omap_hwmod *
1939 * This is a public function exposed to drivers. Some drivers may need to do
1940 * some settings before and after resetting the device. Those drivers after
1941 * doing the necessary settings could use this function to start a reset by
1942 * setting the SYSCONFIG.SOFTRESET bit.
1944 int omap_hwmod_softreset(struct omap_hwmod *oh)
1949 if (!oh || !(oh->_sysc_cache))
1952 v = oh->_sysc_cache;
1953 ret = _set_softreset(oh, &v);
1956 _write_sysconfig(v, oh);
1958 ret = _clear_softreset(oh, &v);
1961 _write_sysconfig(v, oh);
1968 * omap_hwmod_set_slave_idlemode - set the hwmod's OCP slave idlemode
1969 * @oh: struct omap_hwmod *
1970 * @idlemode: SIDLEMODE field bits (shifted to bit 0)
1972 * Sets the IP block's OCP slave idlemode in hardware, and updates our
1973 * local copy. Intended to be used by drivers that have some erratum
1974 * that requires direct manipulation of the SIDLEMODE bits. Returns
1975 * -EINVAL if @oh is null, or passes along the return value from
1976 * _set_slave_idlemode().
1978 * XXX Does this function have any current users? If not, we should
1979 * remove it; it is better to let the rest of the hwmod code handle this.
1980 * Any users of this function should be scrutinized carefully.
1982 int omap_hwmod_set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode)
1990 v = oh->_sysc_cache;
1992 retval = _set_slave_idlemode(oh, idlemode, &v);
1994 _write_sysconfig(v, oh);
2000 * omap_hwmod_lookup - look up a registered omap_hwmod by name
2001 * @name: name of the omap_hwmod to look up
2003 * Given a @name of an omap_hwmod, return a pointer to the registered
2004 * struct omap_hwmod *, or NULL upon error.
2006 struct omap_hwmod *omap_hwmod_lookup(const char *name)
2008 struct omap_hwmod *oh;
2019 * omap_hwmod_for_each - call function for each registered omap_hwmod
2020 * @fn: pointer to a callback function
2021 * @data: void * data to pass to callback function
2023 * Call @fn for each registered omap_hwmod, passing @data to each
2024 * function. @fn must return 0 for success or any other value for
2025 * failure. If @fn returns non-zero, the iteration across omap_hwmods
2026 * will stop and the non-zero return value will be passed to the
2027 * caller of omap_hwmod_for_each(). @fn is called with
2028 * omap_hwmod_for_each() held.
2030 int omap_hwmod_for_each(int (*fn)(struct omap_hwmod *oh, void *data),
2033 struct omap_hwmod *temp_oh;
2039 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
2040 ret = (*fn)(temp_oh, data);
2049 * omap_hwmod_register - register an array of hwmods
2050 * @ohs: pointer to an array of omap_hwmods to register
2052 * Intended to be called early in boot before the clock framework is
2053 * initialized. If @ohs is not null, will register all omap_hwmods
2054 * listed in @ohs that are valid for this chip. Returns 0.
2056 int __init omap_hwmod_register(struct omap_hwmod **ohs)
2065 r = _register(ohs[i]);
2066 WARN(r, "omap_hwmod: %s: _register returned %d\n", ohs[i]->name,
2074 * _populate_mpu_rt_base - populate the virtual address for a hwmod
2076 * Must be called only from omap_hwmod_setup_*() so ioremap works properly.
2077 * Assumes the caller takes care of locking if needed.
2079 static int __init _populate_mpu_rt_base(struct omap_hwmod *oh, void *data)
2081 if (oh->_state != _HWMOD_STATE_REGISTERED)
2084 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2087 oh->_mpu_rt_va = _find_mpu_rt_base(oh, oh->_mpu_port_index);
2093 * omap_hwmod_setup_one - set up a single hwmod
2094 * @oh_name: const char * name of the already-registered hwmod to set up
2096 * Must be called after omap2_clk_init(). Resolves the struct clk
2097 * names to struct clk pointers for each registered omap_hwmod. Also
2098 * calls _setup() on each hwmod. Returns -EINVAL upon error or 0 upon
2101 int __init omap_hwmod_setup_one(const char *oh_name)
2103 struct omap_hwmod *oh;
2106 pr_debug("omap_hwmod: %s: %s\n", oh_name, __func__);
2109 pr_err("omap_hwmod: %s: cannot setup_one: MPU initiator hwmod %s not yet registered\n",
2110 oh_name, MPU_INITIATOR_NAME);
2114 oh = _lookup(oh_name);
2116 WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name);
2120 if (mpu_oh->_state == _HWMOD_STATE_REGISTERED && oh != mpu_oh)
2121 omap_hwmod_setup_one(MPU_INITIATOR_NAME);
2123 r = _populate_mpu_rt_base(oh, NULL);
2124 if (IS_ERR_VALUE(r)) {
2125 WARN(1, "omap_hwmod: %s: couldn't set mpu_rt_base\n", oh_name);
2129 r = _init_clocks(oh, NULL);
2130 if (IS_ERR_VALUE(r)) {
2131 WARN(1, "omap_hwmod: %s: couldn't init clocks\n", oh_name);
2141 * omap_hwmod_setup - do some post-clock framework initialization
2143 * Must be called after omap2_clk_init(). Resolves the struct clk names
2144 * to struct clk pointers for each registered omap_hwmod. Also calls
2145 * _setup() on each hwmod. Returns 0 upon success.
2147 static int __init omap_hwmod_setup_all(void)
2152 pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",
2153 __func__, MPU_INITIATOR_NAME);
2157 r = omap_hwmod_for_each(_populate_mpu_rt_base, NULL);
2159 r = omap_hwmod_for_each(_init_clocks, NULL);
2160 WARN(IS_ERR_VALUE(r),
2161 "omap_hwmod: %s: _init_clocks failed\n", __func__);
2163 omap_hwmod_for_each(_setup, NULL);
2167 core_initcall(omap_hwmod_setup_all);
2170 * omap_hwmod_enable - enable an omap_hwmod
2171 * @oh: struct omap_hwmod *
2173 * Enable an omap_hwmod @oh. Intended to be called by omap_device_enable().
2174 * Returns -EINVAL on error or passes along the return value from _enable().
2176 int omap_hwmod_enable(struct omap_hwmod *oh)
2179 unsigned long flags;
2184 spin_lock_irqsave(&oh->_lock, flags);
2186 spin_unlock_irqrestore(&oh->_lock, flags);
2192 * omap_hwmod_idle - idle an omap_hwmod
2193 * @oh: struct omap_hwmod *
2195 * Idle an omap_hwmod @oh. Intended to be called by omap_device_idle().
2196 * Returns -EINVAL on error or passes along the return value from _idle().
2198 int omap_hwmod_idle(struct omap_hwmod *oh)
2200 unsigned long flags;
2205 spin_lock_irqsave(&oh->_lock, flags);
2207 spin_unlock_irqrestore(&oh->_lock, flags);
2213 * omap_hwmod_shutdown - shutdown an omap_hwmod
2214 * @oh: struct omap_hwmod *
2216 * Shutdown an omap_hwmod @oh. Intended to be called by
2217 * omap_device_shutdown(). Returns -EINVAL on error or passes along
2218 * the return value from _shutdown().
2220 int omap_hwmod_shutdown(struct omap_hwmod *oh)
2222 unsigned long flags;
2227 spin_lock_irqsave(&oh->_lock, flags);
2229 spin_unlock_irqrestore(&oh->_lock, flags);
2235 * omap_hwmod_enable_clocks - enable main_clk, all interface clocks
2236 * @oh: struct omap_hwmod *oh
2238 * Intended to be called by the omap_device code.
2240 int omap_hwmod_enable_clocks(struct omap_hwmod *oh)
2242 unsigned long flags;
2244 spin_lock_irqsave(&oh->_lock, flags);
2246 spin_unlock_irqrestore(&oh->_lock, flags);
2252 * omap_hwmod_disable_clocks - disable main_clk, all interface clocks
2253 * @oh: struct omap_hwmod *oh
2255 * Intended to be called by the omap_device code.
2257 int omap_hwmod_disable_clocks(struct omap_hwmod *oh)
2259 unsigned long flags;
2261 spin_lock_irqsave(&oh->_lock, flags);
2262 _disable_clocks(oh);
2263 spin_unlock_irqrestore(&oh->_lock, flags);
2269 * omap_hwmod_ocp_barrier - wait for posted writes against the hwmod to complete
2270 * @oh: struct omap_hwmod *oh
2272 * Intended to be called by drivers and core code when all posted
2273 * writes to a device must complete before continuing further
2274 * execution (for example, after clearing some device IRQSTATUS
2277 * XXX what about targets with multiple OCP threads?
2279 void omap_hwmod_ocp_barrier(struct omap_hwmod *oh)
2283 if (!oh->class->sysc || !oh->class->sysc->sysc_flags) {
2284 WARN(1, "omap_device: %s: OCP barrier impossible due to "
2285 "device configuration\n", oh->name);
2290 * Forces posted writes to complete on the OCP thread handling
2293 omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
2297 * omap_hwmod_reset - reset the hwmod
2298 * @oh: struct omap_hwmod *
2300 * Under some conditions, a driver may wish to reset the entire device.
2301 * Called from omap_device code. Returns -EINVAL on error or passes along
2302 * the return value from _reset().
2304 int omap_hwmod_reset(struct omap_hwmod *oh)
2307 unsigned long flags;
2312 spin_lock_irqsave(&oh->_lock, flags);
2314 spin_unlock_irqrestore(&oh->_lock, flags);
2320 * omap_hwmod_count_resources - count number of struct resources needed by hwmod
2321 * @oh: struct omap_hwmod *
2322 * @res: pointer to the first element of an array of struct resource to fill
2324 * Count the number of struct resource array elements necessary to
2325 * contain omap_hwmod @oh resources. Intended to be called by code
2326 * that registers omap_devices. Intended to be used to determine the
2327 * size of a dynamically-allocated struct resource array, before
2328 * calling omap_hwmod_fill_resources(). Returns the number of struct
2329 * resource array elements needed.
2331 * XXX This code is not optimized. It could attempt to merge adjacent
2335 int omap_hwmod_count_resources(struct omap_hwmod *oh)
2339 ret = _count_mpu_irqs(oh) + _count_sdma_reqs(oh);
2341 for (i = 0; i < oh->slaves_cnt; i++)
2342 ret += _count_ocp_if_addr_spaces(oh->slaves[i]);
2348 * omap_hwmod_fill_resources - fill struct resource array with hwmod data
2349 * @oh: struct omap_hwmod *
2350 * @res: pointer to the first element of an array of struct resource to fill
2352 * Fill the struct resource array @res with resource data from the
2353 * omap_hwmod @oh. Intended to be called by code that registers
2354 * omap_devices. See also omap_hwmod_count_resources(). Returns the
2355 * number of array elements filled.
2357 int omap_hwmod_fill_resources(struct omap_hwmod *oh, struct resource *res)
2359 int i, j, mpu_irqs_cnt, sdma_reqs_cnt;
2362 /* For each IRQ, DMA, memory area, fill in array.*/
2364 mpu_irqs_cnt = _count_mpu_irqs(oh);
2365 for (i = 0; i < mpu_irqs_cnt; i++) {
2366 (res + r)->name = (oh->mpu_irqs + i)->name;
2367 (res + r)->start = (oh->mpu_irqs + i)->irq;
2368 (res + r)->end = (oh->mpu_irqs + i)->irq;
2369 (res + r)->flags = IORESOURCE_IRQ;
2373 sdma_reqs_cnt = _count_sdma_reqs(oh);
2374 for (i = 0; i < sdma_reqs_cnt; i++) {
2375 (res + r)->name = (oh->sdma_reqs + i)->name;
2376 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
2377 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
2378 (res + r)->flags = IORESOURCE_DMA;
2382 for (i = 0; i < oh->slaves_cnt; i++) {
2383 struct omap_hwmod_ocp_if *os;
2387 addr_cnt = _count_ocp_if_addr_spaces(os);
2389 for (j = 0; j < addr_cnt; j++) {
2390 (res + r)->name = (os->addr + j)->name;
2391 (res + r)->start = (os->addr + j)->pa_start;
2392 (res + r)->end = (os->addr + j)->pa_end;
2393 (res + r)->flags = IORESOURCE_MEM;
2402 * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
2403 * @oh: struct omap_hwmod *
2405 * Return the powerdomain pointer associated with the OMAP module
2406 * @oh's main clock. If @oh does not have a main clk, return the
2407 * powerdomain associated with the interface clock associated with the
2408 * module's MPU port. (XXX Perhaps this should use the SDMA port
2409 * instead?) Returns NULL on error, or a struct powerdomain * on
2412 struct powerdomain *omap_hwmod_get_pwrdm(struct omap_hwmod *oh)
2422 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2424 c = oh->slaves[oh->_mpu_port_index]->_clk;
2430 return c->clkdm->pwrdm.ptr;
2435 * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
2436 * @oh: struct omap_hwmod *
2438 * Returns the virtual address corresponding to the beginning of the
2439 * module's register target, in the address range that is intended to
2440 * be used by the MPU. Returns the virtual address upon success or NULL
2443 void __iomem *omap_hwmod_get_mpu_rt_va(struct omap_hwmod *oh)
2448 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2451 if (oh->_state == _HWMOD_STATE_UNKNOWN)
2454 return oh->_mpu_rt_va;
2458 * omap_hwmod_add_initiator_dep - add sleepdep from @init_oh to @oh
2459 * @oh: struct omap_hwmod *
2460 * @init_oh: struct omap_hwmod * (initiator)
2462 * Add a sleep dependency between the initiator @init_oh and @oh.
2463 * Intended to be called by DSP/Bridge code via platform_data for the
2464 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
2465 * code needs to add/del initiator dependencies dynamically
2466 * before/after accessing a device. Returns the return value from
2467 * _add_initiator_dep().
2469 * XXX Keep a usecount in the clockdomain code
2471 int omap_hwmod_add_initiator_dep(struct omap_hwmod *oh,
2472 struct omap_hwmod *init_oh)
2474 return _add_initiator_dep(oh, init_oh);
2478 * XXX what about functions for drivers to save/restore ocp_sysconfig
2479 * for context save/restore operations?
2483 * omap_hwmod_del_initiator_dep - remove sleepdep from @init_oh to @oh
2484 * @oh: struct omap_hwmod *
2485 * @init_oh: struct omap_hwmod * (initiator)
2487 * Remove a sleep dependency between the initiator @init_oh and @oh.
2488 * Intended to be called by DSP/Bridge code via platform_data for the
2489 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
2490 * code needs to add/del initiator dependencies dynamically
2491 * before/after accessing a device. Returns the return value from
2492 * _del_initiator_dep().
2494 * XXX Keep a usecount in the clockdomain code
2496 int omap_hwmod_del_initiator_dep(struct omap_hwmod *oh,
2497 struct omap_hwmod *init_oh)
2499 return _del_initiator_dep(oh, init_oh);
2503 * omap_hwmod_enable_wakeup - allow device to wake up the system
2504 * @oh: struct omap_hwmod *
2506 * Sets the module OCP socket ENAWAKEUP bit to allow the module to
2507 * send wakeups to the PRCM. Eventually this should sets PRCM wakeup
2508 * registers to cause the PRCM to receive wakeup events from the
2509 * module. Does not set any wakeup routing registers beyond this
2510 * point - if the module is to wake up any other module or subsystem,
2511 * that must be set separately. Called by omap_device code. Returns
2512 * -EINVAL on error or 0 upon success.
2514 int omap_hwmod_enable_wakeup(struct omap_hwmod *oh)
2516 unsigned long flags;
2519 if (!oh->class->sysc ||
2520 !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
2523 spin_lock_irqsave(&oh->_lock, flags);
2524 v = oh->_sysc_cache;
2525 _enable_wakeup(oh, &v);
2526 _write_sysconfig(v, oh);
2527 spin_unlock_irqrestore(&oh->_lock, flags);
2533 * omap_hwmod_disable_wakeup - prevent device from waking the system
2534 * @oh: struct omap_hwmod *
2536 * Clears the module OCP socket ENAWAKEUP bit to prevent the module
2537 * from sending wakeups to the PRCM. Eventually this should clear
2538 * PRCM wakeup registers to cause the PRCM to ignore wakeup events
2539 * from the module. Does not set any wakeup routing registers beyond
2540 * this point - if the module is to wake up any other module or
2541 * subsystem, that must be set separately. Called by omap_device
2542 * code. Returns -EINVAL on error or 0 upon success.
2544 int omap_hwmod_disable_wakeup(struct omap_hwmod *oh)
2546 unsigned long flags;
2549 if (!oh->class->sysc ||
2550 !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
2553 spin_lock_irqsave(&oh->_lock, flags);
2554 v = oh->_sysc_cache;
2555 _disable_wakeup(oh, &v);
2556 _write_sysconfig(v, oh);
2557 spin_unlock_irqrestore(&oh->_lock, flags);
2563 * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
2564 * contained in the hwmod module.
2565 * @oh: struct omap_hwmod *
2566 * @name: name of the reset line to lookup and assert
2568 * Some IP like dsp, ipu or iva contain processor that require
2569 * an HW reset line to be assert / deassert in order to enable fully
2570 * the IP. Returns -EINVAL if @oh is null or if the operation is not
2571 * yet supported on this OMAP; otherwise, passes along the return value
2572 * from _assert_hardreset().
2574 int omap_hwmod_assert_hardreset(struct omap_hwmod *oh, const char *name)
2577 unsigned long flags;
2582 spin_lock_irqsave(&oh->_lock, flags);
2583 ret = _assert_hardreset(oh, name);
2584 spin_unlock_irqrestore(&oh->_lock, flags);
2590 * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
2591 * contained in the hwmod module.
2592 * @oh: struct omap_hwmod *
2593 * @name: name of the reset line to look up and deassert
2595 * Some IP like dsp, ipu or iva contain processor that require
2596 * an HW reset line to be assert / deassert in order to enable fully
2597 * the IP. Returns -EINVAL if @oh is null or if the operation is not
2598 * yet supported on this OMAP; otherwise, passes along the return value
2599 * from _deassert_hardreset().
2601 int omap_hwmod_deassert_hardreset(struct omap_hwmod *oh, const char *name)
2604 unsigned long flags;
2609 spin_lock_irqsave(&oh->_lock, flags);
2610 ret = _deassert_hardreset(oh, name);
2611 spin_unlock_irqrestore(&oh->_lock, flags);
2617 * omap_hwmod_read_hardreset - read the HW reset line state of submodules
2618 * contained in the hwmod module
2619 * @oh: struct omap_hwmod *
2620 * @name: name of the reset line to look up and read
2622 * Return the current state of the hwmod @oh's reset line named @name:
2623 * returns -EINVAL upon parameter error or if this operation
2624 * is unsupported on the current OMAP; otherwise, passes along the return
2625 * value from _read_hardreset().
2627 int omap_hwmod_read_hardreset(struct omap_hwmod *oh, const char *name)
2630 unsigned long flags;
2635 spin_lock_irqsave(&oh->_lock, flags);
2636 ret = _read_hardreset(oh, name);
2637 spin_unlock_irqrestore(&oh->_lock, flags);
2644 * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
2645 * @classname: struct omap_hwmod_class name to search for
2646 * @fn: callback function pointer to call for each hwmod in class @classname
2647 * @user: arbitrary context data to pass to the callback function
2649 * For each omap_hwmod of class @classname, call @fn.
2650 * If the callback function returns something other than
2651 * zero, the iterator is terminated, and the callback function's return
2652 * value is passed back to the caller. Returns 0 upon success, -EINVAL
2653 * if @classname or @fn are NULL, or passes back the error code from @fn.
2655 int omap_hwmod_for_each_by_class(const char *classname,
2656 int (*fn)(struct omap_hwmod *oh,
2660 struct omap_hwmod *temp_oh;
2663 if (!classname || !fn)
2666 pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
2667 __func__, classname);
2669 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
2670 if (!strcmp(temp_oh->class->name, classname)) {
2671 pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
2672 __func__, temp_oh->name);
2673 ret = (*fn)(temp_oh, user);
2680 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
2687 * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
2688 * @oh: struct omap_hwmod *
2689 * @state: state that _setup() should leave the hwmod in
2691 * Sets the hwmod state that @oh will enter at the end of _setup()
2692 * (called by omap_hwmod_setup_*()). Only valid to call between
2693 * calling omap_hwmod_register() and omap_hwmod_setup_*(). Returns
2694 * 0 upon success or -EINVAL if there is a problem with the arguments
2695 * or if the hwmod is in the wrong state.
2697 int omap_hwmod_set_postsetup_state(struct omap_hwmod *oh, u8 state)
2700 unsigned long flags;
2705 if (state != _HWMOD_STATE_DISABLED &&
2706 state != _HWMOD_STATE_ENABLED &&
2707 state != _HWMOD_STATE_IDLE)
2710 spin_lock_irqsave(&oh->_lock, flags);
2712 if (oh->_state != _HWMOD_STATE_REGISTERED) {
2717 oh->_postsetup_state = state;
2721 spin_unlock_irqrestore(&oh->_lock, flags);
2727 * omap_hwmod_get_context_loss_count - get lost context count
2728 * @oh: struct omap_hwmod *
2730 * Query the powerdomain of of @oh to get the context loss
2731 * count for this device.
2733 * Returns the context loss count of the powerdomain assocated with @oh
2734 * upon success, or zero if no powerdomain exists for @oh.
2736 int omap_hwmod_get_context_loss_count(struct omap_hwmod *oh)
2738 struct powerdomain *pwrdm;
2741 pwrdm = omap_hwmod_get_pwrdm(oh);
2743 ret = pwrdm_get_context_loss_count(pwrdm);
2749 * omap_hwmod_no_setup_reset - prevent a hwmod from being reset upon setup
2750 * @oh: struct omap_hwmod *
2752 * Prevent the hwmod @oh from being reset during the setup process.
2753 * Intended for use by board-*.c files on boards with devices that
2754 * cannot tolerate being reset. Must be called before the hwmod has
2755 * been set up. Returns 0 upon success or negative error code upon
2758 int omap_hwmod_no_setup_reset(struct omap_hwmod *oh)
2763 if (oh->_state != _HWMOD_STATE_REGISTERED) {
2764 pr_err("omap_hwmod: %s: cannot prevent setup reset; in wrong state\n",
2769 oh->flags |= HWMOD_INIT_NO_RESET;