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 _write_sysconfig(v, oh);
1441 * Set the autoidle bit only after setting the smartidle bit
1442 * Setting this will not have any impact on the other modules.
1444 if (sf & SYSC_HAS_AUTOIDLE) {
1445 idlemode = (oh->flags & HWMOD_NO_OCP_AUTOIDLE) ?
1447 _set_module_autoidle(oh, idlemode, &v);
1448 _write_sysconfig(v, oh);
1453 * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
1454 * @oh: struct omap_hwmod *
1456 * If module is marked as SWSUP_SIDLE, force the module into slave
1457 * idle; otherwise, configure it for smart-idle. If module is marked
1458 * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
1459 * configure it for smart-standby. No return value.
1461 static void _idle_sysc(struct omap_hwmod *oh)
1466 if (!oh->class->sysc)
1469 v = oh->_sysc_cache;
1470 sf = oh->class->sysc->sysc_flags;
1472 if (sf & SYSC_HAS_SIDLEMODE) {
1473 if (oh->flags & HWMOD_SWSUP_SIDLE) {
1474 idlemode = HWMOD_IDLEMODE_FORCE;
1476 if (sf & SYSC_HAS_ENAWAKEUP)
1477 _enable_wakeup(oh, &v);
1478 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
1479 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1481 idlemode = HWMOD_IDLEMODE_SMART;
1483 _set_slave_idlemode(oh, idlemode, &v);
1486 if (sf & SYSC_HAS_MIDLEMODE) {
1487 if ((oh->flags & HWMOD_SWSUP_MSTANDBY) ||
1488 (oh->flags & HWMOD_FORCE_MSTANDBY)) {
1489 idlemode = HWMOD_IDLEMODE_FORCE;
1491 if (sf & SYSC_HAS_ENAWAKEUP)
1492 _enable_wakeup(oh, &v);
1493 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1494 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1496 idlemode = HWMOD_IDLEMODE_SMART;
1498 _set_master_standbymode(oh, idlemode, &v);
1501 _write_sysconfig(v, oh);
1505 * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
1506 * @oh: struct omap_hwmod *
1508 * Force the module into slave idle and master suspend. No return
1511 static void _shutdown_sysc(struct omap_hwmod *oh)
1516 if (!oh->class->sysc)
1519 v = oh->_sysc_cache;
1520 sf = oh->class->sysc->sysc_flags;
1522 if (sf & SYSC_HAS_SIDLEMODE)
1523 _set_slave_idlemode(oh, HWMOD_IDLEMODE_FORCE, &v);
1525 if (sf & SYSC_HAS_MIDLEMODE)
1526 _set_master_standbymode(oh, HWMOD_IDLEMODE_FORCE, &v);
1528 if (sf & SYSC_HAS_AUTOIDLE)
1529 _set_module_autoidle(oh, 1, &v);
1531 _write_sysconfig(v, oh);
1535 * _lookup - find an omap_hwmod by name
1536 * @name: find an omap_hwmod by name
1538 * Return a pointer to an omap_hwmod by name, or NULL if not found.
1540 static struct omap_hwmod *_lookup(const char *name)
1542 struct omap_hwmod *oh, *temp_oh;
1546 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1547 if (!strcmp(name, temp_oh->name)) {
1557 * _init_clkdm - look up a clockdomain name, store pointer in omap_hwmod
1558 * @oh: struct omap_hwmod *
1560 * Convert a clockdomain name stored in a struct omap_hwmod into a
1561 * clockdomain pointer, and save it into the struct omap_hwmod.
1562 * Return -EINVAL if the clkdm_name lookup failed.
1564 static int _init_clkdm(struct omap_hwmod *oh)
1566 if (!oh->clkdm_name) {
1567 pr_debug("omap_hwmod: %s: missing clockdomain\n", oh->name);
1571 oh->clkdm = clkdm_lookup(oh->clkdm_name);
1573 pr_warning("omap_hwmod: %s: could not associate to clkdm %s\n",
1574 oh->name, oh->clkdm_name);
1578 pr_debug("omap_hwmod: %s: associated to clkdm %s\n",
1579 oh->name, oh->clkdm_name);
1585 * _init_clocks - clk_get() all clocks associated with this hwmod. Retrieve as
1586 * well the clockdomain.
1587 * @oh: struct omap_hwmod *
1588 * @data: not used; pass NULL
1590 * Called by omap_hwmod_setup_*() (after omap2_clk_init()).
1591 * Resolves all clock names embedded in the hwmod. Returns 0 on
1592 * success, or a negative error code on failure.
1594 static int _init_clocks(struct omap_hwmod *oh, void *data)
1598 if (oh->_state != _HWMOD_STATE_REGISTERED)
1601 pr_debug("omap_hwmod: %s: looking up clocks\n", oh->name);
1603 if (soc_ops.init_clkdm)
1604 ret |= soc_ops.init_clkdm(oh);
1606 ret |= _init_main_clk(oh);
1607 ret |= _init_interface_clks(oh);
1608 ret |= _init_opt_clks(oh);
1611 oh->_state = _HWMOD_STATE_CLKS_INITED;
1613 pr_warning("omap_hwmod: %s: cannot _init_clocks\n", oh->name);
1619 * _lookup_hardreset - fill register bit info for this hwmod/reset line
1620 * @oh: struct omap_hwmod *
1621 * @name: name of the reset line in the context of this hwmod
1622 * @ohri: struct omap_hwmod_rst_info * that this function will fill in
1624 * Return the bit position of the reset line that match the
1625 * input name. Return -ENOENT if not found.
1627 static int _lookup_hardreset(struct omap_hwmod *oh, const char *name,
1628 struct omap_hwmod_rst_info *ohri)
1632 for (i = 0; i < oh->rst_lines_cnt; i++) {
1633 const char *rst_line = oh->rst_lines[i].name;
1634 if (!strcmp(rst_line, name)) {
1635 ohri->rst_shift = oh->rst_lines[i].rst_shift;
1636 ohri->st_shift = oh->rst_lines[i].st_shift;
1637 pr_debug("omap_hwmod: %s: %s: %s: rst %d st %d\n",
1638 oh->name, __func__, rst_line, ohri->rst_shift,
1649 * _assert_hardreset - assert the HW reset line of submodules
1650 * contained in the hwmod module.
1651 * @oh: struct omap_hwmod *
1652 * @name: name of the reset line to lookup and assert
1654 * Some IP like dsp, ipu or iva contain processor that require an HW
1655 * reset line to be assert / deassert in order to enable fully the IP.
1656 * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1657 * asserting the hardreset line on the currently-booted SoC, or passes
1658 * along the return value from _lookup_hardreset() or the SoC's
1659 * assert_hardreset code.
1661 static int _assert_hardreset(struct omap_hwmod *oh, const char *name)
1663 struct omap_hwmod_rst_info ohri;
1669 if (!soc_ops.assert_hardreset)
1672 ret = _lookup_hardreset(oh, name, &ohri);
1676 ret = soc_ops.assert_hardreset(oh, &ohri);
1682 * _deassert_hardreset - deassert the HW reset line of submodules contained
1683 * in the hwmod module.
1684 * @oh: struct omap_hwmod *
1685 * @name: name of the reset line to look up and deassert
1687 * Some IP like dsp, ipu or iva contain processor that require an HW
1688 * reset line to be assert / deassert in order to enable fully the IP.
1689 * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1690 * deasserting the hardreset line on the currently-booted SoC, or passes
1691 * along the return value from _lookup_hardreset() or the SoC's
1692 * deassert_hardreset code.
1694 static int _deassert_hardreset(struct omap_hwmod *oh, const char *name)
1696 struct omap_hwmod_rst_info ohri;
1703 if (!soc_ops.deassert_hardreset)
1706 ret = _lookup_hardreset(oh, name, &ohri);
1712 * A clockdomain must be in SW_SUP otherwise reset
1713 * might not be completed. The clockdomain can be set
1714 * in HW_AUTO only when the module become ready.
1716 hwsup = clkdm_in_hwsup(oh->clkdm);
1717 ret = clkdm_hwmod_enable(oh->clkdm, oh);
1719 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1720 oh->name, oh->clkdm->name, ret);
1726 if (soc_ops.enable_module)
1727 soc_ops.enable_module(oh);
1729 ret = soc_ops.deassert_hardreset(oh, &ohri);
1731 if (soc_ops.disable_module)
1732 soc_ops.disable_module(oh);
1733 _disable_clocks(oh);
1736 pr_warning("omap_hwmod: %s: failed to hardreset\n", oh->name);
1740 * Set the clockdomain to HW_AUTO, assuming that the
1741 * previous state was HW_AUTO.
1743 if (oh->clkdm && hwsup)
1744 clkdm_allow_idle(oh->clkdm);
1747 clkdm_hwmod_disable(oh->clkdm, oh);
1754 * _read_hardreset - read the HW reset line state of submodules
1755 * contained in the hwmod module
1756 * @oh: struct omap_hwmod *
1757 * @name: name of the reset line to look up and read
1759 * Return the state of the reset line. Returns -EINVAL if @oh is
1760 * null, -ENOSYS if we have no way of reading the hardreset line
1761 * status on the currently-booted SoC, or passes along the return
1762 * value from _lookup_hardreset() or the SoC's is_hardreset_asserted
1765 static int _read_hardreset(struct omap_hwmod *oh, const char *name)
1767 struct omap_hwmod_rst_info ohri;
1773 if (!soc_ops.is_hardreset_asserted)
1776 ret = _lookup_hardreset(oh, name, &ohri);
1780 return soc_ops.is_hardreset_asserted(oh, &ohri);
1784 * _are_all_hardreset_lines_asserted - return true if the @oh is hard-reset
1785 * @oh: struct omap_hwmod *
1787 * If all hardreset lines associated with @oh are asserted, then return true.
1788 * Otherwise, if part of @oh is out hardreset or if no hardreset lines
1789 * associated with @oh are asserted, then return false.
1790 * This function is used to avoid executing some parts of the IP block
1791 * enable/disable sequence if its hardreset line is set.
1793 static bool _are_all_hardreset_lines_asserted(struct omap_hwmod *oh)
1797 if (oh->rst_lines_cnt == 0)
1800 for (i = 0; i < oh->rst_lines_cnt; i++)
1801 if (_read_hardreset(oh, oh->rst_lines[i].name) > 0)
1804 if (oh->rst_lines_cnt == rst_cnt)
1811 * _are_any_hardreset_lines_asserted - return true if any part of @oh is
1813 * @oh: struct omap_hwmod *
1815 * If any hardreset lines associated with @oh are asserted, then
1816 * return true. Otherwise, if no hardreset lines associated with @oh
1817 * are asserted, or if @oh has no hardreset lines, then return false.
1818 * This function is used to avoid executing some parts of the IP block
1819 * enable/disable sequence if any hardreset line is set.
1821 static bool _are_any_hardreset_lines_asserted(struct omap_hwmod *oh)
1826 for (i = 0; i < oh->rst_lines_cnt && rst_cnt == 0; i++)
1827 if (_read_hardreset(oh, oh->rst_lines[i].name) > 0)
1830 return (rst_cnt) ? true : false;
1834 * _omap4_disable_module - enable CLKCTRL modulemode on OMAP4
1835 * @oh: struct omap_hwmod *
1837 * Disable the PRCM module mode related to the hwmod @oh.
1838 * Return EINVAL if the modulemode is not supported and 0 in case of success.
1840 static int _omap4_disable_module(struct omap_hwmod *oh)
1844 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
1848 * Since integration code might still be doing something, only
1849 * disable if all lines are under hardreset.
1851 if (_are_any_hardreset_lines_asserted(oh))
1854 pr_debug("omap_hwmod: %s: %s\n", oh->name, __func__);
1856 omap4_cminst_module_disable(oh->clkdm->prcm_partition,
1858 oh->clkdm->clkdm_offs,
1859 oh->prcm.omap4.clkctrl_offs);
1861 v = _omap4_wait_target_disable(oh);
1863 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1870 * _am33xx_disable_module - enable CLKCTRL modulemode on AM33XX
1871 * @oh: struct omap_hwmod *
1873 * Disable the PRCM module mode related to the hwmod @oh.
1874 * Return EINVAL if the modulemode is not supported and 0 in case of success.
1876 static int _am33xx_disable_module(struct omap_hwmod *oh)
1880 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
1883 pr_debug("omap_hwmod: %s: %s\n", oh->name, __func__);
1885 if (_are_any_hardreset_lines_asserted(oh))
1888 am33xx_cm_module_disable(oh->clkdm->cm_inst, oh->clkdm->clkdm_offs,
1889 oh->prcm.omap4.clkctrl_offs);
1891 v = _am33xx_wait_target_disable(oh);
1893 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1900 * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1901 * @oh: struct omap_hwmod *
1903 * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit. hwmod must be
1904 * enabled for this to work. Returns -ENOENT if the hwmod cannot be
1905 * reset this way, -EINVAL if the hwmod is in the wrong state,
1906 * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1908 * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1909 * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1910 * use the SYSCONFIG softreset bit to provide the status.
1912 * Note that some IP like McBSP do have reset control but don't have
1915 static int _ocp_softreset(struct omap_hwmod *oh)
1921 if (!oh->class->sysc ||
1922 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
1925 /* clocks must be on for this operation */
1926 if (oh->_state != _HWMOD_STATE_ENABLED) {
1927 pr_warn("omap_hwmod: %s: reset can only be entered from enabled state\n",
1932 /* For some modules, all optionnal clocks need to be enabled as well */
1933 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1934 _enable_optional_clocks(oh);
1936 pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh->name);
1938 v = oh->_sysc_cache;
1939 ret = _set_softreset(oh, &v);
1943 _write_sysconfig(v, oh);
1944 ret = _clear_softreset(oh, &v);
1948 _write_sysconfig(v, oh);
1950 if (oh->class->sysc->srst_udelay)
1951 udelay(oh->class->sysc->srst_udelay);
1953 c = _wait_softreset_complete(oh);
1954 if (c == MAX_MODULE_SOFTRESET_WAIT)
1955 pr_warning("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1956 oh->name, MAX_MODULE_SOFTRESET_WAIT);
1958 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh->name, c);
1961 * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1962 * _wait_target_ready() or _reset()
1965 ret = (c == MAX_MODULE_SOFTRESET_WAIT) ? -ETIMEDOUT : 0;
1968 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1969 _disable_optional_clocks(oh);
1975 * _reset - reset an omap_hwmod
1976 * @oh: struct omap_hwmod *
1978 * Resets an omap_hwmod @oh. If the module has a custom reset
1979 * function pointer defined, then call it to reset the IP block, and
1980 * pass along its return value to the caller. Otherwise, if the IP
1981 * block has an OCP_SYSCONFIG register with a SOFTRESET bitfield
1982 * associated with it, call a function to reset the IP block via that
1983 * method, and pass along the return value to the caller. Finally, if
1984 * the IP block has some hardreset lines associated with it, assert
1985 * all of those, but do _not_ deassert them. (This is because driver
1986 * authors have expressed an apparent requirement to control the
1987 * deassertion of the hardreset lines themselves.)
1989 * The default software reset mechanism for most OMAP IP blocks is
1990 * triggered via the OCP_SYSCONFIG.SOFTRESET bit. However, some
1991 * hwmods cannot be reset via this method. Some are not targets and
1992 * therefore have no OCP header registers to access. Others (like the
1993 * IVA) have idiosyncratic reset sequences. So for these relatively
1994 * rare cases, custom reset code can be supplied in the struct
1995 * omap_hwmod_class .reset function pointer.
1997 * _set_dmadisable() is called to set the DMADISABLE bit so that it
1998 * does not prevent idling of the system. This is necessary for cases
1999 * where ROMCODE/BOOTLOADER uses dma and transfers control to the
2000 * kernel without disabling dma.
2002 * Passes along the return value from either _ocp_softreset() or the
2003 * custom reset function - these must return -EINVAL if the hwmod
2004 * cannot be reset this way or if the hwmod is in the wrong state,
2005 * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
2007 static int _reset(struct omap_hwmod *oh)
2011 pr_debug("omap_hwmod: %s: resetting\n", oh->name);
2013 if (oh->class->reset) {
2014 r = oh->class->reset(oh);
2016 if (oh->rst_lines_cnt > 0) {
2017 for (i = 0; i < oh->rst_lines_cnt; i++)
2018 _assert_hardreset(oh, oh->rst_lines[i].name);
2021 r = _ocp_softreset(oh);
2027 _set_dmadisable(oh);
2030 * OCP_SYSCONFIG bits need to be reprogrammed after a
2031 * softreset. The _enable() function should be split to avoid
2032 * the rewrite of the OCP_SYSCONFIG register.
2034 if (oh->class->sysc) {
2035 _update_sysc_cache(oh);
2043 * _reconfigure_io_chain - clear any I/O chain wakeups and reconfigure chain
2045 * Call the appropriate PRM function to clear any logged I/O chain
2046 * wakeups and to reconfigure the chain. This apparently needs to be
2047 * done upon every mux change. Since hwmods can be concurrently
2048 * enabled and idled, hold a spinlock around the I/O chain
2049 * reconfiguration sequence. No return value.
2051 * XXX When the PRM code is moved to drivers, this function can be removed,
2052 * as the PRM infrastructure should abstract this.
2054 static void _reconfigure_io_chain(void)
2056 unsigned long flags;
2058 spin_lock_irqsave(&io_chain_lock, flags);
2060 if (cpu_is_omap34xx() && omap3_has_io_chain_ctrl())
2061 omap3xxx_prm_reconfigure_io_chain();
2062 else if (cpu_is_omap44xx())
2063 omap44xx_prm_reconfigure_io_chain();
2065 spin_unlock_irqrestore(&io_chain_lock, flags);
2069 * _omap4_update_context_lost - increment hwmod context loss counter if
2070 * hwmod context was lost, and clear hardware context loss reg
2071 * @oh: hwmod to check for context loss
2073 * If the PRCM indicates that the hwmod @oh lost context, increment
2074 * our in-memory context loss counter, and clear the RM_*_CONTEXT
2075 * bits. No return value.
2077 static void _omap4_update_context_lost(struct omap_hwmod *oh)
2079 if (oh->prcm.omap4.flags & HWMOD_OMAP4_NO_CONTEXT_LOSS_BIT)
2082 if (!prm_was_any_context_lost_old(oh->clkdm->pwrdm.ptr->prcm_partition,
2083 oh->clkdm->pwrdm.ptr->prcm_offs,
2084 oh->prcm.omap4.context_offs))
2087 oh->prcm.omap4.context_lost_counter++;
2088 prm_clear_context_loss_flags_old(oh->clkdm->pwrdm.ptr->prcm_partition,
2089 oh->clkdm->pwrdm.ptr->prcm_offs,
2090 oh->prcm.omap4.context_offs);
2094 * _omap4_get_context_lost - get context loss counter for a hwmod
2095 * @oh: hwmod to get context loss counter for
2097 * Returns the in-memory context loss counter for a hwmod.
2099 static int _omap4_get_context_lost(struct omap_hwmod *oh)
2101 return oh->prcm.omap4.context_lost_counter;
2105 * _enable_preprogram - Pre-program an IP block during the _enable() process
2106 * @oh: struct omap_hwmod *
2108 * Some IP blocks (such as AESS) require some additional programming
2109 * after enable before they can enter idle. If a function pointer to
2110 * do so is present in the hwmod data, then call it and pass along the
2111 * return value; otherwise, return 0.
2113 static int _enable_preprogram(struct omap_hwmod *oh)
2115 if (!oh->class->enable_preprogram)
2118 return oh->class->enable_preprogram(oh);
2122 * _enable - enable an omap_hwmod
2123 * @oh: struct omap_hwmod *
2125 * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
2126 * register target. Returns -EINVAL if the hwmod is in the wrong
2127 * state or passes along the return value of _wait_target_ready().
2129 static int _enable(struct omap_hwmod *oh)
2134 pr_debug("omap_hwmod: %s: enabling\n", oh->name);
2137 * hwmods with HWMOD_INIT_NO_IDLE flag set are left in enabled
2138 * state at init. Now that someone is really trying to enable
2139 * them, just ensure that the hwmod mux is set.
2141 if (oh->_int_flags & _HWMOD_SKIP_ENABLE) {
2143 * If the caller has mux data populated, do the mux'ing
2144 * which wouldn't have been done as part of the _enable()
2145 * done during setup.
2148 omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
2150 oh->_int_flags &= ~_HWMOD_SKIP_ENABLE;
2154 if (oh->_state != _HWMOD_STATE_INITIALIZED &&
2155 oh->_state != _HWMOD_STATE_IDLE &&
2156 oh->_state != _HWMOD_STATE_DISABLED) {
2157 WARN(1, "omap_hwmod: %s: enabled state can only be entered from initialized, idle, or disabled state\n",
2163 * If an IP block contains HW reset lines and all of them are
2164 * asserted, we let integration code associated with that
2165 * block handle the enable. We've received very little
2166 * information on what those driver authors need, and until
2167 * detailed information is provided and the driver code is
2168 * posted to the public lists, this is probably the best we
2171 if (_are_all_hardreset_lines_asserted(oh))
2174 /* Mux pins for device runtime if populated */
2175 if (oh->mux && (!oh->mux->enabled ||
2176 ((oh->_state == _HWMOD_STATE_IDLE) &&
2177 oh->mux->pads_dynamic))) {
2178 omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
2179 _reconfigure_io_chain();
2180 } else if (oh->flags & HWMOD_FORCE_MSTANDBY) {
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();
2288 } else if (oh->flags & HWMOD_FORCE_MSTANDBY) {
2289 _reconfigure_io_chain();
2292 oh->_state = _HWMOD_STATE_IDLE;
2298 * _shutdown - shutdown an omap_hwmod
2299 * @oh: struct omap_hwmod *
2301 * Shut down an omap_hwmod @oh. This should be called when the driver
2302 * used for the hwmod is removed or unloaded or if the driver is not
2303 * used by the system. Returns -EINVAL if the hwmod is in the wrong
2304 * state or returns 0.
2306 static int _shutdown(struct omap_hwmod *oh)
2311 if (oh->_state != _HWMOD_STATE_IDLE &&
2312 oh->_state != _HWMOD_STATE_ENABLED) {
2313 WARN(1, "omap_hwmod: %s: disabled state can only be entered from idle, or enabled state\n",
2318 if (_are_all_hardreset_lines_asserted(oh))
2321 pr_debug("omap_hwmod: %s: disabling\n", oh->name);
2323 if (oh->class->pre_shutdown) {
2324 prev_state = oh->_state;
2325 if (oh->_state == _HWMOD_STATE_IDLE)
2327 ret = oh->class->pre_shutdown(oh);
2329 if (prev_state == _HWMOD_STATE_IDLE)
2335 if (oh->class->sysc) {
2336 if (oh->_state == _HWMOD_STATE_IDLE)
2341 /* clocks and deps are already disabled in idle */
2342 if (oh->_state == _HWMOD_STATE_ENABLED) {
2343 _del_initiator_dep(oh, mpu_oh);
2344 /* XXX what about the other system initiators here? dma, dsp */
2345 if (oh->flags & HWMOD_BLOCK_WFI)
2346 cpu_idle_poll_ctrl(false);
2347 if (soc_ops.disable_module)
2348 soc_ops.disable_module(oh);
2349 _disable_clocks(oh);
2351 clkdm_hwmod_disable(oh->clkdm, oh);
2353 /* XXX Should this code also force-disable the optional clocks? */
2355 for (i = 0; i < oh->rst_lines_cnt; i++)
2356 _assert_hardreset(oh, oh->rst_lines[i].name);
2358 /* Mux pins to safe mode or use populated off mode values */
2360 omap_hwmod_mux(oh->mux, _HWMOD_STATE_DISABLED);
2362 oh->_state = _HWMOD_STATE_DISABLED;
2368 * of_dev_hwmod_lookup - look up needed hwmod from dt blob
2369 * @np: struct device_node *
2370 * @oh: struct omap_hwmod *
2372 * Parse the dt blob and find out needed hwmod. Recursive function is
2373 * implemented to take care hierarchical dt blob parsing.
2374 * Return: The device node on success or NULL on failure.
2376 static struct device_node *of_dev_hwmod_lookup(struct device_node *np,
2377 struct omap_hwmod *oh)
2379 struct device_node *np0 = NULL, *np1 = NULL;
2382 for_each_child_of_node(np, np0) {
2383 if (of_find_property(np0, "ti,hwmods", NULL)) {
2384 p = of_get_property(np0, "ti,hwmods", NULL);
2385 if (!strcmp(p, oh->name))
2387 np1 = of_dev_hwmod_lookup(np0, oh);
2396 * _init_mpu_rt_base - populate the virtual address for a hwmod
2397 * @oh: struct omap_hwmod * to locate the virtual address
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.
2404 static void __init _init_mpu_rt_base(struct omap_hwmod *oh, void *data)
2406 struct omap_hwmod_addr_space *mem;
2407 void __iomem *va_start = NULL;
2408 struct device_node *np;
2413 _save_mpu_port_index(oh);
2415 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2418 mem = _find_mpu_rt_addr_space(oh);
2420 pr_debug("omap_hwmod: %s: no MPU register target found\n",
2423 /* Extract the IO space from device tree blob */
2424 if (!of_have_populated_dt())
2427 np = of_dev_hwmod_lookup(of_find_node_by_name(NULL, "ocp"), oh);
2429 va_start = of_iomap(np, 0);
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;
2446 * _init - initialize internal data for the hwmod @oh
2447 * @oh: struct omap_hwmod *
2450 * Look up the clocks and the address space used by the MPU to access
2451 * registers belonging to the hwmod @oh. @oh must already be
2452 * registered at this point. This is the first of two phases for
2453 * hwmod initialization. Code called here does not touch any hardware
2454 * registers, it simply prepares internal data structures. Returns 0
2455 * upon success or if the hwmod isn't registered, or -EINVAL upon
2458 static int __init _init(struct omap_hwmod *oh, void *data)
2462 if (oh->_state != _HWMOD_STATE_REGISTERED)
2465 if (oh->class->sysc)
2466 _init_mpu_rt_base(oh, NULL);
2468 r = _init_clocks(oh, NULL);
2470 WARN(1, "omap_hwmod: %s: couldn't init clocks\n", oh->name);
2474 oh->_state = _HWMOD_STATE_INITIALIZED;
2480 * _setup_iclk_autoidle - configure an IP block's interface clocks
2481 * @oh: struct omap_hwmod *
2483 * Set up the module's interface clocks. XXX This function is still mostly
2484 * a stub; implementing this properly requires iclk autoidle usecounting in
2485 * the clock code. No return value.
2487 static void __init _setup_iclk_autoidle(struct omap_hwmod *oh)
2489 struct omap_hwmod_ocp_if *os;
2490 struct list_head *p;
2492 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2495 p = oh->slave_ports.next;
2497 while (i < oh->slaves_cnt) {
2498 os = _fetch_next_ocp_if(&p, &i);
2502 if (os->flags & OCPIF_SWSUP_IDLE) {
2503 /* XXX omap_iclk_deny_idle(c); */
2505 /* XXX omap_iclk_allow_idle(c); */
2506 clk_enable(os->_clk);
2514 * _setup_reset - reset an IP block during the setup process
2515 * @oh: struct omap_hwmod *
2517 * Reset the IP block corresponding to the hwmod @oh during the setup
2518 * process. The IP block is first enabled so it can be successfully
2519 * reset. Returns 0 upon success or a negative error code upon
2522 static int __init _setup_reset(struct omap_hwmod *oh)
2526 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2529 if (oh->flags & HWMOD_EXT_OPT_MAIN_CLK)
2532 if (oh->rst_lines_cnt == 0) {
2535 pr_warning("omap_hwmod: %s: cannot be enabled for reset (%d)\n",
2536 oh->name, oh->_state);
2541 if (!(oh->flags & HWMOD_INIT_NO_RESET))
2548 * _setup_postsetup - transition to the appropriate state after _setup
2549 * @oh: struct omap_hwmod *
2551 * Place an IP block represented by @oh into a "post-setup" state --
2552 * either IDLE, ENABLED, or DISABLED. ("post-setup" simply means that
2553 * this function is called at the end of _setup().) The postsetup
2554 * state for an IP block can be changed by calling
2555 * omap_hwmod_enter_postsetup_state() early in the boot process,
2556 * before one of the omap_hwmod_setup*() functions are called for the
2559 * The IP block stays in this state until a PM runtime-based driver is
2560 * loaded for that IP block. A post-setup state of IDLE is
2561 * appropriate for almost all IP blocks with runtime PM-enabled
2562 * drivers, since those drivers are able to enable the IP block. A
2563 * post-setup state of ENABLED is appropriate for kernels with PM
2564 * runtime disabled. The DISABLED state is appropriate for unusual IP
2565 * blocks such as the MPU WDTIMER on kernels without WDTIMER drivers
2566 * included, since the WDTIMER starts running on reset and will reset
2567 * the MPU if left active.
2569 * This post-setup mechanism is deprecated. Once all of the OMAP
2570 * drivers have been converted to use PM runtime, and all of the IP
2571 * block data and interconnect data is available to the hwmod code, it
2572 * should be possible to replace this mechanism with a "lazy reset"
2573 * arrangement. In a "lazy reset" setup, each IP block is enabled
2574 * when the driver first probes, then all remaining IP blocks without
2575 * drivers are either shut down or enabled after the drivers have
2576 * loaded. However, this cannot take place until the above
2577 * preconditions have been met, since otherwise the late reset code
2578 * has no way of knowing which IP blocks are in use by drivers, and
2579 * which ones are unused.
2583 static void __init _setup_postsetup(struct omap_hwmod *oh)
2587 if (oh->rst_lines_cnt > 0)
2590 postsetup_state = oh->_postsetup_state;
2591 if (postsetup_state == _HWMOD_STATE_UNKNOWN)
2592 postsetup_state = _HWMOD_STATE_ENABLED;
2595 * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
2596 * it should be set by the core code as a runtime flag during startup
2598 if ((oh->flags & HWMOD_INIT_NO_IDLE) &&
2599 (postsetup_state == _HWMOD_STATE_IDLE)) {
2600 oh->_int_flags |= _HWMOD_SKIP_ENABLE;
2601 postsetup_state = _HWMOD_STATE_ENABLED;
2604 if (postsetup_state == _HWMOD_STATE_IDLE)
2606 else if (postsetup_state == _HWMOD_STATE_DISABLED)
2608 else if (postsetup_state != _HWMOD_STATE_ENABLED)
2609 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
2610 oh->name, postsetup_state);
2616 * _setup - prepare IP block hardware for use
2617 * @oh: struct omap_hwmod *
2618 * @n: (unused, pass NULL)
2620 * Configure the IP block represented by @oh. This may include
2621 * enabling the IP block, resetting it, and placing it into a
2622 * post-setup state, depending on the type of IP block and applicable
2623 * flags. IP blocks are reset to prevent any previous configuration
2624 * by the bootloader or previous operating system from interfering
2625 * with power management or other parts of the system. The reset can
2626 * be avoided; see omap_hwmod_no_setup_reset(). This is the second of
2627 * two phases for hwmod initialization. Code called here generally
2628 * affects the IP block hardware, or system integration hardware
2629 * associated with the IP block. Returns 0.
2631 static int __init _setup(struct omap_hwmod *oh, void *data)
2633 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2636 _setup_iclk_autoidle(oh);
2638 if (!_setup_reset(oh))
2639 _setup_postsetup(oh);
2645 * _register - register a struct omap_hwmod
2646 * @oh: struct omap_hwmod *
2648 * Registers the omap_hwmod @oh. Returns -EEXIST if an omap_hwmod
2649 * already has been registered by the same name; -EINVAL if the
2650 * omap_hwmod is in the wrong state, if @oh is NULL, if the
2651 * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
2652 * name, or if the omap_hwmod's class is missing a name; or 0 upon
2655 * XXX The data should be copied into bootmem, so the original data
2656 * should be marked __initdata and freed after init. This would allow
2657 * unneeded omap_hwmods to be freed on multi-OMAP configurations. Note
2658 * that the copy process would be relatively complex due to the large number
2661 static int __init _register(struct omap_hwmod *oh)
2663 if (!oh || !oh->name || !oh->class || !oh->class->name ||
2664 (oh->_state != _HWMOD_STATE_UNKNOWN))
2667 pr_debug("omap_hwmod: %s: registering\n", oh->name);
2669 if (_lookup(oh->name))
2672 list_add_tail(&oh->node, &omap_hwmod_list);
2674 INIT_LIST_HEAD(&oh->master_ports);
2675 INIT_LIST_HEAD(&oh->slave_ports);
2676 spin_lock_init(&oh->_lock);
2678 oh->_state = _HWMOD_STATE_REGISTERED;
2681 * XXX Rather than doing a strcmp(), this should test a flag
2682 * set in the hwmod data, inserted by the autogenerator code.
2684 if (!strcmp(oh->name, MPU_INITIATOR_NAME))
2691 * _alloc_links - return allocated memory for hwmod links
2692 * @ml: pointer to a struct omap_hwmod_link * for the master link
2693 * @sl: pointer to a struct omap_hwmod_link * for the slave link
2695 * Return pointers to two struct omap_hwmod_link records, via the
2696 * addresses pointed to by @ml and @sl. Will first attempt to return
2697 * memory allocated as part of a large initial block, but if that has
2698 * been exhausted, will allocate memory itself. Since ideally this
2699 * second allocation path will never occur, the number of these
2700 * 'supplemental' allocations will be logged when debugging is
2701 * enabled. Returns 0.
2703 static int __init _alloc_links(struct omap_hwmod_link **ml,
2704 struct omap_hwmod_link **sl)
2708 if ((free_ls + LINKS_PER_OCP_IF) <= max_ls) {
2709 *ml = &linkspace[free_ls++];
2710 *sl = &linkspace[free_ls++];
2714 sz = sizeof(struct omap_hwmod_link) * LINKS_PER_OCP_IF;
2717 *ml = alloc_bootmem(sz);
2721 *sl = (void *)(*ml) + sizeof(struct omap_hwmod_link);
2724 pr_debug("omap_hwmod: supplemental link allocations needed: %d\n",
2725 ls_supp * LINKS_PER_OCP_IF);
2731 * _add_link - add an interconnect between two IP blocks
2732 * @oi: pointer to a struct omap_hwmod_ocp_if record
2734 * Add struct omap_hwmod_link records connecting the master IP block
2735 * specified in @oi->master to @oi, and connecting the slave IP block
2736 * specified in @oi->slave to @oi. This code is assumed to run before
2737 * preemption or SMP has been enabled, thus avoiding the need for
2738 * locking in this code. Changes to this assumption will require
2739 * additional locking. Returns 0.
2741 static int __init _add_link(struct omap_hwmod_ocp_if *oi)
2743 struct omap_hwmod_link *ml, *sl;
2745 pr_debug("omap_hwmod: %s -> %s: adding link\n", oi->master->name,
2748 _alloc_links(&ml, &sl);
2751 INIT_LIST_HEAD(&ml->node);
2752 list_add(&ml->node, &oi->master->master_ports);
2753 oi->master->masters_cnt++;
2756 INIT_LIST_HEAD(&sl->node);
2757 list_add(&sl->node, &oi->slave->slave_ports);
2758 oi->slave->slaves_cnt++;
2764 * _register_link - register a struct omap_hwmod_ocp_if
2765 * @oi: struct omap_hwmod_ocp_if *
2767 * Registers the omap_hwmod_ocp_if record @oi. Returns -EEXIST if it
2768 * has already been registered; -EINVAL if @oi is NULL or if the
2769 * record pointed to by @oi is missing required fields; or 0 upon
2772 * XXX The data should be copied into bootmem, so the original data
2773 * should be marked __initdata and freed after init. This would allow
2774 * unneeded omap_hwmods to be freed on multi-OMAP configurations.
2776 static int __init _register_link(struct omap_hwmod_ocp_if *oi)
2778 if (!oi || !oi->master || !oi->slave || !oi->user)
2781 if (oi->_int_flags & _OCPIF_INT_FLAGS_REGISTERED)
2784 pr_debug("omap_hwmod: registering link from %s to %s\n",
2785 oi->master->name, oi->slave->name);
2788 * Register the connected hwmods, if they haven't been
2789 * registered already
2791 if (oi->master->_state != _HWMOD_STATE_REGISTERED)
2792 _register(oi->master);
2794 if (oi->slave->_state != _HWMOD_STATE_REGISTERED)
2795 _register(oi->slave);
2799 oi->_int_flags |= _OCPIF_INT_FLAGS_REGISTERED;
2805 * _alloc_linkspace - allocate large block of hwmod links
2806 * @ois: pointer to an array of struct omap_hwmod_ocp_if records to count
2808 * Allocate a large block of struct omap_hwmod_link records. This
2809 * improves boot time significantly by avoiding the need to allocate
2810 * individual records one by one. If the number of records to
2811 * allocate in the block hasn't been manually specified, this function
2812 * will count the number of struct omap_hwmod_ocp_if records in @ois
2813 * and use that to determine the allocation size. For SoC families
2814 * that require multiple list registrations, such as OMAP3xxx, this
2815 * estimation process isn't optimal, so manual estimation is advised
2816 * in those cases. Returns -EEXIST if the allocation has already occurred
2817 * or 0 upon success.
2819 static int __init _alloc_linkspace(struct omap_hwmod_ocp_if **ois)
2825 WARN(1, "linkspace already allocated\n");
2831 max_ls += LINKS_PER_OCP_IF;
2833 sz = sizeof(struct omap_hwmod_link) * max_ls;
2835 pr_debug("omap_hwmod: %s: allocating %d byte linkspace (%d links)\n",
2836 __func__, sz, max_ls);
2838 linkspace = alloc_bootmem(sz);
2840 memset(linkspace, 0, sz);
2845 /* Static functions intended only for use in soc_ops field function pointers */
2848 * _omap2xxx_wait_target_ready - wait for a module to leave slave idle
2849 * @oh: struct omap_hwmod *
2851 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2852 * does not have an IDLEST bit or if the module successfully leaves
2853 * slave idle; otherwise, pass along the return value of the
2854 * appropriate *_cm*_wait_module_ready() function.
2856 static int _omap2xxx_wait_target_ready(struct omap_hwmod *oh)
2861 if (oh->flags & HWMOD_NO_IDLEST)
2864 if (!_find_mpu_rt_port(oh))
2867 /* XXX check module SIDLEMODE, hardreset status, enabled clocks */
2869 return omap2xxx_cm_wait_module_ready(oh->prcm.omap2.module_offs,
2870 oh->prcm.omap2.idlest_reg_id,
2871 oh->prcm.omap2.idlest_idle_bit);
2875 * _omap3xxx_wait_target_ready - wait for a module to leave slave idle
2876 * @oh: struct omap_hwmod *
2878 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2879 * does not have an IDLEST bit or if the module successfully leaves
2880 * slave idle; otherwise, pass along the return value of the
2881 * appropriate *_cm*_wait_module_ready() function.
2883 static int _omap3xxx_wait_target_ready(struct omap_hwmod *oh)
2888 if (oh->flags & HWMOD_NO_IDLEST)
2891 if (!_find_mpu_rt_port(oh))
2894 /* XXX check module SIDLEMODE, hardreset status, enabled clocks */
2896 return omap3xxx_cm_wait_module_ready(oh->prcm.omap2.module_offs,
2897 oh->prcm.omap2.idlest_reg_id,
2898 oh->prcm.omap2.idlest_idle_bit);
2902 * _omap4_wait_target_ready - wait for a module to leave slave idle
2903 * @oh: struct omap_hwmod *
2905 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2906 * does not have an IDLEST bit or if the module successfully leaves
2907 * slave idle; otherwise, pass along the return value of the
2908 * appropriate *_cm*_wait_module_ready() function.
2910 static int _omap4_wait_target_ready(struct omap_hwmod *oh)
2915 if (oh->flags & HWMOD_NO_IDLEST || !oh->clkdm)
2918 if (!_find_mpu_rt_port(oh))
2921 /* XXX check module SIDLEMODE, hardreset status */
2923 return omap4_cminst_wait_module_ready(oh->clkdm->prcm_partition,
2925 oh->clkdm->clkdm_offs,
2926 oh->prcm.omap4.clkctrl_offs);
2930 * _am33xx_wait_target_ready - wait for a module to leave slave idle
2931 * @oh: struct omap_hwmod *
2933 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2934 * does not have an IDLEST bit or if the module successfully leaves
2935 * slave idle; otherwise, pass along the return value of the
2936 * appropriate *_cm*_wait_module_ready() function.
2938 static int _am33xx_wait_target_ready(struct omap_hwmod *oh)
2940 if (!oh || !oh->clkdm)
2943 if (oh->flags & HWMOD_NO_IDLEST)
2946 if (!_find_mpu_rt_port(oh))
2949 /* XXX check module SIDLEMODE, hardreset status */
2951 return am33xx_cm_wait_module_ready(oh->clkdm->cm_inst,
2952 oh->clkdm->clkdm_offs,
2953 oh->prcm.omap4.clkctrl_offs);
2957 * _omap2_assert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2958 * @oh: struct omap_hwmod * to assert hardreset
2959 * @ohri: hardreset line data
2961 * Call omap2_prm_assert_hardreset() with parameters extracted from
2962 * the hwmod @oh and the hardreset line data @ohri. Only intended for
2963 * use as an soc_ops function pointer. Passes along the return value
2964 * from omap2_prm_assert_hardreset(). XXX This function is scheduled
2965 * for removal when the PRM code is moved into drivers/.
2967 static int _omap2_assert_hardreset(struct omap_hwmod *oh,
2968 struct omap_hwmod_rst_info *ohri)
2970 return omap2_prm_assert_hardreset(oh->prcm.omap2.module_offs,
2975 * _omap2_deassert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2976 * @oh: struct omap_hwmod * to deassert hardreset
2977 * @ohri: hardreset line data
2979 * Call omap2_prm_deassert_hardreset() with parameters extracted from
2980 * the hwmod @oh and the hardreset line data @ohri. Only intended for
2981 * use as an soc_ops function pointer. Passes along the return value
2982 * from omap2_prm_deassert_hardreset(). XXX This function is
2983 * scheduled for removal when the PRM code is moved into drivers/.
2985 static int _omap2_deassert_hardreset(struct omap_hwmod *oh,
2986 struct omap_hwmod_rst_info *ohri)
2988 return omap2_prm_deassert_hardreset(oh->prcm.omap2.module_offs,
2994 * _omap2_is_hardreset_asserted - call OMAP2 PRM hardreset fn with hwmod args
2995 * @oh: struct omap_hwmod * to test hardreset
2996 * @ohri: hardreset line data
2998 * Call omap2_prm_is_hardreset_asserted() with parameters extracted
2999 * from the hwmod @oh and the hardreset line data @ohri. Only
3000 * intended for use as an soc_ops function pointer. Passes along the
3001 * return value from omap2_prm_is_hardreset_asserted(). XXX This
3002 * function is scheduled for removal when the PRM code is moved into
3005 static int _omap2_is_hardreset_asserted(struct omap_hwmod *oh,
3006 struct omap_hwmod_rst_info *ohri)
3008 return omap2_prm_is_hardreset_asserted(oh->prcm.omap2.module_offs,
3013 * _omap4_assert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
3014 * @oh: struct omap_hwmod * to assert hardreset
3015 * @ohri: hardreset line data
3017 * Call omap4_prminst_assert_hardreset() with parameters extracted
3018 * from the hwmod @oh and the hardreset line data @ohri. Only
3019 * intended for use as an soc_ops function pointer. Passes along the
3020 * return value from omap4_prminst_assert_hardreset(). XXX This
3021 * function is scheduled for removal when the PRM code is moved into
3024 static int _omap4_assert_hardreset(struct omap_hwmod *oh,
3025 struct omap_hwmod_rst_info *ohri)
3030 return omap4_prminst_assert_hardreset(ohri->rst_shift,
3031 oh->clkdm->pwrdm.ptr->prcm_partition,
3032 oh->clkdm->pwrdm.ptr->prcm_offs,
3033 oh->prcm.omap4.rstctrl_offs);
3037 * _omap4_deassert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
3038 * @oh: struct omap_hwmod * to deassert hardreset
3039 * @ohri: hardreset line data
3041 * Call omap4_prminst_deassert_hardreset() with parameters extracted
3042 * from the hwmod @oh and the hardreset line data @ohri. Only
3043 * intended for use as an soc_ops function pointer. Passes along the
3044 * return value from omap4_prminst_deassert_hardreset(). XXX This
3045 * function is scheduled for removal when the PRM code is moved into
3048 static int _omap4_deassert_hardreset(struct omap_hwmod *oh,
3049 struct omap_hwmod_rst_info *ohri)
3055 pr_err("omap_hwmod: %s: %s: hwmod data error: OMAP4 does not support st_shift\n",
3056 oh->name, ohri->name);
3057 return omap4_prminst_deassert_hardreset(ohri->rst_shift,
3058 oh->clkdm->pwrdm.ptr->prcm_partition,
3059 oh->clkdm->pwrdm.ptr->prcm_offs,
3060 oh->prcm.omap4.rstctrl_offs);
3064 * _omap4_is_hardreset_asserted - call OMAP4 PRM hardreset fn with hwmod args
3065 * @oh: struct omap_hwmod * to test hardreset
3066 * @ohri: hardreset line data
3068 * Call omap4_prminst_is_hardreset_asserted() with parameters
3069 * extracted from the hwmod @oh and the hardreset line data @ohri.
3070 * Only intended for use as an soc_ops function pointer. Passes along
3071 * the return value from omap4_prminst_is_hardreset_asserted(). XXX
3072 * This function is scheduled for removal when the PRM code is moved
3075 static int _omap4_is_hardreset_asserted(struct omap_hwmod *oh,
3076 struct omap_hwmod_rst_info *ohri)
3081 return omap4_prminst_is_hardreset_asserted(ohri->rst_shift,
3082 oh->clkdm->pwrdm.ptr->prcm_partition,
3083 oh->clkdm->pwrdm.ptr->prcm_offs,
3084 oh->prcm.omap4.rstctrl_offs);
3088 * _am33xx_assert_hardreset - call AM33XX PRM hardreset fn with hwmod args
3089 * @oh: struct omap_hwmod * to assert hardreset
3090 * @ohri: hardreset line data
3092 * Call am33xx_prminst_assert_hardreset() with parameters extracted
3093 * from the hwmod @oh and the hardreset line data @ohri. Only
3094 * intended for use as an soc_ops function pointer. Passes along the
3095 * return value from am33xx_prminst_assert_hardreset(). XXX This
3096 * function is scheduled for removal when the PRM code is moved into
3099 static int _am33xx_assert_hardreset(struct omap_hwmod *oh,
3100 struct omap_hwmod_rst_info *ohri)
3103 return am33xx_prm_assert_hardreset(ohri->rst_shift,
3104 oh->clkdm->pwrdm.ptr->prcm_offs,
3105 oh->prcm.omap4.rstctrl_offs);
3109 * _am33xx_deassert_hardreset - call AM33XX PRM hardreset fn with hwmod args
3110 * @oh: struct omap_hwmod * to deassert hardreset
3111 * @ohri: hardreset line data
3113 * Call am33xx_prminst_deassert_hardreset() with parameters extracted
3114 * from the hwmod @oh and the hardreset line data @ohri. Only
3115 * intended for use as an soc_ops function pointer. Passes along the
3116 * return value from am33xx_prminst_deassert_hardreset(). XXX This
3117 * function is scheduled for removal when the PRM code is moved into
3120 static int _am33xx_deassert_hardreset(struct omap_hwmod *oh,
3121 struct omap_hwmod_rst_info *ohri)
3123 return am33xx_prm_deassert_hardreset(ohri->rst_shift,
3125 oh->clkdm->pwrdm.ptr->prcm_offs,
3126 oh->prcm.omap4.rstctrl_offs,
3127 oh->prcm.omap4.rstst_offs);
3131 * _am33xx_is_hardreset_asserted - call AM33XX PRM hardreset fn with hwmod args
3132 * @oh: struct omap_hwmod * to test hardreset
3133 * @ohri: hardreset line data
3135 * Call am33xx_prminst_is_hardreset_asserted() with parameters
3136 * extracted from the hwmod @oh and the hardreset line data @ohri.
3137 * Only intended for use as an soc_ops function pointer. Passes along
3138 * the return value from am33xx_prminst_is_hardreset_asserted(). XXX
3139 * This function is scheduled for removal when the PRM code is moved
3142 static int _am33xx_is_hardreset_asserted(struct omap_hwmod *oh,
3143 struct omap_hwmod_rst_info *ohri)
3145 return am33xx_prm_is_hardreset_asserted(ohri->rst_shift,
3146 oh->clkdm->pwrdm.ptr->prcm_offs,
3147 oh->prcm.omap4.rstctrl_offs);
3150 /* Public functions */
3152 u32 omap_hwmod_read(struct omap_hwmod *oh, u16 reg_offs)
3154 if (oh->flags & HWMOD_16BIT_REG)
3155 return __raw_readw(oh->_mpu_rt_va + reg_offs);
3157 return __raw_readl(oh->_mpu_rt_va + reg_offs);
3160 void omap_hwmod_write(u32 v, struct omap_hwmod *oh, u16 reg_offs)
3162 if (oh->flags & HWMOD_16BIT_REG)
3163 __raw_writew(v, oh->_mpu_rt_va + reg_offs);
3165 __raw_writel(v, oh->_mpu_rt_va + reg_offs);
3169 * omap_hwmod_softreset - reset a module via SYSCONFIG.SOFTRESET bit
3170 * @oh: struct omap_hwmod *
3172 * This is a public function exposed to drivers. Some drivers may need to do
3173 * some settings before and after resetting the device. Those drivers after
3174 * doing the necessary settings could use this function to start a reset by
3175 * setting the SYSCONFIG.SOFTRESET bit.
3177 int omap_hwmod_softreset(struct omap_hwmod *oh)
3182 if (!oh || !(oh->_sysc_cache))
3185 v = oh->_sysc_cache;
3186 ret = _set_softreset(oh, &v);
3189 _write_sysconfig(v, oh);
3191 ret = _clear_softreset(oh, &v);
3194 _write_sysconfig(v, oh);
3201 * omap_hwmod_lookup - look up a registered omap_hwmod by name
3202 * @name: name of the omap_hwmod to look up
3204 * Given a @name of an omap_hwmod, return a pointer to the registered
3205 * struct omap_hwmod *, or NULL upon error.
3207 struct omap_hwmod *omap_hwmod_lookup(const char *name)
3209 struct omap_hwmod *oh;
3220 * omap_hwmod_for_each - call function for each registered omap_hwmod
3221 * @fn: pointer to a callback function
3222 * @data: void * data to pass to callback function
3224 * Call @fn for each registered omap_hwmod, passing @data to each
3225 * function. @fn must return 0 for success or any other value for
3226 * failure. If @fn returns non-zero, the iteration across omap_hwmods
3227 * will stop and the non-zero return value will be passed to the
3228 * caller of omap_hwmod_for_each(). @fn is called with
3229 * omap_hwmod_for_each() held.
3231 int omap_hwmod_for_each(int (*fn)(struct omap_hwmod *oh, void *data),
3234 struct omap_hwmod *temp_oh;
3240 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
3241 ret = (*fn)(temp_oh, data);
3250 * omap_hwmod_register_links - register an array of hwmod links
3251 * @ois: pointer to an array of omap_hwmod_ocp_if to register
3253 * Intended to be called early in boot before the clock framework is
3254 * initialized. If @ois is not null, will register all omap_hwmods
3255 * listed in @ois that are valid for this chip. Returns -EINVAL if
3256 * omap_hwmod_init() hasn't been called before calling this function,
3257 * -ENOMEM if the link memory area can't be allocated, or 0 upon
3260 int __init omap_hwmod_register_links(struct omap_hwmod_ocp_if **ois)
3271 if (_alloc_linkspace(ois)) {
3272 pr_err("omap_hwmod: could not allocate link space\n");
3279 r = _register_link(ois[i]);
3280 WARN(r && r != -EEXIST,
3281 "omap_hwmod: _register_link(%s -> %s) returned %d\n",
3282 ois[i]->master->name, ois[i]->slave->name, r);
3289 * _ensure_mpu_hwmod_is_setup - ensure the MPU SS hwmod is init'ed and set up
3290 * @oh: pointer to the hwmod currently being set up (usually not the MPU)
3292 * If the hwmod data corresponding to the MPU subsystem IP block
3293 * hasn't been initialized and set up yet, do so now. This must be
3294 * done first since sleep dependencies may be added from other hwmods
3295 * to the MPU. Intended to be called only by omap_hwmod_setup*(). No
3298 static void __init _ensure_mpu_hwmod_is_setup(struct omap_hwmod *oh)
3300 if (!mpu_oh || mpu_oh->_state == _HWMOD_STATE_UNKNOWN)
3301 pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",
3302 __func__, MPU_INITIATOR_NAME);
3303 else if (mpu_oh->_state == _HWMOD_STATE_REGISTERED && oh != mpu_oh)
3304 omap_hwmod_setup_one(MPU_INITIATOR_NAME);
3308 * omap_hwmod_setup_one - set up a single hwmod
3309 * @oh_name: const char * name of the already-registered hwmod to set up
3311 * Initialize and set up a single hwmod. Intended to be used for a
3312 * small number of early devices, such as the timer IP blocks used for
3313 * the scheduler clock. Must be called after omap2_clk_init().
3314 * Resolves the struct clk names to struct clk pointers for each
3315 * registered omap_hwmod. Also calls _setup() on each hwmod. Returns
3316 * -EINVAL upon error or 0 upon success.
3318 int __init omap_hwmod_setup_one(const char *oh_name)
3320 struct omap_hwmod *oh;
3322 pr_debug("omap_hwmod: %s: %s\n", oh_name, __func__);
3324 oh = _lookup(oh_name);
3326 WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name);
3330 _ensure_mpu_hwmod_is_setup(oh);
3339 * omap_hwmod_setup_all - set up all registered IP blocks
3341 * Initialize and set up all IP blocks registered with the hwmod code.
3342 * Must be called after omap2_clk_init(). Resolves the struct clk
3343 * names to struct clk pointers for each registered omap_hwmod. Also
3344 * calls _setup() on each hwmod. Returns 0 upon success.
3346 static int __init omap_hwmod_setup_all(void)
3348 _ensure_mpu_hwmod_is_setup(NULL);
3350 omap_hwmod_for_each(_init, NULL);
3351 omap_hwmod_for_each(_setup, NULL);
3355 omap_core_initcall(omap_hwmod_setup_all);
3358 * omap_hwmod_enable - enable an omap_hwmod
3359 * @oh: struct omap_hwmod *
3361 * Enable an omap_hwmod @oh. Intended to be called by omap_device_enable().
3362 * Returns -EINVAL on error or passes along the return value from _enable().
3364 int omap_hwmod_enable(struct omap_hwmod *oh)
3367 unsigned long flags;
3372 spin_lock_irqsave(&oh->_lock, flags);
3374 spin_unlock_irqrestore(&oh->_lock, flags);
3380 * omap_hwmod_idle - idle an omap_hwmod
3381 * @oh: struct omap_hwmod *
3383 * Idle an omap_hwmod @oh. Intended to be called by omap_device_idle().
3384 * Returns -EINVAL on error or passes along the return value from _idle().
3386 int omap_hwmod_idle(struct omap_hwmod *oh)
3388 unsigned long flags;
3393 spin_lock_irqsave(&oh->_lock, flags);
3395 spin_unlock_irqrestore(&oh->_lock, flags);
3401 * omap_hwmod_shutdown - shutdown an omap_hwmod
3402 * @oh: struct omap_hwmod *
3404 * Shutdown an omap_hwmod @oh. Intended to be called by
3405 * omap_device_shutdown(). Returns -EINVAL on error or passes along
3406 * the return value from _shutdown().
3408 int omap_hwmod_shutdown(struct omap_hwmod *oh)
3410 unsigned long flags;
3415 spin_lock_irqsave(&oh->_lock, flags);
3417 spin_unlock_irqrestore(&oh->_lock, flags);
3423 * omap_hwmod_enable_clocks - enable main_clk, all interface clocks
3424 * @oh: struct omap_hwmod *oh
3426 * Intended to be called by the omap_device code.
3428 int omap_hwmod_enable_clocks(struct omap_hwmod *oh)
3430 unsigned long flags;
3432 spin_lock_irqsave(&oh->_lock, flags);
3434 spin_unlock_irqrestore(&oh->_lock, flags);
3440 * omap_hwmod_disable_clocks - disable 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_disable_clocks(struct omap_hwmod *oh)
3447 unsigned long flags;
3449 spin_lock_irqsave(&oh->_lock, flags);
3450 _disable_clocks(oh);
3451 spin_unlock_irqrestore(&oh->_lock, flags);
3457 * omap_hwmod_ocp_barrier - wait for posted writes against the hwmod to complete
3458 * @oh: struct omap_hwmod *oh
3460 * Intended to be called by drivers and core code when all posted
3461 * writes to a device must complete before continuing further
3462 * execution (for example, after clearing some device IRQSTATUS
3465 * XXX what about targets with multiple OCP threads?
3467 void omap_hwmod_ocp_barrier(struct omap_hwmod *oh)
3471 if (!oh->class->sysc || !oh->class->sysc->sysc_flags) {
3472 WARN(1, "omap_device: %s: OCP barrier impossible due to device configuration\n",
3478 * Forces posted writes to complete on the OCP thread handling
3481 omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
3485 * omap_hwmod_reset - reset the hwmod
3486 * @oh: struct omap_hwmod *
3488 * Under some conditions, a driver may wish to reset the entire device.
3489 * Called from omap_device code. Returns -EINVAL on error or passes along
3490 * the return value from _reset().
3492 int omap_hwmod_reset(struct omap_hwmod *oh)
3495 unsigned long flags;
3500 spin_lock_irqsave(&oh->_lock, flags);
3502 spin_unlock_irqrestore(&oh->_lock, flags);
3508 * IP block data retrieval functions
3512 * omap_hwmod_count_resources - count number of struct resources needed by hwmod
3513 * @oh: struct omap_hwmod *
3514 * @flags: Type of resources to include when counting (IRQ/DMA/MEM)
3516 * Count the number of struct resource array elements necessary to
3517 * contain omap_hwmod @oh resources. Intended to be called by code
3518 * that registers omap_devices. Intended to be used to determine the
3519 * size of a dynamically-allocated struct resource array, before
3520 * calling omap_hwmod_fill_resources(). Returns the number of struct
3521 * resource array elements needed.
3523 * XXX This code is not optimized. It could attempt to merge adjacent
3527 int omap_hwmod_count_resources(struct omap_hwmod *oh, unsigned long flags)
3531 if (flags & IORESOURCE_IRQ)
3532 ret += _count_mpu_irqs(oh);
3534 if (flags & IORESOURCE_DMA)
3535 ret += _count_sdma_reqs(oh);
3537 if (flags & IORESOURCE_MEM) {
3539 struct omap_hwmod_ocp_if *os;
3540 struct list_head *p = oh->slave_ports.next;
3542 while (i < oh->slaves_cnt) {
3543 os = _fetch_next_ocp_if(&p, &i);
3544 ret += _count_ocp_if_addr_spaces(os);
3552 * omap_hwmod_fill_resources - fill struct resource array with hwmod data
3553 * @oh: struct omap_hwmod *
3554 * @res: pointer to the first element of an array of struct resource to fill
3556 * Fill the struct resource array @res with resource data from the
3557 * omap_hwmod @oh. Intended to be called by code that registers
3558 * omap_devices. See also omap_hwmod_count_resources(). Returns the
3559 * number of array elements filled.
3561 int omap_hwmod_fill_resources(struct omap_hwmod *oh, struct resource *res)
3563 struct omap_hwmod_ocp_if *os;
3564 struct list_head *p;
3565 int i, j, mpu_irqs_cnt, sdma_reqs_cnt, addr_cnt;
3568 /* For each IRQ, DMA, memory area, fill in array.*/
3570 mpu_irqs_cnt = _count_mpu_irqs(oh);
3571 for (i = 0; i < mpu_irqs_cnt; i++) {
3572 (res + r)->name = (oh->mpu_irqs + i)->name;
3573 (res + r)->start = (oh->mpu_irqs + i)->irq;
3574 (res + r)->end = (oh->mpu_irqs + i)->irq;
3575 (res + r)->flags = IORESOURCE_IRQ;
3579 sdma_reqs_cnt = _count_sdma_reqs(oh);
3580 for (i = 0; i < sdma_reqs_cnt; i++) {
3581 (res + r)->name = (oh->sdma_reqs + i)->name;
3582 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
3583 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
3584 (res + r)->flags = IORESOURCE_DMA;
3588 p = oh->slave_ports.next;
3591 while (i < oh->slaves_cnt) {
3592 os = _fetch_next_ocp_if(&p, &i);
3593 addr_cnt = _count_ocp_if_addr_spaces(os);
3595 for (j = 0; j < addr_cnt; j++) {
3596 (res + r)->name = (os->addr + j)->name;
3597 (res + r)->start = (os->addr + j)->pa_start;
3598 (res + r)->end = (os->addr + j)->pa_end;
3599 (res + r)->flags = IORESOURCE_MEM;
3608 * omap_hwmod_fill_dma_resources - fill struct resource array with dma data
3609 * @oh: struct omap_hwmod *
3610 * @res: pointer to the array of struct resource to fill
3612 * Fill the struct resource array @res with dma resource data from the
3613 * omap_hwmod @oh. Intended to be called by code that registers
3614 * omap_devices. See also omap_hwmod_count_resources(). Returns the
3615 * number of array elements filled.
3617 int omap_hwmod_fill_dma_resources(struct omap_hwmod *oh, struct resource *res)
3619 int i, sdma_reqs_cnt;
3622 sdma_reqs_cnt = _count_sdma_reqs(oh);
3623 for (i = 0; i < sdma_reqs_cnt; i++) {
3624 (res + r)->name = (oh->sdma_reqs + i)->name;
3625 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
3626 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
3627 (res + r)->flags = IORESOURCE_DMA;
3635 * omap_hwmod_get_resource_byname - fetch IP block integration data by name
3636 * @oh: struct omap_hwmod * to operate on
3637 * @type: one of the IORESOURCE_* constants from include/linux/ioport.h
3638 * @name: pointer to the name of the data to fetch (optional)
3639 * @rsrc: pointer to a struct resource, allocated by the caller
3641 * Retrieve MPU IRQ, SDMA request line, or address space start/end
3642 * data for the IP block pointed to by @oh. The data will be filled
3643 * into a struct resource record pointed to by @rsrc. The struct
3644 * resource must be allocated by the caller. When @name is non-null,
3645 * the data associated with the matching entry in the IRQ/SDMA/address
3646 * space hwmod data arrays will be returned. If @name is null, the
3647 * first array entry will be returned. Data order is not meaningful
3648 * in hwmod data, so callers are strongly encouraged to use a non-null
3649 * @name whenever possible to avoid unpredictable effects if hwmod
3650 * data is later added that causes data ordering to change. This
3651 * function is only intended for use by OMAP core code. Device
3652 * drivers should not call this function - the appropriate bus-related
3653 * data accessor functions should be used instead. Returns 0 upon
3654 * success or a negative error code upon error.
3656 int omap_hwmod_get_resource_byname(struct omap_hwmod *oh, unsigned int type,
3657 const char *name, struct resource *rsrc)
3660 unsigned int irq, dma;
3661 u32 pa_start, pa_end;
3666 if (type == IORESOURCE_IRQ) {
3667 r = _get_mpu_irq_by_name(oh, name, &irq);
3673 } else if (type == IORESOURCE_DMA) {
3674 r = _get_sdma_req_by_name(oh, name, &dma);
3680 } else if (type == IORESOURCE_MEM) {
3681 r = _get_addr_space_by_name(oh, name, &pa_start, &pa_end);
3685 rsrc->start = pa_start;
3698 * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
3699 * @oh: struct omap_hwmod *
3701 * Return the powerdomain pointer associated with the OMAP module
3702 * @oh's main clock. If @oh does not have a main clk, return the
3703 * powerdomain associated with the interface clock associated with the
3704 * module's MPU port. (XXX Perhaps this should use the SDMA port
3705 * instead?) Returns NULL on error, or a struct powerdomain * on
3708 struct powerdomain *omap_hwmod_get_pwrdm(struct omap_hwmod *oh)
3711 struct omap_hwmod_ocp_if *oi;
3712 struct clockdomain *clkdm;
3713 struct clk_hw_omap *clk;
3719 return oh->clkdm->pwrdm.ptr;
3724 oi = _find_mpu_rt_port(oh);
3730 clk = to_clk_hw_omap(__clk_get_hw(c));
3735 return clkdm->pwrdm.ptr;
3739 * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
3740 * @oh: struct omap_hwmod *
3742 * Returns the virtual address corresponding to the beginning of the
3743 * module's register target, in the address range that is intended to
3744 * be used by the MPU. Returns the virtual address upon success or NULL
3747 void __iomem *omap_hwmod_get_mpu_rt_va(struct omap_hwmod *oh)
3752 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
3755 if (oh->_state == _HWMOD_STATE_UNKNOWN)
3758 return oh->_mpu_rt_va;
3762 * omap_hwmod_add_initiator_dep - add sleepdep from @init_oh to @oh
3763 * @oh: struct omap_hwmod *
3764 * @init_oh: struct omap_hwmod * (initiator)
3766 * Add a sleep dependency between the initiator @init_oh and @oh.
3767 * Intended to be called by DSP/Bridge code via platform_data for the
3768 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
3769 * code needs to add/del initiator dependencies dynamically
3770 * before/after accessing a device. Returns the return value from
3771 * _add_initiator_dep().
3773 * XXX Keep a usecount in the clockdomain code
3775 int omap_hwmod_add_initiator_dep(struct omap_hwmod *oh,
3776 struct omap_hwmod *init_oh)
3778 return _add_initiator_dep(oh, init_oh);
3782 * XXX what about functions for drivers to save/restore ocp_sysconfig
3783 * for context save/restore operations?
3787 * omap_hwmod_del_initiator_dep - remove sleepdep from @init_oh to @oh
3788 * @oh: struct omap_hwmod *
3789 * @init_oh: struct omap_hwmod * (initiator)
3791 * Remove a sleep dependency between the initiator @init_oh and @oh.
3792 * Intended to be called by DSP/Bridge code via platform_data for the
3793 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
3794 * code needs to add/del initiator dependencies dynamically
3795 * before/after accessing a device. Returns the return value from
3796 * _del_initiator_dep().
3798 * XXX Keep a usecount in the clockdomain code
3800 int omap_hwmod_del_initiator_dep(struct omap_hwmod *oh,
3801 struct omap_hwmod *init_oh)
3803 return _del_initiator_dep(oh, init_oh);
3807 * omap_hwmod_enable_wakeup - allow device to wake up the system
3808 * @oh: struct omap_hwmod *
3810 * Sets the module OCP socket ENAWAKEUP bit to allow the module to
3811 * send wakeups to the PRCM, and enable I/O ring wakeup events for
3812 * this IP block if it has dynamic mux entries. Eventually this
3813 * should set PRCM wakeup registers to cause the PRCM to receive
3814 * wakeup events from the module. Does not set any wakeup routing
3815 * registers beyond this point - if the module is to wake up any other
3816 * module or subsystem, that must be set separately. Called by
3817 * omap_device code. Returns -EINVAL on error or 0 upon success.
3819 int omap_hwmod_enable_wakeup(struct omap_hwmod *oh)
3821 unsigned long flags;
3824 spin_lock_irqsave(&oh->_lock, flags);
3826 if (oh->class->sysc &&
3827 (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)) {
3828 v = oh->_sysc_cache;
3829 _enable_wakeup(oh, &v);
3830 _write_sysconfig(v, oh);
3833 _set_idle_ioring_wakeup(oh, true);
3834 spin_unlock_irqrestore(&oh->_lock, flags);
3840 * omap_hwmod_disable_wakeup - prevent device from waking the system
3841 * @oh: struct omap_hwmod *
3843 * Clears the module OCP socket ENAWAKEUP bit to prevent the module
3844 * from sending wakeups to the PRCM, and disable I/O ring wakeup
3845 * events for this IP block if it has dynamic mux entries. Eventually
3846 * this should clear PRCM wakeup registers to cause the PRCM to ignore
3847 * wakeup events from the module. Does not set any wakeup routing
3848 * registers beyond this point - if the module is to wake up any other
3849 * module or subsystem, that must be set separately. Called by
3850 * omap_device code. Returns -EINVAL on error or 0 upon success.
3852 int omap_hwmod_disable_wakeup(struct omap_hwmod *oh)
3854 unsigned long flags;
3857 spin_lock_irqsave(&oh->_lock, flags);
3859 if (oh->class->sysc &&
3860 (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)) {
3861 v = oh->_sysc_cache;
3862 _disable_wakeup(oh, &v);
3863 _write_sysconfig(v, oh);
3866 _set_idle_ioring_wakeup(oh, false);
3867 spin_unlock_irqrestore(&oh->_lock, flags);
3873 * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
3874 * contained in the hwmod module.
3875 * @oh: struct omap_hwmod *
3876 * @name: name of the reset line to lookup and assert
3878 * Some IP like dsp, ipu or iva contain processor that require
3879 * an HW reset line to be assert / deassert in order to enable fully
3880 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3881 * yet supported on this OMAP; otherwise, passes along the return value
3882 * from _assert_hardreset().
3884 int omap_hwmod_assert_hardreset(struct omap_hwmod *oh, const char *name)
3887 unsigned long flags;
3892 spin_lock_irqsave(&oh->_lock, flags);
3893 ret = _assert_hardreset(oh, name);
3894 spin_unlock_irqrestore(&oh->_lock, flags);
3900 * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
3901 * contained in the hwmod module.
3902 * @oh: struct omap_hwmod *
3903 * @name: name of the reset line to look up and deassert
3905 * Some IP like dsp, ipu or iva contain processor that require
3906 * an HW reset line to be assert / deassert in order to enable fully
3907 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3908 * yet supported on this OMAP; otherwise, passes along the return value
3909 * from _deassert_hardreset().
3911 int omap_hwmod_deassert_hardreset(struct omap_hwmod *oh, const char *name)
3914 unsigned long flags;
3919 spin_lock_irqsave(&oh->_lock, flags);
3920 ret = _deassert_hardreset(oh, name);
3921 spin_unlock_irqrestore(&oh->_lock, flags);
3927 * omap_hwmod_read_hardreset - read the HW reset line state of submodules
3928 * contained in the hwmod module
3929 * @oh: struct omap_hwmod *
3930 * @name: name of the reset line to look up and read
3932 * Return the current state of the hwmod @oh's reset line named @name:
3933 * returns -EINVAL upon parameter error or if this operation
3934 * is unsupported on the current OMAP; otherwise, passes along the return
3935 * value from _read_hardreset().
3937 int omap_hwmod_read_hardreset(struct omap_hwmod *oh, const char *name)
3940 unsigned long flags;
3945 spin_lock_irqsave(&oh->_lock, flags);
3946 ret = _read_hardreset(oh, name);
3947 spin_unlock_irqrestore(&oh->_lock, flags);
3954 * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
3955 * @classname: struct omap_hwmod_class name to search for
3956 * @fn: callback function pointer to call for each hwmod in class @classname
3957 * @user: arbitrary context data to pass to the callback function
3959 * For each omap_hwmod of class @classname, call @fn.
3960 * If the callback function returns something other than
3961 * zero, the iterator is terminated, and the callback function's return
3962 * value is passed back to the caller. Returns 0 upon success, -EINVAL
3963 * if @classname or @fn are NULL, or passes back the error code from @fn.
3965 int omap_hwmod_for_each_by_class(const char *classname,
3966 int (*fn)(struct omap_hwmod *oh,
3970 struct omap_hwmod *temp_oh;
3973 if (!classname || !fn)
3976 pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
3977 __func__, classname);
3979 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
3980 if (!strcmp(temp_oh->class->name, classname)) {
3981 pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
3982 __func__, temp_oh->name);
3983 ret = (*fn)(temp_oh, user);
3990 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
3997 * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
3998 * @oh: struct omap_hwmod *
3999 * @state: state that _setup() should leave the hwmod in
4001 * Sets the hwmod state that @oh will enter at the end of _setup()
4002 * (called by omap_hwmod_setup_*()). See also the documentation
4003 * for _setup_postsetup(), above. Returns 0 upon success or
4004 * -EINVAL if there is a problem with the arguments or if the hwmod is
4005 * in the wrong state.
4007 int omap_hwmod_set_postsetup_state(struct omap_hwmod *oh, u8 state)
4010 unsigned long flags;
4015 if (state != _HWMOD_STATE_DISABLED &&
4016 state != _HWMOD_STATE_ENABLED &&
4017 state != _HWMOD_STATE_IDLE)
4020 spin_lock_irqsave(&oh->_lock, flags);
4022 if (oh->_state != _HWMOD_STATE_REGISTERED) {
4027 oh->_postsetup_state = state;
4031 spin_unlock_irqrestore(&oh->_lock, flags);
4037 * omap_hwmod_get_context_loss_count - get lost context count
4038 * @oh: struct omap_hwmod *
4040 * Returns the context loss count of associated @oh
4041 * upon success, or zero if no context loss data is available.
4043 * On OMAP4, this queries the per-hwmod context loss register,
4044 * assuming one exists. If not, or on OMAP2/3, this queries the
4045 * enclosing powerdomain context loss count.
4047 int omap_hwmod_get_context_loss_count(struct omap_hwmod *oh)
4049 struct powerdomain *pwrdm;
4052 if (soc_ops.get_context_lost)
4053 return soc_ops.get_context_lost(oh);
4055 pwrdm = omap_hwmod_get_pwrdm(oh);
4057 ret = pwrdm_get_context_loss_count(pwrdm);
4063 * omap_hwmod_no_setup_reset - prevent a hwmod from being reset upon setup
4064 * @oh: struct omap_hwmod *
4066 * Prevent the hwmod @oh from being reset during the setup process.
4067 * Intended for use by board-*.c files on boards with devices that
4068 * cannot tolerate being reset. Must be called before the hwmod has
4069 * been set up. Returns 0 upon success or negative error code upon
4072 int omap_hwmod_no_setup_reset(struct omap_hwmod *oh)
4077 if (oh->_state != _HWMOD_STATE_REGISTERED) {
4078 pr_err("omap_hwmod: %s: cannot prevent setup reset; in wrong state\n",
4083 oh->flags |= HWMOD_INIT_NO_RESET;
4089 * omap_hwmod_pad_route_irq - route an I/O pad wakeup to a particular MPU IRQ
4090 * @oh: struct omap_hwmod * containing hwmod mux entries
4091 * @pad_idx: array index in oh->mux of the hwmod mux entry to route wakeup
4092 * @irq_idx: the hwmod mpu_irqs array index of the IRQ to trigger on wakeup
4094 * When an I/O pad wakeup arrives for the dynamic or wakeup hwmod mux
4095 * entry number @pad_idx for the hwmod @oh, trigger the interrupt
4096 * service routine for the hwmod's mpu_irqs array index @irq_idx. If
4097 * this function is not called for a given pad_idx, then the ISR
4098 * associated with @oh's first MPU IRQ will be triggered when an I/O
4099 * pad wakeup occurs on that pad. Note that @pad_idx is the index of
4100 * the _dynamic or wakeup_ entry: if there are other entries not
4101 * marked with OMAP_DEVICE_PAD_WAKEUP or OMAP_DEVICE_PAD_REMUX, these
4102 * entries are NOT COUNTED in the dynamic pad index. This function
4103 * must be called separately for each pad that requires its interrupt
4104 * to be re-routed this way. Returns -EINVAL if there is an argument
4105 * problem or if @oh does not have hwmod mux entries or MPU IRQs;
4106 * returns -ENOMEM if memory cannot be allocated; or 0 upon success.
4108 * XXX This function interface is fragile. Rather than using array
4109 * indexes, which are subject to unpredictable change, it should be
4110 * using hwmod IRQ names, and some other stable key for the hwmod mux
4113 int omap_hwmod_pad_route_irq(struct omap_hwmod *oh, int pad_idx, int irq_idx)
4119 if (!oh || !oh->mux || !oh->mpu_irqs || pad_idx < 0 ||
4120 pad_idx >= oh->mux->nr_pads_dynamic)
4123 /* Check the number of available mpu_irqs */
4124 for (nr_irqs = 0; oh->mpu_irqs[nr_irqs].irq >= 0; nr_irqs++)
4127 if (irq_idx >= nr_irqs)
4130 if (!oh->mux->irqs) {
4131 /* XXX What frees this? */
4132 oh->mux->irqs = kzalloc(sizeof(int) * oh->mux->nr_pads_dynamic,
4137 oh->mux->irqs[pad_idx] = irq_idx;
4143 * omap_hwmod_init - initialize the hwmod code
4145 * Sets up some function pointers needed by the hwmod code to operate on the
4146 * currently-booted SoC. Intended to be called once during kernel init
4147 * before any hwmods are registered. No return value.
4149 void __init omap_hwmod_init(void)
4151 if (cpu_is_omap24xx()) {
4152 soc_ops.wait_target_ready = _omap2xxx_wait_target_ready;
4153 soc_ops.assert_hardreset = _omap2_assert_hardreset;
4154 soc_ops.deassert_hardreset = _omap2_deassert_hardreset;
4155 soc_ops.is_hardreset_asserted = _omap2_is_hardreset_asserted;
4156 } else if (cpu_is_omap34xx()) {
4157 soc_ops.wait_target_ready = _omap3xxx_wait_target_ready;
4158 soc_ops.assert_hardreset = _omap2_assert_hardreset;
4159 soc_ops.deassert_hardreset = _omap2_deassert_hardreset;
4160 soc_ops.is_hardreset_asserted = _omap2_is_hardreset_asserted;
4161 } else if (cpu_is_omap44xx() || soc_is_omap54xx()) {
4162 soc_ops.enable_module = _omap4_enable_module;
4163 soc_ops.disable_module = _omap4_disable_module;
4164 soc_ops.wait_target_ready = _omap4_wait_target_ready;
4165 soc_ops.assert_hardreset = _omap4_assert_hardreset;
4166 soc_ops.deassert_hardreset = _omap4_deassert_hardreset;
4167 soc_ops.is_hardreset_asserted = _omap4_is_hardreset_asserted;
4168 soc_ops.init_clkdm = _init_clkdm;
4169 soc_ops.update_context_lost = _omap4_update_context_lost;
4170 soc_ops.get_context_lost = _omap4_get_context_lost;
4171 } else if (soc_is_am33xx()) {
4172 soc_ops.enable_module = _am33xx_enable_module;
4173 soc_ops.disable_module = _am33xx_disable_module;
4174 soc_ops.wait_target_ready = _am33xx_wait_target_ready;
4175 soc_ops.assert_hardreset = _am33xx_assert_hardreset;
4176 soc_ops.deassert_hardreset = _am33xx_deassert_hardreset;
4177 soc_ops.is_hardreset_asserted = _am33xx_is_hardreset_asserted;
4178 soc_ops.init_clkdm = _init_clkdm;
4180 WARN(1, "omap_hwmod: unknown SoC type\n");
4187 * omap_hwmod_get_main_clk - get pointer to main clock name
4188 * @oh: struct omap_hwmod *
4190 * Returns the main clock name assocated with @oh upon success,
4191 * or NULL if @oh is NULL.
4193 const char *omap_hwmod_get_main_clk(struct omap_hwmod *oh)
4198 return oh->main_clk;