2 * omap_hwmod implementation for OMAP2/3/4
4 * Copyright (C) 2009 Nokia Corporation
6 * Paul Walmsley, BenoƮt Cousson, Kevin Hilman
8 * Created in collaboration with (alphabetical order): Thara Gopinath,
9 * Tony Lindgren, Rajendra Nayak, Vikram Pandita, Sakari Poussa, Anand
10 * Sawant, Santosh Shilimkar, Richard Woodruff
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License version 2 as
14 * published by the Free Software Foundation.
16 * This code manages "OMAP modules" (on-chip devices) and their
17 * integration with Linux device driver and bus code.
20 * - OMAP2420 Multimedia Processor Silicon Revision 2.1.1, 2.2 (SWPU064)
21 * - OMAP2430 Multimedia Device POP Silicon Revision 2.1 (SWPU090)
22 * - OMAP34xx Multimedia Device Silicon Revision 3.1 (SWPU108)
23 * - OMAP4430 Multimedia Device Silicon Revision 1.0 (SWPU140)
24 * - Open Core Protocol Specification 2.2
29 * - bus throughput & module latency measurement code
31 * XXX add tests at the beginning of each function to ensure the hwmod is
32 * in the appropriate state
33 * XXX error return values should be checked to ensure that they are
38 #include <linux/kernel.h>
39 #include <linux/errno.h>
41 #include <linux/clk.h>
42 #include <linux/delay.h>
43 #include <linux/err.h>
44 #include <linux/list.h>
45 #include <linux/mutex.h>
47 #include <plat/common.h>
49 #include <plat/clockdomain.h>
50 #include <plat/powerdomain.h>
51 #include <plat/clock.h>
52 #include <plat/omap_hwmod.h>
56 /* Maximum microseconds to wait for OMAP module to reset */
57 #define MAX_MODULE_RESET_WAIT 10000
59 /* Name of the OMAP hwmod for the MPU */
60 #define MPU_INITIATOR_NAME "mpu"
62 /* omap_hwmod_list contains all registered struct omap_hwmods */
63 static LIST_HEAD(omap_hwmod_list);
65 static DEFINE_MUTEX(omap_hwmod_mutex);
67 /* mpu_oh: used to add/remove MPU initiator from sleepdep list */
68 static struct omap_hwmod *mpu_oh;
70 /* inited: 0 if omap_hwmod_init() has not yet been called; 1 otherwise */
74 /* Private functions */
77 * _update_sysc_cache - return the module OCP_SYSCONFIG register, keep copy
78 * @oh: struct omap_hwmod *
80 * Load the current value of the hwmod OCP_SYSCONFIG register into the
81 * struct omap_hwmod for later use. Returns -EINVAL if the hwmod has no
82 * OCP_SYSCONFIG register or 0 upon success.
84 static int _update_sysc_cache(struct omap_hwmod *oh)
86 if (!oh->class->sysc) {
87 WARN(1, "omap_hwmod: %s: cannot read OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
91 /* XXX ensure module interface clock is up */
93 oh->_sysc_cache = omap_hwmod_readl(oh, oh->class->sysc->sysc_offs);
95 if (!(oh->class->sysc->sysc_flags & SYSC_NO_CACHE))
96 oh->_int_flags |= _HWMOD_SYSCONFIG_LOADED;
102 * _write_sysconfig - write a value to the module's OCP_SYSCONFIG register
103 * @v: OCP_SYSCONFIG value to write
104 * @oh: struct omap_hwmod *
106 * Write @v into the module class' OCP_SYSCONFIG register, if it has
107 * one. No return value.
109 static void _write_sysconfig(u32 v, struct omap_hwmod *oh)
111 if (!oh->class->sysc) {
112 WARN(1, "omap_hwmod: %s: cannot write OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
116 /* XXX ensure module interface clock is up */
118 if (oh->_sysc_cache != v) {
120 omap_hwmod_writel(v, oh, oh->class->sysc->sysc_offs);
125 * _set_master_standbymode: set the OCP_SYSCONFIG MIDLEMODE field in @v
126 * @oh: struct omap_hwmod *
127 * @standbymode: MIDLEMODE field bits
128 * @v: pointer to register contents to modify
130 * Update the master standby mode bits in @v to be @standbymode for
131 * the @oh hwmod. Does not write to the hardware. Returns -EINVAL
132 * upon error or 0 upon success.
134 static int _set_master_standbymode(struct omap_hwmod *oh, u8 standbymode,
140 if (!oh->class->sysc ||
141 !(oh->class->sysc->sysc_flags & SYSC_HAS_MIDLEMODE))
144 if (!oh->class->sysc->sysc_fields) {
145 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
149 mstandby_shift = oh->class->sysc->sysc_fields->midle_shift;
150 mstandby_mask = (0x3 << mstandby_shift);
152 *v &= ~mstandby_mask;
153 *v |= __ffs(standbymode) << mstandby_shift;
159 * _set_slave_idlemode: set the OCP_SYSCONFIG SIDLEMODE field in @v
160 * @oh: struct omap_hwmod *
161 * @idlemode: SIDLEMODE field bits
162 * @v: pointer to register contents to modify
164 * Update the slave idle mode bits in @v to be @idlemode for the @oh
165 * hwmod. Does not write to the hardware. Returns -EINVAL upon error
168 static int _set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode, u32 *v)
173 if (!oh->class->sysc ||
174 !(oh->class->sysc->sysc_flags & SYSC_HAS_SIDLEMODE))
177 if (!oh->class->sysc->sysc_fields) {
178 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
182 sidle_shift = oh->class->sysc->sysc_fields->sidle_shift;
183 sidle_mask = (0x3 << sidle_shift);
186 *v |= __ffs(idlemode) << sidle_shift;
192 * _set_clockactivity: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
193 * @oh: struct omap_hwmod *
194 * @clockact: CLOCKACTIVITY field bits
195 * @v: pointer to register contents to modify
197 * Update the clockactivity mode bits in @v to be @clockact for the
198 * @oh hwmod. Used for additional powersaving on some modules. Does
199 * not write to the hardware. Returns -EINVAL upon error or 0 upon
202 static int _set_clockactivity(struct omap_hwmod *oh, u8 clockact, u32 *v)
207 if (!oh->class->sysc ||
208 !(oh->class->sysc->sysc_flags & SYSC_HAS_CLOCKACTIVITY))
211 if (!oh->class->sysc->sysc_fields) {
212 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
216 clkact_shift = oh->class->sysc->sysc_fields->clkact_shift;
217 clkact_mask = (0x3 << clkact_shift);
220 *v |= clockact << clkact_shift;
226 * _set_softreset: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
227 * @oh: struct omap_hwmod *
228 * @v: pointer to register contents to modify
230 * Set the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
231 * error or 0 upon success.
233 static int _set_softreset(struct omap_hwmod *oh, u32 *v)
237 if (!oh->class->sysc ||
238 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
241 if (!oh->class->sysc->sysc_fields) {
242 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
246 softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
254 * _set_module_autoidle: set the OCP_SYSCONFIG AUTOIDLE field in @v
255 * @oh: struct omap_hwmod *
256 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
257 * @v: pointer to register contents to modify
259 * Update the module autoidle bit in @v to be @autoidle for the @oh
260 * hwmod. The autoidle bit controls whether the module can gate
261 * internal clocks automatically when it isn't doing anything; the
262 * exact function of this bit varies on a per-module basis. This
263 * function does not write to the hardware. Returns -EINVAL upon
264 * error or 0 upon success.
266 static int _set_module_autoidle(struct omap_hwmod *oh, u8 autoidle,
272 if (!oh->class->sysc ||
273 !(oh->class->sysc->sysc_flags & SYSC_HAS_AUTOIDLE))
276 if (!oh->class->sysc->sysc_fields) {
277 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
281 autoidle_shift = oh->class->sysc->sysc_fields->autoidle_shift;
282 autoidle_mask = (0x3 << autoidle_shift);
284 *v &= ~autoidle_mask;
285 *v |= autoidle << autoidle_shift;
291 * _enable_wakeup: set OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
292 * @oh: struct omap_hwmod *
294 * Allow the hardware module @oh to send wakeups. Returns -EINVAL
295 * upon error or 0 upon success.
297 static int _enable_wakeup(struct omap_hwmod *oh)
301 if (!oh->class->sysc ||
302 !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
305 if (!oh->class->sysc->sysc_fields) {
306 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
310 wakeup_mask = (0x1 << oh->class->sysc->sysc_fields->enwkup_shift);
314 _write_sysconfig(v, oh);
316 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
318 oh->_int_flags |= _HWMOD_WAKEUP_ENABLED;
324 * _disable_wakeup: clear OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
325 * @oh: struct omap_hwmod *
327 * Prevent the hardware module @oh to send wakeups. Returns -EINVAL
328 * upon error or 0 upon success.
330 static int _disable_wakeup(struct omap_hwmod *oh)
334 if (!oh->class->sysc ||
335 !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
338 if (!oh->class->sysc->sysc_fields) {
339 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
343 wakeup_mask = (0x1 << oh->class->sysc->sysc_fields->enwkup_shift);
347 _write_sysconfig(v, oh);
349 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
351 oh->_int_flags &= ~_HWMOD_WAKEUP_ENABLED;
357 * _add_initiator_dep: prevent @oh from smart-idling while @init_oh is active
358 * @oh: struct omap_hwmod *
360 * Prevent the hardware module @oh from entering idle while the
361 * hardare module initiator @init_oh is active. Useful when a module
362 * will be accessed by a particular initiator (e.g., if a module will
363 * be accessed by the IVA, there should be a sleepdep between the IVA
364 * initiator and the module). Only applies to modules in smart-idle
365 * mode. Returns -EINVAL upon error or passes along
366 * clkdm_add_sleepdep() value upon success.
368 static int _add_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
373 return clkdm_add_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
377 * _del_initiator_dep: allow @oh to smart-idle even if @init_oh is active
378 * @oh: struct omap_hwmod *
380 * Allow the hardware module @oh to enter idle while the hardare
381 * module initiator @init_oh is active. Useful when a module will not
382 * be accessed by a particular initiator (e.g., if a module will not
383 * be accessed by the IVA, there should be no sleepdep between the IVA
384 * initiator and the module). Only applies to modules in smart-idle
385 * mode. Returns -EINVAL upon error or passes along
386 * clkdm_del_sleepdep() value upon success.
388 static int _del_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
393 return clkdm_del_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
397 * _init_main_clk - get a struct clk * for the the hwmod's main functional clk
398 * @oh: struct omap_hwmod *
400 * Called from _init_clocks(). Populates the @oh _clk (main
401 * functional clock pointer) if a main_clk is present. Returns 0 on
402 * success or -EINVAL on error.
404 static int _init_main_clk(struct omap_hwmod *oh)
411 oh->_clk = omap_clk_get_by_name(oh->main_clk);
413 pr_warning("omap_hwmod: %s: cannot clk_get main_clk %s\n",
414 oh->name, oh->main_clk);
418 if (!oh->_clk->clkdm)
419 pr_warning("omap_hwmod: %s: missing clockdomain for %s.\n",
420 oh->main_clk, oh->_clk->name);
426 * _init_interface_clk - get a struct clk * for the the hwmod's interface clks
427 * @oh: struct omap_hwmod *
429 * Called from _init_clocks(). Populates the @oh OCP slave interface
430 * clock pointers. Returns 0 on success or -EINVAL on error.
432 static int _init_interface_clks(struct omap_hwmod *oh)
438 if (oh->slaves_cnt == 0)
441 for (i = 0; i < oh->slaves_cnt; i++) {
442 struct omap_hwmod_ocp_if *os = oh->slaves[i];
447 c = omap_clk_get_by_name(os->clk);
449 pr_warning("omap_hwmod: %s: cannot clk_get interface_clk %s\n",
460 * _init_opt_clk - get a struct clk * for the the hwmod's optional clocks
461 * @oh: struct omap_hwmod *
463 * Called from _init_clocks(). Populates the @oh omap_hwmod_opt_clk
464 * clock pointers. Returns 0 on success or -EINVAL on error.
466 static int _init_opt_clks(struct omap_hwmod *oh)
468 struct omap_hwmod_opt_clk *oc;
473 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++) {
474 c = omap_clk_get_by_name(oc->clk);
476 pr_warning("omap_hwmod: %s: cannot clk_get opt_clk %s\n",
487 * _enable_clocks - enable hwmod main clock and interface clocks
488 * @oh: struct omap_hwmod *
490 * Enables all clocks necessary for register reads and writes to succeed
491 * on the hwmod @oh. Returns 0.
493 static int _enable_clocks(struct omap_hwmod *oh)
497 pr_debug("omap_hwmod: %s: enabling clocks\n", oh->name);
500 clk_enable(oh->_clk);
502 if (oh->slaves_cnt > 0) {
503 for (i = 0; i < oh->slaves_cnt; i++) {
504 struct omap_hwmod_ocp_if *os = oh->slaves[i];
505 struct clk *c = os->_clk;
507 if (c && (os->flags & OCPIF_SWSUP_IDLE))
512 /* The opt clocks are controlled by the device driver. */
518 * _disable_clocks - disable hwmod main clock and interface clocks
519 * @oh: struct omap_hwmod *
521 * Disables the hwmod @oh main functional and interface clocks. Returns 0.
523 static int _disable_clocks(struct omap_hwmod *oh)
527 pr_debug("omap_hwmod: %s: disabling clocks\n", oh->name);
530 clk_disable(oh->_clk);
532 if (oh->slaves_cnt > 0) {
533 for (i = 0; i < oh->slaves_cnt; i++) {
534 struct omap_hwmod_ocp_if *os = oh->slaves[i];
535 struct clk *c = os->_clk;
537 if (c && (os->flags & OCPIF_SWSUP_IDLE))
542 /* The opt clocks are controlled by the device driver. */
548 * _find_mpu_port_index - find hwmod OCP slave port ID intended for MPU use
549 * @oh: struct omap_hwmod *
551 * Returns the array index of the OCP slave port that the MPU
552 * addresses the device on, or -EINVAL upon error or not found.
554 static int _find_mpu_port_index(struct omap_hwmod *oh)
559 if (!oh || oh->slaves_cnt == 0)
562 for (i = 0; i < oh->slaves_cnt; i++) {
563 struct omap_hwmod_ocp_if *os = oh->slaves[i];
565 if (os->user & OCP_USER_MPU) {
572 pr_debug("omap_hwmod: %s: MPU OCP slave port ID %d\n",
575 pr_debug("omap_hwmod: %s: no MPU OCP slave port found\n",
578 return (found) ? i : -EINVAL;
582 * _find_mpu_rt_base - find hwmod register target base addr accessible by MPU
583 * @oh: struct omap_hwmod *
585 * Return the virtual address of the base of the register target of
586 * device @oh, or NULL on error.
588 static void __iomem *_find_mpu_rt_base(struct omap_hwmod *oh, u8 index)
590 struct omap_hwmod_ocp_if *os;
591 struct omap_hwmod_addr_space *mem;
594 void __iomem *va_start;
596 if (!oh || oh->slaves_cnt == 0)
599 os = oh->slaves[index];
601 for (i = 0, mem = os->addr; i < os->addr_cnt; i++, mem++) {
602 if (mem->flags & ADDR_TYPE_RT) {
609 va_start = ioremap(mem->pa_start, mem->pa_end - mem->pa_start);
611 pr_err("omap_hwmod: %s: Could not ioremap\n", oh->name);
614 pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
617 pr_debug("omap_hwmod: %s: no MPU register target found\n",
621 return (found) ? va_start : NULL;
625 * _sysc_enable - try to bring a module out of idle via OCP_SYSCONFIG
626 * @oh: struct omap_hwmod *
628 * If module is marked as SWSUP_SIDLE, force the module out of slave
629 * idle; otherwise, configure it for smart-idle. If module is marked
630 * as SWSUP_MSUSPEND, force the module out of master standby;
631 * otherwise, configure it for smart-standby. No return value.
633 static void _sysc_enable(struct omap_hwmod *oh)
638 if (!oh->class->sysc)
642 sf = oh->class->sysc->sysc_flags;
644 if (sf & SYSC_HAS_SIDLEMODE) {
645 idlemode = (oh->flags & HWMOD_SWSUP_SIDLE) ?
646 HWMOD_IDLEMODE_NO : HWMOD_IDLEMODE_SMART;
647 _set_slave_idlemode(oh, idlemode, &v);
650 if (sf & SYSC_HAS_MIDLEMODE) {
651 idlemode = (oh->flags & HWMOD_SWSUP_MSTANDBY) ?
652 HWMOD_IDLEMODE_NO : HWMOD_IDLEMODE_SMART;
653 _set_master_standbymode(oh, idlemode, &v);
656 if (sf & SYSC_HAS_AUTOIDLE) {
657 idlemode = (oh->flags & HWMOD_NO_OCP_AUTOIDLE) ?
659 _set_module_autoidle(oh, idlemode, &v);
662 /* XXX OCP ENAWAKEUP bit? */
665 * XXX The clock framework should handle this, by
666 * calling into this code. But this must wait until the
667 * clock structures are tagged with omap_hwmod entries
669 if ((oh->flags & HWMOD_SET_DEFAULT_CLOCKACT) &&
670 (sf & SYSC_HAS_CLOCKACTIVITY))
671 _set_clockactivity(oh, oh->class->sysc->clockact, &v);
673 _write_sysconfig(v, oh);
677 * _sysc_idle - try to put a module into idle via OCP_SYSCONFIG
678 * @oh: struct omap_hwmod *
680 * If module is marked as SWSUP_SIDLE, force the module into slave
681 * idle; otherwise, configure it for smart-idle. If module is marked
682 * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
683 * configure it for smart-standby. No return value.
685 static void _sysc_idle(struct omap_hwmod *oh)
690 if (!oh->class->sysc)
694 sf = oh->class->sysc->sysc_flags;
696 if (sf & SYSC_HAS_SIDLEMODE) {
697 idlemode = (oh->flags & HWMOD_SWSUP_SIDLE) ?
698 HWMOD_IDLEMODE_FORCE : HWMOD_IDLEMODE_SMART;
699 _set_slave_idlemode(oh, idlemode, &v);
702 if (sf & SYSC_HAS_MIDLEMODE) {
703 idlemode = (oh->flags & HWMOD_SWSUP_MSTANDBY) ?
704 HWMOD_IDLEMODE_FORCE : HWMOD_IDLEMODE_SMART;
705 _set_master_standbymode(oh, idlemode, &v);
708 _write_sysconfig(v, oh);
712 * _sysc_shutdown - force a module into idle via OCP_SYSCONFIG
713 * @oh: struct omap_hwmod *
715 * Force the module into slave idle and master suspend. No return
718 static void _sysc_shutdown(struct omap_hwmod *oh)
723 if (!oh->class->sysc)
727 sf = oh->class->sysc->sysc_flags;
729 if (sf & SYSC_HAS_SIDLEMODE)
730 _set_slave_idlemode(oh, HWMOD_IDLEMODE_FORCE, &v);
732 if (sf & SYSC_HAS_MIDLEMODE)
733 _set_master_standbymode(oh, HWMOD_IDLEMODE_FORCE, &v);
735 if (sf & SYSC_HAS_AUTOIDLE)
736 _set_module_autoidle(oh, 1, &v);
738 _write_sysconfig(v, oh);
742 * _lookup - find an omap_hwmod by name
743 * @name: find an omap_hwmod by name
745 * Return a pointer to an omap_hwmod by name, or NULL if not found.
746 * Caller must hold omap_hwmod_mutex.
748 static struct omap_hwmod *_lookup(const char *name)
750 struct omap_hwmod *oh, *temp_oh;
754 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
755 if (!strcmp(name, temp_oh->name)) {
765 * _init_clocks - clk_get() all clocks associated with this hwmod
766 * @oh: struct omap_hwmod *
768 * Called by omap_hwmod_late_init() (after omap2_clk_init()).
769 * Resolves all clock names embedded in the hwmod. Must be called
770 * with omap_hwmod_mutex held. Returns -EINVAL if the omap_hwmod
771 * has not yet been registered or if the clocks have already been
772 * initialized, 0 on success, or a non-zero error on failure.
774 static int _init_clocks(struct omap_hwmod *oh)
778 if (!oh || (oh->_state != _HWMOD_STATE_REGISTERED))
781 pr_debug("omap_hwmod: %s: looking up clocks\n", oh->name);
783 ret |= _init_main_clk(oh);
784 ret |= _init_interface_clks(oh);
785 ret |= _init_opt_clks(oh);
788 oh->_state = _HWMOD_STATE_CLKS_INITED;
794 * _wait_target_ready - wait for a module to leave slave idle
795 * @oh: struct omap_hwmod *
797 * Wait for a module @oh to leave slave idle. Returns 0 if the module
798 * does not have an IDLEST bit or if the module successfully leaves
799 * slave idle; otherwise, pass along the return value of the
800 * appropriate *_cm_wait_module_ready() function.
802 static int _wait_target_ready(struct omap_hwmod *oh)
804 struct omap_hwmod_ocp_if *os;
810 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
813 os = oh->slaves[oh->_mpu_port_index];
815 if (oh->flags & HWMOD_NO_IDLEST)
818 /* XXX check module SIDLEMODE */
820 /* XXX check clock enable states */
822 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
823 ret = omap2_cm_wait_module_ready(oh->prcm.omap2.module_offs,
824 oh->prcm.omap2.idlest_reg_id,
825 oh->prcm.omap2.idlest_idle_bit);
826 } else if (cpu_is_omap44xx()) {
827 ret = omap4_cm_wait_module_ready(oh->prcm.omap4.clkctrl_reg);
836 * _reset - reset an omap_hwmod
837 * @oh: struct omap_hwmod *
839 * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit. hwmod must be
840 * enabled for this to work. Must be called with omap_hwmod_mutex
841 * held. Returns -EINVAL if the hwmod cannot be reset this way or if
842 * the hwmod is in the wrong state, -ETIMEDOUT if the module did not
843 * reset in time, or 0 upon success.
845 static int _reset(struct omap_hwmod *oh)
850 if (!oh->class->sysc ||
851 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET) ||
852 (oh->class->sysc->sysc_flags & SYSS_MISSING))
855 /* clocks must be on for this operation */
856 if (oh->_state != _HWMOD_STATE_ENABLED) {
857 WARN(1, "omap_hwmod: %s: reset can only be entered from "
858 "enabled state\n", oh->name);
862 pr_debug("omap_hwmod: %s: resetting\n", oh->name);
865 r = _set_softreset(oh, &v);
868 _write_sysconfig(v, oh);
870 omap_test_timeout((omap_hwmod_readl(oh, oh->class->sysc->syss_offs) &
871 SYSS_RESETDONE_MASK),
872 MAX_MODULE_RESET_WAIT, c);
874 if (c == MAX_MODULE_RESET_WAIT)
875 WARN(1, "omap_hwmod: %s: failed to reset in %d usec\n",
876 oh->name, MAX_MODULE_RESET_WAIT);
878 pr_debug("omap_hwmod: %s: reset in %d usec\n", oh->name, c);
881 * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
882 * _wait_target_ready() or _reset()
885 return (c == MAX_MODULE_RESET_WAIT) ? -ETIMEDOUT : 0;
889 * _enable - enable an omap_hwmod
890 * @oh: struct omap_hwmod *
892 * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
893 * register target. Must be called with omap_hwmod_mutex held.
894 * Returns -EINVAL if the hwmod is in the wrong state or passes along
895 * the return value of _wait_target_ready().
897 static int _enable(struct omap_hwmod *oh)
901 if (oh->_state != _HWMOD_STATE_INITIALIZED &&
902 oh->_state != _HWMOD_STATE_IDLE &&
903 oh->_state != _HWMOD_STATE_DISABLED) {
904 WARN(1, "omap_hwmod: %s: enabled state can only be entered "
905 "from initialized, idle, or disabled state\n", oh->name);
909 pr_debug("omap_hwmod: %s: enabling\n", oh->name);
913 _add_initiator_dep(oh, mpu_oh);
916 r = _wait_target_ready(oh);
918 oh->_state = _HWMOD_STATE_ENABLED;
920 /* Access the sysconfig only if the target is ready */
921 if (oh->class->sysc) {
922 if (!(oh->_int_flags & _HWMOD_SYSCONFIG_LOADED))
923 _update_sysc_cache(oh);
927 pr_debug("omap_hwmod: %s: _wait_target_ready: %d\n",
935 * _idle - idle an omap_hwmod
936 * @oh: struct omap_hwmod *
938 * Idles an omap_hwmod @oh. This should be called once the hwmod has
939 * no further work. Returns -EINVAL if the hwmod is in the wrong
940 * state or returns 0.
942 static int _idle(struct omap_hwmod *oh)
944 if (oh->_state != _HWMOD_STATE_ENABLED) {
945 WARN(1, "omap_hwmod: %s: idle state can only be entered from "
946 "enabled state\n", oh->name);
950 pr_debug("omap_hwmod: %s: idling\n", oh->name);
954 _del_initiator_dep(oh, mpu_oh);
957 oh->_state = _HWMOD_STATE_IDLE;
963 * _shutdown - shutdown an omap_hwmod
964 * @oh: struct omap_hwmod *
966 * Shut down an omap_hwmod @oh. This should be called when the driver
967 * used for the hwmod is removed or unloaded or if the driver is not
968 * used by the system. Returns -EINVAL if the hwmod is in the wrong
969 * state or returns 0.
971 static int _shutdown(struct omap_hwmod *oh)
973 if (oh->_state != _HWMOD_STATE_IDLE &&
974 oh->_state != _HWMOD_STATE_ENABLED) {
975 WARN(1, "omap_hwmod: %s: disabled state can only be entered "
976 "from idle, or enabled state\n", oh->name);
980 pr_debug("omap_hwmod: %s: disabling\n", oh->name);
984 _del_initiator_dep(oh, mpu_oh);
985 /* XXX what about the other system initiators here? DMA, tesla, d2d */
987 /* XXX Should this code also force-disable the optional clocks? */
989 /* XXX mux any associated balls to safe mode */
991 oh->_state = _HWMOD_STATE_DISABLED;
997 * _setup - do initial configuration of omap_hwmod
998 * @oh: struct omap_hwmod *
1000 * Writes the CLOCKACTIVITY bits @clockact to the hwmod @oh
1001 * OCP_SYSCONFIG register. Must be called with omap_hwmod_mutex
1002 * held. Returns -EINVAL if the hwmod is in the wrong state or returns
1005 static int _setup(struct omap_hwmod *oh)
1012 /* Set iclk autoidle mode */
1013 if (oh->slaves_cnt > 0) {
1014 for (i = 0; i < oh->slaves_cnt; i++) {
1015 struct omap_hwmod_ocp_if *os = oh->slaves[i];
1016 struct clk *c = os->_clk;
1021 if (os->flags & OCPIF_SWSUP_IDLE) {
1022 /* XXX omap_iclk_deny_idle(c); */
1024 /* XXX omap_iclk_allow_idle(c); */
1030 oh->_state = _HWMOD_STATE_INITIALIZED;
1034 pr_warning("omap_hwmod: %s: cannot be enabled (%d)\n",
1035 oh->name, oh->_state);
1039 if (!(oh->flags & HWMOD_INIT_NO_RESET)) {
1041 * XXX Do the OCP_SYSCONFIG bits need to be
1042 * reprogrammed after a reset? If not, then this can
1043 * be removed. If they do, then probably the
1044 * _enable() function should be split to avoid the
1045 * rewrite of the OCP_SYSCONFIG register.
1047 if (oh->class->sysc) {
1048 _update_sysc_cache(oh);
1053 if (!(oh->flags & HWMOD_INIT_NO_IDLE))
1061 /* Public functions */
1063 u32 omap_hwmod_readl(struct omap_hwmod *oh, u16 reg_offs)
1065 return __raw_readl(oh->_rt_va + reg_offs);
1068 void omap_hwmod_writel(u32 v, struct omap_hwmod *oh, u16 reg_offs)
1070 __raw_writel(v, oh->_rt_va + reg_offs);
1073 int omap_hwmod_set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode)
1081 v = oh->_sysc_cache;
1083 retval = _set_slave_idlemode(oh, idlemode, &v);
1085 _write_sysconfig(v, oh);
1091 * omap_hwmod_register - register a struct omap_hwmod
1092 * @oh: struct omap_hwmod *
1094 * Registers the omap_hwmod @oh. Returns -EEXIST if an omap_hwmod
1095 * already has been registered by the same name; -EINVAL if the
1096 * omap_hwmod is in the wrong state, if @oh is NULL, if the
1097 * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
1098 * name, or if the omap_hwmod's class is missing a name; or 0 upon
1101 * XXX The data should be copied into bootmem, so the original data
1102 * should be marked __initdata and freed after init. This would allow
1103 * unneeded omap_hwmods to be freed on multi-OMAP configurations. Note
1104 * that the copy process would be relatively complex due to the large number
1107 int omap_hwmod_register(struct omap_hwmod *oh)
1111 if (!oh || !oh->name || !oh->class || !oh->class->name ||
1112 (oh->_state != _HWMOD_STATE_UNKNOWN))
1115 mutex_lock(&omap_hwmod_mutex);
1117 pr_debug("omap_hwmod: %s: registering\n", oh->name);
1119 if (_lookup(oh->name)) {
1124 ms_id = _find_mpu_port_index(oh);
1125 if (!IS_ERR_VALUE(ms_id)) {
1126 oh->_mpu_port_index = ms_id;
1127 oh->_rt_va = _find_mpu_rt_base(oh, oh->_mpu_port_index);
1129 oh->_int_flags |= _HWMOD_NO_MPU_PORT;
1132 list_add_tail(&oh->node, &omap_hwmod_list);
1134 oh->_state = _HWMOD_STATE_REGISTERED;
1139 mutex_unlock(&omap_hwmod_mutex);
1144 * omap_hwmod_lookup - look up a registered omap_hwmod by name
1145 * @name: name of the omap_hwmod to look up
1147 * Given a @name of an omap_hwmod, return a pointer to the registered
1148 * struct omap_hwmod *, or NULL upon error.
1150 struct omap_hwmod *omap_hwmod_lookup(const char *name)
1152 struct omap_hwmod *oh;
1157 mutex_lock(&omap_hwmod_mutex);
1159 mutex_unlock(&omap_hwmod_mutex);
1165 * omap_hwmod_for_each - call function for each registered omap_hwmod
1166 * @fn: pointer to a callback function
1168 * Call @fn for each registered omap_hwmod, passing @data to each
1169 * function. @fn must return 0 for success or any other value for
1170 * failure. If @fn returns non-zero, the iteration across omap_hwmods
1171 * will stop and the non-zero return value will be passed to the
1172 * caller of omap_hwmod_for_each(). @fn is called with
1173 * omap_hwmod_for_each() held.
1175 int omap_hwmod_for_each(int (*fn)(struct omap_hwmod *oh))
1177 struct omap_hwmod *temp_oh;
1183 mutex_lock(&omap_hwmod_mutex);
1184 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1185 ret = (*fn)(temp_oh);
1189 mutex_unlock(&omap_hwmod_mutex);
1196 * omap_hwmod_init - init omap_hwmod code and register hwmods
1197 * @ohs: pointer to an array of omap_hwmods to register
1199 * Intended to be called early in boot before the clock framework is
1200 * initialized. If @ohs is not null, will register all omap_hwmods
1201 * listed in @ohs that are valid for this chip. Returns -EINVAL if
1202 * omap_hwmod_init() has already been called or 0 otherwise.
1204 int omap_hwmod_init(struct omap_hwmod **ohs)
1206 struct omap_hwmod *oh;
1219 if (omap_chip_is(oh->omap_chip)) {
1220 r = omap_hwmod_register(oh);
1221 WARN(r, "omap_hwmod: %s: omap_hwmod_register returned "
1222 "%d\n", oh->name, r);
1231 * omap_hwmod_late_init - do some post-clock framework initialization
1233 * Must be called after omap2_clk_init(). Resolves the struct clk names
1234 * to struct clk pointers for each registered omap_hwmod. Also calls
1235 * _setup() on each hwmod. Returns 0.
1237 int omap_hwmod_late_init(void)
1241 /* XXX check return value */
1242 r = omap_hwmod_for_each(_init_clocks);
1243 WARN(r, "omap_hwmod: omap_hwmod_late_init(): _init_clocks failed\n");
1245 mpu_oh = omap_hwmod_lookup(MPU_INITIATOR_NAME);
1246 WARN(!mpu_oh, "omap_hwmod: could not find MPU initiator hwmod %s\n",
1247 MPU_INITIATOR_NAME);
1249 omap_hwmod_for_each(_setup);
1255 * omap_hwmod_unregister - unregister an omap_hwmod
1256 * @oh: struct omap_hwmod *
1258 * Unregisters a previously-registered omap_hwmod @oh. There's probably
1259 * no use case for this, so it is likely to be removed in a later version.
1261 * XXX Free all of the bootmem-allocated structures here when that is
1262 * implemented. Make it clear that core code is the only code that is
1263 * expected to unregister modules.
1265 int omap_hwmod_unregister(struct omap_hwmod *oh)
1270 pr_debug("omap_hwmod: %s: unregistering\n", oh->name);
1272 mutex_lock(&omap_hwmod_mutex);
1273 iounmap(oh->_rt_va);
1274 list_del(&oh->node);
1275 mutex_unlock(&omap_hwmod_mutex);
1281 * omap_hwmod_enable - enable an omap_hwmod
1282 * @oh: struct omap_hwmod *
1284 * Enable an omap_hwomd @oh. Intended to be called by omap_device_enable().
1285 * Returns -EINVAL on error or passes along the return value from _enable().
1287 int omap_hwmod_enable(struct omap_hwmod *oh)
1294 mutex_lock(&omap_hwmod_mutex);
1296 mutex_unlock(&omap_hwmod_mutex);
1302 * omap_hwmod_idle - idle an omap_hwmod
1303 * @oh: struct omap_hwmod *
1305 * Idle an omap_hwomd @oh. Intended to be called by omap_device_idle().
1306 * Returns -EINVAL on error or passes along the return value from _idle().
1308 int omap_hwmod_idle(struct omap_hwmod *oh)
1313 mutex_lock(&omap_hwmod_mutex);
1315 mutex_unlock(&omap_hwmod_mutex);
1321 * omap_hwmod_shutdown - shutdown an omap_hwmod
1322 * @oh: struct omap_hwmod *
1324 * Shutdown an omap_hwomd @oh. Intended to be called by
1325 * omap_device_shutdown(). Returns -EINVAL on error or passes along
1326 * the return value from _shutdown().
1328 int omap_hwmod_shutdown(struct omap_hwmod *oh)
1333 mutex_lock(&omap_hwmod_mutex);
1335 mutex_unlock(&omap_hwmod_mutex);
1341 * omap_hwmod_enable_clocks - enable main_clk, all interface clocks
1342 * @oh: struct omap_hwmod *oh
1344 * Intended to be called by the omap_device code.
1346 int omap_hwmod_enable_clocks(struct omap_hwmod *oh)
1348 mutex_lock(&omap_hwmod_mutex);
1350 mutex_unlock(&omap_hwmod_mutex);
1356 * omap_hwmod_disable_clocks - disable main_clk, all interface clocks
1357 * @oh: struct omap_hwmod *oh
1359 * Intended to be called by the omap_device code.
1361 int omap_hwmod_disable_clocks(struct omap_hwmod *oh)
1363 mutex_lock(&omap_hwmod_mutex);
1364 _disable_clocks(oh);
1365 mutex_unlock(&omap_hwmod_mutex);
1371 * omap_hwmod_ocp_barrier - wait for posted writes against the hwmod to complete
1372 * @oh: struct omap_hwmod *oh
1374 * Intended to be called by drivers and core code when all posted
1375 * writes to a device must complete before continuing further
1376 * execution (for example, after clearing some device IRQSTATUS
1379 * XXX what about targets with multiple OCP threads?
1381 void omap_hwmod_ocp_barrier(struct omap_hwmod *oh)
1385 if (!oh->class->sysc || !oh->class->sysc->sysc_flags) {
1386 WARN(1, "omap_device: %s: OCP barrier impossible due to "
1387 "device configuration\n", oh->name);
1392 * Forces posted writes to complete on the OCP thread handling
1395 omap_hwmod_readl(oh, oh->class->sysc->sysc_offs);
1399 * omap_hwmod_reset - reset the hwmod
1400 * @oh: struct omap_hwmod *
1402 * Under some conditions, a driver may wish to reset the entire device.
1403 * Called from omap_device code. Returns -EINVAL on error or passes along
1404 * the return value from _reset()/_enable().
1406 int omap_hwmod_reset(struct omap_hwmod *oh)
1410 if (!oh || !(oh->_state & _HWMOD_STATE_ENABLED))
1413 mutex_lock(&omap_hwmod_mutex);
1417 mutex_unlock(&omap_hwmod_mutex);
1423 * omap_hwmod_count_resources - count number of struct resources needed by hwmod
1424 * @oh: struct omap_hwmod *
1425 * @res: pointer to the first element of an array of struct resource to fill
1427 * Count the number of struct resource array elements necessary to
1428 * contain omap_hwmod @oh resources. Intended to be called by code
1429 * that registers omap_devices. Intended to be used to determine the
1430 * size of a dynamically-allocated struct resource array, before
1431 * calling omap_hwmod_fill_resources(). Returns the number of struct
1432 * resource array elements needed.
1434 * XXX This code is not optimized. It could attempt to merge adjacent
1438 int omap_hwmod_count_resources(struct omap_hwmod *oh)
1442 ret = oh->mpu_irqs_cnt + oh->sdma_chs_cnt;
1444 for (i = 0; i < oh->slaves_cnt; i++)
1445 ret += oh->slaves[i]->addr_cnt;
1451 * omap_hwmod_fill_resources - fill struct resource array with hwmod data
1452 * @oh: struct omap_hwmod *
1453 * @res: pointer to the first element of an array of struct resource to fill
1455 * Fill the struct resource array @res with resource data from the
1456 * omap_hwmod @oh. Intended to be called by code that registers
1457 * omap_devices. See also omap_hwmod_count_resources(). Returns the
1458 * number of array elements filled.
1460 int omap_hwmod_fill_resources(struct omap_hwmod *oh, struct resource *res)
1465 /* For each IRQ, DMA, memory area, fill in array.*/
1467 for (i = 0; i < oh->mpu_irqs_cnt; i++) {
1468 (res + r)->name = (oh->mpu_irqs + i)->name;
1469 (res + r)->start = (oh->mpu_irqs + i)->irq;
1470 (res + r)->end = (oh->mpu_irqs + i)->irq;
1471 (res + r)->flags = IORESOURCE_IRQ;
1475 for (i = 0; i < oh->sdma_chs_cnt; i++) {
1476 (res + r)->name = (oh->sdma_chs + i)->name;
1477 (res + r)->start = (oh->sdma_chs + i)->dma_ch;
1478 (res + r)->end = (oh->sdma_chs + i)->dma_ch;
1479 (res + r)->flags = IORESOURCE_DMA;
1483 for (i = 0; i < oh->slaves_cnt; i++) {
1484 struct omap_hwmod_ocp_if *os;
1488 for (j = 0; j < os->addr_cnt; j++) {
1489 (res + r)->start = (os->addr + j)->pa_start;
1490 (res + r)->end = (os->addr + j)->pa_end;
1491 (res + r)->flags = IORESOURCE_MEM;
1500 * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
1501 * @oh: struct omap_hwmod *
1503 * Return the powerdomain pointer associated with the OMAP module
1504 * @oh's main clock. If @oh does not have a main clk, return the
1505 * powerdomain associated with the interface clock associated with the
1506 * module's MPU port. (XXX Perhaps this should use the SDMA port
1507 * instead?) Returns NULL on error, or a struct powerdomain * on
1510 struct powerdomain *omap_hwmod_get_pwrdm(struct omap_hwmod *oh)
1520 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
1522 c = oh->slaves[oh->_mpu_port_index]->_clk;
1528 return c->clkdm->pwrdm.ptr;
1533 * omap_hwmod_add_initiator_dep - add sleepdep from @init_oh to @oh
1534 * @oh: struct omap_hwmod *
1535 * @init_oh: struct omap_hwmod * (initiator)
1537 * Add a sleep dependency between the initiator @init_oh and @oh.
1538 * Intended to be called by DSP/Bridge code via platform_data for the
1539 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
1540 * code needs to add/del initiator dependencies dynamically
1541 * before/after accessing a device. Returns the return value from
1542 * _add_initiator_dep().
1544 * XXX Keep a usecount in the clockdomain code
1546 int omap_hwmod_add_initiator_dep(struct omap_hwmod *oh,
1547 struct omap_hwmod *init_oh)
1549 return _add_initiator_dep(oh, init_oh);
1553 * XXX what about functions for drivers to save/restore ocp_sysconfig
1554 * for context save/restore operations?
1558 * omap_hwmod_del_initiator_dep - remove sleepdep from @init_oh to @oh
1559 * @oh: struct omap_hwmod *
1560 * @init_oh: struct omap_hwmod * (initiator)
1562 * Remove a sleep dependency between the initiator @init_oh and @oh.
1563 * Intended to be called by DSP/Bridge code via platform_data for the
1564 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
1565 * code needs to add/del initiator dependencies dynamically
1566 * before/after accessing a device. Returns the return value from
1567 * _del_initiator_dep().
1569 * XXX Keep a usecount in the clockdomain code
1571 int omap_hwmod_del_initiator_dep(struct omap_hwmod *oh,
1572 struct omap_hwmod *init_oh)
1574 return _del_initiator_dep(oh, init_oh);
1578 * omap_hwmod_enable_wakeup - allow device to wake up the system
1579 * @oh: struct omap_hwmod *
1581 * Sets the module OCP socket ENAWAKEUP bit to allow the module to
1582 * send wakeups to the PRCM. Eventually this should sets PRCM wakeup
1583 * registers to cause the PRCM to receive wakeup events from the
1584 * module. Does not set any wakeup routing registers beyond this
1585 * point - if the module is to wake up any other module or subsystem,
1586 * that must be set separately. Called by omap_device code. Returns
1587 * -EINVAL on error or 0 upon success.
1589 int omap_hwmod_enable_wakeup(struct omap_hwmod *oh)
1591 if (!oh->class->sysc ||
1592 !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
1595 mutex_lock(&omap_hwmod_mutex);
1597 mutex_unlock(&omap_hwmod_mutex);
1603 * omap_hwmod_disable_wakeup - prevent device from waking the system
1604 * @oh: struct omap_hwmod *
1606 * Clears the module OCP socket ENAWAKEUP bit to prevent the module
1607 * from sending wakeups to the PRCM. Eventually this should clear
1608 * PRCM wakeup registers to cause the PRCM to ignore wakeup events
1609 * from the module. Does not set any wakeup routing registers beyond
1610 * this point - if the module is to wake up any other module or
1611 * subsystem, that must be set separately. Called by omap_device
1612 * code. Returns -EINVAL on error or 0 upon success.
1614 int omap_hwmod_disable_wakeup(struct omap_hwmod *oh)
1616 if (!oh->class->sysc ||
1617 !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
1620 mutex_lock(&omap_hwmod_mutex);
1621 _disable_wakeup(oh);
1622 mutex_unlock(&omap_hwmod_mutex);
1628 * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
1629 * @classname: struct omap_hwmod_class name to search for
1630 * @fn: callback function pointer to call for each hwmod in class @classname
1631 * @user: arbitrary context data to pass to the callback function
1633 * For each omap_hwmod of class @classname, call @fn. Takes
1634 * omap_hwmod_mutex to prevent the hwmod list from changing during the
1635 * iteration. If the callback function returns something other than
1636 * zero, the iterator is terminated, and the callback function's return
1637 * value is passed back to the caller. Returns 0 upon success, -EINVAL
1638 * if @classname or @fn are NULL, or passes back the error code from @fn.
1640 int omap_hwmod_for_each_by_class(const char *classname,
1641 int (*fn)(struct omap_hwmod *oh,
1645 struct omap_hwmod *temp_oh;
1648 if (!classname || !fn)
1651 pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
1652 __func__, classname);
1654 mutex_lock(&omap_hwmod_mutex);
1656 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1657 if (!strcmp(temp_oh->class->name, classname)) {
1658 pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
1659 __func__, temp_oh->name);
1660 ret = (*fn)(temp_oh, user);
1666 mutex_unlock(&omap_hwmod_mutex);
1669 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",