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 * | ({read,write}l_relaxed, 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"
161 #include "prminst44xx.h"
165 /* Name of the OMAP hwmod for the MPU */
166 #define MPU_INITIATOR_NAME "mpu"
169 * Number of struct omap_hwmod_link records per struct
170 * omap_hwmod_ocp_if record (master->slave and slave->master)
172 #define LINKS_PER_OCP_IF 2
175 * struct omap_hwmod_soc_ops - fn ptrs for some SoC-specific operations
176 * @enable_module: function to enable a module (via MODULEMODE)
177 * @disable_module: function to disable a module (via MODULEMODE)
179 * XXX Eventually this functionality will be hidden inside the PRM/CM
180 * device drivers. Until then, this should avoid huge blocks of cpu_is_*()
181 * conditionals in this code.
183 struct omap_hwmod_soc_ops
{
184 void (*enable_module
)(struct omap_hwmod
*oh
);
185 int (*disable_module
)(struct omap_hwmod
*oh
);
186 int (*wait_target_ready
)(struct omap_hwmod
*oh
);
187 int (*assert_hardreset
)(struct omap_hwmod
*oh
,
188 struct omap_hwmod_rst_info
*ohri
);
189 int (*deassert_hardreset
)(struct omap_hwmod
*oh
,
190 struct omap_hwmod_rst_info
*ohri
);
191 int (*is_hardreset_asserted
)(struct omap_hwmod
*oh
,
192 struct omap_hwmod_rst_info
*ohri
);
193 int (*init_clkdm
)(struct omap_hwmod
*oh
);
194 void (*update_context_lost
)(struct omap_hwmod
*oh
);
195 int (*get_context_lost
)(struct omap_hwmod
*oh
);
198 /* soc_ops: adapts the omap_hwmod code to the currently-booted SoC */
199 static struct omap_hwmod_soc_ops soc_ops
;
201 /* omap_hwmod_list contains all registered struct omap_hwmods */
202 static LIST_HEAD(omap_hwmod_list
);
204 /* mpu_oh: used to add/remove MPU initiator from sleepdep list */
205 static struct omap_hwmod
*mpu_oh
;
207 /* io_chain_lock: used to serialize reconfigurations of the I/O chain */
208 static DEFINE_SPINLOCK(io_chain_lock
);
211 * linkspace: ptr to a buffer that struct omap_hwmod_link records are
212 * allocated from - used to reduce the number of small memory
213 * allocations, which has a significant impact on performance
215 static struct omap_hwmod_link
*linkspace
;
218 * free_ls, max_ls: array indexes into linkspace; representing the
219 * next free struct omap_hwmod_link index, and the maximum number of
220 * struct omap_hwmod_link records allocated (respectively)
222 static unsigned short free_ls
, max_ls
, ls_supp
;
224 /* inited: set to true once the hwmod code is initialized */
227 /* Private functions */
230 * _fetch_next_ocp_if - return the next OCP interface in a list
231 * @p: ptr to a ptr to the list_head inside the ocp_if to return
232 * @i: pointer to the index of the element pointed to by @p in the list
234 * Return a pointer to the struct omap_hwmod_ocp_if record
235 * containing the struct list_head pointed to by @p, and increment
236 * @p such that a future call to this routine will return the next
239 static struct omap_hwmod_ocp_if
*_fetch_next_ocp_if(struct list_head
**p
,
242 struct omap_hwmod_ocp_if
*oi
;
244 oi
= list_entry(*p
, struct omap_hwmod_link
, node
)->ocp_if
;
253 * _update_sysc_cache - return the module OCP_SYSCONFIG register, keep copy
254 * @oh: struct omap_hwmod *
256 * Load the current value of the hwmod OCP_SYSCONFIG register into the
257 * struct omap_hwmod for later use. Returns -EINVAL if the hwmod has no
258 * OCP_SYSCONFIG register or 0 upon success.
260 static int _update_sysc_cache(struct omap_hwmod
*oh
)
262 if (!oh
->class->sysc
) {
263 WARN(1, "omap_hwmod: %s: cannot read OCP_SYSCONFIG: not defined on hwmod's class\n", oh
->name
);
267 /* XXX ensure module interface clock is up */
269 oh
->_sysc_cache
= omap_hwmod_read(oh
, oh
->class->sysc
->sysc_offs
);
271 if (!(oh
->class->sysc
->sysc_flags
& SYSC_NO_CACHE
))
272 oh
->_int_flags
|= _HWMOD_SYSCONFIG_LOADED
;
278 * _write_sysconfig - write a value to the module's OCP_SYSCONFIG register
279 * @v: OCP_SYSCONFIG value to write
280 * @oh: struct omap_hwmod *
282 * Write @v into the module class' OCP_SYSCONFIG register, if it has
283 * one. No return value.
285 static void _write_sysconfig(u32 v
, struct omap_hwmod
*oh
)
287 if (!oh
->class->sysc
) {
288 WARN(1, "omap_hwmod: %s: cannot write OCP_SYSCONFIG: not defined on hwmod's class\n", oh
->name
);
292 /* XXX ensure module interface clock is up */
294 /* Module might have lost context, always update cache and register */
296 omap_hwmod_write(v
, oh
, oh
->class->sysc
->sysc_offs
);
300 * _set_master_standbymode: set the OCP_SYSCONFIG MIDLEMODE field in @v
301 * @oh: struct omap_hwmod *
302 * @standbymode: MIDLEMODE field bits
303 * @v: pointer to register contents to modify
305 * Update the master standby mode bits in @v to be @standbymode for
306 * the @oh hwmod. Does not write to the hardware. Returns -EINVAL
307 * upon error or 0 upon success.
309 static int _set_master_standbymode(struct omap_hwmod
*oh
, u8 standbymode
,
315 if (!oh
->class->sysc
||
316 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_MIDLEMODE
))
319 if (!oh
->class->sysc
->sysc_fields
) {
320 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
324 mstandby_shift
= oh
->class->sysc
->sysc_fields
->midle_shift
;
325 mstandby_mask
= (0x3 << mstandby_shift
);
327 *v
&= ~mstandby_mask
;
328 *v
|= __ffs(standbymode
) << mstandby_shift
;
334 * _set_slave_idlemode: set the OCP_SYSCONFIG SIDLEMODE field in @v
335 * @oh: struct omap_hwmod *
336 * @idlemode: SIDLEMODE field bits
337 * @v: pointer to register contents to modify
339 * Update the slave idle mode bits in @v to be @idlemode for the @oh
340 * hwmod. Does not write to the hardware. Returns -EINVAL upon error
343 static int _set_slave_idlemode(struct omap_hwmod
*oh
, u8 idlemode
, u32
*v
)
348 if (!oh
->class->sysc
||
349 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_SIDLEMODE
))
352 if (!oh
->class->sysc
->sysc_fields
) {
353 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
357 sidle_shift
= oh
->class->sysc
->sysc_fields
->sidle_shift
;
358 sidle_mask
= (0x3 << sidle_shift
);
361 *v
|= __ffs(idlemode
) << sidle_shift
;
367 * _set_clockactivity: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
368 * @oh: struct omap_hwmod *
369 * @clockact: CLOCKACTIVITY field bits
370 * @v: pointer to register contents to modify
372 * Update the clockactivity mode bits in @v to be @clockact for the
373 * @oh hwmod. Used for additional powersaving on some modules. Does
374 * not write to the hardware. Returns -EINVAL upon error or 0 upon
377 static int _set_clockactivity(struct omap_hwmod
*oh
, u8 clockact
, u32
*v
)
382 if (!oh
->class->sysc
||
383 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_CLOCKACTIVITY
))
386 if (!oh
->class->sysc
->sysc_fields
) {
387 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
391 clkact_shift
= oh
->class->sysc
->sysc_fields
->clkact_shift
;
392 clkact_mask
= (0x3 << clkact_shift
);
395 *v
|= clockact
<< clkact_shift
;
401 * _set_softreset: set OCP_SYSCONFIG.SOFTRESET bit in @v
402 * @oh: struct omap_hwmod *
403 * @v: pointer to register contents to modify
405 * Set the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
406 * error or 0 upon success.
408 static int _set_softreset(struct omap_hwmod
*oh
, u32
*v
)
412 if (!oh
->class->sysc
||
413 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_SOFTRESET
))
416 if (!oh
->class->sysc
->sysc_fields
) {
417 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
421 softrst_mask
= (0x1 << oh
->class->sysc
->sysc_fields
->srst_shift
);
429 * _clear_softreset: clear OCP_SYSCONFIG.SOFTRESET bit in @v
430 * @oh: struct omap_hwmod *
431 * @v: pointer to register contents to modify
433 * Clear the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
434 * error or 0 upon success.
436 static int _clear_softreset(struct omap_hwmod
*oh
, u32
*v
)
440 if (!oh
->class->sysc
||
441 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_SOFTRESET
))
444 if (!oh
->class->sysc
->sysc_fields
) {
446 "omap_hwmod: %s: sysc_fields absent for sysconfig class\n",
451 softrst_mask
= (0x1 << oh
->class->sysc
->sysc_fields
->srst_shift
);
459 * _wait_softreset_complete - wait for an OCP softreset to complete
460 * @oh: struct omap_hwmod * to wait on
462 * Wait until the IP block represented by @oh reports that its OCP
463 * softreset is complete. This can be triggered by software (see
464 * _ocp_softreset()) or by hardware upon returning from off-mode (one
465 * example is HSMMC). Waits for up to MAX_MODULE_SOFTRESET_WAIT
466 * microseconds. Returns the number of microseconds waited.
468 static int _wait_softreset_complete(struct omap_hwmod
*oh
)
470 struct omap_hwmod_class_sysconfig
*sysc
;
474 sysc
= oh
->class->sysc
;
476 if (sysc
->sysc_flags
& SYSS_HAS_RESET_STATUS
)
477 omap_test_timeout((omap_hwmod_read(oh
, sysc
->syss_offs
)
478 & SYSS_RESETDONE_MASK
),
479 MAX_MODULE_SOFTRESET_WAIT
, c
);
480 else if (sysc
->sysc_flags
& SYSC_HAS_RESET_STATUS
) {
481 softrst_mask
= (0x1 << sysc
->sysc_fields
->srst_shift
);
482 omap_test_timeout(!(omap_hwmod_read(oh
, sysc
->sysc_offs
)
484 MAX_MODULE_SOFTRESET_WAIT
, c
);
491 * _set_dmadisable: set OCP_SYSCONFIG.DMADISABLE bit in @v
492 * @oh: struct omap_hwmod *
494 * The DMADISABLE bit is a semi-automatic bit present in sysconfig register
495 * of some modules. When the DMA must perform read/write accesses, the
496 * DMADISABLE bit is cleared by the hardware. But when the DMA must stop
497 * for power management, software must set the DMADISABLE bit back to 1.
499 * Set the DMADISABLE bit in @v for hwmod @oh. Returns -EINVAL upon
500 * error or 0 upon success.
502 static int _set_dmadisable(struct omap_hwmod
*oh
)
507 if (!oh
->class->sysc
||
508 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_DMADISABLE
))
511 if (!oh
->class->sysc
->sysc_fields
) {
512 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
516 /* clocks must be on for this operation */
517 if (oh
->_state
!= _HWMOD_STATE_ENABLED
) {
518 pr_warn("omap_hwmod: %s: dma can be disabled only from enabled state\n", oh
->name
);
522 pr_debug("omap_hwmod: %s: setting DMADISABLE\n", oh
->name
);
526 (0x1 << oh
->class->sysc
->sysc_fields
->dmadisable_shift
);
527 v
|= dmadisable_mask
;
528 _write_sysconfig(v
, oh
);
534 * _set_module_autoidle: set the OCP_SYSCONFIG AUTOIDLE field in @v
535 * @oh: struct omap_hwmod *
536 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
537 * @v: pointer to register contents to modify
539 * Update the module autoidle bit in @v to be @autoidle for the @oh
540 * hwmod. The autoidle bit controls whether the module can gate
541 * internal clocks automatically when it isn't doing anything; the
542 * exact function of this bit varies on a per-module basis. This
543 * function does not write to the hardware. Returns -EINVAL upon
544 * error or 0 upon success.
546 static int _set_module_autoidle(struct omap_hwmod
*oh
, u8 autoidle
,
552 if (!oh
->class->sysc
||
553 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_AUTOIDLE
))
556 if (!oh
->class->sysc
->sysc_fields
) {
557 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
561 autoidle_shift
= oh
->class->sysc
->sysc_fields
->autoidle_shift
;
562 autoidle_mask
= (0x1 << autoidle_shift
);
564 *v
&= ~autoidle_mask
;
565 *v
|= autoidle
<< autoidle_shift
;
571 * _set_idle_ioring_wakeup - enable/disable IO pad wakeup on hwmod idle for mux
572 * @oh: struct omap_hwmod *
573 * @set_wake: bool value indicating to set (true) or clear (false) wakeup enable
575 * Set or clear the I/O pad wakeup flag in the mux entries for the
576 * hwmod @oh. This function changes the @oh->mux->pads_dynamic array
577 * in memory. If the hwmod is currently idled, and the new idle
578 * values don't match the previous ones, this function will also
579 * update the SCM PADCTRL registers. Otherwise, if the hwmod is not
580 * currently idled, this function won't touch the hardware: the new
581 * mux settings are written to the SCM PADCTRL registers when the
582 * hwmod is idled. No return value.
584 static void _set_idle_ioring_wakeup(struct omap_hwmod
*oh
, bool set_wake
)
586 struct omap_device_pad
*pad
;
591 if (!oh
->mux
|| !oh
->mux
->enabled
)
594 for (j
= 0; j
< oh
->mux
->nr_pads_dynamic
; j
++) {
595 pad
= oh
->mux
->pads_dynamic
[j
];
597 if (!(pad
->flags
& OMAP_DEVICE_PAD_WAKEUP
))
600 prev_idle
= pad
->idle
;
603 pad
->idle
|= OMAP_WAKEUP_EN
;
605 pad
->idle
&= ~OMAP_WAKEUP_EN
;
607 if (prev_idle
!= pad
->idle
)
611 if (change
&& oh
->_state
== _HWMOD_STATE_IDLE
)
612 omap_hwmod_mux(oh
->mux
, _HWMOD_STATE_IDLE
);
616 * _enable_wakeup: set OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
617 * @oh: struct omap_hwmod *
619 * Allow the hardware module @oh to send wakeups. Returns -EINVAL
620 * upon error or 0 upon success.
622 static int _enable_wakeup(struct omap_hwmod
*oh
, u32
*v
)
624 if (!oh
->class->sysc
||
625 !((oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
) ||
626 (oh
->class->sysc
->idlemodes
& SIDLE_SMART_WKUP
) ||
627 (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)))
630 if (!oh
->class->sysc
->sysc_fields
) {
631 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
635 if (oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
)
636 *v
|= 0x1 << oh
->class->sysc
->sysc_fields
->enwkup_shift
;
638 if (oh
->class->sysc
->idlemodes
& SIDLE_SMART_WKUP
)
639 _set_slave_idlemode(oh
, HWMOD_IDLEMODE_SMART_WKUP
, v
);
640 if (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)
641 _set_master_standbymode(oh
, HWMOD_IDLEMODE_SMART_WKUP
, v
);
643 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
649 * _disable_wakeup: clear OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
650 * @oh: struct omap_hwmod *
652 * Prevent the hardware module @oh to send wakeups. Returns -EINVAL
653 * upon error or 0 upon success.
655 static int _disable_wakeup(struct omap_hwmod
*oh
, u32
*v
)
657 if (!oh
->class->sysc
||
658 !((oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
) ||
659 (oh
->class->sysc
->idlemodes
& SIDLE_SMART_WKUP
) ||
660 (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)))
663 if (!oh
->class->sysc
->sysc_fields
) {
664 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
668 if (oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
)
669 *v
&= ~(0x1 << oh
->class->sysc
->sysc_fields
->enwkup_shift
);
671 if (oh
->class->sysc
->idlemodes
& SIDLE_SMART_WKUP
)
672 _set_slave_idlemode(oh
, HWMOD_IDLEMODE_SMART
, v
);
673 if (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)
674 _set_master_standbymode(oh
, HWMOD_IDLEMODE_SMART
, v
);
676 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
681 static struct clockdomain
*_get_clkdm(struct omap_hwmod
*oh
)
683 struct clk_hw_omap
*clk
;
687 } else if (oh
->_clk
) {
688 if (__clk_get_flags(oh
->_clk
) & CLK_IS_BASIC
)
690 clk
= to_clk_hw_omap(__clk_get_hw(oh
->_clk
));
697 * _add_initiator_dep: prevent @oh from smart-idling while @init_oh is active
698 * @oh: struct omap_hwmod *
700 * Prevent the hardware module @oh from entering idle while the
701 * hardare module initiator @init_oh is active. Useful when a module
702 * will be accessed by a particular initiator (e.g., if a module will
703 * be accessed by the IVA, there should be a sleepdep between the IVA
704 * initiator and the module). Only applies to modules in smart-idle
705 * mode. If the clockdomain is marked as not needing autodeps, return
706 * 0 without doing anything. Otherwise, returns -EINVAL upon error or
707 * passes along clkdm_add_sleepdep() value upon success.
709 static int _add_initiator_dep(struct omap_hwmod
*oh
, struct omap_hwmod
*init_oh
)
711 struct clockdomain
*clkdm
, *init_clkdm
;
713 clkdm
= _get_clkdm(oh
);
714 init_clkdm
= _get_clkdm(init_oh
);
716 if (!clkdm
|| !init_clkdm
)
719 if (clkdm
&& clkdm
->flags
& CLKDM_NO_AUTODEPS
)
722 return clkdm_add_sleepdep(clkdm
, init_clkdm
);
726 * _del_initiator_dep: allow @oh to smart-idle even if @init_oh is active
727 * @oh: struct omap_hwmod *
729 * Allow the hardware module @oh to enter idle while the hardare
730 * module initiator @init_oh is active. Useful when a module will not
731 * be accessed by a particular initiator (e.g., if a module will not
732 * be accessed by the IVA, there should be no sleepdep between the IVA
733 * initiator and the module). Only applies to modules in smart-idle
734 * mode. If the clockdomain is marked as not needing autodeps, return
735 * 0 without doing anything. Returns -EINVAL upon error or passes
736 * along clkdm_del_sleepdep() value upon success.
738 static int _del_initiator_dep(struct omap_hwmod
*oh
, struct omap_hwmod
*init_oh
)
740 struct clockdomain
*clkdm
, *init_clkdm
;
742 clkdm
= _get_clkdm(oh
);
743 init_clkdm
= _get_clkdm(init_oh
);
745 if (!clkdm
|| !init_clkdm
)
748 if (clkdm
&& clkdm
->flags
& CLKDM_NO_AUTODEPS
)
751 return clkdm_del_sleepdep(clkdm
, init_clkdm
);
755 * _init_main_clk - get a struct clk * for the the hwmod's main functional clk
756 * @oh: struct omap_hwmod *
758 * Called from _init_clocks(). Populates the @oh _clk (main
759 * functional clock pointer) if a main_clk is present. Returns 0 on
760 * success or -EINVAL on error.
762 static int _init_main_clk(struct omap_hwmod
*oh
)
769 oh
->_clk
= clk_get(NULL
, oh
->main_clk
);
770 if (IS_ERR(oh
->_clk
)) {
771 pr_warn("omap_hwmod: %s: cannot clk_get main_clk %s\n",
772 oh
->name
, oh
->main_clk
);
776 * HACK: This needs a re-visit once clk_prepare() is implemented
777 * to do something meaningful. Today its just a no-op.
778 * If clk_prepare() is used at some point to do things like
779 * voltage scaling etc, then this would have to be moved to
780 * some point where subsystems like i2c and pmic become
783 clk_prepare(oh
->_clk
);
786 pr_debug("omap_hwmod: %s: missing clockdomain for %s.\n",
787 oh
->name
, oh
->main_clk
);
793 * _init_interface_clks - get a struct clk * for the the hwmod's interface clks
794 * @oh: struct omap_hwmod *
796 * Called from _init_clocks(). Populates the @oh OCP slave interface
797 * clock pointers. Returns 0 on success or -EINVAL on error.
799 static int _init_interface_clks(struct omap_hwmod
*oh
)
801 struct omap_hwmod_ocp_if
*os
;
807 p
= oh
->slave_ports
.next
;
809 while (i
< oh
->slaves_cnt
) {
810 os
= _fetch_next_ocp_if(&p
, &i
);
814 c
= clk_get(NULL
, os
->clk
);
816 pr_warn("omap_hwmod: %s: cannot clk_get interface_clk %s\n",
823 * HACK: This needs a re-visit once clk_prepare() is implemented
824 * to do something meaningful. Today its just a no-op.
825 * If clk_prepare() is used at some point to do things like
826 * voltage scaling etc, then this would have to be moved to
827 * some point where subsystems like i2c and pmic become
830 clk_prepare(os
->_clk
);
837 * _init_opt_clk - get a struct clk * for the the hwmod's optional clocks
838 * @oh: struct omap_hwmod *
840 * Called from _init_clocks(). Populates the @oh omap_hwmod_opt_clk
841 * clock pointers. Returns 0 on success or -EINVAL on error.
843 static int _init_opt_clks(struct omap_hwmod
*oh
)
845 struct omap_hwmod_opt_clk
*oc
;
850 for (i
= oh
->opt_clks_cnt
, oc
= oh
->opt_clks
; i
> 0; i
--, oc
++) {
851 c
= clk_get(NULL
, oc
->clk
);
853 pr_warn("omap_hwmod: %s: cannot clk_get opt_clk %s\n",
860 * HACK: This needs a re-visit once clk_prepare() is implemented
861 * to do something meaningful. Today its just a no-op.
862 * If clk_prepare() is used at some point to do things like
863 * voltage scaling etc, then this would have to be moved to
864 * some point where subsystems like i2c and pmic become
867 clk_prepare(oc
->_clk
);
874 * _enable_clocks - enable hwmod main clock and interface clocks
875 * @oh: struct omap_hwmod *
877 * Enables all clocks necessary for register reads and writes to succeed
878 * on the hwmod @oh. Returns 0.
880 static int _enable_clocks(struct omap_hwmod
*oh
)
882 struct omap_hwmod_ocp_if
*os
;
886 pr_debug("omap_hwmod: %s: enabling clocks\n", oh
->name
);
889 clk_enable(oh
->_clk
);
891 p
= oh
->slave_ports
.next
;
893 while (i
< oh
->slaves_cnt
) {
894 os
= _fetch_next_ocp_if(&p
, &i
);
896 if (os
->_clk
&& (os
->flags
& OCPIF_SWSUP_IDLE
))
897 clk_enable(os
->_clk
);
900 /* The opt clocks are controlled by the device driver. */
906 * _disable_clocks - disable hwmod main clock and interface clocks
907 * @oh: struct omap_hwmod *
909 * Disables the hwmod @oh main functional and interface clocks. Returns 0.
911 static int _disable_clocks(struct omap_hwmod
*oh
)
913 struct omap_hwmod_ocp_if
*os
;
917 pr_debug("omap_hwmod: %s: disabling clocks\n", oh
->name
);
920 clk_disable(oh
->_clk
);
922 p
= oh
->slave_ports
.next
;
924 while (i
< oh
->slaves_cnt
) {
925 os
= _fetch_next_ocp_if(&p
, &i
);
927 if (os
->_clk
&& (os
->flags
& OCPIF_SWSUP_IDLE
))
928 clk_disable(os
->_clk
);
931 /* The opt clocks are controlled by the device driver. */
936 static void _enable_optional_clocks(struct omap_hwmod
*oh
)
938 struct omap_hwmod_opt_clk
*oc
;
941 pr_debug("omap_hwmod: %s: enabling optional clocks\n", oh
->name
);
943 for (i
= oh
->opt_clks_cnt
, oc
= oh
->opt_clks
; i
> 0; i
--, oc
++)
945 pr_debug("omap_hwmod: enable %s:%s\n", oc
->role
,
946 __clk_get_name(oc
->_clk
));
947 clk_enable(oc
->_clk
);
951 static void _disable_optional_clocks(struct omap_hwmod
*oh
)
953 struct omap_hwmod_opt_clk
*oc
;
956 pr_debug("omap_hwmod: %s: disabling optional clocks\n", oh
->name
);
958 for (i
= oh
->opt_clks_cnt
, oc
= oh
->opt_clks
; i
> 0; i
--, oc
++)
960 pr_debug("omap_hwmod: disable %s:%s\n", oc
->role
,
961 __clk_get_name(oc
->_clk
));
962 clk_disable(oc
->_clk
);
967 * _omap4_enable_module - enable CLKCTRL modulemode on OMAP4
968 * @oh: struct omap_hwmod *
970 * Enables the PRCM module mode related to the hwmod @oh.
973 static void _omap4_enable_module(struct omap_hwmod
*oh
)
975 if (!oh
->clkdm
|| !oh
->prcm
.omap4
.modulemode
)
978 pr_debug("omap_hwmod: %s: %s: %d\n",
979 oh
->name
, __func__
, oh
->prcm
.omap4
.modulemode
);
981 omap_cm_module_enable(oh
->prcm
.omap4
.modulemode
,
982 oh
->clkdm
->prcm_partition
,
983 oh
->clkdm
->cm_inst
, oh
->prcm
.omap4
.clkctrl_offs
);
987 * _omap4_wait_target_disable - wait for a module to be disabled on OMAP4
988 * @oh: struct omap_hwmod *
990 * Wait for a module @oh to enter slave idle. Returns 0 if the module
991 * does not have an IDLEST bit or if the module successfully enters
992 * slave idle; otherwise, pass along the return value of the
993 * appropriate *_cm*_wait_module_idle() function.
995 static int _omap4_wait_target_disable(struct omap_hwmod
*oh
)
1000 if (oh
->_int_flags
& _HWMOD_NO_MPU_PORT
|| !oh
->clkdm
)
1003 if (oh
->flags
& HWMOD_NO_IDLEST
)
1006 return omap_cm_wait_module_idle(oh
->clkdm
->prcm_partition
,
1008 oh
->prcm
.omap4
.clkctrl_offs
, 0);
1012 * _count_mpu_irqs - count the number of MPU IRQ lines associated with @oh
1013 * @oh: struct omap_hwmod *oh
1015 * Count and return the number of MPU IRQs associated with the hwmod
1016 * @oh. Used to allocate struct resource data. Returns 0 if @oh is
1019 static int _count_mpu_irqs(struct omap_hwmod
*oh
)
1021 struct omap_hwmod_irq_info
*ohii
;
1024 if (!oh
|| !oh
->mpu_irqs
)
1028 ohii
= &oh
->mpu_irqs
[i
++];
1029 } while (ohii
->irq
!= -1);
1035 * _count_sdma_reqs - count the number of SDMA request lines associated with @oh
1036 * @oh: struct omap_hwmod *oh
1038 * Count and return the number of SDMA request lines associated with
1039 * the hwmod @oh. Used to allocate struct resource data. Returns 0
1042 static int _count_sdma_reqs(struct omap_hwmod
*oh
)
1044 struct omap_hwmod_dma_info
*ohdi
;
1047 if (!oh
|| !oh
->sdma_reqs
)
1051 ohdi
= &oh
->sdma_reqs
[i
++];
1052 } while (ohdi
->dma_req
!= -1);
1058 * _count_ocp_if_addr_spaces - count the number of address space entries for @oh
1059 * @oh: struct omap_hwmod *oh
1061 * Count and return the number of address space ranges associated with
1062 * the hwmod @oh. Used to allocate struct resource data. Returns 0
1065 static int _count_ocp_if_addr_spaces(struct omap_hwmod_ocp_if
*os
)
1067 struct omap_hwmod_addr_space
*mem
;
1070 if (!os
|| !os
->addr
)
1074 mem
= &os
->addr
[i
++];
1075 } while (mem
->pa_start
!= mem
->pa_end
);
1081 * _get_mpu_irq_by_name - fetch MPU interrupt line number by name
1082 * @oh: struct omap_hwmod * to operate on
1083 * @name: pointer to the name of the MPU interrupt number to fetch (optional)
1084 * @irq: pointer to an unsigned int to store the MPU IRQ number to
1086 * Retrieve a MPU hardware IRQ line number named by @name associated
1087 * with the IP block pointed to by @oh. The IRQ number will be filled
1088 * into the address pointed to by @dma. When @name is non-null, the
1089 * IRQ line number associated with the named entry will be returned.
1090 * If @name is null, the first matching entry will be returned. Data
1091 * order is not meaningful in hwmod data, so callers are strongly
1092 * encouraged to use a non-null @name whenever possible to avoid
1093 * unpredictable effects if hwmod data is later added that causes data
1094 * ordering to change. Returns 0 upon success or a negative error
1097 static int _get_mpu_irq_by_name(struct omap_hwmod
*oh
, const char *name
,
1107 while (oh
->mpu_irqs
[i
].irq
!= -1) {
1108 if (name
== oh
->mpu_irqs
[i
].name
||
1109 !strcmp(name
, oh
->mpu_irqs
[i
].name
)) {
1119 *irq
= oh
->mpu_irqs
[i
].irq
;
1125 * _get_sdma_req_by_name - fetch SDMA request line ID by name
1126 * @oh: struct omap_hwmod * to operate on
1127 * @name: pointer to the name of the SDMA request line to fetch (optional)
1128 * @dma: pointer to an unsigned int to store the request line ID to
1130 * Retrieve an SDMA request line ID named by @name on the IP block
1131 * pointed to by @oh. The ID will be filled into the address pointed
1132 * to by @dma. When @name is non-null, the request line ID associated
1133 * with the named entry will be returned. If @name is null, the first
1134 * matching entry will be returned. Data order is not meaningful in
1135 * hwmod data, so callers are strongly encouraged to use a non-null
1136 * @name whenever possible to avoid unpredictable effects if hwmod
1137 * data is later added that causes data ordering to change. Returns 0
1138 * upon success or a negative error code upon error.
1140 static int _get_sdma_req_by_name(struct omap_hwmod
*oh
, const char *name
,
1150 while (oh
->sdma_reqs
[i
].dma_req
!= -1) {
1151 if (name
== oh
->sdma_reqs
[i
].name
||
1152 !strcmp(name
, oh
->sdma_reqs
[i
].name
)) {
1162 *dma
= oh
->sdma_reqs
[i
].dma_req
;
1168 * _get_addr_space_by_name - fetch address space start & end by name
1169 * @oh: struct omap_hwmod * to operate on
1170 * @name: pointer to the name of the address space to fetch (optional)
1171 * @pa_start: pointer to a u32 to store the starting address to
1172 * @pa_end: pointer to a u32 to store the ending address to
1174 * Retrieve address space start and end addresses for the IP block
1175 * pointed to by @oh. The data will be filled into the addresses
1176 * pointed to by @pa_start and @pa_end. When @name is non-null, the
1177 * address space data associated with the named entry will be
1178 * returned. If @name is null, the first matching entry will be
1179 * returned. Data order is not meaningful in hwmod data, so callers
1180 * are strongly encouraged to use a non-null @name whenever possible
1181 * to avoid unpredictable effects if hwmod data is later added that
1182 * causes data ordering to change. Returns 0 upon success or a
1183 * negative error code upon error.
1185 static int _get_addr_space_by_name(struct omap_hwmod
*oh
, const char *name
,
1186 u32
*pa_start
, u32
*pa_end
)
1189 struct omap_hwmod_ocp_if
*os
;
1190 struct list_head
*p
= NULL
;
1193 p
= oh
->slave_ports
.next
;
1196 while (i
< oh
->slaves_cnt
) {
1197 os
= _fetch_next_ocp_if(&p
, &i
);
1203 while (os
->addr
[j
].pa_start
!= os
->addr
[j
].pa_end
) {
1204 if (name
== os
->addr
[j
].name
||
1205 !strcmp(name
, os
->addr
[j
].name
)) {
1219 *pa_start
= os
->addr
[j
].pa_start
;
1220 *pa_end
= os
->addr
[j
].pa_end
;
1226 * _save_mpu_port_index - find and save the index to @oh's MPU port
1227 * @oh: struct omap_hwmod *
1229 * Determines the array index of the OCP slave port that the MPU uses
1230 * to address the device, and saves it into the struct omap_hwmod.
1231 * Intended to be called during hwmod registration only. No return
1234 static void __init
_save_mpu_port_index(struct omap_hwmod
*oh
)
1236 struct omap_hwmod_ocp_if
*os
= NULL
;
1237 struct list_head
*p
;
1243 oh
->_int_flags
|= _HWMOD_NO_MPU_PORT
;
1245 p
= oh
->slave_ports
.next
;
1247 while (i
< oh
->slaves_cnt
) {
1248 os
= _fetch_next_ocp_if(&p
, &i
);
1249 if (os
->user
& OCP_USER_MPU
) {
1251 oh
->_int_flags
&= ~_HWMOD_NO_MPU_PORT
;
1260 * _find_mpu_rt_port - return omap_hwmod_ocp_if accessible by the MPU
1261 * @oh: struct omap_hwmod *
1263 * Given a pointer to a struct omap_hwmod record @oh, return a pointer
1264 * to the struct omap_hwmod_ocp_if record that is used by the MPU to
1265 * communicate with the IP block. This interface need not be directly
1266 * connected to the MPU (and almost certainly is not), but is directly
1267 * connected to the IP block represented by @oh. Returns a pointer
1268 * to the struct omap_hwmod_ocp_if * upon success, or returns NULL upon
1269 * error or if there does not appear to be a path from the MPU to this
1272 static struct omap_hwmod_ocp_if
*_find_mpu_rt_port(struct omap_hwmod
*oh
)
1274 if (!oh
|| oh
->_int_flags
& _HWMOD_NO_MPU_PORT
|| oh
->slaves_cnt
== 0)
1277 return oh
->_mpu_port
;
1281 * _find_mpu_rt_addr_space - return MPU register target address space for @oh
1282 * @oh: struct omap_hwmod *
1284 * Returns a pointer to the struct omap_hwmod_addr_space record representing
1285 * the register target MPU address space; or returns NULL upon error.
1287 static struct omap_hwmod_addr_space
* __init
_find_mpu_rt_addr_space(struct omap_hwmod
*oh
)
1289 struct omap_hwmod_ocp_if
*os
;
1290 struct omap_hwmod_addr_space
*mem
;
1291 int found
= 0, i
= 0;
1293 os
= _find_mpu_rt_port(oh
);
1294 if (!os
|| !os
->addr
)
1298 mem
= &os
->addr
[i
++];
1299 if (mem
->flags
& ADDR_TYPE_RT
)
1301 } while (!found
&& mem
->pa_start
!= mem
->pa_end
);
1303 return (found
) ? mem
: NULL
;
1307 * _enable_sysc - try to bring a module out of idle via OCP_SYSCONFIG
1308 * @oh: struct omap_hwmod *
1310 * Ensure that the OCP_SYSCONFIG register for the IP block represented
1311 * by @oh is set to indicate to the PRCM that the IP block is active.
1312 * Usually this means placing the module into smart-idle mode and
1313 * smart-standby, but if there is a bug in the automatic idle handling
1314 * for the IP block, it may need to be placed into the force-idle or
1315 * no-idle variants of these modes. No return value.
1317 static void _enable_sysc(struct omap_hwmod
*oh
)
1322 struct clockdomain
*clkdm
;
1324 if (!oh
->class->sysc
)
1328 * Wait until reset has completed, this is needed as the IP
1329 * block is reset automatically by hardware in some cases
1330 * (off-mode for example), and the drivers require the
1331 * IP to be ready when they access it
1333 if (oh
->flags
& HWMOD_CONTROL_OPT_CLKS_IN_RESET
)
1334 _enable_optional_clocks(oh
);
1335 _wait_softreset_complete(oh
);
1336 if (oh
->flags
& HWMOD_CONTROL_OPT_CLKS_IN_RESET
)
1337 _disable_optional_clocks(oh
);
1339 v
= oh
->_sysc_cache
;
1340 sf
= oh
->class->sysc
->sysc_flags
;
1342 clkdm
= _get_clkdm(oh
);
1343 if (sf
& SYSC_HAS_SIDLEMODE
) {
1344 if (oh
->flags
& HWMOD_SWSUP_SIDLE
||
1345 oh
->flags
& HWMOD_SWSUP_SIDLE_ACT
) {
1346 idlemode
= HWMOD_IDLEMODE_NO
;
1348 if (sf
& SYSC_HAS_ENAWAKEUP
)
1349 _enable_wakeup(oh
, &v
);
1350 if (oh
->class->sysc
->idlemodes
& SIDLE_SMART_WKUP
)
1351 idlemode
= HWMOD_IDLEMODE_SMART_WKUP
;
1353 idlemode
= HWMOD_IDLEMODE_SMART
;
1357 * This is special handling for some IPs like
1358 * 32k sync timer. Force them to idle!
1360 clkdm_act
= (clkdm
&& clkdm
->flags
& CLKDM_ACTIVE_WITH_MPU
);
1361 if (clkdm_act
&& !(oh
->class->sysc
->idlemodes
&
1362 (SIDLE_SMART
| SIDLE_SMART_WKUP
)))
1363 idlemode
= HWMOD_IDLEMODE_FORCE
;
1365 _set_slave_idlemode(oh
, idlemode
, &v
);
1368 if (sf
& SYSC_HAS_MIDLEMODE
) {
1369 if (oh
->flags
& HWMOD_FORCE_MSTANDBY
) {
1370 idlemode
= HWMOD_IDLEMODE_FORCE
;
1371 } else if (oh
->flags
& HWMOD_SWSUP_MSTANDBY
) {
1372 idlemode
= HWMOD_IDLEMODE_NO
;
1374 if (sf
& SYSC_HAS_ENAWAKEUP
)
1375 _enable_wakeup(oh
, &v
);
1376 if (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)
1377 idlemode
= HWMOD_IDLEMODE_SMART_WKUP
;
1379 idlemode
= HWMOD_IDLEMODE_SMART
;
1381 _set_master_standbymode(oh
, idlemode
, &v
);
1385 * XXX The clock framework should handle this, by
1386 * calling into this code. But this must wait until the
1387 * clock structures are tagged with omap_hwmod entries
1389 if ((oh
->flags
& HWMOD_SET_DEFAULT_CLOCKACT
) &&
1390 (sf
& SYSC_HAS_CLOCKACTIVITY
))
1391 _set_clockactivity(oh
, oh
->class->sysc
->clockact
, &v
);
1393 /* If the cached value is the same as the new value, skip the write */
1394 if (oh
->_sysc_cache
!= v
)
1395 _write_sysconfig(v
, oh
);
1398 * Set the autoidle bit only after setting the smartidle bit
1399 * Setting this will not have any impact on the other modules.
1401 if (sf
& SYSC_HAS_AUTOIDLE
) {
1402 idlemode
= (oh
->flags
& HWMOD_NO_OCP_AUTOIDLE
) ?
1404 _set_module_autoidle(oh
, idlemode
, &v
);
1405 _write_sysconfig(v
, oh
);
1410 * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
1411 * @oh: struct omap_hwmod *
1413 * If module is marked as SWSUP_SIDLE, force the module into slave
1414 * idle; otherwise, configure it for smart-idle. If module is marked
1415 * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
1416 * configure it for smart-standby. No return value.
1418 static void _idle_sysc(struct omap_hwmod
*oh
)
1423 if (!oh
->class->sysc
)
1426 v
= oh
->_sysc_cache
;
1427 sf
= oh
->class->sysc
->sysc_flags
;
1429 if (sf
& SYSC_HAS_SIDLEMODE
) {
1430 if (oh
->flags
& HWMOD_SWSUP_SIDLE
) {
1431 idlemode
= HWMOD_IDLEMODE_FORCE
;
1433 if (sf
& SYSC_HAS_ENAWAKEUP
)
1434 _enable_wakeup(oh
, &v
);
1435 if (oh
->class->sysc
->idlemodes
& SIDLE_SMART_WKUP
)
1436 idlemode
= HWMOD_IDLEMODE_SMART_WKUP
;
1438 idlemode
= HWMOD_IDLEMODE_SMART
;
1440 _set_slave_idlemode(oh
, idlemode
, &v
);
1443 if (sf
& SYSC_HAS_MIDLEMODE
) {
1444 if ((oh
->flags
& HWMOD_SWSUP_MSTANDBY
) ||
1445 (oh
->flags
& HWMOD_FORCE_MSTANDBY
)) {
1446 idlemode
= HWMOD_IDLEMODE_FORCE
;
1448 if (sf
& SYSC_HAS_ENAWAKEUP
)
1449 _enable_wakeup(oh
, &v
);
1450 if (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)
1451 idlemode
= HWMOD_IDLEMODE_SMART_WKUP
;
1453 idlemode
= HWMOD_IDLEMODE_SMART
;
1455 _set_master_standbymode(oh
, idlemode
, &v
);
1458 _write_sysconfig(v
, oh
);
1462 * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
1463 * @oh: struct omap_hwmod *
1465 * Force the module into slave idle and master suspend. No return
1468 static void _shutdown_sysc(struct omap_hwmod
*oh
)
1473 if (!oh
->class->sysc
)
1476 v
= oh
->_sysc_cache
;
1477 sf
= oh
->class->sysc
->sysc_flags
;
1479 if (sf
& SYSC_HAS_SIDLEMODE
)
1480 _set_slave_idlemode(oh
, HWMOD_IDLEMODE_FORCE
, &v
);
1482 if (sf
& SYSC_HAS_MIDLEMODE
)
1483 _set_master_standbymode(oh
, HWMOD_IDLEMODE_FORCE
, &v
);
1485 if (sf
& SYSC_HAS_AUTOIDLE
)
1486 _set_module_autoidle(oh
, 1, &v
);
1488 _write_sysconfig(v
, oh
);
1492 * _lookup - find an omap_hwmod by name
1493 * @name: find an omap_hwmod by name
1495 * Return a pointer to an omap_hwmod by name, or NULL if not found.
1497 static struct omap_hwmod
*_lookup(const char *name
)
1499 struct omap_hwmod
*oh
, *temp_oh
;
1503 list_for_each_entry(temp_oh
, &omap_hwmod_list
, node
) {
1504 if (!strcmp(name
, temp_oh
->name
)) {
1514 * _init_clkdm - look up a clockdomain name, store pointer in omap_hwmod
1515 * @oh: struct omap_hwmod *
1517 * Convert a clockdomain name stored in a struct omap_hwmod into a
1518 * clockdomain pointer, and save it into the struct omap_hwmod.
1519 * Return -EINVAL if the clkdm_name lookup failed.
1521 static int _init_clkdm(struct omap_hwmod
*oh
)
1523 if (!oh
->clkdm_name
) {
1524 pr_debug("omap_hwmod: %s: missing clockdomain\n", oh
->name
);
1528 oh
->clkdm
= clkdm_lookup(oh
->clkdm_name
);
1530 pr_warn("omap_hwmod: %s: could not associate to clkdm %s\n",
1531 oh
->name
, oh
->clkdm_name
);
1535 pr_debug("omap_hwmod: %s: associated to clkdm %s\n",
1536 oh
->name
, oh
->clkdm_name
);
1542 * _init_clocks - clk_get() all clocks associated with this hwmod. Retrieve as
1543 * well the clockdomain.
1544 * @oh: struct omap_hwmod *
1545 * @data: not used; pass NULL
1547 * Called by omap_hwmod_setup_*() (after omap2_clk_init()).
1548 * Resolves all clock names embedded in the hwmod. Returns 0 on
1549 * success, or a negative error code on failure.
1551 static int _init_clocks(struct omap_hwmod
*oh
, void *data
)
1555 if (oh
->_state
!= _HWMOD_STATE_REGISTERED
)
1558 pr_debug("omap_hwmod: %s: looking up clocks\n", oh
->name
);
1560 if (soc_ops
.init_clkdm
)
1561 ret
|= soc_ops
.init_clkdm(oh
);
1563 ret
|= _init_main_clk(oh
);
1564 ret
|= _init_interface_clks(oh
);
1565 ret
|= _init_opt_clks(oh
);
1568 oh
->_state
= _HWMOD_STATE_CLKS_INITED
;
1570 pr_warn("omap_hwmod: %s: cannot _init_clocks\n", oh
->name
);
1576 * _lookup_hardreset - fill register bit info for this hwmod/reset line
1577 * @oh: struct omap_hwmod *
1578 * @name: name of the reset line in the context of this hwmod
1579 * @ohri: struct omap_hwmod_rst_info * that this function will fill in
1581 * Return the bit position of the reset line that match the
1582 * input name. Return -ENOENT if not found.
1584 static int _lookup_hardreset(struct omap_hwmod
*oh
, const char *name
,
1585 struct omap_hwmod_rst_info
*ohri
)
1589 for (i
= 0; i
< oh
->rst_lines_cnt
; i
++) {
1590 const char *rst_line
= oh
->rst_lines
[i
].name
;
1591 if (!strcmp(rst_line
, name
)) {
1592 ohri
->rst_shift
= oh
->rst_lines
[i
].rst_shift
;
1593 ohri
->st_shift
= oh
->rst_lines
[i
].st_shift
;
1594 pr_debug("omap_hwmod: %s: %s: %s: rst %d st %d\n",
1595 oh
->name
, __func__
, rst_line
, ohri
->rst_shift
,
1606 * _assert_hardreset - assert the HW reset line of submodules
1607 * contained in the hwmod module.
1608 * @oh: struct omap_hwmod *
1609 * @name: name of the reset line to lookup and assert
1611 * Some IP like dsp, ipu or iva contain processor that require an HW
1612 * reset line to be assert / deassert in order to enable fully the IP.
1613 * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1614 * asserting the hardreset line on the currently-booted SoC, or passes
1615 * along the return value from _lookup_hardreset() or the SoC's
1616 * assert_hardreset code.
1618 static int _assert_hardreset(struct omap_hwmod
*oh
, const char *name
)
1620 struct omap_hwmod_rst_info ohri
;
1626 if (!soc_ops
.assert_hardreset
)
1629 ret
= _lookup_hardreset(oh
, name
, &ohri
);
1633 ret
= soc_ops
.assert_hardreset(oh
, &ohri
);
1639 * _deassert_hardreset - deassert the HW reset line of submodules contained
1640 * in the hwmod module.
1641 * @oh: struct omap_hwmod *
1642 * @name: name of the reset line to look up and deassert
1644 * Some IP like dsp, ipu or iva contain processor that require an HW
1645 * reset line to be assert / deassert in order to enable fully the IP.
1646 * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1647 * deasserting the hardreset line on the currently-booted SoC, or passes
1648 * along the return value from _lookup_hardreset() or the SoC's
1649 * deassert_hardreset code.
1651 static int _deassert_hardreset(struct omap_hwmod
*oh
, const char *name
)
1653 struct omap_hwmod_rst_info ohri
;
1660 if (!soc_ops
.deassert_hardreset
)
1663 ret
= _lookup_hardreset(oh
, name
, &ohri
);
1669 * A clockdomain must be in SW_SUP otherwise reset
1670 * might not be completed. The clockdomain can be set
1671 * in HW_AUTO only when the module become ready.
1673 hwsup
= clkdm_in_hwsup(oh
->clkdm
);
1674 ret
= clkdm_hwmod_enable(oh
->clkdm
, oh
);
1676 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1677 oh
->name
, oh
->clkdm
->name
, ret
);
1683 if (soc_ops
.enable_module
)
1684 soc_ops
.enable_module(oh
);
1686 ret
= soc_ops
.deassert_hardreset(oh
, &ohri
);
1688 if (soc_ops
.disable_module
)
1689 soc_ops
.disable_module(oh
);
1690 _disable_clocks(oh
);
1693 pr_warn("omap_hwmod: %s: failed to hardreset\n", oh
->name
);
1697 * Set the clockdomain to HW_AUTO, assuming that the
1698 * previous state was HW_AUTO.
1700 if (oh
->clkdm
&& hwsup
)
1701 clkdm_allow_idle(oh
->clkdm
);
1704 clkdm_hwmod_disable(oh
->clkdm
, oh
);
1711 * _read_hardreset - read the HW reset line state of submodules
1712 * contained in the hwmod module
1713 * @oh: struct omap_hwmod *
1714 * @name: name of the reset line to look up and read
1716 * Return the state of the reset line. Returns -EINVAL if @oh is
1717 * null, -ENOSYS if we have no way of reading the hardreset line
1718 * status on the currently-booted SoC, or passes along the return
1719 * value from _lookup_hardreset() or the SoC's is_hardreset_asserted
1722 static int _read_hardreset(struct omap_hwmod
*oh
, const char *name
)
1724 struct omap_hwmod_rst_info ohri
;
1730 if (!soc_ops
.is_hardreset_asserted
)
1733 ret
= _lookup_hardreset(oh
, name
, &ohri
);
1737 return soc_ops
.is_hardreset_asserted(oh
, &ohri
);
1741 * _are_all_hardreset_lines_asserted - return true if the @oh is hard-reset
1742 * @oh: struct omap_hwmod *
1744 * If all hardreset lines associated with @oh are asserted, then return true.
1745 * Otherwise, if part of @oh is out hardreset or if no hardreset lines
1746 * associated with @oh are asserted, then return false.
1747 * This function is used to avoid executing some parts of the IP block
1748 * enable/disable sequence if its hardreset line is set.
1750 static bool _are_all_hardreset_lines_asserted(struct omap_hwmod
*oh
)
1754 if (oh
->rst_lines_cnt
== 0)
1757 for (i
= 0; i
< oh
->rst_lines_cnt
; i
++)
1758 if (_read_hardreset(oh
, oh
->rst_lines
[i
].name
) > 0)
1761 if (oh
->rst_lines_cnt
== rst_cnt
)
1768 * _are_any_hardreset_lines_asserted - return true if any part of @oh is
1770 * @oh: struct omap_hwmod *
1772 * If any hardreset lines associated with @oh are asserted, then
1773 * return true. Otherwise, if no hardreset lines associated with @oh
1774 * are asserted, or if @oh has no hardreset lines, then return false.
1775 * This function is used to avoid executing some parts of the IP block
1776 * enable/disable sequence if any hardreset line is set.
1778 static bool _are_any_hardreset_lines_asserted(struct omap_hwmod
*oh
)
1783 for (i
= 0; i
< oh
->rst_lines_cnt
&& rst_cnt
== 0; i
++)
1784 if (_read_hardreset(oh
, oh
->rst_lines
[i
].name
) > 0)
1787 return (rst_cnt
) ? true : false;
1791 * _omap4_disable_module - enable CLKCTRL modulemode on OMAP4
1792 * @oh: struct omap_hwmod *
1794 * Disable the PRCM module mode related to the hwmod @oh.
1795 * Return EINVAL if the modulemode is not supported and 0 in case of success.
1797 static int _omap4_disable_module(struct omap_hwmod
*oh
)
1801 if (!oh
->clkdm
|| !oh
->prcm
.omap4
.modulemode
)
1805 * Since integration code might still be doing something, only
1806 * disable if all lines are under hardreset.
1808 if (_are_any_hardreset_lines_asserted(oh
))
1811 pr_debug("omap_hwmod: %s: %s\n", oh
->name
, __func__
);
1813 omap_cm_module_disable(oh
->clkdm
->prcm_partition
, oh
->clkdm
->cm_inst
,
1814 oh
->prcm
.omap4
.clkctrl_offs
);
1816 v
= _omap4_wait_target_disable(oh
);
1818 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1825 * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1826 * @oh: struct omap_hwmod *
1828 * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit. hwmod must be
1829 * enabled for this to work. Returns -ENOENT if the hwmod cannot be
1830 * reset this way, -EINVAL if the hwmod is in the wrong state,
1831 * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1833 * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1834 * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1835 * use the SYSCONFIG softreset bit to provide the status.
1837 * Note that some IP like McBSP do have reset control but don't have
1840 static int _ocp_softreset(struct omap_hwmod
*oh
)
1846 if (!oh
->class->sysc
||
1847 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_SOFTRESET
))
1850 /* clocks must be on for this operation */
1851 if (oh
->_state
!= _HWMOD_STATE_ENABLED
) {
1852 pr_warn("omap_hwmod: %s: reset can only be entered from enabled state\n",
1857 /* For some modules, all optionnal clocks need to be enabled as well */
1858 if (oh
->flags
& HWMOD_CONTROL_OPT_CLKS_IN_RESET
)
1859 _enable_optional_clocks(oh
);
1861 pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh
->name
);
1863 v
= oh
->_sysc_cache
;
1864 ret
= _set_softreset(oh
, &v
);
1868 _write_sysconfig(v
, oh
);
1870 if (oh
->class->sysc
->srst_udelay
)
1871 udelay(oh
->class->sysc
->srst_udelay
);
1873 c
= _wait_softreset_complete(oh
);
1874 if (c
== MAX_MODULE_SOFTRESET_WAIT
) {
1875 pr_warn("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1876 oh
->name
, MAX_MODULE_SOFTRESET_WAIT
);
1880 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh
->name
, c
);
1883 ret
= _clear_softreset(oh
, &v
);
1887 _write_sysconfig(v
, oh
);
1890 * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1891 * _wait_target_ready() or _reset()
1895 if (oh
->flags
& HWMOD_CONTROL_OPT_CLKS_IN_RESET
)
1896 _disable_optional_clocks(oh
);
1902 * _reset - reset an omap_hwmod
1903 * @oh: struct omap_hwmod *
1905 * Resets an omap_hwmod @oh. If the module has a custom reset
1906 * function pointer defined, then call it to reset the IP block, and
1907 * pass along its return value to the caller. Otherwise, if the IP
1908 * block has an OCP_SYSCONFIG register with a SOFTRESET bitfield
1909 * associated with it, call a function to reset the IP block via that
1910 * method, and pass along the return value to the caller. Finally, if
1911 * the IP block has some hardreset lines associated with it, assert
1912 * all of those, but do _not_ deassert them. (This is because driver
1913 * authors have expressed an apparent requirement to control the
1914 * deassertion of the hardreset lines themselves.)
1916 * The default software reset mechanism for most OMAP IP blocks is
1917 * triggered via the OCP_SYSCONFIG.SOFTRESET bit. However, some
1918 * hwmods cannot be reset via this method. Some are not targets and
1919 * therefore have no OCP header registers to access. Others (like the
1920 * IVA) have idiosyncratic reset sequences. So for these relatively
1921 * rare cases, custom reset code can be supplied in the struct
1922 * omap_hwmod_class .reset function pointer.
1924 * _set_dmadisable() is called to set the DMADISABLE bit so that it
1925 * does not prevent idling of the system. This is necessary for cases
1926 * where ROMCODE/BOOTLOADER uses dma and transfers control to the
1927 * kernel without disabling dma.
1929 * Passes along the return value from either _ocp_softreset() or the
1930 * custom reset function - these must return -EINVAL if the hwmod
1931 * cannot be reset this way or if the hwmod is in the wrong state,
1932 * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1934 static int _reset(struct omap_hwmod
*oh
)
1938 pr_debug("omap_hwmod: %s: resetting\n", oh
->name
);
1940 if (oh
->class->reset
) {
1941 r
= oh
->class->reset(oh
);
1943 if (oh
->rst_lines_cnt
> 0) {
1944 for (i
= 0; i
< oh
->rst_lines_cnt
; i
++)
1945 _assert_hardreset(oh
, oh
->rst_lines
[i
].name
);
1948 r
= _ocp_softreset(oh
);
1954 _set_dmadisable(oh
);
1957 * OCP_SYSCONFIG bits need to be reprogrammed after a
1958 * softreset. The _enable() function should be split to avoid
1959 * the rewrite of the OCP_SYSCONFIG register.
1961 if (oh
->class->sysc
) {
1962 _update_sysc_cache(oh
);
1970 * _reconfigure_io_chain - clear any I/O chain wakeups and reconfigure chain
1972 * Call the appropriate PRM function to clear any logged I/O chain
1973 * wakeups and to reconfigure the chain. This apparently needs to be
1974 * done upon every mux change. Since hwmods can be concurrently
1975 * enabled and idled, hold a spinlock around the I/O chain
1976 * reconfiguration sequence. No return value.
1978 * XXX When the PRM code is moved to drivers, this function can be removed,
1979 * as the PRM infrastructure should abstract this.
1981 static void _reconfigure_io_chain(void)
1983 unsigned long flags
;
1985 spin_lock_irqsave(&io_chain_lock
, flags
);
1987 omap_prm_reconfigure_io_chain();
1989 spin_unlock_irqrestore(&io_chain_lock
, flags
);
1993 * _omap4_update_context_lost - increment hwmod context loss counter if
1994 * hwmod context was lost, and clear hardware context loss reg
1995 * @oh: hwmod to check for context loss
1997 * If the PRCM indicates that the hwmod @oh lost context, increment
1998 * our in-memory context loss counter, and clear the RM_*_CONTEXT
1999 * bits. No return value.
2001 static void _omap4_update_context_lost(struct omap_hwmod
*oh
)
2003 if (oh
->prcm
.omap4
.flags
& HWMOD_OMAP4_NO_CONTEXT_LOSS_BIT
)
2006 if (!prm_was_any_context_lost_old(oh
->clkdm
->pwrdm
.ptr
->prcm_partition
,
2007 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
2008 oh
->prcm
.omap4
.context_offs
))
2011 oh
->prcm
.omap4
.context_lost_counter
++;
2012 prm_clear_context_loss_flags_old(oh
->clkdm
->pwrdm
.ptr
->prcm_partition
,
2013 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
2014 oh
->prcm
.omap4
.context_offs
);
2018 * _omap4_get_context_lost - get context loss counter for a hwmod
2019 * @oh: hwmod to get context loss counter for
2021 * Returns the in-memory context loss counter for a hwmod.
2023 static int _omap4_get_context_lost(struct omap_hwmod
*oh
)
2025 return oh
->prcm
.omap4
.context_lost_counter
;
2029 * _enable_preprogram - Pre-program an IP block during the _enable() process
2030 * @oh: struct omap_hwmod *
2032 * Some IP blocks (such as AESS) require some additional programming
2033 * after enable before they can enter idle. If a function pointer to
2034 * do so is present in the hwmod data, then call it and pass along the
2035 * return value; otherwise, return 0.
2037 static int _enable_preprogram(struct omap_hwmod
*oh
)
2039 if (!oh
->class->enable_preprogram
)
2042 return oh
->class->enable_preprogram(oh
);
2046 * _enable - enable an omap_hwmod
2047 * @oh: struct omap_hwmod *
2049 * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
2050 * register target. Returns -EINVAL if the hwmod is in the wrong
2051 * state or passes along the return value of _wait_target_ready().
2053 static int _enable(struct omap_hwmod
*oh
)
2058 pr_debug("omap_hwmod: %s: enabling\n", oh
->name
);
2061 * hwmods with HWMOD_INIT_NO_IDLE flag set are left in enabled
2062 * state at init. Now that someone is really trying to enable
2063 * them, just ensure that the hwmod mux is set.
2065 if (oh
->_int_flags
& _HWMOD_SKIP_ENABLE
) {
2067 * If the caller has mux data populated, do the mux'ing
2068 * which wouldn't have been done as part of the _enable()
2069 * done during setup.
2072 omap_hwmod_mux(oh
->mux
, _HWMOD_STATE_ENABLED
);
2074 oh
->_int_flags
&= ~_HWMOD_SKIP_ENABLE
;
2078 if (oh
->_state
!= _HWMOD_STATE_INITIALIZED
&&
2079 oh
->_state
!= _HWMOD_STATE_IDLE
&&
2080 oh
->_state
!= _HWMOD_STATE_DISABLED
) {
2081 WARN(1, "omap_hwmod: %s: enabled state can only be entered from initialized, idle, or disabled state\n",
2087 * If an IP block contains HW reset lines and all of them are
2088 * asserted, we let integration code associated with that
2089 * block handle the enable. We've received very little
2090 * information on what those driver authors need, and until
2091 * detailed information is provided and the driver code is
2092 * posted to the public lists, this is probably the best we
2095 if (_are_all_hardreset_lines_asserted(oh
))
2098 /* Mux pins for device runtime if populated */
2099 if (oh
->mux
&& (!oh
->mux
->enabled
||
2100 ((oh
->_state
== _HWMOD_STATE_IDLE
) &&
2101 oh
->mux
->pads_dynamic
))) {
2102 omap_hwmod_mux(oh
->mux
, _HWMOD_STATE_ENABLED
);
2103 _reconfigure_io_chain();
2104 } else if (oh
->flags
& HWMOD_RECONFIG_IO_CHAIN
) {
2105 _reconfigure_io_chain();
2108 _add_initiator_dep(oh
, mpu_oh
);
2112 * A clockdomain must be in SW_SUP before enabling
2113 * completely the module. The clockdomain can be set
2114 * in HW_AUTO only when the module become ready.
2116 hwsup
= clkdm_in_hwsup(oh
->clkdm
) &&
2117 !clkdm_missing_idle_reporting(oh
->clkdm
);
2118 r
= clkdm_hwmod_enable(oh
->clkdm
, oh
);
2120 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
2121 oh
->name
, oh
->clkdm
->name
, r
);
2127 if (soc_ops
.enable_module
)
2128 soc_ops
.enable_module(oh
);
2129 if (oh
->flags
& HWMOD_BLOCK_WFI
)
2130 cpu_idle_poll_ctrl(true);
2132 if (soc_ops
.update_context_lost
)
2133 soc_ops
.update_context_lost(oh
);
2135 r
= (soc_ops
.wait_target_ready
) ? soc_ops
.wait_target_ready(oh
) :
2139 * Set the clockdomain to HW_AUTO only if the target is ready,
2140 * assuming that the previous state was HW_AUTO
2142 if (oh
->clkdm
&& hwsup
)
2143 clkdm_allow_idle(oh
->clkdm
);
2145 oh
->_state
= _HWMOD_STATE_ENABLED
;
2147 /* Access the sysconfig only if the target is ready */
2148 if (oh
->class->sysc
) {
2149 if (!(oh
->_int_flags
& _HWMOD_SYSCONFIG_LOADED
))
2150 _update_sysc_cache(oh
);
2153 r
= _enable_preprogram(oh
);
2155 if (soc_ops
.disable_module
)
2156 soc_ops
.disable_module(oh
);
2157 _disable_clocks(oh
);
2158 pr_debug("omap_hwmod: %s: _wait_target_ready: %d\n",
2162 clkdm_hwmod_disable(oh
->clkdm
, oh
);
2169 * _idle - idle an omap_hwmod
2170 * @oh: struct omap_hwmod *
2172 * Idles an omap_hwmod @oh. This should be called once the hwmod has
2173 * no further work. Returns -EINVAL if the hwmod is in the wrong
2174 * state or returns 0.
2176 static int _idle(struct omap_hwmod
*oh
)
2178 pr_debug("omap_hwmod: %s: idling\n", oh
->name
);
2180 if (oh
->_state
!= _HWMOD_STATE_ENABLED
) {
2181 WARN(1, "omap_hwmod: %s: idle state can only be entered from enabled state\n",
2186 if (_are_all_hardreset_lines_asserted(oh
))
2189 if (oh
->class->sysc
)
2191 _del_initiator_dep(oh
, mpu_oh
);
2193 if (oh
->flags
& HWMOD_BLOCK_WFI
)
2194 cpu_idle_poll_ctrl(false);
2195 if (soc_ops
.disable_module
)
2196 soc_ops
.disable_module(oh
);
2199 * The module must be in idle mode before disabling any parents
2200 * clocks. Otherwise, the parent clock might be disabled before
2201 * the module transition is done, and thus will prevent the
2202 * transition to complete properly.
2204 _disable_clocks(oh
);
2206 clkdm_hwmod_disable(oh
->clkdm
, oh
);
2208 /* Mux pins for device idle if populated */
2209 if (oh
->mux
&& oh
->mux
->pads_dynamic
) {
2210 omap_hwmod_mux(oh
->mux
, _HWMOD_STATE_IDLE
);
2211 _reconfigure_io_chain();
2212 } else if (oh
->flags
& HWMOD_RECONFIG_IO_CHAIN
) {
2213 _reconfigure_io_chain();
2216 oh
->_state
= _HWMOD_STATE_IDLE
;
2222 * _shutdown - shutdown an omap_hwmod
2223 * @oh: struct omap_hwmod *
2225 * Shut down an omap_hwmod @oh. This should be called when the driver
2226 * used for the hwmod is removed or unloaded or if the driver is not
2227 * used by the system. Returns -EINVAL if the hwmod is in the wrong
2228 * state or returns 0.
2230 static int _shutdown(struct omap_hwmod
*oh
)
2235 if (oh
->_state
!= _HWMOD_STATE_IDLE
&&
2236 oh
->_state
!= _HWMOD_STATE_ENABLED
) {
2237 WARN(1, "omap_hwmod: %s: disabled state can only be entered from idle, or enabled state\n",
2242 if (_are_all_hardreset_lines_asserted(oh
))
2245 pr_debug("omap_hwmod: %s: disabling\n", oh
->name
);
2247 if (oh
->class->pre_shutdown
) {
2248 prev_state
= oh
->_state
;
2249 if (oh
->_state
== _HWMOD_STATE_IDLE
)
2251 ret
= oh
->class->pre_shutdown(oh
);
2253 if (prev_state
== _HWMOD_STATE_IDLE
)
2259 if (oh
->class->sysc
) {
2260 if (oh
->_state
== _HWMOD_STATE_IDLE
)
2265 /* clocks and deps are already disabled in idle */
2266 if (oh
->_state
== _HWMOD_STATE_ENABLED
) {
2267 _del_initiator_dep(oh
, mpu_oh
);
2268 /* XXX what about the other system initiators here? dma, dsp */
2269 if (oh
->flags
& HWMOD_BLOCK_WFI
)
2270 cpu_idle_poll_ctrl(false);
2271 if (soc_ops
.disable_module
)
2272 soc_ops
.disable_module(oh
);
2273 _disable_clocks(oh
);
2275 clkdm_hwmod_disable(oh
->clkdm
, oh
);
2277 /* XXX Should this code also force-disable the optional clocks? */
2279 for (i
= 0; i
< oh
->rst_lines_cnt
; i
++)
2280 _assert_hardreset(oh
, oh
->rst_lines
[i
].name
);
2282 /* Mux pins to safe mode or use populated off mode values */
2284 omap_hwmod_mux(oh
->mux
, _HWMOD_STATE_DISABLED
);
2286 oh
->_state
= _HWMOD_STATE_DISABLED
;
2291 static int of_dev_find_hwmod(struct device_node
*np
,
2292 struct omap_hwmod
*oh
)
2297 count
= of_property_count_strings(np
, "ti,hwmods");
2301 for (i
= 0; i
< count
; i
++) {
2302 res
= of_property_read_string_index(np
, "ti,hwmods",
2306 if (!strcmp(p
, oh
->name
)) {
2307 pr_debug("omap_hwmod: dt %s[%i] uses hwmod %s\n",
2308 np
->name
, i
, oh
->name
);
2317 * of_dev_hwmod_lookup - look up needed hwmod from dt blob
2318 * @np: struct device_node *
2319 * @oh: struct omap_hwmod *
2320 * @index: index of the entry found
2321 * @found: struct device_node * found or NULL
2323 * Parse the dt blob and find out needed hwmod. Recursive function is
2324 * implemented to take care hierarchical dt blob parsing.
2325 * Return: Returns 0 on success, -ENODEV when not found.
2327 static int of_dev_hwmod_lookup(struct device_node
*np
,
2328 struct omap_hwmod
*oh
,
2330 struct device_node
**found
)
2332 struct device_node
*np0
= NULL
;
2335 res
= of_dev_find_hwmod(np
, oh
);
2342 for_each_child_of_node(np
, np0
) {
2343 struct device_node
*fc
;
2346 res
= of_dev_hwmod_lookup(np0
, oh
, &i
, &fc
);
2361 * _init_mpu_rt_base - populate the virtual address for a hwmod
2362 * @oh: struct omap_hwmod * to locate the virtual address
2363 * @data: (unused, caller should pass NULL)
2364 * @index: index of the reg entry iospace in device tree
2365 * @np: struct device_node * of the IP block's device node in the DT data
2367 * Cache the virtual address used by the MPU to access this IP block's
2368 * registers. This address is needed early so the OCP registers that
2369 * are part of the device's address space can be ioremapped properly.
2371 * Returns 0 on success, -EINVAL if an invalid hwmod is passed, and
2372 * -ENXIO on absent or invalid register target address space.
2374 static int __init
_init_mpu_rt_base(struct omap_hwmod
*oh
, void *data
,
2375 int index
, struct device_node
*np
)
2377 struct omap_hwmod_addr_space
*mem
;
2378 void __iomem
*va_start
= NULL
;
2383 _save_mpu_port_index(oh
);
2385 if (oh
->_int_flags
& _HWMOD_NO_MPU_PORT
)
2388 mem
= _find_mpu_rt_addr_space(oh
);
2390 pr_debug("omap_hwmod: %s: no MPU register target found\n",
2393 /* Extract the IO space from device tree blob */
2397 va_start
= of_iomap(np
, index
+ oh
->mpu_rt_idx
);
2399 va_start
= ioremap(mem
->pa_start
, mem
->pa_end
- mem
->pa_start
);
2404 pr_err("omap_hwmod: %s: Could not ioremap\n", oh
->name
);
2406 pr_err("omap_hwmod: %s: Missing dt reg%i for %s\n",
2407 oh
->name
, index
, np
->full_name
);
2411 pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
2412 oh
->name
, va_start
);
2414 oh
->_mpu_rt_va
= va_start
;
2419 * _init - initialize internal data for the hwmod @oh
2420 * @oh: struct omap_hwmod *
2423 * Look up the clocks and the address space used by the MPU to access
2424 * registers belonging to the hwmod @oh. @oh must already be
2425 * registered at this point. This is the first of two phases for
2426 * hwmod initialization. Code called here does not touch any hardware
2427 * registers, it simply prepares internal data structures. Returns 0
2428 * upon success or if the hwmod isn't registered or if the hwmod's
2429 * address space is not defined, or -EINVAL upon failure.
2431 static int __init
_init(struct omap_hwmod
*oh
, void *data
)
2434 struct device_node
*np
= NULL
;
2436 if (oh
->_state
!= _HWMOD_STATE_REGISTERED
)
2439 if (of_have_populated_dt()) {
2440 struct device_node
*bus
;
2442 bus
= of_find_node_by_name(NULL
, "ocp");
2446 r
= of_dev_hwmod_lookup(bus
, oh
, &index
, &np
);
2448 pr_debug("omap_hwmod: %s missing dt data\n", oh
->name
);
2449 else if (np
&& index
)
2450 pr_warn("omap_hwmod: %s using broken dt data from %s\n",
2451 oh
->name
, np
->name
);
2454 if (oh
->class->sysc
) {
2455 r
= _init_mpu_rt_base(oh
, NULL
, index
, np
);
2457 WARN(1, "omap_hwmod: %s: doesn't have mpu register target base\n",
2463 r
= _init_clocks(oh
, NULL
);
2465 WARN(1, "omap_hwmod: %s: couldn't init clocks\n", oh
->name
);
2470 if (of_find_property(np
, "ti,no-reset-on-init", NULL
))
2471 oh
->flags
|= HWMOD_INIT_NO_RESET
;
2472 if (of_find_property(np
, "ti,no-idle-on-init", NULL
))
2473 oh
->flags
|= HWMOD_INIT_NO_IDLE
;
2476 oh
->_state
= _HWMOD_STATE_INITIALIZED
;
2482 * _setup_iclk_autoidle - configure an IP block's interface clocks
2483 * @oh: struct omap_hwmod *
2485 * Set up the module's interface clocks. XXX This function is still mostly
2486 * a stub; implementing this properly requires iclk autoidle usecounting in
2487 * the clock code. No return value.
2489 static void __init
_setup_iclk_autoidle(struct omap_hwmod
*oh
)
2491 struct omap_hwmod_ocp_if
*os
;
2492 struct list_head
*p
;
2494 if (oh
->_state
!= _HWMOD_STATE_INITIALIZED
)
2497 p
= oh
->slave_ports
.next
;
2499 while (i
< oh
->slaves_cnt
) {
2500 os
= _fetch_next_ocp_if(&p
, &i
);
2504 if (os
->flags
& OCPIF_SWSUP_IDLE
) {
2505 /* XXX omap_iclk_deny_idle(c); */
2507 /* XXX omap_iclk_allow_idle(c); */
2508 clk_enable(os
->_clk
);
2516 * _setup_reset - reset an IP block during the setup process
2517 * @oh: struct omap_hwmod *
2519 * Reset the IP block corresponding to the hwmod @oh during the setup
2520 * process. The IP block is first enabled so it can be successfully
2521 * reset. Returns 0 upon success or a negative error code upon
2524 static int __init
_setup_reset(struct omap_hwmod
*oh
)
2528 if (oh
->_state
!= _HWMOD_STATE_INITIALIZED
)
2531 if (oh
->flags
& HWMOD_EXT_OPT_MAIN_CLK
)
2534 if (oh
->rst_lines_cnt
== 0) {
2537 pr_warn("omap_hwmod: %s: cannot be enabled for reset (%d)\n",
2538 oh
->name
, oh
->_state
);
2543 if (!(oh
->flags
& HWMOD_INIT_NO_RESET
))
2550 * _setup_postsetup - transition to the appropriate state after _setup
2551 * @oh: struct omap_hwmod *
2553 * Place an IP block represented by @oh into a "post-setup" state --
2554 * either IDLE, ENABLED, or DISABLED. ("post-setup" simply means that
2555 * this function is called at the end of _setup().) The postsetup
2556 * state for an IP block can be changed by calling
2557 * omap_hwmod_enter_postsetup_state() early in the boot process,
2558 * before one of the omap_hwmod_setup*() functions are called for the
2561 * The IP block stays in this state until a PM runtime-based driver is
2562 * loaded for that IP block. A post-setup state of IDLE is
2563 * appropriate for almost all IP blocks with runtime PM-enabled
2564 * drivers, since those drivers are able to enable the IP block. A
2565 * post-setup state of ENABLED is appropriate for kernels with PM
2566 * runtime disabled. The DISABLED state is appropriate for unusual IP
2567 * blocks such as the MPU WDTIMER on kernels without WDTIMER drivers
2568 * included, since the WDTIMER starts running on reset and will reset
2569 * the MPU if left active.
2571 * This post-setup mechanism is deprecated. Once all of the OMAP
2572 * drivers have been converted to use PM runtime, and all of the IP
2573 * block data and interconnect data is available to the hwmod code, it
2574 * should be possible to replace this mechanism with a "lazy reset"
2575 * arrangement. In a "lazy reset" setup, each IP block is enabled
2576 * when the driver first probes, then all remaining IP blocks without
2577 * drivers are either shut down or enabled after the drivers have
2578 * loaded. However, this cannot take place until the above
2579 * preconditions have been met, since otherwise the late reset code
2580 * has no way of knowing which IP blocks are in use by drivers, and
2581 * which ones are unused.
2585 static void __init
_setup_postsetup(struct omap_hwmod
*oh
)
2589 if (oh
->rst_lines_cnt
> 0)
2592 postsetup_state
= oh
->_postsetup_state
;
2593 if (postsetup_state
== _HWMOD_STATE_UNKNOWN
)
2594 postsetup_state
= _HWMOD_STATE_ENABLED
;
2597 * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
2598 * it should be set by the core code as a runtime flag during startup
2600 if ((oh
->flags
& HWMOD_INIT_NO_IDLE
) &&
2601 (postsetup_state
== _HWMOD_STATE_IDLE
)) {
2602 oh
->_int_flags
|= _HWMOD_SKIP_ENABLE
;
2603 postsetup_state
= _HWMOD_STATE_ENABLED
;
2606 if (postsetup_state
== _HWMOD_STATE_IDLE
)
2608 else if (postsetup_state
== _HWMOD_STATE_DISABLED
)
2610 else if (postsetup_state
!= _HWMOD_STATE_ENABLED
)
2611 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
2612 oh
->name
, postsetup_state
);
2618 * _setup - prepare IP block hardware for use
2619 * @oh: struct omap_hwmod *
2620 * @n: (unused, pass NULL)
2622 * Configure the IP block represented by @oh. This may include
2623 * enabling the IP block, resetting it, and placing it into a
2624 * post-setup state, depending on the type of IP block and applicable
2625 * flags. IP blocks are reset to prevent any previous configuration
2626 * by the bootloader or previous operating system from interfering
2627 * with power management or other parts of the system. The reset can
2628 * be avoided; see omap_hwmod_no_setup_reset(). This is the second of
2629 * two phases for hwmod initialization. Code called here generally
2630 * affects the IP block hardware, or system integration hardware
2631 * associated with the IP block. Returns 0.
2633 static int __init
_setup(struct omap_hwmod
*oh
, void *data
)
2635 if (oh
->_state
!= _HWMOD_STATE_INITIALIZED
)
2638 if (oh
->parent_hwmod
) {
2641 r
= _enable(oh
->parent_hwmod
);
2642 WARN(r
, "hwmod: %s: setup: failed to enable parent hwmod %s\n",
2643 oh
->name
, oh
->parent_hwmod
->name
);
2646 _setup_iclk_autoidle(oh
);
2648 if (!_setup_reset(oh
))
2649 _setup_postsetup(oh
);
2651 if (oh
->parent_hwmod
) {
2654 postsetup_state
= oh
->parent_hwmod
->_postsetup_state
;
2656 if (postsetup_state
== _HWMOD_STATE_IDLE
)
2657 _idle(oh
->parent_hwmod
);
2658 else if (postsetup_state
== _HWMOD_STATE_DISABLED
)
2659 _shutdown(oh
->parent_hwmod
);
2660 else if (postsetup_state
!= _HWMOD_STATE_ENABLED
)
2661 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
2662 oh
->parent_hwmod
->name
, postsetup_state
);
2669 * _register - register a struct omap_hwmod
2670 * @oh: struct omap_hwmod *
2672 * Registers the omap_hwmod @oh. Returns -EEXIST if an omap_hwmod
2673 * already has been registered by the same name; -EINVAL if the
2674 * omap_hwmod is in the wrong state, if @oh is NULL, if the
2675 * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
2676 * name, or if the omap_hwmod's class is missing a name; or 0 upon
2679 * XXX The data should be copied into bootmem, so the original data
2680 * should be marked __initdata and freed after init. This would allow
2681 * unneeded omap_hwmods to be freed on multi-OMAP configurations. Note
2682 * that the copy process would be relatively complex due to the large number
2685 static int __init
_register(struct omap_hwmod
*oh
)
2687 if (!oh
|| !oh
->name
|| !oh
->class || !oh
->class->name
||
2688 (oh
->_state
!= _HWMOD_STATE_UNKNOWN
))
2691 pr_debug("omap_hwmod: %s: registering\n", oh
->name
);
2693 if (_lookup(oh
->name
))
2696 list_add_tail(&oh
->node
, &omap_hwmod_list
);
2698 INIT_LIST_HEAD(&oh
->master_ports
);
2699 INIT_LIST_HEAD(&oh
->slave_ports
);
2700 spin_lock_init(&oh
->_lock
);
2702 oh
->_state
= _HWMOD_STATE_REGISTERED
;
2705 * XXX Rather than doing a strcmp(), this should test a flag
2706 * set in the hwmod data, inserted by the autogenerator code.
2708 if (!strcmp(oh
->name
, MPU_INITIATOR_NAME
))
2715 * _alloc_links - return allocated memory for hwmod links
2716 * @ml: pointer to a struct omap_hwmod_link * for the master link
2717 * @sl: pointer to a struct omap_hwmod_link * for the slave link
2719 * Return pointers to two struct omap_hwmod_link records, via the
2720 * addresses pointed to by @ml and @sl. Will first attempt to return
2721 * memory allocated as part of a large initial block, but if that has
2722 * been exhausted, will allocate memory itself. Since ideally this
2723 * second allocation path will never occur, the number of these
2724 * 'supplemental' allocations will be logged when debugging is
2725 * enabled. Returns 0.
2727 static int __init
_alloc_links(struct omap_hwmod_link
**ml
,
2728 struct omap_hwmod_link
**sl
)
2732 if ((free_ls
+ LINKS_PER_OCP_IF
) <= max_ls
) {
2733 *ml
= &linkspace
[free_ls
++];
2734 *sl
= &linkspace
[free_ls
++];
2738 sz
= sizeof(struct omap_hwmod_link
) * LINKS_PER_OCP_IF
;
2741 *ml
= memblock_virt_alloc(sz
, 0);
2743 *sl
= (void *)(*ml
) + sizeof(struct omap_hwmod_link
);
2746 pr_debug("omap_hwmod: supplemental link allocations needed: %d\n",
2747 ls_supp
* LINKS_PER_OCP_IF
);
2753 * _add_link - add an interconnect between two IP blocks
2754 * @oi: pointer to a struct omap_hwmod_ocp_if record
2756 * Add struct omap_hwmod_link records connecting the master IP block
2757 * specified in @oi->master to @oi, and connecting the slave IP block
2758 * specified in @oi->slave to @oi. This code is assumed to run before
2759 * preemption or SMP has been enabled, thus avoiding the need for
2760 * locking in this code. Changes to this assumption will require
2761 * additional locking. Returns 0.
2763 static int __init
_add_link(struct omap_hwmod_ocp_if
*oi
)
2765 struct omap_hwmod_link
*ml
, *sl
;
2767 pr_debug("omap_hwmod: %s -> %s: adding link\n", oi
->master
->name
,
2770 _alloc_links(&ml
, &sl
);
2773 list_add(&ml
->node
, &oi
->master
->master_ports
);
2774 oi
->master
->masters_cnt
++;
2777 list_add(&sl
->node
, &oi
->slave
->slave_ports
);
2778 oi
->slave
->slaves_cnt
++;
2784 * _register_link - register a struct omap_hwmod_ocp_if
2785 * @oi: struct omap_hwmod_ocp_if *
2787 * Registers the omap_hwmod_ocp_if record @oi. Returns -EEXIST if it
2788 * has already been registered; -EINVAL if @oi is NULL or if the
2789 * record pointed to by @oi is missing required fields; or 0 upon
2792 * XXX The data should be copied into bootmem, so the original data
2793 * should be marked __initdata and freed after init. This would allow
2794 * unneeded omap_hwmods to be freed on multi-OMAP configurations.
2796 static int __init
_register_link(struct omap_hwmod_ocp_if
*oi
)
2798 if (!oi
|| !oi
->master
|| !oi
->slave
|| !oi
->user
)
2801 if (oi
->_int_flags
& _OCPIF_INT_FLAGS_REGISTERED
)
2804 pr_debug("omap_hwmod: registering link from %s to %s\n",
2805 oi
->master
->name
, oi
->slave
->name
);
2808 * Register the connected hwmods, if they haven't been
2809 * registered already
2811 if (oi
->master
->_state
!= _HWMOD_STATE_REGISTERED
)
2812 _register(oi
->master
);
2814 if (oi
->slave
->_state
!= _HWMOD_STATE_REGISTERED
)
2815 _register(oi
->slave
);
2819 oi
->_int_flags
|= _OCPIF_INT_FLAGS_REGISTERED
;
2825 * _alloc_linkspace - allocate large block of hwmod links
2826 * @ois: pointer to an array of struct omap_hwmod_ocp_if records to count
2828 * Allocate a large block of struct omap_hwmod_link records. This
2829 * improves boot time significantly by avoiding the need to allocate
2830 * individual records one by one. If the number of records to
2831 * allocate in the block hasn't been manually specified, this function
2832 * will count the number of struct omap_hwmod_ocp_if records in @ois
2833 * and use that to determine the allocation size. For SoC families
2834 * that require multiple list registrations, such as OMAP3xxx, this
2835 * estimation process isn't optimal, so manual estimation is advised
2836 * in those cases. Returns -EEXIST if the allocation has already occurred
2837 * or 0 upon success.
2839 static int __init
_alloc_linkspace(struct omap_hwmod_ocp_if
**ois
)
2845 WARN(1, "linkspace already allocated\n");
2851 max_ls
+= LINKS_PER_OCP_IF
;
2853 sz
= sizeof(struct omap_hwmod_link
) * max_ls
;
2855 pr_debug("omap_hwmod: %s: allocating %d byte linkspace (%d links)\n",
2856 __func__
, sz
, max_ls
);
2858 linkspace
= memblock_virt_alloc(sz
, 0);
2863 /* Static functions intended only for use in soc_ops field function pointers */
2866 * _omap2xxx_3xxx_wait_target_ready - wait for a module to leave slave idle
2867 * @oh: struct omap_hwmod *
2869 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2870 * does not have an IDLEST bit or if the module successfully leaves
2871 * slave idle; otherwise, pass along the return value of the
2872 * appropriate *_cm*_wait_module_ready() function.
2874 static int _omap2xxx_3xxx_wait_target_ready(struct omap_hwmod
*oh
)
2879 if (oh
->flags
& HWMOD_NO_IDLEST
)
2882 if (!_find_mpu_rt_port(oh
))
2885 /* XXX check module SIDLEMODE, hardreset status, enabled clocks */
2887 return omap_cm_wait_module_ready(0, oh
->prcm
.omap2
.module_offs
,
2888 oh
->prcm
.omap2
.idlest_reg_id
,
2889 oh
->prcm
.omap2
.idlest_idle_bit
);
2893 * _omap4_wait_target_ready - wait for a module to leave slave idle
2894 * @oh: struct omap_hwmod *
2896 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2897 * does not have an IDLEST bit or if the module successfully leaves
2898 * slave idle; otherwise, pass along the return value of the
2899 * appropriate *_cm*_wait_module_ready() function.
2901 static int _omap4_wait_target_ready(struct omap_hwmod
*oh
)
2906 if (oh
->flags
& HWMOD_NO_IDLEST
|| !oh
->clkdm
)
2909 if (!_find_mpu_rt_port(oh
))
2912 /* XXX check module SIDLEMODE, hardreset status */
2914 return omap_cm_wait_module_ready(oh
->clkdm
->prcm_partition
,
2916 oh
->prcm
.omap4
.clkctrl_offs
, 0);
2920 * _omap2_assert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2921 * @oh: struct omap_hwmod * to assert hardreset
2922 * @ohri: hardreset line data
2924 * Call omap2_prm_assert_hardreset() with parameters extracted from
2925 * the hwmod @oh and the hardreset line data @ohri. Only intended for
2926 * use as an soc_ops function pointer. Passes along the return value
2927 * from omap2_prm_assert_hardreset(). XXX This function is scheduled
2928 * for removal when the PRM code is moved into drivers/.
2930 static int _omap2_assert_hardreset(struct omap_hwmod
*oh
,
2931 struct omap_hwmod_rst_info
*ohri
)
2933 return omap_prm_assert_hardreset(ohri
->rst_shift
, 0,
2934 oh
->prcm
.omap2
.module_offs
, 0);
2938 * _omap2_deassert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2939 * @oh: struct omap_hwmod * to deassert hardreset
2940 * @ohri: hardreset line data
2942 * Call omap2_prm_deassert_hardreset() with parameters extracted from
2943 * the hwmod @oh and the hardreset line data @ohri. Only intended for
2944 * use as an soc_ops function pointer. Passes along the return value
2945 * from omap2_prm_deassert_hardreset(). XXX This function is
2946 * scheduled for removal when the PRM code is moved into drivers/.
2948 static int _omap2_deassert_hardreset(struct omap_hwmod
*oh
,
2949 struct omap_hwmod_rst_info
*ohri
)
2951 return omap_prm_deassert_hardreset(ohri
->rst_shift
, ohri
->st_shift
, 0,
2952 oh
->prcm
.omap2
.module_offs
, 0, 0);
2956 * _omap2_is_hardreset_asserted - call OMAP2 PRM hardreset fn with hwmod args
2957 * @oh: struct omap_hwmod * to test hardreset
2958 * @ohri: hardreset line data
2960 * Call omap2_prm_is_hardreset_asserted() with parameters extracted
2961 * from the hwmod @oh and the hardreset line data @ohri. Only
2962 * intended for use as an soc_ops function pointer. Passes along the
2963 * return value from omap2_prm_is_hardreset_asserted(). XXX This
2964 * function is scheduled for removal when the PRM code is moved into
2967 static int _omap2_is_hardreset_asserted(struct omap_hwmod
*oh
,
2968 struct omap_hwmod_rst_info
*ohri
)
2970 return omap_prm_is_hardreset_asserted(ohri
->st_shift
, 0,
2971 oh
->prcm
.omap2
.module_offs
, 0);
2975 * _omap4_assert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
2976 * @oh: struct omap_hwmod * to assert hardreset
2977 * @ohri: hardreset line data
2979 * Call omap4_prminst_assert_hardreset() with parameters extracted
2980 * from the hwmod @oh and the hardreset line data @ohri. Only
2981 * intended for use as an soc_ops function pointer. Passes along the
2982 * return value from omap4_prminst_assert_hardreset(). XXX This
2983 * function is scheduled for removal when the PRM code is moved into
2986 static int _omap4_assert_hardreset(struct omap_hwmod
*oh
,
2987 struct omap_hwmod_rst_info
*ohri
)
2992 return omap_prm_assert_hardreset(ohri
->rst_shift
,
2993 oh
->clkdm
->pwrdm
.ptr
->prcm_partition
,
2994 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
2995 oh
->prcm
.omap4
.rstctrl_offs
);
2999 * _omap4_deassert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
3000 * @oh: struct omap_hwmod * to deassert hardreset
3001 * @ohri: hardreset line data
3003 * Call omap4_prminst_deassert_hardreset() with parameters extracted
3004 * from the hwmod @oh and the hardreset line data @ohri. Only
3005 * intended for use as an soc_ops function pointer. Passes along the
3006 * return value from omap4_prminst_deassert_hardreset(). XXX This
3007 * function is scheduled for removal when the PRM code is moved into
3010 static int _omap4_deassert_hardreset(struct omap_hwmod
*oh
,
3011 struct omap_hwmod_rst_info
*ohri
)
3017 pr_err("omap_hwmod: %s: %s: hwmod data error: OMAP4 does not support st_shift\n",
3018 oh
->name
, ohri
->name
);
3019 return omap_prm_deassert_hardreset(ohri
->rst_shift
, 0,
3020 oh
->clkdm
->pwrdm
.ptr
->prcm_partition
,
3021 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
3022 oh
->prcm
.omap4
.rstctrl_offs
, 0);
3026 * _omap4_is_hardreset_asserted - call OMAP4 PRM hardreset fn with hwmod args
3027 * @oh: struct omap_hwmod * to test hardreset
3028 * @ohri: hardreset line data
3030 * Call omap4_prminst_is_hardreset_asserted() with parameters
3031 * extracted from the hwmod @oh and the hardreset line data @ohri.
3032 * Only intended for use as an soc_ops function pointer. Passes along
3033 * the return value from omap4_prminst_is_hardreset_asserted(). XXX
3034 * This function is scheduled for removal when the PRM code is moved
3037 static int _omap4_is_hardreset_asserted(struct omap_hwmod
*oh
,
3038 struct omap_hwmod_rst_info
*ohri
)
3043 return omap_prm_is_hardreset_asserted(ohri
->rst_shift
,
3044 oh
->clkdm
->pwrdm
.ptr
->
3046 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
3047 oh
->prcm
.omap4
.rstctrl_offs
);
3051 * _am33xx_assert_hardreset - call AM33XX PRM hardreset fn with hwmod args
3052 * @oh: struct omap_hwmod * to assert hardreset
3053 * @ohri: hardreset line data
3055 * Call am33xx_prminst_assert_hardreset() with parameters extracted
3056 * from the hwmod @oh and the hardreset line data @ohri. Only
3057 * intended for use as an soc_ops function pointer. Passes along the
3058 * return value from am33xx_prminst_assert_hardreset(). XXX This
3059 * function is scheduled for removal when the PRM code is moved into
3062 static int _am33xx_assert_hardreset(struct omap_hwmod
*oh
,
3063 struct omap_hwmod_rst_info
*ohri
)
3066 return omap_prm_assert_hardreset(ohri
->rst_shift
, 0,
3067 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
3068 oh
->prcm
.omap4
.rstctrl_offs
);
3072 * _am33xx_deassert_hardreset - call AM33XX PRM hardreset fn with hwmod args
3073 * @oh: struct omap_hwmod * to deassert hardreset
3074 * @ohri: hardreset line data
3076 * Call am33xx_prminst_deassert_hardreset() with parameters extracted
3077 * from the hwmod @oh and the hardreset line data @ohri. Only
3078 * intended for use as an soc_ops function pointer. Passes along the
3079 * return value from am33xx_prminst_deassert_hardreset(). XXX This
3080 * function is scheduled for removal when the PRM code is moved into
3083 static int _am33xx_deassert_hardreset(struct omap_hwmod
*oh
,
3084 struct omap_hwmod_rst_info
*ohri
)
3086 return omap_prm_deassert_hardreset(ohri
->rst_shift
, ohri
->st_shift
, 0,
3087 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
3088 oh
->prcm
.omap4
.rstctrl_offs
,
3089 oh
->prcm
.omap4
.rstst_offs
);
3093 * _am33xx_is_hardreset_asserted - call AM33XX PRM hardreset fn with hwmod args
3094 * @oh: struct omap_hwmod * to test hardreset
3095 * @ohri: hardreset line data
3097 * Call am33xx_prminst_is_hardreset_asserted() with parameters
3098 * extracted from the hwmod @oh and the hardreset line data @ohri.
3099 * Only intended for use as an soc_ops function pointer. Passes along
3100 * the return value from am33xx_prminst_is_hardreset_asserted(). XXX
3101 * This function is scheduled for removal when the PRM code is moved
3104 static int _am33xx_is_hardreset_asserted(struct omap_hwmod
*oh
,
3105 struct omap_hwmod_rst_info
*ohri
)
3107 return omap_prm_is_hardreset_asserted(ohri
->rst_shift
, 0,
3108 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
3109 oh
->prcm
.omap4
.rstctrl_offs
);
3112 /* Public functions */
3114 u32
omap_hwmod_read(struct omap_hwmod
*oh
, u16 reg_offs
)
3116 if (oh
->flags
& HWMOD_16BIT_REG
)
3117 return readw_relaxed(oh
->_mpu_rt_va
+ reg_offs
);
3119 return readl_relaxed(oh
->_mpu_rt_va
+ reg_offs
);
3122 void omap_hwmod_write(u32 v
, struct omap_hwmod
*oh
, u16 reg_offs
)
3124 if (oh
->flags
& HWMOD_16BIT_REG
)
3125 writew_relaxed(v
, oh
->_mpu_rt_va
+ reg_offs
);
3127 writel_relaxed(v
, oh
->_mpu_rt_va
+ reg_offs
);
3131 * omap_hwmod_softreset - reset a module via SYSCONFIG.SOFTRESET bit
3132 * @oh: struct omap_hwmod *
3134 * This is a public function exposed to drivers. Some drivers may need to do
3135 * some settings before and after resetting the device. Those drivers after
3136 * doing the necessary settings could use this function to start a reset by
3137 * setting the SYSCONFIG.SOFTRESET bit.
3139 int omap_hwmod_softreset(struct omap_hwmod
*oh
)
3144 if (!oh
|| !(oh
->_sysc_cache
))
3147 v
= oh
->_sysc_cache
;
3148 ret
= _set_softreset(oh
, &v
);
3151 _write_sysconfig(v
, oh
);
3153 ret
= _clear_softreset(oh
, &v
);
3156 _write_sysconfig(v
, oh
);
3163 * omap_hwmod_lookup - look up a registered omap_hwmod by name
3164 * @name: name of the omap_hwmod to look up
3166 * Given a @name of an omap_hwmod, return a pointer to the registered
3167 * struct omap_hwmod *, or NULL upon error.
3169 struct omap_hwmod
*omap_hwmod_lookup(const char *name
)
3171 struct omap_hwmod
*oh
;
3182 * omap_hwmod_for_each - call function for each registered omap_hwmod
3183 * @fn: pointer to a callback function
3184 * @data: void * data to pass to callback function
3186 * Call @fn for each registered omap_hwmod, passing @data to each
3187 * function. @fn must return 0 for success or any other value for
3188 * failure. If @fn returns non-zero, the iteration across omap_hwmods
3189 * will stop and the non-zero return value will be passed to the
3190 * caller of omap_hwmod_for_each(). @fn is called with
3191 * omap_hwmod_for_each() held.
3193 int omap_hwmod_for_each(int (*fn
)(struct omap_hwmod
*oh
, void *data
),
3196 struct omap_hwmod
*temp_oh
;
3202 list_for_each_entry(temp_oh
, &omap_hwmod_list
, node
) {
3203 ret
= (*fn
)(temp_oh
, data
);
3212 * omap_hwmod_register_links - register an array of hwmod links
3213 * @ois: pointer to an array of omap_hwmod_ocp_if to register
3215 * Intended to be called early in boot before the clock framework is
3216 * initialized. If @ois is not null, will register all omap_hwmods
3217 * listed in @ois that are valid for this chip. Returns -EINVAL if
3218 * omap_hwmod_init() hasn't been called before calling this function,
3219 * -ENOMEM if the link memory area can't be allocated, or 0 upon
3222 int __init
omap_hwmod_register_links(struct omap_hwmod_ocp_if
**ois
)
3232 if (ois
[0] == NULL
) /* Empty list */
3236 if (_alloc_linkspace(ois
)) {
3237 pr_err("omap_hwmod: could not allocate link space\n");
3244 r
= _register_link(ois
[i
]);
3245 WARN(r
&& r
!= -EEXIST
,
3246 "omap_hwmod: _register_link(%s -> %s) returned %d\n",
3247 ois
[i
]->master
->name
, ois
[i
]->slave
->name
, r
);
3254 * _ensure_mpu_hwmod_is_setup - ensure the MPU SS hwmod is init'ed and set up
3255 * @oh: pointer to the hwmod currently being set up (usually not the MPU)
3257 * If the hwmod data corresponding to the MPU subsystem IP block
3258 * hasn't been initialized and set up yet, do so now. This must be
3259 * done first since sleep dependencies may be added from other hwmods
3260 * to the MPU. Intended to be called only by omap_hwmod_setup*(). No
3263 static void __init
_ensure_mpu_hwmod_is_setup(struct omap_hwmod
*oh
)
3265 if (!mpu_oh
|| mpu_oh
->_state
== _HWMOD_STATE_UNKNOWN
)
3266 pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",
3267 __func__
, MPU_INITIATOR_NAME
);
3268 else if (mpu_oh
->_state
== _HWMOD_STATE_REGISTERED
&& oh
!= mpu_oh
)
3269 omap_hwmod_setup_one(MPU_INITIATOR_NAME
);
3273 * omap_hwmod_setup_one - set up a single hwmod
3274 * @oh_name: const char * name of the already-registered hwmod to set up
3276 * Initialize and set up a single hwmod. Intended to be used for a
3277 * small number of early devices, such as the timer IP blocks used for
3278 * the scheduler clock. Must be called after omap2_clk_init().
3279 * Resolves the struct clk names to struct clk pointers for each
3280 * registered omap_hwmod. Also calls _setup() on each hwmod. Returns
3281 * -EINVAL upon error or 0 upon success.
3283 int __init
omap_hwmod_setup_one(const char *oh_name
)
3285 struct omap_hwmod
*oh
;
3287 pr_debug("omap_hwmod: %s: %s\n", oh_name
, __func__
);
3289 oh
= _lookup(oh_name
);
3291 WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name
);
3295 _ensure_mpu_hwmod_is_setup(oh
);
3304 * omap_hwmod_setup_all - set up all registered IP blocks
3306 * Initialize and set up all IP blocks registered with the hwmod code.
3307 * Must be called after omap2_clk_init(). Resolves the struct clk
3308 * names to struct clk pointers for each registered omap_hwmod. Also
3309 * calls _setup() on each hwmod. Returns 0 upon success.
3311 static int __init
omap_hwmod_setup_all(void)
3313 _ensure_mpu_hwmod_is_setup(NULL
);
3315 omap_hwmod_for_each(_init
, NULL
);
3316 omap_hwmod_for_each(_setup
, NULL
);
3320 omap_core_initcall(omap_hwmod_setup_all
);
3323 * omap_hwmod_enable - enable an omap_hwmod
3324 * @oh: struct omap_hwmod *
3326 * Enable an omap_hwmod @oh. Intended to be called by omap_device_enable().
3327 * Returns -EINVAL on error or passes along the return value from _enable().
3329 int omap_hwmod_enable(struct omap_hwmod
*oh
)
3332 unsigned long flags
;
3337 spin_lock_irqsave(&oh
->_lock
, flags
);
3339 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3345 * omap_hwmod_idle - idle an omap_hwmod
3346 * @oh: struct omap_hwmod *
3348 * Idle an omap_hwmod @oh. Intended to be called by omap_device_idle().
3349 * Returns -EINVAL on error or passes along the return value from _idle().
3351 int omap_hwmod_idle(struct omap_hwmod
*oh
)
3353 unsigned long flags
;
3358 spin_lock_irqsave(&oh
->_lock
, flags
);
3360 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3366 * omap_hwmod_shutdown - shutdown an omap_hwmod
3367 * @oh: struct omap_hwmod *
3369 * Shutdown an omap_hwmod @oh. Intended to be called by
3370 * omap_device_shutdown(). Returns -EINVAL on error or passes along
3371 * the return value from _shutdown().
3373 int omap_hwmod_shutdown(struct omap_hwmod
*oh
)
3375 unsigned long flags
;
3380 spin_lock_irqsave(&oh
->_lock
, flags
);
3382 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3388 * omap_hwmod_enable_clocks - enable main_clk, all interface clocks
3389 * @oh: struct omap_hwmod *oh
3391 * Intended to be called by the omap_device code.
3393 int omap_hwmod_enable_clocks(struct omap_hwmod
*oh
)
3395 unsigned long flags
;
3397 spin_lock_irqsave(&oh
->_lock
, flags
);
3399 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3405 * omap_hwmod_disable_clocks - disable main_clk, all interface clocks
3406 * @oh: struct omap_hwmod *oh
3408 * Intended to be called by the omap_device code.
3410 int omap_hwmod_disable_clocks(struct omap_hwmod
*oh
)
3412 unsigned long flags
;
3414 spin_lock_irqsave(&oh
->_lock
, flags
);
3415 _disable_clocks(oh
);
3416 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3422 * omap_hwmod_ocp_barrier - wait for posted writes against the hwmod to complete
3423 * @oh: struct omap_hwmod *oh
3425 * Intended to be called by drivers and core code when all posted
3426 * writes to a device must complete before continuing further
3427 * execution (for example, after clearing some device IRQSTATUS
3430 * XXX what about targets with multiple OCP threads?
3432 void omap_hwmod_ocp_barrier(struct omap_hwmod
*oh
)
3436 if (!oh
->class->sysc
|| !oh
->class->sysc
->sysc_flags
) {
3437 WARN(1, "omap_device: %s: OCP barrier impossible due to device configuration\n",
3443 * Forces posted writes to complete on the OCP thread handling
3446 omap_hwmod_read(oh
, oh
->class->sysc
->sysc_offs
);
3450 * omap_hwmod_reset - reset the hwmod
3451 * @oh: struct omap_hwmod *
3453 * Under some conditions, a driver may wish to reset the entire device.
3454 * Called from omap_device code. Returns -EINVAL on error or passes along
3455 * the return value from _reset().
3457 int omap_hwmod_reset(struct omap_hwmod
*oh
)
3460 unsigned long flags
;
3465 spin_lock_irqsave(&oh
->_lock
, flags
);
3467 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3473 * IP block data retrieval functions
3477 * omap_hwmod_count_resources - count number of struct resources needed by hwmod
3478 * @oh: struct omap_hwmod *
3479 * @flags: Type of resources to include when counting (IRQ/DMA/MEM)
3481 * Count the number of struct resource array elements necessary to
3482 * contain omap_hwmod @oh resources. Intended to be called by code
3483 * that registers omap_devices. Intended to be used to determine the
3484 * size of a dynamically-allocated struct resource array, before
3485 * calling omap_hwmod_fill_resources(). Returns the number of struct
3486 * resource array elements needed.
3488 * XXX This code is not optimized. It could attempt to merge adjacent
3492 int omap_hwmod_count_resources(struct omap_hwmod
*oh
, unsigned long flags
)
3496 if (flags
& IORESOURCE_IRQ
)
3497 ret
+= _count_mpu_irqs(oh
);
3499 if (flags
& IORESOURCE_DMA
)
3500 ret
+= _count_sdma_reqs(oh
);
3502 if (flags
& IORESOURCE_MEM
) {
3504 struct omap_hwmod_ocp_if
*os
;
3505 struct list_head
*p
= oh
->slave_ports
.next
;
3507 while (i
< oh
->slaves_cnt
) {
3508 os
= _fetch_next_ocp_if(&p
, &i
);
3509 ret
+= _count_ocp_if_addr_spaces(os
);
3517 * omap_hwmod_fill_resources - fill struct resource array with hwmod data
3518 * @oh: struct omap_hwmod *
3519 * @res: pointer to the first element of an array of struct resource to fill
3521 * Fill the struct resource array @res with resource data from the
3522 * omap_hwmod @oh. Intended to be called by code that registers
3523 * omap_devices. See also omap_hwmod_count_resources(). Returns the
3524 * number of array elements filled.
3526 int omap_hwmod_fill_resources(struct omap_hwmod
*oh
, struct resource
*res
)
3528 struct omap_hwmod_ocp_if
*os
;
3529 struct list_head
*p
;
3530 int i
, j
, mpu_irqs_cnt
, sdma_reqs_cnt
, addr_cnt
;
3533 /* For each IRQ, DMA, memory area, fill in array.*/
3535 mpu_irqs_cnt
= _count_mpu_irqs(oh
);
3536 for (i
= 0; i
< mpu_irqs_cnt
; i
++) {
3540 irq
= oh
->xlate_irq((oh
->mpu_irqs
+ i
)->irq
);
3542 irq
= (oh
->mpu_irqs
+ i
)->irq
;
3543 (res
+ r
)->name
= (oh
->mpu_irqs
+ i
)->name
;
3544 (res
+ r
)->start
= irq
;
3545 (res
+ r
)->end
= irq
;
3546 (res
+ r
)->flags
= IORESOURCE_IRQ
;
3550 sdma_reqs_cnt
= _count_sdma_reqs(oh
);
3551 for (i
= 0; i
< sdma_reqs_cnt
; i
++) {
3552 (res
+ r
)->name
= (oh
->sdma_reqs
+ i
)->name
;
3553 (res
+ r
)->start
= (oh
->sdma_reqs
+ i
)->dma_req
;
3554 (res
+ r
)->end
= (oh
->sdma_reqs
+ i
)->dma_req
;
3555 (res
+ r
)->flags
= IORESOURCE_DMA
;
3559 p
= oh
->slave_ports
.next
;
3562 while (i
< oh
->slaves_cnt
) {
3563 os
= _fetch_next_ocp_if(&p
, &i
);
3564 addr_cnt
= _count_ocp_if_addr_spaces(os
);
3566 for (j
= 0; j
< addr_cnt
; j
++) {
3567 (res
+ r
)->name
= (os
->addr
+ j
)->name
;
3568 (res
+ r
)->start
= (os
->addr
+ j
)->pa_start
;
3569 (res
+ r
)->end
= (os
->addr
+ j
)->pa_end
;
3570 (res
+ r
)->flags
= IORESOURCE_MEM
;
3579 * omap_hwmod_fill_dma_resources - fill struct resource array with dma data
3580 * @oh: struct omap_hwmod *
3581 * @res: pointer to the array of struct resource to fill
3583 * Fill the struct resource array @res with dma resource data from the
3584 * omap_hwmod @oh. Intended to be called by code that registers
3585 * omap_devices. See also omap_hwmod_count_resources(). Returns the
3586 * number of array elements filled.
3588 int omap_hwmod_fill_dma_resources(struct omap_hwmod
*oh
, struct resource
*res
)
3590 int i
, sdma_reqs_cnt
;
3593 sdma_reqs_cnt
= _count_sdma_reqs(oh
);
3594 for (i
= 0; i
< sdma_reqs_cnt
; i
++) {
3595 (res
+ r
)->name
= (oh
->sdma_reqs
+ i
)->name
;
3596 (res
+ r
)->start
= (oh
->sdma_reqs
+ i
)->dma_req
;
3597 (res
+ r
)->end
= (oh
->sdma_reqs
+ i
)->dma_req
;
3598 (res
+ r
)->flags
= IORESOURCE_DMA
;
3606 * omap_hwmod_get_resource_byname - fetch IP block integration data by name
3607 * @oh: struct omap_hwmod * to operate on
3608 * @type: one of the IORESOURCE_* constants from include/linux/ioport.h
3609 * @name: pointer to the name of the data to fetch (optional)
3610 * @rsrc: pointer to a struct resource, allocated by the caller
3612 * Retrieve MPU IRQ, SDMA request line, or address space start/end
3613 * data for the IP block pointed to by @oh. The data will be filled
3614 * into a struct resource record pointed to by @rsrc. The struct
3615 * resource must be allocated by the caller. When @name is non-null,
3616 * the data associated with the matching entry in the IRQ/SDMA/address
3617 * space hwmod data arrays will be returned. If @name is null, the
3618 * first array entry will be returned. Data order is not meaningful
3619 * in hwmod data, so callers are strongly encouraged to use a non-null
3620 * @name whenever possible to avoid unpredictable effects if hwmod
3621 * data is later added that causes data ordering to change. This
3622 * function is only intended for use by OMAP core code. Device
3623 * drivers should not call this function - the appropriate bus-related
3624 * data accessor functions should be used instead. Returns 0 upon
3625 * success or a negative error code upon error.
3627 int omap_hwmod_get_resource_byname(struct omap_hwmod
*oh
, unsigned int type
,
3628 const char *name
, struct resource
*rsrc
)
3631 unsigned int irq
, dma
;
3632 u32 pa_start
, pa_end
;
3637 if (type
== IORESOURCE_IRQ
) {
3638 r
= _get_mpu_irq_by_name(oh
, name
, &irq
);
3644 } else if (type
== IORESOURCE_DMA
) {
3645 r
= _get_sdma_req_by_name(oh
, name
, &dma
);
3651 } else if (type
== IORESOURCE_MEM
) {
3652 r
= _get_addr_space_by_name(oh
, name
, &pa_start
, &pa_end
);
3656 rsrc
->start
= pa_start
;
3669 * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
3670 * @oh: struct omap_hwmod *
3672 * Return the powerdomain pointer associated with the OMAP module
3673 * @oh's main clock. If @oh does not have a main clk, return the
3674 * powerdomain associated with the interface clock associated with the
3675 * module's MPU port. (XXX Perhaps this should use the SDMA port
3676 * instead?) Returns NULL on error, or a struct powerdomain * on
3679 struct powerdomain
*omap_hwmod_get_pwrdm(struct omap_hwmod
*oh
)
3682 struct omap_hwmod_ocp_if
*oi
;
3683 struct clockdomain
*clkdm
;
3684 struct clk_hw_omap
*clk
;
3690 return oh
->clkdm
->pwrdm
.ptr
;
3695 oi
= _find_mpu_rt_port(oh
);
3701 clk
= to_clk_hw_omap(__clk_get_hw(c
));
3706 return clkdm
->pwrdm
.ptr
;
3710 * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
3711 * @oh: struct omap_hwmod *
3713 * Returns the virtual address corresponding to the beginning of the
3714 * module's register target, in the address range that is intended to
3715 * be used by the MPU. Returns the virtual address upon success or NULL
3718 void __iomem
*omap_hwmod_get_mpu_rt_va(struct omap_hwmod
*oh
)
3723 if (oh
->_int_flags
& _HWMOD_NO_MPU_PORT
)
3726 if (oh
->_state
== _HWMOD_STATE_UNKNOWN
)
3729 return oh
->_mpu_rt_va
;
3733 * omap_hwmod_add_initiator_dep - add sleepdep from @init_oh to @oh
3734 * @oh: struct omap_hwmod *
3735 * @init_oh: struct omap_hwmod * (initiator)
3737 * Add a sleep dependency between the initiator @init_oh and @oh.
3738 * Intended to be called by DSP/Bridge code via platform_data for the
3739 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
3740 * code needs to add/del initiator dependencies dynamically
3741 * before/after accessing a device. Returns the return value from
3742 * _add_initiator_dep().
3744 * XXX Keep a usecount in the clockdomain code
3746 int omap_hwmod_add_initiator_dep(struct omap_hwmod
*oh
,
3747 struct omap_hwmod
*init_oh
)
3749 return _add_initiator_dep(oh
, init_oh
);
3753 * XXX what about functions for drivers to save/restore ocp_sysconfig
3754 * for context save/restore operations?
3758 * omap_hwmod_del_initiator_dep - remove sleepdep from @init_oh to @oh
3759 * @oh: struct omap_hwmod *
3760 * @init_oh: struct omap_hwmod * (initiator)
3762 * Remove a sleep dependency between the initiator @init_oh and @oh.
3763 * Intended to be called by DSP/Bridge code via platform_data for the
3764 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
3765 * code needs to add/del initiator dependencies dynamically
3766 * before/after accessing a device. Returns the return value from
3767 * _del_initiator_dep().
3769 * XXX Keep a usecount in the clockdomain code
3771 int omap_hwmod_del_initiator_dep(struct omap_hwmod
*oh
,
3772 struct omap_hwmod
*init_oh
)
3774 return _del_initiator_dep(oh
, init_oh
);
3778 * omap_hwmod_enable_wakeup - allow device to wake up the system
3779 * @oh: struct omap_hwmod *
3781 * Sets the module OCP socket ENAWAKEUP bit to allow the module to
3782 * send wakeups to the PRCM, and enable I/O ring wakeup events for
3783 * this IP block if it has dynamic mux entries. Eventually this
3784 * should set PRCM wakeup registers to cause the PRCM to receive
3785 * wakeup events from the module. Does not set any wakeup routing
3786 * registers beyond this point - if the module is to wake up any other
3787 * module or subsystem, that must be set separately. Called by
3788 * omap_device code. Returns -EINVAL on error or 0 upon success.
3790 int omap_hwmod_enable_wakeup(struct omap_hwmod
*oh
)
3792 unsigned long flags
;
3795 spin_lock_irqsave(&oh
->_lock
, flags
);
3797 if (oh
->class->sysc
&&
3798 (oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
)) {
3799 v
= oh
->_sysc_cache
;
3800 _enable_wakeup(oh
, &v
);
3801 _write_sysconfig(v
, oh
);
3804 _set_idle_ioring_wakeup(oh
, true);
3805 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3811 * omap_hwmod_disable_wakeup - prevent device from waking the system
3812 * @oh: struct omap_hwmod *
3814 * Clears the module OCP socket ENAWAKEUP bit to prevent the module
3815 * from sending wakeups to the PRCM, and disable I/O ring wakeup
3816 * events for this IP block if it has dynamic mux entries. Eventually
3817 * this should clear PRCM wakeup registers to cause the PRCM to ignore
3818 * wakeup events from the module. Does not set any wakeup routing
3819 * registers beyond this point - if the module is to wake up any other
3820 * module or subsystem, that must be set separately. Called by
3821 * omap_device code. Returns -EINVAL on error or 0 upon success.
3823 int omap_hwmod_disable_wakeup(struct omap_hwmod
*oh
)
3825 unsigned long flags
;
3828 spin_lock_irqsave(&oh
->_lock
, flags
);
3830 if (oh
->class->sysc
&&
3831 (oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
)) {
3832 v
= oh
->_sysc_cache
;
3833 _disable_wakeup(oh
, &v
);
3834 _write_sysconfig(v
, oh
);
3837 _set_idle_ioring_wakeup(oh
, false);
3838 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3844 * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
3845 * contained in the hwmod module.
3846 * @oh: struct omap_hwmod *
3847 * @name: name of the reset line to lookup and assert
3849 * Some IP like dsp, ipu or iva contain processor that require
3850 * an HW reset line to be assert / deassert in order to enable fully
3851 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3852 * yet supported on this OMAP; otherwise, passes along the return value
3853 * from _assert_hardreset().
3855 int omap_hwmod_assert_hardreset(struct omap_hwmod
*oh
, const char *name
)
3858 unsigned long flags
;
3863 spin_lock_irqsave(&oh
->_lock
, flags
);
3864 ret
= _assert_hardreset(oh
, name
);
3865 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3871 * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
3872 * contained in the hwmod module.
3873 * @oh: struct omap_hwmod *
3874 * @name: name of the reset line to look up and deassert
3876 * Some IP like dsp, ipu or iva contain processor that require
3877 * an HW reset line to be assert / deassert in order to enable fully
3878 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3879 * yet supported on this OMAP; otherwise, passes along the return value
3880 * from _deassert_hardreset().
3882 int omap_hwmod_deassert_hardreset(struct omap_hwmod
*oh
, const char *name
)
3885 unsigned long flags
;
3890 spin_lock_irqsave(&oh
->_lock
, flags
);
3891 ret
= _deassert_hardreset(oh
, name
);
3892 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3898 * omap_hwmod_read_hardreset - read the HW reset line state of submodules
3899 * contained in the hwmod module
3900 * @oh: struct omap_hwmod *
3901 * @name: name of the reset line to look up and read
3903 * Return the current state of the hwmod @oh's reset line named @name:
3904 * returns -EINVAL upon parameter error or if this operation
3905 * is unsupported on the current OMAP; otherwise, passes along the return
3906 * value from _read_hardreset().
3908 int omap_hwmod_read_hardreset(struct omap_hwmod
*oh
, const char *name
)
3911 unsigned long flags
;
3916 spin_lock_irqsave(&oh
->_lock
, flags
);
3917 ret
= _read_hardreset(oh
, name
);
3918 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3925 * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
3926 * @classname: struct omap_hwmod_class name to search for
3927 * @fn: callback function pointer to call for each hwmod in class @classname
3928 * @user: arbitrary context data to pass to the callback function
3930 * For each omap_hwmod of class @classname, call @fn.
3931 * If the callback function returns something other than
3932 * zero, the iterator is terminated, and the callback function's return
3933 * value is passed back to the caller. Returns 0 upon success, -EINVAL
3934 * if @classname or @fn are NULL, or passes back the error code from @fn.
3936 int omap_hwmod_for_each_by_class(const char *classname
,
3937 int (*fn
)(struct omap_hwmod
*oh
,
3941 struct omap_hwmod
*temp_oh
;
3944 if (!classname
|| !fn
)
3947 pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
3948 __func__
, classname
);
3950 list_for_each_entry(temp_oh
, &omap_hwmod_list
, node
) {
3951 if (!strcmp(temp_oh
->class->name
, classname
)) {
3952 pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
3953 __func__
, temp_oh
->name
);
3954 ret
= (*fn
)(temp_oh
, user
);
3961 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
3968 * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
3969 * @oh: struct omap_hwmod *
3970 * @state: state that _setup() should leave the hwmod in
3972 * Sets the hwmod state that @oh will enter at the end of _setup()
3973 * (called by omap_hwmod_setup_*()). See also the documentation
3974 * for _setup_postsetup(), above. Returns 0 upon success or
3975 * -EINVAL if there is a problem with the arguments or if the hwmod is
3976 * in the wrong state.
3978 int omap_hwmod_set_postsetup_state(struct omap_hwmod
*oh
, u8 state
)
3981 unsigned long flags
;
3986 if (state
!= _HWMOD_STATE_DISABLED
&&
3987 state
!= _HWMOD_STATE_ENABLED
&&
3988 state
!= _HWMOD_STATE_IDLE
)
3991 spin_lock_irqsave(&oh
->_lock
, flags
);
3993 if (oh
->_state
!= _HWMOD_STATE_REGISTERED
) {
3998 oh
->_postsetup_state
= state
;
4002 spin_unlock_irqrestore(&oh
->_lock
, flags
);
4008 * omap_hwmod_get_context_loss_count - get lost context count
4009 * @oh: struct omap_hwmod *
4011 * Returns the context loss count of associated @oh
4012 * upon success, or zero if no context loss data is available.
4014 * On OMAP4, this queries the per-hwmod context loss register,
4015 * assuming one exists. If not, or on OMAP2/3, this queries the
4016 * enclosing powerdomain context loss count.
4018 int omap_hwmod_get_context_loss_count(struct omap_hwmod
*oh
)
4020 struct powerdomain
*pwrdm
;
4023 if (soc_ops
.get_context_lost
)
4024 return soc_ops
.get_context_lost(oh
);
4026 pwrdm
= omap_hwmod_get_pwrdm(oh
);
4028 ret
= pwrdm_get_context_loss_count(pwrdm
);
4034 * omap_hwmod_no_setup_reset - prevent a hwmod from being reset upon setup
4035 * @oh: struct omap_hwmod *
4037 * Prevent the hwmod @oh from being reset during the setup process.
4038 * Intended for use by board-*.c files on boards with devices that
4039 * cannot tolerate being reset. Must be called before the hwmod has
4040 * been set up. Returns 0 upon success or negative error code upon
4043 int omap_hwmod_no_setup_reset(struct omap_hwmod
*oh
)
4048 if (oh
->_state
!= _HWMOD_STATE_REGISTERED
) {
4049 pr_err("omap_hwmod: %s: cannot prevent setup reset; in wrong state\n",
4054 oh
->flags
|= HWMOD_INIT_NO_RESET
;
4060 * omap_hwmod_pad_route_irq - route an I/O pad wakeup to a particular MPU IRQ
4061 * @oh: struct omap_hwmod * containing hwmod mux entries
4062 * @pad_idx: array index in oh->mux of the hwmod mux entry to route wakeup
4063 * @irq_idx: the hwmod mpu_irqs array index of the IRQ to trigger on wakeup
4065 * When an I/O pad wakeup arrives for the dynamic or wakeup hwmod mux
4066 * entry number @pad_idx for the hwmod @oh, trigger the interrupt
4067 * service routine for the hwmod's mpu_irqs array index @irq_idx. If
4068 * this function is not called for a given pad_idx, then the ISR
4069 * associated with @oh's first MPU IRQ will be triggered when an I/O
4070 * pad wakeup occurs on that pad. Note that @pad_idx is the index of
4071 * the _dynamic or wakeup_ entry: if there are other entries not
4072 * marked with OMAP_DEVICE_PAD_WAKEUP or OMAP_DEVICE_PAD_REMUX, these
4073 * entries are NOT COUNTED in the dynamic pad index. This function
4074 * must be called separately for each pad that requires its interrupt
4075 * to be re-routed this way. Returns -EINVAL if there is an argument
4076 * problem or if @oh does not have hwmod mux entries or MPU IRQs;
4077 * returns -ENOMEM if memory cannot be allocated; or 0 upon success.
4079 * XXX This function interface is fragile. Rather than using array
4080 * indexes, which are subject to unpredictable change, it should be
4081 * using hwmod IRQ names, and some other stable key for the hwmod mux
4084 int omap_hwmod_pad_route_irq(struct omap_hwmod
*oh
, int pad_idx
, int irq_idx
)
4090 if (!oh
|| !oh
->mux
|| !oh
->mpu_irqs
|| pad_idx
< 0 ||
4091 pad_idx
>= oh
->mux
->nr_pads_dynamic
)
4094 /* Check the number of available mpu_irqs */
4095 for (nr_irqs
= 0; oh
->mpu_irqs
[nr_irqs
].irq
>= 0; nr_irqs
++)
4098 if (irq_idx
>= nr_irqs
)
4101 if (!oh
->mux
->irqs
) {
4102 /* XXX What frees this? */
4103 oh
->mux
->irqs
= kzalloc(sizeof(int) * oh
->mux
->nr_pads_dynamic
,
4108 oh
->mux
->irqs
[pad_idx
] = irq_idx
;
4114 * omap_hwmod_init - initialize the hwmod code
4116 * Sets up some function pointers needed by the hwmod code to operate on the
4117 * currently-booted SoC. Intended to be called once during kernel init
4118 * before any hwmods are registered. No return value.
4120 void __init
omap_hwmod_init(void)
4122 if (cpu_is_omap24xx()) {
4123 soc_ops
.wait_target_ready
= _omap2xxx_3xxx_wait_target_ready
;
4124 soc_ops
.assert_hardreset
= _omap2_assert_hardreset
;
4125 soc_ops
.deassert_hardreset
= _omap2_deassert_hardreset
;
4126 soc_ops
.is_hardreset_asserted
= _omap2_is_hardreset_asserted
;
4127 } else if (cpu_is_omap34xx()) {
4128 soc_ops
.wait_target_ready
= _omap2xxx_3xxx_wait_target_ready
;
4129 soc_ops
.assert_hardreset
= _omap2_assert_hardreset
;
4130 soc_ops
.deassert_hardreset
= _omap2_deassert_hardreset
;
4131 soc_ops
.is_hardreset_asserted
= _omap2_is_hardreset_asserted
;
4132 soc_ops
.init_clkdm
= _init_clkdm
;
4133 } else if (cpu_is_omap44xx() || soc_is_omap54xx() || soc_is_dra7xx()) {
4134 soc_ops
.enable_module
= _omap4_enable_module
;
4135 soc_ops
.disable_module
= _omap4_disable_module
;
4136 soc_ops
.wait_target_ready
= _omap4_wait_target_ready
;
4137 soc_ops
.assert_hardreset
= _omap4_assert_hardreset
;
4138 soc_ops
.deassert_hardreset
= _omap4_deassert_hardreset
;
4139 soc_ops
.is_hardreset_asserted
= _omap4_is_hardreset_asserted
;
4140 soc_ops
.init_clkdm
= _init_clkdm
;
4141 soc_ops
.update_context_lost
= _omap4_update_context_lost
;
4142 soc_ops
.get_context_lost
= _omap4_get_context_lost
;
4143 } else if (soc_is_am43xx()) {
4144 soc_ops
.enable_module
= _omap4_enable_module
;
4145 soc_ops
.disable_module
= _omap4_disable_module
;
4146 soc_ops
.wait_target_ready
= _omap4_wait_target_ready
;
4147 soc_ops
.assert_hardreset
= _omap4_assert_hardreset
;
4148 soc_ops
.deassert_hardreset
= _omap4_deassert_hardreset
;
4149 soc_ops
.is_hardreset_asserted
= _omap4_is_hardreset_asserted
;
4150 soc_ops
.init_clkdm
= _init_clkdm
;
4151 } else if (soc_is_am33xx()) {
4152 soc_ops
.enable_module
= _omap4_enable_module
;
4153 soc_ops
.disable_module
= _omap4_disable_module
;
4154 soc_ops
.wait_target_ready
= _omap4_wait_target_ready
;
4155 soc_ops
.assert_hardreset
= _am33xx_assert_hardreset
;
4156 soc_ops
.deassert_hardreset
= _am33xx_deassert_hardreset
;
4157 soc_ops
.is_hardreset_asserted
= _am33xx_is_hardreset_asserted
;
4158 soc_ops
.init_clkdm
= _init_clkdm
;
4160 WARN(1, "omap_hwmod: unknown SoC type\n");
4167 * omap_hwmod_get_main_clk - get pointer to main clock name
4168 * @oh: struct omap_hwmod *
4170 * Returns the main clock name assocated with @oh upon success,
4171 * or NULL if @oh is NULL.
4173 const char *omap_hwmod_get_main_clk(struct omap_hwmod
*oh
)
4178 return oh
->main_clk
;