2 * omap_hwmod implementation for OMAP2/3/4
4 * Copyright (C) 2009-2011 Nokia Corporation
5 * Copyright (C) 2011-2012 Texas Instruments, Inc.
7 * Paul Walmsley, BenoƮt Cousson, Kevin Hilman
9 * Created in collaboration with (alphabetical order): Thara Gopinath,
10 * Tony Lindgren, Rajendra Nayak, Vikram Pandita, Sakari Poussa, Anand
11 * Sawant, Santosh Shilimkar, Richard Woodruff
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License version 2 as
15 * published by the Free Software Foundation.
19 * One way to view an OMAP SoC is as a collection of largely unrelated
20 * IP blocks connected by interconnects. The IP blocks include
21 * devices such as ARM processors, audio serial interfaces, UARTs,
22 * etc. Some of these devices, like the DSP, are created by TI;
23 * others, like the SGX, largely originate from external vendors. In
24 * TI's documentation, on-chip devices are referred to as "OMAP
25 * modules." Some of these IP blocks are identical across several
26 * OMAP versions. Others are revised frequently.
28 * These OMAP modules are tied together by various interconnects.
29 * Most of the address and data flow between modules is via OCP-based
30 * interconnects such as the L3 and L4 buses; but there are other
31 * interconnects that distribute the hardware clock tree, handle idle
32 * and reset signaling, supply power, and connect the modules to
33 * various pads or balls on the OMAP package.
35 * OMAP hwmod provides a consistent way to describe the on-chip
36 * hardware blocks and their integration into the rest of the chip.
37 * This description can be automatically generated from the TI
38 * hardware database. OMAP hwmod provides a standard, consistent API
39 * to reset, enable, idle, and disable these hardware blocks. And
40 * hwmod provides a way for other core code, such as the Linux device
41 * code or the OMAP power management and address space mapping code,
42 * to query the hardware database.
46 * Drivers won't call hwmod functions directly. That is done by the
47 * omap_device code, and in rare occasions, by custom integration code
48 * in arch/arm/ *omap*. The omap_device code includes functions to
49 * build a struct platform_device using omap_hwmod data, and that is
50 * currently how hwmod data is communicated to drivers and to the
51 * Linux driver model. Most drivers will call omap_hwmod functions only
52 * indirectly, via pm_runtime*() functions.
54 * From a layering perspective, here is where the OMAP hwmod code
55 * fits into the kernel software stack:
57 * +-------------------------------+
58 * | Device driver code |
59 * | (e.g., drivers/) |
60 * +-------------------------------+
61 * | Linux driver model |
62 * | (platform_device / |
63 * | platform_driver data/code) |
64 * +-------------------------------+
65 * | OMAP core-driver integration |
66 * |(arch/arm/mach-omap2/devices.c)|
67 * +-------------------------------+
68 * | omap_device code |
69 * | (../plat-omap/omap_device.c) |
70 * +-------------------------------+
71 * ----> | omap_hwmod code/data | <-----
72 * | (../mach-omap2/omap_hwmod*) |
73 * +-------------------------------+
74 * | OMAP clock/PRCM/register fns |
75 * | (__raw_{read,write}l, clk*) |
76 * +-------------------------------+
78 * Device drivers should not contain any OMAP-specific code or data in
79 * them. They should only contain code to operate the IP block that
80 * the driver is responsible for. This is because these IP blocks can
81 * also appear in other SoCs, either from TI (such as DaVinci) or from
82 * other manufacturers; and drivers should be reusable across other
85 * The OMAP hwmod code also will attempt to reset and idle all on-chip
86 * devices upon boot. The goal here is for the kernel to be
87 * completely self-reliant and independent from bootloaders. This is
88 * to ensure a repeatable configuration, both to ensure consistent
89 * runtime behavior, and to make it easier for others to reproduce
92 * OMAP module activity states
93 * ---------------------------
94 * The hwmod code considers modules to be in one of several activity
95 * states. IP blocks start out in an UNKNOWN state, then once they
96 * are registered via the hwmod code, proceed to the REGISTERED state.
97 * Once their clock names are resolved to clock pointers, the module
98 * enters the CLKS_INITED state; and finally, once the module has been
99 * reset and the integration registers programmed, the INITIALIZED state
100 * is entered. The hwmod code will then place the module into either
101 * the IDLE state to save power, or in the case of a critical system
102 * module, the ENABLED state.
104 * OMAP core integration code can then call omap_hwmod*() functions
105 * directly to move the module between the IDLE, ENABLED, and DISABLED
106 * states, as needed. This is done during both the PM idle loop, and
107 * in the OMAP core integration code's implementation of the PM runtime
112 * This is a partial list.
113 * - OMAP2420 Multimedia Processor Silicon Revision 2.1.1, 2.2 (SWPU064)
114 * - OMAP2430 Multimedia Device POP Silicon Revision 2.1 (SWPU090)
115 * - OMAP34xx Multimedia Device Silicon Revision 3.1 (SWPU108)
116 * - OMAP4430 Multimedia Device Silicon Revision 1.0 (SWPU140)
117 * - Open Core Protocol Specification 2.2
120 * - handle IO mapping
121 * - bus throughput & module latency measurement code
123 * XXX add tests at the beginning of each function to ensure the hwmod is
124 * in the appropriate state
125 * XXX error return values should be checked to ensure that they are
130 #include <linux/kernel.h>
131 #include <linux/errno.h>
132 #include <linux/io.h>
133 #include <linux/clk.h>
134 #include <linux/delay.h>
135 #include <linux/err.h>
136 #include <linux/list.h>
137 #include <linux/mutex.h>
138 #include <linux/spinlock.h>
139 #include <linux/slab.h>
140 #include <linux/bootmem.h>
143 #include <plat/cpu.h>
144 #include "clockdomain.h"
145 #include "powerdomain.h"
146 #include <plat/clock.h>
147 #include <plat/omap_hwmod.h>
148 #include <plat/prcm.h>
150 #include "cm2xxx_3xxx.h"
151 #include "cminst44xx.h"
152 #include "prm2xxx_3xxx.h"
154 #include "prminst44xx.h"
157 /* Maximum microseconds to wait for OMAP module to softreset */
158 #define MAX_MODULE_SOFTRESET_WAIT 10000
160 /* Name of the OMAP hwmod for the MPU */
161 #define MPU_INITIATOR_NAME "mpu"
164 * Number of struct omap_hwmod_link records per struct
165 * omap_hwmod_ocp_if record (master->slave and slave->master)
167 #define LINKS_PER_OCP_IF 2
170 * struct omap_hwmod_soc_ops - fn ptrs for some SoC-specific operations
171 * @enable_module: function to enable a module (via MODULEMODE)
172 * @disable_module: function to disable a module (via MODULEMODE)
174 * XXX Eventually this functionality will be hidden inside the PRM/CM
175 * device drivers. Until then, this should avoid huge blocks of cpu_is_*()
176 * conditionals in this code.
178 struct omap_hwmod_soc_ops
{
179 void (*enable_module
)(struct omap_hwmod
*oh
);
180 int (*disable_module
)(struct omap_hwmod
*oh
);
181 int (*wait_target_ready
)(struct omap_hwmod
*oh
);
182 int (*assert_hardreset
)(struct omap_hwmod
*oh
,
183 struct omap_hwmod_rst_info
*ohri
);
184 int (*deassert_hardreset
)(struct omap_hwmod
*oh
,
185 struct omap_hwmod_rst_info
*ohri
);
186 int (*is_hardreset_asserted
)(struct omap_hwmod
*oh
,
187 struct omap_hwmod_rst_info
*ohri
);
188 int (*init_clkdm
)(struct omap_hwmod
*oh
);
191 /* soc_ops: adapts the omap_hwmod code to the currently-booted SoC */
192 static struct omap_hwmod_soc_ops soc_ops
;
194 /* omap_hwmod_list contains all registered struct omap_hwmods */
195 static LIST_HEAD(omap_hwmod_list
);
197 /* mpu_oh: used to add/remove MPU initiator from sleepdep list */
198 static struct omap_hwmod
*mpu_oh
;
201 * linkspace: ptr to a buffer that struct omap_hwmod_link records are
202 * allocated from - used to reduce the number of small memory
203 * allocations, which has a significant impact on performance
205 static struct omap_hwmod_link
*linkspace
;
208 * free_ls, max_ls: array indexes into linkspace; representing the
209 * next free struct omap_hwmod_link index, and the maximum number of
210 * struct omap_hwmod_link records allocated (respectively)
212 static unsigned short free_ls
, max_ls
, ls_supp
;
214 /* inited: set to true once the hwmod code is initialized */
217 /* Private functions */
220 * _fetch_next_ocp_if - return the next OCP interface in a list
221 * @p: ptr to a ptr to the list_head inside the ocp_if to return
222 * @i: pointer to the index of the element pointed to by @p in the list
224 * Return a pointer to the struct omap_hwmod_ocp_if record
225 * containing the struct list_head pointed to by @p, and increment
226 * @p such that a future call to this routine will return the next
229 static struct omap_hwmod_ocp_if
*_fetch_next_ocp_if(struct list_head
**p
,
232 struct omap_hwmod_ocp_if
*oi
;
234 oi
= list_entry(*p
, struct omap_hwmod_link
, node
)->ocp_if
;
243 * _update_sysc_cache - return the module OCP_SYSCONFIG register, keep copy
244 * @oh: struct omap_hwmod *
246 * Load the current value of the hwmod OCP_SYSCONFIG register into the
247 * struct omap_hwmod for later use. Returns -EINVAL if the hwmod has no
248 * OCP_SYSCONFIG register or 0 upon success.
250 static int _update_sysc_cache(struct omap_hwmod
*oh
)
252 if (!oh
->class->sysc
) {
253 WARN(1, "omap_hwmod: %s: cannot read OCP_SYSCONFIG: not defined on hwmod's class\n", oh
->name
);
257 /* XXX ensure module interface clock is up */
259 oh
->_sysc_cache
= omap_hwmod_read(oh
, oh
->class->sysc
->sysc_offs
);
261 if (!(oh
->class->sysc
->sysc_flags
& SYSC_NO_CACHE
))
262 oh
->_int_flags
|= _HWMOD_SYSCONFIG_LOADED
;
268 * _write_sysconfig - write a value to the module's OCP_SYSCONFIG register
269 * @v: OCP_SYSCONFIG value to write
270 * @oh: struct omap_hwmod *
272 * Write @v into the module class' OCP_SYSCONFIG register, if it has
273 * one. No return value.
275 static void _write_sysconfig(u32 v
, struct omap_hwmod
*oh
)
277 if (!oh
->class->sysc
) {
278 WARN(1, "omap_hwmod: %s: cannot write OCP_SYSCONFIG: not defined on hwmod's class\n", oh
->name
);
282 /* XXX ensure module interface clock is up */
284 /* Module might have lost context, always update cache and register */
286 omap_hwmod_write(v
, oh
, oh
->class->sysc
->sysc_offs
);
290 * _set_master_standbymode: set the OCP_SYSCONFIG MIDLEMODE field in @v
291 * @oh: struct omap_hwmod *
292 * @standbymode: MIDLEMODE field bits
293 * @v: pointer to register contents to modify
295 * Update the master standby mode bits in @v to be @standbymode for
296 * the @oh hwmod. Does not write to the hardware. Returns -EINVAL
297 * upon error or 0 upon success.
299 static int _set_master_standbymode(struct omap_hwmod
*oh
, u8 standbymode
,
305 if (!oh
->class->sysc
||
306 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_MIDLEMODE
))
309 if (!oh
->class->sysc
->sysc_fields
) {
310 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
314 mstandby_shift
= oh
->class->sysc
->sysc_fields
->midle_shift
;
315 mstandby_mask
= (0x3 << mstandby_shift
);
317 *v
&= ~mstandby_mask
;
318 *v
|= __ffs(standbymode
) << mstandby_shift
;
324 * _set_slave_idlemode: set the OCP_SYSCONFIG SIDLEMODE field in @v
325 * @oh: struct omap_hwmod *
326 * @idlemode: SIDLEMODE field bits
327 * @v: pointer to register contents to modify
329 * Update the slave idle mode bits in @v to be @idlemode for the @oh
330 * hwmod. Does not write to the hardware. Returns -EINVAL upon error
333 static int _set_slave_idlemode(struct omap_hwmod
*oh
, u8 idlemode
, u32
*v
)
338 if (!oh
->class->sysc
||
339 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_SIDLEMODE
))
342 if (!oh
->class->sysc
->sysc_fields
) {
343 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
347 sidle_shift
= oh
->class->sysc
->sysc_fields
->sidle_shift
;
348 sidle_mask
= (0x3 << sidle_shift
);
351 *v
|= __ffs(idlemode
) << sidle_shift
;
357 * _set_clockactivity: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
358 * @oh: struct omap_hwmod *
359 * @clockact: CLOCKACTIVITY field bits
360 * @v: pointer to register contents to modify
362 * Update the clockactivity mode bits in @v to be @clockact for the
363 * @oh hwmod. Used for additional powersaving on some modules. Does
364 * not write to the hardware. Returns -EINVAL upon error or 0 upon
367 static int _set_clockactivity(struct omap_hwmod
*oh
, u8 clockact
, u32
*v
)
372 if (!oh
->class->sysc
||
373 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_CLOCKACTIVITY
))
376 if (!oh
->class->sysc
->sysc_fields
) {
377 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
381 clkact_shift
= oh
->class->sysc
->sysc_fields
->clkact_shift
;
382 clkact_mask
= (0x3 << clkact_shift
);
385 *v
|= clockact
<< clkact_shift
;
391 * _set_softreset: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
392 * @oh: struct omap_hwmod *
393 * @v: pointer to register contents to modify
395 * Set the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
396 * error or 0 upon success.
398 static int _set_softreset(struct omap_hwmod
*oh
, u32
*v
)
402 if (!oh
->class->sysc
||
403 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_SOFTRESET
))
406 if (!oh
->class->sysc
->sysc_fields
) {
407 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
411 softrst_mask
= (0x1 << oh
->class->sysc
->sysc_fields
->srst_shift
);
419 * _set_module_autoidle: set the OCP_SYSCONFIG AUTOIDLE field in @v
420 * @oh: struct omap_hwmod *
421 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
422 * @v: pointer to register contents to modify
424 * Update the module autoidle bit in @v to be @autoidle for the @oh
425 * hwmod. The autoidle bit controls whether the module can gate
426 * internal clocks automatically when it isn't doing anything; the
427 * exact function of this bit varies on a per-module basis. This
428 * function does not write to the hardware. Returns -EINVAL upon
429 * error or 0 upon success.
431 static int _set_module_autoidle(struct omap_hwmod
*oh
, u8 autoidle
,
437 if (!oh
->class->sysc
||
438 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_AUTOIDLE
))
441 if (!oh
->class->sysc
->sysc_fields
) {
442 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
446 autoidle_shift
= oh
->class->sysc
->sysc_fields
->autoidle_shift
;
447 autoidle_mask
= (0x1 << autoidle_shift
);
449 *v
&= ~autoidle_mask
;
450 *v
|= autoidle
<< autoidle_shift
;
456 * _set_idle_ioring_wakeup - enable/disable IO pad wakeup on hwmod idle for mux
457 * @oh: struct omap_hwmod *
458 * @set_wake: bool value indicating to set (true) or clear (false) wakeup enable
460 * Set or clear the I/O pad wakeup flag in the mux entries for the
461 * hwmod @oh. This function changes the @oh->mux->pads_dynamic array
462 * in memory. If the hwmod is currently idled, and the new idle
463 * values don't match the previous ones, this function will also
464 * update the SCM PADCTRL registers. Otherwise, if the hwmod is not
465 * currently idled, this function won't touch the hardware: the new
466 * mux settings are written to the SCM PADCTRL registers when the
467 * hwmod is idled. No return value.
469 static void _set_idle_ioring_wakeup(struct omap_hwmod
*oh
, bool set_wake
)
471 struct omap_device_pad
*pad
;
476 if (!oh
->mux
|| !oh
->mux
->enabled
)
479 for (j
= 0; j
< oh
->mux
->nr_pads_dynamic
; j
++) {
480 pad
= oh
->mux
->pads_dynamic
[j
];
482 if (!(pad
->flags
& OMAP_DEVICE_PAD_WAKEUP
))
485 prev_idle
= pad
->idle
;
488 pad
->idle
|= OMAP_WAKEUP_EN
;
490 pad
->idle
&= ~OMAP_WAKEUP_EN
;
492 if (prev_idle
!= pad
->idle
)
496 if (change
&& oh
->_state
== _HWMOD_STATE_IDLE
)
497 omap_hwmod_mux(oh
->mux
, _HWMOD_STATE_IDLE
);
501 * _enable_wakeup: set OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
502 * @oh: struct omap_hwmod *
504 * Allow the hardware module @oh to send wakeups. Returns -EINVAL
505 * upon error or 0 upon success.
507 static int _enable_wakeup(struct omap_hwmod
*oh
, u32
*v
)
509 if (!oh
->class->sysc
||
510 !((oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
) ||
511 (oh
->class->sysc
->idlemodes
& SIDLE_SMART_WKUP
) ||
512 (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)))
515 if (!oh
->class->sysc
->sysc_fields
) {
516 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
520 if (oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
)
521 *v
|= 0x1 << oh
->class->sysc
->sysc_fields
->enwkup_shift
;
523 if (oh
->class->sysc
->idlemodes
& SIDLE_SMART_WKUP
)
524 _set_slave_idlemode(oh
, HWMOD_IDLEMODE_SMART_WKUP
, v
);
525 if (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)
526 _set_master_standbymode(oh
, HWMOD_IDLEMODE_SMART_WKUP
, v
);
528 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
530 oh
->_int_flags
|= _HWMOD_WAKEUP_ENABLED
;
536 * _disable_wakeup: clear OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
537 * @oh: struct omap_hwmod *
539 * Prevent the hardware module @oh to send wakeups. Returns -EINVAL
540 * upon error or 0 upon success.
542 static int _disable_wakeup(struct omap_hwmod
*oh
, u32
*v
)
544 if (!oh
->class->sysc
||
545 !((oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
) ||
546 (oh
->class->sysc
->idlemodes
& SIDLE_SMART_WKUP
) ||
547 (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)))
550 if (!oh
->class->sysc
->sysc_fields
) {
551 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
555 if (oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
)
556 *v
&= ~(0x1 << oh
->class->sysc
->sysc_fields
->enwkup_shift
);
558 if (oh
->class->sysc
->idlemodes
& SIDLE_SMART_WKUP
)
559 _set_slave_idlemode(oh
, HWMOD_IDLEMODE_SMART
, v
);
560 if (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)
561 _set_master_standbymode(oh
, HWMOD_IDLEMODE_SMART
, v
);
563 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
565 oh
->_int_flags
&= ~_HWMOD_WAKEUP_ENABLED
;
571 * _add_initiator_dep: prevent @oh from smart-idling while @init_oh is active
572 * @oh: struct omap_hwmod *
574 * Prevent the hardware module @oh from entering idle while the
575 * hardare module initiator @init_oh is active. Useful when a module
576 * will be accessed by a particular initiator (e.g., if a module will
577 * be accessed by the IVA, there should be a sleepdep between the IVA
578 * initiator and the module). Only applies to modules in smart-idle
579 * mode. If the clockdomain is marked as not needing autodeps, return
580 * 0 without doing anything. Otherwise, returns -EINVAL upon error or
581 * passes along clkdm_add_sleepdep() value upon success.
583 static int _add_initiator_dep(struct omap_hwmod
*oh
, struct omap_hwmod
*init_oh
)
588 if (oh
->_clk
->clkdm
&& oh
->_clk
->clkdm
->flags
& CLKDM_NO_AUTODEPS
)
591 return clkdm_add_sleepdep(oh
->_clk
->clkdm
, init_oh
->_clk
->clkdm
);
595 * _del_initiator_dep: allow @oh to smart-idle even if @init_oh is active
596 * @oh: struct omap_hwmod *
598 * Allow the hardware module @oh to enter idle while the hardare
599 * module initiator @init_oh is active. Useful when a module will not
600 * be accessed by a particular initiator (e.g., if a module will not
601 * be accessed by the IVA, there should be no sleepdep between the IVA
602 * initiator and the module). Only applies to modules in smart-idle
603 * mode. If the clockdomain is marked as not needing autodeps, return
604 * 0 without doing anything. Returns -EINVAL upon error or passes
605 * along clkdm_del_sleepdep() value upon success.
607 static int _del_initiator_dep(struct omap_hwmod
*oh
, struct omap_hwmod
*init_oh
)
612 if (oh
->_clk
->clkdm
&& oh
->_clk
->clkdm
->flags
& CLKDM_NO_AUTODEPS
)
615 return clkdm_del_sleepdep(oh
->_clk
->clkdm
, init_oh
->_clk
->clkdm
);
619 * _init_main_clk - get a struct clk * for the the hwmod's main functional clk
620 * @oh: struct omap_hwmod *
622 * Called from _init_clocks(). Populates the @oh _clk (main
623 * functional clock pointer) if a main_clk is present. Returns 0 on
624 * success or -EINVAL on error.
626 static int _init_main_clk(struct omap_hwmod
*oh
)
633 oh
->_clk
= omap_clk_get_by_name(oh
->main_clk
);
635 pr_warning("omap_hwmod: %s: cannot clk_get main_clk %s\n",
636 oh
->name
, oh
->main_clk
);
640 if (!oh
->_clk
->clkdm
)
641 pr_warning("omap_hwmod: %s: missing clockdomain for %s.\n",
642 oh
->main_clk
, oh
->_clk
->name
);
648 * _init_interface_clks - get a struct clk * for the the hwmod's interface clks
649 * @oh: struct omap_hwmod *
651 * Called from _init_clocks(). Populates the @oh OCP slave interface
652 * clock pointers. Returns 0 on success or -EINVAL on error.
654 static int _init_interface_clks(struct omap_hwmod
*oh
)
656 struct omap_hwmod_ocp_if
*os
;
662 p
= oh
->slave_ports
.next
;
664 while (i
< oh
->slaves_cnt
) {
665 os
= _fetch_next_ocp_if(&p
, &i
);
669 c
= omap_clk_get_by_name(os
->clk
);
671 pr_warning("omap_hwmod: %s: cannot clk_get interface_clk %s\n",
682 * _init_opt_clk - get a struct clk * for the the hwmod's optional clocks
683 * @oh: struct omap_hwmod *
685 * Called from _init_clocks(). Populates the @oh omap_hwmod_opt_clk
686 * clock pointers. Returns 0 on success or -EINVAL on error.
688 static int _init_opt_clks(struct omap_hwmod
*oh
)
690 struct omap_hwmod_opt_clk
*oc
;
695 for (i
= oh
->opt_clks_cnt
, oc
= oh
->opt_clks
; i
> 0; i
--, oc
++) {
696 c
= omap_clk_get_by_name(oc
->clk
);
698 pr_warning("omap_hwmod: %s: cannot clk_get opt_clk %s\n",
709 * _enable_clocks - enable hwmod main clock and interface clocks
710 * @oh: struct omap_hwmod *
712 * Enables all clocks necessary for register reads and writes to succeed
713 * on the hwmod @oh. Returns 0.
715 static int _enable_clocks(struct omap_hwmod
*oh
)
717 struct omap_hwmod_ocp_if
*os
;
721 pr_debug("omap_hwmod: %s: enabling clocks\n", oh
->name
);
724 clk_enable(oh
->_clk
);
726 p
= oh
->slave_ports
.next
;
728 while (i
< oh
->slaves_cnt
) {
729 os
= _fetch_next_ocp_if(&p
, &i
);
731 if (os
->_clk
&& (os
->flags
& OCPIF_SWSUP_IDLE
))
732 clk_enable(os
->_clk
);
735 /* The opt clocks are controlled by the device driver. */
741 * _disable_clocks - disable hwmod main clock and interface clocks
742 * @oh: struct omap_hwmod *
744 * Disables the hwmod @oh main functional and interface clocks. Returns 0.
746 static int _disable_clocks(struct omap_hwmod
*oh
)
748 struct omap_hwmod_ocp_if
*os
;
752 pr_debug("omap_hwmod: %s: disabling clocks\n", oh
->name
);
755 clk_disable(oh
->_clk
);
757 p
= oh
->slave_ports
.next
;
759 while (i
< oh
->slaves_cnt
) {
760 os
= _fetch_next_ocp_if(&p
, &i
);
762 if (os
->_clk
&& (os
->flags
& OCPIF_SWSUP_IDLE
))
763 clk_disable(os
->_clk
);
766 /* The opt clocks are controlled by the device driver. */
771 static void _enable_optional_clocks(struct omap_hwmod
*oh
)
773 struct omap_hwmod_opt_clk
*oc
;
776 pr_debug("omap_hwmod: %s: enabling optional clocks\n", oh
->name
);
778 for (i
= oh
->opt_clks_cnt
, oc
= oh
->opt_clks
; i
> 0; i
--, oc
++)
780 pr_debug("omap_hwmod: enable %s:%s\n", oc
->role
,
782 clk_enable(oc
->_clk
);
786 static void _disable_optional_clocks(struct omap_hwmod
*oh
)
788 struct omap_hwmod_opt_clk
*oc
;
791 pr_debug("omap_hwmod: %s: disabling optional clocks\n", oh
->name
);
793 for (i
= oh
->opt_clks_cnt
, oc
= oh
->opt_clks
; i
> 0; i
--, oc
++)
795 pr_debug("omap_hwmod: disable %s:%s\n", oc
->role
,
797 clk_disable(oc
->_clk
);
802 * _omap4_enable_module - enable CLKCTRL modulemode on OMAP4
803 * @oh: struct omap_hwmod *
805 * Enables the PRCM module mode related to the hwmod @oh.
808 static void _omap4_enable_module(struct omap_hwmod
*oh
)
810 if (!oh
->clkdm
|| !oh
->prcm
.omap4
.modulemode
)
813 pr_debug("omap_hwmod: %s: %s: %d\n",
814 oh
->name
, __func__
, oh
->prcm
.omap4
.modulemode
);
816 omap4_cminst_module_enable(oh
->prcm
.omap4
.modulemode
,
817 oh
->clkdm
->prcm_partition
,
819 oh
->clkdm
->clkdm_offs
,
820 oh
->prcm
.omap4
.clkctrl_offs
);
824 * _omap4_wait_target_disable - wait for a module to be disabled on OMAP4
825 * @oh: struct omap_hwmod *
827 * Wait for a module @oh to enter slave idle. Returns 0 if the module
828 * does not have an IDLEST bit or if the module successfully enters
829 * slave idle; otherwise, pass along the return value of the
830 * appropriate *_cm*_wait_module_idle() function.
832 static int _omap4_wait_target_disable(struct omap_hwmod
*oh
)
834 if (!oh
|| !oh
->clkdm
)
837 if (oh
->_int_flags
& _HWMOD_NO_MPU_PORT
)
840 if (oh
->flags
& HWMOD_NO_IDLEST
)
843 return omap4_cminst_wait_module_idle(oh
->clkdm
->prcm_partition
,
845 oh
->clkdm
->clkdm_offs
,
846 oh
->prcm
.omap4
.clkctrl_offs
);
850 * _count_mpu_irqs - count the number of MPU IRQ lines associated with @oh
851 * @oh: struct omap_hwmod *oh
853 * Count and return the number of MPU IRQs associated with the hwmod
854 * @oh. Used to allocate struct resource data. Returns 0 if @oh is
857 static int _count_mpu_irqs(struct omap_hwmod
*oh
)
859 struct omap_hwmod_irq_info
*ohii
;
862 if (!oh
|| !oh
->mpu_irqs
)
866 ohii
= &oh
->mpu_irqs
[i
++];
867 } while (ohii
->irq
!= -1);
873 * _count_sdma_reqs - count the number of SDMA request lines associated with @oh
874 * @oh: struct omap_hwmod *oh
876 * Count and return the number of SDMA request lines associated with
877 * the hwmod @oh. Used to allocate struct resource data. Returns 0
880 static int _count_sdma_reqs(struct omap_hwmod
*oh
)
882 struct omap_hwmod_dma_info
*ohdi
;
885 if (!oh
|| !oh
->sdma_reqs
)
889 ohdi
= &oh
->sdma_reqs
[i
++];
890 } while (ohdi
->dma_req
!= -1);
896 * _count_ocp_if_addr_spaces - count the number of address space entries for @oh
897 * @oh: struct omap_hwmod *oh
899 * Count and return the number of address space ranges associated with
900 * the hwmod @oh. Used to allocate struct resource data. Returns 0
903 static int _count_ocp_if_addr_spaces(struct omap_hwmod_ocp_if
*os
)
905 struct omap_hwmod_addr_space
*mem
;
908 if (!os
|| !os
->addr
)
912 mem
= &os
->addr
[i
++];
913 } while (mem
->pa_start
!= mem
->pa_end
);
919 * _get_mpu_irq_by_name - fetch MPU interrupt line number by name
920 * @oh: struct omap_hwmod * to operate on
921 * @name: pointer to the name of the MPU interrupt number to fetch (optional)
922 * @irq: pointer to an unsigned int to store the MPU IRQ number to
924 * Retrieve a MPU hardware IRQ line number named by @name associated
925 * with the IP block pointed to by @oh. The IRQ number will be filled
926 * into the address pointed to by @dma. When @name is non-null, the
927 * IRQ line number associated with the named entry will be returned.
928 * If @name is null, the first matching entry will be returned. Data
929 * order is not meaningful in hwmod data, so callers are strongly
930 * encouraged to use a non-null @name whenever possible to avoid
931 * unpredictable effects if hwmod data is later added that causes data
932 * ordering to change. Returns 0 upon success or a negative error
935 static int _get_mpu_irq_by_name(struct omap_hwmod
*oh
, const char *name
,
945 while (oh
->mpu_irqs
[i
].irq
!= -1) {
946 if (name
== oh
->mpu_irqs
[i
].name
||
947 !strcmp(name
, oh
->mpu_irqs
[i
].name
)) {
957 *irq
= oh
->mpu_irqs
[i
].irq
;
963 * _get_sdma_req_by_name - fetch SDMA request line ID by name
964 * @oh: struct omap_hwmod * to operate on
965 * @name: pointer to the name of the SDMA request line to fetch (optional)
966 * @dma: pointer to an unsigned int to store the request line ID to
968 * Retrieve an SDMA request line ID named by @name on the IP block
969 * pointed to by @oh. The ID will be filled into the address pointed
970 * to by @dma. When @name is non-null, the request line ID associated
971 * with the named entry will be returned. If @name is null, the first
972 * matching entry will be returned. Data order is not meaningful in
973 * hwmod data, so callers are strongly encouraged to use a non-null
974 * @name whenever possible to avoid unpredictable effects if hwmod
975 * data is later added that causes data ordering to change. Returns 0
976 * upon success or a negative error code upon error.
978 static int _get_sdma_req_by_name(struct omap_hwmod
*oh
, const char *name
,
988 while (oh
->sdma_reqs
[i
].dma_req
!= -1) {
989 if (name
== oh
->sdma_reqs
[i
].name
||
990 !strcmp(name
, oh
->sdma_reqs
[i
].name
)) {
1000 *dma
= oh
->sdma_reqs
[i
].dma_req
;
1006 * _get_addr_space_by_name - fetch address space start & end by name
1007 * @oh: struct omap_hwmod * to operate on
1008 * @name: pointer to the name of the address space to fetch (optional)
1009 * @pa_start: pointer to a u32 to store the starting address to
1010 * @pa_end: pointer to a u32 to store the ending address to
1012 * Retrieve address space start and end addresses for the IP block
1013 * pointed to by @oh. The data will be filled into the addresses
1014 * pointed to by @pa_start and @pa_end. When @name is non-null, the
1015 * address space data associated with the named entry will be
1016 * returned. If @name is null, the first matching entry will be
1017 * returned. Data order is not meaningful in hwmod data, so callers
1018 * are strongly encouraged to use a non-null @name whenever possible
1019 * to avoid unpredictable effects if hwmod data is later added that
1020 * causes data ordering to change. Returns 0 upon success or a
1021 * negative error code upon error.
1023 static int _get_addr_space_by_name(struct omap_hwmod
*oh
, const char *name
,
1024 u32
*pa_start
, u32
*pa_end
)
1027 struct omap_hwmod_ocp_if
*os
;
1028 struct list_head
*p
= NULL
;
1031 p
= oh
->slave_ports
.next
;
1034 while (i
< oh
->slaves_cnt
) {
1035 os
= _fetch_next_ocp_if(&p
, &i
);
1041 while (os
->addr
[j
].pa_start
!= os
->addr
[j
].pa_end
) {
1042 if (name
== os
->addr
[j
].name
||
1043 !strcmp(name
, os
->addr
[j
].name
)) {
1057 *pa_start
= os
->addr
[j
].pa_start
;
1058 *pa_end
= os
->addr
[j
].pa_end
;
1064 * _save_mpu_port_index - find and save the index to @oh's MPU port
1065 * @oh: struct omap_hwmod *
1067 * Determines the array index of the OCP slave port that the MPU uses
1068 * to address the device, and saves it into the struct omap_hwmod.
1069 * Intended to be called during hwmod registration only. No return
1072 static void __init
_save_mpu_port_index(struct omap_hwmod
*oh
)
1074 struct omap_hwmod_ocp_if
*os
= NULL
;
1075 struct list_head
*p
;
1081 oh
->_int_flags
|= _HWMOD_NO_MPU_PORT
;
1083 p
= oh
->slave_ports
.next
;
1085 while (i
< oh
->slaves_cnt
) {
1086 os
= _fetch_next_ocp_if(&p
, &i
);
1087 if (os
->user
& OCP_USER_MPU
) {
1089 oh
->_int_flags
&= ~_HWMOD_NO_MPU_PORT
;
1098 * _find_mpu_rt_port - return omap_hwmod_ocp_if accessible by the MPU
1099 * @oh: struct omap_hwmod *
1101 * Given a pointer to a struct omap_hwmod record @oh, return a pointer
1102 * to the struct omap_hwmod_ocp_if record that is used by the MPU to
1103 * communicate with the IP block. This interface need not be directly
1104 * connected to the MPU (and almost certainly is not), but is directly
1105 * connected to the IP block represented by @oh. Returns a pointer
1106 * to the struct omap_hwmod_ocp_if * upon success, or returns NULL upon
1107 * error or if there does not appear to be a path from the MPU to this
1110 static struct omap_hwmod_ocp_if
*_find_mpu_rt_port(struct omap_hwmod
*oh
)
1112 if (!oh
|| oh
->_int_flags
& _HWMOD_NO_MPU_PORT
|| oh
->slaves_cnt
== 0)
1115 return oh
->_mpu_port
;
1119 * _find_mpu_rt_addr_space - return MPU register target address space for @oh
1120 * @oh: struct omap_hwmod *
1122 * Returns a pointer to the struct omap_hwmod_addr_space record representing
1123 * the register target MPU address space; or returns NULL upon error.
1125 static struct omap_hwmod_addr_space
* __init
_find_mpu_rt_addr_space(struct omap_hwmod
*oh
)
1127 struct omap_hwmod_ocp_if
*os
;
1128 struct omap_hwmod_addr_space
*mem
;
1129 int found
= 0, i
= 0;
1131 os
= _find_mpu_rt_port(oh
);
1132 if (!os
|| !os
->addr
)
1136 mem
= &os
->addr
[i
++];
1137 if (mem
->flags
& ADDR_TYPE_RT
)
1139 } while (!found
&& mem
->pa_start
!= mem
->pa_end
);
1141 return (found
) ? mem
: NULL
;
1145 * _enable_sysc - try to bring a module out of idle via OCP_SYSCONFIG
1146 * @oh: struct omap_hwmod *
1148 * If module is marked as SWSUP_SIDLE, force the module out of slave
1149 * idle; otherwise, configure it for smart-idle. If module is marked
1150 * as SWSUP_MSUSPEND, force the module out of master standby;
1151 * otherwise, configure it for smart-standby. No return value.
1153 static void _enable_sysc(struct omap_hwmod
*oh
)
1158 if (!oh
->class->sysc
)
1161 v
= oh
->_sysc_cache
;
1162 sf
= oh
->class->sysc
->sysc_flags
;
1164 if (sf
& SYSC_HAS_SIDLEMODE
) {
1165 idlemode
= (oh
->flags
& HWMOD_SWSUP_SIDLE
) ?
1166 HWMOD_IDLEMODE_NO
: HWMOD_IDLEMODE_SMART
;
1167 _set_slave_idlemode(oh
, idlemode
, &v
);
1170 if (sf
& SYSC_HAS_MIDLEMODE
) {
1171 if (oh
->flags
& HWMOD_SWSUP_MSTANDBY
) {
1172 idlemode
= HWMOD_IDLEMODE_NO
;
1174 if (sf
& SYSC_HAS_ENAWAKEUP
)
1175 _enable_wakeup(oh
, &v
);
1176 if (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)
1177 idlemode
= HWMOD_IDLEMODE_SMART_WKUP
;
1179 idlemode
= HWMOD_IDLEMODE_SMART
;
1181 _set_master_standbymode(oh
, idlemode
, &v
);
1185 * XXX The clock framework should handle this, by
1186 * calling into this code. But this must wait until the
1187 * clock structures are tagged with omap_hwmod entries
1189 if ((oh
->flags
& HWMOD_SET_DEFAULT_CLOCKACT
) &&
1190 (sf
& SYSC_HAS_CLOCKACTIVITY
))
1191 _set_clockactivity(oh
, oh
->class->sysc
->clockact
, &v
);
1193 /* If slave is in SMARTIDLE, also enable wakeup */
1194 if ((sf
& SYSC_HAS_SIDLEMODE
) && !(oh
->flags
& HWMOD_SWSUP_SIDLE
))
1195 _enable_wakeup(oh
, &v
);
1197 _write_sysconfig(v
, oh
);
1200 * Set the autoidle bit only after setting the smartidle bit
1201 * Setting this will not have any impact on the other modules.
1203 if (sf
& SYSC_HAS_AUTOIDLE
) {
1204 idlemode
= (oh
->flags
& HWMOD_NO_OCP_AUTOIDLE
) ?
1206 _set_module_autoidle(oh
, idlemode
, &v
);
1207 _write_sysconfig(v
, oh
);
1212 * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
1213 * @oh: struct omap_hwmod *
1215 * If module is marked as SWSUP_SIDLE, force the module into slave
1216 * idle; otherwise, configure it for smart-idle. If module is marked
1217 * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
1218 * configure it for smart-standby. No return value.
1220 static void _idle_sysc(struct omap_hwmod
*oh
)
1225 if (!oh
->class->sysc
)
1228 v
= oh
->_sysc_cache
;
1229 sf
= oh
->class->sysc
->sysc_flags
;
1231 if (sf
& SYSC_HAS_SIDLEMODE
) {
1232 idlemode
= (oh
->flags
& HWMOD_SWSUP_SIDLE
) ?
1233 HWMOD_IDLEMODE_FORCE
: HWMOD_IDLEMODE_SMART
;
1234 _set_slave_idlemode(oh
, idlemode
, &v
);
1237 if (sf
& SYSC_HAS_MIDLEMODE
) {
1238 if (oh
->flags
& HWMOD_SWSUP_MSTANDBY
) {
1239 idlemode
= HWMOD_IDLEMODE_FORCE
;
1241 if (sf
& SYSC_HAS_ENAWAKEUP
)
1242 _enable_wakeup(oh
, &v
);
1243 if (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)
1244 idlemode
= HWMOD_IDLEMODE_SMART_WKUP
;
1246 idlemode
= HWMOD_IDLEMODE_SMART
;
1248 _set_master_standbymode(oh
, idlemode
, &v
);
1251 /* If slave is in SMARTIDLE, also enable wakeup */
1252 if ((sf
& SYSC_HAS_SIDLEMODE
) && !(oh
->flags
& HWMOD_SWSUP_SIDLE
))
1253 _enable_wakeup(oh
, &v
);
1255 _write_sysconfig(v
, oh
);
1259 * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
1260 * @oh: struct omap_hwmod *
1262 * Force the module into slave idle and master suspend. No return
1265 static void _shutdown_sysc(struct omap_hwmod
*oh
)
1270 if (!oh
->class->sysc
)
1273 v
= oh
->_sysc_cache
;
1274 sf
= oh
->class->sysc
->sysc_flags
;
1276 if (sf
& SYSC_HAS_SIDLEMODE
)
1277 _set_slave_idlemode(oh
, HWMOD_IDLEMODE_FORCE
, &v
);
1279 if (sf
& SYSC_HAS_MIDLEMODE
)
1280 _set_master_standbymode(oh
, HWMOD_IDLEMODE_FORCE
, &v
);
1282 if (sf
& SYSC_HAS_AUTOIDLE
)
1283 _set_module_autoidle(oh
, 1, &v
);
1285 _write_sysconfig(v
, oh
);
1289 * _lookup - find an omap_hwmod by name
1290 * @name: find an omap_hwmod by name
1292 * Return a pointer to an omap_hwmod by name, or NULL if not found.
1294 static struct omap_hwmod
*_lookup(const char *name
)
1296 struct omap_hwmod
*oh
, *temp_oh
;
1300 list_for_each_entry(temp_oh
, &omap_hwmod_list
, node
) {
1301 if (!strcmp(name
, temp_oh
->name
)) {
1311 * _init_clkdm - look up a clockdomain name, store pointer in omap_hwmod
1312 * @oh: struct omap_hwmod *
1314 * Convert a clockdomain name stored in a struct omap_hwmod into a
1315 * clockdomain pointer, and save it into the struct omap_hwmod.
1316 * Return -EINVAL if the clkdm_name lookup failed.
1318 static int _init_clkdm(struct omap_hwmod
*oh
)
1320 if (!oh
->clkdm_name
)
1323 oh
->clkdm
= clkdm_lookup(oh
->clkdm_name
);
1325 pr_warning("omap_hwmod: %s: could not associate to clkdm %s\n",
1326 oh
->name
, oh
->clkdm_name
);
1330 pr_debug("omap_hwmod: %s: associated to clkdm %s\n",
1331 oh
->name
, oh
->clkdm_name
);
1337 * _init_clocks - clk_get() all clocks associated with this hwmod. Retrieve as
1338 * well the clockdomain.
1339 * @oh: struct omap_hwmod *
1340 * @data: not used; pass NULL
1342 * Called by omap_hwmod_setup_*() (after omap2_clk_init()).
1343 * Resolves all clock names embedded in the hwmod. Returns 0 on
1344 * success, or a negative error code on failure.
1346 static int _init_clocks(struct omap_hwmod
*oh
, void *data
)
1350 if (oh
->_state
!= _HWMOD_STATE_REGISTERED
)
1353 pr_debug("omap_hwmod: %s: looking up clocks\n", oh
->name
);
1355 ret
|= _init_main_clk(oh
);
1356 ret
|= _init_interface_clks(oh
);
1357 ret
|= _init_opt_clks(oh
);
1358 if (soc_ops
.init_clkdm
)
1359 ret
|= soc_ops
.init_clkdm(oh
);
1362 oh
->_state
= _HWMOD_STATE_CLKS_INITED
;
1364 pr_warning("omap_hwmod: %s: cannot _init_clocks\n", oh
->name
);
1370 * _lookup_hardreset - fill register bit info for this hwmod/reset line
1371 * @oh: struct omap_hwmod *
1372 * @name: name of the reset line in the context of this hwmod
1373 * @ohri: struct omap_hwmod_rst_info * that this function will fill in
1375 * Return the bit position of the reset line that match the
1376 * input name. Return -ENOENT if not found.
1378 static u8
_lookup_hardreset(struct omap_hwmod
*oh
, const char *name
,
1379 struct omap_hwmod_rst_info
*ohri
)
1383 for (i
= 0; i
< oh
->rst_lines_cnt
; i
++) {
1384 const char *rst_line
= oh
->rst_lines
[i
].name
;
1385 if (!strcmp(rst_line
, name
)) {
1386 ohri
->rst_shift
= oh
->rst_lines
[i
].rst_shift
;
1387 ohri
->st_shift
= oh
->rst_lines
[i
].st_shift
;
1388 pr_debug("omap_hwmod: %s: %s: %s: rst %d st %d\n",
1389 oh
->name
, __func__
, rst_line
, ohri
->rst_shift
,
1400 * _assert_hardreset - assert the HW reset line of submodules
1401 * contained in the hwmod module.
1402 * @oh: struct omap_hwmod *
1403 * @name: name of the reset line to lookup and assert
1405 * Some IP like dsp, ipu or iva contain processor that require an HW
1406 * reset line to be assert / deassert in order to enable fully the IP.
1407 * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1408 * asserting the hardreset line on the currently-booted SoC, or passes
1409 * along the return value from _lookup_hardreset() or the SoC's
1410 * assert_hardreset code.
1412 static int _assert_hardreset(struct omap_hwmod
*oh
, const char *name
)
1414 struct omap_hwmod_rst_info ohri
;
1420 if (!soc_ops
.assert_hardreset
)
1423 ret
= _lookup_hardreset(oh
, name
, &ohri
);
1424 if (IS_ERR_VALUE(ret
))
1427 ret
= soc_ops
.assert_hardreset(oh
, &ohri
);
1433 * _deassert_hardreset - deassert the HW reset line of submodules contained
1434 * in the hwmod module.
1435 * @oh: struct omap_hwmod *
1436 * @name: name of the reset line to look up and deassert
1438 * Some IP like dsp, ipu or iva contain processor that require an HW
1439 * reset line to be assert / deassert in order to enable fully the IP.
1440 * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1441 * deasserting the hardreset line on the currently-booted SoC, or passes
1442 * along the return value from _lookup_hardreset() or the SoC's
1443 * deassert_hardreset code.
1445 static int _deassert_hardreset(struct omap_hwmod
*oh
, const char *name
)
1447 struct omap_hwmod_rst_info ohri
;
1453 if (!soc_ops
.deassert_hardreset
)
1456 ret
= _lookup_hardreset(oh
, name
, &ohri
);
1457 if (IS_ERR_VALUE(ret
))
1460 ret
= soc_ops
.deassert_hardreset(oh
, &ohri
);
1462 pr_warning("omap_hwmod: %s: failed to hardreset\n", oh
->name
);
1468 * _read_hardreset - read the HW reset line state of submodules
1469 * contained in the hwmod module
1470 * @oh: struct omap_hwmod *
1471 * @name: name of the reset line to look up and read
1473 * Return the state of the reset line. Returns -EINVAL if @oh is
1474 * null, -ENOSYS if we have no way of reading the hardreset line
1475 * status on the currently-booted SoC, or passes along the return
1476 * value from _lookup_hardreset() or the SoC's is_hardreset_asserted
1479 static int _read_hardreset(struct omap_hwmod
*oh
, const char *name
)
1481 struct omap_hwmod_rst_info ohri
;
1487 if (!soc_ops
.is_hardreset_asserted
)
1490 ret
= _lookup_hardreset(oh
, name
, &ohri
);
1491 if (IS_ERR_VALUE(ret
))
1494 return soc_ops
.is_hardreset_asserted(oh
, &ohri
);
1498 * _are_any_hardreset_lines_asserted - return true if part of @oh is hard-reset
1499 * @oh: struct omap_hwmod *
1501 * If any hardreset line associated with @oh is asserted, then return true.
1502 * Otherwise, if @oh has no hardreset lines associated with it, or if
1503 * no hardreset lines associated with @oh are asserted, then return false.
1504 * This function is used to avoid executing some parts of the IP block
1505 * enable/disable sequence if a hardreset line is set.
1507 static bool _are_any_hardreset_lines_asserted(struct omap_hwmod
*oh
)
1511 if (oh
->rst_lines_cnt
== 0)
1514 for (i
= 0; i
< oh
->rst_lines_cnt
; i
++)
1515 if (_read_hardreset(oh
, oh
->rst_lines
[i
].name
) > 0)
1522 * _omap4_disable_module - enable CLKCTRL modulemode on OMAP4
1523 * @oh: struct omap_hwmod *
1525 * Disable the PRCM module mode related to the hwmod @oh.
1526 * Return EINVAL if the modulemode is not supported and 0 in case of success.
1528 static int _omap4_disable_module(struct omap_hwmod
*oh
)
1532 if (!oh
->clkdm
|| !oh
->prcm
.omap4
.modulemode
)
1535 pr_debug("omap_hwmod: %s: %s\n", oh
->name
, __func__
);
1537 omap4_cminst_module_disable(oh
->clkdm
->prcm_partition
,
1539 oh
->clkdm
->clkdm_offs
,
1540 oh
->prcm
.omap4
.clkctrl_offs
);
1542 if (_are_any_hardreset_lines_asserted(oh
))
1545 v
= _omap4_wait_target_disable(oh
);
1547 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1554 * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1555 * @oh: struct omap_hwmod *
1557 * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit. hwmod must be
1558 * enabled for this to work. Returns -ENOENT if the hwmod cannot be
1559 * reset this way, -EINVAL if the hwmod is in the wrong state,
1560 * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1562 * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1563 * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1564 * use the SYSCONFIG softreset bit to provide the status.
1566 * Note that some IP like McBSP do have reset control but don't have
1569 static int _ocp_softreset(struct omap_hwmod
*oh
)
1571 u32 v
, softrst_mask
;
1575 if (!oh
->class->sysc
||
1576 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_SOFTRESET
))
1579 /* clocks must be on for this operation */
1580 if (oh
->_state
!= _HWMOD_STATE_ENABLED
) {
1581 pr_warning("omap_hwmod: %s: reset can only be entered from "
1582 "enabled state\n", oh
->name
);
1586 /* For some modules, all optionnal clocks need to be enabled as well */
1587 if (oh
->flags
& HWMOD_CONTROL_OPT_CLKS_IN_RESET
)
1588 _enable_optional_clocks(oh
);
1590 pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh
->name
);
1592 v
= oh
->_sysc_cache
;
1593 ret
= _set_softreset(oh
, &v
);
1596 _write_sysconfig(v
, oh
);
1598 if (oh
->class->sysc
->srst_udelay
)
1599 udelay(oh
->class->sysc
->srst_udelay
);
1601 if (oh
->class->sysc
->sysc_flags
& SYSS_HAS_RESET_STATUS
)
1602 omap_test_timeout((omap_hwmod_read(oh
,
1603 oh
->class->sysc
->syss_offs
)
1604 & SYSS_RESETDONE_MASK
),
1605 MAX_MODULE_SOFTRESET_WAIT
, c
);
1606 else if (oh
->class->sysc
->sysc_flags
& SYSC_HAS_RESET_STATUS
) {
1607 softrst_mask
= (0x1 << oh
->class->sysc
->sysc_fields
->srst_shift
);
1608 omap_test_timeout(!(omap_hwmod_read(oh
,
1609 oh
->class->sysc
->sysc_offs
)
1611 MAX_MODULE_SOFTRESET_WAIT
, c
);
1614 if (c
== MAX_MODULE_SOFTRESET_WAIT
)
1615 pr_warning("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1616 oh
->name
, MAX_MODULE_SOFTRESET_WAIT
);
1618 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh
->name
, c
);
1621 * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1622 * _wait_target_ready() or _reset()
1625 ret
= (c
== MAX_MODULE_SOFTRESET_WAIT
) ? -ETIMEDOUT
: 0;
1628 if (oh
->flags
& HWMOD_CONTROL_OPT_CLKS_IN_RESET
)
1629 _disable_optional_clocks(oh
);
1635 * _reset - reset an omap_hwmod
1636 * @oh: struct omap_hwmod *
1638 * Resets an omap_hwmod @oh. If the module has a custom reset
1639 * function pointer defined, then call it to reset the IP block, and
1640 * pass along its return value to the caller. Otherwise, if the IP
1641 * block has an OCP_SYSCONFIG register with a SOFTRESET bitfield
1642 * associated with it, call a function to reset the IP block via that
1643 * method, and pass along the return value to the caller. Finally, if
1644 * the IP block has some hardreset lines associated with it, assert
1645 * all of those, but do _not_ deassert them. (This is because driver
1646 * authors have expressed an apparent requirement to control the
1647 * deassertion of the hardreset lines themselves.)
1649 * The default software reset mechanism for most OMAP IP blocks is
1650 * triggered via the OCP_SYSCONFIG.SOFTRESET bit. However, some
1651 * hwmods cannot be reset via this method. Some are not targets and
1652 * therefore have no OCP header registers to access. Others (like the
1653 * IVA) have idiosyncratic reset sequences. So for these relatively
1654 * rare cases, custom reset code can be supplied in the struct
1655 * omap_hwmod_class .reset function pointer. Passes along the return
1656 * value from either _ocp_softreset() or the custom reset function -
1657 * these must return -EINVAL if the hwmod cannot be reset this way or
1658 * if the hwmod is in the wrong state, -ETIMEDOUT if the module did
1659 * not reset in time, or 0 upon success.
1661 static int _reset(struct omap_hwmod
*oh
)
1665 pr_debug("omap_hwmod: %s: resetting\n", oh
->name
);
1667 if (oh
->class->reset
) {
1668 r
= oh
->class->reset(oh
);
1670 if (oh
->rst_lines_cnt
> 0) {
1671 for (i
= 0; i
< oh
->rst_lines_cnt
; i
++)
1672 _assert_hardreset(oh
, oh
->rst_lines
[i
].name
);
1675 r
= _ocp_softreset(oh
);
1682 * OCP_SYSCONFIG bits need to be reprogrammed after a
1683 * softreset. The _enable() function should be split to avoid
1684 * the rewrite of the OCP_SYSCONFIG register.
1686 if (oh
->class->sysc
) {
1687 _update_sysc_cache(oh
);
1695 * _enable - enable an omap_hwmod
1696 * @oh: struct omap_hwmod *
1698 * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
1699 * register target. Returns -EINVAL if the hwmod is in the wrong
1700 * state or passes along the return value of _wait_target_ready().
1702 static int _enable(struct omap_hwmod
*oh
)
1707 pr_debug("omap_hwmod: %s: enabling\n", oh
->name
);
1710 * hwmods with HWMOD_INIT_NO_IDLE flag set are left in enabled
1711 * state at init. Now that someone is really trying to enable
1712 * them, just ensure that the hwmod mux is set.
1714 if (oh
->_int_flags
& _HWMOD_SKIP_ENABLE
) {
1716 * If the caller has mux data populated, do the mux'ing
1717 * which wouldn't have been done as part of the _enable()
1718 * done during setup.
1721 omap_hwmod_mux(oh
->mux
, _HWMOD_STATE_ENABLED
);
1723 oh
->_int_flags
&= ~_HWMOD_SKIP_ENABLE
;
1727 if (oh
->_state
!= _HWMOD_STATE_INITIALIZED
&&
1728 oh
->_state
!= _HWMOD_STATE_IDLE
&&
1729 oh
->_state
!= _HWMOD_STATE_DISABLED
) {
1730 WARN(1, "omap_hwmod: %s: enabled state can only be entered from initialized, idle, or disabled state\n",
1736 * If an IP block contains HW reset lines and any of them are
1737 * asserted, we let integration code associated with that
1738 * block handle the enable. We've received very little
1739 * information on what those driver authors need, and until
1740 * detailed information is provided and the driver code is
1741 * posted to the public lists, this is probably the best we
1744 if (_are_any_hardreset_lines_asserted(oh
))
1747 /* Mux pins for device runtime if populated */
1748 if (oh
->mux
&& (!oh
->mux
->enabled
||
1749 ((oh
->_state
== _HWMOD_STATE_IDLE
) &&
1750 oh
->mux
->pads_dynamic
)))
1751 omap_hwmod_mux(oh
->mux
, _HWMOD_STATE_ENABLED
);
1753 _add_initiator_dep(oh
, mpu_oh
);
1757 * A clockdomain must be in SW_SUP before enabling
1758 * completely the module. The clockdomain can be set
1759 * in HW_AUTO only when the module become ready.
1761 hwsup
= clkdm_in_hwsup(oh
->clkdm
);
1762 r
= clkdm_hwmod_enable(oh
->clkdm
, oh
);
1764 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1765 oh
->name
, oh
->clkdm
->name
, r
);
1771 if (soc_ops
.enable_module
)
1772 soc_ops
.enable_module(oh
);
1774 r
= (soc_ops
.wait_target_ready
) ? soc_ops
.wait_target_ready(oh
) :
1778 * Set the clockdomain to HW_AUTO only if the target is ready,
1779 * assuming that the previous state was HW_AUTO
1781 if (oh
->clkdm
&& hwsup
)
1782 clkdm_allow_idle(oh
->clkdm
);
1784 oh
->_state
= _HWMOD_STATE_ENABLED
;
1786 /* Access the sysconfig only if the target is ready */
1787 if (oh
->class->sysc
) {
1788 if (!(oh
->_int_flags
& _HWMOD_SYSCONFIG_LOADED
))
1789 _update_sysc_cache(oh
);
1793 _disable_clocks(oh
);
1794 pr_debug("omap_hwmod: %s: _wait_target_ready: %d\n",
1798 clkdm_hwmod_disable(oh
->clkdm
, oh
);
1805 * _idle - idle an omap_hwmod
1806 * @oh: struct omap_hwmod *
1808 * Idles an omap_hwmod @oh. This should be called once the hwmod has
1809 * no further work. Returns -EINVAL if the hwmod is in the wrong
1810 * state or returns 0.
1812 static int _idle(struct omap_hwmod
*oh
)
1814 pr_debug("omap_hwmod: %s: idling\n", oh
->name
);
1816 if (oh
->_state
!= _HWMOD_STATE_ENABLED
) {
1817 WARN(1, "omap_hwmod: %s: idle state can only be entered from enabled state\n",
1822 if (_are_any_hardreset_lines_asserted(oh
))
1825 if (oh
->class->sysc
)
1827 _del_initiator_dep(oh
, mpu_oh
);
1829 if (soc_ops
.disable_module
)
1830 soc_ops
.disable_module(oh
);
1833 * The module must be in idle mode before disabling any parents
1834 * clocks. Otherwise, the parent clock might be disabled before
1835 * the module transition is done, and thus will prevent the
1836 * transition to complete properly.
1838 _disable_clocks(oh
);
1840 clkdm_hwmod_disable(oh
->clkdm
, oh
);
1842 /* Mux pins for device idle if populated */
1843 if (oh
->mux
&& oh
->mux
->pads_dynamic
)
1844 omap_hwmod_mux(oh
->mux
, _HWMOD_STATE_IDLE
);
1846 oh
->_state
= _HWMOD_STATE_IDLE
;
1852 * omap_hwmod_set_ocp_autoidle - set the hwmod's OCP autoidle bit
1853 * @oh: struct omap_hwmod *
1854 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
1856 * Sets the IP block's OCP autoidle bit in hardware, and updates our
1857 * local copy. Intended to be used by drivers that require
1858 * direct manipulation of the AUTOIDLE bits.
1859 * Returns -EINVAL if @oh is null or is not in the ENABLED state, or passes
1860 * along the return value from _set_module_autoidle().
1862 * Any users of this function should be scrutinized carefully.
1864 int omap_hwmod_set_ocp_autoidle(struct omap_hwmod
*oh
, u8 autoidle
)
1868 unsigned long flags
;
1870 if (!oh
|| oh
->_state
!= _HWMOD_STATE_ENABLED
)
1873 spin_lock_irqsave(&oh
->_lock
, flags
);
1875 v
= oh
->_sysc_cache
;
1877 retval
= _set_module_autoidle(oh
, autoidle
, &v
);
1880 _write_sysconfig(v
, oh
);
1882 spin_unlock_irqrestore(&oh
->_lock
, flags
);
1888 * _shutdown - shutdown an omap_hwmod
1889 * @oh: struct omap_hwmod *
1891 * Shut down an omap_hwmod @oh. This should be called when the driver
1892 * used for the hwmod is removed or unloaded or if the driver is not
1893 * used by the system. Returns -EINVAL if the hwmod is in the wrong
1894 * state or returns 0.
1896 static int _shutdown(struct omap_hwmod
*oh
)
1901 if (oh
->_state
!= _HWMOD_STATE_IDLE
&&
1902 oh
->_state
!= _HWMOD_STATE_ENABLED
) {
1903 WARN(1, "omap_hwmod: %s: disabled state can only be entered from idle, or enabled state\n",
1908 if (_are_any_hardreset_lines_asserted(oh
))
1911 pr_debug("omap_hwmod: %s: disabling\n", oh
->name
);
1913 if (oh
->class->pre_shutdown
) {
1914 prev_state
= oh
->_state
;
1915 if (oh
->_state
== _HWMOD_STATE_IDLE
)
1917 ret
= oh
->class->pre_shutdown(oh
);
1919 if (prev_state
== _HWMOD_STATE_IDLE
)
1925 if (oh
->class->sysc
) {
1926 if (oh
->_state
== _HWMOD_STATE_IDLE
)
1931 /* clocks and deps are already disabled in idle */
1932 if (oh
->_state
== _HWMOD_STATE_ENABLED
) {
1933 _del_initiator_dep(oh
, mpu_oh
);
1934 /* XXX what about the other system initiators here? dma, dsp */
1935 if (soc_ops
.disable_module
)
1936 soc_ops
.disable_module(oh
);
1937 _disable_clocks(oh
);
1939 clkdm_hwmod_disable(oh
->clkdm
, oh
);
1941 /* XXX Should this code also force-disable the optional clocks? */
1943 for (i
= 0; i
< oh
->rst_lines_cnt
; i
++)
1944 _assert_hardreset(oh
, oh
->rst_lines
[i
].name
);
1946 /* Mux pins to safe mode or use populated off mode values */
1948 omap_hwmod_mux(oh
->mux
, _HWMOD_STATE_DISABLED
);
1950 oh
->_state
= _HWMOD_STATE_DISABLED
;
1956 * _init_mpu_rt_base - populate the virtual address for a hwmod
1957 * @oh: struct omap_hwmod * to locate the virtual address
1959 * Cache the virtual address used by the MPU to access this IP block's
1960 * registers. This address is needed early so the OCP registers that
1961 * are part of the device's address space can be ioremapped properly.
1964 static void __init
_init_mpu_rt_base(struct omap_hwmod
*oh
, void *data
)
1966 struct omap_hwmod_addr_space
*mem
;
1967 void __iomem
*va_start
;
1972 _save_mpu_port_index(oh
);
1974 if (oh
->_int_flags
& _HWMOD_NO_MPU_PORT
)
1977 mem
= _find_mpu_rt_addr_space(oh
);
1979 pr_debug("omap_hwmod: %s: no MPU register target found\n",
1984 va_start
= ioremap(mem
->pa_start
, mem
->pa_end
- mem
->pa_start
);
1986 pr_err("omap_hwmod: %s: Could not ioremap\n", oh
->name
);
1990 pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
1991 oh
->name
, va_start
);
1993 oh
->_mpu_rt_va
= va_start
;
1997 * _init - initialize internal data for the hwmod @oh
1998 * @oh: struct omap_hwmod *
2001 * Look up the clocks and the address space used by the MPU to access
2002 * registers belonging to the hwmod @oh. @oh must already be
2003 * registered at this point. This is the first of two phases for
2004 * hwmod initialization. Code called here does not touch any hardware
2005 * registers, it simply prepares internal data structures. Returns 0
2006 * upon success or if the hwmod isn't registered, or -EINVAL upon
2009 static int __init
_init(struct omap_hwmod
*oh
, void *data
)
2013 if (oh
->_state
!= _HWMOD_STATE_REGISTERED
)
2016 _init_mpu_rt_base(oh
, NULL
);
2018 r
= _init_clocks(oh
, NULL
);
2019 if (IS_ERR_VALUE(r
)) {
2020 WARN(1, "omap_hwmod: %s: couldn't init clocks\n", oh
->name
);
2024 oh
->_state
= _HWMOD_STATE_INITIALIZED
;
2030 * _setup_iclk_autoidle - configure an IP block's interface clocks
2031 * @oh: struct omap_hwmod *
2033 * Set up the module's interface clocks. XXX This function is still mostly
2034 * a stub; implementing this properly requires iclk autoidle usecounting in
2035 * the clock code. No return value.
2037 static void __init
_setup_iclk_autoidle(struct omap_hwmod
*oh
)
2039 struct omap_hwmod_ocp_if
*os
;
2040 struct list_head
*p
;
2042 if (oh
->_state
!= _HWMOD_STATE_INITIALIZED
)
2045 p
= oh
->slave_ports
.next
;
2047 while (i
< oh
->slaves_cnt
) {
2048 os
= _fetch_next_ocp_if(&p
, &i
);
2052 if (os
->flags
& OCPIF_SWSUP_IDLE
) {
2053 /* XXX omap_iclk_deny_idle(c); */
2055 /* XXX omap_iclk_allow_idle(c); */
2056 clk_enable(os
->_clk
);
2064 * _setup_reset - reset an IP block during the setup process
2065 * @oh: struct omap_hwmod *
2067 * Reset the IP block corresponding to the hwmod @oh during the setup
2068 * process. The IP block is first enabled so it can be successfully
2069 * reset. Returns 0 upon success or a negative error code upon
2072 static int __init
_setup_reset(struct omap_hwmod
*oh
)
2076 if (oh
->_state
!= _HWMOD_STATE_INITIALIZED
)
2079 if (oh
->rst_lines_cnt
== 0) {
2082 pr_warning("omap_hwmod: %s: cannot be enabled for reset (%d)\n",
2083 oh
->name
, oh
->_state
);
2088 if (!(oh
->flags
& HWMOD_INIT_NO_RESET
))
2095 * _setup_postsetup - transition to the appropriate state after _setup
2096 * @oh: struct omap_hwmod *
2098 * Place an IP block represented by @oh into a "post-setup" state --
2099 * either IDLE, ENABLED, or DISABLED. ("post-setup" simply means that
2100 * this function is called at the end of _setup().) The postsetup
2101 * state for an IP block can be changed by calling
2102 * omap_hwmod_enter_postsetup_state() early in the boot process,
2103 * before one of the omap_hwmod_setup*() functions are called for the
2106 * The IP block stays in this state until a PM runtime-based driver is
2107 * loaded for that IP block. A post-setup state of IDLE is
2108 * appropriate for almost all IP blocks with runtime PM-enabled
2109 * drivers, since those drivers are able to enable the IP block. A
2110 * post-setup state of ENABLED is appropriate for kernels with PM
2111 * runtime disabled. The DISABLED state is appropriate for unusual IP
2112 * blocks such as the MPU WDTIMER on kernels without WDTIMER drivers
2113 * included, since the WDTIMER starts running on reset and will reset
2114 * the MPU if left active.
2116 * This post-setup mechanism is deprecated. Once all of the OMAP
2117 * drivers have been converted to use PM runtime, and all of the IP
2118 * block data and interconnect data is available to the hwmod code, it
2119 * should be possible to replace this mechanism with a "lazy reset"
2120 * arrangement. In a "lazy reset" setup, each IP block is enabled
2121 * when the driver first probes, then all remaining IP blocks without
2122 * drivers are either shut down or enabled after the drivers have
2123 * loaded. However, this cannot take place until the above
2124 * preconditions have been met, since otherwise the late reset code
2125 * has no way of knowing which IP blocks are in use by drivers, and
2126 * which ones are unused.
2130 static void __init
_setup_postsetup(struct omap_hwmod
*oh
)
2134 if (oh
->rst_lines_cnt
> 0)
2137 postsetup_state
= oh
->_postsetup_state
;
2138 if (postsetup_state
== _HWMOD_STATE_UNKNOWN
)
2139 postsetup_state
= _HWMOD_STATE_ENABLED
;
2142 * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
2143 * it should be set by the core code as a runtime flag during startup
2145 if ((oh
->flags
& HWMOD_INIT_NO_IDLE
) &&
2146 (postsetup_state
== _HWMOD_STATE_IDLE
)) {
2147 oh
->_int_flags
|= _HWMOD_SKIP_ENABLE
;
2148 postsetup_state
= _HWMOD_STATE_ENABLED
;
2151 if (postsetup_state
== _HWMOD_STATE_IDLE
)
2153 else if (postsetup_state
== _HWMOD_STATE_DISABLED
)
2155 else if (postsetup_state
!= _HWMOD_STATE_ENABLED
)
2156 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
2157 oh
->name
, postsetup_state
);
2163 * _setup - prepare IP block hardware for use
2164 * @oh: struct omap_hwmod *
2165 * @n: (unused, pass NULL)
2167 * Configure the IP block represented by @oh. This may include
2168 * enabling the IP block, resetting it, and placing it into a
2169 * post-setup state, depending on the type of IP block and applicable
2170 * flags. IP blocks are reset to prevent any previous configuration
2171 * by the bootloader or previous operating system from interfering
2172 * with power management or other parts of the system. The reset can
2173 * be avoided; see omap_hwmod_no_setup_reset(). This is the second of
2174 * two phases for hwmod initialization. Code called here generally
2175 * affects the IP block hardware, or system integration hardware
2176 * associated with the IP block. Returns 0.
2178 static int __init
_setup(struct omap_hwmod
*oh
, void *data
)
2180 if (oh
->_state
!= _HWMOD_STATE_INITIALIZED
)
2183 _setup_iclk_autoidle(oh
);
2185 if (!_setup_reset(oh
))
2186 _setup_postsetup(oh
);
2192 * _register - register a struct omap_hwmod
2193 * @oh: struct omap_hwmod *
2195 * Registers the omap_hwmod @oh. Returns -EEXIST if an omap_hwmod
2196 * already has been registered by the same name; -EINVAL if the
2197 * omap_hwmod is in the wrong state, if @oh is NULL, if the
2198 * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
2199 * name, or if the omap_hwmod's class is missing a name; or 0 upon
2202 * XXX The data should be copied into bootmem, so the original data
2203 * should be marked __initdata and freed after init. This would allow
2204 * unneeded omap_hwmods to be freed on multi-OMAP configurations. Note
2205 * that the copy process would be relatively complex due to the large number
2208 static int __init
_register(struct omap_hwmod
*oh
)
2210 if (!oh
|| !oh
->name
|| !oh
->class || !oh
->class->name
||
2211 (oh
->_state
!= _HWMOD_STATE_UNKNOWN
))
2214 pr_debug("omap_hwmod: %s: registering\n", oh
->name
);
2216 if (_lookup(oh
->name
))
2219 list_add_tail(&oh
->node
, &omap_hwmod_list
);
2221 INIT_LIST_HEAD(&oh
->master_ports
);
2222 INIT_LIST_HEAD(&oh
->slave_ports
);
2223 spin_lock_init(&oh
->_lock
);
2225 oh
->_state
= _HWMOD_STATE_REGISTERED
;
2228 * XXX Rather than doing a strcmp(), this should test a flag
2229 * set in the hwmod data, inserted by the autogenerator code.
2231 if (!strcmp(oh
->name
, MPU_INITIATOR_NAME
))
2238 * _alloc_links - return allocated memory for hwmod links
2239 * @ml: pointer to a struct omap_hwmod_link * for the master link
2240 * @sl: pointer to a struct omap_hwmod_link * for the slave link
2242 * Return pointers to two struct omap_hwmod_link records, via the
2243 * addresses pointed to by @ml and @sl. Will first attempt to return
2244 * memory allocated as part of a large initial block, but if that has
2245 * been exhausted, will allocate memory itself. Since ideally this
2246 * second allocation path will never occur, the number of these
2247 * 'supplemental' allocations will be logged when debugging is
2248 * enabled. Returns 0.
2250 static int __init
_alloc_links(struct omap_hwmod_link
**ml
,
2251 struct omap_hwmod_link
**sl
)
2255 if ((free_ls
+ LINKS_PER_OCP_IF
) <= max_ls
) {
2256 *ml
= &linkspace
[free_ls
++];
2257 *sl
= &linkspace
[free_ls
++];
2261 sz
= sizeof(struct omap_hwmod_link
) * LINKS_PER_OCP_IF
;
2264 *ml
= alloc_bootmem(sz
);
2268 *sl
= (void *)(*ml
) + sizeof(struct omap_hwmod_link
);
2271 pr_debug("omap_hwmod: supplemental link allocations needed: %d\n",
2272 ls_supp
* LINKS_PER_OCP_IF
);
2278 * _add_link - add an interconnect between two IP blocks
2279 * @oi: pointer to a struct omap_hwmod_ocp_if record
2281 * Add struct omap_hwmod_link records connecting the master IP block
2282 * specified in @oi->master to @oi, and connecting the slave IP block
2283 * specified in @oi->slave to @oi. This code is assumed to run before
2284 * preemption or SMP has been enabled, thus avoiding the need for
2285 * locking in this code. Changes to this assumption will require
2286 * additional locking. Returns 0.
2288 static int __init
_add_link(struct omap_hwmod_ocp_if
*oi
)
2290 struct omap_hwmod_link
*ml
, *sl
;
2292 pr_debug("omap_hwmod: %s -> %s: adding link\n", oi
->master
->name
,
2295 _alloc_links(&ml
, &sl
);
2298 INIT_LIST_HEAD(&ml
->node
);
2299 list_add(&ml
->node
, &oi
->master
->master_ports
);
2300 oi
->master
->masters_cnt
++;
2303 INIT_LIST_HEAD(&sl
->node
);
2304 list_add(&sl
->node
, &oi
->slave
->slave_ports
);
2305 oi
->slave
->slaves_cnt
++;
2311 * _register_link - register a struct omap_hwmod_ocp_if
2312 * @oi: struct omap_hwmod_ocp_if *
2314 * Registers the omap_hwmod_ocp_if record @oi. Returns -EEXIST if it
2315 * has already been registered; -EINVAL if @oi is NULL or if the
2316 * record pointed to by @oi is missing required fields; or 0 upon
2319 * XXX The data should be copied into bootmem, so the original data
2320 * should be marked __initdata and freed after init. This would allow
2321 * unneeded omap_hwmods to be freed on multi-OMAP configurations.
2323 static int __init
_register_link(struct omap_hwmod_ocp_if
*oi
)
2325 if (!oi
|| !oi
->master
|| !oi
->slave
|| !oi
->user
)
2328 if (oi
->_int_flags
& _OCPIF_INT_FLAGS_REGISTERED
)
2331 pr_debug("omap_hwmod: registering link from %s to %s\n",
2332 oi
->master
->name
, oi
->slave
->name
);
2335 * Register the connected hwmods, if they haven't been
2336 * registered already
2338 if (oi
->master
->_state
!= _HWMOD_STATE_REGISTERED
)
2339 _register(oi
->master
);
2341 if (oi
->slave
->_state
!= _HWMOD_STATE_REGISTERED
)
2342 _register(oi
->slave
);
2346 oi
->_int_flags
|= _OCPIF_INT_FLAGS_REGISTERED
;
2352 * _alloc_linkspace - allocate large block of hwmod links
2353 * @ois: pointer to an array of struct omap_hwmod_ocp_if records to count
2355 * Allocate a large block of struct omap_hwmod_link records. This
2356 * improves boot time significantly by avoiding the need to allocate
2357 * individual records one by one. If the number of records to
2358 * allocate in the block hasn't been manually specified, this function
2359 * will count the number of struct omap_hwmod_ocp_if records in @ois
2360 * and use that to determine the allocation size. For SoC families
2361 * that require multiple list registrations, such as OMAP3xxx, this
2362 * estimation process isn't optimal, so manual estimation is advised
2363 * in those cases. Returns -EEXIST if the allocation has already occurred
2364 * or 0 upon success.
2366 static int __init
_alloc_linkspace(struct omap_hwmod_ocp_if
**ois
)
2372 WARN(1, "linkspace already allocated\n");
2378 max_ls
+= LINKS_PER_OCP_IF
;
2380 sz
= sizeof(struct omap_hwmod_link
) * max_ls
;
2382 pr_debug("omap_hwmod: %s: allocating %d byte linkspace (%d links)\n",
2383 __func__
, sz
, max_ls
);
2385 linkspace
= alloc_bootmem(sz
);
2387 memset(linkspace
, 0, sz
);
2392 /* Static functions intended only for use in soc_ops field function pointers */
2395 * _omap2_wait_target_ready - wait for a module to leave slave idle
2396 * @oh: struct omap_hwmod *
2398 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2399 * does not have an IDLEST bit or if the module successfully leaves
2400 * slave idle; otherwise, pass along the return value of the
2401 * appropriate *_cm*_wait_module_ready() function.
2403 static int _omap2_wait_target_ready(struct omap_hwmod
*oh
)
2408 if (oh
->flags
& HWMOD_NO_IDLEST
)
2411 if (!_find_mpu_rt_port(oh
))
2414 /* XXX check module SIDLEMODE, hardreset status, enabled clocks */
2416 return omap2_cm_wait_module_ready(oh
->prcm
.omap2
.module_offs
,
2417 oh
->prcm
.omap2
.idlest_reg_id
,
2418 oh
->prcm
.omap2
.idlest_idle_bit
);
2422 * _omap4_wait_target_ready - wait for a module to leave slave idle
2423 * @oh: struct omap_hwmod *
2425 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2426 * does not have an IDLEST bit or if the module successfully leaves
2427 * slave idle; otherwise, pass along the return value of the
2428 * appropriate *_cm*_wait_module_ready() function.
2430 static int _omap4_wait_target_ready(struct omap_hwmod
*oh
)
2432 if (!oh
|| !oh
->clkdm
)
2435 if (oh
->flags
& HWMOD_NO_IDLEST
)
2438 if (!_find_mpu_rt_port(oh
))
2441 /* XXX check module SIDLEMODE, hardreset status */
2443 return omap4_cminst_wait_module_ready(oh
->clkdm
->prcm_partition
,
2445 oh
->clkdm
->clkdm_offs
,
2446 oh
->prcm
.omap4
.clkctrl_offs
);
2450 * _omap2_assert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2451 * @oh: struct omap_hwmod * to assert hardreset
2452 * @ohri: hardreset line data
2454 * Call omap2_prm_assert_hardreset() with parameters extracted from
2455 * the hwmod @oh and the hardreset line data @ohri. Only intended for
2456 * use as an soc_ops function pointer. Passes along the return value
2457 * from omap2_prm_assert_hardreset(). XXX This function is scheduled
2458 * for removal when the PRM code is moved into drivers/.
2460 static int _omap2_assert_hardreset(struct omap_hwmod
*oh
,
2461 struct omap_hwmod_rst_info
*ohri
)
2463 return omap2_prm_assert_hardreset(oh
->prcm
.omap2
.module_offs
,
2468 * _omap2_deassert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2469 * @oh: struct omap_hwmod * to deassert hardreset
2470 * @ohri: hardreset line data
2472 * Call omap2_prm_deassert_hardreset() with parameters extracted from
2473 * the hwmod @oh and the hardreset line data @ohri. Only intended for
2474 * use as an soc_ops function pointer. Passes along the return value
2475 * from omap2_prm_deassert_hardreset(). XXX This function is
2476 * scheduled for removal when the PRM code is moved into drivers/.
2478 static int _omap2_deassert_hardreset(struct omap_hwmod
*oh
,
2479 struct omap_hwmod_rst_info
*ohri
)
2481 return omap2_prm_deassert_hardreset(oh
->prcm
.omap2
.module_offs
,
2487 * _omap2_is_hardreset_asserted - call OMAP2 PRM hardreset fn with hwmod args
2488 * @oh: struct omap_hwmod * to test hardreset
2489 * @ohri: hardreset line data
2491 * Call omap2_prm_is_hardreset_asserted() with parameters extracted
2492 * from the hwmod @oh and the hardreset line data @ohri. Only
2493 * intended for use as an soc_ops function pointer. Passes along the
2494 * return value from omap2_prm_is_hardreset_asserted(). XXX This
2495 * function is scheduled for removal when the PRM code is moved into
2498 static int _omap2_is_hardreset_asserted(struct omap_hwmod
*oh
,
2499 struct omap_hwmod_rst_info
*ohri
)
2501 return omap2_prm_is_hardreset_asserted(oh
->prcm
.omap2
.module_offs
,
2506 * _omap4_assert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
2507 * @oh: struct omap_hwmod * to assert hardreset
2508 * @ohri: hardreset line data
2510 * Call omap4_prminst_assert_hardreset() with parameters extracted
2511 * from the hwmod @oh and the hardreset line data @ohri. Only
2512 * intended for use as an soc_ops function pointer. Passes along the
2513 * return value from omap4_prminst_assert_hardreset(). XXX This
2514 * function is scheduled for removal when the PRM code is moved into
2517 static int _omap4_assert_hardreset(struct omap_hwmod
*oh
,
2518 struct omap_hwmod_rst_info
*ohri
)
2523 return omap4_prminst_assert_hardreset(ohri
->rst_shift
,
2524 oh
->clkdm
->pwrdm
.ptr
->prcm_partition
,
2525 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
2526 oh
->prcm
.omap4
.rstctrl_offs
);
2530 * _omap4_deassert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
2531 * @oh: struct omap_hwmod * to deassert hardreset
2532 * @ohri: hardreset line data
2534 * Call omap4_prminst_deassert_hardreset() with parameters extracted
2535 * from the hwmod @oh and the hardreset line data @ohri. Only
2536 * intended for use as an soc_ops function pointer. Passes along the
2537 * return value from omap4_prminst_deassert_hardreset(). XXX This
2538 * function is scheduled for removal when the PRM code is moved into
2541 static int _omap4_deassert_hardreset(struct omap_hwmod
*oh
,
2542 struct omap_hwmod_rst_info
*ohri
)
2548 pr_err("omap_hwmod: %s: %s: hwmod data error: OMAP4 does not support st_shift\n",
2549 oh
->name
, ohri
->name
);
2550 return omap4_prminst_deassert_hardreset(ohri
->rst_shift
,
2551 oh
->clkdm
->pwrdm
.ptr
->prcm_partition
,
2552 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
2553 oh
->prcm
.omap4
.rstctrl_offs
);
2557 * _omap4_is_hardreset_asserted - call OMAP4 PRM hardreset fn with hwmod args
2558 * @oh: struct omap_hwmod * to test hardreset
2559 * @ohri: hardreset line data
2561 * Call omap4_prminst_is_hardreset_asserted() with parameters
2562 * extracted from the hwmod @oh and the hardreset line data @ohri.
2563 * Only intended for use as an soc_ops function pointer. Passes along
2564 * the return value from omap4_prminst_is_hardreset_asserted(). XXX
2565 * This function is scheduled for removal when the PRM code is moved
2568 static int _omap4_is_hardreset_asserted(struct omap_hwmod
*oh
,
2569 struct omap_hwmod_rst_info
*ohri
)
2574 return omap4_prminst_is_hardreset_asserted(ohri
->rst_shift
,
2575 oh
->clkdm
->pwrdm
.ptr
->prcm_partition
,
2576 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
2577 oh
->prcm
.omap4
.rstctrl_offs
);
2580 /* Public functions */
2582 u32
omap_hwmod_read(struct omap_hwmod
*oh
, u16 reg_offs
)
2584 if (oh
->flags
& HWMOD_16BIT_REG
)
2585 return __raw_readw(oh
->_mpu_rt_va
+ reg_offs
);
2587 return __raw_readl(oh
->_mpu_rt_va
+ reg_offs
);
2590 void omap_hwmod_write(u32 v
, struct omap_hwmod
*oh
, u16 reg_offs
)
2592 if (oh
->flags
& HWMOD_16BIT_REG
)
2593 __raw_writew(v
, oh
->_mpu_rt_va
+ reg_offs
);
2595 __raw_writel(v
, oh
->_mpu_rt_va
+ reg_offs
);
2599 * omap_hwmod_softreset - reset a module via SYSCONFIG.SOFTRESET bit
2600 * @oh: struct omap_hwmod *
2602 * This is a public function exposed to drivers. Some drivers may need to do
2603 * some settings before and after resetting the device. Those drivers after
2604 * doing the necessary settings could use this function to start a reset by
2605 * setting the SYSCONFIG.SOFTRESET bit.
2607 int omap_hwmod_softreset(struct omap_hwmod
*oh
)
2612 if (!oh
|| !(oh
->_sysc_cache
))
2615 v
= oh
->_sysc_cache
;
2616 ret
= _set_softreset(oh
, &v
);
2619 _write_sysconfig(v
, oh
);
2626 * omap_hwmod_set_slave_idlemode - set the hwmod's OCP slave idlemode
2627 * @oh: struct omap_hwmod *
2628 * @idlemode: SIDLEMODE field bits (shifted to bit 0)
2630 * Sets the IP block's OCP slave idlemode in hardware, and updates our
2631 * local copy. Intended to be used by drivers that have some erratum
2632 * that requires direct manipulation of the SIDLEMODE bits. Returns
2633 * -EINVAL if @oh is null, or passes along the return value from
2634 * _set_slave_idlemode().
2636 * XXX Does this function have any current users? If not, we should
2637 * remove it; it is better to let the rest of the hwmod code handle this.
2638 * Any users of this function should be scrutinized carefully.
2640 int omap_hwmod_set_slave_idlemode(struct omap_hwmod
*oh
, u8 idlemode
)
2648 v
= oh
->_sysc_cache
;
2650 retval
= _set_slave_idlemode(oh
, idlemode
, &v
);
2652 _write_sysconfig(v
, oh
);
2658 * omap_hwmod_lookup - look up a registered omap_hwmod by name
2659 * @name: name of the omap_hwmod to look up
2661 * Given a @name of an omap_hwmod, return a pointer to the registered
2662 * struct omap_hwmod *, or NULL upon error.
2664 struct omap_hwmod
*omap_hwmod_lookup(const char *name
)
2666 struct omap_hwmod
*oh
;
2677 * omap_hwmod_for_each - call function for each registered omap_hwmod
2678 * @fn: pointer to a callback function
2679 * @data: void * data to pass to callback function
2681 * Call @fn for each registered omap_hwmod, passing @data to each
2682 * function. @fn must return 0 for success or any other value for
2683 * failure. If @fn returns non-zero, the iteration across omap_hwmods
2684 * will stop and the non-zero return value will be passed to the
2685 * caller of omap_hwmod_for_each(). @fn is called with
2686 * omap_hwmod_for_each() held.
2688 int omap_hwmod_for_each(int (*fn
)(struct omap_hwmod
*oh
, void *data
),
2691 struct omap_hwmod
*temp_oh
;
2697 list_for_each_entry(temp_oh
, &omap_hwmod_list
, node
) {
2698 ret
= (*fn
)(temp_oh
, data
);
2707 * omap_hwmod_register_links - register an array of hwmod links
2708 * @ois: pointer to an array of omap_hwmod_ocp_if to register
2710 * Intended to be called early in boot before the clock framework is
2711 * initialized. If @ois is not null, will register all omap_hwmods
2712 * listed in @ois that are valid for this chip. Returns -EINVAL if
2713 * omap_hwmod_init() hasn't been called before calling this function,
2714 * -ENOMEM if the link memory area can't be allocated, or 0 upon
2717 int __init
omap_hwmod_register_links(struct omap_hwmod_ocp_if
**ois
)
2728 if (_alloc_linkspace(ois
)) {
2729 pr_err("omap_hwmod: could not allocate link space\n");
2736 r
= _register_link(ois
[i
]);
2737 WARN(r
&& r
!= -EEXIST
,
2738 "omap_hwmod: _register_link(%s -> %s) returned %d\n",
2739 ois
[i
]->master
->name
, ois
[i
]->slave
->name
, r
);
2746 * _ensure_mpu_hwmod_is_setup - ensure the MPU SS hwmod is init'ed and set up
2747 * @oh: pointer to the hwmod currently being set up (usually not the MPU)
2749 * If the hwmod data corresponding to the MPU subsystem IP block
2750 * hasn't been initialized and set up yet, do so now. This must be
2751 * done first since sleep dependencies may be added from other hwmods
2752 * to the MPU. Intended to be called only by omap_hwmod_setup*(). No
2755 static void __init
_ensure_mpu_hwmod_is_setup(struct omap_hwmod
*oh
)
2757 if (!mpu_oh
|| mpu_oh
->_state
== _HWMOD_STATE_UNKNOWN
)
2758 pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",
2759 __func__
, MPU_INITIATOR_NAME
);
2760 else if (mpu_oh
->_state
== _HWMOD_STATE_REGISTERED
&& oh
!= mpu_oh
)
2761 omap_hwmod_setup_one(MPU_INITIATOR_NAME
);
2765 * omap_hwmod_setup_one - set up a single hwmod
2766 * @oh_name: const char * name of the already-registered hwmod to set up
2768 * Initialize and set up a single hwmod. Intended to be used for a
2769 * small number of early devices, such as the timer IP blocks used for
2770 * the scheduler clock. Must be called after omap2_clk_init().
2771 * Resolves the struct clk names to struct clk pointers for each
2772 * registered omap_hwmod. Also calls _setup() on each hwmod. Returns
2773 * -EINVAL upon error or 0 upon success.
2775 int __init
omap_hwmod_setup_one(const char *oh_name
)
2777 struct omap_hwmod
*oh
;
2779 pr_debug("omap_hwmod: %s: %s\n", oh_name
, __func__
);
2781 oh
= _lookup(oh_name
);
2783 WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name
);
2787 _ensure_mpu_hwmod_is_setup(oh
);
2796 * omap_hwmod_setup_all - set up all registered IP blocks
2798 * Initialize and set up all IP blocks registered with the hwmod code.
2799 * Must be called after omap2_clk_init(). Resolves the struct clk
2800 * names to struct clk pointers for each registered omap_hwmod. Also
2801 * calls _setup() on each hwmod. Returns 0 upon success.
2803 static int __init
omap_hwmod_setup_all(void)
2805 _ensure_mpu_hwmod_is_setup(NULL
);
2807 omap_hwmod_for_each(_init
, NULL
);
2808 omap_hwmod_for_each(_setup
, NULL
);
2812 core_initcall(omap_hwmod_setup_all
);
2815 * omap_hwmod_enable - enable an omap_hwmod
2816 * @oh: struct omap_hwmod *
2818 * Enable an omap_hwmod @oh. Intended to be called by omap_device_enable().
2819 * Returns -EINVAL on error or passes along the return value from _enable().
2821 int omap_hwmod_enable(struct omap_hwmod
*oh
)
2824 unsigned long flags
;
2829 spin_lock_irqsave(&oh
->_lock
, flags
);
2831 spin_unlock_irqrestore(&oh
->_lock
, flags
);
2837 * omap_hwmod_idle - idle an omap_hwmod
2838 * @oh: struct omap_hwmod *
2840 * Idle an omap_hwmod @oh. Intended to be called by omap_device_idle().
2841 * Returns -EINVAL on error or passes along the return value from _idle().
2843 int omap_hwmod_idle(struct omap_hwmod
*oh
)
2845 unsigned long flags
;
2850 spin_lock_irqsave(&oh
->_lock
, flags
);
2852 spin_unlock_irqrestore(&oh
->_lock
, flags
);
2858 * omap_hwmod_shutdown - shutdown an omap_hwmod
2859 * @oh: struct omap_hwmod *
2861 * Shutdown an omap_hwmod @oh. Intended to be called by
2862 * omap_device_shutdown(). Returns -EINVAL on error or passes along
2863 * the return value from _shutdown().
2865 int omap_hwmod_shutdown(struct omap_hwmod
*oh
)
2867 unsigned long flags
;
2872 spin_lock_irqsave(&oh
->_lock
, flags
);
2874 spin_unlock_irqrestore(&oh
->_lock
, flags
);
2880 * omap_hwmod_enable_clocks - enable main_clk, all interface clocks
2881 * @oh: struct omap_hwmod *oh
2883 * Intended to be called by the omap_device code.
2885 int omap_hwmod_enable_clocks(struct omap_hwmod
*oh
)
2887 unsigned long flags
;
2889 spin_lock_irqsave(&oh
->_lock
, flags
);
2891 spin_unlock_irqrestore(&oh
->_lock
, flags
);
2897 * omap_hwmod_disable_clocks - disable main_clk, all interface clocks
2898 * @oh: struct omap_hwmod *oh
2900 * Intended to be called by the omap_device code.
2902 int omap_hwmod_disable_clocks(struct omap_hwmod
*oh
)
2904 unsigned long flags
;
2906 spin_lock_irqsave(&oh
->_lock
, flags
);
2907 _disable_clocks(oh
);
2908 spin_unlock_irqrestore(&oh
->_lock
, flags
);
2914 * omap_hwmod_ocp_barrier - wait for posted writes against the hwmod to complete
2915 * @oh: struct omap_hwmod *oh
2917 * Intended to be called by drivers and core code when all posted
2918 * writes to a device must complete before continuing further
2919 * execution (for example, after clearing some device IRQSTATUS
2922 * XXX what about targets with multiple OCP threads?
2924 void omap_hwmod_ocp_barrier(struct omap_hwmod
*oh
)
2928 if (!oh
->class->sysc
|| !oh
->class->sysc
->sysc_flags
) {
2929 WARN(1, "omap_device: %s: OCP barrier impossible due to device configuration\n",
2935 * Forces posted writes to complete on the OCP thread handling
2938 omap_hwmod_read(oh
, oh
->class->sysc
->sysc_offs
);
2942 * omap_hwmod_reset - reset the hwmod
2943 * @oh: struct omap_hwmod *
2945 * Under some conditions, a driver may wish to reset the entire device.
2946 * Called from omap_device code. Returns -EINVAL on error or passes along
2947 * the return value from _reset().
2949 int omap_hwmod_reset(struct omap_hwmod
*oh
)
2952 unsigned long flags
;
2957 spin_lock_irqsave(&oh
->_lock
, flags
);
2959 spin_unlock_irqrestore(&oh
->_lock
, flags
);
2965 * IP block data retrieval functions
2969 * omap_hwmod_count_resources - count number of struct resources needed by hwmod
2970 * @oh: struct omap_hwmod *
2971 * @res: pointer to the first element of an array of struct resource to fill
2973 * Count the number of struct resource array elements necessary to
2974 * contain omap_hwmod @oh resources. Intended to be called by code
2975 * that registers omap_devices. Intended to be used to determine the
2976 * size of a dynamically-allocated struct resource array, before
2977 * calling omap_hwmod_fill_resources(). Returns the number of struct
2978 * resource array elements needed.
2980 * XXX This code is not optimized. It could attempt to merge adjacent
2984 int omap_hwmod_count_resources(struct omap_hwmod
*oh
)
2986 struct omap_hwmod_ocp_if
*os
;
2987 struct list_head
*p
;
2991 ret
= _count_mpu_irqs(oh
) + _count_sdma_reqs(oh
);
2993 p
= oh
->slave_ports
.next
;
2995 while (i
< oh
->slaves_cnt
) {
2996 os
= _fetch_next_ocp_if(&p
, &i
);
2997 ret
+= _count_ocp_if_addr_spaces(os
);
3004 * omap_hwmod_fill_resources - fill struct resource array with hwmod data
3005 * @oh: struct omap_hwmod *
3006 * @res: pointer to the first element of an array of struct resource to fill
3008 * Fill the struct resource array @res with resource data from the
3009 * omap_hwmod @oh. Intended to be called by code that registers
3010 * omap_devices. See also omap_hwmod_count_resources(). Returns the
3011 * number of array elements filled.
3013 int omap_hwmod_fill_resources(struct omap_hwmod
*oh
, struct resource
*res
)
3015 struct omap_hwmod_ocp_if
*os
;
3016 struct list_head
*p
;
3017 int i
, j
, mpu_irqs_cnt
, sdma_reqs_cnt
, addr_cnt
;
3020 /* For each IRQ, DMA, memory area, fill in array.*/
3022 mpu_irqs_cnt
= _count_mpu_irqs(oh
);
3023 for (i
= 0; i
< mpu_irqs_cnt
; i
++) {
3024 (res
+ r
)->name
= (oh
->mpu_irqs
+ i
)->name
;
3025 (res
+ r
)->start
= (oh
->mpu_irqs
+ i
)->irq
;
3026 (res
+ r
)->end
= (oh
->mpu_irqs
+ i
)->irq
;
3027 (res
+ r
)->flags
= IORESOURCE_IRQ
;
3031 sdma_reqs_cnt
= _count_sdma_reqs(oh
);
3032 for (i
= 0; i
< sdma_reqs_cnt
; i
++) {
3033 (res
+ r
)->name
= (oh
->sdma_reqs
+ i
)->name
;
3034 (res
+ r
)->start
= (oh
->sdma_reqs
+ i
)->dma_req
;
3035 (res
+ r
)->end
= (oh
->sdma_reqs
+ i
)->dma_req
;
3036 (res
+ r
)->flags
= IORESOURCE_DMA
;
3040 p
= oh
->slave_ports
.next
;
3043 while (i
< oh
->slaves_cnt
) {
3044 os
= _fetch_next_ocp_if(&p
, &i
);
3045 addr_cnt
= _count_ocp_if_addr_spaces(os
);
3047 for (j
= 0; j
< addr_cnt
; j
++) {
3048 (res
+ r
)->name
= (os
->addr
+ j
)->name
;
3049 (res
+ r
)->start
= (os
->addr
+ j
)->pa_start
;
3050 (res
+ r
)->end
= (os
->addr
+ j
)->pa_end
;
3051 (res
+ r
)->flags
= IORESOURCE_MEM
;
3060 * omap_hwmod_get_resource_byname - fetch IP block integration data by name
3061 * @oh: struct omap_hwmod * to operate on
3062 * @type: one of the IORESOURCE_* constants from include/linux/ioport.h
3063 * @name: pointer to the name of the data to fetch (optional)
3064 * @rsrc: pointer to a struct resource, allocated by the caller
3066 * Retrieve MPU IRQ, SDMA request line, or address space start/end
3067 * data for the IP block pointed to by @oh. The data will be filled
3068 * into a struct resource record pointed to by @rsrc. The struct
3069 * resource must be allocated by the caller. When @name is non-null,
3070 * the data associated with the matching entry in the IRQ/SDMA/address
3071 * space hwmod data arrays will be returned. If @name is null, the
3072 * first array entry will be returned. Data order is not meaningful
3073 * in hwmod data, so callers are strongly encouraged to use a non-null
3074 * @name whenever possible to avoid unpredictable effects if hwmod
3075 * data is later added that causes data ordering to change. This
3076 * function is only intended for use by OMAP core code. Device
3077 * drivers should not call this function - the appropriate bus-related
3078 * data accessor functions should be used instead. Returns 0 upon
3079 * success or a negative error code upon error.
3081 int omap_hwmod_get_resource_byname(struct omap_hwmod
*oh
, unsigned int type
,
3082 const char *name
, struct resource
*rsrc
)
3085 unsigned int irq
, dma
;
3086 u32 pa_start
, pa_end
;
3091 if (type
== IORESOURCE_IRQ
) {
3092 r
= _get_mpu_irq_by_name(oh
, name
, &irq
);
3098 } else if (type
== IORESOURCE_DMA
) {
3099 r
= _get_sdma_req_by_name(oh
, name
, &dma
);
3105 } else if (type
== IORESOURCE_MEM
) {
3106 r
= _get_addr_space_by_name(oh
, name
, &pa_start
, &pa_end
);
3110 rsrc
->start
= pa_start
;
3123 * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
3124 * @oh: struct omap_hwmod *
3126 * Return the powerdomain pointer associated with the OMAP module
3127 * @oh's main clock. If @oh does not have a main clk, return the
3128 * powerdomain associated with the interface clock associated with the
3129 * module's MPU port. (XXX Perhaps this should use the SDMA port
3130 * instead?) Returns NULL on error, or a struct powerdomain * on
3133 struct powerdomain
*omap_hwmod_get_pwrdm(struct omap_hwmod
*oh
)
3136 struct omap_hwmod_ocp_if
*oi
;
3144 oi
= _find_mpu_rt_port(oh
);
3153 return c
->clkdm
->pwrdm
.ptr
;
3158 * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
3159 * @oh: struct omap_hwmod *
3161 * Returns the virtual address corresponding to the beginning of the
3162 * module's register target, in the address range that is intended to
3163 * be used by the MPU. Returns the virtual address upon success or NULL
3166 void __iomem
*omap_hwmod_get_mpu_rt_va(struct omap_hwmod
*oh
)
3171 if (oh
->_int_flags
& _HWMOD_NO_MPU_PORT
)
3174 if (oh
->_state
== _HWMOD_STATE_UNKNOWN
)
3177 return oh
->_mpu_rt_va
;
3181 * omap_hwmod_add_initiator_dep - add sleepdep from @init_oh to @oh
3182 * @oh: struct omap_hwmod *
3183 * @init_oh: struct omap_hwmod * (initiator)
3185 * Add a sleep dependency between the initiator @init_oh and @oh.
3186 * Intended to be called by DSP/Bridge code via platform_data for the
3187 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
3188 * code needs to add/del initiator dependencies dynamically
3189 * before/after accessing a device. Returns the return value from
3190 * _add_initiator_dep().
3192 * XXX Keep a usecount in the clockdomain code
3194 int omap_hwmod_add_initiator_dep(struct omap_hwmod
*oh
,
3195 struct omap_hwmod
*init_oh
)
3197 return _add_initiator_dep(oh
, init_oh
);
3201 * XXX what about functions for drivers to save/restore ocp_sysconfig
3202 * for context save/restore operations?
3206 * omap_hwmod_del_initiator_dep - remove sleepdep from @init_oh to @oh
3207 * @oh: struct omap_hwmod *
3208 * @init_oh: struct omap_hwmod * (initiator)
3210 * Remove a sleep dependency between the initiator @init_oh and @oh.
3211 * Intended to be called by DSP/Bridge code via platform_data for the
3212 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
3213 * code needs to add/del initiator dependencies dynamically
3214 * before/after accessing a device. Returns the return value from
3215 * _del_initiator_dep().
3217 * XXX Keep a usecount in the clockdomain code
3219 int omap_hwmod_del_initiator_dep(struct omap_hwmod
*oh
,
3220 struct omap_hwmod
*init_oh
)
3222 return _del_initiator_dep(oh
, init_oh
);
3226 * omap_hwmod_enable_wakeup - allow device to wake up the system
3227 * @oh: struct omap_hwmod *
3229 * Sets the module OCP socket ENAWAKEUP bit to allow the module to
3230 * send wakeups to the PRCM, and enable I/O ring wakeup events for
3231 * this IP block if it has dynamic mux entries. Eventually this
3232 * should set PRCM wakeup registers to cause the PRCM to receive
3233 * wakeup events from the module. Does not set any wakeup routing
3234 * registers beyond this point - if the module is to wake up any other
3235 * module or subsystem, that must be set separately. Called by
3236 * omap_device code. Returns -EINVAL on error or 0 upon success.
3238 int omap_hwmod_enable_wakeup(struct omap_hwmod
*oh
)
3240 unsigned long flags
;
3243 spin_lock_irqsave(&oh
->_lock
, flags
);
3245 if (oh
->class->sysc
&&
3246 (oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
)) {
3247 v
= oh
->_sysc_cache
;
3248 _enable_wakeup(oh
, &v
);
3249 _write_sysconfig(v
, oh
);
3252 _set_idle_ioring_wakeup(oh
, true);
3253 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3259 * omap_hwmod_disable_wakeup - prevent device from waking the system
3260 * @oh: struct omap_hwmod *
3262 * Clears the module OCP socket ENAWAKEUP bit to prevent the module
3263 * from sending wakeups to the PRCM, and disable I/O ring wakeup
3264 * events for this IP block if it has dynamic mux entries. Eventually
3265 * this should clear PRCM wakeup registers to cause the PRCM to ignore
3266 * wakeup events from the module. Does not set any wakeup routing
3267 * registers beyond this point - if the module is to wake up any other
3268 * module or subsystem, that must be set separately. Called by
3269 * omap_device code. Returns -EINVAL on error or 0 upon success.
3271 int omap_hwmod_disable_wakeup(struct omap_hwmod
*oh
)
3273 unsigned long flags
;
3276 spin_lock_irqsave(&oh
->_lock
, flags
);
3278 if (oh
->class->sysc
&&
3279 (oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
)) {
3280 v
= oh
->_sysc_cache
;
3281 _disable_wakeup(oh
, &v
);
3282 _write_sysconfig(v
, oh
);
3285 _set_idle_ioring_wakeup(oh
, false);
3286 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3292 * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
3293 * contained in the hwmod module.
3294 * @oh: struct omap_hwmod *
3295 * @name: name of the reset line to lookup and assert
3297 * Some IP like dsp, ipu or iva contain processor that require
3298 * an HW reset line to be assert / deassert in order to enable fully
3299 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3300 * yet supported on this OMAP; otherwise, passes along the return value
3301 * from _assert_hardreset().
3303 int omap_hwmod_assert_hardreset(struct omap_hwmod
*oh
, const char *name
)
3306 unsigned long flags
;
3311 spin_lock_irqsave(&oh
->_lock
, flags
);
3312 ret
= _assert_hardreset(oh
, name
);
3313 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3319 * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
3320 * contained in the hwmod module.
3321 * @oh: struct omap_hwmod *
3322 * @name: name of the reset line to look up and deassert
3324 * Some IP like dsp, ipu or iva contain processor that require
3325 * an HW reset line to be assert / deassert in order to enable fully
3326 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3327 * yet supported on this OMAP; otherwise, passes along the return value
3328 * from _deassert_hardreset().
3330 int omap_hwmod_deassert_hardreset(struct omap_hwmod
*oh
, const char *name
)
3333 unsigned long flags
;
3338 spin_lock_irqsave(&oh
->_lock
, flags
);
3339 ret
= _deassert_hardreset(oh
, name
);
3340 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3346 * omap_hwmod_read_hardreset - read the HW reset line state of submodules
3347 * contained in the hwmod module
3348 * @oh: struct omap_hwmod *
3349 * @name: name of the reset line to look up and read
3351 * Return the current state of the hwmod @oh's reset line named @name:
3352 * returns -EINVAL upon parameter error or if this operation
3353 * is unsupported on the current OMAP; otherwise, passes along the return
3354 * value from _read_hardreset().
3356 int omap_hwmod_read_hardreset(struct omap_hwmod
*oh
, const char *name
)
3359 unsigned long flags
;
3364 spin_lock_irqsave(&oh
->_lock
, flags
);
3365 ret
= _read_hardreset(oh
, name
);
3366 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3373 * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
3374 * @classname: struct omap_hwmod_class name to search for
3375 * @fn: callback function pointer to call for each hwmod in class @classname
3376 * @user: arbitrary context data to pass to the callback function
3378 * For each omap_hwmod of class @classname, call @fn.
3379 * If the callback function returns something other than
3380 * zero, the iterator is terminated, and the callback function's return
3381 * value is passed back to the caller. Returns 0 upon success, -EINVAL
3382 * if @classname or @fn are NULL, or passes back the error code from @fn.
3384 int omap_hwmod_for_each_by_class(const char *classname
,
3385 int (*fn
)(struct omap_hwmod
*oh
,
3389 struct omap_hwmod
*temp_oh
;
3392 if (!classname
|| !fn
)
3395 pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
3396 __func__
, classname
);
3398 list_for_each_entry(temp_oh
, &omap_hwmod_list
, node
) {
3399 if (!strcmp(temp_oh
->class->name
, classname
)) {
3400 pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
3401 __func__
, temp_oh
->name
);
3402 ret
= (*fn
)(temp_oh
, user
);
3409 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
3416 * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
3417 * @oh: struct omap_hwmod *
3418 * @state: state that _setup() should leave the hwmod in
3420 * Sets the hwmod state that @oh will enter at the end of _setup()
3421 * (called by omap_hwmod_setup_*()). See also the documentation
3422 * for _setup_postsetup(), above. Returns 0 upon success or
3423 * -EINVAL if there is a problem with the arguments or if the hwmod is
3424 * in the wrong state.
3426 int omap_hwmod_set_postsetup_state(struct omap_hwmod
*oh
, u8 state
)
3429 unsigned long flags
;
3434 if (state
!= _HWMOD_STATE_DISABLED
&&
3435 state
!= _HWMOD_STATE_ENABLED
&&
3436 state
!= _HWMOD_STATE_IDLE
)
3439 spin_lock_irqsave(&oh
->_lock
, flags
);
3441 if (oh
->_state
!= _HWMOD_STATE_REGISTERED
) {
3446 oh
->_postsetup_state
= state
;
3450 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3456 * omap_hwmod_get_context_loss_count - get lost context count
3457 * @oh: struct omap_hwmod *
3459 * Query the powerdomain of of @oh to get the context loss
3460 * count for this device.
3462 * Returns the context loss count of the powerdomain assocated with @oh
3463 * upon success, or zero if no powerdomain exists for @oh.
3465 int omap_hwmod_get_context_loss_count(struct omap_hwmod
*oh
)
3467 struct powerdomain
*pwrdm
;
3470 pwrdm
= omap_hwmod_get_pwrdm(oh
);
3472 ret
= pwrdm_get_context_loss_count(pwrdm
);
3478 * omap_hwmod_no_setup_reset - prevent a hwmod from being reset upon setup
3479 * @oh: struct omap_hwmod *
3481 * Prevent the hwmod @oh from being reset during the setup process.
3482 * Intended for use by board-*.c files on boards with devices that
3483 * cannot tolerate being reset. Must be called before the hwmod has
3484 * been set up. Returns 0 upon success or negative error code upon
3487 int omap_hwmod_no_setup_reset(struct omap_hwmod
*oh
)
3492 if (oh
->_state
!= _HWMOD_STATE_REGISTERED
) {
3493 pr_err("omap_hwmod: %s: cannot prevent setup reset; in wrong state\n",
3498 oh
->flags
|= HWMOD_INIT_NO_RESET
;
3504 * omap_hwmod_pad_route_irq - route an I/O pad wakeup to a particular MPU IRQ
3505 * @oh: struct omap_hwmod * containing hwmod mux entries
3506 * @pad_idx: array index in oh->mux of the hwmod mux entry to route wakeup
3507 * @irq_idx: the hwmod mpu_irqs array index of the IRQ to trigger on wakeup
3509 * When an I/O pad wakeup arrives for the dynamic or wakeup hwmod mux
3510 * entry number @pad_idx for the hwmod @oh, trigger the interrupt
3511 * service routine for the hwmod's mpu_irqs array index @irq_idx. If
3512 * this function is not called for a given pad_idx, then the ISR
3513 * associated with @oh's first MPU IRQ will be triggered when an I/O
3514 * pad wakeup occurs on that pad. Note that @pad_idx is the index of
3515 * the _dynamic or wakeup_ entry: if there are other entries not
3516 * marked with OMAP_DEVICE_PAD_WAKEUP or OMAP_DEVICE_PAD_REMUX, these
3517 * entries are NOT COUNTED in the dynamic pad index. This function
3518 * must be called separately for each pad that requires its interrupt
3519 * to be re-routed this way. Returns -EINVAL if there is an argument
3520 * problem or if @oh does not have hwmod mux entries or MPU IRQs;
3521 * returns -ENOMEM if memory cannot be allocated; or 0 upon success.
3523 * XXX This function interface is fragile. Rather than using array
3524 * indexes, which are subject to unpredictable change, it should be
3525 * using hwmod IRQ names, and some other stable key for the hwmod mux
3528 int omap_hwmod_pad_route_irq(struct omap_hwmod
*oh
, int pad_idx
, int irq_idx
)
3534 if (!oh
|| !oh
->mux
|| !oh
->mpu_irqs
|| pad_idx
< 0 ||
3535 pad_idx
>= oh
->mux
->nr_pads_dynamic
)
3538 /* Check the number of available mpu_irqs */
3539 for (nr_irqs
= 0; oh
->mpu_irqs
[nr_irqs
].irq
>= 0; nr_irqs
++)
3542 if (irq_idx
>= nr_irqs
)
3545 if (!oh
->mux
->irqs
) {
3546 /* XXX What frees this? */
3547 oh
->mux
->irqs
= kzalloc(sizeof(int) * oh
->mux
->nr_pads_dynamic
,
3552 oh
->mux
->irqs
[pad_idx
] = irq_idx
;
3558 * omap_hwmod_init - initialize the hwmod code
3560 * Sets up some function pointers needed by the hwmod code to operate on the
3561 * currently-booted SoC. Intended to be called once during kernel init
3562 * before any hwmods are registered. No return value.
3564 void __init
omap_hwmod_init(void)
3566 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
3567 soc_ops
.wait_target_ready
= _omap2_wait_target_ready
;
3568 soc_ops
.assert_hardreset
= _omap2_assert_hardreset
;
3569 soc_ops
.deassert_hardreset
= _omap2_deassert_hardreset
;
3570 soc_ops
.is_hardreset_asserted
= _omap2_is_hardreset_asserted
;
3571 } else if (cpu_is_omap44xx()) {
3572 soc_ops
.enable_module
= _omap4_enable_module
;
3573 soc_ops
.disable_module
= _omap4_disable_module
;
3574 soc_ops
.wait_target_ready
= _omap4_wait_target_ready
;
3575 soc_ops
.assert_hardreset
= _omap4_assert_hardreset
;
3576 soc_ops
.deassert_hardreset
= _omap4_deassert_hardreset
;
3577 soc_ops
.is_hardreset_asserted
= _omap4_is_hardreset_asserted
;
3578 soc_ops
.init_clkdm
= _init_clkdm
;
3580 WARN(1, "omap_hwmod: unknown SoC type\n");