2 * omap_hwmod implementation for OMAP2/3/4
4 * Copyright (C) 2009-2011 Nokia Corporation
5 * Copyright (C) 2011-2012 Texas Instruments, Inc.
7 * Paul Walmsley, BenoƮt Cousson, Kevin Hilman
9 * Created in collaboration with (alphabetical order): Thara Gopinath,
10 * Tony Lindgren, Rajendra Nayak, Vikram Pandita, Sakari Poussa, Anand
11 * Sawant, Santosh Shilimkar, Richard Woodruff
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License version 2 as
15 * published by the Free Software Foundation.
19 * One way to view an OMAP SoC is as a collection of largely unrelated
20 * IP blocks connected by interconnects. The IP blocks include
21 * devices such as ARM processors, audio serial interfaces, UARTs,
22 * etc. Some of these devices, like the DSP, are created by TI;
23 * others, like the SGX, largely originate from external vendors. In
24 * TI's documentation, on-chip devices are referred to as "OMAP
25 * modules." Some of these IP blocks are identical across several
26 * OMAP versions. Others are revised frequently.
28 * These OMAP modules are tied together by various interconnects.
29 * Most of the address and data flow between modules is via OCP-based
30 * interconnects such as the L3 and L4 buses; but there are other
31 * interconnects that distribute the hardware clock tree, handle idle
32 * and reset signaling, supply power, and connect the modules to
33 * various pads or balls on the OMAP package.
35 * OMAP hwmod provides a consistent way to describe the on-chip
36 * hardware blocks and their integration into the rest of the chip.
37 * This description can be automatically generated from the TI
38 * hardware database. OMAP hwmod provides a standard, consistent API
39 * to reset, enable, idle, and disable these hardware blocks. And
40 * hwmod provides a way for other core code, such as the Linux device
41 * code or the OMAP power management and address space mapping code,
42 * to query the hardware database.
46 * Drivers won't call hwmod functions directly. That is done by the
47 * omap_device code, and in rare occasions, by custom integration code
48 * in arch/arm/ *omap*. The omap_device code includes functions to
49 * build a struct platform_device using omap_hwmod data, and that is
50 * currently how hwmod data is communicated to drivers and to the
51 * Linux driver model. Most drivers will call omap_hwmod functions only
52 * indirectly, via pm_runtime*() functions.
54 * From a layering perspective, here is where the OMAP hwmod code
55 * fits into the kernel software stack:
57 * +-------------------------------+
58 * | Device driver code |
59 * | (e.g., drivers/) |
60 * +-------------------------------+
61 * | Linux driver model |
62 * | (platform_device / |
63 * | platform_driver data/code) |
64 * +-------------------------------+
65 * | OMAP core-driver integration |
66 * |(arch/arm/mach-omap2/devices.c)|
67 * +-------------------------------+
68 * | omap_device code |
69 * | (../plat-omap/omap_device.c) |
70 * +-------------------------------+
71 * ----> | omap_hwmod code/data | <-----
72 * | (../mach-omap2/omap_hwmod*) |
73 * +-------------------------------+
74 * | OMAP clock/PRCM/register fns |
75 * | (__raw_{read,write}l, clk*) |
76 * +-------------------------------+
78 * Device drivers should not contain any OMAP-specific code or data in
79 * them. They should only contain code to operate the IP block that
80 * the driver is responsible for. This is because these IP blocks can
81 * also appear in other SoCs, either from TI (such as DaVinci) or from
82 * other manufacturers; and drivers should be reusable across other
85 * The OMAP hwmod code also will attempt to reset and idle all on-chip
86 * devices upon boot. The goal here is for the kernel to be
87 * completely self-reliant and independent from bootloaders. This is
88 * to ensure a repeatable configuration, both to ensure consistent
89 * runtime behavior, and to make it easier for others to reproduce
92 * OMAP module activity states
93 * ---------------------------
94 * The hwmod code considers modules to be in one of several activity
95 * states. IP blocks start out in an UNKNOWN state, then once they
96 * are registered via the hwmod code, proceed to the REGISTERED state.
97 * Once their clock names are resolved to clock pointers, the module
98 * enters the CLKS_INITED state; and finally, once the module has been
99 * reset and the integration registers programmed, the INITIALIZED state
100 * is entered. The hwmod code will then place the module into either
101 * the IDLE state to save power, or in the case of a critical system
102 * module, the ENABLED state.
104 * OMAP core integration code can then call omap_hwmod*() functions
105 * directly to move the module between the IDLE, ENABLED, and DISABLED
106 * states, as needed. This is done during both the PM idle loop, and
107 * in the OMAP core integration code's implementation of the PM runtime
112 * This is a partial list.
113 * - OMAP2420 Multimedia Processor Silicon Revision 2.1.1, 2.2 (SWPU064)
114 * - OMAP2430 Multimedia Device POP Silicon Revision 2.1 (SWPU090)
115 * - OMAP34xx Multimedia Device Silicon Revision 3.1 (SWPU108)
116 * - OMAP4430 Multimedia Device Silicon Revision 1.0 (SWPU140)
117 * - Open Core Protocol Specification 2.2
120 * - handle IO mapping
121 * - bus throughput & module latency measurement code
123 * XXX add tests at the beginning of each function to ensure the hwmod is
124 * in the appropriate state
125 * XXX error return values should be checked to ensure that they are
130 #include <linux/kernel.h>
131 #include <linux/errno.h>
132 #include <linux/io.h>
133 #include <linux/clk.h>
134 #include <linux/delay.h>
135 #include <linux/err.h>
136 #include <linux/list.h>
137 #include <linux/mutex.h>
138 #include <linux/spinlock.h>
139 #include <linux/slab.h>
140 #include <linux/bootmem.h>
143 #include <plat/cpu.h>
144 #include "clockdomain.h"
145 #include "powerdomain.h"
146 #include <plat/clock.h>
147 #include <plat/omap_hwmod.h>
148 #include <plat/prcm.h>
150 #include "cm2xxx_3xxx.h"
151 #include "cminst44xx.h"
152 #include "prm2xxx_3xxx.h"
154 #include "prminst44xx.h"
157 /* Maximum microseconds to wait for OMAP module to softreset */
158 #define MAX_MODULE_SOFTRESET_WAIT 10000
160 /* Name of the OMAP hwmod for the MPU */
161 #define MPU_INITIATOR_NAME "mpu"
164 * Number of struct omap_hwmod_link records per struct
165 * omap_hwmod_ocp_if record (master->slave and slave->master)
167 #define LINKS_PER_OCP_IF 2
169 /* omap_hwmod_list contains all registered struct omap_hwmods */
170 static LIST_HEAD(omap_hwmod_list);
172 /* mpu_oh: used to add/remove MPU initiator from sleepdep list */
173 static struct omap_hwmod *mpu_oh;
176 * linkspace: ptr to a buffer that struct omap_hwmod_link records are
177 * allocated from - used to reduce the number of small memory
178 * allocations, which has a significant impact on performance
180 static struct omap_hwmod_link *linkspace;
183 * free_ls, max_ls: array indexes into linkspace; representing the
184 * next free struct omap_hwmod_link index, and the maximum number of
185 * struct omap_hwmod_link records allocated (respectively)
187 static unsigned short free_ls, max_ls, ls_supp;
189 /* Private functions */
192 * _fetch_next_ocp_if - return the next OCP interface in a list
193 * @p: ptr to a ptr to the list_head inside the ocp_if to return
194 * @i: pointer to the index of the element pointed to by @p in the list
196 * Return a pointer to the struct omap_hwmod_ocp_if record
197 * containing the struct list_head pointed to by @p, and increment
198 * @p such that a future call to this routine will return the next
201 static struct omap_hwmod_ocp_if *_fetch_next_ocp_if(struct list_head **p,
204 struct omap_hwmod_ocp_if *oi;
206 oi = list_entry(*p, struct omap_hwmod_link, node)->ocp_if;
215 * _update_sysc_cache - return the module OCP_SYSCONFIG register, keep copy
216 * @oh: struct omap_hwmod *
218 * Load the current value of the hwmod OCP_SYSCONFIG register into the
219 * struct omap_hwmod for later use. Returns -EINVAL if the hwmod has no
220 * OCP_SYSCONFIG register or 0 upon success.
222 static int _update_sysc_cache(struct omap_hwmod *oh)
224 if (!oh->class->sysc) {
225 WARN(1, "omap_hwmod: %s: cannot read OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
229 /* XXX ensure module interface clock is up */
231 oh->_sysc_cache = omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
233 if (!(oh->class->sysc->sysc_flags & SYSC_NO_CACHE))
234 oh->_int_flags |= _HWMOD_SYSCONFIG_LOADED;
240 * _write_sysconfig - write a value to the module's OCP_SYSCONFIG register
241 * @v: OCP_SYSCONFIG value to write
242 * @oh: struct omap_hwmod *
244 * Write @v into the module class' OCP_SYSCONFIG register, if it has
245 * one. No return value.
247 static void _write_sysconfig(u32 v, struct omap_hwmod *oh)
249 if (!oh->class->sysc) {
250 WARN(1, "omap_hwmod: %s: cannot write OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
254 /* XXX ensure module interface clock is up */
256 /* Module might have lost context, always update cache and register */
258 omap_hwmod_write(v, oh, oh->class->sysc->sysc_offs);
262 * _set_master_standbymode: set the OCP_SYSCONFIG MIDLEMODE field in @v
263 * @oh: struct omap_hwmod *
264 * @standbymode: MIDLEMODE field bits
265 * @v: pointer to register contents to modify
267 * Update the master standby mode bits in @v to be @standbymode for
268 * the @oh hwmod. Does not write to the hardware. Returns -EINVAL
269 * upon error or 0 upon success.
271 static int _set_master_standbymode(struct omap_hwmod *oh, u8 standbymode,
277 if (!oh->class->sysc ||
278 !(oh->class->sysc->sysc_flags & SYSC_HAS_MIDLEMODE))
281 if (!oh->class->sysc->sysc_fields) {
282 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
286 mstandby_shift = oh->class->sysc->sysc_fields->midle_shift;
287 mstandby_mask = (0x3 << mstandby_shift);
289 *v &= ~mstandby_mask;
290 *v |= __ffs(standbymode) << mstandby_shift;
296 * _set_slave_idlemode: set the OCP_SYSCONFIG SIDLEMODE field in @v
297 * @oh: struct omap_hwmod *
298 * @idlemode: SIDLEMODE field bits
299 * @v: pointer to register contents to modify
301 * Update the slave idle mode bits in @v to be @idlemode for the @oh
302 * hwmod. Does not write to the hardware. Returns -EINVAL upon error
305 static int _set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode, u32 *v)
310 if (!oh->class->sysc ||
311 !(oh->class->sysc->sysc_flags & SYSC_HAS_SIDLEMODE))
314 if (!oh->class->sysc->sysc_fields) {
315 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
319 sidle_shift = oh->class->sysc->sysc_fields->sidle_shift;
320 sidle_mask = (0x3 << sidle_shift);
323 *v |= __ffs(idlemode) << sidle_shift;
329 * _set_clockactivity: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
330 * @oh: struct omap_hwmod *
331 * @clockact: CLOCKACTIVITY field bits
332 * @v: pointer to register contents to modify
334 * Update the clockactivity mode bits in @v to be @clockact for the
335 * @oh hwmod. Used for additional powersaving on some modules. Does
336 * not write to the hardware. Returns -EINVAL upon error or 0 upon
339 static int _set_clockactivity(struct omap_hwmod *oh, u8 clockact, u32 *v)
344 if (!oh->class->sysc ||
345 !(oh->class->sysc->sysc_flags & SYSC_HAS_CLOCKACTIVITY))
348 if (!oh->class->sysc->sysc_fields) {
349 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
353 clkact_shift = oh->class->sysc->sysc_fields->clkact_shift;
354 clkact_mask = (0x3 << clkact_shift);
357 *v |= clockact << clkact_shift;
363 * _set_softreset: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
364 * @oh: struct omap_hwmod *
365 * @v: pointer to register contents to modify
367 * Set the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
368 * error or 0 upon success.
370 static int _set_softreset(struct omap_hwmod *oh, u32 *v)
374 if (!oh->class->sysc ||
375 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
378 if (!oh->class->sysc->sysc_fields) {
379 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
383 softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
391 * _set_module_autoidle: set the OCP_SYSCONFIG AUTOIDLE field in @v
392 * @oh: struct omap_hwmod *
393 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
394 * @v: pointer to register contents to modify
396 * Update the module autoidle bit in @v to be @autoidle for the @oh
397 * hwmod. The autoidle bit controls whether the module can gate
398 * internal clocks automatically when it isn't doing anything; the
399 * exact function of this bit varies on a per-module basis. This
400 * function does not write to the hardware. Returns -EINVAL upon
401 * error or 0 upon success.
403 static int _set_module_autoidle(struct omap_hwmod *oh, u8 autoidle,
409 if (!oh->class->sysc ||
410 !(oh->class->sysc->sysc_flags & SYSC_HAS_AUTOIDLE))
413 if (!oh->class->sysc->sysc_fields) {
414 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
418 autoidle_shift = oh->class->sysc->sysc_fields->autoidle_shift;
419 autoidle_mask = (0x1 << autoidle_shift);
421 *v &= ~autoidle_mask;
422 *v |= autoidle << autoidle_shift;
428 * _set_idle_ioring_wakeup - enable/disable IO pad wakeup on hwmod idle for mux
429 * @oh: struct omap_hwmod *
430 * @set_wake: bool value indicating to set (true) or clear (false) wakeup enable
432 * Set or clear the I/O pad wakeup flag in the mux entries for the
433 * hwmod @oh. This function changes the @oh->mux->pads_dynamic array
434 * in memory. If the hwmod is currently idled, and the new idle
435 * values don't match the previous ones, this function will also
436 * update the SCM PADCTRL registers. Otherwise, if the hwmod is not
437 * currently idled, this function won't touch the hardware: the new
438 * mux settings are written to the SCM PADCTRL registers when the
439 * hwmod is idled. No return value.
441 static void _set_idle_ioring_wakeup(struct omap_hwmod *oh, bool set_wake)
443 struct omap_device_pad *pad;
448 if (!oh->mux || !oh->mux->enabled)
451 for (j = 0; j < oh->mux->nr_pads_dynamic; j++) {
452 pad = oh->mux->pads_dynamic[j];
454 if (!(pad->flags & OMAP_DEVICE_PAD_WAKEUP))
457 prev_idle = pad->idle;
460 pad->idle |= OMAP_WAKEUP_EN;
462 pad->idle &= ~OMAP_WAKEUP_EN;
464 if (prev_idle != pad->idle)
468 if (change && oh->_state == _HWMOD_STATE_IDLE)
469 omap_hwmod_mux(oh->mux, _HWMOD_STATE_IDLE);
473 * _enable_wakeup: set OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
474 * @oh: struct omap_hwmod *
476 * Allow the hardware module @oh to send wakeups. Returns -EINVAL
477 * upon error or 0 upon success.
479 static int _enable_wakeup(struct omap_hwmod *oh, u32 *v)
481 if (!oh->class->sysc ||
482 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
483 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
484 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
487 if (!oh->class->sysc->sysc_fields) {
488 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
492 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
493 *v |= 0x1 << oh->class->sysc->sysc_fields->enwkup_shift;
495 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
496 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
497 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
498 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
500 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
502 oh->_int_flags |= _HWMOD_WAKEUP_ENABLED;
508 * _disable_wakeup: clear OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
509 * @oh: struct omap_hwmod *
511 * Prevent the hardware module @oh to send wakeups. Returns -EINVAL
512 * upon error or 0 upon success.
514 static int _disable_wakeup(struct omap_hwmod *oh, u32 *v)
516 if (!oh->class->sysc ||
517 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
518 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
519 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
522 if (!oh->class->sysc->sysc_fields) {
523 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
527 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
528 *v &= ~(0x1 << oh->class->sysc->sysc_fields->enwkup_shift);
530 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
531 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART, v);
532 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
533 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART, v);
535 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
537 oh->_int_flags &= ~_HWMOD_WAKEUP_ENABLED;
543 * _add_initiator_dep: prevent @oh from smart-idling while @init_oh is active
544 * @oh: struct omap_hwmod *
546 * Prevent the hardware module @oh from entering idle while the
547 * hardare module initiator @init_oh is active. Useful when a module
548 * will be accessed by a particular initiator (e.g., if a module will
549 * be accessed by the IVA, there should be a sleepdep between the IVA
550 * initiator and the module). Only applies to modules in smart-idle
551 * mode. If the clockdomain is marked as not needing autodeps, return
552 * 0 without doing anything. Otherwise, returns -EINVAL upon error or
553 * passes along clkdm_add_sleepdep() value upon success.
555 static int _add_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
560 if (oh->_clk->clkdm && oh->_clk->clkdm->flags & CLKDM_NO_AUTODEPS)
563 return clkdm_add_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
567 * _del_initiator_dep: allow @oh to smart-idle even if @init_oh is active
568 * @oh: struct omap_hwmod *
570 * Allow the hardware module @oh to enter idle while the hardare
571 * module initiator @init_oh is active. Useful when a module will not
572 * be accessed by a particular initiator (e.g., if a module will not
573 * be accessed by the IVA, there should be no sleepdep between the IVA
574 * initiator and the module). Only applies to modules in smart-idle
575 * mode. If the clockdomain is marked as not needing autodeps, return
576 * 0 without doing anything. Returns -EINVAL upon error or passes
577 * along clkdm_del_sleepdep() value upon success.
579 static int _del_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
584 if (oh->_clk->clkdm && oh->_clk->clkdm->flags & CLKDM_NO_AUTODEPS)
587 return clkdm_del_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
591 * _init_main_clk - get a struct clk * for the the hwmod's main functional clk
592 * @oh: struct omap_hwmod *
594 * Called from _init_clocks(). Populates the @oh _clk (main
595 * functional clock pointer) if a main_clk is present. Returns 0 on
596 * success or -EINVAL on error.
598 static int _init_main_clk(struct omap_hwmod *oh)
605 oh->_clk = omap_clk_get_by_name(oh->main_clk);
607 pr_warning("omap_hwmod: %s: cannot clk_get main_clk %s\n",
608 oh->name, oh->main_clk);
612 if (!oh->_clk->clkdm)
613 pr_warning("omap_hwmod: %s: missing clockdomain for %s.\n",
614 oh->main_clk, oh->_clk->name);
620 * _init_interface_clks - get a struct clk * for the the hwmod's interface clks
621 * @oh: struct omap_hwmod *
623 * Called from _init_clocks(). Populates the @oh OCP slave interface
624 * clock pointers. Returns 0 on success or -EINVAL on error.
626 static int _init_interface_clks(struct omap_hwmod *oh)
628 struct omap_hwmod_ocp_if *os;
634 p = oh->slave_ports.next;
636 while (i < oh->slaves_cnt) {
637 os = _fetch_next_ocp_if(&p, &i);
641 c = omap_clk_get_by_name(os->clk);
643 pr_warning("omap_hwmod: %s: cannot clk_get interface_clk %s\n",
654 * _init_opt_clk - get a struct clk * for the the hwmod's optional clocks
655 * @oh: struct omap_hwmod *
657 * Called from _init_clocks(). Populates the @oh omap_hwmod_opt_clk
658 * clock pointers. Returns 0 on success or -EINVAL on error.
660 static int _init_opt_clks(struct omap_hwmod *oh)
662 struct omap_hwmod_opt_clk *oc;
667 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++) {
668 c = omap_clk_get_by_name(oc->clk);
670 pr_warning("omap_hwmod: %s: cannot clk_get opt_clk %s\n",
681 * _enable_clocks - enable hwmod main clock and interface clocks
682 * @oh: struct omap_hwmod *
684 * Enables all clocks necessary for register reads and writes to succeed
685 * on the hwmod @oh. Returns 0.
687 static int _enable_clocks(struct omap_hwmod *oh)
689 struct omap_hwmod_ocp_if *os;
693 pr_debug("omap_hwmod: %s: enabling clocks\n", oh->name);
696 clk_enable(oh->_clk);
698 p = oh->slave_ports.next;
700 while (i < oh->slaves_cnt) {
701 os = _fetch_next_ocp_if(&p, &i);
703 if (os->_clk && (os->flags & OCPIF_SWSUP_IDLE))
704 clk_enable(os->_clk);
707 /* The opt clocks are controlled by the device driver. */
713 * _disable_clocks - disable hwmod main clock and interface clocks
714 * @oh: struct omap_hwmod *
716 * Disables the hwmod @oh main functional and interface clocks. Returns 0.
718 static int _disable_clocks(struct omap_hwmod *oh)
720 struct omap_hwmod_ocp_if *os;
724 pr_debug("omap_hwmod: %s: disabling clocks\n", oh->name);
727 clk_disable(oh->_clk);
729 p = oh->slave_ports.next;
731 while (i < oh->slaves_cnt) {
732 os = _fetch_next_ocp_if(&p, &i);
734 if (os->_clk && (os->flags & OCPIF_SWSUP_IDLE))
735 clk_disable(os->_clk);
738 /* The opt clocks are controlled by the device driver. */
743 static void _enable_optional_clocks(struct omap_hwmod *oh)
745 struct omap_hwmod_opt_clk *oc;
748 pr_debug("omap_hwmod: %s: enabling optional clocks\n", oh->name);
750 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
752 pr_debug("omap_hwmod: enable %s:%s\n", oc->role,
754 clk_enable(oc->_clk);
758 static void _disable_optional_clocks(struct omap_hwmod *oh)
760 struct omap_hwmod_opt_clk *oc;
763 pr_debug("omap_hwmod: %s: disabling optional clocks\n", oh->name);
765 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
767 pr_debug("omap_hwmod: disable %s:%s\n", oc->role,
769 clk_disable(oc->_clk);
774 * _enable_module - enable CLKCTRL modulemode on OMAP4
775 * @oh: struct omap_hwmod *
777 * Enables the PRCM module mode related to the hwmod @oh.
780 static void _enable_module(struct omap_hwmod *oh)
782 /* The module mode does not exist prior OMAP4 */
783 if (cpu_is_omap24xx() || cpu_is_omap34xx())
786 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
789 pr_debug("omap_hwmod: %s: _enable_module: %d\n",
790 oh->name, oh->prcm.omap4.modulemode);
792 omap4_cminst_module_enable(oh->prcm.omap4.modulemode,
793 oh->clkdm->prcm_partition,
795 oh->clkdm->clkdm_offs,
796 oh->prcm.omap4.clkctrl_offs);
800 * _omap4_wait_target_disable - wait for a module to be disabled on OMAP4
801 * @oh: struct omap_hwmod *
803 * Wait for a module @oh to enter slave idle. Returns 0 if the module
804 * does not have an IDLEST bit or if the module successfully enters
805 * slave idle; otherwise, pass along the return value of the
806 * appropriate *_cm*_wait_module_idle() function.
808 static int _omap4_wait_target_disable(struct omap_hwmod *oh)
810 if (!cpu_is_omap44xx())
816 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
819 if (oh->flags & HWMOD_NO_IDLEST)
822 return omap4_cminst_wait_module_idle(oh->clkdm->prcm_partition,
824 oh->clkdm->clkdm_offs,
825 oh->prcm.omap4.clkctrl_offs);
829 * _count_mpu_irqs - count the number of MPU IRQ lines associated with @oh
830 * @oh: struct omap_hwmod *oh
832 * Count and return the number of MPU IRQs associated with the hwmod
833 * @oh. Used to allocate struct resource data. Returns 0 if @oh is
836 static int _count_mpu_irqs(struct omap_hwmod *oh)
838 struct omap_hwmod_irq_info *ohii;
841 if (!oh || !oh->mpu_irqs)
845 ohii = &oh->mpu_irqs[i++];
846 } while (ohii->irq != -1);
852 * _count_sdma_reqs - count the number of SDMA request lines associated with @oh
853 * @oh: struct omap_hwmod *oh
855 * Count and return the number of SDMA request lines associated with
856 * the hwmod @oh. Used to allocate struct resource data. Returns 0
859 static int _count_sdma_reqs(struct omap_hwmod *oh)
861 struct omap_hwmod_dma_info *ohdi;
864 if (!oh || !oh->sdma_reqs)
868 ohdi = &oh->sdma_reqs[i++];
869 } while (ohdi->dma_req != -1);
875 * _count_ocp_if_addr_spaces - count the number of address space entries for @oh
876 * @oh: struct omap_hwmod *oh
878 * Count and return the number of address space ranges associated with
879 * the hwmod @oh. Used to allocate struct resource data. Returns 0
882 static int _count_ocp_if_addr_spaces(struct omap_hwmod_ocp_if *os)
884 struct omap_hwmod_addr_space *mem;
887 if (!os || !os->addr)
891 mem = &os->addr[i++];
892 } while (mem->pa_start != mem->pa_end);
898 * _get_mpu_irq_by_name - fetch MPU interrupt line number by name
899 * @oh: struct omap_hwmod * to operate on
900 * @name: pointer to the name of the MPU interrupt number to fetch (optional)
901 * @irq: pointer to an unsigned int to store the MPU IRQ number to
903 * Retrieve a MPU hardware IRQ line number named by @name associated
904 * with the IP block pointed to by @oh. The IRQ number will be filled
905 * into the address pointed to by @dma. When @name is non-null, the
906 * IRQ line number associated with the named entry will be returned.
907 * If @name is null, the first matching entry will be returned. Data
908 * order is not meaningful in hwmod data, so callers are strongly
909 * encouraged to use a non-null @name whenever possible to avoid
910 * unpredictable effects if hwmod data is later added that causes data
911 * ordering to change. Returns 0 upon success or a negative error
914 static int _get_mpu_irq_by_name(struct omap_hwmod *oh, const char *name,
924 while (oh->mpu_irqs[i].irq != -1) {
925 if (name == oh->mpu_irqs[i].name ||
926 !strcmp(name, oh->mpu_irqs[i].name)) {
936 *irq = oh->mpu_irqs[i].irq;
942 * _get_sdma_req_by_name - fetch SDMA request line ID by name
943 * @oh: struct omap_hwmod * to operate on
944 * @name: pointer to the name of the SDMA request line to fetch (optional)
945 * @dma: pointer to an unsigned int to store the request line ID to
947 * Retrieve an SDMA request line ID named by @name on the IP block
948 * pointed to by @oh. The ID will be filled into the address pointed
949 * to by @dma. When @name is non-null, the request line ID associated
950 * with the named entry will be returned. If @name is null, the first
951 * matching entry will be returned. Data order is not meaningful in
952 * hwmod data, so callers are strongly encouraged to use a non-null
953 * @name whenever possible to avoid unpredictable effects if hwmod
954 * data is later added that causes data ordering to change. Returns 0
955 * upon success or a negative error code upon error.
957 static int _get_sdma_req_by_name(struct omap_hwmod *oh, const char *name,
967 while (oh->sdma_reqs[i].dma_req != -1) {
968 if (name == oh->sdma_reqs[i].name ||
969 !strcmp(name, oh->sdma_reqs[i].name)) {
979 *dma = oh->sdma_reqs[i].dma_req;
985 * _get_addr_space_by_name - fetch address space start & end by name
986 * @oh: struct omap_hwmod * to operate on
987 * @name: pointer to the name of the address space to fetch (optional)
988 * @pa_start: pointer to a u32 to store the starting address to
989 * @pa_end: pointer to a u32 to store the ending address to
991 * Retrieve address space start and end addresses for the IP block
992 * pointed to by @oh. The data will be filled into the addresses
993 * pointed to by @pa_start and @pa_end. When @name is non-null, the
994 * address space data associated with the named entry will be
995 * returned. If @name is null, the first matching entry will be
996 * returned. Data order is not meaningful in hwmod data, so callers
997 * are strongly encouraged to use a non-null @name whenever possible
998 * to avoid unpredictable effects if hwmod data is later added that
999 * causes data ordering to change. Returns 0 upon success or a
1000 * negative error code upon error.
1002 static int _get_addr_space_by_name(struct omap_hwmod *oh, const char *name,
1003 u32 *pa_start, u32 *pa_end)
1006 struct omap_hwmod_ocp_if *os;
1007 struct list_head *p = NULL;
1010 p = oh->slave_ports.next;
1013 while (i < oh->slaves_cnt) {
1014 os = _fetch_next_ocp_if(&p, &i);
1020 while (os->addr[j].pa_start != os->addr[j].pa_end) {
1021 if (name == os->addr[j].name ||
1022 !strcmp(name, os->addr[j].name)) {
1036 *pa_start = os->addr[j].pa_start;
1037 *pa_end = os->addr[j].pa_end;
1043 * _save_mpu_port_index - find and save the index to @oh's MPU port
1044 * @oh: struct omap_hwmod *
1046 * Determines the array index of the OCP slave port that the MPU uses
1047 * to address the device, and saves it into the struct omap_hwmod.
1048 * Intended to be called during hwmod registration only. No return
1051 static void __init _save_mpu_port_index(struct omap_hwmod *oh)
1053 struct omap_hwmod_ocp_if *os = NULL;
1054 struct list_head *p;
1060 oh->_int_flags |= _HWMOD_NO_MPU_PORT;
1062 p = oh->slave_ports.next;
1064 while (i < oh->slaves_cnt) {
1065 os = _fetch_next_ocp_if(&p, &i);
1066 if (os->user & OCP_USER_MPU) {
1068 oh->_int_flags &= ~_HWMOD_NO_MPU_PORT;
1077 * _find_mpu_rt_port - return omap_hwmod_ocp_if accessible by the MPU
1078 * @oh: struct omap_hwmod *
1080 * Given a pointer to a struct omap_hwmod record @oh, return a pointer
1081 * to the struct omap_hwmod_ocp_if record that is used by the MPU to
1082 * communicate with the IP block. This interface need not be directly
1083 * connected to the MPU (and almost certainly is not), but is directly
1084 * connected to the IP block represented by @oh. Returns a pointer
1085 * to the struct omap_hwmod_ocp_if * upon success, or returns NULL upon
1086 * error or if there does not appear to be a path from the MPU to this
1089 static struct omap_hwmod_ocp_if *_find_mpu_rt_port(struct omap_hwmod *oh)
1091 if (!oh || oh->_int_flags & _HWMOD_NO_MPU_PORT || oh->slaves_cnt == 0)
1094 return oh->_mpu_port;
1098 * _find_mpu_rt_addr_space - return MPU register target address space for @oh
1099 * @oh: struct omap_hwmod *
1101 * Returns a pointer to the struct omap_hwmod_addr_space record representing
1102 * the register target MPU address space; or returns NULL upon error.
1104 static struct omap_hwmod_addr_space * __init _find_mpu_rt_addr_space(struct omap_hwmod *oh)
1106 struct omap_hwmod_ocp_if *os;
1107 struct omap_hwmod_addr_space *mem;
1108 int found = 0, i = 0;
1110 os = _find_mpu_rt_port(oh);
1111 if (!os || !os->addr)
1115 mem = &os->addr[i++];
1116 if (mem->flags & ADDR_TYPE_RT)
1118 } while (!found && mem->pa_start != mem->pa_end);
1120 return (found) ? mem : NULL;
1124 * _enable_sysc - try to bring a module out of idle via OCP_SYSCONFIG
1125 * @oh: struct omap_hwmod *
1127 * Ensure that the OCP_SYSCONFIG register for the IP block represented
1128 * by @oh is set to indicate to the PRCM that the IP block is active.
1129 * Usually this means placing the module into smart-idle mode and
1130 * smart-standby, but if there is a bug in the automatic idle handling
1131 * for the IP block, it may need to be placed into the force-idle or
1132 * no-idle variants of these modes. No return value.
1134 static void _enable_sysc(struct omap_hwmod *oh)
1140 if (!oh->class->sysc)
1143 v = oh->_sysc_cache;
1144 sf = oh->class->sysc->sysc_flags;
1146 if (sf & SYSC_HAS_SIDLEMODE) {
1147 clkdm_act = ((oh->clkdm &&
1148 oh->clkdm->flags & CLKDM_ACTIVE_WITH_MPU) ||
1149 (oh->_clk && oh->_clk->clkdm &&
1150 oh->_clk->clkdm->flags & CLKDM_ACTIVE_WITH_MPU));
1151 if (clkdm_act && !(oh->class->sysc->idlemodes &
1152 (SIDLE_SMART | SIDLE_SMART_WKUP)))
1153 idlemode = HWMOD_IDLEMODE_FORCE;
1155 idlemode = (oh->flags & HWMOD_SWSUP_SIDLE) ?
1156 HWMOD_IDLEMODE_NO : HWMOD_IDLEMODE_SMART;
1157 _set_slave_idlemode(oh, idlemode, &v);
1160 if (sf & SYSC_HAS_MIDLEMODE) {
1161 if (oh->flags & HWMOD_SWSUP_MSTANDBY) {
1162 idlemode = HWMOD_IDLEMODE_NO;
1164 if (sf & SYSC_HAS_ENAWAKEUP)
1165 _enable_wakeup(oh, &v);
1166 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1167 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1169 idlemode = HWMOD_IDLEMODE_SMART;
1171 _set_master_standbymode(oh, idlemode, &v);
1175 * XXX The clock framework should handle this, by
1176 * calling into this code. But this must wait until the
1177 * clock structures are tagged with omap_hwmod entries
1179 if ((oh->flags & HWMOD_SET_DEFAULT_CLOCKACT) &&
1180 (sf & SYSC_HAS_CLOCKACTIVITY))
1181 _set_clockactivity(oh, oh->class->sysc->clockact, &v);
1183 /* If slave is in SMARTIDLE, also enable wakeup */
1184 if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
1185 _enable_wakeup(oh, &v);
1187 _write_sysconfig(v, oh);
1190 * Set the autoidle bit only after setting the smartidle bit
1191 * Setting this will not have any impact on the other modules.
1193 if (sf & SYSC_HAS_AUTOIDLE) {
1194 idlemode = (oh->flags & HWMOD_NO_OCP_AUTOIDLE) ?
1196 _set_module_autoidle(oh, idlemode, &v);
1197 _write_sysconfig(v, oh);
1202 * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
1203 * @oh: struct omap_hwmod *
1205 * If module is marked as SWSUP_SIDLE, force the module into slave
1206 * idle; otherwise, configure it for smart-idle. If module is marked
1207 * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
1208 * configure it for smart-standby. No return value.
1210 static void _idle_sysc(struct omap_hwmod *oh)
1215 if (!oh->class->sysc)
1218 v = oh->_sysc_cache;
1219 sf = oh->class->sysc->sysc_flags;
1221 if (sf & SYSC_HAS_SIDLEMODE) {
1222 /* XXX What about HWMOD_IDLEMODE_SMART_WKUP? */
1223 if (oh->flags & HWMOD_SWSUP_SIDLE ||
1224 !(oh->class->sysc->idlemodes &
1225 (SIDLE_SMART | SIDLE_SMART_WKUP)))
1226 idlemode = HWMOD_IDLEMODE_FORCE;
1228 idlemode = HWMOD_IDLEMODE_SMART;
1229 _set_slave_idlemode(oh, idlemode, &v);
1232 if (sf & SYSC_HAS_MIDLEMODE) {
1233 if (oh->flags & HWMOD_SWSUP_MSTANDBY) {
1234 idlemode = HWMOD_IDLEMODE_FORCE;
1236 if (sf & SYSC_HAS_ENAWAKEUP)
1237 _enable_wakeup(oh, &v);
1238 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1239 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1241 idlemode = HWMOD_IDLEMODE_SMART;
1243 _set_master_standbymode(oh, idlemode, &v);
1246 /* If slave is in SMARTIDLE, also enable wakeup */
1247 if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
1248 _enable_wakeup(oh, &v);
1250 _write_sysconfig(v, oh);
1254 * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
1255 * @oh: struct omap_hwmod *
1257 * Force the module into slave idle and master suspend. No return
1260 static void _shutdown_sysc(struct omap_hwmod *oh)
1265 if (!oh->class->sysc)
1268 v = oh->_sysc_cache;
1269 sf = oh->class->sysc->sysc_flags;
1271 if (sf & SYSC_HAS_SIDLEMODE)
1272 _set_slave_idlemode(oh, HWMOD_IDLEMODE_FORCE, &v);
1274 if (sf & SYSC_HAS_MIDLEMODE)
1275 _set_master_standbymode(oh, HWMOD_IDLEMODE_FORCE, &v);
1277 if (sf & SYSC_HAS_AUTOIDLE)
1278 _set_module_autoidle(oh, 1, &v);
1280 _write_sysconfig(v, oh);
1284 * _lookup - find an omap_hwmod by name
1285 * @name: find an omap_hwmod by name
1287 * Return a pointer to an omap_hwmod by name, or NULL if not found.
1289 static struct omap_hwmod *_lookup(const char *name)
1291 struct omap_hwmod *oh, *temp_oh;
1295 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1296 if (!strcmp(name, temp_oh->name)) {
1305 * _init_clkdm - look up a clockdomain name, store pointer in omap_hwmod
1306 * @oh: struct omap_hwmod *
1308 * Convert a clockdomain name stored in a struct omap_hwmod into a
1309 * clockdomain pointer, and save it into the struct omap_hwmod.
1310 * return -EINVAL if clkdm_name does not exist or if the lookup failed.
1312 static int _init_clkdm(struct omap_hwmod *oh)
1314 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1317 if (!oh->clkdm_name) {
1318 pr_warning("omap_hwmod: %s: no clkdm_name\n", oh->name);
1322 oh->clkdm = clkdm_lookup(oh->clkdm_name);
1324 pr_warning("omap_hwmod: %s: could not associate to clkdm %s\n",
1325 oh->name, oh->clkdm_name);
1329 pr_debug("omap_hwmod: %s: associated to clkdm %s\n",
1330 oh->name, oh->clkdm_name);
1336 * _init_clocks - clk_get() all clocks associated with this hwmod. Retrieve as
1337 * well the clockdomain.
1338 * @oh: struct omap_hwmod *
1339 * @data: not used; pass NULL
1341 * Called by omap_hwmod_setup_*() (after omap2_clk_init()).
1342 * Resolves all clock names embedded in the hwmod. Returns 0 on
1343 * success, or a negative error code on failure.
1345 static int _init_clocks(struct omap_hwmod *oh, void *data)
1349 if (oh->_state != _HWMOD_STATE_REGISTERED)
1352 pr_debug("omap_hwmod: %s: looking up clocks\n", oh->name);
1354 ret |= _init_main_clk(oh);
1355 ret |= _init_interface_clks(oh);
1356 ret |= _init_opt_clks(oh);
1357 ret |= _init_clkdm(oh);
1360 oh->_state = _HWMOD_STATE_CLKS_INITED;
1362 pr_warning("omap_hwmod: %s: cannot _init_clocks\n", oh->name);
1368 * _wait_target_ready - wait for a module to leave slave idle
1369 * @oh: struct omap_hwmod *
1371 * Wait for a module @oh to leave slave idle. Returns 0 if the module
1372 * does not have an IDLEST bit or if the module successfully leaves
1373 * slave idle; otherwise, pass along the return value of the
1374 * appropriate *_cm*_wait_module_ready() function.
1376 static int _wait_target_ready(struct omap_hwmod *oh)
1378 struct omap_hwmod_ocp_if *os;
1384 if (oh->flags & HWMOD_NO_IDLEST)
1387 os = _find_mpu_rt_port(oh);
1391 /* XXX check module SIDLEMODE */
1393 /* XXX check clock enable states */
1395 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1396 ret = omap2_cm_wait_module_ready(oh->prcm.omap2.module_offs,
1397 oh->prcm.omap2.idlest_reg_id,
1398 oh->prcm.omap2.idlest_idle_bit);
1399 } else if (cpu_is_omap44xx()) {
1403 ret = omap4_cminst_wait_module_ready(oh->clkdm->prcm_partition,
1405 oh->clkdm->clkdm_offs,
1406 oh->prcm.omap4.clkctrl_offs);
1415 * _lookup_hardreset - fill register bit info for this hwmod/reset line
1416 * @oh: struct omap_hwmod *
1417 * @name: name of the reset line in the context of this hwmod
1418 * @ohri: struct omap_hwmod_rst_info * that this function will fill in
1420 * Return the bit position of the reset line that match the
1421 * input name. Return -ENOENT if not found.
1423 static u8 _lookup_hardreset(struct omap_hwmod *oh, const char *name,
1424 struct omap_hwmod_rst_info *ohri)
1428 for (i = 0; i < oh->rst_lines_cnt; i++) {
1429 const char *rst_line = oh->rst_lines[i].name;
1430 if (!strcmp(rst_line, name)) {
1431 ohri->rst_shift = oh->rst_lines[i].rst_shift;
1432 ohri->st_shift = oh->rst_lines[i].st_shift;
1433 pr_debug("omap_hwmod: %s: %s: %s: rst %d st %d\n",
1434 oh->name, __func__, rst_line, ohri->rst_shift,
1445 * _assert_hardreset - assert the HW reset line of submodules
1446 * contained in the hwmod module.
1447 * @oh: struct omap_hwmod *
1448 * @name: name of the reset line to lookup and assert
1450 * Some IP like dsp, ipu or iva contain processor that require
1451 * an HW reset line to be assert / deassert in order to enable fully
1454 static int _assert_hardreset(struct omap_hwmod *oh, const char *name)
1456 struct omap_hwmod_rst_info ohri;
1462 ret = _lookup_hardreset(oh, name, &ohri);
1463 if (IS_ERR_VALUE(ret))
1466 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1467 return omap2_prm_assert_hardreset(oh->prcm.omap2.module_offs,
1469 else if (cpu_is_omap44xx())
1470 return omap4_prminst_assert_hardreset(ohri.rst_shift,
1471 oh->clkdm->pwrdm.ptr->prcm_partition,
1472 oh->clkdm->pwrdm.ptr->prcm_offs,
1473 oh->prcm.omap4.rstctrl_offs);
1479 * _deassert_hardreset - deassert the HW reset line of submodules contained
1480 * in the hwmod module.
1481 * @oh: struct omap_hwmod *
1482 * @name: name of the reset line to look up and deassert
1484 * Some IP like dsp, ipu or iva contain processor that require
1485 * an HW reset line to be assert / deassert in order to enable fully
1488 static int _deassert_hardreset(struct omap_hwmod *oh, const char *name)
1490 struct omap_hwmod_rst_info ohri;
1496 ret = _lookup_hardreset(oh, name, &ohri);
1497 if (IS_ERR_VALUE(ret))
1500 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1501 ret = omap2_prm_deassert_hardreset(oh->prcm.omap2.module_offs,
1504 } else if (cpu_is_omap44xx()) {
1506 pr_err("omap_hwmod: %s: %s: hwmod data error: OMAP4 does not support st_shift\n",
1508 ret = omap4_prminst_deassert_hardreset(ohri.rst_shift,
1509 oh->clkdm->pwrdm.ptr->prcm_partition,
1510 oh->clkdm->pwrdm.ptr->prcm_offs,
1511 oh->prcm.omap4.rstctrl_offs);
1517 pr_warning("omap_hwmod: %s: failed to hardreset\n", oh->name);
1523 * _read_hardreset - read the HW reset line state of submodules
1524 * contained in the hwmod module
1525 * @oh: struct omap_hwmod *
1526 * @name: name of the reset line to look up and read
1528 * Return the state of the reset line.
1530 static int _read_hardreset(struct omap_hwmod *oh, const char *name)
1532 struct omap_hwmod_rst_info ohri;
1538 ret = _lookup_hardreset(oh, name, &ohri);
1539 if (IS_ERR_VALUE(ret))
1542 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1543 return omap2_prm_is_hardreset_asserted(oh->prcm.omap2.module_offs,
1545 } else if (cpu_is_omap44xx()) {
1546 return omap4_prminst_is_hardreset_asserted(ohri.rst_shift,
1547 oh->clkdm->pwrdm.ptr->prcm_partition,
1548 oh->clkdm->pwrdm.ptr->prcm_offs,
1549 oh->prcm.omap4.rstctrl_offs);
1556 * _are_any_hardreset_lines_asserted - return true if part of @oh is hard-reset
1557 * @oh: struct omap_hwmod *
1559 * If any hardreset line associated with @oh is asserted, then return true.
1560 * Otherwise, if @oh has no hardreset lines associated with it, or if
1561 * no hardreset lines associated with @oh are asserted, then return false.
1562 * This function is used to avoid executing some parts of the IP block
1563 * enable/disable sequence if a hardreset line is set.
1565 static bool _are_any_hardreset_lines_asserted(struct omap_hwmod *oh)
1569 if (oh->rst_lines_cnt == 0)
1572 for (i = 0; i < oh->rst_lines_cnt; i++)
1573 if (_read_hardreset(oh, oh->rst_lines[i].name) > 0)
1580 * _omap4_disable_module - enable CLKCTRL modulemode on OMAP4
1581 * @oh: struct omap_hwmod *
1583 * Disable the PRCM module mode related to the hwmod @oh.
1584 * Return EINVAL if the modulemode is not supported and 0 in case of success.
1586 static int _omap4_disable_module(struct omap_hwmod *oh)
1590 /* The module mode does not exist prior OMAP4 */
1591 if (!cpu_is_omap44xx())
1594 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
1597 pr_debug("omap_hwmod: %s: %s\n", oh->name, __func__);
1599 omap4_cminst_module_disable(oh->clkdm->prcm_partition,
1601 oh->clkdm->clkdm_offs,
1602 oh->prcm.omap4.clkctrl_offs);
1604 if (_are_any_hardreset_lines_asserted(oh))
1607 v = _omap4_wait_target_disable(oh);
1609 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1616 * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1617 * @oh: struct omap_hwmod *
1619 * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit. hwmod must be
1620 * enabled for this to work. Returns -ENOENT if the hwmod cannot be
1621 * reset this way, -EINVAL if the hwmod is in the wrong state,
1622 * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1624 * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1625 * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1626 * use the SYSCONFIG softreset bit to provide the status.
1628 * Note that some IP like McBSP do have reset control but don't have
1631 static int _ocp_softreset(struct omap_hwmod *oh)
1633 u32 v, softrst_mask;
1637 if (!oh->class->sysc ||
1638 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
1641 /* clocks must be on for this operation */
1642 if (oh->_state != _HWMOD_STATE_ENABLED) {
1643 pr_warning("omap_hwmod: %s: reset can only be entered from "
1644 "enabled state\n", oh->name);
1648 /* For some modules, all optionnal clocks need to be enabled as well */
1649 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1650 _enable_optional_clocks(oh);
1652 pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh->name);
1654 v = oh->_sysc_cache;
1655 ret = _set_softreset(oh, &v);
1658 _write_sysconfig(v, oh);
1660 if (oh->class->sysc->srst_udelay)
1661 udelay(oh->class->sysc->srst_udelay);
1663 if (oh->class->sysc->sysc_flags & SYSS_HAS_RESET_STATUS)
1664 omap_test_timeout((omap_hwmod_read(oh,
1665 oh->class->sysc->syss_offs)
1666 & SYSS_RESETDONE_MASK),
1667 MAX_MODULE_SOFTRESET_WAIT, c);
1668 else if (oh->class->sysc->sysc_flags & SYSC_HAS_RESET_STATUS) {
1669 softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
1670 omap_test_timeout(!(omap_hwmod_read(oh,
1671 oh->class->sysc->sysc_offs)
1673 MAX_MODULE_SOFTRESET_WAIT, c);
1676 if (c == MAX_MODULE_SOFTRESET_WAIT)
1677 pr_warning("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1678 oh->name, MAX_MODULE_SOFTRESET_WAIT);
1680 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh->name, c);
1683 * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1684 * _wait_target_ready() or _reset()
1687 ret = (c == MAX_MODULE_SOFTRESET_WAIT) ? -ETIMEDOUT : 0;
1690 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1691 _disable_optional_clocks(oh);
1697 * _reset - reset an omap_hwmod
1698 * @oh: struct omap_hwmod *
1700 * Resets an omap_hwmod @oh. If the module has a custom reset
1701 * function pointer defined, then call it to reset the IP block, and
1702 * pass along its return value to the caller. Otherwise, if the IP
1703 * block has an OCP_SYSCONFIG register with a SOFTRESET bitfield
1704 * associated with it, call a function to reset the IP block via that
1705 * method, and pass along the return value to the caller. Finally, if
1706 * the IP block has some hardreset lines associated with it, assert
1707 * all of those, but do _not_ deassert them. (This is because driver
1708 * authors have expressed an apparent requirement to control the
1709 * deassertion of the hardreset lines themselves.)
1711 * The default software reset mechanism for most OMAP IP blocks is
1712 * triggered via the OCP_SYSCONFIG.SOFTRESET bit. However, some
1713 * hwmods cannot be reset via this method. Some are not targets and
1714 * therefore have no OCP header registers to access. Others (like the
1715 * IVA) have idiosyncratic reset sequences. So for these relatively
1716 * rare cases, custom reset code can be supplied in the struct
1717 * omap_hwmod_class .reset function pointer. Passes along the return
1718 * value from either _ocp_softreset() or the custom reset function -
1719 * these must return -EINVAL if the hwmod cannot be reset this way or
1720 * if the hwmod is in the wrong state, -ETIMEDOUT if the module did
1721 * not reset in time, or 0 upon success.
1723 static int _reset(struct omap_hwmod *oh)
1727 pr_debug("omap_hwmod: %s: resetting\n", oh->name);
1729 if (oh->class->reset) {
1730 r = oh->class->reset(oh);
1732 if (oh->rst_lines_cnt > 0) {
1733 for (i = 0; i < oh->rst_lines_cnt; i++)
1734 _assert_hardreset(oh, oh->rst_lines[i].name);
1737 r = _ocp_softreset(oh);
1744 * OCP_SYSCONFIG bits need to be reprogrammed after a
1745 * softreset. The _enable() function should be split to avoid
1746 * the rewrite of the OCP_SYSCONFIG register.
1748 if (oh->class->sysc) {
1749 _update_sysc_cache(oh);
1757 * _enable - enable an omap_hwmod
1758 * @oh: struct omap_hwmod *
1760 * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
1761 * register target. Returns -EINVAL if the hwmod is in the wrong
1762 * state or passes along the return value of _wait_target_ready().
1764 static int _enable(struct omap_hwmod *oh)
1769 pr_debug("omap_hwmod: %s: enabling\n", oh->name);
1772 * hwmods with HWMOD_INIT_NO_IDLE flag set are left in enabled
1773 * state at init. Now that someone is really trying to enable
1774 * them, just ensure that the hwmod mux is set.
1776 if (oh->_int_flags & _HWMOD_SKIP_ENABLE) {
1778 * If the caller has mux data populated, do the mux'ing
1779 * which wouldn't have been done as part of the _enable()
1780 * done during setup.
1783 omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
1785 oh->_int_flags &= ~_HWMOD_SKIP_ENABLE;
1789 if (oh->_state != _HWMOD_STATE_INITIALIZED &&
1790 oh->_state != _HWMOD_STATE_IDLE &&
1791 oh->_state != _HWMOD_STATE_DISABLED) {
1792 WARN(1, "omap_hwmod: %s: enabled state can only be entered from initialized, idle, or disabled state\n",
1798 * If an IP block contains HW reset lines and any of them are
1799 * asserted, we let integration code associated with that
1800 * block handle the enable. We've received very little
1801 * information on what those driver authors need, and until
1802 * detailed information is provided and the driver code is
1803 * posted to the public lists, this is probably the best we
1806 if (_are_any_hardreset_lines_asserted(oh))
1809 /* Mux pins for device runtime if populated */
1810 if (oh->mux && (!oh->mux->enabled ||
1811 ((oh->_state == _HWMOD_STATE_IDLE) &&
1812 oh->mux->pads_dynamic)))
1813 omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
1815 _add_initiator_dep(oh, mpu_oh);
1819 * A clockdomain must be in SW_SUP before enabling
1820 * completely the module. The clockdomain can be set
1821 * in HW_AUTO only when the module become ready.
1823 hwsup = clkdm_in_hwsup(oh->clkdm);
1824 r = clkdm_hwmod_enable(oh->clkdm, oh);
1826 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1827 oh->name, oh->clkdm->name, r);
1835 r = _wait_target_ready(oh);
1838 * Set the clockdomain to HW_AUTO only if the target is ready,
1839 * assuming that the previous state was HW_AUTO
1841 if (oh->clkdm && hwsup)
1842 clkdm_allow_idle(oh->clkdm);
1844 oh->_state = _HWMOD_STATE_ENABLED;
1846 /* Access the sysconfig only if the target is ready */
1847 if (oh->class->sysc) {
1848 if (!(oh->_int_flags & _HWMOD_SYSCONFIG_LOADED))
1849 _update_sysc_cache(oh);
1853 _disable_clocks(oh);
1854 pr_debug("omap_hwmod: %s: _wait_target_ready: %d\n",
1858 clkdm_hwmod_disable(oh->clkdm, oh);
1865 * _idle - idle an omap_hwmod
1866 * @oh: struct omap_hwmod *
1868 * Idles an omap_hwmod @oh. This should be called once the hwmod has
1869 * no further work. Returns -EINVAL if the hwmod is in the wrong
1870 * state or returns 0.
1872 static int _idle(struct omap_hwmod *oh)
1874 pr_debug("omap_hwmod: %s: idling\n", oh->name);
1876 if (oh->_state != _HWMOD_STATE_ENABLED) {
1877 WARN(1, "omap_hwmod: %s: idle state can only be entered from enabled state\n",
1882 if (_are_any_hardreset_lines_asserted(oh))
1885 if (oh->class->sysc)
1887 _del_initiator_dep(oh, mpu_oh);
1889 _omap4_disable_module(oh);
1892 * The module must be in idle mode before disabling any parents
1893 * clocks. Otherwise, the parent clock might be disabled before
1894 * the module transition is done, and thus will prevent the
1895 * transition to complete properly.
1897 _disable_clocks(oh);
1899 clkdm_hwmod_disable(oh->clkdm, oh);
1901 /* Mux pins for device idle if populated */
1902 if (oh->mux && oh->mux->pads_dynamic)
1903 omap_hwmod_mux(oh->mux, _HWMOD_STATE_IDLE);
1905 oh->_state = _HWMOD_STATE_IDLE;
1911 * omap_hwmod_set_ocp_autoidle - set the hwmod's OCP autoidle bit
1912 * @oh: struct omap_hwmod *
1913 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
1915 * Sets the IP block's OCP autoidle bit in hardware, and updates our
1916 * local copy. Intended to be used by drivers that require
1917 * direct manipulation of the AUTOIDLE bits.
1918 * Returns -EINVAL if @oh is null or is not in the ENABLED state, or passes
1919 * along the return value from _set_module_autoidle().
1921 * Any users of this function should be scrutinized carefully.
1923 int omap_hwmod_set_ocp_autoidle(struct omap_hwmod *oh, u8 autoidle)
1927 unsigned long flags;
1929 if (!oh || oh->_state != _HWMOD_STATE_ENABLED)
1932 spin_lock_irqsave(&oh->_lock, flags);
1934 v = oh->_sysc_cache;
1936 retval = _set_module_autoidle(oh, autoidle, &v);
1939 _write_sysconfig(v, oh);
1941 spin_unlock_irqrestore(&oh->_lock, flags);
1947 * _shutdown - shutdown an omap_hwmod
1948 * @oh: struct omap_hwmod *
1950 * Shut down an omap_hwmod @oh. This should be called when the driver
1951 * used for the hwmod is removed or unloaded or if the driver is not
1952 * used by the system. Returns -EINVAL if the hwmod is in the wrong
1953 * state or returns 0.
1955 static int _shutdown(struct omap_hwmod *oh)
1960 if (oh->_state != _HWMOD_STATE_IDLE &&
1961 oh->_state != _HWMOD_STATE_ENABLED) {
1962 WARN(1, "omap_hwmod: %s: disabled state can only be entered from idle, or enabled state\n",
1967 if (_are_any_hardreset_lines_asserted(oh))
1970 pr_debug("omap_hwmod: %s: disabling\n", oh->name);
1972 if (oh->class->pre_shutdown) {
1973 prev_state = oh->_state;
1974 if (oh->_state == _HWMOD_STATE_IDLE)
1976 ret = oh->class->pre_shutdown(oh);
1978 if (prev_state == _HWMOD_STATE_IDLE)
1984 if (oh->class->sysc) {
1985 if (oh->_state == _HWMOD_STATE_IDLE)
1990 /* clocks and deps are already disabled in idle */
1991 if (oh->_state == _HWMOD_STATE_ENABLED) {
1992 _del_initiator_dep(oh, mpu_oh);
1993 /* XXX what about the other system initiators here? dma, dsp */
1994 _omap4_disable_module(oh);
1995 _disable_clocks(oh);
1997 clkdm_hwmod_disable(oh->clkdm, oh);
1999 /* XXX Should this code also force-disable the optional clocks? */
2001 for (i = 0; i < oh->rst_lines_cnt; i++)
2002 _assert_hardreset(oh, oh->rst_lines[i].name);
2004 /* Mux pins to safe mode or use populated off mode values */
2006 omap_hwmod_mux(oh->mux, _HWMOD_STATE_DISABLED);
2008 oh->_state = _HWMOD_STATE_DISABLED;
2014 * _init_mpu_rt_base - populate the virtual address for a hwmod
2015 * @oh: struct omap_hwmod * to locate the virtual address
2017 * Cache the virtual address used by the MPU to access this IP block's
2018 * registers. This address is needed early so the OCP registers that
2019 * are part of the device's address space can be ioremapped properly.
2022 static void __init _init_mpu_rt_base(struct omap_hwmod *oh, void *data)
2024 struct omap_hwmod_addr_space *mem;
2025 void __iomem *va_start;
2030 _save_mpu_port_index(oh);
2032 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2035 mem = _find_mpu_rt_addr_space(oh);
2037 pr_debug("omap_hwmod: %s: no MPU register target found\n",
2042 va_start = ioremap(mem->pa_start, mem->pa_end - mem->pa_start);
2044 pr_err("omap_hwmod: %s: Could not ioremap\n", oh->name);
2048 pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
2049 oh->name, va_start);
2051 oh->_mpu_rt_va = va_start;
2055 * _init - initialize internal data for the hwmod @oh
2056 * @oh: struct omap_hwmod *
2059 * Look up the clocks and the address space used by the MPU to access
2060 * registers belonging to the hwmod @oh. @oh must already be
2061 * registered at this point. This is the first of two phases for
2062 * hwmod initialization. Code called here does not touch any hardware
2063 * registers, it simply prepares internal data structures. Returns 0
2064 * upon success or if the hwmod isn't registered, or -EINVAL upon
2067 static int __init _init(struct omap_hwmod *oh, void *data)
2071 if (oh->_state != _HWMOD_STATE_REGISTERED)
2074 _init_mpu_rt_base(oh, NULL);
2076 r = _init_clocks(oh, NULL);
2077 if (IS_ERR_VALUE(r)) {
2078 WARN(1, "omap_hwmod: %s: couldn't init clocks\n", oh->name);
2082 oh->_state = _HWMOD_STATE_INITIALIZED;
2088 * _setup_iclk_autoidle - configure an IP block's interface clocks
2089 * @oh: struct omap_hwmod *
2091 * Set up the module's interface clocks. XXX This function is still mostly
2092 * a stub; implementing this properly requires iclk autoidle usecounting in
2093 * the clock code. No return value.
2095 static void __init _setup_iclk_autoidle(struct omap_hwmod *oh)
2097 struct omap_hwmod_ocp_if *os;
2098 struct list_head *p;
2100 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2103 p = oh->slave_ports.next;
2105 while (i < oh->slaves_cnt) {
2106 os = _fetch_next_ocp_if(&p, &i);
2110 if (os->flags & OCPIF_SWSUP_IDLE) {
2111 /* XXX omap_iclk_deny_idle(c); */
2113 /* XXX omap_iclk_allow_idle(c); */
2114 clk_enable(os->_clk);
2122 * _setup_reset - reset an IP block during the setup process
2123 * @oh: struct omap_hwmod *
2125 * Reset the IP block corresponding to the hwmod @oh during the setup
2126 * process. The IP block is first enabled so it can be successfully
2127 * reset. Returns 0 upon success or a negative error code upon
2130 static int __init _setup_reset(struct omap_hwmod *oh)
2134 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2137 if (oh->rst_lines_cnt == 0) {
2140 pr_warning("omap_hwmod: %s: cannot be enabled for reset (%d)\n",
2141 oh->name, oh->_state);
2146 if (!(oh->flags & HWMOD_INIT_NO_RESET))
2153 * _setup_postsetup - transition to the appropriate state after _setup
2154 * @oh: struct omap_hwmod *
2156 * Place an IP block represented by @oh into a "post-setup" state --
2157 * either IDLE, ENABLED, or DISABLED. ("post-setup" simply means that
2158 * this function is called at the end of _setup().) The postsetup
2159 * state for an IP block can be changed by calling
2160 * omap_hwmod_enter_postsetup_state() early in the boot process,
2161 * before one of the omap_hwmod_setup*() functions are called for the
2164 * The IP block stays in this state until a PM runtime-based driver is
2165 * loaded for that IP block. A post-setup state of IDLE is
2166 * appropriate for almost all IP blocks with runtime PM-enabled
2167 * drivers, since those drivers are able to enable the IP block. A
2168 * post-setup state of ENABLED is appropriate for kernels with PM
2169 * runtime disabled. The DISABLED state is appropriate for unusual IP
2170 * blocks such as the MPU WDTIMER on kernels without WDTIMER drivers
2171 * included, since the WDTIMER starts running on reset and will reset
2172 * the MPU if left active.
2174 * This post-setup mechanism is deprecated. Once all of the OMAP
2175 * drivers have been converted to use PM runtime, and all of the IP
2176 * block data and interconnect data is available to the hwmod code, it
2177 * should be possible to replace this mechanism with a "lazy reset"
2178 * arrangement. In a "lazy reset" setup, each IP block is enabled
2179 * when the driver first probes, then all remaining IP blocks without
2180 * drivers are either shut down or enabled after the drivers have
2181 * loaded. However, this cannot take place until the above
2182 * preconditions have been met, since otherwise the late reset code
2183 * has no way of knowing which IP blocks are in use by drivers, and
2184 * which ones are unused.
2188 static void __init _setup_postsetup(struct omap_hwmod *oh)
2192 if (oh->rst_lines_cnt > 0)
2195 postsetup_state = oh->_postsetup_state;
2196 if (postsetup_state == _HWMOD_STATE_UNKNOWN)
2197 postsetup_state = _HWMOD_STATE_ENABLED;
2200 * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
2201 * it should be set by the core code as a runtime flag during startup
2203 if ((oh->flags & HWMOD_INIT_NO_IDLE) &&
2204 (postsetup_state == _HWMOD_STATE_IDLE)) {
2205 oh->_int_flags |= _HWMOD_SKIP_ENABLE;
2206 postsetup_state = _HWMOD_STATE_ENABLED;
2209 if (postsetup_state == _HWMOD_STATE_IDLE)
2211 else if (postsetup_state == _HWMOD_STATE_DISABLED)
2213 else if (postsetup_state != _HWMOD_STATE_ENABLED)
2214 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
2215 oh->name, postsetup_state);
2221 * _setup - prepare IP block hardware for use
2222 * @oh: struct omap_hwmod *
2223 * @n: (unused, pass NULL)
2225 * Configure the IP block represented by @oh. This may include
2226 * enabling the IP block, resetting it, and placing it into a
2227 * post-setup state, depending on the type of IP block and applicable
2228 * flags. IP blocks are reset to prevent any previous configuration
2229 * by the bootloader or previous operating system from interfering
2230 * with power management or other parts of the system. The reset can
2231 * be avoided; see omap_hwmod_no_setup_reset(). This is the second of
2232 * two phases for hwmod initialization. Code called here generally
2233 * affects the IP block hardware, or system integration hardware
2234 * associated with the IP block. Returns 0.
2236 static int __init _setup(struct omap_hwmod *oh, void *data)
2238 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2241 _setup_iclk_autoidle(oh);
2243 if (!_setup_reset(oh))
2244 _setup_postsetup(oh);
2250 * _register - register a struct omap_hwmod
2251 * @oh: struct omap_hwmod *
2253 * Registers the omap_hwmod @oh. Returns -EEXIST if an omap_hwmod
2254 * already has been registered by the same name; -EINVAL if the
2255 * omap_hwmod is in the wrong state, if @oh is NULL, if the
2256 * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
2257 * name, or if the omap_hwmod's class is missing a name; or 0 upon
2260 * XXX The data should be copied into bootmem, so the original data
2261 * should be marked __initdata and freed after init. This would allow
2262 * unneeded omap_hwmods to be freed on multi-OMAP configurations. Note
2263 * that the copy process would be relatively complex due to the large number
2266 static int __init _register(struct omap_hwmod *oh)
2268 if (!oh || !oh->name || !oh->class || !oh->class->name ||
2269 (oh->_state != _HWMOD_STATE_UNKNOWN))
2272 pr_debug("omap_hwmod: %s: registering\n", oh->name);
2274 if (_lookup(oh->name))
2277 list_add_tail(&oh->node, &omap_hwmod_list);
2279 INIT_LIST_HEAD(&oh->master_ports);
2280 INIT_LIST_HEAD(&oh->slave_ports);
2281 spin_lock_init(&oh->_lock);
2283 oh->_state = _HWMOD_STATE_REGISTERED;
2286 * XXX Rather than doing a strcmp(), this should test a flag
2287 * set in the hwmod data, inserted by the autogenerator code.
2289 if (!strcmp(oh->name, MPU_INITIATOR_NAME))
2296 * _alloc_links - return allocated memory for hwmod links
2297 * @ml: pointer to a struct omap_hwmod_link * for the master link
2298 * @sl: pointer to a struct omap_hwmod_link * for the slave link
2300 * Return pointers to two struct omap_hwmod_link records, via the
2301 * addresses pointed to by @ml and @sl. Will first attempt to return
2302 * memory allocated as part of a large initial block, but if that has
2303 * been exhausted, will allocate memory itself. Since ideally this
2304 * second allocation path will never occur, the number of these
2305 * 'supplemental' allocations will be logged when debugging is
2306 * enabled. Returns 0.
2308 static int __init _alloc_links(struct omap_hwmod_link **ml,
2309 struct omap_hwmod_link **sl)
2313 if ((free_ls + LINKS_PER_OCP_IF) <= max_ls) {
2314 *ml = &linkspace[free_ls++];
2315 *sl = &linkspace[free_ls++];
2319 sz = sizeof(struct omap_hwmod_link) * LINKS_PER_OCP_IF;
2322 *ml = alloc_bootmem(sz);
2326 *sl = (void *)(*ml) + sizeof(struct omap_hwmod_link);
2329 pr_debug("omap_hwmod: supplemental link allocations needed: %d\n",
2330 ls_supp * LINKS_PER_OCP_IF);
2336 * _add_link - add an interconnect between two IP blocks
2337 * @oi: pointer to a struct omap_hwmod_ocp_if record
2339 * Add struct omap_hwmod_link records connecting the master IP block
2340 * specified in @oi->master to @oi, and connecting the slave IP block
2341 * specified in @oi->slave to @oi. This code is assumed to run before
2342 * preemption or SMP has been enabled, thus avoiding the need for
2343 * locking in this code. Changes to this assumption will require
2344 * additional locking. Returns 0.
2346 static int __init _add_link(struct omap_hwmod_ocp_if *oi)
2348 struct omap_hwmod_link *ml, *sl;
2350 pr_debug("omap_hwmod: %s -> %s: adding link\n", oi->master->name,
2353 _alloc_links(&ml, &sl);
2356 INIT_LIST_HEAD(&ml->node);
2357 list_add(&ml->node, &oi->master->master_ports);
2358 oi->master->masters_cnt++;
2361 INIT_LIST_HEAD(&sl->node);
2362 list_add(&sl->node, &oi->slave->slave_ports);
2363 oi->slave->slaves_cnt++;
2369 * _register_link - register a struct omap_hwmod_ocp_if
2370 * @oi: struct omap_hwmod_ocp_if *
2372 * Registers the omap_hwmod_ocp_if record @oi. Returns -EEXIST if it
2373 * has already been registered; -EINVAL if @oi is NULL or if the
2374 * record pointed to by @oi is missing required fields; or 0 upon
2377 * XXX The data should be copied into bootmem, so the original data
2378 * should be marked __initdata and freed after init. This would allow
2379 * unneeded omap_hwmods to be freed on multi-OMAP configurations.
2381 static int __init _register_link(struct omap_hwmod_ocp_if *oi)
2383 if (!oi || !oi->master || !oi->slave || !oi->user)
2386 if (oi->_int_flags & _OCPIF_INT_FLAGS_REGISTERED)
2389 pr_debug("omap_hwmod: registering link from %s to %s\n",
2390 oi->master->name, oi->slave->name);
2393 * Register the connected hwmods, if they haven't been
2394 * registered already
2396 if (oi->master->_state != _HWMOD_STATE_REGISTERED)
2397 _register(oi->master);
2399 if (oi->slave->_state != _HWMOD_STATE_REGISTERED)
2400 _register(oi->slave);
2404 oi->_int_flags |= _OCPIF_INT_FLAGS_REGISTERED;
2410 * _alloc_linkspace - allocate large block of hwmod links
2411 * @ois: pointer to an array of struct omap_hwmod_ocp_if records to count
2413 * Allocate a large block of struct omap_hwmod_link records. This
2414 * improves boot time significantly by avoiding the need to allocate
2415 * individual records one by one. If the number of records to
2416 * allocate in the block hasn't been manually specified, this function
2417 * will count the number of struct omap_hwmod_ocp_if records in @ois
2418 * and use that to determine the allocation size. For SoC families
2419 * that require multiple list registrations, such as OMAP3xxx, this
2420 * estimation process isn't optimal, so manual estimation is advised
2421 * in those cases. Returns -EEXIST if the allocation has already occurred
2422 * or 0 upon success.
2424 static int __init _alloc_linkspace(struct omap_hwmod_ocp_if **ois)
2430 WARN(1, "linkspace already allocated\n");
2436 max_ls += LINKS_PER_OCP_IF;
2438 sz = sizeof(struct omap_hwmod_link) * max_ls;
2440 pr_debug("omap_hwmod: %s: allocating %d byte linkspace (%d links)\n",
2441 __func__, sz, max_ls);
2443 linkspace = alloc_bootmem(sz);
2445 memset(linkspace, 0, sz);
2450 /* Public functions */
2452 u32 omap_hwmod_read(struct omap_hwmod *oh, u16 reg_offs)
2454 if (oh->flags & HWMOD_16BIT_REG)
2455 return __raw_readw(oh->_mpu_rt_va + reg_offs);
2457 return __raw_readl(oh->_mpu_rt_va + reg_offs);
2460 void omap_hwmod_write(u32 v, struct omap_hwmod *oh, u16 reg_offs)
2462 if (oh->flags & HWMOD_16BIT_REG)
2463 __raw_writew(v, oh->_mpu_rt_va + reg_offs);
2465 __raw_writel(v, oh->_mpu_rt_va + reg_offs);
2469 * omap_hwmod_softreset - reset a module via SYSCONFIG.SOFTRESET bit
2470 * @oh: struct omap_hwmod *
2472 * This is a public function exposed to drivers. Some drivers may need to do
2473 * some settings before and after resetting the device. Those drivers after
2474 * doing the necessary settings could use this function to start a reset by
2475 * setting the SYSCONFIG.SOFTRESET bit.
2477 int omap_hwmod_softreset(struct omap_hwmod *oh)
2482 if (!oh || !(oh->_sysc_cache))
2485 v = oh->_sysc_cache;
2486 ret = _set_softreset(oh, &v);
2489 _write_sysconfig(v, oh);
2496 * omap_hwmod_set_slave_idlemode - set the hwmod's OCP slave idlemode
2497 * @oh: struct omap_hwmod *
2498 * @idlemode: SIDLEMODE field bits (shifted to bit 0)
2500 * Sets the IP block's OCP slave idlemode in hardware, and updates our
2501 * local copy. Intended to be used by drivers that have some erratum
2502 * that requires direct manipulation of the SIDLEMODE bits. Returns
2503 * -EINVAL if @oh is null, or passes along the return value from
2504 * _set_slave_idlemode().
2506 * XXX Does this function have any current users? If not, we should
2507 * remove it; it is better to let the rest of the hwmod code handle this.
2508 * Any users of this function should be scrutinized carefully.
2510 int omap_hwmod_set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode)
2518 v = oh->_sysc_cache;
2520 retval = _set_slave_idlemode(oh, idlemode, &v);
2522 _write_sysconfig(v, oh);
2528 * omap_hwmod_lookup - look up a registered omap_hwmod by name
2529 * @name: name of the omap_hwmod to look up
2531 * Given a @name of an omap_hwmod, return a pointer to the registered
2532 * struct omap_hwmod *, or NULL upon error.
2534 struct omap_hwmod *omap_hwmod_lookup(const char *name)
2536 struct omap_hwmod *oh;
2547 * omap_hwmod_for_each - call function for each registered omap_hwmod
2548 * @fn: pointer to a callback function
2549 * @data: void * data to pass to callback function
2551 * Call @fn for each registered omap_hwmod, passing @data to each
2552 * function. @fn must return 0 for success or any other value for
2553 * failure. If @fn returns non-zero, the iteration across omap_hwmods
2554 * will stop and the non-zero return value will be passed to the
2555 * caller of omap_hwmod_for_each(). @fn is called with
2556 * omap_hwmod_for_each() held.
2558 int omap_hwmod_for_each(int (*fn)(struct omap_hwmod *oh, void *data),
2561 struct omap_hwmod *temp_oh;
2567 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
2568 ret = (*fn)(temp_oh, data);
2577 * omap_hwmod_register_links - register an array of hwmod links
2578 * @ois: pointer to an array of omap_hwmod_ocp_if to register
2580 * Intended to be called early in boot before the clock framework is
2581 * initialized. If @ois is not null, will register all omap_hwmods
2582 * listed in @ois that are valid for this chip. Returns 0.
2584 int __init omap_hwmod_register_links(struct omap_hwmod_ocp_if **ois)
2592 if (_alloc_linkspace(ois)) {
2593 pr_err("omap_hwmod: could not allocate link space\n");
2600 r = _register_link(ois[i]);
2601 WARN(r && r != -EEXIST,
2602 "omap_hwmod: _register_link(%s -> %s) returned %d\n",
2603 ois[i]->master->name, ois[i]->slave->name, r);
2610 * _ensure_mpu_hwmod_is_setup - ensure the MPU SS hwmod is init'ed and set up
2611 * @oh: pointer to the hwmod currently being set up (usually not the MPU)
2613 * If the hwmod data corresponding to the MPU subsystem IP block
2614 * hasn't been initialized and set up yet, do so now. This must be
2615 * done first since sleep dependencies may be added from other hwmods
2616 * to the MPU. Intended to be called only by omap_hwmod_setup*(). No
2619 static void __init _ensure_mpu_hwmod_is_setup(struct omap_hwmod *oh)
2621 if (!mpu_oh || mpu_oh->_state == _HWMOD_STATE_UNKNOWN)
2622 pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",
2623 __func__, MPU_INITIATOR_NAME);
2624 else if (mpu_oh->_state == _HWMOD_STATE_REGISTERED && oh != mpu_oh)
2625 omap_hwmod_setup_one(MPU_INITIATOR_NAME);
2629 * omap_hwmod_setup_one - set up a single hwmod
2630 * @oh_name: const char * name of the already-registered hwmod to set up
2632 * Initialize and set up a single hwmod. Intended to be used for a
2633 * small number of early devices, such as the timer IP blocks used for
2634 * the scheduler clock. Must be called after omap2_clk_init().
2635 * Resolves the struct clk names to struct clk pointers for each
2636 * registered omap_hwmod. Also calls _setup() on each hwmod. Returns
2637 * -EINVAL upon error or 0 upon success.
2639 int __init omap_hwmod_setup_one(const char *oh_name)
2641 struct omap_hwmod *oh;
2643 pr_debug("omap_hwmod: %s: %s\n", oh_name, __func__);
2645 oh = _lookup(oh_name);
2647 WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name);
2651 _ensure_mpu_hwmod_is_setup(oh);
2660 * omap_hwmod_setup_all - set up all registered IP blocks
2662 * Initialize and set up all IP blocks registered with the hwmod code.
2663 * Must be called after omap2_clk_init(). Resolves the struct clk
2664 * names to struct clk pointers for each registered omap_hwmod. Also
2665 * calls _setup() on each hwmod. Returns 0 upon success.
2667 static int __init omap_hwmod_setup_all(void)
2669 _ensure_mpu_hwmod_is_setup(NULL);
2671 omap_hwmod_for_each(_init, NULL);
2672 omap_hwmod_for_each(_setup, NULL);
2676 core_initcall(omap_hwmod_setup_all);
2679 * omap_hwmod_enable - enable an omap_hwmod
2680 * @oh: struct omap_hwmod *
2682 * Enable an omap_hwmod @oh. Intended to be called by omap_device_enable().
2683 * Returns -EINVAL on error or passes along the return value from _enable().
2685 int omap_hwmod_enable(struct omap_hwmod *oh)
2688 unsigned long flags;
2693 spin_lock_irqsave(&oh->_lock, flags);
2695 spin_unlock_irqrestore(&oh->_lock, flags);
2701 * omap_hwmod_idle - idle an omap_hwmod
2702 * @oh: struct omap_hwmod *
2704 * Idle an omap_hwmod @oh. Intended to be called by omap_device_idle().
2705 * Returns -EINVAL on error or passes along the return value from _idle().
2707 int omap_hwmod_idle(struct omap_hwmod *oh)
2709 unsigned long flags;
2714 spin_lock_irqsave(&oh->_lock, flags);
2716 spin_unlock_irqrestore(&oh->_lock, flags);
2722 * omap_hwmod_shutdown - shutdown an omap_hwmod
2723 * @oh: struct omap_hwmod *
2725 * Shutdown an omap_hwmod @oh. Intended to be called by
2726 * omap_device_shutdown(). Returns -EINVAL on error or passes along
2727 * the return value from _shutdown().
2729 int omap_hwmod_shutdown(struct omap_hwmod *oh)
2731 unsigned long flags;
2736 spin_lock_irqsave(&oh->_lock, flags);
2738 spin_unlock_irqrestore(&oh->_lock, flags);
2744 * omap_hwmod_enable_clocks - enable main_clk, all interface clocks
2745 * @oh: struct omap_hwmod *oh
2747 * Intended to be called by the omap_device code.
2749 int omap_hwmod_enable_clocks(struct omap_hwmod *oh)
2751 unsigned long flags;
2753 spin_lock_irqsave(&oh->_lock, flags);
2755 spin_unlock_irqrestore(&oh->_lock, flags);
2761 * omap_hwmod_disable_clocks - disable main_clk, all interface clocks
2762 * @oh: struct omap_hwmod *oh
2764 * Intended to be called by the omap_device code.
2766 int omap_hwmod_disable_clocks(struct omap_hwmod *oh)
2768 unsigned long flags;
2770 spin_lock_irqsave(&oh->_lock, flags);
2771 _disable_clocks(oh);
2772 spin_unlock_irqrestore(&oh->_lock, flags);
2778 * omap_hwmod_ocp_barrier - wait for posted writes against the hwmod to complete
2779 * @oh: struct omap_hwmod *oh
2781 * Intended to be called by drivers and core code when all posted
2782 * writes to a device must complete before continuing further
2783 * execution (for example, after clearing some device IRQSTATUS
2786 * XXX what about targets with multiple OCP threads?
2788 void omap_hwmod_ocp_barrier(struct omap_hwmod *oh)
2792 if (!oh->class->sysc || !oh->class->sysc->sysc_flags) {
2793 WARN(1, "omap_device: %s: OCP barrier impossible due to device configuration\n",
2799 * Forces posted writes to complete on the OCP thread handling
2802 omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
2806 * omap_hwmod_reset - reset the hwmod
2807 * @oh: struct omap_hwmod *
2809 * Under some conditions, a driver may wish to reset the entire device.
2810 * Called from omap_device code. Returns -EINVAL on error or passes along
2811 * the return value from _reset().
2813 int omap_hwmod_reset(struct omap_hwmod *oh)
2816 unsigned long flags;
2821 spin_lock_irqsave(&oh->_lock, flags);
2823 spin_unlock_irqrestore(&oh->_lock, flags);
2829 * IP block data retrieval functions
2833 * omap_hwmod_count_resources - count number of struct resources needed by hwmod
2834 * @oh: struct omap_hwmod *
2835 * @res: pointer to the first element of an array of struct resource to fill
2837 * Count the number of struct resource array elements necessary to
2838 * contain omap_hwmod @oh resources. Intended to be called by code
2839 * that registers omap_devices. Intended to be used to determine the
2840 * size of a dynamically-allocated struct resource array, before
2841 * calling omap_hwmod_fill_resources(). Returns the number of struct
2842 * resource array elements needed.
2844 * XXX This code is not optimized. It could attempt to merge adjacent
2848 int omap_hwmod_count_resources(struct omap_hwmod *oh)
2850 struct omap_hwmod_ocp_if *os;
2851 struct list_head *p;
2855 ret = _count_mpu_irqs(oh) + _count_sdma_reqs(oh);
2857 p = oh->slave_ports.next;
2859 while (i < oh->slaves_cnt) {
2860 os = _fetch_next_ocp_if(&p, &i);
2861 ret += _count_ocp_if_addr_spaces(os);
2868 * omap_hwmod_fill_resources - fill struct resource array with hwmod data
2869 * @oh: struct omap_hwmod *
2870 * @res: pointer to the first element of an array of struct resource to fill
2872 * Fill the struct resource array @res with resource data from the
2873 * omap_hwmod @oh. Intended to be called by code that registers
2874 * omap_devices. See also omap_hwmod_count_resources(). Returns the
2875 * number of array elements filled.
2877 int omap_hwmod_fill_resources(struct omap_hwmod *oh, struct resource *res)
2879 struct omap_hwmod_ocp_if *os;
2880 struct list_head *p;
2881 int i, j, mpu_irqs_cnt, sdma_reqs_cnt, addr_cnt;
2884 /* For each IRQ, DMA, memory area, fill in array.*/
2886 mpu_irqs_cnt = _count_mpu_irqs(oh);
2887 for (i = 0; i < mpu_irqs_cnt; i++) {
2888 (res + r)->name = (oh->mpu_irqs + i)->name;
2889 (res + r)->start = (oh->mpu_irqs + i)->irq;
2890 (res + r)->end = (oh->mpu_irqs + i)->irq;
2891 (res + r)->flags = IORESOURCE_IRQ;
2895 sdma_reqs_cnt = _count_sdma_reqs(oh);
2896 for (i = 0; i < sdma_reqs_cnt; i++) {
2897 (res + r)->name = (oh->sdma_reqs + i)->name;
2898 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
2899 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
2900 (res + r)->flags = IORESOURCE_DMA;
2904 p = oh->slave_ports.next;
2907 while (i < oh->slaves_cnt) {
2908 os = _fetch_next_ocp_if(&p, &i);
2909 addr_cnt = _count_ocp_if_addr_spaces(os);
2911 for (j = 0; j < addr_cnt; j++) {
2912 (res + r)->name = (os->addr + j)->name;
2913 (res + r)->start = (os->addr + j)->pa_start;
2914 (res + r)->end = (os->addr + j)->pa_end;
2915 (res + r)->flags = IORESOURCE_MEM;
2924 * omap_hwmod_get_resource_byname - fetch IP block integration data by name
2925 * @oh: struct omap_hwmod * to operate on
2926 * @type: one of the IORESOURCE_* constants from include/linux/ioport.h
2927 * @name: pointer to the name of the data to fetch (optional)
2928 * @rsrc: pointer to a struct resource, allocated by the caller
2930 * Retrieve MPU IRQ, SDMA request line, or address space start/end
2931 * data for the IP block pointed to by @oh. The data will be filled
2932 * into a struct resource record pointed to by @rsrc. The struct
2933 * resource must be allocated by the caller. When @name is non-null,
2934 * the data associated with the matching entry in the IRQ/SDMA/address
2935 * space hwmod data arrays will be returned. If @name is null, the
2936 * first array entry will be returned. Data order is not meaningful
2937 * in hwmod data, so callers are strongly encouraged to use a non-null
2938 * @name whenever possible to avoid unpredictable effects if hwmod
2939 * data is later added that causes data ordering to change. This
2940 * function is only intended for use by OMAP core code. Device
2941 * drivers should not call this function - the appropriate bus-related
2942 * data accessor functions should be used instead. Returns 0 upon
2943 * success or a negative error code upon error.
2945 int omap_hwmod_get_resource_byname(struct omap_hwmod *oh, unsigned int type,
2946 const char *name, struct resource *rsrc)
2949 unsigned int irq, dma;
2950 u32 pa_start, pa_end;
2955 if (type == IORESOURCE_IRQ) {
2956 r = _get_mpu_irq_by_name(oh, name, &irq);
2962 } else if (type == IORESOURCE_DMA) {
2963 r = _get_sdma_req_by_name(oh, name, &dma);
2969 } else if (type == IORESOURCE_MEM) {
2970 r = _get_addr_space_by_name(oh, name, &pa_start, &pa_end);
2974 rsrc->start = pa_start;
2987 * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
2988 * @oh: struct omap_hwmod *
2990 * Return the powerdomain pointer associated with the OMAP module
2991 * @oh's main clock. If @oh does not have a main clk, return the
2992 * powerdomain associated with the interface clock associated with the
2993 * module's MPU port. (XXX Perhaps this should use the SDMA port
2994 * instead?) Returns NULL on error, or a struct powerdomain * on
2997 struct powerdomain *omap_hwmod_get_pwrdm(struct omap_hwmod *oh)
3000 struct omap_hwmod_ocp_if *oi;
3008 oi = _find_mpu_rt_port(oh);
3017 return c->clkdm->pwrdm.ptr;
3022 * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
3023 * @oh: struct omap_hwmod *
3025 * Returns the virtual address corresponding to the beginning of the
3026 * module's register target, in the address range that is intended to
3027 * be used by the MPU. Returns the virtual address upon success or NULL
3030 void __iomem *omap_hwmod_get_mpu_rt_va(struct omap_hwmod *oh)
3035 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
3038 if (oh->_state == _HWMOD_STATE_UNKNOWN)
3041 return oh->_mpu_rt_va;
3045 * omap_hwmod_add_initiator_dep - add sleepdep from @init_oh to @oh
3046 * @oh: struct omap_hwmod *
3047 * @init_oh: struct omap_hwmod * (initiator)
3049 * Add a sleep dependency between the initiator @init_oh and @oh.
3050 * Intended to be called by DSP/Bridge code via platform_data for the
3051 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
3052 * code needs to add/del initiator dependencies dynamically
3053 * before/after accessing a device. Returns the return value from
3054 * _add_initiator_dep().
3056 * XXX Keep a usecount in the clockdomain code
3058 int omap_hwmod_add_initiator_dep(struct omap_hwmod *oh,
3059 struct omap_hwmod *init_oh)
3061 return _add_initiator_dep(oh, init_oh);
3065 * XXX what about functions for drivers to save/restore ocp_sysconfig
3066 * for context save/restore operations?
3070 * omap_hwmod_del_initiator_dep - remove sleepdep from @init_oh to @oh
3071 * @oh: struct omap_hwmod *
3072 * @init_oh: struct omap_hwmod * (initiator)
3074 * Remove a sleep dependency between the initiator @init_oh and @oh.
3075 * Intended to be called by DSP/Bridge code via platform_data for the
3076 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
3077 * code needs to add/del initiator dependencies dynamically
3078 * before/after accessing a device. Returns the return value from
3079 * _del_initiator_dep().
3081 * XXX Keep a usecount in the clockdomain code
3083 int omap_hwmod_del_initiator_dep(struct omap_hwmod *oh,
3084 struct omap_hwmod *init_oh)
3086 return _del_initiator_dep(oh, init_oh);
3090 * omap_hwmod_enable_wakeup - allow device to wake up the system
3091 * @oh: struct omap_hwmod *
3093 * Sets the module OCP socket ENAWAKEUP bit to allow the module to
3094 * send wakeups to the PRCM, and enable I/O ring wakeup events for
3095 * this IP block if it has dynamic mux entries. Eventually this
3096 * should set PRCM wakeup registers to cause the PRCM to receive
3097 * wakeup events from the module. Does not set any wakeup routing
3098 * registers beyond this point - if the module is to wake up any other
3099 * module or subsystem, that must be set separately. Called by
3100 * omap_device code. Returns -EINVAL on error or 0 upon success.
3102 int omap_hwmod_enable_wakeup(struct omap_hwmod *oh)
3104 unsigned long flags;
3107 spin_lock_irqsave(&oh->_lock, flags);
3109 if (oh->class->sysc &&
3110 (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)) {
3111 v = oh->_sysc_cache;
3112 _enable_wakeup(oh, &v);
3113 _write_sysconfig(v, oh);
3116 _set_idle_ioring_wakeup(oh, true);
3117 spin_unlock_irqrestore(&oh->_lock, flags);
3123 * omap_hwmod_disable_wakeup - prevent device from waking the system
3124 * @oh: struct omap_hwmod *
3126 * Clears the module OCP socket ENAWAKEUP bit to prevent the module
3127 * from sending wakeups to the PRCM, and disable I/O ring wakeup
3128 * events for this IP block if it has dynamic mux entries. Eventually
3129 * this should clear PRCM wakeup registers to cause the PRCM to ignore
3130 * wakeup events from the module. Does not set any wakeup routing
3131 * registers beyond this point - if the module is to wake up any other
3132 * module or subsystem, that must be set separately. Called by
3133 * omap_device code. Returns -EINVAL on error or 0 upon success.
3135 int omap_hwmod_disable_wakeup(struct omap_hwmod *oh)
3137 unsigned long flags;
3140 spin_lock_irqsave(&oh->_lock, flags);
3142 if (oh->class->sysc &&
3143 (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)) {
3144 v = oh->_sysc_cache;
3145 _disable_wakeup(oh, &v);
3146 _write_sysconfig(v, oh);
3149 _set_idle_ioring_wakeup(oh, false);
3150 spin_unlock_irqrestore(&oh->_lock, flags);
3156 * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
3157 * contained in the hwmod module.
3158 * @oh: struct omap_hwmod *
3159 * @name: name of the reset line to lookup and assert
3161 * Some IP like dsp, ipu or iva contain processor that require
3162 * an HW reset line to be assert / deassert in order to enable fully
3163 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3164 * yet supported on this OMAP; otherwise, passes along the return value
3165 * from _assert_hardreset().
3167 int omap_hwmod_assert_hardreset(struct omap_hwmod *oh, const char *name)
3170 unsigned long flags;
3175 spin_lock_irqsave(&oh->_lock, flags);
3176 ret = _assert_hardreset(oh, name);
3177 spin_unlock_irqrestore(&oh->_lock, flags);
3183 * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
3184 * contained in the hwmod module.
3185 * @oh: struct omap_hwmod *
3186 * @name: name of the reset line to look up and deassert
3188 * Some IP like dsp, ipu or iva contain processor that require
3189 * an HW reset line to be assert / deassert in order to enable fully
3190 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3191 * yet supported on this OMAP; otherwise, passes along the return value
3192 * from _deassert_hardreset().
3194 int omap_hwmod_deassert_hardreset(struct omap_hwmod *oh, const char *name)
3197 unsigned long flags;
3202 spin_lock_irqsave(&oh->_lock, flags);
3203 ret = _deassert_hardreset(oh, name);
3204 spin_unlock_irqrestore(&oh->_lock, flags);
3210 * omap_hwmod_read_hardreset - read the HW reset line state of submodules
3211 * contained in the hwmod module
3212 * @oh: struct omap_hwmod *
3213 * @name: name of the reset line to look up and read
3215 * Return the current state of the hwmod @oh's reset line named @name:
3216 * returns -EINVAL upon parameter error or if this operation
3217 * is unsupported on the current OMAP; otherwise, passes along the return
3218 * value from _read_hardreset().
3220 int omap_hwmod_read_hardreset(struct omap_hwmod *oh, const char *name)
3223 unsigned long flags;
3228 spin_lock_irqsave(&oh->_lock, flags);
3229 ret = _read_hardreset(oh, name);
3230 spin_unlock_irqrestore(&oh->_lock, flags);
3237 * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
3238 * @classname: struct omap_hwmod_class name to search for
3239 * @fn: callback function pointer to call for each hwmod in class @classname
3240 * @user: arbitrary context data to pass to the callback function
3242 * For each omap_hwmod of class @classname, call @fn.
3243 * If the callback function returns something other than
3244 * zero, the iterator is terminated, and the callback function's return
3245 * value is passed back to the caller. Returns 0 upon success, -EINVAL
3246 * if @classname or @fn are NULL, or passes back the error code from @fn.
3248 int omap_hwmod_for_each_by_class(const char *classname,
3249 int (*fn)(struct omap_hwmod *oh,
3253 struct omap_hwmod *temp_oh;
3256 if (!classname || !fn)
3259 pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
3260 __func__, classname);
3262 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
3263 if (!strcmp(temp_oh->class->name, classname)) {
3264 pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
3265 __func__, temp_oh->name);
3266 ret = (*fn)(temp_oh, user);
3273 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
3280 * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
3281 * @oh: struct omap_hwmod *
3282 * @state: state that _setup() should leave the hwmod in
3284 * Sets the hwmod state that @oh will enter at the end of _setup()
3285 * (called by omap_hwmod_setup_*()). See also the documentation
3286 * for _setup_postsetup(), above. Returns 0 upon success or
3287 * -EINVAL if there is a problem with the arguments or if the hwmod is
3288 * in the wrong state.
3290 int omap_hwmod_set_postsetup_state(struct omap_hwmod *oh, u8 state)
3293 unsigned long flags;
3298 if (state != _HWMOD_STATE_DISABLED &&
3299 state != _HWMOD_STATE_ENABLED &&
3300 state != _HWMOD_STATE_IDLE)
3303 spin_lock_irqsave(&oh->_lock, flags);
3305 if (oh->_state != _HWMOD_STATE_REGISTERED) {
3310 oh->_postsetup_state = state;
3314 spin_unlock_irqrestore(&oh->_lock, flags);
3320 * omap_hwmod_get_context_loss_count - get lost context count
3321 * @oh: struct omap_hwmod *
3323 * Query the powerdomain of of @oh to get the context loss
3324 * count for this device.
3326 * Returns the context loss count of the powerdomain assocated with @oh
3327 * upon success, or zero if no powerdomain exists for @oh.
3329 int omap_hwmod_get_context_loss_count(struct omap_hwmod *oh)
3331 struct powerdomain *pwrdm;
3334 pwrdm = omap_hwmod_get_pwrdm(oh);
3336 ret = pwrdm_get_context_loss_count(pwrdm);
3342 * omap_hwmod_no_setup_reset - prevent a hwmod from being reset upon setup
3343 * @oh: struct omap_hwmod *
3345 * Prevent the hwmod @oh from being reset during the setup process.
3346 * Intended for use by board-*.c files on boards with devices that
3347 * cannot tolerate being reset. Must be called before the hwmod has
3348 * been set up. Returns 0 upon success or negative error code upon
3351 int omap_hwmod_no_setup_reset(struct omap_hwmod *oh)
3356 if (oh->_state != _HWMOD_STATE_REGISTERED) {
3357 pr_err("omap_hwmod: %s: cannot prevent setup reset; in wrong state\n",
3362 oh->flags |= HWMOD_INIT_NO_RESET;
3368 * omap_hwmod_pad_route_irq - route an I/O pad wakeup to a particular MPU IRQ
3369 * @oh: struct omap_hwmod * containing hwmod mux entries
3370 * @pad_idx: array index in oh->mux of the hwmod mux entry to route wakeup
3371 * @irq_idx: the hwmod mpu_irqs array index of the IRQ to trigger on wakeup
3373 * When an I/O pad wakeup arrives for the dynamic or wakeup hwmod mux
3374 * entry number @pad_idx for the hwmod @oh, trigger the interrupt
3375 * service routine for the hwmod's mpu_irqs array index @irq_idx. If
3376 * this function is not called for a given pad_idx, then the ISR
3377 * associated with @oh's first MPU IRQ will be triggered when an I/O
3378 * pad wakeup occurs on that pad. Note that @pad_idx is the index of
3379 * the _dynamic or wakeup_ entry: if there are other entries not
3380 * marked with OMAP_DEVICE_PAD_WAKEUP or OMAP_DEVICE_PAD_REMUX, these
3381 * entries are NOT COUNTED in the dynamic pad index. This function
3382 * must be called separately for each pad that requires its interrupt
3383 * to be re-routed this way. Returns -EINVAL if there is an argument
3384 * problem or if @oh does not have hwmod mux entries or MPU IRQs;
3385 * returns -ENOMEM if memory cannot be allocated; or 0 upon success.
3387 * XXX This function interface is fragile. Rather than using array
3388 * indexes, which are subject to unpredictable change, it should be
3389 * using hwmod IRQ names, and some other stable key for the hwmod mux
3392 int omap_hwmod_pad_route_irq(struct omap_hwmod *oh, int pad_idx, int irq_idx)
3398 if (!oh || !oh->mux || !oh->mpu_irqs || pad_idx < 0 ||
3399 pad_idx >= oh->mux->nr_pads_dynamic)
3402 /* Check the number of available mpu_irqs */
3403 for (nr_irqs = 0; oh->mpu_irqs[nr_irqs].irq >= 0; nr_irqs++)
3406 if (irq_idx >= nr_irqs)
3409 if (!oh->mux->irqs) {
3410 /* XXX What frees this? */
3411 oh->mux->irqs = kzalloc(sizeof(int) * oh->mux->nr_pads_dynamic,
3416 oh->mux->irqs[pad_idx] = irq_idx;