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>
148 #include "cm2xxx_3xxx.h"
150 #include "prm2xxx_3xxx.h"
153 /* Maximum microseconds to wait for OMAP module to softreset */
154 #define MAX_MODULE_SOFTRESET_WAIT 10000
156 /* Name of the OMAP hwmod for the MPU */
157 #define MPU_INITIATOR_NAME "mpu"
159 /* omap_hwmod_list contains all registered struct omap_hwmods */
160 static LIST_HEAD(omap_hwmod_list);
162 static DEFINE_MUTEX(omap_hwmod_mutex);
164 /* mpu_oh: used to add/remove MPU initiator from sleepdep list */
165 static struct omap_hwmod *mpu_oh;
167 /* inited: 0 if omap_hwmod_init() has not yet been called; 1 otherwise */
171 /* Private functions */
174 * _update_sysc_cache - return the module OCP_SYSCONFIG register, keep copy
175 * @oh: struct omap_hwmod *
177 * Load the current value of the hwmod OCP_SYSCONFIG register into the
178 * struct omap_hwmod for later use. Returns -EINVAL if the hwmod has no
179 * OCP_SYSCONFIG register or 0 upon success.
181 static int _update_sysc_cache(struct omap_hwmod *oh)
183 if (!oh->class->sysc) {
184 WARN(1, "omap_hwmod: %s: cannot read OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
188 /* XXX ensure module interface clock is up */
190 oh->_sysc_cache = omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
192 if (!(oh->class->sysc->sysc_flags & SYSC_NO_CACHE))
193 oh->_int_flags |= _HWMOD_SYSCONFIG_LOADED;
199 * _write_sysconfig - write a value to the module's OCP_SYSCONFIG register
200 * @v: OCP_SYSCONFIG value to write
201 * @oh: struct omap_hwmod *
203 * Write @v into the module class' OCP_SYSCONFIG register, if it has
204 * one. No return value.
206 static void _write_sysconfig(u32 v, struct omap_hwmod *oh)
208 if (!oh->class->sysc) {
209 WARN(1, "omap_hwmod: %s: cannot write OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
213 /* XXX ensure module interface clock is up */
215 /* Module might have lost context, always update cache and register */
217 omap_hwmod_write(v, oh, oh->class->sysc->sysc_offs);
221 * _set_master_standbymode: set the OCP_SYSCONFIG MIDLEMODE field in @v
222 * @oh: struct omap_hwmod *
223 * @standbymode: MIDLEMODE field bits
224 * @v: pointer to register contents to modify
226 * Update the master standby mode bits in @v to be @standbymode for
227 * the @oh hwmod. Does not write to the hardware. Returns -EINVAL
228 * upon error or 0 upon success.
230 static int _set_master_standbymode(struct omap_hwmod *oh, u8 standbymode,
236 if (!oh->class->sysc ||
237 !(oh->class->sysc->sysc_flags & SYSC_HAS_MIDLEMODE))
240 if (!oh->class->sysc->sysc_fields) {
241 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
245 mstandby_shift = oh->class->sysc->sysc_fields->midle_shift;
246 mstandby_mask = (0x3 << mstandby_shift);
248 *v &= ~mstandby_mask;
249 *v |= __ffs(standbymode) << mstandby_shift;
255 * _set_slave_idlemode: set the OCP_SYSCONFIG SIDLEMODE field in @v
256 * @oh: struct omap_hwmod *
257 * @idlemode: SIDLEMODE field bits
258 * @v: pointer to register contents to modify
260 * Update the slave idle mode bits in @v to be @idlemode for the @oh
261 * hwmod. Does not write to the hardware. Returns -EINVAL upon error
264 static int _set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode, u32 *v)
269 if (!oh->class->sysc ||
270 !(oh->class->sysc->sysc_flags & SYSC_HAS_SIDLEMODE))
273 if (!oh->class->sysc->sysc_fields) {
274 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
278 sidle_shift = oh->class->sysc->sysc_fields->sidle_shift;
279 sidle_mask = (0x3 << sidle_shift);
282 *v |= __ffs(idlemode) << sidle_shift;
288 * _set_clockactivity: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
289 * @oh: struct omap_hwmod *
290 * @clockact: CLOCKACTIVITY field bits
291 * @v: pointer to register contents to modify
293 * Update the clockactivity mode bits in @v to be @clockact for the
294 * @oh hwmod. Used for additional powersaving on some modules. Does
295 * not write to the hardware. Returns -EINVAL upon error or 0 upon
298 static int _set_clockactivity(struct omap_hwmod *oh, u8 clockact, u32 *v)
303 if (!oh->class->sysc ||
304 !(oh->class->sysc->sysc_flags & SYSC_HAS_CLOCKACTIVITY))
307 if (!oh->class->sysc->sysc_fields) {
308 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
312 clkact_shift = oh->class->sysc->sysc_fields->clkact_shift;
313 clkact_mask = (0x3 << clkact_shift);
316 *v |= clockact << clkact_shift;
322 * _set_softreset: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
323 * @oh: struct omap_hwmod *
324 * @v: pointer to register contents to modify
326 * Set the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
327 * error or 0 upon success.
329 static int _set_softreset(struct omap_hwmod *oh, u32 *v)
333 if (!oh->class->sysc ||
334 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
337 if (!oh->class->sysc->sysc_fields) {
338 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
342 softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
350 * _set_module_autoidle: set the OCP_SYSCONFIG AUTOIDLE field in @v
351 * @oh: struct omap_hwmod *
352 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
353 * @v: pointer to register contents to modify
355 * Update the module autoidle bit in @v to be @autoidle for the @oh
356 * hwmod. The autoidle bit controls whether the module can gate
357 * internal clocks automatically when it isn't doing anything; the
358 * exact function of this bit varies on a per-module basis. This
359 * function does not write to the hardware. Returns -EINVAL upon
360 * error or 0 upon success.
362 static int _set_module_autoidle(struct omap_hwmod *oh, u8 autoidle,
368 if (!oh->class->sysc ||
369 !(oh->class->sysc->sysc_flags & SYSC_HAS_AUTOIDLE))
372 if (!oh->class->sysc->sysc_fields) {
373 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
377 autoidle_shift = oh->class->sysc->sysc_fields->autoidle_shift;
378 autoidle_mask = (0x3 << autoidle_shift);
380 *v &= ~autoidle_mask;
381 *v |= autoidle << autoidle_shift;
387 * _enable_wakeup: set OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
388 * @oh: struct omap_hwmod *
390 * Allow the hardware module @oh to send wakeups. Returns -EINVAL
391 * upon error or 0 upon success.
393 static int _enable_wakeup(struct omap_hwmod *oh)
397 if (!oh->class->sysc ||
398 !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
401 if (!oh->class->sysc->sysc_fields) {
402 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
406 wakeup_mask = (0x1 << oh->class->sysc->sysc_fields->enwkup_shift);
410 _write_sysconfig(v, oh);
412 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
414 oh->_int_flags |= _HWMOD_WAKEUP_ENABLED;
420 * _disable_wakeup: clear OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
421 * @oh: struct omap_hwmod *
423 * Prevent the hardware module @oh to send wakeups. Returns -EINVAL
424 * upon error or 0 upon success.
426 static int _disable_wakeup(struct omap_hwmod *oh)
430 if (!oh->class->sysc ||
431 !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
434 if (!oh->class->sysc->sysc_fields) {
435 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
439 wakeup_mask = (0x1 << oh->class->sysc->sysc_fields->enwkup_shift);
443 _write_sysconfig(v, oh);
445 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
447 oh->_int_flags &= ~_HWMOD_WAKEUP_ENABLED;
453 * _add_initiator_dep: prevent @oh from smart-idling while @init_oh is active
454 * @oh: struct omap_hwmod *
456 * Prevent the hardware module @oh from entering idle while the
457 * hardare module initiator @init_oh is active. Useful when a module
458 * will be accessed by a particular initiator (e.g., if a module will
459 * be accessed by the IVA, there should be a sleepdep between the IVA
460 * initiator and the module). Only applies to modules in smart-idle
461 * mode. Returns -EINVAL upon error or passes along
462 * clkdm_add_sleepdep() value upon success.
464 static int _add_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
469 return clkdm_add_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
473 * _del_initiator_dep: allow @oh to smart-idle even if @init_oh is active
474 * @oh: struct omap_hwmod *
476 * Allow the hardware module @oh to enter idle while the hardare
477 * module initiator @init_oh is active. Useful when a module will not
478 * be accessed by a particular initiator (e.g., if a module will not
479 * be accessed by the IVA, there should be no sleepdep between the IVA
480 * initiator and the module). Only applies to modules in smart-idle
481 * mode. Returns -EINVAL upon error or passes along
482 * clkdm_del_sleepdep() value upon success.
484 static int _del_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
489 return clkdm_del_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
493 * _init_main_clk - get a struct clk * for the the hwmod's main functional clk
494 * @oh: struct omap_hwmod *
496 * Called from _init_clocks(). Populates the @oh _clk (main
497 * functional clock pointer) if a main_clk is present. Returns 0 on
498 * success or -EINVAL on error.
500 static int _init_main_clk(struct omap_hwmod *oh)
507 oh->_clk = omap_clk_get_by_name(oh->main_clk);
509 pr_warning("omap_hwmod: %s: cannot clk_get main_clk %s\n",
510 oh->name, oh->main_clk);
514 if (!oh->_clk->clkdm)
515 pr_warning("omap_hwmod: %s: missing clockdomain for %s.\n",
516 oh->main_clk, oh->_clk->name);
522 * _init_interface_clks - get a struct clk * for the the hwmod's interface clks
523 * @oh: struct omap_hwmod *
525 * Called from _init_clocks(). Populates the @oh OCP slave interface
526 * clock pointers. Returns 0 on success or -EINVAL on error.
528 static int _init_interface_clks(struct omap_hwmod *oh)
534 if (oh->slaves_cnt == 0)
537 for (i = 0; i < oh->slaves_cnt; i++) {
538 struct omap_hwmod_ocp_if *os = oh->slaves[i];
543 c = omap_clk_get_by_name(os->clk);
545 pr_warning("omap_hwmod: %s: cannot clk_get interface_clk %s\n",
556 * _init_opt_clk - get a struct clk * for the the hwmod's optional clocks
557 * @oh: struct omap_hwmod *
559 * Called from _init_clocks(). Populates the @oh omap_hwmod_opt_clk
560 * clock pointers. Returns 0 on success or -EINVAL on error.
562 static int _init_opt_clks(struct omap_hwmod *oh)
564 struct omap_hwmod_opt_clk *oc;
569 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++) {
570 c = omap_clk_get_by_name(oc->clk);
572 pr_warning("omap_hwmod: %s: cannot clk_get opt_clk %s\n",
583 * _enable_clocks - enable hwmod main clock and interface clocks
584 * @oh: struct omap_hwmod *
586 * Enables all clocks necessary for register reads and writes to succeed
587 * on the hwmod @oh. Returns 0.
589 static int _enable_clocks(struct omap_hwmod *oh)
593 pr_debug("omap_hwmod: %s: enabling clocks\n", oh->name);
596 clk_enable(oh->_clk);
598 if (oh->slaves_cnt > 0) {
599 for (i = 0; i < oh->slaves_cnt; i++) {
600 struct omap_hwmod_ocp_if *os = oh->slaves[i];
601 struct clk *c = os->_clk;
603 if (c && (os->flags & OCPIF_SWSUP_IDLE))
608 /* The opt clocks are controlled by the device driver. */
614 * _disable_clocks - disable hwmod main clock and interface clocks
615 * @oh: struct omap_hwmod *
617 * Disables the hwmod @oh main functional and interface clocks. Returns 0.
619 static int _disable_clocks(struct omap_hwmod *oh)
623 pr_debug("omap_hwmod: %s: disabling clocks\n", oh->name);
626 clk_disable(oh->_clk);
628 if (oh->slaves_cnt > 0) {
629 for (i = 0; i < oh->slaves_cnt; i++) {
630 struct omap_hwmod_ocp_if *os = oh->slaves[i];
631 struct clk *c = os->_clk;
633 if (c && (os->flags & OCPIF_SWSUP_IDLE))
638 /* The opt clocks are controlled by the device driver. */
643 static void _enable_optional_clocks(struct omap_hwmod *oh)
645 struct omap_hwmod_opt_clk *oc;
648 pr_debug("omap_hwmod: %s: enabling optional clocks\n", oh->name);
650 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
652 pr_debug("omap_hwmod: enable %s:%s\n", oc->role,
654 clk_enable(oc->_clk);
658 static void _disable_optional_clocks(struct omap_hwmod *oh)
660 struct omap_hwmod_opt_clk *oc;
663 pr_debug("omap_hwmod: %s: disabling optional clocks\n", oh->name);
665 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
667 pr_debug("omap_hwmod: disable %s:%s\n", oc->role,
669 clk_disable(oc->_clk);
674 * _find_mpu_port_index - find hwmod OCP slave port ID intended for MPU use
675 * @oh: struct omap_hwmod *
677 * Returns the array index of the OCP slave port that the MPU
678 * addresses the device on, or -EINVAL upon error or not found.
680 static int _find_mpu_port_index(struct omap_hwmod *oh)
685 if (!oh || oh->slaves_cnt == 0)
688 for (i = 0; i < oh->slaves_cnt; i++) {
689 struct omap_hwmod_ocp_if *os = oh->slaves[i];
691 if (os->user & OCP_USER_MPU) {
698 pr_debug("omap_hwmod: %s: MPU OCP slave port ID %d\n",
701 pr_debug("omap_hwmod: %s: no MPU OCP slave port found\n",
704 return (found) ? i : -EINVAL;
708 * _find_mpu_rt_base - find hwmod register target base addr accessible by MPU
709 * @oh: struct omap_hwmod *
711 * Return the virtual address of the base of the register target of
712 * device @oh, or NULL on error.
714 static void __iomem *_find_mpu_rt_base(struct omap_hwmod *oh, u8 index)
716 struct omap_hwmod_ocp_if *os;
717 struct omap_hwmod_addr_space *mem;
720 void __iomem *va_start;
722 if (!oh || oh->slaves_cnt == 0)
725 os = oh->slaves[index];
727 for (i = 0, mem = os->addr; i < os->addr_cnt; i++, mem++) {
728 if (mem->flags & ADDR_TYPE_RT) {
735 va_start = ioremap(mem->pa_start, mem->pa_end - mem->pa_start);
737 pr_err("omap_hwmod: %s: Could not ioremap\n", oh->name);
740 pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
743 pr_debug("omap_hwmod: %s: no MPU register target found\n",
747 return (found) ? va_start : NULL;
751 * _enable_sysc - try to bring a module out of idle via OCP_SYSCONFIG
752 * @oh: struct omap_hwmod *
754 * If module is marked as SWSUP_SIDLE, force the module out of slave
755 * idle; otherwise, configure it for smart-idle. If module is marked
756 * as SWSUP_MSUSPEND, force the module out of master standby;
757 * otherwise, configure it for smart-standby. No return value.
759 static void _enable_sysc(struct omap_hwmod *oh)
764 if (!oh->class->sysc)
768 sf = oh->class->sysc->sysc_flags;
770 if (sf & SYSC_HAS_SIDLEMODE) {
771 idlemode = (oh->flags & HWMOD_SWSUP_SIDLE) ?
772 HWMOD_IDLEMODE_NO : HWMOD_IDLEMODE_SMART;
773 _set_slave_idlemode(oh, idlemode, &v);
776 if (sf & SYSC_HAS_MIDLEMODE) {
777 idlemode = (oh->flags & HWMOD_SWSUP_MSTANDBY) ?
778 HWMOD_IDLEMODE_NO : HWMOD_IDLEMODE_SMART;
779 _set_master_standbymode(oh, idlemode, &v);
783 * XXX The clock framework should handle this, by
784 * calling into this code. But this must wait until the
785 * clock structures are tagged with omap_hwmod entries
787 if ((oh->flags & HWMOD_SET_DEFAULT_CLOCKACT) &&
788 (sf & SYSC_HAS_CLOCKACTIVITY))
789 _set_clockactivity(oh, oh->class->sysc->clockact, &v);
791 _write_sysconfig(v, oh);
793 /* If slave is in SMARTIDLE, also enable wakeup */
794 if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
798 * Set the autoidle bit only after setting the smartidle bit
799 * Setting this will not have any impact on the other modules.
801 if (sf & SYSC_HAS_AUTOIDLE) {
802 idlemode = (oh->flags & HWMOD_NO_OCP_AUTOIDLE) ?
804 _set_module_autoidle(oh, idlemode, &v);
805 _write_sysconfig(v, oh);
810 * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
811 * @oh: struct omap_hwmod *
813 * If module is marked as SWSUP_SIDLE, force the module into slave
814 * idle; otherwise, configure it for smart-idle. If module is marked
815 * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
816 * configure it for smart-standby. No return value.
818 static void _idle_sysc(struct omap_hwmod *oh)
823 if (!oh->class->sysc)
827 sf = oh->class->sysc->sysc_flags;
829 if (sf & SYSC_HAS_SIDLEMODE) {
830 idlemode = (oh->flags & HWMOD_SWSUP_SIDLE) ?
831 HWMOD_IDLEMODE_FORCE : HWMOD_IDLEMODE_SMART;
832 _set_slave_idlemode(oh, idlemode, &v);
835 if (sf & SYSC_HAS_MIDLEMODE) {
836 idlemode = (oh->flags & HWMOD_SWSUP_MSTANDBY) ?
837 HWMOD_IDLEMODE_FORCE : HWMOD_IDLEMODE_SMART;
838 _set_master_standbymode(oh, idlemode, &v);
841 _write_sysconfig(v, oh);
845 * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
846 * @oh: struct omap_hwmod *
848 * Force the module into slave idle and master suspend. No return
851 static void _shutdown_sysc(struct omap_hwmod *oh)
856 if (!oh->class->sysc)
860 sf = oh->class->sysc->sysc_flags;
862 if (sf & SYSC_HAS_SIDLEMODE)
863 _set_slave_idlemode(oh, HWMOD_IDLEMODE_FORCE, &v);
865 if (sf & SYSC_HAS_MIDLEMODE)
866 _set_master_standbymode(oh, HWMOD_IDLEMODE_FORCE, &v);
868 if (sf & SYSC_HAS_AUTOIDLE)
869 _set_module_autoidle(oh, 1, &v);
871 _write_sysconfig(v, oh);
875 * _lookup - find an omap_hwmod by name
876 * @name: find an omap_hwmod by name
878 * Return a pointer to an omap_hwmod by name, or NULL if not found.
879 * Caller must hold omap_hwmod_mutex.
881 static struct omap_hwmod *_lookup(const char *name)
883 struct omap_hwmod *oh, *temp_oh;
887 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
888 if (!strcmp(name, temp_oh->name)) {
898 * _init_clocks - clk_get() all clocks associated with this hwmod
899 * @oh: struct omap_hwmod *
900 * @data: not used; pass NULL
902 * Called by omap_hwmod_late_init() (after omap2_clk_init()).
903 * Resolves all clock names embedded in the hwmod. Returns -EINVAL if
904 * the omap_hwmod has not yet been registered or if the clocks have
905 * already been initialized, 0 on success, or a non-zero error on
908 static int _init_clocks(struct omap_hwmod *oh, void *data)
912 if (!oh || (oh->_state != _HWMOD_STATE_REGISTERED))
915 pr_debug("omap_hwmod: %s: looking up clocks\n", oh->name);
917 ret |= _init_main_clk(oh);
918 ret |= _init_interface_clks(oh);
919 ret |= _init_opt_clks(oh);
922 oh->_state = _HWMOD_STATE_CLKS_INITED;
928 * _wait_target_ready - wait for a module to leave slave idle
929 * @oh: struct omap_hwmod *
931 * Wait for a module @oh to leave slave idle. Returns 0 if the module
932 * does not have an IDLEST bit or if the module successfully leaves
933 * slave idle; otherwise, pass along the return value of the
934 * appropriate *_cm_wait_module_ready() function.
936 static int _wait_target_ready(struct omap_hwmod *oh)
938 struct omap_hwmod_ocp_if *os;
944 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
947 os = oh->slaves[oh->_mpu_port_index];
949 if (oh->flags & HWMOD_NO_IDLEST)
952 /* XXX check module SIDLEMODE */
954 /* XXX check clock enable states */
956 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
957 ret = omap2_cm_wait_module_ready(oh->prcm.omap2.module_offs,
958 oh->prcm.omap2.idlest_reg_id,
959 oh->prcm.omap2.idlest_idle_bit);
960 } else if (cpu_is_omap44xx()) {
961 ret = omap4_cm_wait_module_ready(oh->prcm.omap4.clkctrl_reg);
970 * _lookup_hardreset - return the register bit shift for this hwmod/reset line
971 * @oh: struct omap_hwmod *
972 * @name: name of the reset line in the context of this hwmod
974 * Return the bit position of the reset line that match the
975 * input name. Return -ENOENT if not found.
977 static u8 _lookup_hardreset(struct omap_hwmod *oh, const char *name)
981 for (i = 0; i < oh->rst_lines_cnt; i++) {
982 const char *rst_line = oh->rst_lines[i].name;
983 if (!strcmp(rst_line, name)) {
984 u8 shift = oh->rst_lines[i].rst_shift;
985 pr_debug("omap_hwmod: %s: _lookup_hardreset: %s: %d\n",
986 oh->name, rst_line, shift);
996 * _assert_hardreset - assert the HW reset line of submodules
997 * contained in the hwmod module.
998 * @oh: struct omap_hwmod *
999 * @name: name of the reset line to lookup and assert
1001 * Some IP like dsp, ipu or iva contain processor that require
1002 * an HW reset line to be assert / deassert in order to enable fully
1005 static int _assert_hardreset(struct omap_hwmod *oh, const char *name)
1012 shift = _lookup_hardreset(oh, name);
1013 if (IS_ERR_VALUE(shift))
1016 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1017 return omap2_prm_assert_hardreset(oh->prcm.omap2.module_offs,
1019 else if (cpu_is_omap44xx())
1020 return omap4_prm_assert_hardreset(oh->prcm.omap4.rstctrl_reg,
1027 * _deassert_hardreset - deassert the HW reset line of submodules contained
1028 * in the hwmod module.
1029 * @oh: struct omap_hwmod *
1030 * @name: name of the reset line to look up and deassert
1032 * Some IP like dsp, ipu or iva contain processor that require
1033 * an HW reset line to be assert / deassert in order to enable fully
1036 static int _deassert_hardreset(struct omap_hwmod *oh, const char *name)
1044 shift = _lookup_hardreset(oh, name);
1045 if (IS_ERR_VALUE(shift))
1048 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1049 r = omap2_prm_deassert_hardreset(oh->prcm.omap2.module_offs,
1051 else if (cpu_is_omap44xx())
1052 r = omap4_prm_deassert_hardreset(oh->prcm.omap4.rstctrl_reg,
1058 pr_warning("omap_hwmod: %s: failed to hardreset\n", oh->name);
1064 * _read_hardreset - read the HW reset line state of submodules
1065 * contained in the hwmod module
1066 * @oh: struct omap_hwmod *
1067 * @name: name of the reset line to look up and read
1069 * Return the state of the reset line.
1071 static int _read_hardreset(struct omap_hwmod *oh, const char *name)
1078 shift = _lookup_hardreset(oh, name);
1079 if (IS_ERR_VALUE(shift))
1082 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1083 return omap2_prm_is_hardreset_asserted(oh->prcm.omap2.module_offs,
1085 } else if (cpu_is_omap44xx()) {
1086 return omap4_prm_is_hardreset_asserted(oh->prcm.omap4.rstctrl_reg,
1094 * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1095 * @oh: struct omap_hwmod *
1097 * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit. hwmod must be
1098 * enabled for this to work. Returns -EINVAL if the hwmod cannot be
1099 * reset this way or if the hwmod is in the wrong state, -ETIMEDOUT if
1100 * the module did not reset in time, or 0 upon success.
1102 * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1103 * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1104 * use the SYSCONFIG softreset bit to provide the status.
1106 * Note that some IP like McBSP do have reset control but don't have
1109 static int _ocp_softreset(struct omap_hwmod *oh)
1115 if (!oh->class->sysc ||
1116 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
1119 /* clocks must be on for this operation */
1120 if (oh->_state != _HWMOD_STATE_ENABLED) {
1121 pr_warning("omap_hwmod: %s: reset can only be entered from "
1122 "enabled state\n", oh->name);
1126 /* For some modules, all optionnal clocks need to be enabled as well */
1127 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1128 _enable_optional_clocks(oh);
1130 pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh->name);
1132 v = oh->_sysc_cache;
1133 ret = _set_softreset(oh, &v);
1136 _write_sysconfig(v, oh);
1138 if (oh->class->sysc->sysc_flags & SYSS_HAS_RESET_STATUS)
1139 omap_test_timeout((omap_hwmod_read(oh,
1140 oh->class->sysc->syss_offs)
1141 & SYSS_RESETDONE_MASK),
1142 MAX_MODULE_SOFTRESET_WAIT, c);
1143 else if (oh->class->sysc->sysc_flags & SYSC_HAS_RESET_STATUS)
1144 omap_test_timeout(!(omap_hwmod_read(oh,
1145 oh->class->sysc->sysc_offs)
1146 & SYSC_TYPE2_SOFTRESET_MASK),
1147 MAX_MODULE_SOFTRESET_WAIT, c);
1149 if (c == MAX_MODULE_SOFTRESET_WAIT)
1150 pr_warning("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1151 oh->name, MAX_MODULE_SOFTRESET_WAIT);
1153 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh->name, c);
1156 * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1157 * _wait_target_ready() or _reset()
1160 ret = (c == MAX_MODULE_SOFTRESET_WAIT) ? -ETIMEDOUT : 0;
1163 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1164 _disable_optional_clocks(oh);
1170 * _reset - reset an omap_hwmod
1171 * @oh: struct omap_hwmod *
1173 * Resets an omap_hwmod @oh. The default software reset mechanism for
1174 * most OMAP IP blocks is triggered via the OCP_SYSCONFIG.SOFTRESET
1175 * bit. However, some hwmods cannot be reset via this method: some
1176 * are not targets and therefore have no OCP header registers to
1177 * access; others (like the IVA) have idiosyncratic reset sequences.
1178 * So for these relatively rare cases, custom reset code can be
1179 * supplied in the struct omap_hwmod_class .reset function pointer.
1180 * Passes along the return value from either _reset() or the custom
1181 * reset function - these must return -EINVAL if the hwmod cannot be
1182 * reset this way or if the hwmod is in the wrong state, -ETIMEDOUT if
1183 * the module did not reset in time, or 0 upon success.
1185 static int _reset(struct omap_hwmod *oh)
1189 pr_debug("omap_hwmod: %s: resetting\n", oh->name);
1191 ret = (oh->class->reset) ? oh->class->reset(oh) : _ocp_softreset(oh);
1197 * _enable - enable an omap_hwmod
1198 * @oh: struct omap_hwmod *
1200 * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
1201 * register target. Returns -EINVAL if the hwmod is in the wrong
1202 * state or passes along the return value of _wait_target_ready().
1204 static int _enable(struct omap_hwmod *oh)
1208 if (oh->_state != _HWMOD_STATE_INITIALIZED &&
1209 oh->_state != _HWMOD_STATE_IDLE &&
1210 oh->_state != _HWMOD_STATE_DISABLED) {
1211 WARN(1, "omap_hwmod: %s: enabled state can only be entered "
1212 "from initialized, idle, or disabled state\n", oh->name);
1216 pr_debug("omap_hwmod: %s: enabling\n", oh->name);
1219 * If an IP contains only one HW reset line, then de-assert it in order
1220 * to allow to enable the clocks. Otherwise the PRCM will return
1221 * Intransition status, and the init will failed.
1223 if ((oh->_state == _HWMOD_STATE_INITIALIZED ||
1224 oh->_state == _HWMOD_STATE_DISABLED) && oh->rst_lines_cnt == 1)
1225 _deassert_hardreset(oh, oh->rst_lines[0].name);
1229 _add_initiator_dep(oh, mpu_oh);
1232 r = _wait_target_ready(oh);
1234 oh->_state = _HWMOD_STATE_ENABLED;
1236 /* Access the sysconfig only if the target is ready */
1237 if (oh->class->sysc) {
1238 if (!(oh->_int_flags & _HWMOD_SYSCONFIG_LOADED))
1239 _update_sysc_cache(oh);
1243 pr_debug("omap_hwmod: %s: _wait_target_ready: %d\n",
1251 * _idle - idle an omap_hwmod
1252 * @oh: struct omap_hwmod *
1254 * Idles an omap_hwmod @oh. This should be called once the hwmod has
1255 * no further work. Returns -EINVAL if the hwmod is in the wrong
1256 * state or returns 0.
1258 static int _idle(struct omap_hwmod *oh)
1260 if (oh->_state != _HWMOD_STATE_ENABLED) {
1261 WARN(1, "omap_hwmod: %s: idle state can only be entered from "
1262 "enabled state\n", oh->name);
1266 pr_debug("omap_hwmod: %s: idling\n", oh->name);
1268 if (oh->class->sysc)
1270 _del_initiator_dep(oh, mpu_oh);
1271 _disable_clocks(oh);
1273 oh->_state = _HWMOD_STATE_IDLE;
1279 * _shutdown - shutdown an omap_hwmod
1280 * @oh: struct omap_hwmod *
1282 * Shut down an omap_hwmod @oh. This should be called when the driver
1283 * used for the hwmod is removed or unloaded or if the driver is not
1284 * used by the system. Returns -EINVAL if the hwmod is in the wrong
1285 * state or returns 0.
1287 static int _shutdown(struct omap_hwmod *oh)
1292 if (oh->_state != _HWMOD_STATE_IDLE &&
1293 oh->_state != _HWMOD_STATE_ENABLED) {
1294 WARN(1, "omap_hwmod: %s: disabled state can only be entered "
1295 "from idle, or enabled state\n", oh->name);
1299 pr_debug("omap_hwmod: %s: disabling\n", oh->name);
1301 if (oh->class->pre_shutdown) {
1302 prev_state = oh->_state;
1303 if (oh->_state == _HWMOD_STATE_IDLE)
1305 ret = oh->class->pre_shutdown(oh);
1307 if (prev_state == _HWMOD_STATE_IDLE)
1313 if (oh->class->sysc)
1317 * If an IP contains only one HW reset line, then assert it
1318 * before disabling the clocks and shutting down the IP.
1320 if (oh->rst_lines_cnt == 1)
1321 _assert_hardreset(oh, oh->rst_lines[0].name);
1323 /* clocks and deps are already disabled in idle */
1324 if (oh->_state == _HWMOD_STATE_ENABLED) {
1325 _del_initiator_dep(oh, mpu_oh);
1326 /* XXX what about the other system initiators here? dma, dsp */
1327 _disable_clocks(oh);
1329 /* XXX Should this code also force-disable the optional clocks? */
1331 /* XXX mux any associated balls to safe mode */
1333 oh->_state = _HWMOD_STATE_DISABLED;
1339 * _setup - do initial configuration of omap_hwmod
1340 * @oh: struct omap_hwmod *
1342 * Writes the CLOCKACTIVITY bits @clockact to the hwmod @oh
1343 * OCP_SYSCONFIG register. Returns -EINVAL if the hwmod is in the
1344 * wrong state or returns 0.
1346 static int _setup(struct omap_hwmod *oh, void *data)
1351 /* Set iclk autoidle mode */
1352 if (oh->slaves_cnt > 0) {
1353 for (i = 0; i < oh->slaves_cnt; i++) {
1354 struct omap_hwmod_ocp_if *os = oh->slaves[i];
1355 struct clk *c = os->_clk;
1360 if (os->flags & OCPIF_SWSUP_IDLE) {
1361 /* XXX omap_iclk_deny_idle(c); */
1363 /* XXX omap_iclk_allow_idle(c); */
1369 oh->_state = _HWMOD_STATE_INITIALIZED;
1372 * In the case of hwmod with hardreset that should not be
1373 * de-assert at boot time, we have to keep the module
1374 * initialized, because we cannot enable it properly with the
1375 * reset asserted. Exit without warning because that behavior is
1378 if ((oh->flags & HWMOD_INIT_NO_RESET) && oh->rst_lines_cnt == 1)
1383 pr_warning("omap_hwmod: %s: cannot be enabled (%d)\n",
1384 oh->name, oh->_state);
1388 if (!(oh->flags & HWMOD_INIT_NO_RESET)) {
1392 * OCP_SYSCONFIG bits need to be reprogrammed after a softreset.
1393 * The _enable() function should be split to
1394 * avoid the rewrite of the OCP_SYSCONFIG register.
1396 if (oh->class->sysc) {
1397 _update_sysc_cache(oh);
1402 postsetup_state = oh->_postsetup_state;
1403 if (postsetup_state == _HWMOD_STATE_UNKNOWN)
1404 postsetup_state = _HWMOD_STATE_ENABLED;
1407 * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
1408 * it should be set by the core code as a runtime flag during startup
1410 if ((oh->flags & HWMOD_INIT_NO_IDLE) &&
1411 (postsetup_state == _HWMOD_STATE_IDLE))
1412 postsetup_state = _HWMOD_STATE_ENABLED;
1414 if (postsetup_state == _HWMOD_STATE_IDLE)
1416 else if (postsetup_state == _HWMOD_STATE_DISABLED)
1418 else if (postsetup_state != _HWMOD_STATE_ENABLED)
1419 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
1420 oh->name, postsetup_state);
1427 /* Public functions */
1429 u32 omap_hwmod_read(struct omap_hwmod *oh, u16 reg_offs)
1431 if (oh->flags & HWMOD_16BIT_REG)
1432 return __raw_readw(oh->_mpu_rt_va + reg_offs);
1434 return __raw_readl(oh->_mpu_rt_va + reg_offs);
1437 void omap_hwmod_write(u32 v, struct omap_hwmod *oh, u16 reg_offs)
1439 if (oh->flags & HWMOD_16BIT_REG)
1440 __raw_writew(v, oh->_mpu_rt_va + reg_offs);
1442 __raw_writel(v, oh->_mpu_rt_va + reg_offs);
1446 * omap_hwmod_set_slave_idlemode - set the hwmod's OCP slave idlemode
1447 * @oh: struct omap_hwmod *
1448 * @idlemode: SIDLEMODE field bits (shifted to bit 0)
1450 * Sets the IP block's OCP slave idlemode in hardware, and updates our
1451 * local copy. Intended to be used by drivers that have some erratum
1452 * that requires direct manipulation of the SIDLEMODE bits. Returns
1453 * -EINVAL if @oh is null, or passes along the return value from
1454 * _set_slave_idlemode().
1456 * XXX Does this function have any current users? If not, we should
1457 * remove it; it is better to let the rest of the hwmod code handle this.
1458 * Any users of this function should be scrutinized carefully.
1460 int omap_hwmod_set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode)
1468 v = oh->_sysc_cache;
1470 retval = _set_slave_idlemode(oh, idlemode, &v);
1472 _write_sysconfig(v, oh);
1478 * omap_hwmod_register - register a struct omap_hwmod
1479 * @oh: struct omap_hwmod *
1481 * Registers the omap_hwmod @oh. Returns -EEXIST if an omap_hwmod
1482 * already has been registered by the same name; -EINVAL if the
1483 * omap_hwmod is in the wrong state, if @oh is NULL, if the
1484 * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
1485 * name, or if the omap_hwmod's class is missing a name; or 0 upon
1488 * XXX The data should be copied into bootmem, so the original data
1489 * should be marked __initdata and freed after init. This would allow
1490 * unneeded omap_hwmods to be freed on multi-OMAP configurations. Note
1491 * that the copy process would be relatively complex due to the large number
1494 int omap_hwmod_register(struct omap_hwmod *oh)
1498 if (!oh || !oh->name || !oh->class || !oh->class->name ||
1499 (oh->_state != _HWMOD_STATE_UNKNOWN))
1502 mutex_lock(&omap_hwmod_mutex);
1504 pr_debug("omap_hwmod: %s: registering\n", oh->name);
1506 if (_lookup(oh->name)) {
1511 ms_id = _find_mpu_port_index(oh);
1512 if (!IS_ERR_VALUE(ms_id)) {
1513 oh->_mpu_port_index = ms_id;
1514 oh->_mpu_rt_va = _find_mpu_rt_base(oh, oh->_mpu_port_index);
1516 oh->_int_flags |= _HWMOD_NO_MPU_PORT;
1519 list_add_tail(&oh->node, &omap_hwmod_list);
1521 spin_lock_init(&oh->_lock);
1523 oh->_state = _HWMOD_STATE_REGISTERED;
1528 mutex_unlock(&omap_hwmod_mutex);
1533 * omap_hwmod_lookup - look up a registered omap_hwmod by name
1534 * @name: name of the omap_hwmod to look up
1536 * Given a @name of an omap_hwmod, return a pointer to the registered
1537 * struct omap_hwmod *, or NULL upon error.
1539 struct omap_hwmod *omap_hwmod_lookup(const char *name)
1541 struct omap_hwmod *oh;
1546 mutex_lock(&omap_hwmod_mutex);
1548 mutex_unlock(&omap_hwmod_mutex);
1554 * omap_hwmod_for_each - call function for each registered omap_hwmod
1555 * @fn: pointer to a callback function
1556 * @data: void * data to pass to callback function
1558 * Call @fn for each registered omap_hwmod, passing @data to each
1559 * function. @fn must return 0 for success or any other value for
1560 * failure. If @fn returns non-zero, the iteration across omap_hwmods
1561 * will stop and the non-zero return value will be passed to the
1562 * caller of omap_hwmod_for_each(). @fn is called with
1563 * omap_hwmod_for_each() held.
1565 int omap_hwmod_for_each(int (*fn)(struct omap_hwmod *oh, void *data),
1568 struct omap_hwmod *temp_oh;
1574 mutex_lock(&omap_hwmod_mutex);
1575 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1576 ret = (*fn)(temp_oh, data);
1580 mutex_unlock(&omap_hwmod_mutex);
1587 * omap_hwmod_init - init omap_hwmod code and register hwmods
1588 * @ohs: pointer to an array of omap_hwmods to register
1590 * Intended to be called early in boot before the clock framework is
1591 * initialized. If @ohs is not null, will register all omap_hwmods
1592 * listed in @ohs that are valid for this chip. Returns -EINVAL if
1593 * omap_hwmod_init() has already been called or 0 otherwise.
1595 int omap_hwmod_init(struct omap_hwmod **ohs)
1597 struct omap_hwmod *oh;
1610 if (omap_chip_is(oh->omap_chip)) {
1611 r = omap_hwmod_register(oh);
1612 WARN(r, "omap_hwmod: %s: omap_hwmod_register returned "
1613 "%d\n", oh->name, r);
1622 * omap_hwmod_late_init - do some post-clock framework initialization
1624 * Must be called after omap2_clk_init(). Resolves the struct clk names
1625 * to struct clk pointers for each registered omap_hwmod. Also calls
1626 * _setup() on each hwmod. Returns 0.
1628 int omap_hwmod_late_init(void)
1632 /* XXX check return value */
1633 r = omap_hwmod_for_each(_init_clocks, NULL);
1634 WARN(r, "omap_hwmod: omap_hwmod_late_init(): _init_clocks failed\n");
1636 mpu_oh = omap_hwmod_lookup(MPU_INITIATOR_NAME);
1637 WARN(!mpu_oh, "omap_hwmod: could not find MPU initiator hwmod %s\n",
1638 MPU_INITIATOR_NAME);
1640 omap_hwmod_for_each(_setup, NULL);
1646 * omap_hwmod_unregister - unregister an omap_hwmod
1647 * @oh: struct omap_hwmod *
1649 * Unregisters a previously-registered omap_hwmod @oh. There's probably
1650 * no use case for this, so it is likely to be removed in a later version.
1652 * XXX Free all of the bootmem-allocated structures here when that is
1653 * implemented. Make it clear that core code is the only code that is
1654 * expected to unregister modules.
1656 int omap_hwmod_unregister(struct omap_hwmod *oh)
1661 pr_debug("omap_hwmod: %s: unregistering\n", oh->name);
1663 mutex_lock(&omap_hwmod_mutex);
1664 iounmap(oh->_mpu_rt_va);
1665 list_del(&oh->node);
1666 mutex_unlock(&omap_hwmod_mutex);
1672 * omap_hwmod_enable - enable an omap_hwmod
1673 * @oh: struct omap_hwmod *
1675 * Enable an omap_hwmod @oh. Intended to be called by omap_device_enable().
1676 * Returns -EINVAL on error or passes along the return value from _enable().
1678 int omap_hwmod_enable(struct omap_hwmod *oh)
1681 unsigned long flags;
1686 spin_lock_irqsave(&oh->_lock, flags);
1688 spin_unlock_irqrestore(&oh->_lock, flags);
1694 * omap_hwmod_idle - idle an omap_hwmod
1695 * @oh: struct omap_hwmod *
1697 * Idle an omap_hwmod @oh. Intended to be called by omap_device_idle().
1698 * Returns -EINVAL on error or passes along the return value from _idle().
1700 int omap_hwmod_idle(struct omap_hwmod *oh)
1702 unsigned long flags;
1707 spin_lock_irqsave(&oh->_lock, flags);
1709 spin_unlock_irqrestore(&oh->_lock, flags);
1715 * omap_hwmod_shutdown - shutdown an omap_hwmod
1716 * @oh: struct omap_hwmod *
1718 * Shutdown an omap_hwmod @oh. Intended to be called by
1719 * omap_device_shutdown(). Returns -EINVAL on error or passes along
1720 * the return value from _shutdown().
1722 int omap_hwmod_shutdown(struct omap_hwmod *oh)
1724 unsigned long flags;
1729 spin_lock_irqsave(&oh->_lock, flags);
1731 spin_unlock_irqrestore(&oh->_lock, flags);
1737 * omap_hwmod_enable_clocks - enable main_clk, all interface clocks
1738 * @oh: struct omap_hwmod *oh
1740 * Intended to be called by the omap_device code.
1742 int omap_hwmod_enable_clocks(struct omap_hwmod *oh)
1744 unsigned long flags;
1746 spin_lock_irqsave(&oh->_lock, flags);
1748 spin_unlock_irqrestore(&oh->_lock, flags);
1754 * omap_hwmod_disable_clocks - disable main_clk, all interface clocks
1755 * @oh: struct omap_hwmod *oh
1757 * Intended to be called by the omap_device code.
1759 int omap_hwmod_disable_clocks(struct omap_hwmod *oh)
1761 unsigned long flags;
1763 spin_lock_irqsave(&oh->_lock, flags);
1764 _disable_clocks(oh);
1765 spin_unlock_irqrestore(&oh->_lock, flags);
1771 * omap_hwmod_ocp_barrier - wait for posted writes against the hwmod to complete
1772 * @oh: struct omap_hwmod *oh
1774 * Intended to be called by drivers and core code when all posted
1775 * writes to a device must complete before continuing further
1776 * execution (for example, after clearing some device IRQSTATUS
1779 * XXX what about targets with multiple OCP threads?
1781 void omap_hwmod_ocp_barrier(struct omap_hwmod *oh)
1785 if (!oh->class->sysc || !oh->class->sysc->sysc_flags) {
1786 WARN(1, "omap_device: %s: OCP barrier impossible due to "
1787 "device configuration\n", oh->name);
1792 * Forces posted writes to complete on the OCP thread handling
1795 omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
1799 * omap_hwmod_reset - reset the hwmod
1800 * @oh: struct omap_hwmod *
1802 * Under some conditions, a driver may wish to reset the entire device.
1803 * Called from omap_device code. Returns -EINVAL on error or passes along
1804 * the return value from _reset().
1806 int omap_hwmod_reset(struct omap_hwmod *oh)
1809 unsigned long flags;
1814 spin_lock_irqsave(&oh->_lock, flags);
1816 spin_unlock_irqrestore(&oh->_lock, flags);
1822 * omap_hwmod_count_resources - count number of struct resources needed by hwmod
1823 * @oh: struct omap_hwmod *
1824 * @res: pointer to the first element of an array of struct resource to fill
1826 * Count the number of struct resource array elements necessary to
1827 * contain omap_hwmod @oh resources. Intended to be called by code
1828 * that registers omap_devices. Intended to be used to determine the
1829 * size of a dynamically-allocated struct resource array, before
1830 * calling omap_hwmod_fill_resources(). Returns the number of struct
1831 * resource array elements needed.
1833 * XXX This code is not optimized. It could attempt to merge adjacent
1837 int omap_hwmod_count_resources(struct omap_hwmod *oh)
1841 ret = oh->mpu_irqs_cnt + oh->sdma_reqs_cnt;
1843 for (i = 0; i < oh->slaves_cnt; i++)
1844 ret += oh->slaves[i]->addr_cnt;
1850 * omap_hwmod_fill_resources - fill struct resource array with hwmod data
1851 * @oh: struct omap_hwmod *
1852 * @res: pointer to the first element of an array of struct resource to fill
1854 * Fill the struct resource array @res with resource data from the
1855 * omap_hwmod @oh. Intended to be called by code that registers
1856 * omap_devices. See also omap_hwmod_count_resources(). Returns the
1857 * number of array elements filled.
1859 int omap_hwmod_fill_resources(struct omap_hwmod *oh, struct resource *res)
1864 /* For each IRQ, DMA, memory area, fill in array.*/
1866 for (i = 0; i < oh->mpu_irqs_cnt; i++) {
1867 (res + r)->name = (oh->mpu_irqs + i)->name;
1868 (res + r)->start = (oh->mpu_irqs + i)->irq;
1869 (res + r)->end = (oh->mpu_irqs + i)->irq;
1870 (res + r)->flags = IORESOURCE_IRQ;
1874 for (i = 0; i < oh->sdma_reqs_cnt; i++) {
1875 (res + r)->name = (oh->sdma_reqs + i)->name;
1876 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
1877 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
1878 (res + r)->flags = IORESOURCE_DMA;
1882 for (i = 0; i < oh->slaves_cnt; i++) {
1883 struct omap_hwmod_ocp_if *os;
1887 for (j = 0; j < os->addr_cnt; j++) {
1888 (res + r)->start = (os->addr + j)->pa_start;
1889 (res + r)->end = (os->addr + j)->pa_end;
1890 (res + r)->flags = IORESOURCE_MEM;
1899 * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
1900 * @oh: struct omap_hwmod *
1902 * Return the powerdomain pointer associated with the OMAP module
1903 * @oh's main clock. If @oh does not have a main clk, return the
1904 * powerdomain associated with the interface clock associated with the
1905 * module's MPU port. (XXX Perhaps this should use the SDMA port
1906 * instead?) Returns NULL on error, or a struct powerdomain * on
1909 struct powerdomain *omap_hwmod_get_pwrdm(struct omap_hwmod *oh)
1919 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
1921 c = oh->slaves[oh->_mpu_port_index]->_clk;
1927 return c->clkdm->pwrdm.ptr;
1932 * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
1933 * @oh: struct omap_hwmod *
1935 * Returns the virtual address corresponding to the beginning of the
1936 * module's register target, in the address range that is intended to
1937 * be used by the MPU. Returns the virtual address upon success or NULL
1940 void __iomem *omap_hwmod_get_mpu_rt_va(struct omap_hwmod *oh)
1945 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
1948 if (oh->_state == _HWMOD_STATE_UNKNOWN)
1951 return oh->_mpu_rt_va;
1955 * omap_hwmod_add_initiator_dep - add sleepdep from @init_oh to @oh
1956 * @oh: struct omap_hwmod *
1957 * @init_oh: struct omap_hwmod * (initiator)
1959 * Add a sleep dependency between the initiator @init_oh and @oh.
1960 * Intended to be called by DSP/Bridge code via platform_data for the
1961 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
1962 * code needs to add/del initiator dependencies dynamically
1963 * before/after accessing a device. Returns the return value from
1964 * _add_initiator_dep().
1966 * XXX Keep a usecount in the clockdomain code
1968 int omap_hwmod_add_initiator_dep(struct omap_hwmod *oh,
1969 struct omap_hwmod *init_oh)
1971 return _add_initiator_dep(oh, init_oh);
1975 * XXX what about functions for drivers to save/restore ocp_sysconfig
1976 * for context save/restore operations?
1980 * omap_hwmod_del_initiator_dep - remove sleepdep from @init_oh to @oh
1981 * @oh: struct omap_hwmod *
1982 * @init_oh: struct omap_hwmod * (initiator)
1984 * Remove a sleep dependency between the initiator @init_oh and @oh.
1985 * Intended to be called by DSP/Bridge code via platform_data for the
1986 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
1987 * code needs to add/del initiator dependencies dynamically
1988 * before/after accessing a device. Returns the return value from
1989 * _del_initiator_dep().
1991 * XXX Keep a usecount in the clockdomain code
1993 int omap_hwmod_del_initiator_dep(struct omap_hwmod *oh,
1994 struct omap_hwmod *init_oh)
1996 return _del_initiator_dep(oh, init_oh);
2000 * omap_hwmod_enable_wakeup - allow device to wake up the system
2001 * @oh: struct omap_hwmod *
2003 * Sets the module OCP socket ENAWAKEUP bit to allow the module to
2004 * send wakeups to the PRCM. Eventually this should sets PRCM wakeup
2005 * registers to cause the PRCM to receive wakeup events from the
2006 * module. Does not set any wakeup routing registers beyond this
2007 * point - if the module is to wake up any other module or subsystem,
2008 * that must be set separately. Called by omap_device code. Returns
2009 * -EINVAL on error or 0 upon success.
2011 int omap_hwmod_enable_wakeup(struct omap_hwmod *oh)
2013 unsigned long flags;
2015 if (!oh->class->sysc ||
2016 !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
2019 spin_lock_irqsave(&oh->_lock, flags);
2021 spin_unlock_irqrestore(&oh->_lock, flags);
2027 * omap_hwmod_disable_wakeup - prevent device from waking the system
2028 * @oh: struct omap_hwmod *
2030 * Clears the module OCP socket ENAWAKEUP bit to prevent the module
2031 * from sending wakeups to the PRCM. Eventually this should clear
2032 * PRCM wakeup registers to cause the PRCM to ignore wakeup events
2033 * from the module. Does not set any wakeup routing registers beyond
2034 * this point - if the module is to wake up any other module or
2035 * subsystem, that must be set separately. Called by omap_device
2036 * code. Returns -EINVAL on error or 0 upon success.
2038 int omap_hwmod_disable_wakeup(struct omap_hwmod *oh)
2040 unsigned long flags;
2042 if (!oh->class->sysc ||
2043 !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
2046 spin_lock_irqsave(&oh->_lock, flags);
2047 _disable_wakeup(oh);
2048 spin_unlock_irqrestore(&oh->_lock, flags);
2054 * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
2055 * contained in the hwmod module.
2056 * @oh: struct omap_hwmod *
2057 * @name: name of the reset line to lookup and assert
2059 * Some IP like dsp, ipu or iva contain processor that require
2060 * an HW reset line to be assert / deassert in order to enable fully
2061 * the IP. Returns -EINVAL if @oh is null or if the operation is not
2062 * yet supported on this OMAP; otherwise, passes along the return value
2063 * from _assert_hardreset().
2065 int omap_hwmod_assert_hardreset(struct omap_hwmod *oh, const char *name)
2068 unsigned long flags;
2073 spin_lock_irqsave(&oh->_lock, flags);
2074 ret = _assert_hardreset(oh, name);
2075 spin_unlock_irqrestore(&oh->_lock, flags);
2081 * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
2082 * contained in the hwmod module.
2083 * @oh: struct omap_hwmod *
2084 * @name: name of the reset line to look up and deassert
2086 * Some IP like dsp, ipu or iva contain processor that require
2087 * an HW reset line to be assert / deassert in order to enable fully
2088 * the IP. Returns -EINVAL if @oh is null or if the operation is not
2089 * yet supported on this OMAP; otherwise, passes along the return value
2090 * from _deassert_hardreset().
2092 int omap_hwmod_deassert_hardreset(struct omap_hwmod *oh, const char *name)
2095 unsigned long flags;
2100 spin_lock_irqsave(&oh->_lock, flags);
2101 ret = _deassert_hardreset(oh, name);
2102 spin_unlock_irqrestore(&oh->_lock, flags);
2108 * omap_hwmod_read_hardreset - read the HW reset line state of submodules
2109 * contained in the hwmod module
2110 * @oh: struct omap_hwmod *
2111 * @name: name of the reset line to look up and read
2113 * Return the current state of the hwmod @oh's reset line named @name:
2114 * returns -EINVAL upon parameter error or if this operation
2115 * is unsupported on the current OMAP; otherwise, passes along the return
2116 * value from _read_hardreset().
2118 int omap_hwmod_read_hardreset(struct omap_hwmod *oh, const char *name)
2121 unsigned long flags;
2126 spin_lock_irqsave(&oh->_lock, flags);
2127 ret = _read_hardreset(oh, name);
2128 spin_unlock_irqrestore(&oh->_lock, flags);
2135 * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
2136 * @classname: struct omap_hwmod_class name to search for
2137 * @fn: callback function pointer to call for each hwmod in class @classname
2138 * @user: arbitrary context data to pass to the callback function
2140 * For each omap_hwmod of class @classname, call @fn. Takes
2141 * omap_hwmod_mutex to prevent the hwmod list from changing during the
2142 * iteration. If the callback function returns something other than
2143 * zero, the iterator is terminated, and the callback function's return
2144 * value is passed back to the caller. Returns 0 upon success, -EINVAL
2145 * if @classname or @fn are NULL, or passes back the error code from @fn.
2147 int omap_hwmod_for_each_by_class(const char *classname,
2148 int (*fn)(struct omap_hwmod *oh,
2152 struct omap_hwmod *temp_oh;
2155 if (!classname || !fn)
2158 pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
2159 __func__, classname);
2161 mutex_lock(&omap_hwmod_mutex);
2163 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
2164 if (!strcmp(temp_oh->class->name, classname)) {
2165 pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
2166 __func__, temp_oh->name);
2167 ret = (*fn)(temp_oh, user);
2173 mutex_unlock(&omap_hwmod_mutex);
2176 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
2183 * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
2184 * @oh: struct omap_hwmod *
2185 * @state: state that _setup() should leave the hwmod in
2187 * Sets the hwmod state that @oh will enter at the end of _setup() (called by
2188 * omap_hwmod_late_init()). Only valid to call between calls to
2189 * omap_hwmod_init() and omap_hwmod_late_init(). Returns 0 upon success or
2190 * -EINVAL if there is a problem with the arguments or if the hwmod is
2191 * in the wrong state.
2193 int omap_hwmod_set_postsetup_state(struct omap_hwmod *oh, u8 state)
2196 unsigned long flags;
2201 if (state != _HWMOD_STATE_DISABLED &&
2202 state != _HWMOD_STATE_ENABLED &&
2203 state != _HWMOD_STATE_IDLE)
2206 spin_lock_irqsave(&oh->_lock, flags);
2208 if (oh->_state != _HWMOD_STATE_REGISTERED) {
2213 oh->_postsetup_state = state;
2217 spin_unlock_irqrestore(&oh->_lock, flags);