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-provider.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>
141 #include <linux/cpu.h>
142 #include <linux/of.h>
143 #include <linux/of_address.h>
145 #include <asm/system_misc.h>
148 #include "omap_hwmod.h"
152 #include "clockdomain.h"
153 #include "powerdomain.h"
156 #include "cminst44xx.h"
162 #include "prminst44xx.h"
166 /* Name of the OMAP hwmod for the MPU */
167 #define MPU_INITIATOR_NAME "mpu"
170 * Number of struct omap_hwmod_link records per struct
171 * omap_hwmod_ocp_if record (master->slave and slave->master)
173 #define LINKS_PER_OCP_IF 2
176 * struct omap_hwmod_soc_ops - fn ptrs for some SoC-specific operations
177 * @enable_module: function to enable a module (via MODULEMODE)
178 * @disable_module: function to disable a module (via MODULEMODE)
180 * XXX Eventually this functionality will be hidden inside the PRM/CM
181 * device drivers. Until then, this should avoid huge blocks of cpu_is_*()
182 * conditionals in this code.
184 struct omap_hwmod_soc_ops {
185 void (*enable_module)(struct omap_hwmod *oh);
186 int (*disable_module)(struct omap_hwmod *oh);
187 int (*wait_target_ready)(struct omap_hwmod *oh);
188 int (*assert_hardreset)(struct omap_hwmod *oh,
189 struct omap_hwmod_rst_info *ohri);
190 int (*deassert_hardreset)(struct omap_hwmod *oh,
191 struct omap_hwmod_rst_info *ohri);
192 int (*is_hardreset_asserted)(struct omap_hwmod *oh,
193 struct omap_hwmod_rst_info *ohri);
194 int (*init_clkdm)(struct omap_hwmod *oh);
195 void (*update_context_lost)(struct omap_hwmod *oh);
196 int (*get_context_lost)(struct omap_hwmod *oh);
199 /* soc_ops: adapts the omap_hwmod code to the currently-booted SoC */
200 static struct omap_hwmod_soc_ops soc_ops;
202 /* omap_hwmod_list contains all registered struct omap_hwmods */
203 static LIST_HEAD(omap_hwmod_list);
205 /* mpu_oh: used to add/remove MPU initiator from sleepdep list */
206 static struct omap_hwmod *mpu_oh;
208 /* io_chain_lock: used to serialize reconfigurations of the I/O chain */
209 static DEFINE_SPINLOCK(io_chain_lock);
212 * linkspace: ptr to a buffer that struct omap_hwmod_link records are
213 * allocated from - used to reduce the number of small memory
214 * allocations, which has a significant impact on performance
216 static struct omap_hwmod_link *linkspace;
219 * free_ls, max_ls: array indexes into linkspace; representing the
220 * next free struct omap_hwmod_link index, and the maximum number of
221 * struct omap_hwmod_link records allocated (respectively)
223 static unsigned short free_ls, max_ls, ls_supp;
225 /* inited: set to true once the hwmod code is initialized */
228 /* Private functions */
231 * _fetch_next_ocp_if - return the next OCP interface in a list
232 * @p: ptr to a ptr to the list_head inside the ocp_if to return
233 * @i: pointer to the index of the element pointed to by @p in the list
235 * Return a pointer to the struct omap_hwmod_ocp_if record
236 * containing the struct list_head pointed to by @p, and increment
237 * @p such that a future call to this routine will return the next
240 static struct omap_hwmod_ocp_if *_fetch_next_ocp_if(struct list_head **p,
243 struct omap_hwmod_ocp_if *oi;
245 oi = list_entry(*p, struct omap_hwmod_link, node)->ocp_if;
254 * _update_sysc_cache - return the module OCP_SYSCONFIG register, keep copy
255 * @oh: struct omap_hwmod *
257 * Load the current value of the hwmod OCP_SYSCONFIG register into the
258 * struct omap_hwmod for later use. Returns -EINVAL if the hwmod has no
259 * OCP_SYSCONFIG register or 0 upon success.
261 static int _update_sysc_cache(struct omap_hwmod *oh)
263 if (!oh->class->sysc) {
264 WARN(1, "omap_hwmod: %s: cannot read OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
268 /* XXX ensure module interface clock is up */
270 oh->_sysc_cache = omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
272 if (!(oh->class->sysc->sysc_flags & SYSC_NO_CACHE))
273 oh->_int_flags |= _HWMOD_SYSCONFIG_LOADED;
279 * _write_sysconfig - write a value to the module's OCP_SYSCONFIG register
280 * @v: OCP_SYSCONFIG value to write
281 * @oh: struct omap_hwmod *
283 * Write @v into the module class' OCP_SYSCONFIG register, if it has
284 * one. No return value.
286 static void _write_sysconfig(u32 v, struct omap_hwmod *oh)
288 if (!oh->class->sysc) {
289 WARN(1, "omap_hwmod: %s: cannot write OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
293 /* XXX ensure module interface clock is up */
295 /* Module might have lost context, always update cache and register */
297 omap_hwmod_write(v, oh, oh->class->sysc->sysc_offs);
301 * _set_master_standbymode: set the OCP_SYSCONFIG MIDLEMODE field in @v
302 * @oh: struct omap_hwmod *
303 * @standbymode: MIDLEMODE field bits
304 * @v: pointer to register contents to modify
306 * Update the master standby mode bits in @v to be @standbymode for
307 * the @oh hwmod. Does not write to the hardware. Returns -EINVAL
308 * upon error or 0 upon success.
310 static int _set_master_standbymode(struct omap_hwmod *oh, u8 standbymode,
316 if (!oh->class->sysc ||
317 !(oh->class->sysc->sysc_flags & SYSC_HAS_MIDLEMODE))
320 if (!oh->class->sysc->sysc_fields) {
321 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
325 mstandby_shift = oh->class->sysc->sysc_fields->midle_shift;
326 mstandby_mask = (0x3 << mstandby_shift);
328 *v &= ~mstandby_mask;
329 *v |= __ffs(standbymode) << mstandby_shift;
335 * _set_slave_idlemode: set the OCP_SYSCONFIG SIDLEMODE field in @v
336 * @oh: struct omap_hwmod *
337 * @idlemode: SIDLEMODE field bits
338 * @v: pointer to register contents to modify
340 * Update the slave idle mode bits in @v to be @idlemode for the @oh
341 * hwmod. Does not write to the hardware. Returns -EINVAL upon error
344 static int _set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode, u32 *v)
349 if (!oh->class->sysc ||
350 !(oh->class->sysc->sysc_flags & SYSC_HAS_SIDLEMODE))
353 if (!oh->class->sysc->sysc_fields) {
354 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
358 sidle_shift = oh->class->sysc->sysc_fields->sidle_shift;
359 sidle_mask = (0x3 << sidle_shift);
362 *v |= __ffs(idlemode) << sidle_shift;
368 * _set_clockactivity: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
369 * @oh: struct omap_hwmod *
370 * @clockact: CLOCKACTIVITY field bits
371 * @v: pointer to register contents to modify
373 * Update the clockactivity mode bits in @v to be @clockact for the
374 * @oh hwmod. Used for additional powersaving on some modules. Does
375 * not write to the hardware. Returns -EINVAL upon error or 0 upon
378 static int _set_clockactivity(struct omap_hwmod *oh, u8 clockact, u32 *v)
383 if (!oh->class->sysc ||
384 !(oh->class->sysc->sysc_flags & SYSC_HAS_CLOCKACTIVITY))
387 if (!oh->class->sysc->sysc_fields) {
388 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
392 clkact_shift = oh->class->sysc->sysc_fields->clkact_shift;
393 clkact_mask = (0x3 << clkact_shift);
396 *v |= clockact << clkact_shift;
402 * _set_softreset: set OCP_SYSCONFIG.SOFTRESET bit in @v
403 * @oh: struct omap_hwmod *
404 * @v: pointer to register contents to modify
406 * Set the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
407 * error or 0 upon success.
409 static int _set_softreset(struct omap_hwmod *oh, u32 *v)
413 if (!oh->class->sysc ||
414 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
417 if (!oh->class->sysc->sysc_fields) {
418 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
422 softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
430 * _clear_softreset: clear OCP_SYSCONFIG.SOFTRESET bit in @v
431 * @oh: struct omap_hwmod *
432 * @v: pointer to register contents to modify
434 * Clear the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
435 * error or 0 upon success.
437 static int _clear_softreset(struct omap_hwmod *oh, u32 *v)
441 if (!oh->class->sysc ||
442 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
445 if (!oh->class->sysc->sysc_fields) {
447 "omap_hwmod: %s: sysc_fields absent for sysconfig class\n",
452 softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
460 * _wait_softreset_complete - wait for an OCP softreset to complete
461 * @oh: struct omap_hwmod * to wait on
463 * Wait until the IP block represented by @oh reports that its OCP
464 * softreset is complete. This can be triggered by software (see
465 * _ocp_softreset()) or by hardware upon returning from off-mode (one
466 * example is HSMMC). Waits for up to MAX_MODULE_SOFTRESET_WAIT
467 * microseconds. Returns the number of microseconds waited.
469 static int _wait_softreset_complete(struct omap_hwmod *oh)
471 struct omap_hwmod_class_sysconfig *sysc;
475 sysc = oh->class->sysc;
477 if (sysc->sysc_flags & SYSS_HAS_RESET_STATUS)
478 omap_test_timeout((omap_hwmod_read(oh, sysc->syss_offs)
479 & SYSS_RESETDONE_MASK),
480 MAX_MODULE_SOFTRESET_WAIT, c);
481 else if (sysc->sysc_flags & SYSC_HAS_RESET_STATUS) {
482 softrst_mask = (0x1 << sysc->sysc_fields->srst_shift);
483 omap_test_timeout(!(omap_hwmod_read(oh, sysc->sysc_offs)
485 MAX_MODULE_SOFTRESET_WAIT, c);
492 * _set_dmadisable: set OCP_SYSCONFIG.DMADISABLE bit in @v
493 * @oh: struct omap_hwmod *
495 * The DMADISABLE bit is a semi-automatic bit present in sysconfig register
496 * of some modules. When the DMA must perform read/write accesses, the
497 * DMADISABLE bit is cleared by the hardware. But when the DMA must stop
498 * for power management, software must set the DMADISABLE bit back to 1.
500 * Set the DMADISABLE bit in @v for hwmod @oh. Returns -EINVAL upon
501 * error or 0 upon success.
503 static int _set_dmadisable(struct omap_hwmod *oh)
508 if (!oh->class->sysc ||
509 !(oh->class->sysc->sysc_flags & SYSC_HAS_DMADISABLE))
512 if (!oh->class->sysc->sysc_fields) {
513 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
517 /* clocks must be on for this operation */
518 if (oh->_state != _HWMOD_STATE_ENABLED) {
519 pr_warn("omap_hwmod: %s: dma can be disabled only from enabled state\n", oh->name);
523 pr_debug("omap_hwmod: %s: setting DMADISABLE\n", oh->name);
527 (0x1 << oh->class->sysc->sysc_fields->dmadisable_shift);
528 v |= dmadisable_mask;
529 _write_sysconfig(v, oh);
535 * _set_module_autoidle: set the OCP_SYSCONFIG AUTOIDLE field in @v
536 * @oh: struct omap_hwmod *
537 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
538 * @v: pointer to register contents to modify
540 * Update the module autoidle bit in @v to be @autoidle for the @oh
541 * hwmod. The autoidle bit controls whether the module can gate
542 * internal clocks automatically when it isn't doing anything; the
543 * exact function of this bit varies on a per-module basis. This
544 * function does not write to the hardware. Returns -EINVAL upon
545 * error or 0 upon success.
547 static int _set_module_autoidle(struct omap_hwmod *oh, u8 autoidle,
553 if (!oh->class->sysc ||
554 !(oh->class->sysc->sysc_flags & SYSC_HAS_AUTOIDLE))
557 if (!oh->class->sysc->sysc_fields) {
558 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
562 autoidle_shift = oh->class->sysc->sysc_fields->autoidle_shift;
563 autoidle_mask = (0x1 << autoidle_shift);
565 *v &= ~autoidle_mask;
566 *v |= autoidle << autoidle_shift;
572 * _set_idle_ioring_wakeup - enable/disable IO pad wakeup on hwmod idle for mux
573 * @oh: struct omap_hwmod *
574 * @set_wake: bool value indicating to set (true) or clear (false) wakeup enable
576 * Set or clear the I/O pad wakeup flag in the mux entries for the
577 * hwmod @oh. This function changes the @oh->mux->pads_dynamic array
578 * in memory. If the hwmod is currently idled, and the new idle
579 * values don't match the previous ones, this function will also
580 * update the SCM PADCTRL registers. Otherwise, if the hwmod is not
581 * currently idled, this function won't touch the hardware: the new
582 * mux settings are written to the SCM PADCTRL registers when the
583 * hwmod is idled. No return value.
585 static void _set_idle_ioring_wakeup(struct omap_hwmod *oh, bool set_wake)
587 struct omap_device_pad *pad;
592 if (!oh->mux || !oh->mux->enabled)
595 for (j = 0; j < oh->mux->nr_pads_dynamic; j++) {
596 pad = oh->mux->pads_dynamic[j];
598 if (!(pad->flags & OMAP_DEVICE_PAD_WAKEUP))
601 prev_idle = pad->idle;
604 pad->idle |= OMAP_WAKEUP_EN;
606 pad->idle &= ~OMAP_WAKEUP_EN;
608 if (prev_idle != pad->idle)
612 if (change && oh->_state == _HWMOD_STATE_IDLE)
613 omap_hwmod_mux(oh->mux, _HWMOD_STATE_IDLE);
617 * _enable_wakeup: set OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
618 * @oh: struct omap_hwmod *
620 * Allow the hardware module @oh to send wakeups. Returns -EINVAL
621 * upon error or 0 upon success.
623 static int _enable_wakeup(struct omap_hwmod *oh, u32 *v)
625 if (!oh->class->sysc ||
626 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
627 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
628 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
631 if (!oh->class->sysc->sysc_fields) {
632 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
636 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
637 *v |= 0x1 << oh->class->sysc->sysc_fields->enwkup_shift;
639 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
640 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
641 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
642 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
644 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
650 * _disable_wakeup: clear OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
651 * @oh: struct omap_hwmod *
653 * Prevent the hardware module @oh to send wakeups. Returns -EINVAL
654 * upon error or 0 upon success.
656 static int _disable_wakeup(struct omap_hwmod *oh, u32 *v)
658 if (!oh->class->sysc ||
659 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
660 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
661 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
664 if (!oh->class->sysc->sysc_fields) {
665 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
669 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
670 *v &= ~(0x1 << oh->class->sysc->sysc_fields->enwkup_shift);
672 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
673 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART, v);
674 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
675 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART, v);
677 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
682 static struct clockdomain *_get_clkdm(struct omap_hwmod *oh)
684 struct clk_hw_omap *clk;
688 } else if (oh->_clk) {
689 clk = to_clk_hw_omap(__clk_get_hw(oh->_clk));
696 * _add_initiator_dep: prevent @oh from smart-idling while @init_oh is active
697 * @oh: struct omap_hwmod *
699 * Prevent the hardware module @oh from entering idle while the
700 * hardare module initiator @init_oh is active. Useful when a module
701 * will be accessed by a particular initiator (e.g., if a module will
702 * be accessed by the IVA, there should be a sleepdep between the IVA
703 * initiator and the module). Only applies to modules in smart-idle
704 * mode. If the clockdomain is marked as not needing autodeps, return
705 * 0 without doing anything. Otherwise, returns -EINVAL upon error or
706 * passes along clkdm_add_sleepdep() value upon success.
708 static int _add_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
710 struct clockdomain *clkdm, *init_clkdm;
712 clkdm = _get_clkdm(oh);
713 init_clkdm = _get_clkdm(init_oh);
715 if (!clkdm || !init_clkdm)
718 if (clkdm && clkdm->flags & CLKDM_NO_AUTODEPS)
721 return clkdm_add_sleepdep(clkdm, init_clkdm);
725 * _del_initiator_dep: allow @oh to smart-idle even if @init_oh is active
726 * @oh: struct omap_hwmod *
728 * Allow the hardware module @oh to enter idle while the hardare
729 * module initiator @init_oh is active. Useful when a module will not
730 * be accessed by a particular initiator (e.g., if a module will not
731 * be accessed by the IVA, there should be no sleepdep between the IVA
732 * initiator and the module). Only applies to modules in smart-idle
733 * mode. If the clockdomain is marked as not needing autodeps, return
734 * 0 without doing anything. Returns -EINVAL upon error or passes
735 * along clkdm_del_sleepdep() value upon success.
737 static int _del_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
739 struct clockdomain *clkdm, *init_clkdm;
741 clkdm = _get_clkdm(oh);
742 init_clkdm = _get_clkdm(init_oh);
744 if (!clkdm || !init_clkdm)
747 if (clkdm && clkdm->flags & CLKDM_NO_AUTODEPS)
750 return clkdm_del_sleepdep(clkdm, init_clkdm);
754 * _init_main_clk - get a struct clk * for the the hwmod's main functional clk
755 * @oh: struct omap_hwmod *
757 * Called from _init_clocks(). Populates the @oh _clk (main
758 * functional clock pointer) if a main_clk is present. Returns 0 on
759 * success or -EINVAL on error.
761 static int _init_main_clk(struct omap_hwmod *oh)
768 oh->_clk = clk_get(NULL, oh->main_clk);
769 if (IS_ERR(oh->_clk)) {
770 pr_warning("omap_hwmod: %s: cannot clk_get main_clk %s\n",
771 oh->name, oh->main_clk);
775 * HACK: This needs a re-visit once clk_prepare() is implemented
776 * to do something meaningful. Today its just a no-op.
777 * If clk_prepare() is used at some point to do things like
778 * voltage scaling etc, then this would have to be moved to
779 * some point where subsystems like i2c and pmic become
782 clk_prepare(oh->_clk);
785 pr_debug("omap_hwmod: %s: missing clockdomain for %s.\n",
786 oh->name, oh->main_clk);
792 * _init_interface_clks - get a struct clk * for the the hwmod's interface clks
793 * @oh: struct omap_hwmod *
795 * Called from _init_clocks(). Populates the @oh OCP slave interface
796 * clock pointers. Returns 0 on success or -EINVAL on error.
798 static int _init_interface_clks(struct omap_hwmod *oh)
800 struct omap_hwmod_ocp_if *os;
806 p = oh->slave_ports.next;
808 while (i < oh->slaves_cnt) {
809 os = _fetch_next_ocp_if(&p, &i);
813 c = clk_get(NULL, os->clk);
815 pr_warning("omap_hwmod: %s: cannot clk_get interface_clk %s\n",
821 * HACK: This needs a re-visit once clk_prepare() is implemented
822 * to do something meaningful. Today its just a no-op.
823 * If clk_prepare() is used at some point to do things like
824 * voltage scaling etc, then this would have to be moved to
825 * some point where subsystems like i2c and pmic become
828 clk_prepare(os->_clk);
835 * _init_opt_clk - get a struct clk * for the the hwmod's optional clocks
836 * @oh: struct omap_hwmod *
838 * Called from _init_clocks(). Populates the @oh omap_hwmod_opt_clk
839 * clock pointers. Returns 0 on success or -EINVAL on error.
841 static int _init_opt_clks(struct omap_hwmod *oh)
843 struct omap_hwmod_opt_clk *oc;
848 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++) {
849 c = clk_get(NULL, oc->clk);
851 pr_warning("omap_hwmod: %s: cannot clk_get opt_clk %s\n",
857 * HACK: This needs a re-visit once clk_prepare() is implemented
858 * to do something meaningful. Today its just a no-op.
859 * If clk_prepare() is used at some point to do things like
860 * voltage scaling etc, then this would have to be moved to
861 * some point where subsystems like i2c and pmic become
864 clk_prepare(oc->_clk);
871 * _enable_clocks - enable hwmod main clock and interface clocks
872 * @oh: struct omap_hwmod *
874 * Enables all clocks necessary for register reads and writes to succeed
875 * on the hwmod @oh. Returns 0.
877 static int _enable_clocks(struct omap_hwmod *oh)
879 struct omap_hwmod_ocp_if *os;
883 pr_debug("omap_hwmod: %s: enabling clocks\n", oh->name);
886 clk_enable(oh->_clk);
888 p = oh->slave_ports.next;
890 while (i < oh->slaves_cnt) {
891 os = _fetch_next_ocp_if(&p, &i);
893 if (os->_clk && (os->flags & OCPIF_SWSUP_IDLE))
894 clk_enable(os->_clk);
897 /* The opt clocks are controlled by the device driver. */
903 * _disable_clocks - disable hwmod main clock and interface clocks
904 * @oh: struct omap_hwmod *
906 * Disables the hwmod @oh main functional and interface clocks. Returns 0.
908 static int _disable_clocks(struct omap_hwmod *oh)
910 struct omap_hwmod_ocp_if *os;
914 pr_debug("omap_hwmod: %s: disabling clocks\n", oh->name);
917 clk_disable(oh->_clk);
919 p = oh->slave_ports.next;
921 while (i < oh->slaves_cnt) {
922 os = _fetch_next_ocp_if(&p, &i);
924 if (os->_clk && (os->flags & OCPIF_SWSUP_IDLE))
925 clk_disable(os->_clk);
928 /* The opt clocks are controlled by the device driver. */
933 static void _enable_optional_clocks(struct omap_hwmod *oh)
935 struct omap_hwmod_opt_clk *oc;
938 pr_debug("omap_hwmod: %s: enabling optional clocks\n", oh->name);
940 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
942 pr_debug("omap_hwmod: enable %s:%s\n", oc->role,
943 __clk_get_name(oc->_clk));
944 clk_enable(oc->_clk);
948 static void _disable_optional_clocks(struct omap_hwmod *oh)
950 struct omap_hwmod_opt_clk *oc;
953 pr_debug("omap_hwmod: %s: disabling optional clocks\n", oh->name);
955 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
957 pr_debug("omap_hwmod: disable %s:%s\n", oc->role,
958 __clk_get_name(oc->_clk));
959 clk_disable(oc->_clk);
964 * _omap4_enable_module - enable CLKCTRL modulemode on OMAP4
965 * @oh: struct omap_hwmod *
967 * Enables the PRCM module mode related to the hwmod @oh.
970 static void _omap4_enable_module(struct omap_hwmod *oh)
972 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
975 pr_debug("omap_hwmod: %s: %s: %d\n",
976 oh->name, __func__, oh->prcm.omap4.modulemode);
978 omap4_cminst_module_enable(oh->prcm.omap4.modulemode,
979 oh->clkdm->prcm_partition,
981 oh->clkdm->clkdm_offs,
982 oh->prcm.omap4.clkctrl_offs);
986 * _am33xx_enable_module - enable CLKCTRL modulemode on AM33XX
987 * @oh: struct omap_hwmod *
989 * Enables the PRCM module mode related to the hwmod @oh.
992 static void _am33xx_enable_module(struct omap_hwmod *oh)
994 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
997 pr_debug("omap_hwmod: %s: %s: %d\n",
998 oh->name, __func__, oh->prcm.omap4.modulemode);
1000 am33xx_cm_module_enable(oh->prcm.omap4.modulemode, oh->clkdm->cm_inst,
1001 oh->clkdm->clkdm_offs,
1002 oh->prcm.omap4.clkctrl_offs);
1006 * _omap4_wait_target_disable - wait for a module to be disabled on OMAP4
1007 * @oh: struct omap_hwmod *
1009 * Wait for a module @oh to enter slave idle. Returns 0 if the module
1010 * does not have an IDLEST bit or if the module successfully enters
1011 * slave idle; otherwise, pass along the return value of the
1012 * appropriate *_cm*_wait_module_idle() function.
1014 static int _omap4_wait_target_disable(struct omap_hwmod *oh)
1019 if (oh->_int_flags & _HWMOD_NO_MPU_PORT || !oh->clkdm)
1022 if (oh->flags & HWMOD_NO_IDLEST)
1025 return omap4_cminst_wait_module_idle(oh->clkdm->prcm_partition,
1027 oh->clkdm->clkdm_offs,
1028 oh->prcm.omap4.clkctrl_offs);
1032 * _am33xx_wait_target_disable - wait for a module to be disabled on AM33XX
1033 * @oh: struct omap_hwmod *
1035 * Wait for a module @oh to enter slave idle. Returns 0 if the module
1036 * does not have an IDLEST bit or if the module successfully enters
1037 * slave idle; otherwise, pass along the return value of the
1038 * appropriate *_cm*_wait_module_idle() function.
1040 static int _am33xx_wait_target_disable(struct omap_hwmod *oh)
1045 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
1048 if (oh->flags & HWMOD_NO_IDLEST)
1051 return am33xx_cm_wait_module_idle(oh->clkdm->cm_inst,
1052 oh->clkdm->clkdm_offs,
1053 oh->prcm.omap4.clkctrl_offs);
1057 * _count_mpu_irqs - count the number of MPU IRQ lines associated with @oh
1058 * @oh: struct omap_hwmod *oh
1060 * Count and return the number of MPU IRQs associated with the hwmod
1061 * @oh. Used to allocate struct resource data. Returns 0 if @oh is
1064 static int _count_mpu_irqs(struct omap_hwmod *oh)
1066 struct omap_hwmod_irq_info *ohii;
1069 if (!oh || !oh->mpu_irqs)
1073 ohii = &oh->mpu_irqs[i++];
1074 } while (ohii->irq != -1);
1080 * _count_sdma_reqs - count the number of SDMA request lines associated with @oh
1081 * @oh: struct omap_hwmod *oh
1083 * Count and return the number of SDMA request lines associated with
1084 * the hwmod @oh. Used to allocate struct resource data. Returns 0
1087 static int _count_sdma_reqs(struct omap_hwmod *oh)
1089 struct omap_hwmod_dma_info *ohdi;
1092 if (!oh || !oh->sdma_reqs)
1096 ohdi = &oh->sdma_reqs[i++];
1097 } while (ohdi->dma_req != -1);
1103 * _count_ocp_if_addr_spaces - count the number of address space entries for @oh
1104 * @oh: struct omap_hwmod *oh
1106 * Count and return the number of address space ranges associated with
1107 * the hwmod @oh. Used to allocate struct resource data. Returns 0
1110 static int _count_ocp_if_addr_spaces(struct omap_hwmod_ocp_if *os)
1112 struct omap_hwmod_addr_space *mem;
1115 if (!os || !os->addr)
1119 mem = &os->addr[i++];
1120 } while (mem->pa_start != mem->pa_end);
1126 * _get_mpu_irq_by_name - fetch MPU interrupt line number by name
1127 * @oh: struct omap_hwmod * to operate on
1128 * @name: pointer to the name of the MPU interrupt number to fetch (optional)
1129 * @irq: pointer to an unsigned int to store the MPU IRQ number to
1131 * Retrieve a MPU hardware IRQ line number named by @name associated
1132 * with the IP block pointed to by @oh. The IRQ number will be filled
1133 * into the address pointed to by @dma. When @name is non-null, the
1134 * IRQ line number associated with the named entry will be returned.
1135 * If @name is null, the first matching entry will be returned. Data
1136 * order is not meaningful in hwmod data, so callers are strongly
1137 * encouraged to use a non-null @name whenever possible to avoid
1138 * unpredictable effects if hwmod data is later added that causes data
1139 * ordering to change. Returns 0 upon success or a negative error
1142 static int _get_mpu_irq_by_name(struct omap_hwmod *oh, const char *name,
1152 while (oh->mpu_irqs[i].irq != -1) {
1153 if (name == oh->mpu_irqs[i].name ||
1154 !strcmp(name, oh->mpu_irqs[i].name)) {
1164 *irq = oh->mpu_irqs[i].irq;
1170 * _get_sdma_req_by_name - fetch SDMA request line ID by name
1171 * @oh: struct omap_hwmod * to operate on
1172 * @name: pointer to the name of the SDMA request line to fetch (optional)
1173 * @dma: pointer to an unsigned int to store the request line ID to
1175 * Retrieve an SDMA request line ID named by @name on the IP block
1176 * pointed to by @oh. The ID will be filled into the address pointed
1177 * to by @dma. When @name is non-null, the request line ID associated
1178 * with the named entry will be returned. If @name is null, the first
1179 * matching entry will be returned. Data order is not meaningful in
1180 * hwmod data, so callers are strongly encouraged to use a non-null
1181 * @name whenever possible to avoid unpredictable effects if hwmod
1182 * data is later added that causes data ordering to change. Returns 0
1183 * upon success or a negative error code upon error.
1185 static int _get_sdma_req_by_name(struct omap_hwmod *oh, const char *name,
1195 while (oh->sdma_reqs[i].dma_req != -1) {
1196 if (name == oh->sdma_reqs[i].name ||
1197 !strcmp(name, oh->sdma_reqs[i].name)) {
1207 *dma = oh->sdma_reqs[i].dma_req;
1213 * _get_addr_space_by_name - fetch address space start & end by name
1214 * @oh: struct omap_hwmod * to operate on
1215 * @name: pointer to the name of the address space to fetch (optional)
1216 * @pa_start: pointer to a u32 to store the starting address to
1217 * @pa_end: pointer to a u32 to store the ending address to
1219 * Retrieve address space start and end addresses for the IP block
1220 * pointed to by @oh. The data will be filled into the addresses
1221 * pointed to by @pa_start and @pa_end. When @name is non-null, the
1222 * address space data associated with the named entry will be
1223 * returned. If @name is null, the first matching entry will be
1224 * returned. Data order is not meaningful in hwmod data, so callers
1225 * are strongly encouraged to use a non-null @name whenever possible
1226 * to avoid unpredictable effects if hwmod data is later added that
1227 * causes data ordering to change. Returns 0 upon success or a
1228 * negative error code upon error.
1230 static int _get_addr_space_by_name(struct omap_hwmod *oh, const char *name,
1231 u32 *pa_start, u32 *pa_end)
1234 struct omap_hwmod_ocp_if *os;
1235 struct list_head *p = NULL;
1238 p = oh->slave_ports.next;
1241 while (i < oh->slaves_cnt) {
1242 os = _fetch_next_ocp_if(&p, &i);
1248 while (os->addr[j].pa_start != os->addr[j].pa_end) {
1249 if (name == os->addr[j].name ||
1250 !strcmp(name, os->addr[j].name)) {
1264 *pa_start = os->addr[j].pa_start;
1265 *pa_end = os->addr[j].pa_end;
1271 * _save_mpu_port_index - find and save the index to @oh's MPU port
1272 * @oh: struct omap_hwmod *
1274 * Determines the array index of the OCP slave port that the MPU uses
1275 * to address the device, and saves it into the struct omap_hwmod.
1276 * Intended to be called during hwmod registration only. No return
1279 static void __init _save_mpu_port_index(struct omap_hwmod *oh)
1281 struct omap_hwmod_ocp_if *os = NULL;
1282 struct list_head *p;
1288 oh->_int_flags |= _HWMOD_NO_MPU_PORT;
1290 p = oh->slave_ports.next;
1292 while (i < oh->slaves_cnt) {
1293 os = _fetch_next_ocp_if(&p, &i);
1294 if (os->user & OCP_USER_MPU) {
1296 oh->_int_flags &= ~_HWMOD_NO_MPU_PORT;
1305 * _find_mpu_rt_port - return omap_hwmod_ocp_if accessible by the MPU
1306 * @oh: struct omap_hwmod *
1308 * Given a pointer to a struct omap_hwmod record @oh, return a pointer
1309 * to the struct omap_hwmod_ocp_if record that is used by the MPU to
1310 * communicate with the IP block. This interface need not be directly
1311 * connected to the MPU (and almost certainly is not), but is directly
1312 * connected to the IP block represented by @oh. Returns a pointer
1313 * to the struct omap_hwmod_ocp_if * upon success, or returns NULL upon
1314 * error or if there does not appear to be a path from the MPU to this
1317 static struct omap_hwmod_ocp_if *_find_mpu_rt_port(struct omap_hwmod *oh)
1319 if (!oh || oh->_int_flags & _HWMOD_NO_MPU_PORT || oh->slaves_cnt == 0)
1322 return oh->_mpu_port;
1326 * _find_mpu_rt_addr_space - return MPU register target address space for @oh
1327 * @oh: struct omap_hwmod *
1329 * Returns a pointer to the struct omap_hwmod_addr_space record representing
1330 * the register target MPU address space; or returns NULL upon error.
1332 static struct omap_hwmod_addr_space * __init _find_mpu_rt_addr_space(struct omap_hwmod *oh)
1334 struct omap_hwmod_ocp_if *os;
1335 struct omap_hwmod_addr_space *mem;
1336 int found = 0, i = 0;
1338 os = _find_mpu_rt_port(oh);
1339 if (!os || !os->addr)
1343 mem = &os->addr[i++];
1344 if (mem->flags & ADDR_TYPE_RT)
1346 } while (!found && mem->pa_start != mem->pa_end);
1348 return (found) ? mem : NULL;
1352 * _enable_sysc - try to bring a module out of idle via OCP_SYSCONFIG
1353 * @oh: struct omap_hwmod *
1355 * Ensure that the OCP_SYSCONFIG register for the IP block represented
1356 * by @oh is set to indicate to the PRCM that the IP block is active.
1357 * Usually this means placing the module into smart-idle mode and
1358 * smart-standby, but if there is a bug in the automatic idle handling
1359 * for the IP block, it may need to be placed into the force-idle or
1360 * no-idle variants of these modes. No return value.
1362 static void _enable_sysc(struct omap_hwmod *oh)
1367 struct clockdomain *clkdm;
1369 if (!oh->class->sysc)
1373 * Wait until reset has completed, this is needed as the IP
1374 * block is reset automatically by hardware in some cases
1375 * (off-mode for example), and the drivers require the
1376 * IP to be ready when they access it
1378 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1379 _enable_optional_clocks(oh);
1380 _wait_softreset_complete(oh);
1381 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1382 _disable_optional_clocks(oh);
1384 v = oh->_sysc_cache;
1385 sf = oh->class->sysc->sysc_flags;
1387 clkdm = _get_clkdm(oh);
1388 if (sf & SYSC_HAS_SIDLEMODE) {
1389 if (oh->flags & HWMOD_SWSUP_SIDLE ||
1390 oh->flags & HWMOD_SWSUP_SIDLE_ACT) {
1391 idlemode = HWMOD_IDLEMODE_NO;
1393 if (sf & SYSC_HAS_ENAWAKEUP)
1394 _enable_wakeup(oh, &v);
1395 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
1396 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1398 idlemode = HWMOD_IDLEMODE_SMART;
1402 * This is special handling for some IPs like
1403 * 32k sync timer. Force them to idle!
1405 clkdm_act = (clkdm && clkdm->flags & CLKDM_ACTIVE_WITH_MPU);
1406 if (clkdm_act && !(oh->class->sysc->idlemodes &
1407 (SIDLE_SMART | SIDLE_SMART_WKUP)))
1408 idlemode = HWMOD_IDLEMODE_FORCE;
1410 _set_slave_idlemode(oh, idlemode, &v);
1413 if (sf & SYSC_HAS_MIDLEMODE) {
1414 if (oh->flags & HWMOD_FORCE_MSTANDBY) {
1415 idlemode = HWMOD_IDLEMODE_FORCE;
1416 } else if (oh->flags & HWMOD_SWSUP_MSTANDBY) {
1417 idlemode = HWMOD_IDLEMODE_NO;
1419 if (sf & SYSC_HAS_ENAWAKEUP)
1420 _enable_wakeup(oh, &v);
1421 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1422 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1424 idlemode = HWMOD_IDLEMODE_SMART;
1426 _set_master_standbymode(oh, idlemode, &v);
1430 * XXX The clock framework should handle this, by
1431 * calling into this code. But this must wait until the
1432 * clock structures are tagged with omap_hwmod entries
1434 if ((oh->flags & HWMOD_SET_DEFAULT_CLOCKACT) &&
1435 (sf & SYSC_HAS_CLOCKACTIVITY))
1436 _set_clockactivity(oh, oh->class->sysc->clockact, &v);
1438 /* If the cached value is the same as the new value, skip the write */
1439 if (oh->_sysc_cache != v)
1440 _write_sysconfig(v, oh);
1443 * Set the autoidle bit only after setting the smartidle bit
1444 * Setting this will not have any impact on the other modules.
1446 if (sf & SYSC_HAS_AUTOIDLE) {
1447 idlemode = (oh->flags & HWMOD_NO_OCP_AUTOIDLE) ?
1449 _set_module_autoidle(oh, idlemode, &v);
1450 _write_sysconfig(v, oh);
1455 * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
1456 * @oh: struct omap_hwmod *
1458 * If module is marked as SWSUP_SIDLE, force the module into slave
1459 * idle; otherwise, configure it for smart-idle. If module is marked
1460 * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
1461 * configure it for smart-standby. No return value.
1463 static void _idle_sysc(struct omap_hwmod *oh)
1468 if (!oh->class->sysc)
1471 v = oh->_sysc_cache;
1472 sf = oh->class->sysc->sysc_flags;
1474 if (sf & SYSC_HAS_SIDLEMODE) {
1475 if (oh->flags & HWMOD_SWSUP_SIDLE) {
1476 idlemode = HWMOD_IDLEMODE_FORCE;
1478 if (sf & SYSC_HAS_ENAWAKEUP)
1479 _enable_wakeup(oh, &v);
1480 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
1481 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1483 idlemode = HWMOD_IDLEMODE_SMART;
1485 _set_slave_idlemode(oh, idlemode, &v);
1488 if (sf & SYSC_HAS_MIDLEMODE) {
1489 if ((oh->flags & HWMOD_SWSUP_MSTANDBY) ||
1490 (oh->flags & HWMOD_FORCE_MSTANDBY)) {
1491 idlemode = HWMOD_IDLEMODE_FORCE;
1493 if (sf & SYSC_HAS_ENAWAKEUP)
1494 _enable_wakeup(oh, &v);
1495 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1496 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1498 idlemode = HWMOD_IDLEMODE_SMART;
1500 _set_master_standbymode(oh, idlemode, &v);
1503 _write_sysconfig(v, oh);
1507 * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
1508 * @oh: struct omap_hwmod *
1510 * Force the module into slave idle and master suspend. No return
1513 static void _shutdown_sysc(struct omap_hwmod *oh)
1518 if (!oh->class->sysc)
1521 v = oh->_sysc_cache;
1522 sf = oh->class->sysc->sysc_flags;
1524 if (sf & SYSC_HAS_SIDLEMODE)
1525 _set_slave_idlemode(oh, HWMOD_IDLEMODE_FORCE, &v);
1527 if (sf & SYSC_HAS_MIDLEMODE)
1528 _set_master_standbymode(oh, HWMOD_IDLEMODE_FORCE, &v);
1530 if (sf & SYSC_HAS_AUTOIDLE)
1531 _set_module_autoidle(oh, 1, &v);
1533 _write_sysconfig(v, oh);
1537 * _lookup - find an omap_hwmod by name
1538 * @name: find an omap_hwmod by name
1540 * Return a pointer to an omap_hwmod by name, or NULL if not found.
1542 static struct omap_hwmod *_lookup(const char *name)
1544 struct omap_hwmod *oh, *temp_oh;
1548 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1549 if (!strcmp(name, temp_oh->name)) {
1559 * _init_clkdm - look up a clockdomain name, store pointer in omap_hwmod
1560 * @oh: struct omap_hwmod *
1562 * Convert a clockdomain name stored in a struct omap_hwmod into a
1563 * clockdomain pointer, and save it into the struct omap_hwmod.
1564 * Return -EINVAL if the clkdm_name lookup failed.
1566 static int _init_clkdm(struct omap_hwmod *oh)
1568 if (!oh->clkdm_name) {
1569 pr_debug("omap_hwmod: %s: missing clockdomain\n", oh->name);
1573 oh->clkdm = clkdm_lookup(oh->clkdm_name);
1575 pr_warning("omap_hwmod: %s: could not associate to clkdm %s\n",
1576 oh->name, oh->clkdm_name);
1580 pr_debug("omap_hwmod: %s: associated to clkdm %s\n",
1581 oh->name, oh->clkdm_name);
1587 * _init_clocks - clk_get() all clocks associated with this hwmod. Retrieve as
1588 * well the clockdomain.
1589 * @oh: struct omap_hwmod *
1590 * @data: not used; pass NULL
1592 * Called by omap_hwmod_setup_*() (after omap2_clk_init()).
1593 * Resolves all clock names embedded in the hwmod. Returns 0 on
1594 * success, or a negative error code on failure.
1596 static int _init_clocks(struct omap_hwmod *oh, void *data)
1600 if (oh->_state != _HWMOD_STATE_REGISTERED)
1603 pr_debug("omap_hwmod: %s: looking up clocks\n", oh->name);
1605 if (soc_ops.init_clkdm)
1606 ret |= soc_ops.init_clkdm(oh);
1608 ret |= _init_main_clk(oh);
1609 ret |= _init_interface_clks(oh);
1610 ret |= _init_opt_clks(oh);
1613 oh->_state = _HWMOD_STATE_CLKS_INITED;
1615 pr_warning("omap_hwmod: %s: cannot _init_clocks\n", oh->name);
1621 * _lookup_hardreset - fill register bit info for this hwmod/reset line
1622 * @oh: struct omap_hwmod *
1623 * @name: name of the reset line in the context of this hwmod
1624 * @ohri: struct omap_hwmod_rst_info * that this function will fill in
1626 * Return the bit position of the reset line that match the
1627 * input name. Return -ENOENT if not found.
1629 static int _lookup_hardreset(struct omap_hwmod *oh, const char *name,
1630 struct omap_hwmod_rst_info *ohri)
1634 for (i = 0; i < oh->rst_lines_cnt; i++) {
1635 const char *rst_line = oh->rst_lines[i].name;
1636 if (!strcmp(rst_line, name)) {
1637 ohri->rst_shift = oh->rst_lines[i].rst_shift;
1638 ohri->st_shift = oh->rst_lines[i].st_shift;
1639 pr_debug("omap_hwmod: %s: %s: %s: rst %d st %d\n",
1640 oh->name, __func__, rst_line, ohri->rst_shift,
1651 * _assert_hardreset - assert the HW reset line of submodules
1652 * contained in the hwmod module.
1653 * @oh: struct omap_hwmod *
1654 * @name: name of the reset line to lookup and assert
1656 * Some IP like dsp, ipu or iva contain processor that require an HW
1657 * reset line to be assert / deassert in order to enable fully the IP.
1658 * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1659 * asserting the hardreset line on the currently-booted SoC, or passes
1660 * along the return value from _lookup_hardreset() or the SoC's
1661 * assert_hardreset code.
1663 static int _assert_hardreset(struct omap_hwmod *oh, const char *name)
1665 struct omap_hwmod_rst_info ohri;
1671 if (!soc_ops.assert_hardreset)
1674 ret = _lookup_hardreset(oh, name, &ohri);
1678 ret = soc_ops.assert_hardreset(oh, &ohri);
1684 * _deassert_hardreset - deassert the HW reset line of submodules contained
1685 * in the hwmod module.
1686 * @oh: struct omap_hwmod *
1687 * @name: name of the reset line to look up and deassert
1689 * Some IP like dsp, ipu or iva contain processor that require an HW
1690 * reset line to be assert / deassert in order to enable fully the IP.
1691 * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1692 * deasserting the hardreset line on the currently-booted SoC, or passes
1693 * along the return value from _lookup_hardreset() or the SoC's
1694 * deassert_hardreset code.
1696 static int _deassert_hardreset(struct omap_hwmod *oh, const char *name)
1698 struct omap_hwmod_rst_info ohri;
1705 if (!soc_ops.deassert_hardreset)
1708 ret = _lookup_hardreset(oh, name, &ohri);
1714 * A clockdomain must be in SW_SUP otherwise reset
1715 * might not be completed. The clockdomain can be set
1716 * in HW_AUTO only when the module become ready.
1718 hwsup = clkdm_in_hwsup(oh->clkdm);
1719 ret = clkdm_hwmod_enable(oh->clkdm, oh);
1721 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1722 oh->name, oh->clkdm->name, ret);
1728 if (soc_ops.enable_module)
1729 soc_ops.enable_module(oh);
1731 ret = soc_ops.deassert_hardreset(oh, &ohri);
1733 if (soc_ops.disable_module)
1734 soc_ops.disable_module(oh);
1735 _disable_clocks(oh);
1738 pr_warning("omap_hwmod: %s: failed to hardreset\n", oh->name);
1742 * Set the clockdomain to HW_AUTO, assuming that the
1743 * previous state was HW_AUTO.
1745 if (oh->clkdm && hwsup)
1746 clkdm_allow_idle(oh->clkdm);
1749 clkdm_hwmod_disable(oh->clkdm, oh);
1756 * _read_hardreset - read the HW reset line state of submodules
1757 * contained in the hwmod module
1758 * @oh: struct omap_hwmod *
1759 * @name: name of the reset line to look up and read
1761 * Return the state of the reset line. Returns -EINVAL if @oh is
1762 * null, -ENOSYS if we have no way of reading the hardreset line
1763 * status on the currently-booted SoC, or passes along the return
1764 * value from _lookup_hardreset() or the SoC's is_hardreset_asserted
1767 static int _read_hardreset(struct omap_hwmod *oh, const char *name)
1769 struct omap_hwmod_rst_info ohri;
1775 if (!soc_ops.is_hardreset_asserted)
1778 ret = _lookup_hardreset(oh, name, &ohri);
1782 return soc_ops.is_hardreset_asserted(oh, &ohri);
1786 * _are_all_hardreset_lines_asserted - return true if the @oh is hard-reset
1787 * @oh: struct omap_hwmod *
1789 * If all hardreset lines associated with @oh are asserted, then return true.
1790 * Otherwise, if part of @oh is out hardreset or if no hardreset lines
1791 * associated with @oh are asserted, then return false.
1792 * This function is used to avoid executing some parts of the IP block
1793 * enable/disable sequence if its hardreset line is set.
1795 static bool _are_all_hardreset_lines_asserted(struct omap_hwmod *oh)
1799 if (oh->rst_lines_cnt == 0)
1802 for (i = 0; i < oh->rst_lines_cnt; i++)
1803 if (_read_hardreset(oh, oh->rst_lines[i].name) > 0)
1806 if (oh->rst_lines_cnt == rst_cnt)
1813 * _are_any_hardreset_lines_asserted - return true if any part of @oh is
1815 * @oh: struct omap_hwmod *
1817 * If any hardreset lines associated with @oh are asserted, then
1818 * return true. Otherwise, if no hardreset lines associated with @oh
1819 * are asserted, or if @oh has no hardreset lines, then return false.
1820 * This function is used to avoid executing some parts of the IP block
1821 * enable/disable sequence if any hardreset line is set.
1823 static bool _are_any_hardreset_lines_asserted(struct omap_hwmod *oh)
1828 for (i = 0; i < oh->rst_lines_cnt && rst_cnt == 0; i++)
1829 if (_read_hardreset(oh, oh->rst_lines[i].name) > 0)
1832 return (rst_cnt) ? true : false;
1836 * _omap4_disable_module - enable CLKCTRL modulemode on OMAP4
1837 * @oh: struct omap_hwmod *
1839 * Disable the PRCM module mode related to the hwmod @oh.
1840 * Return EINVAL if the modulemode is not supported and 0 in case of success.
1842 static int _omap4_disable_module(struct omap_hwmod *oh)
1846 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
1850 * Since integration code might still be doing something, only
1851 * disable if all lines are under hardreset.
1853 if (_are_any_hardreset_lines_asserted(oh))
1856 pr_debug("omap_hwmod: %s: %s\n", oh->name, __func__);
1858 omap4_cminst_module_disable(oh->clkdm->prcm_partition,
1860 oh->clkdm->clkdm_offs,
1861 oh->prcm.omap4.clkctrl_offs);
1863 v = _omap4_wait_target_disable(oh);
1865 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1872 * _am33xx_disable_module - enable CLKCTRL modulemode on AM33XX
1873 * @oh: struct omap_hwmod *
1875 * Disable the PRCM module mode related to the hwmod @oh.
1876 * Return EINVAL if the modulemode is not supported and 0 in case of success.
1878 static int _am33xx_disable_module(struct omap_hwmod *oh)
1882 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
1885 pr_debug("omap_hwmod: %s: %s\n", oh->name, __func__);
1887 if (_are_any_hardreset_lines_asserted(oh))
1890 am33xx_cm_module_disable(oh->clkdm->cm_inst, oh->clkdm->clkdm_offs,
1891 oh->prcm.omap4.clkctrl_offs);
1893 v = _am33xx_wait_target_disable(oh);
1895 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1902 * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1903 * @oh: struct omap_hwmod *
1905 * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit. hwmod must be
1906 * enabled for this to work. Returns -ENOENT if the hwmod cannot be
1907 * reset this way, -EINVAL if the hwmod is in the wrong state,
1908 * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1910 * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1911 * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1912 * use the SYSCONFIG softreset bit to provide the status.
1914 * Note that some IP like McBSP do have reset control but don't have
1917 static int _ocp_softreset(struct omap_hwmod *oh)
1923 if (!oh->class->sysc ||
1924 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
1927 /* clocks must be on for this operation */
1928 if (oh->_state != _HWMOD_STATE_ENABLED) {
1929 pr_warn("omap_hwmod: %s: reset can only be entered from enabled state\n",
1934 /* For some modules, all optionnal clocks need to be enabled as well */
1935 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1936 _enable_optional_clocks(oh);
1938 pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh->name);
1940 v = oh->_sysc_cache;
1941 ret = _set_softreset(oh, &v);
1945 _write_sysconfig(v, oh);
1946 ret = _clear_softreset(oh, &v);
1950 _write_sysconfig(v, oh);
1952 if (oh->class->sysc->srst_udelay)
1953 udelay(oh->class->sysc->srst_udelay);
1955 c = _wait_softreset_complete(oh);
1956 if (c == MAX_MODULE_SOFTRESET_WAIT)
1957 pr_warning("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1958 oh->name, MAX_MODULE_SOFTRESET_WAIT);
1960 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh->name, c);
1963 * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1964 * _wait_target_ready() or _reset()
1967 ret = (c == MAX_MODULE_SOFTRESET_WAIT) ? -ETIMEDOUT : 0;
1970 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1971 _disable_optional_clocks(oh);
1977 * _reset - reset an omap_hwmod
1978 * @oh: struct omap_hwmod *
1980 * Resets an omap_hwmod @oh. If the module has a custom reset
1981 * function pointer defined, then call it to reset the IP block, and
1982 * pass along its return value to the caller. Otherwise, if the IP
1983 * block has an OCP_SYSCONFIG register with a SOFTRESET bitfield
1984 * associated with it, call a function to reset the IP block via that
1985 * method, and pass along the return value to the caller. Finally, if
1986 * the IP block has some hardreset lines associated with it, assert
1987 * all of those, but do _not_ deassert them. (This is because driver
1988 * authors have expressed an apparent requirement to control the
1989 * deassertion of the hardreset lines themselves.)
1991 * The default software reset mechanism for most OMAP IP blocks is
1992 * triggered via the OCP_SYSCONFIG.SOFTRESET bit. However, some
1993 * hwmods cannot be reset via this method. Some are not targets and
1994 * therefore have no OCP header registers to access. Others (like the
1995 * IVA) have idiosyncratic reset sequences. So for these relatively
1996 * rare cases, custom reset code can be supplied in the struct
1997 * omap_hwmod_class .reset function pointer.
1999 * _set_dmadisable() is called to set the DMADISABLE bit so that it
2000 * does not prevent idling of the system. This is necessary for cases
2001 * where ROMCODE/BOOTLOADER uses dma and transfers control to the
2002 * kernel without disabling dma.
2004 * Passes along the return value from either _ocp_softreset() or the
2005 * custom reset function - these must return -EINVAL if the hwmod
2006 * cannot be reset this way or if the hwmod is in the wrong state,
2007 * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
2009 static int _reset(struct omap_hwmod *oh)
2013 pr_debug("omap_hwmod: %s: resetting\n", oh->name);
2015 if (oh->class->reset) {
2016 r = oh->class->reset(oh);
2018 if (oh->rst_lines_cnt > 0) {
2019 for (i = 0; i < oh->rst_lines_cnt; i++)
2020 _assert_hardreset(oh, oh->rst_lines[i].name);
2023 r = _ocp_softreset(oh);
2029 _set_dmadisable(oh);
2032 * OCP_SYSCONFIG bits need to be reprogrammed after a
2033 * softreset. The _enable() function should be split to avoid
2034 * the rewrite of the OCP_SYSCONFIG register.
2036 if (oh->class->sysc) {
2037 _update_sysc_cache(oh);
2045 * _reconfigure_io_chain - clear any I/O chain wakeups and reconfigure chain
2047 * Call the appropriate PRM function to clear any logged I/O chain
2048 * wakeups and to reconfigure the chain. This apparently needs to be
2049 * done upon every mux change. Since hwmods can be concurrently
2050 * enabled and idled, hold a spinlock around the I/O chain
2051 * reconfiguration sequence. No return value.
2053 * XXX When the PRM code is moved to drivers, this function can be removed,
2054 * as the PRM infrastructure should abstract this.
2056 static void _reconfigure_io_chain(void)
2058 unsigned long flags;
2060 spin_lock_irqsave(&io_chain_lock, flags);
2062 if (cpu_is_omap34xx() && omap3_has_io_chain_ctrl())
2063 omap3xxx_prm_reconfigure_io_chain();
2064 else if (cpu_is_omap44xx())
2065 omap44xx_prm_reconfigure_io_chain();
2067 spin_unlock_irqrestore(&io_chain_lock, flags);
2071 * _omap4_update_context_lost - increment hwmod context loss counter if
2072 * hwmod context was lost, and clear hardware context loss reg
2073 * @oh: hwmod to check for context loss
2075 * If the PRCM indicates that the hwmod @oh lost context, increment
2076 * our in-memory context loss counter, and clear the RM_*_CONTEXT
2077 * bits. No return value.
2079 static void _omap4_update_context_lost(struct omap_hwmod *oh)
2081 if (oh->prcm.omap4.flags & HWMOD_OMAP4_NO_CONTEXT_LOSS_BIT)
2084 if (!prm_was_any_context_lost_old(oh->clkdm->pwrdm.ptr->prcm_partition,
2085 oh->clkdm->pwrdm.ptr->prcm_offs,
2086 oh->prcm.omap4.context_offs))
2089 oh->prcm.omap4.context_lost_counter++;
2090 prm_clear_context_loss_flags_old(oh->clkdm->pwrdm.ptr->prcm_partition,
2091 oh->clkdm->pwrdm.ptr->prcm_offs,
2092 oh->prcm.omap4.context_offs);
2096 * _omap4_get_context_lost - get context loss counter for a hwmod
2097 * @oh: hwmod to get context loss counter for
2099 * Returns the in-memory context loss counter for a hwmod.
2101 static int _omap4_get_context_lost(struct omap_hwmod *oh)
2103 return oh->prcm.omap4.context_lost_counter;
2107 * _enable_preprogram - Pre-program an IP block during the _enable() process
2108 * @oh: struct omap_hwmod *
2110 * Some IP blocks (such as AESS) require some additional programming
2111 * after enable before they can enter idle. If a function pointer to
2112 * do so is present in the hwmod data, then call it and pass along the
2113 * return value; otherwise, return 0.
2115 static int _enable_preprogram(struct omap_hwmod *oh)
2117 if (!oh->class->enable_preprogram)
2120 return oh->class->enable_preprogram(oh);
2124 * _enable - enable an omap_hwmod
2125 * @oh: struct omap_hwmod *
2127 * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
2128 * register target. Returns -EINVAL if the hwmod is in the wrong
2129 * state or passes along the return value of _wait_target_ready().
2131 static int _enable(struct omap_hwmod *oh)
2136 pr_debug("omap_hwmod: %s: enabling\n", oh->name);
2139 * hwmods with HWMOD_INIT_NO_IDLE flag set are left in enabled
2140 * state at init. Now that someone is really trying to enable
2141 * them, just ensure that the hwmod mux is set.
2143 if (oh->_int_flags & _HWMOD_SKIP_ENABLE) {
2145 * If the caller has mux data populated, do the mux'ing
2146 * which wouldn't have been done as part of the _enable()
2147 * done during setup.
2150 omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
2152 oh->_int_flags &= ~_HWMOD_SKIP_ENABLE;
2156 if (oh->_state != _HWMOD_STATE_INITIALIZED &&
2157 oh->_state != _HWMOD_STATE_IDLE &&
2158 oh->_state != _HWMOD_STATE_DISABLED) {
2159 WARN(1, "omap_hwmod: %s: enabled state can only be entered from initialized, idle, or disabled state\n",
2165 * If an IP block contains HW reset lines and all of them are
2166 * asserted, we let integration code associated with that
2167 * block handle the enable. We've received very little
2168 * information on what those driver authors need, and until
2169 * detailed information is provided and the driver code is
2170 * posted to the public lists, this is probably the best we
2173 if (_are_all_hardreset_lines_asserted(oh))
2176 /* Mux pins for device runtime if populated */
2177 if (oh->mux && (!oh->mux->enabled ||
2178 ((oh->_state == _HWMOD_STATE_IDLE) &&
2179 oh->mux->pads_dynamic))) {
2180 omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
2181 _reconfigure_io_chain();
2184 _add_initiator_dep(oh, mpu_oh);
2188 * A clockdomain must be in SW_SUP before enabling
2189 * completely the module. The clockdomain can be set
2190 * in HW_AUTO only when the module become ready.
2192 hwsup = clkdm_in_hwsup(oh->clkdm) &&
2193 !clkdm_missing_idle_reporting(oh->clkdm);
2194 r = clkdm_hwmod_enable(oh->clkdm, oh);
2196 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
2197 oh->name, oh->clkdm->name, r);
2203 if (soc_ops.enable_module)
2204 soc_ops.enable_module(oh);
2205 if (oh->flags & HWMOD_BLOCK_WFI)
2206 cpu_idle_poll_ctrl(true);
2208 if (soc_ops.update_context_lost)
2209 soc_ops.update_context_lost(oh);
2211 r = (soc_ops.wait_target_ready) ? soc_ops.wait_target_ready(oh) :
2215 * Set the clockdomain to HW_AUTO only if the target is ready,
2216 * assuming that the previous state was HW_AUTO
2218 if (oh->clkdm && hwsup)
2219 clkdm_allow_idle(oh->clkdm);
2221 oh->_state = _HWMOD_STATE_ENABLED;
2223 /* Access the sysconfig only if the target is ready */
2224 if (oh->class->sysc) {
2225 if (!(oh->_int_flags & _HWMOD_SYSCONFIG_LOADED))
2226 _update_sysc_cache(oh);
2229 r = _enable_preprogram(oh);
2231 if (soc_ops.disable_module)
2232 soc_ops.disable_module(oh);
2233 _disable_clocks(oh);
2234 pr_debug("omap_hwmod: %s: _wait_target_ready: %d\n",
2238 clkdm_hwmod_disable(oh->clkdm, oh);
2245 * _idle - idle an omap_hwmod
2246 * @oh: struct omap_hwmod *
2248 * Idles an omap_hwmod @oh. This should be called once the hwmod has
2249 * no further work. Returns -EINVAL if the hwmod is in the wrong
2250 * state or returns 0.
2252 static int _idle(struct omap_hwmod *oh)
2254 pr_debug("omap_hwmod: %s: idling\n", oh->name);
2256 if (oh->_state != _HWMOD_STATE_ENABLED) {
2257 WARN(1, "omap_hwmod: %s: idle state can only be entered from enabled state\n",
2262 if (_are_all_hardreset_lines_asserted(oh))
2265 if (oh->class->sysc)
2267 _del_initiator_dep(oh, mpu_oh);
2269 if (oh->flags & HWMOD_BLOCK_WFI)
2270 cpu_idle_poll_ctrl(false);
2271 if (soc_ops.disable_module)
2272 soc_ops.disable_module(oh);
2275 * The module must be in idle mode before disabling any parents
2276 * clocks. Otherwise, the parent clock might be disabled before
2277 * the module transition is done, and thus will prevent the
2278 * transition to complete properly.
2280 _disable_clocks(oh);
2282 clkdm_hwmod_disable(oh->clkdm, oh);
2284 /* Mux pins for device idle if populated */
2285 if (oh->mux && oh->mux->pads_dynamic) {
2286 omap_hwmod_mux(oh->mux, _HWMOD_STATE_IDLE);
2287 _reconfigure_io_chain();
2290 oh->_state = _HWMOD_STATE_IDLE;
2296 * _shutdown - shutdown an omap_hwmod
2297 * @oh: struct omap_hwmod *
2299 * Shut down an omap_hwmod @oh. This should be called when the driver
2300 * used for the hwmod is removed or unloaded or if the driver is not
2301 * used by the system. Returns -EINVAL if the hwmod is in the wrong
2302 * state or returns 0.
2304 static int _shutdown(struct omap_hwmod *oh)
2309 if (oh->_state != _HWMOD_STATE_IDLE &&
2310 oh->_state != _HWMOD_STATE_ENABLED) {
2311 WARN(1, "omap_hwmod: %s: disabled state can only be entered from idle, or enabled state\n",
2316 if (_are_all_hardreset_lines_asserted(oh))
2319 pr_debug("omap_hwmod: %s: disabling\n", oh->name);
2321 if (oh->class->pre_shutdown) {
2322 prev_state = oh->_state;
2323 if (oh->_state == _HWMOD_STATE_IDLE)
2325 ret = oh->class->pre_shutdown(oh);
2327 if (prev_state == _HWMOD_STATE_IDLE)
2333 if (oh->class->sysc) {
2334 if (oh->_state == _HWMOD_STATE_IDLE)
2339 /* clocks and deps are already disabled in idle */
2340 if (oh->_state == _HWMOD_STATE_ENABLED) {
2341 _del_initiator_dep(oh, mpu_oh);
2342 /* XXX what about the other system initiators here? dma, dsp */
2343 if (oh->flags & HWMOD_BLOCK_WFI)
2344 cpu_idle_poll_ctrl(false);
2345 if (soc_ops.disable_module)
2346 soc_ops.disable_module(oh);
2347 _disable_clocks(oh);
2349 clkdm_hwmod_disable(oh->clkdm, oh);
2351 /* XXX Should this code also force-disable the optional clocks? */
2353 for (i = 0; i < oh->rst_lines_cnt; i++)
2354 _assert_hardreset(oh, oh->rst_lines[i].name);
2356 /* Mux pins to safe mode or use populated off mode values */
2358 omap_hwmod_mux(oh->mux, _HWMOD_STATE_DISABLED);
2360 oh->_state = _HWMOD_STATE_DISABLED;
2366 * of_dev_hwmod_lookup - look up needed hwmod from dt blob
2367 * @np: struct device_node *
2368 * @oh: struct omap_hwmod *
2370 * Parse the dt blob and find out needed hwmod. Recursive function is
2371 * implemented to take care hierarchical dt blob parsing.
2372 * Return: The device node on success or NULL on failure.
2374 static struct device_node *of_dev_hwmod_lookup(struct device_node *np,
2375 struct omap_hwmod *oh)
2377 struct device_node *np0 = NULL, *np1 = NULL;
2380 for_each_child_of_node(np, np0) {
2381 if (of_find_property(np0, "ti,hwmods", NULL)) {
2382 p = of_get_property(np0, "ti,hwmods", NULL);
2383 if (!strcmp(p, oh->name))
2385 np1 = of_dev_hwmod_lookup(np0, oh);
2394 * _init_mpu_rt_base - populate the virtual address for a hwmod
2395 * @oh: struct omap_hwmod * to locate the virtual address
2396 * @data: (unused, caller should pass NULL)
2397 * @np: struct device_node * of the IP block's device node in the DT data
2399 * Cache the virtual address used by the MPU to access this IP block's
2400 * registers. This address is needed early so the OCP registers that
2401 * are part of the device's address space can be ioremapped properly.
2403 * Returns 0 on success, -EINVAL if an invalid hwmod is passed, and
2404 * -ENXIO on absent or invalid register target address space.
2406 static int __init _init_mpu_rt_base(struct omap_hwmod *oh, void *data,
2407 struct device_node *np)
2409 struct omap_hwmod_addr_space *mem;
2410 void __iomem *va_start = NULL;
2415 _save_mpu_port_index(oh);
2417 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2420 mem = _find_mpu_rt_addr_space(oh);
2422 pr_debug("omap_hwmod: %s: no MPU register target found\n",
2425 /* Extract the IO space from device tree blob */
2429 va_start = of_iomap(np, oh->mpu_rt_idx);
2431 va_start = ioremap(mem->pa_start, mem->pa_end - mem->pa_start);
2435 pr_err("omap_hwmod: %s: Could not ioremap\n", oh->name);
2439 pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
2440 oh->name, va_start);
2442 oh->_mpu_rt_va = va_start;
2447 * _init - initialize internal data for the hwmod @oh
2448 * @oh: struct omap_hwmod *
2451 * Look up the clocks and the address space used by the MPU to access
2452 * registers belonging to the hwmod @oh. @oh must already be
2453 * registered at this point. This is the first of two phases for
2454 * hwmod initialization. Code called here does not touch any hardware
2455 * registers, it simply prepares internal data structures. Returns 0
2456 * upon success or if the hwmod isn't registered or if the hwmod's
2457 * address space is not defined, or -EINVAL upon failure.
2459 static int __init _init(struct omap_hwmod *oh, void *data)
2462 struct device_node *np = NULL;
2464 if (oh->_state != _HWMOD_STATE_REGISTERED)
2467 if (of_have_populated_dt())
2468 np = of_dev_hwmod_lookup(of_find_node_by_name(NULL, "ocp"), oh);
2470 if (oh->class->sysc) {
2471 r = _init_mpu_rt_base(oh, NULL, np);
2473 WARN(1, "omap_hwmod: %s: doesn't have mpu register target base\n",
2479 r = _init_clocks(oh, NULL);
2481 WARN(1, "omap_hwmod: %s: couldn't init clocks\n", oh->name);
2486 if (of_find_property(np, "ti,no-reset-on-init", NULL))
2487 oh->flags |= HWMOD_INIT_NO_RESET;
2488 if (of_find_property(np, "ti,no-idle-on-init", NULL))
2489 oh->flags |= HWMOD_INIT_NO_IDLE;
2491 oh->_state = _HWMOD_STATE_INITIALIZED;
2497 * _setup_iclk_autoidle - configure an IP block's interface clocks
2498 * @oh: struct omap_hwmod *
2500 * Set up the module's interface clocks. XXX This function is still mostly
2501 * a stub; implementing this properly requires iclk autoidle usecounting in
2502 * the clock code. No return value.
2504 static void __init _setup_iclk_autoidle(struct omap_hwmod *oh)
2506 struct omap_hwmod_ocp_if *os;
2507 struct list_head *p;
2509 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2512 p = oh->slave_ports.next;
2514 while (i < oh->slaves_cnt) {
2515 os = _fetch_next_ocp_if(&p, &i);
2519 if (os->flags & OCPIF_SWSUP_IDLE) {
2520 /* XXX omap_iclk_deny_idle(c); */
2522 /* XXX omap_iclk_allow_idle(c); */
2523 clk_enable(os->_clk);
2531 * _setup_reset - reset an IP block during the setup process
2532 * @oh: struct omap_hwmod *
2534 * Reset the IP block corresponding to the hwmod @oh during the setup
2535 * process. The IP block is first enabled so it can be successfully
2536 * reset. Returns 0 upon success or a negative error code upon
2539 static int __init _setup_reset(struct omap_hwmod *oh)
2543 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2546 if (oh->flags & HWMOD_EXT_OPT_MAIN_CLK)
2549 if (oh->rst_lines_cnt == 0) {
2552 pr_warning("omap_hwmod: %s: cannot be enabled for reset (%d)\n",
2553 oh->name, oh->_state);
2558 if (!(oh->flags & HWMOD_INIT_NO_RESET))
2565 * _setup_postsetup - transition to the appropriate state after _setup
2566 * @oh: struct omap_hwmod *
2568 * Place an IP block represented by @oh into a "post-setup" state --
2569 * either IDLE, ENABLED, or DISABLED. ("post-setup" simply means that
2570 * this function is called at the end of _setup().) The postsetup
2571 * state for an IP block can be changed by calling
2572 * omap_hwmod_enter_postsetup_state() early in the boot process,
2573 * before one of the omap_hwmod_setup*() functions are called for the
2576 * The IP block stays in this state until a PM runtime-based driver is
2577 * loaded for that IP block. A post-setup state of IDLE is
2578 * appropriate for almost all IP blocks with runtime PM-enabled
2579 * drivers, since those drivers are able to enable the IP block. A
2580 * post-setup state of ENABLED is appropriate for kernels with PM
2581 * runtime disabled. The DISABLED state is appropriate for unusual IP
2582 * blocks such as the MPU WDTIMER on kernels without WDTIMER drivers
2583 * included, since the WDTIMER starts running on reset and will reset
2584 * the MPU if left active.
2586 * This post-setup mechanism is deprecated. Once all of the OMAP
2587 * drivers have been converted to use PM runtime, and all of the IP
2588 * block data and interconnect data is available to the hwmod code, it
2589 * should be possible to replace this mechanism with a "lazy reset"
2590 * arrangement. In a "lazy reset" setup, each IP block is enabled
2591 * when the driver first probes, then all remaining IP blocks without
2592 * drivers are either shut down or enabled after the drivers have
2593 * loaded. However, this cannot take place until the above
2594 * preconditions have been met, since otherwise the late reset code
2595 * has no way of knowing which IP blocks are in use by drivers, and
2596 * which ones are unused.
2600 static void __init _setup_postsetup(struct omap_hwmod *oh)
2604 if (oh->rst_lines_cnt > 0)
2607 postsetup_state = oh->_postsetup_state;
2608 if (postsetup_state == _HWMOD_STATE_UNKNOWN)
2609 postsetup_state = _HWMOD_STATE_ENABLED;
2612 * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
2613 * it should be set by the core code as a runtime flag during startup
2615 if ((oh->flags & HWMOD_INIT_NO_IDLE) &&
2616 (postsetup_state == _HWMOD_STATE_IDLE)) {
2617 oh->_int_flags |= _HWMOD_SKIP_ENABLE;
2618 postsetup_state = _HWMOD_STATE_ENABLED;
2621 if (postsetup_state == _HWMOD_STATE_IDLE)
2623 else if (postsetup_state == _HWMOD_STATE_DISABLED)
2625 else if (postsetup_state != _HWMOD_STATE_ENABLED)
2626 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
2627 oh->name, postsetup_state);
2633 * _setup - prepare IP block hardware for use
2634 * @oh: struct omap_hwmod *
2635 * @n: (unused, pass NULL)
2637 * Configure the IP block represented by @oh. This may include
2638 * enabling the IP block, resetting it, and placing it into a
2639 * post-setup state, depending on the type of IP block and applicable
2640 * flags. IP blocks are reset to prevent any previous configuration
2641 * by the bootloader or previous operating system from interfering
2642 * with power management or other parts of the system. The reset can
2643 * be avoided; see omap_hwmod_no_setup_reset(). This is the second of
2644 * two phases for hwmod initialization. Code called here generally
2645 * affects the IP block hardware, or system integration hardware
2646 * associated with the IP block. Returns 0.
2648 static int __init _setup(struct omap_hwmod *oh, void *data)
2650 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2653 _setup_iclk_autoidle(oh);
2655 if (!_setup_reset(oh))
2656 _setup_postsetup(oh);
2662 * _register - register a struct omap_hwmod
2663 * @oh: struct omap_hwmod *
2665 * Registers the omap_hwmod @oh. Returns -EEXIST if an omap_hwmod
2666 * already has been registered by the same name; -EINVAL if the
2667 * omap_hwmod is in the wrong state, if @oh is NULL, if the
2668 * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
2669 * name, or if the omap_hwmod's class is missing a name; or 0 upon
2672 * XXX The data should be copied into bootmem, so the original data
2673 * should be marked __initdata and freed after init. This would allow
2674 * unneeded omap_hwmods to be freed on multi-OMAP configurations. Note
2675 * that the copy process would be relatively complex due to the large number
2678 static int __init _register(struct omap_hwmod *oh)
2680 if (!oh || !oh->name || !oh->class || !oh->class->name ||
2681 (oh->_state != _HWMOD_STATE_UNKNOWN))
2684 pr_debug("omap_hwmod: %s: registering\n", oh->name);
2686 if (_lookup(oh->name))
2689 list_add_tail(&oh->node, &omap_hwmod_list);
2691 INIT_LIST_HEAD(&oh->master_ports);
2692 INIT_LIST_HEAD(&oh->slave_ports);
2693 spin_lock_init(&oh->_lock);
2695 oh->_state = _HWMOD_STATE_REGISTERED;
2698 * XXX Rather than doing a strcmp(), this should test a flag
2699 * set in the hwmod data, inserted by the autogenerator code.
2701 if (!strcmp(oh->name, MPU_INITIATOR_NAME))
2708 * _alloc_links - return allocated memory for hwmod links
2709 * @ml: pointer to a struct omap_hwmod_link * for the master link
2710 * @sl: pointer to a struct omap_hwmod_link * for the slave link
2712 * Return pointers to two struct omap_hwmod_link records, via the
2713 * addresses pointed to by @ml and @sl. Will first attempt to return
2714 * memory allocated as part of a large initial block, but if that has
2715 * been exhausted, will allocate memory itself. Since ideally this
2716 * second allocation path will never occur, the number of these
2717 * 'supplemental' allocations will be logged when debugging is
2718 * enabled. Returns 0.
2720 static int __init _alloc_links(struct omap_hwmod_link **ml,
2721 struct omap_hwmod_link **sl)
2725 if ((free_ls + LINKS_PER_OCP_IF) <= max_ls) {
2726 *ml = &linkspace[free_ls++];
2727 *sl = &linkspace[free_ls++];
2731 sz = sizeof(struct omap_hwmod_link) * LINKS_PER_OCP_IF;
2734 *ml = alloc_bootmem(sz);
2738 *sl = (void *)(*ml) + sizeof(struct omap_hwmod_link);
2741 pr_debug("omap_hwmod: supplemental link allocations needed: %d\n",
2742 ls_supp * LINKS_PER_OCP_IF);
2748 * _add_link - add an interconnect between two IP blocks
2749 * @oi: pointer to a struct omap_hwmod_ocp_if record
2751 * Add struct omap_hwmod_link records connecting the master IP block
2752 * specified in @oi->master to @oi, and connecting the slave IP block
2753 * specified in @oi->slave to @oi. This code is assumed to run before
2754 * preemption or SMP has been enabled, thus avoiding the need for
2755 * locking in this code. Changes to this assumption will require
2756 * additional locking. Returns 0.
2758 static int __init _add_link(struct omap_hwmod_ocp_if *oi)
2760 struct omap_hwmod_link *ml, *sl;
2762 pr_debug("omap_hwmod: %s -> %s: adding link\n", oi->master->name,
2765 _alloc_links(&ml, &sl);
2768 INIT_LIST_HEAD(&ml->node);
2769 list_add(&ml->node, &oi->master->master_ports);
2770 oi->master->masters_cnt++;
2773 INIT_LIST_HEAD(&sl->node);
2774 list_add(&sl->node, &oi->slave->slave_ports);
2775 oi->slave->slaves_cnt++;
2781 * _register_link - register a struct omap_hwmod_ocp_if
2782 * @oi: struct omap_hwmod_ocp_if *
2784 * Registers the omap_hwmod_ocp_if record @oi. Returns -EEXIST if it
2785 * has already been registered; -EINVAL if @oi is NULL or if the
2786 * record pointed to by @oi is missing required fields; or 0 upon
2789 * XXX The data should be copied into bootmem, so the original data
2790 * should be marked __initdata and freed after init. This would allow
2791 * unneeded omap_hwmods to be freed on multi-OMAP configurations.
2793 static int __init _register_link(struct omap_hwmod_ocp_if *oi)
2795 if (!oi || !oi->master || !oi->slave || !oi->user)
2798 if (oi->_int_flags & _OCPIF_INT_FLAGS_REGISTERED)
2801 pr_debug("omap_hwmod: registering link from %s to %s\n",
2802 oi->master->name, oi->slave->name);
2805 * Register the connected hwmods, if they haven't been
2806 * registered already
2808 if (oi->master->_state != _HWMOD_STATE_REGISTERED)
2809 _register(oi->master);
2811 if (oi->slave->_state != _HWMOD_STATE_REGISTERED)
2812 _register(oi->slave);
2816 oi->_int_flags |= _OCPIF_INT_FLAGS_REGISTERED;
2822 * _alloc_linkspace - allocate large block of hwmod links
2823 * @ois: pointer to an array of struct omap_hwmod_ocp_if records to count
2825 * Allocate a large block of struct omap_hwmod_link records. This
2826 * improves boot time significantly by avoiding the need to allocate
2827 * individual records one by one. If the number of records to
2828 * allocate in the block hasn't been manually specified, this function
2829 * will count the number of struct omap_hwmod_ocp_if records in @ois
2830 * and use that to determine the allocation size. For SoC families
2831 * that require multiple list registrations, such as OMAP3xxx, this
2832 * estimation process isn't optimal, so manual estimation is advised
2833 * in those cases. Returns -EEXIST if the allocation has already occurred
2834 * or 0 upon success.
2836 static int __init _alloc_linkspace(struct omap_hwmod_ocp_if **ois)
2842 WARN(1, "linkspace already allocated\n");
2848 max_ls += LINKS_PER_OCP_IF;
2850 sz = sizeof(struct omap_hwmod_link) * max_ls;
2852 pr_debug("omap_hwmod: %s: allocating %d byte linkspace (%d links)\n",
2853 __func__, sz, max_ls);
2855 linkspace = alloc_bootmem(sz);
2857 memset(linkspace, 0, sz);
2862 /* Static functions intended only for use in soc_ops field function pointers */
2865 * _omap2xxx_wait_target_ready - wait for a module to leave slave idle
2866 * @oh: struct omap_hwmod *
2868 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2869 * does not have an IDLEST bit or if the module successfully leaves
2870 * slave idle; otherwise, pass along the return value of the
2871 * appropriate *_cm*_wait_module_ready() function.
2873 static int _omap2xxx_wait_target_ready(struct omap_hwmod *oh)
2878 if (oh->flags & HWMOD_NO_IDLEST)
2881 if (!_find_mpu_rt_port(oh))
2884 /* XXX check module SIDLEMODE, hardreset status, enabled clocks */
2886 return omap2xxx_cm_wait_module_ready(oh->prcm.omap2.module_offs,
2887 oh->prcm.omap2.idlest_reg_id,
2888 oh->prcm.omap2.idlest_idle_bit);
2892 * _omap3xxx_wait_target_ready - wait for a module to leave slave idle
2893 * @oh: struct omap_hwmod *
2895 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2896 * does not have an IDLEST bit or if the module successfully leaves
2897 * slave idle; otherwise, pass along the return value of the
2898 * appropriate *_cm*_wait_module_ready() function.
2900 static int _omap3xxx_wait_target_ready(struct omap_hwmod *oh)
2905 if (oh->flags & HWMOD_NO_IDLEST)
2908 if (!_find_mpu_rt_port(oh))
2911 /* XXX check module SIDLEMODE, hardreset status, enabled clocks */
2913 return omap3xxx_cm_wait_module_ready(oh->prcm.omap2.module_offs,
2914 oh->prcm.omap2.idlest_reg_id,
2915 oh->prcm.omap2.idlest_idle_bit);
2919 * _omap4_wait_target_ready - wait for a module to leave slave idle
2920 * @oh: struct omap_hwmod *
2922 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2923 * does not have an IDLEST bit or if the module successfully leaves
2924 * slave idle; otherwise, pass along the return value of the
2925 * appropriate *_cm*_wait_module_ready() function.
2927 static int _omap4_wait_target_ready(struct omap_hwmod *oh)
2932 if (oh->flags & HWMOD_NO_IDLEST || !oh->clkdm)
2935 if (!_find_mpu_rt_port(oh))
2938 /* XXX check module SIDLEMODE, hardreset status */
2940 return omap4_cminst_wait_module_ready(oh->clkdm->prcm_partition,
2942 oh->clkdm->clkdm_offs,
2943 oh->prcm.omap4.clkctrl_offs);
2947 * _am33xx_wait_target_ready - wait for a module to leave slave idle
2948 * @oh: struct omap_hwmod *
2950 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2951 * does not have an IDLEST bit or if the module successfully leaves
2952 * slave idle; otherwise, pass along the return value of the
2953 * appropriate *_cm*_wait_module_ready() function.
2955 static int _am33xx_wait_target_ready(struct omap_hwmod *oh)
2957 if (!oh || !oh->clkdm)
2960 if (oh->flags & HWMOD_NO_IDLEST)
2963 if (!_find_mpu_rt_port(oh))
2966 /* XXX check module SIDLEMODE, hardreset status */
2968 return am33xx_cm_wait_module_ready(oh->clkdm->cm_inst,
2969 oh->clkdm->clkdm_offs,
2970 oh->prcm.omap4.clkctrl_offs);
2974 * _omap2_assert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2975 * @oh: struct omap_hwmod * to assert hardreset
2976 * @ohri: hardreset line data
2978 * Call omap2_prm_assert_hardreset() with parameters extracted from
2979 * the hwmod @oh and the hardreset line data @ohri. Only intended for
2980 * use as an soc_ops function pointer. Passes along the return value
2981 * from omap2_prm_assert_hardreset(). XXX This function is scheduled
2982 * for removal when the PRM code is moved into drivers/.
2984 static int _omap2_assert_hardreset(struct omap_hwmod *oh,
2985 struct omap_hwmod_rst_info *ohri)
2987 return omap2_prm_assert_hardreset(oh->prcm.omap2.module_offs,
2992 * _omap2_deassert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2993 * @oh: struct omap_hwmod * to deassert hardreset
2994 * @ohri: hardreset line data
2996 * Call omap2_prm_deassert_hardreset() with parameters extracted from
2997 * the hwmod @oh and the hardreset line data @ohri. Only intended for
2998 * use as an soc_ops function pointer. Passes along the return value
2999 * from omap2_prm_deassert_hardreset(). XXX This function is
3000 * scheduled for removal when the PRM code is moved into drivers/.
3002 static int _omap2_deassert_hardreset(struct omap_hwmod *oh,
3003 struct omap_hwmod_rst_info *ohri)
3005 return omap2_prm_deassert_hardreset(oh->prcm.omap2.module_offs,
3011 * _omap2_is_hardreset_asserted - call OMAP2 PRM hardreset fn with hwmod args
3012 * @oh: struct omap_hwmod * to test hardreset
3013 * @ohri: hardreset line data
3015 * Call omap2_prm_is_hardreset_asserted() with parameters extracted
3016 * from the hwmod @oh and the hardreset line data @ohri. Only
3017 * intended for use as an soc_ops function pointer. Passes along the
3018 * return value from omap2_prm_is_hardreset_asserted(). XXX This
3019 * function is scheduled for removal when the PRM code is moved into
3022 static int _omap2_is_hardreset_asserted(struct omap_hwmod *oh,
3023 struct omap_hwmod_rst_info *ohri)
3025 return omap2_prm_is_hardreset_asserted(oh->prcm.omap2.module_offs,
3030 * _omap4_assert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
3031 * @oh: struct omap_hwmod * to assert hardreset
3032 * @ohri: hardreset line data
3034 * Call omap4_prminst_assert_hardreset() with parameters extracted
3035 * from the hwmod @oh and the hardreset line data @ohri. Only
3036 * intended for use as an soc_ops function pointer. Passes along the
3037 * return value from omap4_prminst_assert_hardreset(). XXX This
3038 * function is scheduled for removal when the PRM code is moved into
3041 static int _omap4_assert_hardreset(struct omap_hwmod *oh,
3042 struct omap_hwmod_rst_info *ohri)
3047 return omap4_prminst_assert_hardreset(ohri->rst_shift,
3048 oh->clkdm->pwrdm.ptr->prcm_partition,
3049 oh->clkdm->pwrdm.ptr->prcm_offs,
3050 oh->prcm.omap4.rstctrl_offs);
3054 * _omap4_deassert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
3055 * @oh: struct omap_hwmod * to deassert hardreset
3056 * @ohri: hardreset line data
3058 * Call omap4_prminst_deassert_hardreset() with parameters extracted
3059 * from the hwmod @oh and the hardreset line data @ohri. Only
3060 * intended for use as an soc_ops function pointer. Passes along the
3061 * return value from omap4_prminst_deassert_hardreset(). XXX This
3062 * function is scheduled for removal when the PRM code is moved into
3065 static int _omap4_deassert_hardreset(struct omap_hwmod *oh,
3066 struct omap_hwmod_rst_info *ohri)
3072 pr_err("omap_hwmod: %s: %s: hwmod data error: OMAP4 does not support st_shift\n",
3073 oh->name, ohri->name);
3074 return omap4_prminst_deassert_hardreset(ohri->rst_shift,
3075 oh->clkdm->pwrdm.ptr->prcm_partition,
3076 oh->clkdm->pwrdm.ptr->prcm_offs,
3077 oh->prcm.omap4.rstctrl_offs);
3081 * _omap4_is_hardreset_asserted - call OMAP4 PRM hardreset fn with hwmod args
3082 * @oh: struct omap_hwmod * to test hardreset
3083 * @ohri: hardreset line data
3085 * Call omap4_prminst_is_hardreset_asserted() with parameters
3086 * extracted from the hwmod @oh and the hardreset line data @ohri.
3087 * Only intended for use as an soc_ops function pointer. Passes along
3088 * the return value from omap4_prminst_is_hardreset_asserted(). XXX
3089 * This function is scheduled for removal when the PRM code is moved
3092 static int _omap4_is_hardreset_asserted(struct omap_hwmod *oh,
3093 struct omap_hwmod_rst_info *ohri)
3098 return omap4_prminst_is_hardreset_asserted(ohri->rst_shift,
3099 oh->clkdm->pwrdm.ptr->prcm_partition,
3100 oh->clkdm->pwrdm.ptr->prcm_offs,
3101 oh->prcm.omap4.rstctrl_offs);
3105 * _am33xx_assert_hardreset - call AM33XX PRM hardreset fn with hwmod args
3106 * @oh: struct omap_hwmod * to assert hardreset
3107 * @ohri: hardreset line data
3109 * Call am33xx_prminst_assert_hardreset() with parameters extracted
3110 * from the hwmod @oh and the hardreset line data @ohri. Only
3111 * intended for use as an soc_ops function pointer. Passes along the
3112 * return value from am33xx_prminst_assert_hardreset(). XXX This
3113 * function is scheduled for removal when the PRM code is moved into
3116 static int _am33xx_assert_hardreset(struct omap_hwmod *oh,
3117 struct omap_hwmod_rst_info *ohri)
3120 return am33xx_prm_assert_hardreset(ohri->rst_shift,
3121 oh->clkdm->pwrdm.ptr->prcm_offs,
3122 oh->prcm.omap4.rstctrl_offs);
3126 * _am33xx_deassert_hardreset - call AM33XX PRM hardreset fn with hwmod args
3127 * @oh: struct omap_hwmod * to deassert hardreset
3128 * @ohri: hardreset line data
3130 * Call am33xx_prminst_deassert_hardreset() with parameters extracted
3131 * from the hwmod @oh and the hardreset line data @ohri. Only
3132 * intended for use as an soc_ops function pointer. Passes along the
3133 * return value from am33xx_prminst_deassert_hardreset(). XXX This
3134 * function is scheduled for removal when the PRM code is moved into
3137 static int _am33xx_deassert_hardreset(struct omap_hwmod *oh,
3138 struct omap_hwmod_rst_info *ohri)
3140 return am33xx_prm_deassert_hardreset(ohri->rst_shift,
3142 oh->clkdm->pwrdm.ptr->prcm_offs,
3143 oh->prcm.omap4.rstctrl_offs,
3144 oh->prcm.omap4.rstst_offs);
3148 * _am33xx_is_hardreset_asserted - call AM33XX PRM hardreset fn with hwmod args
3149 * @oh: struct omap_hwmod * to test hardreset
3150 * @ohri: hardreset line data
3152 * Call am33xx_prminst_is_hardreset_asserted() with parameters
3153 * extracted from the hwmod @oh and the hardreset line data @ohri.
3154 * Only intended for use as an soc_ops function pointer. Passes along
3155 * the return value from am33xx_prminst_is_hardreset_asserted(). XXX
3156 * This function is scheduled for removal when the PRM code is moved
3159 static int _am33xx_is_hardreset_asserted(struct omap_hwmod *oh,
3160 struct omap_hwmod_rst_info *ohri)
3162 return am33xx_prm_is_hardreset_asserted(ohri->rst_shift,
3163 oh->clkdm->pwrdm.ptr->prcm_offs,
3164 oh->prcm.omap4.rstctrl_offs);
3167 /* Public functions */
3169 u32 omap_hwmod_read(struct omap_hwmod *oh, u16 reg_offs)
3171 if (oh->flags & HWMOD_16BIT_REG)
3172 return __raw_readw(oh->_mpu_rt_va + reg_offs);
3174 return __raw_readl(oh->_mpu_rt_va + reg_offs);
3177 void omap_hwmod_write(u32 v, struct omap_hwmod *oh, u16 reg_offs)
3179 if (oh->flags & HWMOD_16BIT_REG)
3180 __raw_writew(v, oh->_mpu_rt_va + reg_offs);
3182 __raw_writel(v, oh->_mpu_rt_va + reg_offs);
3186 * omap_hwmod_softreset - reset a module via SYSCONFIG.SOFTRESET bit
3187 * @oh: struct omap_hwmod *
3189 * This is a public function exposed to drivers. Some drivers may need to do
3190 * some settings before and after resetting the device. Those drivers after
3191 * doing the necessary settings could use this function to start a reset by
3192 * setting the SYSCONFIG.SOFTRESET bit.
3194 int omap_hwmod_softreset(struct omap_hwmod *oh)
3199 if (!oh || !(oh->_sysc_cache))
3202 v = oh->_sysc_cache;
3203 ret = _set_softreset(oh, &v);
3206 _write_sysconfig(v, oh);
3208 ret = _clear_softreset(oh, &v);
3211 _write_sysconfig(v, oh);
3218 * omap_hwmod_lookup - look up a registered omap_hwmod by name
3219 * @name: name of the omap_hwmod to look up
3221 * Given a @name of an omap_hwmod, return a pointer to the registered
3222 * struct omap_hwmod *, or NULL upon error.
3224 struct omap_hwmod *omap_hwmod_lookup(const char *name)
3226 struct omap_hwmod *oh;
3237 * omap_hwmod_for_each - call function for each registered omap_hwmod
3238 * @fn: pointer to a callback function
3239 * @data: void * data to pass to callback function
3241 * Call @fn for each registered omap_hwmod, passing @data to each
3242 * function. @fn must return 0 for success or any other value for
3243 * failure. If @fn returns non-zero, the iteration across omap_hwmods
3244 * will stop and the non-zero return value will be passed to the
3245 * caller of omap_hwmod_for_each(). @fn is called with
3246 * omap_hwmod_for_each() held.
3248 int omap_hwmod_for_each(int (*fn)(struct omap_hwmod *oh, void *data),
3251 struct omap_hwmod *temp_oh;
3257 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
3258 ret = (*fn)(temp_oh, data);
3267 * omap_hwmod_register_links - register an array of hwmod links
3268 * @ois: pointer to an array of omap_hwmod_ocp_if to register
3270 * Intended to be called early in boot before the clock framework is
3271 * initialized. If @ois is not null, will register all omap_hwmods
3272 * listed in @ois that are valid for this chip. Returns -EINVAL if
3273 * omap_hwmod_init() hasn't been called before calling this function,
3274 * -ENOMEM if the link memory area can't be allocated, or 0 upon
3277 int __init omap_hwmod_register_links(struct omap_hwmod_ocp_if **ois)
3288 if (_alloc_linkspace(ois)) {
3289 pr_err("omap_hwmod: could not allocate link space\n");
3296 r = _register_link(ois[i]);
3297 WARN(r && r != -EEXIST,
3298 "omap_hwmod: _register_link(%s -> %s) returned %d\n",
3299 ois[i]->master->name, ois[i]->slave->name, r);
3306 * _ensure_mpu_hwmod_is_setup - ensure the MPU SS hwmod is init'ed and set up
3307 * @oh: pointer to the hwmod currently being set up (usually not the MPU)
3309 * If the hwmod data corresponding to the MPU subsystem IP block
3310 * hasn't been initialized and set up yet, do so now. This must be
3311 * done first since sleep dependencies may be added from other hwmods
3312 * to the MPU. Intended to be called only by omap_hwmod_setup*(). No
3315 static void __init _ensure_mpu_hwmod_is_setup(struct omap_hwmod *oh)
3317 if (!mpu_oh || mpu_oh->_state == _HWMOD_STATE_UNKNOWN)
3318 pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",
3319 __func__, MPU_INITIATOR_NAME);
3320 else if (mpu_oh->_state == _HWMOD_STATE_REGISTERED && oh != mpu_oh)
3321 omap_hwmod_setup_one(MPU_INITIATOR_NAME);
3325 * omap_hwmod_setup_one - set up a single hwmod
3326 * @oh_name: const char * name of the already-registered hwmod to set up
3328 * Initialize and set up a single hwmod. Intended to be used for a
3329 * small number of early devices, such as the timer IP blocks used for
3330 * the scheduler clock. Must be called after omap2_clk_init().
3331 * Resolves the struct clk names to struct clk pointers for each
3332 * registered omap_hwmod. Also calls _setup() on each hwmod. Returns
3333 * -EINVAL upon error or 0 upon success.
3335 int __init omap_hwmod_setup_one(const char *oh_name)
3337 struct omap_hwmod *oh;
3339 pr_debug("omap_hwmod: %s: %s\n", oh_name, __func__);
3341 oh = _lookup(oh_name);
3343 WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name);
3347 _ensure_mpu_hwmod_is_setup(oh);
3356 * omap_hwmod_setup_all - set up all registered IP blocks
3358 * Initialize and set up all IP blocks registered with the hwmod code.
3359 * Must be called after omap2_clk_init(). Resolves the struct clk
3360 * names to struct clk pointers for each registered omap_hwmod. Also
3361 * calls _setup() on each hwmod. Returns 0 upon success.
3363 static int __init omap_hwmod_setup_all(void)
3365 _ensure_mpu_hwmod_is_setup(NULL);
3367 omap_hwmod_for_each(_init, NULL);
3368 omap_hwmod_for_each(_setup, NULL);
3372 omap_core_initcall(omap_hwmod_setup_all);
3375 * omap_hwmod_enable - enable an omap_hwmod
3376 * @oh: struct omap_hwmod *
3378 * Enable an omap_hwmod @oh. Intended to be called by omap_device_enable().
3379 * Returns -EINVAL on error or passes along the return value from _enable().
3381 int omap_hwmod_enable(struct omap_hwmod *oh)
3384 unsigned long flags;
3389 spin_lock_irqsave(&oh->_lock, flags);
3391 spin_unlock_irqrestore(&oh->_lock, flags);
3397 * omap_hwmod_idle - idle an omap_hwmod
3398 * @oh: struct omap_hwmod *
3400 * Idle an omap_hwmod @oh. Intended to be called by omap_device_idle().
3401 * Returns -EINVAL on error or passes along the return value from _idle().
3403 int omap_hwmod_idle(struct omap_hwmod *oh)
3405 unsigned long flags;
3410 spin_lock_irqsave(&oh->_lock, flags);
3412 spin_unlock_irqrestore(&oh->_lock, flags);
3418 * omap_hwmod_shutdown - shutdown an omap_hwmod
3419 * @oh: struct omap_hwmod *
3421 * Shutdown an omap_hwmod @oh. Intended to be called by
3422 * omap_device_shutdown(). Returns -EINVAL on error or passes along
3423 * the return value from _shutdown().
3425 int omap_hwmod_shutdown(struct omap_hwmod *oh)
3427 unsigned long flags;
3432 spin_lock_irqsave(&oh->_lock, flags);
3434 spin_unlock_irqrestore(&oh->_lock, flags);
3440 * omap_hwmod_enable_clocks - enable main_clk, all interface clocks
3441 * @oh: struct omap_hwmod *oh
3443 * Intended to be called by the omap_device code.
3445 int omap_hwmod_enable_clocks(struct omap_hwmod *oh)
3447 unsigned long flags;
3449 spin_lock_irqsave(&oh->_lock, flags);
3451 spin_unlock_irqrestore(&oh->_lock, flags);
3457 * omap_hwmod_disable_clocks - disable main_clk, all interface clocks
3458 * @oh: struct omap_hwmod *oh
3460 * Intended to be called by the omap_device code.
3462 int omap_hwmod_disable_clocks(struct omap_hwmod *oh)
3464 unsigned long flags;
3466 spin_lock_irqsave(&oh->_lock, flags);
3467 _disable_clocks(oh);
3468 spin_unlock_irqrestore(&oh->_lock, flags);
3474 * omap_hwmod_ocp_barrier - wait for posted writes against the hwmod to complete
3475 * @oh: struct omap_hwmod *oh
3477 * Intended to be called by drivers and core code when all posted
3478 * writes to a device must complete before continuing further
3479 * execution (for example, after clearing some device IRQSTATUS
3482 * XXX what about targets with multiple OCP threads?
3484 void omap_hwmod_ocp_barrier(struct omap_hwmod *oh)
3488 if (!oh->class->sysc || !oh->class->sysc->sysc_flags) {
3489 WARN(1, "omap_device: %s: OCP barrier impossible due to device configuration\n",
3495 * Forces posted writes to complete on the OCP thread handling
3498 omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
3502 * omap_hwmod_reset - reset the hwmod
3503 * @oh: struct omap_hwmod *
3505 * Under some conditions, a driver may wish to reset the entire device.
3506 * Called from omap_device code. Returns -EINVAL on error or passes along
3507 * the return value from _reset().
3509 int omap_hwmod_reset(struct omap_hwmod *oh)
3512 unsigned long flags;
3517 spin_lock_irqsave(&oh->_lock, flags);
3519 spin_unlock_irqrestore(&oh->_lock, flags);
3525 * IP block data retrieval functions
3529 * omap_hwmod_count_resources - count number of struct resources needed by hwmod
3530 * @oh: struct omap_hwmod *
3531 * @flags: Type of resources to include when counting (IRQ/DMA/MEM)
3533 * Count the number of struct resource array elements necessary to
3534 * contain omap_hwmod @oh resources. Intended to be called by code
3535 * that registers omap_devices. Intended to be used to determine the
3536 * size of a dynamically-allocated struct resource array, before
3537 * calling omap_hwmod_fill_resources(). Returns the number of struct
3538 * resource array elements needed.
3540 * XXX This code is not optimized. It could attempt to merge adjacent
3544 int omap_hwmod_count_resources(struct omap_hwmod *oh, unsigned long flags)
3548 if (flags & IORESOURCE_IRQ)
3549 ret += _count_mpu_irqs(oh);
3551 if (flags & IORESOURCE_DMA)
3552 ret += _count_sdma_reqs(oh);
3554 if (flags & IORESOURCE_MEM) {
3556 struct omap_hwmod_ocp_if *os;
3557 struct list_head *p = oh->slave_ports.next;
3559 while (i < oh->slaves_cnt) {
3560 os = _fetch_next_ocp_if(&p, &i);
3561 ret += _count_ocp_if_addr_spaces(os);
3569 * omap_hwmod_fill_resources - fill struct resource array with hwmod data
3570 * @oh: struct omap_hwmod *
3571 * @res: pointer to the first element of an array of struct resource to fill
3573 * Fill the struct resource array @res with resource data from the
3574 * omap_hwmod @oh. Intended to be called by code that registers
3575 * omap_devices. See also omap_hwmod_count_resources(). Returns the
3576 * number of array elements filled.
3578 int omap_hwmod_fill_resources(struct omap_hwmod *oh, struct resource *res)
3580 struct omap_hwmod_ocp_if *os;
3581 struct list_head *p;
3582 int i, j, mpu_irqs_cnt, sdma_reqs_cnt, addr_cnt;
3585 /* For each IRQ, DMA, memory area, fill in array.*/
3587 mpu_irqs_cnt = _count_mpu_irqs(oh);
3588 for (i = 0; i < mpu_irqs_cnt; i++) {
3589 (res + r)->name = (oh->mpu_irqs + i)->name;
3590 (res + r)->start = (oh->mpu_irqs + i)->irq;
3591 (res + r)->end = (oh->mpu_irqs + i)->irq;
3592 (res + r)->flags = IORESOURCE_IRQ;
3596 sdma_reqs_cnt = _count_sdma_reqs(oh);
3597 for (i = 0; i < sdma_reqs_cnt; i++) {
3598 (res + r)->name = (oh->sdma_reqs + i)->name;
3599 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
3600 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
3601 (res + r)->flags = IORESOURCE_DMA;
3605 p = oh->slave_ports.next;
3608 while (i < oh->slaves_cnt) {
3609 os = _fetch_next_ocp_if(&p, &i);
3610 addr_cnt = _count_ocp_if_addr_spaces(os);
3612 for (j = 0; j < addr_cnt; j++) {
3613 (res + r)->name = (os->addr + j)->name;
3614 (res + r)->start = (os->addr + j)->pa_start;
3615 (res + r)->end = (os->addr + j)->pa_end;
3616 (res + r)->flags = IORESOURCE_MEM;
3625 * omap_hwmod_fill_dma_resources - fill struct resource array with dma data
3626 * @oh: struct omap_hwmod *
3627 * @res: pointer to the array of struct resource to fill
3629 * Fill the struct resource array @res with dma resource data from the
3630 * omap_hwmod @oh. Intended to be called by code that registers
3631 * omap_devices. See also omap_hwmod_count_resources(). Returns the
3632 * number of array elements filled.
3634 int omap_hwmod_fill_dma_resources(struct omap_hwmod *oh, struct resource *res)
3636 int i, sdma_reqs_cnt;
3639 sdma_reqs_cnt = _count_sdma_reqs(oh);
3640 for (i = 0; i < sdma_reqs_cnt; i++) {
3641 (res + r)->name = (oh->sdma_reqs + i)->name;
3642 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
3643 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
3644 (res + r)->flags = IORESOURCE_DMA;
3652 * omap_hwmod_get_resource_byname - fetch IP block integration data by name
3653 * @oh: struct omap_hwmod * to operate on
3654 * @type: one of the IORESOURCE_* constants from include/linux/ioport.h
3655 * @name: pointer to the name of the data to fetch (optional)
3656 * @rsrc: pointer to a struct resource, allocated by the caller
3658 * Retrieve MPU IRQ, SDMA request line, or address space start/end
3659 * data for the IP block pointed to by @oh. The data will be filled
3660 * into a struct resource record pointed to by @rsrc. The struct
3661 * resource must be allocated by the caller. When @name is non-null,
3662 * the data associated with the matching entry in the IRQ/SDMA/address
3663 * space hwmod data arrays will be returned. If @name is null, the
3664 * first array entry will be returned. Data order is not meaningful
3665 * in hwmod data, so callers are strongly encouraged to use a non-null
3666 * @name whenever possible to avoid unpredictable effects if hwmod
3667 * data is later added that causes data ordering to change. This
3668 * function is only intended for use by OMAP core code. Device
3669 * drivers should not call this function - the appropriate bus-related
3670 * data accessor functions should be used instead. Returns 0 upon
3671 * success or a negative error code upon error.
3673 int omap_hwmod_get_resource_byname(struct omap_hwmod *oh, unsigned int type,
3674 const char *name, struct resource *rsrc)
3677 unsigned int irq, dma;
3678 u32 pa_start, pa_end;
3683 if (type == IORESOURCE_IRQ) {
3684 r = _get_mpu_irq_by_name(oh, name, &irq);
3690 } else if (type == IORESOURCE_DMA) {
3691 r = _get_sdma_req_by_name(oh, name, &dma);
3697 } else if (type == IORESOURCE_MEM) {
3698 r = _get_addr_space_by_name(oh, name, &pa_start, &pa_end);
3702 rsrc->start = pa_start;
3715 * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
3716 * @oh: struct omap_hwmod *
3718 * Return the powerdomain pointer associated with the OMAP module
3719 * @oh's main clock. If @oh does not have a main clk, return the
3720 * powerdomain associated with the interface clock associated with the
3721 * module's MPU port. (XXX Perhaps this should use the SDMA port
3722 * instead?) Returns NULL on error, or a struct powerdomain * on
3725 struct powerdomain *omap_hwmod_get_pwrdm(struct omap_hwmod *oh)
3728 struct omap_hwmod_ocp_if *oi;
3729 struct clockdomain *clkdm;
3730 struct clk_hw_omap *clk;
3736 return oh->clkdm->pwrdm.ptr;
3741 oi = _find_mpu_rt_port(oh);
3747 clk = to_clk_hw_omap(__clk_get_hw(c));
3752 return clkdm->pwrdm.ptr;
3756 * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
3757 * @oh: struct omap_hwmod *
3759 * Returns the virtual address corresponding to the beginning of the
3760 * module's register target, in the address range that is intended to
3761 * be used by the MPU. Returns the virtual address upon success or NULL
3764 void __iomem *omap_hwmod_get_mpu_rt_va(struct omap_hwmod *oh)
3769 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
3772 if (oh->_state == _HWMOD_STATE_UNKNOWN)
3775 return oh->_mpu_rt_va;
3779 * omap_hwmod_add_initiator_dep - add sleepdep from @init_oh to @oh
3780 * @oh: struct omap_hwmod *
3781 * @init_oh: struct omap_hwmod * (initiator)
3783 * Add a sleep dependency between the initiator @init_oh and @oh.
3784 * Intended to be called by DSP/Bridge code via platform_data for the
3785 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
3786 * code needs to add/del initiator dependencies dynamically
3787 * before/after accessing a device. Returns the return value from
3788 * _add_initiator_dep().
3790 * XXX Keep a usecount in the clockdomain code
3792 int omap_hwmod_add_initiator_dep(struct omap_hwmod *oh,
3793 struct omap_hwmod *init_oh)
3795 return _add_initiator_dep(oh, init_oh);
3799 * XXX what about functions for drivers to save/restore ocp_sysconfig
3800 * for context save/restore operations?
3804 * omap_hwmod_del_initiator_dep - remove sleepdep from @init_oh to @oh
3805 * @oh: struct omap_hwmod *
3806 * @init_oh: struct omap_hwmod * (initiator)
3808 * Remove a sleep dependency between the initiator @init_oh and @oh.
3809 * Intended to be called by DSP/Bridge code via platform_data for the
3810 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
3811 * code needs to add/del initiator dependencies dynamically
3812 * before/after accessing a device. Returns the return value from
3813 * _del_initiator_dep().
3815 * XXX Keep a usecount in the clockdomain code
3817 int omap_hwmod_del_initiator_dep(struct omap_hwmod *oh,
3818 struct omap_hwmod *init_oh)
3820 return _del_initiator_dep(oh, init_oh);
3824 * omap_hwmod_enable_wakeup - allow device to wake up the system
3825 * @oh: struct omap_hwmod *
3827 * Sets the module OCP socket ENAWAKEUP bit to allow the module to
3828 * send wakeups to the PRCM, and enable I/O ring wakeup events for
3829 * this IP block if it has dynamic mux entries. Eventually this
3830 * should set PRCM wakeup registers to cause the PRCM to receive
3831 * wakeup events from the module. Does not set any wakeup routing
3832 * registers beyond this point - if the module is to wake up any other
3833 * module or subsystem, that must be set separately. Called by
3834 * omap_device code. Returns -EINVAL on error or 0 upon success.
3836 int omap_hwmod_enable_wakeup(struct omap_hwmod *oh)
3838 unsigned long flags;
3841 spin_lock_irqsave(&oh->_lock, flags);
3843 if (oh->class->sysc &&
3844 (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)) {
3845 v = oh->_sysc_cache;
3846 _enable_wakeup(oh, &v);
3847 _write_sysconfig(v, oh);
3850 _set_idle_ioring_wakeup(oh, true);
3851 spin_unlock_irqrestore(&oh->_lock, flags);
3857 * omap_hwmod_disable_wakeup - prevent device from waking the system
3858 * @oh: struct omap_hwmod *
3860 * Clears the module OCP socket ENAWAKEUP bit to prevent the module
3861 * from sending wakeups to the PRCM, and disable I/O ring wakeup
3862 * events for this IP block if it has dynamic mux entries. Eventually
3863 * this should clear PRCM wakeup registers to cause the PRCM to ignore
3864 * wakeup events from the module. Does not set any wakeup routing
3865 * registers beyond this point - if the module is to wake up any other
3866 * module or subsystem, that must be set separately. Called by
3867 * omap_device code. Returns -EINVAL on error or 0 upon success.
3869 int omap_hwmod_disable_wakeup(struct omap_hwmod *oh)
3871 unsigned long flags;
3874 spin_lock_irqsave(&oh->_lock, flags);
3876 if (oh->class->sysc &&
3877 (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)) {
3878 v = oh->_sysc_cache;
3879 _disable_wakeup(oh, &v);
3880 _write_sysconfig(v, oh);
3883 _set_idle_ioring_wakeup(oh, false);
3884 spin_unlock_irqrestore(&oh->_lock, flags);
3890 * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
3891 * contained in the hwmod module.
3892 * @oh: struct omap_hwmod *
3893 * @name: name of the reset line to lookup and assert
3895 * Some IP like dsp, ipu or iva contain processor that require
3896 * an HW reset line to be assert / deassert in order to enable fully
3897 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3898 * yet supported on this OMAP; otherwise, passes along the return value
3899 * from _assert_hardreset().
3901 int omap_hwmod_assert_hardreset(struct omap_hwmod *oh, const char *name)
3904 unsigned long flags;
3909 spin_lock_irqsave(&oh->_lock, flags);
3910 ret = _assert_hardreset(oh, name);
3911 spin_unlock_irqrestore(&oh->_lock, flags);
3917 * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
3918 * contained in the hwmod module.
3919 * @oh: struct omap_hwmod *
3920 * @name: name of the reset line to look up and deassert
3922 * Some IP like dsp, ipu or iva contain processor that require
3923 * an HW reset line to be assert / deassert in order to enable fully
3924 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3925 * yet supported on this OMAP; otherwise, passes along the return value
3926 * from _deassert_hardreset().
3928 int omap_hwmod_deassert_hardreset(struct omap_hwmod *oh, const char *name)
3931 unsigned long flags;
3936 spin_lock_irqsave(&oh->_lock, flags);
3937 ret = _deassert_hardreset(oh, name);
3938 spin_unlock_irqrestore(&oh->_lock, flags);
3944 * omap_hwmod_read_hardreset - read the HW reset line state of submodules
3945 * contained in the hwmod module
3946 * @oh: struct omap_hwmod *
3947 * @name: name of the reset line to look up and read
3949 * Return the current state of the hwmod @oh's reset line named @name:
3950 * returns -EINVAL upon parameter error or if this operation
3951 * is unsupported on the current OMAP; otherwise, passes along the return
3952 * value from _read_hardreset().
3954 int omap_hwmod_read_hardreset(struct omap_hwmod *oh, const char *name)
3957 unsigned long flags;
3962 spin_lock_irqsave(&oh->_lock, flags);
3963 ret = _read_hardreset(oh, name);
3964 spin_unlock_irqrestore(&oh->_lock, flags);
3971 * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
3972 * @classname: struct omap_hwmod_class name to search for
3973 * @fn: callback function pointer to call for each hwmod in class @classname
3974 * @user: arbitrary context data to pass to the callback function
3976 * For each omap_hwmod of class @classname, call @fn.
3977 * If the callback function returns something other than
3978 * zero, the iterator is terminated, and the callback function's return
3979 * value is passed back to the caller. Returns 0 upon success, -EINVAL
3980 * if @classname or @fn are NULL, or passes back the error code from @fn.
3982 int omap_hwmod_for_each_by_class(const char *classname,
3983 int (*fn)(struct omap_hwmod *oh,
3987 struct omap_hwmod *temp_oh;
3990 if (!classname || !fn)
3993 pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
3994 __func__, classname);
3996 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
3997 if (!strcmp(temp_oh->class->name, classname)) {
3998 pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
3999 __func__, temp_oh->name);
4000 ret = (*fn)(temp_oh, user);
4007 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
4014 * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
4015 * @oh: struct omap_hwmod *
4016 * @state: state that _setup() should leave the hwmod in
4018 * Sets the hwmod state that @oh will enter at the end of _setup()
4019 * (called by omap_hwmod_setup_*()). See also the documentation
4020 * for _setup_postsetup(), above. Returns 0 upon success or
4021 * -EINVAL if there is a problem with the arguments or if the hwmod is
4022 * in the wrong state.
4024 int omap_hwmod_set_postsetup_state(struct omap_hwmod *oh, u8 state)
4027 unsigned long flags;
4032 if (state != _HWMOD_STATE_DISABLED &&
4033 state != _HWMOD_STATE_ENABLED &&
4034 state != _HWMOD_STATE_IDLE)
4037 spin_lock_irqsave(&oh->_lock, flags);
4039 if (oh->_state != _HWMOD_STATE_REGISTERED) {
4044 oh->_postsetup_state = state;
4048 spin_unlock_irqrestore(&oh->_lock, flags);
4054 * omap_hwmod_get_context_loss_count - get lost context count
4055 * @oh: struct omap_hwmod *
4057 * Returns the context loss count of associated @oh
4058 * upon success, or zero if no context loss data is available.
4060 * On OMAP4, this queries the per-hwmod context loss register,
4061 * assuming one exists. If not, or on OMAP2/3, this queries the
4062 * enclosing powerdomain context loss count.
4064 int omap_hwmod_get_context_loss_count(struct omap_hwmod *oh)
4066 struct powerdomain *pwrdm;
4069 if (soc_ops.get_context_lost)
4070 return soc_ops.get_context_lost(oh);
4072 pwrdm = omap_hwmod_get_pwrdm(oh);
4074 ret = pwrdm_get_context_loss_count(pwrdm);
4080 * omap_hwmod_no_setup_reset - prevent a hwmod from being reset upon setup
4081 * @oh: struct omap_hwmod *
4083 * Prevent the hwmod @oh from being reset during the setup process.
4084 * Intended for use by board-*.c files on boards with devices that
4085 * cannot tolerate being reset. Must be called before the hwmod has
4086 * been set up. Returns 0 upon success or negative error code upon
4089 int omap_hwmod_no_setup_reset(struct omap_hwmod *oh)
4094 if (oh->_state != _HWMOD_STATE_REGISTERED) {
4095 pr_err("omap_hwmod: %s: cannot prevent setup reset; in wrong state\n",
4100 oh->flags |= HWMOD_INIT_NO_RESET;
4106 * omap_hwmod_pad_route_irq - route an I/O pad wakeup to a particular MPU IRQ
4107 * @oh: struct omap_hwmod * containing hwmod mux entries
4108 * @pad_idx: array index in oh->mux of the hwmod mux entry to route wakeup
4109 * @irq_idx: the hwmod mpu_irqs array index of the IRQ to trigger on wakeup
4111 * When an I/O pad wakeup arrives for the dynamic or wakeup hwmod mux
4112 * entry number @pad_idx for the hwmod @oh, trigger the interrupt
4113 * service routine for the hwmod's mpu_irqs array index @irq_idx. If
4114 * this function is not called for a given pad_idx, then the ISR
4115 * associated with @oh's first MPU IRQ will be triggered when an I/O
4116 * pad wakeup occurs on that pad. Note that @pad_idx is the index of
4117 * the _dynamic or wakeup_ entry: if there are other entries not
4118 * marked with OMAP_DEVICE_PAD_WAKEUP or OMAP_DEVICE_PAD_REMUX, these
4119 * entries are NOT COUNTED in the dynamic pad index. This function
4120 * must be called separately for each pad that requires its interrupt
4121 * to be re-routed this way. Returns -EINVAL if there is an argument
4122 * problem or if @oh does not have hwmod mux entries or MPU IRQs;
4123 * returns -ENOMEM if memory cannot be allocated; or 0 upon success.
4125 * XXX This function interface is fragile. Rather than using array
4126 * indexes, which are subject to unpredictable change, it should be
4127 * using hwmod IRQ names, and some other stable key for the hwmod mux
4130 int omap_hwmod_pad_route_irq(struct omap_hwmod *oh, int pad_idx, int irq_idx)
4136 if (!oh || !oh->mux || !oh->mpu_irqs || pad_idx < 0 ||
4137 pad_idx >= oh->mux->nr_pads_dynamic)
4140 /* Check the number of available mpu_irqs */
4141 for (nr_irqs = 0; oh->mpu_irqs[nr_irqs].irq >= 0; nr_irqs++)
4144 if (irq_idx >= nr_irqs)
4147 if (!oh->mux->irqs) {
4148 /* XXX What frees this? */
4149 oh->mux->irqs = kzalloc(sizeof(int) * oh->mux->nr_pads_dynamic,
4154 oh->mux->irqs[pad_idx] = irq_idx;
4160 * omap_hwmod_init - initialize the hwmod code
4162 * Sets up some function pointers needed by the hwmod code to operate on the
4163 * currently-booted SoC. Intended to be called once during kernel init
4164 * before any hwmods are registered. No return value.
4166 void __init omap_hwmod_init(void)
4168 if (cpu_is_omap24xx()) {
4169 soc_ops.wait_target_ready = _omap2xxx_wait_target_ready;
4170 soc_ops.assert_hardreset = _omap2_assert_hardreset;
4171 soc_ops.deassert_hardreset = _omap2_deassert_hardreset;
4172 soc_ops.is_hardreset_asserted = _omap2_is_hardreset_asserted;
4173 } else if (cpu_is_omap34xx()) {
4174 soc_ops.wait_target_ready = _omap3xxx_wait_target_ready;
4175 soc_ops.assert_hardreset = _omap2_assert_hardreset;
4176 soc_ops.deassert_hardreset = _omap2_deassert_hardreset;
4177 soc_ops.is_hardreset_asserted = _omap2_is_hardreset_asserted;
4178 } else if (cpu_is_omap44xx() || soc_is_omap54xx() || soc_is_dra7xx()) {
4179 soc_ops.enable_module = _omap4_enable_module;
4180 soc_ops.disable_module = _omap4_disable_module;
4181 soc_ops.wait_target_ready = _omap4_wait_target_ready;
4182 soc_ops.assert_hardreset = _omap4_assert_hardreset;
4183 soc_ops.deassert_hardreset = _omap4_deassert_hardreset;
4184 soc_ops.is_hardreset_asserted = _omap4_is_hardreset_asserted;
4185 soc_ops.init_clkdm = _init_clkdm;
4186 soc_ops.update_context_lost = _omap4_update_context_lost;
4187 soc_ops.get_context_lost = _omap4_get_context_lost;
4188 } else if (soc_is_am43xx()) {
4189 soc_ops.enable_module = _omap4_enable_module;
4190 soc_ops.disable_module = _omap4_disable_module;
4191 soc_ops.wait_target_ready = _omap4_wait_target_ready;
4192 soc_ops.assert_hardreset = _omap4_assert_hardreset;
4193 soc_ops.deassert_hardreset = _omap4_deassert_hardreset;
4194 soc_ops.is_hardreset_asserted = _omap4_is_hardreset_asserted;
4195 soc_ops.init_clkdm = _init_clkdm;
4196 } else if (soc_is_am33xx()) {
4197 soc_ops.enable_module = _am33xx_enable_module;
4198 soc_ops.disable_module = _am33xx_disable_module;
4199 soc_ops.wait_target_ready = _am33xx_wait_target_ready;
4200 soc_ops.assert_hardreset = _am33xx_assert_hardreset;
4201 soc_ops.deassert_hardreset = _am33xx_deassert_hardreset;
4202 soc_ops.is_hardreset_asserted = _am33xx_is_hardreset_asserted;
4203 soc_ops.init_clkdm = _init_clkdm;
4205 WARN(1, "omap_hwmod: unknown SoC type\n");
4212 * omap_hwmod_get_main_clk - get pointer to main clock name
4213 * @oh: struct omap_hwmod *
4215 * Returns the main clock name assocated with @oh upon success,
4216 * or NULL if @oh is NULL.
4218 const char *omap_hwmod_get_main_clk(struct omap_hwmod *oh)
4223 return oh->main_clk;