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
170 * struct omap_hwmod_soc_ops - fn ptrs for some SoC-specific operations
171 * @enable_module: function to enable a module (via MODULEMODE)
172 * @disable_module: function to disable a module (via MODULEMODE)
174 * XXX Eventually this functionality will be hidden inside the PRM/CM
175 * device drivers. Until then, this should avoid huge blocks of cpu_is_*()
176 * conditionals in this code.
178 struct omap_hwmod_soc_ops {
179 void (*enable_module)(struct omap_hwmod *oh);
180 int (*disable_module)(struct omap_hwmod *oh);
181 int (*wait_target_ready)(struct omap_hwmod *oh);
182 int (*assert_hardreset)(struct omap_hwmod *oh,
183 struct omap_hwmod_rst_info *ohri);
184 int (*deassert_hardreset)(struct omap_hwmod *oh,
185 struct omap_hwmod_rst_info *ohri);
186 int (*is_hardreset_asserted)(struct omap_hwmod *oh,
187 struct omap_hwmod_rst_info *ohri);
188 int (*init_clkdm)(struct omap_hwmod *oh);
191 /* soc_ops: adapts the omap_hwmod code to the currently-booted SoC */
192 static struct omap_hwmod_soc_ops soc_ops;
194 /* omap_hwmod_list contains all registered struct omap_hwmods */
195 static LIST_HEAD(omap_hwmod_list);
197 /* mpu_oh: used to add/remove MPU initiator from sleepdep list */
198 static struct omap_hwmod *mpu_oh;
201 * linkspace: ptr to a buffer that struct omap_hwmod_link records are
202 * allocated from - used to reduce the number of small memory
203 * allocations, which has a significant impact on performance
205 static struct omap_hwmod_link *linkspace;
208 * free_ls, max_ls: array indexes into linkspace; representing the
209 * next free struct omap_hwmod_link index, and the maximum number of
210 * struct omap_hwmod_link records allocated (respectively)
212 static unsigned short free_ls, max_ls, ls_supp;
214 /* inited: set to true once the hwmod code is initialized */
217 /* Private functions */
220 * _fetch_next_ocp_if - return the next OCP interface in a list
221 * @p: ptr to a ptr to the list_head inside the ocp_if to return
222 * @i: pointer to the index of the element pointed to by @p in the list
224 * Return a pointer to the struct omap_hwmod_ocp_if record
225 * containing the struct list_head pointed to by @p, and increment
226 * @p such that a future call to this routine will return the next
229 static struct omap_hwmod_ocp_if *_fetch_next_ocp_if(struct list_head **p,
232 struct omap_hwmod_ocp_if *oi;
234 oi = list_entry(*p, struct omap_hwmod_link, node)->ocp_if;
243 * _update_sysc_cache - return the module OCP_SYSCONFIG register, keep copy
244 * @oh: struct omap_hwmod *
246 * Load the current value of the hwmod OCP_SYSCONFIG register into the
247 * struct omap_hwmod for later use. Returns -EINVAL if the hwmod has no
248 * OCP_SYSCONFIG register or 0 upon success.
250 static int _update_sysc_cache(struct omap_hwmod *oh)
252 if (!oh->class->sysc) {
253 WARN(1, "omap_hwmod: %s: cannot read OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
257 /* XXX ensure module interface clock is up */
259 oh->_sysc_cache = omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
261 if (!(oh->class->sysc->sysc_flags & SYSC_NO_CACHE))
262 oh->_int_flags |= _HWMOD_SYSCONFIG_LOADED;
268 * _write_sysconfig - write a value to the module's OCP_SYSCONFIG register
269 * @v: OCP_SYSCONFIG value to write
270 * @oh: struct omap_hwmod *
272 * Write @v into the module class' OCP_SYSCONFIG register, if it has
273 * one. No return value.
275 static void _write_sysconfig(u32 v, struct omap_hwmod *oh)
277 if (!oh->class->sysc) {
278 WARN(1, "omap_hwmod: %s: cannot write OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
282 /* XXX ensure module interface clock is up */
284 /* Module might have lost context, always update cache and register */
286 omap_hwmod_write(v, oh, oh->class->sysc->sysc_offs);
290 * _set_master_standbymode: set the OCP_SYSCONFIG MIDLEMODE field in @v
291 * @oh: struct omap_hwmod *
292 * @standbymode: MIDLEMODE field bits
293 * @v: pointer to register contents to modify
295 * Update the master standby mode bits in @v to be @standbymode for
296 * the @oh hwmod. Does not write to the hardware. Returns -EINVAL
297 * upon error or 0 upon success.
299 static int _set_master_standbymode(struct omap_hwmod *oh, u8 standbymode,
305 if (!oh->class->sysc ||
306 !(oh->class->sysc->sysc_flags & SYSC_HAS_MIDLEMODE))
309 if (!oh->class->sysc->sysc_fields) {
310 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
314 mstandby_shift = oh->class->sysc->sysc_fields->midle_shift;
315 mstandby_mask = (0x3 << mstandby_shift);
317 *v &= ~mstandby_mask;
318 *v |= __ffs(standbymode) << mstandby_shift;
324 * _set_slave_idlemode: set the OCP_SYSCONFIG SIDLEMODE field in @v
325 * @oh: struct omap_hwmod *
326 * @idlemode: SIDLEMODE field bits
327 * @v: pointer to register contents to modify
329 * Update the slave idle mode bits in @v to be @idlemode for the @oh
330 * hwmod. Does not write to the hardware. Returns -EINVAL upon error
333 static int _set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode, u32 *v)
338 if (!oh->class->sysc ||
339 !(oh->class->sysc->sysc_flags & SYSC_HAS_SIDLEMODE))
342 if (!oh->class->sysc->sysc_fields) {
343 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
347 sidle_shift = oh->class->sysc->sysc_fields->sidle_shift;
348 sidle_mask = (0x3 << sidle_shift);
351 *v |= __ffs(idlemode) << sidle_shift;
357 * _set_clockactivity: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
358 * @oh: struct omap_hwmod *
359 * @clockact: CLOCKACTIVITY field bits
360 * @v: pointer to register contents to modify
362 * Update the clockactivity mode bits in @v to be @clockact for the
363 * @oh hwmod. Used for additional powersaving on some modules. Does
364 * not write to the hardware. Returns -EINVAL upon error or 0 upon
367 static int _set_clockactivity(struct omap_hwmod *oh, u8 clockact, u32 *v)
372 if (!oh->class->sysc ||
373 !(oh->class->sysc->sysc_flags & SYSC_HAS_CLOCKACTIVITY))
376 if (!oh->class->sysc->sysc_fields) {
377 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
381 clkact_shift = oh->class->sysc->sysc_fields->clkact_shift;
382 clkact_mask = (0x3 << clkact_shift);
385 *v |= clockact << clkact_shift;
391 * _set_softreset: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
392 * @oh: struct omap_hwmod *
393 * @v: pointer to register contents to modify
395 * Set the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
396 * error or 0 upon success.
398 static int _set_softreset(struct omap_hwmod *oh, u32 *v)
402 if (!oh->class->sysc ||
403 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
406 if (!oh->class->sysc->sysc_fields) {
407 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
411 softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
419 * _set_dmadisable: set OCP_SYSCONFIG.DMADISABLE bit in @v
420 * @oh: struct omap_hwmod *
422 * The DMADISABLE bit is a semi-automatic bit present in sysconfig register
423 * of some modules. When the DMA must perform read/write accesses, the
424 * DMADISABLE bit is cleared by the hardware. But when the DMA must stop
425 * for power management, software must set the DMADISABLE bit back to 1.
427 * Set the DMADISABLE bit in @v for hwmod @oh. Returns -EINVAL upon
428 * error or 0 upon success.
430 static int _set_dmadisable(struct omap_hwmod *oh)
435 if (!oh->class->sysc ||
436 !(oh->class->sysc->sysc_flags & SYSC_HAS_DMADISABLE))
439 if (!oh->class->sysc->sysc_fields) {
440 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
444 /* clocks must be on for this operation */
445 if (oh->_state != _HWMOD_STATE_ENABLED) {
446 pr_warn("omap_hwmod: %s: dma can be disabled only from enabled state\n", oh->name);
450 pr_debug("omap_hwmod: %s: setting DMADISABLE\n", oh->name);
454 (0x1 << oh->class->sysc->sysc_fields->dmadisable_shift);
455 v |= dmadisable_mask;
456 _write_sysconfig(v, oh);
462 * _set_module_autoidle: set the OCP_SYSCONFIG AUTOIDLE field in @v
463 * @oh: struct omap_hwmod *
464 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
465 * @v: pointer to register contents to modify
467 * Update the module autoidle bit in @v to be @autoidle for the @oh
468 * hwmod. The autoidle bit controls whether the module can gate
469 * internal clocks automatically when it isn't doing anything; the
470 * exact function of this bit varies on a per-module basis. This
471 * function does not write to the hardware. Returns -EINVAL upon
472 * error or 0 upon success.
474 static int _set_module_autoidle(struct omap_hwmod *oh, u8 autoidle,
480 if (!oh->class->sysc ||
481 !(oh->class->sysc->sysc_flags & SYSC_HAS_AUTOIDLE))
484 if (!oh->class->sysc->sysc_fields) {
485 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
489 autoidle_shift = oh->class->sysc->sysc_fields->autoidle_shift;
490 autoidle_mask = (0x1 << autoidle_shift);
492 *v &= ~autoidle_mask;
493 *v |= autoidle << autoidle_shift;
499 * _set_idle_ioring_wakeup - enable/disable IO pad wakeup on hwmod idle for mux
500 * @oh: struct omap_hwmod *
501 * @set_wake: bool value indicating to set (true) or clear (false) wakeup enable
503 * Set or clear the I/O pad wakeup flag in the mux entries for the
504 * hwmod @oh. This function changes the @oh->mux->pads_dynamic array
505 * in memory. If the hwmod is currently idled, and the new idle
506 * values don't match the previous ones, this function will also
507 * update the SCM PADCTRL registers. Otherwise, if the hwmod is not
508 * currently idled, this function won't touch the hardware: the new
509 * mux settings are written to the SCM PADCTRL registers when the
510 * hwmod is idled. No return value.
512 static void _set_idle_ioring_wakeup(struct omap_hwmod *oh, bool set_wake)
514 struct omap_device_pad *pad;
519 if (!oh->mux || !oh->mux->enabled)
522 for (j = 0; j < oh->mux->nr_pads_dynamic; j++) {
523 pad = oh->mux->pads_dynamic[j];
525 if (!(pad->flags & OMAP_DEVICE_PAD_WAKEUP))
528 prev_idle = pad->idle;
531 pad->idle |= OMAP_WAKEUP_EN;
533 pad->idle &= ~OMAP_WAKEUP_EN;
535 if (prev_idle != pad->idle)
539 if (change && oh->_state == _HWMOD_STATE_IDLE)
540 omap_hwmod_mux(oh->mux, _HWMOD_STATE_IDLE);
544 * _enable_wakeup: set OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
545 * @oh: struct omap_hwmod *
547 * Allow the hardware module @oh to send wakeups. Returns -EINVAL
548 * upon error or 0 upon success.
550 static int _enable_wakeup(struct omap_hwmod *oh, u32 *v)
552 if (!oh->class->sysc ||
553 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
554 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
555 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
558 if (!oh->class->sysc->sysc_fields) {
559 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
563 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
564 *v |= 0x1 << oh->class->sysc->sysc_fields->enwkup_shift;
566 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
567 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
568 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
569 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
571 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
573 oh->_int_flags |= _HWMOD_WAKEUP_ENABLED;
579 * _disable_wakeup: clear OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
580 * @oh: struct omap_hwmod *
582 * Prevent the hardware module @oh to send wakeups. Returns -EINVAL
583 * upon error or 0 upon success.
585 static int _disable_wakeup(struct omap_hwmod *oh, u32 *v)
587 if (!oh->class->sysc ||
588 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
589 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
590 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
593 if (!oh->class->sysc->sysc_fields) {
594 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
598 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
599 *v &= ~(0x1 << oh->class->sysc->sysc_fields->enwkup_shift);
601 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
602 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART, v);
603 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
604 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART, v);
606 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
608 oh->_int_flags &= ~_HWMOD_WAKEUP_ENABLED;
614 * _add_initiator_dep: prevent @oh from smart-idling while @init_oh is active
615 * @oh: struct omap_hwmod *
617 * Prevent the hardware module @oh from entering idle while the
618 * hardare module initiator @init_oh is active. Useful when a module
619 * will be accessed by a particular initiator (e.g., if a module will
620 * be accessed by the IVA, there should be a sleepdep between the IVA
621 * initiator and the module). Only applies to modules in smart-idle
622 * mode. If the clockdomain is marked as not needing autodeps, return
623 * 0 without doing anything. Otherwise, returns -EINVAL upon error or
624 * passes along clkdm_add_sleepdep() value upon success.
626 static int _add_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
631 if (oh->_clk->clkdm && oh->_clk->clkdm->flags & CLKDM_NO_AUTODEPS)
634 return clkdm_add_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
638 * _del_initiator_dep: allow @oh to smart-idle even if @init_oh is active
639 * @oh: struct omap_hwmod *
641 * Allow the hardware module @oh to enter idle while the hardare
642 * module initiator @init_oh is active. Useful when a module will not
643 * be accessed by a particular initiator (e.g., if a module will not
644 * be accessed by the IVA, there should be no sleepdep between the IVA
645 * initiator and the module). Only applies to modules in smart-idle
646 * mode. If the clockdomain is marked as not needing autodeps, return
647 * 0 without doing anything. Returns -EINVAL upon error or passes
648 * along clkdm_del_sleepdep() value upon success.
650 static int _del_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
655 if (oh->_clk->clkdm && oh->_clk->clkdm->flags & CLKDM_NO_AUTODEPS)
658 return clkdm_del_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
662 * _init_main_clk - get a struct clk * for the the hwmod's main functional clk
663 * @oh: struct omap_hwmod *
665 * Called from _init_clocks(). Populates the @oh _clk (main
666 * functional clock pointer) if a main_clk is present. Returns 0 on
667 * success or -EINVAL on error.
669 static int _init_main_clk(struct omap_hwmod *oh)
676 oh->_clk = omap_clk_get_by_name(oh->main_clk);
678 pr_warning("omap_hwmod: %s: cannot clk_get main_clk %s\n",
679 oh->name, oh->main_clk);
683 if (!oh->_clk->clkdm)
684 pr_warning("omap_hwmod: %s: missing clockdomain for %s.\n",
685 oh->main_clk, oh->_clk->name);
691 * _init_interface_clks - get a struct clk * for the the hwmod's interface clks
692 * @oh: struct omap_hwmod *
694 * Called from _init_clocks(). Populates the @oh OCP slave interface
695 * clock pointers. Returns 0 on success or -EINVAL on error.
697 static int _init_interface_clks(struct omap_hwmod *oh)
699 struct omap_hwmod_ocp_if *os;
705 p = oh->slave_ports.next;
707 while (i < oh->slaves_cnt) {
708 os = _fetch_next_ocp_if(&p, &i);
712 c = omap_clk_get_by_name(os->clk);
714 pr_warning("omap_hwmod: %s: cannot clk_get interface_clk %s\n",
725 * _init_opt_clk - get a struct clk * for the the hwmod's optional clocks
726 * @oh: struct omap_hwmod *
728 * Called from _init_clocks(). Populates the @oh omap_hwmod_opt_clk
729 * clock pointers. Returns 0 on success or -EINVAL on error.
731 static int _init_opt_clks(struct omap_hwmod *oh)
733 struct omap_hwmod_opt_clk *oc;
738 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++) {
739 c = omap_clk_get_by_name(oc->clk);
741 pr_warning("omap_hwmod: %s: cannot clk_get opt_clk %s\n",
752 * _enable_clocks - enable hwmod main clock and interface clocks
753 * @oh: struct omap_hwmod *
755 * Enables all clocks necessary for register reads and writes to succeed
756 * on the hwmod @oh. Returns 0.
758 static int _enable_clocks(struct omap_hwmod *oh)
760 struct omap_hwmod_ocp_if *os;
764 pr_debug("omap_hwmod: %s: enabling clocks\n", oh->name);
767 clk_enable(oh->_clk);
769 p = oh->slave_ports.next;
771 while (i < oh->slaves_cnt) {
772 os = _fetch_next_ocp_if(&p, &i);
774 if (os->_clk && (os->flags & OCPIF_SWSUP_IDLE))
775 clk_enable(os->_clk);
778 /* The opt clocks are controlled by the device driver. */
784 * _disable_clocks - disable hwmod main clock and interface clocks
785 * @oh: struct omap_hwmod *
787 * Disables the hwmod @oh main functional and interface clocks. Returns 0.
789 static int _disable_clocks(struct omap_hwmod *oh)
791 struct omap_hwmod_ocp_if *os;
795 pr_debug("omap_hwmod: %s: disabling clocks\n", oh->name);
798 clk_disable(oh->_clk);
800 p = oh->slave_ports.next;
802 while (i < oh->slaves_cnt) {
803 os = _fetch_next_ocp_if(&p, &i);
805 if (os->_clk && (os->flags & OCPIF_SWSUP_IDLE))
806 clk_disable(os->_clk);
809 /* The opt clocks are controlled by the device driver. */
814 static void _enable_optional_clocks(struct omap_hwmod *oh)
816 struct omap_hwmod_opt_clk *oc;
819 pr_debug("omap_hwmod: %s: enabling optional clocks\n", oh->name);
821 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
823 pr_debug("omap_hwmod: enable %s:%s\n", oc->role,
825 clk_enable(oc->_clk);
829 static void _disable_optional_clocks(struct omap_hwmod *oh)
831 struct omap_hwmod_opt_clk *oc;
834 pr_debug("omap_hwmod: %s: disabling optional clocks\n", oh->name);
836 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
838 pr_debug("omap_hwmod: disable %s:%s\n", oc->role,
840 clk_disable(oc->_clk);
845 * _omap4_enable_module - enable CLKCTRL modulemode on OMAP4
846 * @oh: struct omap_hwmod *
848 * Enables the PRCM module mode related to the hwmod @oh.
851 static void _omap4_enable_module(struct omap_hwmod *oh)
853 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
856 pr_debug("omap_hwmod: %s: %s: %d\n",
857 oh->name, __func__, oh->prcm.omap4.modulemode);
859 omap4_cminst_module_enable(oh->prcm.omap4.modulemode,
860 oh->clkdm->prcm_partition,
862 oh->clkdm->clkdm_offs,
863 oh->prcm.omap4.clkctrl_offs);
867 * _omap4_wait_target_disable - wait for a module to be disabled on OMAP4
868 * @oh: struct omap_hwmod *
870 * Wait for a module @oh to enter slave idle. Returns 0 if the module
871 * does not have an IDLEST bit or if the module successfully enters
872 * slave idle; otherwise, pass along the return value of the
873 * appropriate *_cm*_wait_module_idle() function.
875 static int _omap4_wait_target_disable(struct omap_hwmod *oh)
877 if (!oh || !oh->clkdm)
880 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
883 if (oh->flags & HWMOD_NO_IDLEST)
886 return omap4_cminst_wait_module_idle(oh->clkdm->prcm_partition,
888 oh->clkdm->clkdm_offs,
889 oh->prcm.omap4.clkctrl_offs);
893 * _count_mpu_irqs - count the number of MPU IRQ lines associated with @oh
894 * @oh: struct omap_hwmod *oh
896 * Count and return the number of MPU IRQs associated with the hwmod
897 * @oh. Used to allocate struct resource data. Returns 0 if @oh is
900 static int _count_mpu_irqs(struct omap_hwmod *oh)
902 struct omap_hwmod_irq_info *ohii;
905 if (!oh || !oh->mpu_irqs)
909 ohii = &oh->mpu_irqs[i++];
910 } while (ohii->irq != -1);
916 * _count_sdma_reqs - count the number of SDMA request lines associated with @oh
917 * @oh: struct omap_hwmod *oh
919 * Count and return the number of SDMA request lines associated with
920 * the hwmod @oh. Used to allocate struct resource data. Returns 0
923 static int _count_sdma_reqs(struct omap_hwmod *oh)
925 struct omap_hwmod_dma_info *ohdi;
928 if (!oh || !oh->sdma_reqs)
932 ohdi = &oh->sdma_reqs[i++];
933 } while (ohdi->dma_req != -1);
939 * _count_ocp_if_addr_spaces - count the number of address space entries for @oh
940 * @oh: struct omap_hwmod *oh
942 * Count and return the number of address space ranges associated with
943 * the hwmod @oh. Used to allocate struct resource data. Returns 0
946 static int _count_ocp_if_addr_spaces(struct omap_hwmod_ocp_if *os)
948 struct omap_hwmod_addr_space *mem;
951 if (!os || !os->addr)
955 mem = &os->addr[i++];
956 } while (mem->pa_start != mem->pa_end);
962 * _get_mpu_irq_by_name - fetch MPU interrupt line number by name
963 * @oh: struct omap_hwmod * to operate on
964 * @name: pointer to the name of the MPU interrupt number to fetch (optional)
965 * @irq: pointer to an unsigned int to store the MPU IRQ number to
967 * Retrieve a MPU hardware IRQ line number named by @name associated
968 * with the IP block pointed to by @oh. The IRQ number will be filled
969 * into the address pointed to by @dma. When @name is non-null, the
970 * IRQ line number associated with the named entry will be returned.
971 * If @name is null, the first matching entry will be returned. Data
972 * order is not meaningful in hwmod data, so callers are strongly
973 * encouraged to use a non-null @name whenever possible to avoid
974 * unpredictable effects if hwmod data is later added that causes data
975 * ordering to change. Returns 0 upon success or a negative error
978 static int _get_mpu_irq_by_name(struct omap_hwmod *oh, const char *name,
988 while (oh->mpu_irqs[i].irq != -1) {
989 if (name == oh->mpu_irqs[i].name ||
990 !strcmp(name, oh->mpu_irqs[i].name)) {
1000 *irq = oh->mpu_irqs[i].irq;
1006 * _get_sdma_req_by_name - fetch SDMA request line ID by name
1007 * @oh: struct omap_hwmod * to operate on
1008 * @name: pointer to the name of the SDMA request line to fetch (optional)
1009 * @dma: pointer to an unsigned int to store the request line ID to
1011 * Retrieve an SDMA request line ID named by @name on the IP block
1012 * pointed to by @oh. The ID will be filled into the address pointed
1013 * to by @dma. When @name is non-null, the request line ID associated
1014 * with the named entry will be returned. If @name is null, the first
1015 * matching entry will be returned. Data order is not meaningful in
1016 * hwmod data, so callers are strongly encouraged to use a non-null
1017 * @name whenever possible to avoid unpredictable effects if hwmod
1018 * data is later added that causes data ordering to change. Returns 0
1019 * upon success or a negative error code upon error.
1021 static int _get_sdma_req_by_name(struct omap_hwmod *oh, const char *name,
1031 while (oh->sdma_reqs[i].dma_req != -1) {
1032 if (name == oh->sdma_reqs[i].name ||
1033 !strcmp(name, oh->sdma_reqs[i].name)) {
1043 *dma = oh->sdma_reqs[i].dma_req;
1049 * _get_addr_space_by_name - fetch address space start & end by name
1050 * @oh: struct omap_hwmod * to operate on
1051 * @name: pointer to the name of the address space to fetch (optional)
1052 * @pa_start: pointer to a u32 to store the starting address to
1053 * @pa_end: pointer to a u32 to store the ending address to
1055 * Retrieve address space start and end addresses for the IP block
1056 * pointed to by @oh. The data will be filled into the addresses
1057 * pointed to by @pa_start and @pa_end. When @name is non-null, the
1058 * address space data associated with the named entry will be
1059 * returned. If @name is null, the first matching entry will be
1060 * returned. Data order is not meaningful in hwmod data, so callers
1061 * are strongly encouraged to use a non-null @name whenever possible
1062 * to avoid unpredictable effects if hwmod data is later added that
1063 * causes data ordering to change. Returns 0 upon success or a
1064 * negative error code upon error.
1066 static int _get_addr_space_by_name(struct omap_hwmod *oh, const char *name,
1067 u32 *pa_start, u32 *pa_end)
1070 struct omap_hwmod_ocp_if *os;
1071 struct list_head *p = NULL;
1074 p = oh->slave_ports.next;
1077 while (i < oh->slaves_cnt) {
1078 os = _fetch_next_ocp_if(&p, &i);
1084 while (os->addr[j].pa_start != os->addr[j].pa_end) {
1085 if (name == os->addr[j].name ||
1086 !strcmp(name, os->addr[j].name)) {
1100 *pa_start = os->addr[j].pa_start;
1101 *pa_end = os->addr[j].pa_end;
1107 * _save_mpu_port_index - find and save the index to @oh's MPU port
1108 * @oh: struct omap_hwmod *
1110 * Determines the array index of the OCP slave port that the MPU uses
1111 * to address the device, and saves it into the struct omap_hwmod.
1112 * Intended to be called during hwmod registration only. No return
1115 static void __init _save_mpu_port_index(struct omap_hwmod *oh)
1117 struct omap_hwmod_ocp_if *os = NULL;
1118 struct list_head *p;
1124 oh->_int_flags |= _HWMOD_NO_MPU_PORT;
1126 p = oh->slave_ports.next;
1128 while (i < oh->slaves_cnt) {
1129 os = _fetch_next_ocp_if(&p, &i);
1130 if (os->user & OCP_USER_MPU) {
1132 oh->_int_flags &= ~_HWMOD_NO_MPU_PORT;
1141 * _find_mpu_rt_port - return omap_hwmod_ocp_if accessible by the MPU
1142 * @oh: struct omap_hwmod *
1144 * Given a pointer to a struct omap_hwmod record @oh, return a pointer
1145 * to the struct omap_hwmod_ocp_if record that is used by the MPU to
1146 * communicate with the IP block. This interface need not be directly
1147 * connected to the MPU (and almost certainly is not), but is directly
1148 * connected to the IP block represented by @oh. Returns a pointer
1149 * to the struct omap_hwmod_ocp_if * upon success, or returns NULL upon
1150 * error or if there does not appear to be a path from the MPU to this
1153 static struct omap_hwmod_ocp_if *_find_mpu_rt_port(struct omap_hwmod *oh)
1155 if (!oh || oh->_int_flags & _HWMOD_NO_MPU_PORT || oh->slaves_cnt == 0)
1158 return oh->_mpu_port;
1162 * _find_mpu_rt_addr_space - return MPU register target address space for @oh
1163 * @oh: struct omap_hwmod *
1165 * Returns a pointer to the struct omap_hwmod_addr_space record representing
1166 * the register target MPU address space; or returns NULL upon error.
1168 static struct omap_hwmod_addr_space * __init _find_mpu_rt_addr_space(struct omap_hwmod *oh)
1170 struct omap_hwmod_ocp_if *os;
1171 struct omap_hwmod_addr_space *mem;
1172 int found = 0, i = 0;
1174 os = _find_mpu_rt_port(oh);
1175 if (!os || !os->addr)
1179 mem = &os->addr[i++];
1180 if (mem->flags & ADDR_TYPE_RT)
1182 } while (!found && mem->pa_start != mem->pa_end);
1184 return (found) ? mem : NULL;
1188 * _enable_sysc - try to bring a module out of idle via OCP_SYSCONFIG
1189 * @oh: struct omap_hwmod *
1191 * If module is marked as SWSUP_SIDLE, force the module out of slave
1192 * idle; otherwise, configure it for smart-idle. If module is marked
1193 * as SWSUP_MSUSPEND, force the module out of master standby;
1194 * otherwise, configure it for smart-standby. No return value.
1196 static void _enable_sysc(struct omap_hwmod *oh)
1201 if (!oh->class->sysc)
1204 v = oh->_sysc_cache;
1205 sf = oh->class->sysc->sysc_flags;
1207 if (sf & SYSC_HAS_SIDLEMODE) {
1208 idlemode = (oh->flags & HWMOD_SWSUP_SIDLE) ?
1209 HWMOD_IDLEMODE_NO : HWMOD_IDLEMODE_SMART;
1210 _set_slave_idlemode(oh, idlemode, &v);
1213 if (sf & SYSC_HAS_MIDLEMODE) {
1214 if (oh->flags & HWMOD_SWSUP_MSTANDBY) {
1215 idlemode = HWMOD_IDLEMODE_NO;
1217 if (sf & SYSC_HAS_ENAWAKEUP)
1218 _enable_wakeup(oh, &v);
1219 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1220 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1222 idlemode = HWMOD_IDLEMODE_SMART;
1224 _set_master_standbymode(oh, idlemode, &v);
1228 * XXX The clock framework should handle this, by
1229 * calling into this code. But this must wait until the
1230 * clock structures are tagged with omap_hwmod entries
1232 if ((oh->flags & HWMOD_SET_DEFAULT_CLOCKACT) &&
1233 (sf & SYSC_HAS_CLOCKACTIVITY))
1234 _set_clockactivity(oh, oh->class->sysc->clockact, &v);
1236 /* If slave is in SMARTIDLE, also enable wakeup */
1237 if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
1238 _enable_wakeup(oh, &v);
1240 _write_sysconfig(v, oh);
1243 * Set the autoidle bit only after setting the smartidle bit
1244 * Setting this will not have any impact on the other modules.
1246 if (sf & SYSC_HAS_AUTOIDLE) {
1247 idlemode = (oh->flags & HWMOD_NO_OCP_AUTOIDLE) ?
1249 _set_module_autoidle(oh, idlemode, &v);
1250 _write_sysconfig(v, oh);
1255 * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
1256 * @oh: struct omap_hwmod *
1258 * If module is marked as SWSUP_SIDLE, force the module into slave
1259 * idle; otherwise, configure it for smart-idle. If module is marked
1260 * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
1261 * configure it for smart-standby. No return value.
1263 static void _idle_sysc(struct omap_hwmod *oh)
1268 if (!oh->class->sysc)
1271 v = oh->_sysc_cache;
1272 sf = oh->class->sysc->sysc_flags;
1274 if (sf & SYSC_HAS_SIDLEMODE) {
1275 idlemode = (oh->flags & HWMOD_SWSUP_SIDLE) ?
1276 HWMOD_IDLEMODE_FORCE : HWMOD_IDLEMODE_SMART;
1277 _set_slave_idlemode(oh, idlemode, &v);
1280 if (sf & SYSC_HAS_MIDLEMODE) {
1281 if (oh->flags & HWMOD_SWSUP_MSTANDBY) {
1282 idlemode = HWMOD_IDLEMODE_FORCE;
1284 if (sf & SYSC_HAS_ENAWAKEUP)
1285 _enable_wakeup(oh, &v);
1286 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1287 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1289 idlemode = HWMOD_IDLEMODE_SMART;
1291 _set_master_standbymode(oh, idlemode, &v);
1294 /* If slave is in SMARTIDLE, also enable wakeup */
1295 if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
1296 _enable_wakeup(oh, &v);
1298 _write_sysconfig(v, oh);
1302 * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
1303 * @oh: struct omap_hwmod *
1305 * Force the module into slave idle and master suspend. No return
1308 static void _shutdown_sysc(struct omap_hwmod *oh)
1313 if (!oh->class->sysc)
1316 v = oh->_sysc_cache;
1317 sf = oh->class->sysc->sysc_flags;
1319 if (sf & SYSC_HAS_SIDLEMODE)
1320 _set_slave_idlemode(oh, HWMOD_IDLEMODE_FORCE, &v);
1322 if (sf & SYSC_HAS_MIDLEMODE)
1323 _set_master_standbymode(oh, HWMOD_IDLEMODE_FORCE, &v);
1325 if (sf & SYSC_HAS_AUTOIDLE)
1326 _set_module_autoidle(oh, 1, &v);
1328 _write_sysconfig(v, oh);
1332 * _lookup - find an omap_hwmod by name
1333 * @name: find an omap_hwmod by name
1335 * Return a pointer to an omap_hwmod by name, or NULL if not found.
1337 static struct omap_hwmod *_lookup(const char *name)
1339 struct omap_hwmod *oh, *temp_oh;
1343 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1344 if (!strcmp(name, temp_oh->name)) {
1354 * _init_clkdm - look up a clockdomain name, store pointer in omap_hwmod
1355 * @oh: struct omap_hwmod *
1357 * Convert a clockdomain name stored in a struct omap_hwmod into a
1358 * clockdomain pointer, and save it into the struct omap_hwmod.
1359 * Return -EINVAL if the clkdm_name lookup failed.
1361 static int _init_clkdm(struct omap_hwmod *oh)
1363 if (!oh->clkdm_name)
1366 oh->clkdm = clkdm_lookup(oh->clkdm_name);
1368 pr_warning("omap_hwmod: %s: could not associate to clkdm %s\n",
1369 oh->name, oh->clkdm_name);
1373 pr_debug("omap_hwmod: %s: associated to clkdm %s\n",
1374 oh->name, oh->clkdm_name);
1380 * _init_clocks - clk_get() all clocks associated with this hwmod. Retrieve as
1381 * well the clockdomain.
1382 * @oh: struct omap_hwmod *
1383 * @data: not used; pass NULL
1385 * Called by omap_hwmod_setup_*() (after omap2_clk_init()).
1386 * Resolves all clock names embedded in the hwmod. Returns 0 on
1387 * success, or a negative error code on failure.
1389 static int _init_clocks(struct omap_hwmod *oh, void *data)
1393 if (oh->_state != _HWMOD_STATE_REGISTERED)
1396 pr_debug("omap_hwmod: %s: looking up clocks\n", oh->name);
1398 ret |= _init_main_clk(oh);
1399 ret |= _init_interface_clks(oh);
1400 ret |= _init_opt_clks(oh);
1401 if (soc_ops.init_clkdm)
1402 ret |= soc_ops.init_clkdm(oh);
1405 oh->_state = _HWMOD_STATE_CLKS_INITED;
1407 pr_warning("omap_hwmod: %s: cannot _init_clocks\n", oh->name);
1413 * _lookup_hardreset - fill register bit info for this hwmod/reset line
1414 * @oh: struct omap_hwmod *
1415 * @name: name of the reset line in the context of this hwmod
1416 * @ohri: struct omap_hwmod_rst_info * that this function will fill in
1418 * Return the bit position of the reset line that match the
1419 * input name. Return -ENOENT if not found.
1421 static u8 _lookup_hardreset(struct omap_hwmod *oh, const char *name,
1422 struct omap_hwmod_rst_info *ohri)
1426 for (i = 0; i < oh->rst_lines_cnt; i++) {
1427 const char *rst_line = oh->rst_lines[i].name;
1428 if (!strcmp(rst_line, name)) {
1429 ohri->rst_shift = oh->rst_lines[i].rst_shift;
1430 ohri->st_shift = oh->rst_lines[i].st_shift;
1431 pr_debug("omap_hwmod: %s: %s: %s: rst %d st %d\n",
1432 oh->name, __func__, rst_line, ohri->rst_shift,
1443 * _assert_hardreset - assert the HW reset line of submodules
1444 * contained in the hwmod module.
1445 * @oh: struct omap_hwmod *
1446 * @name: name of the reset line to lookup and assert
1448 * Some IP like dsp, ipu or iva contain processor that require an HW
1449 * reset line to be assert / deassert in order to enable fully the IP.
1450 * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1451 * asserting the hardreset line on the currently-booted SoC, or passes
1452 * along the return value from _lookup_hardreset() or the SoC's
1453 * assert_hardreset code.
1455 static int _assert_hardreset(struct omap_hwmod *oh, const char *name)
1457 struct omap_hwmod_rst_info ohri;
1463 if (!soc_ops.assert_hardreset)
1466 ret = _lookup_hardreset(oh, name, &ohri);
1467 if (IS_ERR_VALUE(ret))
1470 ret = soc_ops.assert_hardreset(oh, &ohri);
1476 * _deassert_hardreset - deassert the HW reset line of submodules contained
1477 * in the hwmod module.
1478 * @oh: struct omap_hwmod *
1479 * @name: name of the reset line to look up and deassert
1481 * Some IP like dsp, ipu or iva contain processor that require an HW
1482 * reset line to be assert / deassert in order to enable fully the IP.
1483 * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1484 * deasserting the hardreset line on the currently-booted SoC, or passes
1485 * along the return value from _lookup_hardreset() or the SoC's
1486 * deassert_hardreset code.
1488 static int _deassert_hardreset(struct omap_hwmod *oh, const char *name)
1490 struct omap_hwmod_rst_info ohri;
1496 if (!soc_ops.deassert_hardreset)
1499 ret = _lookup_hardreset(oh, name, &ohri);
1500 if (IS_ERR_VALUE(ret))
1503 ret = soc_ops.deassert_hardreset(oh, &ohri);
1505 pr_warning("omap_hwmod: %s: failed to hardreset\n", oh->name);
1511 * _read_hardreset - read the HW reset line state of submodules
1512 * contained in the hwmod module
1513 * @oh: struct omap_hwmod *
1514 * @name: name of the reset line to look up and read
1516 * Return the state of the reset line. Returns -EINVAL if @oh is
1517 * null, -ENOSYS if we have no way of reading the hardreset line
1518 * status on the currently-booted SoC, or passes along the return
1519 * value from _lookup_hardreset() or the SoC's is_hardreset_asserted
1522 static int _read_hardreset(struct omap_hwmod *oh, const char *name)
1524 struct omap_hwmod_rst_info ohri;
1530 if (!soc_ops.is_hardreset_asserted)
1533 ret = _lookup_hardreset(oh, name, &ohri);
1534 if (IS_ERR_VALUE(ret))
1537 return soc_ops.is_hardreset_asserted(oh, &ohri);
1541 * _are_any_hardreset_lines_asserted - return true if part of @oh is hard-reset
1542 * @oh: struct omap_hwmod *
1544 * If any hardreset line associated with @oh is asserted, then return true.
1545 * Otherwise, if @oh has no hardreset lines associated with it, or if
1546 * no hardreset lines associated with @oh are asserted, then return false.
1547 * This function is used to avoid executing some parts of the IP block
1548 * enable/disable sequence if a hardreset line is set.
1550 static bool _are_any_hardreset_lines_asserted(struct omap_hwmod *oh)
1554 if (oh->rst_lines_cnt == 0)
1557 for (i = 0; i < oh->rst_lines_cnt; i++)
1558 if (_read_hardreset(oh, oh->rst_lines[i].name) > 0)
1565 * _omap4_disable_module - enable CLKCTRL modulemode on OMAP4
1566 * @oh: struct omap_hwmod *
1568 * Disable the PRCM module mode related to the hwmod @oh.
1569 * Return EINVAL if the modulemode is not supported and 0 in case of success.
1571 static int _omap4_disable_module(struct omap_hwmod *oh)
1575 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
1578 pr_debug("omap_hwmod: %s: %s\n", oh->name, __func__);
1580 omap4_cminst_module_disable(oh->clkdm->prcm_partition,
1582 oh->clkdm->clkdm_offs,
1583 oh->prcm.omap4.clkctrl_offs);
1585 if (_are_any_hardreset_lines_asserted(oh))
1588 v = _omap4_wait_target_disable(oh);
1590 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1597 * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1598 * @oh: struct omap_hwmod *
1600 * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit. hwmod must be
1601 * enabled for this to work. Returns -ENOENT if the hwmod cannot be
1602 * reset this way, -EINVAL if the hwmod is in the wrong state,
1603 * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1605 * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1606 * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1607 * use the SYSCONFIG softreset bit to provide the status.
1609 * Note that some IP like McBSP do have reset control but don't have
1612 static int _ocp_softreset(struct omap_hwmod *oh)
1614 u32 v, softrst_mask;
1618 if (!oh->class->sysc ||
1619 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
1622 /* clocks must be on for this operation */
1623 if (oh->_state != _HWMOD_STATE_ENABLED) {
1624 pr_warning("omap_hwmod: %s: reset can only be entered from "
1625 "enabled state\n", oh->name);
1629 /* For some modules, all optionnal clocks need to be enabled as well */
1630 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1631 _enable_optional_clocks(oh);
1633 pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh->name);
1635 v = oh->_sysc_cache;
1636 ret = _set_softreset(oh, &v);
1639 _write_sysconfig(v, oh);
1641 if (oh->class->sysc->srst_udelay)
1642 udelay(oh->class->sysc->srst_udelay);
1644 if (oh->class->sysc->sysc_flags & SYSS_HAS_RESET_STATUS)
1645 omap_test_timeout((omap_hwmod_read(oh,
1646 oh->class->sysc->syss_offs)
1647 & SYSS_RESETDONE_MASK),
1648 MAX_MODULE_SOFTRESET_WAIT, c);
1649 else if (oh->class->sysc->sysc_flags & SYSC_HAS_RESET_STATUS) {
1650 softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
1651 omap_test_timeout(!(omap_hwmod_read(oh,
1652 oh->class->sysc->sysc_offs)
1654 MAX_MODULE_SOFTRESET_WAIT, c);
1657 if (c == MAX_MODULE_SOFTRESET_WAIT)
1658 pr_warning("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1659 oh->name, MAX_MODULE_SOFTRESET_WAIT);
1661 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh->name, c);
1664 * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1665 * _wait_target_ready() or _reset()
1668 ret = (c == MAX_MODULE_SOFTRESET_WAIT) ? -ETIMEDOUT : 0;
1671 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1672 _disable_optional_clocks(oh);
1678 * _reset - reset an omap_hwmod
1679 * @oh: struct omap_hwmod *
1681 * Resets an omap_hwmod @oh. If the module has a custom reset
1682 * function pointer defined, then call it to reset the IP block, and
1683 * pass along its return value to the caller. Otherwise, if the IP
1684 * block has an OCP_SYSCONFIG register with a SOFTRESET bitfield
1685 * associated with it, call a function to reset the IP block via that
1686 * method, and pass along the return value to the caller. Finally, if
1687 * the IP block has some hardreset lines associated with it, assert
1688 * all of those, but do _not_ deassert them. (This is because driver
1689 * authors have expressed an apparent requirement to control the
1690 * deassertion of the hardreset lines themselves.)
1692 * The default software reset mechanism for most OMAP IP blocks is
1693 * triggered via the OCP_SYSCONFIG.SOFTRESET bit. However, some
1694 * hwmods cannot be reset via this method. Some are not targets and
1695 * therefore have no OCP header registers to access. Others (like the
1696 * IVA) have idiosyncratic reset sequences. So for these relatively
1697 * rare cases, custom reset code can be supplied in the struct
1698 * omap_hwmod_class .reset function pointer.
1700 * _set_dmadisable() is called to set the DMADISABLE bit so that it
1701 * does not prevent idling of the system. This is necessary for cases
1702 * where ROMCODE/BOOTLOADER uses dma and transfers control to the
1703 * kernel without disabling dma.
1705 * Passes along the return value from either _ocp_softreset() or the
1706 * custom reset function - these must return -EINVAL if the hwmod
1707 * cannot be reset this way or if the hwmod is in the wrong state,
1708 * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1710 static int _reset(struct omap_hwmod *oh)
1714 pr_debug("omap_hwmod: %s: resetting\n", oh->name);
1716 if (oh->class->reset) {
1717 r = oh->class->reset(oh);
1719 if (oh->rst_lines_cnt > 0) {
1720 for (i = 0; i < oh->rst_lines_cnt; i++)
1721 _assert_hardreset(oh, oh->rst_lines[i].name);
1724 r = _ocp_softreset(oh);
1730 _set_dmadisable(oh);
1733 * OCP_SYSCONFIG bits need to be reprogrammed after a
1734 * softreset. The _enable() function should be split to avoid
1735 * the rewrite of the OCP_SYSCONFIG register.
1737 if (oh->class->sysc) {
1738 _update_sysc_cache(oh);
1746 * _enable - enable an omap_hwmod
1747 * @oh: struct omap_hwmod *
1749 * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
1750 * register target. Returns -EINVAL if the hwmod is in the wrong
1751 * state or passes along the return value of _wait_target_ready().
1753 static int _enable(struct omap_hwmod *oh)
1758 pr_debug("omap_hwmod: %s: enabling\n", oh->name);
1761 * hwmods with HWMOD_INIT_NO_IDLE flag set are left in enabled
1762 * state at init. Now that someone is really trying to enable
1763 * them, just ensure that the hwmod mux is set.
1765 if (oh->_int_flags & _HWMOD_SKIP_ENABLE) {
1767 * If the caller has mux data populated, do the mux'ing
1768 * which wouldn't have been done as part of the _enable()
1769 * done during setup.
1772 omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
1774 oh->_int_flags &= ~_HWMOD_SKIP_ENABLE;
1778 if (oh->_state != _HWMOD_STATE_INITIALIZED &&
1779 oh->_state != _HWMOD_STATE_IDLE &&
1780 oh->_state != _HWMOD_STATE_DISABLED) {
1781 WARN(1, "omap_hwmod: %s: enabled state can only be entered from initialized, idle, or disabled state\n",
1787 * If an IP block contains HW reset lines and any of them are
1788 * asserted, we let integration code associated with that
1789 * block handle the enable. We've received very little
1790 * information on what those driver authors need, and until
1791 * detailed information is provided and the driver code is
1792 * posted to the public lists, this is probably the best we
1795 if (_are_any_hardreset_lines_asserted(oh))
1798 /* Mux pins for device runtime if populated */
1799 if (oh->mux && (!oh->mux->enabled ||
1800 ((oh->_state == _HWMOD_STATE_IDLE) &&
1801 oh->mux->pads_dynamic)))
1802 omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
1804 _add_initiator_dep(oh, mpu_oh);
1808 * A clockdomain must be in SW_SUP before enabling
1809 * completely the module. The clockdomain can be set
1810 * in HW_AUTO only when the module become ready.
1812 hwsup = clkdm_in_hwsup(oh->clkdm);
1813 r = clkdm_hwmod_enable(oh->clkdm, oh);
1815 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1816 oh->name, oh->clkdm->name, r);
1822 if (soc_ops.enable_module)
1823 soc_ops.enable_module(oh);
1825 r = (soc_ops.wait_target_ready) ? soc_ops.wait_target_ready(oh) :
1829 * Set the clockdomain to HW_AUTO only if the target is ready,
1830 * assuming that the previous state was HW_AUTO
1832 if (oh->clkdm && hwsup)
1833 clkdm_allow_idle(oh->clkdm);
1835 oh->_state = _HWMOD_STATE_ENABLED;
1837 /* Access the sysconfig only if the target is ready */
1838 if (oh->class->sysc) {
1839 if (!(oh->_int_flags & _HWMOD_SYSCONFIG_LOADED))
1840 _update_sysc_cache(oh);
1844 _disable_clocks(oh);
1845 pr_debug("omap_hwmod: %s: _wait_target_ready: %d\n",
1849 clkdm_hwmod_disable(oh->clkdm, oh);
1856 * _idle - idle an omap_hwmod
1857 * @oh: struct omap_hwmod *
1859 * Idles an omap_hwmod @oh. This should be called once the hwmod has
1860 * no further work. Returns -EINVAL if the hwmod is in the wrong
1861 * state or returns 0.
1863 static int _idle(struct omap_hwmod *oh)
1865 pr_debug("omap_hwmod: %s: idling\n", oh->name);
1867 if (oh->_state != _HWMOD_STATE_ENABLED) {
1868 WARN(1, "omap_hwmod: %s: idle state can only be entered from enabled state\n",
1873 if (_are_any_hardreset_lines_asserted(oh))
1876 if (oh->class->sysc)
1878 _del_initiator_dep(oh, mpu_oh);
1880 if (soc_ops.disable_module)
1881 soc_ops.disable_module(oh);
1884 * The module must be in idle mode before disabling any parents
1885 * clocks. Otherwise, the parent clock might be disabled before
1886 * the module transition is done, and thus will prevent the
1887 * transition to complete properly.
1889 _disable_clocks(oh);
1891 clkdm_hwmod_disable(oh->clkdm, oh);
1893 /* Mux pins for device idle if populated */
1894 if (oh->mux && oh->mux->pads_dynamic)
1895 omap_hwmod_mux(oh->mux, _HWMOD_STATE_IDLE);
1897 oh->_state = _HWMOD_STATE_IDLE;
1903 * omap_hwmod_set_ocp_autoidle - set the hwmod's OCP autoidle bit
1904 * @oh: struct omap_hwmod *
1905 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
1907 * Sets the IP block's OCP autoidle bit in hardware, and updates our
1908 * local copy. Intended to be used by drivers that require
1909 * direct manipulation of the AUTOIDLE bits.
1910 * Returns -EINVAL if @oh is null or is not in the ENABLED state, or passes
1911 * along the return value from _set_module_autoidle().
1913 * Any users of this function should be scrutinized carefully.
1915 int omap_hwmod_set_ocp_autoidle(struct omap_hwmod *oh, u8 autoidle)
1919 unsigned long flags;
1921 if (!oh || oh->_state != _HWMOD_STATE_ENABLED)
1924 spin_lock_irqsave(&oh->_lock, flags);
1926 v = oh->_sysc_cache;
1928 retval = _set_module_autoidle(oh, autoidle, &v);
1931 _write_sysconfig(v, oh);
1933 spin_unlock_irqrestore(&oh->_lock, flags);
1939 * _shutdown - shutdown an omap_hwmod
1940 * @oh: struct omap_hwmod *
1942 * Shut down an omap_hwmod @oh. This should be called when the driver
1943 * used for the hwmod is removed or unloaded or if the driver is not
1944 * used by the system. Returns -EINVAL if the hwmod is in the wrong
1945 * state or returns 0.
1947 static int _shutdown(struct omap_hwmod *oh)
1952 if (oh->_state != _HWMOD_STATE_IDLE &&
1953 oh->_state != _HWMOD_STATE_ENABLED) {
1954 WARN(1, "omap_hwmod: %s: disabled state can only be entered from idle, or enabled state\n",
1959 if (_are_any_hardreset_lines_asserted(oh))
1962 pr_debug("omap_hwmod: %s: disabling\n", oh->name);
1964 if (oh->class->pre_shutdown) {
1965 prev_state = oh->_state;
1966 if (oh->_state == _HWMOD_STATE_IDLE)
1968 ret = oh->class->pre_shutdown(oh);
1970 if (prev_state == _HWMOD_STATE_IDLE)
1976 if (oh->class->sysc) {
1977 if (oh->_state == _HWMOD_STATE_IDLE)
1982 /* clocks and deps are already disabled in idle */
1983 if (oh->_state == _HWMOD_STATE_ENABLED) {
1984 _del_initiator_dep(oh, mpu_oh);
1985 /* XXX what about the other system initiators here? dma, dsp */
1986 if (soc_ops.disable_module)
1987 soc_ops.disable_module(oh);
1988 _disable_clocks(oh);
1990 clkdm_hwmod_disable(oh->clkdm, oh);
1992 /* XXX Should this code also force-disable the optional clocks? */
1994 for (i = 0; i < oh->rst_lines_cnt; i++)
1995 _assert_hardreset(oh, oh->rst_lines[i].name);
1997 /* Mux pins to safe mode or use populated off mode values */
1999 omap_hwmod_mux(oh->mux, _HWMOD_STATE_DISABLED);
2001 oh->_state = _HWMOD_STATE_DISABLED;
2007 * _init_mpu_rt_base - populate the virtual address for a hwmod
2008 * @oh: struct omap_hwmod * to locate the virtual address
2010 * Cache the virtual address used by the MPU to access this IP block's
2011 * registers. This address is needed early so the OCP registers that
2012 * are part of the device's address space can be ioremapped properly.
2015 static void __init _init_mpu_rt_base(struct omap_hwmod *oh, void *data)
2017 struct omap_hwmod_addr_space *mem;
2018 void __iomem *va_start;
2023 _save_mpu_port_index(oh);
2025 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2028 mem = _find_mpu_rt_addr_space(oh);
2030 pr_debug("omap_hwmod: %s: no MPU register target found\n",
2035 va_start = ioremap(mem->pa_start, mem->pa_end - mem->pa_start);
2037 pr_err("omap_hwmod: %s: Could not ioremap\n", oh->name);
2041 pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
2042 oh->name, va_start);
2044 oh->_mpu_rt_va = va_start;
2048 * _init - initialize internal data for the hwmod @oh
2049 * @oh: struct omap_hwmod *
2052 * Look up the clocks and the address space used by the MPU to access
2053 * registers belonging to the hwmod @oh. @oh must already be
2054 * registered at this point. This is the first of two phases for
2055 * hwmod initialization. Code called here does not touch any hardware
2056 * registers, it simply prepares internal data structures. Returns 0
2057 * upon success or if the hwmod isn't registered, or -EINVAL upon
2060 static int __init _init(struct omap_hwmod *oh, void *data)
2064 if (oh->_state != _HWMOD_STATE_REGISTERED)
2067 _init_mpu_rt_base(oh, NULL);
2069 r = _init_clocks(oh, NULL);
2070 if (IS_ERR_VALUE(r)) {
2071 WARN(1, "omap_hwmod: %s: couldn't init clocks\n", oh->name);
2075 oh->_state = _HWMOD_STATE_INITIALIZED;
2081 * _setup_iclk_autoidle - configure an IP block's interface clocks
2082 * @oh: struct omap_hwmod *
2084 * Set up the module's interface clocks. XXX This function is still mostly
2085 * a stub; implementing this properly requires iclk autoidle usecounting in
2086 * the clock code. No return value.
2088 static void __init _setup_iclk_autoidle(struct omap_hwmod *oh)
2090 struct omap_hwmod_ocp_if *os;
2091 struct list_head *p;
2093 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2096 p = oh->slave_ports.next;
2098 while (i < oh->slaves_cnt) {
2099 os = _fetch_next_ocp_if(&p, &i);
2103 if (os->flags & OCPIF_SWSUP_IDLE) {
2104 /* XXX omap_iclk_deny_idle(c); */
2106 /* XXX omap_iclk_allow_idle(c); */
2107 clk_enable(os->_clk);
2115 * _setup_reset - reset an IP block during the setup process
2116 * @oh: struct omap_hwmod *
2118 * Reset the IP block corresponding to the hwmod @oh during the setup
2119 * process. The IP block is first enabled so it can be successfully
2120 * reset. Returns 0 upon success or a negative error code upon
2123 static int __init _setup_reset(struct omap_hwmod *oh)
2127 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2130 if (oh->rst_lines_cnt == 0) {
2133 pr_warning("omap_hwmod: %s: cannot be enabled for reset (%d)\n",
2134 oh->name, oh->_state);
2139 if (!(oh->flags & HWMOD_INIT_NO_RESET))
2146 * _setup_postsetup - transition to the appropriate state after _setup
2147 * @oh: struct omap_hwmod *
2149 * Place an IP block represented by @oh into a "post-setup" state --
2150 * either IDLE, ENABLED, or DISABLED. ("post-setup" simply means that
2151 * this function is called at the end of _setup().) The postsetup
2152 * state for an IP block can be changed by calling
2153 * omap_hwmod_enter_postsetup_state() early in the boot process,
2154 * before one of the omap_hwmod_setup*() functions are called for the
2157 * The IP block stays in this state until a PM runtime-based driver is
2158 * loaded for that IP block. A post-setup state of IDLE is
2159 * appropriate for almost all IP blocks with runtime PM-enabled
2160 * drivers, since those drivers are able to enable the IP block. A
2161 * post-setup state of ENABLED is appropriate for kernels with PM
2162 * runtime disabled. The DISABLED state is appropriate for unusual IP
2163 * blocks such as the MPU WDTIMER on kernels without WDTIMER drivers
2164 * included, since the WDTIMER starts running on reset and will reset
2165 * the MPU if left active.
2167 * This post-setup mechanism is deprecated. Once all of the OMAP
2168 * drivers have been converted to use PM runtime, and all of the IP
2169 * block data and interconnect data is available to the hwmod code, it
2170 * should be possible to replace this mechanism with a "lazy reset"
2171 * arrangement. In a "lazy reset" setup, each IP block is enabled
2172 * when the driver first probes, then all remaining IP blocks without
2173 * drivers are either shut down or enabled after the drivers have
2174 * loaded. However, this cannot take place until the above
2175 * preconditions have been met, since otherwise the late reset code
2176 * has no way of knowing which IP blocks are in use by drivers, and
2177 * which ones are unused.
2181 static void __init _setup_postsetup(struct omap_hwmod *oh)
2185 if (oh->rst_lines_cnt > 0)
2188 postsetup_state = oh->_postsetup_state;
2189 if (postsetup_state == _HWMOD_STATE_UNKNOWN)
2190 postsetup_state = _HWMOD_STATE_ENABLED;
2193 * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
2194 * it should be set by the core code as a runtime flag during startup
2196 if ((oh->flags & HWMOD_INIT_NO_IDLE) &&
2197 (postsetup_state == _HWMOD_STATE_IDLE)) {
2198 oh->_int_flags |= _HWMOD_SKIP_ENABLE;
2199 postsetup_state = _HWMOD_STATE_ENABLED;
2202 if (postsetup_state == _HWMOD_STATE_IDLE)
2204 else if (postsetup_state == _HWMOD_STATE_DISABLED)
2206 else if (postsetup_state != _HWMOD_STATE_ENABLED)
2207 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
2208 oh->name, postsetup_state);
2214 * _setup - prepare IP block hardware for use
2215 * @oh: struct omap_hwmod *
2216 * @n: (unused, pass NULL)
2218 * Configure the IP block represented by @oh. This may include
2219 * enabling the IP block, resetting it, and placing it into a
2220 * post-setup state, depending on the type of IP block and applicable
2221 * flags. IP blocks are reset to prevent any previous configuration
2222 * by the bootloader or previous operating system from interfering
2223 * with power management or other parts of the system. The reset can
2224 * be avoided; see omap_hwmod_no_setup_reset(). This is the second of
2225 * two phases for hwmod initialization. Code called here generally
2226 * affects the IP block hardware, or system integration hardware
2227 * associated with the IP block. Returns 0.
2229 static int __init _setup(struct omap_hwmod *oh, void *data)
2231 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2234 _setup_iclk_autoidle(oh);
2236 if (!_setup_reset(oh))
2237 _setup_postsetup(oh);
2243 * _register - register a struct omap_hwmod
2244 * @oh: struct omap_hwmod *
2246 * Registers the omap_hwmod @oh. Returns -EEXIST if an omap_hwmod
2247 * already has been registered by the same name; -EINVAL if the
2248 * omap_hwmod is in the wrong state, if @oh is NULL, if the
2249 * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
2250 * name, or if the omap_hwmod's class is missing a name; or 0 upon
2253 * XXX The data should be copied into bootmem, so the original data
2254 * should be marked __initdata and freed after init. This would allow
2255 * unneeded omap_hwmods to be freed on multi-OMAP configurations. Note
2256 * that the copy process would be relatively complex due to the large number
2259 static int __init _register(struct omap_hwmod *oh)
2261 if (!oh || !oh->name || !oh->class || !oh->class->name ||
2262 (oh->_state != _HWMOD_STATE_UNKNOWN))
2265 pr_debug("omap_hwmod: %s: registering\n", oh->name);
2267 if (_lookup(oh->name))
2270 list_add_tail(&oh->node, &omap_hwmod_list);
2272 INIT_LIST_HEAD(&oh->master_ports);
2273 INIT_LIST_HEAD(&oh->slave_ports);
2274 spin_lock_init(&oh->_lock);
2276 oh->_state = _HWMOD_STATE_REGISTERED;
2279 * XXX Rather than doing a strcmp(), this should test a flag
2280 * set in the hwmod data, inserted by the autogenerator code.
2282 if (!strcmp(oh->name, MPU_INITIATOR_NAME))
2289 * _alloc_links - return allocated memory for hwmod links
2290 * @ml: pointer to a struct omap_hwmod_link * for the master link
2291 * @sl: pointer to a struct omap_hwmod_link * for the slave link
2293 * Return pointers to two struct omap_hwmod_link records, via the
2294 * addresses pointed to by @ml and @sl. Will first attempt to return
2295 * memory allocated as part of a large initial block, but if that has
2296 * been exhausted, will allocate memory itself. Since ideally this
2297 * second allocation path will never occur, the number of these
2298 * 'supplemental' allocations will be logged when debugging is
2299 * enabled. Returns 0.
2301 static int __init _alloc_links(struct omap_hwmod_link **ml,
2302 struct omap_hwmod_link **sl)
2306 if ((free_ls + LINKS_PER_OCP_IF) <= max_ls) {
2307 *ml = &linkspace[free_ls++];
2308 *sl = &linkspace[free_ls++];
2312 sz = sizeof(struct omap_hwmod_link) * LINKS_PER_OCP_IF;
2315 *ml = alloc_bootmem(sz);
2319 *sl = (void *)(*ml) + sizeof(struct omap_hwmod_link);
2322 pr_debug("omap_hwmod: supplemental link allocations needed: %d\n",
2323 ls_supp * LINKS_PER_OCP_IF);
2329 * _add_link - add an interconnect between two IP blocks
2330 * @oi: pointer to a struct omap_hwmod_ocp_if record
2332 * Add struct omap_hwmod_link records connecting the master IP block
2333 * specified in @oi->master to @oi, and connecting the slave IP block
2334 * specified in @oi->slave to @oi. This code is assumed to run before
2335 * preemption or SMP has been enabled, thus avoiding the need for
2336 * locking in this code. Changes to this assumption will require
2337 * additional locking. Returns 0.
2339 static int __init _add_link(struct omap_hwmod_ocp_if *oi)
2341 struct omap_hwmod_link *ml, *sl;
2343 pr_debug("omap_hwmod: %s -> %s: adding link\n", oi->master->name,
2346 _alloc_links(&ml, &sl);
2349 INIT_LIST_HEAD(&ml->node);
2350 list_add(&ml->node, &oi->master->master_ports);
2351 oi->master->masters_cnt++;
2354 INIT_LIST_HEAD(&sl->node);
2355 list_add(&sl->node, &oi->slave->slave_ports);
2356 oi->slave->slaves_cnt++;
2362 * _register_link - register a struct omap_hwmod_ocp_if
2363 * @oi: struct omap_hwmod_ocp_if *
2365 * Registers the omap_hwmod_ocp_if record @oi. Returns -EEXIST if it
2366 * has already been registered; -EINVAL if @oi is NULL or if the
2367 * record pointed to by @oi is missing required fields; or 0 upon
2370 * XXX The data should be copied into bootmem, so the original data
2371 * should be marked __initdata and freed after init. This would allow
2372 * unneeded omap_hwmods to be freed on multi-OMAP configurations.
2374 static int __init _register_link(struct omap_hwmod_ocp_if *oi)
2376 if (!oi || !oi->master || !oi->slave || !oi->user)
2379 if (oi->_int_flags & _OCPIF_INT_FLAGS_REGISTERED)
2382 pr_debug("omap_hwmod: registering link from %s to %s\n",
2383 oi->master->name, oi->slave->name);
2386 * Register the connected hwmods, if they haven't been
2387 * registered already
2389 if (oi->master->_state != _HWMOD_STATE_REGISTERED)
2390 _register(oi->master);
2392 if (oi->slave->_state != _HWMOD_STATE_REGISTERED)
2393 _register(oi->slave);
2397 oi->_int_flags |= _OCPIF_INT_FLAGS_REGISTERED;
2403 * _alloc_linkspace - allocate large block of hwmod links
2404 * @ois: pointer to an array of struct omap_hwmod_ocp_if records to count
2406 * Allocate a large block of struct omap_hwmod_link records. This
2407 * improves boot time significantly by avoiding the need to allocate
2408 * individual records one by one. If the number of records to
2409 * allocate in the block hasn't been manually specified, this function
2410 * will count the number of struct omap_hwmod_ocp_if records in @ois
2411 * and use that to determine the allocation size. For SoC families
2412 * that require multiple list registrations, such as OMAP3xxx, this
2413 * estimation process isn't optimal, so manual estimation is advised
2414 * in those cases. Returns -EEXIST if the allocation has already occurred
2415 * or 0 upon success.
2417 static int __init _alloc_linkspace(struct omap_hwmod_ocp_if **ois)
2423 WARN(1, "linkspace already allocated\n");
2429 max_ls += LINKS_PER_OCP_IF;
2431 sz = sizeof(struct omap_hwmod_link) * max_ls;
2433 pr_debug("omap_hwmod: %s: allocating %d byte linkspace (%d links)\n",
2434 __func__, sz, max_ls);
2436 linkspace = alloc_bootmem(sz);
2438 memset(linkspace, 0, sz);
2443 /* Static functions intended only for use in soc_ops field function pointers */
2446 * _omap2_wait_target_ready - wait for a module to leave slave idle
2447 * @oh: struct omap_hwmod *
2449 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2450 * does not have an IDLEST bit or if the module successfully leaves
2451 * slave idle; otherwise, pass along the return value of the
2452 * appropriate *_cm*_wait_module_ready() function.
2454 static int _omap2_wait_target_ready(struct omap_hwmod *oh)
2459 if (oh->flags & HWMOD_NO_IDLEST)
2462 if (!_find_mpu_rt_port(oh))
2465 /* XXX check module SIDLEMODE, hardreset status, enabled clocks */
2467 return omap2_cm_wait_module_ready(oh->prcm.omap2.module_offs,
2468 oh->prcm.omap2.idlest_reg_id,
2469 oh->prcm.omap2.idlest_idle_bit);
2473 * _omap4_wait_target_ready - wait for a module to leave slave idle
2474 * @oh: struct omap_hwmod *
2476 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2477 * does not have an IDLEST bit or if the module successfully leaves
2478 * slave idle; otherwise, pass along the return value of the
2479 * appropriate *_cm*_wait_module_ready() function.
2481 static int _omap4_wait_target_ready(struct omap_hwmod *oh)
2483 if (!oh || !oh->clkdm)
2486 if (oh->flags & HWMOD_NO_IDLEST)
2489 if (!_find_mpu_rt_port(oh))
2492 /* XXX check module SIDLEMODE, hardreset status */
2494 return omap4_cminst_wait_module_ready(oh->clkdm->prcm_partition,
2496 oh->clkdm->clkdm_offs,
2497 oh->prcm.omap4.clkctrl_offs);
2501 * _omap2_assert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2502 * @oh: struct omap_hwmod * to assert hardreset
2503 * @ohri: hardreset line data
2505 * Call omap2_prm_assert_hardreset() with parameters extracted from
2506 * the hwmod @oh and the hardreset line data @ohri. Only intended for
2507 * use as an soc_ops function pointer. Passes along the return value
2508 * from omap2_prm_assert_hardreset(). XXX This function is scheduled
2509 * for removal when the PRM code is moved into drivers/.
2511 static int _omap2_assert_hardreset(struct omap_hwmod *oh,
2512 struct omap_hwmod_rst_info *ohri)
2514 return omap2_prm_assert_hardreset(oh->prcm.omap2.module_offs,
2519 * _omap2_deassert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2520 * @oh: struct omap_hwmod * to deassert hardreset
2521 * @ohri: hardreset line data
2523 * Call omap2_prm_deassert_hardreset() with parameters extracted from
2524 * the hwmod @oh and the hardreset line data @ohri. Only intended for
2525 * use as an soc_ops function pointer. Passes along the return value
2526 * from omap2_prm_deassert_hardreset(). XXX This function is
2527 * scheduled for removal when the PRM code is moved into drivers/.
2529 static int _omap2_deassert_hardreset(struct omap_hwmod *oh,
2530 struct omap_hwmod_rst_info *ohri)
2532 return omap2_prm_deassert_hardreset(oh->prcm.omap2.module_offs,
2538 * _omap2_is_hardreset_asserted - call OMAP2 PRM hardreset fn with hwmod args
2539 * @oh: struct omap_hwmod * to test hardreset
2540 * @ohri: hardreset line data
2542 * Call omap2_prm_is_hardreset_asserted() with parameters extracted
2543 * from the hwmod @oh and the hardreset line data @ohri. Only
2544 * intended for use as an soc_ops function pointer. Passes along the
2545 * return value from omap2_prm_is_hardreset_asserted(). XXX This
2546 * function is scheduled for removal when the PRM code is moved into
2549 static int _omap2_is_hardreset_asserted(struct omap_hwmod *oh,
2550 struct omap_hwmod_rst_info *ohri)
2552 return omap2_prm_is_hardreset_asserted(oh->prcm.omap2.module_offs,
2557 * _omap4_assert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
2558 * @oh: struct omap_hwmod * to assert hardreset
2559 * @ohri: hardreset line data
2561 * Call omap4_prminst_assert_hardreset() with parameters extracted
2562 * from the hwmod @oh and the hardreset line data @ohri. Only
2563 * intended for use as an soc_ops function pointer. Passes along the
2564 * return value from omap4_prminst_assert_hardreset(). XXX This
2565 * function is scheduled for removal when the PRM code is moved into
2568 static int _omap4_assert_hardreset(struct omap_hwmod *oh,
2569 struct omap_hwmod_rst_info *ohri)
2574 return omap4_prminst_assert_hardreset(ohri->rst_shift,
2575 oh->clkdm->pwrdm.ptr->prcm_partition,
2576 oh->clkdm->pwrdm.ptr->prcm_offs,
2577 oh->prcm.omap4.rstctrl_offs);
2581 * _omap4_deassert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
2582 * @oh: struct omap_hwmod * to deassert hardreset
2583 * @ohri: hardreset line data
2585 * Call omap4_prminst_deassert_hardreset() with parameters extracted
2586 * from the hwmod @oh and the hardreset line data @ohri. Only
2587 * intended for use as an soc_ops function pointer. Passes along the
2588 * return value from omap4_prminst_deassert_hardreset(). XXX This
2589 * function is scheduled for removal when the PRM code is moved into
2592 static int _omap4_deassert_hardreset(struct omap_hwmod *oh,
2593 struct omap_hwmod_rst_info *ohri)
2599 pr_err("omap_hwmod: %s: %s: hwmod data error: OMAP4 does not support st_shift\n",
2600 oh->name, ohri->name);
2601 return omap4_prminst_deassert_hardreset(ohri->rst_shift,
2602 oh->clkdm->pwrdm.ptr->prcm_partition,
2603 oh->clkdm->pwrdm.ptr->prcm_offs,
2604 oh->prcm.omap4.rstctrl_offs);
2608 * _omap4_is_hardreset_asserted - call OMAP4 PRM hardreset fn with hwmod args
2609 * @oh: struct omap_hwmod * to test hardreset
2610 * @ohri: hardreset line data
2612 * Call omap4_prminst_is_hardreset_asserted() with parameters
2613 * extracted from the hwmod @oh and the hardreset line data @ohri.
2614 * Only intended for use as an soc_ops function pointer. Passes along
2615 * the return value from omap4_prminst_is_hardreset_asserted(). XXX
2616 * This function is scheduled for removal when the PRM code is moved
2619 static int _omap4_is_hardreset_asserted(struct omap_hwmod *oh,
2620 struct omap_hwmod_rst_info *ohri)
2625 return omap4_prminst_is_hardreset_asserted(ohri->rst_shift,
2626 oh->clkdm->pwrdm.ptr->prcm_partition,
2627 oh->clkdm->pwrdm.ptr->prcm_offs,
2628 oh->prcm.omap4.rstctrl_offs);
2631 /* Public functions */
2633 u32 omap_hwmod_read(struct omap_hwmod *oh, u16 reg_offs)
2635 if (oh->flags & HWMOD_16BIT_REG)
2636 return __raw_readw(oh->_mpu_rt_va + reg_offs);
2638 return __raw_readl(oh->_mpu_rt_va + reg_offs);
2641 void omap_hwmod_write(u32 v, struct omap_hwmod *oh, u16 reg_offs)
2643 if (oh->flags & HWMOD_16BIT_REG)
2644 __raw_writew(v, oh->_mpu_rt_va + reg_offs);
2646 __raw_writel(v, oh->_mpu_rt_va + reg_offs);
2650 * omap_hwmod_softreset - reset a module via SYSCONFIG.SOFTRESET bit
2651 * @oh: struct omap_hwmod *
2653 * This is a public function exposed to drivers. Some drivers may need to do
2654 * some settings before and after resetting the device. Those drivers after
2655 * doing the necessary settings could use this function to start a reset by
2656 * setting the SYSCONFIG.SOFTRESET bit.
2658 int omap_hwmod_softreset(struct omap_hwmod *oh)
2663 if (!oh || !(oh->_sysc_cache))
2666 v = oh->_sysc_cache;
2667 ret = _set_softreset(oh, &v);
2670 _write_sysconfig(v, oh);
2677 * omap_hwmod_set_slave_idlemode - set the hwmod's OCP slave idlemode
2678 * @oh: struct omap_hwmod *
2679 * @idlemode: SIDLEMODE field bits (shifted to bit 0)
2681 * Sets the IP block's OCP slave idlemode in hardware, and updates our
2682 * local copy. Intended to be used by drivers that have some erratum
2683 * that requires direct manipulation of the SIDLEMODE bits. Returns
2684 * -EINVAL if @oh is null, or passes along the return value from
2685 * _set_slave_idlemode().
2687 * XXX Does this function have any current users? If not, we should
2688 * remove it; it is better to let the rest of the hwmod code handle this.
2689 * Any users of this function should be scrutinized carefully.
2691 int omap_hwmod_set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode)
2699 v = oh->_sysc_cache;
2701 retval = _set_slave_idlemode(oh, idlemode, &v);
2703 _write_sysconfig(v, oh);
2709 * omap_hwmod_lookup - look up a registered omap_hwmod by name
2710 * @name: name of the omap_hwmod to look up
2712 * Given a @name of an omap_hwmod, return a pointer to the registered
2713 * struct omap_hwmod *, or NULL upon error.
2715 struct omap_hwmod *omap_hwmod_lookup(const char *name)
2717 struct omap_hwmod *oh;
2728 * omap_hwmod_for_each - call function for each registered omap_hwmod
2729 * @fn: pointer to a callback function
2730 * @data: void * data to pass to callback function
2732 * Call @fn for each registered omap_hwmod, passing @data to each
2733 * function. @fn must return 0 for success or any other value for
2734 * failure. If @fn returns non-zero, the iteration across omap_hwmods
2735 * will stop and the non-zero return value will be passed to the
2736 * caller of omap_hwmod_for_each(). @fn is called with
2737 * omap_hwmod_for_each() held.
2739 int omap_hwmod_for_each(int (*fn)(struct omap_hwmod *oh, void *data),
2742 struct omap_hwmod *temp_oh;
2748 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
2749 ret = (*fn)(temp_oh, data);
2758 * omap_hwmod_register_links - register an array of hwmod links
2759 * @ois: pointer to an array of omap_hwmod_ocp_if to register
2761 * Intended to be called early in boot before the clock framework is
2762 * initialized. If @ois is not null, will register all omap_hwmods
2763 * listed in @ois that are valid for this chip. Returns -EINVAL if
2764 * omap_hwmod_init() hasn't been called before calling this function,
2765 * -ENOMEM if the link memory area can't be allocated, or 0 upon
2768 int __init omap_hwmod_register_links(struct omap_hwmod_ocp_if **ois)
2779 if (_alloc_linkspace(ois)) {
2780 pr_err("omap_hwmod: could not allocate link space\n");
2787 r = _register_link(ois[i]);
2788 WARN(r && r != -EEXIST,
2789 "omap_hwmod: _register_link(%s -> %s) returned %d\n",
2790 ois[i]->master->name, ois[i]->slave->name, r);
2797 * _ensure_mpu_hwmod_is_setup - ensure the MPU SS hwmod is init'ed and set up
2798 * @oh: pointer to the hwmod currently being set up (usually not the MPU)
2800 * If the hwmod data corresponding to the MPU subsystem IP block
2801 * hasn't been initialized and set up yet, do so now. This must be
2802 * done first since sleep dependencies may be added from other hwmods
2803 * to the MPU. Intended to be called only by omap_hwmod_setup*(). No
2806 static void __init _ensure_mpu_hwmod_is_setup(struct omap_hwmod *oh)
2808 if (!mpu_oh || mpu_oh->_state == _HWMOD_STATE_UNKNOWN)
2809 pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",
2810 __func__, MPU_INITIATOR_NAME);
2811 else if (mpu_oh->_state == _HWMOD_STATE_REGISTERED && oh != mpu_oh)
2812 omap_hwmod_setup_one(MPU_INITIATOR_NAME);
2816 * omap_hwmod_setup_one - set up a single hwmod
2817 * @oh_name: const char * name of the already-registered hwmod to set up
2819 * Initialize and set up a single hwmod. Intended to be used for a
2820 * small number of early devices, such as the timer IP blocks used for
2821 * the scheduler clock. Must be called after omap2_clk_init().
2822 * Resolves the struct clk names to struct clk pointers for each
2823 * registered omap_hwmod. Also calls _setup() on each hwmod. Returns
2824 * -EINVAL upon error or 0 upon success.
2826 int __init omap_hwmod_setup_one(const char *oh_name)
2828 struct omap_hwmod *oh;
2830 pr_debug("omap_hwmod: %s: %s\n", oh_name, __func__);
2832 oh = _lookup(oh_name);
2834 WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name);
2838 _ensure_mpu_hwmod_is_setup(oh);
2847 * omap_hwmod_setup_all - set up all registered IP blocks
2849 * Initialize and set up all IP blocks registered with the hwmod code.
2850 * Must be called after omap2_clk_init(). Resolves the struct clk
2851 * names to struct clk pointers for each registered omap_hwmod. Also
2852 * calls _setup() on each hwmod. Returns 0 upon success.
2854 static int __init omap_hwmod_setup_all(void)
2856 _ensure_mpu_hwmod_is_setup(NULL);
2858 omap_hwmod_for_each(_init, NULL);
2859 omap_hwmod_for_each(_setup, NULL);
2863 core_initcall(omap_hwmod_setup_all);
2866 * omap_hwmod_enable - enable an omap_hwmod
2867 * @oh: struct omap_hwmod *
2869 * Enable an omap_hwmod @oh. Intended to be called by omap_device_enable().
2870 * Returns -EINVAL on error or passes along the return value from _enable().
2872 int omap_hwmod_enable(struct omap_hwmod *oh)
2875 unsigned long flags;
2880 spin_lock_irqsave(&oh->_lock, flags);
2882 spin_unlock_irqrestore(&oh->_lock, flags);
2888 * omap_hwmod_idle - idle an omap_hwmod
2889 * @oh: struct omap_hwmod *
2891 * Idle an omap_hwmod @oh. Intended to be called by omap_device_idle().
2892 * Returns -EINVAL on error or passes along the return value from _idle().
2894 int omap_hwmod_idle(struct omap_hwmod *oh)
2896 unsigned long flags;
2901 spin_lock_irqsave(&oh->_lock, flags);
2903 spin_unlock_irqrestore(&oh->_lock, flags);
2909 * omap_hwmod_shutdown - shutdown an omap_hwmod
2910 * @oh: struct omap_hwmod *
2912 * Shutdown an omap_hwmod @oh. Intended to be called by
2913 * omap_device_shutdown(). Returns -EINVAL on error or passes along
2914 * the return value from _shutdown().
2916 int omap_hwmod_shutdown(struct omap_hwmod *oh)
2918 unsigned long flags;
2923 spin_lock_irqsave(&oh->_lock, flags);
2925 spin_unlock_irqrestore(&oh->_lock, flags);
2931 * omap_hwmod_enable_clocks - enable main_clk, all interface clocks
2932 * @oh: struct omap_hwmod *oh
2934 * Intended to be called by the omap_device code.
2936 int omap_hwmod_enable_clocks(struct omap_hwmod *oh)
2938 unsigned long flags;
2940 spin_lock_irqsave(&oh->_lock, flags);
2942 spin_unlock_irqrestore(&oh->_lock, flags);
2948 * omap_hwmod_disable_clocks - disable main_clk, all interface clocks
2949 * @oh: struct omap_hwmod *oh
2951 * Intended to be called by the omap_device code.
2953 int omap_hwmod_disable_clocks(struct omap_hwmod *oh)
2955 unsigned long flags;
2957 spin_lock_irqsave(&oh->_lock, flags);
2958 _disable_clocks(oh);
2959 spin_unlock_irqrestore(&oh->_lock, flags);
2965 * omap_hwmod_ocp_barrier - wait for posted writes against the hwmod to complete
2966 * @oh: struct omap_hwmod *oh
2968 * Intended to be called by drivers and core code when all posted
2969 * writes to a device must complete before continuing further
2970 * execution (for example, after clearing some device IRQSTATUS
2973 * XXX what about targets with multiple OCP threads?
2975 void omap_hwmod_ocp_barrier(struct omap_hwmod *oh)
2979 if (!oh->class->sysc || !oh->class->sysc->sysc_flags) {
2980 WARN(1, "omap_device: %s: OCP barrier impossible due to device configuration\n",
2986 * Forces posted writes to complete on the OCP thread handling
2989 omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
2993 * omap_hwmod_reset - reset the hwmod
2994 * @oh: struct omap_hwmod *
2996 * Under some conditions, a driver may wish to reset the entire device.
2997 * Called from omap_device code. Returns -EINVAL on error or passes along
2998 * the return value from _reset().
3000 int omap_hwmod_reset(struct omap_hwmod *oh)
3003 unsigned long flags;
3008 spin_lock_irqsave(&oh->_lock, flags);
3010 spin_unlock_irqrestore(&oh->_lock, flags);
3016 * IP block data retrieval functions
3020 * omap_hwmod_count_resources - count number of struct resources needed by hwmod
3021 * @oh: struct omap_hwmod *
3022 * @res: pointer to the first element of an array of struct resource to fill
3024 * Count the number of struct resource array elements necessary to
3025 * contain omap_hwmod @oh resources. Intended to be called by code
3026 * that registers omap_devices. Intended to be used to determine the
3027 * size of a dynamically-allocated struct resource array, before
3028 * calling omap_hwmod_fill_resources(). Returns the number of struct
3029 * resource array elements needed.
3031 * XXX This code is not optimized. It could attempt to merge adjacent
3035 int omap_hwmod_count_resources(struct omap_hwmod *oh)
3037 struct omap_hwmod_ocp_if *os;
3038 struct list_head *p;
3042 ret = _count_mpu_irqs(oh) + _count_sdma_reqs(oh);
3044 p = oh->slave_ports.next;
3046 while (i < oh->slaves_cnt) {
3047 os = _fetch_next_ocp_if(&p, &i);
3048 ret += _count_ocp_if_addr_spaces(os);
3055 * omap_hwmod_fill_resources - fill struct resource array with hwmod data
3056 * @oh: struct omap_hwmod *
3057 * @res: pointer to the first element of an array of struct resource to fill
3059 * Fill the struct resource array @res with resource data from the
3060 * omap_hwmod @oh. Intended to be called by code that registers
3061 * omap_devices. See also omap_hwmod_count_resources(). Returns the
3062 * number of array elements filled.
3064 int omap_hwmod_fill_resources(struct omap_hwmod *oh, struct resource *res)
3066 struct omap_hwmod_ocp_if *os;
3067 struct list_head *p;
3068 int i, j, mpu_irqs_cnt, sdma_reqs_cnt, addr_cnt;
3071 /* For each IRQ, DMA, memory area, fill in array.*/
3073 mpu_irqs_cnt = _count_mpu_irqs(oh);
3074 for (i = 0; i < mpu_irqs_cnt; i++) {
3075 (res + r)->name = (oh->mpu_irqs + i)->name;
3076 (res + r)->start = (oh->mpu_irqs + i)->irq;
3077 (res + r)->end = (oh->mpu_irqs + i)->irq;
3078 (res + r)->flags = IORESOURCE_IRQ;
3082 sdma_reqs_cnt = _count_sdma_reqs(oh);
3083 for (i = 0; i < sdma_reqs_cnt; i++) {
3084 (res + r)->name = (oh->sdma_reqs + i)->name;
3085 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
3086 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
3087 (res + r)->flags = IORESOURCE_DMA;
3091 p = oh->slave_ports.next;
3094 while (i < oh->slaves_cnt) {
3095 os = _fetch_next_ocp_if(&p, &i);
3096 addr_cnt = _count_ocp_if_addr_spaces(os);
3098 for (j = 0; j < addr_cnt; j++) {
3099 (res + r)->name = (os->addr + j)->name;
3100 (res + r)->start = (os->addr + j)->pa_start;
3101 (res + r)->end = (os->addr + j)->pa_end;
3102 (res + r)->flags = IORESOURCE_MEM;
3111 * omap_hwmod_get_resource_byname - fetch IP block integration data by name
3112 * @oh: struct omap_hwmod * to operate on
3113 * @type: one of the IORESOURCE_* constants from include/linux/ioport.h
3114 * @name: pointer to the name of the data to fetch (optional)
3115 * @rsrc: pointer to a struct resource, allocated by the caller
3117 * Retrieve MPU IRQ, SDMA request line, or address space start/end
3118 * data for the IP block pointed to by @oh. The data will be filled
3119 * into a struct resource record pointed to by @rsrc. The struct
3120 * resource must be allocated by the caller. When @name is non-null,
3121 * the data associated with the matching entry in the IRQ/SDMA/address
3122 * space hwmod data arrays will be returned. If @name is null, the
3123 * first array entry will be returned. Data order is not meaningful
3124 * in hwmod data, so callers are strongly encouraged to use a non-null
3125 * @name whenever possible to avoid unpredictable effects if hwmod
3126 * data is later added that causes data ordering to change. This
3127 * function is only intended for use by OMAP core code. Device
3128 * drivers should not call this function - the appropriate bus-related
3129 * data accessor functions should be used instead. Returns 0 upon
3130 * success or a negative error code upon error.
3132 int omap_hwmod_get_resource_byname(struct omap_hwmod *oh, unsigned int type,
3133 const char *name, struct resource *rsrc)
3136 unsigned int irq, dma;
3137 u32 pa_start, pa_end;
3142 if (type == IORESOURCE_IRQ) {
3143 r = _get_mpu_irq_by_name(oh, name, &irq);
3149 } else if (type == IORESOURCE_DMA) {
3150 r = _get_sdma_req_by_name(oh, name, &dma);
3156 } else if (type == IORESOURCE_MEM) {
3157 r = _get_addr_space_by_name(oh, name, &pa_start, &pa_end);
3161 rsrc->start = pa_start;
3174 * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
3175 * @oh: struct omap_hwmod *
3177 * Return the powerdomain pointer associated with the OMAP module
3178 * @oh's main clock. If @oh does not have a main clk, return the
3179 * powerdomain associated with the interface clock associated with the
3180 * module's MPU port. (XXX Perhaps this should use the SDMA port
3181 * instead?) Returns NULL on error, or a struct powerdomain * on
3184 struct powerdomain *omap_hwmod_get_pwrdm(struct omap_hwmod *oh)
3187 struct omap_hwmod_ocp_if *oi;
3195 oi = _find_mpu_rt_port(oh);
3204 return c->clkdm->pwrdm.ptr;
3209 * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
3210 * @oh: struct omap_hwmod *
3212 * Returns the virtual address corresponding to the beginning of the
3213 * module's register target, in the address range that is intended to
3214 * be used by the MPU. Returns the virtual address upon success or NULL
3217 void __iomem *omap_hwmod_get_mpu_rt_va(struct omap_hwmod *oh)
3222 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
3225 if (oh->_state == _HWMOD_STATE_UNKNOWN)
3228 return oh->_mpu_rt_va;
3232 * omap_hwmod_add_initiator_dep - add sleepdep from @init_oh to @oh
3233 * @oh: struct omap_hwmod *
3234 * @init_oh: struct omap_hwmod * (initiator)
3236 * Add a sleep dependency between the initiator @init_oh and @oh.
3237 * Intended to be called by DSP/Bridge code via platform_data for the
3238 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
3239 * code needs to add/del initiator dependencies dynamically
3240 * before/after accessing a device. Returns the return value from
3241 * _add_initiator_dep().
3243 * XXX Keep a usecount in the clockdomain code
3245 int omap_hwmod_add_initiator_dep(struct omap_hwmod *oh,
3246 struct omap_hwmod *init_oh)
3248 return _add_initiator_dep(oh, init_oh);
3252 * XXX what about functions for drivers to save/restore ocp_sysconfig
3253 * for context save/restore operations?
3257 * omap_hwmod_del_initiator_dep - remove sleepdep from @init_oh to @oh
3258 * @oh: struct omap_hwmod *
3259 * @init_oh: struct omap_hwmod * (initiator)
3261 * Remove a sleep dependency between the initiator @init_oh and @oh.
3262 * Intended to be called by DSP/Bridge code via platform_data for the
3263 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
3264 * code needs to add/del initiator dependencies dynamically
3265 * before/after accessing a device. Returns the return value from
3266 * _del_initiator_dep().
3268 * XXX Keep a usecount in the clockdomain code
3270 int omap_hwmod_del_initiator_dep(struct omap_hwmod *oh,
3271 struct omap_hwmod *init_oh)
3273 return _del_initiator_dep(oh, init_oh);
3277 * omap_hwmod_enable_wakeup - allow device to wake up the system
3278 * @oh: struct omap_hwmod *
3280 * Sets the module OCP socket ENAWAKEUP bit to allow the module to
3281 * send wakeups to the PRCM, and enable I/O ring wakeup events for
3282 * this IP block if it has dynamic mux entries. Eventually this
3283 * should set PRCM wakeup registers to cause the PRCM to receive
3284 * wakeup events from the module. Does not set any wakeup routing
3285 * registers beyond this point - if the module is to wake up any other
3286 * module or subsystem, that must be set separately. Called by
3287 * omap_device code. Returns -EINVAL on error or 0 upon success.
3289 int omap_hwmod_enable_wakeup(struct omap_hwmod *oh)
3291 unsigned long flags;
3294 spin_lock_irqsave(&oh->_lock, flags);
3296 if (oh->class->sysc &&
3297 (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)) {
3298 v = oh->_sysc_cache;
3299 _enable_wakeup(oh, &v);
3300 _write_sysconfig(v, oh);
3303 _set_idle_ioring_wakeup(oh, true);
3304 spin_unlock_irqrestore(&oh->_lock, flags);
3310 * omap_hwmod_disable_wakeup - prevent device from waking the system
3311 * @oh: struct omap_hwmod *
3313 * Clears the module OCP socket ENAWAKEUP bit to prevent the module
3314 * from sending wakeups to the PRCM, and disable I/O ring wakeup
3315 * events for this IP block if it has dynamic mux entries. Eventually
3316 * this should clear PRCM wakeup registers to cause the PRCM to ignore
3317 * wakeup events from the module. Does not set any wakeup routing
3318 * registers beyond this point - if the module is to wake up any other
3319 * module or subsystem, that must be set separately. Called by
3320 * omap_device code. Returns -EINVAL on error or 0 upon success.
3322 int omap_hwmod_disable_wakeup(struct omap_hwmod *oh)
3324 unsigned long flags;
3327 spin_lock_irqsave(&oh->_lock, flags);
3329 if (oh->class->sysc &&
3330 (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)) {
3331 v = oh->_sysc_cache;
3332 _disable_wakeup(oh, &v);
3333 _write_sysconfig(v, oh);
3336 _set_idle_ioring_wakeup(oh, false);
3337 spin_unlock_irqrestore(&oh->_lock, flags);
3343 * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
3344 * contained in the hwmod module.
3345 * @oh: struct omap_hwmod *
3346 * @name: name of the reset line to lookup and assert
3348 * Some IP like dsp, ipu or iva contain processor that require
3349 * an HW reset line to be assert / deassert in order to enable fully
3350 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3351 * yet supported on this OMAP; otherwise, passes along the return value
3352 * from _assert_hardreset().
3354 int omap_hwmod_assert_hardreset(struct omap_hwmod *oh, const char *name)
3357 unsigned long flags;
3362 spin_lock_irqsave(&oh->_lock, flags);
3363 ret = _assert_hardreset(oh, name);
3364 spin_unlock_irqrestore(&oh->_lock, flags);
3370 * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
3371 * contained in the hwmod module.
3372 * @oh: struct omap_hwmod *
3373 * @name: name of the reset line to look up and deassert
3375 * Some IP like dsp, ipu or iva contain processor that require
3376 * an HW reset line to be assert / deassert in order to enable fully
3377 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3378 * yet supported on this OMAP; otherwise, passes along the return value
3379 * from _deassert_hardreset().
3381 int omap_hwmod_deassert_hardreset(struct omap_hwmod *oh, const char *name)
3384 unsigned long flags;
3389 spin_lock_irqsave(&oh->_lock, flags);
3390 ret = _deassert_hardreset(oh, name);
3391 spin_unlock_irqrestore(&oh->_lock, flags);
3397 * omap_hwmod_read_hardreset - read the HW reset line state of submodules
3398 * contained in the hwmod module
3399 * @oh: struct omap_hwmod *
3400 * @name: name of the reset line to look up and read
3402 * Return the current state of the hwmod @oh's reset line named @name:
3403 * returns -EINVAL upon parameter error or if this operation
3404 * is unsupported on the current OMAP; otherwise, passes along the return
3405 * value from _read_hardreset().
3407 int omap_hwmod_read_hardreset(struct omap_hwmod *oh, const char *name)
3410 unsigned long flags;
3415 spin_lock_irqsave(&oh->_lock, flags);
3416 ret = _read_hardreset(oh, name);
3417 spin_unlock_irqrestore(&oh->_lock, flags);
3424 * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
3425 * @classname: struct omap_hwmod_class name to search for
3426 * @fn: callback function pointer to call for each hwmod in class @classname
3427 * @user: arbitrary context data to pass to the callback function
3429 * For each omap_hwmod of class @classname, call @fn.
3430 * If the callback function returns something other than
3431 * zero, the iterator is terminated, and the callback function's return
3432 * value is passed back to the caller. Returns 0 upon success, -EINVAL
3433 * if @classname or @fn are NULL, or passes back the error code from @fn.
3435 int omap_hwmod_for_each_by_class(const char *classname,
3436 int (*fn)(struct omap_hwmod *oh,
3440 struct omap_hwmod *temp_oh;
3443 if (!classname || !fn)
3446 pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
3447 __func__, classname);
3449 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
3450 if (!strcmp(temp_oh->class->name, classname)) {
3451 pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
3452 __func__, temp_oh->name);
3453 ret = (*fn)(temp_oh, user);
3460 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
3467 * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
3468 * @oh: struct omap_hwmod *
3469 * @state: state that _setup() should leave the hwmod in
3471 * Sets the hwmod state that @oh will enter at the end of _setup()
3472 * (called by omap_hwmod_setup_*()). See also the documentation
3473 * for _setup_postsetup(), above. Returns 0 upon success or
3474 * -EINVAL if there is a problem with the arguments or if the hwmod is
3475 * in the wrong state.
3477 int omap_hwmod_set_postsetup_state(struct omap_hwmod *oh, u8 state)
3480 unsigned long flags;
3485 if (state != _HWMOD_STATE_DISABLED &&
3486 state != _HWMOD_STATE_ENABLED &&
3487 state != _HWMOD_STATE_IDLE)
3490 spin_lock_irqsave(&oh->_lock, flags);
3492 if (oh->_state != _HWMOD_STATE_REGISTERED) {
3497 oh->_postsetup_state = state;
3501 spin_unlock_irqrestore(&oh->_lock, flags);
3507 * omap_hwmod_get_context_loss_count - get lost context count
3508 * @oh: struct omap_hwmod *
3510 * Query the powerdomain of of @oh to get the context loss
3511 * count for this device.
3513 * Returns the context loss count of the powerdomain assocated with @oh
3514 * upon success, or zero if no powerdomain exists for @oh.
3516 int omap_hwmod_get_context_loss_count(struct omap_hwmod *oh)
3518 struct powerdomain *pwrdm;
3521 pwrdm = omap_hwmod_get_pwrdm(oh);
3523 ret = pwrdm_get_context_loss_count(pwrdm);
3529 * omap_hwmod_no_setup_reset - prevent a hwmod from being reset upon setup
3530 * @oh: struct omap_hwmod *
3532 * Prevent the hwmod @oh from being reset during the setup process.
3533 * Intended for use by board-*.c files on boards with devices that
3534 * cannot tolerate being reset. Must be called before the hwmod has
3535 * been set up. Returns 0 upon success or negative error code upon
3538 int omap_hwmod_no_setup_reset(struct omap_hwmod *oh)
3543 if (oh->_state != _HWMOD_STATE_REGISTERED) {
3544 pr_err("omap_hwmod: %s: cannot prevent setup reset; in wrong state\n",
3549 oh->flags |= HWMOD_INIT_NO_RESET;
3555 * omap_hwmod_pad_route_irq - route an I/O pad wakeup to a particular MPU IRQ
3556 * @oh: struct omap_hwmod * containing hwmod mux entries
3557 * @pad_idx: array index in oh->mux of the hwmod mux entry to route wakeup
3558 * @irq_idx: the hwmod mpu_irqs array index of the IRQ to trigger on wakeup
3560 * When an I/O pad wakeup arrives for the dynamic or wakeup hwmod mux
3561 * entry number @pad_idx for the hwmod @oh, trigger the interrupt
3562 * service routine for the hwmod's mpu_irqs array index @irq_idx. If
3563 * this function is not called for a given pad_idx, then the ISR
3564 * associated with @oh's first MPU IRQ will be triggered when an I/O
3565 * pad wakeup occurs on that pad. Note that @pad_idx is the index of
3566 * the _dynamic or wakeup_ entry: if there are other entries not
3567 * marked with OMAP_DEVICE_PAD_WAKEUP or OMAP_DEVICE_PAD_REMUX, these
3568 * entries are NOT COUNTED in the dynamic pad index. This function
3569 * must be called separately for each pad that requires its interrupt
3570 * to be re-routed this way. Returns -EINVAL if there is an argument
3571 * problem or if @oh does not have hwmod mux entries or MPU IRQs;
3572 * returns -ENOMEM if memory cannot be allocated; or 0 upon success.
3574 * XXX This function interface is fragile. Rather than using array
3575 * indexes, which are subject to unpredictable change, it should be
3576 * using hwmod IRQ names, and some other stable key for the hwmod mux
3579 int omap_hwmod_pad_route_irq(struct omap_hwmod *oh, int pad_idx, int irq_idx)
3585 if (!oh || !oh->mux || !oh->mpu_irqs || pad_idx < 0 ||
3586 pad_idx >= oh->mux->nr_pads_dynamic)
3589 /* Check the number of available mpu_irqs */
3590 for (nr_irqs = 0; oh->mpu_irqs[nr_irqs].irq >= 0; nr_irqs++)
3593 if (irq_idx >= nr_irqs)
3596 if (!oh->mux->irqs) {
3597 /* XXX What frees this? */
3598 oh->mux->irqs = kzalloc(sizeof(int) * oh->mux->nr_pads_dynamic,
3603 oh->mux->irqs[pad_idx] = irq_idx;
3609 * omap_hwmod_init - initialize the hwmod code
3611 * Sets up some function pointers needed by the hwmod code to operate on the
3612 * currently-booted SoC. Intended to be called once during kernel init
3613 * before any hwmods are registered. No return value.
3615 void __init omap_hwmod_init(void)
3617 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
3618 soc_ops.wait_target_ready = _omap2_wait_target_ready;
3619 soc_ops.assert_hardreset = _omap2_assert_hardreset;
3620 soc_ops.deassert_hardreset = _omap2_deassert_hardreset;
3621 soc_ops.is_hardreset_asserted = _omap2_is_hardreset_asserted;
3622 } else if (cpu_is_omap44xx()) {
3623 soc_ops.enable_module = _omap4_enable_module;
3624 soc_ops.disable_module = _omap4_disable_module;
3625 soc_ops.wait_target_ready = _omap4_wait_target_ready;
3626 soc_ops.assert_hardreset = _omap4_assert_hardreset;
3627 soc_ops.deassert_hardreset = _omap4_deassert_hardreset;
3628 soc_ops.is_hardreset_asserted = _omap4_is_hardreset_asserted;
3629 soc_ops.init_clkdm = _init_clkdm;
3631 WARN(1, "omap_hwmod: unknown SoC type\n");
3638 * omap_hwmod_get_main_clk - get pointer to main clock name
3639 * @oh: struct omap_hwmod *
3641 * Returns the main clock name assocated with @oh upon success,
3642 * or NULL if @oh is NULL.
3644 const char *omap_hwmod_get_main_clk(struct omap_hwmod *oh)
3649 return oh->main_clk;