]> Gitweb @ Texas Instruments - Open Source Git Repositories - git.TI.com/gitweb - sitara-epos/sitara-epos-kernel.git/blob - arch/arm/mach-omap2/omap_hwmod.c
Merge branch 'v4l_for_linus' of git://git.kernel.org/pub/scm/linux/kernel/git/mchehab...
[sitara-epos/sitara-epos-kernel.git] / arch / arm / mach-omap2 / omap_hwmod.c
1 /*
2  * omap_hwmod implementation for OMAP2/3/4
3  *
4  * Copyright (C) 2009-2011 Nokia Corporation
5  *
6  * Paul Walmsley, BenoĆ®t Cousson, Kevin Hilman
7  *
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
11  *
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.
15  *
16  * Introduction
17  * ------------
18  * One way to view an OMAP SoC is as a collection of largely unrelated
19  * IP blocks connected by interconnects.  The IP blocks include
20  * devices such as ARM processors, audio serial interfaces, UARTs,
21  * etc.  Some of these devices, like the DSP, are created by TI;
22  * others, like the SGX, largely originate from external vendors.  In
23  * TI's documentation, on-chip devices are referred to as "OMAP
24  * modules."  Some of these IP blocks are identical across several
25  * OMAP versions.  Others are revised frequently.
26  *
27  * These OMAP modules are tied together by various interconnects.
28  * Most of the address and data flow between modules is via OCP-based
29  * interconnects such as the L3 and L4 buses; but there are other
30  * interconnects that distribute the hardware clock tree, handle idle
31  * and reset signaling, supply power, and connect the modules to
32  * various pads or balls on the OMAP package.
33  *
34  * OMAP hwmod provides a consistent way to describe the on-chip
35  * hardware blocks and their integration into the rest of the chip.
36  * This description can be automatically generated from the TI
37  * hardware database.  OMAP hwmod provides a standard, consistent API
38  * to reset, enable, idle, and disable these hardware blocks.  And
39  * hwmod provides a way for other core code, such as the Linux device
40  * code or the OMAP power management and address space mapping code,
41  * to query the hardware database.
42  *
43  * Using hwmod
44  * -----------
45  * Drivers won't call hwmod functions directly.  That is done by the
46  * omap_device code, and in rare occasions, by custom integration code
47  * in arch/arm/ *omap*.  The omap_device code includes functions to
48  * build a struct platform_device using omap_hwmod data, and that is
49  * currently how hwmod data is communicated to drivers and to the
50  * Linux driver model.  Most drivers will call omap_hwmod functions only
51  * indirectly, via pm_runtime*() functions.
52  *
53  * From a layering perspective, here is where the OMAP hwmod code
54  * fits into the kernel software stack:
55  *
56  *            +-------------------------------+
57  *            |      Device driver code       |
58  *            |      (e.g., drivers/)         |
59  *            +-------------------------------+
60  *            |      Linux driver model       |
61  *            |     (platform_device /        |
62  *            |  platform_driver data/code)   |
63  *            +-------------------------------+
64  *            | OMAP core-driver integration  |
65  *            |(arch/arm/mach-omap2/devices.c)|
66  *            +-------------------------------+
67  *            |      omap_device code         |
68  *            | (../plat-omap/omap_device.c)  |
69  *            +-------------------------------+
70  *   ---->    |    omap_hwmod code/data       |    <-----
71  *            | (../mach-omap2/omap_hwmod*)   |
72  *            +-------------------------------+
73  *            | OMAP clock/PRCM/register fns  |
74  *            | (__raw_{read,write}l, clk*)   |
75  *            +-------------------------------+
76  *
77  * Device drivers should not contain any OMAP-specific code or data in
78  * them.  They should only contain code to operate the IP block that
79  * the driver is responsible for.  This is because these IP blocks can
80  * also appear in other SoCs, either from TI (such as DaVinci) or from
81  * other manufacturers; and drivers should be reusable across other
82  * platforms.
83  *
84  * The OMAP hwmod code also will attempt to reset and idle all on-chip
85  * devices upon boot.  The goal here is for the kernel to be
86  * completely self-reliant and independent from bootloaders.  This is
87  * to ensure a repeatable configuration, both to ensure consistent
88  * runtime behavior, and to make it easier for others to reproduce
89  * bugs.
90  *
91  * OMAP module activity states
92  * ---------------------------
93  * The hwmod code considers modules to be in one of several activity
94  * states.  IP blocks start out in an UNKNOWN state, then once they
95  * are registered via the hwmod code, proceed to the REGISTERED state.
96  * Once their clock names are resolved to clock pointers, the module
97  * enters the CLKS_INITED state; and finally, once the module has been
98  * reset and the integration registers programmed, the INITIALIZED state
99  * is entered.  The hwmod code will then place the module into either
100  * the IDLE state to save power, or in the case of a critical system
101  * module, the ENABLED state.
102  *
103  * OMAP core integration code can then call omap_hwmod*() functions
104  * directly to move the module between the IDLE, ENABLED, and DISABLED
105  * states, as needed.  This is done during both the PM idle loop, and
106  * in the OMAP core integration code's implementation of the PM runtime
107  * functions.
108  *
109  * References
110  * ----------
111  * This is a partial list.
112  * - OMAP2420 Multimedia Processor Silicon Revision 2.1.1, 2.2 (SWPU064)
113  * - OMAP2430 Multimedia Device POP Silicon Revision 2.1 (SWPU090)
114  * - OMAP34xx Multimedia Device Silicon Revision 3.1 (SWPU108)
115  * - OMAP4430 Multimedia Device Silicon Revision 1.0 (SWPU140)
116  * - Open Core Protocol Specification 2.2
117  *
118  * To do:
119  * - handle IO mapping
120  * - bus throughput & module latency measurement code
121  *
122  * XXX add tests at the beginning of each function to ensure the hwmod is
123  * in the appropriate state
124  * XXX error return values should be checked to ensure that they are
125  * appropriate
126  */
127 #undef DEBUG
129 #include <linux/kernel.h>
130 #include <linux/errno.h>
131 #include <linux/io.h>
132 #include <linux/clk.h>
133 #include <linux/delay.h>
134 #include <linux/err.h>
135 #include <linux/list.h>
136 #include <linux/mutex.h>
137 #include <linux/spinlock.h>
139 #include <plat/common.h>
140 #include <plat/cpu.h>
141 #include "clockdomain.h"
142 #include "powerdomain.h"
143 #include <plat/clock.h>
144 #include <plat/omap_hwmod.h>
145 #include <plat/prcm.h>
147 #include "cm2xxx_3xxx.h"
148 #include "cm44xx.h"
149 #include "prm2xxx_3xxx.h"
150 #include "prm44xx.h"
151 #include "mux.h"
153 /* Maximum microseconds to wait for OMAP module to softreset */
154 #define MAX_MODULE_SOFTRESET_WAIT       10000
156 /* Name of the OMAP hwmod for the MPU */
157 #define MPU_INITIATOR_NAME              "mpu"
159 /* omap_hwmod_list contains all registered struct omap_hwmods */
160 static LIST_HEAD(omap_hwmod_list);
162 /* mpu_oh: used to add/remove MPU initiator from sleepdep list */
163 static struct omap_hwmod *mpu_oh;
166 /* Private functions */
168 /**
169  * _update_sysc_cache - return the module OCP_SYSCONFIG register, keep copy
170  * @oh: struct omap_hwmod *
171  *
172  * Load the current value of the hwmod OCP_SYSCONFIG register into the
173  * struct omap_hwmod for later use.  Returns -EINVAL if the hwmod has no
174  * OCP_SYSCONFIG register or 0 upon success.
175  */
176 static int _update_sysc_cache(struct omap_hwmod *oh)
178         if (!oh->class->sysc) {
179                 WARN(1, "omap_hwmod: %s: cannot read OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
180                 return -EINVAL;
181         }
183         /* XXX ensure module interface clock is up */
185         oh->_sysc_cache = omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
187         if (!(oh->class->sysc->sysc_flags & SYSC_NO_CACHE))
188                 oh->_int_flags |= _HWMOD_SYSCONFIG_LOADED;
190         return 0;
193 /**
194  * _write_sysconfig - write a value to the module's OCP_SYSCONFIG register
195  * @v: OCP_SYSCONFIG value to write
196  * @oh: struct omap_hwmod *
197  *
198  * Write @v into the module class' OCP_SYSCONFIG register, if it has
199  * one.  No return value.
200  */
201 static void _write_sysconfig(u32 v, struct omap_hwmod *oh)
203         if (!oh->class->sysc) {
204                 WARN(1, "omap_hwmod: %s: cannot write OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
205                 return;
206         }
208         /* XXX ensure module interface clock is up */
210         /* Module might have lost context, always update cache and register */
211         oh->_sysc_cache = v;
212         omap_hwmod_write(v, oh, oh->class->sysc->sysc_offs);
215 /**
216  * _set_master_standbymode: set the OCP_SYSCONFIG MIDLEMODE field in @v
217  * @oh: struct omap_hwmod *
218  * @standbymode: MIDLEMODE field bits
219  * @v: pointer to register contents to modify
220  *
221  * Update the master standby mode bits in @v to be @standbymode for
222  * the @oh hwmod.  Does not write to the hardware.  Returns -EINVAL
223  * upon error or 0 upon success.
224  */
225 static int _set_master_standbymode(struct omap_hwmod *oh, u8 standbymode,
226                                    u32 *v)
228         u32 mstandby_mask;
229         u8 mstandby_shift;
231         if (!oh->class->sysc ||
232             !(oh->class->sysc->sysc_flags & SYSC_HAS_MIDLEMODE))
233                 return -EINVAL;
235         if (!oh->class->sysc->sysc_fields) {
236                 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
237                 return -EINVAL;
238         }
240         mstandby_shift = oh->class->sysc->sysc_fields->midle_shift;
241         mstandby_mask = (0x3 << mstandby_shift);
243         *v &= ~mstandby_mask;
244         *v |= __ffs(standbymode) << mstandby_shift;
246         return 0;
249 /**
250  * _set_slave_idlemode: set the OCP_SYSCONFIG SIDLEMODE field in @v
251  * @oh: struct omap_hwmod *
252  * @idlemode: SIDLEMODE field bits
253  * @v: pointer to register contents to modify
254  *
255  * Update the slave idle mode bits in @v to be @idlemode for the @oh
256  * hwmod.  Does not write to the hardware.  Returns -EINVAL upon error
257  * or 0 upon success.
258  */
259 static int _set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode, u32 *v)
261         u32 sidle_mask;
262         u8 sidle_shift;
264         if (!oh->class->sysc ||
265             !(oh->class->sysc->sysc_flags & SYSC_HAS_SIDLEMODE))
266                 return -EINVAL;
268         if (!oh->class->sysc->sysc_fields) {
269                 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
270                 return -EINVAL;
271         }
273         sidle_shift = oh->class->sysc->sysc_fields->sidle_shift;
274         sidle_mask = (0x3 << sidle_shift);
276         *v &= ~sidle_mask;
277         *v |= __ffs(idlemode) << sidle_shift;
279         return 0;
282 /**
283  * _set_clockactivity: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
284  * @oh: struct omap_hwmod *
285  * @clockact: CLOCKACTIVITY field bits
286  * @v: pointer to register contents to modify
287  *
288  * Update the clockactivity mode bits in @v to be @clockact for the
289  * @oh hwmod.  Used for additional powersaving on some modules.  Does
290  * not write to the hardware.  Returns -EINVAL upon error or 0 upon
291  * success.
292  */
293 static int _set_clockactivity(struct omap_hwmod *oh, u8 clockact, u32 *v)
295         u32 clkact_mask;
296         u8  clkact_shift;
298         if (!oh->class->sysc ||
299             !(oh->class->sysc->sysc_flags & SYSC_HAS_CLOCKACTIVITY))
300                 return -EINVAL;
302         if (!oh->class->sysc->sysc_fields) {
303                 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
304                 return -EINVAL;
305         }
307         clkact_shift = oh->class->sysc->sysc_fields->clkact_shift;
308         clkact_mask = (0x3 << clkact_shift);
310         *v &= ~clkact_mask;
311         *v |= clockact << clkact_shift;
313         return 0;
316 /**
317  * _set_softreset: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
318  * @oh: struct omap_hwmod *
319  * @v: pointer to register contents to modify
320  *
321  * Set the SOFTRESET bit in @v for hwmod @oh.  Returns -EINVAL upon
322  * error or 0 upon success.
323  */
324 static int _set_softreset(struct omap_hwmod *oh, u32 *v)
326         u32 softrst_mask;
328         if (!oh->class->sysc ||
329             !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
330                 return -EINVAL;
332         if (!oh->class->sysc->sysc_fields) {
333                 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
334                 return -EINVAL;
335         }
337         softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
339         *v |= softrst_mask;
341         return 0;
344 /**
345  * _set_module_autoidle: set the OCP_SYSCONFIG AUTOIDLE field in @v
346  * @oh: struct omap_hwmod *
347  * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
348  * @v: pointer to register contents to modify
349  *
350  * Update the module autoidle bit in @v to be @autoidle for the @oh
351  * hwmod.  The autoidle bit controls whether the module can gate
352  * internal clocks automatically when it isn't doing anything; the
353  * exact function of this bit varies on a per-module basis.  This
354  * function does not write to the hardware.  Returns -EINVAL upon
355  * error or 0 upon success.
356  */
357 static int _set_module_autoidle(struct omap_hwmod *oh, u8 autoidle,
358                                 u32 *v)
360         u32 autoidle_mask;
361         u8 autoidle_shift;
363         if (!oh->class->sysc ||
364             !(oh->class->sysc->sysc_flags & SYSC_HAS_AUTOIDLE))
365                 return -EINVAL;
367         if (!oh->class->sysc->sysc_fields) {
368                 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
369                 return -EINVAL;
370         }
372         autoidle_shift = oh->class->sysc->sysc_fields->autoidle_shift;
373         autoidle_mask = (0x1 << autoidle_shift);
375         *v &= ~autoidle_mask;
376         *v |= autoidle << autoidle_shift;
378         return 0;
381 /**
382  * _enable_wakeup: set OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
383  * @oh: struct omap_hwmod *
384  *
385  * Allow the hardware module @oh to send wakeups.  Returns -EINVAL
386  * upon error or 0 upon success.
387  */
388 static int _enable_wakeup(struct omap_hwmod *oh, u32 *v)
390         u32 wakeup_mask;
392         if (!oh->class->sysc ||
393             !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
394               (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)))
395                 return -EINVAL;
397         if (!oh->class->sysc->sysc_fields) {
398                 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
399                 return -EINVAL;
400         }
402         wakeup_mask = (0x1 << oh->class->sysc->sysc_fields->enwkup_shift);
404         *v |= wakeup_mask;
406         if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
407                 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
409         /* XXX test pwrdm_get_wken for this hwmod's subsystem */
411         oh->_int_flags |= _HWMOD_WAKEUP_ENABLED;
413         return 0;
416 /**
417  * _disable_wakeup: clear OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
418  * @oh: struct omap_hwmod *
419  *
420  * Prevent the hardware module @oh to send wakeups.  Returns -EINVAL
421  * upon error or 0 upon success.
422  */
423 static int _disable_wakeup(struct omap_hwmod *oh, u32 *v)
425         u32 wakeup_mask;
427         if (!oh->class->sysc ||
428             !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
429               (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)))
430                 return -EINVAL;
432         if (!oh->class->sysc->sysc_fields) {
433                 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
434                 return -EINVAL;
435         }
437         wakeup_mask = (0x1 << oh->class->sysc->sysc_fields->enwkup_shift);
439         *v &= ~wakeup_mask;
441         if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
442                 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART, v);
444         /* XXX test pwrdm_get_wken for this hwmod's subsystem */
446         oh->_int_flags &= ~_HWMOD_WAKEUP_ENABLED;
448         return 0;
451 /**
452  * _add_initiator_dep: prevent @oh from smart-idling while @init_oh is active
453  * @oh: struct omap_hwmod *
454  *
455  * Prevent the hardware module @oh from entering idle while the
456  * hardare module initiator @init_oh is active.  Useful when a module
457  * will be accessed by a particular initiator (e.g., if a module will
458  * be accessed by the IVA, there should be a sleepdep between the IVA
459  * initiator and the module).  Only applies to modules in smart-idle
460  * mode.  If the clockdomain is marked as not needing autodeps, return
461  * 0 without doing anything.  Otherwise, returns -EINVAL upon error or
462  * passes along clkdm_add_sleepdep() value upon success.
463  */
464 static int _add_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
466         if (!oh->_clk)
467                 return -EINVAL;
469         if (oh->_clk->clkdm && oh->_clk->clkdm->flags & CLKDM_NO_AUTODEPS)
470                 return 0;
472         return clkdm_add_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
475 /**
476  * _del_initiator_dep: allow @oh to smart-idle even if @init_oh is active
477  * @oh: struct omap_hwmod *
478  *
479  * Allow the hardware module @oh to enter idle while the hardare
480  * module initiator @init_oh is active.  Useful when a module will not
481  * be accessed by a particular initiator (e.g., if a module will not
482  * be accessed by the IVA, there should be no sleepdep between the IVA
483  * initiator and the module).  Only applies to modules in smart-idle
484  * mode.  If the clockdomain is marked as not needing autodeps, return
485  * 0 without doing anything.  Returns -EINVAL upon error or passes
486  * along clkdm_del_sleepdep() value upon success.
487  */
488 static int _del_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
490         if (!oh->_clk)
491                 return -EINVAL;
493         if (oh->_clk->clkdm && oh->_clk->clkdm->flags & CLKDM_NO_AUTODEPS)
494                 return 0;
496         return clkdm_del_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
499 /**
500  * _init_main_clk - get a struct clk * for the the hwmod's main functional clk
501  * @oh: struct omap_hwmod *
502  *
503  * Called from _init_clocks().  Populates the @oh _clk (main
504  * functional clock pointer) if a main_clk is present.  Returns 0 on
505  * success or -EINVAL on error.
506  */
507 static int _init_main_clk(struct omap_hwmod *oh)
509         int ret = 0;
511         if (!oh->main_clk)
512                 return 0;
514         oh->_clk = omap_clk_get_by_name(oh->main_clk);
515         if (!oh->_clk) {
516                 pr_warning("omap_hwmod: %s: cannot clk_get main_clk %s\n",
517                            oh->name, oh->main_clk);
518                 return -EINVAL;
519         }
521         if (!oh->_clk->clkdm)
522                 pr_warning("omap_hwmod: %s: missing clockdomain for %s.\n",
523                            oh->main_clk, oh->_clk->name);
525         return ret;
528 /**
529  * _init_interface_clks - get a struct clk * for the the hwmod's interface clks
530  * @oh: struct omap_hwmod *
531  *
532  * Called from _init_clocks().  Populates the @oh OCP slave interface
533  * clock pointers.  Returns 0 on success or -EINVAL on error.
534  */
535 static int _init_interface_clks(struct omap_hwmod *oh)
537         struct clk *c;
538         int i;
539         int ret = 0;
541         if (oh->slaves_cnt == 0)
542                 return 0;
544         for (i = 0; i < oh->slaves_cnt; i++) {
545                 struct omap_hwmod_ocp_if *os = oh->slaves[i];
547                 if (!os->clk)
548                         continue;
550                 c = omap_clk_get_by_name(os->clk);
551                 if (!c) {
552                         pr_warning("omap_hwmod: %s: cannot clk_get interface_clk %s\n",
553                                    oh->name, os->clk);
554                         ret = -EINVAL;
555                 }
556                 os->_clk = c;
557         }
559         return ret;
562 /**
563  * _init_opt_clk - get a struct clk * for the the hwmod's optional clocks
564  * @oh: struct omap_hwmod *
565  *
566  * Called from _init_clocks().  Populates the @oh omap_hwmod_opt_clk
567  * clock pointers.  Returns 0 on success or -EINVAL on error.
568  */
569 static int _init_opt_clks(struct omap_hwmod *oh)
571         struct omap_hwmod_opt_clk *oc;
572         struct clk *c;
573         int i;
574         int ret = 0;
576         for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++) {
577                 c = omap_clk_get_by_name(oc->clk);
578                 if (!c) {
579                         pr_warning("omap_hwmod: %s: cannot clk_get opt_clk %s\n",
580                                    oh->name, oc->clk);
581                         ret = -EINVAL;
582                 }
583                 oc->_clk = c;
584         }
586         return ret;
589 /**
590  * _enable_clocks - enable hwmod main clock and interface clocks
591  * @oh: struct omap_hwmod *
592  *
593  * Enables all clocks necessary for register reads and writes to succeed
594  * on the hwmod @oh.  Returns 0.
595  */
596 static int _enable_clocks(struct omap_hwmod *oh)
598         int i;
600         pr_debug("omap_hwmod: %s: enabling clocks\n", oh->name);
602         if (oh->_clk)
603                 clk_enable(oh->_clk);
605         if (oh->slaves_cnt > 0) {
606                 for (i = 0; i < oh->slaves_cnt; i++) {
607                         struct omap_hwmod_ocp_if *os = oh->slaves[i];
608                         struct clk *c = os->_clk;
610                         if (c && (os->flags & OCPIF_SWSUP_IDLE))
611                                 clk_enable(c);
612                 }
613         }
615         /* The opt clocks are controlled by the device driver. */
617         return 0;
620 /**
621  * _disable_clocks - disable hwmod main clock and interface clocks
622  * @oh: struct omap_hwmod *
623  *
624  * Disables the hwmod @oh main functional and interface clocks.  Returns 0.
625  */
626 static int _disable_clocks(struct omap_hwmod *oh)
628         int i;
630         pr_debug("omap_hwmod: %s: disabling clocks\n", oh->name);
632         if (oh->_clk)
633                 clk_disable(oh->_clk);
635         if (oh->slaves_cnt > 0) {
636                 for (i = 0; i < oh->slaves_cnt; i++) {
637                         struct omap_hwmod_ocp_if *os = oh->slaves[i];
638                         struct clk *c = os->_clk;
640                         if (c && (os->flags & OCPIF_SWSUP_IDLE))
641                                 clk_disable(c);
642                 }
643         }
645         /* The opt clocks are controlled by the device driver. */
647         return 0;
650 static void _enable_optional_clocks(struct omap_hwmod *oh)
652         struct omap_hwmod_opt_clk *oc;
653         int i;
655         pr_debug("omap_hwmod: %s: enabling optional clocks\n", oh->name);
657         for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
658                 if (oc->_clk) {
659                         pr_debug("omap_hwmod: enable %s:%s\n", oc->role,
660                                  oc->_clk->name);
661                         clk_enable(oc->_clk);
662                 }
665 static void _disable_optional_clocks(struct omap_hwmod *oh)
667         struct omap_hwmod_opt_clk *oc;
668         int i;
670         pr_debug("omap_hwmod: %s: disabling optional clocks\n", oh->name);
672         for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
673                 if (oc->_clk) {
674                         pr_debug("omap_hwmod: disable %s:%s\n", oc->role,
675                                  oc->_clk->name);
676                         clk_disable(oc->_clk);
677                 }
680 /**
681  * _find_mpu_port_index - find hwmod OCP slave port ID intended for MPU use
682  * @oh: struct omap_hwmod *
683  *
684  * Returns the array index of the OCP slave port that the MPU
685  * addresses the device on, or -EINVAL upon error or not found.
686  */
687 static int __init _find_mpu_port_index(struct omap_hwmod *oh)
689         int i;
690         int found = 0;
692         if (!oh || oh->slaves_cnt == 0)
693                 return -EINVAL;
695         for (i = 0; i < oh->slaves_cnt; i++) {
696                 struct omap_hwmod_ocp_if *os = oh->slaves[i];
698                 if (os->user & OCP_USER_MPU) {
699                         found = 1;
700                         break;
701                 }
702         }
704         if (found)
705                 pr_debug("omap_hwmod: %s: MPU OCP slave port ID  %d\n",
706                          oh->name, i);
707         else
708                 pr_debug("omap_hwmod: %s: no MPU OCP slave port found\n",
709                          oh->name);
711         return (found) ? i : -EINVAL;
714 /**
715  * _find_mpu_rt_base - find hwmod register target base addr accessible by MPU
716  * @oh: struct omap_hwmod *
717  *
718  * Return the virtual address of the base of the register target of
719  * device @oh, or NULL on error.
720  */
721 static void __iomem * __init _find_mpu_rt_base(struct omap_hwmod *oh, u8 index)
723         struct omap_hwmod_ocp_if *os;
724         struct omap_hwmod_addr_space *mem;
725         int i;
726         int found = 0;
727         void __iomem *va_start;
729         if (!oh || oh->slaves_cnt == 0)
730                 return NULL;
732         os = oh->slaves[index];
734         for (i = 0, mem = os->addr; i < os->addr_cnt; i++, mem++) {
735                 if (mem->flags & ADDR_TYPE_RT) {
736                         found = 1;
737                         break;
738                 }
739         }
741         if (found) {
742                 va_start = ioremap(mem->pa_start, mem->pa_end - mem->pa_start);
743                 if (!va_start) {
744                         pr_err("omap_hwmod: %s: Could not ioremap\n", oh->name);
745                         return NULL;
746                 }
747                 pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
748                          oh->name, va_start);
749         } else {
750                 pr_debug("omap_hwmod: %s: no MPU register target found\n",
751                          oh->name);
752         }
754         return (found) ? va_start : NULL;
757 /**
758  * _enable_sysc - try to bring a module out of idle via OCP_SYSCONFIG
759  * @oh: struct omap_hwmod *
760  *
761  * If module is marked as SWSUP_SIDLE, force the module out of slave
762  * idle; otherwise, configure it for smart-idle.  If module is marked
763  * as SWSUP_MSUSPEND, force the module out of master standby;
764  * otherwise, configure it for smart-standby.  No return value.
765  */
766 static void _enable_sysc(struct omap_hwmod *oh)
768         u8 idlemode, sf;
769         u32 v;
771         if (!oh->class->sysc)
772                 return;
774         v = oh->_sysc_cache;
775         sf = oh->class->sysc->sysc_flags;
777         if (sf & SYSC_HAS_SIDLEMODE) {
778                 idlemode = (oh->flags & HWMOD_SWSUP_SIDLE) ?
779                         HWMOD_IDLEMODE_NO : HWMOD_IDLEMODE_SMART;
780                 _set_slave_idlemode(oh, idlemode, &v);
781         }
783         if (sf & SYSC_HAS_MIDLEMODE) {
784                 idlemode = (oh->flags & HWMOD_SWSUP_MSTANDBY) ?
785                         HWMOD_IDLEMODE_NO : HWMOD_IDLEMODE_SMART;
786                 _set_master_standbymode(oh, idlemode, &v);
787         }
789         /*
790          * XXX The clock framework should handle this, by
791          * calling into this code.  But this must wait until the
792          * clock structures are tagged with omap_hwmod entries
793          */
794         if ((oh->flags & HWMOD_SET_DEFAULT_CLOCKACT) &&
795             (sf & SYSC_HAS_CLOCKACTIVITY))
796                 _set_clockactivity(oh, oh->class->sysc->clockact, &v);
798         /* If slave is in SMARTIDLE, also enable wakeup */
799         if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
800                 _enable_wakeup(oh, &v);
802         _write_sysconfig(v, oh);
804         /*
805          * Set the autoidle bit only after setting the smartidle bit
806          * Setting this will not have any impact on the other modules.
807          */
808         if (sf & SYSC_HAS_AUTOIDLE) {
809                 idlemode = (oh->flags & HWMOD_NO_OCP_AUTOIDLE) ?
810                         0 : 1;
811                 _set_module_autoidle(oh, idlemode, &v);
812                 _write_sysconfig(v, oh);
813         }
816 /**
817  * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
818  * @oh: struct omap_hwmod *
819  *
820  * If module is marked as SWSUP_SIDLE, force the module into slave
821  * idle; otherwise, configure it for smart-idle.  If module is marked
822  * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
823  * configure it for smart-standby.  No return value.
824  */
825 static void _idle_sysc(struct omap_hwmod *oh)
827         u8 idlemode, sf;
828         u32 v;
830         if (!oh->class->sysc)
831                 return;
833         v = oh->_sysc_cache;
834         sf = oh->class->sysc->sysc_flags;
836         if (sf & SYSC_HAS_SIDLEMODE) {
837                 idlemode = (oh->flags & HWMOD_SWSUP_SIDLE) ?
838                         HWMOD_IDLEMODE_FORCE : HWMOD_IDLEMODE_SMART;
839                 _set_slave_idlemode(oh, idlemode, &v);
840         }
842         if (sf & SYSC_HAS_MIDLEMODE) {
843                 idlemode = (oh->flags & HWMOD_SWSUP_MSTANDBY) ?
844                         HWMOD_IDLEMODE_FORCE : HWMOD_IDLEMODE_SMART;
845                 _set_master_standbymode(oh, idlemode, &v);
846         }
848         /* If slave is in SMARTIDLE, also enable wakeup */
849         if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
850                 _enable_wakeup(oh, &v);
852         _write_sysconfig(v, oh);
855 /**
856  * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
857  * @oh: struct omap_hwmod *
858  *
859  * Force the module into slave idle and master suspend. No return
860  * value.
861  */
862 static void _shutdown_sysc(struct omap_hwmod *oh)
864         u32 v;
865         u8 sf;
867         if (!oh->class->sysc)
868                 return;
870         v = oh->_sysc_cache;
871         sf = oh->class->sysc->sysc_flags;
873         if (sf & SYSC_HAS_SIDLEMODE)
874                 _set_slave_idlemode(oh, HWMOD_IDLEMODE_FORCE, &v);
876         if (sf & SYSC_HAS_MIDLEMODE)
877                 _set_master_standbymode(oh, HWMOD_IDLEMODE_FORCE, &v);
879         if (sf & SYSC_HAS_AUTOIDLE)
880                 _set_module_autoidle(oh, 1, &v);
882         _write_sysconfig(v, oh);
885 /**
886  * _lookup - find an omap_hwmod by name
887  * @name: find an omap_hwmod by name
888  *
889  * Return a pointer to an omap_hwmod by name, or NULL if not found.
890  */
891 static struct omap_hwmod *_lookup(const char *name)
893         struct omap_hwmod *oh, *temp_oh;
895         oh = NULL;
897         list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
898                 if (!strcmp(name, temp_oh->name)) {
899                         oh = temp_oh;
900                         break;
901                 }
902         }
904         return oh;
907 /**
908  * _init_clocks - clk_get() all clocks associated with this hwmod
909  * @oh: struct omap_hwmod *
910  * @data: not used; pass NULL
911  *
912  * Called by omap_hwmod_setup_*() (after omap2_clk_init()).
913  * Resolves all clock names embedded in the hwmod.  Returns 0 on
914  * success, or a negative error code on failure.
915  */
916 static int _init_clocks(struct omap_hwmod *oh, void *data)
918         int ret = 0;
920         if (oh->_state != _HWMOD_STATE_REGISTERED)
921                 return 0;
923         pr_debug("omap_hwmod: %s: looking up clocks\n", oh->name);
925         ret |= _init_main_clk(oh);
926         ret |= _init_interface_clks(oh);
927         ret |= _init_opt_clks(oh);
929         if (!ret)
930                 oh->_state = _HWMOD_STATE_CLKS_INITED;
932         return ret;
935 /**
936  * _wait_target_ready - wait for a module to leave slave idle
937  * @oh: struct omap_hwmod *
938  *
939  * Wait for a module @oh to leave slave idle.  Returns 0 if the module
940  * does not have an IDLEST bit or if the module successfully leaves
941  * slave idle; otherwise, pass along the return value of the
942  * appropriate *_cm_wait_module_ready() function.
943  */
944 static int _wait_target_ready(struct omap_hwmod *oh)
946         struct omap_hwmod_ocp_if *os;
947         int ret;
949         if (!oh)
950                 return -EINVAL;
952         if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
953                 return 0;
955         os = oh->slaves[oh->_mpu_port_index];
957         if (oh->flags & HWMOD_NO_IDLEST)
958                 return 0;
960         /* XXX check module SIDLEMODE */
962         /* XXX check clock enable states */
964         if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
965                 ret = omap2_cm_wait_module_ready(oh->prcm.omap2.module_offs,
966                                                  oh->prcm.omap2.idlest_reg_id,
967                                                  oh->prcm.omap2.idlest_idle_bit);
968         } else if (cpu_is_omap44xx()) {
969                 ret = omap4_cm_wait_module_ready(oh->prcm.omap4.clkctrl_reg);
970         } else {
971                 BUG();
972         };
974         return ret;
977 /**
978  * _lookup_hardreset - fill register bit info for this hwmod/reset line
979  * @oh: struct omap_hwmod *
980  * @name: name of the reset line in the context of this hwmod
981  * @ohri: struct omap_hwmod_rst_info * that this function will fill in
982  *
983  * Return the bit position of the reset line that match the
984  * input name. Return -ENOENT if not found.
985  */
986 static u8 _lookup_hardreset(struct omap_hwmod *oh, const char *name,
987                             struct omap_hwmod_rst_info *ohri)
989         int i;
991         for (i = 0; i < oh->rst_lines_cnt; i++) {
992                 const char *rst_line = oh->rst_lines[i].name;
993                 if (!strcmp(rst_line, name)) {
994                         ohri->rst_shift = oh->rst_lines[i].rst_shift;
995                         ohri->st_shift = oh->rst_lines[i].st_shift;
996                         pr_debug("omap_hwmod: %s: %s: %s: rst %d st %d\n",
997                                  oh->name, __func__, rst_line, ohri->rst_shift,
998                                  ohri->st_shift);
1000                         return 0;
1001                 }
1002         }
1004         return -ENOENT;
1007 /**
1008  * _assert_hardreset - assert the HW reset line of submodules
1009  * contained in the hwmod module.
1010  * @oh: struct omap_hwmod *
1011  * @name: name of the reset line to lookup and assert
1012  *
1013  * Some IP like dsp, ipu or iva contain processor that require
1014  * an HW reset line to be assert / deassert in order to enable fully
1015  * the IP.
1016  */
1017 static int _assert_hardreset(struct omap_hwmod *oh, const char *name)
1019         struct omap_hwmod_rst_info ohri;
1020         u8 ret;
1022         if (!oh)
1023                 return -EINVAL;
1025         ret = _lookup_hardreset(oh, name, &ohri);
1026         if (IS_ERR_VALUE(ret))
1027                 return ret;
1029         if (cpu_is_omap24xx() || cpu_is_omap34xx())
1030                 return omap2_prm_assert_hardreset(oh->prcm.omap2.module_offs,
1031                                                   ohri.rst_shift);
1032         else if (cpu_is_omap44xx())
1033                 return omap4_prm_assert_hardreset(oh->prcm.omap4.rstctrl_reg,
1034                                                   ohri.rst_shift);
1035         else
1036                 return -EINVAL;
1039 /**
1040  * _deassert_hardreset - deassert the HW reset line of submodules contained
1041  * in the hwmod module.
1042  * @oh: struct omap_hwmod *
1043  * @name: name of the reset line to look up and deassert
1044  *
1045  * Some IP like dsp, ipu or iva contain processor that require
1046  * an HW reset line to be assert / deassert in order to enable fully
1047  * the IP.
1048  */
1049 static int _deassert_hardreset(struct omap_hwmod *oh, const char *name)
1051         struct omap_hwmod_rst_info ohri;
1052         int ret;
1054         if (!oh)
1055                 return -EINVAL;
1057         ret = _lookup_hardreset(oh, name, &ohri);
1058         if (IS_ERR_VALUE(ret))
1059                 return ret;
1061         if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1062                 ret = omap2_prm_deassert_hardreset(oh->prcm.omap2.module_offs,
1063                                                    ohri.rst_shift,
1064                                                    ohri.st_shift);
1065         } else if (cpu_is_omap44xx()) {
1066                 if (ohri.st_shift)
1067                         pr_err("omap_hwmod: %s: %s: hwmod data error: OMAP4 does not support st_shift\n",
1068                                oh->name, name);
1069                 ret = omap4_prm_deassert_hardreset(oh->prcm.omap4.rstctrl_reg,
1070                                                    ohri.rst_shift);
1071         } else {
1072                 return -EINVAL;
1073         }
1075         if (ret == -EBUSY)
1076                 pr_warning("omap_hwmod: %s: failed to hardreset\n", oh->name);
1078         return ret;
1081 /**
1082  * _read_hardreset - read the HW reset line state of submodules
1083  * contained in the hwmod module
1084  * @oh: struct omap_hwmod *
1085  * @name: name of the reset line to look up and read
1086  *
1087  * Return the state of the reset line.
1088  */
1089 static int _read_hardreset(struct omap_hwmod *oh, const char *name)
1091         struct omap_hwmod_rst_info ohri;
1092         u8 ret;
1094         if (!oh)
1095                 return -EINVAL;
1097         ret = _lookup_hardreset(oh, name, &ohri);
1098         if (IS_ERR_VALUE(ret))
1099                 return ret;
1101         if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1102                 return omap2_prm_is_hardreset_asserted(oh->prcm.omap2.module_offs,
1103                                                        ohri.st_shift);
1104         } else if (cpu_is_omap44xx()) {
1105                 return omap4_prm_is_hardreset_asserted(oh->prcm.omap4.rstctrl_reg,
1106                                                        ohri.rst_shift);
1107         } else {
1108                 return -EINVAL;
1109         }
1112 /**
1113  * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1114  * @oh: struct omap_hwmod *
1115  *
1116  * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit.  hwmod must be
1117  * enabled for this to work.  Returns -EINVAL if the hwmod cannot be
1118  * reset this way or if the hwmod is in the wrong state, -ETIMEDOUT if
1119  * the module did not reset in time, or 0 upon success.
1120  *
1121  * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1122  * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1123  * use the SYSCONFIG softreset bit to provide the status.
1124  *
1125  * Note that some IP like McBSP do have reset control but don't have
1126  * reset status.
1127  */
1128 static int _ocp_softreset(struct omap_hwmod *oh)
1130         u32 v;
1131         int c = 0;
1132         int ret = 0;
1134         if (!oh->class->sysc ||
1135             !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
1136                 return -EINVAL;
1138         /* clocks must be on for this operation */
1139         if (oh->_state != _HWMOD_STATE_ENABLED) {
1140                 pr_warning("omap_hwmod: %s: reset can only be entered from "
1141                            "enabled state\n", oh->name);
1142                 return -EINVAL;
1143         }
1145         /* For some modules, all optionnal clocks need to be enabled as well */
1146         if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1147                 _enable_optional_clocks(oh);
1149         pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh->name);
1151         v = oh->_sysc_cache;
1152         ret = _set_softreset(oh, &v);
1153         if (ret)
1154                 goto dis_opt_clks;
1155         _write_sysconfig(v, oh);
1157         if (oh->class->sysc->sysc_flags & SYSS_HAS_RESET_STATUS)
1158                 omap_test_timeout((omap_hwmod_read(oh,
1159                                                     oh->class->sysc->syss_offs)
1160                                    & SYSS_RESETDONE_MASK),
1161                                   MAX_MODULE_SOFTRESET_WAIT, c);
1162         else if (oh->class->sysc->sysc_flags & SYSC_HAS_RESET_STATUS)
1163                 omap_test_timeout(!(omap_hwmod_read(oh,
1164                                                      oh->class->sysc->sysc_offs)
1165                                    & SYSC_TYPE2_SOFTRESET_MASK),
1166                                   MAX_MODULE_SOFTRESET_WAIT, c);
1168         if (c == MAX_MODULE_SOFTRESET_WAIT)
1169                 pr_warning("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1170                            oh->name, MAX_MODULE_SOFTRESET_WAIT);
1171         else
1172                 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh->name, c);
1174         /*
1175          * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1176          * _wait_target_ready() or _reset()
1177          */
1179         ret = (c == MAX_MODULE_SOFTRESET_WAIT) ? -ETIMEDOUT : 0;
1181 dis_opt_clks:
1182         if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1183                 _disable_optional_clocks(oh);
1185         return ret;
1188 /**
1189  * _reset - reset an omap_hwmod
1190  * @oh: struct omap_hwmod *
1191  *
1192  * Resets an omap_hwmod @oh.  The default software reset mechanism for
1193  * most OMAP IP blocks is triggered via the OCP_SYSCONFIG.SOFTRESET
1194  * bit.  However, some hwmods cannot be reset via this method: some
1195  * are not targets and therefore have no OCP header registers to
1196  * access; others (like the IVA) have idiosyncratic reset sequences.
1197  * So for these relatively rare cases, custom reset code can be
1198  * supplied in the struct omap_hwmod_class .reset function pointer.
1199  * Passes along the return value from either _reset() or the custom
1200  * reset function - these must return -EINVAL if the hwmod cannot be
1201  * reset this way or if the hwmod is in the wrong state, -ETIMEDOUT if
1202  * the module did not reset in time, or 0 upon success.
1203  */
1204 static int _reset(struct omap_hwmod *oh)
1206         int ret;
1208         pr_debug("omap_hwmod: %s: resetting\n", oh->name);
1210         ret = (oh->class->reset) ? oh->class->reset(oh) : _ocp_softreset(oh);
1212         return ret;
1215 /**
1216  * _enable - enable an omap_hwmod
1217  * @oh: struct omap_hwmod *
1218  *
1219  * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
1220  * register target.  Returns -EINVAL if the hwmod is in the wrong
1221  * state or passes along the return value of _wait_target_ready().
1222  */
1223 static int _enable(struct omap_hwmod *oh)
1225         int r;
1227         if (oh->_state != _HWMOD_STATE_INITIALIZED &&
1228             oh->_state != _HWMOD_STATE_IDLE &&
1229             oh->_state != _HWMOD_STATE_DISABLED) {
1230                 WARN(1, "omap_hwmod: %s: enabled state can only be entered "
1231                      "from initialized, idle, or disabled state\n", oh->name);
1232                 return -EINVAL;
1233         }
1235         pr_debug("omap_hwmod: %s: enabling\n", oh->name);
1237         /*
1238          * If an IP contains only one HW reset line, then de-assert it in order
1239          * to allow to enable the clocks. Otherwise the PRCM will return
1240          * Intransition status, and the init will failed.
1241          */
1242         if ((oh->_state == _HWMOD_STATE_INITIALIZED ||
1243              oh->_state == _HWMOD_STATE_DISABLED) && oh->rst_lines_cnt == 1)
1244                 _deassert_hardreset(oh, oh->rst_lines[0].name);
1246         /* Mux pins for device runtime if populated */
1247         if (oh->mux && (!oh->mux->enabled ||
1248                         ((oh->_state == _HWMOD_STATE_IDLE) &&
1249                          oh->mux->pads_dynamic)))
1250                 omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
1252         _add_initiator_dep(oh, mpu_oh);
1253         _enable_clocks(oh);
1255         r = _wait_target_ready(oh);
1256         if (!r) {
1257                 oh->_state = _HWMOD_STATE_ENABLED;
1259                 /* Access the sysconfig only if the target is ready */
1260                 if (oh->class->sysc) {
1261                         if (!(oh->_int_flags & _HWMOD_SYSCONFIG_LOADED))
1262                                 _update_sysc_cache(oh);
1263                         _enable_sysc(oh);
1264                 }
1265         } else {
1266                 _disable_clocks(oh);
1267                 pr_debug("omap_hwmod: %s: _wait_target_ready: %d\n",
1268                          oh->name, r);
1269         }
1271         return r;
1274 /**
1275  * _idle - idle an omap_hwmod
1276  * @oh: struct omap_hwmod *
1277  *
1278  * Idles an omap_hwmod @oh.  This should be called once the hwmod has
1279  * no further work.  Returns -EINVAL if the hwmod is in the wrong
1280  * state or returns 0.
1281  */
1282 static int _idle(struct omap_hwmod *oh)
1284         if (oh->_state != _HWMOD_STATE_ENABLED) {
1285                 WARN(1, "omap_hwmod: %s: idle state can only be entered from "
1286                      "enabled state\n", oh->name);
1287                 return -EINVAL;
1288         }
1290         pr_debug("omap_hwmod: %s: idling\n", oh->name);
1292         if (oh->class->sysc)
1293                 _idle_sysc(oh);
1294         _del_initiator_dep(oh, mpu_oh);
1295         _disable_clocks(oh);
1297         /* Mux pins for device idle if populated */
1298         if (oh->mux && oh->mux->pads_dynamic)
1299                 omap_hwmod_mux(oh->mux, _HWMOD_STATE_IDLE);
1301         oh->_state = _HWMOD_STATE_IDLE;
1303         return 0;
1306 /**
1307  * omap_hwmod_set_ocp_autoidle - set the hwmod's OCP autoidle bit
1308  * @oh: struct omap_hwmod *
1309  * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
1310  *
1311  * Sets the IP block's OCP autoidle bit in hardware, and updates our
1312  * local copy. Intended to be used by drivers that require
1313  * direct manipulation of the AUTOIDLE bits.
1314  * Returns -EINVAL if @oh is null or is not in the ENABLED state, or passes
1315  * along the return value from _set_module_autoidle().
1316  *
1317  * Any users of this function should be scrutinized carefully.
1318  */
1319 int omap_hwmod_set_ocp_autoidle(struct omap_hwmod *oh, u8 autoidle)
1321         u32 v;
1322         int retval = 0;
1323         unsigned long flags;
1325         if (!oh || oh->_state != _HWMOD_STATE_ENABLED)
1326                 return -EINVAL;
1328         spin_lock_irqsave(&oh->_lock, flags);
1330         v = oh->_sysc_cache;
1332         retval = _set_module_autoidle(oh, autoidle, &v);
1334         if (!retval)
1335                 _write_sysconfig(v, oh);
1337         spin_unlock_irqrestore(&oh->_lock, flags);
1339         return retval;
1342 /**
1343  * _shutdown - shutdown an omap_hwmod
1344  * @oh: struct omap_hwmod *
1345  *
1346  * Shut down an omap_hwmod @oh.  This should be called when the driver
1347  * used for the hwmod is removed or unloaded or if the driver is not
1348  * used by the system.  Returns -EINVAL if the hwmod is in the wrong
1349  * state or returns 0.
1350  */
1351 static int _shutdown(struct omap_hwmod *oh)
1353         int ret;
1354         u8 prev_state;
1356         if (oh->_state != _HWMOD_STATE_IDLE &&
1357             oh->_state != _HWMOD_STATE_ENABLED) {
1358                 WARN(1, "omap_hwmod: %s: disabled state can only be entered "
1359                      "from idle, or enabled state\n", oh->name);
1360                 return -EINVAL;
1361         }
1363         pr_debug("omap_hwmod: %s: disabling\n", oh->name);
1365         if (oh->class->pre_shutdown) {
1366                 prev_state = oh->_state;
1367                 if (oh->_state == _HWMOD_STATE_IDLE)
1368                         _enable(oh);
1369                 ret = oh->class->pre_shutdown(oh);
1370                 if (ret) {
1371                         if (prev_state == _HWMOD_STATE_IDLE)
1372                                 _idle(oh);
1373                         return ret;
1374                 }
1375         }
1377         if (oh->class->sysc)
1378                 _shutdown_sysc(oh);
1380         /*
1381          * If an IP contains only one HW reset line, then assert it
1382          * before disabling the clocks and shutting down the IP.
1383          */
1384         if (oh->rst_lines_cnt == 1)
1385                 _assert_hardreset(oh, oh->rst_lines[0].name);
1387         /* clocks and deps are already disabled in idle */
1388         if (oh->_state == _HWMOD_STATE_ENABLED) {
1389                 _del_initiator_dep(oh, mpu_oh);
1390                 /* XXX what about the other system initiators here? dma, dsp */
1391                 _disable_clocks(oh);
1392         }
1393         /* XXX Should this code also force-disable the optional clocks? */
1395         /* Mux pins to safe mode or use populated off mode values */
1396         if (oh->mux)
1397                 omap_hwmod_mux(oh->mux, _HWMOD_STATE_DISABLED);
1399         oh->_state = _HWMOD_STATE_DISABLED;
1401         return 0;
1404 /**
1405  * _setup - do initial configuration of omap_hwmod
1406  * @oh: struct omap_hwmod *
1407  *
1408  * Writes the CLOCKACTIVITY bits @clockact to the hwmod @oh
1409  * OCP_SYSCONFIG register.  Returns 0.
1410  */
1411 static int _setup(struct omap_hwmod *oh, void *data)
1413         int i, r;
1414         u8 postsetup_state;
1416         if (oh->_state != _HWMOD_STATE_CLKS_INITED)
1417                 return 0;
1419         /* Set iclk autoidle mode */
1420         if (oh->slaves_cnt > 0) {
1421                 for (i = 0; i < oh->slaves_cnt; i++) {
1422                         struct omap_hwmod_ocp_if *os = oh->slaves[i];
1423                         struct clk *c = os->_clk;
1425                         if (!c)
1426                                 continue;
1428                         if (os->flags & OCPIF_SWSUP_IDLE) {
1429                                 /* XXX omap_iclk_deny_idle(c); */
1430                         } else {
1431                                 /* XXX omap_iclk_allow_idle(c); */
1432                                 clk_enable(c);
1433                         }
1434                 }
1435         }
1437         oh->_state = _HWMOD_STATE_INITIALIZED;
1439         /*
1440          * In the case of hwmod with hardreset that should not be
1441          * de-assert at boot time, we have to keep the module
1442          * initialized, because we cannot enable it properly with the
1443          * reset asserted. Exit without warning because that behavior is
1444          * expected.
1445          */
1446         if ((oh->flags & HWMOD_INIT_NO_RESET) && oh->rst_lines_cnt == 1)
1447                 return 0;
1449         r = _enable(oh);
1450         if (r) {
1451                 pr_warning("omap_hwmod: %s: cannot be enabled (%d)\n",
1452                            oh->name, oh->_state);
1453                 return 0;
1454         }
1456         if (!(oh->flags & HWMOD_INIT_NO_RESET)) {
1457                 _reset(oh);
1459                 /*
1460                  * OCP_SYSCONFIG bits need to be reprogrammed after a softreset.
1461                  * The _enable() function should be split to
1462                  * avoid the rewrite of the OCP_SYSCONFIG register.
1463                  */
1464                 if (oh->class->sysc) {
1465                         _update_sysc_cache(oh);
1466                         _enable_sysc(oh);
1467                 }
1468         }
1470         postsetup_state = oh->_postsetup_state;
1471         if (postsetup_state == _HWMOD_STATE_UNKNOWN)
1472                 postsetup_state = _HWMOD_STATE_ENABLED;
1474         /*
1475          * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
1476          * it should be set by the core code as a runtime flag during startup
1477          */
1478         if ((oh->flags & HWMOD_INIT_NO_IDLE) &&
1479             (postsetup_state == _HWMOD_STATE_IDLE))
1480                 postsetup_state = _HWMOD_STATE_ENABLED;
1482         if (postsetup_state == _HWMOD_STATE_IDLE)
1483                 _idle(oh);
1484         else if (postsetup_state == _HWMOD_STATE_DISABLED)
1485                 _shutdown(oh);
1486         else if (postsetup_state != _HWMOD_STATE_ENABLED)
1487                 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
1488                      oh->name, postsetup_state);
1490         return 0;
1493 /**
1494  * _register - register a struct omap_hwmod
1495  * @oh: struct omap_hwmod *
1496  *
1497  * Registers the omap_hwmod @oh.  Returns -EEXIST if an omap_hwmod
1498  * already has been registered by the same name; -EINVAL if the
1499  * omap_hwmod is in the wrong state, if @oh is NULL, if the
1500  * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
1501  * name, or if the omap_hwmod's class is missing a name; or 0 upon
1502  * success.
1503  *
1504  * XXX The data should be copied into bootmem, so the original data
1505  * should be marked __initdata and freed after init.  This would allow
1506  * unneeded omap_hwmods to be freed on multi-OMAP configurations.  Note
1507  * that the copy process would be relatively complex due to the large number
1508  * of substructures.
1509  */
1510 static int __init _register(struct omap_hwmod *oh)
1512         int ms_id;
1514         if (!oh || !oh->name || !oh->class || !oh->class->name ||
1515             (oh->_state != _HWMOD_STATE_UNKNOWN))
1516                 return -EINVAL;
1518         pr_debug("omap_hwmod: %s: registering\n", oh->name);
1520         if (_lookup(oh->name))
1521                 return -EEXIST;
1523         ms_id = _find_mpu_port_index(oh);
1524         if (!IS_ERR_VALUE(ms_id))
1525                 oh->_mpu_port_index = ms_id;
1526         else
1527                 oh->_int_flags |= _HWMOD_NO_MPU_PORT;
1529         list_add_tail(&oh->node, &omap_hwmod_list);
1531         spin_lock_init(&oh->_lock);
1533         oh->_state = _HWMOD_STATE_REGISTERED;
1535         /*
1536          * XXX Rather than doing a strcmp(), this should test a flag
1537          * set in the hwmod data, inserted by the autogenerator code.
1538          */
1539         if (!strcmp(oh->name, MPU_INITIATOR_NAME))
1540                 mpu_oh = oh;
1542         return 0;
1546 /* Public functions */
1548 u32 omap_hwmod_read(struct omap_hwmod *oh, u16 reg_offs)
1550         if (oh->flags & HWMOD_16BIT_REG)
1551                 return __raw_readw(oh->_mpu_rt_va + reg_offs);
1552         else
1553                 return __raw_readl(oh->_mpu_rt_va + reg_offs);
1556 void omap_hwmod_write(u32 v, struct omap_hwmod *oh, u16 reg_offs)
1558         if (oh->flags & HWMOD_16BIT_REG)
1559                 __raw_writew(v, oh->_mpu_rt_va + reg_offs);
1560         else
1561                 __raw_writel(v, oh->_mpu_rt_va + reg_offs);
1564 /**
1565  * omap_hwmod_set_slave_idlemode - set the hwmod's OCP slave idlemode
1566  * @oh: struct omap_hwmod *
1567  * @idlemode: SIDLEMODE field bits (shifted to bit 0)
1568  *
1569  * Sets the IP block's OCP slave idlemode in hardware, and updates our
1570  * local copy.  Intended to be used by drivers that have some erratum
1571  * that requires direct manipulation of the SIDLEMODE bits.  Returns
1572  * -EINVAL if @oh is null, or passes along the return value from
1573  * _set_slave_idlemode().
1574  *
1575  * XXX Does this function have any current users?  If not, we should
1576  * remove it; it is better to let the rest of the hwmod code handle this.
1577  * Any users of this function should be scrutinized carefully.
1578  */
1579 int omap_hwmod_set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode)
1581         u32 v;
1582         int retval = 0;
1584         if (!oh)
1585                 return -EINVAL;
1587         v = oh->_sysc_cache;
1589         retval = _set_slave_idlemode(oh, idlemode, &v);
1590         if (!retval)
1591                 _write_sysconfig(v, oh);
1593         return retval;
1596 /**
1597  * omap_hwmod_lookup - look up a registered omap_hwmod by name
1598  * @name: name of the omap_hwmod to look up
1599  *
1600  * Given a @name of an omap_hwmod, return a pointer to the registered
1601  * struct omap_hwmod *, or NULL upon error.
1602  */
1603 struct omap_hwmod *omap_hwmod_lookup(const char *name)
1605         struct omap_hwmod *oh;
1607         if (!name)
1608                 return NULL;
1610         oh = _lookup(name);
1612         return oh;
1615 /**
1616  * omap_hwmod_for_each - call function for each registered omap_hwmod
1617  * @fn: pointer to a callback function
1618  * @data: void * data to pass to callback function
1619  *
1620  * Call @fn for each registered omap_hwmod, passing @data to each
1621  * function.  @fn must return 0 for success or any other value for
1622  * failure.  If @fn returns non-zero, the iteration across omap_hwmods
1623  * will stop and the non-zero return value will be passed to the
1624  * caller of omap_hwmod_for_each().  @fn is called with
1625  * omap_hwmod_for_each() held.
1626  */
1627 int omap_hwmod_for_each(int (*fn)(struct omap_hwmod *oh, void *data),
1628                         void *data)
1630         struct omap_hwmod *temp_oh;
1631         int ret;
1633         if (!fn)
1634                 return -EINVAL;
1636         list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1637                 ret = (*fn)(temp_oh, data);
1638                 if (ret)
1639                         break;
1640         }
1642         return ret;
1645 /**
1646  * omap_hwmod_register - register an array of hwmods
1647  * @ohs: pointer to an array of omap_hwmods to register
1648  *
1649  * Intended to be called early in boot before the clock framework is
1650  * initialized.  If @ohs is not null, will register all omap_hwmods
1651  * listed in @ohs that are valid for this chip.  Returns 0.
1652  */
1653 int __init omap_hwmod_register(struct omap_hwmod **ohs)
1655         int r, i;
1657         if (!ohs)
1658                 return 0;
1660         i = 0;
1661         do {
1662                 if (!omap_chip_is(ohs[i]->omap_chip))
1663                         continue;
1665                 r = _register(ohs[i]);
1666                 WARN(r, "omap_hwmod: %s: _register returned %d\n", ohs[i]->name,
1667                      r);
1668         } while (ohs[++i]);
1670         return 0;
1673 /*
1674  * _populate_mpu_rt_base - populate the virtual address for a hwmod
1675  *
1676  * Must be called only from omap_hwmod_setup_*() so ioremap works properly.
1677  * Assumes the caller takes care of locking if needed.
1678  */
1679 static int __init _populate_mpu_rt_base(struct omap_hwmod *oh, void *data)
1681         if (oh->_state != _HWMOD_STATE_REGISTERED)
1682                 return 0;
1684         if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
1685                 return 0;
1687         oh->_mpu_rt_va = _find_mpu_rt_base(oh, oh->_mpu_port_index);
1688         if (!oh->_mpu_rt_va)
1689                 pr_warning("omap_hwmod: %s found no _mpu_rt_va for %s\n",
1690                                 __func__, oh->name);
1692         return 0;
1695 /**
1696  * omap_hwmod_setup_one - set up a single hwmod
1697  * @oh_name: const char * name of the already-registered hwmod to set up
1698  *
1699  * Must be called after omap2_clk_init().  Resolves the struct clk
1700  * names to struct clk pointers for each registered omap_hwmod.  Also
1701  * calls _setup() on each hwmod.  Returns -EINVAL upon error or 0 upon
1702  * success.
1703  */
1704 int __init omap_hwmod_setup_one(const char *oh_name)
1706         struct omap_hwmod *oh;
1707         int r;
1709         pr_debug("omap_hwmod: %s: %s\n", oh_name, __func__);
1711         if (!mpu_oh) {
1712                 pr_err("omap_hwmod: %s: cannot setup_one: MPU initiator hwmod %s not yet registered\n",
1713                        oh_name, MPU_INITIATOR_NAME);
1714                 return -EINVAL;
1715         }
1717         oh = _lookup(oh_name);
1718         if (!oh) {
1719                 WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name);
1720                 return -EINVAL;
1721         }
1723         if (mpu_oh->_state == _HWMOD_STATE_REGISTERED && oh != mpu_oh)
1724                 omap_hwmod_setup_one(MPU_INITIATOR_NAME);
1726         r = _populate_mpu_rt_base(oh, NULL);
1727         if (IS_ERR_VALUE(r)) {
1728                 WARN(1, "omap_hwmod: %s: couldn't set mpu_rt_base\n", oh_name);
1729                 return -EINVAL;
1730         }
1732         r = _init_clocks(oh, NULL);
1733         if (IS_ERR_VALUE(r)) {
1734                 WARN(1, "omap_hwmod: %s: couldn't init clocks\n", oh_name);
1735                 return -EINVAL;
1736         }
1738         _setup(oh, NULL);
1740         return 0;
1743 /**
1744  * omap_hwmod_setup - do some post-clock framework initialization
1745  *
1746  * Must be called after omap2_clk_init().  Resolves the struct clk names
1747  * to struct clk pointers for each registered omap_hwmod.  Also calls
1748  * _setup() on each hwmod.  Returns 0 upon success.
1749  */
1750 static int __init omap_hwmod_setup_all(void)
1752         int r;
1754         if (!mpu_oh) {
1755                 pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",
1756                        __func__, MPU_INITIATOR_NAME);
1757                 return -EINVAL;
1758         }
1760         r = omap_hwmod_for_each(_populate_mpu_rt_base, NULL);
1762         r = omap_hwmod_for_each(_init_clocks, NULL);
1763         WARN(IS_ERR_VALUE(r),
1764              "omap_hwmod: %s: _init_clocks failed\n", __func__);
1766         omap_hwmod_for_each(_setup, NULL);
1768         return 0;
1770 core_initcall(omap_hwmod_setup_all);
1772 /**
1773  * omap_hwmod_enable - enable an omap_hwmod
1774  * @oh: struct omap_hwmod *
1775  *
1776  * Enable an omap_hwmod @oh.  Intended to be called by omap_device_enable().
1777  * Returns -EINVAL on error or passes along the return value from _enable().
1778  */
1779 int omap_hwmod_enable(struct omap_hwmod *oh)
1781         int r;
1782         unsigned long flags;
1784         if (!oh)
1785                 return -EINVAL;
1787         spin_lock_irqsave(&oh->_lock, flags);
1788         r = _enable(oh);
1789         spin_unlock_irqrestore(&oh->_lock, flags);
1791         return r;
1794 /**
1795  * omap_hwmod_idle - idle an omap_hwmod
1796  * @oh: struct omap_hwmod *
1797  *
1798  * Idle an omap_hwmod @oh.  Intended to be called by omap_device_idle().
1799  * Returns -EINVAL on error or passes along the return value from _idle().
1800  */
1801 int omap_hwmod_idle(struct omap_hwmod *oh)
1803         unsigned long flags;
1805         if (!oh)
1806                 return -EINVAL;
1808         spin_lock_irqsave(&oh->_lock, flags);
1809         _idle(oh);
1810         spin_unlock_irqrestore(&oh->_lock, flags);
1812         return 0;
1815 /**
1816  * omap_hwmod_shutdown - shutdown an omap_hwmod
1817  * @oh: struct omap_hwmod *
1818  *
1819  * Shutdown an omap_hwmod @oh.  Intended to be called by
1820  * omap_device_shutdown().  Returns -EINVAL on error or passes along
1821  * the return value from _shutdown().
1822  */
1823 int omap_hwmod_shutdown(struct omap_hwmod *oh)
1825         unsigned long flags;
1827         if (!oh)
1828                 return -EINVAL;
1830         spin_lock_irqsave(&oh->_lock, flags);
1831         _shutdown(oh);
1832         spin_unlock_irqrestore(&oh->_lock, flags);
1834         return 0;
1837 /**
1838  * omap_hwmod_enable_clocks - enable main_clk, all interface clocks
1839  * @oh: struct omap_hwmod *oh
1840  *
1841  * Intended to be called by the omap_device code.
1842  */
1843 int omap_hwmod_enable_clocks(struct omap_hwmod *oh)
1845         unsigned long flags;
1847         spin_lock_irqsave(&oh->_lock, flags);
1848         _enable_clocks(oh);
1849         spin_unlock_irqrestore(&oh->_lock, flags);
1851         return 0;
1854 /**
1855  * omap_hwmod_disable_clocks - disable main_clk, all interface clocks
1856  * @oh: struct omap_hwmod *oh
1857  *
1858  * Intended to be called by the omap_device code.
1859  */
1860 int omap_hwmod_disable_clocks(struct omap_hwmod *oh)
1862         unsigned long flags;
1864         spin_lock_irqsave(&oh->_lock, flags);
1865         _disable_clocks(oh);
1866         spin_unlock_irqrestore(&oh->_lock, flags);
1868         return 0;
1871 /**
1872  * omap_hwmod_ocp_barrier - wait for posted writes against the hwmod to complete
1873  * @oh: struct omap_hwmod *oh
1874  *
1875  * Intended to be called by drivers and core code when all posted
1876  * writes to a device must complete before continuing further
1877  * execution (for example, after clearing some device IRQSTATUS
1878  * register bits)
1879  *
1880  * XXX what about targets with multiple OCP threads?
1881  */
1882 void omap_hwmod_ocp_barrier(struct omap_hwmod *oh)
1884         BUG_ON(!oh);
1886         if (!oh->class->sysc || !oh->class->sysc->sysc_flags) {
1887                 WARN(1, "omap_device: %s: OCP barrier impossible due to "
1888                       "device configuration\n", oh->name);
1889                 return;
1890         }
1892         /*
1893          * Forces posted writes to complete on the OCP thread handling
1894          * register writes
1895          */
1896         omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
1899 /**
1900  * omap_hwmod_reset - reset the hwmod
1901  * @oh: struct omap_hwmod *
1902  *
1903  * Under some conditions, a driver may wish to reset the entire device.
1904  * Called from omap_device code.  Returns -EINVAL on error or passes along
1905  * the return value from _reset().
1906  */
1907 int omap_hwmod_reset(struct omap_hwmod *oh)
1909         int r;
1910         unsigned long flags;
1912         if (!oh)
1913                 return -EINVAL;
1915         spin_lock_irqsave(&oh->_lock, flags);
1916         r = _reset(oh);
1917         spin_unlock_irqrestore(&oh->_lock, flags);
1919         return r;
1922 /**
1923  * omap_hwmod_count_resources - count number of struct resources needed by hwmod
1924  * @oh: struct omap_hwmod *
1925  * @res: pointer to the first element of an array of struct resource to fill
1926  *
1927  * Count the number of struct resource array elements necessary to
1928  * contain omap_hwmod @oh resources.  Intended to be called by code
1929  * that registers omap_devices.  Intended to be used to determine the
1930  * size of a dynamically-allocated struct resource array, before
1931  * calling omap_hwmod_fill_resources().  Returns the number of struct
1932  * resource array elements needed.
1933  *
1934  * XXX This code is not optimized.  It could attempt to merge adjacent
1935  * resource IDs.
1936  *
1937  */
1938 int omap_hwmod_count_resources(struct omap_hwmod *oh)
1940         int ret, i;
1942         ret = oh->mpu_irqs_cnt + oh->sdma_reqs_cnt;
1944         for (i = 0; i < oh->slaves_cnt; i++)
1945                 ret += oh->slaves[i]->addr_cnt;
1947         return ret;
1950 /**
1951  * omap_hwmod_fill_resources - fill struct resource array with hwmod data
1952  * @oh: struct omap_hwmod *
1953  * @res: pointer to the first element of an array of struct resource to fill
1954  *
1955  * Fill the struct resource array @res with resource data from the
1956  * omap_hwmod @oh.  Intended to be called by code that registers
1957  * omap_devices.  See also omap_hwmod_count_resources().  Returns the
1958  * number of array elements filled.
1959  */
1960 int omap_hwmod_fill_resources(struct omap_hwmod *oh, struct resource *res)
1962         int i, j;
1963         int r = 0;
1965         /* For each IRQ, DMA, memory area, fill in array.*/
1967         for (i = 0; i < oh->mpu_irqs_cnt; i++) {
1968                 (res + r)->name = (oh->mpu_irqs + i)->name;
1969                 (res + r)->start = (oh->mpu_irqs + i)->irq;
1970                 (res + r)->end = (oh->mpu_irqs + i)->irq;
1971                 (res + r)->flags = IORESOURCE_IRQ;
1972                 r++;
1973         }
1975         for (i = 0; i < oh->sdma_reqs_cnt; i++) {
1976                 (res + r)->name = (oh->sdma_reqs + i)->name;
1977                 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
1978                 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
1979                 (res + r)->flags = IORESOURCE_DMA;
1980                 r++;
1981         }
1983         for (i = 0; i < oh->slaves_cnt; i++) {
1984                 struct omap_hwmod_ocp_if *os;
1986                 os = oh->slaves[i];
1988                 for (j = 0; j < os->addr_cnt; j++) {
1989                         (res + r)->name = (os->addr + j)->name;
1990                         (res + r)->start = (os->addr + j)->pa_start;
1991                         (res + r)->end = (os->addr + j)->pa_end;
1992                         (res + r)->flags = IORESOURCE_MEM;
1993                         r++;
1994                 }
1995         }
1997         return r;
2000 /**
2001  * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
2002  * @oh: struct omap_hwmod *
2003  *
2004  * Return the powerdomain pointer associated with the OMAP module
2005  * @oh's main clock.  If @oh does not have a main clk, return the
2006  * powerdomain associated with the interface clock associated with the
2007  * module's MPU port. (XXX Perhaps this should use the SDMA port
2008  * instead?)  Returns NULL on error, or a struct powerdomain * on
2009  * success.
2010  */
2011 struct powerdomain *omap_hwmod_get_pwrdm(struct omap_hwmod *oh)
2013         struct clk *c;
2015         if (!oh)
2016                 return NULL;
2018         if (oh->_clk) {
2019                 c = oh->_clk;
2020         } else {
2021                 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2022                         return NULL;
2023                 c = oh->slaves[oh->_mpu_port_index]->_clk;
2024         }
2026         if (!c->clkdm)
2027                 return NULL;
2029         return c->clkdm->pwrdm.ptr;
2033 /**
2034  * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
2035  * @oh: struct omap_hwmod *
2036  *
2037  * Returns the virtual address corresponding to the beginning of the
2038  * module's register target, in the address range that is intended to
2039  * be used by the MPU.  Returns the virtual address upon success or NULL
2040  * upon error.
2041  */
2042 void __iomem *omap_hwmod_get_mpu_rt_va(struct omap_hwmod *oh)
2044         if (!oh)
2045                 return NULL;
2047         if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2048                 return NULL;
2050         if (oh->_state == _HWMOD_STATE_UNKNOWN)
2051                 return NULL;
2053         return oh->_mpu_rt_va;
2056 /**
2057  * omap_hwmod_add_initiator_dep - add sleepdep from @init_oh to @oh
2058  * @oh: struct omap_hwmod *
2059  * @init_oh: struct omap_hwmod * (initiator)
2060  *
2061  * Add a sleep dependency between the initiator @init_oh and @oh.
2062  * Intended to be called by DSP/Bridge code via platform_data for the
2063  * DSP case; and by the DMA code in the sDMA case.  DMA code, *Bridge
2064  * code needs to add/del initiator dependencies dynamically
2065  * before/after accessing a device.  Returns the return value from
2066  * _add_initiator_dep().
2067  *
2068  * XXX Keep a usecount in the clockdomain code
2069  */
2070 int omap_hwmod_add_initiator_dep(struct omap_hwmod *oh,
2071                                  struct omap_hwmod *init_oh)
2073         return _add_initiator_dep(oh, init_oh);
2076 /*
2077  * XXX what about functions for drivers to save/restore ocp_sysconfig
2078  * for context save/restore operations?
2079  */
2081 /**
2082  * omap_hwmod_del_initiator_dep - remove sleepdep from @init_oh to @oh
2083  * @oh: struct omap_hwmod *
2084  * @init_oh: struct omap_hwmod * (initiator)
2085  *
2086  * Remove a sleep dependency between the initiator @init_oh and @oh.
2087  * Intended to be called by DSP/Bridge code via platform_data for the
2088  * DSP case; and by the DMA code in the sDMA case.  DMA code, *Bridge
2089  * code needs to add/del initiator dependencies dynamically
2090  * before/after accessing a device.  Returns the return value from
2091  * _del_initiator_dep().
2092  *
2093  * XXX Keep a usecount in the clockdomain code
2094  */
2095 int omap_hwmod_del_initiator_dep(struct omap_hwmod *oh,
2096                                  struct omap_hwmod *init_oh)
2098         return _del_initiator_dep(oh, init_oh);
2101 /**
2102  * omap_hwmod_enable_wakeup - allow device to wake up the system
2103  * @oh: struct omap_hwmod *
2104  *
2105  * Sets the module OCP socket ENAWAKEUP bit to allow the module to
2106  * send wakeups to the PRCM.  Eventually this should sets PRCM wakeup
2107  * registers to cause the PRCM to receive wakeup events from the
2108  * module.  Does not set any wakeup routing registers beyond this
2109  * point - if the module is to wake up any other module or subsystem,
2110  * that must be set separately.  Called by omap_device code.  Returns
2111  * -EINVAL on error or 0 upon success.
2112  */
2113 int omap_hwmod_enable_wakeup(struct omap_hwmod *oh)
2115         unsigned long flags;
2116         u32 v;
2118         if (!oh->class->sysc ||
2119             !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
2120                 return -EINVAL;
2122         spin_lock_irqsave(&oh->_lock, flags);
2123         v = oh->_sysc_cache;
2124         _enable_wakeup(oh, &v);
2125         _write_sysconfig(v, oh);
2126         spin_unlock_irqrestore(&oh->_lock, flags);
2128         return 0;
2131 /**
2132  * omap_hwmod_disable_wakeup - prevent device from waking the system
2133  * @oh: struct omap_hwmod *
2134  *
2135  * Clears the module OCP socket ENAWAKEUP bit to prevent the module
2136  * from sending wakeups to the PRCM.  Eventually this should clear
2137  * PRCM wakeup registers to cause the PRCM to ignore wakeup events
2138  * from the module.  Does not set any wakeup routing registers beyond
2139  * this point - if the module is to wake up any other module or
2140  * subsystem, that must be set separately.  Called by omap_device
2141  * code.  Returns -EINVAL on error or 0 upon success.
2142  */
2143 int omap_hwmod_disable_wakeup(struct omap_hwmod *oh)
2145         unsigned long flags;
2146         u32 v;
2148         if (!oh->class->sysc ||
2149             !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
2150                 return -EINVAL;
2152         spin_lock_irqsave(&oh->_lock, flags);
2153         v = oh->_sysc_cache;
2154         _disable_wakeup(oh, &v);
2155         _write_sysconfig(v, oh);
2156         spin_unlock_irqrestore(&oh->_lock, flags);
2158         return 0;
2161 /**
2162  * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
2163  * contained in the hwmod module.
2164  * @oh: struct omap_hwmod *
2165  * @name: name of the reset line to lookup and assert
2166  *
2167  * Some IP like dsp, ipu or iva contain processor that require
2168  * an HW reset line to be assert / deassert in order to enable fully
2169  * the IP.  Returns -EINVAL if @oh is null or if the operation is not
2170  * yet supported on this OMAP; otherwise, passes along the return value
2171  * from _assert_hardreset().
2172  */
2173 int omap_hwmod_assert_hardreset(struct omap_hwmod *oh, const char *name)
2175         int ret;
2176         unsigned long flags;
2178         if (!oh)
2179                 return -EINVAL;
2181         spin_lock_irqsave(&oh->_lock, flags);
2182         ret = _assert_hardreset(oh, name);
2183         spin_unlock_irqrestore(&oh->_lock, flags);
2185         return ret;
2188 /**
2189  * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
2190  * contained in the hwmod module.
2191  * @oh: struct omap_hwmod *
2192  * @name: name of the reset line to look up and deassert
2193  *
2194  * Some IP like dsp, ipu or iva contain processor that require
2195  * an HW reset line to be assert / deassert in order to enable fully
2196  * the IP.  Returns -EINVAL if @oh is null or if the operation is not
2197  * yet supported on this OMAP; otherwise, passes along the return value
2198  * from _deassert_hardreset().
2199  */
2200 int omap_hwmod_deassert_hardreset(struct omap_hwmod *oh, const char *name)
2202         int ret;
2203         unsigned long flags;
2205         if (!oh)
2206                 return -EINVAL;
2208         spin_lock_irqsave(&oh->_lock, flags);
2209         ret = _deassert_hardreset(oh, name);
2210         spin_unlock_irqrestore(&oh->_lock, flags);
2212         return ret;
2215 /**
2216  * omap_hwmod_read_hardreset - read the HW reset line state of submodules
2217  * contained in the hwmod module
2218  * @oh: struct omap_hwmod *
2219  * @name: name of the reset line to look up and read
2220  *
2221  * Return the current state of the hwmod @oh's reset line named @name:
2222  * returns -EINVAL upon parameter error or if this operation
2223  * is unsupported on the current OMAP; otherwise, passes along the return
2224  * value from _read_hardreset().
2225  */
2226 int omap_hwmod_read_hardreset(struct omap_hwmod *oh, const char *name)
2228         int ret;
2229         unsigned long flags;
2231         if (!oh)
2232                 return -EINVAL;
2234         spin_lock_irqsave(&oh->_lock, flags);
2235         ret = _read_hardreset(oh, name);
2236         spin_unlock_irqrestore(&oh->_lock, flags);
2238         return ret;
2242 /**
2243  * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
2244  * @classname: struct omap_hwmod_class name to search for
2245  * @fn: callback function pointer to call for each hwmod in class @classname
2246  * @user: arbitrary context data to pass to the callback function
2247  *
2248  * For each omap_hwmod of class @classname, call @fn.
2249  * If the callback function returns something other than
2250  * zero, the iterator is terminated, and the callback function's return
2251  * value is passed back to the caller.  Returns 0 upon success, -EINVAL
2252  * if @classname or @fn are NULL, or passes back the error code from @fn.
2253  */
2254 int omap_hwmod_for_each_by_class(const char *classname,
2255                                  int (*fn)(struct omap_hwmod *oh,
2256                                            void *user),
2257                                  void *user)
2259         struct omap_hwmod *temp_oh;
2260         int ret = 0;
2262         if (!classname || !fn)
2263                 return -EINVAL;
2265         pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
2266                  __func__, classname);
2268         list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
2269                 if (!strcmp(temp_oh->class->name, classname)) {
2270                         pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
2271                                  __func__, temp_oh->name);
2272                         ret = (*fn)(temp_oh, user);
2273                         if (ret)
2274                                 break;
2275                 }
2276         }
2278         if (ret)
2279                 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
2280                          __func__, ret);
2282         return ret;
2285 /**
2286  * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
2287  * @oh: struct omap_hwmod *
2288  * @state: state that _setup() should leave the hwmod in
2289  *
2290  * Sets the hwmod state that @oh will enter at the end of _setup()
2291  * (called by omap_hwmod_setup_*()).  Only valid to call between
2292  * calling omap_hwmod_register() and omap_hwmod_setup_*().  Returns
2293  * 0 upon success or -EINVAL if there is a problem with the arguments
2294  * or if the hwmod is in the wrong state.
2295  */
2296 int omap_hwmod_set_postsetup_state(struct omap_hwmod *oh, u8 state)
2298         int ret;
2299         unsigned long flags;
2301         if (!oh)
2302                 return -EINVAL;
2304         if (state != _HWMOD_STATE_DISABLED &&
2305             state != _HWMOD_STATE_ENABLED &&
2306             state != _HWMOD_STATE_IDLE)
2307                 return -EINVAL;
2309         spin_lock_irqsave(&oh->_lock, flags);
2311         if (oh->_state != _HWMOD_STATE_REGISTERED) {
2312                 ret = -EINVAL;
2313                 goto ohsps_unlock;
2314         }
2316         oh->_postsetup_state = state;
2317         ret = 0;
2319 ohsps_unlock:
2320         spin_unlock_irqrestore(&oh->_lock, flags);
2322         return ret;
2325 /**
2326  * omap_hwmod_get_context_loss_count - get lost context count
2327  * @oh: struct omap_hwmod *
2328  *
2329  * Query the powerdomain of of @oh to get the context loss
2330  * count for this device.
2331  *
2332  * Returns the context loss count of the powerdomain assocated with @oh
2333  * upon success, or zero if no powerdomain exists for @oh.
2334  */
2335 u32 omap_hwmod_get_context_loss_count(struct omap_hwmod *oh)
2337         struct powerdomain *pwrdm;
2338         int ret = 0;
2340         pwrdm = omap_hwmod_get_pwrdm(oh);
2341         if (pwrdm)
2342                 ret = pwrdm_get_context_loss_count(pwrdm);
2344         return ret;
2347 /**
2348  * omap_hwmod_no_setup_reset - prevent a hwmod from being reset upon setup
2349  * @oh: struct omap_hwmod *
2350  *
2351  * Prevent the hwmod @oh from being reset during the setup process.
2352  * Intended for use by board-*.c files on boards with devices that
2353  * cannot tolerate being reset.  Must be called before the hwmod has
2354  * been set up.  Returns 0 upon success or negative error code upon
2355  * failure.
2356  */
2357 int omap_hwmod_no_setup_reset(struct omap_hwmod *oh)
2359         if (!oh)
2360                 return -EINVAL;
2362         if (oh->_state != _HWMOD_STATE_REGISTERED) {
2363                 pr_err("omap_hwmod: %s: cannot prevent setup reset; in wrong state\n",
2364                         oh->name);
2365                 return -EINVAL;
2366         }
2368         oh->flags |= HWMOD_INIT_NO_RESET;
2370         return 0;