2 * omap_hwmod implementation for OMAP2/3/4
4 * Copyright (C) 2009-2011 Nokia Corporation
5 * Copyright (C) 2011-2012 Texas Instruments, Inc.
7 * Paul Walmsley, BenoƮt Cousson, Kevin Hilman
9 * Created in collaboration with (alphabetical order): Thara Gopinath,
10 * Tony Lindgren, Rajendra Nayak, Vikram Pandita, Sakari Poussa, Anand
11 * Sawant, Santosh Shilimkar, Richard Woodruff
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License version 2 as
15 * published by the Free Software Foundation.
19 * One way to view an OMAP SoC is as a collection of largely unrelated
20 * IP blocks connected by interconnects. The IP blocks include
21 * devices such as ARM processors, audio serial interfaces, UARTs,
22 * etc. Some of these devices, like the DSP, are created by TI;
23 * others, like the SGX, largely originate from external vendors. In
24 * TI's documentation, on-chip devices are referred to as "OMAP
25 * modules." Some of these IP blocks are identical across several
26 * OMAP versions. Others are revised frequently.
28 * These OMAP modules are tied together by various interconnects.
29 * Most of the address and data flow between modules is via OCP-based
30 * interconnects such as the L3 and L4 buses; but there are other
31 * interconnects that distribute the hardware clock tree, handle idle
32 * and reset signaling, supply power, and connect the modules to
33 * various pads or balls on the OMAP package.
35 * OMAP hwmod provides a consistent way to describe the on-chip
36 * hardware blocks and their integration into the rest of the chip.
37 * This description can be automatically generated from the TI
38 * hardware database. OMAP hwmod provides a standard, consistent API
39 * to reset, enable, idle, and disable these hardware blocks. And
40 * hwmod provides a way for other core code, such as the Linux device
41 * code or the OMAP power management and address space mapping code,
42 * to query the hardware database.
46 * Drivers won't call hwmod functions directly. That is done by the
47 * omap_device code, and in rare occasions, by custom integration code
48 * in arch/arm/ *omap*. The omap_device code includes functions to
49 * build a struct platform_device using omap_hwmod data, and that is
50 * currently how hwmod data is communicated to drivers and to the
51 * Linux driver model. Most drivers will call omap_hwmod functions only
52 * indirectly, via pm_runtime*() functions.
54 * From a layering perspective, here is where the OMAP hwmod code
55 * fits into the kernel software stack:
57 * +-------------------------------+
58 * | Device driver code |
59 * | (e.g., drivers/) |
60 * +-------------------------------+
61 * | Linux driver model |
62 * | (platform_device / |
63 * | platform_driver data/code) |
64 * +-------------------------------+
65 * | OMAP core-driver integration |
66 * |(arch/arm/mach-omap2/devices.c)|
67 * +-------------------------------+
68 * | omap_device code |
69 * | (../plat-omap/omap_device.c) |
70 * +-------------------------------+
71 * ----> | omap_hwmod code/data | <-----
72 * | (../mach-omap2/omap_hwmod*) |
73 * +-------------------------------+
74 * | OMAP clock/PRCM/register fns |
75 * | (__raw_{read,write}l, clk*) |
76 * +-------------------------------+
78 * Device drivers should not contain any OMAP-specific code or data in
79 * them. They should only contain code to operate the IP block that
80 * the driver is responsible for. This is because these IP blocks can
81 * also appear in other SoCs, either from TI (such as DaVinci) or from
82 * other manufacturers; and drivers should be reusable across other
85 * The OMAP hwmod code also will attempt to reset and idle all on-chip
86 * devices upon boot. The goal here is for the kernel to be
87 * completely self-reliant and independent from bootloaders. This is
88 * to ensure a repeatable configuration, both to ensure consistent
89 * runtime behavior, and to make it easier for others to reproduce
92 * OMAP module activity states
93 * ---------------------------
94 * The hwmod code considers modules to be in one of several activity
95 * states. IP blocks start out in an UNKNOWN state, then once they
96 * are registered via the hwmod code, proceed to the REGISTERED state.
97 * Once their clock names are resolved to clock pointers, the module
98 * enters the CLKS_INITED state; and finally, once the module has been
99 * reset and the integration registers programmed, the INITIALIZED state
100 * is entered. The hwmod code will then place the module into either
101 * the IDLE state to save power, or in the case of a critical system
102 * module, the ENABLED state.
104 * OMAP core integration code can then call omap_hwmod*() functions
105 * directly to move the module between the IDLE, ENABLED, and DISABLED
106 * states, as needed. This is done during both the PM idle loop, and
107 * in the OMAP core integration code's implementation of the PM runtime
112 * This is a partial list.
113 * - OMAP2420 Multimedia Processor Silicon Revision 2.1.1, 2.2 (SWPU064)
114 * - OMAP2430 Multimedia Device POP Silicon Revision 2.1 (SWPU090)
115 * - OMAP34xx Multimedia Device Silicon Revision 3.1 (SWPU108)
116 * - OMAP4430 Multimedia Device Silicon Revision 1.0 (SWPU140)
117 * - Open Core Protocol Specification 2.2
120 * - handle IO mapping
121 * - bus throughput & module latency measurement code
123 * XXX add tests at the beginning of each function to ensure the hwmod is
124 * in the appropriate state
125 * XXX error return values should be checked to ensure that they are
130 #include <linux/kernel.h>
131 #include <linux/errno.h>
132 #include <linux/io.h>
133 #include <linux/clk.h>
134 #include <linux/delay.h>
135 #include <linux/err.h>
136 #include <linux/list.h>
137 #include <linux/mutex.h>
138 #include <linux/spinlock.h>
139 #include <linux/slab.h>
140 #include <linux/bootmem.h>
143 #include <plat/cpu.h>
144 #include "clockdomain.h"
145 #include "powerdomain.h"
146 #include <plat/clock.h>
147 #include <plat/omap_hwmod.h>
148 #include <plat/prcm.h>
150 #include "cm2xxx_3xxx.h"
151 #include "cminst44xx.h"
152 #include "prm2xxx_3xxx.h"
154 #include "prminst44xx.h"
157 /* Maximum microseconds to wait for OMAP module to softreset */
158 #define MAX_MODULE_SOFTRESET_WAIT 10000
160 /* Name of the OMAP hwmod for the MPU */
161 #define MPU_INITIATOR_NAME "mpu"
164 * Number of struct omap_hwmod_link records per struct
165 * omap_hwmod_ocp_if record (master->slave and slave->master)
167 #define LINKS_PER_OCP_IF 2
170 * struct omap_hwmod_soc_ops - fn ptrs for some SoC-specific operations
171 * @enable_module: function to enable a module (via MODULEMODE)
172 * @disable_module: function to disable a module (via MODULEMODE)
174 * XXX Eventually this functionality will be hidden inside the PRM/CM
175 * device drivers. Until then, this should avoid huge blocks of cpu_is_*()
176 * conditionals in this code.
178 struct omap_hwmod_soc_ops {
179 void (*enable_module)(struct omap_hwmod *oh);
180 int (*disable_module)(struct omap_hwmod *oh);
181 int (*wait_target_ready)(struct omap_hwmod *oh);
182 int (*assert_hardreset)(struct omap_hwmod *oh,
183 struct omap_hwmod_rst_info *ohri);
184 int (*deassert_hardreset)(struct omap_hwmod *oh,
185 struct omap_hwmod_rst_info *ohri);
186 int (*is_hardreset_asserted)(struct omap_hwmod *oh,
187 struct omap_hwmod_rst_info *ohri);
188 int (*init_clkdm)(struct omap_hwmod *oh);
191 /* soc_ops: adapts the omap_hwmod code to the currently-booted SoC */
192 static struct omap_hwmod_soc_ops soc_ops;
194 /* omap_hwmod_list contains all registered struct omap_hwmods */
195 static LIST_HEAD(omap_hwmod_list);
197 /* mpu_oh: used to add/remove MPU initiator from sleepdep list */
198 static struct omap_hwmod *mpu_oh;
201 * linkspace: ptr to a buffer that struct omap_hwmod_link records are
202 * allocated from - used to reduce the number of small memory
203 * allocations, which has a significant impact on performance
205 static struct omap_hwmod_link *linkspace;
208 * free_ls, max_ls: array indexes into linkspace; representing the
209 * next free struct omap_hwmod_link index, and the maximum number of
210 * struct omap_hwmod_link records allocated (respectively)
212 static unsigned short free_ls, max_ls, ls_supp;
214 /* inited: set to true once the hwmod code is initialized */
217 /* Private functions */
220 * _fetch_next_ocp_if - return the next OCP interface in a list
221 * @p: ptr to a ptr to the list_head inside the ocp_if to return
222 * @i: pointer to the index of the element pointed to by @p in the list
224 * Return a pointer to the struct omap_hwmod_ocp_if record
225 * containing the struct list_head pointed to by @p, and increment
226 * @p such that a future call to this routine will return the next
229 static struct omap_hwmod_ocp_if *_fetch_next_ocp_if(struct list_head **p,
232 struct omap_hwmod_ocp_if *oi;
234 oi = list_entry(*p, struct omap_hwmod_link, node)->ocp_if;
243 * _update_sysc_cache - return the module OCP_SYSCONFIG register, keep copy
244 * @oh: struct omap_hwmod *
246 * Load the current value of the hwmod OCP_SYSCONFIG register into the
247 * struct omap_hwmod for later use. Returns -EINVAL if the hwmod has no
248 * OCP_SYSCONFIG register or 0 upon success.
250 static int _update_sysc_cache(struct omap_hwmod *oh)
252 if (!oh->class->sysc) {
253 WARN(1, "omap_hwmod: %s: cannot read OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
257 /* XXX ensure module interface clock is up */
259 oh->_sysc_cache = omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
261 if (!(oh->class->sysc->sysc_flags & SYSC_NO_CACHE))
262 oh->_int_flags |= _HWMOD_SYSCONFIG_LOADED;
268 * _write_sysconfig - write a value to the module's OCP_SYSCONFIG register
269 * @v: OCP_SYSCONFIG value to write
270 * @oh: struct omap_hwmod *
272 * Write @v into the module class' OCP_SYSCONFIG register, if it has
273 * one. No return value.
275 static void _write_sysconfig(u32 v, struct omap_hwmod *oh)
277 if (!oh->class->sysc) {
278 WARN(1, "omap_hwmod: %s: cannot write OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
282 /* XXX ensure module interface clock is up */
284 /* Module might have lost context, always update cache and register */
286 omap_hwmod_write(v, oh, oh->class->sysc->sysc_offs);
290 * _set_master_standbymode: set the OCP_SYSCONFIG MIDLEMODE field in @v
291 * @oh: struct omap_hwmod *
292 * @standbymode: MIDLEMODE field bits
293 * @v: pointer to register contents to modify
295 * Update the master standby mode bits in @v to be @standbymode for
296 * the @oh hwmod. Does not write to the hardware. Returns -EINVAL
297 * upon error or 0 upon success.
299 static int _set_master_standbymode(struct omap_hwmod *oh, u8 standbymode,
305 if (!oh->class->sysc ||
306 !(oh->class->sysc->sysc_flags & SYSC_HAS_MIDLEMODE))
309 if (!oh->class->sysc->sysc_fields) {
310 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
314 mstandby_shift = oh->class->sysc->sysc_fields->midle_shift;
315 mstandby_mask = (0x3 << mstandby_shift);
317 *v &= ~mstandby_mask;
318 *v |= __ffs(standbymode) << mstandby_shift;
324 * _set_slave_idlemode: set the OCP_SYSCONFIG SIDLEMODE field in @v
325 * @oh: struct omap_hwmod *
326 * @idlemode: SIDLEMODE field bits
327 * @v: pointer to register contents to modify
329 * Update the slave idle mode bits in @v to be @idlemode for the @oh
330 * hwmod. Does not write to the hardware. Returns -EINVAL upon error
333 static int _set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode, u32 *v)
338 if (!oh->class->sysc ||
339 !(oh->class->sysc->sysc_flags & SYSC_HAS_SIDLEMODE))
342 if (!oh->class->sysc->sysc_fields) {
343 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
347 sidle_shift = oh->class->sysc->sysc_fields->sidle_shift;
348 sidle_mask = (0x3 << sidle_shift);
351 *v |= __ffs(idlemode) << sidle_shift;
357 * _set_clockactivity: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
358 * @oh: struct omap_hwmod *
359 * @clockact: CLOCKACTIVITY field bits
360 * @v: pointer to register contents to modify
362 * Update the clockactivity mode bits in @v to be @clockact for the
363 * @oh hwmod. Used for additional powersaving on some modules. Does
364 * not write to the hardware. Returns -EINVAL upon error or 0 upon
367 static int _set_clockactivity(struct omap_hwmod *oh, u8 clockact, u32 *v)
372 if (!oh->class->sysc ||
373 !(oh->class->sysc->sysc_flags & SYSC_HAS_CLOCKACTIVITY))
376 if (!oh->class->sysc->sysc_fields) {
377 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
381 clkact_shift = oh->class->sysc->sysc_fields->clkact_shift;
382 clkact_mask = (0x3 << clkact_shift);
385 *v |= clockact << clkact_shift;
391 * _set_softreset: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
392 * @oh: struct omap_hwmod *
393 * @v: pointer to register contents to modify
395 * Set the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
396 * error or 0 upon success.
398 static int _set_softreset(struct omap_hwmod *oh, u32 *v)
402 if (!oh->class->sysc ||
403 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
406 if (!oh->class->sysc->sysc_fields) {
407 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
411 softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
419 * _set_module_autoidle: set the OCP_SYSCONFIG AUTOIDLE field in @v
420 * @oh: struct omap_hwmod *
421 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
422 * @v: pointer to register contents to modify
424 * Update the module autoidle bit in @v to be @autoidle for the @oh
425 * hwmod. The autoidle bit controls whether the module can gate
426 * internal clocks automatically when it isn't doing anything; the
427 * exact function of this bit varies on a per-module basis. This
428 * function does not write to the hardware. Returns -EINVAL upon
429 * error or 0 upon success.
431 static int _set_module_autoidle(struct omap_hwmod *oh, u8 autoidle,
437 if (!oh->class->sysc ||
438 !(oh->class->sysc->sysc_flags & SYSC_HAS_AUTOIDLE))
441 if (!oh->class->sysc->sysc_fields) {
442 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
446 autoidle_shift = oh->class->sysc->sysc_fields->autoidle_shift;
447 autoidle_mask = (0x1 << autoidle_shift);
449 *v &= ~autoidle_mask;
450 *v |= autoidle << autoidle_shift;
456 * _set_idle_ioring_wakeup - enable/disable IO pad wakeup on hwmod idle for mux
457 * @oh: struct omap_hwmod *
458 * @set_wake: bool value indicating to set (true) or clear (false) wakeup enable
460 * Set or clear the I/O pad wakeup flag in the mux entries for the
461 * hwmod @oh. This function changes the @oh->mux->pads_dynamic array
462 * in memory. If the hwmod is currently idled, and the new idle
463 * values don't match the previous ones, this function will also
464 * update the SCM PADCTRL registers. Otherwise, if the hwmod is not
465 * currently idled, this function won't touch the hardware: the new
466 * mux settings are written to the SCM PADCTRL registers when the
467 * hwmod is idled. No return value.
469 static void _set_idle_ioring_wakeup(struct omap_hwmod *oh, bool set_wake)
471 struct omap_device_pad *pad;
476 if (!oh->mux || !oh->mux->enabled)
479 for (j = 0; j < oh->mux->nr_pads_dynamic; j++) {
480 pad = oh->mux->pads_dynamic[j];
482 if (!(pad->flags & OMAP_DEVICE_PAD_WAKEUP))
485 prev_idle = pad->idle;
488 pad->idle |= OMAP_WAKEUP_EN;
490 pad->idle &= ~OMAP_WAKEUP_EN;
492 if (prev_idle != pad->idle)
496 if (change && oh->_state == _HWMOD_STATE_IDLE)
497 omap_hwmod_mux(oh->mux, _HWMOD_STATE_IDLE);
501 * _enable_wakeup: set OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
502 * @oh: struct omap_hwmod *
504 * Allow the hardware module @oh to send wakeups. Returns -EINVAL
505 * upon error or 0 upon success.
507 static int _enable_wakeup(struct omap_hwmod *oh, u32 *v)
509 if (!oh->class->sysc ||
510 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
511 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
512 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
515 if (!oh->class->sysc->sysc_fields) {
516 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
520 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
521 *v |= 0x1 << oh->class->sysc->sysc_fields->enwkup_shift;
523 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
524 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
525 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
526 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
528 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
530 oh->_int_flags |= _HWMOD_WAKEUP_ENABLED;
536 * _disable_wakeup: clear OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
537 * @oh: struct omap_hwmod *
539 * Prevent the hardware module @oh to send wakeups. Returns -EINVAL
540 * upon error or 0 upon success.
542 static int _disable_wakeup(struct omap_hwmod *oh, u32 *v)
544 if (!oh->class->sysc ||
545 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
546 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
547 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
550 if (!oh->class->sysc->sysc_fields) {
551 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
555 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
556 *v &= ~(0x1 << oh->class->sysc->sysc_fields->enwkup_shift);
558 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
559 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART, v);
560 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
561 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART, v);
563 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
565 oh->_int_flags &= ~_HWMOD_WAKEUP_ENABLED;
571 * _add_initiator_dep: prevent @oh from smart-idling while @init_oh is active
572 * @oh: struct omap_hwmod *
574 * Prevent the hardware module @oh from entering idle while the
575 * hardare module initiator @init_oh is active. Useful when a module
576 * will be accessed by a particular initiator (e.g., if a module will
577 * be accessed by the IVA, there should be a sleepdep between the IVA
578 * initiator and the module). Only applies to modules in smart-idle
579 * mode. If the clockdomain is marked as not needing autodeps, return
580 * 0 without doing anything. Otherwise, returns -EINVAL upon error or
581 * passes along clkdm_add_sleepdep() value upon success.
583 static int _add_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
588 if (oh->_clk->clkdm && oh->_clk->clkdm->flags & CLKDM_NO_AUTODEPS)
591 return clkdm_add_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
595 * _del_initiator_dep: allow @oh to smart-idle even if @init_oh is active
596 * @oh: struct omap_hwmod *
598 * Allow the hardware module @oh to enter idle while the hardare
599 * module initiator @init_oh is active. Useful when a module will not
600 * be accessed by a particular initiator (e.g., if a module will not
601 * be accessed by the IVA, there should be no sleepdep between the IVA
602 * initiator and the module). Only applies to modules in smart-idle
603 * mode. If the clockdomain is marked as not needing autodeps, return
604 * 0 without doing anything. Returns -EINVAL upon error or passes
605 * along clkdm_del_sleepdep() value upon success.
607 static int _del_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
612 if (oh->_clk->clkdm && oh->_clk->clkdm->flags & CLKDM_NO_AUTODEPS)
615 return clkdm_del_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
619 * _init_main_clk - get a struct clk * for the the hwmod's main functional clk
620 * @oh: struct omap_hwmod *
622 * Called from _init_clocks(). Populates the @oh _clk (main
623 * functional clock pointer) if a main_clk is present. Returns 0 on
624 * success or -EINVAL on error.
626 static int _init_main_clk(struct omap_hwmod *oh)
633 oh->_clk = omap_clk_get_by_name(oh->main_clk);
635 pr_warning("omap_hwmod: %s: cannot clk_get main_clk %s\n",
636 oh->name, oh->main_clk);
640 if (!oh->_clk->clkdm)
641 pr_warning("omap_hwmod: %s: missing clockdomain for %s.\n",
642 oh->main_clk, oh->_clk->name);
648 * _init_interface_clks - get a struct clk * for the the hwmod's interface clks
649 * @oh: struct omap_hwmod *
651 * Called from _init_clocks(). Populates the @oh OCP slave interface
652 * clock pointers. Returns 0 on success or -EINVAL on error.
654 static int _init_interface_clks(struct omap_hwmod *oh)
656 struct omap_hwmod_ocp_if *os;
662 p = oh->slave_ports.next;
664 while (i < oh->slaves_cnt) {
665 os = _fetch_next_ocp_if(&p, &i);
669 c = omap_clk_get_by_name(os->clk);
671 pr_warning("omap_hwmod: %s: cannot clk_get interface_clk %s\n",
682 * _init_opt_clk - get a struct clk * for the the hwmod's optional clocks
683 * @oh: struct omap_hwmod *
685 * Called from _init_clocks(). Populates the @oh omap_hwmod_opt_clk
686 * clock pointers. Returns 0 on success or -EINVAL on error.
688 static int _init_opt_clks(struct omap_hwmod *oh)
690 struct omap_hwmod_opt_clk *oc;
695 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++) {
696 c = omap_clk_get_by_name(oc->clk);
698 pr_warning("omap_hwmod: %s: cannot clk_get opt_clk %s\n",
709 * _enable_clocks - enable hwmod main clock and interface clocks
710 * @oh: struct omap_hwmod *
712 * Enables all clocks necessary for register reads and writes to succeed
713 * on the hwmod @oh. Returns 0.
715 static int _enable_clocks(struct omap_hwmod *oh)
717 struct omap_hwmod_ocp_if *os;
721 pr_debug("omap_hwmod: %s: enabling clocks\n", oh->name);
724 clk_enable(oh->_clk);
726 p = oh->slave_ports.next;
728 while (i < oh->slaves_cnt) {
729 os = _fetch_next_ocp_if(&p, &i);
731 if (os->_clk && (os->flags & OCPIF_SWSUP_IDLE))
732 clk_enable(os->_clk);
735 /* The opt clocks are controlled by the device driver. */
741 * _disable_clocks - disable hwmod main clock and interface clocks
742 * @oh: struct omap_hwmod *
744 * Disables the hwmod @oh main functional and interface clocks. Returns 0.
746 static int _disable_clocks(struct omap_hwmod *oh)
748 struct omap_hwmod_ocp_if *os;
752 pr_debug("omap_hwmod: %s: disabling clocks\n", oh->name);
755 clk_disable(oh->_clk);
757 p = oh->slave_ports.next;
759 while (i < oh->slaves_cnt) {
760 os = _fetch_next_ocp_if(&p, &i);
762 if (os->_clk && (os->flags & OCPIF_SWSUP_IDLE))
763 clk_disable(os->_clk);
766 /* The opt clocks are controlled by the device driver. */
771 static void _enable_optional_clocks(struct omap_hwmod *oh)
773 struct omap_hwmod_opt_clk *oc;
776 pr_debug("omap_hwmod: %s: enabling optional clocks\n", oh->name);
778 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
780 pr_debug("omap_hwmod: enable %s:%s\n", oc->role,
782 clk_enable(oc->_clk);
786 static void _disable_optional_clocks(struct omap_hwmod *oh)
788 struct omap_hwmod_opt_clk *oc;
791 pr_debug("omap_hwmod: %s: disabling optional clocks\n", oh->name);
793 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
795 pr_debug("omap_hwmod: disable %s:%s\n", oc->role,
797 clk_disable(oc->_clk);
802 * _omap4_enable_module - enable CLKCTRL modulemode on OMAP4
803 * @oh: struct omap_hwmod *
805 * Enables the PRCM module mode related to the hwmod @oh.
808 static void _omap4_enable_module(struct omap_hwmod *oh)
810 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
813 pr_debug("omap_hwmod: %s: %s: %d\n",
814 oh->name, __func__, oh->prcm.omap4.modulemode);
816 omap4_cminst_module_enable(oh->prcm.omap4.modulemode,
817 oh->clkdm->prcm_partition,
819 oh->clkdm->clkdm_offs,
820 oh->prcm.omap4.clkctrl_offs);
824 * _omap4_wait_target_disable - wait for a module to be disabled on OMAP4
825 * @oh: struct omap_hwmod *
827 * Wait for a module @oh to enter slave idle. Returns 0 if the module
828 * does not have an IDLEST bit or if the module successfully enters
829 * slave idle; otherwise, pass along the return value of the
830 * appropriate *_cm*_wait_module_idle() function.
832 static int _omap4_wait_target_disable(struct omap_hwmod *oh)
834 if (!oh || !oh->clkdm)
837 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
840 if (oh->flags & HWMOD_NO_IDLEST)
843 return omap4_cminst_wait_module_idle(oh->clkdm->prcm_partition,
845 oh->clkdm->clkdm_offs,
846 oh->prcm.omap4.clkctrl_offs);
850 * _count_mpu_irqs - count the number of MPU IRQ lines associated with @oh
851 * @oh: struct omap_hwmod *oh
853 * Count and return the number of MPU IRQs associated with the hwmod
854 * @oh. Used to allocate struct resource data. Returns 0 if @oh is
857 static int _count_mpu_irqs(struct omap_hwmod *oh)
859 struct omap_hwmod_irq_info *ohii;
862 if (!oh || !oh->mpu_irqs)
866 ohii = &oh->mpu_irqs[i++];
867 } while (ohii->irq != -1);
873 * _count_sdma_reqs - count the number of SDMA request lines associated with @oh
874 * @oh: struct omap_hwmod *oh
876 * Count and return the number of SDMA request lines associated with
877 * the hwmod @oh. Used to allocate struct resource data. Returns 0
880 static int _count_sdma_reqs(struct omap_hwmod *oh)
882 struct omap_hwmod_dma_info *ohdi;
885 if (!oh || !oh->sdma_reqs)
889 ohdi = &oh->sdma_reqs[i++];
890 } while (ohdi->dma_req != -1);
896 * _count_ocp_if_addr_spaces - count the number of address space entries for @oh
897 * @oh: struct omap_hwmod *oh
899 * Count and return the number of address space ranges associated with
900 * the hwmod @oh. Used to allocate struct resource data. Returns 0
903 static int _count_ocp_if_addr_spaces(struct omap_hwmod_ocp_if *os)
905 struct omap_hwmod_addr_space *mem;
908 if (!os || !os->addr)
912 mem = &os->addr[i++];
913 } while (mem->pa_start != mem->pa_end);
919 * _get_mpu_irq_by_name - fetch MPU interrupt line number by name
920 * @oh: struct omap_hwmod * to operate on
921 * @name: pointer to the name of the MPU interrupt number to fetch (optional)
922 * @irq: pointer to an unsigned int to store the MPU IRQ number to
924 * Retrieve a MPU hardware IRQ line number named by @name associated
925 * with the IP block pointed to by @oh. The IRQ number will be filled
926 * into the address pointed to by @dma. When @name is non-null, the
927 * IRQ line number associated with the named entry will be returned.
928 * If @name is null, the first matching entry will be returned. Data
929 * order is not meaningful in hwmod data, so callers are strongly
930 * encouraged to use a non-null @name whenever possible to avoid
931 * unpredictable effects if hwmod data is later added that causes data
932 * ordering to change. Returns 0 upon success or a negative error
935 static int _get_mpu_irq_by_name(struct omap_hwmod *oh, const char *name,
945 while (oh->mpu_irqs[i].irq != -1) {
946 if (name == oh->mpu_irqs[i].name ||
947 !strcmp(name, oh->mpu_irqs[i].name)) {
957 *irq = oh->mpu_irqs[i].irq;
963 * _get_sdma_req_by_name - fetch SDMA request line ID by name
964 * @oh: struct omap_hwmod * to operate on
965 * @name: pointer to the name of the SDMA request line to fetch (optional)
966 * @dma: pointer to an unsigned int to store the request line ID to
968 * Retrieve an SDMA request line ID named by @name on the IP block
969 * pointed to by @oh. The ID will be filled into the address pointed
970 * to by @dma. When @name is non-null, the request line ID associated
971 * with the named entry will be returned. If @name is null, the first
972 * matching entry will be returned. Data order is not meaningful in
973 * hwmod data, so callers are strongly encouraged to use a non-null
974 * @name whenever possible to avoid unpredictable effects if hwmod
975 * data is later added that causes data ordering to change. Returns 0
976 * upon success or a negative error code upon error.
978 static int _get_sdma_req_by_name(struct omap_hwmod *oh, const char *name,
988 while (oh->sdma_reqs[i].dma_req != -1) {
989 if (name == oh->sdma_reqs[i].name ||
990 !strcmp(name, oh->sdma_reqs[i].name)) {
1000 *dma = oh->sdma_reqs[i].dma_req;
1006 * _get_addr_space_by_name - fetch address space start & end by name
1007 * @oh: struct omap_hwmod * to operate on
1008 * @name: pointer to the name of the address space to fetch (optional)
1009 * @pa_start: pointer to a u32 to store the starting address to
1010 * @pa_end: pointer to a u32 to store the ending address to
1012 * Retrieve address space start and end addresses for the IP block
1013 * pointed to by @oh. The data will be filled into the addresses
1014 * pointed to by @pa_start and @pa_end. When @name is non-null, the
1015 * address space data associated with the named entry will be
1016 * returned. If @name is null, the first matching entry will be
1017 * returned. Data order is not meaningful in hwmod data, so callers
1018 * are strongly encouraged to use a non-null @name whenever possible
1019 * to avoid unpredictable effects if hwmod data is later added that
1020 * causes data ordering to change. Returns 0 upon success or a
1021 * negative error code upon error.
1023 static int _get_addr_space_by_name(struct omap_hwmod *oh, const char *name,
1024 u32 *pa_start, u32 *pa_end)
1027 struct omap_hwmod_ocp_if *os;
1028 struct list_head *p = NULL;
1031 p = oh->slave_ports.next;
1034 while (i < oh->slaves_cnt) {
1035 os = _fetch_next_ocp_if(&p, &i);
1041 while (os->addr[j].pa_start != os->addr[j].pa_end) {
1042 if (name == os->addr[j].name ||
1043 !strcmp(name, os->addr[j].name)) {
1057 *pa_start = os->addr[j].pa_start;
1058 *pa_end = os->addr[j].pa_end;
1064 * _save_mpu_port_index - find and save the index to @oh's MPU port
1065 * @oh: struct omap_hwmod *
1067 * Determines the array index of the OCP slave port that the MPU uses
1068 * to address the device, and saves it into the struct omap_hwmod.
1069 * Intended to be called during hwmod registration only. No return
1072 static void __init _save_mpu_port_index(struct omap_hwmod *oh)
1074 struct omap_hwmod_ocp_if *os = NULL;
1075 struct list_head *p;
1081 oh->_int_flags |= _HWMOD_NO_MPU_PORT;
1083 p = oh->slave_ports.next;
1085 while (i < oh->slaves_cnt) {
1086 os = _fetch_next_ocp_if(&p, &i);
1087 if (os->user & OCP_USER_MPU) {
1089 oh->_int_flags &= ~_HWMOD_NO_MPU_PORT;
1098 * _find_mpu_rt_port - return omap_hwmod_ocp_if accessible by the MPU
1099 * @oh: struct omap_hwmod *
1101 * Given a pointer to a struct omap_hwmod record @oh, return a pointer
1102 * to the struct omap_hwmod_ocp_if record that is used by the MPU to
1103 * communicate with the IP block. This interface need not be directly
1104 * connected to the MPU (and almost certainly is not), but is directly
1105 * connected to the IP block represented by @oh. Returns a pointer
1106 * to the struct omap_hwmod_ocp_if * upon success, or returns NULL upon
1107 * error or if there does not appear to be a path from the MPU to this
1110 static struct omap_hwmod_ocp_if *_find_mpu_rt_port(struct omap_hwmod *oh)
1112 if (!oh || oh->_int_flags & _HWMOD_NO_MPU_PORT || oh->slaves_cnt == 0)
1115 return oh->_mpu_port;
1119 * _find_mpu_rt_addr_space - return MPU register target address space for @oh
1120 * @oh: struct omap_hwmod *
1122 * Returns a pointer to the struct omap_hwmod_addr_space record representing
1123 * the register target MPU address space; or returns NULL upon error.
1125 static struct omap_hwmod_addr_space * __init _find_mpu_rt_addr_space(struct omap_hwmod *oh)
1127 struct omap_hwmod_ocp_if *os;
1128 struct omap_hwmod_addr_space *mem;
1129 int found = 0, i = 0;
1131 os = _find_mpu_rt_port(oh);
1132 if (!os || !os->addr)
1136 mem = &os->addr[i++];
1137 if (mem->flags & ADDR_TYPE_RT)
1139 } while (!found && mem->pa_start != mem->pa_end);
1141 return (found) ? mem : NULL;
1145 * _enable_sysc - try to bring a module out of idle via OCP_SYSCONFIG
1146 * @oh: struct omap_hwmod *
1148 * Ensure that the OCP_SYSCONFIG register for the IP block represented
1149 * by @oh is set to indicate to the PRCM that the IP block is active.
1150 * Usually this means placing the module into smart-idle mode and
1151 * smart-standby, but if there is a bug in the automatic idle handling
1152 * for the IP block, it may need to be placed into the force-idle or
1153 * no-idle variants of these modes. No return value.
1155 static void _enable_sysc(struct omap_hwmod *oh)
1161 if (!oh->class->sysc)
1164 v = oh->_sysc_cache;
1165 sf = oh->class->sysc->sysc_flags;
1167 if (sf & SYSC_HAS_SIDLEMODE) {
1168 clkdm_act = ((oh->clkdm &&
1169 oh->clkdm->flags & CLKDM_ACTIVE_WITH_MPU) ||
1170 (oh->_clk && oh->_clk->clkdm &&
1171 oh->_clk->clkdm->flags & CLKDM_ACTIVE_WITH_MPU));
1172 if (clkdm_act && !(oh->class->sysc->idlemodes &
1173 (SIDLE_SMART | SIDLE_SMART_WKUP)))
1174 idlemode = HWMOD_IDLEMODE_FORCE;
1176 idlemode = (oh->flags & HWMOD_SWSUP_SIDLE) ?
1177 HWMOD_IDLEMODE_NO : HWMOD_IDLEMODE_SMART;
1178 _set_slave_idlemode(oh, idlemode, &v);
1181 if (sf & SYSC_HAS_MIDLEMODE) {
1182 if (oh->flags & HWMOD_SWSUP_MSTANDBY) {
1183 idlemode = HWMOD_IDLEMODE_NO;
1185 if (sf & SYSC_HAS_ENAWAKEUP)
1186 _enable_wakeup(oh, &v);
1187 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1188 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1190 idlemode = HWMOD_IDLEMODE_SMART;
1192 _set_master_standbymode(oh, idlemode, &v);
1196 * XXX The clock framework should handle this, by
1197 * calling into this code. But this must wait until the
1198 * clock structures are tagged with omap_hwmod entries
1200 if ((oh->flags & HWMOD_SET_DEFAULT_CLOCKACT) &&
1201 (sf & SYSC_HAS_CLOCKACTIVITY))
1202 _set_clockactivity(oh, oh->class->sysc->clockact, &v);
1204 /* If slave is in SMARTIDLE, also enable wakeup */
1205 if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
1206 _enable_wakeup(oh, &v);
1208 _write_sysconfig(v, oh);
1211 * Set the autoidle bit only after setting the smartidle bit
1212 * Setting this will not have any impact on the other modules.
1214 if (sf & SYSC_HAS_AUTOIDLE) {
1215 idlemode = (oh->flags & HWMOD_NO_OCP_AUTOIDLE) ?
1217 _set_module_autoidle(oh, idlemode, &v);
1218 _write_sysconfig(v, oh);
1223 * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
1224 * @oh: struct omap_hwmod *
1226 * If module is marked as SWSUP_SIDLE, force the module into slave
1227 * idle; otherwise, configure it for smart-idle. If module is marked
1228 * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
1229 * configure it for smart-standby. No return value.
1231 static void _idle_sysc(struct omap_hwmod *oh)
1236 if (!oh->class->sysc)
1239 v = oh->_sysc_cache;
1240 sf = oh->class->sysc->sysc_flags;
1242 if (sf & SYSC_HAS_SIDLEMODE) {
1243 /* XXX What about HWMOD_IDLEMODE_SMART_WKUP? */
1244 if (oh->flags & HWMOD_SWSUP_SIDLE ||
1245 !(oh->class->sysc->idlemodes &
1246 (SIDLE_SMART | SIDLE_SMART_WKUP)))
1247 idlemode = HWMOD_IDLEMODE_FORCE;
1249 idlemode = HWMOD_IDLEMODE_SMART;
1250 _set_slave_idlemode(oh, idlemode, &v);
1253 if (sf & SYSC_HAS_MIDLEMODE) {
1254 if (oh->flags & HWMOD_SWSUP_MSTANDBY) {
1255 idlemode = HWMOD_IDLEMODE_FORCE;
1257 if (sf & SYSC_HAS_ENAWAKEUP)
1258 _enable_wakeup(oh, &v);
1259 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1260 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1262 idlemode = HWMOD_IDLEMODE_SMART;
1264 _set_master_standbymode(oh, idlemode, &v);
1267 /* If slave is in SMARTIDLE, also enable wakeup */
1268 if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
1269 _enable_wakeup(oh, &v);
1271 _write_sysconfig(v, oh);
1275 * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
1276 * @oh: struct omap_hwmod *
1278 * Force the module into slave idle and master suspend. No return
1281 static void _shutdown_sysc(struct omap_hwmod *oh)
1286 if (!oh->class->sysc)
1289 v = oh->_sysc_cache;
1290 sf = oh->class->sysc->sysc_flags;
1292 if (sf & SYSC_HAS_SIDLEMODE)
1293 _set_slave_idlemode(oh, HWMOD_IDLEMODE_FORCE, &v);
1295 if (sf & SYSC_HAS_MIDLEMODE)
1296 _set_master_standbymode(oh, HWMOD_IDLEMODE_FORCE, &v);
1298 if (sf & SYSC_HAS_AUTOIDLE)
1299 _set_module_autoidle(oh, 1, &v);
1301 _write_sysconfig(v, oh);
1305 * _lookup - find an omap_hwmod by name
1306 * @name: find an omap_hwmod by name
1308 * Return a pointer to an omap_hwmod by name, or NULL if not found.
1310 static struct omap_hwmod *_lookup(const char *name)
1312 struct omap_hwmod *oh, *temp_oh;
1316 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1317 if (!strcmp(name, temp_oh->name)) {
1327 * _init_clkdm - look up a clockdomain name, store pointer in omap_hwmod
1328 * @oh: struct omap_hwmod *
1330 * Convert a clockdomain name stored in a struct omap_hwmod into a
1331 * clockdomain pointer, and save it into the struct omap_hwmod.
1332 * Return -EINVAL if the clkdm_name lookup failed.
1334 static int _init_clkdm(struct omap_hwmod *oh)
1336 if (!oh->clkdm_name)
1339 oh->clkdm = clkdm_lookup(oh->clkdm_name);
1341 pr_warning("omap_hwmod: %s: could not associate to clkdm %s\n",
1342 oh->name, oh->clkdm_name);
1346 pr_debug("omap_hwmod: %s: associated to clkdm %s\n",
1347 oh->name, oh->clkdm_name);
1353 * _init_clocks - clk_get() all clocks associated with this hwmod. Retrieve as
1354 * well the clockdomain.
1355 * @oh: struct omap_hwmod *
1356 * @data: not used; pass NULL
1358 * Called by omap_hwmod_setup_*() (after omap2_clk_init()).
1359 * Resolves all clock names embedded in the hwmod. Returns 0 on
1360 * success, or a negative error code on failure.
1362 static int _init_clocks(struct omap_hwmod *oh, void *data)
1366 if (oh->_state != _HWMOD_STATE_REGISTERED)
1369 pr_debug("omap_hwmod: %s: looking up clocks\n", oh->name);
1371 ret |= _init_main_clk(oh);
1372 ret |= _init_interface_clks(oh);
1373 ret |= _init_opt_clks(oh);
1374 if (soc_ops.init_clkdm)
1375 ret |= soc_ops.init_clkdm(oh);
1378 oh->_state = _HWMOD_STATE_CLKS_INITED;
1380 pr_warning("omap_hwmod: %s: cannot _init_clocks\n", oh->name);
1386 * _lookup_hardreset - fill register bit info for this hwmod/reset line
1387 * @oh: struct omap_hwmod *
1388 * @name: name of the reset line in the context of this hwmod
1389 * @ohri: struct omap_hwmod_rst_info * that this function will fill in
1391 * Return the bit position of the reset line that match the
1392 * input name. Return -ENOENT if not found.
1394 static u8 _lookup_hardreset(struct omap_hwmod *oh, const char *name,
1395 struct omap_hwmod_rst_info *ohri)
1399 for (i = 0; i < oh->rst_lines_cnt; i++) {
1400 const char *rst_line = oh->rst_lines[i].name;
1401 if (!strcmp(rst_line, name)) {
1402 ohri->rst_shift = oh->rst_lines[i].rst_shift;
1403 ohri->st_shift = oh->rst_lines[i].st_shift;
1404 pr_debug("omap_hwmod: %s: %s: %s: rst %d st %d\n",
1405 oh->name, __func__, rst_line, ohri->rst_shift,
1416 * _assert_hardreset - assert the HW reset line of submodules
1417 * contained in the hwmod module.
1418 * @oh: struct omap_hwmod *
1419 * @name: name of the reset line to lookup and assert
1421 * Some IP like dsp, ipu or iva contain processor that require an HW
1422 * reset line to be assert / deassert in order to enable fully the IP.
1423 * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1424 * asserting the hardreset line on the currently-booted SoC, or passes
1425 * along the return value from _lookup_hardreset() or the SoC's
1426 * assert_hardreset code.
1428 static int _assert_hardreset(struct omap_hwmod *oh, const char *name)
1430 struct omap_hwmod_rst_info ohri;
1436 if (!soc_ops.assert_hardreset)
1439 ret = _lookup_hardreset(oh, name, &ohri);
1440 if (IS_ERR_VALUE(ret))
1443 ret = soc_ops.assert_hardreset(oh, &ohri);
1449 * _deassert_hardreset - deassert the HW reset line of submodules contained
1450 * in the hwmod module.
1451 * @oh: struct omap_hwmod *
1452 * @name: name of the reset line to look up and deassert
1454 * Some IP like dsp, ipu or iva contain processor that require an HW
1455 * reset line to be assert / deassert in order to enable fully the IP.
1456 * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1457 * deasserting the hardreset line on the currently-booted SoC, or passes
1458 * along the return value from _lookup_hardreset() or the SoC's
1459 * deassert_hardreset code.
1461 static int _deassert_hardreset(struct omap_hwmod *oh, const char *name)
1463 struct omap_hwmod_rst_info ohri;
1469 if (!soc_ops.deassert_hardreset)
1472 ret = _lookup_hardreset(oh, name, &ohri);
1473 if (IS_ERR_VALUE(ret))
1476 ret = soc_ops.deassert_hardreset(oh, &ohri);
1478 pr_warning("omap_hwmod: %s: failed to hardreset\n", oh->name);
1484 * _read_hardreset - read the HW reset line state of submodules
1485 * contained in the hwmod module
1486 * @oh: struct omap_hwmod *
1487 * @name: name of the reset line to look up and read
1489 * Return the state of the reset line. Returns -EINVAL if @oh is
1490 * null, -ENOSYS if we have no way of reading the hardreset line
1491 * status on the currently-booted SoC, or passes along the return
1492 * value from _lookup_hardreset() or the SoC's is_hardreset_asserted
1495 static int _read_hardreset(struct omap_hwmod *oh, const char *name)
1497 struct omap_hwmod_rst_info ohri;
1503 if (!soc_ops.is_hardreset_asserted)
1506 ret = _lookup_hardreset(oh, name, &ohri);
1507 if (IS_ERR_VALUE(ret))
1510 return soc_ops.is_hardreset_asserted(oh, &ohri);
1514 * _are_any_hardreset_lines_asserted - return true if part of @oh is hard-reset
1515 * @oh: struct omap_hwmod *
1517 * If any hardreset line associated with @oh is asserted, then return true.
1518 * Otherwise, if @oh has no hardreset lines associated with it, or if
1519 * no hardreset lines associated with @oh are asserted, then return false.
1520 * This function is used to avoid executing some parts of the IP block
1521 * enable/disable sequence if a hardreset line is set.
1523 static bool _are_any_hardreset_lines_asserted(struct omap_hwmod *oh)
1527 if (oh->rst_lines_cnt == 0)
1530 for (i = 0; i < oh->rst_lines_cnt; i++)
1531 if (_read_hardreset(oh, oh->rst_lines[i].name) > 0)
1538 * _omap4_disable_module - enable CLKCTRL modulemode on OMAP4
1539 * @oh: struct omap_hwmod *
1541 * Disable the PRCM module mode related to the hwmod @oh.
1542 * Return EINVAL if the modulemode is not supported and 0 in case of success.
1544 static int _omap4_disable_module(struct omap_hwmod *oh)
1548 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
1551 pr_debug("omap_hwmod: %s: %s\n", oh->name, __func__);
1553 omap4_cminst_module_disable(oh->clkdm->prcm_partition,
1555 oh->clkdm->clkdm_offs,
1556 oh->prcm.omap4.clkctrl_offs);
1558 if (_are_any_hardreset_lines_asserted(oh))
1561 v = _omap4_wait_target_disable(oh);
1563 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1570 * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1571 * @oh: struct omap_hwmod *
1573 * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit. hwmod must be
1574 * enabled for this to work. Returns -ENOENT if the hwmod cannot be
1575 * reset this way, -EINVAL if the hwmod is in the wrong state,
1576 * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1578 * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1579 * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1580 * use the SYSCONFIG softreset bit to provide the status.
1582 * Note that some IP like McBSP do have reset control but don't have
1585 static int _ocp_softreset(struct omap_hwmod *oh)
1587 u32 v, softrst_mask;
1591 if (!oh->class->sysc ||
1592 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
1595 /* clocks must be on for this operation */
1596 if (oh->_state != _HWMOD_STATE_ENABLED) {
1597 pr_warning("omap_hwmod: %s: reset can only be entered from "
1598 "enabled state\n", oh->name);
1602 /* For some modules, all optionnal clocks need to be enabled as well */
1603 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1604 _enable_optional_clocks(oh);
1606 pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh->name);
1608 v = oh->_sysc_cache;
1609 ret = _set_softreset(oh, &v);
1612 _write_sysconfig(v, oh);
1614 if (oh->class->sysc->srst_udelay)
1615 udelay(oh->class->sysc->srst_udelay);
1617 if (oh->class->sysc->sysc_flags & SYSS_HAS_RESET_STATUS)
1618 omap_test_timeout((omap_hwmod_read(oh,
1619 oh->class->sysc->syss_offs)
1620 & SYSS_RESETDONE_MASK),
1621 MAX_MODULE_SOFTRESET_WAIT, c);
1622 else if (oh->class->sysc->sysc_flags & SYSC_HAS_RESET_STATUS) {
1623 softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
1624 omap_test_timeout(!(omap_hwmod_read(oh,
1625 oh->class->sysc->sysc_offs)
1627 MAX_MODULE_SOFTRESET_WAIT, c);
1630 if (c == MAX_MODULE_SOFTRESET_WAIT)
1631 pr_warning("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1632 oh->name, MAX_MODULE_SOFTRESET_WAIT);
1634 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh->name, c);
1637 * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1638 * _wait_target_ready() or _reset()
1641 ret = (c == MAX_MODULE_SOFTRESET_WAIT) ? -ETIMEDOUT : 0;
1644 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1645 _disable_optional_clocks(oh);
1651 * _reset - reset an omap_hwmod
1652 * @oh: struct omap_hwmod *
1654 * Resets an omap_hwmod @oh. If the module has a custom reset
1655 * function pointer defined, then call it to reset the IP block, and
1656 * pass along its return value to the caller. Otherwise, if the IP
1657 * block has an OCP_SYSCONFIG register with a SOFTRESET bitfield
1658 * associated with it, call a function to reset the IP block via that
1659 * method, and pass along the return value to the caller. Finally, if
1660 * the IP block has some hardreset lines associated with it, assert
1661 * all of those, but do _not_ deassert them. (This is because driver
1662 * authors have expressed an apparent requirement to control the
1663 * deassertion of the hardreset lines themselves.)
1665 * The default software reset mechanism for most OMAP IP blocks is
1666 * triggered via the OCP_SYSCONFIG.SOFTRESET bit. However, some
1667 * hwmods cannot be reset via this method. Some are not targets and
1668 * therefore have no OCP header registers to access. Others (like the
1669 * IVA) have idiosyncratic reset sequences. So for these relatively
1670 * rare cases, custom reset code can be supplied in the struct
1671 * omap_hwmod_class .reset function pointer. Passes along the return
1672 * value from either _ocp_softreset() or the custom reset function -
1673 * these must return -EINVAL if the hwmod cannot be reset this way or
1674 * if the hwmod is in the wrong state, -ETIMEDOUT if the module did
1675 * not reset in time, or 0 upon success.
1677 static int _reset(struct omap_hwmod *oh)
1681 pr_debug("omap_hwmod: %s: resetting\n", oh->name);
1683 if (oh->class->reset) {
1684 r = oh->class->reset(oh);
1686 if (oh->rst_lines_cnt > 0) {
1687 for (i = 0; i < oh->rst_lines_cnt; i++)
1688 _assert_hardreset(oh, oh->rst_lines[i].name);
1691 r = _ocp_softreset(oh);
1698 * OCP_SYSCONFIG bits need to be reprogrammed after a
1699 * softreset. The _enable() function should be split to avoid
1700 * the rewrite of the OCP_SYSCONFIG register.
1702 if (oh->class->sysc) {
1703 _update_sysc_cache(oh);
1711 * _enable - enable an omap_hwmod
1712 * @oh: struct omap_hwmod *
1714 * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
1715 * register target. Returns -EINVAL if the hwmod is in the wrong
1716 * state or passes along the return value of _wait_target_ready().
1718 static int _enable(struct omap_hwmod *oh)
1723 pr_debug("omap_hwmod: %s: enabling\n", oh->name);
1726 * hwmods with HWMOD_INIT_NO_IDLE flag set are left in enabled
1727 * state at init. Now that someone is really trying to enable
1728 * them, just ensure that the hwmod mux is set.
1730 if (oh->_int_flags & _HWMOD_SKIP_ENABLE) {
1732 * If the caller has mux data populated, do the mux'ing
1733 * which wouldn't have been done as part of the _enable()
1734 * done during setup.
1737 omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
1739 oh->_int_flags &= ~_HWMOD_SKIP_ENABLE;
1743 if (oh->_state != _HWMOD_STATE_INITIALIZED &&
1744 oh->_state != _HWMOD_STATE_IDLE &&
1745 oh->_state != _HWMOD_STATE_DISABLED) {
1746 WARN(1, "omap_hwmod: %s: enabled state can only be entered from initialized, idle, or disabled state\n",
1752 * If an IP block contains HW reset lines and any of them are
1753 * asserted, we let integration code associated with that
1754 * block handle the enable. We've received very little
1755 * information on what those driver authors need, and until
1756 * detailed information is provided and the driver code is
1757 * posted to the public lists, this is probably the best we
1760 if (_are_any_hardreset_lines_asserted(oh))
1763 /* Mux pins for device runtime if populated */
1764 if (oh->mux && (!oh->mux->enabled ||
1765 ((oh->_state == _HWMOD_STATE_IDLE) &&
1766 oh->mux->pads_dynamic)))
1767 omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
1769 _add_initiator_dep(oh, mpu_oh);
1773 * A clockdomain must be in SW_SUP before enabling
1774 * completely the module. The clockdomain can be set
1775 * in HW_AUTO only when the module become ready.
1777 hwsup = clkdm_in_hwsup(oh->clkdm);
1778 r = clkdm_hwmod_enable(oh->clkdm, oh);
1780 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1781 oh->name, oh->clkdm->name, r);
1787 if (soc_ops.enable_module)
1788 soc_ops.enable_module(oh);
1790 r = (soc_ops.wait_target_ready) ? soc_ops.wait_target_ready(oh) :
1794 * Set the clockdomain to HW_AUTO only if the target is ready,
1795 * assuming that the previous state was HW_AUTO
1797 if (oh->clkdm && hwsup)
1798 clkdm_allow_idle(oh->clkdm);
1800 oh->_state = _HWMOD_STATE_ENABLED;
1802 /* Access the sysconfig only if the target is ready */
1803 if (oh->class->sysc) {
1804 if (!(oh->_int_flags & _HWMOD_SYSCONFIG_LOADED))
1805 _update_sysc_cache(oh);
1809 _disable_clocks(oh);
1810 pr_debug("omap_hwmod: %s: _wait_target_ready: %d\n",
1814 clkdm_hwmod_disable(oh->clkdm, oh);
1821 * _idle - idle an omap_hwmod
1822 * @oh: struct omap_hwmod *
1824 * Idles an omap_hwmod @oh. This should be called once the hwmod has
1825 * no further work. Returns -EINVAL if the hwmod is in the wrong
1826 * state or returns 0.
1828 static int _idle(struct omap_hwmod *oh)
1830 pr_debug("omap_hwmod: %s: idling\n", oh->name);
1832 if (oh->_state != _HWMOD_STATE_ENABLED) {
1833 WARN(1, "omap_hwmod: %s: idle state can only be entered from enabled state\n",
1838 if (_are_any_hardreset_lines_asserted(oh))
1841 if (oh->class->sysc)
1843 _del_initiator_dep(oh, mpu_oh);
1845 if (soc_ops.disable_module)
1846 soc_ops.disable_module(oh);
1849 * The module must be in idle mode before disabling any parents
1850 * clocks. Otherwise, the parent clock might be disabled before
1851 * the module transition is done, and thus will prevent the
1852 * transition to complete properly.
1854 _disable_clocks(oh);
1856 clkdm_hwmod_disable(oh->clkdm, oh);
1858 /* Mux pins for device idle if populated */
1859 if (oh->mux && oh->mux->pads_dynamic)
1860 omap_hwmod_mux(oh->mux, _HWMOD_STATE_IDLE);
1862 oh->_state = _HWMOD_STATE_IDLE;
1868 * omap_hwmod_set_ocp_autoidle - set the hwmod's OCP autoidle bit
1869 * @oh: struct omap_hwmod *
1870 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
1872 * Sets the IP block's OCP autoidle bit in hardware, and updates our
1873 * local copy. Intended to be used by drivers that require
1874 * direct manipulation of the AUTOIDLE bits.
1875 * Returns -EINVAL if @oh is null or is not in the ENABLED state, or passes
1876 * along the return value from _set_module_autoidle().
1878 * Any users of this function should be scrutinized carefully.
1880 int omap_hwmod_set_ocp_autoidle(struct omap_hwmod *oh, u8 autoidle)
1884 unsigned long flags;
1886 if (!oh || oh->_state != _HWMOD_STATE_ENABLED)
1889 spin_lock_irqsave(&oh->_lock, flags);
1891 v = oh->_sysc_cache;
1893 retval = _set_module_autoidle(oh, autoidle, &v);
1896 _write_sysconfig(v, oh);
1898 spin_unlock_irqrestore(&oh->_lock, flags);
1904 * _shutdown - shutdown an omap_hwmod
1905 * @oh: struct omap_hwmod *
1907 * Shut down an omap_hwmod @oh. This should be called when the driver
1908 * used for the hwmod is removed or unloaded or if the driver is not
1909 * used by the system. Returns -EINVAL if the hwmod is in the wrong
1910 * state or returns 0.
1912 static int _shutdown(struct omap_hwmod *oh)
1917 if (oh->_state != _HWMOD_STATE_IDLE &&
1918 oh->_state != _HWMOD_STATE_ENABLED) {
1919 WARN(1, "omap_hwmod: %s: disabled state can only be entered from idle, or enabled state\n",
1924 if (_are_any_hardreset_lines_asserted(oh))
1927 pr_debug("omap_hwmod: %s: disabling\n", oh->name);
1929 if (oh->class->pre_shutdown) {
1930 prev_state = oh->_state;
1931 if (oh->_state == _HWMOD_STATE_IDLE)
1933 ret = oh->class->pre_shutdown(oh);
1935 if (prev_state == _HWMOD_STATE_IDLE)
1941 if (oh->class->sysc) {
1942 if (oh->_state == _HWMOD_STATE_IDLE)
1947 /* clocks and deps are already disabled in idle */
1948 if (oh->_state == _HWMOD_STATE_ENABLED) {
1949 _del_initiator_dep(oh, mpu_oh);
1950 /* XXX what about the other system initiators here? dma, dsp */
1951 if (soc_ops.disable_module)
1952 soc_ops.disable_module(oh);
1953 _disable_clocks(oh);
1955 clkdm_hwmod_disable(oh->clkdm, oh);
1957 /* XXX Should this code also force-disable the optional clocks? */
1959 for (i = 0; i < oh->rst_lines_cnt; i++)
1960 _assert_hardreset(oh, oh->rst_lines[i].name);
1962 /* Mux pins to safe mode or use populated off mode values */
1964 omap_hwmod_mux(oh->mux, _HWMOD_STATE_DISABLED);
1966 oh->_state = _HWMOD_STATE_DISABLED;
1972 * _init_mpu_rt_base - populate the virtual address for a hwmod
1973 * @oh: struct omap_hwmod * to locate the virtual address
1975 * Cache the virtual address used by the MPU to access this IP block's
1976 * registers. This address is needed early so the OCP registers that
1977 * are part of the device's address space can be ioremapped properly.
1980 static void __init _init_mpu_rt_base(struct omap_hwmod *oh, void *data)
1982 struct omap_hwmod_addr_space *mem;
1983 void __iomem *va_start;
1988 _save_mpu_port_index(oh);
1990 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
1993 mem = _find_mpu_rt_addr_space(oh);
1995 pr_debug("omap_hwmod: %s: no MPU register target found\n",
2000 va_start = ioremap(mem->pa_start, mem->pa_end - mem->pa_start);
2002 pr_err("omap_hwmod: %s: Could not ioremap\n", oh->name);
2006 pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
2007 oh->name, va_start);
2009 oh->_mpu_rt_va = va_start;
2013 * _init - initialize internal data for the hwmod @oh
2014 * @oh: struct omap_hwmod *
2017 * Look up the clocks and the address space used by the MPU to access
2018 * registers belonging to the hwmod @oh. @oh must already be
2019 * registered at this point. This is the first of two phases for
2020 * hwmod initialization. Code called here does not touch any hardware
2021 * registers, it simply prepares internal data structures. Returns 0
2022 * upon success or if the hwmod isn't registered, or -EINVAL upon
2025 static int __init _init(struct omap_hwmod *oh, void *data)
2029 if (oh->_state != _HWMOD_STATE_REGISTERED)
2032 _init_mpu_rt_base(oh, NULL);
2034 r = _init_clocks(oh, NULL);
2035 if (IS_ERR_VALUE(r)) {
2036 WARN(1, "omap_hwmod: %s: couldn't init clocks\n", oh->name);
2040 oh->_state = _HWMOD_STATE_INITIALIZED;
2046 * _setup_iclk_autoidle - configure an IP block's interface clocks
2047 * @oh: struct omap_hwmod *
2049 * Set up the module's interface clocks. XXX This function is still mostly
2050 * a stub; implementing this properly requires iclk autoidle usecounting in
2051 * the clock code. No return value.
2053 static void __init _setup_iclk_autoidle(struct omap_hwmod *oh)
2055 struct omap_hwmod_ocp_if *os;
2056 struct list_head *p;
2058 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2061 p = oh->slave_ports.next;
2063 while (i < oh->slaves_cnt) {
2064 os = _fetch_next_ocp_if(&p, &i);
2068 if (os->flags & OCPIF_SWSUP_IDLE) {
2069 /* XXX omap_iclk_deny_idle(c); */
2071 /* XXX omap_iclk_allow_idle(c); */
2072 clk_enable(os->_clk);
2080 * _setup_reset - reset an IP block during the setup process
2081 * @oh: struct omap_hwmod *
2083 * Reset the IP block corresponding to the hwmod @oh during the setup
2084 * process. The IP block is first enabled so it can be successfully
2085 * reset. Returns 0 upon success or a negative error code upon
2088 static int __init _setup_reset(struct omap_hwmod *oh)
2092 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2095 if (oh->rst_lines_cnt == 0) {
2098 pr_warning("omap_hwmod: %s: cannot be enabled for reset (%d)\n",
2099 oh->name, oh->_state);
2104 if (!(oh->flags & HWMOD_INIT_NO_RESET))
2111 * _setup_postsetup - transition to the appropriate state after _setup
2112 * @oh: struct omap_hwmod *
2114 * Place an IP block represented by @oh into a "post-setup" state --
2115 * either IDLE, ENABLED, or DISABLED. ("post-setup" simply means that
2116 * this function is called at the end of _setup().) The postsetup
2117 * state for an IP block can be changed by calling
2118 * omap_hwmod_enter_postsetup_state() early in the boot process,
2119 * before one of the omap_hwmod_setup*() functions are called for the
2122 * The IP block stays in this state until a PM runtime-based driver is
2123 * loaded for that IP block. A post-setup state of IDLE is
2124 * appropriate for almost all IP blocks with runtime PM-enabled
2125 * drivers, since those drivers are able to enable the IP block. A
2126 * post-setup state of ENABLED is appropriate for kernels with PM
2127 * runtime disabled. The DISABLED state is appropriate for unusual IP
2128 * blocks such as the MPU WDTIMER on kernels without WDTIMER drivers
2129 * included, since the WDTIMER starts running on reset and will reset
2130 * the MPU if left active.
2132 * This post-setup mechanism is deprecated. Once all of the OMAP
2133 * drivers have been converted to use PM runtime, and all of the IP
2134 * block data and interconnect data is available to the hwmod code, it
2135 * should be possible to replace this mechanism with a "lazy reset"
2136 * arrangement. In a "lazy reset" setup, each IP block is enabled
2137 * when the driver first probes, then all remaining IP blocks without
2138 * drivers are either shut down or enabled after the drivers have
2139 * loaded. However, this cannot take place until the above
2140 * preconditions have been met, since otherwise the late reset code
2141 * has no way of knowing which IP blocks are in use by drivers, and
2142 * which ones are unused.
2146 static void __init _setup_postsetup(struct omap_hwmod *oh)
2150 if (oh->rst_lines_cnt > 0)
2153 postsetup_state = oh->_postsetup_state;
2154 if (postsetup_state == _HWMOD_STATE_UNKNOWN)
2155 postsetup_state = _HWMOD_STATE_ENABLED;
2158 * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
2159 * it should be set by the core code as a runtime flag during startup
2161 if ((oh->flags & HWMOD_INIT_NO_IDLE) &&
2162 (postsetup_state == _HWMOD_STATE_IDLE)) {
2163 oh->_int_flags |= _HWMOD_SKIP_ENABLE;
2164 postsetup_state = _HWMOD_STATE_ENABLED;
2167 if (postsetup_state == _HWMOD_STATE_IDLE)
2169 else if (postsetup_state == _HWMOD_STATE_DISABLED)
2171 else if (postsetup_state != _HWMOD_STATE_ENABLED)
2172 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
2173 oh->name, postsetup_state);
2179 * _setup - prepare IP block hardware for use
2180 * @oh: struct omap_hwmod *
2181 * @n: (unused, pass NULL)
2183 * Configure the IP block represented by @oh. This may include
2184 * enabling the IP block, resetting it, and placing it into a
2185 * post-setup state, depending on the type of IP block and applicable
2186 * flags. IP blocks are reset to prevent any previous configuration
2187 * by the bootloader or previous operating system from interfering
2188 * with power management or other parts of the system. The reset can
2189 * be avoided; see omap_hwmod_no_setup_reset(). This is the second of
2190 * two phases for hwmod initialization. Code called here generally
2191 * affects the IP block hardware, or system integration hardware
2192 * associated with the IP block. Returns 0.
2194 static int __init _setup(struct omap_hwmod *oh, void *data)
2196 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2199 _setup_iclk_autoidle(oh);
2201 if (!_setup_reset(oh))
2202 _setup_postsetup(oh);
2208 * _register - register a struct omap_hwmod
2209 * @oh: struct omap_hwmod *
2211 * Registers the omap_hwmod @oh. Returns -EEXIST if an omap_hwmod
2212 * already has been registered by the same name; -EINVAL if the
2213 * omap_hwmod is in the wrong state, if @oh is NULL, if the
2214 * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
2215 * name, or if the omap_hwmod's class is missing a name; or 0 upon
2218 * XXX The data should be copied into bootmem, so the original data
2219 * should be marked __initdata and freed after init. This would allow
2220 * unneeded omap_hwmods to be freed on multi-OMAP configurations. Note
2221 * that the copy process would be relatively complex due to the large number
2224 static int __init _register(struct omap_hwmod *oh)
2226 if (!oh || !oh->name || !oh->class || !oh->class->name ||
2227 (oh->_state != _HWMOD_STATE_UNKNOWN))
2230 pr_debug("omap_hwmod: %s: registering\n", oh->name);
2232 if (_lookup(oh->name))
2235 list_add_tail(&oh->node, &omap_hwmod_list);
2237 INIT_LIST_HEAD(&oh->master_ports);
2238 INIT_LIST_HEAD(&oh->slave_ports);
2239 spin_lock_init(&oh->_lock);
2241 oh->_state = _HWMOD_STATE_REGISTERED;
2244 * XXX Rather than doing a strcmp(), this should test a flag
2245 * set in the hwmod data, inserted by the autogenerator code.
2247 if (!strcmp(oh->name, MPU_INITIATOR_NAME))
2254 * _alloc_links - return allocated memory for hwmod links
2255 * @ml: pointer to a struct omap_hwmod_link * for the master link
2256 * @sl: pointer to a struct omap_hwmod_link * for the slave link
2258 * Return pointers to two struct omap_hwmod_link records, via the
2259 * addresses pointed to by @ml and @sl. Will first attempt to return
2260 * memory allocated as part of a large initial block, but if that has
2261 * been exhausted, will allocate memory itself. Since ideally this
2262 * second allocation path will never occur, the number of these
2263 * 'supplemental' allocations will be logged when debugging is
2264 * enabled. Returns 0.
2266 static int __init _alloc_links(struct omap_hwmod_link **ml,
2267 struct omap_hwmod_link **sl)
2271 if ((free_ls + LINKS_PER_OCP_IF) <= max_ls) {
2272 *ml = &linkspace[free_ls++];
2273 *sl = &linkspace[free_ls++];
2277 sz = sizeof(struct omap_hwmod_link) * LINKS_PER_OCP_IF;
2280 *ml = alloc_bootmem(sz);
2284 *sl = (void *)(*ml) + sizeof(struct omap_hwmod_link);
2287 pr_debug("omap_hwmod: supplemental link allocations needed: %d\n",
2288 ls_supp * LINKS_PER_OCP_IF);
2294 * _add_link - add an interconnect between two IP blocks
2295 * @oi: pointer to a struct omap_hwmod_ocp_if record
2297 * Add struct omap_hwmod_link records connecting the master IP block
2298 * specified in @oi->master to @oi, and connecting the slave IP block
2299 * specified in @oi->slave to @oi. This code is assumed to run before
2300 * preemption or SMP has been enabled, thus avoiding the need for
2301 * locking in this code. Changes to this assumption will require
2302 * additional locking. Returns 0.
2304 static int __init _add_link(struct omap_hwmod_ocp_if *oi)
2306 struct omap_hwmod_link *ml, *sl;
2308 pr_debug("omap_hwmod: %s -> %s: adding link\n", oi->master->name,
2311 _alloc_links(&ml, &sl);
2314 INIT_LIST_HEAD(&ml->node);
2315 list_add(&ml->node, &oi->master->master_ports);
2316 oi->master->masters_cnt++;
2319 INIT_LIST_HEAD(&sl->node);
2320 list_add(&sl->node, &oi->slave->slave_ports);
2321 oi->slave->slaves_cnt++;
2327 * _register_link - register a struct omap_hwmod_ocp_if
2328 * @oi: struct omap_hwmod_ocp_if *
2330 * Registers the omap_hwmod_ocp_if record @oi. Returns -EEXIST if it
2331 * has already been registered; -EINVAL if @oi is NULL or if the
2332 * record pointed to by @oi is missing required fields; or 0 upon
2335 * XXX The data should be copied into bootmem, so the original data
2336 * should be marked __initdata and freed after init. This would allow
2337 * unneeded omap_hwmods to be freed on multi-OMAP configurations.
2339 static int __init _register_link(struct omap_hwmod_ocp_if *oi)
2341 if (!oi || !oi->master || !oi->slave || !oi->user)
2344 if (oi->_int_flags & _OCPIF_INT_FLAGS_REGISTERED)
2347 pr_debug("omap_hwmod: registering link from %s to %s\n",
2348 oi->master->name, oi->slave->name);
2351 * Register the connected hwmods, if they haven't been
2352 * registered already
2354 if (oi->master->_state != _HWMOD_STATE_REGISTERED)
2355 _register(oi->master);
2357 if (oi->slave->_state != _HWMOD_STATE_REGISTERED)
2358 _register(oi->slave);
2362 oi->_int_flags |= _OCPIF_INT_FLAGS_REGISTERED;
2368 * _alloc_linkspace - allocate large block of hwmod links
2369 * @ois: pointer to an array of struct omap_hwmod_ocp_if records to count
2371 * Allocate a large block of struct omap_hwmod_link records. This
2372 * improves boot time significantly by avoiding the need to allocate
2373 * individual records one by one. If the number of records to
2374 * allocate in the block hasn't been manually specified, this function
2375 * will count the number of struct omap_hwmod_ocp_if records in @ois
2376 * and use that to determine the allocation size. For SoC families
2377 * that require multiple list registrations, such as OMAP3xxx, this
2378 * estimation process isn't optimal, so manual estimation is advised
2379 * in those cases. Returns -EEXIST if the allocation has already occurred
2380 * or 0 upon success.
2382 static int __init _alloc_linkspace(struct omap_hwmod_ocp_if **ois)
2388 WARN(1, "linkspace already allocated\n");
2394 max_ls += LINKS_PER_OCP_IF;
2396 sz = sizeof(struct omap_hwmod_link) * max_ls;
2398 pr_debug("omap_hwmod: %s: allocating %d byte linkspace (%d links)\n",
2399 __func__, sz, max_ls);
2401 linkspace = alloc_bootmem(sz);
2403 memset(linkspace, 0, sz);
2408 /* Static functions intended only for use in soc_ops field function pointers */
2411 * _omap2_wait_target_ready - wait for a module to leave slave idle
2412 * @oh: struct omap_hwmod *
2414 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2415 * does not have an IDLEST bit or if the module successfully leaves
2416 * slave idle; otherwise, pass along the return value of the
2417 * appropriate *_cm*_wait_module_ready() function.
2419 static int _omap2_wait_target_ready(struct omap_hwmod *oh)
2424 if (oh->flags & HWMOD_NO_IDLEST)
2427 if (!_find_mpu_rt_port(oh))
2430 /* XXX check module SIDLEMODE, hardreset status, enabled clocks */
2432 return omap2_cm_wait_module_ready(oh->prcm.omap2.module_offs,
2433 oh->prcm.omap2.idlest_reg_id,
2434 oh->prcm.omap2.idlest_idle_bit);
2438 * _omap4_wait_target_ready - wait for a module to leave slave idle
2439 * @oh: struct omap_hwmod *
2441 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2442 * does not have an IDLEST bit or if the module successfully leaves
2443 * slave idle; otherwise, pass along the return value of the
2444 * appropriate *_cm*_wait_module_ready() function.
2446 static int _omap4_wait_target_ready(struct omap_hwmod *oh)
2448 if (!oh || !oh->clkdm)
2451 if (oh->flags & HWMOD_NO_IDLEST)
2454 if (!_find_mpu_rt_port(oh))
2457 /* XXX check module SIDLEMODE, hardreset status */
2459 return omap4_cminst_wait_module_ready(oh->clkdm->prcm_partition,
2461 oh->clkdm->clkdm_offs,
2462 oh->prcm.omap4.clkctrl_offs);
2466 * _omap2_assert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2467 * @oh: struct omap_hwmod * to assert hardreset
2468 * @ohri: hardreset line data
2470 * Call omap2_prm_assert_hardreset() with parameters extracted from
2471 * the hwmod @oh and the hardreset line data @ohri. Only intended for
2472 * use as an soc_ops function pointer. Passes along the return value
2473 * from omap2_prm_assert_hardreset(). XXX This function is scheduled
2474 * for removal when the PRM code is moved into drivers/.
2476 static int _omap2_assert_hardreset(struct omap_hwmod *oh,
2477 struct omap_hwmod_rst_info *ohri)
2479 return omap2_prm_assert_hardreset(oh->prcm.omap2.module_offs,
2484 * _omap2_deassert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2485 * @oh: struct omap_hwmod * to deassert hardreset
2486 * @ohri: hardreset line data
2488 * Call omap2_prm_deassert_hardreset() with parameters extracted from
2489 * the hwmod @oh and the hardreset line data @ohri. Only intended for
2490 * use as an soc_ops function pointer. Passes along the return value
2491 * from omap2_prm_deassert_hardreset(). XXX This function is
2492 * scheduled for removal when the PRM code is moved into drivers/.
2494 static int _omap2_deassert_hardreset(struct omap_hwmod *oh,
2495 struct omap_hwmod_rst_info *ohri)
2497 return omap2_prm_deassert_hardreset(oh->prcm.omap2.module_offs,
2503 * _omap2_is_hardreset_asserted - call OMAP2 PRM hardreset fn with hwmod args
2504 * @oh: struct omap_hwmod * to test hardreset
2505 * @ohri: hardreset line data
2507 * Call omap2_prm_is_hardreset_asserted() with parameters extracted
2508 * from the hwmod @oh and the hardreset line data @ohri. Only
2509 * intended for use as an soc_ops function pointer. Passes along the
2510 * return value from omap2_prm_is_hardreset_asserted(). XXX This
2511 * function is scheduled for removal when the PRM code is moved into
2514 static int _omap2_is_hardreset_asserted(struct omap_hwmod *oh,
2515 struct omap_hwmod_rst_info *ohri)
2517 return omap2_prm_is_hardreset_asserted(oh->prcm.omap2.module_offs,
2522 * _omap4_assert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
2523 * @oh: struct omap_hwmod * to assert hardreset
2524 * @ohri: hardreset line data
2526 * Call omap4_prminst_assert_hardreset() with parameters extracted
2527 * from the hwmod @oh and the hardreset line data @ohri. Only
2528 * intended for use as an soc_ops function pointer. Passes along the
2529 * return value from omap4_prminst_assert_hardreset(). XXX This
2530 * function is scheduled for removal when the PRM code is moved into
2533 static int _omap4_assert_hardreset(struct omap_hwmod *oh,
2534 struct omap_hwmod_rst_info *ohri)
2539 return omap4_prminst_assert_hardreset(ohri->rst_shift,
2540 oh->clkdm->pwrdm.ptr->prcm_partition,
2541 oh->clkdm->pwrdm.ptr->prcm_offs,
2542 oh->prcm.omap4.rstctrl_offs);
2546 * _omap4_deassert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
2547 * @oh: struct omap_hwmod * to deassert hardreset
2548 * @ohri: hardreset line data
2550 * Call omap4_prminst_deassert_hardreset() with parameters extracted
2551 * from the hwmod @oh and the hardreset line data @ohri. Only
2552 * intended for use as an soc_ops function pointer. Passes along the
2553 * return value from omap4_prminst_deassert_hardreset(). XXX This
2554 * function is scheduled for removal when the PRM code is moved into
2557 static int _omap4_deassert_hardreset(struct omap_hwmod *oh,
2558 struct omap_hwmod_rst_info *ohri)
2564 pr_err("omap_hwmod: %s: %s: hwmod data error: OMAP4 does not support st_shift\n",
2565 oh->name, ohri->name);
2566 return omap4_prminst_deassert_hardreset(ohri->rst_shift,
2567 oh->clkdm->pwrdm.ptr->prcm_partition,
2568 oh->clkdm->pwrdm.ptr->prcm_offs,
2569 oh->prcm.omap4.rstctrl_offs);
2573 * _omap4_is_hardreset_asserted - call OMAP4 PRM hardreset fn with hwmod args
2574 * @oh: struct omap_hwmod * to test hardreset
2575 * @ohri: hardreset line data
2577 * Call omap4_prminst_is_hardreset_asserted() with parameters
2578 * extracted from the hwmod @oh and the hardreset line data @ohri.
2579 * Only intended for use as an soc_ops function pointer. Passes along
2580 * the return value from omap4_prminst_is_hardreset_asserted(). XXX
2581 * This function is scheduled for removal when the PRM code is moved
2584 static int _omap4_is_hardreset_asserted(struct omap_hwmod *oh,
2585 struct omap_hwmod_rst_info *ohri)
2590 return omap4_prminst_is_hardreset_asserted(ohri->rst_shift,
2591 oh->clkdm->pwrdm.ptr->prcm_partition,
2592 oh->clkdm->pwrdm.ptr->prcm_offs,
2593 oh->prcm.omap4.rstctrl_offs);
2596 /* Public functions */
2598 u32 omap_hwmod_read(struct omap_hwmod *oh, u16 reg_offs)
2600 if (oh->flags & HWMOD_16BIT_REG)
2601 return __raw_readw(oh->_mpu_rt_va + reg_offs);
2603 return __raw_readl(oh->_mpu_rt_va + reg_offs);
2606 void omap_hwmod_write(u32 v, struct omap_hwmod *oh, u16 reg_offs)
2608 if (oh->flags & HWMOD_16BIT_REG)
2609 __raw_writew(v, oh->_mpu_rt_va + reg_offs);
2611 __raw_writel(v, oh->_mpu_rt_va + reg_offs);
2615 * omap_hwmod_softreset - reset a module via SYSCONFIG.SOFTRESET bit
2616 * @oh: struct omap_hwmod *
2618 * This is a public function exposed to drivers. Some drivers may need to do
2619 * some settings before and after resetting the device. Those drivers after
2620 * doing the necessary settings could use this function to start a reset by
2621 * setting the SYSCONFIG.SOFTRESET bit.
2623 int omap_hwmod_softreset(struct omap_hwmod *oh)
2628 if (!oh || !(oh->_sysc_cache))
2631 v = oh->_sysc_cache;
2632 ret = _set_softreset(oh, &v);
2635 _write_sysconfig(v, oh);
2642 * omap_hwmod_set_slave_idlemode - set the hwmod's OCP slave idlemode
2643 * @oh: struct omap_hwmod *
2644 * @idlemode: SIDLEMODE field bits (shifted to bit 0)
2646 * Sets the IP block's OCP slave idlemode in hardware, and updates our
2647 * local copy. Intended to be used by drivers that have some erratum
2648 * that requires direct manipulation of the SIDLEMODE bits. Returns
2649 * -EINVAL if @oh is null, or passes along the return value from
2650 * _set_slave_idlemode().
2652 * XXX Does this function have any current users? If not, we should
2653 * remove it; it is better to let the rest of the hwmod code handle this.
2654 * Any users of this function should be scrutinized carefully.
2656 int omap_hwmod_set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode)
2664 v = oh->_sysc_cache;
2666 retval = _set_slave_idlemode(oh, idlemode, &v);
2668 _write_sysconfig(v, oh);
2674 * omap_hwmod_lookup - look up a registered omap_hwmod by name
2675 * @name: name of the omap_hwmod to look up
2677 * Given a @name of an omap_hwmod, return a pointer to the registered
2678 * struct omap_hwmod *, or NULL upon error.
2680 struct omap_hwmod *omap_hwmod_lookup(const char *name)
2682 struct omap_hwmod *oh;
2693 * omap_hwmod_for_each - call function for each registered omap_hwmod
2694 * @fn: pointer to a callback function
2695 * @data: void * data to pass to callback function
2697 * Call @fn for each registered omap_hwmod, passing @data to each
2698 * function. @fn must return 0 for success or any other value for
2699 * failure. If @fn returns non-zero, the iteration across omap_hwmods
2700 * will stop and the non-zero return value will be passed to the
2701 * caller of omap_hwmod_for_each(). @fn is called with
2702 * omap_hwmod_for_each() held.
2704 int omap_hwmod_for_each(int (*fn)(struct omap_hwmod *oh, void *data),
2707 struct omap_hwmod *temp_oh;
2713 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
2714 ret = (*fn)(temp_oh, data);
2723 * omap_hwmod_register_links - register an array of hwmod links
2724 * @ois: pointer to an array of omap_hwmod_ocp_if to register
2726 * Intended to be called early in boot before the clock framework is
2727 * initialized. If @ois is not null, will register all omap_hwmods
2728 * listed in @ois that are valid for this chip. Returns -EINVAL if
2729 * omap_hwmod_init() hasn't been called before calling this function,
2730 * -ENOMEM if the link memory area can't be allocated, or 0 upon
2733 int __init omap_hwmod_register_links(struct omap_hwmod_ocp_if **ois)
2744 if (_alloc_linkspace(ois)) {
2745 pr_err("omap_hwmod: could not allocate link space\n");
2752 r = _register_link(ois[i]);
2753 WARN(r && r != -EEXIST,
2754 "omap_hwmod: _register_link(%s -> %s) returned %d\n",
2755 ois[i]->master->name, ois[i]->slave->name, r);
2762 * _ensure_mpu_hwmod_is_setup - ensure the MPU SS hwmod is init'ed and set up
2763 * @oh: pointer to the hwmod currently being set up (usually not the MPU)
2765 * If the hwmod data corresponding to the MPU subsystem IP block
2766 * hasn't been initialized and set up yet, do so now. This must be
2767 * done first since sleep dependencies may be added from other hwmods
2768 * to the MPU. Intended to be called only by omap_hwmod_setup*(). No
2771 static void __init _ensure_mpu_hwmod_is_setup(struct omap_hwmod *oh)
2773 if (!mpu_oh || mpu_oh->_state == _HWMOD_STATE_UNKNOWN)
2774 pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",
2775 __func__, MPU_INITIATOR_NAME);
2776 else if (mpu_oh->_state == _HWMOD_STATE_REGISTERED && oh != mpu_oh)
2777 omap_hwmod_setup_one(MPU_INITIATOR_NAME);
2781 * omap_hwmod_setup_one - set up a single hwmod
2782 * @oh_name: const char * name of the already-registered hwmod to set up
2784 * Initialize and set up a single hwmod. Intended to be used for a
2785 * small number of early devices, such as the timer IP blocks used for
2786 * the scheduler clock. Must be called after omap2_clk_init().
2787 * Resolves the struct clk names to struct clk pointers for each
2788 * registered omap_hwmod. Also calls _setup() on each hwmod. Returns
2789 * -EINVAL upon error or 0 upon success.
2791 int __init omap_hwmod_setup_one(const char *oh_name)
2793 struct omap_hwmod *oh;
2795 pr_debug("omap_hwmod: %s: %s\n", oh_name, __func__);
2797 oh = _lookup(oh_name);
2799 WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name);
2803 _ensure_mpu_hwmod_is_setup(oh);
2812 * omap_hwmod_setup_all - set up all registered IP blocks
2814 * Initialize and set up all IP blocks registered with the hwmod code.
2815 * Must be called after omap2_clk_init(). Resolves the struct clk
2816 * names to struct clk pointers for each registered omap_hwmod. Also
2817 * calls _setup() on each hwmod. Returns 0 upon success.
2819 static int __init omap_hwmod_setup_all(void)
2821 _ensure_mpu_hwmod_is_setup(NULL);
2823 omap_hwmod_for_each(_init, NULL);
2824 omap_hwmod_for_each(_setup, NULL);
2828 core_initcall(omap_hwmod_setup_all);
2831 * omap_hwmod_enable - enable an omap_hwmod
2832 * @oh: struct omap_hwmod *
2834 * Enable an omap_hwmod @oh. Intended to be called by omap_device_enable().
2835 * Returns -EINVAL on error or passes along the return value from _enable().
2837 int omap_hwmod_enable(struct omap_hwmod *oh)
2840 unsigned long flags;
2845 spin_lock_irqsave(&oh->_lock, flags);
2847 spin_unlock_irqrestore(&oh->_lock, flags);
2853 * omap_hwmod_idle - idle an omap_hwmod
2854 * @oh: struct omap_hwmod *
2856 * Idle an omap_hwmod @oh. Intended to be called by omap_device_idle().
2857 * Returns -EINVAL on error or passes along the return value from _idle().
2859 int omap_hwmod_idle(struct omap_hwmod *oh)
2861 unsigned long flags;
2866 spin_lock_irqsave(&oh->_lock, flags);
2868 spin_unlock_irqrestore(&oh->_lock, flags);
2874 * omap_hwmod_shutdown - shutdown an omap_hwmod
2875 * @oh: struct omap_hwmod *
2877 * Shutdown an omap_hwmod @oh. Intended to be called by
2878 * omap_device_shutdown(). Returns -EINVAL on error or passes along
2879 * the return value from _shutdown().
2881 int omap_hwmod_shutdown(struct omap_hwmod *oh)
2883 unsigned long flags;
2888 spin_lock_irqsave(&oh->_lock, flags);
2890 spin_unlock_irqrestore(&oh->_lock, flags);
2896 * omap_hwmod_enable_clocks - enable main_clk, all interface clocks
2897 * @oh: struct omap_hwmod *oh
2899 * Intended to be called by the omap_device code.
2901 int omap_hwmod_enable_clocks(struct omap_hwmod *oh)
2903 unsigned long flags;
2905 spin_lock_irqsave(&oh->_lock, flags);
2907 spin_unlock_irqrestore(&oh->_lock, flags);
2913 * omap_hwmod_disable_clocks - disable main_clk, all interface clocks
2914 * @oh: struct omap_hwmod *oh
2916 * Intended to be called by the omap_device code.
2918 int omap_hwmod_disable_clocks(struct omap_hwmod *oh)
2920 unsigned long flags;
2922 spin_lock_irqsave(&oh->_lock, flags);
2923 _disable_clocks(oh);
2924 spin_unlock_irqrestore(&oh->_lock, flags);
2930 * omap_hwmod_ocp_barrier - wait for posted writes against the hwmod to complete
2931 * @oh: struct omap_hwmod *oh
2933 * Intended to be called by drivers and core code when all posted
2934 * writes to a device must complete before continuing further
2935 * execution (for example, after clearing some device IRQSTATUS
2938 * XXX what about targets with multiple OCP threads?
2940 void omap_hwmod_ocp_barrier(struct omap_hwmod *oh)
2944 if (!oh->class->sysc || !oh->class->sysc->sysc_flags) {
2945 WARN(1, "omap_device: %s: OCP barrier impossible due to device configuration\n",
2951 * Forces posted writes to complete on the OCP thread handling
2954 omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
2958 * omap_hwmod_reset - reset the hwmod
2959 * @oh: struct omap_hwmod *
2961 * Under some conditions, a driver may wish to reset the entire device.
2962 * Called from omap_device code. Returns -EINVAL on error or passes along
2963 * the return value from _reset().
2965 int omap_hwmod_reset(struct omap_hwmod *oh)
2968 unsigned long flags;
2973 spin_lock_irqsave(&oh->_lock, flags);
2975 spin_unlock_irqrestore(&oh->_lock, flags);
2981 * IP block data retrieval functions
2985 * omap_hwmod_count_resources - count number of struct resources needed by hwmod
2986 * @oh: struct omap_hwmod *
2987 * @res: pointer to the first element of an array of struct resource to fill
2989 * Count the number of struct resource array elements necessary to
2990 * contain omap_hwmod @oh resources. Intended to be called by code
2991 * that registers omap_devices. Intended to be used to determine the
2992 * size of a dynamically-allocated struct resource array, before
2993 * calling omap_hwmod_fill_resources(). Returns the number of struct
2994 * resource array elements needed.
2996 * XXX This code is not optimized. It could attempt to merge adjacent
3000 int omap_hwmod_count_resources(struct omap_hwmod *oh)
3002 struct omap_hwmod_ocp_if *os;
3003 struct list_head *p;
3007 ret = _count_mpu_irqs(oh) + _count_sdma_reqs(oh);
3009 p = oh->slave_ports.next;
3011 while (i < oh->slaves_cnt) {
3012 os = _fetch_next_ocp_if(&p, &i);
3013 ret += _count_ocp_if_addr_spaces(os);
3020 * omap_hwmod_fill_resources - fill struct resource array with hwmod data
3021 * @oh: struct omap_hwmod *
3022 * @res: pointer to the first element of an array of struct resource to fill
3024 * Fill the struct resource array @res with resource data from the
3025 * omap_hwmod @oh. Intended to be called by code that registers
3026 * omap_devices. See also omap_hwmod_count_resources(). Returns the
3027 * number of array elements filled.
3029 int omap_hwmod_fill_resources(struct omap_hwmod *oh, struct resource *res)
3031 struct omap_hwmod_ocp_if *os;
3032 struct list_head *p;
3033 int i, j, mpu_irqs_cnt, sdma_reqs_cnt, addr_cnt;
3036 /* For each IRQ, DMA, memory area, fill in array.*/
3038 mpu_irqs_cnt = _count_mpu_irqs(oh);
3039 for (i = 0; i < mpu_irqs_cnt; i++) {
3040 (res + r)->name = (oh->mpu_irqs + i)->name;
3041 (res + r)->start = (oh->mpu_irqs + i)->irq;
3042 (res + r)->end = (oh->mpu_irqs + i)->irq;
3043 (res + r)->flags = IORESOURCE_IRQ;
3047 sdma_reqs_cnt = _count_sdma_reqs(oh);
3048 for (i = 0; i < sdma_reqs_cnt; i++) {
3049 (res + r)->name = (oh->sdma_reqs + i)->name;
3050 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
3051 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
3052 (res + r)->flags = IORESOURCE_DMA;
3056 p = oh->slave_ports.next;
3059 while (i < oh->slaves_cnt) {
3060 os = _fetch_next_ocp_if(&p, &i);
3061 addr_cnt = _count_ocp_if_addr_spaces(os);
3063 for (j = 0; j < addr_cnt; j++) {
3064 (res + r)->name = (os->addr + j)->name;
3065 (res + r)->start = (os->addr + j)->pa_start;
3066 (res + r)->end = (os->addr + j)->pa_end;
3067 (res + r)->flags = IORESOURCE_MEM;
3076 * omap_hwmod_get_resource_byname - fetch IP block integration data by name
3077 * @oh: struct omap_hwmod * to operate on
3078 * @type: one of the IORESOURCE_* constants from include/linux/ioport.h
3079 * @name: pointer to the name of the data to fetch (optional)
3080 * @rsrc: pointer to a struct resource, allocated by the caller
3082 * Retrieve MPU IRQ, SDMA request line, or address space start/end
3083 * data for the IP block pointed to by @oh. The data will be filled
3084 * into a struct resource record pointed to by @rsrc. The struct
3085 * resource must be allocated by the caller. When @name is non-null,
3086 * the data associated with the matching entry in the IRQ/SDMA/address
3087 * space hwmod data arrays will be returned. If @name is null, the
3088 * first array entry will be returned. Data order is not meaningful
3089 * in hwmod data, so callers are strongly encouraged to use a non-null
3090 * @name whenever possible to avoid unpredictable effects if hwmod
3091 * data is later added that causes data ordering to change. This
3092 * function is only intended for use by OMAP core code. Device
3093 * drivers should not call this function - the appropriate bus-related
3094 * data accessor functions should be used instead. Returns 0 upon
3095 * success or a negative error code upon error.
3097 int omap_hwmod_get_resource_byname(struct omap_hwmod *oh, unsigned int type,
3098 const char *name, struct resource *rsrc)
3101 unsigned int irq, dma;
3102 u32 pa_start, pa_end;
3107 if (type == IORESOURCE_IRQ) {
3108 r = _get_mpu_irq_by_name(oh, name, &irq);
3114 } else if (type == IORESOURCE_DMA) {
3115 r = _get_sdma_req_by_name(oh, name, &dma);
3121 } else if (type == IORESOURCE_MEM) {
3122 r = _get_addr_space_by_name(oh, name, &pa_start, &pa_end);
3126 rsrc->start = pa_start;
3139 * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
3140 * @oh: struct omap_hwmod *
3142 * Return the powerdomain pointer associated with the OMAP module
3143 * @oh's main clock. If @oh does not have a main clk, return the
3144 * powerdomain associated with the interface clock associated with the
3145 * module's MPU port. (XXX Perhaps this should use the SDMA port
3146 * instead?) Returns NULL on error, or a struct powerdomain * on
3149 struct powerdomain *omap_hwmod_get_pwrdm(struct omap_hwmod *oh)
3152 struct omap_hwmod_ocp_if *oi;
3160 oi = _find_mpu_rt_port(oh);
3169 return c->clkdm->pwrdm.ptr;
3174 * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
3175 * @oh: struct omap_hwmod *
3177 * Returns the virtual address corresponding to the beginning of the
3178 * module's register target, in the address range that is intended to
3179 * be used by the MPU. Returns the virtual address upon success or NULL
3182 void __iomem *omap_hwmod_get_mpu_rt_va(struct omap_hwmod *oh)
3187 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
3190 if (oh->_state == _HWMOD_STATE_UNKNOWN)
3193 return oh->_mpu_rt_va;
3197 * omap_hwmod_add_initiator_dep - add sleepdep from @init_oh to @oh
3198 * @oh: struct omap_hwmod *
3199 * @init_oh: struct omap_hwmod * (initiator)
3201 * Add a sleep dependency between the initiator @init_oh and @oh.
3202 * Intended to be called by DSP/Bridge code via platform_data for the
3203 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
3204 * code needs to add/del initiator dependencies dynamically
3205 * before/after accessing a device. Returns the return value from
3206 * _add_initiator_dep().
3208 * XXX Keep a usecount in the clockdomain code
3210 int omap_hwmod_add_initiator_dep(struct omap_hwmod *oh,
3211 struct omap_hwmod *init_oh)
3213 return _add_initiator_dep(oh, init_oh);
3217 * XXX what about functions for drivers to save/restore ocp_sysconfig
3218 * for context save/restore operations?
3222 * omap_hwmod_del_initiator_dep - remove sleepdep from @init_oh to @oh
3223 * @oh: struct omap_hwmod *
3224 * @init_oh: struct omap_hwmod * (initiator)
3226 * Remove a sleep dependency between the initiator @init_oh and @oh.
3227 * Intended to be called by DSP/Bridge code via platform_data for the
3228 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
3229 * code needs to add/del initiator dependencies dynamically
3230 * before/after accessing a device. Returns the return value from
3231 * _del_initiator_dep().
3233 * XXX Keep a usecount in the clockdomain code
3235 int omap_hwmod_del_initiator_dep(struct omap_hwmod *oh,
3236 struct omap_hwmod *init_oh)
3238 return _del_initiator_dep(oh, init_oh);
3242 * omap_hwmod_enable_wakeup - allow device to wake up the system
3243 * @oh: struct omap_hwmod *
3245 * Sets the module OCP socket ENAWAKEUP bit to allow the module to
3246 * send wakeups to the PRCM, and enable I/O ring wakeup events for
3247 * this IP block if it has dynamic mux entries. Eventually this
3248 * should set PRCM wakeup registers to cause the PRCM to receive
3249 * wakeup events from the module. Does not set any wakeup routing
3250 * registers beyond this point - if the module is to wake up any other
3251 * module or subsystem, that must be set separately. Called by
3252 * omap_device code. Returns -EINVAL on error or 0 upon success.
3254 int omap_hwmod_enable_wakeup(struct omap_hwmod *oh)
3256 unsigned long flags;
3259 spin_lock_irqsave(&oh->_lock, flags);
3261 if (oh->class->sysc &&
3262 (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)) {
3263 v = oh->_sysc_cache;
3264 _enable_wakeup(oh, &v);
3265 _write_sysconfig(v, oh);
3268 _set_idle_ioring_wakeup(oh, true);
3269 spin_unlock_irqrestore(&oh->_lock, flags);
3275 * omap_hwmod_disable_wakeup - prevent device from waking the system
3276 * @oh: struct omap_hwmod *
3278 * Clears the module OCP socket ENAWAKEUP bit to prevent the module
3279 * from sending wakeups to the PRCM, and disable I/O ring wakeup
3280 * events for this IP block if it has dynamic mux entries. Eventually
3281 * this should clear PRCM wakeup registers to cause the PRCM to ignore
3282 * wakeup events from the module. Does not set any wakeup routing
3283 * registers beyond this point - if the module is to wake up any other
3284 * module or subsystem, that must be set separately. Called by
3285 * omap_device code. Returns -EINVAL on error or 0 upon success.
3287 int omap_hwmod_disable_wakeup(struct omap_hwmod *oh)
3289 unsigned long flags;
3292 spin_lock_irqsave(&oh->_lock, flags);
3294 if (oh->class->sysc &&
3295 (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)) {
3296 v = oh->_sysc_cache;
3297 _disable_wakeup(oh, &v);
3298 _write_sysconfig(v, oh);
3301 _set_idle_ioring_wakeup(oh, false);
3302 spin_unlock_irqrestore(&oh->_lock, flags);
3308 * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
3309 * contained in the hwmod module.
3310 * @oh: struct omap_hwmod *
3311 * @name: name of the reset line to lookup and assert
3313 * Some IP like dsp, ipu or iva contain processor that require
3314 * an HW reset line to be assert / deassert in order to enable fully
3315 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3316 * yet supported on this OMAP; otherwise, passes along the return value
3317 * from _assert_hardreset().
3319 int omap_hwmod_assert_hardreset(struct omap_hwmod *oh, const char *name)
3322 unsigned long flags;
3327 spin_lock_irqsave(&oh->_lock, flags);
3328 ret = _assert_hardreset(oh, name);
3329 spin_unlock_irqrestore(&oh->_lock, flags);
3335 * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
3336 * contained in the hwmod module.
3337 * @oh: struct omap_hwmod *
3338 * @name: name of the reset line to look up and deassert
3340 * Some IP like dsp, ipu or iva contain processor that require
3341 * an HW reset line to be assert / deassert in order to enable fully
3342 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3343 * yet supported on this OMAP; otherwise, passes along the return value
3344 * from _deassert_hardreset().
3346 int omap_hwmod_deassert_hardreset(struct omap_hwmod *oh, const char *name)
3349 unsigned long flags;
3354 spin_lock_irqsave(&oh->_lock, flags);
3355 ret = _deassert_hardreset(oh, name);
3356 spin_unlock_irqrestore(&oh->_lock, flags);
3362 * omap_hwmod_read_hardreset - read the HW reset line state of submodules
3363 * contained in the hwmod module
3364 * @oh: struct omap_hwmod *
3365 * @name: name of the reset line to look up and read
3367 * Return the current state of the hwmod @oh's reset line named @name:
3368 * returns -EINVAL upon parameter error or if this operation
3369 * is unsupported on the current OMAP; otherwise, passes along the return
3370 * value from _read_hardreset().
3372 int omap_hwmod_read_hardreset(struct omap_hwmod *oh, const char *name)
3375 unsigned long flags;
3380 spin_lock_irqsave(&oh->_lock, flags);
3381 ret = _read_hardreset(oh, name);
3382 spin_unlock_irqrestore(&oh->_lock, flags);
3389 * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
3390 * @classname: struct omap_hwmod_class name to search for
3391 * @fn: callback function pointer to call for each hwmod in class @classname
3392 * @user: arbitrary context data to pass to the callback function
3394 * For each omap_hwmod of class @classname, call @fn.
3395 * If the callback function returns something other than
3396 * zero, the iterator is terminated, and the callback function's return
3397 * value is passed back to the caller. Returns 0 upon success, -EINVAL
3398 * if @classname or @fn are NULL, or passes back the error code from @fn.
3400 int omap_hwmod_for_each_by_class(const char *classname,
3401 int (*fn)(struct omap_hwmod *oh,
3405 struct omap_hwmod *temp_oh;
3408 if (!classname || !fn)
3411 pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
3412 __func__, classname);
3414 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
3415 if (!strcmp(temp_oh->class->name, classname)) {
3416 pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
3417 __func__, temp_oh->name);
3418 ret = (*fn)(temp_oh, user);
3425 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
3432 * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
3433 * @oh: struct omap_hwmod *
3434 * @state: state that _setup() should leave the hwmod in
3436 * Sets the hwmod state that @oh will enter at the end of _setup()
3437 * (called by omap_hwmod_setup_*()). See also the documentation
3438 * for _setup_postsetup(), above. Returns 0 upon success or
3439 * -EINVAL if there is a problem with the arguments or if the hwmod is
3440 * in the wrong state.
3442 int omap_hwmod_set_postsetup_state(struct omap_hwmod *oh, u8 state)
3445 unsigned long flags;
3450 if (state != _HWMOD_STATE_DISABLED &&
3451 state != _HWMOD_STATE_ENABLED &&
3452 state != _HWMOD_STATE_IDLE)
3455 spin_lock_irqsave(&oh->_lock, flags);
3457 if (oh->_state != _HWMOD_STATE_REGISTERED) {
3462 oh->_postsetup_state = state;
3466 spin_unlock_irqrestore(&oh->_lock, flags);
3472 * omap_hwmod_get_context_loss_count - get lost context count
3473 * @oh: struct omap_hwmod *
3475 * Query the powerdomain of of @oh to get the context loss
3476 * count for this device.
3478 * Returns the context loss count of the powerdomain assocated with @oh
3479 * upon success, or zero if no powerdomain exists for @oh.
3481 int omap_hwmod_get_context_loss_count(struct omap_hwmod *oh)
3483 struct powerdomain *pwrdm;
3486 pwrdm = omap_hwmod_get_pwrdm(oh);
3488 ret = pwrdm_get_context_loss_count(pwrdm);
3494 * omap_hwmod_no_setup_reset - prevent a hwmod from being reset upon setup
3495 * @oh: struct omap_hwmod *
3497 * Prevent the hwmod @oh from being reset during the setup process.
3498 * Intended for use by board-*.c files on boards with devices that
3499 * cannot tolerate being reset. Must be called before the hwmod has
3500 * been set up. Returns 0 upon success or negative error code upon
3503 int omap_hwmod_no_setup_reset(struct omap_hwmod *oh)
3508 if (oh->_state != _HWMOD_STATE_REGISTERED) {
3509 pr_err("omap_hwmod: %s: cannot prevent setup reset; in wrong state\n",
3514 oh->flags |= HWMOD_INIT_NO_RESET;
3520 * omap_hwmod_pad_route_irq - route an I/O pad wakeup to a particular MPU IRQ
3521 * @oh: struct omap_hwmod * containing hwmod mux entries
3522 * @pad_idx: array index in oh->mux of the hwmod mux entry to route wakeup
3523 * @irq_idx: the hwmod mpu_irqs array index of the IRQ to trigger on wakeup
3525 * When an I/O pad wakeup arrives for the dynamic or wakeup hwmod mux
3526 * entry number @pad_idx for the hwmod @oh, trigger the interrupt
3527 * service routine for the hwmod's mpu_irqs array index @irq_idx. If
3528 * this function is not called for a given pad_idx, then the ISR
3529 * associated with @oh's first MPU IRQ will be triggered when an I/O
3530 * pad wakeup occurs on that pad. Note that @pad_idx is the index of
3531 * the _dynamic or wakeup_ entry: if there are other entries not
3532 * marked with OMAP_DEVICE_PAD_WAKEUP or OMAP_DEVICE_PAD_REMUX, these
3533 * entries are NOT COUNTED in the dynamic pad index. This function
3534 * must be called separately for each pad that requires its interrupt
3535 * to be re-routed this way. Returns -EINVAL if there is an argument
3536 * problem or if @oh does not have hwmod mux entries or MPU IRQs;
3537 * returns -ENOMEM if memory cannot be allocated; or 0 upon success.
3539 * XXX This function interface is fragile. Rather than using array
3540 * indexes, which are subject to unpredictable change, it should be
3541 * using hwmod IRQ names, and some other stable key for the hwmod mux
3544 int omap_hwmod_pad_route_irq(struct omap_hwmod *oh, int pad_idx, int irq_idx)
3550 if (!oh || !oh->mux || !oh->mpu_irqs || pad_idx < 0 ||
3551 pad_idx >= oh->mux->nr_pads_dynamic)
3554 /* Check the number of available mpu_irqs */
3555 for (nr_irqs = 0; oh->mpu_irqs[nr_irqs].irq >= 0; nr_irqs++)
3558 if (irq_idx >= nr_irqs)
3561 if (!oh->mux->irqs) {
3562 /* XXX What frees this? */
3563 oh->mux->irqs = kzalloc(sizeof(int) * oh->mux->nr_pads_dynamic,
3568 oh->mux->irqs[pad_idx] = irq_idx;
3574 * omap_hwmod_init - initialize the hwmod code
3576 * Sets up some function pointers needed by the hwmod code to operate on the
3577 * currently-booted SoC. Intended to be called once during kernel init
3578 * before any hwmods are registered. No return value.
3580 void __init omap_hwmod_init(void)
3582 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
3583 soc_ops.wait_target_ready = _omap2_wait_target_ready;
3584 soc_ops.assert_hardreset = _omap2_assert_hardreset;
3585 soc_ops.deassert_hardreset = _omap2_deassert_hardreset;
3586 soc_ops.is_hardreset_asserted = _omap2_is_hardreset_asserted;
3587 } else if (cpu_is_omap44xx()) {
3588 soc_ops.enable_module = _omap4_enable_module;
3589 soc_ops.disable_module = _omap4_disable_module;
3590 soc_ops.wait_target_ready = _omap4_wait_target_ready;
3591 soc_ops.assert_hardreset = _omap4_assert_hardreset;
3592 soc_ops.deassert_hardreset = _omap4_deassert_hardreset;
3593 soc_ops.is_hardreset_asserted = _omap4_is_hardreset_asserted;
3594 soc_ops.init_clkdm = _init_clkdm;
3596 WARN(1, "omap_hwmod: unknown SoC type\n");