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.h>
134 #include <linux/clk-provider.h>
135 #include <linux/delay.h>
136 #include <linux/err.h>
137 #include <linux/list.h>
138 #include <linux/mutex.h>
139 #include <linux/spinlock.h>
140 #include <linux/slab.h>
141 #include <linux/cpu.h>
142 #include <linux/of.h>
143 #include <linux/of_address.h>
144 #include <linux/bootmem.h>
146 #include <asm/system_misc.h>
149 #include "omap_hwmod.h"
153 #include "clockdomain.h"
154 #include "powerdomain.h"
162 #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 * Address offset (in bytes) between the reset control and the reset
176 * status registers: 4 bytes on OMAP4
178 #define OMAP4_RST_CTRL_ST_OFFSET 4
181 * Maximum length for module clock handle names
183 #define MOD_CLK_MAX_NAME_LEN 32
186 * struct clkctrl_provider - clkctrl provider mapping data
187 * @addr: base address for the provider
188 * @offset: base offset for the provider
189 * @clkdm: base clockdomain for provider
190 * @node: device node associated with the provider
193 struct clkctrl_provider
{
196 struct clockdomain
*clkdm
;
197 struct device_node
*node
;
198 struct list_head link
;
201 static LIST_HEAD(clkctrl_providers
);
204 * struct omap_hwmod_soc_ops - fn ptrs for some SoC-specific operations
205 * @enable_module: function to enable a module (via MODULEMODE)
206 * @disable_module: function to disable a module (via MODULEMODE)
208 * XXX Eventually this functionality will be hidden inside the PRM/CM
209 * device drivers. Until then, this should avoid huge blocks of cpu_is_*()
210 * conditionals in this code.
212 struct omap_hwmod_soc_ops
{
213 void (*enable_module
)(struct omap_hwmod
*oh
);
214 int (*disable_module
)(struct omap_hwmod
*oh
);
215 int (*wait_target_ready
)(struct omap_hwmod
*oh
);
216 int (*assert_hardreset
)(struct omap_hwmod
*oh
,
217 struct omap_hwmod_rst_info
*ohri
);
218 int (*deassert_hardreset
)(struct omap_hwmod
*oh
,
219 struct omap_hwmod_rst_info
*ohri
);
220 int (*is_hardreset_asserted
)(struct omap_hwmod
*oh
,
221 struct omap_hwmod_rst_info
*ohri
);
222 int (*init_clkdm
)(struct omap_hwmod
*oh
);
223 void (*update_context_lost
)(struct omap_hwmod
*oh
);
224 int (*get_context_lost
)(struct omap_hwmod
*oh
);
225 int (*disable_direct_prcm
)(struct omap_hwmod
*oh
);
226 u32 (*xlate_clkctrl
)(struct omap_hwmod
*oh
,
227 struct clkctrl_provider
*provider
);
230 /* soc_ops: adapts the omap_hwmod code to the currently-booted SoC */
231 static struct omap_hwmod_soc_ops soc_ops
;
233 /* omap_hwmod_list contains all registered struct omap_hwmods */
234 static LIST_HEAD(omap_hwmod_list
);
236 /* mpu_oh: used to add/remove MPU initiator from sleepdep list */
237 static struct omap_hwmod
*mpu_oh
;
239 /* inited: set to true once the hwmod code is initialized */
242 /* Private functions */
245 * _update_sysc_cache - return the module OCP_SYSCONFIG register, keep copy
246 * @oh: struct omap_hwmod *
248 * Load the current value of the hwmod OCP_SYSCONFIG register into the
249 * struct omap_hwmod for later use. Returns -EINVAL if the hwmod has no
250 * OCP_SYSCONFIG register or 0 upon success.
252 static int _update_sysc_cache(struct omap_hwmod
*oh
)
254 if (!oh
->class->sysc
) {
255 WARN(1, "omap_hwmod: %s: cannot read OCP_SYSCONFIG: not defined on hwmod's class\n", oh
->name
);
259 /* XXX ensure module interface clock is up */
261 oh
->_sysc_cache
= omap_hwmod_read(oh
, oh
->class->sysc
->sysc_offs
);
263 if (!(oh
->class->sysc
->sysc_flags
& SYSC_NO_CACHE
))
264 oh
->_int_flags
|= _HWMOD_SYSCONFIG_LOADED
;
270 * _write_sysconfig - write a value to the module's OCP_SYSCONFIG register
271 * @v: OCP_SYSCONFIG value to write
272 * @oh: struct omap_hwmod *
274 * Write @v into the module class' OCP_SYSCONFIG register, if it has
275 * one. No return value.
277 static void _write_sysconfig(u32 v
, struct omap_hwmod
*oh
)
279 if (!oh
->class->sysc
) {
280 WARN(1, "omap_hwmod: %s: cannot write OCP_SYSCONFIG: not defined on hwmod's class\n", oh
->name
);
284 /* XXX ensure module interface clock is up */
286 /* Module might have lost context, always update cache and register */
290 * Some IP blocks (such as RTC) require unlocking of IP before
291 * accessing its registers. If a function pointer is present
292 * to unlock, then call it before accessing sysconfig and
293 * call lock after writing sysconfig.
295 if (oh
->class->unlock
)
296 oh
->class->unlock(oh
);
298 omap_hwmod_write(v
, oh
, oh
->class->sysc
->sysc_offs
);
305 * _set_master_standbymode: set the OCP_SYSCONFIG MIDLEMODE field in @v
306 * @oh: struct omap_hwmod *
307 * @standbymode: MIDLEMODE field bits
308 * @v: pointer to register contents to modify
310 * Update the master standby mode bits in @v to be @standbymode for
311 * the @oh hwmod. Does not write to the hardware. Returns -EINVAL
312 * upon error or 0 upon success.
314 static int _set_master_standbymode(struct omap_hwmod
*oh
, u8 standbymode
,
320 if (!oh
->class->sysc
||
321 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_MIDLEMODE
))
324 if (!oh
->class->sysc
->sysc_fields
) {
325 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
329 mstandby_shift
= oh
->class->sysc
->sysc_fields
->midle_shift
;
330 mstandby_mask
= (0x3 << mstandby_shift
);
332 *v
&= ~mstandby_mask
;
333 *v
|= __ffs(standbymode
) << mstandby_shift
;
339 * _set_slave_idlemode: set the OCP_SYSCONFIG SIDLEMODE field in @v
340 * @oh: struct omap_hwmod *
341 * @idlemode: SIDLEMODE field bits
342 * @v: pointer to register contents to modify
344 * Update the slave idle mode bits in @v to be @idlemode for the @oh
345 * hwmod. Does not write to the hardware. Returns -EINVAL upon error
348 static int _set_slave_idlemode(struct omap_hwmod
*oh
, u8 idlemode
, u32
*v
)
353 if (!oh
->class->sysc
||
354 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_SIDLEMODE
))
357 if (!oh
->class->sysc
->sysc_fields
) {
358 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
362 sidle_shift
= oh
->class->sysc
->sysc_fields
->sidle_shift
;
363 sidle_mask
= (0x3 << sidle_shift
);
366 *v
|= __ffs(idlemode
) << sidle_shift
;
372 * _set_clockactivity: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
373 * @oh: struct omap_hwmod *
374 * @clockact: CLOCKACTIVITY field bits
375 * @v: pointer to register contents to modify
377 * Update the clockactivity mode bits in @v to be @clockact for the
378 * @oh hwmod. Used for additional powersaving on some modules. Does
379 * not write to the hardware. Returns -EINVAL upon error or 0 upon
382 static int _set_clockactivity(struct omap_hwmod
*oh
, u8 clockact
, u32
*v
)
387 if (!oh
->class->sysc
||
388 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_CLOCKACTIVITY
))
391 if (!oh
->class->sysc
->sysc_fields
) {
392 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
396 clkact_shift
= oh
->class->sysc
->sysc_fields
->clkact_shift
;
397 clkact_mask
= (0x3 << clkact_shift
);
400 *v
|= clockact
<< clkact_shift
;
406 * _set_softreset: set OCP_SYSCONFIG.SOFTRESET bit in @v
407 * @oh: struct omap_hwmod *
408 * @v: pointer to register contents to modify
410 * Set the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
411 * error or 0 upon success.
413 static int _set_softreset(struct omap_hwmod
*oh
, u32
*v
)
417 if (!oh
->class->sysc
||
418 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_SOFTRESET
))
421 if (!oh
->class->sysc
->sysc_fields
) {
422 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
426 softrst_mask
= (0x1 << oh
->class->sysc
->sysc_fields
->srst_shift
);
434 * _clear_softreset: clear OCP_SYSCONFIG.SOFTRESET bit in @v
435 * @oh: struct omap_hwmod *
436 * @v: pointer to register contents to modify
438 * Clear the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
439 * error or 0 upon success.
441 static int _clear_softreset(struct omap_hwmod
*oh
, u32
*v
)
445 if (!oh
->class->sysc
||
446 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_SOFTRESET
))
449 if (!oh
->class->sysc
->sysc_fields
) {
451 "omap_hwmod: %s: sysc_fields absent for sysconfig class\n",
456 softrst_mask
= (0x1 << oh
->class->sysc
->sysc_fields
->srst_shift
);
464 * _wait_softreset_complete - wait for an OCP softreset to complete
465 * @oh: struct omap_hwmod * to wait on
467 * Wait until the IP block represented by @oh reports that its OCP
468 * softreset is complete. This can be triggered by software (see
469 * _ocp_softreset()) or by hardware upon returning from off-mode (one
470 * example is HSMMC). Waits for up to MAX_MODULE_SOFTRESET_WAIT
471 * microseconds. Returns the number of microseconds waited.
473 static int _wait_softreset_complete(struct omap_hwmod
*oh
)
475 struct omap_hwmod_class_sysconfig
*sysc
;
479 sysc
= oh
->class->sysc
;
481 if (sysc
->sysc_flags
& SYSS_HAS_RESET_STATUS
)
482 omap_test_timeout((omap_hwmod_read(oh
, sysc
->syss_offs
)
483 & SYSS_RESETDONE_MASK
),
484 MAX_MODULE_SOFTRESET_WAIT
, c
);
485 else if (sysc
->sysc_flags
& SYSC_HAS_RESET_STATUS
) {
486 softrst_mask
= (0x1 << sysc
->sysc_fields
->srst_shift
);
487 omap_test_timeout(!(omap_hwmod_read(oh
, sysc
->sysc_offs
)
489 MAX_MODULE_SOFTRESET_WAIT
, c
);
496 * _set_dmadisable: set OCP_SYSCONFIG.DMADISABLE bit in @v
497 * @oh: struct omap_hwmod *
499 * The DMADISABLE bit is a semi-automatic bit present in sysconfig register
500 * of some modules. When the DMA must perform read/write accesses, the
501 * DMADISABLE bit is cleared by the hardware. But when the DMA must stop
502 * for power management, software must set the DMADISABLE bit back to 1.
504 * Set the DMADISABLE bit in @v for hwmod @oh. Returns -EINVAL upon
505 * error or 0 upon success.
507 static int _set_dmadisable(struct omap_hwmod
*oh
)
512 if (!oh
->class->sysc
||
513 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_DMADISABLE
))
516 if (!oh
->class->sysc
->sysc_fields
) {
517 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
521 /* clocks must be on for this operation */
522 if (oh
->_state
!= _HWMOD_STATE_ENABLED
) {
523 pr_warn("omap_hwmod: %s: dma can be disabled only from enabled state\n", oh
->name
);
527 pr_debug("omap_hwmod: %s: setting DMADISABLE\n", oh
->name
);
531 (0x1 << oh
->class->sysc
->sysc_fields
->dmadisable_shift
);
532 v
|= dmadisable_mask
;
533 _write_sysconfig(v
, oh
);
539 * _set_module_autoidle: set the OCP_SYSCONFIG AUTOIDLE field in @v
540 * @oh: struct omap_hwmod *
541 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
542 * @v: pointer to register contents to modify
544 * Update the module autoidle bit in @v to be @autoidle for the @oh
545 * hwmod. The autoidle bit controls whether the module can gate
546 * internal clocks automatically when it isn't doing anything; the
547 * exact function of this bit varies on a per-module basis. This
548 * function does not write to the hardware. Returns -EINVAL upon
549 * error or 0 upon success.
551 static int _set_module_autoidle(struct omap_hwmod
*oh
, u8 autoidle
,
557 if (!oh
->class->sysc
||
558 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_AUTOIDLE
))
561 if (!oh
->class->sysc
->sysc_fields
) {
562 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
566 autoidle_shift
= oh
->class->sysc
->sysc_fields
->autoidle_shift
;
567 autoidle_mask
= (0x1 << autoidle_shift
);
569 *v
&= ~autoidle_mask
;
570 *v
|= autoidle
<< autoidle_shift
;
576 * _enable_wakeup: set OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
577 * @oh: struct omap_hwmod *
579 * Allow the hardware module @oh to send wakeups. Returns -EINVAL
580 * upon error or 0 upon success.
582 static int _enable_wakeup(struct omap_hwmod
*oh
, u32
*v
)
584 if (!oh
->class->sysc
||
585 !((oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
) ||
586 (oh
->class->sysc
->idlemodes
& SIDLE_SMART_WKUP
) ||
587 (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)))
590 if (!oh
->class->sysc
->sysc_fields
) {
591 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
595 if (oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
)
596 *v
|= 0x1 << oh
->class->sysc
->sysc_fields
->enwkup_shift
;
598 if (oh
->class->sysc
->idlemodes
& SIDLE_SMART_WKUP
)
599 _set_slave_idlemode(oh
, HWMOD_IDLEMODE_SMART_WKUP
, v
);
600 if (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)
601 _set_master_standbymode(oh
, HWMOD_IDLEMODE_SMART_WKUP
, v
);
603 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
609 * _disable_wakeup: clear OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
610 * @oh: struct omap_hwmod *
612 * Prevent the hardware module @oh to send wakeups. Returns -EINVAL
613 * upon error or 0 upon success.
615 static int _disable_wakeup(struct omap_hwmod
*oh
, u32
*v
)
617 if (!oh
->class->sysc
||
618 !((oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
) ||
619 (oh
->class->sysc
->idlemodes
& SIDLE_SMART_WKUP
) ||
620 (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)))
623 if (!oh
->class->sysc
->sysc_fields
) {
624 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
628 if (oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
)
629 *v
&= ~(0x1 << oh
->class->sysc
->sysc_fields
->enwkup_shift
);
631 if (oh
->class->sysc
->idlemodes
& SIDLE_SMART_WKUP
)
632 _set_slave_idlemode(oh
, HWMOD_IDLEMODE_SMART
, v
);
633 if (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)
634 _set_master_standbymode(oh
, HWMOD_IDLEMODE_SMART
, v
);
636 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
641 static struct clockdomain
*_get_clkdm(struct omap_hwmod
*oh
)
643 struct clk_hw_omap
*clk
;
647 } else if (oh
->_clk
) {
648 if (__clk_get_flags(oh
->_clk
) & CLK_IS_BASIC
)
650 clk
= to_clk_hw_omap(__clk_get_hw(oh
->_clk
));
657 * _add_initiator_dep: prevent @oh from smart-idling while @init_oh is active
658 * @oh: struct omap_hwmod *
660 * Prevent the hardware module @oh from entering idle while the
661 * hardare module initiator @init_oh is active. Useful when a module
662 * will be accessed by a particular initiator (e.g., if a module will
663 * be accessed by the IVA, there should be a sleepdep between the IVA
664 * initiator and the module). Only applies to modules in smart-idle
665 * mode. If the clockdomain is marked as not needing autodeps, return
666 * 0 without doing anything. Otherwise, returns -EINVAL upon error or
667 * passes along clkdm_add_sleepdep() value upon success.
669 static int _add_initiator_dep(struct omap_hwmod
*oh
, struct omap_hwmod
*init_oh
)
671 struct clockdomain
*clkdm
, *init_clkdm
;
673 clkdm
= _get_clkdm(oh
);
674 init_clkdm
= _get_clkdm(init_oh
);
676 if (!clkdm
|| !init_clkdm
)
679 if (clkdm
&& clkdm
->flags
& CLKDM_NO_AUTODEPS
)
682 return clkdm_add_sleepdep(clkdm
, init_clkdm
);
686 * _del_initiator_dep: allow @oh to smart-idle even if @init_oh is active
687 * @oh: struct omap_hwmod *
689 * Allow the hardware module @oh to enter idle while the hardare
690 * module initiator @init_oh is active. Useful when a module will not
691 * be accessed by a particular initiator (e.g., if a module will not
692 * be accessed by the IVA, there should be no sleepdep between the IVA
693 * initiator and the module). Only applies to modules in smart-idle
694 * mode. If the clockdomain is marked as not needing autodeps, return
695 * 0 without doing anything. Returns -EINVAL upon error or passes
696 * along clkdm_del_sleepdep() value upon success.
698 static int _del_initiator_dep(struct omap_hwmod
*oh
, struct omap_hwmod
*init_oh
)
700 struct clockdomain
*clkdm
, *init_clkdm
;
702 clkdm
= _get_clkdm(oh
);
703 init_clkdm
= _get_clkdm(init_oh
);
705 if (!clkdm
|| !init_clkdm
)
708 if (clkdm
&& clkdm
->flags
& CLKDM_NO_AUTODEPS
)
711 return clkdm_del_sleepdep(clkdm
, init_clkdm
);
714 static const struct of_device_id ti_clkctrl_match_table
[] __initconst
= {
715 { .compatible
= "ti,clkctrl" },
719 static int _match_clkdm(struct clockdomain
*clkdm
, void *user
)
721 struct clkctrl_provider
*provider
= user
;
723 if (clkdm_xlate_address(clkdm
) == provider
->addr
) {
724 pr_debug("%s: Matched clkdm %s for addr %x (%s)\n", __func__
,
725 clkdm
->name
, provider
->addr
,
726 provider
->node
->parent
->name
);
727 provider
->clkdm
= clkdm
;
735 static int _setup_clkctrl_provider(struct device_node
*np
)
738 struct clkctrl_provider
*provider
;
740 provider
= memblock_virt_alloc(sizeof(*provider
), 0);
744 addrp
= of_get_address(np
, 0, NULL
, NULL
);
745 provider
->addr
= (u32
)of_translate_address(np
, addrp
);
746 provider
->offset
= provider
->addr
& 0xff;
747 provider
->addr
&= ~0xff;
750 clkdm_for_each(_match_clkdm
, provider
);
752 if (!provider
->clkdm
) {
753 pr_err("%s: nothing matched for node %s (%x)\n",
754 __func__
, np
->parent
->name
, provider
->addr
);
755 memblock_free_early(__pa(provider
), sizeof(*provider
));
759 list_add(&provider
->link
, &clkctrl_providers
);
764 static int _init_clkctrl_providers(void)
766 struct device_node
*np
;
769 for_each_matching_node(np
, ti_clkctrl_match_table
) {
770 ret
= _setup_clkctrl_provider(np
);
778 static u32
_omap4_xlate_clkctrl(struct omap_hwmod
*oh
,
779 struct clkctrl_provider
*provider
)
781 return oh
->prcm
.omap4
.clkctrl_offs
-
782 provider
->offset
- provider
->clkdm
->clkdm_offs
;
785 static struct clk
*_lookup_clkctrl_clk(struct omap_hwmod
*oh
)
787 struct clkctrl_provider
*provider
;
790 if (!soc_ops
.xlate_clkctrl
)
793 list_for_each_entry(provider
, &clkctrl_providers
, link
) {
794 if (provider
->clkdm
== oh
->clkdm
) {
795 struct of_phandle_args clkspec
;
797 clkspec
.np
= provider
->node
;
798 clkspec
.args_count
= 2;
799 clkspec
.args
[0] = soc_ops
.xlate_clkctrl(oh
, provider
);
802 clk
= of_clk_get_from_provider(&clkspec
);
812 * _init_main_clk - get a struct clk * for the the hwmod's main functional clk
813 * @oh: struct omap_hwmod *
815 * Called from _init_clocks(). Populates the @oh _clk (main
816 * functional clock pointer) if a clock matching the hwmod name is found,
817 * or a main_clk is present. Returns 0 on success or -EINVAL on error.
819 static int _init_main_clk(struct omap_hwmod
*oh
)
822 struct clk
*clk
= NULL
;
824 clk
= _lookup_clkctrl_clk(oh
);
826 if (!IS_ERR_OR_NULL(clk
)) {
827 pr_debug("%s: mapped main_clk %s for %s\n", __func__
,
828 __clk_get_name(clk
), oh
->name
);
829 oh
->main_clk
= __clk_get_name(clk
);
831 soc_ops
.disable_direct_prcm(oh
);
836 oh
->_clk
= clk_get(NULL
, oh
->main_clk
);
839 if (IS_ERR(oh
->_clk
)) {
840 pr_warn("omap_hwmod: %s: cannot clk_get main_clk %s\n",
841 oh
->name
, oh
->main_clk
);
845 * HACK: This needs a re-visit once clk_prepare() is implemented
846 * to do something meaningful. Today its just a no-op.
847 * If clk_prepare() is used at some point to do things like
848 * voltage scaling etc, then this would have to be moved to
849 * some point where subsystems like i2c and pmic become
852 clk_prepare(oh
->_clk
);
855 pr_debug("omap_hwmod: %s: missing clockdomain for %s.\n",
856 oh
->name
, oh
->main_clk
);
862 * _init_interface_clks - get a struct clk * for the the hwmod's interface clks
863 * @oh: struct omap_hwmod *
865 * Called from _init_clocks(). Populates the @oh OCP slave interface
866 * clock pointers. Returns 0 on success or -EINVAL on error.
868 static int _init_interface_clks(struct omap_hwmod
*oh
)
870 struct omap_hwmod_ocp_if
*os
;
874 list_for_each_entry(os
, &oh
->slave_ports
, node
) {
878 c
= clk_get(NULL
, os
->clk
);
880 pr_warn("omap_hwmod: %s: cannot clk_get interface_clk %s\n",
887 * HACK: This needs a re-visit once clk_prepare() is implemented
888 * to do something meaningful. Today its just a no-op.
889 * If clk_prepare() is used at some point to do things like
890 * voltage scaling etc, then this would have to be moved to
891 * some point where subsystems like i2c and pmic become
894 clk_prepare(os
->_clk
);
901 * _init_opt_clk - get a struct clk * for the the hwmod's optional clocks
902 * @oh: struct omap_hwmod *
904 * Called from _init_clocks(). Populates the @oh omap_hwmod_opt_clk
905 * clock pointers. Returns 0 on success or -EINVAL on error.
907 static int _init_opt_clks(struct omap_hwmod
*oh
)
909 struct omap_hwmod_opt_clk
*oc
;
914 for (i
= oh
->opt_clks_cnt
, oc
= oh
->opt_clks
; i
> 0; i
--, oc
++) {
915 c
= clk_get(NULL
, oc
->clk
);
917 pr_warn("omap_hwmod: %s: cannot clk_get opt_clk %s\n",
924 * HACK: This needs a re-visit once clk_prepare() is implemented
925 * to do something meaningful. Today its just a no-op.
926 * If clk_prepare() is used at some point to do things like
927 * voltage scaling etc, then this would have to be moved to
928 * some point where subsystems like i2c and pmic become
931 clk_prepare(oc
->_clk
);
937 static void _enable_optional_clocks(struct omap_hwmod
*oh
)
939 struct omap_hwmod_opt_clk
*oc
;
942 pr_debug("omap_hwmod: %s: enabling optional clocks\n", oh
->name
);
944 for (i
= oh
->opt_clks_cnt
, oc
= oh
->opt_clks
; i
> 0; i
--, oc
++)
946 pr_debug("omap_hwmod: enable %s:%s\n", oc
->role
,
947 __clk_get_name(oc
->_clk
));
948 clk_enable(oc
->_clk
);
952 static void _disable_optional_clocks(struct omap_hwmod
*oh
)
954 struct omap_hwmod_opt_clk
*oc
;
957 pr_debug("omap_hwmod: %s: disabling optional clocks\n", oh
->name
);
959 for (i
= oh
->opt_clks_cnt
, oc
= oh
->opt_clks
; i
> 0; i
--, oc
++)
961 pr_debug("omap_hwmod: disable %s:%s\n", oc
->role
,
962 __clk_get_name(oc
->_clk
));
963 clk_disable(oc
->_clk
);
968 * _enable_clocks - enable hwmod main clock and interface clocks
969 * @oh: struct omap_hwmod *
971 * Enables all clocks necessary for register reads and writes to succeed
972 * on the hwmod @oh. Returns 0.
974 static int _enable_clocks(struct omap_hwmod
*oh
)
976 struct omap_hwmod_ocp_if
*os
;
978 pr_debug("omap_hwmod: %s: enabling clocks\n", oh
->name
);
981 clk_enable(oh
->_clk
);
983 list_for_each_entry(os
, &oh
->slave_ports
, node
) {
984 if (os
->_clk
&& (os
->flags
& OCPIF_SWSUP_IDLE
))
985 clk_enable(os
->_clk
);
988 if (oh
->flags
& HWMOD_OPT_CLKS_NEEDED
)
989 _enable_optional_clocks(oh
);
991 /* The opt clocks are controlled by the device driver. */
997 * _omap4_clkctrl_managed_by_clkfwk - true if clkctrl managed by clock framework
998 * @oh: struct omap_hwmod *
1000 static bool _omap4_clkctrl_managed_by_clkfwk(struct omap_hwmod
*oh
)
1002 if (oh
->prcm
.omap4
.flags
& HWMOD_OMAP4_CLKFWK_CLKCTR_CLOCK
)
1009 * _omap4_has_clkctrl_clock - returns true if a module has clkctrl clock
1010 * @oh: struct omap_hwmod *
1012 static bool _omap4_has_clkctrl_clock(struct omap_hwmod
*oh
)
1014 if (oh
->prcm
.omap4
.clkctrl_offs
)
1017 if (!oh
->prcm
.omap4
.clkctrl_offs
&&
1018 oh
->prcm
.omap4
.flags
& HWMOD_OMAP4_ZERO_CLKCTRL_OFFSET
)
1025 * _disable_clocks - disable hwmod main clock and interface clocks
1026 * @oh: struct omap_hwmod *
1028 * Disables the hwmod @oh main functional and interface clocks. Returns 0.
1030 static int _disable_clocks(struct omap_hwmod
*oh
)
1032 struct omap_hwmod_ocp_if
*os
;
1034 pr_debug("omap_hwmod: %s: disabling clocks\n", oh
->name
);
1037 clk_disable(oh
->_clk
);
1039 list_for_each_entry(os
, &oh
->slave_ports
, node
) {
1040 if (os
->_clk
&& (os
->flags
& OCPIF_SWSUP_IDLE
))
1041 clk_disable(os
->_clk
);
1044 if (oh
->flags
& HWMOD_OPT_CLKS_NEEDED
)
1045 _disable_optional_clocks(oh
);
1047 /* The opt clocks are controlled by the device driver. */
1053 * _omap4_enable_module - enable CLKCTRL modulemode on OMAP4
1054 * @oh: struct omap_hwmod *
1056 * Enables the PRCM module mode related to the hwmod @oh.
1059 static void _omap4_enable_module(struct omap_hwmod
*oh
)
1061 if (!oh
->clkdm
|| !oh
->prcm
.omap4
.modulemode
||
1062 _omap4_clkctrl_managed_by_clkfwk(oh
))
1065 pr_debug("omap_hwmod: %s: %s: %d\n",
1066 oh
->name
, __func__
, oh
->prcm
.omap4
.modulemode
);
1068 omap_cm_module_enable(oh
->prcm
.omap4
.modulemode
,
1069 oh
->clkdm
->prcm_partition
,
1070 oh
->clkdm
->cm_inst
, oh
->prcm
.omap4
.clkctrl_offs
);
1074 * _omap4_wait_target_disable - wait for a module to be disabled on OMAP4
1075 * @oh: struct omap_hwmod *
1077 * Wait for a module @oh to enter slave idle. Returns 0 if the module
1078 * does not have an IDLEST bit or if the module successfully enters
1079 * slave idle; otherwise, pass along the return value of the
1080 * appropriate *_cm*_wait_module_idle() function.
1082 static int _omap4_wait_target_disable(struct omap_hwmod
*oh
)
1087 if (oh
->_int_flags
& _HWMOD_NO_MPU_PORT
|| !oh
->clkdm
)
1090 if (oh
->flags
& HWMOD_NO_IDLEST
)
1093 if (_omap4_clkctrl_managed_by_clkfwk(oh
))
1096 if (!_omap4_has_clkctrl_clock(oh
))
1099 return omap_cm_wait_module_idle(oh
->clkdm
->prcm_partition
,
1101 oh
->prcm
.omap4
.clkctrl_offs
, 0);
1105 * _save_mpu_port_index - find and save the index to @oh's MPU port
1106 * @oh: struct omap_hwmod *
1108 * Determines the array index of the OCP slave port that the MPU uses
1109 * to address the device, and saves it into the struct omap_hwmod.
1110 * Intended to be called during hwmod registration only. No return
1113 static void __init
_save_mpu_port_index(struct omap_hwmod
*oh
)
1115 struct omap_hwmod_ocp_if
*os
= NULL
;
1120 oh
->_int_flags
|= _HWMOD_NO_MPU_PORT
;
1122 list_for_each_entry(os
, &oh
->slave_ports
, node
) {
1123 if (os
->user
& OCP_USER_MPU
) {
1125 oh
->_int_flags
&= ~_HWMOD_NO_MPU_PORT
;
1134 * _find_mpu_rt_port - return omap_hwmod_ocp_if accessible by the MPU
1135 * @oh: struct omap_hwmod *
1137 * Given a pointer to a struct omap_hwmod record @oh, return a pointer
1138 * to the struct omap_hwmod_ocp_if record that is used by the MPU to
1139 * communicate with the IP block. This interface need not be directly
1140 * connected to the MPU (and almost certainly is not), but is directly
1141 * connected to the IP block represented by @oh. Returns a pointer
1142 * to the struct omap_hwmod_ocp_if * upon success, or returns NULL upon
1143 * error or if there does not appear to be a path from the MPU to this
1146 static struct omap_hwmod_ocp_if
*_find_mpu_rt_port(struct omap_hwmod
*oh
)
1148 if (!oh
|| oh
->_int_flags
& _HWMOD_NO_MPU_PORT
|| oh
->slaves_cnt
== 0)
1151 return oh
->_mpu_port
;
1155 * _enable_sysc - try to bring a module out of idle via OCP_SYSCONFIG
1156 * @oh: struct omap_hwmod *
1158 * Ensure that the OCP_SYSCONFIG register for the IP block represented
1159 * by @oh is set to indicate to the PRCM that the IP block is active.
1160 * Usually this means placing the module into smart-idle mode and
1161 * smart-standby, but if there is a bug in the automatic idle handling
1162 * for the IP block, it may need to be placed into the force-idle or
1163 * no-idle variants of these modes. No return value.
1165 static void _enable_sysc(struct omap_hwmod
*oh
)
1170 struct clockdomain
*clkdm
;
1172 if (!oh
->class->sysc
)
1176 * Wait until reset has completed, this is needed as the IP
1177 * block is reset automatically by hardware in some cases
1178 * (off-mode for example), and the drivers require the
1179 * IP to be ready when they access it
1181 if (oh
->flags
& HWMOD_CONTROL_OPT_CLKS_IN_RESET
)
1182 _enable_optional_clocks(oh
);
1183 _wait_softreset_complete(oh
);
1184 if (oh
->flags
& HWMOD_CONTROL_OPT_CLKS_IN_RESET
)
1185 _disable_optional_clocks(oh
);
1187 v
= oh
->_sysc_cache
;
1188 sf
= oh
->class->sysc
->sysc_flags
;
1190 clkdm
= _get_clkdm(oh
);
1191 if (sf
& SYSC_HAS_SIDLEMODE
) {
1192 if (oh
->flags
& HWMOD_SWSUP_SIDLE
||
1193 oh
->flags
& HWMOD_SWSUP_SIDLE_ACT
) {
1194 idlemode
= HWMOD_IDLEMODE_NO
;
1196 if (sf
& SYSC_HAS_ENAWAKEUP
)
1197 _enable_wakeup(oh
, &v
);
1198 if (oh
->class->sysc
->idlemodes
& SIDLE_SMART_WKUP
)
1199 idlemode
= HWMOD_IDLEMODE_SMART_WKUP
;
1201 idlemode
= HWMOD_IDLEMODE_SMART
;
1205 * This is special handling for some IPs like
1206 * 32k sync timer. Force them to idle!
1208 clkdm_act
= (clkdm
&& clkdm
->flags
& CLKDM_ACTIVE_WITH_MPU
);
1209 if (clkdm_act
&& !(oh
->class->sysc
->idlemodes
&
1210 (SIDLE_SMART
| SIDLE_SMART_WKUP
)))
1211 idlemode
= HWMOD_IDLEMODE_FORCE
;
1213 _set_slave_idlemode(oh
, idlemode
, &v
);
1216 if (sf
& SYSC_HAS_MIDLEMODE
) {
1217 if (oh
->flags
& HWMOD_FORCE_MSTANDBY
) {
1218 idlemode
= HWMOD_IDLEMODE_FORCE
;
1219 } else if (oh
->flags
& HWMOD_SWSUP_MSTANDBY
) {
1220 idlemode
= HWMOD_IDLEMODE_NO
;
1222 if (sf
& SYSC_HAS_ENAWAKEUP
)
1223 _enable_wakeup(oh
, &v
);
1224 if (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)
1225 idlemode
= HWMOD_IDLEMODE_SMART_WKUP
;
1227 idlemode
= HWMOD_IDLEMODE_SMART
;
1229 _set_master_standbymode(oh
, idlemode
, &v
);
1233 * XXX The clock framework should handle this, by
1234 * calling into this code. But this must wait until the
1235 * clock structures are tagged with omap_hwmod entries
1237 if ((oh
->flags
& HWMOD_SET_DEFAULT_CLOCKACT
) &&
1238 (sf
& SYSC_HAS_CLOCKACTIVITY
))
1239 _set_clockactivity(oh
, CLOCKACT_TEST_ICLK
, &v
);
1241 _write_sysconfig(v
, oh
);
1244 * Set the autoidle bit only after setting the smartidle bit
1245 * Setting this will not have any impact on the other modules.
1247 if (sf
& SYSC_HAS_AUTOIDLE
) {
1248 idlemode
= (oh
->flags
& HWMOD_NO_OCP_AUTOIDLE
) ?
1250 _set_module_autoidle(oh
, idlemode
, &v
);
1251 _write_sysconfig(v
, oh
);
1256 * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
1257 * @oh: struct omap_hwmod *
1259 * If module is marked as SWSUP_SIDLE, force the module into slave
1260 * idle; otherwise, configure it for smart-idle. If module is marked
1261 * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
1262 * configure it for smart-standby. No return value.
1264 static void _idle_sysc(struct omap_hwmod
*oh
)
1269 if (!oh
->class->sysc
)
1272 v
= oh
->_sysc_cache
;
1273 sf
= oh
->class->sysc
->sysc_flags
;
1275 if (sf
& SYSC_HAS_SIDLEMODE
) {
1276 if (oh
->flags
& HWMOD_SWSUP_SIDLE
) {
1277 idlemode
= HWMOD_IDLEMODE_FORCE
;
1279 if (sf
& SYSC_HAS_ENAWAKEUP
)
1280 _enable_wakeup(oh
, &v
);
1281 if (oh
->class->sysc
->idlemodes
& SIDLE_SMART_WKUP
)
1282 idlemode
= HWMOD_IDLEMODE_SMART_WKUP
;
1284 idlemode
= HWMOD_IDLEMODE_SMART
;
1286 _set_slave_idlemode(oh
, idlemode
, &v
);
1289 if (sf
& SYSC_HAS_MIDLEMODE
) {
1290 if ((oh
->flags
& HWMOD_SWSUP_MSTANDBY
) ||
1291 (oh
->flags
& HWMOD_FORCE_MSTANDBY
)) {
1292 idlemode
= HWMOD_IDLEMODE_FORCE
;
1294 if (sf
& SYSC_HAS_ENAWAKEUP
)
1295 _enable_wakeup(oh
, &v
);
1296 if (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)
1297 idlemode
= HWMOD_IDLEMODE_SMART_WKUP
;
1299 idlemode
= HWMOD_IDLEMODE_SMART
;
1301 _set_master_standbymode(oh
, idlemode
, &v
);
1304 /* If the cached value is the same as the new value, skip the write */
1305 if (oh
->_sysc_cache
!= v
)
1306 _write_sysconfig(v
, oh
);
1310 * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
1311 * @oh: struct omap_hwmod *
1313 * Force the module into slave idle and master suspend. No return
1316 static void _shutdown_sysc(struct omap_hwmod
*oh
)
1321 if (!oh
->class->sysc
)
1324 v
= oh
->_sysc_cache
;
1325 sf
= oh
->class->sysc
->sysc_flags
;
1327 if (sf
& SYSC_HAS_SIDLEMODE
)
1328 _set_slave_idlemode(oh
, HWMOD_IDLEMODE_FORCE
, &v
);
1330 if (sf
& SYSC_HAS_MIDLEMODE
)
1331 _set_master_standbymode(oh
, HWMOD_IDLEMODE_FORCE
, &v
);
1333 if (sf
& SYSC_HAS_AUTOIDLE
)
1334 _set_module_autoidle(oh
, 1, &v
);
1336 _write_sysconfig(v
, oh
);
1340 * _lookup - find an omap_hwmod by name
1341 * @name: find an omap_hwmod by name
1343 * Return a pointer to an omap_hwmod by name, or NULL if not found.
1345 static struct omap_hwmod
*_lookup(const char *name
)
1347 struct omap_hwmod
*oh
, *temp_oh
;
1351 list_for_each_entry(temp_oh
, &omap_hwmod_list
, node
) {
1352 if (!strcmp(name
, temp_oh
->name
)) {
1362 * _init_clkdm - look up a clockdomain name, store pointer in omap_hwmod
1363 * @oh: struct omap_hwmod *
1365 * Convert a clockdomain name stored in a struct omap_hwmod into a
1366 * clockdomain pointer, and save it into the struct omap_hwmod.
1367 * Return -EINVAL if the clkdm_name lookup failed.
1369 static int _init_clkdm(struct omap_hwmod
*oh
)
1371 if (!oh
->clkdm_name
) {
1372 pr_debug("omap_hwmod: %s: missing clockdomain\n", oh
->name
);
1376 oh
->clkdm
= clkdm_lookup(oh
->clkdm_name
);
1378 pr_warn("omap_hwmod: %s: could not associate to clkdm %s\n",
1379 oh
->name
, oh
->clkdm_name
);
1383 pr_debug("omap_hwmod: %s: associated to clkdm %s\n",
1384 oh
->name
, oh
->clkdm_name
);
1390 * _init_clocks - clk_get() all clocks associated with this hwmod. Retrieve as
1391 * well the clockdomain.
1392 * @oh: struct omap_hwmod *
1393 * @np: device_node mapped to this hwmod
1395 * Called by omap_hwmod_setup_*() (after omap2_clk_init()).
1396 * Resolves all clock names embedded in the hwmod. Returns 0 on
1397 * success, or a negative error code on failure.
1399 static int _init_clocks(struct omap_hwmod
*oh
, struct device_node
*np
)
1403 if (oh
->_state
!= _HWMOD_STATE_REGISTERED
)
1406 pr_debug("omap_hwmod: %s: looking up clocks\n", oh
->name
);
1408 if (soc_ops
.init_clkdm
)
1409 ret
|= soc_ops
.init_clkdm(oh
);
1411 ret
|= _init_main_clk(oh
);
1412 ret
|= _init_interface_clks(oh
);
1413 ret
|= _init_opt_clks(oh
);
1416 oh
->_state
= _HWMOD_STATE_CLKS_INITED
;
1418 pr_warn("omap_hwmod: %s: cannot _init_clocks\n", oh
->name
);
1424 * _lookup_hardreset - fill register bit info for this hwmod/reset line
1425 * @oh: struct omap_hwmod *
1426 * @name: name of the reset line in the context of this hwmod
1427 * @ohri: struct omap_hwmod_rst_info * that this function will fill in
1429 * Return the bit position of the reset line that match the
1430 * input name. Return -ENOENT if not found.
1432 static int _lookup_hardreset(struct omap_hwmod
*oh
, const char *name
,
1433 struct omap_hwmod_rst_info
*ohri
)
1437 for (i
= 0; i
< oh
->rst_lines_cnt
; i
++) {
1438 const char *rst_line
= oh
->rst_lines
[i
].name
;
1439 if (!strcmp(rst_line
, name
)) {
1440 ohri
->rst_shift
= oh
->rst_lines
[i
].rst_shift
;
1441 ohri
->st_shift
= oh
->rst_lines
[i
].st_shift
;
1442 pr_debug("omap_hwmod: %s: %s: %s: rst %d st %d\n",
1443 oh
->name
, __func__
, rst_line
, ohri
->rst_shift
,
1454 * _assert_hardreset - assert the HW reset line of submodules
1455 * contained in the hwmod module.
1456 * @oh: struct omap_hwmod *
1457 * @name: name of the reset line to lookup and assert
1459 * Some IP like dsp, ipu or iva contain processor that require an HW
1460 * reset line to be assert / deassert in order to enable fully the IP.
1461 * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1462 * asserting the hardreset line on the currently-booted SoC, or passes
1463 * along the return value from _lookup_hardreset() or the SoC's
1464 * assert_hardreset code.
1466 static int _assert_hardreset(struct omap_hwmod
*oh
, const char *name
)
1468 struct omap_hwmod_rst_info ohri
;
1474 if (!soc_ops
.assert_hardreset
)
1477 ret
= _lookup_hardreset(oh
, name
, &ohri
);
1481 ret
= soc_ops
.assert_hardreset(oh
, &ohri
);
1487 * _deassert_hardreset - deassert the HW reset line of submodules contained
1488 * in the hwmod module.
1489 * @oh: struct omap_hwmod *
1490 * @name: name of the reset line to look up and deassert
1492 * Some IP like dsp, ipu or iva contain processor that require an HW
1493 * reset line to be assert / deassert in order to enable fully the IP.
1494 * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1495 * deasserting the hardreset line on the currently-booted SoC, or passes
1496 * along the return value from _lookup_hardreset() or the SoC's
1497 * deassert_hardreset code.
1499 static int _deassert_hardreset(struct omap_hwmod
*oh
, const char *name
)
1501 struct omap_hwmod_rst_info ohri
;
1507 if (!soc_ops
.deassert_hardreset
)
1510 ret
= _lookup_hardreset(oh
, name
, &ohri
);
1516 * A clockdomain must be in SW_SUP otherwise reset
1517 * might not be completed. The clockdomain can be set
1518 * in HW_AUTO only when the module become ready.
1520 clkdm_deny_idle(oh
->clkdm
);
1521 ret
= clkdm_hwmod_enable(oh
->clkdm
, oh
);
1523 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1524 oh
->name
, oh
->clkdm
->name
, ret
);
1530 if (soc_ops
.enable_module
)
1531 soc_ops
.enable_module(oh
);
1533 ret
= soc_ops
.deassert_hardreset(oh
, &ohri
);
1535 if (soc_ops
.disable_module
)
1536 soc_ops
.disable_module(oh
);
1537 _disable_clocks(oh
);
1540 pr_warn("omap_hwmod: %s: failed to hardreset\n", oh
->name
);
1544 * Set the clockdomain to HW_AUTO, assuming that the
1545 * previous state was HW_AUTO.
1547 clkdm_allow_idle(oh
->clkdm
);
1549 clkdm_hwmod_disable(oh
->clkdm
, oh
);
1556 * _read_hardreset - read the HW reset line state of submodules
1557 * contained in the hwmod module
1558 * @oh: struct omap_hwmod *
1559 * @name: name of the reset line to look up and read
1561 * Return the state of the reset line. Returns -EINVAL if @oh is
1562 * null, -ENOSYS if we have no way of reading the hardreset line
1563 * status on the currently-booted SoC, or passes along the return
1564 * value from _lookup_hardreset() or the SoC's is_hardreset_asserted
1567 static int _read_hardreset(struct omap_hwmod
*oh
, const char *name
)
1569 struct omap_hwmod_rst_info ohri
;
1575 if (!soc_ops
.is_hardreset_asserted
)
1578 ret
= _lookup_hardreset(oh
, name
, &ohri
);
1582 return soc_ops
.is_hardreset_asserted(oh
, &ohri
);
1586 * _are_all_hardreset_lines_asserted - return true if the @oh is hard-reset
1587 * @oh: struct omap_hwmod *
1589 * If all hardreset lines associated with @oh are asserted, then return true.
1590 * Otherwise, if part of @oh is out hardreset or if no hardreset lines
1591 * associated with @oh are asserted, then return false.
1592 * This function is used to avoid executing some parts of the IP block
1593 * enable/disable sequence if its hardreset line is set.
1595 static bool _are_all_hardreset_lines_asserted(struct omap_hwmod
*oh
)
1599 if (oh
->rst_lines_cnt
== 0)
1602 for (i
= 0; i
< oh
->rst_lines_cnt
; i
++)
1603 if (_read_hardreset(oh
, oh
->rst_lines
[i
].name
) > 0)
1606 if (oh
->rst_lines_cnt
== rst_cnt
)
1613 * _are_any_hardreset_lines_asserted - return true if any part of @oh is
1615 * @oh: struct omap_hwmod *
1617 * If any hardreset lines associated with @oh are asserted, then
1618 * return true. Otherwise, if no hardreset lines associated with @oh
1619 * are asserted, or if @oh has no hardreset lines, then return false.
1620 * This function is used to avoid executing some parts of the IP block
1621 * enable/disable sequence if any hardreset line is set.
1623 static bool _are_any_hardreset_lines_asserted(struct omap_hwmod
*oh
)
1628 for (i
= 0; i
< oh
->rst_lines_cnt
&& rst_cnt
== 0; i
++)
1629 if (_read_hardreset(oh
, oh
->rst_lines
[i
].name
) > 0)
1632 return (rst_cnt
) ? true : false;
1636 * _omap4_disable_module - enable CLKCTRL modulemode on OMAP4
1637 * @oh: struct omap_hwmod *
1639 * Disable the PRCM module mode related to the hwmod @oh.
1640 * Return EINVAL if the modulemode is not supported and 0 in case of success.
1642 static int _omap4_disable_module(struct omap_hwmod
*oh
)
1646 if (!oh
->clkdm
|| !oh
->prcm
.omap4
.modulemode
||
1647 _omap4_clkctrl_managed_by_clkfwk(oh
))
1651 * Since integration code might still be doing something, only
1652 * disable if all lines are under hardreset.
1654 if (_are_any_hardreset_lines_asserted(oh
))
1657 pr_debug("omap_hwmod: %s: %s\n", oh
->name
, __func__
);
1659 omap_cm_module_disable(oh
->clkdm
->prcm_partition
, oh
->clkdm
->cm_inst
,
1660 oh
->prcm
.omap4
.clkctrl_offs
);
1662 v
= _omap4_wait_target_disable(oh
);
1664 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1671 * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1672 * @oh: struct omap_hwmod *
1674 * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit. hwmod must be
1675 * enabled for this to work. Returns -ENOENT if the hwmod cannot be
1676 * reset this way, -EINVAL if the hwmod is in the wrong state,
1677 * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1679 * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1680 * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1681 * use the SYSCONFIG softreset bit to provide the status.
1683 * Note that some IP like McBSP do have reset control but don't have
1686 static int _ocp_softreset(struct omap_hwmod
*oh
)
1692 if (!oh
->class->sysc
||
1693 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_SOFTRESET
))
1696 /* clocks must be on for this operation */
1697 if (oh
->_state
!= _HWMOD_STATE_ENABLED
) {
1698 pr_warn("omap_hwmod: %s: reset can only be entered from enabled state\n",
1703 /* For some modules, all optionnal clocks need to be enabled as well */
1704 if (oh
->flags
& HWMOD_CONTROL_OPT_CLKS_IN_RESET
)
1705 _enable_optional_clocks(oh
);
1707 pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh
->name
);
1709 v
= oh
->_sysc_cache
;
1710 ret
= _set_softreset(oh
, &v
);
1714 _write_sysconfig(v
, oh
);
1716 if (oh
->class->sysc
->srst_udelay
)
1717 udelay(oh
->class->sysc
->srst_udelay
);
1719 c
= _wait_softreset_complete(oh
);
1720 if (c
== MAX_MODULE_SOFTRESET_WAIT
) {
1721 pr_warn("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1722 oh
->name
, MAX_MODULE_SOFTRESET_WAIT
);
1726 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh
->name
, c
);
1729 ret
= _clear_softreset(oh
, &v
);
1733 _write_sysconfig(v
, oh
);
1736 * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1737 * _wait_target_ready() or _reset()
1741 if (oh
->flags
& HWMOD_CONTROL_OPT_CLKS_IN_RESET
)
1742 _disable_optional_clocks(oh
);
1748 * _reset - reset an omap_hwmod
1749 * @oh: struct omap_hwmod *
1751 * Resets an omap_hwmod @oh. If the module has a custom reset
1752 * function pointer defined, then call it to reset the IP block, and
1753 * pass along its return value to the caller. Otherwise, if the IP
1754 * block has an OCP_SYSCONFIG register with a SOFTRESET bitfield
1755 * associated with it, call a function to reset the IP block via that
1756 * method, and pass along the return value to the caller. Finally, if
1757 * the IP block has some hardreset lines associated with it, assert
1758 * all of those, but do _not_ deassert them. (This is because driver
1759 * authors have expressed an apparent requirement to control the
1760 * deassertion of the hardreset lines themselves.)
1762 * The default software reset mechanism for most OMAP IP blocks is
1763 * triggered via the OCP_SYSCONFIG.SOFTRESET bit. However, some
1764 * hwmods cannot be reset via this method. Some are not targets and
1765 * therefore have no OCP header registers to access. Others (like the
1766 * IVA) have idiosyncratic reset sequences. So for these relatively
1767 * rare cases, custom reset code can be supplied in the struct
1768 * omap_hwmod_class .reset function pointer.
1770 * _set_dmadisable() is called to set the DMADISABLE bit so that it
1771 * does not prevent idling of the system. This is necessary for cases
1772 * where ROMCODE/BOOTLOADER uses dma and transfers control to the
1773 * kernel without disabling dma.
1775 * Passes along the return value from either _ocp_softreset() or the
1776 * custom reset function - these must return -EINVAL if the hwmod
1777 * cannot be reset this way or if the hwmod is in the wrong state,
1778 * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1780 static int _reset(struct omap_hwmod
*oh
)
1784 pr_debug("omap_hwmod: %s: resetting\n", oh
->name
);
1786 if (oh
->class->reset
) {
1787 r
= oh
->class->reset(oh
);
1789 if (oh
->rst_lines_cnt
> 0) {
1790 for (i
= 0; i
< oh
->rst_lines_cnt
; i
++)
1791 _assert_hardreset(oh
, oh
->rst_lines
[i
].name
);
1794 r
= _ocp_softreset(oh
);
1800 _set_dmadisable(oh
);
1803 * OCP_SYSCONFIG bits need to be reprogrammed after a
1804 * softreset. The _enable() function should be split to avoid
1805 * the rewrite of the OCP_SYSCONFIG register.
1807 if (oh
->class->sysc
) {
1808 _update_sysc_cache(oh
);
1816 * _omap4_update_context_lost - increment hwmod context loss counter if
1817 * hwmod context was lost, and clear hardware context loss reg
1818 * @oh: hwmod to check for context loss
1820 * If the PRCM indicates that the hwmod @oh lost context, increment
1821 * our in-memory context loss counter, and clear the RM_*_CONTEXT
1822 * bits. No return value.
1824 static void _omap4_update_context_lost(struct omap_hwmod
*oh
)
1826 if (oh
->prcm
.omap4
.flags
& HWMOD_OMAP4_NO_CONTEXT_LOSS_BIT
)
1829 if (!prm_was_any_context_lost_old(oh
->clkdm
->pwrdm
.ptr
->prcm_partition
,
1830 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
1831 oh
->prcm
.omap4
.context_offs
))
1834 oh
->prcm
.omap4
.context_lost_counter
++;
1835 prm_clear_context_loss_flags_old(oh
->clkdm
->pwrdm
.ptr
->prcm_partition
,
1836 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
1837 oh
->prcm
.omap4
.context_offs
);
1841 * _omap4_get_context_lost - get context loss counter for a hwmod
1842 * @oh: hwmod to get context loss counter for
1844 * Returns the in-memory context loss counter for a hwmod.
1846 static int _omap4_get_context_lost(struct omap_hwmod
*oh
)
1848 return oh
->prcm
.omap4
.context_lost_counter
;
1852 * _enable_preprogram - Pre-program an IP block during the _enable() process
1853 * @oh: struct omap_hwmod *
1855 * Some IP blocks (such as AESS) require some additional programming
1856 * after enable before they can enter idle. If a function pointer to
1857 * do so is present in the hwmod data, then call it and pass along the
1858 * return value; otherwise, return 0.
1860 static int _enable_preprogram(struct omap_hwmod
*oh
)
1862 if (!oh
->class->enable_preprogram
)
1865 return oh
->class->enable_preprogram(oh
);
1869 * _enable - enable an omap_hwmod
1870 * @oh: struct omap_hwmod *
1872 * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
1873 * register target. Returns -EINVAL if the hwmod is in the wrong
1874 * state or passes along the return value of _wait_target_ready().
1876 static int _enable(struct omap_hwmod
*oh
)
1880 pr_debug("omap_hwmod: %s: enabling\n", oh
->name
);
1883 * hwmods with HWMOD_INIT_NO_IDLE flag set are left in enabled
1886 if (oh
->_int_flags
& _HWMOD_SKIP_ENABLE
) {
1887 oh
->_int_flags
&= ~_HWMOD_SKIP_ENABLE
;
1891 if (oh
->_state
!= _HWMOD_STATE_INITIALIZED
&&
1892 oh
->_state
!= _HWMOD_STATE_IDLE
&&
1893 oh
->_state
!= _HWMOD_STATE_DISABLED
) {
1894 WARN(1, "omap_hwmod: %s: enabled state can only be entered from initialized, idle, or disabled state\n",
1900 * If an IP block contains HW reset lines and all of them are
1901 * asserted, we let integration code associated with that
1902 * block handle the enable. We've received very little
1903 * information on what those driver authors need, and until
1904 * detailed information is provided and the driver code is
1905 * posted to the public lists, this is probably the best we
1908 if (_are_all_hardreset_lines_asserted(oh
))
1911 _add_initiator_dep(oh
, mpu_oh
);
1915 * A clockdomain must be in SW_SUP before enabling
1916 * completely the module. The clockdomain can be set
1917 * in HW_AUTO only when the module become ready.
1919 clkdm_deny_idle(oh
->clkdm
);
1920 r
= clkdm_hwmod_enable(oh
->clkdm
, oh
);
1922 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1923 oh
->name
, oh
->clkdm
->name
, r
);
1929 if (soc_ops
.enable_module
)
1930 soc_ops
.enable_module(oh
);
1931 if (oh
->flags
& HWMOD_BLOCK_WFI
)
1932 cpu_idle_poll_ctrl(true);
1934 if (soc_ops
.update_context_lost
)
1935 soc_ops
.update_context_lost(oh
);
1937 r
= (soc_ops
.wait_target_ready
) ? soc_ops
.wait_target_ready(oh
) :
1939 if (oh
->clkdm
&& !(oh
->flags
& HWMOD_CLKDM_NOAUTO
))
1940 clkdm_allow_idle(oh
->clkdm
);
1943 oh
->_state
= _HWMOD_STATE_ENABLED
;
1945 /* Access the sysconfig only if the target is ready */
1946 if (oh
->class->sysc
) {
1947 if (!(oh
->_int_flags
& _HWMOD_SYSCONFIG_LOADED
))
1948 _update_sysc_cache(oh
);
1951 r
= _enable_preprogram(oh
);
1953 if (soc_ops
.disable_module
)
1954 soc_ops
.disable_module(oh
);
1955 _disable_clocks(oh
);
1956 pr_err("omap_hwmod: %s: _wait_target_ready failed: %d\n",
1960 clkdm_hwmod_disable(oh
->clkdm
, oh
);
1967 * _idle - idle an omap_hwmod
1968 * @oh: struct omap_hwmod *
1970 * Idles an omap_hwmod @oh. This should be called once the hwmod has
1971 * no further work. Returns -EINVAL if the hwmod is in the wrong
1972 * state or returns 0.
1974 static int _idle(struct omap_hwmod
*oh
)
1976 if (oh
->flags
& HWMOD_NO_IDLE
) {
1977 oh
->_int_flags
|= _HWMOD_SKIP_ENABLE
;
1981 pr_debug("omap_hwmod: %s: idling\n", oh
->name
);
1983 if (_are_all_hardreset_lines_asserted(oh
))
1986 if (oh
->_state
!= _HWMOD_STATE_ENABLED
) {
1987 WARN(1, "omap_hwmod: %s: idle state can only be entered from enabled state\n",
1992 if (oh
->class->sysc
)
1994 _del_initiator_dep(oh
, mpu_oh
);
1997 * If HWMOD_CLKDM_NOAUTO is set then we don't
1998 * deny idle the clkdm again since idle was already denied
2001 if (oh
->clkdm
&& !(oh
->flags
& HWMOD_CLKDM_NOAUTO
))
2002 clkdm_deny_idle(oh
->clkdm
);
2004 if (oh
->flags
& HWMOD_BLOCK_WFI
)
2005 cpu_idle_poll_ctrl(false);
2006 if (soc_ops
.disable_module
)
2007 soc_ops
.disable_module(oh
);
2010 * The module must be in idle mode before disabling any parents
2011 * clocks. Otherwise, the parent clock might be disabled before
2012 * the module transition is done, and thus will prevent the
2013 * transition to complete properly.
2015 _disable_clocks(oh
);
2017 clkdm_allow_idle(oh
->clkdm
);
2018 clkdm_hwmod_disable(oh
->clkdm
, oh
);
2021 oh
->_state
= _HWMOD_STATE_IDLE
;
2027 * _shutdown - shutdown an omap_hwmod
2028 * @oh: struct omap_hwmod *
2030 * Shut down an omap_hwmod @oh. This should be called when the driver
2031 * used for the hwmod is removed or unloaded or if the driver is not
2032 * used by the system. Returns -EINVAL if the hwmod is in the wrong
2033 * state or returns 0.
2035 static int _shutdown(struct omap_hwmod
*oh
)
2040 if (_are_all_hardreset_lines_asserted(oh
))
2043 if (oh
->_state
!= _HWMOD_STATE_IDLE
&&
2044 oh
->_state
!= _HWMOD_STATE_ENABLED
) {
2045 WARN(1, "omap_hwmod: %s: disabled state can only be entered from idle, or enabled state\n",
2050 pr_debug("omap_hwmod: %s: disabling\n", oh
->name
);
2052 if (oh
->class->pre_shutdown
) {
2053 prev_state
= oh
->_state
;
2054 if (oh
->_state
== _HWMOD_STATE_IDLE
)
2056 ret
= oh
->class->pre_shutdown(oh
);
2058 if (prev_state
== _HWMOD_STATE_IDLE
)
2064 if (oh
->class->sysc
) {
2065 if (oh
->_state
== _HWMOD_STATE_IDLE
)
2070 /* clocks and deps are already disabled in idle */
2071 if (oh
->_state
== _HWMOD_STATE_ENABLED
) {
2072 _del_initiator_dep(oh
, mpu_oh
);
2073 /* XXX what about the other system initiators here? dma, dsp */
2074 if (oh
->flags
& HWMOD_BLOCK_WFI
)
2075 cpu_idle_poll_ctrl(false);
2076 if (soc_ops
.disable_module
)
2077 soc_ops
.disable_module(oh
);
2078 _disable_clocks(oh
);
2080 clkdm_hwmod_disable(oh
->clkdm
, oh
);
2082 /* XXX Should this code also force-disable the optional clocks? */
2084 for (i
= 0; i
< oh
->rst_lines_cnt
; i
++)
2085 _assert_hardreset(oh
, oh
->rst_lines
[i
].name
);
2087 oh
->_state
= _HWMOD_STATE_DISABLED
;
2092 static int of_dev_find_hwmod(struct device_node
*np
,
2093 struct omap_hwmod
*oh
)
2098 count
= of_property_count_strings(np
, "ti,hwmods");
2102 for (i
= 0; i
< count
; i
++) {
2103 res
= of_property_read_string_index(np
, "ti,hwmods",
2107 if (!strcmp(p
, oh
->name
)) {
2108 pr_debug("omap_hwmod: dt %s[%i] uses hwmod %s\n",
2109 np
->name
, i
, oh
->name
);
2118 * of_dev_hwmod_lookup - look up needed hwmod from dt blob
2119 * @np: struct device_node *
2120 * @oh: struct omap_hwmod *
2121 * @index: index of the entry found
2122 * @found: struct device_node * found or NULL
2124 * Parse the dt blob and find out needed hwmod. Recursive function is
2125 * implemented to take care hierarchical dt blob parsing.
2126 * Return: Returns 0 on success, -ENODEV when not found.
2128 static int of_dev_hwmod_lookup(struct device_node
*np
,
2129 struct omap_hwmod
*oh
,
2131 struct device_node
**found
)
2133 struct device_node
*np0
= NULL
;
2136 res
= of_dev_find_hwmod(np
, oh
);
2143 for_each_child_of_node(np
, np0
) {
2144 struct device_node
*fc
;
2147 res
= of_dev_hwmod_lookup(np0
, oh
, &i
, &fc
);
2162 * omap_hwmod_fix_mpu_rt_idx - fix up mpu_rt_idx register offsets
2164 * @oh: struct omap_hwmod *
2165 * @np: struct device_node *
2167 * Fix up module register offsets for modules with mpu_rt_idx.
2168 * Only needed for cpsw with interconnect target module defined
2169 * in device tree while still using legacy hwmod platform data
2170 * for rev, sysc and syss registers.
2172 * Can be removed when all cpsw hwmod platform data has been
2175 static void omap_hwmod_fix_mpu_rt_idx(struct omap_hwmod
*oh
,
2176 struct device_node
*np
,
2177 struct resource
*res
)
2179 struct device_node
*child
= NULL
;
2182 child
= of_get_next_child(np
, child
);
2186 error
= of_address_to_resource(child
, oh
->mpu_rt_idx
, res
);
2188 pr_err("%s: error mapping mpu_rt_idx: %i\n",
2193 * omap_hwmod_parse_module_range - map module IO range from device tree
2194 * @oh: struct omap_hwmod *
2195 * @np: struct device_node *
2197 * Parse the device tree range an interconnect target module provides
2198 * for it's child device IP blocks. This way we can support the old
2199 * "ti,hwmods" property with just dts data without a need for platform
2200 * data for IO resources. And we don't need all the child IP device
2201 * nodes available in the dts.
2203 int omap_hwmod_parse_module_range(struct omap_hwmod
*oh
,
2204 struct device_node
*np
,
2205 struct resource
*res
)
2207 struct property
*prop
;
2208 const __be32
*ranges
;
2210 u32 nr_addr
, nr_size
;
2217 ranges
= of_get_property(np
, "ranges", &len
);
2221 len
/= sizeof(*ranges
);
2226 of_property_for_each_string(np
, "compatible", prop
, name
)
2227 if (!strncmp("ti,sysc-", name
, 8))
2233 error
= of_property_read_u32(np
, "#address-cells", &nr_addr
);
2237 error
= of_property_read_u32(np
, "#size-cells", &nr_size
);
2241 if (nr_addr
!= 1 || nr_size
!= 1) {
2242 pr_err("%s: invalid range for %s->%s\n", __func__
,
2243 oh
->name
, np
->name
);
2248 base
= of_translate_address(np
, ranges
++);
2249 size
= be32_to_cpup(ranges
);
2251 pr_debug("omap_hwmod: %s %s at 0x%llx size 0x%llx\n",
2252 oh
? oh
->name
: "", np
->name
, base
, size
);
2254 if (oh
&& oh
->mpu_rt_idx
) {
2255 omap_hwmod_fix_mpu_rt_idx(oh
, np
, res
);
2261 res
->end
= base
+ size
- 1;
2262 res
->flags
= IORESOURCE_MEM
;
2268 * _init_mpu_rt_base - populate the virtual address for a hwmod
2269 * @oh: struct omap_hwmod * to locate the virtual address
2270 * @data: (unused, caller should pass NULL)
2271 * @index: index of the reg entry iospace in device tree
2272 * @np: struct device_node * of the IP block's device node in the DT data
2274 * Cache the virtual address used by the MPU to access this IP block's
2275 * registers. This address is needed early so the OCP registers that
2276 * are part of the device's address space can be ioremapped properly.
2278 * If SYSC access is not needed, the registers will not be remapped
2279 * and non-availability of MPU access is not treated as an error.
2281 * Returns 0 on success, -EINVAL if an invalid hwmod is passed, and
2282 * -ENXIO on absent or invalid register target address space.
2284 static int __init
_init_mpu_rt_base(struct omap_hwmod
*oh
, void *data
,
2285 int index
, struct device_node
*np
)
2287 void __iomem
*va_start
= NULL
;
2288 struct resource res
;
2294 _save_mpu_port_index(oh
);
2296 /* if we don't need sysc access we don't need to ioremap */
2297 if (!oh
->class->sysc
)
2300 /* we can't continue without MPU PORT if we need sysc access */
2301 if (oh
->_int_flags
& _HWMOD_NO_MPU_PORT
)
2305 pr_err("omap_hwmod: %s: no dt node\n", oh
->name
);
2309 /* Do we have a dts range for the interconnect target module? */
2310 error
= omap_hwmod_parse_module_range(oh
, np
, &res
);
2312 va_start
= ioremap(res
.start
, resource_size(&res
));
2314 /* No ranges, rely on device reg entry */
2316 va_start
= of_iomap(np
, index
+ oh
->mpu_rt_idx
);
2318 pr_err("omap_hwmod: %s: Missing dt reg%i for %pOF\n",
2319 oh
->name
, index
, np
);
2323 pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
2324 oh
->name
, va_start
);
2326 oh
->_mpu_rt_va
= va_start
;
2331 * _init - initialize internal data for the hwmod @oh
2332 * @oh: struct omap_hwmod *
2335 * Look up the clocks and the address space used by the MPU to access
2336 * registers belonging to the hwmod @oh. @oh must already be
2337 * registered at this point. This is the first of two phases for
2338 * hwmod initialization. Code called here does not touch any hardware
2339 * registers, it simply prepares internal data structures. Returns 0
2340 * upon success or if the hwmod isn't registered or if the hwmod's
2341 * address space is not defined, or -EINVAL upon failure.
2343 static int __init
_init(struct omap_hwmod
*oh
, void *data
)
2346 struct device_node
*np
= NULL
;
2347 struct device_node
*bus
;
2349 if (oh
->_state
!= _HWMOD_STATE_REGISTERED
)
2352 bus
= of_find_node_by_name(NULL
, "ocp");
2356 r
= of_dev_hwmod_lookup(bus
, oh
, &index
, &np
);
2358 pr_debug("omap_hwmod: %s missing dt data\n", oh
->name
);
2359 else if (np
&& index
)
2360 pr_warn("omap_hwmod: %s using broken dt data from %s\n",
2361 oh
->name
, np
->name
);
2363 r
= _init_mpu_rt_base(oh
, NULL
, index
, np
);
2365 WARN(1, "omap_hwmod: %s: doesn't have mpu register target base\n",
2370 r
= _init_clocks(oh
, np
);
2372 WARN(1, "omap_hwmod: %s: couldn't init clocks\n", oh
->name
);
2377 if (of_find_property(np
, "ti,no-reset-on-init", NULL
))
2378 oh
->flags
|= HWMOD_INIT_NO_RESET
;
2379 if (of_find_property(np
, "ti,no-idle-on-init", NULL
))
2380 oh
->flags
|= HWMOD_INIT_NO_IDLE
;
2381 if (of_find_property(np
, "ti,no-idle", NULL
))
2382 oh
->flags
|= HWMOD_NO_IDLE
;
2385 oh
->_state
= _HWMOD_STATE_INITIALIZED
;
2391 * _setup_iclk_autoidle - configure an IP block's interface clocks
2392 * @oh: struct omap_hwmod *
2394 * Set up the module's interface clocks. XXX This function is still mostly
2395 * a stub; implementing this properly requires iclk autoidle usecounting in
2396 * the clock code. No return value.
2398 static void _setup_iclk_autoidle(struct omap_hwmod
*oh
)
2400 struct omap_hwmod_ocp_if
*os
;
2402 if (oh
->_state
!= _HWMOD_STATE_INITIALIZED
)
2405 list_for_each_entry(os
, &oh
->slave_ports
, node
) {
2409 if (os
->flags
& OCPIF_SWSUP_IDLE
) {
2410 /* XXX omap_iclk_deny_idle(c); */
2412 /* XXX omap_iclk_allow_idle(c); */
2413 clk_enable(os
->_clk
);
2421 * _setup_reset - reset an IP block during the setup process
2422 * @oh: struct omap_hwmod *
2424 * Reset the IP block corresponding to the hwmod @oh during the setup
2425 * process. The IP block is first enabled so it can be successfully
2426 * reset. Returns 0 upon success or a negative error code upon
2429 static int _setup_reset(struct omap_hwmod
*oh
)
2433 if (oh
->_state
!= _HWMOD_STATE_INITIALIZED
)
2436 if (oh
->flags
& HWMOD_EXT_OPT_MAIN_CLK
)
2439 if (oh
->rst_lines_cnt
== 0) {
2442 pr_warn("omap_hwmod: %s: cannot be enabled for reset (%d)\n",
2443 oh
->name
, oh
->_state
);
2448 if (!(oh
->flags
& HWMOD_INIT_NO_RESET
))
2455 * _setup_postsetup - transition to the appropriate state after _setup
2456 * @oh: struct omap_hwmod *
2458 * Place an IP block represented by @oh into a "post-setup" state --
2459 * either IDLE, ENABLED, or DISABLED. ("post-setup" simply means that
2460 * this function is called at the end of _setup().) The postsetup
2461 * state for an IP block can be changed by calling
2462 * omap_hwmod_enter_postsetup_state() early in the boot process,
2463 * before one of the omap_hwmod_setup*() functions are called for the
2466 * The IP block stays in this state until a PM runtime-based driver is
2467 * loaded for that IP block. A post-setup state of IDLE is
2468 * appropriate for almost all IP blocks with runtime PM-enabled
2469 * drivers, since those drivers are able to enable the IP block. A
2470 * post-setup state of ENABLED is appropriate for kernels with PM
2471 * runtime disabled. The DISABLED state is appropriate for unusual IP
2472 * blocks such as the MPU WDTIMER on kernels without WDTIMER drivers
2473 * included, since the WDTIMER starts running on reset and will reset
2474 * the MPU if left active.
2476 * This post-setup mechanism is deprecated. Once all of the OMAP
2477 * drivers have been converted to use PM runtime, and all of the IP
2478 * block data and interconnect data is available to the hwmod code, it
2479 * should be possible to replace this mechanism with a "lazy reset"
2480 * arrangement. In a "lazy reset" setup, each IP block is enabled
2481 * when the driver first probes, then all remaining IP blocks without
2482 * drivers are either shut down or enabled after the drivers have
2483 * loaded. However, this cannot take place until the above
2484 * preconditions have been met, since otherwise the late reset code
2485 * has no way of knowing which IP blocks are in use by drivers, and
2486 * which ones are unused.
2490 static void _setup_postsetup(struct omap_hwmod
*oh
)
2494 if (oh
->rst_lines_cnt
> 0)
2497 postsetup_state
= oh
->_postsetup_state
;
2498 if (postsetup_state
== _HWMOD_STATE_UNKNOWN
)
2499 postsetup_state
= _HWMOD_STATE_ENABLED
;
2502 * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
2503 * it should be set by the core code as a runtime flag during startup
2505 if ((oh
->flags
& (HWMOD_INIT_NO_IDLE
| HWMOD_NO_IDLE
)) &&
2506 (postsetup_state
== _HWMOD_STATE_IDLE
)) {
2507 oh
->_int_flags
|= _HWMOD_SKIP_ENABLE
;
2508 postsetup_state
= _HWMOD_STATE_ENABLED
;
2511 if (postsetup_state
== _HWMOD_STATE_IDLE
)
2513 else if (postsetup_state
== _HWMOD_STATE_DISABLED
)
2515 else if (postsetup_state
!= _HWMOD_STATE_ENABLED
)
2516 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
2517 oh
->name
, postsetup_state
);
2523 * _setup - prepare IP block hardware for use
2524 * @oh: struct omap_hwmod *
2525 * @n: (unused, pass NULL)
2527 * Configure the IP block represented by @oh. This may include
2528 * enabling the IP block, resetting it, and placing it into a
2529 * post-setup state, depending on the type of IP block and applicable
2530 * flags. IP blocks are reset to prevent any previous configuration
2531 * by the bootloader or previous operating system from interfering
2532 * with power management or other parts of the system. The reset can
2533 * be avoided; see omap_hwmod_no_setup_reset(). This is the second of
2534 * two phases for hwmod initialization. Code called here generally
2535 * affects the IP block hardware, or system integration hardware
2536 * associated with the IP block. Returns 0.
2538 static int __init
_setup(struct omap_hwmod
*oh
, void *data
)
2540 if (oh
->_state
!= _HWMOD_STATE_INITIALIZED
)
2543 if (oh
->parent_hwmod
) {
2546 r
= _enable(oh
->parent_hwmod
);
2547 WARN(r
, "hwmod: %s: setup: failed to enable parent hwmod %s\n",
2548 oh
->name
, oh
->parent_hwmod
->name
);
2551 _setup_iclk_autoidle(oh
);
2553 if (!_setup_reset(oh
))
2554 _setup_postsetup(oh
);
2556 if (oh
->parent_hwmod
) {
2559 postsetup_state
= oh
->parent_hwmod
->_postsetup_state
;
2561 if (postsetup_state
== _HWMOD_STATE_IDLE
)
2562 _idle(oh
->parent_hwmod
);
2563 else if (postsetup_state
== _HWMOD_STATE_DISABLED
)
2564 _shutdown(oh
->parent_hwmod
);
2565 else if (postsetup_state
!= _HWMOD_STATE_ENABLED
)
2566 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
2567 oh
->parent_hwmod
->name
, postsetup_state
);
2574 * _register - register a struct omap_hwmod
2575 * @oh: struct omap_hwmod *
2577 * Registers the omap_hwmod @oh. Returns -EEXIST if an omap_hwmod
2578 * already has been registered by the same name; -EINVAL if the
2579 * omap_hwmod is in the wrong state, if @oh is NULL, if the
2580 * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
2581 * name, or if the omap_hwmod's class is missing a name; or 0 upon
2584 * XXX The data should be copied into bootmem, so the original data
2585 * should be marked __initdata and freed after init. This would allow
2586 * unneeded omap_hwmods to be freed on multi-OMAP configurations. Note
2587 * that the copy process would be relatively complex due to the large number
2590 static int __init
_register(struct omap_hwmod
*oh
)
2592 if (!oh
|| !oh
->name
|| !oh
->class || !oh
->class->name
||
2593 (oh
->_state
!= _HWMOD_STATE_UNKNOWN
))
2596 pr_debug("omap_hwmod: %s: registering\n", oh
->name
);
2598 if (_lookup(oh
->name
))
2601 list_add_tail(&oh
->node
, &omap_hwmod_list
);
2603 INIT_LIST_HEAD(&oh
->slave_ports
);
2604 spin_lock_init(&oh
->_lock
);
2605 lockdep_set_class(&oh
->_lock
, &oh
->hwmod_key
);
2607 oh
->_state
= _HWMOD_STATE_REGISTERED
;
2610 * XXX Rather than doing a strcmp(), this should test a flag
2611 * set in the hwmod data, inserted by the autogenerator code.
2613 if (!strcmp(oh
->name
, MPU_INITIATOR_NAME
))
2620 * _add_link - add an interconnect between two IP blocks
2621 * @oi: pointer to a struct omap_hwmod_ocp_if record
2623 * Add struct omap_hwmod_link records connecting the slave IP block
2624 * specified in @oi->slave to @oi. This code is assumed to run before
2625 * preemption or SMP has been enabled, thus avoiding the need for
2626 * locking in this code. Changes to this assumption will require
2627 * additional locking. Returns 0.
2629 static int __init
_add_link(struct omap_hwmod_ocp_if
*oi
)
2631 pr_debug("omap_hwmod: %s -> %s: adding link\n", oi
->master
->name
,
2634 list_add(&oi
->node
, &oi
->slave
->slave_ports
);
2635 oi
->slave
->slaves_cnt
++;
2641 * _register_link - register a struct omap_hwmod_ocp_if
2642 * @oi: struct omap_hwmod_ocp_if *
2644 * Registers the omap_hwmod_ocp_if record @oi. Returns -EEXIST if it
2645 * has already been registered; -EINVAL if @oi is NULL or if the
2646 * record pointed to by @oi is missing required fields; or 0 upon
2649 * XXX The data should be copied into bootmem, so the original data
2650 * should be marked __initdata and freed after init. This would allow
2651 * unneeded omap_hwmods to be freed on multi-OMAP configurations.
2653 static int __init
_register_link(struct omap_hwmod_ocp_if
*oi
)
2655 if (!oi
|| !oi
->master
|| !oi
->slave
|| !oi
->user
)
2658 if (oi
->_int_flags
& _OCPIF_INT_FLAGS_REGISTERED
)
2661 pr_debug("omap_hwmod: registering link from %s to %s\n",
2662 oi
->master
->name
, oi
->slave
->name
);
2665 * Register the connected hwmods, if they haven't been
2666 * registered already
2668 if (oi
->master
->_state
!= _HWMOD_STATE_REGISTERED
)
2669 _register(oi
->master
);
2671 if (oi
->slave
->_state
!= _HWMOD_STATE_REGISTERED
)
2672 _register(oi
->slave
);
2676 oi
->_int_flags
|= _OCPIF_INT_FLAGS_REGISTERED
;
2681 /* Static functions intended only for use in soc_ops field function pointers */
2684 * _omap2xxx_3xxx_wait_target_ready - wait for a module to leave slave idle
2685 * @oh: struct omap_hwmod *
2687 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2688 * does not have an IDLEST bit or if the module successfully leaves
2689 * slave idle; otherwise, pass along the return value of the
2690 * appropriate *_cm*_wait_module_ready() function.
2692 static int _omap2xxx_3xxx_wait_target_ready(struct omap_hwmod
*oh
)
2697 if (oh
->flags
& HWMOD_NO_IDLEST
)
2700 if (!_find_mpu_rt_port(oh
))
2703 /* XXX check module SIDLEMODE, hardreset status, enabled clocks */
2705 return omap_cm_wait_module_ready(0, oh
->prcm
.omap2
.module_offs
,
2706 oh
->prcm
.omap2
.idlest_reg_id
,
2707 oh
->prcm
.omap2
.idlest_idle_bit
);
2711 * _omap4_wait_target_ready - wait for a module to leave slave idle
2712 * @oh: struct omap_hwmod *
2714 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2715 * does not have an IDLEST bit or if the module successfully leaves
2716 * slave idle; otherwise, pass along the return value of the
2717 * appropriate *_cm*_wait_module_ready() function.
2719 static int _omap4_wait_target_ready(struct omap_hwmod
*oh
)
2724 if (oh
->flags
& HWMOD_NO_IDLEST
|| !oh
->clkdm
)
2727 if (!_find_mpu_rt_port(oh
))
2730 if (_omap4_clkctrl_managed_by_clkfwk(oh
))
2733 if (!_omap4_has_clkctrl_clock(oh
))
2736 /* XXX check module SIDLEMODE, hardreset status */
2738 return omap_cm_wait_module_ready(oh
->clkdm
->prcm_partition
,
2740 oh
->prcm
.omap4
.clkctrl_offs
, 0);
2744 * _omap2_assert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2745 * @oh: struct omap_hwmod * to assert hardreset
2746 * @ohri: hardreset line data
2748 * Call omap2_prm_assert_hardreset() with parameters extracted from
2749 * the hwmod @oh and the hardreset line data @ohri. Only intended for
2750 * use as an soc_ops function pointer. Passes along the return value
2751 * from omap2_prm_assert_hardreset(). XXX This function is scheduled
2752 * for removal when the PRM code is moved into drivers/.
2754 static int _omap2_assert_hardreset(struct omap_hwmod
*oh
,
2755 struct omap_hwmod_rst_info
*ohri
)
2757 return omap_prm_assert_hardreset(ohri
->rst_shift
, 0,
2758 oh
->prcm
.omap2
.module_offs
, 0);
2762 * _omap2_deassert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2763 * @oh: struct omap_hwmod * to deassert hardreset
2764 * @ohri: hardreset line data
2766 * Call omap2_prm_deassert_hardreset() with parameters extracted from
2767 * the hwmod @oh and the hardreset line data @ohri. Only intended for
2768 * use as an soc_ops function pointer. Passes along the return value
2769 * from omap2_prm_deassert_hardreset(). XXX This function is
2770 * scheduled for removal when the PRM code is moved into drivers/.
2772 static int _omap2_deassert_hardreset(struct omap_hwmod
*oh
,
2773 struct omap_hwmod_rst_info
*ohri
)
2775 return omap_prm_deassert_hardreset(ohri
->rst_shift
, ohri
->st_shift
, 0,
2776 oh
->prcm
.omap2
.module_offs
, 0, 0);
2780 * _omap2_is_hardreset_asserted - call OMAP2 PRM hardreset fn with hwmod args
2781 * @oh: struct omap_hwmod * to test hardreset
2782 * @ohri: hardreset line data
2784 * Call omap2_prm_is_hardreset_asserted() with parameters extracted
2785 * from the hwmod @oh and the hardreset line data @ohri. Only
2786 * intended for use as an soc_ops function pointer. Passes along the
2787 * return value from omap2_prm_is_hardreset_asserted(). XXX This
2788 * function is scheduled for removal when the PRM code is moved into
2791 static int _omap2_is_hardreset_asserted(struct omap_hwmod
*oh
,
2792 struct omap_hwmod_rst_info
*ohri
)
2794 return omap_prm_is_hardreset_asserted(ohri
->st_shift
, 0,
2795 oh
->prcm
.omap2
.module_offs
, 0);
2799 * _omap4_assert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
2800 * @oh: struct omap_hwmod * to assert hardreset
2801 * @ohri: hardreset line data
2803 * Call omap4_prminst_assert_hardreset() with parameters extracted
2804 * from the hwmod @oh and the hardreset line data @ohri. Only
2805 * intended for use as an soc_ops function pointer. Passes along the
2806 * return value from omap4_prminst_assert_hardreset(). XXX This
2807 * function is scheduled for removal when the PRM code is moved into
2810 static int _omap4_assert_hardreset(struct omap_hwmod
*oh
,
2811 struct omap_hwmod_rst_info
*ohri
)
2816 return omap_prm_assert_hardreset(ohri
->rst_shift
,
2817 oh
->clkdm
->pwrdm
.ptr
->prcm_partition
,
2818 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
2819 oh
->prcm
.omap4
.rstctrl_offs
);
2823 * _omap4_deassert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
2824 * @oh: struct omap_hwmod * to deassert hardreset
2825 * @ohri: hardreset line data
2827 * Call omap4_prminst_deassert_hardreset() with parameters extracted
2828 * from the hwmod @oh and the hardreset line data @ohri. Only
2829 * intended for use as an soc_ops function pointer. Passes along the
2830 * return value from omap4_prminst_deassert_hardreset(). XXX This
2831 * function is scheduled for removal when the PRM code is moved into
2834 static int _omap4_deassert_hardreset(struct omap_hwmod
*oh
,
2835 struct omap_hwmod_rst_info
*ohri
)
2841 pr_err("omap_hwmod: %s: %s: hwmod data error: OMAP4 does not support st_shift\n",
2842 oh
->name
, ohri
->name
);
2843 return omap_prm_deassert_hardreset(ohri
->rst_shift
, ohri
->rst_shift
,
2844 oh
->clkdm
->pwrdm
.ptr
->prcm_partition
,
2845 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
2846 oh
->prcm
.omap4
.rstctrl_offs
,
2847 oh
->prcm
.omap4
.rstctrl_offs
+
2848 OMAP4_RST_CTRL_ST_OFFSET
);
2852 * _omap4_is_hardreset_asserted - call OMAP4 PRM hardreset fn with hwmod args
2853 * @oh: struct omap_hwmod * to test hardreset
2854 * @ohri: hardreset line data
2856 * Call omap4_prminst_is_hardreset_asserted() with parameters
2857 * extracted from the hwmod @oh and the hardreset line data @ohri.
2858 * Only intended for use as an soc_ops function pointer. Passes along
2859 * the return value from omap4_prminst_is_hardreset_asserted(). XXX
2860 * This function is scheduled for removal when the PRM code is moved
2863 static int _omap4_is_hardreset_asserted(struct omap_hwmod
*oh
,
2864 struct omap_hwmod_rst_info
*ohri
)
2869 return omap_prm_is_hardreset_asserted(ohri
->rst_shift
,
2870 oh
->clkdm
->pwrdm
.ptr
->
2872 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
2873 oh
->prcm
.omap4
.rstctrl_offs
);
2877 * _omap4_disable_direct_prcm - disable direct PRCM control for hwmod
2878 * @oh: struct omap_hwmod * to disable control for
2880 * Disables direct PRCM clkctrl done by hwmod core. Instead, the hwmod
2881 * will be using its main_clk to enable/disable the module. Returns
2884 static int _omap4_disable_direct_prcm(struct omap_hwmod
*oh
)
2889 oh
->prcm
.omap4
.flags
|= HWMOD_OMAP4_CLKFWK_CLKCTR_CLOCK
;
2895 * _am33xx_deassert_hardreset - call AM33XX PRM hardreset fn with hwmod args
2896 * @oh: struct omap_hwmod * to deassert hardreset
2897 * @ohri: hardreset line data
2899 * Call am33xx_prminst_deassert_hardreset() with parameters extracted
2900 * from the hwmod @oh and the hardreset line data @ohri. Only
2901 * intended for use as an soc_ops function pointer. Passes along the
2902 * return value from am33xx_prminst_deassert_hardreset(). XXX This
2903 * function is scheduled for removal when the PRM code is moved into
2906 static int _am33xx_deassert_hardreset(struct omap_hwmod
*oh
,
2907 struct omap_hwmod_rst_info
*ohri
)
2909 return omap_prm_deassert_hardreset(ohri
->rst_shift
, ohri
->st_shift
,
2910 oh
->clkdm
->pwrdm
.ptr
->prcm_partition
,
2911 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
2912 oh
->prcm
.omap4
.rstctrl_offs
,
2913 oh
->prcm
.omap4
.rstst_offs
);
2916 /* Public functions */
2918 u32
omap_hwmod_read(struct omap_hwmod
*oh
, u16 reg_offs
)
2920 if (oh
->flags
& HWMOD_16BIT_REG
)
2921 return readw_relaxed(oh
->_mpu_rt_va
+ reg_offs
);
2923 return readl_relaxed(oh
->_mpu_rt_va
+ reg_offs
);
2926 void omap_hwmod_write(u32 v
, struct omap_hwmod
*oh
, u16 reg_offs
)
2928 if (oh
->flags
& HWMOD_16BIT_REG
)
2929 writew_relaxed(v
, oh
->_mpu_rt_va
+ reg_offs
);
2931 writel_relaxed(v
, oh
->_mpu_rt_va
+ reg_offs
);
2935 * omap_hwmod_softreset - reset a module via SYSCONFIG.SOFTRESET bit
2936 * @oh: struct omap_hwmod *
2938 * This is a public function exposed to drivers. Some drivers may need to do
2939 * some settings before and after resetting the device. Those drivers after
2940 * doing the necessary settings could use this function to start a reset by
2941 * setting the SYSCONFIG.SOFTRESET bit.
2943 int omap_hwmod_softreset(struct omap_hwmod
*oh
)
2948 if (!oh
|| !(oh
->_sysc_cache
))
2951 v
= oh
->_sysc_cache
;
2952 ret
= _set_softreset(oh
, &v
);
2955 _write_sysconfig(v
, oh
);
2957 ret
= _clear_softreset(oh
, &v
);
2960 _write_sysconfig(v
, oh
);
2967 * omap_hwmod_lookup - look up a registered omap_hwmod by name
2968 * @name: name of the omap_hwmod to look up
2970 * Given a @name of an omap_hwmod, return a pointer to the registered
2971 * struct omap_hwmod *, or NULL upon error.
2973 struct omap_hwmod
*omap_hwmod_lookup(const char *name
)
2975 struct omap_hwmod
*oh
;
2986 * omap_hwmod_for_each - call function for each registered omap_hwmod
2987 * @fn: pointer to a callback function
2988 * @data: void * data to pass to callback function
2990 * Call @fn for each registered omap_hwmod, passing @data to each
2991 * function. @fn must return 0 for success or any other value for
2992 * failure. If @fn returns non-zero, the iteration across omap_hwmods
2993 * will stop and the non-zero return value will be passed to the
2994 * caller of omap_hwmod_for_each(). @fn is called with
2995 * omap_hwmod_for_each() held.
2997 int omap_hwmod_for_each(int (*fn
)(struct omap_hwmod
*oh
, void *data
),
3000 struct omap_hwmod
*temp_oh
;
3006 list_for_each_entry(temp_oh
, &omap_hwmod_list
, node
) {
3007 ret
= (*fn
)(temp_oh
, data
);
3016 * omap_hwmod_register_links - register an array of hwmod links
3017 * @ois: pointer to an array of omap_hwmod_ocp_if to register
3019 * Intended to be called early in boot before the clock framework is
3020 * initialized. If @ois is not null, will register all omap_hwmods
3021 * listed in @ois that are valid for this chip. Returns -EINVAL if
3022 * omap_hwmod_init() hasn't been called before calling this function,
3023 * -ENOMEM if the link memory area can't be allocated, or 0 upon
3026 int __init
omap_hwmod_register_links(struct omap_hwmod_ocp_if
**ois
)
3036 if (ois
[0] == NULL
) /* Empty list */
3041 r
= _register_link(ois
[i
]);
3042 WARN(r
&& r
!= -EEXIST
,
3043 "omap_hwmod: _register_link(%s -> %s) returned %d\n",
3044 ois
[i
]->master
->name
, ois
[i
]->slave
->name
, r
);
3051 * _ensure_mpu_hwmod_is_setup - ensure the MPU SS hwmod is init'ed and set up
3052 * @oh: pointer to the hwmod currently being set up (usually not the MPU)
3054 * If the hwmod data corresponding to the MPU subsystem IP block
3055 * hasn't been initialized and set up yet, do so now. This must be
3056 * done first since sleep dependencies may be added from other hwmods
3057 * to the MPU. Intended to be called only by omap_hwmod_setup*(). No
3060 static void __init
_ensure_mpu_hwmod_is_setup(struct omap_hwmod
*oh
)
3062 if (!mpu_oh
|| mpu_oh
->_state
== _HWMOD_STATE_UNKNOWN
)
3063 pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",
3064 __func__
, MPU_INITIATOR_NAME
);
3065 else if (mpu_oh
->_state
== _HWMOD_STATE_REGISTERED
&& oh
!= mpu_oh
)
3066 omap_hwmod_setup_one(MPU_INITIATOR_NAME
);
3070 * omap_hwmod_setup_one - set up a single hwmod
3071 * @oh_name: const char * name of the already-registered hwmod to set up
3073 * Initialize and set up a single hwmod. Intended to be used for a
3074 * small number of early devices, such as the timer IP blocks used for
3075 * the scheduler clock. Must be called after omap2_clk_init().
3076 * Resolves the struct clk names to struct clk pointers for each
3077 * registered omap_hwmod. Also calls _setup() on each hwmod. Returns
3078 * -EINVAL upon error or 0 upon success.
3080 int __init
omap_hwmod_setup_one(const char *oh_name
)
3082 struct omap_hwmod
*oh
;
3084 pr_debug("omap_hwmod: %s: %s\n", oh_name
, __func__
);
3086 oh
= _lookup(oh_name
);
3088 WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name
);
3092 _ensure_mpu_hwmod_is_setup(oh
);
3101 * omap_hwmod_setup_earlycon_flags - set up flags for early console
3103 * Enable DEBUG_OMAPUART_FLAGS for uart hwmod that is being used as
3104 * early concole so that hwmod core doesn't reset and keep it in idle
3105 * that specific uart.
3107 #ifdef CONFIG_SERIAL_EARLYCON
3108 static void __init
omap_hwmod_setup_earlycon_flags(void)
3110 struct device_node
*np
;
3111 struct omap_hwmod
*oh
;
3114 np
= of_find_node_by_path("/chosen");
3116 uart
= of_get_property(np
, "stdout-path", NULL
);
3118 np
= of_find_node_by_path(uart
);
3120 uart
= of_get_property(np
, "ti,hwmods", NULL
);
3121 oh
= omap_hwmod_lookup(uart
);
3123 oh
->flags
|= DEBUG_OMAPUART_FLAGS
;
3131 * omap_hwmod_setup_all - set up all registered IP blocks
3133 * Initialize and set up all IP blocks registered with the hwmod code.
3134 * Must be called after omap2_clk_init(). Resolves the struct clk
3135 * names to struct clk pointers for each registered omap_hwmod. Also
3136 * calls _setup() on each hwmod. Returns 0 upon success.
3138 static int __init
omap_hwmod_setup_all(void)
3140 _ensure_mpu_hwmod_is_setup(NULL
);
3142 omap_hwmod_for_each(_init
, NULL
);
3143 #ifdef CONFIG_SERIAL_EARLYCON
3144 omap_hwmod_setup_earlycon_flags();
3146 omap_hwmod_for_each(_setup
, NULL
);
3150 omap_postcore_initcall(omap_hwmod_setup_all
);
3153 * omap_hwmod_enable - enable an omap_hwmod
3154 * @oh: struct omap_hwmod *
3156 * Enable an omap_hwmod @oh. Intended to be called by omap_device_enable().
3157 * Returns -EINVAL on error or passes along the return value from _enable().
3159 int omap_hwmod_enable(struct omap_hwmod
*oh
)
3162 unsigned long flags
;
3167 spin_lock_irqsave(&oh
->_lock
, flags
);
3169 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3175 * omap_hwmod_idle - idle an omap_hwmod
3176 * @oh: struct omap_hwmod *
3178 * Idle an omap_hwmod @oh. Intended to be called by omap_device_idle().
3179 * Returns -EINVAL on error or passes along the return value from _idle().
3181 int omap_hwmod_idle(struct omap_hwmod
*oh
)
3184 unsigned long flags
;
3189 spin_lock_irqsave(&oh
->_lock
, flags
);
3191 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3197 * omap_hwmod_shutdown - shutdown an omap_hwmod
3198 * @oh: struct omap_hwmod *
3200 * Shutdown an omap_hwmod @oh. Intended to be called by
3201 * omap_device_shutdown(). Returns -EINVAL on error or passes along
3202 * the return value from _shutdown().
3204 int omap_hwmod_shutdown(struct omap_hwmod
*oh
)
3207 unsigned long flags
;
3212 spin_lock_irqsave(&oh
->_lock
, flags
);
3214 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3220 * IP block data retrieval functions
3224 * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
3225 * @oh: struct omap_hwmod *
3227 * Return the powerdomain pointer associated with the OMAP module
3228 * @oh's main clock. If @oh does not have a main clk, return the
3229 * powerdomain associated with the interface clock associated with the
3230 * module's MPU port. (XXX Perhaps this should use the SDMA port
3231 * instead?) Returns NULL on error, or a struct powerdomain * on
3234 struct powerdomain
*omap_hwmod_get_pwrdm(struct omap_hwmod
*oh
)
3237 struct omap_hwmod_ocp_if
*oi
;
3238 struct clockdomain
*clkdm
;
3239 struct clk_hw_omap
*clk
;
3245 return oh
->clkdm
->pwrdm
.ptr
;
3250 oi
= _find_mpu_rt_port(oh
);
3256 clk
= to_clk_hw_omap(__clk_get_hw(c
));
3261 return clkdm
->pwrdm
.ptr
;
3265 * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
3266 * @oh: struct omap_hwmod *
3268 * Returns the virtual address corresponding to the beginning of the
3269 * module's register target, in the address range that is intended to
3270 * be used by the MPU. Returns the virtual address upon success or NULL
3273 void __iomem
*omap_hwmod_get_mpu_rt_va(struct omap_hwmod
*oh
)
3278 if (oh
->_int_flags
& _HWMOD_NO_MPU_PORT
)
3281 if (oh
->_state
== _HWMOD_STATE_UNKNOWN
)
3284 return oh
->_mpu_rt_va
;
3288 * XXX what about functions for drivers to save/restore ocp_sysconfig
3289 * for context save/restore operations?
3293 * omap_hwmod_enable_wakeup - allow device to wake up the system
3294 * @oh: struct omap_hwmod *
3296 * Sets the module OCP socket ENAWAKEUP bit to allow the module to
3297 * send wakeups to the PRCM, and enable I/O ring wakeup events for
3298 * this IP block if it has dynamic mux entries. Eventually this
3299 * should set PRCM wakeup registers to cause the PRCM to receive
3300 * wakeup events from the module. Does not set any wakeup routing
3301 * registers beyond this point - if the module is to wake up any other
3302 * module or subsystem, that must be set separately. Called by
3303 * omap_device code. Returns -EINVAL on error or 0 upon success.
3305 int omap_hwmod_enable_wakeup(struct omap_hwmod
*oh
)
3307 unsigned long flags
;
3310 spin_lock_irqsave(&oh
->_lock
, flags
);
3312 if (oh
->class->sysc
&&
3313 (oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
)) {
3314 v
= oh
->_sysc_cache
;
3315 _enable_wakeup(oh
, &v
);
3316 _write_sysconfig(v
, oh
);
3319 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3325 * omap_hwmod_disable_wakeup - prevent device from waking the system
3326 * @oh: struct omap_hwmod *
3328 * Clears the module OCP socket ENAWAKEUP bit to prevent the module
3329 * from sending wakeups to the PRCM, and disable I/O ring wakeup
3330 * events for this IP block if it has dynamic mux entries. Eventually
3331 * this should clear PRCM wakeup registers to cause the PRCM to ignore
3332 * wakeup events from the module. Does not set any wakeup routing
3333 * registers beyond this point - if the module is to wake up any other
3334 * module or subsystem, that must be set separately. Called by
3335 * omap_device code. Returns -EINVAL on error or 0 upon success.
3337 int omap_hwmod_disable_wakeup(struct omap_hwmod
*oh
)
3339 unsigned long flags
;
3342 spin_lock_irqsave(&oh
->_lock
, flags
);
3344 if (oh
->class->sysc
&&
3345 (oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
)) {
3346 v
= oh
->_sysc_cache
;
3347 _disable_wakeup(oh
, &v
);
3348 _write_sysconfig(v
, oh
);
3351 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3357 * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
3358 * contained in the hwmod module.
3359 * @oh: struct omap_hwmod *
3360 * @name: name of the reset line to lookup and assert
3362 * Some IP like dsp, ipu or iva contain processor that require
3363 * an HW reset line to be assert / deassert in order to enable fully
3364 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3365 * yet supported on this OMAP; otherwise, passes along the return value
3366 * from _assert_hardreset().
3368 int omap_hwmod_assert_hardreset(struct omap_hwmod
*oh
, const char *name
)
3371 unsigned long flags
;
3376 spin_lock_irqsave(&oh
->_lock
, flags
);
3377 ret
= _assert_hardreset(oh
, name
);
3378 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3384 * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
3385 * contained in the hwmod module.
3386 * @oh: struct omap_hwmod *
3387 * @name: name of the reset line to look up and deassert
3389 * Some IP like dsp, ipu or iva contain processor that require
3390 * an HW reset line to be assert / deassert in order to enable fully
3391 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3392 * yet supported on this OMAP; otherwise, passes along the return value
3393 * from _deassert_hardreset().
3395 int omap_hwmod_deassert_hardreset(struct omap_hwmod
*oh
, const char *name
)
3398 unsigned long flags
;
3403 spin_lock_irqsave(&oh
->_lock
, flags
);
3404 ret
= _deassert_hardreset(oh
, name
);
3405 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3411 * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
3412 * @classname: struct omap_hwmod_class name to search for
3413 * @fn: callback function pointer to call for each hwmod in class @classname
3414 * @user: arbitrary context data to pass to the callback function
3416 * For each omap_hwmod of class @classname, call @fn.
3417 * If the callback function returns something other than
3418 * zero, the iterator is terminated, and the callback function's return
3419 * value is passed back to the caller. Returns 0 upon success, -EINVAL
3420 * if @classname or @fn are NULL, or passes back the error code from @fn.
3422 int omap_hwmod_for_each_by_class(const char *classname
,
3423 int (*fn
)(struct omap_hwmod
*oh
,
3427 struct omap_hwmod
*temp_oh
;
3430 if (!classname
|| !fn
)
3433 pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
3434 __func__
, classname
);
3436 list_for_each_entry(temp_oh
, &omap_hwmod_list
, node
) {
3437 if (!strcmp(temp_oh
->class->name
, classname
)) {
3438 pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
3439 __func__
, temp_oh
->name
);
3440 ret
= (*fn
)(temp_oh
, user
);
3447 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
3454 * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
3455 * @oh: struct omap_hwmod *
3456 * @state: state that _setup() should leave the hwmod in
3458 * Sets the hwmod state that @oh will enter at the end of _setup()
3459 * (called by omap_hwmod_setup_*()). See also the documentation
3460 * for _setup_postsetup(), above. Returns 0 upon success or
3461 * -EINVAL if there is a problem with the arguments or if the hwmod is
3462 * in the wrong state.
3464 int omap_hwmod_set_postsetup_state(struct omap_hwmod
*oh
, u8 state
)
3467 unsigned long flags
;
3472 if (state
!= _HWMOD_STATE_DISABLED
&&
3473 state
!= _HWMOD_STATE_ENABLED
&&
3474 state
!= _HWMOD_STATE_IDLE
)
3477 spin_lock_irqsave(&oh
->_lock
, flags
);
3479 if (oh
->_state
!= _HWMOD_STATE_REGISTERED
) {
3484 oh
->_postsetup_state
= state
;
3488 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3494 * omap_hwmod_get_context_loss_count - get lost context count
3495 * @oh: struct omap_hwmod *
3497 * Returns the context loss count of associated @oh
3498 * upon success, or zero if no context loss data is available.
3500 * On OMAP4, this queries the per-hwmod context loss register,
3501 * assuming one exists. If not, or on OMAP2/3, this queries the
3502 * enclosing powerdomain context loss count.
3504 int omap_hwmod_get_context_loss_count(struct omap_hwmod
*oh
)
3506 struct powerdomain
*pwrdm
;
3509 if (soc_ops
.get_context_lost
)
3510 return soc_ops
.get_context_lost(oh
);
3512 pwrdm
= omap_hwmod_get_pwrdm(oh
);
3514 ret
= pwrdm_get_context_loss_count(pwrdm
);
3520 * omap_hwmod_init - initialize the hwmod code
3522 * Sets up some function pointers needed by the hwmod code to operate on the
3523 * currently-booted SoC. Intended to be called once during kernel init
3524 * before any hwmods are registered. No return value.
3526 void __init
omap_hwmod_init(void)
3528 if (cpu_is_omap24xx()) {
3529 soc_ops
.wait_target_ready
= _omap2xxx_3xxx_wait_target_ready
;
3530 soc_ops
.assert_hardreset
= _omap2_assert_hardreset
;
3531 soc_ops
.deassert_hardreset
= _omap2_deassert_hardreset
;
3532 soc_ops
.is_hardreset_asserted
= _omap2_is_hardreset_asserted
;
3533 } else if (cpu_is_omap34xx()) {
3534 soc_ops
.wait_target_ready
= _omap2xxx_3xxx_wait_target_ready
;
3535 soc_ops
.assert_hardreset
= _omap2_assert_hardreset
;
3536 soc_ops
.deassert_hardreset
= _omap2_deassert_hardreset
;
3537 soc_ops
.is_hardreset_asserted
= _omap2_is_hardreset_asserted
;
3538 soc_ops
.init_clkdm
= _init_clkdm
;
3539 } else if (cpu_is_omap44xx() || soc_is_omap54xx() || soc_is_dra7xx()) {
3540 soc_ops
.enable_module
= _omap4_enable_module
;
3541 soc_ops
.disable_module
= _omap4_disable_module
;
3542 soc_ops
.wait_target_ready
= _omap4_wait_target_ready
;
3543 soc_ops
.assert_hardreset
= _omap4_assert_hardreset
;
3544 soc_ops
.deassert_hardreset
= _omap4_deassert_hardreset
;
3545 soc_ops
.is_hardreset_asserted
= _omap4_is_hardreset_asserted
;
3546 soc_ops
.init_clkdm
= _init_clkdm
;
3547 soc_ops
.update_context_lost
= _omap4_update_context_lost
;
3548 soc_ops
.get_context_lost
= _omap4_get_context_lost
;
3549 soc_ops
.disable_direct_prcm
= _omap4_disable_direct_prcm
;
3550 soc_ops
.xlate_clkctrl
= _omap4_xlate_clkctrl
;
3551 } else if (cpu_is_ti814x() || cpu_is_ti816x() || soc_is_am33xx() ||
3553 soc_ops
.enable_module
= _omap4_enable_module
;
3554 soc_ops
.disable_module
= _omap4_disable_module
;
3555 soc_ops
.wait_target_ready
= _omap4_wait_target_ready
;
3556 soc_ops
.assert_hardreset
= _omap4_assert_hardreset
;
3557 soc_ops
.deassert_hardreset
= _am33xx_deassert_hardreset
;
3558 soc_ops
.is_hardreset_asserted
= _omap4_is_hardreset_asserted
;
3559 soc_ops
.init_clkdm
= _init_clkdm
;
3560 soc_ops
.disable_direct_prcm
= _omap4_disable_direct_prcm
;
3562 WARN(1, "omap_hwmod: unknown SoC type\n");
3565 _init_clkctrl_providers();
3571 * omap_hwmod_get_main_clk - get pointer to main clock name
3572 * @oh: struct omap_hwmod *
3574 * Returns the main clock name assocated with @oh upon success,
3575 * or NULL if @oh is NULL.
3577 const char *omap_hwmod_get_main_clk(struct omap_hwmod
*oh
)
3582 return oh
->main_clk
;