2 * omap_hwmod implementation for OMAP2/3/4
4 * Copyright (C) 2009-2011 Nokia Corporation
5 * Copyright (C) 2011-2012 Texas Instruments, Inc.
7 * Paul Walmsley, BenoƮt Cousson, Kevin Hilman
9 * Created in collaboration with (alphabetical order): Thara Gopinath,
10 * Tony Lindgren, Rajendra Nayak, Vikram Pandita, Sakari Poussa, Anand
11 * Sawant, Santosh Shilimkar, Richard Woodruff
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License version 2 as
15 * published by the Free Software Foundation.
19 * One way to view an OMAP SoC is as a collection of largely unrelated
20 * IP blocks connected by interconnects. The IP blocks include
21 * devices such as ARM processors, audio serial interfaces, UARTs,
22 * etc. Some of these devices, like the DSP, are created by TI;
23 * others, like the SGX, largely originate from external vendors. In
24 * TI's documentation, on-chip devices are referred to as "OMAP
25 * modules." Some of these IP blocks are identical across several
26 * OMAP versions. Others are revised frequently.
28 * These OMAP modules are tied together by various interconnects.
29 * Most of the address and data flow between modules is via OCP-based
30 * interconnects such as the L3 and L4 buses; but there are other
31 * interconnects that distribute the hardware clock tree, handle idle
32 * and reset signaling, supply power, and connect the modules to
33 * various pads or balls on the OMAP package.
35 * OMAP hwmod provides a consistent way to describe the on-chip
36 * hardware blocks and their integration into the rest of the chip.
37 * This description can be automatically generated from the TI
38 * hardware database. OMAP hwmod provides a standard, consistent API
39 * to reset, enable, idle, and disable these hardware blocks. And
40 * hwmod provides a way for other core code, such as the Linux device
41 * code or the OMAP power management and address space mapping code,
42 * to query the hardware database.
46 * Drivers won't call hwmod functions directly. That is done by the
47 * omap_device code, and in rare occasions, by custom integration code
48 * in arch/arm/ *omap*. The omap_device code includes functions to
49 * build a struct platform_device using omap_hwmod data, and that is
50 * currently how hwmod data is communicated to drivers and to the
51 * Linux driver model. Most drivers will call omap_hwmod functions only
52 * indirectly, via pm_runtime*() functions.
54 * From a layering perspective, here is where the OMAP hwmod code
55 * fits into the kernel software stack:
57 * +-------------------------------+
58 * | Device driver code |
59 * | (e.g., drivers/) |
60 * +-------------------------------+
61 * | Linux driver model |
62 * | (platform_device / |
63 * | platform_driver data/code) |
64 * +-------------------------------+
65 * | OMAP core-driver integration |
66 * |(arch/arm/mach-omap2/devices.c)|
67 * +-------------------------------+
68 * | omap_device code |
69 * | (../plat-omap/omap_device.c) |
70 * +-------------------------------+
71 * ----> | omap_hwmod code/data | <-----
72 * | (../mach-omap2/omap_hwmod*) |
73 * +-------------------------------+
74 * | OMAP clock/PRCM/register fns |
75 * | (__raw_{read,write}l, clk*) |
76 * +-------------------------------+
78 * Device drivers should not contain any OMAP-specific code or data in
79 * them. They should only contain code to operate the IP block that
80 * the driver is responsible for. This is because these IP blocks can
81 * also appear in other SoCs, either from TI (such as DaVinci) or from
82 * other manufacturers; and drivers should be reusable across other
85 * The OMAP hwmod code also will attempt to reset and idle all on-chip
86 * devices upon boot. The goal here is for the kernel to be
87 * completely self-reliant and independent from bootloaders. This is
88 * to ensure a repeatable configuration, both to ensure consistent
89 * runtime behavior, and to make it easier for others to reproduce
92 * OMAP module activity states
93 * ---------------------------
94 * The hwmod code considers modules to be in one of several activity
95 * states. IP blocks start out in an UNKNOWN state, then once they
96 * are registered via the hwmod code, proceed to the REGISTERED state.
97 * Once their clock names are resolved to clock pointers, the module
98 * enters the CLKS_INITED state; and finally, once the module has been
99 * reset and the integration registers programmed, the INITIALIZED state
100 * is entered. The hwmod code will then place the module into either
101 * the IDLE state to save power, or in the case of a critical system
102 * module, the ENABLED state.
104 * OMAP core integration code can then call omap_hwmod*() functions
105 * directly to move the module between the IDLE, ENABLED, and DISABLED
106 * states, as needed. This is done during both the PM idle loop, and
107 * in the OMAP core integration code's implementation of the PM runtime
112 * This is a partial list.
113 * - OMAP2420 Multimedia Processor Silicon Revision 2.1.1, 2.2 (SWPU064)
114 * - OMAP2430 Multimedia Device POP Silicon Revision 2.1 (SWPU090)
115 * - OMAP34xx Multimedia Device Silicon Revision 3.1 (SWPU108)
116 * - OMAP4430 Multimedia Device Silicon Revision 1.0 (SWPU140)
117 * - Open Core Protocol Specification 2.2
120 * - handle IO mapping
121 * - bus throughput & module latency measurement code
123 * XXX add tests at the beginning of each function to ensure the hwmod is
124 * in the appropriate state
125 * XXX error return values should be checked to ensure that they are
130 #include <linux/kernel.h>
131 #include <linux/errno.h>
132 #include <linux/io.h>
133 #include <linux/clk-provider.h>
134 #include <linux/delay.h>
135 #include <linux/err.h>
136 #include <linux/list.h>
137 #include <linux/mutex.h>
138 #include <linux/spinlock.h>
139 #include <linux/slab.h>
140 #include <linux/bootmem.h>
141 #include <linux/cpu.h>
142 #include <linux/of.h>
143 #include <linux/of_address.h>
145 #include <asm/system_misc.h>
148 #include "omap_hwmod.h"
152 #include "clockdomain.h"
153 #include "powerdomain.h"
156 #include "cminst44xx.h"
162 #include "prminst44xx.h"
166 /* Name of the OMAP hwmod for the MPU */
167 #define MPU_INITIATOR_NAME "mpu"
170 * Number of struct omap_hwmod_link records per struct
171 * omap_hwmod_ocp_if record (master->slave and slave->master)
173 #define LINKS_PER_OCP_IF 2
176 * struct omap_hwmod_soc_ops - fn ptrs for some SoC-specific operations
177 * @enable_module: function to enable a module (via MODULEMODE)
178 * @disable_module: function to disable a module (via MODULEMODE)
180 * XXX Eventually this functionality will be hidden inside the PRM/CM
181 * device drivers. Until then, this should avoid huge blocks of cpu_is_*()
182 * conditionals in this code.
184 struct omap_hwmod_soc_ops
{
185 void (*enable_module
)(struct omap_hwmod
*oh
);
186 int (*disable_module
)(struct omap_hwmod
*oh
);
187 int (*wait_target_ready
)(struct omap_hwmod
*oh
);
188 int (*assert_hardreset
)(struct omap_hwmod
*oh
,
189 struct omap_hwmod_rst_info
*ohri
);
190 int (*deassert_hardreset
)(struct omap_hwmod
*oh
,
191 struct omap_hwmod_rst_info
*ohri
);
192 int (*is_hardreset_asserted
)(struct omap_hwmod
*oh
,
193 struct omap_hwmod_rst_info
*ohri
);
194 int (*init_clkdm
)(struct omap_hwmod
*oh
);
195 void (*update_context_lost
)(struct omap_hwmod
*oh
);
196 int (*get_context_lost
)(struct omap_hwmod
*oh
);
199 /* soc_ops: adapts the omap_hwmod code to the currently-booted SoC */
200 static struct omap_hwmod_soc_ops soc_ops
;
202 /* omap_hwmod_list contains all registered struct omap_hwmods */
203 static LIST_HEAD(omap_hwmod_list
);
205 /* mpu_oh: used to add/remove MPU initiator from sleepdep list */
206 static struct omap_hwmod
*mpu_oh
;
208 /* io_chain_lock: used to serialize reconfigurations of the I/O chain */
209 static DEFINE_SPINLOCK(io_chain_lock
);
212 * linkspace: ptr to a buffer that struct omap_hwmod_link records are
213 * allocated from - used to reduce the number of small memory
214 * allocations, which has a significant impact on performance
216 static struct omap_hwmod_link
*linkspace
;
219 * free_ls, max_ls: array indexes into linkspace; representing the
220 * next free struct omap_hwmod_link index, and the maximum number of
221 * struct omap_hwmod_link records allocated (respectively)
223 static unsigned short free_ls
, max_ls
, ls_supp
;
225 /* inited: set to true once the hwmod code is initialized */
228 /* Private functions */
231 * _fetch_next_ocp_if - return the next OCP interface in a list
232 * @p: ptr to a ptr to the list_head inside the ocp_if to return
233 * @i: pointer to the index of the element pointed to by @p in the list
235 * Return a pointer to the struct omap_hwmod_ocp_if record
236 * containing the struct list_head pointed to by @p, and increment
237 * @p such that a future call to this routine will return the next
240 static struct omap_hwmod_ocp_if
*_fetch_next_ocp_if(struct list_head
**p
,
243 struct omap_hwmod_ocp_if
*oi
;
245 oi
= list_entry(*p
, struct omap_hwmod_link
, node
)->ocp_if
;
254 * _update_sysc_cache - return the module OCP_SYSCONFIG register, keep copy
255 * @oh: struct omap_hwmod *
257 * Load the current value of the hwmod OCP_SYSCONFIG register into the
258 * struct omap_hwmod for later use. Returns -EINVAL if the hwmod has no
259 * OCP_SYSCONFIG register or 0 upon success.
261 static int _update_sysc_cache(struct omap_hwmod
*oh
)
263 if (!oh
->class->sysc
) {
264 WARN(1, "omap_hwmod: %s: cannot read OCP_SYSCONFIG: not defined on hwmod's class\n", oh
->name
);
268 /* XXX ensure module interface clock is up */
270 oh
->_sysc_cache
= omap_hwmod_read(oh
, oh
->class->sysc
->sysc_offs
);
272 if (!(oh
->class->sysc
->sysc_flags
& SYSC_NO_CACHE
))
273 oh
->_int_flags
|= _HWMOD_SYSCONFIG_LOADED
;
279 * _write_sysconfig - write a value to the module's OCP_SYSCONFIG register
280 * @v: OCP_SYSCONFIG value to write
281 * @oh: struct omap_hwmod *
283 * Write @v into the module class' OCP_SYSCONFIG register, if it has
284 * one. No return value.
286 static void _write_sysconfig(u32 v
, struct omap_hwmod
*oh
)
288 if (!oh
->class->sysc
) {
289 WARN(1, "omap_hwmod: %s: cannot write OCP_SYSCONFIG: not defined on hwmod's class\n", oh
->name
);
293 /* XXX ensure module interface clock is up */
295 /* Module might have lost context, always update cache and register */
297 omap_hwmod_write(v
, oh
, oh
->class->sysc
->sysc_offs
);
301 * _set_master_standbymode: set the OCP_SYSCONFIG MIDLEMODE field in @v
302 * @oh: struct omap_hwmod *
303 * @standbymode: MIDLEMODE field bits
304 * @v: pointer to register contents to modify
306 * Update the master standby mode bits in @v to be @standbymode for
307 * the @oh hwmod. Does not write to the hardware. Returns -EINVAL
308 * upon error or 0 upon success.
310 static int _set_master_standbymode(struct omap_hwmod
*oh
, u8 standbymode
,
316 if (!oh
->class->sysc
||
317 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_MIDLEMODE
))
320 if (!oh
->class->sysc
->sysc_fields
) {
321 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
325 mstandby_shift
= oh
->class->sysc
->sysc_fields
->midle_shift
;
326 mstandby_mask
= (0x3 << mstandby_shift
);
328 *v
&= ~mstandby_mask
;
329 *v
|= __ffs(standbymode
) << mstandby_shift
;
335 * _set_slave_idlemode: set the OCP_SYSCONFIG SIDLEMODE field in @v
336 * @oh: struct omap_hwmod *
337 * @idlemode: SIDLEMODE field bits
338 * @v: pointer to register contents to modify
340 * Update the slave idle mode bits in @v to be @idlemode for the @oh
341 * hwmod. Does not write to the hardware. Returns -EINVAL upon error
344 static int _set_slave_idlemode(struct omap_hwmod
*oh
, u8 idlemode
, u32
*v
)
349 if (!oh
->class->sysc
||
350 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_SIDLEMODE
))
353 if (!oh
->class->sysc
->sysc_fields
) {
354 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
358 sidle_shift
= oh
->class->sysc
->sysc_fields
->sidle_shift
;
359 sidle_mask
= (0x3 << sidle_shift
);
362 *v
|= __ffs(idlemode
) << sidle_shift
;
368 * _set_clockactivity: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
369 * @oh: struct omap_hwmod *
370 * @clockact: CLOCKACTIVITY field bits
371 * @v: pointer to register contents to modify
373 * Update the clockactivity mode bits in @v to be @clockact for the
374 * @oh hwmod. Used for additional powersaving on some modules. Does
375 * not write to the hardware. Returns -EINVAL upon error or 0 upon
378 static int _set_clockactivity(struct omap_hwmod
*oh
, u8 clockact
, u32
*v
)
383 if (!oh
->class->sysc
||
384 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_CLOCKACTIVITY
))
387 if (!oh
->class->sysc
->sysc_fields
) {
388 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
392 clkact_shift
= oh
->class->sysc
->sysc_fields
->clkact_shift
;
393 clkact_mask
= (0x3 << clkact_shift
);
396 *v
|= clockact
<< clkact_shift
;
402 * _set_softreset: set OCP_SYSCONFIG.SOFTRESET bit in @v
403 * @oh: struct omap_hwmod *
404 * @v: pointer to register contents to modify
406 * Set the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
407 * error or 0 upon success.
409 static int _set_softreset(struct omap_hwmod
*oh
, u32
*v
)
413 if (!oh
->class->sysc
||
414 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_SOFTRESET
))
417 if (!oh
->class->sysc
->sysc_fields
) {
418 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
422 softrst_mask
= (0x1 << oh
->class->sysc
->sysc_fields
->srst_shift
);
430 * _clear_softreset: clear OCP_SYSCONFIG.SOFTRESET bit in @v
431 * @oh: struct omap_hwmod *
432 * @v: pointer to register contents to modify
434 * Clear the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
435 * error or 0 upon success.
437 static int _clear_softreset(struct omap_hwmod
*oh
, u32
*v
)
441 if (!oh
->class->sysc
||
442 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_SOFTRESET
))
445 if (!oh
->class->sysc
->sysc_fields
) {
447 "omap_hwmod: %s: sysc_fields absent for sysconfig class\n",
452 softrst_mask
= (0x1 << oh
->class->sysc
->sysc_fields
->srst_shift
);
460 * _wait_softreset_complete - wait for an OCP softreset to complete
461 * @oh: struct omap_hwmod * to wait on
463 * Wait until the IP block represented by @oh reports that its OCP
464 * softreset is complete. This can be triggered by software (see
465 * _ocp_softreset()) or by hardware upon returning from off-mode (one
466 * example is HSMMC). Waits for up to MAX_MODULE_SOFTRESET_WAIT
467 * microseconds. Returns the number of microseconds waited.
469 static int _wait_softreset_complete(struct omap_hwmod
*oh
)
471 struct omap_hwmod_class_sysconfig
*sysc
;
475 sysc
= oh
->class->sysc
;
477 if (sysc
->sysc_flags
& SYSS_HAS_RESET_STATUS
)
478 omap_test_timeout((omap_hwmod_read(oh
, sysc
->syss_offs
)
479 & SYSS_RESETDONE_MASK
),
480 MAX_MODULE_SOFTRESET_WAIT
, c
);
481 else if (sysc
->sysc_flags
& SYSC_HAS_RESET_STATUS
) {
482 softrst_mask
= (0x1 << sysc
->sysc_fields
->srst_shift
);
483 omap_test_timeout(!(omap_hwmod_read(oh
, sysc
->sysc_offs
)
485 MAX_MODULE_SOFTRESET_WAIT
, c
);
492 * _set_dmadisable: set OCP_SYSCONFIG.DMADISABLE bit in @v
493 * @oh: struct omap_hwmod *
495 * The DMADISABLE bit is a semi-automatic bit present in sysconfig register
496 * of some modules. When the DMA must perform read/write accesses, the
497 * DMADISABLE bit is cleared by the hardware. But when the DMA must stop
498 * for power management, software must set the DMADISABLE bit back to 1.
500 * Set the DMADISABLE bit in @v for hwmod @oh. Returns -EINVAL upon
501 * error or 0 upon success.
503 static int _set_dmadisable(struct omap_hwmod
*oh
)
508 if (!oh
->class->sysc
||
509 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_DMADISABLE
))
512 if (!oh
->class->sysc
->sysc_fields
) {
513 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
517 /* clocks must be on for this operation */
518 if (oh
->_state
!= _HWMOD_STATE_ENABLED
) {
519 pr_warn("omap_hwmod: %s: dma can be disabled only from enabled state\n", oh
->name
);
523 pr_debug("omap_hwmod: %s: setting DMADISABLE\n", oh
->name
);
527 (0x1 << oh
->class->sysc
->sysc_fields
->dmadisable_shift
);
528 v
|= dmadisable_mask
;
529 _write_sysconfig(v
, oh
);
535 * _set_module_autoidle: set the OCP_SYSCONFIG AUTOIDLE field in @v
536 * @oh: struct omap_hwmod *
537 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
538 * @v: pointer to register contents to modify
540 * Update the module autoidle bit in @v to be @autoidle for the @oh
541 * hwmod. The autoidle bit controls whether the module can gate
542 * internal clocks automatically when it isn't doing anything; the
543 * exact function of this bit varies on a per-module basis. This
544 * function does not write to the hardware. Returns -EINVAL upon
545 * error or 0 upon success.
547 static int _set_module_autoidle(struct omap_hwmod
*oh
, u8 autoidle
,
553 if (!oh
->class->sysc
||
554 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_AUTOIDLE
))
557 if (!oh
->class->sysc
->sysc_fields
) {
558 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
562 autoidle_shift
= oh
->class->sysc
->sysc_fields
->autoidle_shift
;
563 autoidle_mask
= (0x1 << autoidle_shift
);
565 *v
&= ~autoidle_mask
;
566 *v
|= autoidle
<< autoidle_shift
;
572 * _set_idle_ioring_wakeup - enable/disable IO pad wakeup on hwmod idle for mux
573 * @oh: struct omap_hwmod *
574 * @set_wake: bool value indicating to set (true) or clear (false) wakeup enable
576 * Set or clear the I/O pad wakeup flag in the mux entries for the
577 * hwmod @oh. This function changes the @oh->mux->pads_dynamic array
578 * in memory. If the hwmod is currently idled, and the new idle
579 * values don't match the previous ones, this function will also
580 * update the SCM PADCTRL registers. Otherwise, if the hwmod is not
581 * currently idled, this function won't touch the hardware: the new
582 * mux settings are written to the SCM PADCTRL registers when the
583 * hwmod is idled. No return value.
585 static void _set_idle_ioring_wakeup(struct omap_hwmod
*oh
, bool set_wake
)
587 struct omap_device_pad
*pad
;
592 if (!oh
->mux
|| !oh
->mux
->enabled
)
595 for (j
= 0; j
< oh
->mux
->nr_pads_dynamic
; j
++) {
596 pad
= oh
->mux
->pads_dynamic
[j
];
598 if (!(pad
->flags
& OMAP_DEVICE_PAD_WAKEUP
))
601 prev_idle
= pad
->idle
;
604 pad
->idle
|= OMAP_WAKEUP_EN
;
606 pad
->idle
&= ~OMAP_WAKEUP_EN
;
608 if (prev_idle
!= pad
->idle
)
612 if (change
&& oh
->_state
== _HWMOD_STATE_IDLE
)
613 omap_hwmod_mux(oh
->mux
, _HWMOD_STATE_IDLE
);
617 * _enable_wakeup: set OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
618 * @oh: struct omap_hwmod *
620 * Allow the hardware module @oh to send wakeups. Returns -EINVAL
621 * upon error or 0 upon success.
623 static int _enable_wakeup(struct omap_hwmod
*oh
, u32
*v
)
625 if (!oh
->class->sysc
||
626 !((oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
) ||
627 (oh
->class->sysc
->idlemodes
& SIDLE_SMART_WKUP
) ||
628 (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)))
631 if (!oh
->class->sysc
->sysc_fields
) {
632 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
636 if (oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
)
637 *v
|= 0x1 << oh
->class->sysc
->sysc_fields
->enwkup_shift
;
639 if (oh
->class->sysc
->idlemodes
& SIDLE_SMART_WKUP
)
640 _set_slave_idlemode(oh
, HWMOD_IDLEMODE_SMART_WKUP
, v
);
641 if (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)
642 _set_master_standbymode(oh
, HWMOD_IDLEMODE_SMART_WKUP
, v
);
644 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
650 * _disable_wakeup: clear OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
651 * @oh: struct omap_hwmod *
653 * Prevent the hardware module @oh to send wakeups. Returns -EINVAL
654 * upon error or 0 upon success.
656 static int _disable_wakeup(struct omap_hwmod
*oh
, u32
*v
)
658 if (!oh
->class->sysc
||
659 !((oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
) ||
660 (oh
->class->sysc
->idlemodes
& SIDLE_SMART_WKUP
) ||
661 (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)))
664 if (!oh
->class->sysc
->sysc_fields
) {
665 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
669 if (oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
)
670 *v
&= ~(0x1 << oh
->class->sysc
->sysc_fields
->enwkup_shift
);
672 if (oh
->class->sysc
->idlemodes
& SIDLE_SMART_WKUP
)
673 _set_slave_idlemode(oh
, HWMOD_IDLEMODE_SMART
, v
);
674 if (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)
675 _set_master_standbymode(oh
, HWMOD_IDLEMODE_SMART
, v
);
677 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
682 static struct clockdomain
*_get_clkdm(struct omap_hwmod
*oh
)
684 struct clk_hw_omap
*clk
;
688 } else if (oh
->_clk
) {
689 if (__clk_get_flags(oh
->_clk
) & CLK_IS_BASIC
)
691 clk
= to_clk_hw_omap(__clk_get_hw(oh
->_clk
));
698 * _add_initiator_dep: prevent @oh from smart-idling while @init_oh is active
699 * @oh: struct omap_hwmod *
701 * Prevent the hardware module @oh from entering idle while the
702 * hardare module initiator @init_oh is active. Useful when a module
703 * will be accessed by a particular initiator (e.g., if a module will
704 * be accessed by the IVA, there should be a sleepdep between the IVA
705 * initiator and the module). Only applies to modules in smart-idle
706 * mode. If the clockdomain is marked as not needing autodeps, return
707 * 0 without doing anything. Otherwise, returns -EINVAL upon error or
708 * passes along clkdm_add_sleepdep() value upon success.
710 static int _add_initiator_dep(struct omap_hwmod
*oh
, struct omap_hwmod
*init_oh
)
712 struct clockdomain
*clkdm
, *init_clkdm
;
714 clkdm
= _get_clkdm(oh
);
715 init_clkdm
= _get_clkdm(init_oh
);
717 if (!clkdm
|| !init_clkdm
)
720 if (clkdm
&& clkdm
->flags
& CLKDM_NO_AUTODEPS
)
723 return clkdm_add_sleepdep(clkdm
, init_clkdm
);
727 * _del_initiator_dep: allow @oh to smart-idle even if @init_oh is active
728 * @oh: struct omap_hwmod *
730 * Allow the hardware module @oh to enter idle while the hardare
731 * module initiator @init_oh is active. Useful when a module will not
732 * be accessed by a particular initiator (e.g., if a module will not
733 * be accessed by the IVA, there should be no sleepdep between the IVA
734 * initiator and the module). Only applies to modules in smart-idle
735 * mode. If the clockdomain is marked as not needing autodeps, return
736 * 0 without doing anything. Returns -EINVAL upon error or passes
737 * along clkdm_del_sleepdep() value upon success.
739 static int _del_initiator_dep(struct omap_hwmod
*oh
, struct omap_hwmod
*init_oh
)
741 struct clockdomain
*clkdm
, *init_clkdm
;
743 clkdm
= _get_clkdm(oh
);
744 init_clkdm
= _get_clkdm(init_oh
);
746 if (!clkdm
|| !init_clkdm
)
749 if (clkdm
&& clkdm
->flags
& CLKDM_NO_AUTODEPS
)
752 return clkdm_del_sleepdep(clkdm
, init_clkdm
);
756 * _init_main_clk - get a struct clk * for the the hwmod's main functional clk
757 * @oh: struct omap_hwmod *
759 * Called from _init_clocks(). Populates the @oh _clk (main
760 * functional clock pointer) if a main_clk is present. Returns 0 on
761 * success or -EINVAL on error.
763 static int _init_main_clk(struct omap_hwmod
*oh
)
770 oh
->_clk
= clk_get(NULL
, oh
->main_clk
);
771 if (IS_ERR(oh
->_clk
)) {
772 pr_warning("omap_hwmod: %s: cannot clk_get main_clk %s\n",
773 oh
->name
, oh
->main_clk
);
777 * HACK: This needs a re-visit once clk_prepare() is implemented
778 * to do something meaningful. Today its just a no-op.
779 * If clk_prepare() is used at some point to do things like
780 * voltage scaling etc, then this would have to be moved to
781 * some point where subsystems like i2c and pmic become
784 clk_prepare(oh
->_clk
);
787 pr_debug("omap_hwmod: %s: missing clockdomain for %s.\n",
788 oh
->name
, oh
->main_clk
);
794 * _init_interface_clks - get a struct clk * for the the hwmod's interface clks
795 * @oh: struct omap_hwmod *
797 * Called from _init_clocks(). Populates the @oh OCP slave interface
798 * clock pointers. Returns 0 on success or -EINVAL on error.
800 static int _init_interface_clks(struct omap_hwmod
*oh
)
802 struct omap_hwmod_ocp_if
*os
;
808 p
= oh
->slave_ports
.next
;
810 while (i
< oh
->slaves_cnt
) {
811 os
= _fetch_next_ocp_if(&p
, &i
);
815 c
= clk_get(NULL
, os
->clk
);
817 pr_warning("omap_hwmod: %s: cannot clk_get interface_clk %s\n",
824 * HACK: This needs a re-visit once clk_prepare() is implemented
825 * to do something meaningful. Today its just a no-op.
826 * If clk_prepare() is used at some point to do things like
827 * voltage scaling etc, then this would have to be moved to
828 * some point where subsystems like i2c and pmic become
831 clk_prepare(os
->_clk
);
838 * _init_opt_clk - get a struct clk * for the the hwmod's optional clocks
839 * @oh: struct omap_hwmod *
841 * Called from _init_clocks(). Populates the @oh omap_hwmod_opt_clk
842 * clock pointers. Returns 0 on success or -EINVAL on error.
844 static int _init_opt_clks(struct omap_hwmod
*oh
)
846 struct omap_hwmod_opt_clk
*oc
;
851 for (i
= oh
->opt_clks_cnt
, oc
= oh
->opt_clks
; i
> 0; i
--, oc
++) {
852 c
= clk_get(NULL
, oc
->clk
);
854 pr_warning("omap_hwmod: %s: cannot clk_get opt_clk %s\n",
861 * HACK: This needs a re-visit once clk_prepare() is implemented
862 * to do something meaningful. Today its just a no-op.
863 * If clk_prepare() is used at some point to do things like
864 * voltage scaling etc, then this would have to be moved to
865 * some point where subsystems like i2c and pmic become
868 clk_prepare(oc
->_clk
);
875 * _enable_clocks - enable hwmod main clock and interface clocks
876 * @oh: struct omap_hwmod *
878 * Enables all clocks necessary for register reads and writes to succeed
879 * on the hwmod @oh. Returns 0.
881 static int _enable_clocks(struct omap_hwmod
*oh
)
883 struct omap_hwmod_ocp_if
*os
;
887 pr_debug("omap_hwmod: %s: enabling clocks\n", oh
->name
);
890 clk_enable(oh
->_clk
);
892 p
= oh
->slave_ports
.next
;
894 while (i
< oh
->slaves_cnt
) {
895 os
= _fetch_next_ocp_if(&p
, &i
);
897 if (os
->_clk
&& (os
->flags
& OCPIF_SWSUP_IDLE
))
898 clk_enable(os
->_clk
);
901 /* The opt clocks are controlled by the device driver. */
907 * _disable_clocks - disable hwmod main clock and interface clocks
908 * @oh: struct omap_hwmod *
910 * Disables the hwmod @oh main functional and interface clocks. Returns 0.
912 static int _disable_clocks(struct omap_hwmod
*oh
)
914 struct omap_hwmod_ocp_if
*os
;
918 pr_debug("omap_hwmod: %s: disabling clocks\n", oh
->name
);
921 clk_disable(oh
->_clk
);
923 p
= oh
->slave_ports
.next
;
925 while (i
< oh
->slaves_cnt
) {
926 os
= _fetch_next_ocp_if(&p
, &i
);
928 if (os
->_clk
&& (os
->flags
& OCPIF_SWSUP_IDLE
))
929 clk_disable(os
->_clk
);
932 /* The opt clocks are controlled by the device driver. */
937 static void _enable_optional_clocks(struct omap_hwmod
*oh
)
939 struct omap_hwmod_opt_clk
*oc
;
942 pr_debug("omap_hwmod: %s: enabling optional clocks\n", oh
->name
);
944 for (i
= oh
->opt_clks_cnt
, oc
= oh
->opt_clks
; i
> 0; i
--, oc
++)
946 pr_debug("omap_hwmod: enable %s:%s\n", oc
->role
,
947 __clk_get_name(oc
->_clk
));
948 clk_enable(oc
->_clk
);
952 static void _disable_optional_clocks(struct omap_hwmod
*oh
)
954 struct omap_hwmod_opt_clk
*oc
;
957 pr_debug("omap_hwmod: %s: disabling optional clocks\n", oh
->name
);
959 for (i
= oh
->opt_clks_cnt
, oc
= oh
->opt_clks
; i
> 0; i
--, oc
++)
961 pr_debug("omap_hwmod: disable %s:%s\n", oc
->role
,
962 __clk_get_name(oc
->_clk
));
963 clk_disable(oc
->_clk
);
968 * _omap4_enable_module - enable CLKCTRL modulemode on OMAP4
969 * @oh: struct omap_hwmod *
971 * Enables the PRCM module mode related to the hwmod @oh.
974 static void _omap4_enable_module(struct omap_hwmod
*oh
)
976 if (!oh
->clkdm
|| !oh
->prcm
.omap4
.modulemode
)
979 pr_debug("omap_hwmod: %s: %s: %d\n",
980 oh
->name
, __func__
, oh
->prcm
.omap4
.modulemode
);
982 omap4_cminst_module_enable(oh
->prcm
.omap4
.modulemode
,
983 oh
->clkdm
->prcm_partition
,
985 oh
->clkdm
->clkdm_offs
,
986 oh
->prcm
.omap4
.clkctrl_offs
);
990 * _am33xx_enable_module - enable CLKCTRL modulemode on AM33XX
991 * @oh: struct omap_hwmod *
993 * Enables the PRCM module mode related to the hwmod @oh.
996 static void _am33xx_enable_module(struct omap_hwmod
*oh
)
998 if (!oh
->clkdm
|| !oh
->prcm
.omap4
.modulemode
)
1001 pr_debug("omap_hwmod: %s: %s: %d\n",
1002 oh
->name
, __func__
, oh
->prcm
.omap4
.modulemode
);
1004 am33xx_cm_module_enable(oh
->prcm
.omap4
.modulemode
, oh
->clkdm
->cm_inst
,
1005 oh
->clkdm
->clkdm_offs
,
1006 oh
->prcm
.omap4
.clkctrl_offs
);
1010 * _omap4_wait_target_disable - wait for a module to be disabled on OMAP4
1011 * @oh: struct omap_hwmod *
1013 * Wait for a module @oh to enter slave idle. Returns 0 if the module
1014 * does not have an IDLEST bit or if the module successfully enters
1015 * slave idle; otherwise, pass along the return value of the
1016 * appropriate *_cm*_wait_module_idle() function.
1018 static int _omap4_wait_target_disable(struct omap_hwmod
*oh
)
1023 if (oh
->_int_flags
& _HWMOD_NO_MPU_PORT
|| !oh
->clkdm
)
1026 if (oh
->flags
& HWMOD_NO_IDLEST
)
1029 return omap4_cminst_wait_module_idle(oh
->clkdm
->prcm_partition
,
1031 oh
->clkdm
->clkdm_offs
,
1032 oh
->prcm
.omap4
.clkctrl_offs
);
1036 * _am33xx_wait_target_disable - wait for a module to be disabled on AM33XX
1037 * @oh: struct omap_hwmod *
1039 * Wait for a module @oh to enter slave idle. Returns 0 if the module
1040 * does not have an IDLEST bit or if the module successfully enters
1041 * slave idle; otherwise, pass along the return value of the
1042 * appropriate *_cm*_wait_module_idle() function.
1044 static int _am33xx_wait_target_disable(struct omap_hwmod
*oh
)
1049 if (oh
->_int_flags
& _HWMOD_NO_MPU_PORT
)
1052 if (oh
->flags
& HWMOD_NO_IDLEST
)
1055 return am33xx_cm_wait_module_idle(oh
->clkdm
->cm_inst
,
1056 oh
->clkdm
->clkdm_offs
,
1057 oh
->prcm
.omap4
.clkctrl_offs
);
1061 * _count_mpu_irqs - count the number of MPU IRQ lines associated with @oh
1062 * @oh: struct omap_hwmod *oh
1064 * Count and return the number of MPU IRQs associated with the hwmod
1065 * @oh. Used to allocate struct resource data. Returns 0 if @oh is
1068 static int _count_mpu_irqs(struct omap_hwmod
*oh
)
1070 struct omap_hwmod_irq_info
*ohii
;
1073 if (!oh
|| !oh
->mpu_irqs
)
1077 ohii
= &oh
->mpu_irqs
[i
++];
1078 } while (ohii
->irq
!= -1);
1084 * _count_sdma_reqs - count the number of SDMA request lines associated with @oh
1085 * @oh: struct omap_hwmod *oh
1087 * Count and return the number of SDMA request lines associated with
1088 * the hwmod @oh. Used to allocate struct resource data. Returns 0
1091 static int _count_sdma_reqs(struct omap_hwmod
*oh
)
1093 struct omap_hwmod_dma_info
*ohdi
;
1096 if (!oh
|| !oh
->sdma_reqs
)
1100 ohdi
= &oh
->sdma_reqs
[i
++];
1101 } while (ohdi
->dma_req
!= -1);
1107 * _count_ocp_if_addr_spaces - count the number of address space entries for @oh
1108 * @oh: struct omap_hwmod *oh
1110 * Count and return the number of address space ranges associated with
1111 * the hwmod @oh. Used to allocate struct resource data. Returns 0
1114 static int _count_ocp_if_addr_spaces(struct omap_hwmod_ocp_if
*os
)
1116 struct omap_hwmod_addr_space
*mem
;
1119 if (!os
|| !os
->addr
)
1123 mem
= &os
->addr
[i
++];
1124 } while (mem
->pa_start
!= mem
->pa_end
);
1130 * _get_mpu_irq_by_name - fetch MPU interrupt line number by name
1131 * @oh: struct omap_hwmod * to operate on
1132 * @name: pointer to the name of the MPU interrupt number to fetch (optional)
1133 * @irq: pointer to an unsigned int to store the MPU IRQ number to
1135 * Retrieve a MPU hardware IRQ line number named by @name associated
1136 * with the IP block pointed to by @oh. The IRQ number will be filled
1137 * into the address pointed to by @dma. When @name is non-null, the
1138 * IRQ line number associated with the named entry will be returned.
1139 * If @name is null, the first matching entry will be returned. Data
1140 * order is not meaningful in hwmod data, so callers are strongly
1141 * encouraged to use a non-null @name whenever possible to avoid
1142 * unpredictable effects if hwmod data is later added that causes data
1143 * ordering to change. Returns 0 upon success or a negative error
1146 static int _get_mpu_irq_by_name(struct omap_hwmod
*oh
, const char *name
,
1156 while (oh
->mpu_irqs
[i
].irq
!= -1) {
1157 if (name
== oh
->mpu_irqs
[i
].name
||
1158 !strcmp(name
, oh
->mpu_irqs
[i
].name
)) {
1168 *irq
= oh
->mpu_irqs
[i
].irq
;
1174 * _get_sdma_req_by_name - fetch SDMA request line ID by name
1175 * @oh: struct omap_hwmod * to operate on
1176 * @name: pointer to the name of the SDMA request line to fetch (optional)
1177 * @dma: pointer to an unsigned int to store the request line ID to
1179 * Retrieve an SDMA request line ID named by @name on the IP block
1180 * pointed to by @oh. The ID will be filled into the address pointed
1181 * to by @dma. When @name is non-null, the request line ID associated
1182 * with the named entry will be returned. If @name is null, the first
1183 * matching entry will be returned. Data order is not meaningful in
1184 * hwmod data, so callers are strongly encouraged to use a non-null
1185 * @name whenever possible to avoid unpredictable effects if hwmod
1186 * data is later added that causes data ordering to change. Returns 0
1187 * upon success or a negative error code upon error.
1189 static int _get_sdma_req_by_name(struct omap_hwmod
*oh
, const char *name
,
1199 while (oh
->sdma_reqs
[i
].dma_req
!= -1) {
1200 if (name
== oh
->sdma_reqs
[i
].name
||
1201 !strcmp(name
, oh
->sdma_reqs
[i
].name
)) {
1211 *dma
= oh
->sdma_reqs
[i
].dma_req
;
1217 * _get_addr_space_by_name - fetch address space start & end by name
1218 * @oh: struct omap_hwmod * to operate on
1219 * @name: pointer to the name of the address space to fetch (optional)
1220 * @pa_start: pointer to a u32 to store the starting address to
1221 * @pa_end: pointer to a u32 to store the ending address to
1223 * Retrieve address space start and end addresses for the IP block
1224 * pointed to by @oh. The data will be filled into the addresses
1225 * pointed to by @pa_start and @pa_end. When @name is non-null, the
1226 * address space data associated with the named entry will be
1227 * returned. If @name is null, the first matching entry will be
1228 * returned. Data order is not meaningful in hwmod data, so callers
1229 * are strongly encouraged to use a non-null @name whenever possible
1230 * to avoid unpredictable effects if hwmod data is later added that
1231 * causes data ordering to change. Returns 0 upon success or a
1232 * negative error code upon error.
1234 static int _get_addr_space_by_name(struct omap_hwmod
*oh
, const char *name
,
1235 u32
*pa_start
, u32
*pa_end
)
1238 struct omap_hwmod_ocp_if
*os
;
1239 struct list_head
*p
= NULL
;
1242 p
= oh
->slave_ports
.next
;
1245 while (i
< oh
->slaves_cnt
) {
1246 os
= _fetch_next_ocp_if(&p
, &i
);
1252 while (os
->addr
[j
].pa_start
!= os
->addr
[j
].pa_end
) {
1253 if (name
== os
->addr
[j
].name
||
1254 !strcmp(name
, os
->addr
[j
].name
)) {
1268 *pa_start
= os
->addr
[j
].pa_start
;
1269 *pa_end
= os
->addr
[j
].pa_end
;
1275 * _save_mpu_port_index - find and save the index to @oh's MPU port
1276 * @oh: struct omap_hwmod *
1278 * Determines the array index of the OCP slave port that the MPU uses
1279 * to address the device, and saves it into the struct omap_hwmod.
1280 * Intended to be called during hwmod registration only. No return
1283 static void __init
_save_mpu_port_index(struct omap_hwmod
*oh
)
1285 struct omap_hwmod_ocp_if
*os
= NULL
;
1286 struct list_head
*p
;
1292 oh
->_int_flags
|= _HWMOD_NO_MPU_PORT
;
1294 p
= oh
->slave_ports
.next
;
1296 while (i
< oh
->slaves_cnt
) {
1297 os
= _fetch_next_ocp_if(&p
, &i
);
1298 if (os
->user
& OCP_USER_MPU
) {
1300 oh
->_int_flags
&= ~_HWMOD_NO_MPU_PORT
;
1309 * _find_mpu_rt_port - return omap_hwmod_ocp_if accessible by the MPU
1310 * @oh: struct omap_hwmod *
1312 * Given a pointer to a struct omap_hwmod record @oh, return a pointer
1313 * to the struct omap_hwmod_ocp_if record that is used by the MPU to
1314 * communicate with the IP block. This interface need not be directly
1315 * connected to the MPU (and almost certainly is not), but is directly
1316 * connected to the IP block represented by @oh. Returns a pointer
1317 * to the struct omap_hwmod_ocp_if * upon success, or returns NULL upon
1318 * error or if there does not appear to be a path from the MPU to this
1321 static struct omap_hwmod_ocp_if
*_find_mpu_rt_port(struct omap_hwmod
*oh
)
1323 if (!oh
|| oh
->_int_flags
& _HWMOD_NO_MPU_PORT
|| oh
->slaves_cnt
== 0)
1326 return oh
->_mpu_port
;
1330 * _find_mpu_rt_addr_space - return MPU register target address space for @oh
1331 * @oh: struct omap_hwmod *
1333 * Returns a pointer to the struct omap_hwmod_addr_space record representing
1334 * the register target MPU address space; or returns NULL upon error.
1336 static struct omap_hwmod_addr_space
* __init
_find_mpu_rt_addr_space(struct omap_hwmod
*oh
)
1338 struct omap_hwmod_ocp_if
*os
;
1339 struct omap_hwmod_addr_space
*mem
;
1340 int found
= 0, i
= 0;
1342 os
= _find_mpu_rt_port(oh
);
1343 if (!os
|| !os
->addr
)
1347 mem
= &os
->addr
[i
++];
1348 if (mem
->flags
& ADDR_TYPE_RT
)
1350 } while (!found
&& mem
->pa_start
!= mem
->pa_end
);
1352 return (found
) ? mem
: NULL
;
1356 * _enable_sysc - try to bring a module out of idle via OCP_SYSCONFIG
1357 * @oh: struct omap_hwmod *
1359 * Ensure that the OCP_SYSCONFIG register for the IP block represented
1360 * by @oh is set to indicate to the PRCM that the IP block is active.
1361 * Usually this means placing the module into smart-idle mode and
1362 * smart-standby, but if there is a bug in the automatic idle handling
1363 * for the IP block, it may need to be placed into the force-idle or
1364 * no-idle variants of these modes. No return value.
1366 static void _enable_sysc(struct omap_hwmod
*oh
)
1371 struct clockdomain
*clkdm
;
1373 if (!oh
->class->sysc
)
1377 * Wait until reset has completed, this is needed as the IP
1378 * block is reset automatically by hardware in some cases
1379 * (off-mode for example), and the drivers require the
1380 * IP to be ready when they access it
1382 if (oh
->flags
& HWMOD_CONTROL_OPT_CLKS_IN_RESET
)
1383 _enable_optional_clocks(oh
);
1384 _wait_softreset_complete(oh
);
1385 if (oh
->flags
& HWMOD_CONTROL_OPT_CLKS_IN_RESET
)
1386 _disable_optional_clocks(oh
);
1388 v
= oh
->_sysc_cache
;
1389 sf
= oh
->class->sysc
->sysc_flags
;
1391 clkdm
= _get_clkdm(oh
);
1392 if (sf
& SYSC_HAS_SIDLEMODE
) {
1393 if (oh
->flags
& HWMOD_SWSUP_SIDLE
||
1394 oh
->flags
& HWMOD_SWSUP_SIDLE_ACT
) {
1395 idlemode
= HWMOD_IDLEMODE_NO
;
1397 if (sf
& SYSC_HAS_ENAWAKEUP
)
1398 _enable_wakeup(oh
, &v
);
1399 if (oh
->class->sysc
->idlemodes
& SIDLE_SMART_WKUP
)
1400 idlemode
= HWMOD_IDLEMODE_SMART_WKUP
;
1402 idlemode
= HWMOD_IDLEMODE_SMART
;
1406 * This is special handling for some IPs like
1407 * 32k sync timer. Force them to idle!
1409 clkdm_act
= (clkdm
&& clkdm
->flags
& CLKDM_ACTIVE_WITH_MPU
);
1410 if (clkdm_act
&& !(oh
->class->sysc
->idlemodes
&
1411 (SIDLE_SMART
| SIDLE_SMART_WKUP
)))
1412 idlemode
= HWMOD_IDLEMODE_FORCE
;
1414 _set_slave_idlemode(oh
, idlemode
, &v
);
1417 if (sf
& SYSC_HAS_MIDLEMODE
) {
1418 if (oh
->flags
& HWMOD_FORCE_MSTANDBY
) {
1419 idlemode
= HWMOD_IDLEMODE_FORCE
;
1420 } else if (oh
->flags
& HWMOD_SWSUP_MSTANDBY
) {
1421 idlemode
= HWMOD_IDLEMODE_NO
;
1423 if (sf
& SYSC_HAS_ENAWAKEUP
)
1424 _enable_wakeup(oh
, &v
);
1425 if (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)
1426 idlemode
= HWMOD_IDLEMODE_SMART_WKUP
;
1428 idlemode
= HWMOD_IDLEMODE_SMART
;
1430 _set_master_standbymode(oh
, idlemode
, &v
);
1434 * XXX The clock framework should handle this, by
1435 * calling into this code. But this must wait until the
1436 * clock structures are tagged with omap_hwmod entries
1438 if ((oh
->flags
& HWMOD_SET_DEFAULT_CLOCKACT
) &&
1439 (sf
& SYSC_HAS_CLOCKACTIVITY
))
1440 _set_clockactivity(oh
, oh
->class->sysc
->clockact
, &v
);
1442 /* If the cached value is the same as the new value, skip the write */
1443 if (oh
->_sysc_cache
!= v
)
1444 _write_sysconfig(v
, oh
);
1447 * Set the autoidle bit only after setting the smartidle bit
1448 * Setting this will not have any impact on the other modules.
1450 if (sf
& SYSC_HAS_AUTOIDLE
) {
1451 idlemode
= (oh
->flags
& HWMOD_NO_OCP_AUTOIDLE
) ?
1453 _set_module_autoidle(oh
, idlemode
, &v
);
1454 _write_sysconfig(v
, oh
);
1459 * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
1460 * @oh: struct omap_hwmod *
1462 * If module is marked as SWSUP_SIDLE, force the module into slave
1463 * idle; otherwise, configure it for smart-idle. If module is marked
1464 * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
1465 * configure it for smart-standby. No return value.
1467 static void _idle_sysc(struct omap_hwmod
*oh
)
1472 if (!oh
->class->sysc
)
1475 v
= oh
->_sysc_cache
;
1476 sf
= oh
->class->sysc
->sysc_flags
;
1478 if (sf
& SYSC_HAS_SIDLEMODE
) {
1479 if (oh
->flags
& HWMOD_SWSUP_SIDLE
) {
1480 idlemode
= HWMOD_IDLEMODE_FORCE
;
1482 if (sf
& SYSC_HAS_ENAWAKEUP
)
1483 _enable_wakeup(oh
, &v
);
1484 if (oh
->class->sysc
->idlemodes
& SIDLE_SMART_WKUP
)
1485 idlemode
= HWMOD_IDLEMODE_SMART_WKUP
;
1487 idlemode
= HWMOD_IDLEMODE_SMART
;
1489 _set_slave_idlemode(oh
, idlemode
, &v
);
1492 if (sf
& SYSC_HAS_MIDLEMODE
) {
1493 if ((oh
->flags
& HWMOD_SWSUP_MSTANDBY
) ||
1494 (oh
->flags
& HWMOD_FORCE_MSTANDBY
)) {
1495 idlemode
= HWMOD_IDLEMODE_FORCE
;
1497 if (sf
& SYSC_HAS_ENAWAKEUP
)
1498 _enable_wakeup(oh
, &v
);
1499 if (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)
1500 idlemode
= HWMOD_IDLEMODE_SMART_WKUP
;
1502 idlemode
= HWMOD_IDLEMODE_SMART
;
1504 _set_master_standbymode(oh
, idlemode
, &v
);
1507 _write_sysconfig(v
, oh
);
1511 * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
1512 * @oh: struct omap_hwmod *
1514 * Force the module into slave idle and master suspend. No return
1517 static void _shutdown_sysc(struct omap_hwmod
*oh
)
1522 if (!oh
->class->sysc
)
1525 v
= oh
->_sysc_cache
;
1526 sf
= oh
->class->sysc
->sysc_flags
;
1528 if (sf
& SYSC_HAS_SIDLEMODE
)
1529 _set_slave_idlemode(oh
, HWMOD_IDLEMODE_FORCE
, &v
);
1531 if (sf
& SYSC_HAS_MIDLEMODE
)
1532 _set_master_standbymode(oh
, HWMOD_IDLEMODE_FORCE
, &v
);
1534 if (sf
& SYSC_HAS_AUTOIDLE
)
1535 _set_module_autoidle(oh
, 1, &v
);
1537 _write_sysconfig(v
, oh
);
1541 * _lookup - find an omap_hwmod by name
1542 * @name: find an omap_hwmod by name
1544 * Return a pointer to an omap_hwmod by name, or NULL if not found.
1546 static struct omap_hwmod
*_lookup(const char *name
)
1548 struct omap_hwmod
*oh
, *temp_oh
;
1552 list_for_each_entry(temp_oh
, &omap_hwmod_list
, node
) {
1553 if (!strcmp(name
, temp_oh
->name
)) {
1563 * _init_clkdm - look up a clockdomain name, store pointer in omap_hwmod
1564 * @oh: struct omap_hwmod *
1566 * Convert a clockdomain name stored in a struct omap_hwmod into a
1567 * clockdomain pointer, and save it into the struct omap_hwmod.
1568 * Return -EINVAL if the clkdm_name lookup failed.
1570 static int _init_clkdm(struct omap_hwmod
*oh
)
1572 if (!oh
->clkdm_name
) {
1573 pr_debug("omap_hwmod: %s: missing clockdomain\n", oh
->name
);
1577 oh
->clkdm
= clkdm_lookup(oh
->clkdm_name
);
1579 pr_warning("omap_hwmod: %s: could not associate to clkdm %s\n",
1580 oh
->name
, oh
->clkdm_name
);
1584 pr_debug("omap_hwmod: %s: associated to clkdm %s\n",
1585 oh
->name
, oh
->clkdm_name
);
1591 * _init_clocks - clk_get() all clocks associated with this hwmod. Retrieve as
1592 * well the clockdomain.
1593 * @oh: struct omap_hwmod *
1594 * @data: not used; pass NULL
1596 * Called by omap_hwmod_setup_*() (after omap2_clk_init()).
1597 * Resolves all clock names embedded in the hwmod. Returns 0 on
1598 * success, or a negative error code on failure.
1600 static int _init_clocks(struct omap_hwmod
*oh
, void *data
)
1604 if (oh
->_state
!= _HWMOD_STATE_REGISTERED
)
1607 pr_debug("omap_hwmod: %s: looking up clocks\n", oh
->name
);
1609 if (soc_ops
.init_clkdm
)
1610 ret
|= soc_ops
.init_clkdm(oh
);
1612 ret
|= _init_main_clk(oh
);
1613 ret
|= _init_interface_clks(oh
);
1614 ret
|= _init_opt_clks(oh
);
1617 oh
->_state
= _HWMOD_STATE_CLKS_INITED
;
1619 pr_warning("omap_hwmod: %s: cannot _init_clocks\n", oh
->name
);
1625 * _lookup_hardreset - fill register bit info for this hwmod/reset line
1626 * @oh: struct omap_hwmod *
1627 * @name: name of the reset line in the context of this hwmod
1628 * @ohri: struct omap_hwmod_rst_info * that this function will fill in
1630 * Return the bit position of the reset line that match the
1631 * input name. Return -ENOENT if not found.
1633 static int _lookup_hardreset(struct omap_hwmod
*oh
, const char *name
,
1634 struct omap_hwmod_rst_info
*ohri
)
1638 for (i
= 0; i
< oh
->rst_lines_cnt
; i
++) {
1639 const char *rst_line
= oh
->rst_lines
[i
].name
;
1640 if (!strcmp(rst_line
, name
)) {
1641 ohri
->rst_shift
= oh
->rst_lines
[i
].rst_shift
;
1642 ohri
->st_shift
= oh
->rst_lines
[i
].st_shift
;
1643 pr_debug("omap_hwmod: %s: %s: %s: rst %d st %d\n",
1644 oh
->name
, __func__
, rst_line
, ohri
->rst_shift
,
1655 * _assert_hardreset - assert the HW reset line of submodules
1656 * contained in the hwmod module.
1657 * @oh: struct omap_hwmod *
1658 * @name: name of the reset line to lookup and assert
1660 * Some IP like dsp, ipu or iva contain processor that require an HW
1661 * reset line to be assert / deassert in order to enable fully the IP.
1662 * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1663 * asserting the hardreset line on the currently-booted SoC, or passes
1664 * along the return value from _lookup_hardreset() or the SoC's
1665 * assert_hardreset code.
1667 static int _assert_hardreset(struct omap_hwmod
*oh
, const char *name
)
1669 struct omap_hwmod_rst_info ohri
;
1675 if (!soc_ops
.assert_hardreset
)
1678 ret
= _lookup_hardreset(oh
, name
, &ohri
);
1682 ret
= soc_ops
.assert_hardreset(oh
, &ohri
);
1688 * _deassert_hardreset - deassert the HW reset line of submodules contained
1689 * in the hwmod module.
1690 * @oh: struct omap_hwmod *
1691 * @name: name of the reset line to look up and deassert
1693 * Some IP like dsp, ipu or iva contain processor that require an HW
1694 * reset line to be assert / deassert in order to enable fully the IP.
1695 * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1696 * deasserting the hardreset line on the currently-booted SoC, or passes
1697 * along the return value from _lookup_hardreset() or the SoC's
1698 * deassert_hardreset code.
1700 static int _deassert_hardreset(struct omap_hwmod
*oh
, const char *name
)
1702 struct omap_hwmod_rst_info ohri
;
1709 if (!soc_ops
.deassert_hardreset
)
1712 ret
= _lookup_hardreset(oh
, name
, &ohri
);
1718 * A clockdomain must be in SW_SUP otherwise reset
1719 * might not be completed. The clockdomain can be set
1720 * in HW_AUTO only when the module become ready.
1722 hwsup
= clkdm_in_hwsup(oh
->clkdm
);
1723 ret
= clkdm_hwmod_enable(oh
->clkdm
, oh
);
1725 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1726 oh
->name
, oh
->clkdm
->name
, ret
);
1732 if (soc_ops
.enable_module
)
1733 soc_ops
.enable_module(oh
);
1735 ret
= soc_ops
.deassert_hardreset(oh
, &ohri
);
1737 if (soc_ops
.disable_module
)
1738 soc_ops
.disable_module(oh
);
1739 _disable_clocks(oh
);
1742 pr_warning("omap_hwmod: %s: failed to hardreset\n", oh
->name
);
1746 * Set the clockdomain to HW_AUTO, assuming that the
1747 * previous state was HW_AUTO.
1749 if (oh
->clkdm
&& hwsup
)
1750 clkdm_allow_idle(oh
->clkdm
);
1753 clkdm_hwmod_disable(oh
->clkdm
, oh
);
1760 * _read_hardreset - read the HW reset line state of submodules
1761 * contained in the hwmod module
1762 * @oh: struct omap_hwmod *
1763 * @name: name of the reset line to look up and read
1765 * Return the state of the reset line. Returns -EINVAL if @oh is
1766 * null, -ENOSYS if we have no way of reading the hardreset line
1767 * status on the currently-booted SoC, or passes along the return
1768 * value from _lookup_hardreset() or the SoC's is_hardreset_asserted
1771 static int _read_hardreset(struct omap_hwmod
*oh
, const char *name
)
1773 struct omap_hwmod_rst_info ohri
;
1779 if (!soc_ops
.is_hardreset_asserted
)
1782 ret
= _lookup_hardreset(oh
, name
, &ohri
);
1786 return soc_ops
.is_hardreset_asserted(oh
, &ohri
);
1790 * _are_all_hardreset_lines_asserted - return true if the @oh is hard-reset
1791 * @oh: struct omap_hwmod *
1793 * If all hardreset lines associated with @oh are asserted, then return true.
1794 * Otherwise, if part of @oh is out hardreset or if no hardreset lines
1795 * associated with @oh are asserted, then return false.
1796 * This function is used to avoid executing some parts of the IP block
1797 * enable/disable sequence if its hardreset line is set.
1799 static bool _are_all_hardreset_lines_asserted(struct omap_hwmod
*oh
)
1803 if (oh
->rst_lines_cnt
== 0)
1806 for (i
= 0; i
< oh
->rst_lines_cnt
; i
++)
1807 if (_read_hardreset(oh
, oh
->rst_lines
[i
].name
) > 0)
1810 if (oh
->rst_lines_cnt
== rst_cnt
)
1817 * _are_any_hardreset_lines_asserted - return true if any part of @oh is
1819 * @oh: struct omap_hwmod *
1821 * If any hardreset lines associated with @oh are asserted, then
1822 * return true. Otherwise, if no hardreset lines associated with @oh
1823 * are asserted, or if @oh has no hardreset lines, then return false.
1824 * This function is used to avoid executing some parts of the IP block
1825 * enable/disable sequence if any hardreset line is set.
1827 static bool _are_any_hardreset_lines_asserted(struct omap_hwmod
*oh
)
1832 for (i
= 0; i
< oh
->rst_lines_cnt
&& rst_cnt
== 0; i
++)
1833 if (_read_hardreset(oh
, oh
->rst_lines
[i
].name
) > 0)
1836 return (rst_cnt
) ? true : false;
1840 * _omap4_disable_module - enable CLKCTRL modulemode on OMAP4
1841 * @oh: struct omap_hwmod *
1843 * Disable the PRCM module mode related to the hwmod @oh.
1844 * Return EINVAL if the modulemode is not supported and 0 in case of success.
1846 static int _omap4_disable_module(struct omap_hwmod
*oh
)
1850 if (!oh
->clkdm
|| !oh
->prcm
.omap4
.modulemode
)
1854 * Since integration code might still be doing something, only
1855 * disable if all lines are under hardreset.
1857 if (_are_any_hardreset_lines_asserted(oh
))
1860 pr_debug("omap_hwmod: %s: %s\n", oh
->name
, __func__
);
1862 omap4_cminst_module_disable(oh
->clkdm
->prcm_partition
,
1864 oh
->clkdm
->clkdm_offs
,
1865 oh
->prcm
.omap4
.clkctrl_offs
);
1867 v
= _omap4_wait_target_disable(oh
);
1869 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1876 * _am33xx_disable_module - enable CLKCTRL modulemode on AM33XX
1877 * @oh: struct omap_hwmod *
1879 * Disable the PRCM module mode related to the hwmod @oh.
1880 * Return EINVAL if the modulemode is not supported and 0 in case of success.
1882 static int _am33xx_disable_module(struct omap_hwmod
*oh
)
1886 if (!oh
->clkdm
|| !oh
->prcm
.omap4
.modulemode
)
1889 pr_debug("omap_hwmod: %s: %s\n", oh
->name
, __func__
);
1891 if (_are_any_hardreset_lines_asserted(oh
))
1894 am33xx_cm_module_disable(oh
->clkdm
->cm_inst
, oh
->clkdm
->clkdm_offs
,
1895 oh
->prcm
.omap4
.clkctrl_offs
);
1897 v
= _am33xx_wait_target_disable(oh
);
1899 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1906 * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1907 * @oh: struct omap_hwmod *
1909 * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit. hwmod must be
1910 * enabled for this to work. Returns -ENOENT if the hwmod cannot be
1911 * reset this way, -EINVAL if the hwmod is in the wrong state,
1912 * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1914 * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1915 * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1916 * use the SYSCONFIG softreset bit to provide the status.
1918 * Note that some IP like McBSP do have reset control but don't have
1921 static int _ocp_softreset(struct omap_hwmod
*oh
)
1927 if (!oh
->class->sysc
||
1928 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_SOFTRESET
))
1931 /* clocks must be on for this operation */
1932 if (oh
->_state
!= _HWMOD_STATE_ENABLED
) {
1933 pr_warn("omap_hwmod: %s: reset can only be entered from enabled state\n",
1938 /* For some modules, all optionnal clocks need to be enabled as well */
1939 if (oh
->flags
& HWMOD_CONTROL_OPT_CLKS_IN_RESET
)
1940 _enable_optional_clocks(oh
);
1942 pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh
->name
);
1944 v
= oh
->_sysc_cache
;
1945 ret
= _set_softreset(oh
, &v
);
1949 _write_sysconfig(v
, oh
);
1951 if (oh
->class->sysc
->srst_udelay
)
1952 udelay(oh
->class->sysc
->srst_udelay
);
1954 c
= _wait_softreset_complete(oh
);
1955 if (c
== MAX_MODULE_SOFTRESET_WAIT
) {
1956 pr_warning("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1957 oh
->name
, MAX_MODULE_SOFTRESET_WAIT
);
1961 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh
->name
, c
);
1964 ret
= _clear_softreset(oh
, &v
);
1968 _write_sysconfig(v
, oh
);
1971 * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1972 * _wait_target_ready() or _reset()
1976 if (oh
->flags
& HWMOD_CONTROL_OPT_CLKS_IN_RESET
)
1977 _disable_optional_clocks(oh
);
1983 * _reset - reset an omap_hwmod
1984 * @oh: struct omap_hwmod *
1986 * Resets an omap_hwmod @oh. If the module has a custom reset
1987 * function pointer defined, then call it to reset the IP block, and
1988 * pass along its return value to the caller. Otherwise, if the IP
1989 * block has an OCP_SYSCONFIG register with a SOFTRESET bitfield
1990 * associated with it, call a function to reset the IP block via that
1991 * method, and pass along the return value to the caller. Finally, if
1992 * the IP block has some hardreset lines associated with it, assert
1993 * all of those, but do _not_ deassert them. (This is because driver
1994 * authors have expressed an apparent requirement to control the
1995 * deassertion of the hardreset lines themselves.)
1997 * The default software reset mechanism for most OMAP IP blocks is
1998 * triggered via the OCP_SYSCONFIG.SOFTRESET bit. However, some
1999 * hwmods cannot be reset via this method. Some are not targets and
2000 * therefore have no OCP header registers to access. Others (like the
2001 * IVA) have idiosyncratic reset sequences. So for these relatively
2002 * rare cases, custom reset code can be supplied in the struct
2003 * omap_hwmod_class .reset function pointer.
2005 * _set_dmadisable() is called to set the DMADISABLE bit so that it
2006 * does not prevent idling of the system. This is necessary for cases
2007 * where ROMCODE/BOOTLOADER uses dma and transfers control to the
2008 * kernel without disabling dma.
2010 * Passes along the return value from either _ocp_softreset() or the
2011 * custom reset function - these must return -EINVAL if the hwmod
2012 * cannot be reset this way or if the hwmod is in the wrong state,
2013 * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
2015 static int _reset(struct omap_hwmod
*oh
)
2019 pr_debug("omap_hwmod: %s: resetting\n", oh
->name
);
2021 if (oh
->class->reset
) {
2022 r
= oh
->class->reset(oh
);
2024 if (oh
->rst_lines_cnt
> 0) {
2025 for (i
= 0; i
< oh
->rst_lines_cnt
; i
++)
2026 _assert_hardreset(oh
, oh
->rst_lines
[i
].name
);
2029 r
= _ocp_softreset(oh
);
2035 _set_dmadisable(oh
);
2038 * OCP_SYSCONFIG bits need to be reprogrammed after a
2039 * softreset. The _enable() function should be split to avoid
2040 * the rewrite of the OCP_SYSCONFIG register.
2042 if (oh
->class->sysc
) {
2043 _update_sysc_cache(oh
);
2051 * _reconfigure_io_chain - clear any I/O chain wakeups and reconfigure chain
2053 * Call the appropriate PRM function to clear any logged I/O chain
2054 * wakeups and to reconfigure the chain. This apparently needs to be
2055 * done upon every mux change. Since hwmods can be concurrently
2056 * enabled and idled, hold a spinlock around the I/O chain
2057 * reconfiguration sequence. No return value.
2059 * XXX When the PRM code is moved to drivers, this function can be removed,
2060 * as the PRM infrastructure should abstract this.
2062 static void _reconfigure_io_chain(void)
2064 unsigned long flags
;
2066 spin_lock_irqsave(&io_chain_lock
, flags
);
2068 if (cpu_is_omap34xx() && omap3_has_io_chain_ctrl())
2069 omap3xxx_prm_reconfigure_io_chain();
2070 else if (cpu_is_omap44xx())
2071 omap44xx_prm_reconfigure_io_chain();
2073 spin_unlock_irqrestore(&io_chain_lock
, flags
);
2077 * _omap4_update_context_lost - increment hwmod context loss counter if
2078 * hwmod context was lost, and clear hardware context loss reg
2079 * @oh: hwmod to check for context loss
2081 * If the PRCM indicates that the hwmod @oh lost context, increment
2082 * our in-memory context loss counter, and clear the RM_*_CONTEXT
2083 * bits. No return value.
2085 static void _omap4_update_context_lost(struct omap_hwmod
*oh
)
2087 if (oh
->prcm
.omap4
.flags
& HWMOD_OMAP4_NO_CONTEXT_LOSS_BIT
)
2090 if (!prm_was_any_context_lost_old(oh
->clkdm
->pwrdm
.ptr
->prcm_partition
,
2091 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
2092 oh
->prcm
.omap4
.context_offs
))
2095 oh
->prcm
.omap4
.context_lost_counter
++;
2096 prm_clear_context_loss_flags_old(oh
->clkdm
->pwrdm
.ptr
->prcm_partition
,
2097 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
2098 oh
->prcm
.omap4
.context_offs
);
2102 * _omap4_get_context_lost - get context loss counter for a hwmod
2103 * @oh: hwmod to get context loss counter for
2105 * Returns the in-memory context loss counter for a hwmod.
2107 static int _omap4_get_context_lost(struct omap_hwmod
*oh
)
2109 return oh
->prcm
.omap4
.context_lost_counter
;
2113 * _enable_preprogram - Pre-program an IP block during the _enable() process
2114 * @oh: struct omap_hwmod *
2116 * Some IP blocks (such as AESS) require some additional programming
2117 * after enable before they can enter idle. If a function pointer to
2118 * do so is present in the hwmod data, then call it and pass along the
2119 * return value; otherwise, return 0.
2121 static int _enable_preprogram(struct omap_hwmod
*oh
)
2123 if (!oh
->class->enable_preprogram
)
2126 return oh
->class->enable_preprogram(oh
);
2130 * _enable - enable an omap_hwmod
2131 * @oh: struct omap_hwmod *
2133 * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
2134 * register target. Returns -EINVAL if the hwmod is in the wrong
2135 * state or passes along the return value of _wait_target_ready().
2137 static int _enable(struct omap_hwmod
*oh
)
2142 pr_debug("omap_hwmod: %s: enabling\n", oh
->name
);
2145 * hwmods with HWMOD_INIT_NO_IDLE flag set are left in enabled
2146 * state at init. Now that someone is really trying to enable
2147 * them, just ensure that the hwmod mux is set.
2149 if (oh
->_int_flags
& _HWMOD_SKIP_ENABLE
) {
2151 * If the caller has mux data populated, do the mux'ing
2152 * which wouldn't have been done as part of the _enable()
2153 * done during setup.
2156 omap_hwmod_mux(oh
->mux
, _HWMOD_STATE_ENABLED
);
2158 oh
->_int_flags
&= ~_HWMOD_SKIP_ENABLE
;
2162 if (oh
->_state
!= _HWMOD_STATE_INITIALIZED
&&
2163 oh
->_state
!= _HWMOD_STATE_IDLE
&&
2164 oh
->_state
!= _HWMOD_STATE_DISABLED
) {
2165 WARN(1, "omap_hwmod: %s: enabled state can only be entered from initialized, idle, or disabled state\n",
2171 * If an IP block contains HW reset lines and all of them are
2172 * asserted, we let integration code associated with that
2173 * block handle the enable. We've received very little
2174 * information on what those driver authors need, and until
2175 * detailed information is provided and the driver code is
2176 * posted to the public lists, this is probably the best we
2179 if (_are_all_hardreset_lines_asserted(oh
))
2182 /* Mux pins for device runtime if populated */
2183 if (oh
->mux
&& (!oh
->mux
->enabled
||
2184 ((oh
->_state
== _HWMOD_STATE_IDLE
) &&
2185 oh
->mux
->pads_dynamic
))) {
2186 omap_hwmod_mux(oh
->mux
, _HWMOD_STATE_ENABLED
);
2187 _reconfigure_io_chain();
2190 _add_initiator_dep(oh
, mpu_oh
);
2194 * A clockdomain must be in SW_SUP before enabling
2195 * completely the module. The clockdomain can be set
2196 * in HW_AUTO only when the module become ready.
2198 hwsup
= clkdm_in_hwsup(oh
->clkdm
) &&
2199 !clkdm_missing_idle_reporting(oh
->clkdm
);
2200 r
= clkdm_hwmod_enable(oh
->clkdm
, oh
);
2202 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
2203 oh
->name
, oh
->clkdm
->name
, r
);
2209 if (soc_ops
.enable_module
)
2210 soc_ops
.enable_module(oh
);
2211 if (oh
->flags
& HWMOD_BLOCK_WFI
)
2212 cpu_idle_poll_ctrl(true);
2214 if (soc_ops
.update_context_lost
)
2215 soc_ops
.update_context_lost(oh
);
2217 r
= (soc_ops
.wait_target_ready
) ? soc_ops
.wait_target_ready(oh
) :
2221 * Set the clockdomain to HW_AUTO only if the target is ready,
2222 * assuming that the previous state was HW_AUTO
2224 if (oh
->clkdm
&& hwsup
)
2225 clkdm_allow_idle(oh
->clkdm
);
2227 oh
->_state
= _HWMOD_STATE_ENABLED
;
2229 /* Access the sysconfig only if the target is ready */
2230 if (oh
->class->sysc
) {
2231 if (!(oh
->_int_flags
& _HWMOD_SYSCONFIG_LOADED
))
2232 _update_sysc_cache(oh
);
2235 r
= _enable_preprogram(oh
);
2237 if (soc_ops
.disable_module
)
2238 soc_ops
.disable_module(oh
);
2239 _disable_clocks(oh
);
2240 pr_debug("omap_hwmod: %s: _wait_target_ready: %d\n",
2244 clkdm_hwmod_disable(oh
->clkdm
, oh
);
2251 * _idle - idle an omap_hwmod
2252 * @oh: struct omap_hwmod *
2254 * Idles an omap_hwmod @oh. This should be called once the hwmod has
2255 * no further work. Returns -EINVAL if the hwmod is in the wrong
2256 * state or returns 0.
2258 static int _idle(struct omap_hwmod
*oh
)
2260 pr_debug("omap_hwmod: %s: idling\n", oh
->name
);
2262 if (oh
->_state
!= _HWMOD_STATE_ENABLED
) {
2263 WARN(1, "omap_hwmod: %s: idle state can only be entered from enabled state\n",
2268 if (_are_all_hardreset_lines_asserted(oh
))
2271 if (oh
->class->sysc
)
2273 _del_initiator_dep(oh
, mpu_oh
);
2275 if (oh
->flags
& HWMOD_BLOCK_WFI
)
2276 cpu_idle_poll_ctrl(false);
2277 if (soc_ops
.disable_module
)
2278 soc_ops
.disable_module(oh
);
2281 * The module must be in idle mode before disabling any parents
2282 * clocks. Otherwise, the parent clock might be disabled before
2283 * the module transition is done, and thus will prevent the
2284 * transition to complete properly.
2286 _disable_clocks(oh
);
2288 clkdm_hwmod_disable(oh
->clkdm
, oh
);
2290 /* Mux pins for device idle if populated */
2291 if (oh
->mux
&& oh
->mux
->pads_dynamic
) {
2292 omap_hwmod_mux(oh
->mux
, _HWMOD_STATE_IDLE
);
2293 _reconfigure_io_chain();
2296 oh
->_state
= _HWMOD_STATE_IDLE
;
2302 * _shutdown - shutdown an omap_hwmod
2303 * @oh: struct omap_hwmod *
2305 * Shut down an omap_hwmod @oh. This should be called when the driver
2306 * used for the hwmod is removed or unloaded or if the driver is not
2307 * used by the system. Returns -EINVAL if the hwmod is in the wrong
2308 * state or returns 0.
2310 static int _shutdown(struct omap_hwmod
*oh
)
2315 if (oh
->_state
!= _HWMOD_STATE_IDLE
&&
2316 oh
->_state
!= _HWMOD_STATE_ENABLED
) {
2317 WARN(1, "omap_hwmod: %s: disabled state can only be entered from idle, or enabled state\n",
2322 if (_are_all_hardreset_lines_asserted(oh
))
2325 pr_debug("omap_hwmod: %s: disabling\n", oh
->name
);
2327 if (oh
->class->pre_shutdown
) {
2328 prev_state
= oh
->_state
;
2329 if (oh
->_state
== _HWMOD_STATE_IDLE
)
2331 ret
= oh
->class->pre_shutdown(oh
);
2333 if (prev_state
== _HWMOD_STATE_IDLE
)
2339 if (oh
->class->sysc
) {
2340 if (oh
->_state
== _HWMOD_STATE_IDLE
)
2345 /* clocks and deps are already disabled in idle */
2346 if (oh
->_state
== _HWMOD_STATE_ENABLED
) {
2347 _del_initiator_dep(oh
, mpu_oh
);
2348 /* XXX what about the other system initiators here? dma, dsp */
2349 if (oh
->flags
& HWMOD_BLOCK_WFI
)
2350 cpu_idle_poll_ctrl(false);
2351 if (soc_ops
.disable_module
)
2352 soc_ops
.disable_module(oh
);
2353 _disable_clocks(oh
);
2355 clkdm_hwmod_disable(oh
->clkdm
, oh
);
2357 /* XXX Should this code also force-disable the optional clocks? */
2359 for (i
= 0; i
< oh
->rst_lines_cnt
; i
++)
2360 _assert_hardreset(oh
, oh
->rst_lines
[i
].name
);
2362 /* Mux pins to safe mode or use populated off mode values */
2364 omap_hwmod_mux(oh
->mux
, _HWMOD_STATE_DISABLED
);
2366 oh
->_state
= _HWMOD_STATE_DISABLED
;
2371 static int of_dev_find_hwmod(struct device_node
*np
,
2372 struct omap_hwmod
*oh
)
2377 count
= of_property_count_strings(np
, "ti,hwmods");
2381 for (i
= 0; i
< count
; i
++) {
2382 res
= of_property_read_string_index(np
, "ti,hwmods",
2386 if (!strcmp(p
, oh
->name
)) {
2387 pr_debug("omap_hwmod: dt %s[%i] uses hwmod %s\n",
2388 np
->name
, i
, oh
->name
);
2397 * of_dev_hwmod_lookup - look up needed hwmod from dt blob
2398 * @np: struct device_node *
2399 * @oh: struct omap_hwmod *
2400 * @index: index of the entry found
2401 * @found: struct device_node * found or NULL
2403 * Parse the dt blob and find out needed hwmod. Recursive function is
2404 * implemented to take care hierarchical dt blob parsing.
2405 * Return: Returns 0 on success, -ENODEV when not found.
2407 static int of_dev_hwmod_lookup(struct device_node
*np
,
2408 struct omap_hwmod
*oh
,
2410 struct device_node
**found
)
2412 struct device_node
*np0
= NULL
;
2415 res
= of_dev_find_hwmod(np
, oh
);
2422 for_each_child_of_node(np
, np0
) {
2423 struct device_node
*fc
;
2426 res
= of_dev_hwmod_lookup(np0
, oh
, &i
, &fc
);
2441 * _init_mpu_rt_base - populate the virtual address for a hwmod
2442 * @oh: struct omap_hwmod * to locate the virtual address
2443 * @data: (unused, caller should pass NULL)
2444 * @index: index of the reg entry iospace in device tree
2445 * @np: struct device_node * of the IP block's device node in the DT data
2447 * Cache the virtual address used by the MPU to access this IP block's
2448 * registers. This address is needed early so the OCP registers that
2449 * are part of the device's address space can be ioremapped properly.
2451 * Returns 0 on success, -EINVAL if an invalid hwmod is passed, and
2452 * -ENXIO on absent or invalid register target address space.
2454 static int __init
_init_mpu_rt_base(struct omap_hwmod
*oh
, void *data
,
2455 int index
, struct device_node
*np
)
2457 struct omap_hwmod_addr_space
*mem
;
2458 void __iomem
*va_start
= NULL
;
2463 _save_mpu_port_index(oh
);
2465 if (oh
->_int_flags
& _HWMOD_NO_MPU_PORT
)
2468 mem
= _find_mpu_rt_addr_space(oh
);
2470 pr_debug("omap_hwmod: %s: no MPU register target found\n",
2473 /* Extract the IO space from device tree blob */
2477 va_start
= of_iomap(np
, index
+ oh
->mpu_rt_idx
);
2479 va_start
= ioremap(mem
->pa_start
, mem
->pa_end
- mem
->pa_start
);
2484 pr_err("omap_hwmod: %s: Could not ioremap\n", oh
->name
);
2486 pr_err("omap_hwmod: %s: Missing dt reg%i for %s\n",
2487 oh
->name
, index
, np
->full_name
);
2491 pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
2492 oh
->name
, va_start
);
2494 oh
->_mpu_rt_va
= va_start
;
2499 * _init - initialize internal data for the hwmod @oh
2500 * @oh: struct omap_hwmod *
2503 * Look up the clocks and the address space used by the MPU to access
2504 * registers belonging to the hwmod @oh. @oh must already be
2505 * registered at this point. This is the first of two phases for
2506 * hwmod initialization. Code called here does not touch any hardware
2507 * registers, it simply prepares internal data structures. Returns 0
2508 * upon success or if the hwmod isn't registered or if the hwmod's
2509 * address space is not defined, or -EINVAL upon failure.
2511 static int __init
_init(struct omap_hwmod
*oh
, void *data
)
2514 struct device_node
*np
= NULL
;
2516 if (oh
->_state
!= _HWMOD_STATE_REGISTERED
)
2519 if (of_have_populated_dt()) {
2520 struct device_node
*bus
;
2522 bus
= of_find_node_by_name(NULL
, "ocp");
2526 r
= of_dev_hwmod_lookup(bus
, oh
, &index
, &np
);
2528 pr_debug("omap_hwmod: %s missing dt data\n", oh
->name
);
2529 else if (np
&& index
)
2530 pr_warn("omap_hwmod: %s using broken dt data from %s\n",
2531 oh
->name
, np
->name
);
2534 if (oh
->class->sysc
) {
2535 r
= _init_mpu_rt_base(oh
, NULL
, index
, np
);
2537 WARN(1, "omap_hwmod: %s: doesn't have mpu register target base\n",
2543 r
= _init_clocks(oh
, NULL
);
2545 WARN(1, "omap_hwmod: %s: couldn't init clocks\n", oh
->name
);
2550 if (of_find_property(np
, "ti,no-reset-on-init", NULL
))
2551 oh
->flags
|= HWMOD_INIT_NO_RESET
;
2552 if (of_find_property(np
, "ti,no-idle-on-init", NULL
))
2553 oh
->flags
|= HWMOD_INIT_NO_IDLE
;
2555 oh
->_state
= _HWMOD_STATE_INITIALIZED
;
2561 * _setup_iclk_autoidle - configure an IP block's interface clocks
2562 * @oh: struct omap_hwmod *
2564 * Set up the module's interface clocks. XXX This function is still mostly
2565 * a stub; implementing this properly requires iclk autoidle usecounting in
2566 * the clock code. No return value.
2568 static void __init
_setup_iclk_autoidle(struct omap_hwmod
*oh
)
2570 struct omap_hwmod_ocp_if
*os
;
2571 struct list_head
*p
;
2573 if (oh
->_state
!= _HWMOD_STATE_INITIALIZED
)
2576 p
= oh
->slave_ports
.next
;
2578 while (i
< oh
->slaves_cnt
) {
2579 os
= _fetch_next_ocp_if(&p
, &i
);
2583 if (os
->flags
& OCPIF_SWSUP_IDLE
) {
2584 /* XXX omap_iclk_deny_idle(c); */
2586 /* XXX omap_iclk_allow_idle(c); */
2587 clk_enable(os
->_clk
);
2595 * _setup_reset - reset an IP block during the setup process
2596 * @oh: struct omap_hwmod *
2598 * Reset the IP block corresponding to the hwmod @oh during the setup
2599 * process. The IP block is first enabled so it can be successfully
2600 * reset. Returns 0 upon success or a negative error code upon
2603 static int __init
_setup_reset(struct omap_hwmod
*oh
)
2607 if (oh
->_state
!= _HWMOD_STATE_INITIALIZED
)
2610 if (oh
->flags
& HWMOD_EXT_OPT_MAIN_CLK
)
2613 if (oh
->rst_lines_cnt
== 0) {
2616 pr_warning("omap_hwmod: %s: cannot be enabled for reset (%d)\n",
2617 oh
->name
, oh
->_state
);
2622 if (!(oh
->flags
& HWMOD_INIT_NO_RESET
))
2629 * _setup_postsetup - transition to the appropriate state after _setup
2630 * @oh: struct omap_hwmod *
2632 * Place an IP block represented by @oh into a "post-setup" state --
2633 * either IDLE, ENABLED, or DISABLED. ("post-setup" simply means that
2634 * this function is called at the end of _setup().) The postsetup
2635 * state for an IP block can be changed by calling
2636 * omap_hwmod_enter_postsetup_state() early in the boot process,
2637 * before one of the omap_hwmod_setup*() functions are called for the
2640 * The IP block stays in this state until a PM runtime-based driver is
2641 * loaded for that IP block. A post-setup state of IDLE is
2642 * appropriate for almost all IP blocks with runtime PM-enabled
2643 * drivers, since those drivers are able to enable the IP block. A
2644 * post-setup state of ENABLED is appropriate for kernels with PM
2645 * runtime disabled. The DISABLED state is appropriate for unusual IP
2646 * blocks such as the MPU WDTIMER on kernels without WDTIMER drivers
2647 * included, since the WDTIMER starts running on reset and will reset
2648 * the MPU if left active.
2650 * This post-setup mechanism is deprecated. Once all of the OMAP
2651 * drivers have been converted to use PM runtime, and all of the IP
2652 * block data and interconnect data is available to the hwmod code, it
2653 * should be possible to replace this mechanism with a "lazy reset"
2654 * arrangement. In a "lazy reset" setup, each IP block is enabled
2655 * when the driver first probes, then all remaining IP blocks without
2656 * drivers are either shut down or enabled after the drivers have
2657 * loaded. However, this cannot take place until the above
2658 * preconditions have been met, since otherwise the late reset code
2659 * has no way of knowing which IP blocks are in use by drivers, and
2660 * which ones are unused.
2664 static void __init
_setup_postsetup(struct omap_hwmod
*oh
)
2668 if (oh
->rst_lines_cnt
> 0)
2671 postsetup_state
= oh
->_postsetup_state
;
2672 if (postsetup_state
== _HWMOD_STATE_UNKNOWN
)
2673 postsetup_state
= _HWMOD_STATE_ENABLED
;
2676 * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
2677 * it should be set by the core code as a runtime flag during startup
2679 if ((oh
->flags
& HWMOD_INIT_NO_IDLE
) &&
2680 (postsetup_state
== _HWMOD_STATE_IDLE
)) {
2681 oh
->_int_flags
|= _HWMOD_SKIP_ENABLE
;
2682 postsetup_state
= _HWMOD_STATE_ENABLED
;
2685 if (postsetup_state
== _HWMOD_STATE_IDLE
)
2687 else if (postsetup_state
== _HWMOD_STATE_DISABLED
)
2689 else if (postsetup_state
!= _HWMOD_STATE_ENABLED
)
2690 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
2691 oh
->name
, postsetup_state
);
2697 * _setup - prepare IP block hardware for use
2698 * @oh: struct omap_hwmod *
2699 * @n: (unused, pass NULL)
2701 * Configure the IP block represented by @oh. This may include
2702 * enabling the IP block, resetting it, and placing it into a
2703 * post-setup state, depending on the type of IP block and applicable
2704 * flags. IP blocks are reset to prevent any previous configuration
2705 * by the bootloader or previous operating system from interfering
2706 * with power management or other parts of the system. The reset can
2707 * be avoided; see omap_hwmod_no_setup_reset(). This is the second of
2708 * two phases for hwmod initialization. Code called here generally
2709 * affects the IP block hardware, or system integration hardware
2710 * associated with the IP block. Returns 0.
2712 static int __init
_setup(struct omap_hwmod
*oh
, void *data
)
2714 if (oh
->_state
!= _HWMOD_STATE_INITIALIZED
)
2717 _setup_iclk_autoidle(oh
);
2719 if (!_setup_reset(oh
))
2720 _setup_postsetup(oh
);
2726 * _register - register a struct omap_hwmod
2727 * @oh: struct omap_hwmod *
2729 * Registers the omap_hwmod @oh. Returns -EEXIST if an omap_hwmod
2730 * already has been registered by the same name; -EINVAL if the
2731 * omap_hwmod is in the wrong state, if @oh is NULL, if the
2732 * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
2733 * name, or if the omap_hwmod's class is missing a name; or 0 upon
2736 * XXX The data should be copied into bootmem, so the original data
2737 * should be marked __initdata and freed after init. This would allow
2738 * unneeded omap_hwmods to be freed on multi-OMAP configurations. Note
2739 * that the copy process would be relatively complex due to the large number
2742 static int __init
_register(struct omap_hwmod
*oh
)
2744 if (!oh
|| !oh
->name
|| !oh
->class || !oh
->class->name
||
2745 (oh
->_state
!= _HWMOD_STATE_UNKNOWN
))
2748 pr_debug("omap_hwmod: %s: registering\n", oh
->name
);
2750 if (_lookup(oh
->name
))
2753 list_add_tail(&oh
->node
, &omap_hwmod_list
);
2755 INIT_LIST_HEAD(&oh
->master_ports
);
2756 INIT_LIST_HEAD(&oh
->slave_ports
);
2757 spin_lock_init(&oh
->_lock
);
2759 oh
->_state
= _HWMOD_STATE_REGISTERED
;
2762 * XXX Rather than doing a strcmp(), this should test a flag
2763 * set in the hwmod data, inserted by the autogenerator code.
2765 if (!strcmp(oh
->name
, MPU_INITIATOR_NAME
))
2772 * _alloc_links - return allocated memory for hwmod links
2773 * @ml: pointer to a struct omap_hwmod_link * for the master link
2774 * @sl: pointer to a struct omap_hwmod_link * for the slave link
2776 * Return pointers to two struct omap_hwmod_link records, via the
2777 * addresses pointed to by @ml and @sl. Will first attempt to return
2778 * memory allocated as part of a large initial block, but if that has
2779 * been exhausted, will allocate memory itself. Since ideally this
2780 * second allocation path will never occur, the number of these
2781 * 'supplemental' allocations will be logged when debugging is
2782 * enabled. Returns 0.
2784 static int __init
_alloc_links(struct omap_hwmod_link
**ml
,
2785 struct omap_hwmod_link
**sl
)
2789 if ((free_ls
+ LINKS_PER_OCP_IF
) <= max_ls
) {
2790 *ml
= &linkspace
[free_ls
++];
2791 *sl
= &linkspace
[free_ls
++];
2795 sz
= sizeof(struct omap_hwmod_link
) * LINKS_PER_OCP_IF
;
2798 *ml
= memblock_virt_alloc(sz
, 0);
2800 *sl
= (void *)(*ml
) + sizeof(struct omap_hwmod_link
);
2803 pr_debug("omap_hwmod: supplemental link allocations needed: %d\n",
2804 ls_supp
* LINKS_PER_OCP_IF
);
2810 * _add_link - add an interconnect between two IP blocks
2811 * @oi: pointer to a struct omap_hwmod_ocp_if record
2813 * Add struct omap_hwmod_link records connecting the master IP block
2814 * specified in @oi->master to @oi, and connecting the slave IP block
2815 * specified in @oi->slave to @oi. This code is assumed to run before
2816 * preemption or SMP has been enabled, thus avoiding the need for
2817 * locking in this code. Changes to this assumption will require
2818 * additional locking. Returns 0.
2820 static int __init
_add_link(struct omap_hwmod_ocp_if
*oi
)
2822 struct omap_hwmod_link
*ml
, *sl
;
2824 pr_debug("omap_hwmod: %s -> %s: adding link\n", oi
->master
->name
,
2827 _alloc_links(&ml
, &sl
);
2830 INIT_LIST_HEAD(&ml
->node
);
2831 list_add(&ml
->node
, &oi
->master
->master_ports
);
2832 oi
->master
->masters_cnt
++;
2835 INIT_LIST_HEAD(&sl
->node
);
2836 list_add(&sl
->node
, &oi
->slave
->slave_ports
);
2837 oi
->slave
->slaves_cnt
++;
2843 * _register_link - register a struct omap_hwmod_ocp_if
2844 * @oi: struct omap_hwmod_ocp_if *
2846 * Registers the omap_hwmod_ocp_if record @oi. Returns -EEXIST if it
2847 * has already been registered; -EINVAL if @oi is NULL or if the
2848 * record pointed to by @oi is missing required fields; or 0 upon
2851 * XXX The data should be copied into bootmem, so the original data
2852 * should be marked __initdata and freed after init. This would allow
2853 * unneeded omap_hwmods to be freed on multi-OMAP configurations.
2855 static int __init
_register_link(struct omap_hwmod_ocp_if
*oi
)
2857 if (!oi
|| !oi
->master
|| !oi
->slave
|| !oi
->user
)
2860 if (oi
->_int_flags
& _OCPIF_INT_FLAGS_REGISTERED
)
2863 pr_debug("omap_hwmod: registering link from %s to %s\n",
2864 oi
->master
->name
, oi
->slave
->name
);
2867 * Register the connected hwmods, if they haven't been
2868 * registered already
2870 if (oi
->master
->_state
!= _HWMOD_STATE_REGISTERED
)
2871 _register(oi
->master
);
2873 if (oi
->slave
->_state
!= _HWMOD_STATE_REGISTERED
)
2874 _register(oi
->slave
);
2878 oi
->_int_flags
|= _OCPIF_INT_FLAGS_REGISTERED
;
2884 * _alloc_linkspace - allocate large block of hwmod links
2885 * @ois: pointer to an array of struct omap_hwmod_ocp_if records to count
2887 * Allocate a large block of struct omap_hwmod_link records. This
2888 * improves boot time significantly by avoiding the need to allocate
2889 * individual records one by one. If the number of records to
2890 * allocate in the block hasn't been manually specified, this function
2891 * will count the number of struct omap_hwmod_ocp_if records in @ois
2892 * and use that to determine the allocation size. For SoC families
2893 * that require multiple list registrations, such as OMAP3xxx, this
2894 * estimation process isn't optimal, so manual estimation is advised
2895 * in those cases. Returns -EEXIST if the allocation has already occurred
2896 * or 0 upon success.
2898 static int __init
_alloc_linkspace(struct omap_hwmod_ocp_if
**ois
)
2904 WARN(1, "linkspace already allocated\n");
2910 max_ls
+= LINKS_PER_OCP_IF
;
2912 sz
= sizeof(struct omap_hwmod_link
) * max_ls
;
2914 pr_debug("omap_hwmod: %s: allocating %d byte linkspace (%d links)\n",
2915 __func__
, sz
, max_ls
);
2917 linkspace
= memblock_virt_alloc(sz
, 0);
2922 /* Static functions intended only for use in soc_ops field function pointers */
2925 * _omap2xxx_wait_target_ready - wait for a module to leave slave idle
2926 * @oh: struct omap_hwmod *
2928 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2929 * does not have an IDLEST bit or if the module successfully leaves
2930 * slave idle; otherwise, pass along the return value of the
2931 * appropriate *_cm*_wait_module_ready() function.
2933 static int _omap2xxx_wait_target_ready(struct omap_hwmod
*oh
)
2938 if (oh
->flags
& HWMOD_NO_IDLEST
)
2941 if (!_find_mpu_rt_port(oh
))
2944 /* XXX check module SIDLEMODE, hardreset status, enabled clocks */
2946 return omap2xxx_cm_wait_module_ready(oh
->prcm
.omap2
.module_offs
,
2947 oh
->prcm
.omap2
.idlest_reg_id
,
2948 oh
->prcm
.omap2
.idlest_idle_bit
);
2952 * _omap3xxx_wait_target_ready - wait for a module to leave slave idle
2953 * @oh: struct omap_hwmod *
2955 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2956 * does not have an IDLEST bit or if the module successfully leaves
2957 * slave idle; otherwise, pass along the return value of the
2958 * appropriate *_cm*_wait_module_ready() function.
2960 static int _omap3xxx_wait_target_ready(struct omap_hwmod
*oh
)
2965 if (oh
->flags
& HWMOD_NO_IDLEST
)
2968 if (!_find_mpu_rt_port(oh
))
2971 /* XXX check module SIDLEMODE, hardreset status, enabled clocks */
2973 return omap3xxx_cm_wait_module_ready(oh
->prcm
.omap2
.module_offs
,
2974 oh
->prcm
.omap2
.idlest_reg_id
,
2975 oh
->prcm
.omap2
.idlest_idle_bit
);
2979 * _omap4_wait_target_ready - wait for a module to leave slave idle
2980 * @oh: struct omap_hwmod *
2982 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2983 * does not have an IDLEST bit or if the module successfully leaves
2984 * slave idle; otherwise, pass along the return value of the
2985 * appropriate *_cm*_wait_module_ready() function.
2987 static int _omap4_wait_target_ready(struct omap_hwmod
*oh
)
2992 if (oh
->flags
& HWMOD_NO_IDLEST
|| !oh
->clkdm
)
2995 if (!_find_mpu_rt_port(oh
))
2998 /* XXX check module SIDLEMODE, hardreset status */
3000 return omap4_cminst_wait_module_ready(oh
->clkdm
->prcm_partition
,
3002 oh
->clkdm
->clkdm_offs
,
3003 oh
->prcm
.omap4
.clkctrl_offs
);
3007 * _am33xx_wait_target_ready - wait for a module to leave slave idle
3008 * @oh: struct omap_hwmod *
3010 * Wait for a module @oh to leave slave idle. Returns 0 if the module
3011 * does not have an IDLEST bit or if the module successfully leaves
3012 * slave idle; otherwise, pass along the return value of the
3013 * appropriate *_cm*_wait_module_ready() function.
3015 static int _am33xx_wait_target_ready(struct omap_hwmod
*oh
)
3017 if (!oh
|| !oh
->clkdm
)
3020 if (oh
->flags
& HWMOD_NO_IDLEST
)
3023 if (!_find_mpu_rt_port(oh
))
3026 /* XXX check module SIDLEMODE, hardreset status */
3028 return am33xx_cm_wait_module_ready(oh
->clkdm
->cm_inst
,
3029 oh
->clkdm
->clkdm_offs
,
3030 oh
->prcm
.omap4
.clkctrl_offs
);
3034 * _omap2_assert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
3035 * @oh: struct omap_hwmod * to assert hardreset
3036 * @ohri: hardreset line data
3038 * Call omap2_prm_assert_hardreset() with parameters extracted from
3039 * the hwmod @oh and the hardreset line data @ohri. Only intended for
3040 * use as an soc_ops function pointer. Passes along the return value
3041 * from omap2_prm_assert_hardreset(). XXX This function is scheduled
3042 * for removal when the PRM code is moved into drivers/.
3044 static int _omap2_assert_hardreset(struct omap_hwmod
*oh
,
3045 struct omap_hwmod_rst_info
*ohri
)
3047 return omap2_prm_assert_hardreset(oh
->prcm
.omap2
.module_offs
,
3052 * _omap2_deassert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
3053 * @oh: struct omap_hwmod * to deassert hardreset
3054 * @ohri: hardreset line data
3056 * Call omap2_prm_deassert_hardreset() with parameters extracted from
3057 * the hwmod @oh and the hardreset line data @ohri. Only intended for
3058 * use as an soc_ops function pointer. Passes along the return value
3059 * from omap2_prm_deassert_hardreset(). XXX This function is
3060 * scheduled for removal when the PRM code is moved into drivers/.
3062 static int _omap2_deassert_hardreset(struct omap_hwmod
*oh
,
3063 struct omap_hwmod_rst_info
*ohri
)
3065 return omap2_prm_deassert_hardreset(oh
->prcm
.omap2
.module_offs
,
3071 * _omap2_is_hardreset_asserted - call OMAP2 PRM hardreset fn with hwmod args
3072 * @oh: struct omap_hwmod * to test hardreset
3073 * @ohri: hardreset line data
3075 * Call omap2_prm_is_hardreset_asserted() with parameters extracted
3076 * from the hwmod @oh and the hardreset line data @ohri. Only
3077 * intended for use as an soc_ops function pointer. Passes along the
3078 * return value from omap2_prm_is_hardreset_asserted(). XXX This
3079 * function is scheduled for removal when the PRM code is moved into
3082 static int _omap2_is_hardreset_asserted(struct omap_hwmod
*oh
,
3083 struct omap_hwmod_rst_info
*ohri
)
3085 return omap2_prm_is_hardreset_asserted(oh
->prcm
.omap2
.module_offs
,
3090 * _omap4_assert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
3091 * @oh: struct omap_hwmod * to assert hardreset
3092 * @ohri: hardreset line data
3094 * Call omap4_prminst_assert_hardreset() with parameters extracted
3095 * from the hwmod @oh and the hardreset line data @ohri. Only
3096 * intended for use as an soc_ops function pointer. Passes along the
3097 * return value from omap4_prminst_assert_hardreset(). XXX This
3098 * function is scheduled for removal when the PRM code is moved into
3101 static int _omap4_assert_hardreset(struct omap_hwmod
*oh
,
3102 struct omap_hwmod_rst_info
*ohri
)
3107 return omap4_prminst_assert_hardreset(ohri
->rst_shift
,
3108 oh
->clkdm
->pwrdm
.ptr
->prcm_partition
,
3109 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
3110 oh
->prcm
.omap4
.rstctrl_offs
);
3114 * _omap4_deassert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
3115 * @oh: struct omap_hwmod * to deassert hardreset
3116 * @ohri: hardreset line data
3118 * Call omap4_prminst_deassert_hardreset() with parameters extracted
3119 * from the hwmod @oh and the hardreset line data @ohri. Only
3120 * intended for use as an soc_ops function pointer. Passes along the
3121 * return value from omap4_prminst_deassert_hardreset(). XXX This
3122 * function is scheduled for removal when the PRM code is moved into
3125 static int _omap4_deassert_hardreset(struct omap_hwmod
*oh
,
3126 struct omap_hwmod_rst_info
*ohri
)
3132 pr_err("omap_hwmod: %s: %s: hwmod data error: OMAP4 does not support st_shift\n",
3133 oh
->name
, ohri
->name
);
3134 return omap4_prminst_deassert_hardreset(ohri
->rst_shift
,
3135 oh
->clkdm
->pwrdm
.ptr
->prcm_partition
,
3136 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
3137 oh
->prcm
.omap4
.rstctrl_offs
);
3141 * _omap4_is_hardreset_asserted - call OMAP4 PRM hardreset fn with hwmod args
3142 * @oh: struct omap_hwmod * to test hardreset
3143 * @ohri: hardreset line data
3145 * Call omap4_prminst_is_hardreset_asserted() with parameters
3146 * extracted from the hwmod @oh and the hardreset line data @ohri.
3147 * Only intended for use as an soc_ops function pointer. Passes along
3148 * the return value from omap4_prminst_is_hardreset_asserted(). XXX
3149 * This function is scheduled for removal when the PRM code is moved
3152 static int _omap4_is_hardreset_asserted(struct omap_hwmod
*oh
,
3153 struct omap_hwmod_rst_info
*ohri
)
3158 return omap4_prminst_is_hardreset_asserted(ohri
->rst_shift
,
3159 oh
->clkdm
->pwrdm
.ptr
->prcm_partition
,
3160 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
3161 oh
->prcm
.omap4
.rstctrl_offs
);
3165 * _am33xx_assert_hardreset - call AM33XX PRM hardreset fn with hwmod args
3166 * @oh: struct omap_hwmod * to assert hardreset
3167 * @ohri: hardreset line data
3169 * Call am33xx_prminst_assert_hardreset() with parameters extracted
3170 * from the hwmod @oh and the hardreset line data @ohri. Only
3171 * intended for use as an soc_ops function pointer. Passes along the
3172 * return value from am33xx_prminst_assert_hardreset(). XXX This
3173 * function is scheduled for removal when the PRM code is moved into
3176 static int _am33xx_assert_hardreset(struct omap_hwmod
*oh
,
3177 struct omap_hwmod_rst_info
*ohri
)
3180 return am33xx_prm_assert_hardreset(ohri
->rst_shift
,
3181 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
3182 oh
->prcm
.omap4
.rstctrl_offs
);
3186 * _am33xx_deassert_hardreset - call AM33XX PRM hardreset fn with hwmod args
3187 * @oh: struct omap_hwmod * to deassert hardreset
3188 * @ohri: hardreset line data
3190 * Call am33xx_prminst_deassert_hardreset() with parameters extracted
3191 * from the hwmod @oh and the hardreset line data @ohri. Only
3192 * intended for use as an soc_ops function pointer. Passes along the
3193 * return value from am33xx_prminst_deassert_hardreset(). XXX This
3194 * function is scheduled for removal when the PRM code is moved into
3197 static int _am33xx_deassert_hardreset(struct omap_hwmod
*oh
,
3198 struct omap_hwmod_rst_info
*ohri
)
3200 return am33xx_prm_deassert_hardreset(ohri
->rst_shift
,
3202 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
3203 oh
->prcm
.omap4
.rstctrl_offs
,
3204 oh
->prcm
.omap4
.rstst_offs
);
3208 * _am33xx_is_hardreset_asserted - call AM33XX PRM hardreset fn with hwmod args
3209 * @oh: struct omap_hwmod * to test hardreset
3210 * @ohri: hardreset line data
3212 * Call am33xx_prminst_is_hardreset_asserted() with parameters
3213 * extracted from the hwmod @oh and the hardreset line data @ohri.
3214 * Only intended for use as an soc_ops function pointer. Passes along
3215 * the return value from am33xx_prminst_is_hardreset_asserted(). XXX
3216 * This function is scheduled for removal when the PRM code is moved
3219 static int _am33xx_is_hardreset_asserted(struct omap_hwmod
*oh
,
3220 struct omap_hwmod_rst_info
*ohri
)
3222 return am33xx_prm_is_hardreset_asserted(ohri
->rst_shift
,
3223 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
3224 oh
->prcm
.omap4
.rstctrl_offs
);
3227 /* Public functions */
3229 u32
omap_hwmod_read(struct omap_hwmod
*oh
, u16 reg_offs
)
3231 if (oh
->flags
& HWMOD_16BIT_REG
)
3232 return __raw_readw(oh
->_mpu_rt_va
+ reg_offs
);
3234 return __raw_readl(oh
->_mpu_rt_va
+ reg_offs
);
3237 void omap_hwmod_write(u32 v
, struct omap_hwmod
*oh
, u16 reg_offs
)
3239 if (oh
->flags
& HWMOD_16BIT_REG
)
3240 __raw_writew(v
, oh
->_mpu_rt_va
+ reg_offs
);
3242 __raw_writel(v
, oh
->_mpu_rt_va
+ reg_offs
);
3246 * omap_hwmod_softreset - reset a module via SYSCONFIG.SOFTRESET bit
3247 * @oh: struct omap_hwmod *
3249 * This is a public function exposed to drivers. Some drivers may need to do
3250 * some settings before and after resetting the device. Those drivers after
3251 * doing the necessary settings could use this function to start a reset by
3252 * setting the SYSCONFIG.SOFTRESET bit.
3254 int omap_hwmod_softreset(struct omap_hwmod
*oh
)
3259 if (!oh
|| !(oh
->_sysc_cache
))
3262 v
= oh
->_sysc_cache
;
3263 ret
= _set_softreset(oh
, &v
);
3266 _write_sysconfig(v
, oh
);
3268 ret
= _clear_softreset(oh
, &v
);
3271 _write_sysconfig(v
, oh
);
3278 * omap_hwmod_lookup - look up a registered omap_hwmod by name
3279 * @name: name of the omap_hwmod to look up
3281 * Given a @name of an omap_hwmod, return a pointer to the registered
3282 * struct omap_hwmod *, or NULL upon error.
3284 struct omap_hwmod
*omap_hwmod_lookup(const char *name
)
3286 struct omap_hwmod
*oh
;
3297 * omap_hwmod_for_each - call function for each registered omap_hwmod
3298 * @fn: pointer to a callback function
3299 * @data: void * data to pass to callback function
3301 * Call @fn for each registered omap_hwmod, passing @data to each
3302 * function. @fn must return 0 for success or any other value for
3303 * failure. If @fn returns non-zero, the iteration across omap_hwmods
3304 * will stop and the non-zero return value will be passed to the
3305 * caller of omap_hwmod_for_each(). @fn is called with
3306 * omap_hwmod_for_each() held.
3308 int omap_hwmod_for_each(int (*fn
)(struct omap_hwmod
*oh
, void *data
),
3311 struct omap_hwmod
*temp_oh
;
3317 list_for_each_entry(temp_oh
, &omap_hwmod_list
, node
) {
3318 ret
= (*fn
)(temp_oh
, data
);
3327 * omap_hwmod_register_links - register an array of hwmod links
3328 * @ois: pointer to an array of omap_hwmod_ocp_if to register
3330 * Intended to be called early in boot before the clock framework is
3331 * initialized. If @ois is not null, will register all omap_hwmods
3332 * listed in @ois that are valid for this chip. Returns -EINVAL if
3333 * omap_hwmod_init() hasn't been called before calling this function,
3334 * -ENOMEM if the link memory area can't be allocated, or 0 upon
3337 int __init
omap_hwmod_register_links(struct omap_hwmod_ocp_if
**ois
)
3348 if (_alloc_linkspace(ois
)) {
3349 pr_err("omap_hwmod: could not allocate link space\n");
3356 r
= _register_link(ois
[i
]);
3357 WARN(r
&& r
!= -EEXIST
,
3358 "omap_hwmod: _register_link(%s -> %s) returned %d\n",
3359 ois
[i
]->master
->name
, ois
[i
]->slave
->name
, r
);
3366 * _ensure_mpu_hwmod_is_setup - ensure the MPU SS hwmod is init'ed and set up
3367 * @oh: pointer to the hwmod currently being set up (usually not the MPU)
3369 * If the hwmod data corresponding to the MPU subsystem IP block
3370 * hasn't been initialized and set up yet, do so now. This must be
3371 * done first since sleep dependencies may be added from other hwmods
3372 * to the MPU. Intended to be called only by omap_hwmod_setup*(). No
3375 static void __init
_ensure_mpu_hwmod_is_setup(struct omap_hwmod
*oh
)
3377 if (!mpu_oh
|| mpu_oh
->_state
== _HWMOD_STATE_UNKNOWN
)
3378 pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",
3379 __func__
, MPU_INITIATOR_NAME
);
3380 else if (mpu_oh
->_state
== _HWMOD_STATE_REGISTERED
&& oh
!= mpu_oh
)
3381 omap_hwmod_setup_one(MPU_INITIATOR_NAME
);
3385 * omap_hwmod_setup_one - set up a single hwmod
3386 * @oh_name: const char * name of the already-registered hwmod to set up
3388 * Initialize and set up a single hwmod. Intended to be used for a
3389 * small number of early devices, such as the timer IP blocks used for
3390 * the scheduler clock. Must be called after omap2_clk_init().
3391 * Resolves the struct clk names to struct clk pointers for each
3392 * registered omap_hwmod. Also calls _setup() on each hwmod. Returns
3393 * -EINVAL upon error or 0 upon success.
3395 int __init
omap_hwmod_setup_one(const char *oh_name
)
3397 struct omap_hwmod
*oh
;
3399 pr_debug("omap_hwmod: %s: %s\n", oh_name
, __func__
);
3401 oh
= _lookup(oh_name
);
3403 WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name
);
3407 _ensure_mpu_hwmod_is_setup(oh
);
3416 * omap_hwmod_setup_all - set up all registered IP blocks
3418 * Initialize and set up all IP blocks registered with the hwmod code.
3419 * Must be called after omap2_clk_init(). Resolves the struct clk
3420 * names to struct clk pointers for each registered omap_hwmod. Also
3421 * calls _setup() on each hwmod. Returns 0 upon success.
3423 static int __init
omap_hwmod_setup_all(void)
3425 _ensure_mpu_hwmod_is_setup(NULL
);
3427 omap_hwmod_for_each(_init
, NULL
);
3428 omap_hwmod_for_each(_setup
, NULL
);
3432 omap_core_initcall(omap_hwmod_setup_all
);
3435 * omap_hwmod_enable - enable an omap_hwmod
3436 * @oh: struct omap_hwmod *
3438 * Enable an omap_hwmod @oh. Intended to be called by omap_device_enable().
3439 * Returns -EINVAL on error or passes along the return value from _enable().
3441 int omap_hwmod_enable(struct omap_hwmod
*oh
)
3444 unsigned long flags
;
3449 spin_lock_irqsave(&oh
->_lock
, flags
);
3451 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3457 * omap_hwmod_idle - idle an omap_hwmod
3458 * @oh: struct omap_hwmod *
3460 * Idle an omap_hwmod @oh. Intended to be called by omap_device_idle().
3461 * Returns -EINVAL on error or passes along the return value from _idle().
3463 int omap_hwmod_idle(struct omap_hwmod
*oh
)
3465 unsigned long flags
;
3470 spin_lock_irqsave(&oh
->_lock
, flags
);
3472 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3478 * omap_hwmod_shutdown - shutdown an omap_hwmod
3479 * @oh: struct omap_hwmod *
3481 * Shutdown an omap_hwmod @oh. Intended to be called by
3482 * omap_device_shutdown(). Returns -EINVAL on error or passes along
3483 * the return value from _shutdown().
3485 int omap_hwmod_shutdown(struct omap_hwmod
*oh
)
3487 unsigned long flags
;
3492 spin_lock_irqsave(&oh
->_lock
, flags
);
3494 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3500 * omap_hwmod_enable_clocks - enable main_clk, all interface clocks
3501 * @oh: struct omap_hwmod *oh
3503 * Intended to be called by the omap_device code.
3505 int omap_hwmod_enable_clocks(struct omap_hwmod
*oh
)
3507 unsigned long flags
;
3509 spin_lock_irqsave(&oh
->_lock
, flags
);
3511 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3517 * omap_hwmod_disable_clocks - disable main_clk, all interface clocks
3518 * @oh: struct omap_hwmod *oh
3520 * Intended to be called by the omap_device code.
3522 int omap_hwmod_disable_clocks(struct omap_hwmod
*oh
)
3524 unsigned long flags
;
3526 spin_lock_irqsave(&oh
->_lock
, flags
);
3527 _disable_clocks(oh
);
3528 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3534 * omap_hwmod_ocp_barrier - wait for posted writes against the hwmod to complete
3535 * @oh: struct omap_hwmod *oh
3537 * Intended to be called by drivers and core code when all posted
3538 * writes to a device must complete before continuing further
3539 * execution (for example, after clearing some device IRQSTATUS
3542 * XXX what about targets with multiple OCP threads?
3544 void omap_hwmod_ocp_barrier(struct omap_hwmod
*oh
)
3548 if (!oh
->class->sysc
|| !oh
->class->sysc
->sysc_flags
) {
3549 WARN(1, "omap_device: %s: OCP barrier impossible due to device configuration\n",
3555 * Forces posted writes to complete on the OCP thread handling
3558 omap_hwmod_read(oh
, oh
->class->sysc
->sysc_offs
);
3562 * omap_hwmod_reset - reset the hwmod
3563 * @oh: struct omap_hwmod *
3565 * Under some conditions, a driver may wish to reset the entire device.
3566 * Called from omap_device code. Returns -EINVAL on error or passes along
3567 * the return value from _reset().
3569 int omap_hwmod_reset(struct omap_hwmod
*oh
)
3572 unsigned long flags
;
3577 spin_lock_irqsave(&oh
->_lock
, flags
);
3579 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3585 * IP block data retrieval functions
3589 * omap_hwmod_count_resources - count number of struct resources needed by hwmod
3590 * @oh: struct omap_hwmod *
3591 * @flags: Type of resources to include when counting (IRQ/DMA/MEM)
3593 * Count the number of struct resource array elements necessary to
3594 * contain omap_hwmod @oh resources. Intended to be called by code
3595 * that registers omap_devices. Intended to be used to determine the
3596 * size of a dynamically-allocated struct resource array, before
3597 * calling omap_hwmod_fill_resources(). Returns the number of struct
3598 * resource array elements needed.
3600 * XXX This code is not optimized. It could attempt to merge adjacent
3604 int omap_hwmod_count_resources(struct omap_hwmod
*oh
, unsigned long flags
)
3608 if (flags
& IORESOURCE_IRQ
)
3609 ret
+= _count_mpu_irqs(oh
);
3611 if (flags
& IORESOURCE_DMA
)
3612 ret
+= _count_sdma_reqs(oh
);
3614 if (flags
& IORESOURCE_MEM
) {
3616 struct omap_hwmod_ocp_if
*os
;
3617 struct list_head
*p
= oh
->slave_ports
.next
;
3619 while (i
< oh
->slaves_cnt
) {
3620 os
= _fetch_next_ocp_if(&p
, &i
);
3621 ret
+= _count_ocp_if_addr_spaces(os
);
3629 * omap_hwmod_fill_resources - fill struct resource array with hwmod data
3630 * @oh: struct omap_hwmod *
3631 * @res: pointer to the first element of an array of struct resource to fill
3633 * Fill the struct resource array @res with resource data from the
3634 * omap_hwmod @oh. Intended to be called by code that registers
3635 * omap_devices. See also omap_hwmod_count_resources(). Returns the
3636 * number of array elements filled.
3638 int omap_hwmod_fill_resources(struct omap_hwmod
*oh
, struct resource
*res
)
3640 struct omap_hwmod_ocp_if
*os
;
3641 struct list_head
*p
;
3642 int i
, j
, mpu_irqs_cnt
, sdma_reqs_cnt
, addr_cnt
;
3645 /* For each IRQ, DMA, memory area, fill in array.*/
3647 mpu_irqs_cnt
= _count_mpu_irqs(oh
);
3648 for (i
= 0; i
< mpu_irqs_cnt
; i
++) {
3649 (res
+ r
)->name
= (oh
->mpu_irqs
+ i
)->name
;
3650 (res
+ r
)->start
= (oh
->mpu_irqs
+ i
)->irq
;
3651 (res
+ r
)->end
= (oh
->mpu_irqs
+ i
)->irq
;
3652 (res
+ r
)->flags
= IORESOURCE_IRQ
;
3656 sdma_reqs_cnt
= _count_sdma_reqs(oh
);
3657 for (i
= 0; i
< sdma_reqs_cnt
; i
++) {
3658 (res
+ r
)->name
= (oh
->sdma_reqs
+ i
)->name
;
3659 (res
+ r
)->start
= (oh
->sdma_reqs
+ i
)->dma_req
;
3660 (res
+ r
)->end
= (oh
->sdma_reqs
+ i
)->dma_req
;
3661 (res
+ r
)->flags
= IORESOURCE_DMA
;
3665 p
= oh
->slave_ports
.next
;
3668 while (i
< oh
->slaves_cnt
) {
3669 os
= _fetch_next_ocp_if(&p
, &i
);
3670 addr_cnt
= _count_ocp_if_addr_spaces(os
);
3672 for (j
= 0; j
< addr_cnt
; j
++) {
3673 (res
+ r
)->name
= (os
->addr
+ j
)->name
;
3674 (res
+ r
)->start
= (os
->addr
+ j
)->pa_start
;
3675 (res
+ r
)->end
= (os
->addr
+ j
)->pa_end
;
3676 (res
+ r
)->flags
= IORESOURCE_MEM
;
3685 * omap_hwmod_fill_dma_resources - fill struct resource array with dma data
3686 * @oh: struct omap_hwmod *
3687 * @res: pointer to the array of struct resource to fill
3689 * Fill the struct resource array @res with dma resource data from the
3690 * omap_hwmod @oh. Intended to be called by code that registers
3691 * omap_devices. See also omap_hwmod_count_resources(). Returns the
3692 * number of array elements filled.
3694 int omap_hwmod_fill_dma_resources(struct omap_hwmod
*oh
, struct resource
*res
)
3696 int i
, sdma_reqs_cnt
;
3699 sdma_reqs_cnt
= _count_sdma_reqs(oh
);
3700 for (i
= 0; i
< sdma_reqs_cnt
; i
++) {
3701 (res
+ r
)->name
= (oh
->sdma_reqs
+ i
)->name
;
3702 (res
+ r
)->start
= (oh
->sdma_reqs
+ i
)->dma_req
;
3703 (res
+ r
)->end
= (oh
->sdma_reqs
+ i
)->dma_req
;
3704 (res
+ r
)->flags
= IORESOURCE_DMA
;
3712 * omap_hwmod_get_resource_byname - fetch IP block integration data by name
3713 * @oh: struct omap_hwmod * to operate on
3714 * @type: one of the IORESOURCE_* constants from include/linux/ioport.h
3715 * @name: pointer to the name of the data to fetch (optional)
3716 * @rsrc: pointer to a struct resource, allocated by the caller
3718 * Retrieve MPU IRQ, SDMA request line, or address space start/end
3719 * data for the IP block pointed to by @oh. The data will be filled
3720 * into a struct resource record pointed to by @rsrc. The struct
3721 * resource must be allocated by the caller. When @name is non-null,
3722 * the data associated with the matching entry in the IRQ/SDMA/address
3723 * space hwmod data arrays will be returned. If @name is null, the
3724 * first array entry will be returned. Data order is not meaningful
3725 * in hwmod data, so callers are strongly encouraged to use a non-null
3726 * @name whenever possible to avoid unpredictable effects if hwmod
3727 * data is later added that causes data ordering to change. This
3728 * function is only intended for use by OMAP core code. Device
3729 * drivers should not call this function - the appropriate bus-related
3730 * data accessor functions should be used instead. Returns 0 upon
3731 * success or a negative error code upon error.
3733 int omap_hwmod_get_resource_byname(struct omap_hwmod
*oh
, unsigned int type
,
3734 const char *name
, struct resource
*rsrc
)
3737 unsigned int irq
, dma
;
3738 u32 pa_start
, pa_end
;
3743 if (type
== IORESOURCE_IRQ
) {
3744 r
= _get_mpu_irq_by_name(oh
, name
, &irq
);
3750 } else if (type
== IORESOURCE_DMA
) {
3751 r
= _get_sdma_req_by_name(oh
, name
, &dma
);
3757 } else if (type
== IORESOURCE_MEM
) {
3758 r
= _get_addr_space_by_name(oh
, name
, &pa_start
, &pa_end
);
3762 rsrc
->start
= pa_start
;
3775 * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
3776 * @oh: struct omap_hwmod *
3778 * Return the powerdomain pointer associated with the OMAP module
3779 * @oh's main clock. If @oh does not have a main clk, return the
3780 * powerdomain associated with the interface clock associated with the
3781 * module's MPU port. (XXX Perhaps this should use the SDMA port
3782 * instead?) Returns NULL on error, or a struct powerdomain * on
3785 struct powerdomain
*omap_hwmod_get_pwrdm(struct omap_hwmod
*oh
)
3788 struct omap_hwmod_ocp_if
*oi
;
3789 struct clockdomain
*clkdm
;
3790 struct clk_hw_omap
*clk
;
3796 return oh
->clkdm
->pwrdm
.ptr
;
3801 oi
= _find_mpu_rt_port(oh
);
3807 clk
= to_clk_hw_omap(__clk_get_hw(c
));
3812 return clkdm
->pwrdm
.ptr
;
3816 * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
3817 * @oh: struct omap_hwmod *
3819 * Returns the virtual address corresponding to the beginning of the
3820 * module's register target, in the address range that is intended to
3821 * be used by the MPU. Returns the virtual address upon success or NULL
3824 void __iomem
*omap_hwmod_get_mpu_rt_va(struct omap_hwmod
*oh
)
3829 if (oh
->_int_flags
& _HWMOD_NO_MPU_PORT
)
3832 if (oh
->_state
== _HWMOD_STATE_UNKNOWN
)
3835 return oh
->_mpu_rt_va
;
3839 * omap_hwmod_add_initiator_dep - add sleepdep from @init_oh to @oh
3840 * @oh: struct omap_hwmod *
3841 * @init_oh: struct omap_hwmod * (initiator)
3843 * Add a sleep dependency between the initiator @init_oh and @oh.
3844 * Intended to be called by DSP/Bridge code via platform_data for the
3845 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
3846 * code needs to add/del initiator dependencies dynamically
3847 * before/after accessing a device. Returns the return value from
3848 * _add_initiator_dep().
3850 * XXX Keep a usecount in the clockdomain code
3852 int omap_hwmod_add_initiator_dep(struct omap_hwmod
*oh
,
3853 struct omap_hwmod
*init_oh
)
3855 return _add_initiator_dep(oh
, init_oh
);
3859 * XXX what about functions for drivers to save/restore ocp_sysconfig
3860 * for context save/restore operations?
3864 * omap_hwmod_del_initiator_dep - remove sleepdep from @init_oh to @oh
3865 * @oh: struct omap_hwmod *
3866 * @init_oh: struct omap_hwmod * (initiator)
3868 * Remove a sleep dependency between the initiator @init_oh and @oh.
3869 * Intended to be called by DSP/Bridge code via platform_data for the
3870 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
3871 * code needs to add/del initiator dependencies dynamically
3872 * before/after accessing a device. Returns the return value from
3873 * _del_initiator_dep().
3875 * XXX Keep a usecount in the clockdomain code
3877 int omap_hwmod_del_initiator_dep(struct omap_hwmod
*oh
,
3878 struct omap_hwmod
*init_oh
)
3880 return _del_initiator_dep(oh
, init_oh
);
3884 * omap_hwmod_enable_wakeup - allow device to wake up the system
3885 * @oh: struct omap_hwmod *
3887 * Sets the module OCP socket ENAWAKEUP bit to allow the module to
3888 * send wakeups to the PRCM, and enable I/O ring wakeup events for
3889 * this IP block if it has dynamic mux entries. Eventually this
3890 * should set PRCM wakeup registers to cause the PRCM to receive
3891 * wakeup events from the module. Does not set any wakeup routing
3892 * registers beyond this point - if the module is to wake up any other
3893 * module or subsystem, that must be set separately. Called by
3894 * omap_device code. Returns -EINVAL on error or 0 upon success.
3896 int omap_hwmod_enable_wakeup(struct omap_hwmod
*oh
)
3898 unsigned long flags
;
3901 spin_lock_irqsave(&oh
->_lock
, flags
);
3903 if (oh
->class->sysc
&&
3904 (oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
)) {
3905 v
= oh
->_sysc_cache
;
3906 _enable_wakeup(oh
, &v
);
3907 _write_sysconfig(v
, oh
);
3910 _set_idle_ioring_wakeup(oh
, true);
3911 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3917 * omap_hwmod_disable_wakeup - prevent device from waking the system
3918 * @oh: struct omap_hwmod *
3920 * Clears the module OCP socket ENAWAKEUP bit to prevent the module
3921 * from sending wakeups to the PRCM, and disable I/O ring wakeup
3922 * events for this IP block if it has dynamic mux entries. Eventually
3923 * this should clear PRCM wakeup registers to cause the PRCM to ignore
3924 * wakeup events from the module. Does not set any wakeup routing
3925 * registers beyond this point - if the module is to wake up any other
3926 * module or subsystem, that must be set separately. Called by
3927 * omap_device code. Returns -EINVAL on error or 0 upon success.
3929 int omap_hwmod_disable_wakeup(struct omap_hwmod
*oh
)
3931 unsigned long flags
;
3934 spin_lock_irqsave(&oh
->_lock
, flags
);
3936 if (oh
->class->sysc
&&
3937 (oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
)) {
3938 v
= oh
->_sysc_cache
;
3939 _disable_wakeup(oh
, &v
);
3940 _write_sysconfig(v
, oh
);
3943 _set_idle_ioring_wakeup(oh
, false);
3944 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3950 * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
3951 * contained in the hwmod module.
3952 * @oh: struct omap_hwmod *
3953 * @name: name of the reset line to lookup and assert
3955 * Some IP like dsp, ipu or iva contain processor that require
3956 * an HW reset line to be assert / deassert in order to enable fully
3957 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3958 * yet supported on this OMAP; otherwise, passes along the return value
3959 * from _assert_hardreset().
3961 int omap_hwmod_assert_hardreset(struct omap_hwmod
*oh
, const char *name
)
3964 unsigned long flags
;
3969 spin_lock_irqsave(&oh
->_lock
, flags
);
3970 ret
= _assert_hardreset(oh
, name
);
3971 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3977 * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
3978 * contained in the hwmod module.
3979 * @oh: struct omap_hwmod *
3980 * @name: name of the reset line to look up and deassert
3982 * Some IP like dsp, ipu or iva contain processor that require
3983 * an HW reset line to be assert / deassert in order to enable fully
3984 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3985 * yet supported on this OMAP; otherwise, passes along the return value
3986 * from _deassert_hardreset().
3988 int omap_hwmod_deassert_hardreset(struct omap_hwmod
*oh
, const char *name
)
3991 unsigned long flags
;
3996 spin_lock_irqsave(&oh
->_lock
, flags
);
3997 ret
= _deassert_hardreset(oh
, name
);
3998 spin_unlock_irqrestore(&oh
->_lock
, flags
);
4004 * omap_hwmod_read_hardreset - read the HW reset line state of submodules
4005 * contained in the hwmod module
4006 * @oh: struct omap_hwmod *
4007 * @name: name of the reset line to look up and read
4009 * Return the current state of the hwmod @oh's reset line named @name:
4010 * returns -EINVAL upon parameter error or if this operation
4011 * is unsupported on the current OMAP; otherwise, passes along the return
4012 * value from _read_hardreset().
4014 int omap_hwmod_read_hardreset(struct omap_hwmod
*oh
, const char *name
)
4017 unsigned long flags
;
4022 spin_lock_irqsave(&oh
->_lock
, flags
);
4023 ret
= _read_hardreset(oh
, name
);
4024 spin_unlock_irqrestore(&oh
->_lock
, flags
);
4031 * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
4032 * @classname: struct omap_hwmod_class name to search for
4033 * @fn: callback function pointer to call for each hwmod in class @classname
4034 * @user: arbitrary context data to pass to the callback function
4036 * For each omap_hwmod of class @classname, call @fn.
4037 * If the callback function returns something other than
4038 * zero, the iterator is terminated, and the callback function's return
4039 * value is passed back to the caller. Returns 0 upon success, -EINVAL
4040 * if @classname or @fn are NULL, or passes back the error code from @fn.
4042 int omap_hwmod_for_each_by_class(const char *classname
,
4043 int (*fn
)(struct omap_hwmod
*oh
,
4047 struct omap_hwmod
*temp_oh
;
4050 if (!classname
|| !fn
)
4053 pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
4054 __func__
, classname
);
4056 list_for_each_entry(temp_oh
, &omap_hwmod_list
, node
) {
4057 if (!strcmp(temp_oh
->class->name
, classname
)) {
4058 pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
4059 __func__
, temp_oh
->name
);
4060 ret
= (*fn
)(temp_oh
, user
);
4067 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
4074 * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
4075 * @oh: struct omap_hwmod *
4076 * @state: state that _setup() should leave the hwmod in
4078 * Sets the hwmod state that @oh will enter at the end of _setup()
4079 * (called by omap_hwmod_setup_*()). See also the documentation
4080 * for _setup_postsetup(), above. Returns 0 upon success or
4081 * -EINVAL if there is a problem with the arguments or if the hwmod is
4082 * in the wrong state.
4084 int omap_hwmod_set_postsetup_state(struct omap_hwmod
*oh
, u8 state
)
4087 unsigned long flags
;
4092 if (state
!= _HWMOD_STATE_DISABLED
&&
4093 state
!= _HWMOD_STATE_ENABLED
&&
4094 state
!= _HWMOD_STATE_IDLE
)
4097 spin_lock_irqsave(&oh
->_lock
, flags
);
4099 if (oh
->_state
!= _HWMOD_STATE_REGISTERED
) {
4104 oh
->_postsetup_state
= state
;
4108 spin_unlock_irqrestore(&oh
->_lock
, flags
);
4114 * omap_hwmod_get_context_loss_count - get lost context count
4115 * @oh: struct omap_hwmod *
4117 * Returns the context loss count of associated @oh
4118 * upon success, or zero if no context loss data is available.
4120 * On OMAP4, this queries the per-hwmod context loss register,
4121 * assuming one exists. If not, or on OMAP2/3, this queries the
4122 * enclosing powerdomain context loss count.
4124 int omap_hwmod_get_context_loss_count(struct omap_hwmod
*oh
)
4126 struct powerdomain
*pwrdm
;
4129 if (soc_ops
.get_context_lost
)
4130 return soc_ops
.get_context_lost(oh
);
4132 pwrdm
= omap_hwmod_get_pwrdm(oh
);
4134 ret
= pwrdm_get_context_loss_count(pwrdm
);
4140 * omap_hwmod_no_setup_reset - prevent a hwmod from being reset upon setup
4141 * @oh: struct omap_hwmod *
4143 * Prevent the hwmod @oh from being reset during the setup process.
4144 * Intended for use by board-*.c files on boards with devices that
4145 * cannot tolerate being reset. Must be called before the hwmod has
4146 * been set up. Returns 0 upon success or negative error code upon
4149 int omap_hwmod_no_setup_reset(struct omap_hwmod
*oh
)
4154 if (oh
->_state
!= _HWMOD_STATE_REGISTERED
) {
4155 pr_err("omap_hwmod: %s: cannot prevent setup reset; in wrong state\n",
4160 oh
->flags
|= HWMOD_INIT_NO_RESET
;
4166 * omap_hwmod_pad_route_irq - route an I/O pad wakeup to a particular MPU IRQ
4167 * @oh: struct omap_hwmod * containing hwmod mux entries
4168 * @pad_idx: array index in oh->mux of the hwmod mux entry to route wakeup
4169 * @irq_idx: the hwmod mpu_irqs array index of the IRQ to trigger on wakeup
4171 * When an I/O pad wakeup arrives for the dynamic or wakeup hwmod mux
4172 * entry number @pad_idx for the hwmod @oh, trigger the interrupt
4173 * service routine for the hwmod's mpu_irqs array index @irq_idx. If
4174 * this function is not called for a given pad_idx, then the ISR
4175 * associated with @oh's first MPU IRQ will be triggered when an I/O
4176 * pad wakeup occurs on that pad. Note that @pad_idx is the index of
4177 * the _dynamic or wakeup_ entry: if there are other entries not
4178 * marked with OMAP_DEVICE_PAD_WAKEUP or OMAP_DEVICE_PAD_REMUX, these
4179 * entries are NOT COUNTED in the dynamic pad index. This function
4180 * must be called separately for each pad that requires its interrupt
4181 * to be re-routed this way. Returns -EINVAL if there is an argument
4182 * problem or if @oh does not have hwmod mux entries or MPU IRQs;
4183 * returns -ENOMEM if memory cannot be allocated; or 0 upon success.
4185 * XXX This function interface is fragile. Rather than using array
4186 * indexes, which are subject to unpredictable change, it should be
4187 * using hwmod IRQ names, and some other stable key for the hwmod mux
4190 int omap_hwmod_pad_route_irq(struct omap_hwmod
*oh
, int pad_idx
, int irq_idx
)
4196 if (!oh
|| !oh
->mux
|| !oh
->mpu_irqs
|| pad_idx
< 0 ||
4197 pad_idx
>= oh
->mux
->nr_pads_dynamic
)
4200 /* Check the number of available mpu_irqs */
4201 for (nr_irqs
= 0; oh
->mpu_irqs
[nr_irqs
].irq
>= 0; nr_irqs
++)
4204 if (irq_idx
>= nr_irqs
)
4207 if (!oh
->mux
->irqs
) {
4208 /* XXX What frees this? */
4209 oh
->mux
->irqs
= kzalloc(sizeof(int) * oh
->mux
->nr_pads_dynamic
,
4214 oh
->mux
->irqs
[pad_idx
] = irq_idx
;
4220 * omap_hwmod_init - initialize the hwmod code
4222 * Sets up some function pointers needed by the hwmod code to operate on the
4223 * currently-booted SoC. Intended to be called once during kernel init
4224 * before any hwmods are registered. No return value.
4226 void __init
omap_hwmod_init(void)
4228 if (cpu_is_omap24xx()) {
4229 soc_ops
.wait_target_ready
= _omap2xxx_wait_target_ready
;
4230 soc_ops
.assert_hardreset
= _omap2_assert_hardreset
;
4231 soc_ops
.deassert_hardreset
= _omap2_deassert_hardreset
;
4232 soc_ops
.is_hardreset_asserted
= _omap2_is_hardreset_asserted
;
4233 } else if (cpu_is_omap34xx()) {
4234 soc_ops
.wait_target_ready
= _omap3xxx_wait_target_ready
;
4235 soc_ops
.assert_hardreset
= _omap2_assert_hardreset
;
4236 soc_ops
.deassert_hardreset
= _omap2_deassert_hardreset
;
4237 soc_ops
.is_hardreset_asserted
= _omap2_is_hardreset_asserted
;
4238 soc_ops
.init_clkdm
= _init_clkdm
;
4239 } else if (cpu_is_omap44xx() || soc_is_omap54xx() || soc_is_dra7xx()) {
4240 soc_ops
.enable_module
= _omap4_enable_module
;
4241 soc_ops
.disable_module
= _omap4_disable_module
;
4242 soc_ops
.wait_target_ready
= _omap4_wait_target_ready
;
4243 soc_ops
.assert_hardreset
= _omap4_assert_hardreset
;
4244 soc_ops
.deassert_hardreset
= _omap4_deassert_hardreset
;
4245 soc_ops
.is_hardreset_asserted
= _omap4_is_hardreset_asserted
;
4246 soc_ops
.init_clkdm
= _init_clkdm
;
4247 soc_ops
.update_context_lost
= _omap4_update_context_lost
;
4248 soc_ops
.get_context_lost
= _omap4_get_context_lost
;
4249 } else if (soc_is_am43xx()) {
4250 soc_ops
.enable_module
= _omap4_enable_module
;
4251 soc_ops
.disable_module
= _omap4_disable_module
;
4252 soc_ops
.wait_target_ready
= _omap4_wait_target_ready
;
4253 soc_ops
.assert_hardreset
= _omap4_assert_hardreset
;
4254 soc_ops
.deassert_hardreset
= _omap4_deassert_hardreset
;
4255 soc_ops
.is_hardreset_asserted
= _omap4_is_hardreset_asserted
;
4256 soc_ops
.init_clkdm
= _init_clkdm
;
4257 } else if (soc_is_am33xx()) {
4258 soc_ops
.enable_module
= _am33xx_enable_module
;
4259 soc_ops
.disable_module
= _am33xx_disable_module
;
4260 soc_ops
.wait_target_ready
= _am33xx_wait_target_ready
;
4261 soc_ops
.assert_hardreset
= _am33xx_assert_hardreset
;
4262 soc_ops
.deassert_hardreset
= _am33xx_deassert_hardreset
;
4263 soc_ops
.is_hardreset_asserted
= _am33xx_is_hardreset_asserted
;
4264 soc_ops
.init_clkdm
= _init_clkdm
;
4266 WARN(1, "omap_hwmod: unknown SoC type\n");
4273 * omap_hwmod_get_main_clk - get pointer to main clock name
4274 * @oh: struct omap_hwmod *
4276 * Returns the main clock name assocated with @oh upon success,
4277 * or NULL if @oh is NULL.
4279 const char *omap_hwmod_get_main_clk(struct omap_hwmod
*oh
)
4284 return oh
->main_clk
;