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>
143 #include <asm/system_misc.h>
146 #include "omap_hwmod.h"
150 #include "clockdomain.h"
151 #include "powerdomain.h"
154 #include "cminst44xx.h"
160 #include "prminst44xx.h"
164 /* Name of the OMAP hwmod for the MPU */
165 #define MPU_INITIATOR_NAME "mpu"
168 * Number of struct omap_hwmod_link records per struct
169 * omap_hwmod_ocp_if record (master->slave and slave->master)
171 #define LINKS_PER_OCP_IF 2
174 * struct omap_hwmod_soc_ops - fn ptrs for some SoC-specific operations
175 * @enable_module: function to enable a module (via MODULEMODE)
176 * @disable_module: function to disable a module (via MODULEMODE)
178 * XXX Eventually this functionality will be hidden inside the PRM/CM
179 * device drivers. Until then, this should avoid huge blocks of cpu_is_*()
180 * conditionals in this code.
182 struct omap_hwmod_soc_ops {
183 void (*enable_module)(struct omap_hwmod *oh);
184 int (*disable_module)(struct omap_hwmod *oh);
185 int (*wait_target_ready)(struct omap_hwmod *oh);
186 int (*assert_hardreset)(struct omap_hwmod *oh,
187 struct omap_hwmod_rst_info *ohri);
188 int (*deassert_hardreset)(struct omap_hwmod *oh,
189 struct omap_hwmod_rst_info *ohri);
190 int (*is_hardreset_asserted)(struct omap_hwmod *oh,
191 struct omap_hwmod_rst_info *ohri);
192 int (*init_clkdm)(struct omap_hwmod *oh);
193 void (*update_context_lost)(struct omap_hwmod *oh);
194 int (*get_context_lost)(struct omap_hwmod *oh);
197 /* soc_ops: adapts the omap_hwmod code to the currently-booted SoC */
198 static struct omap_hwmod_soc_ops soc_ops;
200 /* omap_hwmod_list contains all registered struct omap_hwmods */
201 static LIST_HEAD(omap_hwmod_list);
203 /* mpu_oh: used to add/remove MPU initiator from sleepdep list */
204 static struct omap_hwmod *mpu_oh;
206 /* io_chain_lock: used to serialize reconfigurations of the I/O chain */
207 static DEFINE_SPINLOCK(io_chain_lock);
210 * linkspace: ptr to a buffer that struct omap_hwmod_link records are
211 * allocated from - used to reduce the number of small memory
212 * allocations, which has a significant impact on performance
214 static struct omap_hwmod_link *linkspace;
217 * free_ls, max_ls: array indexes into linkspace; representing the
218 * next free struct omap_hwmod_link index, and the maximum number of
219 * struct omap_hwmod_link records allocated (respectively)
221 static unsigned short free_ls, max_ls, ls_supp;
223 /* inited: set to true once the hwmod code is initialized */
226 /* Private functions */
229 * _fetch_next_ocp_if - return the next OCP interface in a list
230 * @p: ptr to a ptr to the list_head inside the ocp_if to return
231 * @i: pointer to the index of the element pointed to by @p in the list
233 * Return a pointer to the struct omap_hwmod_ocp_if record
234 * containing the struct list_head pointed to by @p, and increment
235 * @p such that a future call to this routine will return the next
238 static struct omap_hwmod_ocp_if *_fetch_next_ocp_if(struct list_head **p,
241 struct omap_hwmod_ocp_if *oi;
243 oi = list_entry(*p, struct omap_hwmod_link, node)->ocp_if;
252 * _update_sysc_cache - return the module OCP_SYSCONFIG register, keep copy
253 * @oh: struct omap_hwmod *
255 * Load the current value of the hwmod OCP_SYSCONFIG register into the
256 * struct omap_hwmod for later use. Returns -EINVAL if the hwmod has no
257 * OCP_SYSCONFIG register or 0 upon success.
259 static int _update_sysc_cache(struct omap_hwmod *oh)
261 if (!oh->class->sysc) {
262 WARN(1, "omap_hwmod: %s: cannot read OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
266 /* XXX ensure module interface clock is up */
268 oh->_sysc_cache = omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
270 if (!(oh->class->sysc->sysc_flags & SYSC_NO_CACHE))
271 oh->_int_flags |= _HWMOD_SYSCONFIG_LOADED;
277 * _write_sysconfig - write a value to the module's OCP_SYSCONFIG register
278 * @v: OCP_SYSCONFIG value to write
279 * @oh: struct omap_hwmod *
281 * Write @v into the module class' OCP_SYSCONFIG register, if it has
282 * one. No return value.
284 static void _write_sysconfig(u32 v, struct omap_hwmod *oh)
286 if (!oh->class->sysc) {
287 WARN(1, "omap_hwmod: %s: cannot write OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
291 /* XXX ensure module interface clock is up */
293 /* Module might have lost context, always update cache and register */
295 omap_hwmod_write(v, oh, oh->class->sysc->sysc_offs);
299 * _set_master_standbymode: set the OCP_SYSCONFIG MIDLEMODE field in @v
300 * @oh: struct omap_hwmod *
301 * @standbymode: MIDLEMODE field bits
302 * @v: pointer to register contents to modify
304 * Update the master standby mode bits in @v to be @standbymode for
305 * the @oh hwmod. Does not write to the hardware. Returns -EINVAL
306 * upon error or 0 upon success.
308 static int _set_master_standbymode(struct omap_hwmod *oh, u8 standbymode,
314 if (!oh->class->sysc ||
315 !(oh->class->sysc->sysc_flags & SYSC_HAS_MIDLEMODE))
318 if (!oh->class->sysc->sysc_fields) {
319 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
323 mstandby_shift = oh->class->sysc->sysc_fields->midle_shift;
324 mstandby_mask = (0x3 << mstandby_shift);
326 *v &= ~mstandby_mask;
327 *v |= __ffs(standbymode) << mstandby_shift;
333 * _set_slave_idlemode: set the OCP_SYSCONFIG SIDLEMODE field in @v
334 * @oh: struct omap_hwmod *
335 * @idlemode: SIDLEMODE field bits
336 * @v: pointer to register contents to modify
338 * Update the slave idle mode bits in @v to be @idlemode for the @oh
339 * hwmod. Does not write to the hardware. Returns -EINVAL upon error
342 static int _set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode, u32 *v)
347 if (!oh->class->sysc ||
348 !(oh->class->sysc->sysc_flags & SYSC_HAS_SIDLEMODE))
351 if (!oh->class->sysc->sysc_fields) {
352 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
356 sidle_shift = oh->class->sysc->sysc_fields->sidle_shift;
357 sidle_mask = (0x3 << sidle_shift);
360 *v |= __ffs(idlemode) << sidle_shift;
366 * _set_clockactivity: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
367 * @oh: struct omap_hwmod *
368 * @clockact: CLOCKACTIVITY field bits
369 * @v: pointer to register contents to modify
371 * Update the clockactivity mode bits in @v to be @clockact for the
372 * @oh hwmod. Used for additional powersaving on some modules. Does
373 * not write to the hardware. Returns -EINVAL upon error or 0 upon
376 static int _set_clockactivity(struct omap_hwmod *oh, u8 clockact, u32 *v)
381 if (!oh->class->sysc ||
382 !(oh->class->sysc->sysc_flags & SYSC_HAS_CLOCKACTIVITY))
385 if (!oh->class->sysc->sysc_fields) {
386 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
390 clkact_shift = oh->class->sysc->sysc_fields->clkact_shift;
391 clkact_mask = (0x3 << clkact_shift);
394 *v |= clockact << clkact_shift;
400 * _set_softreset: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
401 * @oh: struct omap_hwmod *
402 * @v: pointer to register contents to modify
404 * Set the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
405 * error or 0 upon success.
407 static int _set_softreset(struct omap_hwmod *oh, u32 *v)
411 if (!oh->class->sysc ||
412 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
415 if (!oh->class->sysc->sysc_fields) {
416 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
420 softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
428 * _wait_softreset_complete - wait for an OCP softreset to complete
429 * @oh: struct omap_hwmod * to wait on
431 * Wait until the IP block represented by @oh reports that its OCP
432 * softreset is complete. This can be triggered by software (see
433 * _ocp_softreset()) or by hardware upon returning from off-mode (one
434 * example is HSMMC). Waits for up to MAX_MODULE_SOFTRESET_WAIT
435 * microseconds. Returns the number of microseconds waited.
437 static int _wait_softreset_complete(struct omap_hwmod *oh)
439 struct omap_hwmod_class_sysconfig *sysc;
443 sysc = oh->class->sysc;
445 if (sysc->sysc_flags & SYSS_HAS_RESET_STATUS)
446 omap_test_timeout((omap_hwmod_read(oh, sysc->syss_offs)
447 & SYSS_RESETDONE_MASK),
448 MAX_MODULE_SOFTRESET_WAIT, c);
449 else if (sysc->sysc_flags & SYSC_HAS_RESET_STATUS) {
450 softrst_mask = (0x1 << sysc->sysc_fields->srst_shift);
451 omap_test_timeout(!(omap_hwmod_read(oh, sysc->sysc_offs)
453 MAX_MODULE_SOFTRESET_WAIT, c);
460 * _set_dmadisable: set OCP_SYSCONFIG.DMADISABLE bit in @v
461 * @oh: struct omap_hwmod *
463 * The DMADISABLE bit is a semi-automatic bit present in sysconfig register
464 * of some modules. When the DMA must perform read/write accesses, the
465 * DMADISABLE bit is cleared by the hardware. But when the DMA must stop
466 * for power management, software must set the DMADISABLE bit back to 1.
468 * Set the DMADISABLE bit in @v for hwmod @oh. Returns -EINVAL upon
469 * error or 0 upon success.
471 static int _set_dmadisable(struct omap_hwmod *oh)
476 if (!oh->class->sysc ||
477 !(oh->class->sysc->sysc_flags & SYSC_HAS_DMADISABLE))
480 if (!oh->class->sysc->sysc_fields) {
481 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
485 /* clocks must be on for this operation */
486 if (oh->_state != _HWMOD_STATE_ENABLED) {
487 pr_warn("omap_hwmod: %s: dma can be disabled only from enabled state\n", oh->name);
491 pr_debug("omap_hwmod: %s: setting DMADISABLE\n", oh->name);
495 (0x1 << oh->class->sysc->sysc_fields->dmadisable_shift);
496 v |= dmadisable_mask;
497 _write_sysconfig(v, oh);
503 * _set_module_autoidle: set the OCP_SYSCONFIG AUTOIDLE field in @v
504 * @oh: struct omap_hwmod *
505 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
506 * @v: pointer to register contents to modify
508 * Update the module autoidle bit in @v to be @autoidle for the @oh
509 * hwmod. The autoidle bit controls whether the module can gate
510 * internal clocks automatically when it isn't doing anything; the
511 * exact function of this bit varies on a per-module basis. This
512 * function does not write to the hardware. Returns -EINVAL upon
513 * error or 0 upon success.
515 static int _set_module_autoidle(struct omap_hwmod *oh, u8 autoidle,
521 if (!oh->class->sysc ||
522 !(oh->class->sysc->sysc_flags & SYSC_HAS_AUTOIDLE))
525 if (!oh->class->sysc->sysc_fields) {
526 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
530 autoidle_shift = oh->class->sysc->sysc_fields->autoidle_shift;
531 autoidle_mask = (0x1 << autoidle_shift);
533 *v &= ~autoidle_mask;
534 *v |= autoidle << autoidle_shift;
540 * _set_idle_ioring_wakeup - enable/disable IO pad wakeup on hwmod idle for mux
541 * @oh: struct omap_hwmod *
542 * @set_wake: bool value indicating to set (true) or clear (false) wakeup enable
544 * Set or clear the I/O pad wakeup flag in the mux entries for the
545 * hwmod @oh. This function changes the @oh->mux->pads_dynamic array
546 * in memory. If the hwmod is currently idled, and the new idle
547 * values don't match the previous ones, this function will also
548 * update the SCM PADCTRL registers. Otherwise, if the hwmod is not
549 * currently idled, this function won't touch the hardware: the new
550 * mux settings are written to the SCM PADCTRL registers when the
551 * hwmod is idled. No return value.
553 static void _set_idle_ioring_wakeup(struct omap_hwmod *oh, bool set_wake)
555 struct omap_device_pad *pad;
560 if (!oh->mux || !oh->mux->enabled)
563 for (j = 0; j < oh->mux->nr_pads_dynamic; j++) {
564 pad = oh->mux->pads_dynamic[j];
566 if (!(pad->flags & OMAP_DEVICE_PAD_WAKEUP))
569 prev_idle = pad->idle;
572 pad->idle |= OMAP_WAKEUP_EN;
574 pad->idle &= ~OMAP_WAKEUP_EN;
576 if (prev_idle != pad->idle)
580 if (change && oh->_state == _HWMOD_STATE_IDLE)
581 omap_hwmod_mux(oh->mux, _HWMOD_STATE_IDLE);
585 * _enable_wakeup: set OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
586 * @oh: struct omap_hwmod *
588 * Allow the hardware module @oh to send wakeups. Returns -EINVAL
589 * upon error or 0 upon success.
591 static int _enable_wakeup(struct omap_hwmod *oh, u32 *v)
593 if (!oh->class->sysc ||
594 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
595 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
596 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
599 if (!oh->class->sysc->sysc_fields) {
600 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
604 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
605 *v |= 0x1 << oh->class->sysc->sysc_fields->enwkup_shift;
607 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
608 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
609 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
610 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
612 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
614 oh->_int_flags |= _HWMOD_WAKEUP_ENABLED;
620 * _disable_wakeup: clear OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
621 * @oh: struct omap_hwmod *
623 * Prevent the hardware module @oh to send wakeups. Returns -EINVAL
624 * upon error or 0 upon success.
626 static int _disable_wakeup(struct omap_hwmod *oh, u32 *v)
628 if (!oh->class->sysc ||
629 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
630 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
631 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
634 if (!oh->class->sysc->sysc_fields) {
635 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
639 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
640 *v &= ~(0x1 << oh->class->sysc->sysc_fields->enwkup_shift);
642 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
643 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART, v);
644 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
645 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART, v);
647 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
649 oh->_int_flags &= ~_HWMOD_WAKEUP_ENABLED;
654 static struct clockdomain *_get_clkdm(struct omap_hwmod *oh)
656 struct clk_hw_omap *clk;
660 } else if (oh->_clk) {
661 clk = to_clk_hw_omap(__clk_get_hw(oh->_clk));
668 * _add_initiator_dep: prevent @oh from smart-idling while @init_oh is active
669 * @oh: struct omap_hwmod *
671 * Prevent the hardware module @oh from entering idle while the
672 * hardare module initiator @init_oh is active. Useful when a module
673 * will be accessed by a particular initiator (e.g., if a module will
674 * be accessed by the IVA, there should be a sleepdep between the IVA
675 * initiator and the module). Only applies to modules in smart-idle
676 * mode. If the clockdomain is marked as not needing autodeps, return
677 * 0 without doing anything. Otherwise, returns -EINVAL upon error or
678 * passes along clkdm_add_sleepdep() value upon success.
680 static int _add_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
682 struct clockdomain *clkdm, *init_clkdm;
684 clkdm = _get_clkdm(oh);
685 init_clkdm = _get_clkdm(init_oh);
687 if (!clkdm || !init_clkdm)
690 if (clkdm && clkdm->flags & CLKDM_NO_AUTODEPS)
693 return clkdm_add_sleepdep(clkdm, init_clkdm);
697 * _del_initiator_dep: allow @oh to smart-idle even if @init_oh is active
698 * @oh: struct omap_hwmod *
700 * Allow the hardware module @oh to enter idle while the hardare
701 * module initiator @init_oh is active. Useful when a module will not
702 * be accessed by a particular initiator (e.g., if a module will not
703 * be accessed by the IVA, there should be no sleepdep between the IVA
704 * initiator and the module). Only applies to modules in smart-idle
705 * mode. If the clockdomain is marked as not needing autodeps, return
706 * 0 without doing anything. Returns -EINVAL upon error or passes
707 * along clkdm_del_sleepdep() value upon success.
709 static int _del_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
711 struct clockdomain *clkdm, *init_clkdm;
713 clkdm = _get_clkdm(oh);
714 init_clkdm = _get_clkdm(init_oh);
716 if (!clkdm || !init_clkdm)
719 if (clkdm && clkdm->flags & CLKDM_NO_AUTODEPS)
722 return clkdm_del_sleepdep(clkdm, init_clkdm);
726 * _init_main_clk - get a struct clk * for the the hwmod's main functional clk
727 * @oh: struct omap_hwmod *
729 * Called from _init_clocks(). Populates the @oh _clk (main
730 * functional clock pointer) if a main_clk is present. Returns 0 on
731 * success or -EINVAL on error.
733 static int _init_main_clk(struct omap_hwmod *oh)
740 oh->_clk = clk_get(NULL, oh->main_clk);
741 if (IS_ERR(oh->_clk)) {
742 pr_warning("omap_hwmod: %s: cannot clk_get main_clk %s\n",
743 oh->name, oh->main_clk);
747 * HACK: This needs a re-visit once clk_prepare() is implemented
748 * to do something meaningful. Today its just a no-op.
749 * If clk_prepare() is used at some point to do things like
750 * voltage scaling etc, then this would have to be moved to
751 * some point where subsystems like i2c and pmic become
754 clk_prepare(oh->_clk);
757 pr_debug("omap_hwmod: %s: missing clockdomain for %s.\n",
758 oh->name, oh->main_clk);
764 * _init_interface_clks - get a struct clk * for the the hwmod's interface clks
765 * @oh: struct omap_hwmod *
767 * Called from _init_clocks(). Populates the @oh OCP slave interface
768 * clock pointers. Returns 0 on success or -EINVAL on error.
770 static int _init_interface_clks(struct omap_hwmod *oh)
772 struct omap_hwmod_ocp_if *os;
778 p = oh->slave_ports.next;
780 while (i < oh->slaves_cnt) {
781 os = _fetch_next_ocp_if(&p, &i);
785 c = clk_get(NULL, os->clk);
787 pr_warning("omap_hwmod: %s: cannot clk_get interface_clk %s\n",
793 * HACK: This needs a re-visit once clk_prepare() is implemented
794 * to do something meaningful. Today its just a no-op.
795 * If clk_prepare() is used at some point to do things like
796 * voltage scaling etc, then this would have to be moved to
797 * some point where subsystems like i2c and pmic become
800 clk_prepare(os->_clk);
807 * _init_opt_clk - get a struct clk * for the the hwmod's optional clocks
808 * @oh: struct omap_hwmod *
810 * Called from _init_clocks(). Populates the @oh omap_hwmod_opt_clk
811 * clock pointers. Returns 0 on success or -EINVAL on error.
813 static int _init_opt_clks(struct omap_hwmod *oh)
815 struct omap_hwmod_opt_clk *oc;
820 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++) {
821 c = clk_get(NULL, oc->clk);
823 pr_warning("omap_hwmod: %s: cannot clk_get opt_clk %s\n",
829 * HACK: This needs a re-visit once clk_prepare() is implemented
830 * to do something meaningful. Today its just a no-op.
831 * If clk_prepare() is used at some point to do things like
832 * voltage scaling etc, then this would have to be moved to
833 * some point where subsystems like i2c and pmic become
836 clk_prepare(oc->_clk);
843 * _enable_clocks - enable hwmod main clock and interface clocks
844 * @oh: struct omap_hwmod *
846 * Enables all clocks necessary for register reads and writes to succeed
847 * on the hwmod @oh. Returns 0.
849 static int _enable_clocks(struct omap_hwmod *oh)
851 struct omap_hwmod_ocp_if *os;
855 pr_debug("omap_hwmod: %s: enabling clocks\n", oh->name);
858 clk_enable(oh->_clk);
860 p = oh->slave_ports.next;
862 while (i < oh->slaves_cnt) {
863 os = _fetch_next_ocp_if(&p, &i);
865 if (os->_clk && (os->flags & OCPIF_SWSUP_IDLE))
866 clk_enable(os->_clk);
869 /* The opt clocks are controlled by the device driver. */
875 * _disable_clocks - disable hwmod main clock and interface clocks
876 * @oh: struct omap_hwmod *
878 * Disables the hwmod @oh main functional and interface clocks. Returns 0.
880 static int _disable_clocks(struct omap_hwmod *oh)
882 struct omap_hwmod_ocp_if *os;
886 pr_debug("omap_hwmod: %s: disabling clocks\n", oh->name);
889 clk_disable(oh->_clk);
891 p = oh->slave_ports.next;
893 while (i < oh->slaves_cnt) {
894 os = _fetch_next_ocp_if(&p, &i);
896 if (os->_clk && (os->flags & OCPIF_SWSUP_IDLE))
897 clk_disable(os->_clk);
900 /* The opt clocks are controlled by the device driver. */
905 static void _enable_optional_clocks(struct omap_hwmod *oh)
907 struct omap_hwmod_opt_clk *oc;
910 pr_debug("omap_hwmod: %s: enabling optional clocks\n", oh->name);
912 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
914 pr_debug("omap_hwmod: enable %s:%s\n", oc->role,
915 __clk_get_name(oc->_clk));
916 clk_enable(oc->_clk);
920 static void _disable_optional_clocks(struct omap_hwmod *oh)
922 struct omap_hwmod_opt_clk *oc;
925 pr_debug("omap_hwmod: %s: disabling optional clocks\n", oh->name);
927 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
929 pr_debug("omap_hwmod: disable %s:%s\n", oc->role,
930 __clk_get_name(oc->_clk));
931 clk_disable(oc->_clk);
936 * _omap4_enable_module - enable CLKCTRL modulemode on OMAP4
937 * @oh: struct omap_hwmod *
939 * Enables the PRCM module mode related to the hwmod @oh.
942 static void _omap4_enable_module(struct omap_hwmod *oh)
944 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
947 pr_debug("omap_hwmod: %s: %s: %d\n",
948 oh->name, __func__, oh->prcm.omap4.modulemode);
950 omap4_cminst_module_enable(oh->prcm.omap4.modulemode,
951 oh->clkdm->prcm_partition,
953 oh->clkdm->clkdm_offs,
954 oh->prcm.omap4.clkctrl_offs);
958 * _am33xx_enable_module - enable CLKCTRL modulemode on AM33XX
959 * @oh: struct omap_hwmod *
961 * Enables the PRCM module mode related to the hwmod @oh.
964 static void _am33xx_enable_module(struct omap_hwmod *oh)
966 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
969 pr_debug("omap_hwmod: %s: %s: %d\n",
970 oh->name, __func__, oh->prcm.omap4.modulemode);
972 am33xx_cm_module_enable(oh->prcm.omap4.modulemode, oh->clkdm->cm_inst,
973 oh->clkdm->clkdm_offs,
974 oh->prcm.omap4.clkctrl_offs);
978 * _omap4_wait_target_disable - wait for a module to be disabled on OMAP4
979 * @oh: struct omap_hwmod *
981 * Wait for a module @oh to enter slave idle. Returns 0 if the module
982 * does not have an IDLEST bit or if the module successfully enters
983 * slave idle; otherwise, pass along the return value of the
984 * appropriate *_cm*_wait_module_idle() function.
986 static int _omap4_wait_target_disable(struct omap_hwmod *oh)
991 if (oh->_int_flags & _HWMOD_NO_MPU_PORT || !oh->clkdm)
994 if (oh->flags & HWMOD_NO_IDLEST)
997 return omap4_cminst_wait_module_idle(oh->clkdm->prcm_partition,
999 oh->clkdm->clkdm_offs,
1000 oh->prcm.omap4.clkctrl_offs);
1004 * _am33xx_wait_target_disable - wait for a module to be disabled on AM33XX
1005 * @oh: struct omap_hwmod *
1007 * Wait for a module @oh to enter slave idle. Returns 0 if the module
1008 * does not have an IDLEST bit or if the module successfully enters
1009 * slave idle; otherwise, pass along the return value of the
1010 * appropriate *_cm*_wait_module_idle() function.
1012 static int _am33xx_wait_target_disable(struct omap_hwmod *oh)
1017 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
1020 if (oh->flags & HWMOD_NO_IDLEST)
1023 return am33xx_cm_wait_module_idle(oh->clkdm->cm_inst,
1024 oh->clkdm->clkdm_offs,
1025 oh->prcm.omap4.clkctrl_offs);
1029 * _count_mpu_irqs - count the number of MPU IRQ lines associated with @oh
1030 * @oh: struct omap_hwmod *oh
1032 * Count and return the number of MPU IRQs associated with the hwmod
1033 * @oh. Used to allocate struct resource data. Returns 0 if @oh is
1036 static int _count_mpu_irqs(struct omap_hwmod *oh)
1038 struct omap_hwmod_irq_info *ohii;
1041 if (!oh || !oh->mpu_irqs)
1045 ohii = &oh->mpu_irqs[i++];
1046 } while (ohii->irq != -1);
1052 * _count_sdma_reqs - count the number of SDMA request lines associated with @oh
1053 * @oh: struct omap_hwmod *oh
1055 * Count and return the number of SDMA request lines associated with
1056 * the hwmod @oh. Used to allocate struct resource data. Returns 0
1059 static int _count_sdma_reqs(struct omap_hwmod *oh)
1061 struct omap_hwmod_dma_info *ohdi;
1064 if (!oh || !oh->sdma_reqs)
1068 ohdi = &oh->sdma_reqs[i++];
1069 } while (ohdi->dma_req != -1);
1075 * _count_ocp_if_addr_spaces - count the number of address space entries for @oh
1076 * @oh: struct omap_hwmod *oh
1078 * Count and return the number of address space ranges associated with
1079 * the hwmod @oh. Used to allocate struct resource data. Returns 0
1082 static int _count_ocp_if_addr_spaces(struct omap_hwmod_ocp_if *os)
1084 struct omap_hwmod_addr_space *mem;
1087 if (!os || !os->addr)
1091 mem = &os->addr[i++];
1092 } while (mem->pa_start != mem->pa_end);
1098 * _get_mpu_irq_by_name - fetch MPU interrupt line number by name
1099 * @oh: struct omap_hwmod * to operate on
1100 * @name: pointer to the name of the MPU interrupt number to fetch (optional)
1101 * @irq: pointer to an unsigned int to store the MPU IRQ number to
1103 * Retrieve a MPU hardware IRQ line number named by @name associated
1104 * with the IP block pointed to by @oh. The IRQ number will be filled
1105 * into the address pointed to by @dma. When @name is non-null, the
1106 * IRQ line number associated with the named entry will be returned.
1107 * If @name is null, the first matching entry will be returned. Data
1108 * order is not meaningful in hwmod data, so callers are strongly
1109 * encouraged to use a non-null @name whenever possible to avoid
1110 * unpredictable effects if hwmod data is later added that causes data
1111 * ordering to change. Returns 0 upon success or a negative error
1114 static int _get_mpu_irq_by_name(struct omap_hwmod *oh, const char *name,
1124 while (oh->mpu_irqs[i].irq != -1) {
1125 if (name == oh->mpu_irqs[i].name ||
1126 !strcmp(name, oh->mpu_irqs[i].name)) {
1136 *irq = oh->mpu_irqs[i].irq;
1142 * _get_sdma_req_by_name - fetch SDMA request line ID by name
1143 * @oh: struct omap_hwmod * to operate on
1144 * @name: pointer to the name of the SDMA request line to fetch (optional)
1145 * @dma: pointer to an unsigned int to store the request line ID to
1147 * Retrieve an SDMA request line ID named by @name on the IP block
1148 * pointed to by @oh. The ID will be filled into the address pointed
1149 * to by @dma. When @name is non-null, the request line ID associated
1150 * with the named entry will be returned. If @name is null, the first
1151 * matching entry will be returned. Data order is not meaningful in
1152 * hwmod data, so callers are strongly encouraged to use a non-null
1153 * @name whenever possible to avoid unpredictable effects if hwmod
1154 * data is later added that causes data ordering to change. Returns 0
1155 * upon success or a negative error code upon error.
1157 static int _get_sdma_req_by_name(struct omap_hwmod *oh, const char *name,
1167 while (oh->sdma_reqs[i].dma_req != -1) {
1168 if (name == oh->sdma_reqs[i].name ||
1169 !strcmp(name, oh->sdma_reqs[i].name)) {
1179 *dma = oh->sdma_reqs[i].dma_req;
1185 * _get_addr_space_by_name - fetch address space start & end by name
1186 * @oh: struct omap_hwmod * to operate on
1187 * @name: pointer to the name of the address space to fetch (optional)
1188 * @pa_start: pointer to a u32 to store the starting address to
1189 * @pa_end: pointer to a u32 to store the ending address to
1191 * Retrieve address space start and end addresses for the IP block
1192 * pointed to by @oh. The data will be filled into the addresses
1193 * pointed to by @pa_start and @pa_end. When @name is non-null, the
1194 * address space data associated with the named entry will be
1195 * returned. If @name is null, the first matching entry will be
1196 * returned. Data order is not meaningful in hwmod data, so callers
1197 * are strongly encouraged to use a non-null @name whenever possible
1198 * to avoid unpredictable effects if hwmod data is later added that
1199 * causes data ordering to change. Returns 0 upon success or a
1200 * negative error code upon error.
1202 static int _get_addr_space_by_name(struct omap_hwmod *oh, const char *name,
1203 u32 *pa_start, u32 *pa_end)
1206 struct omap_hwmod_ocp_if *os;
1207 struct list_head *p = NULL;
1210 p = oh->slave_ports.next;
1213 while (i < oh->slaves_cnt) {
1214 os = _fetch_next_ocp_if(&p, &i);
1220 while (os->addr[j].pa_start != os->addr[j].pa_end) {
1221 if (name == os->addr[j].name ||
1222 !strcmp(name, os->addr[j].name)) {
1236 *pa_start = os->addr[j].pa_start;
1237 *pa_end = os->addr[j].pa_end;
1243 * _save_mpu_port_index - find and save the index to @oh's MPU port
1244 * @oh: struct omap_hwmod *
1246 * Determines the array index of the OCP slave port that the MPU uses
1247 * to address the device, and saves it into the struct omap_hwmod.
1248 * Intended to be called during hwmod registration only. No return
1251 static void __init _save_mpu_port_index(struct omap_hwmod *oh)
1253 struct omap_hwmod_ocp_if *os = NULL;
1254 struct list_head *p;
1260 oh->_int_flags |= _HWMOD_NO_MPU_PORT;
1262 p = oh->slave_ports.next;
1264 while (i < oh->slaves_cnt) {
1265 os = _fetch_next_ocp_if(&p, &i);
1266 if (os->user & OCP_USER_MPU) {
1268 oh->_int_flags &= ~_HWMOD_NO_MPU_PORT;
1277 * _find_mpu_rt_port - return omap_hwmod_ocp_if accessible by the MPU
1278 * @oh: struct omap_hwmod *
1280 * Given a pointer to a struct omap_hwmod record @oh, return a pointer
1281 * to the struct omap_hwmod_ocp_if record that is used by the MPU to
1282 * communicate with the IP block. This interface need not be directly
1283 * connected to the MPU (and almost certainly is not), but is directly
1284 * connected to the IP block represented by @oh. Returns a pointer
1285 * to the struct omap_hwmod_ocp_if * upon success, or returns NULL upon
1286 * error or if there does not appear to be a path from the MPU to this
1289 static struct omap_hwmod_ocp_if *_find_mpu_rt_port(struct omap_hwmod *oh)
1291 if (!oh || oh->_int_flags & _HWMOD_NO_MPU_PORT || oh->slaves_cnt == 0)
1294 return oh->_mpu_port;
1298 * _find_mpu_rt_addr_space - return MPU register target address space for @oh
1299 * @oh: struct omap_hwmod *
1301 * Returns a pointer to the struct omap_hwmod_addr_space record representing
1302 * the register target MPU address space; or returns NULL upon error.
1304 static struct omap_hwmod_addr_space * __init _find_mpu_rt_addr_space(struct omap_hwmod *oh)
1306 struct omap_hwmod_ocp_if *os;
1307 struct omap_hwmod_addr_space *mem;
1308 int found = 0, i = 0;
1310 os = _find_mpu_rt_port(oh);
1311 if (!os || !os->addr)
1315 mem = &os->addr[i++];
1316 if (mem->flags & ADDR_TYPE_RT)
1318 } while (!found && mem->pa_start != mem->pa_end);
1320 return (found) ? mem : NULL;
1324 * _enable_sysc - try to bring a module out of idle via OCP_SYSCONFIG
1325 * @oh: struct omap_hwmod *
1327 * Ensure that the OCP_SYSCONFIG register for the IP block represented
1328 * by @oh is set to indicate to the PRCM that the IP block is active.
1329 * Usually this means placing the module into smart-idle mode and
1330 * smart-standby, but if there is a bug in the automatic idle handling
1331 * for the IP block, it may need to be placed into the force-idle or
1332 * no-idle variants of these modes. No return value.
1334 static void _enable_sysc(struct omap_hwmod *oh)
1339 struct clockdomain *clkdm;
1341 if (!oh->class->sysc)
1345 * Wait until reset has completed, this is needed as the IP
1346 * block is reset automatically by hardware in some cases
1347 * (off-mode for example), and the drivers require the
1348 * IP to be ready when they access it
1350 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1351 _enable_optional_clocks(oh);
1352 _wait_softreset_complete(oh);
1353 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1354 _disable_optional_clocks(oh);
1356 v = oh->_sysc_cache;
1357 sf = oh->class->sysc->sysc_flags;
1359 clkdm = _get_clkdm(oh);
1360 if (sf & SYSC_HAS_SIDLEMODE) {
1361 clkdm_act = (clkdm && clkdm->flags & CLKDM_ACTIVE_WITH_MPU);
1362 if (clkdm_act && !(oh->class->sysc->idlemodes &
1363 (SIDLE_SMART | SIDLE_SMART_WKUP)))
1364 idlemode = HWMOD_IDLEMODE_FORCE;
1366 idlemode = (oh->flags & HWMOD_SWSUP_SIDLE) ?
1367 HWMOD_IDLEMODE_NO : HWMOD_IDLEMODE_SMART;
1368 _set_slave_idlemode(oh, idlemode, &v);
1371 if (sf & SYSC_HAS_MIDLEMODE) {
1372 if (oh->flags & HWMOD_FORCE_MSTANDBY) {
1373 idlemode = HWMOD_IDLEMODE_FORCE;
1374 } else if (oh->flags & HWMOD_SWSUP_MSTANDBY) {
1375 idlemode = HWMOD_IDLEMODE_NO;
1377 if (sf & SYSC_HAS_ENAWAKEUP)
1378 _enable_wakeup(oh, &v);
1379 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1380 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1382 idlemode = HWMOD_IDLEMODE_SMART;
1384 _set_master_standbymode(oh, idlemode, &v);
1388 * XXX The clock framework should handle this, by
1389 * calling into this code. But this must wait until the
1390 * clock structures are tagged with omap_hwmod entries
1392 if ((oh->flags & HWMOD_SET_DEFAULT_CLOCKACT) &&
1393 (sf & SYSC_HAS_CLOCKACTIVITY))
1394 _set_clockactivity(oh, oh->class->sysc->clockact, &v);
1396 /* If slave is in SMARTIDLE, also enable wakeup */
1397 if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
1398 _enable_wakeup(oh, &v);
1400 _write_sysconfig(v, oh);
1403 * Set the autoidle bit only after setting the smartidle bit
1404 * Setting this will not have any impact on the other modules.
1406 if (sf & SYSC_HAS_AUTOIDLE) {
1407 idlemode = (oh->flags & HWMOD_NO_OCP_AUTOIDLE) ?
1409 _set_module_autoidle(oh, idlemode, &v);
1410 _write_sysconfig(v, oh);
1415 * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
1416 * @oh: struct omap_hwmod *
1418 * If module is marked as SWSUP_SIDLE, force the module into slave
1419 * idle; otherwise, configure it for smart-idle. If module is marked
1420 * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
1421 * configure it for smart-standby. No return value.
1423 static void _idle_sysc(struct omap_hwmod *oh)
1428 if (!oh->class->sysc)
1431 v = oh->_sysc_cache;
1432 sf = oh->class->sysc->sysc_flags;
1434 if (sf & SYSC_HAS_SIDLEMODE) {
1435 /* XXX What about HWMOD_IDLEMODE_SMART_WKUP? */
1436 if (oh->flags & HWMOD_SWSUP_SIDLE ||
1437 !(oh->class->sysc->idlemodes &
1438 (SIDLE_SMART | SIDLE_SMART_WKUP)))
1439 idlemode = HWMOD_IDLEMODE_FORCE;
1441 idlemode = HWMOD_IDLEMODE_SMART;
1442 _set_slave_idlemode(oh, idlemode, &v);
1445 if (sf & SYSC_HAS_MIDLEMODE) {
1446 if ((oh->flags & HWMOD_SWSUP_MSTANDBY) ||
1447 (oh->flags & HWMOD_FORCE_MSTANDBY)) {
1448 idlemode = HWMOD_IDLEMODE_FORCE;
1450 if (sf & SYSC_HAS_ENAWAKEUP)
1451 _enable_wakeup(oh, &v);
1452 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1453 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1455 idlemode = HWMOD_IDLEMODE_SMART;
1457 _set_master_standbymode(oh, idlemode, &v);
1460 /* If slave is in SMARTIDLE, also enable wakeup */
1461 if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
1462 _enable_wakeup(oh, &v);
1464 _write_sysconfig(v, oh);
1468 * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
1469 * @oh: struct omap_hwmod *
1471 * Force the module into slave idle and master suspend. No return
1474 static void _shutdown_sysc(struct omap_hwmod *oh)
1479 if (!oh->class->sysc)
1482 v = oh->_sysc_cache;
1483 sf = oh->class->sysc->sysc_flags;
1485 if (sf & SYSC_HAS_SIDLEMODE)
1486 _set_slave_idlemode(oh, HWMOD_IDLEMODE_FORCE, &v);
1488 if (sf & SYSC_HAS_MIDLEMODE)
1489 _set_master_standbymode(oh, HWMOD_IDLEMODE_FORCE, &v);
1491 if (sf & SYSC_HAS_AUTOIDLE)
1492 _set_module_autoidle(oh, 1, &v);
1494 _write_sysconfig(v, oh);
1498 * _lookup - find an omap_hwmod by name
1499 * @name: find an omap_hwmod by name
1501 * Return a pointer to an omap_hwmod by name, or NULL if not found.
1503 static struct omap_hwmod *_lookup(const char *name)
1505 struct omap_hwmod *oh, *temp_oh;
1509 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1510 if (!strcmp(name, temp_oh->name)) {
1520 * _init_clkdm - look up a clockdomain name, store pointer in omap_hwmod
1521 * @oh: struct omap_hwmod *
1523 * Convert a clockdomain name stored in a struct omap_hwmod into a
1524 * clockdomain pointer, and save it into the struct omap_hwmod.
1525 * Return -EINVAL if the clkdm_name lookup failed.
1527 static int _init_clkdm(struct omap_hwmod *oh)
1529 if (!oh->clkdm_name) {
1530 pr_debug("omap_hwmod: %s: missing clockdomain\n", oh->name);
1534 oh->clkdm = clkdm_lookup(oh->clkdm_name);
1536 pr_warning("omap_hwmod: %s: could not associate to clkdm %s\n",
1537 oh->name, oh->clkdm_name);
1541 pr_debug("omap_hwmod: %s: associated to clkdm %s\n",
1542 oh->name, oh->clkdm_name);
1548 * _init_clocks - clk_get() all clocks associated with this hwmod. Retrieve as
1549 * well the clockdomain.
1550 * @oh: struct omap_hwmod *
1551 * @data: not used; pass NULL
1553 * Called by omap_hwmod_setup_*() (after omap2_clk_init()).
1554 * Resolves all clock names embedded in the hwmod. Returns 0 on
1555 * success, or a negative error code on failure.
1557 static int _init_clocks(struct omap_hwmod *oh, void *data)
1561 if (oh->_state != _HWMOD_STATE_REGISTERED)
1564 pr_debug("omap_hwmod: %s: looking up clocks\n", oh->name);
1566 if (soc_ops.init_clkdm)
1567 ret |= soc_ops.init_clkdm(oh);
1569 ret |= _init_main_clk(oh);
1570 ret |= _init_interface_clks(oh);
1571 ret |= _init_opt_clks(oh);
1574 oh->_state = _HWMOD_STATE_CLKS_INITED;
1576 pr_warning("omap_hwmod: %s: cannot _init_clocks\n", oh->name);
1582 * _lookup_hardreset - fill register bit info for this hwmod/reset line
1583 * @oh: struct omap_hwmod *
1584 * @name: name of the reset line in the context of this hwmod
1585 * @ohri: struct omap_hwmod_rst_info * that this function will fill in
1587 * Return the bit position of the reset line that match the
1588 * input name. Return -ENOENT if not found.
1590 static int _lookup_hardreset(struct omap_hwmod *oh, const char *name,
1591 struct omap_hwmod_rst_info *ohri)
1595 for (i = 0; i < oh->rst_lines_cnt; i++) {
1596 const char *rst_line = oh->rst_lines[i].name;
1597 if (!strcmp(rst_line, name)) {
1598 ohri->rst_shift = oh->rst_lines[i].rst_shift;
1599 ohri->st_shift = oh->rst_lines[i].st_shift;
1600 pr_debug("omap_hwmod: %s: %s: %s: rst %d st %d\n",
1601 oh->name, __func__, rst_line, ohri->rst_shift,
1612 * _assert_hardreset - assert the HW reset line of submodules
1613 * contained in the hwmod module.
1614 * @oh: struct omap_hwmod *
1615 * @name: name of the reset line to lookup and assert
1617 * Some IP like dsp, ipu or iva contain processor that require an HW
1618 * reset line to be assert / deassert in order to enable fully the IP.
1619 * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1620 * asserting the hardreset line on the currently-booted SoC, or passes
1621 * along the return value from _lookup_hardreset() or the SoC's
1622 * assert_hardreset code.
1624 static int _assert_hardreset(struct omap_hwmod *oh, const char *name)
1626 struct omap_hwmod_rst_info ohri;
1632 if (!soc_ops.assert_hardreset)
1635 ret = _lookup_hardreset(oh, name, &ohri);
1639 ret = soc_ops.assert_hardreset(oh, &ohri);
1645 * _deassert_hardreset - deassert the HW reset line of submodules contained
1646 * in the hwmod module.
1647 * @oh: struct omap_hwmod *
1648 * @name: name of the reset line to look up and deassert
1650 * Some IP like dsp, ipu or iva contain processor that require an HW
1651 * reset line to be assert / deassert in order to enable fully the IP.
1652 * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1653 * deasserting the hardreset line on the currently-booted SoC, or passes
1654 * along the return value from _lookup_hardreset() or the SoC's
1655 * deassert_hardreset code.
1657 static int _deassert_hardreset(struct omap_hwmod *oh, const char *name)
1659 struct omap_hwmod_rst_info ohri;
1666 if (!soc_ops.deassert_hardreset)
1669 ret = _lookup_hardreset(oh, name, &ohri);
1670 if (IS_ERR_VALUE(ret))
1675 * A clockdomain must be in SW_SUP otherwise reset
1676 * might not be completed. The clockdomain can be set
1677 * in HW_AUTO only when the module become ready.
1679 hwsup = clkdm_in_hwsup(oh->clkdm);
1680 ret = clkdm_hwmod_enable(oh->clkdm, oh);
1682 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1683 oh->name, oh->clkdm->name, ret);
1689 if (soc_ops.enable_module)
1690 soc_ops.enable_module(oh);
1692 ret = soc_ops.deassert_hardreset(oh, &ohri);
1694 if (soc_ops.disable_module)
1695 soc_ops.disable_module(oh);
1696 _disable_clocks(oh);
1699 pr_warning("omap_hwmod: %s: failed to hardreset\n", oh->name);
1703 * Set the clockdomain to HW_AUTO, assuming that the
1704 * previous state was HW_AUTO.
1706 if (oh->clkdm && hwsup)
1707 clkdm_allow_idle(oh->clkdm);
1710 clkdm_hwmod_disable(oh->clkdm, oh);
1717 * _read_hardreset - read the HW reset line state of submodules
1718 * contained in the hwmod module
1719 * @oh: struct omap_hwmod *
1720 * @name: name of the reset line to look up and read
1722 * Return the state of the reset line. Returns -EINVAL if @oh is
1723 * null, -ENOSYS if we have no way of reading the hardreset line
1724 * status on the currently-booted SoC, or passes along the return
1725 * value from _lookup_hardreset() or the SoC's is_hardreset_asserted
1728 static int _read_hardreset(struct omap_hwmod *oh, const char *name)
1730 struct omap_hwmod_rst_info ohri;
1736 if (!soc_ops.is_hardreset_asserted)
1739 ret = _lookup_hardreset(oh, name, &ohri);
1743 return soc_ops.is_hardreset_asserted(oh, &ohri);
1747 * _are_all_hardreset_lines_asserted - return true if the @oh is hard-reset
1748 * @oh: struct omap_hwmod *
1750 * If all hardreset lines associated with @oh are asserted, then return true.
1751 * Otherwise, if part of @oh is out hardreset or if no hardreset lines
1752 * associated with @oh are asserted, then return false.
1753 * This function is used to avoid executing some parts of the IP block
1754 * enable/disable sequence if its hardreset line is set.
1756 static bool _are_all_hardreset_lines_asserted(struct omap_hwmod *oh)
1760 if (oh->rst_lines_cnt == 0)
1763 for (i = 0; i < oh->rst_lines_cnt; i++)
1764 if (_read_hardreset(oh, oh->rst_lines[i].name) > 0)
1767 if (oh->rst_lines_cnt == rst_cnt)
1774 * _are_any_hardreset_lines_asserted - return true if any part of @oh is
1776 * @oh: struct omap_hwmod *
1778 * If any hardreset lines associated with @oh are asserted, then
1779 * return true. Otherwise, if no hardreset lines associated with @oh
1780 * are asserted, or if @oh has no hardreset lines, then return false.
1781 * This function is used to avoid executing some parts of the IP block
1782 * enable/disable sequence if any hardreset line is set.
1784 static bool _are_any_hardreset_lines_asserted(struct omap_hwmod *oh)
1789 for (i = 0; i < oh->rst_lines_cnt && rst_cnt == 0; i++)
1790 if (_read_hardreset(oh, oh->rst_lines[i].name) > 0)
1793 return (rst_cnt) ? true : false;
1797 * _omap4_disable_module - enable CLKCTRL modulemode on OMAP4
1798 * @oh: struct omap_hwmod *
1800 * Disable the PRCM module mode related to the hwmod @oh.
1801 * Return EINVAL if the modulemode is not supported and 0 in case of success.
1803 static int _omap4_disable_module(struct omap_hwmod *oh)
1807 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
1811 * Since integration code might still be doing something, only
1812 * disable if all lines are under hardreset.
1814 if (_are_any_hardreset_lines_asserted(oh))
1817 pr_debug("omap_hwmod: %s: %s\n", oh->name, __func__);
1819 omap4_cminst_module_disable(oh->clkdm->prcm_partition,
1821 oh->clkdm->clkdm_offs,
1822 oh->prcm.omap4.clkctrl_offs);
1824 v = _omap4_wait_target_disable(oh);
1826 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1833 * _am33xx_disable_module - enable CLKCTRL modulemode on AM33XX
1834 * @oh: struct omap_hwmod *
1836 * Disable the PRCM module mode related to the hwmod @oh.
1837 * Return EINVAL if the modulemode is not supported and 0 in case of success.
1839 static int _am33xx_disable_module(struct omap_hwmod *oh)
1843 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
1846 pr_debug("omap_hwmod: %s: %s\n", oh->name, __func__);
1848 if (_are_any_hardreset_lines_asserted(oh))
1851 am33xx_cm_module_disable(oh->clkdm->cm_inst, oh->clkdm->clkdm_offs,
1852 oh->prcm.omap4.clkctrl_offs);
1854 v = _am33xx_wait_target_disable(oh);
1856 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1863 * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1864 * @oh: struct omap_hwmod *
1866 * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit. hwmod must be
1867 * enabled for this to work. Returns -ENOENT if the hwmod cannot be
1868 * reset this way, -EINVAL if the hwmod is in the wrong state,
1869 * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1871 * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1872 * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1873 * use the SYSCONFIG softreset bit to provide the status.
1875 * Note that some IP like McBSP do have reset control but don't have
1878 static int _ocp_softreset(struct omap_hwmod *oh)
1884 if (!oh->class->sysc ||
1885 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
1888 /* clocks must be on for this operation */
1889 if (oh->_state != _HWMOD_STATE_ENABLED) {
1890 pr_warn("omap_hwmod: %s: reset can only be entered from enabled state\n",
1895 /* For some modules, all optionnal clocks need to be enabled as well */
1896 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1897 _enable_optional_clocks(oh);
1899 pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh->name);
1901 v = oh->_sysc_cache;
1902 ret = _set_softreset(oh, &v);
1905 _write_sysconfig(v, oh);
1907 if (oh->class->sysc->srst_udelay)
1908 udelay(oh->class->sysc->srst_udelay);
1910 c = _wait_softreset_complete(oh);
1911 if (c == MAX_MODULE_SOFTRESET_WAIT)
1912 pr_warning("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1913 oh->name, MAX_MODULE_SOFTRESET_WAIT);
1915 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh->name, c);
1918 * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1919 * _wait_target_ready() or _reset()
1922 ret = (c == MAX_MODULE_SOFTRESET_WAIT) ? -ETIMEDOUT : 0;
1925 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1926 _disable_optional_clocks(oh);
1932 * _reset - reset an omap_hwmod
1933 * @oh: struct omap_hwmod *
1935 * Resets an omap_hwmod @oh. If the module has a custom reset
1936 * function pointer defined, then call it to reset the IP block, and
1937 * pass along its return value to the caller. Otherwise, if the IP
1938 * block has an OCP_SYSCONFIG register with a SOFTRESET bitfield
1939 * associated with it, call a function to reset the IP block via that
1940 * method, and pass along the return value to the caller. Finally, if
1941 * the IP block has some hardreset lines associated with it, assert
1942 * all of those, but do _not_ deassert them. (This is because driver
1943 * authors have expressed an apparent requirement to control the
1944 * deassertion of the hardreset lines themselves.)
1946 * The default software reset mechanism for most OMAP IP blocks is
1947 * triggered via the OCP_SYSCONFIG.SOFTRESET bit. However, some
1948 * hwmods cannot be reset via this method. Some are not targets and
1949 * therefore have no OCP header registers to access. Others (like the
1950 * IVA) have idiosyncratic reset sequences. So for these relatively
1951 * rare cases, custom reset code can be supplied in the struct
1952 * omap_hwmod_class .reset function pointer.
1954 * _set_dmadisable() is called to set the DMADISABLE bit so that it
1955 * does not prevent idling of the system. This is necessary for cases
1956 * where ROMCODE/BOOTLOADER uses dma and transfers control to the
1957 * kernel without disabling dma.
1959 * Passes along the return value from either _ocp_softreset() or the
1960 * custom reset function - these must return -EINVAL if the hwmod
1961 * cannot be reset this way or if the hwmod is in the wrong state,
1962 * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1964 static int _reset(struct omap_hwmod *oh)
1968 pr_debug("omap_hwmod: %s: resetting\n", oh->name);
1970 if (oh->class->reset) {
1971 r = oh->class->reset(oh);
1973 if (oh->rst_lines_cnt > 0) {
1974 for (i = 0; i < oh->rst_lines_cnt; i++)
1975 _assert_hardreset(oh, oh->rst_lines[i].name);
1978 r = _ocp_softreset(oh);
1984 _set_dmadisable(oh);
1987 * OCP_SYSCONFIG bits need to be reprogrammed after a
1988 * softreset. The _enable() function should be split to avoid
1989 * the rewrite of the OCP_SYSCONFIG register.
1991 if (oh->class->sysc) {
1992 _update_sysc_cache(oh);
2000 * _reconfigure_io_chain - clear any I/O chain wakeups and reconfigure chain
2002 * Call the appropriate PRM function to clear any logged I/O chain
2003 * wakeups and to reconfigure the chain. This apparently needs to be
2004 * done upon every mux change. Since hwmods can be concurrently
2005 * enabled and idled, hold a spinlock around the I/O chain
2006 * reconfiguration sequence. No return value.
2008 * XXX When the PRM code is moved to drivers, this function can be removed,
2009 * as the PRM infrastructure should abstract this.
2011 static void _reconfigure_io_chain(void)
2013 unsigned long flags;
2015 spin_lock_irqsave(&io_chain_lock, flags);
2017 if (cpu_is_omap34xx() && omap3_has_io_chain_ctrl())
2018 omap3xxx_prm_reconfigure_io_chain();
2019 else if (cpu_is_omap44xx())
2020 omap44xx_prm_reconfigure_io_chain();
2022 spin_unlock_irqrestore(&io_chain_lock, flags);
2026 * _omap4_update_context_lost - increment hwmod context loss counter if
2027 * hwmod context was lost, and clear hardware context loss reg
2028 * @oh: hwmod to check for context loss
2030 * If the PRCM indicates that the hwmod @oh lost context, increment
2031 * our in-memory context loss counter, and clear the RM_*_CONTEXT
2032 * bits. No return value.
2034 static void _omap4_update_context_lost(struct omap_hwmod *oh)
2036 if (oh->prcm.omap4.flags & HWMOD_OMAP4_NO_CONTEXT_LOSS_BIT)
2039 if (!prm_was_any_context_lost_old(oh->clkdm->pwrdm.ptr->prcm_partition,
2040 oh->clkdm->pwrdm.ptr->prcm_offs,
2041 oh->prcm.omap4.context_offs))
2044 oh->prcm.omap4.context_lost_counter++;
2045 prm_clear_context_loss_flags_old(oh->clkdm->pwrdm.ptr->prcm_partition,
2046 oh->clkdm->pwrdm.ptr->prcm_offs,
2047 oh->prcm.omap4.context_offs);
2051 * _omap4_get_context_lost - get context loss counter for a hwmod
2052 * @oh: hwmod to get context loss counter for
2054 * Returns the in-memory context loss counter for a hwmod.
2056 static int _omap4_get_context_lost(struct omap_hwmod *oh)
2058 return oh->prcm.omap4.context_lost_counter;
2062 * _enable_preprogram - Pre-program an IP block during the _enable() process
2063 * @oh: struct omap_hwmod *
2065 * Some IP blocks (such as AESS) require some additional programming
2066 * after enable before they can enter idle. If a function pointer to
2067 * do so is present in the hwmod data, then call it and pass along the
2068 * return value; otherwise, return 0.
2070 static int __init _enable_preprogram(struct omap_hwmod *oh)
2072 if (!oh->class->enable_preprogram)
2075 return oh->class->enable_preprogram(oh);
2079 * _enable - enable an omap_hwmod
2080 * @oh: struct omap_hwmod *
2082 * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
2083 * register target. Returns -EINVAL if the hwmod is in the wrong
2084 * state or passes along the return value of _wait_target_ready().
2086 static int _enable(struct omap_hwmod *oh)
2091 pr_debug("omap_hwmod: %s: enabling\n", oh->name);
2094 * hwmods with HWMOD_INIT_NO_IDLE flag set are left in enabled
2095 * state at init. Now that someone is really trying to enable
2096 * them, just ensure that the hwmod mux is set.
2098 if (oh->_int_flags & _HWMOD_SKIP_ENABLE) {
2100 * If the caller has mux data populated, do the mux'ing
2101 * which wouldn't have been done as part of the _enable()
2102 * done during setup.
2105 omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
2107 oh->_int_flags &= ~_HWMOD_SKIP_ENABLE;
2111 if (oh->_state != _HWMOD_STATE_INITIALIZED &&
2112 oh->_state != _HWMOD_STATE_IDLE &&
2113 oh->_state != _HWMOD_STATE_DISABLED) {
2114 WARN(1, "omap_hwmod: %s: enabled state can only be entered from initialized, idle, or disabled state\n",
2120 * If an IP block contains HW reset lines and all of them are
2121 * asserted, we let integration code associated with that
2122 * block handle the enable. We've received very little
2123 * information on what those driver authors need, and until
2124 * detailed information is provided and the driver code is
2125 * posted to the public lists, this is probably the best we
2128 if (_are_all_hardreset_lines_asserted(oh))
2131 /* Mux pins for device runtime if populated */
2132 if (oh->mux && (!oh->mux->enabled ||
2133 ((oh->_state == _HWMOD_STATE_IDLE) &&
2134 oh->mux->pads_dynamic))) {
2135 omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
2136 _reconfigure_io_chain();
2139 _add_initiator_dep(oh, mpu_oh);
2143 * A clockdomain must be in SW_SUP before enabling
2144 * completely the module. The clockdomain can be set
2145 * in HW_AUTO only when the module become ready.
2147 hwsup = clkdm_in_hwsup(oh->clkdm) &&
2148 !clkdm_missing_idle_reporting(oh->clkdm);
2149 r = clkdm_hwmod_enable(oh->clkdm, oh);
2151 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
2152 oh->name, oh->clkdm->name, r);
2158 if (soc_ops.enable_module)
2159 soc_ops.enable_module(oh);
2160 if (oh->flags & HWMOD_BLOCK_WFI)
2161 cpu_idle_poll_ctrl(true);
2163 if (soc_ops.update_context_lost)
2164 soc_ops.update_context_lost(oh);
2166 r = (soc_ops.wait_target_ready) ? soc_ops.wait_target_ready(oh) :
2170 * Set the clockdomain to HW_AUTO only if the target is ready,
2171 * assuming that the previous state was HW_AUTO
2173 if (oh->clkdm && hwsup)
2174 clkdm_allow_idle(oh->clkdm);
2176 oh->_state = _HWMOD_STATE_ENABLED;
2178 /* Access the sysconfig only if the target is ready */
2179 if (oh->class->sysc) {
2180 if (!(oh->_int_flags & _HWMOD_SYSCONFIG_LOADED))
2181 _update_sysc_cache(oh);
2184 r = _enable_preprogram(oh);
2186 if (soc_ops.disable_module)
2187 soc_ops.disable_module(oh);
2188 _disable_clocks(oh);
2189 pr_debug("omap_hwmod: %s: _wait_target_ready: %d\n",
2193 clkdm_hwmod_disable(oh->clkdm, oh);
2200 * _idle - idle an omap_hwmod
2201 * @oh: struct omap_hwmod *
2203 * Idles an omap_hwmod @oh. This should be called once the hwmod has
2204 * no further work. Returns -EINVAL if the hwmod is in the wrong
2205 * state or returns 0.
2207 static int _idle(struct omap_hwmod *oh)
2209 pr_debug("omap_hwmod: %s: idling\n", oh->name);
2211 if (oh->_state != _HWMOD_STATE_ENABLED) {
2212 WARN(1, "omap_hwmod: %s: idle state can only be entered from enabled state\n",
2217 if (_are_all_hardreset_lines_asserted(oh))
2220 if (oh->class->sysc)
2222 _del_initiator_dep(oh, mpu_oh);
2224 if (oh->flags & HWMOD_BLOCK_WFI)
2225 cpu_idle_poll_ctrl(false);
2226 if (soc_ops.disable_module)
2227 soc_ops.disable_module(oh);
2230 * The module must be in idle mode before disabling any parents
2231 * clocks. Otherwise, the parent clock might be disabled before
2232 * the module transition is done, and thus will prevent the
2233 * transition to complete properly.
2235 _disable_clocks(oh);
2237 clkdm_hwmod_disable(oh->clkdm, oh);
2239 /* Mux pins for device idle if populated */
2240 if (oh->mux && oh->mux->pads_dynamic) {
2241 omap_hwmod_mux(oh->mux, _HWMOD_STATE_IDLE);
2242 _reconfigure_io_chain();
2245 oh->_state = _HWMOD_STATE_IDLE;
2251 * omap_hwmod_set_ocp_autoidle - set the hwmod's OCP autoidle bit
2252 * @oh: struct omap_hwmod *
2253 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
2255 * Sets the IP block's OCP autoidle bit in hardware, and updates our
2256 * local copy. Intended to be used by drivers that require
2257 * direct manipulation of the AUTOIDLE bits.
2258 * Returns -EINVAL if @oh is null or is not in the ENABLED state, or passes
2259 * along the return value from _set_module_autoidle().
2261 * Any users of this function should be scrutinized carefully.
2263 int omap_hwmod_set_ocp_autoidle(struct omap_hwmod *oh, u8 autoidle)
2267 unsigned long flags;
2269 if (!oh || oh->_state != _HWMOD_STATE_ENABLED)
2272 spin_lock_irqsave(&oh->_lock, flags);
2274 v = oh->_sysc_cache;
2276 retval = _set_module_autoidle(oh, autoidle, &v);
2279 _write_sysconfig(v, oh);
2281 spin_unlock_irqrestore(&oh->_lock, flags);
2287 * _shutdown - shutdown an omap_hwmod
2288 * @oh: struct omap_hwmod *
2290 * Shut down an omap_hwmod @oh. This should be called when the driver
2291 * used for the hwmod is removed or unloaded or if the driver is not
2292 * used by the system. Returns -EINVAL if the hwmod is in the wrong
2293 * state or returns 0.
2295 static int _shutdown(struct omap_hwmod *oh)
2300 if (oh->_state != _HWMOD_STATE_IDLE &&
2301 oh->_state != _HWMOD_STATE_ENABLED) {
2302 WARN(1, "omap_hwmod: %s: disabled state can only be entered from idle, or enabled state\n",
2307 if (_are_all_hardreset_lines_asserted(oh))
2310 pr_debug("omap_hwmod: %s: disabling\n", oh->name);
2312 if (oh->class->pre_shutdown) {
2313 prev_state = oh->_state;
2314 if (oh->_state == _HWMOD_STATE_IDLE)
2316 ret = oh->class->pre_shutdown(oh);
2318 if (prev_state == _HWMOD_STATE_IDLE)
2324 if (oh->class->sysc) {
2325 if (oh->_state == _HWMOD_STATE_IDLE)
2330 /* clocks and deps are already disabled in idle */
2331 if (oh->_state == _HWMOD_STATE_ENABLED) {
2332 _del_initiator_dep(oh, mpu_oh);
2333 /* XXX what about the other system initiators here? dma, dsp */
2334 if (oh->flags & HWMOD_BLOCK_WFI)
2335 cpu_idle_poll_ctrl(false);
2336 if (soc_ops.disable_module)
2337 soc_ops.disable_module(oh);
2338 _disable_clocks(oh);
2340 clkdm_hwmod_disable(oh->clkdm, oh);
2342 /* XXX Should this code also force-disable the optional clocks? */
2344 for (i = 0; i < oh->rst_lines_cnt; i++)
2345 _assert_hardreset(oh, oh->rst_lines[i].name);
2347 /* Mux pins to safe mode or use populated off mode values */
2349 omap_hwmod_mux(oh->mux, _HWMOD_STATE_DISABLED);
2351 oh->_state = _HWMOD_STATE_DISABLED;
2357 * _init_mpu_rt_base - populate the virtual address for a hwmod
2358 * @oh: struct omap_hwmod * to locate the virtual address
2360 * Cache the virtual address used by the MPU to access this IP block's
2361 * registers. This address is needed early so the OCP registers that
2362 * are part of the device's address space can be ioremapped properly.
2365 static void __init _init_mpu_rt_base(struct omap_hwmod *oh, void *data)
2367 struct omap_hwmod_addr_space *mem;
2368 void __iomem *va_start;
2373 _save_mpu_port_index(oh);
2375 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2378 mem = _find_mpu_rt_addr_space(oh);
2380 pr_debug("omap_hwmod: %s: no MPU register target found\n",
2385 va_start = ioremap(mem->pa_start, mem->pa_end - mem->pa_start);
2387 pr_err("omap_hwmod: %s: Could not ioremap\n", oh->name);
2391 pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
2392 oh->name, va_start);
2394 oh->_mpu_rt_va = va_start;
2398 * _init - initialize internal data for the hwmod @oh
2399 * @oh: struct omap_hwmod *
2402 * Look up the clocks and the address space used by the MPU to access
2403 * registers belonging to the hwmod @oh. @oh must already be
2404 * registered at this point. This is the first of two phases for
2405 * hwmod initialization. Code called here does not touch any hardware
2406 * registers, it simply prepares internal data structures. Returns 0
2407 * upon success or if the hwmod isn't registered, or -EINVAL upon
2410 static int __init _init(struct omap_hwmod *oh, void *data)
2414 if (oh->_state != _HWMOD_STATE_REGISTERED)
2417 _init_mpu_rt_base(oh, NULL);
2419 r = _init_clocks(oh, NULL);
2420 if (IS_ERR_VALUE(r)) {
2421 WARN(1, "omap_hwmod: %s: couldn't init clocks\n", oh->name);
2425 oh->_state = _HWMOD_STATE_INITIALIZED;
2431 * _setup_iclk_autoidle - configure an IP block's interface clocks
2432 * @oh: struct omap_hwmod *
2434 * Set up the module's interface clocks. XXX This function is still mostly
2435 * a stub; implementing this properly requires iclk autoidle usecounting in
2436 * the clock code. No return value.
2438 static void __init _setup_iclk_autoidle(struct omap_hwmod *oh)
2440 struct omap_hwmod_ocp_if *os;
2441 struct list_head *p;
2443 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2446 p = oh->slave_ports.next;
2448 while (i < oh->slaves_cnt) {
2449 os = _fetch_next_ocp_if(&p, &i);
2453 if (os->flags & OCPIF_SWSUP_IDLE) {
2454 /* XXX omap_iclk_deny_idle(c); */
2456 /* XXX omap_iclk_allow_idle(c); */
2457 clk_enable(os->_clk);
2465 * _setup_reset - reset an IP block during the setup process
2466 * @oh: struct omap_hwmod *
2468 * Reset the IP block corresponding to the hwmod @oh during the setup
2469 * process. The IP block is first enabled so it can be successfully
2470 * reset. Returns 0 upon success or a negative error code upon
2473 static int __init _setup_reset(struct omap_hwmod *oh)
2477 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2480 if (oh->flags & HWMOD_EXT_OPT_MAIN_CLK)
2483 if (oh->rst_lines_cnt == 0) {
2486 pr_warning("omap_hwmod: %s: cannot be enabled for reset (%d)\n",
2487 oh->name, oh->_state);
2492 if (!(oh->flags & HWMOD_INIT_NO_RESET))
2499 * _setup_postsetup - transition to the appropriate state after _setup
2500 * @oh: struct omap_hwmod *
2502 * Place an IP block represented by @oh into a "post-setup" state --
2503 * either IDLE, ENABLED, or DISABLED. ("post-setup" simply means that
2504 * this function is called at the end of _setup().) The postsetup
2505 * state for an IP block can be changed by calling
2506 * omap_hwmod_enter_postsetup_state() early in the boot process,
2507 * before one of the omap_hwmod_setup*() functions are called for the
2510 * The IP block stays in this state until a PM runtime-based driver is
2511 * loaded for that IP block. A post-setup state of IDLE is
2512 * appropriate for almost all IP blocks with runtime PM-enabled
2513 * drivers, since those drivers are able to enable the IP block. A
2514 * post-setup state of ENABLED is appropriate for kernels with PM
2515 * runtime disabled. The DISABLED state is appropriate for unusual IP
2516 * blocks such as the MPU WDTIMER on kernels without WDTIMER drivers
2517 * included, since the WDTIMER starts running on reset and will reset
2518 * the MPU if left active.
2520 * This post-setup mechanism is deprecated. Once all of the OMAP
2521 * drivers have been converted to use PM runtime, and all of the IP
2522 * block data and interconnect data is available to the hwmod code, it
2523 * should be possible to replace this mechanism with a "lazy reset"
2524 * arrangement. In a "lazy reset" setup, each IP block is enabled
2525 * when the driver first probes, then all remaining IP blocks without
2526 * drivers are either shut down or enabled after the drivers have
2527 * loaded. However, this cannot take place until the above
2528 * preconditions have been met, since otherwise the late reset code
2529 * has no way of knowing which IP blocks are in use by drivers, and
2530 * which ones are unused.
2534 static void __init _setup_postsetup(struct omap_hwmod *oh)
2538 if (oh->rst_lines_cnt > 0)
2541 postsetup_state = oh->_postsetup_state;
2542 if (postsetup_state == _HWMOD_STATE_UNKNOWN)
2543 postsetup_state = _HWMOD_STATE_ENABLED;
2546 * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
2547 * it should be set by the core code as a runtime flag during startup
2549 if ((oh->flags & HWMOD_INIT_NO_IDLE) &&
2550 (postsetup_state == _HWMOD_STATE_IDLE)) {
2551 oh->_int_flags |= _HWMOD_SKIP_ENABLE;
2552 postsetup_state = _HWMOD_STATE_ENABLED;
2555 if (postsetup_state == _HWMOD_STATE_IDLE)
2557 else if (postsetup_state == _HWMOD_STATE_DISABLED)
2559 else if (postsetup_state != _HWMOD_STATE_ENABLED)
2560 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
2561 oh->name, postsetup_state);
2567 * _setup - prepare IP block hardware for use
2568 * @oh: struct omap_hwmod *
2569 * @n: (unused, pass NULL)
2571 * Configure the IP block represented by @oh. This may include
2572 * enabling the IP block, resetting it, and placing it into a
2573 * post-setup state, depending on the type of IP block and applicable
2574 * flags. IP blocks are reset to prevent any previous configuration
2575 * by the bootloader or previous operating system from interfering
2576 * with power management or other parts of the system. The reset can
2577 * be avoided; see omap_hwmod_no_setup_reset(). This is the second of
2578 * two phases for hwmod initialization. Code called here generally
2579 * affects the IP block hardware, or system integration hardware
2580 * associated with the IP block. Returns 0.
2582 static int __init _setup(struct omap_hwmod *oh, void *data)
2584 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2587 _setup_iclk_autoidle(oh);
2589 if (!_setup_reset(oh))
2590 _setup_postsetup(oh);
2596 * _register - register a struct omap_hwmod
2597 * @oh: struct omap_hwmod *
2599 * Registers the omap_hwmod @oh. Returns -EEXIST if an omap_hwmod
2600 * already has been registered by the same name; -EINVAL if the
2601 * omap_hwmod is in the wrong state, if @oh is NULL, if the
2602 * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
2603 * name, or if the omap_hwmod's class is missing a name; or 0 upon
2606 * XXX The data should be copied into bootmem, so the original data
2607 * should be marked __initdata and freed after init. This would allow
2608 * unneeded omap_hwmods to be freed on multi-OMAP configurations. Note
2609 * that the copy process would be relatively complex due to the large number
2612 static int __init _register(struct omap_hwmod *oh)
2614 if (!oh || !oh->name || !oh->class || !oh->class->name ||
2615 (oh->_state != _HWMOD_STATE_UNKNOWN))
2618 pr_debug("omap_hwmod: %s: registering\n", oh->name);
2620 if (_lookup(oh->name))
2623 list_add_tail(&oh->node, &omap_hwmod_list);
2625 INIT_LIST_HEAD(&oh->master_ports);
2626 INIT_LIST_HEAD(&oh->slave_ports);
2627 spin_lock_init(&oh->_lock);
2629 oh->_state = _HWMOD_STATE_REGISTERED;
2632 * XXX Rather than doing a strcmp(), this should test a flag
2633 * set in the hwmod data, inserted by the autogenerator code.
2635 if (!strcmp(oh->name, MPU_INITIATOR_NAME))
2642 * _alloc_links - return allocated memory for hwmod links
2643 * @ml: pointer to a struct omap_hwmod_link * for the master link
2644 * @sl: pointer to a struct omap_hwmod_link * for the slave link
2646 * Return pointers to two struct omap_hwmod_link records, via the
2647 * addresses pointed to by @ml and @sl. Will first attempt to return
2648 * memory allocated as part of a large initial block, but if that has
2649 * been exhausted, will allocate memory itself. Since ideally this
2650 * second allocation path will never occur, the number of these
2651 * 'supplemental' allocations will be logged when debugging is
2652 * enabled. Returns 0.
2654 static int __init _alloc_links(struct omap_hwmod_link **ml,
2655 struct omap_hwmod_link **sl)
2659 if ((free_ls + LINKS_PER_OCP_IF) <= max_ls) {
2660 *ml = &linkspace[free_ls++];
2661 *sl = &linkspace[free_ls++];
2665 sz = sizeof(struct omap_hwmod_link) * LINKS_PER_OCP_IF;
2668 *ml = alloc_bootmem(sz);
2672 *sl = (void *)(*ml) + sizeof(struct omap_hwmod_link);
2675 pr_debug("omap_hwmod: supplemental link allocations needed: %d\n",
2676 ls_supp * LINKS_PER_OCP_IF);
2682 * _add_link - add an interconnect between two IP blocks
2683 * @oi: pointer to a struct omap_hwmod_ocp_if record
2685 * Add struct omap_hwmod_link records connecting the master IP block
2686 * specified in @oi->master to @oi, and connecting the slave IP block
2687 * specified in @oi->slave to @oi. This code is assumed to run before
2688 * preemption or SMP has been enabled, thus avoiding the need for
2689 * locking in this code. Changes to this assumption will require
2690 * additional locking. Returns 0.
2692 static int __init _add_link(struct omap_hwmod_ocp_if *oi)
2694 struct omap_hwmod_link *ml, *sl;
2696 pr_debug("omap_hwmod: %s -> %s: adding link\n", oi->master->name,
2699 _alloc_links(&ml, &sl);
2702 INIT_LIST_HEAD(&ml->node);
2703 list_add(&ml->node, &oi->master->master_ports);
2704 oi->master->masters_cnt++;
2707 INIT_LIST_HEAD(&sl->node);
2708 list_add(&sl->node, &oi->slave->slave_ports);
2709 oi->slave->slaves_cnt++;
2715 * _register_link - register a struct omap_hwmod_ocp_if
2716 * @oi: struct omap_hwmod_ocp_if *
2718 * Registers the omap_hwmod_ocp_if record @oi. Returns -EEXIST if it
2719 * has already been registered; -EINVAL if @oi is NULL or if the
2720 * record pointed to by @oi is missing required fields; or 0 upon
2723 * XXX The data should be copied into bootmem, so the original data
2724 * should be marked __initdata and freed after init. This would allow
2725 * unneeded omap_hwmods to be freed on multi-OMAP configurations.
2727 static int __init _register_link(struct omap_hwmod_ocp_if *oi)
2729 if (!oi || !oi->master || !oi->slave || !oi->user)
2732 if (oi->_int_flags & _OCPIF_INT_FLAGS_REGISTERED)
2735 pr_debug("omap_hwmod: registering link from %s to %s\n",
2736 oi->master->name, oi->slave->name);
2739 * Register the connected hwmods, if they haven't been
2740 * registered already
2742 if (oi->master->_state != _HWMOD_STATE_REGISTERED)
2743 _register(oi->master);
2745 if (oi->slave->_state != _HWMOD_STATE_REGISTERED)
2746 _register(oi->slave);
2750 oi->_int_flags |= _OCPIF_INT_FLAGS_REGISTERED;
2756 * _alloc_linkspace - allocate large block of hwmod links
2757 * @ois: pointer to an array of struct omap_hwmod_ocp_if records to count
2759 * Allocate a large block of struct omap_hwmod_link records. This
2760 * improves boot time significantly by avoiding the need to allocate
2761 * individual records one by one. If the number of records to
2762 * allocate in the block hasn't been manually specified, this function
2763 * will count the number of struct omap_hwmod_ocp_if records in @ois
2764 * and use that to determine the allocation size. For SoC families
2765 * that require multiple list registrations, such as OMAP3xxx, this
2766 * estimation process isn't optimal, so manual estimation is advised
2767 * in those cases. Returns -EEXIST if the allocation has already occurred
2768 * or 0 upon success.
2770 static int __init _alloc_linkspace(struct omap_hwmod_ocp_if **ois)
2776 WARN(1, "linkspace already allocated\n");
2782 max_ls += LINKS_PER_OCP_IF;
2784 sz = sizeof(struct omap_hwmod_link) * max_ls;
2786 pr_debug("omap_hwmod: %s: allocating %d byte linkspace (%d links)\n",
2787 __func__, sz, max_ls);
2789 linkspace = alloc_bootmem(sz);
2791 memset(linkspace, 0, sz);
2796 /* Static functions intended only for use in soc_ops field function pointers */
2799 * _omap2xxx_wait_target_ready - wait for a module to leave slave idle
2800 * @oh: struct omap_hwmod *
2802 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2803 * does not have an IDLEST bit or if the module successfully leaves
2804 * slave idle; otherwise, pass along the return value of the
2805 * appropriate *_cm*_wait_module_ready() function.
2807 static int _omap2xxx_wait_target_ready(struct omap_hwmod *oh)
2812 if (oh->flags & HWMOD_NO_IDLEST)
2815 if (!_find_mpu_rt_port(oh))
2818 /* XXX check module SIDLEMODE, hardreset status, enabled clocks */
2820 return omap2xxx_cm_wait_module_ready(oh->prcm.omap2.module_offs,
2821 oh->prcm.omap2.idlest_reg_id,
2822 oh->prcm.omap2.idlest_idle_bit);
2826 * _omap3xxx_wait_target_ready - wait for a module to leave slave idle
2827 * @oh: struct omap_hwmod *
2829 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2830 * does not have an IDLEST bit or if the module successfully leaves
2831 * slave idle; otherwise, pass along the return value of the
2832 * appropriate *_cm*_wait_module_ready() function.
2834 static int _omap3xxx_wait_target_ready(struct omap_hwmod *oh)
2839 if (oh->flags & HWMOD_NO_IDLEST)
2842 if (!_find_mpu_rt_port(oh))
2845 /* XXX check module SIDLEMODE, hardreset status, enabled clocks */
2847 return omap3xxx_cm_wait_module_ready(oh->prcm.omap2.module_offs,
2848 oh->prcm.omap2.idlest_reg_id,
2849 oh->prcm.omap2.idlest_idle_bit);
2853 * _omap4_wait_target_ready - wait for a module to leave slave idle
2854 * @oh: struct omap_hwmod *
2856 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2857 * does not have an IDLEST bit or if the module successfully leaves
2858 * slave idle; otherwise, pass along the return value of the
2859 * appropriate *_cm*_wait_module_ready() function.
2861 static int _omap4_wait_target_ready(struct omap_hwmod *oh)
2866 if (oh->flags & HWMOD_NO_IDLEST || !oh->clkdm)
2869 if (!_find_mpu_rt_port(oh))
2872 /* XXX check module SIDLEMODE, hardreset status */
2874 return omap4_cminst_wait_module_ready(oh->clkdm->prcm_partition,
2876 oh->clkdm->clkdm_offs,
2877 oh->prcm.omap4.clkctrl_offs);
2881 * _am33xx_wait_target_ready - wait for a module to leave slave idle
2882 * @oh: struct omap_hwmod *
2884 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2885 * does not have an IDLEST bit or if the module successfully leaves
2886 * slave idle; otherwise, pass along the return value of the
2887 * appropriate *_cm*_wait_module_ready() function.
2889 static int _am33xx_wait_target_ready(struct omap_hwmod *oh)
2891 if (!oh || !oh->clkdm)
2894 if (oh->flags & HWMOD_NO_IDLEST)
2897 if (!_find_mpu_rt_port(oh))
2900 /* XXX check module SIDLEMODE, hardreset status */
2902 return am33xx_cm_wait_module_ready(oh->clkdm->cm_inst,
2903 oh->clkdm->clkdm_offs,
2904 oh->prcm.omap4.clkctrl_offs);
2908 * _omap2_assert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2909 * @oh: struct omap_hwmod * to assert hardreset
2910 * @ohri: hardreset line data
2912 * Call omap2_prm_assert_hardreset() with parameters extracted from
2913 * the hwmod @oh and the hardreset line data @ohri. Only intended for
2914 * use as an soc_ops function pointer. Passes along the return value
2915 * from omap2_prm_assert_hardreset(). XXX This function is scheduled
2916 * for removal when the PRM code is moved into drivers/.
2918 static int _omap2_assert_hardreset(struct omap_hwmod *oh,
2919 struct omap_hwmod_rst_info *ohri)
2921 return omap2_prm_assert_hardreset(oh->prcm.omap2.module_offs,
2926 * _omap2_deassert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2927 * @oh: struct omap_hwmod * to deassert hardreset
2928 * @ohri: hardreset line data
2930 * Call omap2_prm_deassert_hardreset() with parameters extracted from
2931 * the hwmod @oh and the hardreset line data @ohri. Only intended for
2932 * use as an soc_ops function pointer. Passes along the return value
2933 * from omap2_prm_deassert_hardreset(). XXX This function is
2934 * scheduled for removal when the PRM code is moved into drivers/.
2936 static int _omap2_deassert_hardreset(struct omap_hwmod *oh,
2937 struct omap_hwmod_rst_info *ohri)
2939 return omap2_prm_deassert_hardreset(oh->prcm.omap2.module_offs,
2945 * _omap2_is_hardreset_asserted - call OMAP2 PRM hardreset fn with hwmod args
2946 * @oh: struct omap_hwmod * to test hardreset
2947 * @ohri: hardreset line data
2949 * Call omap2_prm_is_hardreset_asserted() with parameters extracted
2950 * from the hwmod @oh and the hardreset line data @ohri. Only
2951 * intended for use as an soc_ops function pointer. Passes along the
2952 * return value from omap2_prm_is_hardreset_asserted(). XXX This
2953 * function is scheduled for removal when the PRM code is moved into
2956 static int _omap2_is_hardreset_asserted(struct omap_hwmod *oh,
2957 struct omap_hwmod_rst_info *ohri)
2959 return omap2_prm_is_hardreset_asserted(oh->prcm.omap2.module_offs,
2964 * _omap4_assert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
2965 * @oh: struct omap_hwmod * to assert hardreset
2966 * @ohri: hardreset line data
2968 * Call omap4_prminst_assert_hardreset() with parameters extracted
2969 * from the hwmod @oh and the hardreset line data @ohri. Only
2970 * intended for use as an soc_ops function pointer. Passes along the
2971 * return value from omap4_prminst_assert_hardreset(). XXX This
2972 * function is scheduled for removal when the PRM code is moved into
2975 static int _omap4_assert_hardreset(struct omap_hwmod *oh,
2976 struct omap_hwmod_rst_info *ohri)
2981 return omap4_prminst_assert_hardreset(ohri->rst_shift,
2982 oh->clkdm->pwrdm.ptr->prcm_partition,
2983 oh->clkdm->pwrdm.ptr->prcm_offs,
2984 oh->prcm.omap4.rstctrl_offs);
2988 * _omap4_deassert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
2989 * @oh: struct omap_hwmod * to deassert hardreset
2990 * @ohri: hardreset line data
2992 * Call omap4_prminst_deassert_hardreset() with parameters extracted
2993 * from the hwmod @oh and the hardreset line data @ohri. Only
2994 * intended for use as an soc_ops function pointer. Passes along the
2995 * return value from omap4_prminst_deassert_hardreset(). XXX This
2996 * function is scheduled for removal when the PRM code is moved into
2999 static int _omap4_deassert_hardreset(struct omap_hwmod *oh,
3000 struct omap_hwmod_rst_info *ohri)
3006 pr_err("omap_hwmod: %s: %s: hwmod data error: OMAP4 does not support st_shift\n",
3007 oh->name, ohri->name);
3008 return omap4_prminst_deassert_hardreset(ohri->rst_shift,
3009 oh->clkdm->pwrdm.ptr->prcm_partition,
3010 oh->clkdm->pwrdm.ptr->prcm_offs,
3011 oh->prcm.omap4.rstctrl_offs);
3015 * _omap4_is_hardreset_asserted - call OMAP4 PRM hardreset fn with hwmod args
3016 * @oh: struct omap_hwmod * to test hardreset
3017 * @ohri: hardreset line data
3019 * Call omap4_prminst_is_hardreset_asserted() with parameters
3020 * extracted from the hwmod @oh and the hardreset line data @ohri.
3021 * Only intended for use as an soc_ops function pointer. Passes along
3022 * the return value from omap4_prminst_is_hardreset_asserted(). XXX
3023 * This function is scheduled for removal when the PRM code is moved
3026 static int _omap4_is_hardreset_asserted(struct omap_hwmod *oh,
3027 struct omap_hwmod_rst_info *ohri)
3032 return omap4_prminst_is_hardreset_asserted(ohri->rst_shift,
3033 oh->clkdm->pwrdm.ptr->prcm_partition,
3034 oh->clkdm->pwrdm.ptr->prcm_offs,
3035 oh->prcm.omap4.rstctrl_offs);
3039 * _am33xx_assert_hardreset - call AM33XX PRM hardreset fn with hwmod args
3040 * @oh: struct omap_hwmod * to assert hardreset
3041 * @ohri: hardreset line data
3043 * Call am33xx_prminst_assert_hardreset() with parameters extracted
3044 * from the hwmod @oh and the hardreset line data @ohri. Only
3045 * intended for use as an soc_ops function pointer. Passes along the
3046 * return value from am33xx_prminst_assert_hardreset(). XXX This
3047 * function is scheduled for removal when the PRM code is moved into
3050 static int _am33xx_assert_hardreset(struct omap_hwmod *oh,
3051 struct omap_hwmod_rst_info *ohri)
3054 return am33xx_prm_assert_hardreset(ohri->rst_shift,
3055 oh->clkdm->pwrdm.ptr->prcm_offs,
3056 oh->prcm.omap4.rstctrl_offs);
3060 * _am33xx_deassert_hardreset - call AM33XX PRM hardreset fn with hwmod args
3061 * @oh: struct omap_hwmod * to deassert hardreset
3062 * @ohri: hardreset line data
3064 * Call am33xx_prminst_deassert_hardreset() with parameters extracted
3065 * from the hwmod @oh and the hardreset line data @ohri. Only
3066 * intended for use as an soc_ops function pointer. Passes along the
3067 * return value from am33xx_prminst_deassert_hardreset(). XXX This
3068 * function is scheduled for removal when the PRM code is moved into
3071 static int _am33xx_deassert_hardreset(struct omap_hwmod *oh,
3072 struct omap_hwmod_rst_info *ohri)
3074 return am33xx_prm_deassert_hardreset(ohri->rst_shift,
3076 oh->clkdm->pwrdm.ptr->prcm_offs,
3077 oh->prcm.omap4.rstctrl_offs,
3078 oh->prcm.omap4.rstst_offs);
3082 * _am33xx_is_hardreset_asserted - call AM33XX PRM hardreset fn with hwmod args
3083 * @oh: struct omap_hwmod * to test hardreset
3084 * @ohri: hardreset line data
3086 * Call am33xx_prminst_is_hardreset_asserted() with parameters
3087 * extracted from the hwmod @oh and the hardreset line data @ohri.
3088 * Only intended for use as an soc_ops function pointer. Passes along
3089 * the return value from am33xx_prminst_is_hardreset_asserted(). XXX
3090 * This function is scheduled for removal when the PRM code is moved
3093 static int _am33xx_is_hardreset_asserted(struct omap_hwmod *oh,
3094 struct omap_hwmod_rst_info *ohri)
3096 return am33xx_prm_is_hardreset_asserted(ohri->rst_shift,
3097 oh->clkdm->pwrdm.ptr->prcm_offs,
3098 oh->prcm.omap4.rstctrl_offs);
3101 /* Public functions */
3103 u32 omap_hwmod_read(struct omap_hwmod *oh, u16 reg_offs)
3105 if (oh->flags & HWMOD_16BIT_REG)
3106 return __raw_readw(oh->_mpu_rt_va + reg_offs);
3108 return __raw_readl(oh->_mpu_rt_va + reg_offs);
3111 void omap_hwmod_write(u32 v, struct omap_hwmod *oh, u16 reg_offs)
3113 if (oh->flags & HWMOD_16BIT_REG)
3114 __raw_writew(v, oh->_mpu_rt_va + reg_offs);
3116 __raw_writel(v, oh->_mpu_rt_va + reg_offs);
3120 * omap_hwmod_softreset - reset a module via SYSCONFIG.SOFTRESET bit
3121 * @oh: struct omap_hwmod *
3123 * This is a public function exposed to drivers. Some drivers may need to do
3124 * some settings before and after resetting the device. Those drivers after
3125 * doing the necessary settings could use this function to start a reset by
3126 * setting the SYSCONFIG.SOFTRESET bit.
3128 int omap_hwmod_softreset(struct omap_hwmod *oh)
3133 if (!oh || !(oh->_sysc_cache))
3136 v = oh->_sysc_cache;
3137 ret = _set_softreset(oh, &v);
3140 _write_sysconfig(v, oh);
3147 * omap_hwmod_set_slave_idlemode - set the hwmod's OCP slave idlemode
3148 * @oh: struct omap_hwmod *
3149 * @idlemode: SIDLEMODE field bits (shifted to bit 0)
3151 * Sets the IP block's OCP slave idlemode in hardware, and updates our
3152 * local copy. Intended to be used by drivers that have some erratum
3153 * that requires direct manipulation of the SIDLEMODE bits. Returns
3154 * -EINVAL if @oh is null, or passes along the return value from
3155 * _set_slave_idlemode().
3157 * XXX Does this function have any current users? If not, we should
3158 * remove it; it is better to let the rest of the hwmod code handle this.
3159 * Any users of this function should be scrutinized carefully.
3161 int omap_hwmod_set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode)
3169 v = oh->_sysc_cache;
3171 retval = _set_slave_idlemode(oh, idlemode, &v);
3173 _write_sysconfig(v, oh);
3179 * omap_hwmod_lookup - look up a registered omap_hwmod by name
3180 * @name: name of the omap_hwmod to look up
3182 * Given a @name of an omap_hwmod, return a pointer to the registered
3183 * struct omap_hwmod *, or NULL upon error.
3185 struct omap_hwmod *omap_hwmod_lookup(const char *name)
3187 struct omap_hwmod *oh;
3198 * omap_hwmod_for_each - call function for each registered omap_hwmod
3199 * @fn: pointer to a callback function
3200 * @data: void * data to pass to callback function
3202 * Call @fn for each registered omap_hwmod, passing @data to each
3203 * function. @fn must return 0 for success or any other value for
3204 * failure. If @fn returns non-zero, the iteration across omap_hwmods
3205 * will stop and the non-zero return value will be passed to the
3206 * caller of omap_hwmod_for_each(). @fn is called with
3207 * omap_hwmod_for_each() held.
3209 int omap_hwmod_for_each(int (*fn)(struct omap_hwmod *oh, void *data),
3212 struct omap_hwmod *temp_oh;
3218 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
3219 ret = (*fn)(temp_oh, data);
3228 * omap_hwmod_register_links - register an array of hwmod links
3229 * @ois: pointer to an array of omap_hwmod_ocp_if to register
3231 * Intended to be called early in boot before the clock framework is
3232 * initialized. If @ois is not null, will register all omap_hwmods
3233 * listed in @ois that are valid for this chip. Returns -EINVAL if
3234 * omap_hwmod_init() hasn't been called before calling this function,
3235 * -ENOMEM if the link memory area can't be allocated, or 0 upon
3238 int __init omap_hwmod_register_links(struct omap_hwmod_ocp_if **ois)
3249 if (_alloc_linkspace(ois)) {
3250 pr_err("omap_hwmod: could not allocate link space\n");
3257 r = _register_link(ois[i]);
3258 WARN(r && r != -EEXIST,
3259 "omap_hwmod: _register_link(%s -> %s) returned %d\n",
3260 ois[i]->master->name, ois[i]->slave->name, r);
3267 * _ensure_mpu_hwmod_is_setup - ensure the MPU SS hwmod is init'ed and set up
3268 * @oh: pointer to the hwmod currently being set up (usually not the MPU)
3270 * If the hwmod data corresponding to the MPU subsystem IP block
3271 * hasn't been initialized and set up yet, do so now. This must be
3272 * done first since sleep dependencies may be added from other hwmods
3273 * to the MPU. Intended to be called only by omap_hwmod_setup*(). No
3276 static void __init _ensure_mpu_hwmod_is_setup(struct omap_hwmod *oh)
3278 if (!mpu_oh || mpu_oh->_state == _HWMOD_STATE_UNKNOWN)
3279 pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",
3280 __func__, MPU_INITIATOR_NAME);
3281 else if (mpu_oh->_state == _HWMOD_STATE_REGISTERED && oh != mpu_oh)
3282 omap_hwmod_setup_one(MPU_INITIATOR_NAME);
3286 * omap_hwmod_setup_one - set up a single hwmod
3287 * @oh_name: const char * name of the already-registered hwmod to set up
3289 * Initialize and set up a single hwmod. Intended to be used for a
3290 * small number of early devices, such as the timer IP blocks used for
3291 * the scheduler clock. Must be called after omap2_clk_init().
3292 * Resolves the struct clk names to struct clk pointers for each
3293 * registered omap_hwmod. Also calls _setup() on each hwmod. Returns
3294 * -EINVAL upon error or 0 upon success.
3296 int __init omap_hwmod_setup_one(const char *oh_name)
3298 struct omap_hwmod *oh;
3300 pr_debug("omap_hwmod: %s: %s\n", oh_name, __func__);
3302 oh = _lookup(oh_name);
3304 WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name);
3308 _ensure_mpu_hwmod_is_setup(oh);
3317 * omap_hwmod_setup_all - set up all registered IP blocks
3319 * Initialize and set up all IP blocks registered with the hwmod code.
3320 * Must be called after omap2_clk_init(). Resolves the struct clk
3321 * names to struct clk pointers for each registered omap_hwmod. Also
3322 * calls _setup() on each hwmod. Returns 0 upon success.
3324 static int __init omap_hwmod_setup_all(void)
3326 _ensure_mpu_hwmod_is_setup(NULL);
3328 omap_hwmod_for_each(_init, NULL);
3329 omap_hwmod_for_each(_setup, NULL);
3333 omap_core_initcall(omap_hwmod_setup_all);
3336 * omap_hwmod_enable - enable an omap_hwmod
3337 * @oh: struct omap_hwmod *
3339 * Enable an omap_hwmod @oh. Intended to be called by omap_device_enable().
3340 * Returns -EINVAL on error or passes along the return value from _enable().
3342 int omap_hwmod_enable(struct omap_hwmod *oh)
3345 unsigned long flags;
3350 spin_lock_irqsave(&oh->_lock, flags);
3352 spin_unlock_irqrestore(&oh->_lock, flags);
3358 * omap_hwmod_idle - idle an omap_hwmod
3359 * @oh: struct omap_hwmod *
3361 * Idle an omap_hwmod @oh. Intended to be called by omap_device_idle().
3362 * Returns -EINVAL on error or passes along the return value from _idle().
3364 int omap_hwmod_idle(struct omap_hwmod *oh)
3366 unsigned long flags;
3371 spin_lock_irqsave(&oh->_lock, flags);
3373 spin_unlock_irqrestore(&oh->_lock, flags);
3379 * omap_hwmod_shutdown - shutdown an omap_hwmod
3380 * @oh: struct omap_hwmod *
3382 * Shutdown an omap_hwmod @oh. Intended to be called by
3383 * omap_device_shutdown(). Returns -EINVAL on error or passes along
3384 * the return value from _shutdown().
3386 int omap_hwmod_shutdown(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_enable_clocks - enable main_clk, all interface clocks
3402 * @oh: struct omap_hwmod *oh
3404 * Intended to be called by the omap_device code.
3406 int omap_hwmod_enable_clocks(struct omap_hwmod *oh)
3408 unsigned long flags;
3410 spin_lock_irqsave(&oh->_lock, flags);
3412 spin_unlock_irqrestore(&oh->_lock, flags);
3418 * omap_hwmod_disable_clocks - disable main_clk, all interface clocks
3419 * @oh: struct omap_hwmod *oh
3421 * Intended to be called by the omap_device code.
3423 int omap_hwmod_disable_clocks(struct omap_hwmod *oh)
3425 unsigned long flags;
3427 spin_lock_irqsave(&oh->_lock, flags);
3428 _disable_clocks(oh);
3429 spin_unlock_irqrestore(&oh->_lock, flags);
3435 * omap_hwmod_ocp_barrier - wait for posted writes against the hwmod to complete
3436 * @oh: struct omap_hwmod *oh
3438 * Intended to be called by drivers and core code when all posted
3439 * writes to a device must complete before continuing further
3440 * execution (for example, after clearing some device IRQSTATUS
3443 * XXX what about targets with multiple OCP threads?
3445 void omap_hwmod_ocp_barrier(struct omap_hwmod *oh)
3449 if (!oh->class->sysc || !oh->class->sysc->sysc_flags) {
3450 WARN(1, "omap_device: %s: OCP barrier impossible due to device configuration\n",
3456 * Forces posted writes to complete on the OCP thread handling
3459 omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
3463 * omap_hwmod_reset - reset the hwmod
3464 * @oh: struct omap_hwmod *
3466 * Under some conditions, a driver may wish to reset the entire device.
3467 * Called from omap_device code. Returns -EINVAL on error or passes along
3468 * the return value from _reset().
3470 int omap_hwmod_reset(struct omap_hwmod *oh)
3473 unsigned long flags;
3478 spin_lock_irqsave(&oh->_lock, flags);
3480 spin_unlock_irqrestore(&oh->_lock, flags);
3486 * IP block data retrieval functions
3490 * omap_hwmod_count_resources - count number of struct resources needed by hwmod
3491 * @oh: struct omap_hwmod *
3492 * @flags: Type of resources to include when counting (IRQ/DMA/MEM)
3494 * Count the number of struct resource array elements necessary to
3495 * contain omap_hwmod @oh resources. Intended to be called by code
3496 * that registers omap_devices. Intended to be used to determine the
3497 * size of a dynamically-allocated struct resource array, before
3498 * calling omap_hwmod_fill_resources(). Returns the number of struct
3499 * resource array elements needed.
3501 * XXX This code is not optimized. It could attempt to merge adjacent
3505 int omap_hwmod_count_resources(struct omap_hwmod *oh, unsigned long flags)
3509 if (flags & IORESOURCE_IRQ)
3510 ret += _count_mpu_irqs(oh);
3512 if (flags & IORESOURCE_DMA)
3513 ret += _count_sdma_reqs(oh);
3515 if (flags & IORESOURCE_MEM) {
3517 struct omap_hwmod_ocp_if *os;
3518 struct list_head *p = oh->slave_ports.next;
3520 while (i < oh->slaves_cnt) {
3521 os = _fetch_next_ocp_if(&p, &i);
3522 ret += _count_ocp_if_addr_spaces(os);
3530 * omap_hwmod_fill_resources - fill struct resource array with hwmod data
3531 * @oh: struct omap_hwmod *
3532 * @res: pointer to the first element of an array of struct resource to fill
3534 * Fill the struct resource array @res with resource data from the
3535 * omap_hwmod @oh. Intended to be called by code that registers
3536 * omap_devices. See also omap_hwmod_count_resources(). Returns the
3537 * number of array elements filled.
3539 int omap_hwmod_fill_resources(struct omap_hwmod *oh, struct resource *res)
3541 struct omap_hwmod_ocp_if *os;
3542 struct list_head *p;
3543 int i, j, mpu_irqs_cnt, sdma_reqs_cnt, addr_cnt;
3546 /* For each IRQ, DMA, memory area, fill in array.*/
3548 mpu_irqs_cnt = _count_mpu_irqs(oh);
3549 for (i = 0; i < mpu_irqs_cnt; i++) {
3550 (res + r)->name = (oh->mpu_irqs + i)->name;
3551 (res + r)->start = (oh->mpu_irqs + i)->irq;
3552 (res + r)->end = (oh->mpu_irqs + i)->irq;
3553 (res + r)->flags = IORESOURCE_IRQ;
3557 sdma_reqs_cnt = _count_sdma_reqs(oh);
3558 for (i = 0; i < sdma_reqs_cnt; i++) {
3559 (res + r)->name = (oh->sdma_reqs + i)->name;
3560 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
3561 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
3562 (res + r)->flags = IORESOURCE_DMA;
3566 p = oh->slave_ports.next;
3569 while (i < oh->slaves_cnt) {
3570 os = _fetch_next_ocp_if(&p, &i);
3571 addr_cnt = _count_ocp_if_addr_spaces(os);
3573 for (j = 0; j < addr_cnt; j++) {
3574 (res + r)->name = (os->addr + j)->name;
3575 (res + r)->start = (os->addr + j)->pa_start;
3576 (res + r)->end = (os->addr + j)->pa_end;
3577 (res + r)->flags = IORESOURCE_MEM;
3586 * omap_hwmod_fill_dma_resources - fill struct resource array with dma data
3587 * @oh: struct omap_hwmod *
3588 * @res: pointer to the array of struct resource to fill
3590 * Fill the struct resource array @res with dma resource data from the
3591 * omap_hwmod @oh. Intended to be called by code that registers
3592 * omap_devices. See also omap_hwmod_count_resources(). Returns the
3593 * number of array elements filled.
3595 int omap_hwmod_fill_dma_resources(struct omap_hwmod *oh, struct resource *res)
3597 int i, sdma_reqs_cnt;
3600 sdma_reqs_cnt = _count_sdma_reqs(oh);
3601 for (i = 0; i < sdma_reqs_cnt; i++) {
3602 (res + r)->name = (oh->sdma_reqs + i)->name;
3603 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
3604 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
3605 (res + r)->flags = IORESOURCE_DMA;
3613 * omap_hwmod_get_resource_byname - fetch IP block integration data by name
3614 * @oh: struct omap_hwmod * to operate on
3615 * @type: one of the IORESOURCE_* constants from include/linux/ioport.h
3616 * @name: pointer to the name of the data to fetch (optional)
3617 * @rsrc: pointer to a struct resource, allocated by the caller
3619 * Retrieve MPU IRQ, SDMA request line, or address space start/end
3620 * data for the IP block pointed to by @oh. The data will be filled
3621 * into a struct resource record pointed to by @rsrc. The struct
3622 * resource must be allocated by the caller. When @name is non-null,
3623 * the data associated with the matching entry in the IRQ/SDMA/address
3624 * space hwmod data arrays will be returned. If @name is null, the
3625 * first array entry will be returned. Data order is not meaningful
3626 * in hwmod data, so callers are strongly encouraged to use a non-null
3627 * @name whenever possible to avoid unpredictable effects if hwmod
3628 * data is later added that causes data ordering to change. This
3629 * function is only intended for use by OMAP core code. Device
3630 * drivers should not call this function - the appropriate bus-related
3631 * data accessor functions should be used instead. Returns 0 upon
3632 * success or a negative error code upon error.
3634 int omap_hwmod_get_resource_byname(struct omap_hwmod *oh, unsigned int type,
3635 const char *name, struct resource *rsrc)
3638 unsigned int irq, dma;
3639 u32 pa_start, pa_end;
3644 if (type == IORESOURCE_IRQ) {
3645 r = _get_mpu_irq_by_name(oh, name, &irq);
3651 } else if (type == IORESOURCE_DMA) {
3652 r = _get_sdma_req_by_name(oh, name, &dma);
3658 } else if (type == IORESOURCE_MEM) {
3659 r = _get_addr_space_by_name(oh, name, &pa_start, &pa_end);
3663 rsrc->start = pa_start;
3676 * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
3677 * @oh: struct omap_hwmod *
3679 * Return the powerdomain pointer associated with the OMAP module
3680 * @oh's main clock. If @oh does not have a main clk, return the
3681 * powerdomain associated with the interface clock associated with the
3682 * module's MPU port. (XXX Perhaps this should use the SDMA port
3683 * instead?) Returns NULL on error, or a struct powerdomain * on
3686 struct powerdomain *omap_hwmod_get_pwrdm(struct omap_hwmod *oh)
3689 struct omap_hwmod_ocp_if *oi;
3690 struct clockdomain *clkdm;
3691 struct clk_hw_omap *clk;
3697 return oh->clkdm->pwrdm.ptr;
3702 oi = _find_mpu_rt_port(oh);
3708 clk = to_clk_hw_omap(__clk_get_hw(c));
3713 return clkdm->pwrdm.ptr;
3717 * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
3718 * @oh: struct omap_hwmod *
3720 * Returns the virtual address corresponding to the beginning of the
3721 * module's register target, in the address range that is intended to
3722 * be used by the MPU. Returns the virtual address upon success or NULL
3725 void __iomem *omap_hwmod_get_mpu_rt_va(struct omap_hwmod *oh)
3730 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
3733 if (oh->_state == _HWMOD_STATE_UNKNOWN)
3736 return oh->_mpu_rt_va;
3740 * omap_hwmod_add_initiator_dep - add sleepdep from @init_oh to @oh
3741 * @oh: struct omap_hwmod *
3742 * @init_oh: struct omap_hwmod * (initiator)
3744 * Add a sleep dependency between the initiator @init_oh and @oh.
3745 * Intended to be called by DSP/Bridge code via platform_data for the
3746 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
3747 * code needs to add/del initiator dependencies dynamically
3748 * before/after accessing a device. Returns the return value from
3749 * _add_initiator_dep().
3751 * XXX Keep a usecount in the clockdomain code
3753 int omap_hwmod_add_initiator_dep(struct omap_hwmod *oh,
3754 struct omap_hwmod *init_oh)
3756 return _add_initiator_dep(oh, init_oh);
3760 * XXX what about functions for drivers to save/restore ocp_sysconfig
3761 * for context save/restore operations?
3765 * omap_hwmod_del_initiator_dep - remove sleepdep from @init_oh to @oh
3766 * @oh: struct omap_hwmod *
3767 * @init_oh: struct omap_hwmod * (initiator)
3769 * Remove a sleep dependency between the initiator @init_oh and @oh.
3770 * Intended to be called by DSP/Bridge code via platform_data for the
3771 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
3772 * code needs to add/del initiator dependencies dynamically
3773 * before/after accessing a device. Returns the return value from
3774 * _del_initiator_dep().
3776 * XXX Keep a usecount in the clockdomain code
3778 int omap_hwmod_del_initiator_dep(struct omap_hwmod *oh,
3779 struct omap_hwmod *init_oh)
3781 return _del_initiator_dep(oh, init_oh);
3785 * omap_hwmod_enable_wakeup - allow device to wake up the system
3786 * @oh: struct omap_hwmod *
3788 * Sets the module OCP socket ENAWAKEUP bit to allow the module to
3789 * send wakeups to the PRCM, and enable I/O ring wakeup events for
3790 * this IP block if it has dynamic mux entries. Eventually this
3791 * should set PRCM wakeup registers to cause the PRCM to receive
3792 * wakeup events from the module. Does not set any wakeup routing
3793 * registers beyond this point - if the module is to wake up any other
3794 * module or subsystem, that must be set separately. Called by
3795 * omap_device code. Returns -EINVAL on error or 0 upon success.
3797 int omap_hwmod_enable_wakeup(struct omap_hwmod *oh)
3799 unsigned long flags;
3802 spin_lock_irqsave(&oh->_lock, flags);
3804 if (oh->class->sysc &&
3805 (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)) {
3806 v = oh->_sysc_cache;
3807 _enable_wakeup(oh, &v);
3808 _write_sysconfig(v, oh);
3811 _set_idle_ioring_wakeup(oh, true);
3812 spin_unlock_irqrestore(&oh->_lock, flags);
3818 * omap_hwmod_disable_wakeup - prevent device from waking the system
3819 * @oh: struct omap_hwmod *
3821 * Clears the module OCP socket ENAWAKEUP bit to prevent the module
3822 * from sending wakeups to the PRCM, and disable I/O ring wakeup
3823 * events for this IP block if it has dynamic mux entries. Eventually
3824 * this should clear PRCM wakeup registers to cause the PRCM to ignore
3825 * wakeup events from the module. Does not set any wakeup routing
3826 * registers beyond this point - if the module is to wake up any other
3827 * module or subsystem, that must be set separately. Called by
3828 * omap_device code. Returns -EINVAL on error or 0 upon success.
3830 int omap_hwmod_disable_wakeup(struct omap_hwmod *oh)
3832 unsigned long flags;
3835 spin_lock_irqsave(&oh->_lock, flags);
3837 if (oh->class->sysc &&
3838 (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)) {
3839 v = oh->_sysc_cache;
3840 _disable_wakeup(oh, &v);
3841 _write_sysconfig(v, oh);
3844 _set_idle_ioring_wakeup(oh, false);
3845 spin_unlock_irqrestore(&oh->_lock, flags);
3851 * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
3852 * contained in the hwmod module.
3853 * @oh: struct omap_hwmod *
3854 * @name: name of the reset line to lookup and assert
3856 * Some IP like dsp, ipu or iva contain processor that require
3857 * an HW reset line to be assert / deassert in order to enable fully
3858 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3859 * yet supported on this OMAP; otherwise, passes along the return value
3860 * from _assert_hardreset().
3862 int omap_hwmod_assert_hardreset(struct omap_hwmod *oh, const char *name)
3865 unsigned long flags;
3870 spin_lock_irqsave(&oh->_lock, flags);
3871 ret = _assert_hardreset(oh, name);
3872 spin_unlock_irqrestore(&oh->_lock, flags);
3878 * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
3879 * contained in the hwmod module.
3880 * @oh: struct omap_hwmod *
3881 * @name: name of the reset line to look up and deassert
3883 * Some IP like dsp, ipu or iva contain processor that require
3884 * an HW reset line to be assert / deassert in order to enable fully
3885 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3886 * yet supported on this OMAP; otherwise, passes along the return value
3887 * from _deassert_hardreset().
3889 int omap_hwmod_deassert_hardreset(struct omap_hwmod *oh, const char *name)
3892 unsigned long flags;
3897 spin_lock_irqsave(&oh->_lock, flags);
3898 ret = _deassert_hardreset(oh, name);
3899 spin_unlock_irqrestore(&oh->_lock, flags);
3905 * omap_hwmod_read_hardreset - read the HW reset line state of submodules
3906 * contained in the hwmod module
3907 * @oh: struct omap_hwmod *
3908 * @name: name of the reset line to look up and read
3910 * Return the current state of the hwmod @oh's reset line named @name:
3911 * returns -EINVAL upon parameter error or if this operation
3912 * is unsupported on the current OMAP; otherwise, passes along the return
3913 * value from _read_hardreset().
3915 int omap_hwmod_read_hardreset(struct omap_hwmod *oh, const char *name)
3918 unsigned long flags;
3923 spin_lock_irqsave(&oh->_lock, flags);
3924 ret = _read_hardreset(oh, name);
3925 spin_unlock_irqrestore(&oh->_lock, flags);
3932 * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
3933 * @classname: struct omap_hwmod_class name to search for
3934 * @fn: callback function pointer to call for each hwmod in class @classname
3935 * @user: arbitrary context data to pass to the callback function
3937 * For each omap_hwmod of class @classname, call @fn.
3938 * If the callback function returns something other than
3939 * zero, the iterator is terminated, and the callback function's return
3940 * value is passed back to the caller. Returns 0 upon success, -EINVAL
3941 * if @classname or @fn are NULL, or passes back the error code from @fn.
3943 int omap_hwmod_for_each_by_class(const char *classname,
3944 int (*fn)(struct omap_hwmod *oh,
3948 struct omap_hwmod *temp_oh;
3951 if (!classname || !fn)
3954 pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
3955 __func__, classname);
3957 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
3958 if (!strcmp(temp_oh->class->name, classname)) {
3959 pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
3960 __func__, temp_oh->name);
3961 ret = (*fn)(temp_oh, user);
3968 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
3975 * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
3976 * @oh: struct omap_hwmod *
3977 * @state: state that _setup() should leave the hwmod in
3979 * Sets the hwmod state that @oh will enter at the end of _setup()
3980 * (called by omap_hwmod_setup_*()). See also the documentation
3981 * for _setup_postsetup(), above. Returns 0 upon success or
3982 * -EINVAL if there is a problem with the arguments or if the hwmod is
3983 * in the wrong state.
3985 int omap_hwmod_set_postsetup_state(struct omap_hwmod *oh, u8 state)
3988 unsigned long flags;
3993 if (state != _HWMOD_STATE_DISABLED &&
3994 state != _HWMOD_STATE_ENABLED &&
3995 state != _HWMOD_STATE_IDLE)
3998 spin_lock_irqsave(&oh->_lock, flags);
4000 if (oh->_state != _HWMOD_STATE_REGISTERED) {
4005 oh->_postsetup_state = state;
4009 spin_unlock_irqrestore(&oh->_lock, flags);
4015 * omap_hwmod_get_context_loss_count - get lost context count
4016 * @oh: struct omap_hwmod *
4018 * Returns the context loss count of associated @oh
4019 * upon success, or zero if no context loss data is available.
4021 * On OMAP4, this queries the per-hwmod context loss register,
4022 * assuming one exists. If not, or on OMAP2/3, this queries the
4023 * enclosing powerdomain context loss count.
4025 int omap_hwmod_get_context_loss_count(struct omap_hwmod *oh)
4027 struct powerdomain *pwrdm;
4030 if (soc_ops.get_context_lost)
4031 return soc_ops.get_context_lost(oh);
4033 pwrdm = omap_hwmod_get_pwrdm(oh);
4035 ret = pwrdm_get_context_loss_count(pwrdm);
4041 * omap_hwmod_no_setup_reset - prevent a hwmod from being reset upon setup
4042 * @oh: struct omap_hwmod *
4044 * Prevent the hwmod @oh from being reset during the setup process.
4045 * Intended for use by board-*.c files on boards with devices that
4046 * cannot tolerate being reset. Must be called before the hwmod has
4047 * been set up. Returns 0 upon success or negative error code upon
4050 int omap_hwmod_no_setup_reset(struct omap_hwmod *oh)
4055 if (oh->_state != _HWMOD_STATE_REGISTERED) {
4056 pr_err("omap_hwmod: %s: cannot prevent setup reset; in wrong state\n",
4061 oh->flags |= HWMOD_INIT_NO_RESET;
4067 * omap_hwmod_pad_route_irq - route an I/O pad wakeup to a particular MPU IRQ
4068 * @oh: struct omap_hwmod * containing hwmod mux entries
4069 * @pad_idx: array index in oh->mux of the hwmod mux entry to route wakeup
4070 * @irq_idx: the hwmod mpu_irqs array index of the IRQ to trigger on wakeup
4072 * When an I/O pad wakeup arrives for the dynamic or wakeup hwmod mux
4073 * entry number @pad_idx for the hwmod @oh, trigger the interrupt
4074 * service routine for the hwmod's mpu_irqs array index @irq_idx. If
4075 * this function is not called for a given pad_idx, then the ISR
4076 * associated with @oh's first MPU IRQ will be triggered when an I/O
4077 * pad wakeup occurs on that pad. Note that @pad_idx is the index of
4078 * the _dynamic or wakeup_ entry: if there are other entries not
4079 * marked with OMAP_DEVICE_PAD_WAKEUP or OMAP_DEVICE_PAD_REMUX, these
4080 * entries are NOT COUNTED in the dynamic pad index. This function
4081 * must be called separately for each pad that requires its interrupt
4082 * to be re-routed this way. Returns -EINVAL if there is an argument
4083 * problem or if @oh does not have hwmod mux entries or MPU IRQs;
4084 * returns -ENOMEM if memory cannot be allocated; or 0 upon success.
4086 * XXX This function interface is fragile. Rather than using array
4087 * indexes, which are subject to unpredictable change, it should be
4088 * using hwmod IRQ names, and some other stable key for the hwmod mux
4091 int omap_hwmod_pad_route_irq(struct omap_hwmod *oh, int pad_idx, int irq_idx)
4097 if (!oh || !oh->mux || !oh->mpu_irqs || pad_idx < 0 ||
4098 pad_idx >= oh->mux->nr_pads_dynamic)
4101 /* Check the number of available mpu_irqs */
4102 for (nr_irqs = 0; oh->mpu_irqs[nr_irqs].irq >= 0; nr_irqs++)
4105 if (irq_idx >= nr_irqs)
4108 if (!oh->mux->irqs) {
4109 /* XXX What frees this? */
4110 oh->mux->irqs = kzalloc(sizeof(int) * oh->mux->nr_pads_dynamic,
4115 oh->mux->irqs[pad_idx] = irq_idx;
4121 * omap_hwmod_init - initialize the hwmod code
4123 * Sets up some function pointers needed by the hwmod code to operate on the
4124 * currently-booted SoC. Intended to be called once during kernel init
4125 * before any hwmods are registered. No return value.
4127 void __init omap_hwmod_init(void)
4129 if (cpu_is_omap24xx()) {
4130 soc_ops.wait_target_ready = _omap2xxx_wait_target_ready;
4131 soc_ops.assert_hardreset = _omap2_assert_hardreset;
4132 soc_ops.deassert_hardreset = _omap2_deassert_hardreset;
4133 soc_ops.is_hardreset_asserted = _omap2_is_hardreset_asserted;
4134 } else if (cpu_is_omap34xx()) {
4135 soc_ops.wait_target_ready = _omap3xxx_wait_target_ready;
4136 soc_ops.assert_hardreset = _omap2_assert_hardreset;
4137 soc_ops.deassert_hardreset = _omap2_deassert_hardreset;
4138 soc_ops.is_hardreset_asserted = _omap2_is_hardreset_asserted;
4139 } else if (cpu_is_omap44xx() || soc_is_omap54xx()) {
4140 soc_ops.enable_module = _omap4_enable_module;
4141 soc_ops.disable_module = _omap4_disable_module;
4142 soc_ops.wait_target_ready = _omap4_wait_target_ready;
4143 soc_ops.assert_hardreset = _omap4_assert_hardreset;
4144 soc_ops.deassert_hardreset = _omap4_deassert_hardreset;
4145 soc_ops.is_hardreset_asserted = _omap4_is_hardreset_asserted;
4146 soc_ops.init_clkdm = _init_clkdm;
4147 soc_ops.update_context_lost = _omap4_update_context_lost;
4148 soc_ops.get_context_lost = _omap4_get_context_lost;
4149 } else if (soc_is_am33xx()) {
4150 soc_ops.enable_module = _am33xx_enable_module;
4151 soc_ops.disable_module = _am33xx_disable_module;
4152 soc_ops.wait_target_ready = _am33xx_wait_target_ready;
4153 soc_ops.assert_hardreset = _am33xx_assert_hardreset;
4154 soc_ops.deassert_hardreset = _am33xx_deassert_hardreset;
4155 soc_ops.is_hardreset_asserted = _am33xx_is_hardreset_asserted;
4156 soc_ops.init_clkdm = _init_clkdm;
4158 WARN(1, "omap_hwmod: unknown SoC type\n");
4165 * omap_hwmod_get_main_clk - get pointer to main clock name
4166 * @oh: struct omap_hwmod *
4168 * Returns the main clock name assocated with @oh upon success,
4169 * or NULL if @oh is NULL.
4171 const char *omap_hwmod_get_main_clk(struct omap_hwmod *oh)
4176 return oh->main_clk;