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
169 /* omap_hwmod_list contains all registered struct omap_hwmods */
170 static LIST_HEAD(omap_hwmod_list
);
172 /* mpu_oh: used to add/remove MPU initiator from sleepdep list */
173 static struct omap_hwmod
*mpu_oh
;
176 * linkspace: ptr to a buffer that struct omap_hwmod_link records are
177 * allocated from - used to reduce the number of small memory
178 * allocations, which has a significant impact on performance
180 static struct omap_hwmod_link
*linkspace
;
183 * free_ls, max_ls: array indexes into linkspace; representing the
184 * next free struct omap_hwmod_link index, and the maximum number of
185 * struct omap_hwmod_link records allocated (respectively)
187 static unsigned short free_ls
, max_ls
, ls_supp
;
189 /* Private functions */
192 * _fetch_next_ocp_if - return the next OCP interface in a list
193 * @p: ptr to a ptr to the list_head inside the ocp_if to return
194 * @i: pointer to the index of the element pointed to by @p in the list
196 * Return a pointer to the struct omap_hwmod_ocp_if record
197 * containing the struct list_head pointed to by @p, and increment
198 * @p such that a future call to this routine will return the next
201 static struct omap_hwmod_ocp_if
*_fetch_next_ocp_if(struct list_head
**p
,
204 struct omap_hwmod_ocp_if
*oi
;
206 oi
= list_entry(*p
, struct omap_hwmod_link
, node
)->ocp_if
;
215 * _update_sysc_cache - return the module OCP_SYSCONFIG register, keep copy
216 * @oh: struct omap_hwmod *
218 * Load the current value of the hwmod OCP_SYSCONFIG register into the
219 * struct omap_hwmod for later use. Returns -EINVAL if the hwmod has no
220 * OCP_SYSCONFIG register or 0 upon success.
222 static int _update_sysc_cache(struct omap_hwmod
*oh
)
224 if (!oh
->class->sysc
) {
225 WARN(1, "omap_hwmod: %s: cannot read OCP_SYSCONFIG: not defined on hwmod's class\n", oh
->name
);
229 /* XXX ensure module interface clock is up */
231 oh
->_sysc_cache
= omap_hwmod_read(oh
, oh
->class->sysc
->sysc_offs
);
233 if (!(oh
->class->sysc
->sysc_flags
& SYSC_NO_CACHE
))
234 oh
->_int_flags
|= _HWMOD_SYSCONFIG_LOADED
;
240 * _write_sysconfig - write a value to the module's OCP_SYSCONFIG register
241 * @v: OCP_SYSCONFIG value to write
242 * @oh: struct omap_hwmod *
244 * Write @v into the module class' OCP_SYSCONFIG register, if it has
245 * one. No return value.
247 static void _write_sysconfig(u32 v
, struct omap_hwmod
*oh
)
249 if (!oh
->class->sysc
) {
250 WARN(1, "omap_hwmod: %s: cannot write OCP_SYSCONFIG: not defined on hwmod's class\n", oh
->name
);
254 /* XXX ensure module interface clock is up */
256 /* Module might have lost context, always update cache and register */
258 omap_hwmod_write(v
, oh
, oh
->class->sysc
->sysc_offs
);
262 * _set_master_standbymode: set the OCP_SYSCONFIG MIDLEMODE field in @v
263 * @oh: struct omap_hwmod *
264 * @standbymode: MIDLEMODE field bits
265 * @v: pointer to register contents to modify
267 * Update the master standby mode bits in @v to be @standbymode for
268 * the @oh hwmod. Does not write to the hardware. Returns -EINVAL
269 * upon error or 0 upon success.
271 static int _set_master_standbymode(struct omap_hwmod
*oh
, u8 standbymode
,
277 if (!oh
->class->sysc
||
278 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_MIDLEMODE
))
281 if (!oh
->class->sysc
->sysc_fields
) {
282 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
286 mstandby_shift
= oh
->class->sysc
->sysc_fields
->midle_shift
;
287 mstandby_mask
= (0x3 << mstandby_shift
);
289 *v
&= ~mstandby_mask
;
290 *v
|= __ffs(standbymode
) << mstandby_shift
;
296 * _set_slave_idlemode: set the OCP_SYSCONFIG SIDLEMODE field in @v
297 * @oh: struct omap_hwmod *
298 * @idlemode: SIDLEMODE field bits
299 * @v: pointer to register contents to modify
301 * Update the slave idle mode bits in @v to be @idlemode for the @oh
302 * hwmod. Does not write to the hardware. Returns -EINVAL upon error
305 static int _set_slave_idlemode(struct omap_hwmod
*oh
, u8 idlemode
, u32
*v
)
310 if (!oh
->class->sysc
||
311 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_SIDLEMODE
))
314 if (!oh
->class->sysc
->sysc_fields
) {
315 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
319 sidle_shift
= oh
->class->sysc
->sysc_fields
->sidle_shift
;
320 sidle_mask
= (0x3 << sidle_shift
);
323 *v
|= __ffs(idlemode
) << sidle_shift
;
329 * _set_clockactivity: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
330 * @oh: struct omap_hwmod *
331 * @clockact: CLOCKACTIVITY field bits
332 * @v: pointer to register contents to modify
334 * Update the clockactivity mode bits in @v to be @clockact for the
335 * @oh hwmod. Used for additional powersaving on some modules. Does
336 * not write to the hardware. Returns -EINVAL upon error or 0 upon
339 static int _set_clockactivity(struct omap_hwmod
*oh
, u8 clockact
, u32
*v
)
344 if (!oh
->class->sysc
||
345 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_CLOCKACTIVITY
))
348 if (!oh
->class->sysc
->sysc_fields
) {
349 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
353 clkact_shift
= oh
->class->sysc
->sysc_fields
->clkact_shift
;
354 clkact_mask
= (0x3 << clkact_shift
);
357 *v
|= clockact
<< clkact_shift
;
363 * _set_softreset: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
364 * @oh: struct omap_hwmod *
365 * @v: pointer to register contents to modify
367 * Set the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
368 * error or 0 upon success.
370 static int _set_softreset(struct omap_hwmod
*oh
, u32
*v
)
374 if (!oh
->class->sysc
||
375 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_SOFTRESET
))
378 if (!oh
->class->sysc
->sysc_fields
) {
379 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
383 softrst_mask
= (0x1 << oh
->class->sysc
->sysc_fields
->srst_shift
);
391 * _set_module_autoidle: set the OCP_SYSCONFIG AUTOIDLE field in @v
392 * @oh: struct omap_hwmod *
393 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
394 * @v: pointer to register contents to modify
396 * Update the module autoidle bit in @v to be @autoidle for the @oh
397 * hwmod. The autoidle bit controls whether the module can gate
398 * internal clocks automatically when it isn't doing anything; the
399 * exact function of this bit varies on a per-module basis. This
400 * function does not write to the hardware. Returns -EINVAL upon
401 * error or 0 upon success.
403 static int _set_module_autoidle(struct omap_hwmod
*oh
, u8 autoidle
,
409 if (!oh
->class->sysc
||
410 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_AUTOIDLE
))
413 if (!oh
->class->sysc
->sysc_fields
) {
414 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
418 autoidle_shift
= oh
->class->sysc
->sysc_fields
->autoidle_shift
;
419 autoidle_mask
= (0x1 << autoidle_shift
);
421 *v
&= ~autoidle_mask
;
422 *v
|= autoidle
<< autoidle_shift
;
428 * _set_idle_ioring_wakeup - enable/disable IO pad wakeup on hwmod idle for mux
429 * @oh: struct omap_hwmod *
430 * @set_wake: bool value indicating to set (true) or clear (false) wakeup enable
432 * Set or clear the I/O pad wakeup flag in the mux entries for the
433 * hwmod @oh. This function changes the @oh->mux->pads_dynamic array
434 * in memory. If the hwmod is currently idled, and the new idle
435 * values don't match the previous ones, this function will also
436 * update the SCM PADCTRL registers. Otherwise, if the hwmod is not
437 * currently idled, this function won't touch the hardware: the new
438 * mux settings are written to the SCM PADCTRL registers when the
439 * hwmod is idled. No return value.
441 static void _set_idle_ioring_wakeup(struct omap_hwmod
*oh
, bool set_wake
)
443 struct omap_device_pad
*pad
;
448 if (!oh
->mux
|| !oh
->mux
->enabled
)
451 for (j
= 0; j
< oh
->mux
->nr_pads_dynamic
; j
++) {
452 pad
= oh
->mux
->pads_dynamic
[j
];
454 if (!(pad
->flags
& OMAP_DEVICE_PAD_WAKEUP
))
457 prev_idle
= pad
->idle
;
460 pad
->idle
|= OMAP_WAKEUP_EN
;
462 pad
->idle
&= ~OMAP_WAKEUP_EN
;
464 if (prev_idle
!= pad
->idle
)
468 if (change
&& oh
->_state
== _HWMOD_STATE_IDLE
)
469 omap_hwmod_mux(oh
->mux
, _HWMOD_STATE_IDLE
);
473 * _enable_wakeup: set OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
474 * @oh: struct omap_hwmod *
476 * Allow the hardware module @oh to send wakeups. Returns -EINVAL
477 * upon error or 0 upon success.
479 static int _enable_wakeup(struct omap_hwmod
*oh
, u32
*v
)
481 if (!oh
->class->sysc
||
482 !((oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
) ||
483 (oh
->class->sysc
->idlemodes
& SIDLE_SMART_WKUP
) ||
484 (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)))
487 if (!oh
->class->sysc
->sysc_fields
) {
488 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
492 if (oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
)
493 *v
|= 0x1 << oh
->class->sysc
->sysc_fields
->enwkup_shift
;
495 if (oh
->class->sysc
->idlemodes
& SIDLE_SMART_WKUP
)
496 _set_slave_idlemode(oh
, HWMOD_IDLEMODE_SMART_WKUP
, v
);
497 if (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)
498 _set_master_standbymode(oh
, HWMOD_IDLEMODE_SMART_WKUP
, v
);
500 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
502 oh
->_int_flags
|= _HWMOD_WAKEUP_ENABLED
;
508 * _disable_wakeup: clear OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
509 * @oh: struct omap_hwmod *
511 * Prevent the hardware module @oh to send wakeups. Returns -EINVAL
512 * upon error or 0 upon success.
514 static int _disable_wakeup(struct omap_hwmod
*oh
, u32
*v
)
516 if (!oh
->class->sysc
||
517 !((oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
) ||
518 (oh
->class->sysc
->idlemodes
& SIDLE_SMART_WKUP
) ||
519 (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)))
522 if (!oh
->class->sysc
->sysc_fields
) {
523 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh
->name
);
527 if (oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
)
528 *v
&= ~(0x1 << oh
->class->sysc
->sysc_fields
->enwkup_shift
);
530 if (oh
->class->sysc
->idlemodes
& SIDLE_SMART_WKUP
)
531 _set_slave_idlemode(oh
, HWMOD_IDLEMODE_SMART
, v
);
532 if (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)
533 _set_master_standbymode(oh
, HWMOD_IDLEMODE_SMART
, v
);
535 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
537 oh
->_int_flags
&= ~_HWMOD_WAKEUP_ENABLED
;
543 * _add_initiator_dep: prevent @oh from smart-idling while @init_oh is active
544 * @oh: struct omap_hwmod *
546 * Prevent the hardware module @oh from entering idle while the
547 * hardare module initiator @init_oh is active. Useful when a module
548 * will be accessed by a particular initiator (e.g., if a module will
549 * be accessed by the IVA, there should be a sleepdep between the IVA
550 * initiator and the module). Only applies to modules in smart-idle
551 * mode. If the clockdomain is marked as not needing autodeps, return
552 * 0 without doing anything. Otherwise, returns -EINVAL upon error or
553 * passes along clkdm_add_sleepdep() value upon success.
555 static int _add_initiator_dep(struct omap_hwmod
*oh
, struct omap_hwmod
*init_oh
)
560 if (oh
->_clk
->clkdm
&& oh
->_clk
->clkdm
->flags
& CLKDM_NO_AUTODEPS
)
563 return clkdm_add_sleepdep(oh
->_clk
->clkdm
, init_oh
->_clk
->clkdm
);
567 * _del_initiator_dep: allow @oh to smart-idle even if @init_oh is active
568 * @oh: struct omap_hwmod *
570 * Allow the hardware module @oh to enter idle while the hardare
571 * module initiator @init_oh is active. Useful when a module will not
572 * be accessed by a particular initiator (e.g., if a module will not
573 * be accessed by the IVA, there should be no sleepdep between the IVA
574 * initiator and the module). Only applies to modules in smart-idle
575 * mode. If the clockdomain is marked as not needing autodeps, return
576 * 0 without doing anything. Returns -EINVAL upon error or passes
577 * along clkdm_del_sleepdep() value upon success.
579 static int _del_initiator_dep(struct omap_hwmod
*oh
, struct omap_hwmod
*init_oh
)
584 if (oh
->_clk
->clkdm
&& oh
->_clk
->clkdm
->flags
& CLKDM_NO_AUTODEPS
)
587 return clkdm_del_sleepdep(oh
->_clk
->clkdm
, init_oh
->_clk
->clkdm
);
591 * _init_main_clk - get a struct clk * for the the hwmod's main functional clk
592 * @oh: struct omap_hwmod *
594 * Called from _init_clocks(). Populates the @oh _clk (main
595 * functional clock pointer) if a main_clk is present. Returns 0 on
596 * success or -EINVAL on error.
598 static int _init_main_clk(struct omap_hwmod
*oh
)
605 oh
->_clk
= omap_clk_get_by_name(oh
->main_clk
);
607 pr_warning("omap_hwmod: %s: cannot clk_get main_clk %s\n",
608 oh
->name
, oh
->main_clk
);
612 if (!oh
->_clk
->clkdm
)
613 pr_warning("omap_hwmod: %s: missing clockdomain for %s.\n",
614 oh
->main_clk
, oh
->_clk
->name
);
620 * _init_interface_clks - get a struct clk * for the the hwmod's interface clks
621 * @oh: struct omap_hwmod *
623 * Called from _init_clocks(). Populates the @oh OCP slave interface
624 * clock pointers. Returns 0 on success or -EINVAL on error.
626 static int _init_interface_clks(struct omap_hwmod
*oh
)
628 struct omap_hwmod_ocp_if
*os
;
634 p
= oh
->slave_ports
.next
;
636 while (i
< oh
->slaves_cnt
) {
637 os
= _fetch_next_ocp_if(&p
, &i
);
641 c
= omap_clk_get_by_name(os
->clk
);
643 pr_warning("omap_hwmod: %s: cannot clk_get interface_clk %s\n",
654 * _init_opt_clk - get a struct clk * for the the hwmod's optional clocks
655 * @oh: struct omap_hwmod *
657 * Called from _init_clocks(). Populates the @oh omap_hwmod_opt_clk
658 * clock pointers. Returns 0 on success or -EINVAL on error.
660 static int _init_opt_clks(struct omap_hwmod
*oh
)
662 struct omap_hwmod_opt_clk
*oc
;
667 for (i
= oh
->opt_clks_cnt
, oc
= oh
->opt_clks
; i
> 0; i
--, oc
++) {
668 c
= omap_clk_get_by_name(oc
->clk
);
670 pr_warning("omap_hwmod: %s: cannot clk_get opt_clk %s\n",
681 * _enable_clocks - enable hwmod main clock and interface clocks
682 * @oh: struct omap_hwmod *
684 * Enables all clocks necessary for register reads and writes to succeed
685 * on the hwmod @oh. Returns 0.
687 static int _enable_clocks(struct omap_hwmod
*oh
)
689 struct omap_hwmod_ocp_if
*os
;
693 pr_debug("omap_hwmod: %s: enabling clocks\n", oh
->name
);
696 clk_enable(oh
->_clk
);
698 p
= oh
->slave_ports
.next
;
700 while (i
< oh
->slaves_cnt
) {
701 os
= _fetch_next_ocp_if(&p
, &i
);
703 if (os
->_clk
&& (os
->flags
& OCPIF_SWSUP_IDLE
))
704 clk_enable(os
->_clk
);
707 /* The opt clocks are controlled by the device driver. */
713 * _disable_clocks - disable hwmod main clock and interface clocks
714 * @oh: struct omap_hwmod *
716 * Disables the hwmod @oh main functional and interface clocks. Returns 0.
718 static int _disable_clocks(struct omap_hwmod
*oh
)
720 struct omap_hwmod_ocp_if
*os
;
724 pr_debug("omap_hwmod: %s: disabling clocks\n", oh
->name
);
727 clk_disable(oh
->_clk
);
729 p
= oh
->slave_ports
.next
;
731 while (i
< oh
->slaves_cnt
) {
732 os
= _fetch_next_ocp_if(&p
, &i
);
734 if (os
->_clk
&& (os
->flags
& OCPIF_SWSUP_IDLE
))
735 clk_disable(os
->_clk
);
738 /* The opt clocks are controlled by the device driver. */
743 static void _enable_optional_clocks(struct omap_hwmod
*oh
)
745 struct omap_hwmod_opt_clk
*oc
;
748 pr_debug("omap_hwmod: %s: enabling optional clocks\n", oh
->name
);
750 for (i
= oh
->opt_clks_cnt
, oc
= oh
->opt_clks
; i
> 0; i
--, oc
++)
752 pr_debug("omap_hwmod: enable %s:%s\n", oc
->role
,
754 clk_enable(oc
->_clk
);
758 static void _disable_optional_clocks(struct omap_hwmod
*oh
)
760 struct omap_hwmod_opt_clk
*oc
;
763 pr_debug("omap_hwmod: %s: disabling optional clocks\n", oh
->name
);
765 for (i
= oh
->opt_clks_cnt
, oc
= oh
->opt_clks
; i
> 0; i
--, oc
++)
767 pr_debug("omap_hwmod: disable %s:%s\n", oc
->role
,
769 clk_disable(oc
->_clk
);
774 * _enable_module - enable CLKCTRL modulemode on OMAP4
775 * @oh: struct omap_hwmod *
777 * Enables the PRCM module mode related to the hwmod @oh.
780 static void _enable_module(struct omap_hwmod
*oh
)
782 /* The module mode does not exist prior OMAP4 */
783 if (cpu_is_omap24xx() || cpu_is_omap34xx())
786 if (!oh
->clkdm
|| !oh
->prcm
.omap4
.modulemode
)
789 pr_debug("omap_hwmod: %s: _enable_module: %d\n",
790 oh
->name
, oh
->prcm
.omap4
.modulemode
);
792 omap4_cminst_module_enable(oh
->prcm
.omap4
.modulemode
,
793 oh
->clkdm
->prcm_partition
,
795 oh
->clkdm
->clkdm_offs
,
796 oh
->prcm
.omap4
.clkctrl_offs
);
800 * _omap4_wait_target_disable - wait for a module to be disabled on OMAP4
801 * @oh: struct omap_hwmod *
803 * Wait for a module @oh to enter slave idle. Returns 0 if the module
804 * does not have an IDLEST bit or if the module successfully enters
805 * slave idle; otherwise, pass along the return value of the
806 * appropriate *_cm*_wait_module_idle() function.
808 static int _omap4_wait_target_disable(struct omap_hwmod
*oh
)
810 if (!cpu_is_omap44xx())
816 if (oh
->_int_flags
& _HWMOD_NO_MPU_PORT
)
819 if (oh
->flags
& HWMOD_NO_IDLEST
)
822 return omap4_cminst_wait_module_idle(oh
->clkdm
->prcm_partition
,
824 oh
->clkdm
->clkdm_offs
,
825 oh
->prcm
.omap4
.clkctrl_offs
);
829 * _count_mpu_irqs - count the number of MPU IRQ lines associated with @oh
830 * @oh: struct omap_hwmod *oh
832 * Count and return the number of MPU IRQs associated with the hwmod
833 * @oh. Used to allocate struct resource data. Returns 0 if @oh is
836 static int _count_mpu_irqs(struct omap_hwmod
*oh
)
838 struct omap_hwmod_irq_info
*ohii
;
841 if (!oh
|| !oh
->mpu_irqs
)
845 ohii
= &oh
->mpu_irqs
[i
++];
846 } while (ohii
->irq
!= -1);
852 * _count_sdma_reqs - count the number of SDMA request lines associated with @oh
853 * @oh: struct omap_hwmod *oh
855 * Count and return the number of SDMA request lines associated with
856 * the hwmod @oh. Used to allocate struct resource data. Returns 0
859 static int _count_sdma_reqs(struct omap_hwmod
*oh
)
861 struct omap_hwmod_dma_info
*ohdi
;
864 if (!oh
|| !oh
->sdma_reqs
)
868 ohdi
= &oh
->sdma_reqs
[i
++];
869 } while (ohdi
->dma_req
!= -1);
875 * _count_ocp_if_addr_spaces - count the number of address space entries for @oh
876 * @oh: struct omap_hwmod *oh
878 * Count and return the number of address space ranges associated with
879 * the hwmod @oh. Used to allocate struct resource data. Returns 0
882 static int _count_ocp_if_addr_spaces(struct omap_hwmod_ocp_if
*os
)
884 struct omap_hwmod_addr_space
*mem
;
887 if (!os
|| !os
->addr
)
891 mem
= &os
->addr
[i
++];
892 } while (mem
->pa_start
!= mem
->pa_end
);
898 * _get_mpu_irq_by_name - fetch MPU interrupt line number by name
899 * @oh: struct omap_hwmod * to operate on
900 * @name: pointer to the name of the MPU interrupt number to fetch (optional)
901 * @irq: pointer to an unsigned int to store the MPU IRQ number to
903 * Retrieve a MPU hardware IRQ line number named by @name associated
904 * with the IP block pointed to by @oh. The IRQ number will be filled
905 * into the address pointed to by @dma. When @name is non-null, the
906 * IRQ line number associated with the named entry will be returned.
907 * If @name is null, the first matching entry will be returned. Data
908 * order is not meaningful in hwmod data, so callers are strongly
909 * encouraged to use a non-null @name whenever possible to avoid
910 * unpredictable effects if hwmod data is later added that causes data
911 * ordering to change. Returns 0 upon success or a negative error
914 static int _get_mpu_irq_by_name(struct omap_hwmod
*oh
, const char *name
,
924 while (oh
->mpu_irqs
[i
].irq
!= -1) {
925 if (name
== oh
->mpu_irqs
[i
].name
||
926 !strcmp(name
, oh
->mpu_irqs
[i
].name
)) {
936 *irq
= oh
->mpu_irqs
[i
].irq
;
942 * _get_sdma_req_by_name - fetch SDMA request line ID by name
943 * @oh: struct omap_hwmod * to operate on
944 * @name: pointer to the name of the SDMA request line to fetch (optional)
945 * @dma: pointer to an unsigned int to store the request line ID to
947 * Retrieve an SDMA request line ID named by @name on the IP block
948 * pointed to by @oh. The ID will be filled into the address pointed
949 * to by @dma. When @name is non-null, the request line ID associated
950 * with the named entry will be returned. If @name is null, the first
951 * matching entry will be returned. Data order is not meaningful in
952 * hwmod data, so callers are strongly encouraged to use a non-null
953 * @name whenever possible to avoid unpredictable effects if hwmod
954 * data is later added that causes data ordering to change. Returns 0
955 * upon success or a negative error code upon error.
957 static int _get_sdma_req_by_name(struct omap_hwmod
*oh
, const char *name
,
967 while (oh
->sdma_reqs
[i
].dma_req
!= -1) {
968 if (name
== oh
->sdma_reqs
[i
].name
||
969 !strcmp(name
, oh
->sdma_reqs
[i
].name
)) {
979 *dma
= oh
->sdma_reqs
[i
].dma_req
;
985 * _get_addr_space_by_name - fetch address space start & end by name
986 * @oh: struct omap_hwmod * to operate on
987 * @name: pointer to the name of the address space to fetch (optional)
988 * @pa_start: pointer to a u32 to store the starting address to
989 * @pa_end: pointer to a u32 to store the ending address to
991 * Retrieve address space start and end addresses for the IP block
992 * pointed to by @oh. The data will be filled into the addresses
993 * pointed to by @pa_start and @pa_end. When @name is non-null, the
994 * address space data associated with the named entry will be
995 * returned. If @name is null, the first matching entry will be
996 * returned. Data order is not meaningful in hwmod data, so callers
997 * are strongly encouraged to use a non-null @name whenever possible
998 * to avoid unpredictable effects if hwmod data is later added that
999 * causes data ordering to change. Returns 0 upon success or a
1000 * negative error code upon error.
1002 static int _get_addr_space_by_name(struct omap_hwmod
*oh
, const char *name
,
1003 u32
*pa_start
, u32
*pa_end
)
1006 struct omap_hwmod_ocp_if
*os
;
1007 struct list_head
*p
= NULL
;
1010 p
= oh
->slave_ports
.next
;
1013 while (i
< oh
->slaves_cnt
) {
1014 os
= _fetch_next_ocp_if(&p
, &i
);
1020 while (os
->addr
[j
].pa_start
!= os
->addr
[j
].pa_end
) {
1021 if (name
== os
->addr
[j
].name
||
1022 !strcmp(name
, os
->addr
[j
].name
)) {
1036 *pa_start
= os
->addr
[j
].pa_start
;
1037 *pa_end
= os
->addr
[j
].pa_end
;
1043 * _save_mpu_port_index - find and save the index to @oh's MPU port
1044 * @oh: struct omap_hwmod *
1046 * Determines the array index of the OCP slave port that the MPU uses
1047 * to address the device, and saves it into the struct omap_hwmod.
1048 * Intended to be called during hwmod registration only. No return
1051 static void __init
_save_mpu_port_index(struct omap_hwmod
*oh
)
1053 struct omap_hwmod_ocp_if
*os
= NULL
;
1054 struct list_head
*p
;
1060 oh
->_int_flags
|= _HWMOD_NO_MPU_PORT
;
1062 p
= oh
->slave_ports
.next
;
1064 while (i
< oh
->slaves_cnt
) {
1065 os
= _fetch_next_ocp_if(&p
, &i
);
1066 if (os
->user
& OCP_USER_MPU
) {
1068 oh
->_int_flags
&= ~_HWMOD_NO_MPU_PORT
;
1077 * _find_mpu_rt_port - return omap_hwmod_ocp_if accessible by the MPU
1078 * @oh: struct omap_hwmod *
1080 * Given a pointer to a struct omap_hwmod record @oh, return a pointer
1081 * to the struct omap_hwmod_ocp_if record that is used by the MPU to
1082 * communicate with the IP block. This interface need not be directly
1083 * connected to the MPU (and almost certainly is not), but is directly
1084 * connected to the IP block represented by @oh. Returns a pointer
1085 * to the struct omap_hwmod_ocp_if * upon success, or returns NULL upon
1086 * error or if there does not appear to be a path from the MPU to this
1089 static struct omap_hwmod_ocp_if
*_find_mpu_rt_port(struct omap_hwmod
*oh
)
1091 if (!oh
|| oh
->_int_flags
& _HWMOD_NO_MPU_PORT
|| oh
->slaves_cnt
== 0)
1094 return oh
->_mpu_port
;
1098 * _find_mpu_rt_addr_space - return MPU register target address space for @oh
1099 * @oh: struct omap_hwmod *
1101 * Returns a pointer to the struct omap_hwmod_addr_space record representing
1102 * the register target MPU address space; or returns NULL upon error.
1104 static struct omap_hwmod_addr_space
* __init
_find_mpu_rt_addr_space(struct omap_hwmod
*oh
)
1106 struct omap_hwmod_ocp_if
*os
;
1107 struct omap_hwmod_addr_space
*mem
;
1108 int found
= 0, i
= 0;
1110 os
= _find_mpu_rt_port(oh
);
1111 if (!os
|| !os
->addr
)
1115 mem
= &os
->addr
[i
++];
1116 if (mem
->flags
& ADDR_TYPE_RT
)
1118 } while (!found
&& mem
->pa_start
!= mem
->pa_end
);
1120 return (found
) ? mem
: NULL
;
1124 * _enable_sysc - try to bring a module out of idle via OCP_SYSCONFIG
1125 * @oh: struct omap_hwmod *
1127 * If module is marked as SWSUP_SIDLE, force the module out of slave
1128 * idle; otherwise, configure it for smart-idle. If module is marked
1129 * as SWSUP_MSUSPEND, force the module out of master standby;
1130 * otherwise, configure it for smart-standby. No return value.
1132 static void _enable_sysc(struct omap_hwmod
*oh
)
1137 if (!oh
->class->sysc
)
1140 v
= oh
->_sysc_cache
;
1141 sf
= oh
->class->sysc
->sysc_flags
;
1143 if (sf
& SYSC_HAS_SIDLEMODE
) {
1144 idlemode
= (oh
->flags
& HWMOD_SWSUP_SIDLE
) ?
1145 HWMOD_IDLEMODE_NO
: HWMOD_IDLEMODE_SMART
;
1146 _set_slave_idlemode(oh
, idlemode
, &v
);
1149 if (sf
& SYSC_HAS_MIDLEMODE
) {
1150 if (oh
->flags
& HWMOD_SWSUP_MSTANDBY
) {
1151 idlemode
= HWMOD_IDLEMODE_NO
;
1153 if (sf
& SYSC_HAS_ENAWAKEUP
)
1154 _enable_wakeup(oh
, &v
);
1155 if (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)
1156 idlemode
= HWMOD_IDLEMODE_SMART_WKUP
;
1158 idlemode
= HWMOD_IDLEMODE_SMART
;
1160 _set_master_standbymode(oh
, idlemode
, &v
);
1164 * XXX The clock framework should handle this, by
1165 * calling into this code. But this must wait until the
1166 * clock structures are tagged with omap_hwmod entries
1168 if ((oh
->flags
& HWMOD_SET_DEFAULT_CLOCKACT
) &&
1169 (sf
& SYSC_HAS_CLOCKACTIVITY
))
1170 _set_clockactivity(oh
, oh
->class->sysc
->clockact
, &v
);
1172 /* If slave is in SMARTIDLE, also enable wakeup */
1173 if ((sf
& SYSC_HAS_SIDLEMODE
) && !(oh
->flags
& HWMOD_SWSUP_SIDLE
))
1174 _enable_wakeup(oh
, &v
);
1176 _write_sysconfig(v
, oh
);
1179 * Set the autoidle bit only after setting the smartidle bit
1180 * Setting this will not have any impact on the other modules.
1182 if (sf
& SYSC_HAS_AUTOIDLE
) {
1183 idlemode
= (oh
->flags
& HWMOD_NO_OCP_AUTOIDLE
) ?
1185 _set_module_autoidle(oh
, idlemode
, &v
);
1186 _write_sysconfig(v
, oh
);
1191 * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
1192 * @oh: struct omap_hwmod *
1194 * If module is marked as SWSUP_SIDLE, force the module into slave
1195 * idle; otherwise, configure it for smart-idle. If module is marked
1196 * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
1197 * configure it for smart-standby. No return value.
1199 static void _idle_sysc(struct omap_hwmod
*oh
)
1204 if (!oh
->class->sysc
)
1207 v
= oh
->_sysc_cache
;
1208 sf
= oh
->class->sysc
->sysc_flags
;
1210 if (sf
& SYSC_HAS_SIDLEMODE
) {
1211 idlemode
= (oh
->flags
& HWMOD_SWSUP_SIDLE
) ?
1212 HWMOD_IDLEMODE_FORCE
: HWMOD_IDLEMODE_SMART
;
1213 _set_slave_idlemode(oh
, idlemode
, &v
);
1216 if (sf
& SYSC_HAS_MIDLEMODE
) {
1217 if (oh
->flags
& HWMOD_SWSUP_MSTANDBY
) {
1218 idlemode
= HWMOD_IDLEMODE_FORCE
;
1220 if (sf
& SYSC_HAS_ENAWAKEUP
)
1221 _enable_wakeup(oh
, &v
);
1222 if (oh
->class->sysc
->idlemodes
& MSTANDBY_SMART_WKUP
)
1223 idlemode
= HWMOD_IDLEMODE_SMART_WKUP
;
1225 idlemode
= HWMOD_IDLEMODE_SMART
;
1227 _set_master_standbymode(oh
, idlemode
, &v
);
1230 /* If slave is in SMARTIDLE, also enable wakeup */
1231 if ((sf
& SYSC_HAS_SIDLEMODE
) && !(oh
->flags
& HWMOD_SWSUP_SIDLE
))
1232 _enable_wakeup(oh
, &v
);
1234 _write_sysconfig(v
, oh
);
1238 * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
1239 * @oh: struct omap_hwmod *
1241 * Force the module into slave idle and master suspend. No return
1244 static void _shutdown_sysc(struct omap_hwmod
*oh
)
1249 if (!oh
->class->sysc
)
1252 v
= oh
->_sysc_cache
;
1253 sf
= oh
->class->sysc
->sysc_flags
;
1255 if (sf
& SYSC_HAS_SIDLEMODE
)
1256 _set_slave_idlemode(oh
, HWMOD_IDLEMODE_FORCE
, &v
);
1258 if (sf
& SYSC_HAS_MIDLEMODE
)
1259 _set_master_standbymode(oh
, HWMOD_IDLEMODE_FORCE
, &v
);
1261 if (sf
& SYSC_HAS_AUTOIDLE
)
1262 _set_module_autoidle(oh
, 1, &v
);
1264 _write_sysconfig(v
, oh
);
1268 * _lookup - find an omap_hwmod by name
1269 * @name: find an omap_hwmod by name
1271 * Return a pointer to an omap_hwmod by name, or NULL if not found.
1273 static struct omap_hwmod
*_lookup(const char *name
)
1275 struct omap_hwmod
*oh
, *temp_oh
;
1279 list_for_each_entry(temp_oh
, &omap_hwmod_list
, node
) {
1280 if (!strcmp(name
, temp_oh
->name
)) {
1289 * _init_clkdm - look up a clockdomain name, store pointer in omap_hwmod
1290 * @oh: struct omap_hwmod *
1292 * Convert a clockdomain name stored in a struct omap_hwmod into a
1293 * clockdomain pointer, and save it into the struct omap_hwmod.
1294 * return -EINVAL if clkdm_name does not exist or if the lookup failed.
1296 static int _init_clkdm(struct omap_hwmod
*oh
)
1298 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1301 if (!oh
->clkdm_name
) {
1302 pr_warning("omap_hwmod: %s: no clkdm_name\n", oh
->name
);
1306 oh
->clkdm
= clkdm_lookup(oh
->clkdm_name
);
1308 pr_warning("omap_hwmod: %s: could not associate to clkdm %s\n",
1309 oh
->name
, oh
->clkdm_name
);
1313 pr_debug("omap_hwmod: %s: associated to clkdm %s\n",
1314 oh
->name
, oh
->clkdm_name
);
1320 * _init_clocks - clk_get() all clocks associated with this hwmod. Retrieve as
1321 * well the clockdomain.
1322 * @oh: struct omap_hwmod *
1323 * @data: not used; pass NULL
1325 * Called by omap_hwmod_setup_*() (after omap2_clk_init()).
1326 * Resolves all clock names embedded in the hwmod. Returns 0 on
1327 * success, or a negative error code on failure.
1329 static int _init_clocks(struct omap_hwmod
*oh
, void *data
)
1333 if (oh
->_state
!= _HWMOD_STATE_REGISTERED
)
1336 pr_debug("omap_hwmod: %s: looking up clocks\n", oh
->name
);
1338 ret
|= _init_main_clk(oh
);
1339 ret
|= _init_interface_clks(oh
);
1340 ret
|= _init_opt_clks(oh
);
1341 ret
|= _init_clkdm(oh
);
1344 oh
->_state
= _HWMOD_STATE_CLKS_INITED
;
1346 pr_warning("omap_hwmod: %s: cannot _init_clocks\n", oh
->name
);
1352 * _wait_target_ready - wait for a module to leave slave idle
1353 * @oh: struct omap_hwmod *
1355 * Wait for a module @oh to leave slave idle. Returns 0 if the module
1356 * does not have an IDLEST bit or if the module successfully leaves
1357 * slave idle; otherwise, pass along the return value of the
1358 * appropriate *_cm*_wait_module_ready() function.
1360 static int _wait_target_ready(struct omap_hwmod
*oh
)
1362 struct omap_hwmod_ocp_if
*os
;
1368 if (oh
->flags
& HWMOD_NO_IDLEST
)
1371 os
= _find_mpu_rt_port(oh
);
1375 /* XXX check module SIDLEMODE */
1377 /* XXX check clock enable states */
1379 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1380 ret
= omap2_cm_wait_module_ready(oh
->prcm
.omap2
.module_offs
,
1381 oh
->prcm
.omap2
.idlest_reg_id
,
1382 oh
->prcm
.omap2
.idlest_idle_bit
);
1383 } else if (cpu_is_omap44xx()) {
1387 ret
= omap4_cminst_wait_module_ready(oh
->clkdm
->prcm_partition
,
1389 oh
->clkdm
->clkdm_offs
,
1390 oh
->prcm
.omap4
.clkctrl_offs
);
1399 * _lookup_hardreset - fill register bit info for this hwmod/reset line
1400 * @oh: struct omap_hwmod *
1401 * @name: name of the reset line in the context of this hwmod
1402 * @ohri: struct omap_hwmod_rst_info * that this function will fill in
1404 * Return the bit position of the reset line that match the
1405 * input name. Return -ENOENT if not found.
1407 static u8
_lookup_hardreset(struct omap_hwmod
*oh
, const char *name
,
1408 struct omap_hwmod_rst_info
*ohri
)
1412 for (i
= 0; i
< oh
->rst_lines_cnt
; i
++) {
1413 const char *rst_line
= oh
->rst_lines
[i
].name
;
1414 if (!strcmp(rst_line
, name
)) {
1415 ohri
->rst_shift
= oh
->rst_lines
[i
].rst_shift
;
1416 ohri
->st_shift
= oh
->rst_lines
[i
].st_shift
;
1417 pr_debug("omap_hwmod: %s: %s: %s: rst %d st %d\n",
1418 oh
->name
, __func__
, rst_line
, ohri
->rst_shift
,
1429 * _assert_hardreset - assert the HW reset line of submodules
1430 * contained in the hwmod module.
1431 * @oh: struct omap_hwmod *
1432 * @name: name of the reset line to lookup and assert
1434 * Some IP like dsp, ipu or iva contain processor that require
1435 * an HW reset line to be assert / deassert in order to enable fully
1438 static int _assert_hardreset(struct omap_hwmod
*oh
, const char *name
)
1440 struct omap_hwmod_rst_info ohri
;
1446 ret
= _lookup_hardreset(oh
, name
, &ohri
);
1447 if (IS_ERR_VALUE(ret
))
1450 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1451 return omap2_prm_assert_hardreset(oh
->prcm
.omap2
.module_offs
,
1453 else if (cpu_is_omap44xx())
1454 return omap4_prminst_assert_hardreset(ohri
.rst_shift
,
1455 oh
->clkdm
->pwrdm
.ptr
->prcm_partition
,
1456 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
1457 oh
->prcm
.omap4
.rstctrl_offs
);
1463 * _deassert_hardreset - deassert the HW reset line of submodules contained
1464 * in the hwmod module.
1465 * @oh: struct omap_hwmod *
1466 * @name: name of the reset line to look up and deassert
1468 * Some IP like dsp, ipu or iva contain processor that require
1469 * an HW reset line to be assert / deassert in order to enable fully
1472 static int _deassert_hardreset(struct omap_hwmod
*oh
, const char *name
)
1474 struct omap_hwmod_rst_info ohri
;
1480 ret
= _lookup_hardreset(oh
, name
, &ohri
);
1481 if (IS_ERR_VALUE(ret
))
1484 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1485 ret
= omap2_prm_deassert_hardreset(oh
->prcm
.omap2
.module_offs
,
1488 } else if (cpu_is_omap44xx()) {
1490 pr_err("omap_hwmod: %s: %s: hwmod data error: OMAP4 does not support st_shift\n",
1492 ret
= omap4_prminst_deassert_hardreset(ohri
.rst_shift
,
1493 oh
->clkdm
->pwrdm
.ptr
->prcm_partition
,
1494 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
1495 oh
->prcm
.omap4
.rstctrl_offs
);
1501 pr_warning("omap_hwmod: %s: failed to hardreset\n", oh
->name
);
1507 * _read_hardreset - read the HW reset line state of submodules
1508 * contained in the hwmod module
1509 * @oh: struct omap_hwmod *
1510 * @name: name of the reset line to look up and read
1512 * Return the state of the reset line.
1514 static int _read_hardreset(struct omap_hwmod
*oh
, const char *name
)
1516 struct omap_hwmod_rst_info ohri
;
1522 ret
= _lookup_hardreset(oh
, name
, &ohri
);
1523 if (IS_ERR_VALUE(ret
))
1526 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1527 return omap2_prm_is_hardreset_asserted(oh
->prcm
.omap2
.module_offs
,
1529 } else if (cpu_is_omap44xx()) {
1530 return omap4_prminst_is_hardreset_asserted(ohri
.rst_shift
,
1531 oh
->clkdm
->pwrdm
.ptr
->prcm_partition
,
1532 oh
->clkdm
->pwrdm
.ptr
->prcm_offs
,
1533 oh
->prcm
.omap4
.rstctrl_offs
);
1540 * _are_any_hardreset_lines_asserted - return true if part of @oh is hard-reset
1541 * @oh: struct omap_hwmod *
1543 * If any hardreset line associated with @oh is asserted, then return true.
1544 * Otherwise, if @oh has no hardreset lines associated with it, or if
1545 * no hardreset lines associated with @oh are asserted, then return false.
1546 * This function is used to avoid executing some parts of the IP block
1547 * enable/disable sequence if a hardreset line is set.
1549 static bool _are_any_hardreset_lines_asserted(struct omap_hwmod
*oh
)
1553 if (oh
->rst_lines_cnt
== 0)
1556 for (i
= 0; i
< oh
->rst_lines_cnt
; i
++)
1557 if (_read_hardreset(oh
, oh
->rst_lines
[i
].name
) > 0)
1564 * _omap4_disable_module - enable CLKCTRL modulemode on OMAP4
1565 * @oh: struct omap_hwmod *
1567 * Disable the PRCM module mode related to the hwmod @oh.
1568 * Return EINVAL if the modulemode is not supported and 0 in case of success.
1570 static int _omap4_disable_module(struct omap_hwmod
*oh
)
1574 /* The module mode does not exist prior OMAP4 */
1575 if (!cpu_is_omap44xx())
1578 if (!oh
->clkdm
|| !oh
->prcm
.omap4
.modulemode
)
1581 pr_debug("omap_hwmod: %s: %s\n", oh
->name
, __func__
);
1583 omap4_cminst_module_disable(oh
->clkdm
->prcm_partition
,
1585 oh
->clkdm
->clkdm_offs
,
1586 oh
->prcm
.omap4
.clkctrl_offs
);
1588 if (_are_any_hardreset_lines_asserted(oh
))
1591 v
= _omap4_wait_target_disable(oh
);
1593 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1600 * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1601 * @oh: struct omap_hwmod *
1603 * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit. hwmod must be
1604 * enabled for this to work. Returns -ENOENT if the hwmod cannot be
1605 * reset this way, -EINVAL if the hwmod is in the wrong state,
1606 * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1608 * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1609 * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1610 * use the SYSCONFIG softreset bit to provide the status.
1612 * Note that some IP like McBSP do have reset control but don't have
1615 static int _ocp_softreset(struct omap_hwmod
*oh
)
1617 u32 v
, softrst_mask
;
1621 if (!oh
->class->sysc
||
1622 !(oh
->class->sysc
->sysc_flags
& SYSC_HAS_SOFTRESET
))
1625 /* clocks must be on for this operation */
1626 if (oh
->_state
!= _HWMOD_STATE_ENABLED
) {
1627 pr_warning("omap_hwmod: %s: reset can only be entered from "
1628 "enabled state\n", oh
->name
);
1632 /* For some modules, all optionnal clocks need to be enabled as well */
1633 if (oh
->flags
& HWMOD_CONTROL_OPT_CLKS_IN_RESET
)
1634 _enable_optional_clocks(oh
);
1636 pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh
->name
);
1638 v
= oh
->_sysc_cache
;
1639 ret
= _set_softreset(oh
, &v
);
1642 _write_sysconfig(v
, oh
);
1644 if (oh
->class->sysc
->srst_udelay
)
1645 udelay(oh
->class->sysc
->srst_udelay
);
1647 if (oh
->class->sysc
->sysc_flags
& SYSS_HAS_RESET_STATUS
)
1648 omap_test_timeout((omap_hwmod_read(oh
,
1649 oh
->class->sysc
->syss_offs
)
1650 & SYSS_RESETDONE_MASK
),
1651 MAX_MODULE_SOFTRESET_WAIT
, c
);
1652 else if (oh
->class->sysc
->sysc_flags
& SYSC_HAS_RESET_STATUS
) {
1653 softrst_mask
= (0x1 << oh
->class->sysc
->sysc_fields
->srst_shift
);
1654 omap_test_timeout(!(omap_hwmod_read(oh
,
1655 oh
->class->sysc
->sysc_offs
)
1657 MAX_MODULE_SOFTRESET_WAIT
, c
);
1660 if (c
== MAX_MODULE_SOFTRESET_WAIT
)
1661 pr_warning("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1662 oh
->name
, MAX_MODULE_SOFTRESET_WAIT
);
1664 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh
->name
, c
);
1667 * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1668 * _wait_target_ready() or _reset()
1671 ret
= (c
== MAX_MODULE_SOFTRESET_WAIT
) ? -ETIMEDOUT
: 0;
1674 if (oh
->flags
& HWMOD_CONTROL_OPT_CLKS_IN_RESET
)
1675 _disable_optional_clocks(oh
);
1681 * _reset - reset an omap_hwmod
1682 * @oh: struct omap_hwmod *
1684 * Resets an omap_hwmod @oh. If the module has a custom reset
1685 * function pointer defined, then call it to reset the IP block, and
1686 * pass along its return value to the caller. Otherwise, if the IP
1687 * block has an OCP_SYSCONFIG register with a SOFTRESET bitfield
1688 * associated with it, call a function to reset the IP block via that
1689 * method, and pass along the return value to the caller. Finally, if
1690 * the IP block has some hardreset lines associated with it, assert
1691 * all of those, but do _not_ deassert them. (This is because driver
1692 * authors have expressed an apparent requirement to control the
1693 * deassertion of the hardreset lines themselves.)
1695 * The default software reset mechanism for most OMAP IP blocks is
1696 * triggered via the OCP_SYSCONFIG.SOFTRESET bit. However, some
1697 * hwmods cannot be reset via this method. Some are not targets and
1698 * therefore have no OCP header registers to access. Others (like the
1699 * IVA) have idiosyncratic reset sequences. So for these relatively
1700 * rare cases, custom reset code can be supplied in the struct
1701 * omap_hwmod_class .reset function pointer. Passes along the return
1702 * value from either _ocp_softreset() or the custom reset function -
1703 * these must return -EINVAL if the hwmod cannot be reset this way or
1704 * if the hwmod is in the wrong state, -ETIMEDOUT if the module did
1705 * not reset in time, or 0 upon success.
1707 static int _reset(struct omap_hwmod
*oh
)
1711 pr_debug("omap_hwmod: %s: resetting\n", oh
->name
);
1713 if (oh
->class->reset
) {
1714 r
= oh
->class->reset(oh
);
1716 if (oh
->rst_lines_cnt
> 0) {
1717 for (i
= 0; i
< oh
->rst_lines_cnt
; i
++)
1718 _assert_hardreset(oh
, oh
->rst_lines
[i
].name
);
1721 r
= _ocp_softreset(oh
);
1728 * OCP_SYSCONFIG bits need to be reprogrammed after a
1729 * softreset. The _enable() function should be split to avoid
1730 * the rewrite of the OCP_SYSCONFIG register.
1732 if (oh
->class->sysc
) {
1733 _update_sysc_cache(oh
);
1741 * _enable - enable an omap_hwmod
1742 * @oh: struct omap_hwmod *
1744 * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
1745 * register target. Returns -EINVAL if the hwmod is in the wrong
1746 * state or passes along the return value of _wait_target_ready().
1748 static int _enable(struct omap_hwmod
*oh
)
1753 pr_debug("omap_hwmod: %s: enabling\n", oh
->name
);
1756 * hwmods with HWMOD_INIT_NO_IDLE flag set are left in enabled
1757 * state at init. Now that someone is really trying to enable
1758 * them, just ensure that the hwmod mux is set.
1760 if (oh
->_int_flags
& _HWMOD_SKIP_ENABLE
) {
1762 * If the caller has mux data populated, do the mux'ing
1763 * which wouldn't have been done as part of the _enable()
1764 * done during setup.
1767 omap_hwmod_mux(oh
->mux
, _HWMOD_STATE_ENABLED
);
1769 oh
->_int_flags
&= ~_HWMOD_SKIP_ENABLE
;
1773 if (oh
->_state
!= _HWMOD_STATE_INITIALIZED
&&
1774 oh
->_state
!= _HWMOD_STATE_IDLE
&&
1775 oh
->_state
!= _HWMOD_STATE_DISABLED
) {
1776 WARN(1, "omap_hwmod: %s: enabled state can only be entered from initialized, idle, or disabled state\n",
1782 * If an IP block contains HW reset lines and any of them are
1783 * asserted, we let integration code associated with that
1784 * block handle the enable. We've received very little
1785 * information on what those driver authors need, and until
1786 * detailed information is provided and the driver code is
1787 * posted to the public lists, this is probably the best we
1790 if (_are_any_hardreset_lines_asserted(oh
))
1793 /* Mux pins for device runtime if populated */
1794 if (oh
->mux
&& (!oh
->mux
->enabled
||
1795 ((oh
->_state
== _HWMOD_STATE_IDLE
) &&
1796 oh
->mux
->pads_dynamic
)))
1797 omap_hwmod_mux(oh
->mux
, _HWMOD_STATE_ENABLED
);
1799 _add_initiator_dep(oh
, mpu_oh
);
1803 * A clockdomain must be in SW_SUP before enabling
1804 * completely the module. The clockdomain can be set
1805 * in HW_AUTO only when the module become ready.
1807 hwsup
= clkdm_in_hwsup(oh
->clkdm
);
1808 r
= clkdm_hwmod_enable(oh
->clkdm
, oh
);
1810 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1811 oh
->name
, oh
->clkdm
->name
, r
);
1819 r
= _wait_target_ready(oh
);
1822 * Set the clockdomain to HW_AUTO only if the target is ready,
1823 * assuming that the previous state was HW_AUTO
1825 if (oh
->clkdm
&& hwsup
)
1826 clkdm_allow_idle(oh
->clkdm
);
1828 oh
->_state
= _HWMOD_STATE_ENABLED
;
1830 /* Access the sysconfig only if the target is ready */
1831 if (oh
->class->sysc
) {
1832 if (!(oh
->_int_flags
& _HWMOD_SYSCONFIG_LOADED
))
1833 _update_sysc_cache(oh
);
1837 _disable_clocks(oh
);
1838 pr_debug("omap_hwmod: %s: _wait_target_ready: %d\n",
1842 clkdm_hwmod_disable(oh
->clkdm
, oh
);
1849 * _idle - idle an omap_hwmod
1850 * @oh: struct omap_hwmod *
1852 * Idles an omap_hwmod @oh. This should be called once the hwmod has
1853 * no further work. Returns -EINVAL if the hwmod is in the wrong
1854 * state or returns 0.
1856 static int _idle(struct omap_hwmod
*oh
)
1858 pr_debug("omap_hwmod: %s: idling\n", oh
->name
);
1860 if (oh
->_state
!= _HWMOD_STATE_ENABLED
) {
1861 WARN(1, "omap_hwmod: %s: idle state can only be entered from enabled state\n",
1866 if (_are_any_hardreset_lines_asserted(oh
))
1869 if (oh
->class->sysc
)
1871 _del_initiator_dep(oh
, mpu_oh
);
1873 _omap4_disable_module(oh
);
1876 * The module must be in idle mode before disabling any parents
1877 * clocks. Otherwise, the parent clock might be disabled before
1878 * the module transition is done, and thus will prevent the
1879 * transition to complete properly.
1881 _disable_clocks(oh
);
1883 clkdm_hwmod_disable(oh
->clkdm
, oh
);
1885 /* Mux pins for device idle if populated */
1886 if (oh
->mux
&& oh
->mux
->pads_dynamic
)
1887 omap_hwmod_mux(oh
->mux
, _HWMOD_STATE_IDLE
);
1889 oh
->_state
= _HWMOD_STATE_IDLE
;
1895 * omap_hwmod_set_ocp_autoidle - set the hwmod's OCP autoidle bit
1896 * @oh: struct omap_hwmod *
1897 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
1899 * Sets the IP block's OCP autoidle bit in hardware, and updates our
1900 * local copy. Intended to be used by drivers that require
1901 * direct manipulation of the AUTOIDLE bits.
1902 * Returns -EINVAL if @oh is null or is not in the ENABLED state, or passes
1903 * along the return value from _set_module_autoidle().
1905 * Any users of this function should be scrutinized carefully.
1907 int omap_hwmod_set_ocp_autoidle(struct omap_hwmod
*oh
, u8 autoidle
)
1911 unsigned long flags
;
1913 if (!oh
|| oh
->_state
!= _HWMOD_STATE_ENABLED
)
1916 spin_lock_irqsave(&oh
->_lock
, flags
);
1918 v
= oh
->_sysc_cache
;
1920 retval
= _set_module_autoidle(oh
, autoidle
, &v
);
1923 _write_sysconfig(v
, oh
);
1925 spin_unlock_irqrestore(&oh
->_lock
, flags
);
1931 * _shutdown - shutdown an omap_hwmod
1932 * @oh: struct omap_hwmod *
1934 * Shut down an omap_hwmod @oh. This should be called when the driver
1935 * used for the hwmod is removed or unloaded or if the driver is not
1936 * used by the system. Returns -EINVAL if the hwmod is in the wrong
1937 * state or returns 0.
1939 static int _shutdown(struct omap_hwmod
*oh
)
1944 if (oh
->_state
!= _HWMOD_STATE_IDLE
&&
1945 oh
->_state
!= _HWMOD_STATE_ENABLED
) {
1946 WARN(1, "omap_hwmod: %s: disabled state can only be entered from idle, or enabled state\n",
1951 if (_are_any_hardreset_lines_asserted(oh
))
1954 pr_debug("omap_hwmod: %s: disabling\n", oh
->name
);
1956 if (oh
->class->pre_shutdown
) {
1957 prev_state
= oh
->_state
;
1958 if (oh
->_state
== _HWMOD_STATE_IDLE
)
1960 ret
= oh
->class->pre_shutdown(oh
);
1962 if (prev_state
== _HWMOD_STATE_IDLE
)
1968 if (oh
->class->sysc
) {
1969 if (oh
->_state
== _HWMOD_STATE_IDLE
)
1974 /* clocks and deps are already disabled in idle */
1975 if (oh
->_state
== _HWMOD_STATE_ENABLED
) {
1976 _del_initiator_dep(oh
, mpu_oh
);
1977 /* XXX what about the other system initiators here? dma, dsp */
1978 _omap4_disable_module(oh
);
1979 _disable_clocks(oh
);
1981 clkdm_hwmod_disable(oh
->clkdm
, oh
);
1983 /* XXX Should this code also force-disable the optional clocks? */
1985 for (i
= 0; i
< oh
->rst_lines_cnt
; i
++)
1986 _assert_hardreset(oh
, oh
->rst_lines
[i
].name
);
1988 /* Mux pins to safe mode or use populated off mode values */
1990 omap_hwmod_mux(oh
->mux
, _HWMOD_STATE_DISABLED
);
1992 oh
->_state
= _HWMOD_STATE_DISABLED
;
1998 * _init_mpu_rt_base - populate the virtual address for a hwmod
1999 * @oh: struct omap_hwmod * to locate the virtual address
2001 * Cache the virtual address used by the MPU to access this IP block's
2002 * registers. This address is needed early so the OCP registers that
2003 * are part of the device's address space can be ioremapped properly.
2006 static void __init
_init_mpu_rt_base(struct omap_hwmod
*oh
, void *data
)
2008 struct omap_hwmod_addr_space
*mem
;
2009 void __iomem
*va_start
;
2014 _save_mpu_port_index(oh
);
2016 if (oh
->_int_flags
& _HWMOD_NO_MPU_PORT
)
2019 mem
= _find_mpu_rt_addr_space(oh
);
2021 pr_debug("omap_hwmod: %s: no MPU register target found\n",
2026 va_start
= ioremap(mem
->pa_start
, mem
->pa_end
- mem
->pa_start
);
2028 pr_err("omap_hwmod: %s: Could not ioremap\n", oh
->name
);
2032 pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
2033 oh
->name
, va_start
);
2035 oh
->_mpu_rt_va
= va_start
;
2039 * _init - initialize internal data for the hwmod @oh
2040 * @oh: struct omap_hwmod *
2043 * Look up the clocks and the address space used by the MPU to access
2044 * registers belonging to the hwmod @oh. @oh must already be
2045 * registered at this point. This is the first of two phases for
2046 * hwmod initialization. Code called here does not touch any hardware
2047 * registers, it simply prepares internal data structures. Returns 0
2048 * upon success or if the hwmod isn't registered, or -EINVAL upon
2051 static int __init
_init(struct omap_hwmod
*oh
, void *data
)
2055 if (oh
->_state
!= _HWMOD_STATE_REGISTERED
)
2058 _init_mpu_rt_base(oh
, NULL
);
2060 r
= _init_clocks(oh
, NULL
);
2061 if (IS_ERR_VALUE(r
)) {
2062 WARN(1, "omap_hwmod: %s: couldn't init clocks\n", oh
->name
);
2066 oh
->_state
= _HWMOD_STATE_INITIALIZED
;
2072 * _setup_iclk_autoidle - configure an IP block's interface clocks
2073 * @oh: struct omap_hwmod *
2075 * Set up the module's interface clocks. XXX This function is still mostly
2076 * a stub; implementing this properly requires iclk autoidle usecounting in
2077 * the clock code. No return value.
2079 static void __init
_setup_iclk_autoidle(struct omap_hwmod
*oh
)
2081 struct omap_hwmod_ocp_if
*os
;
2082 struct list_head
*p
;
2084 if (oh
->_state
!= _HWMOD_STATE_INITIALIZED
)
2087 p
= oh
->slave_ports
.next
;
2089 while (i
< oh
->slaves_cnt
) {
2090 os
= _fetch_next_ocp_if(&p
, &i
);
2094 if (os
->flags
& OCPIF_SWSUP_IDLE
) {
2095 /* XXX omap_iclk_deny_idle(c); */
2097 /* XXX omap_iclk_allow_idle(c); */
2098 clk_enable(os
->_clk
);
2106 * _setup_reset - reset an IP block during the setup process
2107 * @oh: struct omap_hwmod *
2109 * Reset the IP block corresponding to the hwmod @oh during the setup
2110 * process. The IP block is first enabled so it can be successfully
2111 * reset. Returns 0 upon success or a negative error code upon
2114 static int __init
_setup_reset(struct omap_hwmod
*oh
)
2118 if (oh
->_state
!= _HWMOD_STATE_INITIALIZED
)
2121 if (oh
->rst_lines_cnt
== 0) {
2124 pr_warning("omap_hwmod: %s: cannot be enabled for reset (%d)\n",
2125 oh
->name
, oh
->_state
);
2130 if (!(oh
->flags
& HWMOD_INIT_NO_RESET
))
2137 * _setup_postsetup - transition to the appropriate state after _setup
2138 * @oh: struct omap_hwmod *
2140 * Place an IP block represented by @oh into a "post-setup" state --
2141 * either IDLE, ENABLED, or DISABLED. ("post-setup" simply means that
2142 * this function is called at the end of _setup().) The postsetup
2143 * state for an IP block can be changed by calling
2144 * omap_hwmod_enter_postsetup_state() early in the boot process,
2145 * before one of the omap_hwmod_setup*() functions are called for the
2148 * The IP block stays in this state until a PM runtime-based driver is
2149 * loaded for that IP block. A post-setup state of IDLE is
2150 * appropriate for almost all IP blocks with runtime PM-enabled
2151 * drivers, since those drivers are able to enable the IP block. A
2152 * post-setup state of ENABLED is appropriate for kernels with PM
2153 * runtime disabled. The DISABLED state is appropriate for unusual IP
2154 * blocks such as the MPU WDTIMER on kernels without WDTIMER drivers
2155 * included, since the WDTIMER starts running on reset and will reset
2156 * the MPU if left active.
2158 * This post-setup mechanism is deprecated. Once all of the OMAP
2159 * drivers have been converted to use PM runtime, and all of the IP
2160 * block data and interconnect data is available to the hwmod code, it
2161 * should be possible to replace this mechanism with a "lazy reset"
2162 * arrangement. In a "lazy reset" setup, each IP block is enabled
2163 * when the driver first probes, then all remaining IP blocks without
2164 * drivers are either shut down or enabled after the drivers have
2165 * loaded. However, this cannot take place until the above
2166 * preconditions have been met, since otherwise the late reset code
2167 * has no way of knowing which IP blocks are in use by drivers, and
2168 * which ones are unused.
2172 static void __init
_setup_postsetup(struct omap_hwmod
*oh
)
2176 if (oh
->rst_lines_cnt
> 0)
2179 postsetup_state
= oh
->_postsetup_state
;
2180 if (postsetup_state
== _HWMOD_STATE_UNKNOWN
)
2181 postsetup_state
= _HWMOD_STATE_ENABLED
;
2184 * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
2185 * it should be set by the core code as a runtime flag during startup
2187 if ((oh
->flags
& HWMOD_INIT_NO_IDLE
) &&
2188 (postsetup_state
== _HWMOD_STATE_IDLE
)) {
2189 oh
->_int_flags
|= _HWMOD_SKIP_ENABLE
;
2190 postsetup_state
= _HWMOD_STATE_ENABLED
;
2193 if (postsetup_state
== _HWMOD_STATE_IDLE
)
2195 else if (postsetup_state
== _HWMOD_STATE_DISABLED
)
2197 else if (postsetup_state
!= _HWMOD_STATE_ENABLED
)
2198 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
2199 oh
->name
, postsetup_state
);
2205 * _setup - prepare IP block hardware for use
2206 * @oh: struct omap_hwmod *
2207 * @n: (unused, pass NULL)
2209 * Configure the IP block represented by @oh. This may include
2210 * enabling the IP block, resetting it, and placing it into a
2211 * post-setup state, depending on the type of IP block and applicable
2212 * flags. IP blocks are reset to prevent any previous configuration
2213 * by the bootloader or previous operating system from interfering
2214 * with power management or other parts of the system. The reset can
2215 * be avoided; see omap_hwmod_no_setup_reset(). This is the second of
2216 * two phases for hwmod initialization. Code called here generally
2217 * affects the IP block hardware, or system integration hardware
2218 * associated with the IP block. Returns 0.
2220 static int __init
_setup(struct omap_hwmod
*oh
, void *data
)
2222 if (oh
->_state
!= _HWMOD_STATE_INITIALIZED
)
2225 _setup_iclk_autoidle(oh
);
2227 if (!_setup_reset(oh
))
2228 _setup_postsetup(oh
);
2234 * _register - register a struct omap_hwmod
2235 * @oh: struct omap_hwmod *
2237 * Registers the omap_hwmod @oh. Returns -EEXIST if an omap_hwmod
2238 * already has been registered by the same name; -EINVAL if the
2239 * omap_hwmod is in the wrong state, if @oh is NULL, if the
2240 * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
2241 * name, or if the omap_hwmod's class is missing a name; or 0 upon
2244 * XXX The data should be copied into bootmem, so the original data
2245 * should be marked __initdata and freed after init. This would allow
2246 * unneeded omap_hwmods to be freed on multi-OMAP configurations. Note
2247 * that the copy process would be relatively complex due to the large number
2250 static int __init
_register(struct omap_hwmod
*oh
)
2252 if (!oh
|| !oh
->name
|| !oh
->class || !oh
->class->name
||
2253 (oh
->_state
!= _HWMOD_STATE_UNKNOWN
))
2256 pr_debug("omap_hwmod: %s: registering\n", oh
->name
);
2258 if (_lookup(oh
->name
))
2261 list_add_tail(&oh
->node
, &omap_hwmod_list
);
2263 INIT_LIST_HEAD(&oh
->master_ports
);
2264 INIT_LIST_HEAD(&oh
->slave_ports
);
2265 spin_lock_init(&oh
->_lock
);
2267 oh
->_state
= _HWMOD_STATE_REGISTERED
;
2270 * XXX Rather than doing a strcmp(), this should test a flag
2271 * set in the hwmod data, inserted by the autogenerator code.
2273 if (!strcmp(oh
->name
, MPU_INITIATOR_NAME
))
2280 * _alloc_links - return allocated memory for hwmod links
2281 * @ml: pointer to a struct omap_hwmod_link * for the master link
2282 * @sl: pointer to a struct omap_hwmod_link * for the slave link
2284 * Return pointers to two struct omap_hwmod_link records, via the
2285 * addresses pointed to by @ml and @sl. Will first attempt to return
2286 * memory allocated as part of a large initial block, but if that has
2287 * been exhausted, will allocate memory itself. Since ideally this
2288 * second allocation path will never occur, the number of these
2289 * 'supplemental' allocations will be logged when debugging is
2290 * enabled. Returns 0.
2292 static int __init
_alloc_links(struct omap_hwmod_link
**ml
,
2293 struct omap_hwmod_link
**sl
)
2297 if ((free_ls
+ LINKS_PER_OCP_IF
) <= max_ls
) {
2298 *ml
= &linkspace
[free_ls
++];
2299 *sl
= &linkspace
[free_ls
++];
2303 sz
= sizeof(struct omap_hwmod_link
) * LINKS_PER_OCP_IF
;
2306 *ml
= alloc_bootmem(sz
);
2310 *sl
= (void *)(*ml
) + sizeof(struct omap_hwmod_link
);
2313 pr_debug("omap_hwmod: supplemental link allocations needed: %d\n",
2314 ls_supp
* LINKS_PER_OCP_IF
);
2320 * _add_link - add an interconnect between two IP blocks
2321 * @oi: pointer to a struct omap_hwmod_ocp_if record
2323 * Add struct omap_hwmod_link records connecting the master IP block
2324 * specified in @oi->master to @oi, and connecting the slave IP block
2325 * specified in @oi->slave to @oi. This code is assumed to run before
2326 * preemption or SMP has been enabled, thus avoiding the need for
2327 * locking in this code. Changes to this assumption will require
2328 * additional locking. Returns 0.
2330 static int __init
_add_link(struct omap_hwmod_ocp_if
*oi
)
2332 struct omap_hwmod_link
*ml
, *sl
;
2334 pr_debug("omap_hwmod: %s -> %s: adding link\n", oi
->master
->name
,
2337 _alloc_links(&ml
, &sl
);
2340 INIT_LIST_HEAD(&ml
->node
);
2341 list_add(&ml
->node
, &oi
->master
->master_ports
);
2342 oi
->master
->masters_cnt
++;
2345 INIT_LIST_HEAD(&sl
->node
);
2346 list_add(&sl
->node
, &oi
->slave
->slave_ports
);
2347 oi
->slave
->slaves_cnt
++;
2353 * _register_link - register a struct omap_hwmod_ocp_if
2354 * @oi: struct omap_hwmod_ocp_if *
2356 * Registers the omap_hwmod_ocp_if record @oi. Returns -EEXIST if it
2357 * has already been registered; -EINVAL if @oi is NULL or if the
2358 * record pointed to by @oi is missing required fields; or 0 upon
2361 * XXX The data should be copied into bootmem, so the original data
2362 * should be marked __initdata and freed after init. This would allow
2363 * unneeded omap_hwmods to be freed on multi-OMAP configurations.
2365 static int __init
_register_link(struct omap_hwmod_ocp_if
*oi
)
2367 if (!oi
|| !oi
->master
|| !oi
->slave
|| !oi
->user
)
2370 if (oi
->_int_flags
& _OCPIF_INT_FLAGS_REGISTERED
)
2373 pr_debug("omap_hwmod: registering link from %s to %s\n",
2374 oi
->master
->name
, oi
->slave
->name
);
2377 * Register the connected hwmods, if they haven't been
2378 * registered already
2380 if (oi
->master
->_state
!= _HWMOD_STATE_REGISTERED
)
2381 _register(oi
->master
);
2383 if (oi
->slave
->_state
!= _HWMOD_STATE_REGISTERED
)
2384 _register(oi
->slave
);
2388 oi
->_int_flags
|= _OCPIF_INT_FLAGS_REGISTERED
;
2394 * _alloc_linkspace - allocate large block of hwmod links
2395 * @ois: pointer to an array of struct omap_hwmod_ocp_if records to count
2397 * Allocate a large block of struct omap_hwmod_link records. This
2398 * improves boot time significantly by avoiding the need to allocate
2399 * individual records one by one. If the number of records to
2400 * allocate in the block hasn't been manually specified, this function
2401 * will count the number of struct omap_hwmod_ocp_if records in @ois
2402 * and use that to determine the allocation size. For SoC families
2403 * that require multiple list registrations, such as OMAP3xxx, this
2404 * estimation process isn't optimal, so manual estimation is advised
2405 * in those cases. Returns -EEXIST if the allocation has already occurred
2406 * or 0 upon success.
2408 static int __init
_alloc_linkspace(struct omap_hwmod_ocp_if
**ois
)
2414 WARN(1, "linkspace already allocated\n");
2420 max_ls
+= LINKS_PER_OCP_IF
;
2422 sz
= sizeof(struct omap_hwmod_link
) * max_ls
;
2424 pr_debug("omap_hwmod: %s: allocating %d byte linkspace (%d links)\n",
2425 __func__
, sz
, max_ls
);
2427 linkspace
= alloc_bootmem(sz
);
2429 memset(linkspace
, 0, sz
);
2434 /* Public functions */
2436 u32
omap_hwmod_read(struct omap_hwmod
*oh
, u16 reg_offs
)
2438 if (oh
->flags
& HWMOD_16BIT_REG
)
2439 return __raw_readw(oh
->_mpu_rt_va
+ reg_offs
);
2441 return __raw_readl(oh
->_mpu_rt_va
+ reg_offs
);
2444 void omap_hwmod_write(u32 v
, struct omap_hwmod
*oh
, u16 reg_offs
)
2446 if (oh
->flags
& HWMOD_16BIT_REG
)
2447 __raw_writew(v
, oh
->_mpu_rt_va
+ reg_offs
);
2449 __raw_writel(v
, oh
->_mpu_rt_va
+ reg_offs
);
2453 * omap_hwmod_softreset - reset a module via SYSCONFIG.SOFTRESET bit
2454 * @oh: struct omap_hwmod *
2456 * This is a public function exposed to drivers. Some drivers may need to do
2457 * some settings before and after resetting the device. Those drivers after
2458 * doing the necessary settings could use this function to start a reset by
2459 * setting the SYSCONFIG.SOFTRESET bit.
2461 int omap_hwmod_softreset(struct omap_hwmod
*oh
)
2466 if (!oh
|| !(oh
->_sysc_cache
))
2469 v
= oh
->_sysc_cache
;
2470 ret
= _set_softreset(oh
, &v
);
2473 _write_sysconfig(v
, oh
);
2480 * omap_hwmod_set_slave_idlemode - set the hwmod's OCP slave idlemode
2481 * @oh: struct omap_hwmod *
2482 * @idlemode: SIDLEMODE field bits (shifted to bit 0)
2484 * Sets the IP block's OCP slave idlemode in hardware, and updates our
2485 * local copy. Intended to be used by drivers that have some erratum
2486 * that requires direct manipulation of the SIDLEMODE bits. Returns
2487 * -EINVAL if @oh is null, or passes along the return value from
2488 * _set_slave_idlemode().
2490 * XXX Does this function have any current users? If not, we should
2491 * remove it; it is better to let the rest of the hwmod code handle this.
2492 * Any users of this function should be scrutinized carefully.
2494 int omap_hwmod_set_slave_idlemode(struct omap_hwmod
*oh
, u8 idlemode
)
2502 v
= oh
->_sysc_cache
;
2504 retval
= _set_slave_idlemode(oh
, idlemode
, &v
);
2506 _write_sysconfig(v
, oh
);
2512 * omap_hwmod_lookup - look up a registered omap_hwmod by name
2513 * @name: name of the omap_hwmod to look up
2515 * Given a @name of an omap_hwmod, return a pointer to the registered
2516 * struct omap_hwmod *, or NULL upon error.
2518 struct omap_hwmod
*omap_hwmod_lookup(const char *name
)
2520 struct omap_hwmod
*oh
;
2531 * omap_hwmod_for_each - call function for each registered omap_hwmod
2532 * @fn: pointer to a callback function
2533 * @data: void * data to pass to callback function
2535 * Call @fn for each registered omap_hwmod, passing @data to each
2536 * function. @fn must return 0 for success or any other value for
2537 * failure. If @fn returns non-zero, the iteration across omap_hwmods
2538 * will stop and the non-zero return value will be passed to the
2539 * caller of omap_hwmod_for_each(). @fn is called with
2540 * omap_hwmod_for_each() held.
2542 int omap_hwmod_for_each(int (*fn
)(struct omap_hwmod
*oh
, void *data
),
2545 struct omap_hwmod
*temp_oh
;
2551 list_for_each_entry(temp_oh
, &omap_hwmod_list
, node
) {
2552 ret
= (*fn
)(temp_oh
, data
);
2561 * omap_hwmod_register_links - register an array of hwmod links
2562 * @ois: pointer to an array of omap_hwmod_ocp_if to register
2564 * Intended to be called early in boot before the clock framework is
2565 * initialized. If @ois is not null, will register all omap_hwmods
2566 * listed in @ois that are valid for this chip. Returns 0.
2568 int __init
omap_hwmod_register_links(struct omap_hwmod_ocp_if
**ois
)
2576 if (_alloc_linkspace(ois
)) {
2577 pr_err("omap_hwmod: could not allocate link space\n");
2584 r
= _register_link(ois
[i
]);
2585 WARN(r
&& r
!= -EEXIST
,
2586 "omap_hwmod: _register_link(%s -> %s) returned %d\n",
2587 ois
[i
]->master
->name
, ois
[i
]->slave
->name
, r
);
2594 * _ensure_mpu_hwmod_is_setup - ensure the MPU SS hwmod is init'ed and set up
2595 * @oh: pointer to the hwmod currently being set up (usually not the MPU)
2597 * If the hwmod data corresponding to the MPU subsystem IP block
2598 * hasn't been initialized and set up yet, do so now. This must be
2599 * done first since sleep dependencies may be added from other hwmods
2600 * to the MPU. Intended to be called only by omap_hwmod_setup*(). No
2603 static void __init
_ensure_mpu_hwmod_is_setup(struct omap_hwmod
*oh
)
2605 if (!mpu_oh
|| mpu_oh
->_state
== _HWMOD_STATE_UNKNOWN
)
2606 pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",
2607 __func__
, MPU_INITIATOR_NAME
);
2608 else if (mpu_oh
->_state
== _HWMOD_STATE_REGISTERED
&& oh
!= mpu_oh
)
2609 omap_hwmod_setup_one(MPU_INITIATOR_NAME
);
2613 * omap_hwmod_setup_one - set up a single hwmod
2614 * @oh_name: const char * name of the already-registered hwmod to set up
2616 * Initialize and set up a single hwmod. Intended to be used for a
2617 * small number of early devices, such as the timer IP blocks used for
2618 * the scheduler clock. Must be called after omap2_clk_init().
2619 * Resolves the struct clk names to struct clk pointers for each
2620 * registered omap_hwmod. Also calls _setup() on each hwmod. Returns
2621 * -EINVAL upon error or 0 upon success.
2623 int __init
omap_hwmod_setup_one(const char *oh_name
)
2625 struct omap_hwmod
*oh
;
2627 pr_debug("omap_hwmod: %s: %s\n", oh_name
, __func__
);
2629 oh
= _lookup(oh_name
);
2631 WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name
);
2635 _ensure_mpu_hwmod_is_setup(oh
);
2644 * omap_hwmod_setup_all - set up all registered IP blocks
2646 * Initialize and set up all IP blocks registered with the hwmod code.
2647 * Must be called after omap2_clk_init(). Resolves the struct clk
2648 * names to struct clk pointers for each registered omap_hwmod. Also
2649 * calls _setup() on each hwmod. Returns 0 upon success.
2651 static int __init
omap_hwmod_setup_all(void)
2653 _ensure_mpu_hwmod_is_setup(NULL
);
2655 omap_hwmod_for_each(_init
, NULL
);
2656 omap_hwmod_for_each(_setup
, NULL
);
2660 core_initcall(omap_hwmod_setup_all
);
2663 * omap_hwmod_enable - enable an omap_hwmod
2664 * @oh: struct omap_hwmod *
2666 * Enable an omap_hwmod @oh. Intended to be called by omap_device_enable().
2667 * Returns -EINVAL on error or passes along the return value from _enable().
2669 int omap_hwmod_enable(struct omap_hwmod
*oh
)
2672 unsigned long flags
;
2677 spin_lock_irqsave(&oh
->_lock
, flags
);
2679 spin_unlock_irqrestore(&oh
->_lock
, flags
);
2685 * omap_hwmod_idle - idle an omap_hwmod
2686 * @oh: struct omap_hwmod *
2688 * Idle an omap_hwmod @oh. Intended to be called by omap_device_idle().
2689 * Returns -EINVAL on error or passes along the return value from _idle().
2691 int omap_hwmod_idle(struct omap_hwmod
*oh
)
2693 unsigned long flags
;
2698 spin_lock_irqsave(&oh
->_lock
, flags
);
2700 spin_unlock_irqrestore(&oh
->_lock
, flags
);
2706 * omap_hwmod_shutdown - shutdown an omap_hwmod
2707 * @oh: struct omap_hwmod *
2709 * Shutdown an omap_hwmod @oh. Intended to be called by
2710 * omap_device_shutdown(). Returns -EINVAL on error or passes along
2711 * the return value from _shutdown().
2713 int omap_hwmod_shutdown(struct omap_hwmod
*oh
)
2715 unsigned long flags
;
2720 spin_lock_irqsave(&oh
->_lock
, flags
);
2722 spin_unlock_irqrestore(&oh
->_lock
, flags
);
2728 * omap_hwmod_enable_clocks - enable main_clk, all interface clocks
2729 * @oh: struct omap_hwmod *oh
2731 * Intended to be called by the omap_device code.
2733 int omap_hwmod_enable_clocks(struct omap_hwmod
*oh
)
2735 unsigned long flags
;
2737 spin_lock_irqsave(&oh
->_lock
, flags
);
2739 spin_unlock_irqrestore(&oh
->_lock
, flags
);
2745 * omap_hwmod_disable_clocks - disable main_clk, all interface clocks
2746 * @oh: struct omap_hwmod *oh
2748 * Intended to be called by the omap_device code.
2750 int omap_hwmod_disable_clocks(struct omap_hwmod
*oh
)
2752 unsigned long flags
;
2754 spin_lock_irqsave(&oh
->_lock
, flags
);
2755 _disable_clocks(oh
);
2756 spin_unlock_irqrestore(&oh
->_lock
, flags
);
2762 * omap_hwmod_ocp_barrier - wait for posted writes against the hwmod to complete
2763 * @oh: struct omap_hwmod *oh
2765 * Intended to be called by drivers and core code when all posted
2766 * writes to a device must complete before continuing further
2767 * execution (for example, after clearing some device IRQSTATUS
2770 * XXX what about targets with multiple OCP threads?
2772 void omap_hwmod_ocp_barrier(struct omap_hwmod
*oh
)
2776 if (!oh
->class->sysc
|| !oh
->class->sysc
->sysc_flags
) {
2777 WARN(1, "omap_device: %s: OCP barrier impossible due to device configuration\n",
2783 * Forces posted writes to complete on the OCP thread handling
2786 omap_hwmod_read(oh
, oh
->class->sysc
->sysc_offs
);
2790 * omap_hwmod_reset - reset the hwmod
2791 * @oh: struct omap_hwmod *
2793 * Under some conditions, a driver may wish to reset the entire device.
2794 * Called from omap_device code. Returns -EINVAL on error or passes along
2795 * the return value from _reset().
2797 int omap_hwmod_reset(struct omap_hwmod
*oh
)
2800 unsigned long flags
;
2805 spin_lock_irqsave(&oh
->_lock
, flags
);
2807 spin_unlock_irqrestore(&oh
->_lock
, flags
);
2813 * IP block data retrieval functions
2817 * omap_hwmod_count_resources - count number of struct resources needed by hwmod
2818 * @oh: struct omap_hwmod *
2819 * @res: pointer to the first element of an array of struct resource to fill
2821 * Count the number of struct resource array elements necessary to
2822 * contain omap_hwmod @oh resources. Intended to be called by code
2823 * that registers omap_devices. Intended to be used to determine the
2824 * size of a dynamically-allocated struct resource array, before
2825 * calling omap_hwmod_fill_resources(). Returns the number of struct
2826 * resource array elements needed.
2828 * XXX This code is not optimized. It could attempt to merge adjacent
2832 int omap_hwmod_count_resources(struct omap_hwmod
*oh
)
2834 struct omap_hwmod_ocp_if
*os
;
2835 struct list_head
*p
;
2839 ret
= _count_mpu_irqs(oh
) + _count_sdma_reqs(oh
);
2841 p
= oh
->slave_ports
.next
;
2843 while (i
< oh
->slaves_cnt
) {
2844 os
= _fetch_next_ocp_if(&p
, &i
);
2845 ret
+= _count_ocp_if_addr_spaces(os
);
2852 * omap_hwmod_fill_resources - fill struct resource array with hwmod data
2853 * @oh: struct omap_hwmod *
2854 * @res: pointer to the first element of an array of struct resource to fill
2856 * Fill the struct resource array @res with resource data from the
2857 * omap_hwmod @oh. Intended to be called by code that registers
2858 * omap_devices. See also omap_hwmod_count_resources(). Returns the
2859 * number of array elements filled.
2861 int omap_hwmod_fill_resources(struct omap_hwmod
*oh
, struct resource
*res
)
2863 struct omap_hwmod_ocp_if
*os
;
2864 struct list_head
*p
;
2865 int i
, j
, mpu_irqs_cnt
, sdma_reqs_cnt
, addr_cnt
;
2868 /* For each IRQ, DMA, memory area, fill in array.*/
2870 mpu_irqs_cnt
= _count_mpu_irqs(oh
);
2871 for (i
= 0; i
< mpu_irqs_cnt
; i
++) {
2872 (res
+ r
)->name
= (oh
->mpu_irqs
+ i
)->name
;
2873 (res
+ r
)->start
= (oh
->mpu_irqs
+ i
)->irq
;
2874 (res
+ r
)->end
= (oh
->mpu_irqs
+ i
)->irq
;
2875 (res
+ r
)->flags
= IORESOURCE_IRQ
;
2879 sdma_reqs_cnt
= _count_sdma_reqs(oh
);
2880 for (i
= 0; i
< sdma_reqs_cnt
; i
++) {
2881 (res
+ r
)->name
= (oh
->sdma_reqs
+ i
)->name
;
2882 (res
+ r
)->start
= (oh
->sdma_reqs
+ i
)->dma_req
;
2883 (res
+ r
)->end
= (oh
->sdma_reqs
+ i
)->dma_req
;
2884 (res
+ r
)->flags
= IORESOURCE_DMA
;
2888 p
= oh
->slave_ports
.next
;
2891 while (i
< oh
->slaves_cnt
) {
2892 os
= _fetch_next_ocp_if(&p
, &i
);
2893 addr_cnt
= _count_ocp_if_addr_spaces(os
);
2895 for (j
= 0; j
< addr_cnt
; j
++) {
2896 (res
+ r
)->name
= (os
->addr
+ j
)->name
;
2897 (res
+ r
)->start
= (os
->addr
+ j
)->pa_start
;
2898 (res
+ r
)->end
= (os
->addr
+ j
)->pa_end
;
2899 (res
+ r
)->flags
= IORESOURCE_MEM
;
2908 * omap_hwmod_get_resource_byname - fetch IP block integration data by name
2909 * @oh: struct omap_hwmod * to operate on
2910 * @type: one of the IORESOURCE_* constants from include/linux/ioport.h
2911 * @name: pointer to the name of the data to fetch (optional)
2912 * @rsrc: pointer to a struct resource, allocated by the caller
2914 * Retrieve MPU IRQ, SDMA request line, or address space start/end
2915 * data for the IP block pointed to by @oh. The data will be filled
2916 * into a struct resource record pointed to by @rsrc. The struct
2917 * resource must be allocated by the caller. When @name is non-null,
2918 * the data associated with the matching entry in the IRQ/SDMA/address
2919 * space hwmod data arrays will be returned. If @name is null, the
2920 * first array entry will be returned. Data order is not meaningful
2921 * in hwmod data, so callers are strongly encouraged to use a non-null
2922 * @name whenever possible to avoid unpredictable effects if hwmod
2923 * data is later added that causes data ordering to change. This
2924 * function is only intended for use by OMAP core code. Device
2925 * drivers should not call this function - the appropriate bus-related
2926 * data accessor functions should be used instead. Returns 0 upon
2927 * success or a negative error code upon error.
2929 int omap_hwmod_get_resource_byname(struct omap_hwmod
*oh
, unsigned int type
,
2930 const char *name
, struct resource
*rsrc
)
2933 unsigned int irq
, dma
;
2934 u32 pa_start
, pa_end
;
2939 if (type
== IORESOURCE_IRQ
) {
2940 r
= _get_mpu_irq_by_name(oh
, name
, &irq
);
2946 } else if (type
== IORESOURCE_DMA
) {
2947 r
= _get_sdma_req_by_name(oh
, name
, &dma
);
2953 } else if (type
== IORESOURCE_MEM
) {
2954 r
= _get_addr_space_by_name(oh
, name
, &pa_start
, &pa_end
);
2958 rsrc
->start
= pa_start
;
2971 * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
2972 * @oh: struct omap_hwmod *
2974 * Return the powerdomain pointer associated with the OMAP module
2975 * @oh's main clock. If @oh does not have a main clk, return the
2976 * powerdomain associated with the interface clock associated with the
2977 * module's MPU port. (XXX Perhaps this should use the SDMA port
2978 * instead?) Returns NULL on error, or a struct powerdomain * on
2981 struct powerdomain
*omap_hwmod_get_pwrdm(struct omap_hwmod
*oh
)
2984 struct omap_hwmod_ocp_if
*oi
;
2992 oi
= _find_mpu_rt_port(oh
);
3001 return c
->clkdm
->pwrdm
.ptr
;
3006 * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
3007 * @oh: struct omap_hwmod *
3009 * Returns the virtual address corresponding to the beginning of the
3010 * module's register target, in the address range that is intended to
3011 * be used by the MPU. Returns the virtual address upon success or NULL
3014 void __iomem
*omap_hwmod_get_mpu_rt_va(struct omap_hwmod
*oh
)
3019 if (oh
->_int_flags
& _HWMOD_NO_MPU_PORT
)
3022 if (oh
->_state
== _HWMOD_STATE_UNKNOWN
)
3025 return oh
->_mpu_rt_va
;
3029 * omap_hwmod_add_initiator_dep - add sleepdep from @init_oh to @oh
3030 * @oh: struct omap_hwmod *
3031 * @init_oh: struct omap_hwmod * (initiator)
3033 * Add a sleep dependency between the initiator @init_oh and @oh.
3034 * Intended to be called by DSP/Bridge code via platform_data for the
3035 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
3036 * code needs to add/del initiator dependencies dynamically
3037 * before/after accessing a device. Returns the return value from
3038 * _add_initiator_dep().
3040 * XXX Keep a usecount in the clockdomain code
3042 int omap_hwmod_add_initiator_dep(struct omap_hwmod
*oh
,
3043 struct omap_hwmod
*init_oh
)
3045 return _add_initiator_dep(oh
, init_oh
);
3049 * XXX what about functions for drivers to save/restore ocp_sysconfig
3050 * for context save/restore operations?
3054 * omap_hwmod_del_initiator_dep - remove sleepdep from @init_oh to @oh
3055 * @oh: struct omap_hwmod *
3056 * @init_oh: struct omap_hwmod * (initiator)
3058 * Remove a sleep dependency between the initiator @init_oh and @oh.
3059 * Intended to be called by DSP/Bridge code via platform_data for the
3060 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
3061 * code needs to add/del initiator dependencies dynamically
3062 * before/after accessing a device. Returns the return value from
3063 * _del_initiator_dep().
3065 * XXX Keep a usecount in the clockdomain code
3067 int omap_hwmod_del_initiator_dep(struct omap_hwmod
*oh
,
3068 struct omap_hwmod
*init_oh
)
3070 return _del_initiator_dep(oh
, init_oh
);
3074 * omap_hwmod_enable_wakeup - allow device to wake up the system
3075 * @oh: struct omap_hwmod *
3077 * Sets the module OCP socket ENAWAKEUP bit to allow the module to
3078 * send wakeups to the PRCM, and enable I/O ring wakeup events for
3079 * this IP block if it has dynamic mux entries. Eventually this
3080 * should set PRCM wakeup registers to cause the PRCM to receive
3081 * wakeup events from the module. Does not set any wakeup routing
3082 * registers beyond this point - if the module is to wake up any other
3083 * module or subsystem, that must be set separately. Called by
3084 * omap_device code. Returns -EINVAL on error or 0 upon success.
3086 int omap_hwmod_enable_wakeup(struct omap_hwmod
*oh
)
3088 unsigned long flags
;
3091 spin_lock_irqsave(&oh
->_lock
, flags
);
3093 if (oh
->class->sysc
&&
3094 (oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
)) {
3095 v
= oh
->_sysc_cache
;
3096 _enable_wakeup(oh
, &v
);
3097 _write_sysconfig(v
, oh
);
3100 _set_idle_ioring_wakeup(oh
, true);
3101 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3107 * omap_hwmod_disable_wakeup - prevent device from waking the system
3108 * @oh: struct omap_hwmod *
3110 * Clears the module OCP socket ENAWAKEUP bit to prevent the module
3111 * from sending wakeups to the PRCM, and disable I/O ring wakeup
3112 * events for this IP block if it has dynamic mux entries. Eventually
3113 * this should clear PRCM wakeup registers to cause the PRCM to ignore
3114 * wakeup events from the module. Does not set any wakeup routing
3115 * registers beyond this point - if the module is to wake up any other
3116 * module or subsystem, that must be set separately. Called by
3117 * omap_device code. Returns -EINVAL on error or 0 upon success.
3119 int omap_hwmod_disable_wakeup(struct omap_hwmod
*oh
)
3121 unsigned long flags
;
3124 spin_lock_irqsave(&oh
->_lock
, flags
);
3126 if (oh
->class->sysc
&&
3127 (oh
->class->sysc
->sysc_flags
& SYSC_HAS_ENAWAKEUP
)) {
3128 v
= oh
->_sysc_cache
;
3129 _disable_wakeup(oh
, &v
);
3130 _write_sysconfig(v
, oh
);
3133 _set_idle_ioring_wakeup(oh
, false);
3134 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3140 * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
3141 * contained in the hwmod module.
3142 * @oh: struct omap_hwmod *
3143 * @name: name of the reset line to lookup and assert
3145 * Some IP like dsp, ipu or iva contain processor that require
3146 * an HW reset line to be assert / deassert in order to enable fully
3147 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3148 * yet supported on this OMAP; otherwise, passes along the return value
3149 * from _assert_hardreset().
3151 int omap_hwmod_assert_hardreset(struct omap_hwmod
*oh
, const char *name
)
3154 unsigned long flags
;
3159 spin_lock_irqsave(&oh
->_lock
, flags
);
3160 ret
= _assert_hardreset(oh
, name
);
3161 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3167 * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
3168 * contained in the hwmod module.
3169 * @oh: struct omap_hwmod *
3170 * @name: name of the reset line to look up and deassert
3172 * Some IP like dsp, ipu or iva contain processor that require
3173 * an HW reset line to be assert / deassert in order to enable fully
3174 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3175 * yet supported on this OMAP; otherwise, passes along the return value
3176 * from _deassert_hardreset().
3178 int omap_hwmod_deassert_hardreset(struct omap_hwmod
*oh
, const char *name
)
3181 unsigned long flags
;
3186 spin_lock_irqsave(&oh
->_lock
, flags
);
3187 ret
= _deassert_hardreset(oh
, name
);
3188 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3194 * omap_hwmod_read_hardreset - read the HW reset line state of submodules
3195 * contained in the hwmod module
3196 * @oh: struct omap_hwmod *
3197 * @name: name of the reset line to look up and read
3199 * Return the current state of the hwmod @oh's reset line named @name:
3200 * returns -EINVAL upon parameter error or if this operation
3201 * is unsupported on the current OMAP; otherwise, passes along the return
3202 * value from _read_hardreset().
3204 int omap_hwmod_read_hardreset(struct omap_hwmod
*oh
, const char *name
)
3207 unsigned long flags
;
3212 spin_lock_irqsave(&oh
->_lock
, flags
);
3213 ret
= _read_hardreset(oh
, name
);
3214 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3221 * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
3222 * @classname: struct omap_hwmod_class name to search for
3223 * @fn: callback function pointer to call for each hwmod in class @classname
3224 * @user: arbitrary context data to pass to the callback function
3226 * For each omap_hwmod of class @classname, call @fn.
3227 * If the callback function returns something other than
3228 * zero, the iterator is terminated, and the callback function's return
3229 * value is passed back to the caller. Returns 0 upon success, -EINVAL
3230 * if @classname or @fn are NULL, or passes back the error code from @fn.
3232 int omap_hwmod_for_each_by_class(const char *classname
,
3233 int (*fn
)(struct omap_hwmod
*oh
,
3237 struct omap_hwmod
*temp_oh
;
3240 if (!classname
|| !fn
)
3243 pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
3244 __func__
, classname
);
3246 list_for_each_entry(temp_oh
, &omap_hwmod_list
, node
) {
3247 if (!strcmp(temp_oh
->class->name
, classname
)) {
3248 pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
3249 __func__
, temp_oh
->name
);
3250 ret
= (*fn
)(temp_oh
, user
);
3257 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
3264 * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
3265 * @oh: struct omap_hwmod *
3266 * @state: state that _setup() should leave the hwmod in
3268 * Sets the hwmod state that @oh will enter at the end of _setup()
3269 * (called by omap_hwmod_setup_*()). See also the documentation
3270 * for _setup_postsetup(), above. Returns 0 upon success or
3271 * -EINVAL if there is a problem with the arguments or if the hwmod is
3272 * in the wrong state.
3274 int omap_hwmod_set_postsetup_state(struct omap_hwmod
*oh
, u8 state
)
3277 unsigned long flags
;
3282 if (state
!= _HWMOD_STATE_DISABLED
&&
3283 state
!= _HWMOD_STATE_ENABLED
&&
3284 state
!= _HWMOD_STATE_IDLE
)
3287 spin_lock_irqsave(&oh
->_lock
, flags
);
3289 if (oh
->_state
!= _HWMOD_STATE_REGISTERED
) {
3294 oh
->_postsetup_state
= state
;
3298 spin_unlock_irqrestore(&oh
->_lock
, flags
);
3304 * omap_hwmod_get_context_loss_count - get lost context count
3305 * @oh: struct omap_hwmod *
3307 * Query the powerdomain of of @oh to get the context loss
3308 * count for this device.
3310 * Returns the context loss count of the powerdomain assocated with @oh
3311 * upon success, or zero if no powerdomain exists for @oh.
3313 int omap_hwmod_get_context_loss_count(struct omap_hwmod
*oh
)
3315 struct powerdomain
*pwrdm
;
3318 pwrdm
= omap_hwmod_get_pwrdm(oh
);
3320 ret
= pwrdm_get_context_loss_count(pwrdm
);
3326 * omap_hwmod_no_setup_reset - prevent a hwmod from being reset upon setup
3327 * @oh: struct omap_hwmod *
3329 * Prevent the hwmod @oh from being reset during the setup process.
3330 * Intended for use by board-*.c files on boards with devices that
3331 * cannot tolerate being reset. Must be called before the hwmod has
3332 * been set up. Returns 0 upon success or negative error code upon
3335 int omap_hwmod_no_setup_reset(struct omap_hwmod
*oh
)
3340 if (oh
->_state
!= _HWMOD_STATE_REGISTERED
) {
3341 pr_err("omap_hwmod: %s: cannot prevent setup reset; in wrong state\n",
3346 oh
->flags
|= HWMOD_INIT_NO_RESET
;
3352 * omap_hwmod_pad_route_irq - route an I/O pad wakeup to a particular MPU IRQ
3353 * @oh: struct omap_hwmod * containing hwmod mux entries
3354 * @pad_idx: array index in oh->mux of the hwmod mux entry to route wakeup
3355 * @irq_idx: the hwmod mpu_irqs array index of the IRQ to trigger on wakeup
3357 * When an I/O pad wakeup arrives for the dynamic or wakeup hwmod mux
3358 * entry number @pad_idx for the hwmod @oh, trigger the interrupt
3359 * service routine for the hwmod's mpu_irqs array index @irq_idx. If
3360 * this function is not called for a given pad_idx, then the ISR
3361 * associated with @oh's first MPU IRQ will be triggered when an I/O
3362 * pad wakeup occurs on that pad. Note that @pad_idx is the index of
3363 * the _dynamic or wakeup_ entry: if there are other entries not
3364 * marked with OMAP_DEVICE_PAD_WAKEUP or OMAP_DEVICE_PAD_REMUX, these
3365 * entries are NOT COUNTED in the dynamic pad index. This function
3366 * must be called separately for each pad that requires its interrupt
3367 * to be re-routed this way. Returns -EINVAL if there is an argument
3368 * problem or if @oh does not have hwmod mux entries or MPU IRQs;
3369 * returns -ENOMEM if memory cannot be allocated; or 0 upon success.
3371 * XXX This function interface is fragile. Rather than using array
3372 * indexes, which are subject to unpredictable change, it should be
3373 * using hwmod IRQ names, and some other stable key for the hwmod mux
3376 int omap_hwmod_pad_route_irq(struct omap_hwmod
*oh
, int pad_idx
, int irq_idx
)
3382 if (!oh
|| !oh
->mux
|| !oh
->mpu_irqs
|| pad_idx
< 0 ||
3383 pad_idx
>= oh
->mux
->nr_pads_dynamic
)
3386 /* Check the number of available mpu_irqs */
3387 for (nr_irqs
= 0; oh
->mpu_irqs
[nr_irqs
].irq
>= 0; nr_irqs
++)
3390 if (irq_idx
>= nr_irqs
)
3393 if (!oh
->mux
->irqs
) {
3394 /* XXX What frees this? */
3395 oh
->mux
->irqs
= kzalloc(sizeof(int) * oh
->mux
->nr_pads_dynamic
,
3400 oh
->mux
->irqs
[pad_idx
] = irq_idx
;