2 * omap_hwmod implementation for OMAP2/3/4
4 * Copyright (C) 2009-2010 Nokia Corporation
6 * Paul Walmsley, BenoƮt Cousson, Kevin Hilman
8 * Created in collaboration with (alphabetical order): Thara Gopinath,
9 * Tony Lindgren, Rajendra Nayak, Vikram Pandita, Sakari Poussa, Anand
10 * Sawant, Santosh Shilimkar, Richard Woodruff
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License version 2 as
14 * published by the Free Software Foundation.
18 * One way to view an OMAP SoC is as a collection of largely unrelated
19 * IP blocks connected by interconnects. The IP blocks include
20 * devices such as ARM processors, audio serial interfaces, UARTs,
21 * etc. Some of these devices, like the DSP, are created by TI;
22 * others, like the SGX, largely originate from external vendors. In
23 * TI's documentation, on-chip devices are referred to as "OMAP
24 * modules." Some of these IP blocks are identical across several
25 * OMAP versions. Others are revised frequently.
27 * These OMAP modules are tied together by various interconnects.
28 * Most of the address and data flow between modules is via OCP-based
29 * interconnects such as the L3 and L4 buses; but there are other
30 * interconnects that distribute the hardware clock tree, handle idle
31 * and reset signaling, supply power, and connect the modules to
32 * various pads or balls on the OMAP package.
34 * OMAP hwmod provides a consistent way to describe the on-chip
35 * hardware blocks and their integration into the rest of the chip.
36 * This description can be automatically generated from the TI
37 * hardware database. OMAP hwmod provides a standard, consistent API
38 * to reset, enable, idle, and disable these hardware blocks. And
39 * hwmod provides a way for other core code, such as the Linux device
40 * code or the OMAP power management and address space mapping code,
41 * to query the hardware database.
45 * Drivers won't call hwmod functions directly. That is done by the
46 * omap_device code, and in rare occasions, by custom integration code
47 * in arch/arm/ *omap*. The omap_device code includes functions to
48 * build a struct platform_device using omap_hwmod data, and that is
49 * currently how hwmod data is communicated to drivers and to the
50 * Linux driver model. Most drivers will call omap_hwmod functions only
51 * indirectly, via pm_runtime*() functions.
53 * From a layering perspective, here is where the OMAP hwmod code
54 * fits into the kernel software stack:
56 * +-------------------------------+
57 * | Device driver code |
58 * | (e.g., drivers/) |
59 * +-------------------------------+
60 * | Linux driver model |
61 * | (platform_device / |
62 * | platform_driver data/code) |
63 * +-------------------------------+
64 * | OMAP core-driver integration |
65 * |(arch/arm/mach-omap2/devices.c)|
66 * +-------------------------------+
67 * | omap_device code |
68 * | (../plat-omap/omap_device.c) |
69 * +-------------------------------+
70 * ----> | omap_hwmod code/data | <-----
71 * | (../mach-omap2/omap_hwmod*) |
72 * +-------------------------------+
73 * | OMAP clock/PRCM/register fns |
74 * | (__raw_{read,write}l, clk*) |
75 * +-------------------------------+
77 * Device drivers should not contain any OMAP-specific code or data in
78 * them. They should only contain code to operate the IP block that
79 * the driver is responsible for. This is because these IP blocks can
80 * also appear in other SoCs, either from TI (such as DaVinci) or from
81 * other manufacturers; and drivers should be reusable across other
84 * The OMAP hwmod code also will attempt to reset and idle all on-chip
85 * devices upon boot. The goal here is for the kernel to be
86 * completely self-reliant and independent from bootloaders. This is
87 * to ensure a repeatable configuration, both to ensure consistent
88 * runtime behavior, and to make it easier for others to reproduce
91 * OMAP module activity states
92 * ---------------------------
93 * The hwmod code considers modules to be in one of several activity
94 * states. IP blocks start out in an UNKNOWN state, then once they
95 * are registered via the hwmod code, proceed to the REGISTERED state.
96 * Once their clock names are resolved to clock pointers, the module
97 * enters the CLKS_INITED state; and finally, once the module has been
98 * reset and the integration registers programmed, the INITIALIZED state
99 * is entered. The hwmod code will then place the module into either
100 * the IDLE state to save power, or in the case of a critical system
101 * module, the ENABLED state.
103 * OMAP core integration code can then call omap_hwmod*() functions
104 * directly to move the module between the IDLE, ENABLED, and DISABLED
105 * states, as needed. This is done during both the PM idle loop, and
106 * in the OMAP core integration code's implementation of the PM runtime
111 * This is a partial list.
112 * - OMAP2420 Multimedia Processor Silicon Revision 2.1.1, 2.2 (SWPU064)
113 * - OMAP2430 Multimedia Device POP Silicon Revision 2.1 (SWPU090)
114 * - OMAP34xx Multimedia Device Silicon Revision 3.1 (SWPU108)
115 * - OMAP4430 Multimedia Device Silicon Revision 1.0 (SWPU140)
116 * - 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 <plat/clockdomain.h>
143 #include <plat/powerdomain.h>
144 #include <plat/clock.h>
145 #include <plat/omap_hwmod.h>
146 #include <plat/prcm.h>
152 /* Maximum microseconds to wait for OMAP module to softreset */
153 #define MAX_MODULE_SOFTRESET_WAIT 10000
155 /* Name of the OMAP hwmod for the MPU */
156 #define MPU_INITIATOR_NAME "mpu"
158 /* omap_hwmod_list contains all registered struct omap_hwmods */
159 static LIST_HEAD(omap_hwmod_list);
161 static DEFINE_MUTEX(omap_hwmod_mutex);
163 /* mpu_oh: used to add/remove MPU initiator from sleepdep list */
164 static struct omap_hwmod *mpu_oh;
166 /* inited: 0 if omap_hwmod_init() has not yet been called; 1 otherwise */
170 /* Private functions */
173 * _update_sysc_cache - return the module OCP_SYSCONFIG register, keep copy
174 * @oh: struct omap_hwmod *
176 * Load the current value of the hwmod OCP_SYSCONFIG register into the
177 * struct omap_hwmod for later use. Returns -EINVAL if the hwmod has no
178 * OCP_SYSCONFIG register or 0 upon success.
180 static int _update_sysc_cache(struct omap_hwmod *oh)
182 if (!oh->class->sysc) {
183 WARN(1, "omap_hwmod: %s: cannot read OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
187 /* XXX ensure module interface clock is up */
189 oh->_sysc_cache = omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
191 if (!(oh->class->sysc->sysc_flags & SYSC_NO_CACHE))
192 oh->_int_flags |= _HWMOD_SYSCONFIG_LOADED;
198 * _write_sysconfig - write a value to the module's OCP_SYSCONFIG register
199 * @v: OCP_SYSCONFIG value to write
200 * @oh: struct omap_hwmod *
202 * Write @v into the module class' OCP_SYSCONFIG register, if it has
203 * one. No return value.
205 static void _write_sysconfig(u32 v, struct omap_hwmod *oh)
207 if (!oh->class->sysc) {
208 WARN(1, "omap_hwmod: %s: cannot write OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
212 /* XXX ensure module interface clock is up */
214 /* Module might have lost context, always update cache and register */
216 omap_hwmod_write(v, oh, oh->class->sysc->sysc_offs);
220 * _set_master_standbymode: set the OCP_SYSCONFIG MIDLEMODE field in @v
221 * @oh: struct omap_hwmod *
222 * @standbymode: MIDLEMODE field bits
223 * @v: pointer to register contents to modify
225 * Update the master standby mode bits in @v to be @standbymode for
226 * the @oh hwmod. Does not write to the hardware. Returns -EINVAL
227 * upon error or 0 upon success.
229 static int _set_master_standbymode(struct omap_hwmod *oh, u8 standbymode,
235 if (!oh->class->sysc ||
236 !(oh->class->sysc->sysc_flags & SYSC_HAS_MIDLEMODE))
239 if (!oh->class->sysc->sysc_fields) {
240 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
244 mstandby_shift = oh->class->sysc->sysc_fields->midle_shift;
245 mstandby_mask = (0x3 << mstandby_shift);
247 *v &= ~mstandby_mask;
248 *v |= __ffs(standbymode) << mstandby_shift;
254 * _set_slave_idlemode: set the OCP_SYSCONFIG SIDLEMODE field in @v
255 * @oh: struct omap_hwmod *
256 * @idlemode: SIDLEMODE field bits
257 * @v: pointer to register contents to modify
259 * Update the slave idle mode bits in @v to be @idlemode for the @oh
260 * hwmod. Does not write to the hardware. Returns -EINVAL upon error
263 static int _set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode, u32 *v)
268 if (!oh->class->sysc ||
269 !(oh->class->sysc->sysc_flags & SYSC_HAS_SIDLEMODE))
272 if (!oh->class->sysc->sysc_fields) {
273 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
277 sidle_shift = oh->class->sysc->sysc_fields->sidle_shift;
278 sidle_mask = (0x3 << sidle_shift);
281 *v |= __ffs(idlemode) << sidle_shift;
287 * _set_clockactivity: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
288 * @oh: struct omap_hwmod *
289 * @clockact: CLOCKACTIVITY field bits
290 * @v: pointer to register contents to modify
292 * Update the clockactivity mode bits in @v to be @clockact for the
293 * @oh hwmod. Used for additional powersaving on some modules. Does
294 * not write to the hardware. Returns -EINVAL upon error or 0 upon
297 static int _set_clockactivity(struct omap_hwmod *oh, u8 clockact, u32 *v)
302 if (!oh->class->sysc ||
303 !(oh->class->sysc->sysc_flags & SYSC_HAS_CLOCKACTIVITY))
306 if (!oh->class->sysc->sysc_fields) {
307 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
311 clkact_shift = oh->class->sysc->sysc_fields->clkact_shift;
312 clkact_mask = (0x3 << clkact_shift);
315 *v |= clockact << clkact_shift;
321 * _set_softreset: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
322 * @oh: struct omap_hwmod *
323 * @v: pointer to register contents to modify
325 * Set the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
326 * error or 0 upon success.
328 static int _set_softreset(struct omap_hwmod *oh, u32 *v)
332 if (!oh->class->sysc ||
333 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
336 if (!oh->class->sysc->sysc_fields) {
337 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
341 softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
349 * _set_module_autoidle: set the OCP_SYSCONFIG AUTOIDLE field in @v
350 * @oh: struct omap_hwmod *
351 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
352 * @v: pointer to register contents to modify
354 * Update the module autoidle bit in @v to be @autoidle for the @oh
355 * hwmod. The autoidle bit controls whether the module can gate
356 * internal clocks automatically when it isn't doing anything; the
357 * exact function of this bit varies on a per-module basis. This
358 * function does not write to the hardware. Returns -EINVAL upon
359 * error or 0 upon success.
361 static int _set_module_autoidle(struct omap_hwmod *oh, u8 autoidle,
367 if (!oh->class->sysc ||
368 !(oh->class->sysc->sysc_flags & SYSC_HAS_AUTOIDLE))
371 if (!oh->class->sysc->sysc_fields) {
372 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
376 autoidle_shift = oh->class->sysc->sysc_fields->autoidle_shift;
377 autoidle_mask = (0x3 << autoidle_shift);
379 *v &= ~autoidle_mask;
380 *v |= autoidle << autoidle_shift;
386 * _enable_wakeup: set OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
387 * @oh: struct omap_hwmod *
389 * Allow the hardware module @oh to send wakeups. Returns -EINVAL
390 * upon error or 0 upon success.
392 static int _enable_wakeup(struct omap_hwmod *oh)
396 if (!oh->class->sysc ||
397 !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
400 if (!oh->class->sysc->sysc_fields) {
401 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
405 wakeup_mask = (0x1 << oh->class->sysc->sysc_fields->enwkup_shift);
409 _write_sysconfig(v, oh);
411 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
413 oh->_int_flags |= _HWMOD_WAKEUP_ENABLED;
419 * _disable_wakeup: clear OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
420 * @oh: struct omap_hwmod *
422 * Prevent the hardware module @oh to send wakeups. Returns -EINVAL
423 * upon error or 0 upon success.
425 static int _disable_wakeup(struct omap_hwmod *oh)
429 if (!oh->class->sysc ||
430 !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
433 if (!oh->class->sysc->sysc_fields) {
434 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
438 wakeup_mask = (0x1 << oh->class->sysc->sysc_fields->enwkup_shift);
442 _write_sysconfig(v, oh);
444 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
446 oh->_int_flags &= ~_HWMOD_WAKEUP_ENABLED;
452 * _add_initiator_dep: prevent @oh from smart-idling while @init_oh is active
453 * @oh: struct omap_hwmod *
455 * Prevent the hardware module @oh from entering idle while the
456 * hardare module initiator @init_oh is active. Useful when a module
457 * will be accessed by a particular initiator (e.g., if a module will
458 * be accessed by the IVA, there should be a sleepdep between the IVA
459 * initiator and the module). Only applies to modules in smart-idle
460 * mode. Returns -EINVAL upon error or passes along
461 * clkdm_add_sleepdep() value upon success.
463 static int _add_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
468 return clkdm_add_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
472 * _del_initiator_dep: allow @oh to smart-idle even if @init_oh is active
473 * @oh: struct omap_hwmod *
475 * Allow the hardware module @oh to enter idle while the hardare
476 * module initiator @init_oh is active. Useful when a module will not
477 * be accessed by a particular initiator (e.g., if a module will not
478 * be accessed by the IVA, there should be no sleepdep between the IVA
479 * initiator and the module). Only applies to modules in smart-idle
480 * mode. Returns -EINVAL upon error or passes along
481 * clkdm_del_sleepdep() value upon success.
483 static int _del_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
488 return clkdm_del_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
492 * _init_main_clk - get a struct clk * for the the hwmod's main functional clk
493 * @oh: struct omap_hwmod *
495 * Called from _init_clocks(). Populates the @oh _clk (main
496 * functional clock pointer) if a main_clk is present. Returns 0 on
497 * success or -EINVAL on error.
499 static int _init_main_clk(struct omap_hwmod *oh)
506 oh->_clk = omap_clk_get_by_name(oh->main_clk);
508 pr_warning("omap_hwmod: %s: cannot clk_get main_clk %s\n",
509 oh->name, oh->main_clk);
513 if (!oh->_clk->clkdm)
514 pr_warning("omap_hwmod: %s: missing clockdomain for %s.\n",
515 oh->main_clk, oh->_clk->name);
521 * _init_interface_clks - get a struct clk * for the the hwmod's interface clks
522 * @oh: struct omap_hwmod *
524 * Called from _init_clocks(). Populates the @oh OCP slave interface
525 * clock pointers. Returns 0 on success or -EINVAL on error.
527 static int _init_interface_clks(struct omap_hwmod *oh)
533 if (oh->slaves_cnt == 0)
536 for (i = 0; i < oh->slaves_cnt; i++) {
537 struct omap_hwmod_ocp_if *os = oh->slaves[i];
542 c = omap_clk_get_by_name(os->clk);
544 pr_warning("omap_hwmod: %s: cannot clk_get interface_clk %s\n",
555 * _init_opt_clk - get a struct clk * for the the hwmod's optional clocks
556 * @oh: struct omap_hwmod *
558 * Called from _init_clocks(). Populates the @oh omap_hwmod_opt_clk
559 * clock pointers. Returns 0 on success or -EINVAL on error.
561 static int _init_opt_clks(struct omap_hwmod *oh)
563 struct omap_hwmod_opt_clk *oc;
568 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++) {
569 c = omap_clk_get_by_name(oc->clk);
571 pr_warning("omap_hwmod: %s: cannot clk_get opt_clk %s\n",
582 * _enable_clocks - enable hwmod main clock and interface clocks
583 * @oh: struct omap_hwmod *
585 * Enables all clocks necessary for register reads and writes to succeed
586 * on the hwmod @oh. Returns 0.
588 static int _enable_clocks(struct omap_hwmod *oh)
592 pr_debug("omap_hwmod: %s: enabling clocks\n", oh->name);
595 clk_enable(oh->_clk);
597 if (oh->slaves_cnt > 0) {
598 for (i = 0; i < oh->slaves_cnt; i++) {
599 struct omap_hwmod_ocp_if *os = oh->slaves[i];
600 struct clk *c = os->_clk;
602 if (c && (os->flags & OCPIF_SWSUP_IDLE))
607 /* The opt clocks are controlled by the device driver. */
613 * _disable_clocks - disable hwmod main clock and interface clocks
614 * @oh: struct omap_hwmod *
616 * Disables the hwmod @oh main functional and interface clocks. Returns 0.
618 static int _disable_clocks(struct omap_hwmod *oh)
622 pr_debug("omap_hwmod: %s: disabling clocks\n", oh->name);
625 clk_disable(oh->_clk);
627 if (oh->slaves_cnt > 0) {
628 for (i = 0; i < oh->slaves_cnt; i++) {
629 struct omap_hwmod_ocp_if *os = oh->slaves[i];
630 struct clk *c = os->_clk;
632 if (c && (os->flags & OCPIF_SWSUP_IDLE))
637 /* The opt clocks are controlled by the device driver. */
642 static void _enable_optional_clocks(struct omap_hwmod *oh)
644 struct omap_hwmod_opt_clk *oc;
647 pr_debug("omap_hwmod: %s: enabling optional clocks\n", oh->name);
649 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
651 pr_debug("omap_hwmod: enable %s:%s\n", oc->role,
653 clk_enable(oc->_clk);
657 static void _disable_optional_clocks(struct omap_hwmod *oh)
659 struct omap_hwmod_opt_clk *oc;
662 pr_debug("omap_hwmod: %s: disabling optional clocks\n", oh->name);
664 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
666 pr_debug("omap_hwmod: disable %s:%s\n", oc->role,
668 clk_disable(oc->_clk);
673 * _find_mpu_port_index - find hwmod OCP slave port ID intended for MPU use
674 * @oh: struct omap_hwmod *
676 * Returns the array index of the OCP slave port that the MPU
677 * addresses the device on, or -EINVAL upon error or not found.
679 static int _find_mpu_port_index(struct omap_hwmod *oh)
684 if (!oh || oh->slaves_cnt == 0)
687 for (i = 0; i < oh->slaves_cnt; i++) {
688 struct omap_hwmod_ocp_if *os = oh->slaves[i];
690 if (os->user & OCP_USER_MPU) {
697 pr_debug("omap_hwmod: %s: MPU OCP slave port ID %d\n",
700 pr_debug("omap_hwmod: %s: no MPU OCP slave port found\n",
703 return (found) ? i : -EINVAL;
707 * _find_mpu_rt_base - find hwmod register target base addr accessible by MPU
708 * @oh: struct omap_hwmod *
710 * Return the virtual address of the base of the register target of
711 * device @oh, or NULL on error.
713 static void __iomem *_find_mpu_rt_base(struct omap_hwmod *oh, u8 index)
715 struct omap_hwmod_ocp_if *os;
716 struct omap_hwmod_addr_space *mem;
719 void __iomem *va_start;
721 if (!oh || oh->slaves_cnt == 0)
724 os = oh->slaves[index];
726 for (i = 0, mem = os->addr; i < os->addr_cnt; i++, mem++) {
727 if (mem->flags & ADDR_TYPE_RT) {
734 va_start = ioremap(mem->pa_start, mem->pa_end - mem->pa_start);
736 pr_err("omap_hwmod: %s: Could not ioremap\n", oh->name);
739 pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
742 pr_debug("omap_hwmod: %s: no MPU register target found\n",
746 return (found) ? va_start : NULL;
750 * _enable_sysc - try to bring a module out of idle via OCP_SYSCONFIG
751 * @oh: struct omap_hwmod *
753 * If module is marked as SWSUP_SIDLE, force the module out of slave
754 * idle; otherwise, configure it for smart-idle. If module is marked
755 * as SWSUP_MSUSPEND, force the module out of master standby;
756 * otherwise, configure it for smart-standby. No return value.
758 static void _enable_sysc(struct omap_hwmod *oh)
763 if (!oh->class->sysc)
767 sf = oh->class->sysc->sysc_flags;
769 if (sf & SYSC_HAS_SIDLEMODE) {
770 idlemode = (oh->flags & HWMOD_SWSUP_SIDLE) ?
771 HWMOD_IDLEMODE_NO : HWMOD_IDLEMODE_SMART;
772 _set_slave_idlemode(oh, idlemode, &v);
775 if (sf & SYSC_HAS_MIDLEMODE) {
776 idlemode = (oh->flags & HWMOD_SWSUP_MSTANDBY) ?
777 HWMOD_IDLEMODE_NO : HWMOD_IDLEMODE_SMART;
778 _set_master_standbymode(oh, idlemode, &v);
782 * XXX The clock framework should handle this, by
783 * calling into this code. But this must wait until the
784 * clock structures are tagged with omap_hwmod entries
786 if ((oh->flags & HWMOD_SET_DEFAULT_CLOCKACT) &&
787 (sf & SYSC_HAS_CLOCKACTIVITY))
788 _set_clockactivity(oh, oh->class->sysc->clockact, &v);
790 _write_sysconfig(v, oh);
792 /* If slave is in SMARTIDLE, also enable wakeup */
793 if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
797 * Set the autoidle bit only after setting the smartidle bit
798 * Setting this will not have any impact on the other modules.
800 if (sf & SYSC_HAS_AUTOIDLE) {
801 idlemode = (oh->flags & HWMOD_NO_OCP_AUTOIDLE) ?
803 _set_module_autoidle(oh, idlemode, &v);
804 _write_sysconfig(v, oh);
809 * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
810 * @oh: struct omap_hwmod *
812 * If module is marked as SWSUP_SIDLE, force the module into slave
813 * idle; otherwise, configure it for smart-idle. If module is marked
814 * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
815 * configure it for smart-standby. No return value.
817 static void _idle_sysc(struct omap_hwmod *oh)
822 if (!oh->class->sysc)
826 sf = oh->class->sysc->sysc_flags;
828 if (sf & SYSC_HAS_SIDLEMODE) {
829 idlemode = (oh->flags & HWMOD_SWSUP_SIDLE) ?
830 HWMOD_IDLEMODE_FORCE : HWMOD_IDLEMODE_SMART;
831 _set_slave_idlemode(oh, idlemode, &v);
834 if (sf & SYSC_HAS_MIDLEMODE) {
835 idlemode = (oh->flags & HWMOD_SWSUP_MSTANDBY) ?
836 HWMOD_IDLEMODE_FORCE : HWMOD_IDLEMODE_SMART;
837 _set_master_standbymode(oh, idlemode, &v);
840 _write_sysconfig(v, oh);
844 * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
845 * @oh: struct omap_hwmod *
847 * Force the module into slave idle and master suspend. No return
850 static void _shutdown_sysc(struct omap_hwmod *oh)
855 if (!oh->class->sysc)
859 sf = oh->class->sysc->sysc_flags;
861 if (sf & SYSC_HAS_SIDLEMODE)
862 _set_slave_idlemode(oh, HWMOD_IDLEMODE_FORCE, &v);
864 if (sf & SYSC_HAS_MIDLEMODE)
865 _set_master_standbymode(oh, HWMOD_IDLEMODE_FORCE, &v);
867 if (sf & SYSC_HAS_AUTOIDLE)
868 _set_module_autoidle(oh, 1, &v);
870 _write_sysconfig(v, oh);
874 * _lookup - find an omap_hwmod by name
875 * @name: find an omap_hwmod by name
877 * Return a pointer to an omap_hwmod by name, or NULL if not found.
878 * Caller must hold omap_hwmod_mutex.
880 static struct omap_hwmod *_lookup(const char *name)
882 struct omap_hwmod *oh, *temp_oh;
886 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
887 if (!strcmp(name, temp_oh->name)) {
897 * _init_clocks - clk_get() all clocks associated with this hwmod
898 * @oh: struct omap_hwmod *
899 * @data: not used; pass NULL
901 * Called by omap_hwmod_late_init() (after omap2_clk_init()).
902 * Resolves all clock names embedded in the hwmod. Returns -EINVAL if
903 * the omap_hwmod has not yet been registered or if the clocks have
904 * already been initialized, 0 on success, or a non-zero error on
907 static int _init_clocks(struct omap_hwmod *oh, void *data)
911 if (!oh || (oh->_state != _HWMOD_STATE_REGISTERED))
914 pr_debug("omap_hwmod: %s: looking up clocks\n", oh->name);
916 ret |= _init_main_clk(oh);
917 ret |= _init_interface_clks(oh);
918 ret |= _init_opt_clks(oh);
921 oh->_state = _HWMOD_STATE_CLKS_INITED;
927 * _wait_target_ready - wait for a module to leave slave idle
928 * @oh: struct omap_hwmod *
930 * Wait for a module @oh to leave slave idle. Returns 0 if the module
931 * does not have an IDLEST bit or if the module successfully leaves
932 * slave idle; otherwise, pass along the return value of the
933 * appropriate *_cm_wait_module_ready() function.
935 static int _wait_target_ready(struct omap_hwmod *oh)
937 struct omap_hwmod_ocp_if *os;
943 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
946 os = oh->slaves[oh->_mpu_port_index];
948 if (oh->flags & HWMOD_NO_IDLEST)
951 /* XXX check module SIDLEMODE */
953 /* XXX check clock enable states */
955 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
956 ret = omap2_cm_wait_module_ready(oh->prcm.omap2.module_offs,
957 oh->prcm.omap2.idlest_reg_id,
958 oh->prcm.omap2.idlest_idle_bit);
959 } else if (cpu_is_omap44xx()) {
960 ret = omap4_cm_wait_module_ready(oh->prcm.omap4.clkctrl_reg);
969 * _lookup_hardreset - return the register bit shift for this hwmod/reset line
970 * @oh: struct omap_hwmod *
971 * @name: name of the reset line in the context of this hwmod
973 * Return the bit position of the reset line that match the
974 * input name. Return -ENOENT if not found.
976 static u8 _lookup_hardreset(struct omap_hwmod *oh, const char *name)
980 for (i = 0; i < oh->rst_lines_cnt; i++) {
981 const char *rst_line = oh->rst_lines[i].name;
982 if (!strcmp(rst_line, name)) {
983 u8 shift = oh->rst_lines[i].rst_shift;
984 pr_debug("omap_hwmod: %s: _lookup_hardreset: %s: %d\n",
985 oh->name, rst_line, shift);
995 * _assert_hardreset - assert the HW reset line of submodules
996 * contained in the hwmod module.
997 * @oh: struct omap_hwmod *
998 * @name: name of the reset line to lookup and assert
1000 * Some IP like dsp, ipu or iva contain processor that require
1001 * an HW reset line to be assert / deassert in order to enable fully
1004 static int _assert_hardreset(struct omap_hwmod *oh, const char *name)
1011 shift = _lookup_hardreset(oh, name);
1012 if (IS_ERR_VALUE(shift))
1015 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1016 return omap2_prm_assert_hardreset(oh->prcm.omap2.module_offs,
1018 else if (cpu_is_omap44xx())
1019 return omap4_prm_assert_hardreset(oh->prcm.omap4.rstctrl_reg,
1026 * _deassert_hardreset - deassert the HW reset line of submodules contained
1027 * in the hwmod module.
1028 * @oh: struct omap_hwmod *
1029 * @name: name of the reset line to look up and deassert
1031 * Some IP like dsp, ipu or iva contain processor that require
1032 * an HW reset line to be assert / deassert in order to enable fully
1035 static int _deassert_hardreset(struct omap_hwmod *oh, const char *name)
1043 shift = _lookup_hardreset(oh, name);
1044 if (IS_ERR_VALUE(shift))
1047 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1048 r = omap2_prm_deassert_hardreset(oh->prcm.omap2.module_offs,
1050 else if (cpu_is_omap44xx())
1051 r = omap4_prm_deassert_hardreset(oh->prcm.omap4.rstctrl_reg,
1057 pr_warning("omap_hwmod: %s: failed to hardreset\n", oh->name);
1063 * _read_hardreset - read the HW reset line state of submodules
1064 * contained in the hwmod module
1065 * @oh: struct omap_hwmod *
1066 * @name: name of the reset line to look up and read
1068 * Return the state of the reset line.
1070 static int _read_hardreset(struct omap_hwmod *oh, const char *name)
1077 shift = _lookup_hardreset(oh, name);
1078 if (IS_ERR_VALUE(shift))
1081 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1082 return omap2_prm_is_hardreset_asserted(oh->prcm.omap2.module_offs,
1084 } else if (cpu_is_omap44xx()) {
1085 return omap4_prm_is_hardreset_asserted(oh->prcm.omap4.rstctrl_reg,
1093 * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1094 * @oh: struct omap_hwmod *
1096 * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit. hwmod must be
1097 * enabled for this to work. Returns -EINVAL if the hwmod cannot be
1098 * reset this way or if the hwmod is in the wrong state, -ETIMEDOUT if
1099 * the module did not reset in time, or 0 upon success.
1101 * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1102 * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1103 * use the SYSCONFIG softreset bit to provide the status.
1105 * Note that some IP like McBSP do have reset control but don't have
1108 static int _ocp_softreset(struct omap_hwmod *oh)
1114 if (!oh->class->sysc ||
1115 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
1118 /* clocks must be on for this operation */
1119 if (oh->_state != _HWMOD_STATE_ENABLED) {
1120 pr_warning("omap_hwmod: %s: reset can only be entered from "
1121 "enabled state\n", oh->name);
1125 /* For some modules, all optionnal clocks need to be enabled as well */
1126 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1127 _enable_optional_clocks(oh);
1129 pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh->name);
1131 v = oh->_sysc_cache;
1132 ret = _set_softreset(oh, &v);
1135 _write_sysconfig(v, oh);
1137 if (oh->class->sysc->sysc_flags & SYSS_HAS_RESET_STATUS)
1138 omap_test_timeout((omap_hwmod_read(oh,
1139 oh->class->sysc->syss_offs)
1140 & SYSS_RESETDONE_MASK),
1141 MAX_MODULE_SOFTRESET_WAIT, c);
1142 else if (oh->class->sysc->sysc_flags & SYSC_HAS_RESET_STATUS)
1143 omap_test_timeout(!(omap_hwmod_read(oh,
1144 oh->class->sysc->sysc_offs)
1145 & SYSC_TYPE2_SOFTRESET_MASK),
1146 MAX_MODULE_SOFTRESET_WAIT, c);
1148 if (c == MAX_MODULE_SOFTRESET_WAIT)
1149 pr_warning("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1150 oh->name, MAX_MODULE_SOFTRESET_WAIT);
1152 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh->name, c);
1155 * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1156 * _wait_target_ready() or _reset()
1159 ret = (c == MAX_MODULE_SOFTRESET_WAIT) ? -ETIMEDOUT : 0;
1162 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1163 _disable_optional_clocks(oh);
1169 * _reset - reset an omap_hwmod
1170 * @oh: struct omap_hwmod *
1172 * Resets an omap_hwmod @oh. The default software reset mechanism for
1173 * most OMAP IP blocks is triggered via the OCP_SYSCONFIG.SOFTRESET
1174 * bit. However, some hwmods cannot be reset via this method: some
1175 * are not targets and therefore have no OCP header registers to
1176 * access; others (like the IVA) have idiosyncratic reset sequences.
1177 * So for these relatively rare cases, custom reset code can be
1178 * supplied in the struct omap_hwmod_class .reset function pointer.
1179 * Passes along the return value from either _reset() or the custom
1180 * reset function - these must return -EINVAL if the hwmod cannot be
1181 * reset this way or if the hwmod is in the wrong state, -ETIMEDOUT if
1182 * the module did not reset in time, or 0 upon success.
1184 static int _reset(struct omap_hwmod *oh)
1188 pr_debug("omap_hwmod: %s: resetting\n", oh->name);
1190 ret = (oh->class->reset) ? oh->class->reset(oh) : _ocp_softreset(oh);
1196 * _enable - enable an omap_hwmod
1197 * @oh: struct omap_hwmod *
1199 * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
1200 * register target. Returns -EINVAL if the hwmod is in the wrong
1201 * state or passes along the return value of _wait_target_ready().
1203 static int _enable(struct omap_hwmod *oh)
1207 if (oh->_state != _HWMOD_STATE_INITIALIZED &&
1208 oh->_state != _HWMOD_STATE_IDLE &&
1209 oh->_state != _HWMOD_STATE_DISABLED) {
1210 WARN(1, "omap_hwmod: %s: enabled state can only be entered "
1211 "from initialized, idle, or disabled state\n", oh->name);
1215 pr_debug("omap_hwmod: %s: enabling\n", oh->name);
1218 * If an IP contains only one HW reset line, then de-assert it in order
1219 * to allow to enable the clocks. Otherwise the PRCM will return
1220 * Intransition status, and the init will failed.
1222 if ((oh->_state == _HWMOD_STATE_INITIALIZED ||
1223 oh->_state == _HWMOD_STATE_DISABLED) && oh->rst_lines_cnt == 1)
1224 _deassert_hardreset(oh, oh->rst_lines[0].name);
1228 _add_initiator_dep(oh, mpu_oh);
1231 r = _wait_target_ready(oh);
1233 oh->_state = _HWMOD_STATE_ENABLED;
1235 /* Access the sysconfig only if the target is ready */
1236 if (oh->class->sysc) {
1237 if (!(oh->_int_flags & _HWMOD_SYSCONFIG_LOADED))
1238 _update_sysc_cache(oh);
1242 pr_debug("omap_hwmod: %s: _wait_target_ready: %d\n",
1250 * _idle - idle an omap_hwmod
1251 * @oh: struct omap_hwmod *
1253 * Idles an omap_hwmod @oh. This should be called once the hwmod has
1254 * no further work. Returns -EINVAL if the hwmod is in the wrong
1255 * state or returns 0.
1257 static int _idle(struct omap_hwmod *oh)
1259 if (oh->_state != _HWMOD_STATE_ENABLED) {
1260 WARN(1, "omap_hwmod: %s: idle state can only be entered from "
1261 "enabled state\n", oh->name);
1265 pr_debug("omap_hwmod: %s: idling\n", oh->name);
1267 if (oh->class->sysc)
1269 _del_initiator_dep(oh, mpu_oh);
1270 _disable_clocks(oh);
1272 oh->_state = _HWMOD_STATE_IDLE;
1278 * _shutdown - shutdown an omap_hwmod
1279 * @oh: struct omap_hwmod *
1281 * Shut down an omap_hwmod @oh. This should be called when the driver
1282 * used for the hwmod is removed or unloaded or if the driver is not
1283 * used by the system. Returns -EINVAL if the hwmod is in the wrong
1284 * state or returns 0.
1286 static int _shutdown(struct omap_hwmod *oh)
1291 if (oh->_state != _HWMOD_STATE_IDLE &&
1292 oh->_state != _HWMOD_STATE_ENABLED) {
1293 WARN(1, "omap_hwmod: %s: disabled state can only be entered "
1294 "from idle, or enabled state\n", oh->name);
1298 pr_debug("omap_hwmod: %s: disabling\n", oh->name);
1300 if (oh->class->pre_shutdown) {
1301 prev_state = oh->_state;
1302 if (oh->_state == _HWMOD_STATE_IDLE)
1304 ret = oh->class->pre_shutdown(oh);
1306 if (prev_state == _HWMOD_STATE_IDLE)
1312 if (oh->class->sysc)
1316 * If an IP contains only one HW reset line, then assert it
1317 * before disabling the clocks and shutting down the IP.
1319 if (oh->rst_lines_cnt == 1)
1320 _assert_hardreset(oh, oh->rst_lines[0].name);
1322 /* clocks and deps are already disabled in idle */
1323 if (oh->_state == _HWMOD_STATE_ENABLED) {
1324 _del_initiator_dep(oh, mpu_oh);
1325 /* XXX what about the other system initiators here? dma, dsp */
1326 _disable_clocks(oh);
1328 /* XXX Should this code also force-disable the optional clocks? */
1330 /* XXX mux any associated balls to safe mode */
1332 oh->_state = _HWMOD_STATE_DISABLED;
1338 * _setup - do initial configuration of omap_hwmod
1339 * @oh: struct omap_hwmod *
1341 * Writes the CLOCKACTIVITY bits @clockact to the hwmod @oh
1342 * OCP_SYSCONFIG register. Returns -EINVAL if the hwmod is in the
1343 * wrong state or returns 0.
1345 static int _setup(struct omap_hwmod *oh, void *data)
1350 /* Set iclk autoidle mode */
1351 if (oh->slaves_cnt > 0) {
1352 for (i = 0; i < oh->slaves_cnt; i++) {
1353 struct omap_hwmod_ocp_if *os = oh->slaves[i];
1354 struct clk *c = os->_clk;
1359 if (os->flags & OCPIF_SWSUP_IDLE) {
1360 /* XXX omap_iclk_deny_idle(c); */
1362 /* XXX omap_iclk_allow_idle(c); */
1368 oh->_state = _HWMOD_STATE_INITIALIZED;
1371 * In the case of hwmod with hardreset that should not be
1372 * de-assert at boot time, we have to keep the module
1373 * initialized, because we cannot enable it properly with the
1374 * reset asserted. Exit without warning because that behavior is
1377 if ((oh->flags & HWMOD_INIT_NO_RESET) && oh->rst_lines_cnt == 1)
1382 pr_warning("omap_hwmod: %s: cannot be enabled (%d)\n",
1383 oh->name, oh->_state);
1387 if (!(oh->flags & HWMOD_INIT_NO_RESET)) {
1391 * OCP_SYSCONFIG bits need to be reprogrammed after a softreset.
1392 * The _enable() function should be split to
1393 * avoid the rewrite of the OCP_SYSCONFIG register.
1395 if (oh->class->sysc) {
1396 _update_sysc_cache(oh);
1401 postsetup_state = oh->_postsetup_state;
1402 if (postsetup_state == _HWMOD_STATE_UNKNOWN)
1403 postsetup_state = _HWMOD_STATE_ENABLED;
1406 * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
1407 * it should be set by the core code as a runtime flag during startup
1409 if ((oh->flags & HWMOD_INIT_NO_IDLE) &&
1410 (postsetup_state == _HWMOD_STATE_IDLE))
1411 postsetup_state = _HWMOD_STATE_ENABLED;
1413 if (postsetup_state == _HWMOD_STATE_IDLE)
1415 else if (postsetup_state == _HWMOD_STATE_DISABLED)
1417 else if (postsetup_state != _HWMOD_STATE_ENABLED)
1418 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
1419 oh->name, postsetup_state);
1426 /* Public functions */
1428 u32 omap_hwmod_read(struct omap_hwmod *oh, u16 reg_offs)
1430 if (oh->flags & HWMOD_16BIT_REG)
1431 return __raw_readw(oh->_mpu_rt_va + reg_offs);
1433 return __raw_readl(oh->_mpu_rt_va + reg_offs);
1436 void omap_hwmod_write(u32 v, struct omap_hwmod *oh, u16 reg_offs)
1438 if (oh->flags & HWMOD_16BIT_REG)
1439 __raw_writew(v, oh->_mpu_rt_va + reg_offs);
1441 __raw_writel(v, oh->_mpu_rt_va + reg_offs);
1445 * omap_hwmod_set_slave_idlemode - set the hwmod's OCP slave idlemode
1446 * @oh: struct omap_hwmod *
1447 * @idlemode: SIDLEMODE field bits (shifted to bit 0)
1449 * Sets the IP block's OCP slave idlemode in hardware, and updates our
1450 * local copy. Intended to be used by drivers that have some erratum
1451 * that requires direct manipulation of the SIDLEMODE bits. Returns
1452 * -EINVAL if @oh is null, or passes along the return value from
1453 * _set_slave_idlemode().
1455 * XXX Does this function have any current users? If not, we should
1456 * remove it; it is better to let the rest of the hwmod code handle this.
1457 * Any users of this function should be scrutinized carefully.
1459 int omap_hwmod_set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode)
1467 v = oh->_sysc_cache;
1469 retval = _set_slave_idlemode(oh, idlemode, &v);
1471 _write_sysconfig(v, oh);
1477 * omap_hwmod_register - register a struct omap_hwmod
1478 * @oh: struct omap_hwmod *
1480 * Registers the omap_hwmod @oh. Returns -EEXIST if an omap_hwmod
1481 * already has been registered by the same name; -EINVAL if the
1482 * omap_hwmod is in the wrong state, if @oh is NULL, if the
1483 * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
1484 * name, or if the omap_hwmod's class is missing a name; or 0 upon
1487 * XXX The data should be copied into bootmem, so the original data
1488 * should be marked __initdata and freed after init. This would allow
1489 * unneeded omap_hwmods to be freed on multi-OMAP configurations. Note
1490 * that the copy process would be relatively complex due to the large number
1493 int omap_hwmod_register(struct omap_hwmod *oh)
1497 if (!oh || !oh->name || !oh->class || !oh->class->name ||
1498 (oh->_state != _HWMOD_STATE_UNKNOWN))
1501 mutex_lock(&omap_hwmod_mutex);
1503 pr_debug("omap_hwmod: %s: registering\n", oh->name);
1505 if (_lookup(oh->name)) {
1510 ms_id = _find_mpu_port_index(oh);
1511 if (!IS_ERR_VALUE(ms_id)) {
1512 oh->_mpu_port_index = ms_id;
1513 oh->_mpu_rt_va = _find_mpu_rt_base(oh, oh->_mpu_port_index);
1515 oh->_int_flags |= _HWMOD_NO_MPU_PORT;
1518 list_add_tail(&oh->node, &omap_hwmod_list);
1520 spin_lock_init(&oh->_lock);
1522 oh->_state = _HWMOD_STATE_REGISTERED;
1527 mutex_unlock(&omap_hwmod_mutex);
1532 * omap_hwmod_lookup - look up a registered omap_hwmod by name
1533 * @name: name of the omap_hwmod to look up
1535 * Given a @name of an omap_hwmod, return a pointer to the registered
1536 * struct omap_hwmod *, or NULL upon error.
1538 struct omap_hwmod *omap_hwmod_lookup(const char *name)
1540 struct omap_hwmod *oh;
1545 mutex_lock(&omap_hwmod_mutex);
1547 mutex_unlock(&omap_hwmod_mutex);
1553 * omap_hwmod_for_each - call function for each registered omap_hwmod
1554 * @fn: pointer to a callback function
1555 * @data: void * data to pass to callback function
1557 * Call @fn for each registered omap_hwmod, passing @data to each
1558 * function. @fn must return 0 for success or any other value for
1559 * failure. If @fn returns non-zero, the iteration across omap_hwmods
1560 * will stop and the non-zero return value will be passed to the
1561 * caller of omap_hwmod_for_each(). @fn is called with
1562 * omap_hwmod_for_each() held.
1564 int omap_hwmod_for_each(int (*fn)(struct omap_hwmod *oh, void *data),
1567 struct omap_hwmod *temp_oh;
1573 mutex_lock(&omap_hwmod_mutex);
1574 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1575 ret = (*fn)(temp_oh, data);
1579 mutex_unlock(&omap_hwmod_mutex);
1586 * omap_hwmod_init - init omap_hwmod code and register hwmods
1587 * @ohs: pointer to an array of omap_hwmods to register
1589 * Intended to be called early in boot before the clock framework is
1590 * initialized. If @ohs is not null, will register all omap_hwmods
1591 * listed in @ohs that are valid for this chip. Returns -EINVAL if
1592 * omap_hwmod_init() has already been called or 0 otherwise.
1594 int omap_hwmod_init(struct omap_hwmod **ohs)
1596 struct omap_hwmod *oh;
1609 if (omap_chip_is(oh->omap_chip)) {
1610 r = omap_hwmod_register(oh);
1611 WARN(r, "omap_hwmod: %s: omap_hwmod_register returned "
1612 "%d\n", oh->name, r);
1621 * omap_hwmod_late_init - do some post-clock framework initialization
1623 * Must be called after omap2_clk_init(). Resolves the struct clk names
1624 * to struct clk pointers for each registered omap_hwmod. Also calls
1625 * _setup() on each hwmod. Returns 0.
1627 int omap_hwmod_late_init(void)
1631 /* XXX check return value */
1632 r = omap_hwmod_for_each(_init_clocks, NULL);
1633 WARN(r, "omap_hwmod: omap_hwmod_late_init(): _init_clocks failed\n");
1635 mpu_oh = omap_hwmod_lookup(MPU_INITIATOR_NAME);
1636 WARN(!mpu_oh, "omap_hwmod: could not find MPU initiator hwmod %s\n",
1637 MPU_INITIATOR_NAME);
1639 omap_hwmod_for_each(_setup, NULL);
1645 * omap_hwmod_unregister - unregister an omap_hwmod
1646 * @oh: struct omap_hwmod *
1648 * Unregisters a previously-registered omap_hwmod @oh. There's probably
1649 * no use case for this, so it is likely to be removed in a later version.
1651 * XXX Free all of the bootmem-allocated structures here when that is
1652 * implemented. Make it clear that core code is the only code that is
1653 * expected to unregister modules.
1655 int omap_hwmod_unregister(struct omap_hwmod *oh)
1660 pr_debug("omap_hwmod: %s: unregistering\n", oh->name);
1662 mutex_lock(&omap_hwmod_mutex);
1663 iounmap(oh->_mpu_rt_va);
1664 list_del(&oh->node);
1665 mutex_unlock(&omap_hwmod_mutex);
1671 * omap_hwmod_enable - enable an omap_hwmod
1672 * @oh: struct omap_hwmod *
1674 * Enable an omap_hwmod @oh. Intended to be called by omap_device_enable().
1675 * Returns -EINVAL on error or passes along the return value from _enable().
1677 int omap_hwmod_enable(struct omap_hwmod *oh)
1680 unsigned long flags;
1685 spin_lock_irqsave(&oh->_lock, flags);
1687 spin_unlock_irqrestore(&oh->_lock, flags);
1693 * omap_hwmod_idle - idle an omap_hwmod
1694 * @oh: struct omap_hwmod *
1696 * Idle an omap_hwmod @oh. Intended to be called by omap_device_idle().
1697 * Returns -EINVAL on error or passes along the return value from _idle().
1699 int omap_hwmod_idle(struct omap_hwmod *oh)
1701 unsigned long flags;
1706 spin_lock_irqsave(&oh->_lock, flags);
1708 spin_unlock_irqrestore(&oh->_lock, flags);
1714 * omap_hwmod_shutdown - shutdown an omap_hwmod
1715 * @oh: struct omap_hwmod *
1717 * Shutdown an omap_hwmod @oh. Intended to be called by
1718 * omap_device_shutdown(). Returns -EINVAL on error or passes along
1719 * the return value from _shutdown().
1721 int omap_hwmod_shutdown(struct omap_hwmod *oh)
1723 unsigned long flags;
1728 spin_lock_irqsave(&oh->_lock, flags);
1730 spin_unlock_irqrestore(&oh->_lock, flags);
1736 * omap_hwmod_enable_clocks - enable main_clk, all interface clocks
1737 * @oh: struct omap_hwmod *oh
1739 * Intended to be called by the omap_device code.
1741 int omap_hwmod_enable_clocks(struct omap_hwmod *oh)
1743 unsigned long flags;
1745 spin_lock_irqsave(&oh->_lock, flags);
1747 spin_unlock_irqrestore(&oh->_lock, flags);
1753 * omap_hwmod_disable_clocks - disable main_clk, all interface clocks
1754 * @oh: struct omap_hwmod *oh
1756 * Intended to be called by the omap_device code.
1758 int omap_hwmod_disable_clocks(struct omap_hwmod *oh)
1760 unsigned long flags;
1762 spin_lock_irqsave(&oh->_lock, flags);
1763 _disable_clocks(oh);
1764 spin_unlock_irqrestore(&oh->_lock, flags);
1770 * omap_hwmod_ocp_barrier - wait for posted writes against the hwmod to complete
1771 * @oh: struct omap_hwmod *oh
1773 * Intended to be called by drivers and core code when all posted
1774 * writes to a device must complete before continuing further
1775 * execution (for example, after clearing some device IRQSTATUS
1778 * XXX what about targets with multiple OCP threads?
1780 void omap_hwmod_ocp_barrier(struct omap_hwmod *oh)
1784 if (!oh->class->sysc || !oh->class->sysc->sysc_flags) {
1785 WARN(1, "omap_device: %s: OCP barrier impossible due to "
1786 "device configuration\n", oh->name);
1791 * Forces posted writes to complete on the OCP thread handling
1794 omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
1798 * omap_hwmod_reset - reset the hwmod
1799 * @oh: struct omap_hwmod *
1801 * Under some conditions, a driver may wish to reset the entire device.
1802 * Called from omap_device code. Returns -EINVAL on error or passes along
1803 * the return value from _reset().
1805 int omap_hwmod_reset(struct omap_hwmod *oh)
1808 unsigned long flags;
1813 spin_lock_irqsave(&oh->_lock, flags);
1815 spin_unlock_irqrestore(&oh->_lock, flags);
1821 * omap_hwmod_count_resources - count number of struct resources needed by hwmod
1822 * @oh: struct omap_hwmod *
1823 * @res: pointer to the first element of an array of struct resource to fill
1825 * Count the number of struct resource array elements necessary to
1826 * contain omap_hwmod @oh resources. Intended to be called by code
1827 * that registers omap_devices. Intended to be used to determine the
1828 * size of a dynamically-allocated struct resource array, before
1829 * calling omap_hwmod_fill_resources(). Returns the number of struct
1830 * resource array elements needed.
1832 * XXX This code is not optimized. It could attempt to merge adjacent
1836 int omap_hwmod_count_resources(struct omap_hwmod *oh)
1840 ret = oh->mpu_irqs_cnt + oh->sdma_reqs_cnt;
1842 for (i = 0; i < oh->slaves_cnt; i++)
1843 ret += oh->slaves[i]->addr_cnt;
1849 * omap_hwmod_fill_resources - fill struct resource array with hwmod data
1850 * @oh: struct omap_hwmod *
1851 * @res: pointer to the first element of an array of struct resource to fill
1853 * Fill the struct resource array @res with resource data from the
1854 * omap_hwmod @oh. Intended to be called by code that registers
1855 * omap_devices. See also omap_hwmod_count_resources(). Returns the
1856 * number of array elements filled.
1858 int omap_hwmod_fill_resources(struct omap_hwmod *oh, struct resource *res)
1863 /* For each IRQ, DMA, memory area, fill in array.*/
1865 for (i = 0; i < oh->mpu_irqs_cnt; i++) {
1866 (res + r)->name = (oh->mpu_irqs + i)->name;
1867 (res + r)->start = (oh->mpu_irqs + i)->irq;
1868 (res + r)->end = (oh->mpu_irqs + i)->irq;
1869 (res + r)->flags = IORESOURCE_IRQ;
1873 for (i = 0; i < oh->sdma_reqs_cnt; i++) {
1874 (res + r)->name = (oh->sdma_reqs + i)->name;
1875 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
1876 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
1877 (res + r)->flags = IORESOURCE_DMA;
1881 for (i = 0; i < oh->slaves_cnt; i++) {
1882 struct omap_hwmod_ocp_if *os;
1886 for (j = 0; j < os->addr_cnt; j++) {
1887 (res + r)->start = (os->addr + j)->pa_start;
1888 (res + r)->end = (os->addr + j)->pa_end;
1889 (res + r)->flags = IORESOURCE_MEM;
1898 * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
1899 * @oh: struct omap_hwmod *
1901 * Return the powerdomain pointer associated with the OMAP module
1902 * @oh's main clock. If @oh does not have a main clk, return the
1903 * powerdomain associated with the interface clock associated with the
1904 * module's MPU port. (XXX Perhaps this should use the SDMA port
1905 * instead?) Returns NULL on error, or a struct powerdomain * on
1908 struct powerdomain *omap_hwmod_get_pwrdm(struct omap_hwmod *oh)
1918 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
1920 c = oh->slaves[oh->_mpu_port_index]->_clk;
1926 return c->clkdm->pwrdm.ptr;
1931 * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
1932 * @oh: struct omap_hwmod *
1934 * Returns the virtual address corresponding to the beginning of the
1935 * module's register target, in the address range that is intended to
1936 * be used by the MPU. Returns the virtual address upon success or NULL
1939 void __iomem *omap_hwmod_get_mpu_rt_va(struct omap_hwmod *oh)
1944 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
1947 if (oh->_state == _HWMOD_STATE_UNKNOWN)
1950 return oh->_mpu_rt_va;
1954 * omap_hwmod_add_initiator_dep - add sleepdep from @init_oh to @oh
1955 * @oh: struct omap_hwmod *
1956 * @init_oh: struct omap_hwmod * (initiator)
1958 * Add a sleep dependency between the initiator @init_oh and @oh.
1959 * Intended to be called by DSP/Bridge code via platform_data for the
1960 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
1961 * code needs to add/del initiator dependencies dynamically
1962 * before/after accessing a device. Returns the return value from
1963 * _add_initiator_dep().
1965 * XXX Keep a usecount in the clockdomain code
1967 int omap_hwmod_add_initiator_dep(struct omap_hwmod *oh,
1968 struct omap_hwmod *init_oh)
1970 return _add_initiator_dep(oh, init_oh);
1974 * XXX what about functions for drivers to save/restore ocp_sysconfig
1975 * for context save/restore operations?
1979 * omap_hwmod_del_initiator_dep - remove sleepdep from @init_oh to @oh
1980 * @oh: struct omap_hwmod *
1981 * @init_oh: struct omap_hwmod * (initiator)
1983 * Remove a sleep dependency between the initiator @init_oh and @oh.
1984 * Intended to be called by DSP/Bridge code via platform_data for the
1985 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
1986 * code needs to add/del initiator dependencies dynamically
1987 * before/after accessing a device. Returns the return value from
1988 * _del_initiator_dep().
1990 * XXX Keep a usecount in the clockdomain code
1992 int omap_hwmod_del_initiator_dep(struct omap_hwmod *oh,
1993 struct omap_hwmod *init_oh)
1995 return _del_initiator_dep(oh, init_oh);
1999 * omap_hwmod_enable_wakeup - allow device to wake up the system
2000 * @oh: struct omap_hwmod *
2002 * Sets the module OCP socket ENAWAKEUP bit to allow the module to
2003 * send wakeups to the PRCM. Eventually this should sets PRCM wakeup
2004 * registers to cause the PRCM to receive wakeup events from the
2005 * module. Does not set any wakeup routing registers beyond this
2006 * point - if the module is to wake up any other module or subsystem,
2007 * that must be set separately. Called by omap_device code. Returns
2008 * -EINVAL on error or 0 upon success.
2010 int omap_hwmod_enable_wakeup(struct omap_hwmod *oh)
2012 unsigned long flags;
2014 if (!oh->class->sysc ||
2015 !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
2018 spin_lock_irqsave(&oh->_lock, flags);
2020 spin_unlock_irqrestore(&oh->_lock, flags);
2026 * omap_hwmod_disable_wakeup - prevent device from waking the system
2027 * @oh: struct omap_hwmod *
2029 * Clears the module OCP socket ENAWAKEUP bit to prevent the module
2030 * from sending wakeups to the PRCM. Eventually this should clear
2031 * PRCM wakeup registers to cause the PRCM to ignore wakeup events
2032 * from the module. Does not set any wakeup routing registers beyond
2033 * this point - if the module is to wake up any other module or
2034 * subsystem, that must be set separately. Called by omap_device
2035 * code. Returns -EINVAL on error or 0 upon success.
2037 int omap_hwmod_disable_wakeup(struct omap_hwmod *oh)
2039 unsigned long flags;
2041 if (!oh->class->sysc ||
2042 !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
2045 spin_lock_irqsave(&oh->_lock, flags);
2046 _disable_wakeup(oh);
2047 spin_unlock_irqrestore(&oh->_lock, flags);
2053 * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
2054 * contained in the hwmod module.
2055 * @oh: struct omap_hwmod *
2056 * @name: name of the reset line to lookup and assert
2058 * Some IP like dsp, ipu or iva contain processor that require
2059 * an HW reset line to be assert / deassert in order to enable fully
2060 * the IP. Returns -EINVAL if @oh is null or if the operation is not
2061 * yet supported on this OMAP; otherwise, passes along the return value
2062 * from _assert_hardreset().
2064 int omap_hwmod_assert_hardreset(struct omap_hwmod *oh, const char *name)
2067 unsigned long flags;
2072 spin_lock_irqsave(&oh->_lock, flags);
2073 ret = _assert_hardreset(oh, name);
2074 spin_unlock_irqrestore(&oh->_lock, flags);
2080 * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
2081 * contained in the hwmod module.
2082 * @oh: struct omap_hwmod *
2083 * @name: name of the reset line to look up and deassert
2085 * Some IP like dsp, ipu or iva contain processor that require
2086 * an HW reset line to be assert / deassert in order to enable fully
2087 * the IP. Returns -EINVAL if @oh is null or if the operation is not
2088 * yet supported on this OMAP; otherwise, passes along the return value
2089 * from _deassert_hardreset().
2091 int omap_hwmod_deassert_hardreset(struct omap_hwmod *oh, const char *name)
2094 unsigned long flags;
2099 spin_lock_irqsave(&oh->_lock, flags);
2100 ret = _deassert_hardreset(oh, name);
2101 spin_unlock_irqrestore(&oh->_lock, flags);
2107 * omap_hwmod_read_hardreset - read the HW reset line state of submodules
2108 * contained in the hwmod module
2109 * @oh: struct omap_hwmod *
2110 * @name: name of the reset line to look up and read
2112 * Return the current state of the hwmod @oh's reset line named @name:
2113 * returns -EINVAL upon parameter error or if this operation
2114 * is unsupported on the current OMAP; otherwise, passes along the return
2115 * value from _read_hardreset().
2117 int omap_hwmod_read_hardreset(struct omap_hwmod *oh, const char *name)
2120 unsigned long flags;
2125 spin_lock_irqsave(&oh->_lock, flags);
2126 ret = _read_hardreset(oh, name);
2127 spin_unlock_irqrestore(&oh->_lock, flags);
2134 * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
2135 * @classname: struct omap_hwmod_class name to search for
2136 * @fn: callback function pointer to call for each hwmod in class @classname
2137 * @user: arbitrary context data to pass to the callback function
2139 * For each omap_hwmod of class @classname, call @fn. Takes
2140 * omap_hwmod_mutex to prevent the hwmod list from changing during the
2141 * iteration. If the callback function returns something other than
2142 * zero, the iterator is terminated, and the callback function's return
2143 * value is passed back to the caller. Returns 0 upon success, -EINVAL
2144 * if @classname or @fn are NULL, or passes back the error code from @fn.
2146 int omap_hwmod_for_each_by_class(const char *classname,
2147 int (*fn)(struct omap_hwmod *oh,
2151 struct omap_hwmod *temp_oh;
2154 if (!classname || !fn)
2157 pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
2158 __func__, classname);
2160 mutex_lock(&omap_hwmod_mutex);
2162 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
2163 if (!strcmp(temp_oh->class->name, classname)) {
2164 pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
2165 __func__, temp_oh->name);
2166 ret = (*fn)(temp_oh, user);
2172 mutex_unlock(&omap_hwmod_mutex);
2175 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
2182 * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
2183 * @oh: struct omap_hwmod *
2184 * @state: state that _setup() should leave the hwmod in
2186 * Sets the hwmod state that @oh will enter at the end of _setup() (called by
2187 * omap_hwmod_late_init()). Only valid to call between calls to
2188 * omap_hwmod_init() and omap_hwmod_late_init(). Returns 0 upon success or
2189 * -EINVAL if there is a problem with the arguments or if the hwmod is
2190 * in the wrong state.
2192 int omap_hwmod_set_postsetup_state(struct omap_hwmod *oh, u8 state)
2195 unsigned long flags;
2200 if (state != _HWMOD_STATE_DISABLED &&
2201 state != _HWMOD_STATE_ENABLED &&
2202 state != _HWMOD_STATE_IDLE)
2205 spin_lock_irqsave(&oh->_lock, flags);
2207 if (oh->_state != _HWMOD_STATE_REGISTERED) {
2212 oh->_postsetup_state = state;
2216 spin_unlock_irqrestore(&oh->_lock, flags);