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/of.h>
142 #include <linux/of_address.h>
144 #include <asm/system_misc.h>
147 #include "omap_hwmod.h"
151 #include "clockdomain.h"
152 #include "powerdomain.h"
155 #include "cminst44xx.h"
161 #include "prminst44xx.h"
165 /* Name of the OMAP hwmod for the MPU */
166 #define MPU_INITIATOR_NAME "mpu"
169 * Number of struct omap_hwmod_link records per struct
170 * omap_hwmod_ocp_if record (master->slave and slave->master)
172 #define LINKS_PER_OCP_IF 2
175 * struct omap_hwmod_soc_ops - fn ptrs for some SoC-specific operations
176 * @enable_module: function to enable a module (via MODULEMODE)
177 * @disable_module: function to disable a module (via MODULEMODE)
179 * XXX Eventually this functionality will be hidden inside the PRM/CM
180 * device drivers. Until then, this should avoid huge blocks of cpu_is_*()
181 * conditionals in this code.
183 struct omap_hwmod_soc_ops {
184 void (*enable_module)(struct omap_hwmod *oh);
185 int (*disable_module)(struct omap_hwmod *oh);
186 int (*wait_target_ready)(struct omap_hwmod *oh);
187 int (*assert_hardreset)(struct omap_hwmod *oh,
188 struct omap_hwmod_rst_info *ohri);
189 int (*deassert_hardreset)(struct omap_hwmod *oh,
190 struct omap_hwmod_rst_info *ohri);
191 int (*is_hardreset_asserted)(struct omap_hwmod *oh,
192 struct omap_hwmod_rst_info *ohri);
193 int (*init_clkdm)(struct omap_hwmod *oh);
194 void (*update_context_lost)(struct omap_hwmod *oh);
195 int (*get_context_lost)(struct omap_hwmod *oh);
198 /* soc_ops: adapts the omap_hwmod code to the currently-booted SoC */
199 static struct omap_hwmod_soc_ops soc_ops;
201 /* omap_hwmod_list contains all registered struct omap_hwmods */
202 static LIST_HEAD(omap_hwmod_list);
204 /* mpu_oh: used to add/remove MPU initiator from sleepdep list */
205 static struct omap_hwmod *mpu_oh;
207 /* io_chain_lock: used to serialize reconfigurations of the I/O chain */
208 static DEFINE_SPINLOCK(io_chain_lock);
211 * linkspace: ptr to a buffer that struct omap_hwmod_link records are
212 * allocated from - used to reduce the number of small memory
213 * allocations, which has a significant impact on performance
215 static struct omap_hwmod_link *linkspace;
218 * free_ls, max_ls: array indexes into linkspace; representing the
219 * next free struct omap_hwmod_link index, and the maximum number of
220 * struct omap_hwmod_link records allocated (respectively)
222 static unsigned short free_ls, max_ls, ls_supp;
224 /* inited: set to true once the hwmod code is initialized */
227 /* Private functions */
230 * _fetch_next_ocp_if - return the next OCP interface in a list
231 * @p: ptr to a ptr to the list_head inside the ocp_if to return
232 * @i: pointer to the index of the element pointed to by @p in the list
234 * Return a pointer to the struct omap_hwmod_ocp_if record
235 * containing the struct list_head pointed to by @p, and increment
236 * @p such that a future call to this routine will return the next
239 static struct omap_hwmod_ocp_if *_fetch_next_ocp_if(struct list_head **p,
242 struct omap_hwmod_ocp_if *oi;
244 oi = list_entry(*p, struct omap_hwmod_link, node)->ocp_if;
253 * _update_sysc_cache - return the module OCP_SYSCONFIG register, keep copy
254 * @oh: struct omap_hwmod *
256 * Load the current value of the hwmod OCP_SYSCONFIG register into the
257 * struct omap_hwmod for later use. Returns -EINVAL if the hwmod has no
258 * OCP_SYSCONFIG register or 0 upon success.
260 static int _update_sysc_cache(struct omap_hwmod *oh)
262 if (!oh->class->sysc) {
263 WARN(1, "omap_hwmod: %s: cannot read OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
267 /* XXX ensure module interface clock is up */
269 oh->_sysc_cache = omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
271 if (!(oh->class->sysc->sysc_flags & SYSC_NO_CACHE))
272 oh->_int_flags |= _HWMOD_SYSCONFIG_LOADED;
278 * _write_sysconfig - write a value to the module's OCP_SYSCONFIG register
279 * @v: OCP_SYSCONFIG value to write
280 * @oh: struct omap_hwmod *
282 * Write @v into the module class' OCP_SYSCONFIG register, if it has
283 * one. No return value.
285 static void _write_sysconfig(u32 v, struct omap_hwmod *oh)
287 if (!oh->class->sysc) {
288 WARN(1, "omap_hwmod: %s: cannot write OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
292 /* XXX ensure module interface clock is up */
294 /* Module might have lost context, always update cache and register */
296 omap_hwmod_write(v, oh, oh->class->sysc->sysc_offs);
300 * _set_master_standbymode: set the OCP_SYSCONFIG MIDLEMODE field in @v
301 * @oh: struct omap_hwmod *
302 * @standbymode: MIDLEMODE field bits
303 * @v: pointer to register contents to modify
305 * Update the master standby mode bits in @v to be @standbymode for
306 * the @oh hwmod. Does not write to the hardware. Returns -EINVAL
307 * upon error or 0 upon success.
309 static int _set_master_standbymode(struct omap_hwmod *oh, u8 standbymode,
315 if (!oh->class->sysc ||
316 !(oh->class->sysc->sysc_flags & SYSC_HAS_MIDLEMODE))
319 if (!oh->class->sysc->sysc_fields) {
320 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
324 mstandby_shift = oh->class->sysc->sysc_fields->midle_shift;
325 mstandby_mask = (0x3 << mstandby_shift);
327 *v &= ~mstandby_mask;
328 *v |= __ffs(standbymode) << mstandby_shift;
334 * _set_slave_idlemode: set the OCP_SYSCONFIG SIDLEMODE field in @v
335 * @oh: struct omap_hwmod *
336 * @idlemode: SIDLEMODE field bits
337 * @v: pointer to register contents to modify
339 * Update the slave idle mode bits in @v to be @idlemode for the @oh
340 * hwmod. Does not write to the hardware. Returns -EINVAL upon error
343 static int _set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode, u32 *v)
348 if (!oh->class->sysc ||
349 !(oh->class->sysc->sysc_flags & SYSC_HAS_SIDLEMODE))
352 if (!oh->class->sysc->sysc_fields) {
353 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
357 sidle_shift = oh->class->sysc->sysc_fields->sidle_shift;
358 sidle_mask = (0x3 << sidle_shift);
361 *v |= __ffs(idlemode) << sidle_shift;
367 * _set_clockactivity: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
368 * @oh: struct omap_hwmod *
369 * @clockact: CLOCKACTIVITY field bits
370 * @v: pointer to register contents to modify
372 * Update the clockactivity mode bits in @v to be @clockact for the
373 * @oh hwmod. Used for additional powersaving on some modules. Does
374 * not write to the hardware. Returns -EINVAL upon error or 0 upon
377 static int _set_clockactivity(struct omap_hwmod *oh, u8 clockact, u32 *v)
382 if (!oh->class->sysc ||
383 !(oh->class->sysc->sysc_flags & SYSC_HAS_CLOCKACTIVITY))
386 if (!oh->class->sysc->sysc_fields) {
387 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
391 clkact_shift = oh->class->sysc->sysc_fields->clkact_shift;
392 clkact_mask = (0x3 << clkact_shift);
395 *v |= clockact << clkact_shift;
401 * _set_softreset: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
402 * @oh: struct omap_hwmod *
403 * @v: pointer to register contents to modify
405 * Set the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
406 * error or 0 upon success.
408 static int _set_softreset(struct omap_hwmod *oh, u32 *v)
412 if (!oh->class->sysc ||
413 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
416 if (!oh->class->sysc->sysc_fields) {
417 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
421 softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
429 * _wait_softreset_complete - wait for an OCP softreset to complete
430 * @oh: struct omap_hwmod * to wait on
432 * Wait until the IP block represented by @oh reports that its OCP
433 * softreset is complete. This can be triggered by software (see
434 * _ocp_softreset()) or by hardware upon returning from off-mode (one
435 * example is HSMMC). Waits for up to MAX_MODULE_SOFTRESET_WAIT
436 * microseconds. Returns the number of microseconds waited.
438 static int _wait_softreset_complete(struct omap_hwmod *oh)
440 struct omap_hwmod_class_sysconfig *sysc;
444 sysc = oh->class->sysc;
446 if (sysc->sysc_flags & SYSS_HAS_RESET_STATUS)
447 omap_test_timeout((omap_hwmod_read(oh, sysc->syss_offs)
448 & SYSS_RESETDONE_MASK),
449 MAX_MODULE_SOFTRESET_WAIT, c);
450 else if (sysc->sysc_flags & SYSC_HAS_RESET_STATUS) {
451 softrst_mask = (0x1 << sysc->sysc_fields->srst_shift);
452 omap_test_timeout(!(omap_hwmod_read(oh, sysc->sysc_offs)
454 MAX_MODULE_SOFTRESET_WAIT, c);
461 * _set_dmadisable: set OCP_SYSCONFIG.DMADISABLE bit in @v
462 * @oh: struct omap_hwmod *
464 * The DMADISABLE bit is a semi-automatic bit present in sysconfig register
465 * of some modules. When the DMA must perform read/write accesses, the
466 * DMADISABLE bit is cleared by the hardware. But when the DMA must stop
467 * for power management, software must set the DMADISABLE bit back to 1.
469 * Set the DMADISABLE bit in @v for hwmod @oh. Returns -EINVAL upon
470 * error or 0 upon success.
472 static int _set_dmadisable(struct omap_hwmod *oh)
477 if (!oh->class->sysc ||
478 !(oh->class->sysc->sysc_flags & SYSC_HAS_DMADISABLE))
481 if (!oh->class->sysc->sysc_fields) {
482 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
486 /* clocks must be on for this operation */
487 if (oh->_state != _HWMOD_STATE_ENABLED) {
488 pr_warn("omap_hwmod: %s: dma can be disabled only from enabled state\n", oh->name);
492 pr_debug("omap_hwmod: %s: setting DMADISABLE\n", oh->name);
496 (0x1 << oh->class->sysc->sysc_fields->dmadisable_shift);
497 v |= dmadisable_mask;
498 _write_sysconfig(v, oh);
504 * _set_module_autoidle: set the OCP_SYSCONFIG AUTOIDLE field in @v
505 * @oh: struct omap_hwmod *
506 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
507 * @v: pointer to register contents to modify
509 * Update the module autoidle bit in @v to be @autoidle for the @oh
510 * hwmod. The autoidle bit controls whether the module can gate
511 * internal clocks automatically when it isn't doing anything; the
512 * exact function of this bit varies on a per-module basis. This
513 * function does not write to the hardware. Returns -EINVAL upon
514 * error or 0 upon success.
516 static int _set_module_autoidle(struct omap_hwmod *oh, u8 autoidle,
522 if (!oh->class->sysc ||
523 !(oh->class->sysc->sysc_flags & SYSC_HAS_AUTOIDLE))
526 if (!oh->class->sysc->sysc_fields) {
527 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
531 autoidle_shift = oh->class->sysc->sysc_fields->autoidle_shift;
532 autoidle_mask = (0x1 << autoidle_shift);
534 *v &= ~autoidle_mask;
535 *v |= autoidle << autoidle_shift;
541 * _set_idle_ioring_wakeup - enable/disable IO pad wakeup on hwmod idle for mux
542 * @oh: struct omap_hwmod *
543 * @set_wake: bool value indicating to set (true) or clear (false) wakeup enable
545 * Set or clear the I/O pad wakeup flag in the mux entries for the
546 * hwmod @oh. This function changes the @oh->mux->pads_dynamic array
547 * in memory. If the hwmod is currently idled, and the new idle
548 * values don't match the previous ones, this function will also
549 * update the SCM PADCTRL registers. Otherwise, if the hwmod is not
550 * currently idled, this function won't touch the hardware: the new
551 * mux settings are written to the SCM PADCTRL registers when the
552 * hwmod is idled. No return value.
554 static void _set_idle_ioring_wakeup(struct omap_hwmod *oh, bool set_wake)
556 struct omap_device_pad *pad;
561 if (!oh->mux || !oh->mux->enabled)
564 for (j = 0; j < oh->mux->nr_pads_dynamic; j++) {
565 pad = oh->mux->pads_dynamic[j];
567 if (!(pad->flags & OMAP_DEVICE_PAD_WAKEUP))
570 prev_idle = pad->idle;
573 pad->idle |= OMAP_WAKEUP_EN;
575 pad->idle &= ~OMAP_WAKEUP_EN;
577 if (prev_idle != pad->idle)
581 if (change && oh->_state == _HWMOD_STATE_IDLE)
582 omap_hwmod_mux(oh->mux, _HWMOD_STATE_IDLE);
586 * _enable_wakeup: set OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
587 * @oh: struct omap_hwmod *
589 * Allow the hardware module @oh to send wakeups. Returns -EINVAL
590 * upon error or 0 upon success.
592 static int _enable_wakeup(struct omap_hwmod *oh, u32 *v)
594 if (!oh->class->sysc ||
595 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
596 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
597 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
600 if (!oh->class->sysc->sysc_fields) {
601 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
605 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
606 *v |= 0x1 << oh->class->sysc->sysc_fields->enwkup_shift;
608 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
609 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
610 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
611 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
613 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
619 * _disable_wakeup: clear OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
620 * @oh: struct omap_hwmod *
622 * Prevent the hardware module @oh to send wakeups. Returns -EINVAL
623 * upon error or 0 upon success.
625 static int _disable_wakeup(struct omap_hwmod *oh, u32 *v)
627 if (!oh->class->sysc ||
628 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
629 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
630 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
633 if (!oh->class->sysc->sysc_fields) {
634 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
638 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
639 *v &= ~(0x1 << oh->class->sysc->sysc_fields->enwkup_shift);
641 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
642 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART, v);
643 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
644 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART, v);
646 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
651 static struct clockdomain *_get_clkdm(struct omap_hwmod *oh)
653 struct clk_hw_omap *clk;
657 } else if (oh->_clk) {
658 clk = to_clk_hw_omap(__clk_get_hw(oh->_clk));
665 * _add_initiator_dep: prevent @oh from smart-idling while @init_oh is active
666 * @oh: struct omap_hwmod *
668 * Prevent the hardware module @oh from entering idle while the
669 * hardare module initiator @init_oh is active. Useful when a module
670 * will be accessed by a particular initiator (e.g., if a module will
671 * be accessed by the IVA, there should be a sleepdep between the IVA
672 * initiator and the module). Only applies to modules in smart-idle
673 * mode. If the clockdomain is marked as not needing autodeps, return
674 * 0 without doing anything. Otherwise, returns -EINVAL upon error or
675 * passes along clkdm_add_sleepdep() value upon success.
677 static int _add_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
679 struct clockdomain *clkdm, *init_clkdm;
681 clkdm = _get_clkdm(oh);
682 init_clkdm = _get_clkdm(init_oh);
684 if (!clkdm || !init_clkdm)
687 if (clkdm && clkdm->flags & CLKDM_NO_AUTODEPS)
690 return clkdm_add_sleepdep(clkdm, init_clkdm);
694 * _del_initiator_dep: allow @oh to smart-idle even if @init_oh is active
695 * @oh: struct omap_hwmod *
697 * Allow the hardware module @oh to enter idle while the hardare
698 * module initiator @init_oh is active. Useful when a module will not
699 * be accessed by a particular initiator (e.g., if a module will not
700 * be accessed by the IVA, there should be no sleepdep between the IVA
701 * initiator and the module). Only applies to modules in smart-idle
702 * mode. If the clockdomain is marked as not needing autodeps, return
703 * 0 without doing anything. Returns -EINVAL upon error or passes
704 * along clkdm_del_sleepdep() value upon success.
706 static int _del_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
708 struct clockdomain *clkdm, *init_clkdm;
710 clkdm = _get_clkdm(oh);
711 init_clkdm = _get_clkdm(init_oh);
713 if (!clkdm || !init_clkdm)
716 if (clkdm && clkdm->flags & CLKDM_NO_AUTODEPS)
719 return clkdm_del_sleepdep(clkdm, init_clkdm);
723 * _init_main_clk - get a struct clk * for the the hwmod's main functional clk
724 * @oh: struct omap_hwmod *
726 * Called from _init_clocks(). Populates the @oh _clk (main
727 * functional clock pointer) if a main_clk is present. Returns 0 on
728 * success or -EINVAL on error.
730 static int _init_main_clk(struct omap_hwmod *oh)
737 oh->_clk = clk_get(NULL, oh->main_clk);
738 if (IS_ERR(oh->_clk)) {
739 pr_warning("omap_hwmod: %s: cannot clk_get main_clk %s\n",
740 oh->name, oh->main_clk);
744 * HACK: This needs a re-visit once clk_prepare() is implemented
745 * to do something meaningful. Today its just a no-op.
746 * If clk_prepare() is used at some point to do things like
747 * voltage scaling etc, then this would have to be moved to
748 * some point where subsystems like i2c and pmic become
751 clk_prepare(oh->_clk);
754 pr_debug("omap_hwmod: %s: missing clockdomain for %s.\n",
755 oh->name, oh->main_clk);
761 * _init_interface_clks - get a struct clk * for the the hwmod's interface clks
762 * @oh: struct omap_hwmod *
764 * Called from _init_clocks(). Populates the @oh OCP slave interface
765 * clock pointers. Returns 0 on success or -EINVAL on error.
767 static int _init_interface_clks(struct omap_hwmod *oh)
769 struct omap_hwmod_ocp_if *os;
775 p = oh->slave_ports.next;
777 while (i < oh->slaves_cnt) {
778 os = _fetch_next_ocp_if(&p, &i);
782 c = clk_get(NULL, os->clk);
784 pr_warning("omap_hwmod: %s: cannot clk_get interface_clk %s\n",
790 * HACK: This needs a re-visit once clk_prepare() is implemented
791 * to do something meaningful. Today its just a no-op.
792 * If clk_prepare() is used at some point to do things like
793 * voltage scaling etc, then this would have to be moved to
794 * some point where subsystems like i2c and pmic become
797 clk_prepare(os->_clk);
804 * _init_opt_clk - get a struct clk * for the the hwmod's optional clocks
805 * @oh: struct omap_hwmod *
807 * Called from _init_clocks(). Populates the @oh omap_hwmod_opt_clk
808 * clock pointers. Returns 0 on success or -EINVAL on error.
810 static int _init_opt_clks(struct omap_hwmod *oh)
812 struct omap_hwmod_opt_clk *oc;
817 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++) {
818 c = clk_get(NULL, oc->clk);
820 pr_warning("omap_hwmod: %s: cannot clk_get opt_clk %s\n",
826 * HACK: This needs a re-visit once clk_prepare() is implemented
827 * to do something meaningful. Today its just a no-op.
828 * If clk_prepare() is used at some point to do things like
829 * voltage scaling etc, then this would have to be moved to
830 * some point where subsystems like i2c and pmic become
833 clk_prepare(oc->_clk);
840 * _enable_clocks - enable hwmod main clock and interface clocks
841 * @oh: struct omap_hwmod *
843 * Enables all clocks necessary for register reads and writes to succeed
844 * on the hwmod @oh. Returns 0.
846 static int _enable_clocks(struct omap_hwmod *oh)
848 struct omap_hwmod_ocp_if *os;
852 pr_debug("omap_hwmod: %s: enabling clocks\n", oh->name);
855 clk_enable(oh->_clk);
857 p = oh->slave_ports.next;
859 while (i < oh->slaves_cnt) {
860 os = _fetch_next_ocp_if(&p, &i);
862 if (os->_clk && (os->flags & OCPIF_SWSUP_IDLE))
863 clk_enable(os->_clk);
866 /* The opt clocks are controlled by the device driver. */
872 * _disable_clocks - disable hwmod main clock and interface clocks
873 * @oh: struct omap_hwmod *
875 * Disables the hwmod @oh main functional and interface clocks. Returns 0.
877 static int _disable_clocks(struct omap_hwmod *oh)
879 struct omap_hwmod_ocp_if *os;
883 pr_debug("omap_hwmod: %s: disabling clocks\n", oh->name);
886 clk_disable(oh->_clk);
888 p = oh->slave_ports.next;
890 while (i < oh->slaves_cnt) {
891 os = _fetch_next_ocp_if(&p, &i);
893 if (os->_clk && (os->flags & OCPIF_SWSUP_IDLE))
894 clk_disable(os->_clk);
897 /* The opt clocks are controlled by the device driver. */
902 static void _enable_optional_clocks(struct omap_hwmod *oh)
904 struct omap_hwmod_opt_clk *oc;
907 pr_debug("omap_hwmod: %s: enabling optional clocks\n", oh->name);
909 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
911 pr_debug("omap_hwmod: enable %s:%s\n", oc->role,
912 __clk_get_name(oc->_clk));
913 clk_enable(oc->_clk);
917 static void _disable_optional_clocks(struct omap_hwmod *oh)
919 struct omap_hwmod_opt_clk *oc;
922 pr_debug("omap_hwmod: %s: disabling optional clocks\n", oh->name);
924 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
926 pr_debug("omap_hwmod: disable %s:%s\n", oc->role,
927 __clk_get_name(oc->_clk));
928 clk_disable(oc->_clk);
933 * _omap4_enable_module - enable CLKCTRL modulemode on OMAP4
934 * @oh: struct omap_hwmod *
936 * Enables the PRCM module mode related to the hwmod @oh.
939 static void _omap4_enable_module(struct omap_hwmod *oh)
941 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
944 pr_debug("omap_hwmod: %s: %s: %d\n",
945 oh->name, __func__, oh->prcm.omap4.modulemode);
947 omap4_cminst_module_enable(oh->prcm.omap4.modulemode,
948 oh->clkdm->prcm_partition,
950 oh->clkdm->clkdm_offs,
951 oh->prcm.omap4.clkctrl_offs);
955 * _am33xx_enable_module - enable CLKCTRL modulemode on AM33XX
956 * @oh: struct omap_hwmod *
958 * Enables the PRCM module mode related to the hwmod @oh.
961 static void _am33xx_enable_module(struct omap_hwmod *oh)
963 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
966 pr_debug("omap_hwmod: %s: %s: %d\n",
967 oh->name, __func__, oh->prcm.omap4.modulemode);
969 am33xx_cm_module_enable(oh->prcm.omap4.modulemode, oh->clkdm->cm_inst,
970 oh->clkdm->clkdm_offs,
971 oh->prcm.omap4.clkctrl_offs);
975 * _omap4_wait_target_disable - wait for a module to be disabled on OMAP4
976 * @oh: struct omap_hwmod *
978 * Wait for a module @oh to enter slave idle. Returns 0 if the module
979 * does not have an IDLEST bit or if the module successfully enters
980 * slave idle; otherwise, pass along the return value of the
981 * appropriate *_cm*_wait_module_idle() function.
983 static int _omap4_wait_target_disable(struct omap_hwmod *oh)
988 if (oh->_int_flags & _HWMOD_NO_MPU_PORT || !oh->clkdm)
991 if (oh->flags & HWMOD_NO_IDLEST)
994 return omap4_cminst_wait_module_idle(oh->clkdm->prcm_partition,
996 oh->clkdm->clkdm_offs,
997 oh->prcm.omap4.clkctrl_offs);
1001 * _am33xx_wait_target_disable - wait for a module to be disabled on AM33XX
1002 * @oh: struct omap_hwmod *
1004 * Wait for a module @oh to enter slave idle. Returns 0 if the module
1005 * does not have an IDLEST bit or if the module successfully enters
1006 * slave idle; otherwise, pass along the return value of the
1007 * appropriate *_cm*_wait_module_idle() function.
1009 static int _am33xx_wait_target_disable(struct omap_hwmod *oh)
1014 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
1017 if (oh->flags & HWMOD_NO_IDLEST)
1020 return am33xx_cm_wait_module_idle(oh->clkdm->cm_inst,
1021 oh->clkdm->clkdm_offs,
1022 oh->prcm.omap4.clkctrl_offs);
1026 * _count_mpu_irqs - count the number of MPU IRQ lines associated with @oh
1027 * @oh: struct omap_hwmod *oh
1029 * Count and return the number of MPU IRQs associated with the hwmod
1030 * @oh. Used to allocate struct resource data. Returns 0 if @oh is
1033 static int _count_mpu_irqs(struct omap_hwmod *oh)
1035 struct omap_hwmod_irq_info *ohii;
1038 if (!oh || !oh->mpu_irqs)
1042 ohii = &oh->mpu_irqs[i++];
1043 } while (ohii->irq != -1);
1049 * _count_sdma_reqs - count the number of SDMA request lines associated with @oh
1050 * @oh: struct omap_hwmod *oh
1052 * Count and return the number of SDMA request lines associated with
1053 * the hwmod @oh. Used to allocate struct resource data. Returns 0
1056 static int _count_sdma_reqs(struct omap_hwmod *oh)
1058 struct omap_hwmod_dma_info *ohdi;
1061 if (!oh || !oh->sdma_reqs)
1065 ohdi = &oh->sdma_reqs[i++];
1066 } while (ohdi->dma_req != -1);
1072 * _count_ocp_if_addr_spaces - count the number of address space entries for @oh
1073 * @oh: struct omap_hwmod *oh
1075 * Count and return the number of address space ranges associated with
1076 * the hwmod @oh. Used to allocate struct resource data. Returns 0
1079 static int _count_ocp_if_addr_spaces(struct omap_hwmod_ocp_if *os)
1081 struct omap_hwmod_addr_space *mem;
1084 if (!os || !os->addr)
1088 mem = &os->addr[i++];
1089 } while (mem->pa_start != mem->pa_end);
1095 * _get_mpu_irq_by_name - fetch MPU interrupt line number by name
1096 * @oh: struct omap_hwmod * to operate on
1097 * @name: pointer to the name of the MPU interrupt number to fetch (optional)
1098 * @irq: pointer to an unsigned int to store the MPU IRQ number to
1100 * Retrieve a MPU hardware IRQ line number named by @name associated
1101 * with the IP block pointed to by @oh. The IRQ number will be filled
1102 * into the address pointed to by @dma. When @name is non-null, the
1103 * IRQ line number associated with the named entry will be returned.
1104 * If @name is null, the first matching entry will be returned. Data
1105 * order is not meaningful in hwmod data, so callers are strongly
1106 * encouraged to use a non-null @name whenever possible to avoid
1107 * unpredictable effects if hwmod data is later added that causes data
1108 * ordering to change. Returns 0 upon success or a negative error
1111 static int _get_mpu_irq_by_name(struct omap_hwmod *oh, const char *name,
1121 while (oh->mpu_irqs[i].irq != -1) {
1122 if (name == oh->mpu_irqs[i].name ||
1123 !strcmp(name, oh->mpu_irqs[i].name)) {
1133 *irq = oh->mpu_irqs[i].irq;
1139 * _get_sdma_req_by_name - fetch SDMA request line ID by name
1140 * @oh: struct omap_hwmod * to operate on
1141 * @name: pointer to the name of the SDMA request line to fetch (optional)
1142 * @dma: pointer to an unsigned int to store the request line ID to
1144 * Retrieve an SDMA request line ID named by @name on the IP block
1145 * pointed to by @oh. The ID will be filled into the address pointed
1146 * to by @dma. When @name is non-null, the request line ID associated
1147 * with the named entry will be returned. If @name is null, the first
1148 * matching entry will be returned. Data order is not meaningful in
1149 * hwmod data, so callers are strongly encouraged to use a non-null
1150 * @name whenever possible to avoid unpredictable effects if hwmod
1151 * data is later added that causes data ordering to change. Returns 0
1152 * upon success or a negative error code upon error.
1154 static int _get_sdma_req_by_name(struct omap_hwmod *oh, const char *name,
1164 while (oh->sdma_reqs[i].dma_req != -1) {
1165 if (name == oh->sdma_reqs[i].name ||
1166 !strcmp(name, oh->sdma_reqs[i].name)) {
1176 *dma = oh->sdma_reqs[i].dma_req;
1182 * _get_addr_space_by_name - fetch address space start & end by name
1183 * @oh: struct omap_hwmod * to operate on
1184 * @name: pointer to the name of the address space to fetch (optional)
1185 * @pa_start: pointer to a u32 to store the starting address to
1186 * @pa_end: pointer to a u32 to store the ending address to
1188 * Retrieve address space start and end addresses for the IP block
1189 * pointed to by @oh. The data will be filled into the addresses
1190 * pointed to by @pa_start and @pa_end. When @name is non-null, the
1191 * address space data associated with the named entry will be
1192 * returned. If @name is null, the first matching entry will be
1193 * returned. Data order is not meaningful in hwmod data, so callers
1194 * are strongly encouraged to use a non-null @name whenever possible
1195 * to avoid unpredictable effects if hwmod data is later added that
1196 * causes data ordering to change. Returns 0 upon success or a
1197 * negative error code upon error.
1199 static int _get_addr_space_by_name(struct omap_hwmod *oh, const char *name,
1200 u32 *pa_start, u32 *pa_end)
1203 struct omap_hwmod_ocp_if *os;
1204 struct list_head *p = NULL;
1207 p = oh->slave_ports.next;
1210 while (i < oh->slaves_cnt) {
1211 os = _fetch_next_ocp_if(&p, &i);
1217 while (os->addr[j].pa_start != os->addr[j].pa_end) {
1218 if (name == os->addr[j].name ||
1219 !strcmp(name, os->addr[j].name)) {
1233 *pa_start = os->addr[j].pa_start;
1234 *pa_end = os->addr[j].pa_end;
1240 * _save_mpu_port_index - find and save the index to @oh's MPU port
1241 * @oh: struct omap_hwmod *
1243 * Determines the array index of the OCP slave port that the MPU uses
1244 * to address the device, and saves it into the struct omap_hwmod.
1245 * Intended to be called during hwmod registration only. No return
1248 static void __init _save_mpu_port_index(struct omap_hwmod *oh)
1250 struct omap_hwmod_ocp_if *os = NULL;
1251 struct list_head *p;
1257 oh->_int_flags |= _HWMOD_NO_MPU_PORT;
1259 p = oh->slave_ports.next;
1261 while (i < oh->slaves_cnt) {
1262 os = _fetch_next_ocp_if(&p, &i);
1263 if (os->user & OCP_USER_MPU) {
1265 oh->_int_flags &= ~_HWMOD_NO_MPU_PORT;
1274 * _find_mpu_rt_port - return omap_hwmod_ocp_if accessible by the MPU
1275 * @oh: struct omap_hwmod *
1277 * Given a pointer to a struct omap_hwmod record @oh, return a pointer
1278 * to the struct omap_hwmod_ocp_if record that is used by the MPU to
1279 * communicate with the IP block. This interface need not be directly
1280 * connected to the MPU (and almost certainly is not), but is directly
1281 * connected to the IP block represented by @oh. Returns a pointer
1282 * to the struct omap_hwmod_ocp_if * upon success, or returns NULL upon
1283 * error or if there does not appear to be a path from the MPU to this
1286 static struct omap_hwmod_ocp_if *_find_mpu_rt_port(struct omap_hwmod *oh)
1288 if (!oh || oh->_int_flags & _HWMOD_NO_MPU_PORT || oh->slaves_cnt == 0)
1291 return oh->_mpu_port;
1295 * _find_mpu_rt_addr_space - return MPU register target address space for @oh
1296 * @oh: struct omap_hwmod *
1298 * Returns a pointer to the struct omap_hwmod_addr_space record representing
1299 * the register target MPU address space; or returns NULL upon error.
1301 static struct omap_hwmod_addr_space * __init _find_mpu_rt_addr_space(struct omap_hwmod *oh)
1303 struct omap_hwmod_ocp_if *os;
1304 struct omap_hwmod_addr_space *mem;
1305 int found = 0, i = 0;
1307 os = _find_mpu_rt_port(oh);
1308 if (!os || !os->addr)
1312 mem = &os->addr[i++];
1313 if (mem->flags & ADDR_TYPE_RT)
1315 } while (!found && mem->pa_start != mem->pa_end);
1317 return (found) ? mem : NULL;
1321 * _enable_sysc - try to bring a module out of idle via OCP_SYSCONFIG
1322 * @oh: struct omap_hwmod *
1324 * Ensure that the OCP_SYSCONFIG register for the IP block represented
1325 * by @oh is set to indicate to the PRCM that the IP block is active.
1326 * Usually this means placing the module into smart-idle mode and
1327 * smart-standby, but if there is a bug in the automatic idle handling
1328 * for the IP block, it may need to be placed into the force-idle or
1329 * no-idle variants of these modes. No return value.
1331 static void _enable_sysc(struct omap_hwmod *oh)
1336 struct clockdomain *clkdm;
1338 if (!oh->class->sysc)
1342 * Wait until reset has completed, this is needed as the IP
1343 * block is reset automatically by hardware in some cases
1344 * (off-mode for example), and the drivers require the
1345 * IP to be ready when they access it
1347 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1348 _enable_optional_clocks(oh);
1349 _wait_softreset_complete(oh);
1350 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1351 _disable_optional_clocks(oh);
1353 v = oh->_sysc_cache;
1354 sf = oh->class->sysc->sysc_flags;
1356 clkdm = _get_clkdm(oh);
1357 if (sf & SYSC_HAS_SIDLEMODE) {
1358 clkdm_act = (clkdm && clkdm->flags & CLKDM_ACTIVE_WITH_MPU);
1359 if (clkdm_act && !(oh->class->sysc->idlemodes &
1360 (SIDLE_SMART | SIDLE_SMART_WKUP)))
1361 idlemode = HWMOD_IDLEMODE_FORCE;
1363 idlemode = (oh->flags & HWMOD_SWSUP_SIDLE) ?
1364 HWMOD_IDLEMODE_NO : HWMOD_IDLEMODE_SMART;
1365 _set_slave_idlemode(oh, idlemode, &v);
1368 if (sf & SYSC_HAS_MIDLEMODE) {
1369 if (oh->flags & HWMOD_FORCE_MSTANDBY) {
1370 idlemode = HWMOD_IDLEMODE_FORCE;
1371 } else if (oh->flags & HWMOD_SWSUP_MSTANDBY) {
1372 idlemode = HWMOD_IDLEMODE_NO;
1374 if (sf & SYSC_HAS_ENAWAKEUP)
1375 _enable_wakeup(oh, &v);
1376 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1377 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1379 idlemode = HWMOD_IDLEMODE_SMART;
1381 _set_master_standbymode(oh, idlemode, &v);
1385 * XXX The clock framework should handle this, by
1386 * calling into this code. But this must wait until the
1387 * clock structures are tagged with omap_hwmod entries
1389 if ((oh->flags & HWMOD_SET_DEFAULT_CLOCKACT) &&
1390 (sf & SYSC_HAS_CLOCKACTIVITY))
1391 _set_clockactivity(oh, oh->class->sysc->clockact, &v);
1393 /* If slave is in SMARTIDLE, also enable wakeup */
1394 if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
1395 _enable_wakeup(oh, &v);
1397 _write_sysconfig(v, oh);
1400 * Set the autoidle bit only after setting the smartidle bit
1401 * Setting this will not have any impact on the other modules.
1403 if (sf & SYSC_HAS_AUTOIDLE) {
1404 idlemode = (oh->flags & HWMOD_NO_OCP_AUTOIDLE) ?
1406 _set_module_autoidle(oh, idlemode, &v);
1407 _write_sysconfig(v, oh);
1412 * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
1413 * @oh: struct omap_hwmod *
1415 * If module is marked as SWSUP_SIDLE, force the module into slave
1416 * idle; otherwise, configure it for smart-idle. If module is marked
1417 * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
1418 * configure it for smart-standby. No return value.
1420 static void _idle_sysc(struct omap_hwmod *oh)
1425 if (!oh->class->sysc)
1428 v = oh->_sysc_cache;
1429 sf = oh->class->sysc->sysc_flags;
1431 if (sf & SYSC_HAS_SIDLEMODE) {
1432 /* XXX What about HWMOD_IDLEMODE_SMART_WKUP? */
1433 if (oh->flags & HWMOD_SWSUP_SIDLE ||
1434 !(oh->class->sysc->idlemodes &
1435 (SIDLE_SMART | SIDLE_SMART_WKUP)))
1436 idlemode = HWMOD_IDLEMODE_FORCE;
1438 idlemode = HWMOD_IDLEMODE_SMART;
1439 _set_slave_idlemode(oh, idlemode, &v);
1442 if (sf & SYSC_HAS_MIDLEMODE) {
1443 if ((oh->flags & HWMOD_SWSUP_MSTANDBY) ||
1444 (oh->flags & HWMOD_FORCE_MSTANDBY)) {
1445 idlemode = HWMOD_IDLEMODE_FORCE;
1447 if (sf & SYSC_HAS_ENAWAKEUP)
1448 _enable_wakeup(oh, &v);
1449 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1450 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1452 idlemode = HWMOD_IDLEMODE_SMART;
1454 _set_master_standbymode(oh, idlemode, &v);
1457 /* If slave is in SMARTIDLE, also enable wakeup */
1458 if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
1459 _enable_wakeup(oh, &v);
1461 _write_sysconfig(v, oh);
1465 * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
1466 * @oh: struct omap_hwmod *
1468 * Force the module into slave idle and master suspend. No return
1471 static void _shutdown_sysc(struct omap_hwmod *oh)
1476 if (!oh->class->sysc)
1479 v = oh->_sysc_cache;
1480 sf = oh->class->sysc->sysc_flags;
1482 if (sf & SYSC_HAS_SIDLEMODE)
1483 _set_slave_idlemode(oh, HWMOD_IDLEMODE_FORCE, &v);
1485 if (sf & SYSC_HAS_MIDLEMODE)
1486 _set_master_standbymode(oh, HWMOD_IDLEMODE_FORCE, &v);
1488 if (sf & SYSC_HAS_AUTOIDLE)
1489 _set_module_autoidle(oh, 1, &v);
1491 _write_sysconfig(v, oh);
1495 * _lookup - find an omap_hwmod by name
1496 * @name: find an omap_hwmod by name
1498 * Return a pointer to an omap_hwmod by name, or NULL if not found.
1500 static struct omap_hwmod *_lookup(const char *name)
1502 struct omap_hwmod *oh, *temp_oh;
1506 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1507 if (!strcmp(name, temp_oh->name)) {
1517 * _init_clkdm - look up a clockdomain name, store pointer in omap_hwmod
1518 * @oh: struct omap_hwmod *
1520 * Convert a clockdomain name stored in a struct omap_hwmod into a
1521 * clockdomain pointer, and save it into the struct omap_hwmod.
1522 * Return -EINVAL if the clkdm_name lookup failed.
1524 static int _init_clkdm(struct omap_hwmod *oh)
1526 if (!oh->clkdm_name) {
1527 pr_debug("omap_hwmod: %s: missing clockdomain\n", oh->name);
1531 oh->clkdm = clkdm_lookup(oh->clkdm_name);
1533 pr_warning("omap_hwmod: %s: could not associate to clkdm %s\n",
1534 oh->name, oh->clkdm_name);
1538 pr_debug("omap_hwmod: %s: associated to clkdm %s\n",
1539 oh->name, oh->clkdm_name);
1545 * _init_clocks - clk_get() all clocks associated with this hwmod. Retrieve as
1546 * well the clockdomain.
1547 * @oh: struct omap_hwmod *
1548 * @data: not used; pass NULL
1550 * Called by omap_hwmod_setup_*() (after omap2_clk_init()).
1551 * Resolves all clock names embedded in the hwmod. Returns 0 on
1552 * success, or a negative error code on failure.
1554 static int _init_clocks(struct omap_hwmod *oh, void *data)
1558 if (oh->_state != _HWMOD_STATE_REGISTERED)
1561 pr_debug("omap_hwmod: %s: looking up clocks\n", oh->name);
1563 if (soc_ops.init_clkdm)
1564 ret |= soc_ops.init_clkdm(oh);
1566 ret |= _init_main_clk(oh);
1567 ret |= _init_interface_clks(oh);
1568 ret |= _init_opt_clks(oh);
1571 oh->_state = _HWMOD_STATE_CLKS_INITED;
1573 pr_warning("omap_hwmod: %s: cannot _init_clocks\n", oh->name);
1579 * _lookup_hardreset - fill register bit info for this hwmod/reset line
1580 * @oh: struct omap_hwmod *
1581 * @name: name of the reset line in the context of this hwmod
1582 * @ohri: struct omap_hwmod_rst_info * that this function will fill in
1584 * Return the bit position of the reset line that match the
1585 * input name. Return -ENOENT if not found.
1587 static int _lookup_hardreset(struct omap_hwmod *oh, const char *name,
1588 struct omap_hwmod_rst_info *ohri)
1592 for (i = 0; i < oh->rst_lines_cnt; i++) {
1593 const char *rst_line = oh->rst_lines[i].name;
1594 if (!strcmp(rst_line, name)) {
1595 ohri->rst_shift = oh->rst_lines[i].rst_shift;
1596 ohri->st_shift = oh->rst_lines[i].st_shift;
1597 pr_debug("omap_hwmod: %s: %s: %s: rst %d st %d\n",
1598 oh->name, __func__, rst_line, ohri->rst_shift,
1609 * _assert_hardreset - assert the HW reset line of submodules
1610 * contained in the hwmod module.
1611 * @oh: struct omap_hwmod *
1612 * @name: name of the reset line to lookup and assert
1614 * Some IP like dsp, ipu or iva contain processor that require an HW
1615 * reset line to be assert / deassert in order to enable fully the IP.
1616 * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1617 * asserting the hardreset line on the currently-booted SoC, or passes
1618 * along the return value from _lookup_hardreset() or the SoC's
1619 * assert_hardreset code.
1621 static int _assert_hardreset(struct omap_hwmod *oh, const char *name)
1623 struct omap_hwmod_rst_info ohri;
1629 if (!soc_ops.assert_hardreset)
1632 ret = _lookup_hardreset(oh, name, &ohri);
1636 ret = soc_ops.assert_hardreset(oh, &ohri);
1642 * _deassert_hardreset - deassert the HW reset line of submodules contained
1643 * in the hwmod module.
1644 * @oh: struct omap_hwmod *
1645 * @name: name of the reset line to look up and deassert
1647 * Some IP like dsp, ipu or iva contain processor that require an HW
1648 * reset line to be assert / deassert in order to enable fully the IP.
1649 * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1650 * deasserting the hardreset line on the currently-booted SoC, or passes
1651 * along the return value from _lookup_hardreset() or the SoC's
1652 * deassert_hardreset code.
1654 static int _deassert_hardreset(struct omap_hwmod *oh, const char *name)
1656 struct omap_hwmod_rst_info ohri;
1663 if (!soc_ops.deassert_hardreset)
1666 ret = _lookup_hardreset(oh, name, &ohri);
1667 if (IS_ERR_VALUE(ret))
1672 * A clockdomain must be in SW_SUP otherwise reset
1673 * might not be completed. The clockdomain can be set
1674 * in HW_AUTO only when the module become ready.
1676 hwsup = clkdm_in_hwsup(oh->clkdm);
1677 ret = clkdm_hwmod_enable(oh->clkdm, oh);
1679 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1680 oh->name, oh->clkdm->name, ret);
1686 if (soc_ops.enable_module)
1687 soc_ops.enable_module(oh);
1689 ret = soc_ops.deassert_hardreset(oh, &ohri);
1691 if (soc_ops.disable_module)
1692 soc_ops.disable_module(oh);
1693 _disable_clocks(oh);
1696 pr_warning("omap_hwmod: %s: failed to hardreset\n", oh->name);
1700 * Set the clockdomain to HW_AUTO, assuming that the
1701 * previous state was HW_AUTO.
1703 if (oh->clkdm && hwsup)
1704 clkdm_allow_idle(oh->clkdm);
1707 clkdm_hwmod_disable(oh->clkdm, oh);
1714 * _read_hardreset - read the HW reset line state of submodules
1715 * contained in the hwmod module
1716 * @oh: struct omap_hwmod *
1717 * @name: name of the reset line to look up and read
1719 * Return the state of the reset line. Returns -EINVAL if @oh is
1720 * null, -ENOSYS if we have no way of reading the hardreset line
1721 * status on the currently-booted SoC, or passes along the return
1722 * value from _lookup_hardreset() or the SoC's is_hardreset_asserted
1725 static int _read_hardreset(struct omap_hwmod *oh, const char *name)
1727 struct omap_hwmod_rst_info ohri;
1733 if (!soc_ops.is_hardreset_asserted)
1736 ret = _lookup_hardreset(oh, name, &ohri);
1740 return soc_ops.is_hardreset_asserted(oh, &ohri);
1744 * _are_all_hardreset_lines_asserted - return true if the @oh is hard-reset
1745 * @oh: struct omap_hwmod *
1747 * If all hardreset lines associated with @oh are asserted, then return true.
1748 * Otherwise, if part of @oh is out hardreset or if no hardreset lines
1749 * associated with @oh are asserted, then return false.
1750 * This function is used to avoid executing some parts of the IP block
1751 * enable/disable sequence if its hardreset line is set.
1753 static bool _are_all_hardreset_lines_asserted(struct omap_hwmod *oh)
1757 if (oh->rst_lines_cnt == 0)
1760 for (i = 0; i < oh->rst_lines_cnt; i++)
1761 if (_read_hardreset(oh, oh->rst_lines[i].name) > 0)
1764 if (oh->rst_lines_cnt == rst_cnt)
1771 * _are_any_hardreset_lines_asserted - return true if any part of @oh is
1773 * @oh: struct omap_hwmod *
1775 * If any hardreset lines associated with @oh are asserted, then
1776 * return true. Otherwise, if no hardreset lines associated with @oh
1777 * are asserted, or if @oh has no hardreset lines, then return false.
1778 * This function is used to avoid executing some parts of the IP block
1779 * enable/disable sequence if any hardreset line is set.
1781 static bool _are_any_hardreset_lines_asserted(struct omap_hwmod *oh)
1786 for (i = 0; i < oh->rst_lines_cnt && rst_cnt == 0; i++)
1787 if (_read_hardreset(oh, oh->rst_lines[i].name) > 0)
1790 return (rst_cnt) ? true : false;
1794 * _omap4_disable_module - enable CLKCTRL modulemode on OMAP4
1795 * @oh: struct omap_hwmod *
1797 * Disable the PRCM module mode related to the hwmod @oh.
1798 * Return EINVAL if the modulemode is not supported and 0 in case of success.
1800 static int _omap4_disable_module(struct omap_hwmod *oh)
1804 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
1808 * Since integration code might still be doing something, only
1809 * disable if all lines are under hardreset.
1811 if (_are_any_hardreset_lines_asserted(oh))
1814 pr_debug("omap_hwmod: %s: %s\n", oh->name, __func__);
1816 omap4_cminst_module_disable(oh->clkdm->prcm_partition,
1818 oh->clkdm->clkdm_offs,
1819 oh->prcm.omap4.clkctrl_offs);
1821 v = _omap4_wait_target_disable(oh);
1823 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1830 * _am33xx_disable_module - enable CLKCTRL modulemode on AM33XX
1831 * @oh: struct omap_hwmod *
1833 * Disable the PRCM module mode related to the hwmod @oh.
1834 * Return EINVAL if the modulemode is not supported and 0 in case of success.
1836 static int _am33xx_disable_module(struct omap_hwmod *oh)
1840 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
1843 pr_debug("omap_hwmod: %s: %s\n", oh->name, __func__);
1845 if (_are_any_hardreset_lines_asserted(oh))
1848 am33xx_cm_module_disable(oh->clkdm->cm_inst, oh->clkdm->clkdm_offs,
1849 oh->prcm.omap4.clkctrl_offs);
1851 v = _am33xx_wait_target_disable(oh);
1853 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1860 * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1861 * @oh: struct omap_hwmod *
1863 * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit. hwmod must be
1864 * enabled for this to work. Returns -ENOENT if the hwmod cannot be
1865 * reset this way, -EINVAL if the hwmod is in the wrong state,
1866 * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1868 * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1869 * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1870 * use the SYSCONFIG softreset bit to provide the status.
1872 * Note that some IP like McBSP do have reset control but don't have
1875 static int _ocp_softreset(struct omap_hwmod *oh)
1881 if (!oh->class->sysc ||
1882 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
1885 /* clocks must be on for this operation */
1886 if (oh->_state != _HWMOD_STATE_ENABLED) {
1887 pr_warn("omap_hwmod: %s: reset can only be entered from enabled state\n",
1892 /* For some modules, all optionnal clocks need to be enabled as well */
1893 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1894 _enable_optional_clocks(oh);
1896 pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh->name);
1898 v = oh->_sysc_cache;
1899 ret = _set_softreset(oh, &v);
1902 _write_sysconfig(v, oh);
1904 if (oh->class->sysc->srst_udelay)
1905 udelay(oh->class->sysc->srst_udelay);
1907 c = _wait_softreset_complete(oh);
1908 if (c == MAX_MODULE_SOFTRESET_WAIT)
1909 pr_warning("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1910 oh->name, MAX_MODULE_SOFTRESET_WAIT);
1912 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh->name, c);
1915 * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1916 * _wait_target_ready() or _reset()
1919 ret = (c == MAX_MODULE_SOFTRESET_WAIT) ? -ETIMEDOUT : 0;
1922 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1923 _disable_optional_clocks(oh);
1929 * _reset - reset an omap_hwmod
1930 * @oh: struct omap_hwmod *
1932 * Resets an omap_hwmod @oh. If the module has a custom reset
1933 * function pointer defined, then call it to reset the IP block, and
1934 * pass along its return value to the caller. Otherwise, if the IP
1935 * block has an OCP_SYSCONFIG register with a SOFTRESET bitfield
1936 * associated with it, call a function to reset the IP block via that
1937 * method, and pass along the return value to the caller. Finally, if
1938 * the IP block has some hardreset lines associated with it, assert
1939 * all of those, but do _not_ deassert them. (This is because driver
1940 * authors have expressed an apparent requirement to control the
1941 * deassertion of the hardreset lines themselves.)
1943 * The default software reset mechanism for most OMAP IP blocks is
1944 * triggered via the OCP_SYSCONFIG.SOFTRESET bit. However, some
1945 * hwmods cannot be reset via this method. Some are not targets and
1946 * therefore have no OCP header registers to access. Others (like the
1947 * IVA) have idiosyncratic reset sequences. So for these relatively
1948 * rare cases, custom reset code can be supplied in the struct
1949 * omap_hwmod_class .reset function pointer.
1951 * _set_dmadisable() is called to set the DMADISABLE bit so that it
1952 * does not prevent idling of the system. This is necessary for cases
1953 * where ROMCODE/BOOTLOADER uses dma and transfers control to the
1954 * kernel without disabling dma.
1956 * Passes along the return value from either _ocp_softreset() or the
1957 * custom reset function - these must return -EINVAL if the hwmod
1958 * cannot be reset this way or if the hwmod is in the wrong state,
1959 * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1961 static int _reset(struct omap_hwmod *oh)
1965 pr_debug("omap_hwmod: %s: resetting\n", oh->name);
1967 if (oh->class->reset) {
1968 r = oh->class->reset(oh);
1970 if (oh->rst_lines_cnt > 0) {
1971 for (i = 0; i < oh->rst_lines_cnt; i++)
1972 _assert_hardreset(oh, oh->rst_lines[i].name);
1975 r = _ocp_softreset(oh);
1981 _set_dmadisable(oh);
1984 * OCP_SYSCONFIG bits need to be reprogrammed after a
1985 * softreset. The _enable() function should be split to avoid
1986 * the rewrite of the OCP_SYSCONFIG register.
1988 if (oh->class->sysc) {
1989 _update_sysc_cache(oh);
1997 * _reconfigure_io_chain - clear any I/O chain wakeups and reconfigure chain
1999 * Call the appropriate PRM function to clear any logged I/O chain
2000 * wakeups and to reconfigure the chain. This apparently needs to be
2001 * done upon every mux change. Since hwmods can be concurrently
2002 * enabled and idled, hold a spinlock around the I/O chain
2003 * reconfiguration sequence. No return value.
2005 * XXX When the PRM code is moved to drivers, this function can be removed,
2006 * as the PRM infrastructure should abstract this.
2008 static void _reconfigure_io_chain(void)
2010 unsigned long flags;
2012 spin_lock_irqsave(&io_chain_lock, flags);
2014 if (cpu_is_omap34xx() && omap3_has_io_chain_ctrl())
2015 omap3xxx_prm_reconfigure_io_chain();
2016 else if (cpu_is_omap44xx())
2017 omap44xx_prm_reconfigure_io_chain();
2019 spin_unlock_irqrestore(&io_chain_lock, flags);
2023 * _omap4_update_context_lost - increment hwmod context loss counter if
2024 * hwmod context was lost, and clear hardware context loss reg
2025 * @oh: hwmod to check for context loss
2027 * If the PRCM indicates that the hwmod @oh lost context, increment
2028 * our in-memory context loss counter, and clear the RM_*_CONTEXT
2029 * bits. No return value.
2031 static void _omap4_update_context_lost(struct omap_hwmod *oh)
2033 if (oh->prcm.omap4.flags & HWMOD_OMAP4_NO_CONTEXT_LOSS_BIT)
2036 if (!prm_was_any_context_lost_old(oh->clkdm->pwrdm.ptr->prcm_partition,
2037 oh->clkdm->pwrdm.ptr->prcm_offs,
2038 oh->prcm.omap4.context_offs))
2041 oh->prcm.omap4.context_lost_counter++;
2042 prm_clear_context_loss_flags_old(oh->clkdm->pwrdm.ptr->prcm_partition,
2043 oh->clkdm->pwrdm.ptr->prcm_offs,
2044 oh->prcm.omap4.context_offs);
2048 * _omap4_get_context_lost - get context loss counter for a hwmod
2049 * @oh: hwmod to get context loss counter for
2051 * Returns the in-memory context loss counter for a hwmod.
2053 static int _omap4_get_context_lost(struct omap_hwmod *oh)
2055 return oh->prcm.omap4.context_lost_counter;
2059 * _enable_preprogram - Pre-program an IP block during the _enable() process
2060 * @oh: struct omap_hwmod *
2062 * Some IP blocks (such as AESS) require some additional programming
2063 * after enable before they can enter idle. If a function pointer to
2064 * do so is present in the hwmod data, then call it and pass along the
2065 * return value; otherwise, return 0.
2067 static int __init _enable_preprogram(struct omap_hwmod *oh)
2069 if (!oh->class->enable_preprogram)
2072 return oh->class->enable_preprogram(oh);
2076 * _enable - enable an omap_hwmod
2077 * @oh: struct omap_hwmod *
2079 * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
2080 * register target. Returns -EINVAL if the hwmod is in the wrong
2081 * state or passes along the return value of _wait_target_ready().
2083 static int _enable(struct omap_hwmod *oh)
2088 pr_debug("omap_hwmod: %s: enabling\n", oh->name);
2091 * hwmods with HWMOD_INIT_NO_IDLE flag set are left in enabled
2092 * state at init. Now that someone is really trying to enable
2093 * them, just ensure that the hwmod mux is set.
2095 if (oh->_int_flags & _HWMOD_SKIP_ENABLE) {
2097 * If the caller has mux data populated, do the mux'ing
2098 * which wouldn't have been done as part of the _enable()
2099 * done during setup.
2102 omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
2104 oh->_int_flags &= ~_HWMOD_SKIP_ENABLE;
2108 if (oh->_state != _HWMOD_STATE_INITIALIZED &&
2109 oh->_state != _HWMOD_STATE_IDLE &&
2110 oh->_state != _HWMOD_STATE_DISABLED) {
2111 WARN(1, "omap_hwmod: %s: enabled state can only be entered from initialized, idle, or disabled state\n",
2117 * If an IP block contains HW reset lines and all of them are
2118 * asserted, we let integration code associated with that
2119 * block handle the enable. We've received very little
2120 * information on what those driver authors need, and until
2121 * detailed information is provided and the driver code is
2122 * posted to the public lists, this is probably the best we
2125 if (_are_all_hardreset_lines_asserted(oh))
2128 /* Mux pins for device runtime if populated */
2129 if (oh->mux && (!oh->mux->enabled ||
2130 ((oh->_state == _HWMOD_STATE_IDLE) &&
2131 oh->mux->pads_dynamic))) {
2132 omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
2133 _reconfigure_io_chain();
2136 _add_initiator_dep(oh, mpu_oh);
2140 * A clockdomain must be in SW_SUP before enabling
2141 * completely the module. The clockdomain can be set
2142 * in HW_AUTO only when the module become ready.
2144 hwsup = clkdm_in_hwsup(oh->clkdm) &&
2145 !clkdm_missing_idle_reporting(oh->clkdm);
2146 r = clkdm_hwmod_enable(oh->clkdm, oh);
2148 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
2149 oh->name, oh->clkdm->name, r);
2155 if (soc_ops.enable_module)
2156 soc_ops.enable_module(oh);
2157 if (oh->flags & HWMOD_BLOCK_WFI)
2160 if (soc_ops.update_context_lost)
2161 soc_ops.update_context_lost(oh);
2163 r = (soc_ops.wait_target_ready) ? soc_ops.wait_target_ready(oh) :
2167 * Set the clockdomain to HW_AUTO only if the target is ready,
2168 * assuming that the previous state was HW_AUTO
2170 if (oh->clkdm && hwsup)
2171 clkdm_allow_idle(oh->clkdm);
2173 oh->_state = _HWMOD_STATE_ENABLED;
2175 /* Access the sysconfig only if the target is ready */
2176 if (oh->class->sysc) {
2177 if (!(oh->_int_flags & _HWMOD_SYSCONFIG_LOADED))
2178 _update_sysc_cache(oh);
2181 r = _enable_preprogram(oh);
2183 if (soc_ops.disable_module)
2184 soc_ops.disable_module(oh);
2185 _disable_clocks(oh);
2186 pr_debug("omap_hwmod: %s: _wait_target_ready: %d\n",
2190 clkdm_hwmod_disable(oh->clkdm, oh);
2197 * _idle - idle an omap_hwmod
2198 * @oh: struct omap_hwmod *
2200 * Idles an omap_hwmod @oh. This should be called once the hwmod has
2201 * no further work. Returns -EINVAL if the hwmod is in the wrong
2202 * state or returns 0.
2204 static int _idle(struct omap_hwmod *oh)
2206 pr_debug("omap_hwmod: %s: idling\n", oh->name);
2208 if (oh->_state != _HWMOD_STATE_ENABLED) {
2209 WARN(1, "omap_hwmod: %s: idle state can only be entered from enabled state\n",
2214 if (_are_all_hardreset_lines_asserted(oh))
2217 if (oh->class->sysc)
2219 _del_initiator_dep(oh, mpu_oh);
2221 if (oh->flags & HWMOD_BLOCK_WFI)
2223 if (soc_ops.disable_module)
2224 soc_ops.disable_module(oh);
2227 * The module must be in idle mode before disabling any parents
2228 * clocks. Otherwise, the parent clock might be disabled before
2229 * the module transition is done, and thus will prevent the
2230 * transition to complete properly.
2232 _disable_clocks(oh);
2234 clkdm_hwmod_disable(oh->clkdm, oh);
2236 /* Mux pins for device idle if populated */
2237 if (oh->mux && oh->mux->pads_dynamic) {
2238 omap_hwmod_mux(oh->mux, _HWMOD_STATE_IDLE);
2239 _reconfigure_io_chain();
2242 oh->_state = _HWMOD_STATE_IDLE;
2248 * omap_hwmod_set_ocp_autoidle - set the hwmod's OCP autoidle bit
2249 * @oh: struct omap_hwmod *
2250 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
2252 * Sets the IP block's OCP autoidle bit in hardware, and updates our
2253 * local copy. Intended to be used by drivers that require
2254 * direct manipulation of the AUTOIDLE bits.
2255 * Returns -EINVAL if @oh is null or is not in the ENABLED state, or passes
2256 * along the return value from _set_module_autoidle().
2258 * Any users of this function should be scrutinized carefully.
2260 int omap_hwmod_set_ocp_autoidle(struct omap_hwmod *oh, u8 autoidle)
2264 unsigned long flags;
2266 if (!oh || oh->_state != _HWMOD_STATE_ENABLED)
2269 spin_lock_irqsave(&oh->_lock, flags);
2271 v = oh->_sysc_cache;
2273 retval = _set_module_autoidle(oh, autoidle, &v);
2276 _write_sysconfig(v, oh);
2278 spin_unlock_irqrestore(&oh->_lock, flags);
2284 * _shutdown - shutdown an omap_hwmod
2285 * @oh: struct omap_hwmod *
2287 * Shut down an omap_hwmod @oh. This should be called when the driver
2288 * used for the hwmod is removed or unloaded or if the driver is not
2289 * used by the system. Returns -EINVAL if the hwmod is in the wrong
2290 * state or returns 0.
2292 static int _shutdown(struct omap_hwmod *oh)
2297 if (oh->_state != _HWMOD_STATE_IDLE &&
2298 oh->_state != _HWMOD_STATE_ENABLED) {
2299 WARN(1, "omap_hwmod: %s: disabled state can only be entered from idle, or enabled state\n",
2304 if (_are_all_hardreset_lines_asserted(oh))
2307 pr_debug("omap_hwmod: %s: disabling\n", oh->name);
2309 if (oh->class->pre_shutdown) {
2310 prev_state = oh->_state;
2311 if (oh->_state == _HWMOD_STATE_IDLE)
2313 ret = oh->class->pre_shutdown(oh);
2315 if (prev_state == _HWMOD_STATE_IDLE)
2321 if (oh->class->sysc) {
2322 if (oh->_state == _HWMOD_STATE_IDLE)
2327 /* clocks and deps are already disabled in idle */
2328 if (oh->_state == _HWMOD_STATE_ENABLED) {
2329 _del_initiator_dep(oh, mpu_oh);
2330 /* XXX what about the other system initiators here? dma, dsp */
2331 if (oh->flags & HWMOD_BLOCK_WFI)
2333 if (soc_ops.disable_module)
2334 soc_ops.disable_module(oh);
2335 _disable_clocks(oh);
2337 clkdm_hwmod_disable(oh->clkdm, oh);
2339 /* XXX Should this code also force-disable the optional clocks? */
2341 for (i = 0; i < oh->rst_lines_cnt; i++)
2342 _assert_hardreset(oh, oh->rst_lines[i].name);
2344 /* Mux pins to safe mode or use populated off mode values */
2346 omap_hwmod_mux(oh->mux, _HWMOD_STATE_DISABLED);
2348 oh->_state = _HWMOD_STATE_DISABLED;
2354 * of_dev_hwmod_lookup - look up needed hwmod from dt blob
2355 * @np: struct device_node *
2356 * @oh: struct omap_hwmod *
2358 * Parse the dt blob and find out needed hwmod. Recursive function is
2359 * implemented to take care hierarchical dt blob parsing.
2360 * Return: The device node on success or NULL on failure.
2362 static struct device_node *of_dev_hwmod_lookup(struct device_node *np,
2363 struct omap_hwmod *oh)
2365 struct device_node *np0 = NULL, *np1 = NULL;
2368 for_each_child_of_node(np, np0) {
2369 if (of_find_property(np0, "ti,hwmods", NULL)) {
2370 p = of_get_property(np0, "ti,hwmods", NULL);
2371 if (!strcmp(p, oh->name))
2373 np1 = of_dev_hwmod_lookup(np0, oh);
2382 * _init_mpu_rt_base - populate the virtual address for a hwmod
2383 * @oh: struct omap_hwmod * to locate the virtual address
2385 * Cache the virtual address used by the MPU to access this IP block's
2386 * registers. This address is needed early so the OCP registers that
2387 * are part of the device's address space can be ioremapped properly.
2390 static void __init _init_mpu_rt_base(struct omap_hwmod *oh, void *data)
2392 struct omap_hwmod_addr_space *mem;
2393 void __iomem *va_start = NULL;
2394 struct device_node *np;
2399 _save_mpu_port_index(oh);
2401 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2404 mem = _find_mpu_rt_addr_space(oh);
2406 pr_debug("omap_hwmod: %s: no MPU register target found\n",
2409 /* Extract the IO space from device tree blob */
2410 if (!of_have_populated_dt())
2413 np = of_dev_hwmod_lookup(of_find_node_by_name(NULL, "ocp"), oh);
2415 va_start = of_iomap(np, 0);
2417 va_start = ioremap(mem->pa_start, mem->pa_end - mem->pa_start);
2421 pr_err("omap_hwmod: %s: Could not ioremap\n", oh->name);
2425 pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
2426 oh->name, va_start);
2428 oh->_mpu_rt_va = va_start;
2432 * _init - initialize internal data for the hwmod @oh
2433 * @oh: struct omap_hwmod *
2436 * Look up the clocks and the address space used by the MPU to access
2437 * registers belonging to the hwmod @oh. @oh must already be
2438 * registered at this point. This is the first of two phases for
2439 * hwmod initialization. Code called here does not touch any hardware
2440 * registers, it simply prepares internal data structures. Returns 0
2441 * upon success or if the hwmod isn't registered, or -EINVAL upon
2444 static int __init _init(struct omap_hwmod *oh, void *data)
2448 if (oh->_state != _HWMOD_STATE_REGISTERED)
2451 if (oh->class->sysc)
2452 _init_mpu_rt_base(oh, NULL);
2454 r = _init_clocks(oh, NULL);
2455 if (IS_ERR_VALUE(r)) {
2456 WARN(1, "omap_hwmod: %s: couldn't init clocks\n", oh->name);
2460 oh->_state = _HWMOD_STATE_INITIALIZED;
2466 * _setup_iclk_autoidle - configure an IP block's interface clocks
2467 * @oh: struct omap_hwmod *
2469 * Set up the module's interface clocks. XXX This function is still mostly
2470 * a stub; implementing this properly requires iclk autoidle usecounting in
2471 * the clock code. No return value.
2473 static void __init _setup_iclk_autoidle(struct omap_hwmod *oh)
2475 struct omap_hwmod_ocp_if *os;
2476 struct list_head *p;
2478 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2481 p = oh->slave_ports.next;
2483 while (i < oh->slaves_cnt) {
2484 os = _fetch_next_ocp_if(&p, &i);
2488 if (os->flags & OCPIF_SWSUP_IDLE) {
2489 /* XXX omap_iclk_deny_idle(c); */
2491 /* XXX omap_iclk_allow_idle(c); */
2492 clk_enable(os->_clk);
2500 * _setup_reset - reset an IP block during the setup process
2501 * @oh: struct omap_hwmod *
2503 * Reset the IP block corresponding to the hwmod @oh during the setup
2504 * process. The IP block is first enabled so it can be successfully
2505 * reset. Returns 0 upon success or a negative error code upon
2508 static int __init _setup_reset(struct omap_hwmod *oh)
2512 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2515 if (oh->flags & HWMOD_EXT_OPT_MAIN_CLK)
2518 if (oh->rst_lines_cnt == 0) {
2521 pr_warning("omap_hwmod: %s: cannot be enabled for reset (%d)\n",
2522 oh->name, oh->_state);
2527 if (!(oh->flags & HWMOD_INIT_NO_RESET))
2534 * _setup_postsetup - transition to the appropriate state after _setup
2535 * @oh: struct omap_hwmod *
2537 * Place an IP block represented by @oh into a "post-setup" state --
2538 * either IDLE, ENABLED, or DISABLED. ("post-setup" simply means that
2539 * this function is called at the end of _setup().) The postsetup
2540 * state for an IP block can be changed by calling
2541 * omap_hwmod_enter_postsetup_state() early in the boot process,
2542 * before one of the omap_hwmod_setup*() functions are called for the
2545 * The IP block stays in this state until a PM runtime-based driver is
2546 * loaded for that IP block. A post-setup state of IDLE is
2547 * appropriate for almost all IP blocks with runtime PM-enabled
2548 * drivers, since those drivers are able to enable the IP block. A
2549 * post-setup state of ENABLED is appropriate for kernels with PM
2550 * runtime disabled. The DISABLED state is appropriate for unusual IP
2551 * blocks such as the MPU WDTIMER on kernels without WDTIMER drivers
2552 * included, since the WDTIMER starts running on reset and will reset
2553 * the MPU if left active.
2555 * This post-setup mechanism is deprecated. Once all of the OMAP
2556 * drivers have been converted to use PM runtime, and all of the IP
2557 * block data and interconnect data is available to the hwmod code, it
2558 * should be possible to replace this mechanism with a "lazy reset"
2559 * arrangement. In a "lazy reset" setup, each IP block is enabled
2560 * when the driver first probes, then all remaining IP blocks without
2561 * drivers are either shut down or enabled after the drivers have
2562 * loaded. However, this cannot take place until the above
2563 * preconditions have been met, since otherwise the late reset code
2564 * has no way of knowing which IP blocks are in use by drivers, and
2565 * which ones are unused.
2569 static void __init _setup_postsetup(struct omap_hwmod *oh)
2573 if (oh->rst_lines_cnt > 0)
2576 postsetup_state = oh->_postsetup_state;
2577 if (postsetup_state == _HWMOD_STATE_UNKNOWN)
2578 postsetup_state = _HWMOD_STATE_ENABLED;
2581 * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
2582 * it should be set by the core code as a runtime flag during startup
2584 if ((oh->flags & HWMOD_INIT_NO_IDLE) &&
2585 (postsetup_state == _HWMOD_STATE_IDLE)) {
2586 oh->_int_flags |= _HWMOD_SKIP_ENABLE;
2587 postsetup_state = _HWMOD_STATE_ENABLED;
2590 if (postsetup_state == _HWMOD_STATE_IDLE)
2592 else if (postsetup_state == _HWMOD_STATE_DISABLED)
2594 else if (postsetup_state != _HWMOD_STATE_ENABLED)
2595 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
2596 oh->name, postsetup_state);
2602 * _setup - prepare IP block hardware for use
2603 * @oh: struct omap_hwmod *
2604 * @n: (unused, pass NULL)
2606 * Configure the IP block represented by @oh. This may include
2607 * enabling the IP block, resetting it, and placing it into a
2608 * post-setup state, depending on the type of IP block and applicable
2609 * flags. IP blocks are reset to prevent any previous configuration
2610 * by the bootloader or previous operating system from interfering
2611 * with power management or other parts of the system. The reset can
2612 * be avoided; see omap_hwmod_no_setup_reset(). This is the second of
2613 * two phases for hwmod initialization. Code called here generally
2614 * affects the IP block hardware, or system integration hardware
2615 * associated with the IP block. Returns 0.
2617 static int __init _setup(struct omap_hwmod *oh, void *data)
2619 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2622 _setup_iclk_autoidle(oh);
2624 if (!_setup_reset(oh))
2625 _setup_postsetup(oh);
2631 * _register - register a struct omap_hwmod
2632 * @oh: struct omap_hwmod *
2634 * Registers the omap_hwmod @oh. Returns -EEXIST if an omap_hwmod
2635 * already has been registered by the same name; -EINVAL if the
2636 * omap_hwmod is in the wrong state, if @oh is NULL, if the
2637 * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
2638 * name, or if the omap_hwmod's class is missing a name; or 0 upon
2641 * XXX The data should be copied into bootmem, so the original data
2642 * should be marked __initdata and freed after init. This would allow
2643 * unneeded omap_hwmods to be freed on multi-OMAP configurations. Note
2644 * that the copy process would be relatively complex due to the large number
2647 static int __init _register(struct omap_hwmod *oh)
2649 if (!oh || !oh->name || !oh->class || !oh->class->name ||
2650 (oh->_state != _HWMOD_STATE_UNKNOWN))
2653 pr_debug("omap_hwmod: %s: registering\n", oh->name);
2655 if (_lookup(oh->name))
2658 list_add_tail(&oh->node, &omap_hwmod_list);
2660 INIT_LIST_HEAD(&oh->master_ports);
2661 INIT_LIST_HEAD(&oh->slave_ports);
2662 spin_lock_init(&oh->_lock);
2664 oh->_state = _HWMOD_STATE_REGISTERED;
2667 * XXX Rather than doing a strcmp(), this should test a flag
2668 * set in the hwmod data, inserted by the autogenerator code.
2670 if (!strcmp(oh->name, MPU_INITIATOR_NAME))
2677 * _alloc_links - return allocated memory for hwmod links
2678 * @ml: pointer to a struct omap_hwmod_link * for the master link
2679 * @sl: pointer to a struct omap_hwmod_link * for the slave link
2681 * Return pointers to two struct omap_hwmod_link records, via the
2682 * addresses pointed to by @ml and @sl. Will first attempt to return
2683 * memory allocated as part of a large initial block, but if that has
2684 * been exhausted, will allocate memory itself. Since ideally this
2685 * second allocation path will never occur, the number of these
2686 * 'supplemental' allocations will be logged when debugging is
2687 * enabled. Returns 0.
2689 static int __init _alloc_links(struct omap_hwmod_link **ml,
2690 struct omap_hwmod_link **sl)
2694 if ((free_ls + LINKS_PER_OCP_IF) <= max_ls) {
2695 *ml = &linkspace[free_ls++];
2696 *sl = &linkspace[free_ls++];
2700 sz = sizeof(struct omap_hwmod_link) * LINKS_PER_OCP_IF;
2703 *ml = alloc_bootmem(sz);
2707 *sl = (void *)(*ml) + sizeof(struct omap_hwmod_link);
2710 pr_debug("omap_hwmod: supplemental link allocations needed: %d\n",
2711 ls_supp * LINKS_PER_OCP_IF);
2717 * _add_link - add an interconnect between two IP blocks
2718 * @oi: pointer to a struct omap_hwmod_ocp_if record
2720 * Add struct omap_hwmod_link records connecting the master IP block
2721 * specified in @oi->master to @oi, and connecting the slave IP block
2722 * specified in @oi->slave to @oi. This code is assumed to run before
2723 * preemption or SMP has been enabled, thus avoiding the need for
2724 * locking in this code. Changes to this assumption will require
2725 * additional locking. Returns 0.
2727 static int __init _add_link(struct omap_hwmod_ocp_if *oi)
2729 struct omap_hwmod_link *ml, *sl;
2731 pr_debug("omap_hwmod: %s -> %s: adding link\n", oi->master->name,
2734 _alloc_links(&ml, &sl);
2737 INIT_LIST_HEAD(&ml->node);
2738 list_add(&ml->node, &oi->master->master_ports);
2739 oi->master->masters_cnt++;
2742 INIT_LIST_HEAD(&sl->node);
2743 list_add(&sl->node, &oi->slave->slave_ports);
2744 oi->slave->slaves_cnt++;
2750 * _register_link - register a struct omap_hwmod_ocp_if
2751 * @oi: struct omap_hwmod_ocp_if *
2753 * Registers the omap_hwmod_ocp_if record @oi. Returns -EEXIST if it
2754 * has already been registered; -EINVAL if @oi is NULL or if the
2755 * record pointed to by @oi is missing required fields; or 0 upon
2758 * XXX The data should be copied into bootmem, so the original data
2759 * should be marked __initdata and freed after init. This would allow
2760 * unneeded omap_hwmods to be freed on multi-OMAP configurations.
2762 static int __init _register_link(struct omap_hwmod_ocp_if *oi)
2764 if (!oi || !oi->master || !oi->slave || !oi->user)
2767 if (oi->_int_flags & _OCPIF_INT_FLAGS_REGISTERED)
2770 pr_debug("omap_hwmod: registering link from %s to %s\n",
2771 oi->master->name, oi->slave->name);
2774 * Register the connected hwmods, if they haven't been
2775 * registered already
2777 if (oi->master->_state != _HWMOD_STATE_REGISTERED)
2778 _register(oi->master);
2780 if (oi->slave->_state != _HWMOD_STATE_REGISTERED)
2781 _register(oi->slave);
2785 oi->_int_flags |= _OCPIF_INT_FLAGS_REGISTERED;
2791 * _alloc_linkspace - allocate large block of hwmod links
2792 * @ois: pointer to an array of struct omap_hwmod_ocp_if records to count
2794 * Allocate a large block of struct omap_hwmod_link records. This
2795 * improves boot time significantly by avoiding the need to allocate
2796 * individual records one by one. If the number of records to
2797 * allocate in the block hasn't been manually specified, this function
2798 * will count the number of struct omap_hwmod_ocp_if records in @ois
2799 * and use that to determine the allocation size. For SoC families
2800 * that require multiple list registrations, such as OMAP3xxx, this
2801 * estimation process isn't optimal, so manual estimation is advised
2802 * in those cases. Returns -EEXIST if the allocation has already occurred
2803 * or 0 upon success.
2805 static int __init _alloc_linkspace(struct omap_hwmod_ocp_if **ois)
2811 WARN(1, "linkspace already allocated\n");
2817 max_ls += LINKS_PER_OCP_IF;
2819 sz = sizeof(struct omap_hwmod_link) * max_ls;
2821 pr_debug("omap_hwmod: %s: allocating %d byte linkspace (%d links)\n",
2822 __func__, sz, max_ls);
2824 linkspace = alloc_bootmem(sz);
2826 memset(linkspace, 0, sz);
2831 /* Static functions intended only for use in soc_ops field function pointers */
2834 * _omap2xxx_wait_target_ready - wait for a module to leave slave idle
2835 * @oh: struct omap_hwmod *
2837 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2838 * does not have an IDLEST bit or if the module successfully leaves
2839 * slave idle; otherwise, pass along the return value of the
2840 * appropriate *_cm*_wait_module_ready() function.
2842 static int _omap2xxx_wait_target_ready(struct omap_hwmod *oh)
2847 if (oh->flags & HWMOD_NO_IDLEST)
2850 if (!_find_mpu_rt_port(oh))
2853 /* XXX check module SIDLEMODE, hardreset status, enabled clocks */
2855 return omap2xxx_cm_wait_module_ready(oh->prcm.omap2.module_offs,
2856 oh->prcm.omap2.idlest_reg_id,
2857 oh->prcm.omap2.idlest_idle_bit);
2861 * _omap3xxx_wait_target_ready - wait for a module to leave slave idle
2862 * @oh: struct omap_hwmod *
2864 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2865 * does not have an IDLEST bit or if the module successfully leaves
2866 * slave idle; otherwise, pass along the return value of the
2867 * appropriate *_cm*_wait_module_ready() function.
2869 static int _omap3xxx_wait_target_ready(struct omap_hwmod *oh)
2874 if (oh->flags & HWMOD_NO_IDLEST)
2877 if (!_find_mpu_rt_port(oh))
2880 /* XXX check module SIDLEMODE, hardreset status, enabled clocks */
2882 return omap3xxx_cm_wait_module_ready(oh->prcm.omap2.module_offs,
2883 oh->prcm.omap2.idlest_reg_id,
2884 oh->prcm.omap2.idlest_idle_bit);
2888 * _omap4_wait_target_ready - wait for a module to leave slave idle
2889 * @oh: struct omap_hwmod *
2891 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2892 * does not have an IDLEST bit or if the module successfully leaves
2893 * slave idle; otherwise, pass along the return value of the
2894 * appropriate *_cm*_wait_module_ready() function.
2896 static int _omap4_wait_target_ready(struct omap_hwmod *oh)
2901 if (oh->flags & HWMOD_NO_IDLEST || !oh->clkdm)
2904 if (!_find_mpu_rt_port(oh))
2907 /* XXX check module SIDLEMODE, hardreset status */
2909 return omap4_cminst_wait_module_ready(oh->clkdm->prcm_partition,
2911 oh->clkdm->clkdm_offs,
2912 oh->prcm.omap4.clkctrl_offs);
2916 * _am33xx_wait_target_ready - wait for a module to leave slave idle
2917 * @oh: struct omap_hwmod *
2919 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2920 * does not have an IDLEST bit or if the module successfully leaves
2921 * slave idle; otherwise, pass along the return value of the
2922 * appropriate *_cm*_wait_module_ready() function.
2924 static int _am33xx_wait_target_ready(struct omap_hwmod *oh)
2926 if (!oh || !oh->clkdm)
2929 if (oh->flags & HWMOD_NO_IDLEST)
2932 if (!_find_mpu_rt_port(oh))
2935 /* XXX check module SIDLEMODE, hardreset status */
2937 return am33xx_cm_wait_module_ready(oh->clkdm->cm_inst,
2938 oh->clkdm->clkdm_offs,
2939 oh->prcm.omap4.clkctrl_offs);
2943 * _omap2_assert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2944 * @oh: struct omap_hwmod * to assert hardreset
2945 * @ohri: hardreset line data
2947 * Call omap2_prm_assert_hardreset() with parameters extracted from
2948 * the hwmod @oh and the hardreset line data @ohri. Only intended for
2949 * use as an soc_ops function pointer. Passes along the return value
2950 * from omap2_prm_assert_hardreset(). XXX This function is scheduled
2951 * for removal when the PRM code is moved into drivers/.
2953 static int _omap2_assert_hardreset(struct omap_hwmod *oh,
2954 struct omap_hwmod_rst_info *ohri)
2956 return omap2_prm_assert_hardreset(oh->prcm.omap2.module_offs,
2961 * _omap2_deassert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2962 * @oh: struct omap_hwmod * to deassert hardreset
2963 * @ohri: hardreset line data
2965 * Call omap2_prm_deassert_hardreset() with parameters extracted from
2966 * the hwmod @oh and the hardreset line data @ohri. Only intended for
2967 * use as an soc_ops function pointer. Passes along the return value
2968 * from omap2_prm_deassert_hardreset(). XXX This function is
2969 * scheduled for removal when the PRM code is moved into drivers/.
2971 static int _omap2_deassert_hardreset(struct omap_hwmod *oh,
2972 struct omap_hwmod_rst_info *ohri)
2974 return omap2_prm_deassert_hardreset(oh->prcm.omap2.module_offs,
2980 * _omap2_is_hardreset_asserted - call OMAP2 PRM hardreset fn with hwmod args
2981 * @oh: struct omap_hwmod * to test hardreset
2982 * @ohri: hardreset line data
2984 * Call omap2_prm_is_hardreset_asserted() with parameters extracted
2985 * from the hwmod @oh and the hardreset line data @ohri. Only
2986 * intended for use as an soc_ops function pointer. Passes along the
2987 * return value from omap2_prm_is_hardreset_asserted(). XXX This
2988 * function is scheduled for removal when the PRM code is moved into
2991 static int _omap2_is_hardreset_asserted(struct omap_hwmod *oh,
2992 struct omap_hwmod_rst_info *ohri)
2994 return omap2_prm_is_hardreset_asserted(oh->prcm.omap2.module_offs,
2999 * _omap4_assert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
3000 * @oh: struct omap_hwmod * to assert hardreset
3001 * @ohri: hardreset line data
3003 * Call omap4_prminst_assert_hardreset() with parameters extracted
3004 * from the hwmod @oh and the hardreset line data @ohri. Only
3005 * intended for use as an soc_ops function pointer. Passes along the
3006 * return value from omap4_prminst_assert_hardreset(). XXX This
3007 * function is scheduled for removal when the PRM code is moved into
3010 static int _omap4_assert_hardreset(struct omap_hwmod *oh,
3011 struct omap_hwmod_rst_info *ohri)
3016 return omap4_prminst_assert_hardreset(ohri->rst_shift,
3017 oh->clkdm->pwrdm.ptr->prcm_partition,
3018 oh->clkdm->pwrdm.ptr->prcm_offs,
3019 oh->prcm.omap4.rstctrl_offs);
3023 * _omap4_deassert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
3024 * @oh: struct omap_hwmod * to deassert hardreset
3025 * @ohri: hardreset line data
3027 * Call omap4_prminst_deassert_hardreset() with parameters extracted
3028 * from the hwmod @oh and the hardreset line data @ohri. Only
3029 * intended for use as an soc_ops function pointer. Passes along the
3030 * return value from omap4_prminst_deassert_hardreset(). XXX This
3031 * function is scheduled for removal when the PRM code is moved into
3034 static int _omap4_deassert_hardreset(struct omap_hwmod *oh,
3035 struct omap_hwmod_rst_info *ohri)
3041 pr_err("omap_hwmod: %s: %s: hwmod data error: OMAP4 does not support st_shift\n",
3042 oh->name, ohri->name);
3043 return omap4_prminst_deassert_hardreset(ohri->rst_shift,
3044 oh->clkdm->pwrdm.ptr->prcm_partition,
3045 oh->clkdm->pwrdm.ptr->prcm_offs,
3046 oh->prcm.omap4.rstctrl_offs);
3050 * _omap4_is_hardreset_asserted - call OMAP4 PRM hardreset fn with hwmod args
3051 * @oh: struct omap_hwmod * to test hardreset
3052 * @ohri: hardreset line data
3054 * Call omap4_prminst_is_hardreset_asserted() with parameters
3055 * extracted from the hwmod @oh and the hardreset line data @ohri.
3056 * Only intended for use as an soc_ops function pointer. Passes along
3057 * the return value from omap4_prminst_is_hardreset_asserted(). XXX
3058 * This function is scheduled for removal when the PRM code is moved
3061 static int _omap4_is_hardreset_asserted(struct omap_hwmod *oh,
3062 struct omap_hwmod_rst_info *ohri)
3067 return omap4_prminst_is_hardreset_asserted(ohri->rst_shift,
3068 oh->clkdm->pwrdm.ptr->prcm_partition,
3069 oh->clkdm->pwrdm.ptr->prcm_offs,
3070 oh->prcm.omap4.rstctrl_offs);
3074 * _am33xx_assert_hardreset - call AM33XX PRM hardreset fn with hwmod args
3075 * @oh: struct omap_hwmod * to assert hardreset
3076 * @ohri: hardreset line data
3078 * Call am33xx_prminst_assert_hardreset() with parameters extracted
3079 * from the hwmod @oh and the hardreset line data @ohri. Only
3080 * intended for use as an soc_ops function pointer. Passes along the
3081 * return value from am33xx_prminst_assert_hardreset(). XXX This
3082 * function is scheduled for removal when the PRM code is moved into
3085 static int _am33xx_assert_hardreset(struct omap_hwmod *oh,
3086 struct omap_hwmod_rst_info *ohri)
3089 return am33xx_prm_assert_hardreset(ohri->rst_shift,
3090 oh->clkdm->pwrdm.ptr->prcm_offs,
3091 oh->prcm.omap4.rstctrl_offs);
3095 * _am33xx_deassert_hardreset - call AM33XX PRM hardreset fn with hwmod args
3096 * @oh: struct omap_hwmod * to deassert hardreset
3097 * @ohri: hardreset line data
3099 * Call am33xx_prminst_deassert_hardreset() with parameters extracted
3100 * from the hwmod @oh and the hardreset line data @ohri. Only
3101 * intended for use as an soc_ops function pointer. Passes along the
3102 * return value from am33xx_prminst_deassert_hardreset(). XXX This
3103 * function is scheduled for removal when the PRM code is moved into
3106 static int _am33xx_deassert_hardreset(struct omap_hwmod *oh,
3107 struct omap_hwmod_rst_info *ohri)
3109 return am33xx_prm_deassert_hardreset(ohri->rst_shift,
3111 oh->clkdm->pwrdm.ptr->prcm_offs,
3112 oh->prcm.omap4.rstctrl_offs,
3113 oh->prcm.omap4.rstst_offs);
3117 * _am33xx_is_hardreset_asserted - call AM33XX PRM hardreset fn with hwmod args
3118 * @oh: struct omap_hwmod * to test hardreset
3119 * @ohri: hardreset line data
3121 * Call am33xx_prminst_is_hardreset_asserted() with parameters
3122 * extracted from the hwmod @oh and the hardreset line data @ohri.
3123 * Only intended for use as an soc_ops function pointer. Passes along
3124 * the return value from am33xx_prminst_is_hardreset_asserted(). XXX
3125 * This function is scheduled for removal when the PRM code is moved
3128 static int _am33xx_is_hardreset_asserted(struct omap_hwmod *oh,
3129 struct omap_hwmod_rst_info *ohri)
3131 return am33xx_prm_is_hardreset_asserted(ohri->rst_shift,
3132 oh->clkdm->pwrdm.ptr->prcm_offs,
3133 oh->prcm.omap4.rstctrl_offs);
3136 /* Public functions */
3138 u32 omap_hwmod_read(struct omap_hwmod *oh, u16 reg_offs)
3140 if (oh->flags & HWMOD_16BIT_REG)
3141 return __raw_readw(oh->_mpu_rt_va + reg_offs);
3143 return __raw_readl(oh->_mpu_rt_va + reg_offs);
3146 void omap_hwmod_write(u32 v, struct omap_hwmod *oh, u16 reg_offs)
3148 if (oh->flags & HWMOD_16BIT_REG)
3149 __raw_writew(v, oh->_mpu_rt_va + reg_offs);
3151 __raw_writel(v, oh->_mpu_rt_va + reg_offs);
3155 * omap_hwmod_softreset - reset a module via SYSCONFIG.SOFTRESET bit
3156 * @oh: struct omap_hwmod *
3158 * This is a public function exposed to drivers. Some drivers may need to do
3159 * some settings before and after resetting the device. Those drivers after
3160 * doing the necessary settings could use this function to start a reset by
3161 * setting the SYSCONFIG.SOFTRESET bit.
3163 int omap_hwmod_softreset(struct omap_hwmod *oh)
3168 if (!oh || !(oh->_sysc_cache))
3171 v = oh->_sysc_cache;
3172 ret = _set_softreset(oh, &v);
3175 _write_sysconfig(v, oh);
3182 * omap_hwmod_set_slave_idlemode - set the hwmod's OCP slave idlemode
3183 * @oh: struct omap_hwmod *
3184 * @idlemode: SIDLEMODE field bits (shifted to bit 0)
3186 * Sets the IP block's OCP slave idlemode in hardware, and updates our
3187 * local copy. Intended to be used by drivers that have some erratum
3188 * that requires direct manipulation of the SIDLEMODE bits. Returns
3189 * -EINVAL if @oh is null, or passes along the return value from
3190 * _set_slave_idlemode().
3192 * XXX Does this function have any current users? If not, we should
3193 * remove it; it is better to let the rest of the hwmod code handle this.
3194 * Any users of this function should be scrutinized carefully.
3196 int omap_hwmod_set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode)
3204 v = oh->_sysc_cache;
3206 retval = _set_slave_idlemode(oh, idlemode, &v);
3208 _write_sysconfig(v, oh);
3214 * omap_hwmod_lookup - look up a registered omap_hwmod by name
3215 * @name: name of the omap_hwmod to look up
3217 * Given a @name of an omap_hwmod, return a pointer to the registered
3218 * struct omap_hwmod *, or NULL upon error.
3220 struct omap_hwmod *omap_hwmod_lookup(const char *name)
3222 struct omap_hwmod *oh;
3233 * omap_hwmod_for_each - call function for each registered omap_hwmod
3234 * @fn: pointer to a callback function
3235 * @data: void * data to pass to callback function
3237 * Call @fn for each registered omap_hwmod, passing @data to each
3238 * function. @fn must return 0 for success or any other value for
3239 * failure. If @fn returns non-zero, the iteration across omap_hwmods
3240 * will stop and the non-zero return value will be passed to the
3241 * caller of omap_hwmod_for_each(). @fn is called with
3242 * omap_hwmod_for_each() held.
3244 int omap_hwmod_for_each(int (*fn)(struct omap_hwmod *oh, void *data),
3247 struct omap_hwmod *temp_oh;
3253 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
3254 ret = (*fn)(temp_oh, data);
3263 * omap_hwmod_register_links - register an array of hwmod links
3264 * @ois: pointer to an array of omap_hwmod_ocp_if to register
3266 * Intended to be called early in boot before the clock framework is
3267 * initialized. If @ois is not null, will register all omap_hwmods
3268 * listed in @ois that are valid for this chip. Returns -EINVAL if
3269 * omap_hwmod_init() hasn't been called before calling this function,
3270 * -ENOMEM if the link memory area can't be allocated, or 0 upon
3273 int __init omap_hwmod_register_links(struct omap_hwmod_ocp_if **ois)
3284 if (_alloc_linkspace(ois)) {
3285 pr_err("omap_hwmod: could not allocate link space\n");
3292 r = _register_link(ois[i]);
3293 WARN(r && r != -EEXIST,
3294 "omap_hwmod: _register_link(%s -> %s) returned %d\n",
3295 ois[i]->master->name, ois[i]->slave->name, r);
3302 * _ensure_mpu_hwmod_is_setup - ensure the MPU SS hwmod is init'ed and set up
3303 * @oh: pointer to the hwmod currently being set up (usually not the MPU)
3305 * If the hwmod data corresponding to the MPU subsystem IP block
3306 * hasn't been initialized and set up yet, do so now. This must be
3307 * done first since sleep dependencies may be added from other hwmods
3308 * to the MPU. Intended to be called only by omap_hwmod_setup*(). No
3311 static void __init _ensure_mpu_hwmod_is_setup(struct omap_hwmod *oh)
3313 if (!mpu_oh || mpu_oh->_state == _HWMOD_STATE_UNKNOWN)
3314 pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",
3315 __func__, MPU_INITIATOR_NAME);
3316 else if (mpu_oh->_state == _HWMOD_STATE_REGISTERED && oh != mpu_oh)
3317 omap_hwmod_setup_one(MPU_INITIATOR_NAME);
3321 * omap_hwmod_setup_one - set up a single hwmod
3322 * @oh_name: const char * name of the already-registered hwmod to set up
3324 * Initialize and set up a single hwmod. Intended to be used for a
3325 * small number of early devices, such as the timer IP blocks used for
3326 * the scheduler clock. Must be called after omap2_clk_init().
3327 * Resolves the struct clk names to struct clk pointers for each
3328 * registered omap_hwmod. Also calls _setup() on each hwmod. Returns
3329 * -EINVAL upon error or 0 upon success.
3331 int __init omap_hwmod_setup_one(const char *oh_name)
3333 struct omap_hwmod *oh;
3335 pr_debug("omap_hwmod: %s: %s\n", oh_name, __func__);
3337 oh = _lookup(oh_name);
3339 WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name);
3343 _ensure_mpu_hwmod_is_setup(oh);
3352 * omap_hwmod_setup_all - set up all registered IP blocks
3354 * Initialize and set up all IP blocks registered with the hwmod code.
3355 * Must be called after omap2_clk_init(). Resolves the struct clk
3356 * names to struct clk pointers for each registered omap_hwmod. Also
3357 * calls _setup() on each hwmod. Returns 0 upon success.
3359 static int __init omap_hwmod_setup_all(void)
3361 _ensure_mpu_hwmod_is_setup(NULL);
3363 omap_hwmod_for_each(_init, NULL);
3364 omap_hwmod_for_each(_setup, NULL);
3368 omap_core_initcall(omap_hwmod_setup_all);
3371 * omap_hwmod_enable - enable an omap_hwmod
3372 * @oh: struct omap_hwmod *
3374 * Enable an omap_hwmod @oh. Intended to be called by omap_device_enable().
3375 * Returns -EINVAL on error or passes along the return value from _enable().
3377 int omap_hwmod_enable(struct omap_hwmod *oh)
3380 unsigned long flags;
3385 spin_lock_irqsave(&oh->_lock, flags);
3387 spin_unlock_irqrestore(&oh->_lock, flags);
3393 * omap_hwmod_idle - idle an omap_hwmod
3394 * @oh: struct omap_hwmod *
3396 * Idle an omap_hwmod @oh. Intended to be called by omap_device_idle().
3397 * Returns -EINVAL on error or passes along the return value from _idle().
3399 int omap_hwmod_idle(struct omap_hwmod *oh)
3401 unsigned long flags;
3406 spin_lock_irqsave(&oh->_lock, flags);
3408 spin_unlock_irqrestore(&oh->_lock, flags);
3414 * omap_hwmod_shutdown - shutdown an omap_hwmod
3415 * @oh: struct omap_hwmod *
3417 * Shutdown an omap_hwmod @oh. Intended to be called by
3418 * omap_device_shutdown(). Returns -EINVAL on error or passes along
3419 * the return value from _shutdown().
3421 int omap_hwmod_shutdown(struct omap_hwmod *oh)
3423 unsigned long flags;
3428 spin_lock_irqsave(&oh->_lock, flags);
3430 spin_unlock_irqrestore(&oh->_lock, flags);
3436 * omap_hwmod_enable_clocks - enable main_clk, all interface clocks
3437 * @oh: struct omap_hwmod *oh
3439 * Intended to be called by the omap_device code.
3441 int omap_hwmod_enable_clocks(struct omap_hwmod *oh)
3443 unsigned long flags;
3445 spin_lock_irqsave(&oh->_lock, flags);
3447 spin_unlock_irqrestore(&oh->_lock, flags);
3453 * omap_hwmod_disable_clocks - disable main_clk, all interface clocks
3454 * @oh: struct omap_hwmod *oh
3456 * Intended to be called by the omap_device code.
3458 int omap_hwmod_disable_clocks(struct omap_hwmod *oh)
3460 unsigned long flags;
3462 spin_lock_irqsave(&oh->_lock, flags);
3463 _disable_clocks(oh);
3464 spin_unlock_irqrestore(&oh->_lock, flags);
3470 * omap_hwmod_ocp_barrier - wait for posted writes against the hwmod to complete
3471 * @oh: struct omap_hwmod *oh
3473 * Intended to be called by drivers and core code when all posted
3474 * writes to a device must complete before continuing further
3475 * execution (for example, after clearing some device IRQSTATUS
3478 * XXX what about targets with multiple OCP threads?
3480 void omap_hwmod_ocp_barrier(struct omap_hwmod *oh)
3484 if (!oh->class->sysc || !oh->class->sysc->sysc_flags) {
3485 WARN(1, "omap_device: %s: OCP barrier impossible due to device configuration\n",
3491 * Forces posted writes to complete on the OCP thread handling
3494 omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
3498 * omap_hwmod_reset - reset the hwmod
3499 * @oh: struct omap_hwmod *
3501 * Under some conditions, a driver may wish to reset the entire device.
3502 * Called from omap_device code. Returns -EINVAL on error or passes along
3503 * the return value from _reset().
3505 int omap_hwmod_reset(struct omap_hwmod *oh)
3508 unsigned long flags;
3513 spin_lock_irqsave(&oh->_lock, flags);
3515 spin_unlock_irqrestore(&oh->_lock, flags);
3521 * IP block data retrieval functions
3525 * omap_hwmod_count_resources - count number of struct resources needed by hwmod
3526 * @oh: struct omap_hwmod *
3527 * @flags: Type of resources to include when counting (IRQ/DMA/MEM)
3529 * Count the number of struct resource array elements necessary to
3530 * contain omap_hwmod @oh resources. Intended to be called by code
3531 * that registers omap_devices. Intended to be used to determine the
3532 * size of a dynamically-allocated struct resource array, before
3533 * calling omap_hwmod_fill_resources(). Returns the number of struct
3534 * resource array elements needed.
3536 * XXX This code is not optimized. It could attempt to merge adjacent
3540 int omap_hwmod_count_resources(struct omap_hwmod *oh, unsigned long flags)
3544 if (flags & IORESOURCE_IRQ)
3545 ret += _count_mpu_irqs(oh);
3547 if (flags & IORESOURCE_DMA)
3548 ret += _count_sdma_reqs(oh);
3550 if (flags & IORESOURCE_MEM) {
3552 struct omap_hwmod_ocp_if *os;
3553 struct list_head *p = oh->slave_ports.next;
3555 while (i < oh->slaves_cnt) {
3556 os = _fetch_next_ocp_if(&p, &i);
3557 ret += _count_ocp_if_addr_spaces(os);
3565 * omap_hwmod_fill_resources - fill struct resource array with hwmod data
3566 * @oh: struct omap_hwmod *
3567 * @res: pointer to the first element of an array of struct resource to fill
3569 * Fill the struct resource array @res with resource data from the
3570 * omap_hwmod @oh. Intended to be called by code that registers
3571 * omap_devices. See also omap_hwmod_count_resources(). Returns the
3572 * number of array elements filled.
3574 int omap_hwmod_fill_resources(struct omap_hwmod *oh, struct resource *res)
3576 struct omap_hwmod_ocp_if *os;
3577 struct list_head *p;
3578 int i, j, mpu_irqs_cnt, sdma_reqs_cnt, addr_cnt;
3581 /* For each IRQ, DMA, memory area, fill in array.*/
3583 mpu_irqs_cnt = _count_mpu_irqs(oh);
3584 for (i = 0; i < mpu_irqs_cnt; i++) {
3585 (res + r)->name = (oh->mpu_irqs + i)->name;
3586 (res + r)->start = (oh->mpu_irqs + i)->irq;
3587 (res + r)->end = (oh->mpu_irqs + i)->irq;
3588 (res + r)->flags = IORESOURCE_IRQ;
3592 sdma_reqs_cnt = _count_sdma_reqs(oh);
3593 for (i = 0; i < sdma_reqs_cnt; i++) {
3594 (res + r)->name = (oh->sdma_reqs + i)->name;
3595 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
3596 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
3597 (res + r)->flags = IORESOURCE_DMA;
3601 p = oh->slave_ports.next;
3604 while (i < oh->slaves_cnt) {
3605 os = _fetch_next_ocp_if(&p, &i);
3606 addr_cnt = _count_ocp_if_addr_spaces(os);
3608 for (j = 0; j < addr_cnt; j++) {
3609 (res + r)->name = (os->addr + j)->name;
3610 (res + r)->start = (os->addr + j)->pa_start;
3611 (res + r)->end = (os->addr + j)->pa_end;
3612 (res + r)->flags = IORESOURCE_MEM;
3621 * omap_hwmod_fill_dma_resources - fill struct resource array with dma data
3622 * @oh: struct omap_hwmod *
3623 * @res: pointer to the array of struct resource to fill
3625 * Fill the struct resource array @res with dma resource data from the
3626 * omap_hwmod @oh. Intended to be called by code that registers
3627 * omap_devices. See also omap_hwmod_count_resources(). Returns the
3628 * number of array elements filled.
3630 int omap_hwmod_fill_dma_resources(struct omap_hwmod *oh, struct resource *res)
3632 int i, sdma_reqs_cnt;
3635 sdma_reqs_cnt = _count_sdma_reqs(oh);
3636 for (i = 0; i < sdma_reqs_cnt; i++) {
3637 (res + r)->name = (oh->sdma_reqs + i)->name;
3638 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
3639 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
3640 (res + r)->flags = IORESOURCE_DMA;
3648 * omap_hwmod_get_resource_byname - fetch IP block integration data by name
3649 * @oh: struct omap_hwmod * to operate on
3650 * @type: one of the IORESOURCE_* constants from include/linux/ioport.h
3651 * @name: pointer to the name of the data to fetch (optional)
3652 * @rsrc: pointer to a struct resource, allocated by the caller
3654 * Retrieve MPU IRQ, SDMA request line, or address space start/end
3655 * data for the IP block pointed to by @oh. The data will be filled
3656 * into a struct resource record pointed to by @rsrc. The struct
3657 * resource must be allocated by the caller. When @name is non-null,
3658 * the data associated with the matching entry in the IRQ/SDMA/address
3659 * space hwmod data arrays will be returned. If @name is null, the
3660 * first array entry will be returned. Data order is not meaningful
3661 * in hwmod data, so callers are strongly encouraged to use a non-null
3662 * @name whenever possible to avoid unpredictable effects if hwmod
3663 * data is later added that causes data ordering to change. This
3664 * function is only intended for use by OMAP core code. Device
3665 * drivers should not call this function - the appropriate bus-related
3666 * data accessor functions should be used instead. Returns 0 upon
3667 * success or a negative error code upon error.
3669 int omap_hwmod_get_resource_byname(struct omap_hwmod *oh, unsigned int type,
3670 const char *name, struct resource *rsrc)
3673 unsigned int irq, dma;
3674 u32 pa_start, pa_end;
3679 if (type == IORESOURCE_IRQ) {
3680 r = _get_mpu_irq_by_name(oh, name, &irq);
3686 } else if (type == IORESOURCE_DMA) {
3687 r = _get_sdma_req_by_name(oh, name, &dma);
3693 } else if (type == IORESOURCE_MEM) {
3694 r = _get_addr_space_by_name(oh, name, &pa_start, &pa_end);
3698 rsrc->start = pa_start;
3711 * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
3712 * @oh: struct omap_hwmod *
3714 * Return the powerdomain pointer associated with the OMAP module
3715 * @oh's main clock. If @oh does not have a main clk, return the
3716 * powerdomain associated with the interface clock associated with the
3717 * module's MPU port. (XXX Perhaps this should use the SDMA port
3718 * instead?) Returns NULL on error, or a struct powerdomain * on
3721 struct powerdomain *omap_hwmod_get_pwrdm(struct omap_hwmod *oh)
3724 struct omap_hwmod_ocp_if *oi;
3725 struct clockdomain *clkdm;
3726 struct clk_hw_omap *clk;
3732 return oh->clkdm->pwrdm.ptr;
3737 oi = _find_mpu_rt_port(oh);
3743 clk = to_clk_hw_omap(__clk_get_hw(c));
3748 return clkdm->pwrdm.ptr;
3752 * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
3753 * @oh: struct omap_hwmod *
3755 * Returns the virtual address corresponding to the beginning of the
3756 * module's register target, in the address range that is intended to
3757 * be used by the MPU. Returns the virtual address upon success or NULL
3760 void __iomem *omap_hwmod_get_mpu_rt_va(struct omap_hwmod *oh)
3765 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
3768 if (oh->_state == _HWMOD_STATE_UNKNOWN)
3771 return oh->_mpu_rt_va;
3775 * omap_hwmod_add_initiator_dep - add sleepdep from @init_oh to @oh
3776 * @oh: struct omap_hwmod *
3777 * @init_oh: struct omap_hwmod * (initiator)
3779 * Add a sleep dependency between the initiator @init_oh and @oh.
3780 * Intended to be called by DSP/Bridge code via platform_data for the
3781 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
3782 * code needs to add/del initiator dependencies dynamically
3783 * before/after accessing a device. Returns the return value from
3784 * _add_initiator_dep().
3786 * XXX Keep a usecount in the clockdomain code
3788 int omap_hwmod_add_initiator_dep(struct omap_hwmod *oh,
3789 struct omap_hwmod *init_oh)
3791 return _add_initiator_dep(oh, init_oh);
3795 * XXX what about functions for drivers to save/restore ocp_sysconfig
3796 * for context save/restore operations?
3800 * omap_hwmod_del_initiator_dep - remove sleepdep from @init_oh to @oh
3801 * @oh: struct omap_hwmod *
3802 * @init_oh: struct omap_hwmod * (initiator)
3804 * Remove a sleep dependency between the initiator @init_oh and @oh.
3805 * Intended to be called by DSP/Bridge code via platform_data for the
3806 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
3807 * code needs to add/del initiator dependencies dynamically
3808 * before/after accessing a device. Returns the return value from
3809 * _del_initiator_dep().
3811 * XXX Keep a usecount in the clockdomain code
3813 int omap_hwmod_del_initiator_dep(struct omap_hwmod *oh,
3814 struct omap_hwmod *init_oh)
3816 return _del_initiator_dep(oh, init_oh);
3820 * omap_hwmod_enable_wakeup - allow device to wake up the system
3821 * @oh: struct omap_hwmod *
3823 * Sets the module OCP socket ENAWAKEUP bit to allow the module to
3824 * send wakeups to the PRCM, and enable I/O ring wakeup events for
3825 * this IP block if it has dynamic mux entries. Eventually this
3826 * should set PRCM wakeup registers to cause the PRCM to receive
3827 * wakeup events from the module. Does not set any wakeup routing
3828 * registers beyond this point - if the module is to wake up any other
3829 * module or subsystem, that must be set separately. Called by
3830 * omap_device code. Returns -EINVAL on error or 0 upon success.
3832 int omap_hwmod_enable_wakeup(struct omap_hwmod *oh)
3834 unsigned long flags;
3837 spin_lock_irqsave(&oh->_lock, flags);
3839 if (oh->class->sysc &&
3840 (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)) {
3841 v = oh->_sysc_cache;
3842 _enable_wakeup(oh, &v);
3843 _write_sysconfig(v, oh);
3846 _set_idle_ioring_wakeup(oh, true);
3847 spin_unlock_irqrestore(&oh->_lock, flags);
3853 * omap_hwmod_disable_wakeup - prevent device from waking the system
3854 * @oh: struct omap_hwmod *
3856 * Clears the module OCP socket ENAWAKEUP bit to prevent the module
3857 * from sending wakeups to the PRCM, and disable I/O ring wakeup
3858 * events for this IP block if it has dynamic mux entries. Eventually
3859 * this should clear PRCM wakeup registers to cause the PRCM to ignore
3860 * wakeup events from the module. Does not set any wakeup routing
3861 * registers beyond this point - if the module is to wake up any other
3862 * module or subsystem, that must be set separately. Called by
3863 * omap_device code. Returns -EINVAL on error or 0 upon success.
3865 int omap_hwmod_disable_wakeup(struct omap_hwmod *oh)
3867 unsigned long flags;
3870 spin_lock_irqsave(&oh->_lock, flags);
3872 if (oh->class->sysc &&
3873 (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)) {
3874 v = oh->_sysc_cache;
3875 _disable_wakeup(oh, &v);
3876 _write_sysconfig(v, oh);
3879 _set_idle_ioring_wakeup(oh, false);
3880 spin_unlock_irqrestore(&oh->_lock, flags);
3886 * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
3887 * contained in the hwmod module.
3888 * @oh: struct omap_hwmod *
3889 * @name: name of the reset line to lookup and assert
3891 * Some IP like dsp, ipu or iva contain processor that require
3892 * an HW reset line to be assert / deassert in order to enable fully
3893 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3894 * yet supported on this OMAP; otherwise, passes along the return value
3895 * from _assert_hardreset().
3897 int omap_hwmod_assert_hardreset(struct omap_hwmod *oh, const char *name)
3900 unsigned long flags;
3905 spin_lock_irqsave(&oh->_lock, flags);
3906 ret = _assert_hardreset(oh, name);
3907 spin_unlock_irqrestore(&oh->_lock, flags);
3913 * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
3914 * contained in the hwmod module.
3915 * @oh: struct omap_hwmod *
3916 * @name: name of the reset line to look up and deassert
3918 * Some IP like dsp, ipu or iva contain processor that require
3919 * an HW reset line to be assert / deassert in order to enable fully
3920 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3921 * yet supported on this OMAP; otherwise, passes along the return value
3922 * from _deassert_hardreset().
3924 int omap_hwmod_deassert_hardreset(struct omap_hwmod *oh, const char *name)
3927 unsigned long flags;
3932 spin_lock_irqsave(&oh->_lock, flags);
3933 ret = _deassert_hardreset(oh, name);
3934 spin_unlock_irqrestore(&oh->_lock, flags);
3940 * omap_hwmod_read_hardreset - read the HW reset line state of submodules
3941 * contained in the hwmod module
3942 * @oh: struct omap_hwmod *
3943 * @name: name of the reset line to look up and read
3945 * Return the current state of the hwmod @oh's reset line named @name:
3946 * returns -EINVAL upon parameter error or if this operation
3947 * is unsupported on the current OMAP; otherwise, passes along the return
3948 * value from _read_hardreset().
3950 int omap_hwmod_read_hardreset(struct omap_hwmod *oh, const char *name)
3953 unsigned long flags;
3958 spin_lock_irqsave(&oh->_lock, flags);
3959 ret = _read_hardreset(oh, name);
3960 spin_unlock_irqrestore(&oh->_lock, flags);
3967 * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
3968 * @classname: struct omap_hwmod_class name to search for
3969 * @fn: callback function pointer to call for each hwmod in class @classname
3970 * @user: arbitrary context data to pass to the callback function
3972 * For each omap_hwmod of class @classname, call @fn.
3973 * If the callback function returns something other than
3974 * zero, the iterator is terminated, and the callback function's return
3975 * value is passed back to the caller. Returns 0 upon success, -EINVAL
3976 * if @classname or @fn are NULL, or passes back the error code from @fn.
3978 int omap_hwmod_for_each_by_class(const char *classname,
3979 int (*fn)(struct omap_hwmod *oh,
3983 struct omap_hwmod *temp_oh;
3986 if (!classname || !fn)
3989 pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
3990 __func__, classname);
3992 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
3993 if (!strcmp(temp_oh->class->name, classname)) {
3994 pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
3995 __func__, temp_oh->name);
3996 ret = (*fn)(temp_oh, user);
4003 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
4010 * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
4011 * @oh: struct omap_hwmod *
4012 * @state: state that _setup() should leave the hwmod in
4014 * Sets the hwmod state that @oh will enter at the end of _setup()
4015 * (called by omap_hwmod_setup_*()). See also the documentation
4016 * for _setup_postsetup(), above. Returns 0 upon success or
4017 * -EINVAL if there is a problem with the arguments or if the hwmod is
4018 * in the wrong state.
4020 int omap_hwmod_set_postsetup_state(struct omap_hwmod *oh, u8 state)
4023 unsigned long flags;
4028 if (state != _HWMOD_STATE_DISABLED &&
4029 state != _HWMOD_STATE_ENABLED &&
4030 state != _HWMOD_STATE_IDLE)
4033 spin_lock_irqsave(&oh->_lock, flags);
4035 if (oh->_state != _HWMOD_STATE_REGISTERED) {
4040 oh->_postsetup_state = state;
4044 spin_unlock_irqrestore(&oh->_lock, flags);
4050 * omap_hwmod_get_context_loss_count - get lost context count
4051 * @oh: struct omap_hwmod *
4053 * Returns the context loss count of associated @oh
4054 * upon success, or zero if no context loss data is available.
4056 * On OMAP4, this queries the per-hwmod context loss register,
4057 * assuming one exists. If not, or on OMAP2/3, this queries the
4058 * enclosing powerdomain context loss count.
4060 int omap_hwmod_get_context_loss_count(struct omap_hwmod *oh)
4062 struct powerdomain *pwrdm;
4065 if (soc_ops.get_context_lost)
4066 return soc_ops.get_context_lost(oh);
4068 pwrdm = omap_hwmod_get_pwrdm(oh);
4070 ret = pwrdm_get_context_loss_count(pwrdm);
4076 * omap_hwmod_no_setup_reset - prevent a hwmod from being reset upon setup
4077 * @oh: struct omap_hwmod *
4079 * Prevent the hwmod @oh from being reset during the setup process.
4080 * Intended for use by board-*.c files on boards with devices that
4081 * cannot tolerate being reset. Must be called before the hwmod has
4082 * been set up. Returns 0 upon success or negative error code upon
4085 int omap_hwmod_no_setup_reset(struct omap_hwmod *oh)
4090 if (oh->_state != _HWMOD_STATE_REGISTERED) {
4091 pr_err("omap_hwmod: %s: cannot prevent setup reset; in wrong state\n",
4096 oh->flags |= HWMOD_INIT_NO_RESET;
4102 * omap_hwmod_pad_route_irq - route an I/O pad wakeup to a particular MPU IRQ
4103 * @oh: struct omap_hwmod * containing hwmod mux entries
4104 * @pad_idx: array index in oh->mux of the hwmod mux entry to route wakeup
4105 * @irq_idx: the hwmod mpu_irqs array index of the IRQ to trigger on wakeup
4107 * When an I/O pad wakeup arrives for the dynamic or wakeup hwmod mux
4108 * entry number @pad_idx for the hwmod @oh, trigger the interrupt
4109 * service routine for the hwmod's mpu_irqs array index @irq_idx. If
4110 * this function is not called for a given pad_idx, then the ISR
4111 * associated with @oh's first MPU IRQ will be triggered when an I/O
4112 * pad wakeup occurs on that pad. Note that @pad_idx is the index of
4113 * the _dynamic or wakeup_ entry: if there are other entries not
4114 * marked with OMAP_DEVICE_PAD_WAKEUP or OMAP_DEVICE_PAD_REMUX, these
4115 * entries are NOT COUNTED in the dynamic pad index. This function
4116 * must be called separately for each pad that requires its interrupt
4117 * to be re-routed this way. Returns -EINVAL if there is an argument
4118 * problem or if @oh does not have hwmod mux entries or MPU IRQs;
4119 * returns -ENOMEM if memory cannot be allocated; or 0 upon success.
4121 * XXX This function interface is fragile. Rather than using array
4122 * indexes, which are subject to unpredictable change, it should be
4123 * using hwmod IRQ names, and some other stable key for the hwmod mux
4126 int omap_hwmod_pad_route_irq(struct omap_hwmod *oh, int pad_idx, int irq_idx)
4132 if (!oh || !oh->mux || !oh->mpu_irqs || pad_idx < 0 ||
4133 pad_idx >= oh->mux->nr_pads_dynamic)
4136 /* Check the number of available mpu_irqs */
4137 for (nr_irqs = 0; oh->mpu_irqs[nr_irqs].irq >= 0; nr_irqs++)
4140 if (irq_idx >= nr_irqs)
4143 if (!oh->mux->irqs) {
4144 /* XXX What frees this? */
4145 oh->mux->irqs = kzalloc(sizeof(int) * oh->mux->nr_pads_dynamic,
4150 oh->mux->irqs[pad_idx] = irq_idx;
4156 * omap_hwmod_init - initialize the hwmod code
4158 * Sets up some function pointers needed by the hwmod code to operate on the
4159 * currently-booted SoC. Intended to be called once during kernel init
4160 * before any hwmods are registered. No return value.
4162 void __init omap_hwmod_init(void)
4164 if (cpu_is_omap24xx()) {
4165 soc_ops.wait_target_ready = _omap2xxx_wait_target_ready;
4166 soc_ops.assert_hardreset = _omap2_assert_hardreset;
4167 soc_ops.deassert_hardreset = _omap2_deassert_hardreset;
4168 soc_ops.is_hardreset_asserted = _omap2_is_hardreset_asserted;
4169 } else if (cpu_is_omap34xx()) {
4170 soc_ops.wait_target_ready = _omap3xxx_wait_target_ready;
4171 soc_ops.assert_hardreset = _omap2_assert_hardreset;
4172 soc_ops.deassert_hardreset = _omap2_deassert_hardreset;
4173 soc_ops.is_hardreset_asserted = _omap2_is_hardreset_asserted;
4174 } else if (cpu_is_omap44xx() || soc_is_omap54xx()) {
4175 soc_ops.enable_module = _omap4_enable_module;
4176 soc_ops.disable_module = _omap4_disable_module;
4177 soc_ops.wait_target_ready = _omap4_wait_target_ready;
4178 soc_ops.assert_hardreset = _omap4_assert_hardreset;
4179 soc_ops.deassert_hardreset = _omap4_deassert_hardreset;
4180 soc_ops.is_hardreset_asserted = _omap4_is_hardreset_asserted;
4181 soc_ops.init_clkdm = _init_clkdm;
4182 soc_ops.update_context_lost = _omap4_update_context_lost;
4183 soc_ops.get_context_lost = _omap4_get_context_lost;
4184 } else if (soc_is_am33xx()) {
4185 soc_ops.enable_module = _am33xx_enable_module;
4186 soc_ops.disable_module = _am33xx_disable_module;
4187 soc_ops.wait_target_ready = _am33xx_wait_target_ready;
4188 soc_ops.assert_hardreset = _am33xx_assert_hardreset;
4189 soc_ops.deassert_hardreset = _am33xx_deassert_hardreset;
4190 soc_ops.is_hardreset_asserted = _am33xx_is_hardreset_asserted;
4191 soc_ops.init_clkdm = _init_clkdm;
4193 WARN(1, "omap_hwmod: unknown SoC type\n");
4200 * omap_hwmod_get_main_clk - get pointer to main clock name
4201 * @oh: struct omap_hwmod *
4203 * Returns the main clock name assocated with @oh upon success,
4204 * or NULL if @oh is NULL.
4206 const char *omap_hwmod_get_main_clk(struct omap_hwmod *oh)
4211 return oh->main_clk;