Loading...
1/*
2 * omap_hwmod implementation for OMAP2/3/4
3 *
4 * Copyright (C) 2009-2011 Nokia Corporation
5 * Copyright (C) 2011 Texas Instruments, Inc.
6 *
7 * Paul Walmsley, Benoît Cousson, Kevin Hilman
8 *
9 * Created in collaboration with (alphabetical order): Thara Gopinath,
10 * Tony Lindgren, Rajendra Nayak, Vikram Pandita, Sakari Poussa, Anand
11 * Sawant, Santosh Shilimkar, Richard Woodruff
12 *
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License version 2 as
15 * published by the Free Software Foundation.
16 *
17 * Introduction
18 * ------------
19 * One way to view an OMAP SoC is as a collection of largely unrelated
20 * IP blocks connected by interconnects. The IP blocks include
21 * devices such as ARM processors, audio serial interfaces, UARTs,
22 * etc. Some of these devices, like the DSP, are created by TI;
23 * others, like the SGX, largely originate from external vendors. In
24 * TI's documentation, on-chip devices are referred to as "OMAP
25 * modules." Some of these IP blocks are identical across several
26 * OMAP versions. Others are revised frequently.
27 *
28 * These OMAP modules are tied together by various interconnects.
29 * Most of the address and data flow between modules is via OCP-based
30 * interconnects such as the L3 and L4 buses; but there are other
31 * interconnects that distribute the hardware clock tree, handle idle
32 * and reset signaling, supply power, and connect the modules to
33 * various pads or balls on the OMAP package.
34 *
35 * OMAP hwmod provides a consistent way to describe the on-chip
36 * hardware blocks and their integration into the rest of the chip.
37 * This description can be automatically generated from the TI
38 * hardware database. OMAP hwmod provides a standard, consistent API
39 * to reset, enable, idle, and disable these hardware blocks. And
40 * hwmod provides a way for other core code, such as the Linux device
41 * code or the OMAP power management and address space mapping code,
42 * to query the hardware database.
43 *
44 * Using hwmod
45 * -----------
46 * Drivers won't call hwmod functions directly. That is done by the
47 * omap_device code, and in rare occasions, by custom integration code
48 * in arch/arm/ *omap*. The omap_device code includes functions to
49 * build a struct platform_device using omap_hwmod data, and that is
50 * currently how hwmod data is communicated to drivers and to the
51 * Linux driver model. Most drivers will call omap_hwmod functions only
52 * indirectly, via pm_runtime*() functions.
53 *
54 * From a layering perspective, here is where the OMAP hwmod code
55 * fits into the kernel software stack:
56 *
57 * +-------------------------------+
58 * | Device driver code |
59 * | (e.g., drivers/) |
60 * +-------------------------------+
61 * | Linux driver model |
62 * | (platform_device / |
63 * | platform_driver data/code) |
64 * +-------------------------------+
65 * | OMAP core-driver integration |
66 * |(arch/arm/mach-omap2/devices.c)|
67 * +-------------------------------+
68 * | omap_device code |
69 * | (../plat-omap/omap_device.c) |
70 * +-------------------------------+
71 * ----> | omap_hwmod code/data | <-----
72 * | (../mach-omap2/omap_hwmod*) |
73 * +-------------------------------+
74 * | OMAP clock/PRCM/register fns |
75 * | (__raw_{read,write}l, clk*) |
76 * +-------------------------------+
77 *
78 * Device drivers should not contain any OMAP-specific code or data in
79 * them. They should only contain code to operate the IP block that
80 * the driver is responsible for. This is because these IP blocks can
81 * also appear in other SoCs, either from TI (such as DaVinci) or from
82 * other manufacturers; and drivers should be reusable across other
83 * platforms.
84 *
85 * The OMAP hwmod code also will attempt to reset and idle all on-chip
86 * devices upon boot. The goal here is for the kernel to be
87 * completely self-reliant and independent from bootloaders. This is
88 * to ensure a repeatable configuration, both to ensure consistent
89 * runtime behavior, and to make it easier for others to reproduce
90 * bugs.
91 *
92 * OMAP module activity states
93 * ---------------------------
94 * The hwmod code considers modules to be in one of several activity
95 * states. IP blocks start out in an UNKNOWN state, then once they
96 * are registered via the hwmod code, proceed to the REGISTERED state.
97 * Once their clock names are resolved to clock pointers, the module
98 * enters the CLKS_INITED state; and finally, once the module has been
99 * reset and the integration registers programmed, the INITIALIZED state
100 * is entered. The hwmod code will then place the module into either
101 * the IDLE state to save power, or in the case of a critical system
102 * module, the ENABLED state.
103 *
104 * OMAP core integration code can then call omap_hwmod*() functions
105 * directly to move the module between the IDLE, ENABLED, and DISABLED
106 * states, as needed. This is done during both the PM idle loop, and
107 * in the OMAP core integration code's implementation of the PM runtime
108 * functions.
109 *
110 * References
111 * ----------
112 * This is a partial list.
113 * - OMAP2420 Multimedia Processor Silicon Revision 2.1.1, 2.2 (SWPU064)
114 * - OMAP2430 Multimedia Device POP Silicon Revision 2.1 (SWPU090)
115 * - OMAP34xx Multimedia Device Silicon Revision 3.1 (SWPU108)
116 * - OMAP4430 Multimedia Device Silicon Revision 1.0 (SWPU140)
117 * - Open Core Protocol Specification 2.2
118 *
119 * To do:
120 * - handle IO mapping
121 * - bus throughput & module latency measurement code
122 *
123 * XXX add tests at the beginning of each function to ensure the hwmod is
124 * in the appropriate state
125 * XXX error return values should be checked to ensure that they are
126 * appropriate
127 */
128#undef DEBUG
129
130#include <linux/kernel.h>
131#include <linux/errno.h>
132#include <linux/io.h>
133#include <linux/clk.h>
134#include <linux/delay.h>
135#include <linux/err.h>
136#include <linux/list.h>
137#include <linux/mutex.h>
138#include <linux/spinlock.h>
139
140#include <plat/common.h>
141#include <plat/cpu.h>
142#include "clockdomain.h"
143#include "powerdomain.h"
144#include <plat/clock.h>
145#include <plat/omap_hwmod.h>
146#include <plat/prcm.h>
147
148#include "cm2xxx_3xxx.h"
149#include "cminst44xx.h"
150#include "prm2xxx_3xxx.h"
151#include "prm44xx.h"
152#include "prminst44xx.h"
153#include "mux.h"
154
155/* Maximum microseconds to wait for OMAP module to softreset */
156#define MAX_MODULE_SOFTRESET_WAIT 10000
157
158/* Name of the OMAP hwmod for the MPU */
159#define MPU_INITIATOR_NAME "mpu"
160
161/* omap_hwmod_list contains all registered struct omap_hwmods */
162static LIST_HEAD(omap_hwmod_list);
163
164/* mpu_oh: used to add/remove MPU initiator from sleepdep list */
165static struct omap_hwmod *mpu_oh;
166
167
168/* Private functions */
169
170/**
171 * _update_sysc_cache - return the module OCP_SYSCONFIG register, keep copy
172 * @oh: struct omap_hwmod *
173 *
174 * Load the current value of the hwmod OCP_SYSCONFIG register into the
175 * struct omap_hwmod for later use. Returns -EINVAL if the hwmod has no
176 * OCP_SYSCONFIG register or 0 upon success.
177 */
178static int _update_sysc_cache(struct omap_hwmod *oh)
179{
180 if (!oh->class->sysc) {
181 WARN(1, "omap_hwmod: %s: cannot read OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
182 return -EINVAL;
183 }
184
185 /* XXX ensure module interface clock is up */
186
187 oh->_sysc_cache = omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
188
189 if (!(oh->class->sysc->sysc_flags & SYSC_NO_CACHE))
190 oh->_int_flags |= _HWMOD_SYSCONFIG_LOADED;
191
192 return 0;
193}
194
195/**
196 * _write_sysconfig - write a value to the module's OCP_SYSCONFIG register
197 * @v: OCP_SYSCONFIG value to write
198 * @oh: struct omap_hwmod *
199 *
200 * Write @v into the module class' OCP_SYSCONFIG register, if it has
201 * one. No return value.
202 */
203static void _write_sysconfig(u32 v, struct omap_hwmod *oh)
204{
205 if (!oh->class->sysc) {
206 WARN(1, "omap_hwmod: %s: cannot write OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
207 return;
208 }
209
210 /* XXX ensure module interface clock is up */
211
212 /* Module might have lost context, always update cache and register */
213 oh->_sysc_cache = v;
214 omap_hwmod_write(v, oh, oh->class->sysc->sysc_offs);
215}
216
217/**
218 * _set_master_standbymode: set the OCP_SYSCONFIG MIDLEMODE field in @v
219 * @oh: struct omap_hwmod *
220 * @standbymode: MIDLEMODE field bits
221 * @v: pointer to register contents to modify
222 *
223 * Update the master standby mode bits in @v to be @standbymode for
224 * the @oh hwmod. Does not write to the hardware. Returns -EINVAL
225 * upon error or 0 upon success.
226 */
227static int _set_master_standbymode(struct omap_hwmod *oh, u8 standbymode,
228 u32 *v)
229{
230 u32 mstandby_mask;
231 u8 mstandby_shift;
232
233 if (!oh->class->sysc ||
234 !(oh->class->sysc->sysc_flags & SYSC_HAS_MIDLEMODE))
235 return -EINVAL;
236
237 if (!oh->class->sysc->sysc_fields) {
238 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
239 return -EINVAL;
240 }
241
242 mstandby_shift = oh->class->sysc->sysc_fields->midle_shift;
243 mstandby_mask = (0x3 << mstandby_shift);
244
245 *v &= ~mstandby_mask;
246 *v |= __ffs(standbymode) << mstandby_shift;
247
248 return 0;
249}
250
251/**
252 * _set_slave_idlemode: set the OCP_SYSCONFIG SIDLEMODE field in @v
253 * @oh: struct omap_hwmod *
254 * @idlemode: SIDLEMODE field bits
255 * @v: pointer to register contents to modify
256 *
257 * Update the slave idle mode bits in @v to be @idlemode for the @oh
258 * hwmod. Does not write to the hardware. Returns -EINVAL upon error
259 * or 0 upon success.
260 */
261static int _set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode, u32 *v)
262{
263 u32 sidle_mask;
264 u8 sidle_shift;
265
266 if (!oh->class->sysc ||
267 !(oh->class->sysc->sysc_flags & SYSC_HAS_SIDLEMODE))
268 return -EINVAL;
269
270 if (!oh->class->sysc->sysc_fields) {
271 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
272 return -EINVAL;
273 }
274
275 sidle_shift = oh->class->sysc->sysc_fields->sidle_shift;
276 sidle_mask = (0x3 << sidle_shift);
277
278 *v &= ~sidle_mask;
279 *v |= __ffs(idlemode) << sidle_shift;
280
281 return 0;
282}
283
284/**
285 * _set_clockactivity: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
286 * @oh: struct omap_hwmod *
287 * @clockact: CLOCKACTIVITY field bits
288 * @v: pointer to register contents to modify
289 *
290 * Update the clockactivity mode bits in @v to be @clockact for the
291 * @oh hwmod. Used for additional powersaving on some modules. Does
292 * not write to the hardware. Returns -EINVAL upon error or 0 upon
293 * success.
294 */
295static int _set_clockactivity(struct omap_hwmod *oh, u8 clockact, u32 *v)
296{
297 u32 clkact_mask;
298 u8 clkact_shift;
299
300 if (!oh->class->sysc ||
301 !(oh->class->sysc->sysc_flags & SYSC_HAS_CLOCKACTIVITY))
302 return -EINVAL;
303
304 if (!oh->class->sysc->sysc_fields) {
305 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
306 return -EINVAL;
307 }
308
309 clkact_shift = oh->class->sysc->sysc_fields->clkact_shift;
310 clkact_mask = (0x3 << clkact_shift);
311
312 *v &= ~clkact_mask;
313 *v |= clockact << clkact_shift;
314
315 return 0;
316}
317
318/**
319 * _set_softreset: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
320 * @oh: struct omap_hwmod *
321 * @v: pointer to register contents to modify
322 *
323 * Set the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
324 * error or 0 upon success.
325 */
326static int _set_softreset(struct omap_hwmod *oh, u32 *v)
327{
328 u32 softrst_mask;
329
330 if (!oh->class->sysc ||
331 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
332 return -EINVAL;
333
334 if (!oh->class->sysc->sysc_fields) {
335 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
336 return -EINVAL;
337 }
338
339 softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
340
341 *v |= softrst_mask;
342
343 return 0;
344}
345
346/**
347 * _set_module_autoidle: set the OCP_SYSCONFIG AUTOIDLE field in @v
348 * @oh: struct omap_hwmod *
349 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
350 * @v: pointer to register contents to modify
351 *
352 * Update the module autoidle bit in @v to be @autoidle for the @oh
353 * hwmod. The autoidle bit controls whether the module can gate
354 * internal clocks automatically when it isn't doing anything; the
355 * exact function of this bit varies on a per-module basis. This
356 * function does not write to the hardware. Returns -EINVAL upon
357 * error or 0 upon success.
358 */
359static int _set_module_autoidle(struct omap_hwmod *oh, u8 autoidle,
360 u32 *v)
361{
362 u32 autoidle_mask;
363 u8 autoidle_shift;
364
365 if (!oh->class->sysc ||
366 !(oh->class->sysc->sysc_flags & SYSC_HAS_AUTOIDLE))
367 return -EINVAL;
368
369 if (!oh->class->sysc->sysc_fields) {
370 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
371 return -EINVAL;
372 }
373
374 autoidle_shift = oh->class->sysc->sysc_fields->autoidle_shift;
375 autoidle_mask = (0x1 << autoidle_shift);
376
377 *v &= ~autoidle_mask;
378 *v |= autoidle << autoidle_shift;
379
380 return 0;
381}
382
383/**
384 * _enable_wakeup: set OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
385 * @oh: struct omap_hwmod *
386 *
387 * Allow the hardware module @oh to send wakeups. Returns -EINVAL
388 * upon error or 0 upon success.
389 */
390static int _enable_wakeup(struct omap_hwmod *oh, u32 *v)
391{
392 if (!oh->class->sysc ||
393 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
394 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
395 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
396 return -EINVAL;
397
398 if (!oh->class->sysc->sysc_fields) {
399 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
400 return -EINVAL;
401 }
402
403 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
404 *v |= 0x1 << oh->class->sysc->sysc_fields->enwkup_shift;
405
406 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
407 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
408 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
409 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
410
411 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
412
413 oh->_int_flags |= _HWMOD_WAKEUP_ENABLED;
414
415 return 0;
416}
417
418/**
419 * _disable_wakeup: clear OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
420 * @oh: struct omap_hwmod *
421 *
422 * Prevent the hardware module @oh to send wakeups. Returns -EINVAL
423 * upon error or 0 upon success.
424 */
425static int _disable_wakeup(struct omap_hwmod *oh, u32 *v)
426{
427 if (!oh->class->sysc ||
428 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
429 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
430 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
431 return -EINVAL;
432
433 if (!oh->class->sysc->sysc_fields) {
434 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
435 return -EINVAL;
436 }
437
438 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
439 *v &= ~(0x1 << oh->class->sysc->sysc_fields->enwkup_shift);
440
441 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
442 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART, v);
443 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
444 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
445
446 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
447
448 oh->_int_flags &= ~_HWMOD_WAKEUP_ENABLED;
449
450 return 0;
451}
452
453/**
454 * _add_initiator_dep: prevent @oh from smart-idling while @init_oh is active
455 * @oh: struct omap_hwmod *
456 *
457 * Prevent the hardware module @oh from entering idle while the
458 * hardare module initiator @init_oh is active. Useful when a module
459 * will be accessed by a particular initiator (e.g., if a module will
460 * be accessed by the IVA, there should be a sleepdep between the IVA
461 * initiator and the module). Only applies to modules in smart-idle
462 * mode. If the clockdomain is marked as not needing autodeps, return
463 * 0 without doing anything. Otherwise, returns -EINVAL upon error or
464 * passes along clkdm_add_sleepdep() value upon success.
465 */
466static int _add_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
467{
468 if (!oh->_clk)
469 return -EINVAL;
470
471 if (oh->_clk->clkdm && oh->_clk->clkdm->flags & CLKDM_NO_AUTODEPS)
472 return 0;
473
474 return clkdm_add_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
475}
476
477/**
478 * _del_initiator_dep: allow @oh to smart-idle even if @init_oh is active
479 * @oh: struct omap_hwmod *
480 *
481 * Allow the hardware module @oh to enter idle while the hardare
482 * module initiator @init_oh is active. Useful when a module will not
483 * be accessed by a particular initiator (e.g., if a module will not
484 * be accessed by the IVA, there should be no sleepdep between the IVA
485 * initiator and the module). Only applies to modules in smart-idle
486 * mode. If the clockdomain is marked as not needing autodeps, return
487 * 0 without doing anything. Returns -EINVAL upon error or passes
488 * along clkdm_del_sleepdep() value upon success.
489 */
490static int _del_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
491{
492 if (!oh->_clk)
493 return -EINVAL;
494
495 if (oh->_clk->clkdm && oh->_clk->clkdm->flags & CLKDM_NO_AUTODEPS)
496 return 0;
497
498 return clkdm_del_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
499}
500
501/**
502 * _init_main_clk - get a struct clk * for the the hwmod's main functional clk
503 * @oh: struct omap_hwmod *
504 *
505 * Called from _init_clocks(). Populates the @oh _clk (main
506 * functional clock pointer) if a main_clk is present. Returns 0 on
507 * success or -EINVAL on error.
508 */
509static int _init_main_clk(struct omap_hwmod *oh)
510{
511 int ret = 0;
512
513 if (!oh->main_clk)
514 return 0;
515
516 oh->_clk = omap_clk_get_by_name(oh->main_clk);
517 if (!oh->_clk) {
518 pr_warning("omap_hwmod: %s: cannot clk_get main_clk %s\n",
519 oh->name, oh->main_clk);
520 return -EINVAL;
521 }
522
523 if (!oh->_clk->clkdm)
524 pr_warning("omap_hwmod: %s: missing clockdomain for %s.\n",
525 oh->main_clk, oh->_clk->name);
526
527 return ret;
528}
529
530/**
531 * _init_interface_clks - get a struct clk * for the the hwmod's interface clks
532 * @oh: struct omap_hwmod *
533 *
534 * Called from _init_clocks(). Populates the @oh OCP slave interface
535 * clock pointers. Returns 0 on success or -EINVAL on error.
536 */
537static int _init_interface_clks(struct omap_hwmod *oh)
538{
539 struct clk *c;
540 int i;
541 int ret = 0;
542
543 if (oh->slaves_cnt == 0)
544 return 0;
545
546 for (i = 0; i < oh->slaves_cnt; i++) {
547 struct omap_hwmod_ocp_if *os = oh->slaves[i];
548
549 if (!os->clk)
550 continue;
551
552 c = omap_clk_get_by_name(os->clk);
553 if (!c) {
554 pr_warning("omap_hwmod: %s: cannot clk_get interface_clk %s\n",
555 oh->name, os->clk);
556 ret = -EINVAL;
557 }
558 os->_clk = c;
559 }
560
561 return ret;
562}
563
564/**
565 * _init_opt_clk - get a struct clk * for the the hwmod's optional clocks
566 * @oh: struct omap_hwmod *
567 *
568 * Called from _init_clocks(). Populates the @oh omap_hwmod_opt_clk
569 * clock pointers. Returns 0 on success or -EINVAL on error.
570 */
571static int _init_opt_clks(struct omap_hwmod *oh)
572{
573 struct omap_hwmod_opt_clk *oc;
574 struct clk *c;
575 int i;
576 int ret = 0;
577
578 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++) {
579 c = omap_clk_get_by_name(oc->clk);
580 if (!c) {
581 pr_warning("omap_hwmod: %s: cannot clk_get opt_clk %s\n",
582 oh->name, oc->clk);
583 ret = -EINVAL;
584 }
585 oc->_clk = c;
586 }
587
588 return ret;
589}
590
591/**
592 * _enable_clocks - enable hwmod main clock and interface clocks
593 * @oh: struct omap_hwmod *
594 *
595 * Enables all clocks necessary for register reads and writes to succeed
596 * on the hwmod @oh. Returns 0.
597 */
598static int _enable_clocks(struct omap_hwmod *oh)
599{
600 int i;
601
602 pr_debug("omap_hwmod: %s: enabling clocks\n", oh->name);
603
604 if (oh->_clk)
605 clk_enable(oh->_clk);
606
607 if (oh->slaves_cnt > 0) {
608 for (i = 0; i < oh->slaves_cnt; i++) {
609 struct omap_hwmod_ocp_if *os = oh->slaves[i];
610 struct clk *c = os->_clk;
611
612 if (c && (os->flags & OCPIF_SWSUP_IDLE))
613 clk_enable(c);
614 }
615 }
616
617 /* The opt clocks are controlled by the device driver. */
618
619 return 0;
620}
621
622/**
623 * _disable_clocks - disable hwmod main clock and interface clocks
624 * @oh: struct omap_hwmod *
625 *
626 * Disables the hwmod @oh main functional and interface clocks. Returns 0.
627 */
628static int _disable_clocks(struct omap_hwmod *oh)
629{
630 int i;
631
632 pr_debug("omap_hwmod: %s: disabling clocks\n", oh->name);
633
634 if (oh->_clk)
635 clk_disable(oh->_clk);
636
637 if (oh->slaves_cnt > 0) {
638 for (i = 0; i < oh->slaves_cnt; i++) {
639 struct omap_hwmod_ocp_if *os = oh->slaves[i];
640 struct clk *c = os->_clk;
641
642 if (c && (os->flags & OCPIF_SWSUP_IDLE))
643 clk_disable(c);
644 }
645 }
646
647 /* The opt clocks are controlled by the device driver. */
648
649 return 0;
650}
651
652static void _enable_optional_clocks(struct omap_hwmod *oh)
653{
654 struct omap_hwmod_opt_clk *oc;
655 int i;
656
657 pr_debug("omap_hwmod: %s: enabling optional clocks\n", oh->name);
658
659 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
660 if (oc->_clk) {
661 pr_debug("omap_hwmod: enable %s:%s\n", oc->role,
662 oc->_clk->name);
663 clk_enable(oc->_clk);
664 }
665}
666
667static void _disable_optional_clocks(struct omap_hwmod *oh)
668{
669 struct omap_hwmod_opt_clk *oc;
670 int i;
671
672 pr_debug("omap_hwmod: %s: disabling optional clocks\n", oh->name);
673
674 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
675 if (oc->_clk) {
676 pr_debug("omap_hwmod: disable %s:%s\n", oc->role,
677 oc->_clk->name);
678 clk_disable(oc->_clk);
679 }
680}
681
682/**
683 * _enable_module - enable CLKCTRL modulemode on OMAP4
684 * @oh: struct omap_hwmod *
685 *
686 * Enables the PRCM module mode related to the hwmod @oh.
687 * No return value.
688 */
689static void _enable_module(struct omap_hwmod *oh)
690{
691 /* The module mode does not exist prior OMAP4 */
692 if (cpu_is_omap24xx() || cpu_is_omap34xx())
693 return;
694
695 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
696 return;
697
698 pr_debug("omap_hwmod: %s: _enable_module: %d\n",
699 oh->name, oh->prcm.omap4.modulemode);
700
701 omap4_cminst_module_enable(oh->prcm.omap4.modulemode,
702 oh->clkdm->prcm_partition,
703 oh->clkdm->cm_inst,
704 oh->clkdm->clkdm_offs,
705 oh->prcm.omap4.clkctrl_offs);
706}
707
708/**
709 * _disable_module - enable CLKCTRL modulemode on OMAP4
710 * @oh: struct omap_hwmod *
711 *
712 * Disable the PRCM module mode related to the hwmod @oh.
713 * No return value.
714 */
715static void _disable_module(struct omap_hwmod *oh)
716{
717 /* The module mode does not exist prior OMAP4 */
718 if (cpu_is_omap24xx() || cpu_is_omap34xx())
719 return;
720
721 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
722 return;
723
724 pr_debug("omap_hwmod: %s: _disable_module\n", oh->name);
725
726 omap4_cminst_module_disable(oh->clkdm->prcm_partition,
727 oh->clkdm->cm_inst,
728 oh->clkdm->clkdm_offs,
729 oh->prcm.omap4.clkctrl_offs);
730}
731
732/**
733 * _count_mpu_irqs - count the number of MPU IRQ lines associated with @oh
734 * @oh: struct omap_hwmod *oh
735 *
736 * Count and return the number of MPU IRQs associated with the hwmod
737 * @oh. Used to allocate struct resource data. Returns 0 if @oh is
738 * NULL.
739 */
740static int _count_mpu_irqs(struct omap_hwmod *oh)
741{
742 struct omap_hwmod_irq_info *ohii;
743 int i = 0;
744
745 if (!oh || !oh->mpu_irqs)
746 return 0;
747
748 do {
749 ohii = &oh->mpu_irqs[i++];
750 } while (ohii->irq != -1);
751
752 return i;
753}
754
755/**
756 * _count_sdma_reqs - count the number of SDMA request lines associated with @oh
757 * @oh: struct omap_hwmod *oh
758 *
759 * Count and return the number of SDMA request lines associated with
760 * the hwmod @oh. Used to allocate struct resource data. Returns 0
761 * if @oh is NULL.
762 */
763static int _count_sdma_reqs(struct omap_hwmod *oh)
764{
765 struct omap_hwmod_dma_info *ohdi;
766 int i = 0;
767
768 if (!oh || !oh->sdma_reqs)
769 return 0;
770
771 do {
772 ohdi = &oh->sdma_reqs[i++];
773 } while (ohdi->dma_req != -1);
774
775 return i;
776}
777
778/**
779 * _count_ocp_if_addr_spaces - count the number of address space entries for @oh
780 * @oh: struct omap_hwmod *oh
781 *
782 * Count and return the number of address space ranges associated with
783 * the hwmod @oh. Used to allocate struct resource data. Returns 0
784 * if @oh is NULL.
785 */
786static int _count_ocp_if_addr_spaces(struct omap_hwmod_ocp_if *os)
787{
788 struct omap_hwmod_addr_space *mem;
789 int i = 0;
790
791 if (!os || !os->addr)
792 return 0;
793
794 do {
795 mem = &os->addr[i++];
796 } while (mem->pa_start != mem->pa_end);
797
798 return i;
799}
800
801/**
802 * _find_mpu_port_index - find hwmod OCP slave port ID intended for MPU use
803 * @oh: struct omap_hwmod *
804 *
805 * Returns the array index of the OCP slave port that the MPU
806 * addresses the device on, or -EINVAL upon error or not found.
807 */
808static int __init _find_mpu_port_index(struct omap_hwmod *oh)
809{
810 int i;
811 int found = 0;
812
813 if (!oh || oh->slaves_cnt == 0)
814 return -EINVAL;
815
816 for (i = 0; i < oh->slaves_cnt; i++) {
817 struct omap_hwmod_ocp_if *os = oh->slaves[i];
818
819 if (os->user & OCP_USER_MPU) {
820 found = 1;
821 break;
822 }
823 }
824
825 if (found)
826 pr_debug("omap_hwmod: %s: MPU OCP slave port ID %d\n",
827 oh->name, i);
828 else
829 pr_debug("omap_hwmod: %s: no MPU OCP slave port found\n",
830 oh->name);
831
832 return (found) ? i : -EINVAL;
833}
834
835/**
836 * _find_mpu_rt_base - find hwmod register target base addr accessible by MPU
837 * @oh: struct omap_hwmod *
838 *
839 * Return the virtual address of the base of the register target of
840 * device @oh, or NULL on error.
841 */
842static void __iomem * __init _find_mpu_rt_base(struct omap_hwmod *oh, u8 index)
843{
844 struct omap_hwmod_ocp_if *os;
845 struct omap_hwmod_addr_space *mem;
846 int i = 0, found = 0;
847 void __iomem *va_start;
848
849 if (!oh || oh->slaves_cnt == 0)
850 return NULL;
851
852 os = oh->slaves[index];
853
854 if (!os->addr)
855 return NULL;
856
857 do {
858 mem = &os->addr[i++];
859 if (mem->flags & ADDR_TYPE_RT)
860 found = 1;
861 } while (!found && mem->pa_start != mem->pa_end);
862
863 if (found) {
864 va_start = ioremap(mem->pa_start, mem->pa_end - mem->pa_start);
865 if (!va_start) {
866 pr_err("omap_hwmod: %s: Could not ioremap\n", oh->name);
867 return NULL;
868 }
869 pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
870 oh->name, va_start);
871 } else {
872 pr_debug("omap_hwmod: %s: no MPU register target found\n",
873 oh->name);
874 }
875
876 return (found) ? va_start : NULL;
877}
878
879/**
880 * _enable_sysc - try to bring a module out of idle via OCP_SYSCONFIG
881 * @oh: struct omap_hwmod *
882 *
883 * If module is marked as SWSUP_SIDLE, force the module out of slave
884 * idle; otherwise, configure it for smart-idle. If module is marked
885 * as SWSUP_MSUSPEND, force the module out of master standby;
886 * otherwise, configure it for smart-standby. No return value.
887 */
888static void _enable_sysc(struct omap_hwmod *oh)
889{
890 u8 idlemode, sf;
891 u32 v;
892
893 if (!oh->class->sysc)
894 return;
895
896 v = oh->_sysc_cache;
897 sf = oh->class->sysc->sysc_flags;
898
899 if (sf & SYSC_HAS_SIDLEMODE) {
900 idlemode = (oh->flags & HWMOD_SWSUP_SIDLE) ?
901 HWMOD_IDLEMODE_NO : HWMOD_IDLEMODE_SMART;
902 _set_slave_idlemode(oh, idlemode, &v);
903 }
904
905 if (sf & SYSC_HAS_MIDLEMODE) {
906 if (oh->flags & HWMOD_SWSUP_MSTANDBY) {
907 idlemode = HWMOD_IDLEMODE_NO;
908 } else {
909 if (sf & SYSC_HAS_ENAWAKEUP)
910 _enable_wakeup(oh, &v);
911 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
912 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
913 else
914 idlemode = HWMOD_IDLEMODE_SMART;
915 }
916 _set_master_standbymode(oh, idlemode, &v);
917 }
918
919 /*
920 * XXX The clock framework should handle this, by
921 * calling into this code. But this must wait until the
922 * clock structures are tagged with omap_hwmod entries
923 */
924 if ((oh->flags & HWMOD_SET_DEFAULT_CLOCKACT) &&
925 (sf & SYSC_HAS_CLOCKACTIVITY))
926 _set_clockactivity(oh, oh->class->sysc->clockact, &v);
927
928 /* If slave is in SMARTIDLE, also enable wakeup */
929 if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
930 _enable_wakeup(oh, &v);
931
932 _write_sysconfig(v, oh);
933
934 /*
935 * Set the autoidle bit only after setting the smartidle bit
936 * Setting this will not have any impact on the other modules.
937 */
938 if (sf & SYSC_HAS_AUTOIDLE) {
939 idlemode = (oh->flags & HWMOD_NO_OCP_AUTOIDLE) ?
940 0 : 1;
941 _set_module_autoidle(oh, idlemode, &v);
942 _write_sysconfig(v, oh);
943 }
944}
945
946/**
947 * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
948 * @oh: struct omap_hwmod *
949 *
950 * If module is marked as SWSUP_SIDLE, force the module into slave
951 * idle; otherwise, configure it for smart-idle. If module is marked
952 * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
953 * configure it for smart-standby. No return value.
954 */
955static void _idle_sysc(struct omap_hwmod *oh)
956{
957 u8 idlemode, sf;
958 u32 v;
959
960 if (!oh->class->sysc)
961 return;
962
963 v = oh->_sysc_cache;
964 sf = oh->class->sysc->sysc_flags;
965
966 if (sf & SYSC_HAS_SIDLEMODE) {
967 idlemode = (oh->flags & HWMOD_SWSUP_SIDLE) ?
968 HWMOD_IDLEMODE_FORCE : HWMOD_IDLEMODE_SMART;
969 _set_slave_idlemode(oh, idlemode, &v);
970 }
971
972 if (sf & SYSC_HAS_MIDLEMODE) {
973 if (oh->flags & HWMOD_SWSUP_MSTANDBY) {
974 idlemode = HWMOD_IDLEMODE_FORCE;
975 } else {
976 if (sf & SYSC_HAS_ENAWAKEUP)
977 _enable_wakeup(oh, &v);
978 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
979 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
980 else
981 idlemode = HWMOD_IDLEMODE_SMART;
982 }
983 _set_master_standbymode(oh, idlemode, &v);
984 }
985
986 /* If slave is in SMARTIDLE, also enable wakeup */
987 if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
988 _enable_wakeup(oh, &v);
989
990 _write_sysconfig(v, oh);
991}
992
993/**
994 * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
995 * @oh: struct omap_hwmod *
996 *
997 * Force the module into slave idle and master suspend. No return
998 * value.
999 */
1000static void _shutdown_sysc(struct omap_hwmod *oh)
1001{
1002 u32 v;
1003 u8 sf;
1004
1005 if (!oh->class->sysc)
1006 return;
1007
1008 v = oh->_sysc_cache;
1009 sf = oh->class->sysc->sysc_flags;
1010
1011 if (sf & SYSC_HAS_SIDLEMODE)
1012 _set_slave_idlemode(oh, HWMOD_IDLEMODE_FORCE, &v);
1013
1014 if (sf & SYSC_HAS_MIDLEMODE)
1015 _set_master_standbymode(oh, HWMOD_IDLEMODE_FORCE, &v);
1016
1017 if (sf & SYSC_HAS_AUTOIDLE)
1018 _set_module_autoidle(oh, 1, &v);
1019
1020 _write_sysconfig(v, oh);
1021}
1022
1023/**
1024 * _lookup - find an omap_hwmod by name
1025 * @name: find an omap_hwmod by name
1026 *
1027 * Return a pointer to an omap_hwmod by name, or NULL if not found.
1028 */
1029static struct omap_hwmod *_lookup(const char *name)
1030{
1031 struct omap_hwmod *oh, *temp_oh;
1032
1033 oh = NULL;
1034
1035 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1036 if (!strcmp(name, temp_oh->name)) {
1037 oh = temp_oh;
1038 break;
1039 }
1040 }
1041
1042 return oh;
1043}
1044/**
1045 * _init_clkdm - look up a clockdomain name, store pointer in omap_hwmod
1046 * @oh: struct omap_hwmod *
1047 *
1048 * Convert a clockdomain name stored in a struct omap_hwmod into a
1049 * clockdomain pointer, and save it into the struct omap_hwmod.
1050 * return -EINVAL if clkdm_name does not exist or if the lookup failed.
1051 */
1052static int _init_clkdm(struct omap_hwmod *oh)
1053{
1054 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1055 return 0;
1056
1057 if (!oh->clkdm_name) {
1058 pr_warning("omap_hwmod: %s: no clkdm_name\n", oh->name);
1059 return -EINVAL;
1060 }
1061
1062 oh->clkdm = clkdm_lookup(oh->clkdm_name);
1063 if (!oh->clkdm) {
1064 pr_warning("omap_hwmod: %s: could not associate to clkdm %s\n",
1065 oh->name, oh->clkdm_name);
1066 return -EINVAL;
1067 }
1068
1069 pr_debug("omap_hwmod: %s: associated to clkdm %s\n",
1070 oh->name, oh->clkdm_name);
1071
1072 return 0;
1073}
1074
1075/**
1076 * _init_clocks - clk_get() all clocks associated with this hwmod. Retrieve as
1077 * well the clockdomain.
1078 * @oh: struct omap_hwmod *
1079 * @data: not used; pass NULL
1080 *
1081 * Called by omap_hwmod_setup_*() (after omap2_clk_init()).
1082 * Resolves all clock names embedded in the hwmod. Returns 0 on
1083 * success, or a negative error code on failure.
1084 */
1085static int _init_clocks(struct omap_hwmod *oh, void *data)
1086{
1087 int ret = 0;
1088
1089 if (oh->_state != _HWMOD_STATE_REGISTERED)
1090 return 0;
1091
1092 pr_debug("omap_hwmod: %s: looking up clocks\n", oh->name);
1093
1094 ret |= _init_main_clk(oh);
1095 ret |= _init_interface_clks(oh);
1096 ret |= _init_opt_clks(oh);
1097 ret |= _init_clkdm(oh);
1098
1099 if (!ret)
1100 oh->_state = _HWMOD_STATE_CLKS_INITED;
1101 else
1102 pr_warning("omap_hwmod: %s: cannot _init_clocks\n", oh->name);
1103
1104 return ret;
1105}
1106
1107/**
1108 * _wait_target_ready - wait for a module to leave slave idle
1109 * @oh: struct omap_hwmod *
1110 *
1111 * Wait for a module @oh to leave slave idle. Returns 0 if the module
1112 * does not have an IDLEST bit or if the module successfully leaves
1113 * slave idle; otherwise, pass along the return value of the
1114 * appropriate *_cm*_wait_module_ready() function.
1115 */
1116static int _wait_target_ready(struct omap_hwmod *oh)
1117{
1118 struct omap_hwmod_ocp_if *os;
1119 int ret;
1120
1121 if (!oh)
1122 return -EINVAL;
1123
1124 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
1125 return 0;
1126
1127 os = oh->slaves[oh->_mpu_port_index];
1128
1129 if (oh->flags & HWMOD_NO_IDLEST)
1130 return 0;
1131
1132 /* XXX check module SIDLEMODE */
1133
1134 /* XXX check clock enable states */
1135
1136 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1137 ret = omap2_cm_wait_module_ready(oh->prcm.omap2.module_offs,
1138 oh->prcm.omap2.idlest_reg_id,
1139 oh->prcm.omap2.idlest_idle_bit);
1140 } else if (cpu_is_omap44xx()) {
1141 if (!oh->clkdm)
1142 return -EINVAL;
1143
1144 ret = omap4_cminst_wait_module_ready(oh->clkdm->prcm_partition,
1145 oh->clkdm->cm_inst,
1146 oh->clkdm->clkdm_offs,
1147 oh->prcm.omap4.clkctrl_offs);
1148 } else {
1149 BUG();
1150 };
1151
1152 return ret;
1153}
1154
1155/**
1156 * _wait_target_disable - wait for a module to be disabled
1157 * @oh: struct omap_hwmod *
1158 *
1159 * Wait for a module @oh to enter slave idle. Returns 0 if the module
1160 * does not have an IDLEST bit or if the module successfully enters
1161 * slave idle; otherwise, pass along the return value of the
1162 * appropriate *_cm*_wait_module_idle() function.
1163 */
1164static int _wait_target_disable(struct omap_hwmod *oh)
1165{
1166 /* TODO: For now just handle OMAP4+ */
1167 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1168 return 0;
1169
1170 if (!oh)
1171 return -EINVAL;
1172
1173 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
1174 return 0;
1175
1176 if (oh->flags & HWMOD_NO_IDLEST)
1177 return 0;
1178
1179 return omap4_cminst_wait_module_idle(oh->clkdm->prcm_partition,
1180 oh->clkdm->cm_inst,
1181 oh->clkdm->clkdm_offs,
1182 oh->prcm.omap4.clkctrl_offs);
1183}
1184
1185/**
1186 * _lookup_hardreset - fill register bit info for this hwmod/reset line
1187 * @oh: struct omap_hwmod *
1188 * @name: name of the reset line in the context of this hwmod
1189 * @ohri: struct omap_hwmod_rst_info * that this function will fill in
1190 *
1191 * Return the bit position of the reset line that match the
1192 * input name. Return -ENOENT if not found.
1193 */
1194static u8 _lookup_hardreset(struct omap_hwmod *oh, const char *name,
1195 struct omap_hwmod_rst_info *ohri)
1196{
1197 int i;
1198
1199 for (i = 0; i < oh->rst_lines_cnt; i++) {
1200 const char *rst_line = oh->rst_lines[i].name;
1201 if (!strcmp(rst_line, name)) {
1202 ohri->rst_shift = oh->rst_lines[i].rst_shift;
1203 ohri->st_shift = oh->rst_lines[i].st_shift;
1204 pr_debug("omap_hwmod: %s: %s: %s: rst %d st %d\n",
1205 oh->name, __func__, rst_line, ohri->rst_shift,
1206 ohri->st_shift);
1207
1208 return 0;
1209 }
1210 }
1211
1212 return -ENOENT;
1213}
1214
1215/**
1216 * _assert_hardreset - assert the HW reset line of submodules
1217 * contained in the hwmod module.
1218 * @oh: struct omap_hwmod *
1219 * @name: name of the reset line to lookup and assert
1220 *
1221 * Some IP like dsp, ipu or iva contain processor that require
1222 * an HW reset line to be assert / deassert in order to enable fully
1223 * the IP.
1224 */
1225static int _assert_hardreset(struct omap_hwmod *oh, const char *name)
1226{
1227 struct omap_hwmod_rst_info ohri;
1228 u8 ret;
1229
1230 if (!oh)
1231 return -EINVAL;
1232
1233 ret = _lookup_hardreset(oh, name, &ohri);
1234 if (IS_ERR_VALUE(ret))
1235 return ret;
1236
1237 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1238 return omap2_prm_assert_hardreset(oh->prcm.omap2.module_offs,
1239 ohri.rst_shift);
1240 else if (cpu_is_omap44xx())
1241 return omap4_prminst_assert_hardreset(ohri.rst_shift,
1242 oh->clkdm->pwrdm.ptr->prcm_partition,
1243 oh->clkdm->pwrdm.ptr->prcm_offs,
1244 oh->prcm.omap4.rstctrl_offs);
1245 else
1246 return -EINVAL;
1247}
1248
1249/**
1250 * _deassert_hardreset - deassert the HW reset line of submodules contained
1251 * in the hwmod module.
1252 * @oh: struct omap_hwmod *
1253 * @name: name of the reset line to look up and deassert
1254 *
1255 * Some IP like dsp, ipu or iva contain processor that require
1256 * an HW reset line to be assert / deassert in order to enable fully
1257 * the IP.
1258 */
1259static int _deassert_hardreset(struct omap_hwmod *oh, const char *name)
1260{
1261 struct omap_hwmod_rst_info ohri;
1262 int ret;
1263
1264 if (!oh)
1265 return -EINVAL;
1266
1267 ret = _lookup_hardreset(oh, name, &ohri);
1268 if (IS_ERR_VALUE(ret))
1269 return ret;
1270
1271 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1272 ret = omap2_prm_deassert_hardreset(oh->prcm.omap2.module_offs,
1273 ohri.rst_shift,
1274 ohri.st_shift);
1275 } else if (cpu_is_omap44xx()) {
1276 if (ohri.st_shift)
1277 pr_err("omap_hwmod: %s: %s: hwmod data error: OMAP4 does not support st_shift\n",
1278 oh->name, name);
1279 ret = omap4_prminst_deassert_hardreset(ohri.rst_shift,
1280 oh->clkdm->pwrdm.ptr->prcm_partition,
1281 oh->clkdm->pwrdm.ptr->prcm_offs,
1282 oh->prcm.omap4.rstctrl_offs);
1283 } else {
1284 return -EINVAL;
1285 }
1286
1287 if (ret == -EBUSY)
1288 pr_warning("omap_hwmod: %s: failed to hardreset\n", oh->name);
1289
1290 return ret;
1291}
1292
1293/**
1294 * _read_hardreset - read the HW reset line state of submodules
1295 * contained in the hwmod module
1296 * @oh: struct omap_hwmod *
1297 * @name: name of the reset line to look up and read
1298 *
1299 * Return the state of the reset line.
1300 */
1301static int _read_hardreset(struct omap_hwmod *oh, const char *name)
1302{
1303 struct omap_hwmod_rst_info ohri;
1304 u8 ret;
1305
1306 if (!oh)
1307 return -EINVAL;
1308
1309 ret = _lookup_hardreset(oh, name, &ohri);
1310 if (IS_ERR_VALUE(ret))
1311 return ret;
1312
1313 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1314 return omap2_prm_is_hardreset_asserted(oh->prcm.omap2.module_offs,
1315 ohri.st_shift);
1316 } else if (cpu_is_omap44xx()) {
1317 return omap4_prminst_is_hardreset_asserted(ohri.rst_shift,
1318 oh->clkdm->pwrdm.ptr->prcm_partition,
1319 oh->clkdm->pwrdm.ptr->prcm_offs,
1320 oh->prcm.omap4.rstctrl_offs);
1321 } else {
1322 return -EINVAL;
1323 }
1324}
1325
1326/**
1327 * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1328 * @oh: struct omap_hwmod *
1329 *
1330 * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit. hwmod must be
1331 * enabled for this to work. Returns -EINVAL if the hwmod cannot be
1332 * reset this way or if the hwmod is in the wrong state, -ETIMEDOUT if
1333 * the module did not reset in time, or 0 upon success.
1334 *
1335 * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1336 * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1337 * use the SYSCONFIG softreset bit to provide the status.
1338 *
1339 * Note that some IP like McBSP do have reset control but don't have
1340 * reset status.
1341 */
1342static int _ocp_softreset(struct omap_hwmod *oh)
1343{
1344 u32 v;
1345 int c = 0;
1346 int ret = 0;
1347
1348 if (!oh->class->sysc ||
1349 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
1350 return -EINVAL;
1351
1352 /* clocks must be on for this operation */
1353 if (oh->_state != _HWMOD_STATE_ENABLED) {
1354 pr_warning("omap_hwmod: %s: reset can only be entered from "
1355 "enabled state\n", oh->name);
1356 return -EINVAL;
1357 }
1358
1359 /* For some modules, all optionnal clocks need to be enabled as well */
1360 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1361 _enable_optional_clocks(oh);
1362
1363 pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh->name);
1364
1365 v = oh->_sysc_cache;
1366 ret = _set_softreset(oh, &v);
1367 if (ret)
1368 goto dis_opt_clks;
1369 _write_sysconfig(v, oh);
1370
1371 if (oh->class->sysc->sysc_flags & SYSS_HAS_RESET_STATUS)
1372 omap_test_timeout((omap_hwmod_read(oh,
1373 oh->class->sysc->syss_offs)
1374 & SYSS_RESETDONE_MASK),
1375 MAX_MODULE_SOFTRESET_WAIT, c);
1376 else if (oh->class->sysc->sysc_flags & SYSC_HAS_RESET_STATUS)
1377 omap_test_timeout(!(omap_hwmod_read(oh,
1378 oh->class->sysc->sysc_offs)
1379 & SYSC_TYPE2_SOFTRESET_MASK),
1380 MAX_MODULE_SOFTRESET_WAIT, c);
1381
1382 if (c == MAX_MODULE_SOFTRESET_WAIT)
1383 pr_warning("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1384 oh->name, MAX_MODULE_SOFTRESET_WAIT);
1385 else
1386 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh->name, c);
1387
1388 /*
1389 * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1390 * _wait_target_ready() or _reset()
1391 */
1392
1393 ret = (c == MAX_MODULE_SOFTRESET_WAIT) ? -ETIMEDOUT : 0;
1394
1395dis_opt_clks:
1396 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1397 _disable_optional_clocks(oh);
1398
1399 return ret;
1400}
1401
1402/**
1403 * _reset - reset an omap_hwmod
1404 * @oh: struct omap_hwmod *
1405 *
1406 * Resets an omap_hwmod @oh. The default software reset mechanism for
1407 * most OMAP IP blocks is triggered via the OCP_SYSCONFIG.SOFTRESET
1408 * bit. However, some hwmods cannot be reset via this method: some
1409 * are not targets and therefore have no OCP header registers to
1410 * access; others (like the IVA) have idiosyncratic reset sequences.
1411 * So for these relatively rare cases, custom reset code can be
1412 * supplied in the struct omap_hwmod_class .reset function pointer.
1413 * Passes along the return value from either _reset() or the custom
1414 * reset function - these must return -EINVAL if the hwmod cannot be
1415 * reset this way or if the hwmod is in the wrong state, -ETIMEDOUT if
1416 * the module did not reset in time, or 0 upon success.
1417 */
1418static int _reset(struct omap_hwmod *oh)
1419{
1420 int ret;
1421
1422 pr_debug("omap_hwmod: %s: resetting\n", oh->name);
1423
1424 ret = (oh->class->reset) ? oh->class->reset(oh) : _ocp_softreset(oh);
1425
1426 return ret;
1427}
1428
1429/**
1430 * _enable - enable an omap_hwmod
1431 * @oh: struct omap_hwmod *
1432 *
1433 * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
1434 * register target. Returns -EINVAL if the hwmod is in the wrong
1435 * state or passes along the return value of _wait_target_ready().
1436 */
1437static int _enable(struct omap_hwmod *oh)
1438{
1439 int r;
1440 int hwsup = 0;
1441
1442 pr_debug("omap_hwmod: %s: enabling\n", oh->name);
1443
1444 if (oh->_state != _HWMOD_STATE_INITIALIZED &&
1445 oh->_state != _HWMOD_STATE_IDLE &&
1446 oh->_state != _HWMOD_STATE_DISABLED) {
1447 WARN(1, "omap_hwmod: %s: enabled state can only be entered "
1448 "from initialized, idle, or disabled state\n", oh->name);
1449 return -EINVAL;
1450 }
1451
1452
1453 /*
1454 * If an IP contains only one HW reset line, then de-assert it in order
1455 * to allow the module state transition. Otherwise the PRCM will return
1456 * Intransition status, and the init will failed.
1457 */
1458 if ((oh->_state == _HWMOD_STATE_INITIALIZED ||
1459 oh->_state == _HWMOD_STATE_DISABLED) && oh->rst_lines_cnt == 1)
1460 _deassert_hardreset(oh, oh->rst_lines[0].name);
1461
1462 /* Mux pins for device runtime if populated */
1463 if (oh->mux && (!oh->mux->enabled ||
1464 ((oh->_state == _HWMOD_STATE_IDLE) &&
1465 oh->mux->pads_dynamic)))
1466 omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
1467
1468 _add_initiator_dep(oh, mpu_oh);
1469
1470 if (oh->clkdm) {
1471 /*
1472 * A clockdomain must be in SW_SUP before enabling
1473 * completely the module. The clockdomain can be set
1474 * in HW_AUTO only when the module become ready.
1475 */
1476 hwsup = clkdm_in_hwsup(oh->clkdm);
1477 r = clkdm_hwmod_enable(oh->clkdm, oh);
1478 if (r) {
1479 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1480 oh->name, oh->clkdm->name, r);
1481 return r;
1482 }
1483 }
1484
1485 _enable_clocks(oh);
1486 _enable_module(oh);
1487
1488 r = _wait_target_ready(oh);
1489 if (!r) {
1490 /*
1491 * Set the clockdomain to HW_AUTO only if the target is ready,
1492 * assuming that the previous state was HW_AUTO
1493 */
1494 if (oh->clkdm && hwsup)
1495 clkdm_allow_idle(oh->clkdm);
1496
1497 oh->_state = _HWMOD_STATE_ENABLED;
1498
1499 /* Access the sysconfig only if the target is ready */
1500 if (oh->class->sysc) {
1501 if (!(oh->_int_flags & _HWMOD_SYSCONFIG_LOADED))
1502 _update_sysc_cache(oh);
1503 _enable_sysc(oh);
1504 }
1505 } else {
1506 _disable_clocks(oh);
1507 pr_debug("omap_hwmod: %s: _wait_target_ready: %d\n",
1508 oh->name, r);
1509
1510 if (oh->clkdm)
1511 clkdm_hwmod_disable(oh->clkdm, oh);
1512 }
1513
1514 return r;
1515}
1516
1517/**
1518 * _idle - idle an omap_hwmod
1519 * @oh: struct omap_hwmod *
1520 *
1521 * Idles an omap_hwmod @oh. This should be called once the hwmod has
1522 * no further work. Returns -EINVAL if the hwmod is in the wrong
1523 * state or returns 0.
1524 */
1525static int _idle(struct omap_hwmod *oh)
1526{
1527 int ret;
1528
1529 pr_debug("omap_hwmod: %s: idling\n", oh->name);
1530
1531 if (oh->_state != _HWMOD_STATE_ENABLED) {
1532 WARN(1, "omap_hwmod: %s: idle state can only be entered from "
1533 "enabled state\n", oh->name);
1534 return -EINVAL;
1535 }
1536
1537 if (oh->class->sysc)
1538 _idle_sysc(oh);
1539 _del_initiator_dep(oh, mpu_oh);
1540 _disable_module(oh);
1541 ret = _wait_target_disable(oh);
1542 if (ret)
1543 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1544 oh->name);
1545 /*
1546 * The module must be in idle mode before disabling any parents
1547 * clocks. Otherwise, the parent clock might be disabled before
1548 * the module transition is done, and thus will prevent the
1549 * transition to complete properly.
1550 */
1551 _disable_clocks(oh);
1552 if (oh->clkdm)
1553 clkdm_hwmod_disable(oh->clkdm, oh);
1554
1555 /* Mux pins for device idle if populated */
1556 if (oh->mux && oh->mux->pads_dynamic)
1557 omap_hwmod_mux(oh->mux, _HWMOD_STATE_IDLE);
1558
1559 oh->_state = _HWMOD_STATE_IDLE;
1560
1561 return 0;
1562}
1563
1564/**
1565 * omap_hwmod_set_ocp_autoidle - set the hwmod's OCP autoidle bit
1566 * @oh: struct omap_hwmod *
1567 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
1568 *
1569 * Sets the IP block's OCP autoidle bit in hardware, and updates our
1570 * local copy. Intended to be used by drivers that require
1571 * direct manipulation of the AUTOIDLE bits.
1572 * Returns -EINVAL if @oh is null or is not in the ENABLED state, or passes
1573 * along the return value from _set_module_autoidle().
1574 *
1575 * Any users of this function should be scrutinized carefully.
1576 */
1577int omap_hwmod_set_ocp_autoidle(struct omap_hwmod *oh, u8 autoidle)
1578{
1579 u32 v;
1580 int retval = 0;
1581 unsigned long flags;
1582
1583 if (!oh || oh->_state != _HWMOD_STATE_ENABLED)
1584 return -EINVAL;
1585
1586 spin_lock_irqsave(&oh->_lock, flags);
1587
1588 v = oh->_sysc_cache;
1589
1590 retval = _set_module_autoidle(oh, autoidle, &v);
1591
1592 if (!retval)
1593 _write_sysconfig(v, oh);
1594
1595 spin_unlock_irqrestore(&oh->_lock, flags);
1596
1597 return retval;
1598}
1599
1600/**
1601 * _shutdown - shutdown an omap_hwmod
1602 * @oh: struct omap_hwmod *
1603 *
1604 * Shut down an omap_hwmod @oh. This should be called when the driver
1605 * used for the hwmod is removed or unloaded or if the driver is not
1606 * used by the system. Returns -EINVAL if the hwmod is in the wrong
1607 * state or returns 0.
1608 */
1609static int _shutdown(struct omap_hwmod *oh)
1610{
1611 int ret;
1612 u8 prev_state;
1613
1614 if (oh->_state != _HWMOD_STATE_IDLE &&
1615 oh->_state != _HWMOD_STATE_ENABLED) {
1616 WARN(1, "omap_hwmod: %s: disabled state can only be entered "
1617 "from idle, or enabled state\n", oh->name);
1618 return -EINVAL;
1619 }
1620
1621 pr_debug("omap_hwmod: %s: disabling\n", oh->name);
1622
1623 if (oh->class->pre_shutdown) {
1624 prev_state = oh->_state;
1625 if (oh->_state == _HWMOD_STATE_IDLE)
1626 _enable(oh);
1627 ret = oh->class->pre_shutdown(oh);
1628 if (ret) {
1629 if (prev_state == _HWMOD_STATE_IDLE)
1630 _idle(oh);
1631 return ret;
1632 }
1633 }
1634
1635 if (oh->class->sysc) {
1636 if (oh->_state == _HWMOD_STATE_IDLE)
1637 _enable(oh);
1638 _shutdown_sysc(oh);
1639 }
1640
1641 /* clocks and deps are already disabled in idle */
1642 if (oh->_state == _HWMOD_STATE_ENABLED) {
1643 _del_initiator_dep(oh, mpu_oh);
1644 /* XXX what about the other system initiators here? dma, dsp */
1645 _disable_module(oh);
1646 ret = _wait_target_disable(oh);
1647 if (ret)
1648 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1649 oh->name);
1650 _disable_clocks(oh);
1651 if (oh->clkdm)
1652 clkdm_hwmod_disable(oh->clkdm, oh);
1653 }
1654 /* XXX Should this code also force-disable the optional clocks? */
1655
1656 /*
1657 * If an IP contains only one HW reset line, then assert it
1658 * after disabling the clocks and before shutting down the IP.
1659 */
1660 if (oh->rst_lines_cnt == 1)
1661 _assert_hardreset(oh, oh->rst_lines[0].name);
1662
1663 /* Mux pins to safe mode or use populated off mode values */
1664 if (oh->mux)
1665 omap_hwmod_mux(oh->mux, _HWMOD_STATE_DISABLED);
1666
1667 oh->_state = _HWMOD_STATE_DISABLED;
1668
1669 return 0;
1670}
1671
1672/**
1673 * _setup - do initial configuration of omap_hwmod
1674 * @oh: struct omap_hwmod *
1675 *
1676 * Writes the CLOCKACTIVITY bits @clockact to the hwmod @oh
1677 * OCP_SYSCONFIG register. Returns 0.
1678 */
1679static int _setup(struct omap_hwmod *oh, void *data)
1680{
1681 int i, r;
1682 u8 postsetup_state;
1683
1684 if (oh->_state != _HWMOD_STATE_CLKS_INITED)
1685 return 0;
1686
1687 /* Set iclk autoidle mode */
1688 if (oh->slaves_cnt > 0) {
1689 for (i = 0; i < oh->slaves_cnt; i++) {
1690 struct omap_hwmod_ocp_if *os = oh->slaves[i];
1691 struct clk *c = os->_clk;
1692
1693 if (!c)
1694 continue;
1695
1696 if (os->flags & OCPIF_SWSUP_IDLE) {
1697 /* XXX omap_iclk_deny_idle(c); */
1698 } else {
1699 /* XXX omap_iclk_allow_idle(c); */
1700 clk_enable(c);
1701 }
1702 }
1703 }
1704
1705 oh->_state = _HWMOD_STATE_INITIALIZED;
1706
1707 /*
1708 * In the case of hwmod with hardreset that should not be
1709 * de-assert at boot time, we have to keep the module
1710 * initialized, because we cannot enable it properly with the
1711 * reset asserted. Exit without warning because that behavior is
1712 * expected.
1713 */
1714 if ((oh->flags & HWMOD_INIT_NO_RESET) && oh->rst_lines_cnt == 1)
1715 return 0;
1716
1717 r = _enable(oh);
1718 if (r) {
1719 pr_warning("omap_hwmod: %s: cannot be enabled (%d)\n",
1720 oh->name, oh->_state);
1721 return 0;
1722 }
1723
1724 if (!(oh->flags & HWMOD_INIT_NO_RESET)) {
1725 _reset(oh);
1726
1727 /*
1728 * OCP_SYSCONFIG bits need to be reprogrammed after a softreset.
1729 * The _enable() function should be split to
1730 * avoid the rewrite of the OCP_SYSCONFIG register.
1731 */
1732 if (oh->class->sysc) {
1733 _update_sysc_cache(oh);
1734 _enable_sysc(oh);
1735 }
1736 }
1737
1738 postsetup_state = oh->_postsetup_state;
1739 if (postsetup_state == _HWMOD_STATE_UNKNOWN)
1740 postsetup_state = _HWMOD_STATE_ENABLED;
1741
1742 /*
1743 * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
1744 * it should be set by the core code as a runtime flag during startup
1745 */
1746 if ((oh->flags & HWMOD_INIT_NO_IDLE) &&
1747 (postsetup_state == _HWMOD_STATE_IDLE))
1748 postsetup_state = _HWMOD_STATE_ENABLED;
1749
1750 if (postsetup_state == _HWMOD_STATE_IDLE)
1751 _idle(oh);
1752 else if (postsetup_state == _HWMOD_STATE_DISABLED)
1753 _shutdown(oh);
1754 else if (postsetup_state != _HWMOD_STATE_ENABLED)
1755 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
1756 oh->name, postsetup_state);
1757
1758 return 0;
1759}
1760
1761/**
1762 * _register - register a struct omap_hwmod
1763 * @oh: struct omap_hwmod *
1764 *
1765 * Registers the omap_hwmod @oh. Returns -EEXIST if an omap_hwmod
1766 * already has been registered by the same name; -EINVAL if the
1767 * omap_hwmod is in the wrong state, if @oh is NULL, if the
1768 * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
1769 * name, or if the omap_hwmod's class is missing a name; or 0 upon
1770 * success.
1771 *
1772 * XXX The data should be copied into bootmem, so the original data
1773 * should be marked __initdata and freed after init. This would allow
1774 * unneeded omap_hwmods to be freed on multi-OMAP configurations. Note
1775 * that the copy process would be relatively complex due to the large number
1776 * of substructures.
1777 */
1778static int __init _register(struct omap_hwmod *oh)
1779{
1780 int ms_id;
1781
1782 if (!oh || !oh->name || !oh->class || !oh->class->name ||
1783 (oh->_state != _HWMOD_STATE_UNKNOWN))
1784 return -EINVAL;
1785
1786 pr_debug("omap_hwmod: %s: registering\n", oh->name);
1787
1788 if (_lookup(oh->name))
1789 return -EEXIST;
1790
1791 ms_id = _find_mpu_port_index(oh);
1792 if (!IS_ERR_VALUE(ms_id))
1793 oh->_mpu_port_index = ms_id;
1794 else
1795 oh->_int_flags |= _HWMOD_NO_MPU_PORT;
1796
1797 list_add_tail(&oh->node, &omap_hwmod_list);
1798
1799 spin_lock_init(&oh->_lock);
1800
1801 oh->_state = _HWMOD_STATE_REGISTERED;
1802
1803 /*
1804 * XXX Rather than doing a strcmp(), this should test a flag
1805 * set in the hwmod data, inserted by the autogenerator code.
1806 */
1807 if (!strcmp(oh->name, MPU_INITIATOR_NAME))
1808 mpu_oh = oh;
1809
1810 return 0;
1811}
1812
1813
1814/* Public functions */
1815
1816u32 omap_hwmod_read(struct omap_hwmod *oh, u16 reg_offs)
1817{
1818 if (oh->flags & HWMOD_16BIT_REG)
1819 return __raw_readw(oh->_mpu_rt_va + reg_offs);
1820 else
1821 return __raw_readl(oh->_mpu_rt_va + reg_offs);
1822}
1823
1824void omap_hwmod_write(u32 v, struct omap_hwmod *oh, u16 reg_offs)
1825{
1826 if (oh->flags & HWMOD_16BIT_REG)
1827 __raw_writew(v, oh->_mpu_rt_va + reg_offs);
1828 else
1829 __raw_writel(v, oh->_mpu_rt_va + reg_offs);
1830}
1831
1832/**
1833 * omap_hwmod_softreset - reset a module via SYSCONFIG.SOFTRESET bit
1834 * @oh: struct omap_hwmod *
1835 *
1836 * This is a public function exposed to drivers. Some drivers may need to do
1837 * some settings before and after resetting the device. Those drivers after
1838 * doing the necessary settings could use this function to start a reset by
1839 * setting the SYSCONFIG.SOFTRESET bit.
1840 */
1841int omap_hwmod_softreset(struct omap_hwmod *oh)
1842{
1843 u32 v;
1844 int ret;
1845
1846 if (!oh || !(oh->_sysc_cache))
1847 return -EINVAL;
1848
1849 v = oh->_sysc_cache;
1850 ret = _set_softreset(oh, &v);
1851 if (ret)
1852 goto error;
1853 _write_sysconfig(v, oh);
1854
1855error:
1856 return ret;
1857}
1858
1859/**
1860 * omap_hwmod_set_slave_idlemode - set the hwmod's OCP slave idlemode
1861 * @oh: struct omap_hwmod *
1862 * @idlemode: SIDLEMODE field bits (shifted to bit 0)
1863 *
1864 * Sets the IP block's OCP slave idlemode in hardware, and updates our
1865 * local copy. Intended to be used by drivers that have some erratum
1866 * that requires direct manipulation of the SIDLEMODE bits. Returns
1867 * -EINVAL if @oh is null, or passes along the return value from
1868 * _set_slave_idlemode().
1869 *
1870 * XXX Does this function have any current users? If not, we should
1871 * remove it; it is better to let the rest of the hwmod code handle this.
1872 * Any users of this function should be scrutinized carefully.
1873 */
1874int omap_hwmod_set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode)
1875{
1876 u32 v;
1877 int retval = 0;
1878
1879 if (!oh)
1880 return -EINVAL;
1881
1882 v = oh->_sysc_cache;
1883
1884 retval = _set_slave_idlemode(oh, idlemode, &v);
1885 if (!retval)
1886 _write_sysconfig(v, oh);
1887
1888 return retval;
1889}
1890
1891/**
1892 * omap_hwmod_lookup - look up a registered omap_hwmod by name
1893 * @name: name of the omap_hwmod to look up
1894 *
1895 * Given a @name of an omap_hwmod, return a pointer to the registered
1896 * struct omap_hwmod *, or NULL upon error.
1897 */
1898struct omap_hwmod *omap_hwmod_lookup(const char *name)
1899{
1900 struct omap_hwmod *oh;
1901
1902 if (!name)
1903 return NULL;
1904
1905 oh = _lookup(name);
1906
1907 return oh;
1908}
1909
1910/**
1911 * omap_hwmod_for_each - call function for each registered omap_hwmod
1912 * @fn: pointer to a callback function
1913 * @data: void * data to pass to callback function
1914 *
1915 * Call @fn for each registered omap_hwmod, passing @data to each
1916 * function. @fn must return 0 for success or any other value for
1917 * failure. If @fn returns non-zero, the iteration across omap_hwmods
1918 * will stop and the non-zero return value will be passed to the
1919 * caller of omap_hwmod_for_each(). @fn is called with
1920 * omap_hwmod_for_each() held.
1921 */
1922int omap_hwmod_for_each(int (*fn)(struct omap_hwmod *oh, void *data),
1923 void *data)
1924{
1925 struct omap_hwmod *temp_oh;
1926 int ret = 0;
1927
1928 if (!fn)
1929 return -EINVAL;
1930
1931 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1932 ret = (*fn)(temp_oh, data);
1933 if (ret)
1934 break;
1935 }
1936
1937 return ret;
1938}
1939
1940/**
1941 * omap_hwmod_register - register an array of hwmods
1942 * @ohs: pointer to an array of omap_hwmods to register
1943 *
1944 * Intended to be called early in boot before the clock framework is
1945 * initialized. If @ohs is not null, will register all omap_hwmods
1946 * listed in @ohs that are valid for this chip. Returns 0.
1947 */
1948int __init omap_hwmod_register(struct omap_hwmod **ohs)
1949{
1950 int r, i;
1951
1952 if (!ohs)
1953 return 0;
1954
1955 i = 0;
1956 do {
1957 if (!omap_chip_is(ohs[i]->omap_chip))
1958 continue;
1959
1960 r = _register(ohs[i]);
1961 WARN(r, "omap_hwmod: %s: _register returned %d\n", ohs[i]->name,
1962 r);
1963 } while (ohs[++i]);
1964
1965 return 0;
1966}
1967
1968/*
1969 * _populate_mpu_rt_base - populate the virtual address for a hwmod
1970 *
1971 * Must be called only from omap_hwmod_setup_*() so ioremap works properly.
1972 * Assumes the caller takes care of locking if needed.
1973 */
1974static int __init _populate_mpu_rt_base(struct omap_hwmod *oh, void *data)
1975{
1976 if (oh->_state != _HWMOD_STATE_REGISTERED)
1977 return 0;
1978
1979 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
1980 return 0;
1981
1982 oh->_mpu_rt_va = _find_mpu_rt_base(oh, oh->_mpu_port_index);
1983
1984 return 0;
1985}
1986
1987/**
1988 * omap_hwmod_setup_one - set up a single hwmod
1989 * @oh_name: const char * name of the already-registered hwmod to set up
1990 *
1991 * Must be called after omap2_clk_init(). Resolves the struct clk
1992 * names to struct clk pointers for each registered omap_hwmod. Also
1993 * calls _setup() on each hwmod. Returns -EINVAL upon error or 0 upon
1994 * success.
1995 */
1996int __init omap_hwmod_setup_one(const char *oh_name)
1997{
1998 struct omap_hwmod *oh;
1999 int r;
2000
2001 pr_debug("omap_hwmod: %s: %s\n", oh_name, __func__);
2002
2003 if (!mpu_oh) {
2004 pr_err("omap_hwmod: %s: cannot setup_one: MPU initiator hwmod %s not yet registered\n",
2005 oh_name, MPU_INITIATOR_NAME);
2006 return -EINVAL;
2007 }
2008
2009 oh = _lookup(oh_name);
2010 if (!oh) {
2011 WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name);
2012 return -EINVAL;
2013 }
2014
2015 if (mpu_oh->_state == _HWMOD_STATE_REGISTERED && oh != mpu_oh)
2016 omap_hwmod_setup_one(MPU_INITIATOR_NAME);
2017
2018 r = _populate_mpu_rt_base(oh, NULL);
2019 if (IS_ERR_VALUE(r)) {
2020 WARN(1, "omap_hwmod: %s: couldn't set mpu_rt_base\n", oh_name);
2021 return -EINVAL;
2022 }
2023
2024 r = _init_clocks(oh, NULL);
2025 if (IS_ERR_VALUE(r)) {
2026 WARN(1, "omap_hwmod: %s: couldn't init clocks\n", oh_name);
2027 return -EINVAL;
2028 }
2029
2030 _setup(oh, NULL);
2031
2032 return 0;
2033}
2034
2035/**
2036 * omap_hwmod_setup - do some post-clock framework initialization
2037 *
2038 * Must be called after omap2_clk_init(). Resolves the struct clk names
2039 * to struct clk pointers for each registered omap_hwmod. Also calls
2040 * _setup() on each hwmod. Returns 0 upon success.
2041 */
2042static int __init omap_hwmod_setup_all(void)
2043{
2044 int r;
2045
2046 if (!mpu_oh) {
2047 pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",
2048 __func__, MPU_INITIATOR_NAME);
2049 return -EINVAL;
2050 }
2051
2052 r = omap_hwmod_for_each(_populate_mpu_rt_base, NULL);
2053
2054 r = omap_hwmod_for_each(_init_clocks, NULL);
2055 WARN(IS_ERR_VALUE(r),
2056 "omap_hwmod: %s: _init_clocks failed\n", __func__);
2057
2058 omap_hwmod_for_each(_setup, NULL);
2059
2060 return 0;
2061}
2062core_initcall(omap_hwmod_setup_all);
2063
2064/**
2065 * omap_hwmod_enable - enable an omap_hwmod
2066 * @oh: struct omap_hwmod *
2067 *
2068 * Enable an omap_hwmod @oh. Intended to be called by omap_device_enable().
2069 * Returns -EINVAL on error or passes along the return value from _enable().
2070 */
2071int omap_hwmod_enable(struct omap_hwmod *oh)
2072{
2073 int r;
2074 unsigned long flags;
2075
2076 if (!oh)
2077 return -EINVAL;
2078
2079 spin_lock_irqsave(&oh->_lock, flags);
2080 r = _enable(oh);
2081 spin_unlock_irqrestore(&oh->_lock, flags);
2082
2083 return r;
2084}
2085
2086/**
2087 * omap_hwmod_idle - idle an omap_hwmod
2088 * @oh: struct omap_hwmod *
2089 *
2090 * Idle an omap_hwmod @oh. Intended to be called by omap_device_idle().
2091 * Returns -EINVAL on error or passes along the return value from _idle().
2092 */
2093int omap_hwmod_idle(struct omap_hwmod *oh)
2094{
2095 unsigned long flags;
2096
2097 if (!oh)
2098 return -EINVAL;
2099
2100 spin_lock_irqsave(&oh->_lock, flags);
2101 _idle(oh);
2102 spin_unlock_irqrestore(&oh->_lock, flags);
2103
2104 return 0;
2105}
2106
2107/**
2108 * omap_hwmod_shutdown - shutdown an omap_hwmod
2109 * @oh: struct omap_hwmod *
2110 *
2111 * Shutdown an omap_hwmod @oh. Intended to be called by
2112 * omap_device_shutdown(). Returns -EINVAL on error or passes along
2113 * the return value from _shutdown().
2114 */
2115int omap_hwmod_shutdown(struct omap_hwmod *oh)
2116{
2117 unsigned long flags;
2118
2119 if (!oh)
2120 return -EINVAL;
2121
2122 spin_lock_irqsave(&oh->_lock, flags);
2123 _shutdown(oh);
2124 spin_unlock_irqrestore(&oh->_lock, flags);
2125
2126 return 0;
2127}
2128
2129/**
2130 * omap_hwmod_enable_clocks - enable main_clk, all interface clocks
2131 * @oh: struct omap_hwmod *oh
2132 *
2133 * Intended to be called by the omap_device code.
2134 */
2135int omap_hwmod_enable_clocks(struct omap_hwmod *oh)
2136{
2137 unsigned long flags;
2138
2139 spin_lock_irqsave(&oh->_lock, flags);
2140 _enable_clocks(oh);
2141 spin_unlock_irqrestore(&oh->_lock, flags);
2142
2143 return 0;
2144}
2145
2146/**
2147 * omap_hwmod_disable_clocks - disable main_clk, all interface clocks
2148 * @oh: struct omap_hwmod *oh
2149 *
2150 * Intended to be called by the omap_device code.
2151 */
2152int omap_hwmod_disable_clocks(struct omap_hwmod *oh)
2153{
2154 unsigned long flags;
2155
2156 spin_lock_irqsave(&oh->_lock, flags);
2157 _disable_clocks(oh);
2158 spin_unlock_irqrestore(&oh->_lock, flags);
2159
2160 return 0;
2161}
2162
2163/**
2164 * omap_hwmod_ocp_barrier - wait for posted writes against the hwmod to complete
2165 * @oh: struct omap_hwmod *oh
2166 *
2167 * Intended to be called by drivers and core code when all posted
2168 * writes to a device must complete before continuing further
2169 * execution (for example, after clearing some device IRQSTATUS
2170 * register bits)
2171 *
2172 * XXX what about targets with multiple OCP threads?
2173 */
2174void omap_hwmod_ocp_barrier(struct omap_hwmod *oh)
2175{
2176 BUG_ON(!oh);
2177
2178 if (!oh->class->sysc || !oh->class->sysc->sysc_flags) {
2179 WARN(1, "omap_device: %s: OCP barrier impossible due to "
2180 "device configuration\n", oh->name);
2181 return;
2182 }
2183
2184 /*
2185 * Forces posted writes to complete on the OCP thread handling
2186 * register writes
2187 */
2188 omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
2189}
2190
2191/**
2192 * omap_hwmod_reset - reset the hwmod
2193 * @oh: struct omap_hwmod *
2194 *
2195 * Under some conditions, a driver may wish to reset the entire device.
2196 * Called from omap_device code. Returns -EINVAL on error or passes along
2197 * the return value from _reset().
2198 */
2199int omap_hwmod_reset(struct omap_hwmod *oh)
2200{
2201 int r;
2202 unsigned long flags;
2203
2204 if (!oh)
2205 return -EINVAL;
2206
2207 spin_lock_irqsave(&oh->_lock, flags);
2208 r = _reset(oh);
2209 spin_unlock_irqrestore(&oh->_lock, flags);
2210
2211 return r;
2212}
2213
2214/**
2215 * omap_hwmod_count_resources - count number of struct resources needed by hwmod
2216 * @oh: struct omap_hwmod *
2217 * @res: pointer to the first element of an array of struct resource to fill
2218 *
2219 * Count the number of struct resource array elements necessary to
2220 * contain omap_hwmod @oh resources. Intended to be called by code
2221 * that registers omap_devices. Intended to be used to determine the
2222 * size of a dynamically-allocated struct resource array, before
2223 * calling omap_hwmod_fill_resources(). Returns the number of struct
2224 * resource array elements needed.
2225 *
2226 * XXX This code is not optimized. It could attempt to merge adjacent
2227 * resource IDs.
2228 *
2229 */
2230int omap_hwmod_count_resources(struct omap_hwmod *oh)
2231{
2232 int ret, i;
2233
2234 ret = _count_mpu_irqs(oh) + _count_sdma_reqs(oh);
2235
2236 for (i = 0; i < oh->slaves_cnt; i++)
2237 ret += _count_ocp_if_addr_spaces(oh->slaves[i]);
2238
2239 return ret;
2240}
2241
2242/**
2243 * omap_hwmod_fill_resources - fill struct resource array with hwmod data
2244 * @oh: struct omap_hwmod *
2245 * @res: pointer to the first element of an array of struct resource to fill
2246 *
2247 * Fill the struct resource array @res with resource data from the
2248 * omap_hwmod @oh. Intended to be called by code that registers
2249 * omap_devices. See also omap_hwmod_count_resources(). Returns the
2250 * number of array elements filled.
2251 */
2252int omap_hwmod_fill_resources(struct omap_hwmod *oh, struct resource *res)
2253{
2254 int i, j, mpu_irqs_cnt, sdma_reqs_cnt;
2255 int r = 0;
2256
2257 /* For each IRQ, DMA, memory area, fill in array.*/
2258
2259 mpu_irqs_cnt = _count_mpu_irqs(oh);
2260 for (i = 0; i < mpu_irqs_cnt; i++) {
2261 (res + r)->name = (oh->mpu_irqs + i)->name;
2262 (res + r)->start = (oh->mpu_irqs + i)->irq;
2263 (res + r)->end = (oh->mpu_irqs + i)->irq;
2264 (res + r)->flags = IORESOURCE_IRQ;
2265 r++;
2266 }
2267
2268 sdma_reqs_cnt = _count_sdma_reqs(oh);
2269 for (i = 0; i < sdma_reqs_cnt; i++) {
2270 (res + r)->name = (oh->sdma_reqs + i)->name;
2271 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
2272 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
2273 (res + r)->flags = IORESOURCE_DMA;
2274 r++;
2275 }
2276
2277 for (i = 0; i < oh->slaves_cnt; i++) {
2278 struct omap_hwmod_ocp_if *os;
2279 int addr_cnt;
2280
2281 os = oh->slaves[i];
2282 addr_cnt = _count_ocp_if_addr_spaces(os);
2283
2284 for (j = 0; j < addr_cnt; j++) {
2285 (res + r)->name = (os->addr + j)->name;
2286 (res + r)->start = (os->addr + j)->pa_start;
2287 (res + r)->end = (os->addr + j)->pa_end;
2288 (res + r)->flags = IORESOURCE_MEM;
2289 r++;
2290 }
2291 }
2292
2293 return r;
2294}
2295
2296/**
2297 * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
2298 * @oh: struct omap_hwmod *
2299 *
2300 * Return the powerdomain pointer associated with the OMAP module
2301 * @oh's main clock. If @oh does not have a main clk, return the
2302 * powerdomain associated with the interface clock associated with the
2303 * module's MPU port. (XXX Perhaps this should use the SDMA port
2304 * instead?) Returns NULL on error, or a struct powerdomain * on
2305 * success.
2306 */
2307struct powerdomain *omap_hwmod_get_pwrdm(struct omap_hwmod *oh)
2308{
2309 struct clk *c;
2310
2311 if (!oh)
2312 return NULL;
2313
2314 if (oh->_clk) {
2315 c = oh->_clk;
2316 } else {
2317 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2318 return NULL;
2319 c = oh->slaves[oh->_mpu_port_index]->_clk;
2320 }
2321
2322 if (!c->clkdm)
2323 return NULL;
2324
2325 return c->clkdm->pwrdm.ptr;
2326
2327}
2328
2329/**
2330 * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
2331 * @oh: struct omap_hwmod *
2332 *
2333 * Returns the virtual address corresponding to the beginning of the
2334 * module's register target, in the address range that is intended to
2335 * be used by the MPU. Returns the virtual address upon success or NULL
2336 * upon error.
2337 */
2338void __iomem *omap_hwmod_get_mpu_rt_va(struct omap_hwmod *oh)
2339{
2340 if (!oh)
2341 return NULL;
2342
2343 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2344 return NULL;
2345
2346 if (oh->_state == _HWMOD_STATE_UNKNOWN)
2347 return NULL;
2348
2349 return oh->_mpu_rt_va;
2350}
2351
2352/**
2353 * omap_hwmod_add_initiator_dep - add sleepdep from @init_oh to @oh
2354 * @oh: struct omap_hwmod *
2355 * @init_oh: struct omap_hwmod * (initiator)
2356 *
2357 * Add a sleep dependency between the initiator @init_oh and @oh.
2358 * Intended to be called by DSP/Bridge code via platform_data for the
2359 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
2360 * code needs to add/del initiator dependencies dynamically
2361 * before/after accessing a device. Returns the return value from
2362 * _add_initiator_dep().
2363 *
2364 * XXX Keep a usecount in the clockdomain code
2365 */
2366int omap_hwmod_add_initiator_dep(struct omap_hwmod *oh,
2367 struct omap_hwmod *init_oh)
2368{
2369 return _add_initiator_dep(oh, init_oh);
2370}
2371
2372/*
2373 * XXX what about functions for drivers to save/restore ocp_sysconfig
2374 * for context save/restore operations?
2375 */
2376
2377/**
2378 * omap_hwmod_del_initiator_dep - remove sleepdep from @init_oh to @oh
2379 * @oh: struct omap_hwmod *
2380 * @init_oh: struct omap_hwmod * (initiator)
2381 *
2382 * Remove a sleep dependency between the initiator @init_oh and @oh.
2383 * Intended to be called by DSP/Bridge code via platform_data for the
2384 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
2385 * code needs to add/del initiator dependencies dynamically
2386 * before/after accessing a device. Returns the return value from
2387 * _del_initiator_dep().
2388 *
2389 * XXX Keep a usecount in the clockdomain code
2390 */
2391int omap_hwmod_del_initiator_dep(struct omap_hwmod *oh,
2392 struct omap_hwmod *init_oh)
2393{
2394 return _del_initiator_dep(oh, init_oh);
2395}
2396
2397/**
2398 * omap_hwmod_enable_wakeup - allow device to wake up the system
2399 * @oh: struct omap_hwmod *
2400 *
2401 * Sets the module OCP socket ENAWAKEUP bit to allow the module to
2402 * send wakeups to the PRCM. Eventually this should sets PRCM wakeup
2403 * registers to cause the PRCM to receive wakeup events from the
2404 * module. Does not set any wakeup routing registers beyond this
2405 * point - if the module is to wake up any other module or subsystem,
2406 * that must be set separately. Called by omap_device code. Returns
2407 * -EINVAL on error or 0 upon success.
2408 */
2409int omap_hwmod_enable_wakeup(struct omap_hwmod *oh)
2410{
2411 unsigned long flags;
2412 u32 v;
2413
2414 if (!oh->class->sysc ||
2415 !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
2416 return -EINVAL;
2417
2418 spin_lock_irqsave(&oh->_lock, flags);
2419 v = oh->_sysc_cache;
2420 _enable_wakeup(oh, &v);
2421 _write_sysconfig(v, oh);
2422 spin_unlock_irqrestore(&oh->_lock, flags);
2423
2424 return 0;
2425}
2426
2427/**
2428 * omap_hwmod_disable_wakeup - prevent device from waking the system
2429 * @oh: struct omap_hwmod *
2430 *
2431 * Clears the module OCP socket ENAWAKEUP bit to prevent the module
2432 * from sending wakeups to the PRCM. Eventually this should clear
2433 * PRCM wakeup registers to cause the PRCM to ignore wakeup events
2434 * from the module. Does not set any wakeup routing registers beyond
2435 * this point - if the module is to wake up any other module or
2436 * subsystem, that must be set separately. Called by omap_device
2437 * code. Returns -EINVAL on error or 0 upon success.
2438 */
2439int omap_hwmod_disable_wakeup(struct omap_hwmod *oh)
2440{
2441 unsigned long flags;
2442 u32 v;
2443
2444 if (!oh->class->sysc ||
2445 !(oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP))
2446 return -EINVAL;
2447
2448 spin_lock_irqsave(&oh->_lock, flags);
2449 v = oh->_sysc_cache;
2450 _disable_wakeup(oh, &v);
2451 _write_sysconfig(v, oh);
2452 spin_unlock_irqrestore(&oh->_lock, flags);
2453
2454 return 0;
2455}
2456
2457/**
2458 * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
2459 * contained in the hwmod module.
2460 * @oh: struct omap_hwmod *
2461 * @name: name of the reset line to lookup and assert
2462 *
2463 * Some IP like dsp, ipu or iva contain processor that require
2464 * an HW reset line to be assert / deassert in order to enable fully
2465 * the IP. Returns -EINVAL if @oh is null or if the operation is not
2466 * yet supported on this OMAP; otherwise, passes along the return value
2467 * from _assert_hardreset().
2468 */
2469int omap_hwmod_assert_hardreset(struct omap_hwmod *oh, const char *name)
2470{
2471 int ret;
2472 unsigned long flags;
2473
2474 if (!oh)
2475 return -EINVAL;
2476
2477 spin_lock_irqsave(&oh->_lock, flags);
2478 ret = _assert_hardreset(oh, name);
2479 spin_unlock_irqrestore(&oh->_lock, flags);
2480
2481 return ret;
2482}
2483
2484/**
2485 * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
2486 * contained in the hwmod module.
2487 * @oh: struct omap_hwmod *
2488 * @name: name of the reset line to look up and deassert
2489 *
2490 * Some IP like dsp, ipu or iva contain processor that require
2491 * an HW reset line to be assert / deassert in order to enable fully
2492 * the IP. Returns -EINVAL if @oh is null or if the operation is not
2493 * yet supported on this OMAP; otherwise, passes along the return value
2494 * from _deassert_hardreset().
2495 */
2496int omap_hwmod_deassert_hardreset(struct omap_hwmod *oh, const char *name)
2497{
2498 int ret;
2499 unsigned long flags;
2500
2501 if (!oh)
2502 return -EINVAL;
2503
2504 spin_lock_irqsave(&oh->_lock, flags);
2505 ret = _deassert_hardreset(oh, name);
2506 spin_unlock_irqrestore(&oh->_lock, flags);
2507
2508 return ret;
2509}
2510
2511/**
2512 * omap_hwmod_read_hardreset - read the HW reset line state of submodules
2513 * contained in the hwmod module
2514 * @oh: struct omap_hwmod *
2515 * @name: name of the reset line to look up and read
2516 *
2517 * Return the current state of the hwmod @oh's reset line named @name:
2518 * returns -EINVAL upon parameter error or if this operation
2519 * is unsupported on the current OMAP; otherwise, passes along the return
2520 * value from _read_hardreset().
2521 */
2522int omap_hwmod_read_hardreset(struct omap_hwmod *oh, const char *name)
2523{
2524 int ret;
2525 unsigned long flags;
2526
2527 if (!oh)
2528 return -EINVAL;
2529
2530 spin_lock_irqsave(&oh->_lock, flags);
2531 ret = _read_hardreset(oh, name);
2532 spin_unlock_irqrestore(&oh->_lock, flags);
2533
2534 return ret;
2535}
2536
2537
2538/**
2539 * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
2540 * @classname: struct omap_hwmod_class name to search for
2541 * @fn: callback function pointer to call for each hwmod in class @classname
2542 * @user: arbitrary context data to pass to the callback function
2543 *
2544 * For each omap_hwmod of class @classname, call @fn.
2545 * If the callback function returns something other than
2546 * zero, the iterator is terminated, and the callback function's return
2547 * value is passed back to the caller. Returns 0 upon success, -EINVAL
2548 * if @classname or @fn are NULL, or passes back the error code from @fn.
2549 */
2550int omap_hwmod_for_each_by_class(const char *classname,
2551 int (*fn)(struct omap_hwmod *oh,
2552 void *user),
2553 void *user)
2554{
2555 struct omap_hwmod *temp_oh;
2556 int ret = 0;
2557
2558 if (!classname || !fn)
2559 return -EINVAL;
2560
2561 pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
2562 __func__, classname);
2563
2564 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
2565 if (!strcmp(temp_oh->class->name, classname)) {
2566 pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
2567 __func__, temp_oh->name);
2568 ret = (*fn)(temp_oh, user);
2569 if (ret)
2570 break;
2571 }
2572 }
2573
2574 if (ret)
2575 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
2576 __func__, ret);
2577
2578 return ret;
2579}
2580
2581/**
2582 * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
2583 * @oh: struct omap_hwmod *
2584 * @state: state that _setup() should leave the hwmod in
2585 *
2586 * Sets the hwmod state that @oh will enter at the end of _setup()
2587 * (called by omap_hwmod_setup_*()). Only valid to call between
2588 * calling omap_hwmod_register() and omap_hwmod_setup_*(). Returns
2589 * 0 upon success or -EINVAL if there is a problem with the arguments
2590 * or if the hwmod is in the wrong state.
2591 */
2592int omap_hwmod_set_postsetup_state(struct omap_hwmod *oh, u8 state)
2593{
2594 int ret;
2595 unsigned long flags;
2596
2597 if (!oh)
2598 return -EINVAL;
2599
2600 if (state != _HWMOD_STATE_DISABLED &&
2601 state != _HWMOD_STATE_ENABLED &&
2602 state != _HWMOD_STATE_IDLE)
2603 return -EINVAL;
2604
2605 spin_lock_irqsave(&oh->_lock, flags);
2606
2607 if (oh->_state != _HWMOD_STATE_REGISTERED) {
2608 ret = -EINVAL;
2609 goto ohsps_unlock;
2610 }
2611
2612 oh->_postsetup_state = state;
2613 ret = 0;
2614
2615ohsps_unlock:
2616 spin_unlock_irqrestore(&oh->_lock, flags);
2617
2618 return ret;
2619}
2620
2621/**
2622 * omap_hwmod_get_context_loss_count - get lost context count
2623 * @oh: struct omap_hwmod *
2624 *
2625 * Query the powerdomain of of @oh to get the context loss
2626 * count for this device.
2627 *
2628 * Returns the context loss count of the powerdomain assocated with @oh
2629 * upon success, or zero if no powerdomain exists for @oh.
2630 */
2631u32 omap_hwmod_get_context_loss_count(struct omap_hwmod *oh)
2632{
2633 struct powerdomain *pwrdm;
2634 int ret = 0;
2635
2636 pwrdm = omap_hwmod_get_pwrdm(oh);
2637 if (pwrdm)
2638 ret = pwrdm_get_context_loss_count(pwrdm);
2639
2640 return ret;
2641}
2642
2643/**
2644 * omap_hwmod_no_setup_reset - prevent a hwmod from being reset upon setup
2645 * @oh: struct omap_hwmod *
2646 *
2647 * Prevent the hwmod @oh from being reset during the setup process.
2648 * Intended for use by board-*.c files on boards with devices that
2649 * cannot tolerate being reset. Must be called before the hwmod has
2650 * been set up. Returns 0 upon success or negative error code upon
2651 * failure.
2652 */
2653int omap_hwmod_no_setup_reset(struct omap_hwmod *oh)
2654{
2655 if (!oh)
2656 return -EINVAL;
2657
2658 if (oh->_state != _HWMOD_STATE_REGISTERED) {
2659 pr_err("omap_hwmod: %s: cannot prevent setup reset; in wrong state\n",
2660 oh->name);
2661 return -EINVAL;
2662 }
2663
2664 oh->flags |= HWMOD_INIT_NO_RESET;
2665
2666 return 0;
2667}
1/*
2 * omap_hwmod implementation for OMAP2/3/4
3 *
4 * Copyright (C) 2009-2011 Nokia Corporation
5 * Copyright (C) 2011-2012 Texas Instruments, Inc.
6 *
7 * Paul Walmsley, Benoît Cousson, Kevin Hilman
8 *
9 * Created in collaboration with (alphabetical order): Thara Gopinath,
10 * Tony Lindgren, Rajendra Nayak, Vikram Pandita, Sakari Poussa, Anand
11 * Sawant, Santosh Shilimkar, Richard Woodruff
12 *
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License version 2 as
15 * published by the Free Software Foundation.
16 *
17 * Introduction
18 * ------------
19 * One way to view an OMAP SoC is as a collection of largely unrelated
20 * IP blocks connected by interconnects. The IP blocks include
21 * devices such as ARM processors, audio serial interfaces, UARTs,
22 * etc. Some of these devices, like the DSP, are created by TI;
23 * others, like the SGX, largely originate from external vendors. In
24 * TI's documentation, on-chip devices are referred to as "OMAP
25 * modules." Some of these IP blocks are identical across several
26 * OMAP versions. Others are revised frequently.
27 *
28 * These OMAP modules are tied together by various interconnects.
29 * Most of the address and data flow between modules is via OCP-based
30 * interconnects such as the L3 and L4 buses; but there are other
31 * interconnects that distribute the hardware clock tree, handle idle
32 * and reset signaling, supply power, and connect the modules to
33 * various pads or balls on the OMAP package.
34 *
35 * OMAP hwmod provides a consistent way to describe the on-chip
36 * hardware blocks and their integration into the rest of the chip.
37 * This description can be automatically generated from the TI
38 * hardware database. OMAP hwmod provides a standard, consistent API
39 * to reset, enable, idle, and disable these hardware blocks. And
40 * hwmod provides a way for other core code, such as the Linux device
41 * code or the OMAP power management and address space mapping code,
42 * to query the hardware database.
43 *
44 * Using hwmod
45 * -----------
46 * Drivers won't call hwmod functions directly. That is done by the
47 * omap_device code, and in rare occasions, by custom integration code
48 * in arch/arm/ *omap*. The omap_device code includes functions to
49 * build a struct platform_device using omap_hwmod data, and that is
50 * currently how hwmod data is communicated to drivers and to the
51 * Linux driver model. Most drivers will call omap_hwmod functions only
52 * indirectly, via pm_runtime*() functions.
53 *
54 * From a layering perspective, here is where the OMAP hwmod code
55 * fits into the kernel software stack:
56 *
57 * +-------------------------------+
58 * | Device driver code |
59 * | (e.g., drivers/) |
60 * +-------------------------------+
61 * | Linux driver model |
62 * | (platform_device / |
63 * | platform_driver data/code) |
64 * +-------------------------------+
65 * | OMAP core-driver integration |
66 * |(arch/arm/mach-omap2/devices.c)|
67 * +-------------------------------+
68 * | omap_device code |
69 * | (../plat-omap/omap_device.c) |
70 * +-------------------------------+
71 * ----> | omap_hwmod code/data | <-----
72 * | (../mach-omap2/omap_hwmod*) |
73 * +-------------------------------+
74 * | OMAP clock/PRCM/register fns |
75 * | (__raw_{read,write}l, clk*) |
76 * +-------------------------------+
77 *
78 * Device drivers should not contain any OMAP-specific code or data in
79 * them. They should only contain code to operate the IP block that
80 * the driver is responsible for. This is because these IP blocks can
81 * also appear in other SoCs, either from TI (such as DaVinci) or from
82 * other manufacturers; and drivers should be reusable across other
83 * platforms.
84 *
85 * The OMAP hwmod code also will attempt to reset and idle all on-chip
86 * devices upon boot. The goal here is for the kernel to be
87 * completely self-reliant and independent from bootloaders. This is
88 * to ensure a repeatable configuration, both to ensure consistent
89 * runtime behavior, and to make it easier for others to reproduce
90 * bugs.
91 *
92 * OMAP module activity states
93 * ---------------------------
94 * The hwmod code considers modules to be in one of several activity
95 * states. IP blocks start out in an UNKNOWN state, then once they
96 * are registered via the hwmod code, proceed to the REGISTERED state.
97 * Once their clock names are resolved to clock pointers, the module
98 * enters the CLKS_INITED state; and finally, once the module has been
99 * reset and the integration registers programmed, the INITIALIZED state
100 * is entered. The hwmod code will then place the module into either
101 * the IDLE state to save power, or in the case of a critical system
102 * module, the ENABLED state.
103 *
104 * OMAP core integration code can then call omap_hwmod*() functions
105 * directly to move the module between the IDLE, ENABLED, and DISABLED
106 * states, as needed. This is done during both the PM idle loop, and
107 * in the OMAP core integration code's implementation of the PM runtime
108 * functions.
109 *
110 * References
111 * ----------
112 * This is a partial list.
113 * - OMAP2420 Multimedia Processor Silicon Revision 2.1.1, 2.2 (SWPU064)
114 * - OMAP2430 Multimedia Device POP Silicon Revision 2.1 (SWPU090)
115 * - OMAP34xx Multimedia Device Silicon Revision 3.1 (SWPU108)
116 * - OMAP4430 Multimedia Device Silicon Revision 1.0 (SWPU140)
117 * - Open Core Protocol Specification 2.2
118 *
119 * To do:
120 * - handle IO mapping
121 * - bus throughput & module latency measurement code
122 *
123 * XXX add tests at the beginning of each function to ensure the hwmod is
124 * in the appropriate state
125 * XXX error return values should be checked to ensure that they are
126 * appropriate
127 */
128#undef DEBUG
129
130#include <linux/kernel.h>
131#include <linux/errno.h>
132#include <linux/io.h>
133#include <linux/clk.h>
134#include <linux/delay.h>
135#include <linux/err.h>
136#include <linux/list.h>
137#include <linux/mutex.h>
138#include <linux/spinlock.h>
139#include <linux/slab.h>
140#include <linux/bootmem.h>
141
142#include "common.h"
143#include <plat/cpu.h>
144#include "clockdomain.h"
145#include "powerdomain.h"
146#include <plat/clock.h>
147#include <plat/omap_hwmod.h>
148#include <plat/prcm.h>
149
150#include "cm2xxx_3xxx.h"
151#include "cminst44xx.h"
152#include "prm2xxx_3xxx.h"
153#include "prm44xx.h"
154#include "prminst44xx.h"
155#include "mux.h"
156
157/* Maximum microseconds to wait for OMAP module to softreset */
158#define MAX_MODULE_SOFTRESET_WAIT 10000
159
160/* Name of the OMAP hwmod for the MPU */
161#define MPU_INITIATOR_NAME "mpu"
162
163/*
164 * Number of struct omap_hwmod_link records per struct
165 * omap_hwmod_ocp_if record (master->slave and slave->master)
166 */
167#define LINKS_PER_OCP_IF 2
168
169/* omap_hwmod_list contains all registered struct omap_hwmods */
170static LIST_HEAD(omap_hwmod_list);
171
172/* mpu_oh: used to add/remove MPU initiator from sleepdep list */
173static struct omap_hwmod *mpu_oh;
174
175/*
176 * linkspace: ptr to a buffer that struct omap_hwmod_link records are
177 * allocated from - used to reduce the number of small memory
178 * allocations, which has a significant impact on performance
179 */
180static struct omap_hwmod_link *linkspace;
181
182/*
183 * free_ls, max_ls: array indexes into linkspace; representing the
184 * next free struct omap_hwmod_link index, and the maximum number of
185 * struct omap_hwmod_link records allocated (respectively)
186 */
187static unsigned short free_ls, max_ls, ls_supp;
188
189/* Private functions */
190
191/**
192 * _fetch_next_ocp_if - return the next OCP interface in a list
193 * @p: ptr to a ptr to the list_head inside the ocp_if to return
194 * @i: pointer to the index of the element pointed to by @p in the list
195 *
196 * Return a pointer to the struct omap_hwmod_ocp_if record
197 * containing the struct list_head pointed to by @p, and increment
198 * @p such that a future call to this routine will return the next
199 * record.
200 */
201static struct omap_hwmod_ocp_if *_fetch_next_ocp_if(struct list_head **p,
202 int *i)
203{
204 struct omap_hwmod_ocp_if *oi;
205
206 oi = list_entry(*p, struct omap_hwmod_link, node)->ocp_if;
207 *p = (*p)->next;
208
209 *i = *i + 1;
210
211 return oi;
212}
213
214/**
215 * _update_sysc_cache - return the module OCP_SYSCONFIG register, keep copy
216 * @oh: struct omap_hwmod *
217 *
218 * Load the current value of the hwmod OCP_SYSCONFIG register into the
219 * struct omap_hwmod for later use. Returns -EINVAL if the hwmod has no
220 * OCP_SYSCONFIG register or 0 upon success.
221 */
222static int _update_sysc_cache(struct omap_hwmod *oh)
223{
224 if (!oh->class->sysc) {
225 WARN(1, "omap_hwmod: %s: cannot read OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
226 return -EINVAL;
227 }
228
229 /* XXX ensure module interface clock is up */
230
231 oh->_sysc_cache = omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
232
233 if (!(oh->class->sysc->sysc_flags & SYSC_NO_CACHE))
234 oh->_int_flags |= _HWMOD_SYSCONFIG_LOADED;
235
236 return 0;
237}
238
239/**
240 * _write_sysconfig - write a value to the module's OCP_SYSCONFIG register
241 * @v: OCP_SYSCONFIG value to write
242 * @oh: struct omap_hwmod *
243 *
244 * Write @v into the module class' OCP_SYSCONFIG register, if it has
245 * one. No return value.
246 */
247static void _write_sysconfig(u32 v, struct omap_hwmod *oh)
248{
249 if (!oh->class->sysc) {
250 WARN(1, "omap_hwmod: %s: cannot write OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
251 return;
252 }
253
254 /* XXX ensure module interface clock is up */
255
256 /* Module might have lost context, always update cache and register */
257 oh->_sysc_cache = v;
258 omap_hwmod_write(v, oh, oh->class->sysc->sysc_offs);
259}
260
261/**
262 * _set_master_standbymode: set the OCP_SYSCONFIG MIDLEMODE field in @v
263 * @oh: struct omap_hwmod *
264 * @standbymode: MIDLEMODE field bits
265 * @v: pointer to register contents to modify
266 *
267 * Update the master standby mode bits in @v to be @standbymode for
268 * the @oh hwmod. Does not write to the hardware. Returns -EINVAL
269 * upon error or 0 upon success.
270 */
271static int _set_master_standbymode(struct omap_hwmod *oh, u8 standbymode,
272 u32 *v)
273{
274 u32 mstandby_mask;
275 u8 mstandby_shift;
276
277 if (!oh->class->sysc ||
278 !(oh->class->sysc->sysc_flags & SYSC_HAS_MIDLEMODE))
279 return -EINVAL;
280
281 if (!oh->class->sysc->sysc_fields) {
282 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
283 return -EINVAL;
284 }
285
286 mstandby_shift = oh->class->sysc->sysc_fields->midle_shift;
287 mstandby_mask = (0x3 << mstandby_shift);
288
289 *v &= ~mstandby_mask;
290 *v |= __ffs(standbymode) << mstandby_shift;
291
292 return 0;
293}
294
295/**
296 * _set_slave_idlemode: set the OCP_SYSCONFIG SIDLEMODE field in @v
297 * @oh: struct omap_hwmod *
298 * @idlemode: SIDLEMODE field bits
299 * @v: pointer to register contents to modify
300 *
301 * Update the slave idle mode bits in @v to be @idlemode for the @oh
302 * hwmod. Does not write to the hardware. Returns -EINVAL upon error
303 * or 0 upon success.
304 */
305static int _set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode, u32 *v)
306{
307 u32 sidle_mask;
308 u8 sidle_shift;
309
310 if (!oh->class->sysc ||
311 !(oh->class->sysc->sysc_flags & SYSC_HAS_SIDLEMODE))
312 return -EINVAL;
313
314 if (!oh->class->sysc->sysc_fields) {
315 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
316 return -EINVAL;
317 }
318
319 sidle_shift = oh->class->sysc->sysc_fields->sidle_shift;
320 sidle_mask = (0x3 << sidle_shift);
321
322 *v &= ~sidle_mask;
323 *v |= __ffs(idlemode) << sidle_shift;
324
325 return 0;
326}
327
328/**
329 * _set_clockactivity: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
330 * @oh: struct omap_hwmod *
331 * @clockact: CLOCKACTIVITY field bits
332 * @v: pointer to register contents to modify
333 *
334 * Update the clockactivity mode bits in @v to be @clockact for the
335 * @oh hwmod. Used for additional powersaving on some modules. Does
336 * not write to the hardware. Returns -EINVAL upon error or 0 upon
337 * success.
338 */
339static int _set_clockactivity(struct omap_hwmod *oh, u8 clockact, u32 *v)
340{
341 u32 clkact_mask;
342 u8 clkact_shift;
343
344 if (!oh->class->sysc ||
345 !(oh->class->sysc->sysc_flags & SYSC_HAS_CLOCKACTIVITY))
346 return -EINVAL;
347
348 if (!oh->class->sysc->sysc_fields) {
349 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
350 return -EINVAL;
351 }
352
353 clkact_shift = oh->class->sysc->sysc_fields->clkact_shift;
354 clkact_mask = (0x3 << clkact_shift);
355
356 *v &= ~clkact_mask;
357 *v |= clockact << clkact_shift;
358
359 return 0;
360}
361
362/**
363 * _set_softreset: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
364 * @oh: struct omap_hwmod *
365 * @v: pointer to register contents to modify
366 *
367 * Set the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
368 * error or 0 upon success.
369 */
370static int _set_softreset(struct omap_hwmod *oh, u32 *v)
371{
372 u32 softrst_mask;
373
374 if (!oh->class->sysc ||
375 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
376 return -EINVAL;
377
378 if (!oh->class->sysc->sysc_fields) {
379 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
380 return -EINVAL;
381 }
382
383 softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
384
385 *v |= softrst_mask;
386
387 return 0;
388}
389
390/**
391 * _set_module_autoidle: set the OCP_SYSCONFIG AUTOIDLE field in @v
392 * @oh: struct omap_hwmod *
393 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
394 * @v: pointer to register contents to modify
395 *
396 * Update the module autoidle bit in @v to be @autoidle for the @oh
397 * hwmod. The autoidle bit controls whether the module can gate
398 * internal clocks automatically when it isn't doing anything; the
399 * exact function of this bit varies on a per-module basis. This
400 * function does not write to the hardware. Returns -EINVAL upon
401 * error or 0 upon success.
402 */
403static int _set_module_autoidle(struct omap_hwmod *oh, u8 autoidle,
404 u32 *v)
405{
406 u32 autoidle_mask;
407 u8 autoidle_shift;
408
409 if (!oh->class->sysc ||
410 !(oh->class->sysc->sysc_flags & SYSC_HAS_AUTOIDLE))
411 return -EINVAL;
412
413 if (!oh->class->sysc->sysc_fields) {
414 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
415 return -EINVAL;
416 }
417
418 autoidle_shift = oh->class->sysc->sysc_fields->autoidle_shift;
419 autoidle_mask = (0x1 << autoidle_shift);
420
421 *v &= ~autoidle_mask;
422 *v |= autoidle << autoidle_shift;
423
424 return 0;
425}
426
427/**
428 * _set_idle_ioring_wakeup - enable/disable IO pad wakeup on hwmod idle for mux
429 * @oh: struct omap_hwmod *
430 * @set_wake: bool value indicating to set (true) or clear (false) wakeup enable
431 *
432 * Set or clear the I/O pad wakeup flag in the mux entries for the
433 * hwmod @oh. This function changes the @oh->mux->pads_dynamic array
434 * in memory. If the hwmod is currently idled, and the new idle
435 * values don't match the previous ones, this function will also
436 * update the SCM PADCTRL registers. Otherwise, if the hwmod is not
437 * currently idled, this function won't touch the hardware: the new
438 * mux settings are written to the SCM PADCTRL registers when the
439 * hwmod is idled. No return value.
440 */
441static void _set_idle_ioring_wakeup(struct omap_hwmod *oh, bool set_wake)
442{
443 struct omap_device_pad *pad;
444 bool change = false;
445 u16 prev_idle;
446 int j;
447
448 if (!oh->mux || !oh->mux->enabled)
449 return;
450
451 for (j = 0; j < oh->mux->nr_pads_dynamic; j++) {
452 pad = oh->mux->pads_dynamic[j];
453
454 if (!(pad->flags & OMAP_DEVICE_PAD_WAKEUP))
455 continue;
456
457 prev_idle = pad->idle;
458
459 if (set_wake)
460 pad->idle |= OMAP_WAKEUP_EN;
461 else
462 pad->idle &= ~OMAP_WAKEUP_EN;
463
464 if (prev_idle != pad->idle)
465 change = true;
466 }
467
468 if (change && oh->_state == _HWMOD_STATE_IDLE)
469 omap_hwmod_mux(oh->mux, _HWMOD_STATE_IDLE);
470}
471
472/**
473 * _enable_wakeup: set OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
474 * @oh: struct omap_hwmod *
475 *
476 * Allow the hardware module @oh to send wakeups. Returns -EINVAL
477 * upon error or 0 upon success.
478 */
479static int _enable_wakeup(struct omap_hwmod *oh, u32 *v)
480{
481 if (!oh->class->sysc ||
482 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
483 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
484 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
485 return -EINVAL;
486
487 if (!oh->class->sysc->sysc_fields) {
488 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
489 return -EINVAL;
490 }
491
492 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
493 *v |= 0x1 << oh->class->sysc->sysc_fields->enwkup_shift;
494
495 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
496 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
497 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
498 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
499
500 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
501
502 oh->_int_flags |= _HWMOD_WAKEUP_ENABLED;
503
504 return 0;
505}
506
507/**
508 * _disable_wakeup: clear OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
509 * @oh: struct omap_hwmod *
510 *
511 * Prevent the hardware module @oh to send wakeups. Returns -EINVAL
512 * upon error or 0 upon success.
513 */
514static int _disable_wakeup(struct omap_hwmod *oh, u32 *v)
515{
516 if (!oh->class->sysc ||
517 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
518 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
519 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
520 return -EINVAL;
521
522 if (!oh->class->sysc->sysc_fields) {
523 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
524 return -EINVAL;
525 }
526
527 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
528 *v &= ~(0x1 << oh->class->sysc->sysc_fields->enwkup_shift);
529
530 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
531 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART, v);
532 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
533 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART, v);
534
535 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
536
537 oh->_int_flags &= ~_HWMOD_WAKEUP_ENABLED;
538
539 return 0;
540}
541
542/**
543 * _add_initiator_dep: prevent @oh from smart-idling while @init_oh is active
544 * @oh: struct omap_hwmod *
545 *
546 * Prevent the hardware module @oh from entering idle while the
547 * hardare module initiator @init_oh is active. Useful when a module
548 * will be accessed by a particular initiator (e.g., if a module will
549 * be accessed by the IVA, there should be a sleepdep between the IVA
550 * initiator and the module). Only applies to modules in smart-idle
551 * mode. If the clockdomain is marked as not needing autodeps, return
552 * 0 without doing anything. Otherwise, returns -EINVAL upon error or
553 * passes along clkdm_add_sleepdep() value upon success.
554 */
555static int _add_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
556{
557 if (!oh->_clk)
558 return -EINVAL;
559
560 if (oh->_clk->clkdm && oh->_clk->clkdm->flags & CLKDM_NO_AUTODEPS)
561 return 0;
562
563 return clkdm_add_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
564}
565
566/**
567 * _del_initiator_dep: allow @oh to smart-idle even if @init_oh is active
568 * @oh: struct omap_hwmod *
569 *
570 * Allow the hardware module @oh to enter idle while the hardare
571 * module initiator @init_oh is active. Useful when a module will not
572 * be accessed by a particular initiator (e.g., if a module will not
573 * be accessed by the IVA, there should be no sleepdep between the IVA
574 * initiator and the module). Only applies to modules in smart-idle
575 * mode. If the clockdomain is marked as not needing autodeps, return
576 * 0 without doing anything. Returns -EINVAL upon error or passes
577 * along clkdm_del_sleepdep() value upon success.
578 */
579static int _del_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
580{
581 if (!oh->_clk)
582 return -EINVAL;
583
584 if (oh->_clk->clkdm && oh->_clk->clkdm->flags & CLKDM_NO_AUTODEPS)
585 return 0;
586
587 return clkdm_del_sleepdep(oh->_clk->clkdm, init_oh->_clk->clkdm);
588}
589
590/**
591 * _init_main_clk - get a struct clk * for the the hwmod's main functional clk
592 * @oh: struct omap_hwmod *
593 *
594 * Called from _init_clocks(). Populates the @oh _clk (main
595 * functional clock pointer) if a main_clk is present. Returns 0 on
596 * success or -EINVAL on error.
597 */
598static int _init_main_clk(struct omap_hwmod *oh)
599{
600 int ret = 0;
601
602 if (!oh->main_clk)
603 return 0;
604
605 oh->_clk = omap_clk_get_by_name(oh->main_clk);
606 if (!oh->_clk) {
607 pr_warning("omap_hwmod: %s: cannot clk_get main_clk %s\n",
608 oh->name, oh->main_clk);
609 return -EINVAL;
610 }
611
612 if (!oh->_clk->clkdm)
613 pr_warning("omap_hwmod: %s: missing clockdomain for %s.\n",
614 oh->main_clk, oh->_clk->name);
615
616 return ret;
617}
618
619/**
620 * _init_interface_clks - get a struct clk * for the the hwmod's interface clks
621 * @oh: struct omap_hwmod *
622 *
623 * Called from _init_clocks(). Populates the @oh OCP slave interface
624 * clock pointers. Returns 0 on success or -EINVAL on error.
625 */
626static int _init_interface_clks(struct omap_hwmod *oh)
627{
628 struct omap_hwmod_ocp_if *os;
629 struct list_head *p;
630 struct clk *c;
631 int i = 0;
632 int ret = 0;
633
634 p = oh->slave_ports.next;
635
636 while (i < oh->slaves_cnt) {
637 os = _fetch_next_ocp_if(&p, &i);
638 if (!os->clk)
639 continue;
640
641 c = omap_clk_get_by_name(os->clk);
642 if (!c) {
643 pr_warning("omap_hwmod: %s: cannot clk_get interface_clk %s\n",
644 oh->name, os->clk);
645 ret = -EINVAL;
646 }
647 os->_clk = c;
648 }
649
650 return ret;
651}
652
653/**
654 * _init_opt_clk - get a struct clk * for the the hwmod's optional clocks
655 * @oh: struct omap_hwmod *
656 *
657 * Called from _init_clocks(). Populates the @oh omap_hwmod_opt_clk
658 * clock pointers. Returns 0 on success or -EINVAL on error.
659 */
660static int _init_opt_clks(struct omap_hwmod *oh)
661{
662 struct omap_hwmod_opt_clk *oc;
663 struct clk *c;
664 int i;
665 int ret = 0;
666
667 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++) {
668 c = omap_clk_get_by_name(oc->clk);
669 if (!c) {
670 pr_warning("omap_hwmod: %s: cannot clk_get opt_clk %s\n",
671 oh->name, oc->clk);
672 ret = -EINVAL;
673 }
674 oc->_clk = c;
675 }
676
677 return ret;
678}
679
680/**
681 * _enable_clocks - enable hwmod main clock and interface clocks
682 * @oh: struct omap_hwmod *
683 *
684 * Enables all clocks necessary for register reads and writes to succeed
685 * on the hwmod @oh. Returns 0.
686 */
687static int _enable_clocks(struct omap_hwmod *oh)
688{
689 struct omap_hwmod_ocp_if *os;
690 struct list_head *p;
691 int i = 0;
692
693 pr_debug("omap_hwmod: %s: enabling clocks\n", oh->name);
694
695 if (oh->_clk)
696 clk_enable(oh->_clk);
697
698 p = oh->slave_ports.next;
699
700 while (i < oh->slaves_cnt) {
701 os = _fetch_next_ocp_if(&p, &i);
702
703 if (os->_clk && (os->flags & OCPIF_SWSUP_IDLE))
704 clk_enable(os->_clk);
705 }
706
707 /* The opt clocks are controlled by the device driver. */
708
709 return 0;
710}
711
712/**
713 * _disable_clocks - disable hwmod main clock and interface clocks
714 * @oh: struct omap_hwmod *
715 *
716 * Disables the hwmod @oh main functional and interface clocks. Returns 0.
717 */
718static int _disable_clocks(struct omap_hwmod *oh)
719{
720 struct omap_hwmod_ocp_if *os;
721 struct list_head *p;
722 int i = 0;
723
724 pr_debug("omap_hwmod: %s: disabling clocks\n", oh->name);
725
726 if (oh->_clk)
727 clk_disable(oh->_clk);
728
729 p = oh->slave_ports.next;
730
731 while (i < oh->slaves_cnt) {
732 os = _fetch_next_ocp_if(&p, &i);
733
734 if (os->_clk && (os->flags & OCPIF_SWSUP_IDLE))
735 clk_disable(os->_clk);
736 }
737
738 /* The opt clocks are controlled by the device driver. */
739
740 return 0;
741}
742
743static void _enable_optional_clocks(struct omap_hwmod *oh)
744{
745 struct omap_hwmod_opt_clk *oc;
746 int i;
747
748 pr_debug("omap_hwmod: %s: enabling optional clocks\n", oh->name);
749
750 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
751 if (oc->_clk) {
752 pr_debug("omap_hwmod: enable %s:%s\n", oc->role,
753 oc->_clk->name);
754 clk_enable(oc->_clk);
755 }
756}
757
758static void _disable_optional_clocks(struct omap_hwmod *oh)
759{
760 struct omap_hwmod_opt_clk *oc;
761 int i;
762
763 pr_debug("omap_hwmod: %s: disabling optional clocks\n", oh->name);
764
765 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
766 if (oc->_clk) {
767 pr_debug("omap_hwmod: disable %s:%s\n", oc->role,
768 oc->_clk->name);
769 clk_disable(oc->_clk);
770 }
771}
772
773/**
774 * _enable_module - enable CLKCTRL modulemode on OMAP4
775 * @oh: struct omap_hwmod *
776 *
777 * Enables the PRCM module mode related to the hwmod @oh.
778 * No return value.
779 */
780static void _enable_module(struct omap_hwmod *oh)
781{
782 /* The module mode does not exist prior OMAP4 */
783 if (cpu_is_omap24xx() || cpu_is_omap34xx())
784 return;
785
786 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
787 return;
788
789 pr_debug("omap_hwmod: %s: _enable_module: %d\n",
790 oh->name, oh->prcm.omap4.modulemode);
791
792 omap4_cminst_module_enable(oh->prcm.omap4.modulemode,
793 oh->clkdm->prcm_partition,
794 oh->clkdm->cm_inst,
795 oh->clkdm->clkdm_offs,
796 oh->prcm.omap4.clkctrl_offs);
797}
798
799/**
800 * _omap4_wait_target_disable - wait for a module to be disabled on OMAP4
801 * @oh: struct omap_hwmod *
802 *
803 * Wait for a module @oh to enter slave idle. Returns 0 if the module
804 * does not have an IDLEST bit or if the module successfully enters
805 * slave idle; otherwise, pass along the return value of the
806 * appropriate *_cm*_wait_module_idle() function.
807 */
808static int _omap4_wait_target_disable(struct omap_hwmod *oh)
809{
810 if (!cpu_is_omap44xx())
811 return 0;
812
813 if (!oh)
814 return -EINVAL;
815
816 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
817 return 0;
818
819 if (oh->flags & HWMOD_NO_IDLEST)
820 return 0;
821
822 return omap4_cminst_wait_module_idle(oh->clkdm->prcm_partition,
823 oh->clkdm->cm_inst,
824 oh->clkdm->clkdm_offs,
825 oh->prcm.omap4.clkctrl_offs);
826}
827
828/**
829 * _count_mpu_irqs - count the number of MPU IRQ lines associated with @oh
830 * @oh: struct omap_hwmod *oh
831 *
832 * Count and return the number of MPU IRQs associated with the hwmod
833 * @oh. Used to allocate struct resource data. Returns 0 if @oh is
834 * NULL.
835 */
836static int _count_mpu_irqs(struct omap_hwmod *oh)
837{
838 struct omap_hwmod_irq_info *ohii;
839 int i = 0;
840
841 if (!oh || !oh->mpu_irqs)
842 return 0;
843
844 do {
845 ohii = &oh->mpu_irqs[i++];
846 } while (ohii->irq != -1);
847
848 return i-1;
849}
850
851/**
852 * _count_sdma_reqs - count the number of SDMA request lines associated with @oh
853 * @oh: struct omap_hwmod *oh
854 *
855 * Count and return the number of SDMA request lines associated with
856 * the hwmod @oh. Used to allocate struct resource data. Returns 0
857 * if @oh is NULL.
858 */
859static int _count_sdma_reqs(struct omap_hwmod *oh)
860{
861 struct omap_hwmod_dma_info *ohdi;
862 int i = 0;
863
864 if (!oh || !oh->sdma_reqs)
865 return 0;
866
867 do {
868 ohdi = &oh->sdma_reqs[i++];
869 } while (ohdi->dma_req != -1);
870
871 return i-1;
872}
873
874/**
875 * _count_ocp_if_addr_spaces - count the number of address space entries for @oh
876 * @oh: struct omap_hwmod *oh
877 *
878 * Count and return the number of address space ranges associated with
879 * the hwmod @oh. Used to allocate struct resource data. Returns 0
880 * if @oh is NULL.
881 */
882static int _count_ocp_if_addr_spaces(struct omap_hwmod_ocp_if *os)
883{
884 struct omap_hwmod_addr_space *mem;
885 int i = 0;
886
887 if (!os || !os->addr)
888 return 0;
889
890 do {
891 mem = &os->addr[i++];
892 } while (mem->pa_start != mem->pa_end);
893
894 return i-1;
895}
896
897/**
898 * _get_mpu_irq_by_name - fetch MPU interrupt line number by name
899 * @oh: struct omap_hwmod * to operate on
900 * @name: pointer to the name of the MPU interrupt number to fetch (optional)
901 * @irq: pointer to an unsigned int to store the MPU IRQ number to
902 *
903 * Retrieve a MPU hardware IRQ line number named by @name associated
904 * with the IP block pointed to by @oh. The IRQ number will be filled
905 * into the address pointed to by @dma. When @name is non-null, the
906 * IRQ line number associated with the named entry will be returned.
907 * If @name is null, the first matching entry will be returned. Data
908 * order is not meaningful in hwmod data, so callers are strongly
909 * encouraged to use a non-null @name whenever possible to avoid
910 * unpredictable effects if hwmod data is later added that causes data
911 * ordering to change. Returns 0 upon success or a negative error
912 * code upon error.
913 */
914static int _get_mpu_irq_by_name(struct omap_hwmod *oh, const char *name,
915 unsigned int *irq)
916{
917 int i;
918 bool found = false;
919
920 if (!oh->mpu_irqs)
921 return -ENOENT;
922
923 i = 0;
924 while (oh->mpu_irqs[i].irq != -1) {
925 if (name == oh->mpu_irqs[i].name ||
926 !strcmp(name, oh->mpu_irqs[i].name)) {
927 found = true;
928 break;
929 }
930 i++;
931 }
932
933 if (!found)
934 return -ENOENT;
935
936 *irq = oh->mpu_irqs[i].irq;
937
938 return 0;
939}
940
941/**
942 * _get_sdma_req_by_name - fetch SDMA request line ID by name
943 * @oh: struct omap_hwmod * to operate on
944 * @name: pointer to the name of the SDMA request line to fetch (optional)
945 * @dma: pointer to an unsigned int to store the request line ID to
946 *
947 * Retrieve an SDMA request line ID named by @name on the IP block
948 * pointed to by @oh. The ID will be filled into the address pointed
949 * to by @dma. When @name is non-null, the request line ID associated
950 * with the named entry will be returned. If @name is null, the first
951 * matching entry will be returned. Data order is not meaningful in
952 * hwmod data, so callers are strongly encouraged to use a non-null
953 * @name whenever possible to avoid unpredictable effects if hwmod
954 * data is later added that causes data ordering to change. Returns 0
955 * upon success or a negative error code upon error.
956 */
957static int _get_sdma_req_by_name(struct omap_hwmod *oh, const char *name,
958 unsigned int *dma)
959{
960 int i;
961 bool found = false;
962
963 if (!oh->sdma_reqs)
964 return -ENOENT;
965
966 i = 0;
967 while (oh->sdma_reqs[i].dma_req != -1) {
968 if (name == oh->sdma_reqs[i].name ||
969 !strcmp(name, oh->sdma_reqs[i].name)) {
970 found = true;
971 break;
972 }
973 i++;
974 }
975
976 if (!found)
977 return -ENOENT;
978
979 *dma = oh->sdma_reqs[i].dma_req;
980
981 return 0;
982}
983
984/**
985 * _get_addr_space_by_name - fetch address space start & end by name
986 * @oh: struct omap_hwmod * to operate on
987 * @name: pointer to the name of the address space to fetch (optional)
988 * @pa_start: pointer to a u32 to store the starting address to
989 * @pa_end: pointer to a u32 to store the ending address to
990 *
991 * Retrieve address space start and end addresses for the IP block
992 * pointed to by @oh. The data will be filled into the addresses
993 * pointed to by @pa_start and @pa_end. When @name is non-null, the
994 * address space data associated with the named entry will be
995 * returned. If @name is null, the first matching entry will be
996 * returned. Data order is not meaningful in hwmod data, so callers
997 * are strongly encouraged to use a non-null @name whenever possible
998 * to avoid unpredictable effects if hwmod data is later added that
999 * causes data ordering to change. Returns 0 upon success or a
1000 * negative error code upon error.
1001 */
1002static int _get_addr_space_by_name(struct omap_hwmod *oh, const char *name,
1003 u32 *pa_start, u32 *pa_end)
1004{
1005 int i, j;
1006 struct omap_hwmod_ocp_if *os;
1007 struct list_head *p = NULL;
1008 bool found = false;
1009
1010 p = oh->slave_ports.next;
1011
1012 i = 0;
1013 while (i < oh->slaves_cnt) {
1014 os = _fetch_next_ocp_if(&p, &i);
1015
1016 if (!os->addr)
1017 return -ENOENT;
1018
1019 j = 0;
1020 while (os->addr[j].pa_start != os->addr[j].pa_end) {
1021 if (name == os->addr[j].name ||
1022 !strcmp(name, os->addr[j].name)) {
1023 found = true;
1024 break;
1025 }
1026 j++;
1027 }
1028
1029 if (found)
1030 break;
1031 }
1032
1033 if (!found)
1034 return -ENOENT;
1035
1036 *pa_start = os->addr[j].pa_start;
1037 *pa_end = os->addr[j].pa_end;
1038
1039 return 0;
1040}
1041
1042/**
1043 * _save_mpu_port_index - find and save the index to @oh's MPU port
1044 * @oh: struct omap_hwmod *
1045 *
1046 * Determines the array index of the OCP slave port that the MPU uses
1047 * to address the device, and saves it into the struct omap_hwmod.
1048 * Intended to be called during hwmod registration only. No return
1049 * value.
1050 */
1051static void __init _save_mpu_port_index(struct omap_hwmod *oh)
1052{
1053 struct omap_hwmod_ocp_if *os = NULL;
1054 struct list_head *p;
1055 int i = 0;
1056
1057 if (!oh)
1058 return;
1059
1060 oh->_int_flags |= _HWMOD_NO_MPU_PORT;
1061
1062 p = oh->slave_ports.next;
1063
1064 while (i < oh->slaves_cnt) {
1065 os = _fetch_next_ocp_if(&p, &i);
1066 if (os->user & OCP_USER_MPU) {
1067 oh->_mpu_port = os;
1068 oh->_int_flags &= ~_HWMOD_NO_MPU_PORT;
1069 break;
1070 }
1071 }
1072
1073 return;
1074}
1075
1076/**
1077 * _find_mpu_rt_port - return omap_hwmod_ocp_if accessible by the MPU
1078 * @oh: struct omap_hwmod *
1079 *
1080 * Given a pointer to a struct omap_hwmod record @oh, return a pointer
1081 * to the struct omap_hwmod_ocp_if record that is used by the MPU to
1082 * communicate with the IP block. This interface need not be directly
1083 * connected to the MPU (and almost certainly is not), but is directly
1084 * connected to the IP block represented by @oh. Returns a pointer
1085 * to the struct omap_hwmod_ocp_if * upon success, or returns NULL upon
1086 * error or if there does not appear to be a path from the MPU to this
1087 * IP block.
1088 */
1089static struct omap_hwmod_ocp_if *_find_mpu_rt_port(struct omap_hwmod *oh)
1090{
1091 if (!oh || oh->_int_flags & _HWMOD_NO_MPU_PORT || oh->slaves_cnt == 0)
1092 return NULL;
1093
1094 return oh->_mpu_port;
1095};
1096
1097/**
1098 * _find_mpu_rt_addr_space - return MPU register target address space for @oh
1099 * @oh: struct omap_hwmod *
1100 *
1101 * Returns a pointer to the struct omap_hwmod_addr_space record representing
1102 * the register target MPU address space; or returns NULL upon error.
1103 */
1104static struct omap_hwmod_addr_space * __init _find_mpu_rt_addr_space(struct omap_hwmod *oh)
1105{
1106 struct omap_hwmod_ocp_if *os;
1107 struct omap_hwmod_addr_space *mem;
1108 int found = 0, i = 0;
1109
1110 os = _find_mpu_rt_port(oh);
1111 if (!os || !os->addr)
1112 return NULL;
1113
1114 do {
1115 mem = &os->addr[i++];
1116 if (mem->flags & ADDR_TYPE_RT)
1117 found = 1;
1118 } while (!found && mem->pa_start != mem->pa_end);
1119
1120 return (found) ? mem : NULL;
1121}
1122
1123/**
1124 * _enable_sysc - try to bring a module out of idle via OCP_SYSCONFIG
1125 * @oh: struct omap_hwmod *
1126 *
1127 * Ensure that the OCP_SYSCONFIG register for the IP block represented
1128 * by @oh is set to indicate to the PRCM that the IP block is active.
1129 * Usually this means placing the module into smart-idle mode and
1130 * smart-standby, but if there is a bug in the automatic idle handling
1131 * for the IP block, it may need to be placed into the force-idle or
1132 * no-idle variants of these modes. No return value.
1133 */
1134static void _enable_sysc(struct omap_hwmod *oh)
1135{
1136 u8 idlemode, sf;
1137 u32 v;
1138 bool clkdm_act;
1139
1140 if (!oh->class->sysc)
1141 return;
1142
1143 v = oh->_sysc_cache;
1144 sf = oh->class->sysc->sysc_flags;
1145
1146 if (sf & SYSC_HAS_SIDLEMODE) {
1147 clkdm_act = ((oh->clkdm &&
1148 oh->clkdm->flags & CLKDM_ACTIVE_WITH_MPU) ||
1149 (oh->_clk && oh->_clk->clkdm &&
1150 oh->_clk->clkdm->flags & CLKDM_ACTIVE_WITH_MPU));
1151 if (clkdm_act && !(oh->class->sysc->idlemodes &
1152 (SIDLE_SMART | SIDLE_SMART_WKUP)))
1153 idlemode = HWMOD_IDLEMODE_FORCE;
1154 else
1155 idlemode = (oh->flags & HWMOD_SWSUP_SIDLE) ?
1156 HWMOD_IDLEMODE_NO : HWMOD_IDLEMODE_SMART;
1157 _set_slave_idlemode(oh, idlemode, &v);
1158 }
1159
1160 if (sf & SYSC_HAS_MIDLEMODE) {
1161 if (oh->flags & HWMOD_SWSUP_MSTANDBY) {
1162 idlemode = HWMOD_IDLEMODE_NO;
1163 } else {
1164 if (sf & SYSC_HAS_ENAWAKEUP)
1165 _enable_wakeup(oh, &v);
1166 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1167 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1168 else
1169 idlemode = HWMOD_IDLEMODE_SMART;
1170 }
1171 _set_master_standbymode(oh, idlemode, &v);
1172 }
1173
1174 /*
1175 * XXX The clock framework should handle this, by
1176 * calling into this code. But this must wait until the
1177 * clock structures are tagged with omap_hwmod entries
1178 */
1179 if ((oh->flags & HWMOD_SET_DEFAULT_CLOCKACT) &&
1180 (sf & SYSC_HAS_CLOCKACTIVITY))
1181 _set_clockactivity(oh, oh->class->sysc->clockact, &v);
1182
1183 /* If slave is in SMARTIDLE, also enable wakeup */
1184 if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
1185 _enable_wakeup(oh, &v);
1186
1187 _write_sysconfig(v, oh);
1188
1189 /*
1190 * Set the autoidle bit only after setting the smartidle bit
1191 * Setting this will not have any impact on the other modules.
1192 */
1193 if (sf & SYSC_HAS_AUTOIDLE) {
1194 idlemode = (oh->flags & HWMOD_NO_OCP_AUTOIDLE) ?
1195 0 : 1;
1196 _set_module_autoidle(oh, idlemode, &v);
1197 _write_sysconfig(v, oh);
1198 }
1199}
1200
1201/**
1202 * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
1203 * @oh: struct omap_hwmod *
1204 *
1205 * If module is marked as SWSUP_SIDLE, force the module into slave
1206 * idle; otherwise, configure it for smart-idle. If module is marked
1207 * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
1208 * configure it for smart-standby. No return value.
1209 */
1210static void _idle_sysc(struct omap_hwmod *oh)
1211{
1212 u8 idlemode, sf;
1213 u32 v;
1214
1215 if (!oh->class->sysc)
1216 return;
1217
1218 v = oh->_sysc_cache;
1219 sf = oh->class->sysc->sysc_flags;
1220
1221 if (sf & SYSC_HAS_SIDLEMODE) {
1222 /* XXX What about HWMOD_IDLEMODE_SMART_WKUP? */
1223 if (oh->flags & HWMOD_SWSUP_SIDLE ||
1224 !(oh->class->sysc->idlemodes &
1225 (SIDLE_SMART | SIDLE_SMART_WKUP)))
1226 idlemode = HWMOD_IDLEMODE_FORCE;
1227 else
1228 idlemode = HWMOD_IDLEMODE_SMART;
1229 _set_slave_idlemode(oh, idlemode, &v);
1230 }
1231
1232 if (sf & SYSC_HAS_MIDLEMODE) {
1233 if (oh->flags & HWMOD_SWSUP_MSTANDBY) {
1234 idlemode = HWMOD_IDLEMODE_FORCE;
1235 } else {
1236 if (sf & SYSC_HAS_ENAWAKEUP)
1237 _enable_wakeup(oh, &v);
1238 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1239 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1240 else
1241 idlemode = HWMOD_IDLEMODE_SMART;
1242 }
1243 _set_master_standbymode(oh, idlemode, &v);
1244 }
1245
1246 /* If slave is in SMARTIDLE, also enable wakeup */
1247 if ((sf & SYSC_HAS_SIDLEMODE) && !(oh->flags & HWMOD_SWSUP_SIDLE))
1248 _enable_wakeup(oh, &v);
1249
1250 _write_sysconfig(v, oh);
1251}
1252
1253/**
1254 * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
1255 * @oh: struct omap_hwmod *
1256 *
1257 * Force the module into slave idle and master suspend. No return
1258 * value.
1259 */
1260static void _shutdown_sysc(struct omap_hwmod *oh)
1261{
1262 u32 v;
1263 u8 sf;
1264
1265 if (!oh->class->sysc)
1266 return;
1267
1268 v = oh->_sysc_cache;
1269 sf = oh->class->sysc->sysc_flags;
1270
1271 if (sf & SYSC_HAS_SIDLEMODE)
1272 _set_slave_idlemode(oh, HWMOD_IDLEMODE_FORCE, &v);
1273
1274 if (sf & SYSC_HAS_MIDLEMODE)
1275 _set_master_standbymode(oh, HWMOD_IDLEMODE_FORCE, &v);
1276
1277 if (sf & SYSC_HAS_AUTOIDLE)
1278 _set_module_autoidle(oh, 1, &v);
1279
1280 _write_sysconfig(v, oh);
1281}
1282
1283/**
1284 * _lookup - find an omap_hwmod by name
1285 * @name: find an omap_hwmod by name
1286 *
1287 * Return a pointer to an omap_hwmod by name, or NULL if not found.
1288 */
1289static struct omap_hwmod *_lookup(const char *name)
1290{
1291 struct omap_hwmod *oh, *temp_oh;
1292
1293 oh = NULL;
1294
1295 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1296 if (!strcmp(name, temp_oh->name)) {
1297 oh = temp_oh;
1298 break;
1299 }
1300 }
1301
1302 return oh;
1303}
1304/**
1305 * _init_clkdm - look up a clockdomain name, store pointer in omap_hwmod
1306 * @oh: struct omap_hwmod *
1307 *
1308 * Convert a clockdomain name stored in a struct omap_hwmod into a
1309 * clockdomain pointer, and save it into the struct omap_hwmod.
1310 * return -EINVAL if clkdm_name does not exist or if the lookup failed.
1311 */
1312static int _init_clkdm(struct omap_hwmod *oh)
1313{
1314 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1315 return 0;
1316
1317 if (!oh->clkdm_name) {
1318 pr_warning("omap_hwmod: %s: no clkdm_name\n", oh->name);
1319 return -EINVAL;
1320 }
1321
1322 oh->clkdm = clkdm_lookup(oh->clkdm_name);
1323 if (!oh->clkdm) {
1324 pr_warning("omap_hwmod: %s: could not associate to clkdm %s\n",
1325 oh->name, oh->clkdm_name);
1326 return -EINVAL;
1327 }
1328
1329 pr_debug("omap_hwmod: %s: associated to clkdm %s\n",
1330 oh->name, oh->clkdm_name);
1331
1332 return 0;
1333}
1334
1335/**
1336 * _init_clocks - clk_get() all clocks associated with this hwmod. Retrieve as
1337 * well the clockdomain.
1338 * @oh: struct omap_hwmod *
1339 * @data: not used; pass NULL
1340 *
1341 * Called by omap_hwmod_setup_*() (after omap2_clk_init()).
1342 * Resolves all clock names embedded in the hwmod. Returns 0 on
1343 * success, or a negative error code on failure.
1344 */
1345static int _init_clocks(struct omap_hwmod *oh, void *data)
1346{
1347 int ret = 0;
1348
1349 if (oh->_state != _HWMOD_STATE_REGISTERED)
1350 return 0;
1351
1352 pr_debug("omap_hwmod: %s: looking up clocks\n", oh->name);
1353
1354 ret |= _init_main_clk(oh);
1355 ret |= _init_interface_clks(oh);
1356 ret |= _init_opt_clks(oh);
1357 ret |= _init_clkdm(oh);
1358
1359 if (!ret)
1360 oh->_state = _HWMOD_STATE_CLKS_INITED;
1361 else
1362 pr_warning("omap_hwmod: %s: cannot _init_clocks\n", oh->name);
1363
1364 return ret;
1365}
1366
1367/**
1368 * _wait_target_ready - wait for a module to leave slave idle
1369 * @oh: struct omap_hwmod *
1370 *
1371 * Wait for a module @oh to leave slave idle. Returns 0 if the module
1372 * does not have an IDLEST bit or if the module successfully leaves
1373 * slave idle; otherwise, pass along the return value of the
1374 * appropriate *_cm*_wait_module_ready() function.
1375 */
1376static int _wait_target_ready(struct omap_hwmod *oh)
1377{
1378 struct omap_hwmod_ocp_if *os;
1379 int ret;
1380
1381 if (!oh)
1382 return -EINVAL;
1383
1384 if (oh->flags & HWMOD_NO_IDLEST)
1385 return 0;
1386
1387 os = _find_mpu_rt_port(oh);
1388 if (!os)
1389 return 0;
1390
1391 /* XXX check module SIDLEMODE */
1392
1393 /* XXX check clock enable states */
1394
1395 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1396 ret = omap2_cm_wait_module_ready(oh->prcm.omap2.module_offs,
1397 oh->prcm.omap2.idlest_reg_id,
1398 oh->prcm.omap2.idlest_idle_bit);
1399 } else if (cpu_is_omap44xx()) {
1400 if (!oh->clkdm)
1401 return -EINVAL;
1402
1403 ret = omap4_cminst_wait_module_ready(oh->clkdm->prcm_partition,
1404 oh->clkdm->cm_inst,
1405 oh->clkdm->clkdm_offs,
1406 oh->prcm.omap4.clkctrl_offs);
1407 } else {
1408 BUG();
1409 };
1410
1411 return ret;
1412}
1413
1414/**
1415 * _lookup_hardreset - fill register bit info for this hwmod/reset line
1416 * @oh: struct omap_hwmod *
1417 * @name: name of the reset line in the context of this hwmod
1418 * @ohri: struct omap_hwmod_rst_info * that this function will fill in
1419 *
1420 * Return the bit position of the reset line that match the
1421 * input name. Return -ENOENT if not found.
1422 */
1423static u8 _lookup_hardreset(struct omap_hwmod *oh, const char *name,
1424 struct omap_hwmod_rst_info *ohri)
1425{
1426 int i;
1427
1428 for (i = 0; i < oh->rst_lines_cnt; i++) {
1429 const char *rst_line = oh->rst_lines[i].name;
1430 if (!strcmp(rst_line, name)) {
1431 ohri->rst_shift = oh->rst_lines[i].rst_shift;
1432 ohri->st_shift = oh->rst_lines[i].st_shift;
1433 pr_debug("omap_hwmod: %s: %s: %s: rst %d st %d\n",
1434 oh->name, __func__, rst_line, ohri->rst_shift,
1435 ohri->st_shift);
1436
1437 return 0;
1438 }
1439 }
1440
1441 return -ENOENT;
1442}
1443
1444/**
1445 * _assert_hardreset - assert the HW reset line of submodules
1446 * contained in the hwmod module.
1447 * @oh: struct omap_hwmod *
1448 * @name: name of the reset line to lookup and assert
1449 *
1450 * Some IP like dsp, ipu or iva contain processor that require
1451 * an HW reset line to be assert / deassert in order to enable fully
1452 * the IP.
1453 */
1454static int _assert_hardreset(struct omap_hwmod *oh, const char *name)
1455{
1456 struct omap_hwmod_rst_info ohri;
1457 u8 ret;
1458
1459 if (!oh)
1460 return -EINVAL;
1461
1462 ret = _lookup_hardreset(oh, name, &ohri);
1463 if (IS_ERR_VALUE(ret))
1464 return ret;
1465
1466 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1467 return omap2_prm_assert_hardreset(oh->prcm.omap2.module_offs,
1468 ohri.rst_shift);
1469 else if (cpu_is_omap44xx())
1470 return omap4_prminst_assert_hardreset(ohri.rst_shift,
1471 oh->clkdm->pwrdm.ptr->prcm_partition,
1472 oh->clkdm->pwrdm.ptr->prcm_offs,
1473 oh->prcm.omap4.rstctrl_offs);
1474 else
1475 return -EINVAL;
1476}
1477
1478/**
1479 * _deassert_hardreset - deassert the HW reset line of submodules contained
1480 * in the hwmod module.
1481 * @oh: struct omap_hwmod *
1482 * @name: name of the reset line to look up and deassert
1483 *
1484 * Some IP like dsp, ipu or iva contain processor that require
1485 * an HW reset line to be assert / deassert in order to enable fully
1486 * the IP.
1487 */
1488static int _deassert_hardreset(struct omap_hwmod *oh, const char *name)
1489{
1490 struct omap_hwmod_rst_info ohri;
1491 int ret;
1492
1493 if (!oh)
1494 return -EINVAL;
1495
1496 ret = _lookup_hardreset(oh, name, &ohri);
1497 if (IS_ERR_VALUE(ret))
1498 return ret;
1499
1500 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1501 ret = omap2_prm_deassert_hardreset(oh->prcm.omap2.module_offs,
1502 ohri.rst_shift,
1503 ohri.st_shift);
1504 } else if (cpu_is_omap44xx()) {
1505 if (ohri.st_shift)
1506 pr_err("omap_hwmod: %s: %s: hwmod data error: OMAP4 does not support st_shift\n",
1507 oh->name, name);
1508 ret = omap4_prminst_deassert_hardreset(ohri.rst_shift,
1509 oh->clkdm->pwrdm.ptr->prcm_partition,
1510 oh->clkdm->pwrdm.ptr->prcm_offs,
1511 oh->prcm.omap4.rstctrl_offs);
1512 } else {
1513 return -EINVAL;
1514 }
1515
1516 if (ret == -EBUSY)
1517 pr_warning("omap_hwmod: %s: failed to hardreset\n", oh->name);
1518
1519 return ret;
1520}
1521
1522/**
1523 * _read_hardreset - read the HW reset line state of submodules
1524 * contained in the hwmod module
1525 * @oh: struct omap_hwmod *
1526 * @name: name of the reset line to look up and read
1527 *
1528 * Return the state of the reset line.
1529 */
1530static int _read_hardreset(struct omap_hwmod *oh, const char *name)
1531{
1532 struct omap_hwmod_rst_info ohri;
1533 u8 ret;
1534
1535 if (!oh)
1536 return -EINVAL;
1537
1538 ret = _lookup_hardreset(oh, name, &ohri);
1539 if (IS_ERR_VALUE(ret))
1540 return ret;
1541
1542 if (cpu_is_omap24xx() || cpu_is_omap34xx()) {
1543 return omap2_prm_is_hardreset_asserted(oh->prcm.omap2.module_offs,
1544 ohri.st_shift);
1545 } else if (cpu_is_omap44xx()) {
1546 return omap4_prminst_is_hardreset_asserted(ohri.rst_shift,
1547 oh->clkdm->pwrdm.ptr->prcm_partition,
1548 oh->clkdm->pwrdm.ptr->prcm_offs,
1549 oh->prcm.omap4.rstctrl_offs);
1550 } else {
1551 return -EINVAL;
1552 }
1553}
1554
1555/**
1556 * _are_any_hardreset_lines_asserted - return true if part of @oh is hard-reset
1557 * @oh: struct omap_hwmod *
1558 *
1559 * If any hardreset line associated with @oh is asserted, then return true.
1560 * Otherwise, if @oh has no hardreset lines associated with it, or if
1561 * no hardreset lines associated with @oh are asserted, then return false.
1562 * This function is used to avoid executing some parts of the IP block
1563 * enable/disable sequence if a hardreset line is set.
1564 */
1565static bool _are_any_hardreset_lines_asserted(struct omap_hwmod *oh)
1566{
1567 int i;
1568
1569 if (oh->rst_lines_cnt == 0)
1570 return false;
1571
1572 for (i = 0; i < oh->rst_lines_cnt; i++)
1573 if (_read_hardreset(oh, oh->rst_lines[i].name) > 0)
1574 return true;
1575
1576 return false;
1577}
1578
1579/**
1580 * _omap4_disable_module - enable CLKCTRL modulemode on OMAP4
1581 * @oh: struct omap_hwmod *
1582 *
1583 * Disable the PRCM module mode related to the hwmod @oh.
1584 * Return EINVAL if the modulemode is not supported and 0 in case of success.
1585 */
1586static int _omap4_disable_module(struct omap_hwmod *oh)
1587{
1588 int v;
1589
1590 /* The module mode does not exist prior OMAP4 */
1591 if (!cpu_is_omap44xx())
1592 return -EINVAL;
1593
1594 if (!oh->clkdm || !oh->prcm.omap4.modulemode)
1595 return -EINVAL;
1596
1597 pr_debug("omap_hwmod: %s: %s\n", oh->name, __func__);
1598
1599 omap4_cminst_module_disable(oh->clkdm->prcm_partition,
1600 oh->clkdm->cm_inst,
1601 oh->clkdm->clkdm_offs,
1602 oh->prcm.omap4.clkctrl_offs);
1603
1604 if (_are_any_hardreset_lines_asserted(oh))
1605 return 0;
1606
1607 v = _omap4_wait_target_disable(oh);
1608 if (v)
1609 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1610 oh->name);
1611
1612 return 0;
1613}
1614
1615/**
1616 * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1617 * @oh: struct omap_hwmod *
1618 *
1619 * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit. hwmod must be
1620 * enabled for this to work. Returns -ENOENT if the hwmod cannot be
1621 * reset this way, -EINVAL if the hwmod is in the wrong state,
1622 * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1623 *
1624 * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1625 * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1626 * use the SYSCONFIG softreset bit to provide the status.
1627 *
1628 * Note that some IP like McBSP do have reset control but don't have
1629 * reset status.
1630 */
1631static int _ocp_softreset(struct omap_hwmod *oh)
1632{
1633 u32 v, softrst_mask;
1634 int c = 0;
1635 int ret = 0;
1636
1637 if (!oh->class->sysc ||
1638 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
1639 return -ENOENT;
1640
1641 /* clocks must be on for this operation */
1642 if (oh->_state != _HWMOD_STATE_ENABLED) {
1643 pr_warning("omap_hwmod: %s: reset can only be entered from "
1644 "enabled state\n", oh->name);
1645 return -EINVAL;
1646 }
1647
1648 /* For some modules, all optionnal clocks need to be enabled as well */
1649 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1650 _enable_optional_clocks(oh);
1651
1652 pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh->name);
1653
1654 v = oh->_sysc_cache;
1655 ret = _set_softreset(oh, &v);
1656 if (ret)
1657 goto dis_opt_clks;
1658 _write_sysconfig(v, oh);
1659
1660 if (oh->class->sysc->srst_udelay)
1661 udelay(oh->class->sysc->srst_udelay);
1662
1663 if (oh->class->sysc->sysc_flags & SYSS_HAS_RESET_STATUS)
1664 omap_test_timeout((omap_hwmod_read(oh,
1665 oh->class->sysc->syss_offs)
1666 & SYSS_RESETDONE_MASK),
1667 MAX_MODULE_SOFTRESET_WAIT, c);
1668 else if (oh->class->sysc->sysc_flags & SYSC_HAS_RESET_STATUS) {
1669 softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
1670 omap_test_timeout(!(omap_hwmod_read(oh,
1671 oh->class->sysc->sysc_offs)
1672 & softrst_mask),
1673 MAX_MODULE_SOFTRESET_WAIT, c);
1674 }
1675
1676 if (c == MAX_MODULE_SOFTRESET_WAIT)
1677 pr_warning("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1678 oh->name, MAX_MODULE_SOFTRESET_WAIT);
1679 else
1680 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh->name, c);
1681
1682 /*
1683 * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1684 * _wait_target_ready() or _reset()
1685 */
1686
1687 ret = (c == MAX_MODULE_SOFTRESET_WAIT) ? -ETIMEDOUT : 0;
1688
1689dis_opt_clks:
1690 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1691 _disable_optional_clocks(oh);
1692
1693 return ret;
1694}
1695
1696/**
1697 * _reset - reset an omap_hwmod
1698 * @oh: struct omap_hwmod *
1699 *
1700 * Resets an omap_hwmod @oh. If the module has a custom reset
1701 * function pointer defined, then call it to reset the IP block, and
1702 * pass along its return value to the caller. Otherwise, if the IP
1703 * block has an OCP_SYSCONFIG register with a SOFTRESET bitfield
1704 * associated with it, call a function to reset the IP block via that
1705 * method, and pass along the return value to the caller. Finally, if
1706 * the IP block has some hardreset lines associated with it, assert
1707 * all of those, but do _not_ deassert them. (This is because driver
1708 * authors have expressed an apparent requirement to control the
1709 * deassertion of the hardreset lines themselves.)
1710 *
1711 * The default software reset mechanism for most OMAP IP blocks is
1712 * triggered via the OCP_SYSCONFIG.SOFTRESET bit. However, some
1713 * hwmods cannot be reset via this method. Some are not targets and
1714 * therefore have no OCP header registers to access. Others (like the
1715 * IVA) have idiosyncratic reset sequences. So for these relatively
1716 * rare cases, custom reset code can be supplied in the struct
1717 * omap_hwmod_class .reset function pointer. Passes along the return
1718 * value from either _ocp_softreset() or the custom reset function -
1719 * these must return -EINVAL if the hwmod cannot be reset this way or
1720 * if the hwmod is in the wrong state, -ETIMEDOUT if the module did
1721 * not reset in time, or 0 upon success.
1722 */
1723static int _reset(struct omap_hwmod *oh)
1724{
1725 int i, r;
1726
1727 pr_debug("omap_hwmod: %s: resetting\n", oh->name);
1728
1729 if (oh->class->reset) {
1730 r = oh->class->reset(oh);
1731 } else {
1732 if (oh->rst_lines_cnt > 0) {
1733 for (i = 0; i < oh->rst_lines_cnt; i++)
1734 _assert_hardreset(oh, oh->rst_lines[i].name);
1735 return 0;
1736 } else {
1737 r = _ocp_softreset(oh);
1738 if (r == -ENOENT)
1739 r = 0;
1740 }
1741 }
1742
1743 /*
1744 * OCP_SYSCONFIG bits need to be reprogrammed after a
1745 * softreset. The _enable() function should be split to avoid
1746 * the rewrite of the OCP_SYSCONFIG register.
1747 */
1748 if (oh->class->sysc) {
1749 _update_sysc_cache(oh);
1750 _enable_sysc(oh);
1751 }
1752
1753 return r;
1754}
1755
1756/**
1757 * _enable - enable an omap_hwmod
1758 * @oh: struct omap_hwmod *
1759 *
1760 * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
1761 * register target. Returns -EINVAL if the hwmod is in the wrong
1762 * state or passes along the return value of _wait_target_ready().
1763 */
1764static int _enable(struct omap_hwmod *oh)
1765{
1766 int r;
1767 int hwsup = 0;
1768
1769 pr_debug("omap_hwmod: %s: enabling\n", oh->name);
1770
1771 /*
1772 * hwmods with HWMOD_INIT_NO_IDLE flag set are left in enabled
1773 * state at init. Now that someone is really trying to enable
1774 * them, just ensure that the hwmod mux is set.
1775 */
1776 if (oh->_int_flags & _HWMOD_SKIP_ENABLE) {
1777 /*
1778 * If the caller has mux data populated, do the mux'ing
1779 * which wouldn't have been done as part of the _enable()
1780 * done during setup.
1781 */
1782 if (oh->mux)
1783 omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
1784
1785 oh->_int_flags &= ~_HWMOD_SKIP_ENABLE;
1786 return 0;
1787 }
1788
1789 if (oh->_state != _HWMOD_STATE_INITIALIZED &&
1790 oh->_state != _HWMOD_STATE_IDLE &&
1791 oh->_state != _HWMOD_STATE_DISABLED) {
1792 WARN(1, "omap_hwmod: %s: enabled state can only be entered from initialized, idle, or disabled state\n",
1793 oh->name);
1794 return -EINVAL;
1795 }
1796
1797 /*
1798 * If an IP block contains HW reset lines and any of them are
1799 * asserted, we let integration code associated with that
1800 * block handle the enable. We've received very little
1801 * information on what those driver authors need, and until
1802 * detailed information is provided and the driver code is
1803 * posted to the public lists, this is probably the best we
1804 * can do.
1805 */
1806 if (_are_any_hardreset_lines_asserted(oh))
1807 return 0;
1808
1809 /* Mux pins for device runtime if populated */
1810 if (oh->mux && (!oh->mux->enabled ||
1811 ((oh->_state == _HWMOD_STATE_IDLE) &&
1812 oh->mux->pads_dynamic)))
1813 omap_hwmod_mux(oh->mux, _HWMOD_STATE_ENABLED);
1814
1815 _add_initiator_dep(oh, mpu_oh);
1816
1817 if (oh->clkdm) {
1818 /*
1819 * A clockdomain must be in SW_SUP before enabling
1820 * completely the module. The clockdomain can be set
1821 * in HW_AUTO only when the module become ready.
1822 */
1823 hwsup = clkdm_in_hwsup(oh->clkdm);
1824 r = clkdm_hwmod_enable(oh->clkdm, oh);
1825 if (r) {
1826 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1827 oh->name, oh->clkdm->name, r);
1828 return r;
1829 }
1830 }
1831
1832 _enable_clocks(oh);
1833 _enable_module(oh);
1834
1835 r = _wait_target_ready(oh);
1836 if (!r) {
1837 /*
1838 * Set the clockdomain to HW_AUTO only if the target is ready,
1839 * assuming that the previous state was HW_AUTO
1840 */
1841 if (oh->clkdm && hwsup)
1842 clkdm_allow_idle(oh->clkdm);
1843
1844 oh->_state = _HWMOD_STATE_ENABLED;
1845
1846 /* Access the sysconfig only if the target is ready */
1847 if (oh->class->sysc) {
1848 if (!(oh->_int_flags & _HWMOD_SYSCONFIG_LOADED))
1849 _update_sysc_cache(oh);
1850 _enable_sysc(oh);
1851 }
1852 } else {
1853 _disable_clocks(oh);
1854 pr_debug("omap_hwmod: %s: _wait_target_ready: %d\n",
1855 oh->name, r);
1856
1857 if (oh->clkdm)
1858 clkdm_hwmod_disable(oh->clkdm, oh);
1859 }
1860
1861 return r;
1862}
1863
1864/**
1865 * _idle - idle an omap_hwmod
1866 * @oh: struct omap_hwmod *
1867 *
1868 * Idles an omap_hwmod @oh. This should be called once the hwmod has
1869 * no further work. Returns -EINVAL if the hwmod is in the wrong
1870 * state or returns 0.
1871 */
1872static int _idle(struct omap_hwmod *oh)
1873{
1874 pr_debug("omap_hwmod: %s: idling\n", oh->name);
1875
1876 if (oh->_state != _HWMOD_STATE_ENABLED) {
1877 WARN(1, "omap_hwmod: %s: idle state can only be entered from enabled state\n",
1878 oh->name);
1879 return -EINVAL;
1880 }
1881
1882 if (_are_any_hardreset_lines_asserted(oh))
1883 return 0;
1884
1885 if (oh->class->sysc)
1886 _idle_sysc(oh);
1887 _del_initiator_dep(oh, mpu_oh);
1888
1889 _omap4_disable_module(oh);
1890
1891 /*
1892 * The module must be in idle mode before disabling any parents
1893 * clocks. Otherwise, the parent clock might be disabled before
1894 * the module transition is done, and thus will prevent the
1895 * transition to complete properly.
1896 */
1897 _disable_clocks(oh);
1898 if (oh->clkdm)
1899 clkdm_hwmod_disable(oh->clkdm, oh);
1900
1901 /* Mux pins for device idle if populated */
1902 if (oh->mux && oh->mux->pads_dynamic)
1903 omap_hwmod_mux(oh->mux, _HWMOD_STATE_IDLE);
1904
1905 oh->_state = _HWMOD_STATE_IDLE;
1906
1907 return 0;
1908}
1909
1910/**
1911 * omap_hwmod_set_ocp_autoidle - set the hwmod's OCP autoidle bit
1912 * @oh: struct omap_hwmod *
1913 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
1914 *
1915 * Sets the IP block's OCP autoidle bit in hardware, and updates our
1916 * local copy. Intended to be used by drivers that require
1917 * direct manipulation of the AUTOIDLE bits.
1918 * Returns -EINVAL if @oh is null or is not in the ENABLED state, or passes
1919 * along the return value from _set_module_autoidle().
1920 *
1921 * Any users of this function should be scrutinized carefully.
1922 */
1923int omap_hwmod_set_ocp_autoidle(struct omap_hwmod *oh, u8 autoidle)
1924{
1925 u32 v;
1926 int retval = 0;
1927 unsigned long flags;
1928
1929 if (!oh || oh->_state != _HWMOD_STATE_ENABLED)
1930 return -EINVAL;
1931
1932 spin_lock_irqsave(&oh->_lock, flags);
1933
1934 v = oh->_sysc_cache;
1935
1936 retval = _set_module_autoidle(oh, autoidle, &v);
1937
1938 if (!retval)
1939 _write_sysconfig(v, oh);
1940
1941 spin_unlock_irqrestore(&oh->_lock, flags);
1942
1943 return retval;
1944}
1945
1946/**
1947 * _shutdown - shutdown an omap_hwmod
1948 * @oh: struct omap_hwmod *
1949 *
1950 * Shut down an omap_hwmod @oh. This should be called when the driver
1951 * used for the hwmod is removed or unloaded or if the driver is not
1952 * used by the system. Returns -EINVAL if the hwmod is in the wrong
1953 * state or returns 0.
1954 */
1955static int _shutdown(struct omap_hwmod *oh)
1956{
1957 int ret, i;
1958 u8 prev_state;
1959
1960 if (oh->_state != _HWMOD_STATE_IDLE &&
1961 oh->_state != _HWMOD_STATE_ENABLED) {
1962 WARN(1, "omap_hwmod: %s: disabled state can only be entered from idle, or enabled state\n",
1963 oh->name);
1964 return -EINVAL;
1965 }
1966
1967 if (_are_any_hardreset_lines_asserted(oh))
1968 return 0;
1969
1970 pr_debug("omap_hwmod: %s: disabling\n", oh->name);
1971
1972 if (oh->class->pre_shutdown) {
1973 prev_state = oh->_state;
1974 if (oh->_state == _HWMOD_STATE_IDLE)
1975 _enable(oh);
1976 ret = oh->class->pre_shutdown(oh);
1977 if (ret) {
1978 if (prev_state == _HWMOD_STATE_IDLE)
1979 _idle(oh);
1980 return ret;
1981 }
1982 }
1983
1984 if (oh->class->sysc) {
1985 if (oh->_state == _HWMOD_STATE_IDLE)
1986 _enable(oh);
1987 _shutdown_sysc(oh);
1988 }
1989
1990 /* clocks and deps are already disabled in idle */
1991 if (oh->_state == _HWMOD_STATE_ENABLED) {
1992 _del_initiator_dep(oh, mpu_oh);
1993 /* XXX what about the other system initiators here? dma, dsp */
1994 _omap4_disable_module(oh);
1995 _disable_clocks(oh);
1996 if (oh->clkdm)
1997 clkdm_hwmod_disable(oh->clkdm, oh);
1998 }
1999 /* XXX Should this code also force-disable the optional clocks? */
2000
2001 for (i = 0; i < oh->rst_lines_cnt; i++)
2002 _assert_hardreset(oh, oh->rst_lines[i].name);
2003
2004 /* Mux pins to safe mode or use populated off mode values */
2005 if (oh->mux)
2006 omap_hwmod_mux(oh->mux, _HWMOD_STATE_DISABLED);
2007
2008 oh->_state = _HWMOD_STATE_DISABLED;
2009
2010 return 0;
2011}
2012
2013/**
2014 * _init_mpu_rt_base - populate the virtual address for a hwmod
2015 * @oh: struct omap_hwmod * to locate the virtual address
2016 *
2017 * Cache the virtual address used by the MPU to access this IP block's
2018 * registers. This address is needed early so the OCP registers that
2019 * are part of the device's address space can be ioremapped properly.
2020 * No return value.
2021 */
2022static void __init _init_mpu_rt_base(struct omap_hwmod *oh, void *data)
2023{
2024 struct omap_hwmod_addr_space *mem;
2025 void __iomem *va_start;
2026
2027 if (!oh)
2028 return;
2029
2030 _save_mpu_port_index(oh);
2031
2032 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2033 return;
2034
2035 mem = _find_mpu_rt_addr_space(oh);
2036 if (!mem) {
2037 pr_debug("omap_hwmod: %s: no MPU register target found\n",
2038 oh->name);
2039 return;
2040 }
2041
2042 va_start = ioremap(mem->pa_start, mem->pa_end - mem->pa_start);
2043 if (!va_start) {
2044 pr_err("omap_hwmod: %s: Could not ioremap\n", oh->name);
2045 return;
2046 }
2047
2048 pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
2049 oh->name, va_start);
2050
2051 oh->_mpu_rt_va = va_start;
2052}
2053
2054/**
2055 * _init - initialize internal data for the hwmod @oh
2056 * @oh: struct omap_hwmod *
2057 * @n: (unused)
2058 *
2059 * Look up the clocks and the address space used by the MPU to access
2060 * registers belonging to the hwmod @oh. @oh must already be
2061 * registered at this point. This is the first of two phases for
2062 * hwmod initialization. Code called here does not touch any hardware
2063 * registers, it simply prepares internal data structures. Returns 0
2064 * upon success or if the hwmod isn't registered, or -EINVAL upon
2065 * failure.
2066 */
2067static int __init _init(struct omap_hwmod *oh, void *data)
2068{
2069 int r;
2070
2071 if (oh->_state != _HWMOD_STATE_REGISTERED)
2072 return 0;
2073
2074 _init_mpu_rt_base(oh, NULL);
2075
2076 r = _init_clocks(oh, NULL);
2077 if (IS_ERR_VALUE(r)) {
2078 WARN(1, "omap_hwmod: %s: couldn't init clocks\n", oh->name);
2079 return -EINVAL;
2080 }
2081
2082 oh->_state = _HWMOD_STATE_INITIALIZED;
2083
2084 return 0;
2085}
2086
2087/**
2088 * _setup_iclk_autoidle - configure an IP block's interface clocks
2089 * @oh: struct omap_hwmod *
2090 *
2091 * Set up the module's interface clocks. XXX This function is still mostly
2092 * a stub; implementing this properly requires iclk autoidle usecounting in
2093 * the clock code. No return value.
2094 */
2095static void __init _setup_iclk_autoidle(struct omap_hwmod *oh)
2096{
2097 struct omap_hwmod_ocp_if *os;
2098 struct list_head *p;
2099 int i = 0;
2100 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2101 return;
2102
2103 p = oh->slave_ports.next;
2104
2105 while (i < oh->slaves_cnt) {
2106 os = _fetch_next_ocp_if(&p, &i);
2107 if (!os->_clk)
2108 continue;
2109
2110 if (os->flags & OCPIF_SWSUP_IDLE) {
2111 /* XXX omap_iclk_deny_idle(c); */
2112 } else {
2113 /* XXX omap_iclk_allow_idle(c); */
2114 clk_enable(os->_clk);
2115 }
2116 }
2117
2118 return;
2119}
2120
2121/**
2122 * _setup_reset - reset an IP block during the setup process
2123 * @oh: struct omap_hwmod *
2124 *
2125 * Reset the IP block corresponding to the hwmod @oh during the setup
2126 * process. The IP block is first enabled so it can be successfully
2127 * reset. Returns 0 upon success or a negative error code upon
2128 * failure.
2129 */
2130static int __init _setup_reset(struct omap_hwmod *oh)
2131{
2132 int r;
2133
2134 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2135 return -EINVAL;
2136
2137 if (oh->rst_lines_cnt == 0) {
2138 r = _enable(oh);
2139 if (r) {
2140 pr_warning("omap_hwmod: %s: cannot be enabled for reset (%d)\n",
2141 oh->name, oh->_state);
2142 return -EINVAL;
2143 }
2144 }
2145
2146 if (!(oh->flags & HWMOD_INIT_NO_RESET))
2147 r = _reset(oh);
2148
2149 return r;
2150}
2151
2152/**
2153 * _setup_postsetup - transition to the appropriate state after _setup
2154 * @oh: struct omap_hwmod *
2155 *
2156 * Place an IP block represented by @oh into a "post-setup" state --
2157 * either IDLE, ENABLED, or DISABLED. ("post-setup" simply means that
2158 * this function is called at the end of _setup().) The postsetup
2159 * state for an IP block can be changed by calling
2160 * omap_hwmod_enter_postsetup_state() early in the boot process,
2161 * before one of the omap_hwmod_setup*() functions are called for the
2162 * IP block.
2163 *
2164 * The IP block stays in this state until a PM runtime-based driver is
2165 * loaded for that IP block. A post-setup state of IDLE is
2166 * appropriate for almost all IP blocks with runtime PM-enabled
2167 * drivers, since those drivers are able to enable the IP block. A
2168 * post-setup state of ENABLED is appropriate for kernels with PM
2169 * runtime disabled. The DISABLED state is appropriate for unusual IP
2170 * blocks such as the MPU WDTIMER on kernels without WDTIMER drivers
2171 * included, since the WDTIMER starts running on reset and will reset
2172 * the MPU if left active.
2173 *
2174 * This post-setup mechanism is deprecated. Once all of the OMAP
2175 * drivers have been converted to use PM runtime, and all of the IP
2176 * block data and interconnect data is available to the hwmod code, it
2177 * should be possible to replace this mechanism with a "lazy reset"
2178 * arrangement. In a "lazy reset" setup, each IP block is enabled
2179 * when the driver first probes, then all remaining IP blocks without
2180 * drivers are either shut down or enabled after the drivers have
2181 * loaded. However, this cannot take place until the above
2182 * preconditions have been met, since otherwise the late reset code
2183 * has no way of knowing which IP blocks are in use by drivers, and
2184 * which ones are unused.
2185 *
2186 * No return value.
2187 */
2188static void __init _setup_postsetup(struct omap_hwmod *oh)
2189{
2190 u8 postsetup_state;
2191
2192 if (oh->rst_lines_cnt > 0)
2193 return;
2194
2195 postsetup_state = oh->_postsetup_state;
2196 if (postsetup_state == _HWMOD_STATE_UNKNOWN)
2197 postsetup_state = _HWMOD_STATE_ENABLED;
2198
2199 /*
2200 * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
2201 * it should be set by the core code as a runtime flag during startup
2202 */
2203 if ((oh->flags & HWMOD_INIT_NO_IDLE) &&
2204 (postsetup_state == _HWMOD_STATE_IDLE)) {
2205 oh->_int_flags |= _HWMOD_SKIP_ENABLE;
2206 postsetup_state = _HWMOD_STATE_ENABLED;
2207 }
2208
2209 if (postsetup_state == _HWMOD_STATE_IDLE)
2210 _idle(oh);
2211 else if (postsetup_state == _HWMOD_STATE_DISABLED)
2212 _shutdown(oh);
2213 else if (postsetup_state != _HWMOD_STATE_ENABLED)
2214 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
2215 oh->name, postsetup_state);
2216
2217 return;
2218}
2219
2220/**
2221 * _setup - prepare IP block hardware for use
2222 * @oh: struct omap_hwmod *
2223 * @n: (unused, pass NULL)
2224 *
2225 * Configure the IP block represented by @oh. This may include
2226 * enabling the IP block, resetting it, and placing it into a
2227 * post-setup state, depending on the type of IP block and applicable
2228 * flags. IP blocks are reset to prevent any previous configuration
2229 * by the bootloader or previous operating system from interfering
2230 * with power management or other parts of the system. The reset can
2231 * be avoided; see omap_hwmod_no_setup_reset(). This is the second of
2232 * two phases for hwmod initialization. Code called here generally
2233 * affects the IP block hardware, or system integration hardware
2234 * associated with the IP block. Returns 0.
2235 */
2236static int __init _setup(struct omap_hwmod *oh, void *data)
2237{
2238 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2239 return 0;
2240
2241 _setup_iclk_autoidle(oh);
2242
2243 if (!_setup_reset(oh))
2244 _setup_postsetup(oh);
2245
2246 return 0;
2247}
2248
2249/**
2250 * _register - register a struct omap_hwmod
2251 * @oh: struct omap_hwmod *
2252 *
2253 * Registers the omap_hwmod @oh. Returns -EEXIST if an omap_hwmod
2254 * already has been registered by the same name; -EINVAL if the
2255 * omap_hwmod is in the wrong state, if @oh is NULL, if the
2256 * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
2257 * name, or if the omap_hwmod's class is missing a name; or 0 upon
2258 * success.
2259 *
2260 * XXX The data should be copied into bootmem, so the original data
2261 * should be marked __initdata and freed after init. This would allow
2262 * unneeded omap_hwmods to be freed on multi-OMAP configurations. Note
2263 * that the copy process would be relatively complex due to the large number
2264 * of substructures.
2265 */
2266static int __init _register(struct omap_hwmod *oh)
2267{
2268 if (!oh || !oh->name || !oh->class || !oh->class->name ||
2269 (oh->_state != _HWMOD_STATE_UNKNOWN))
2270 return -EINVAL;
2271
2272 pr_debug("omap_hwmod: %s: registering\n", oh->name);
2273
2274 if (_lookup(oh->name))
2275 return -EEXIST;
2276
2277 list_add_tail(&oh->node, &omap_hwmod_list);
2278
2279 INIT_LIST_HEAD(&oh->master_ports);
2280 INIT_LIST_HEAD(&oh->slave_ports);
2281 spin_lock_init(&oh->_lock);
2282
2283 oh->_state = _HWMOD_STATE_REGISTERED;
2284
2285 /*
2286 * XXX Rather than doing a strcmp(), this should test a flag
2287 * set in the hwmod data, inserted by the autogenerator code.
2288 */
2289 if (!strcmp(oh->name, MPU_INITIATOR_NAME))
2290 mpu_oh = oh;
2291
2292 return 0;
2293}
2294
2295/**
2296 * _alloc_links - return allocated memory for hwmod links
2297 * @ml: pointer to a struct omap_hwmod_link * for the master link
2298 * @sl: pointer to a struct omap_hwmod_link * for the slave link
2299 *
2300 * Return pointers to two struct omap_hwmod_link records, via the
2301 * addresses pointed to by @ml and @sl. Will first attempt to return
2302 * memory allocated as part of a large initial block, but if that has
2303 * been exhausted, will allocate memory itself. Since ideally this
2304 * second allocation path will never occur, the number of these
2305 * 'supplemental' allocations will be logged when debugging is
2306 * enabled. Returns 0.
2307 */
2308static int __init _alloc_links(struct omap_hwmod_link **ml,
2309 struct omap_hwmod_link **sl)
2310{
2311 unsigned int sz;
2312
2313 if ((free_ls + LINKS_PER_OCP_IF) <= max_ls) {
2314 *ml = &linkspace[free_ls++];
2315 *sl = &linkspace[free_ls++];
2316 return 0;
2317 }
2318
2319 sz = sizeof(struct omap_hwmod_link) * LINKS_PER_OCP_IF;
2320
2321 *sl = NULL;
2322 *ml = alloc_bootmem(sz);
2323
2324 memset(*ml, 0, sz);
2325
2326 *sl = (void *)(*ml) + sizeof(struct omap_hwmod_link);
2327
2328 ls_supp++;
2329 pr_debug("omap_hwmod: supplemental link allocations needed: %d\n",
2330 ls_supp * LINKS_PER_OCP_IF);
2331
2332 return 0;
2333};
2334
2335/**
2336 * _add_link - add an interconnect between two IP blocks
2337 * @oi: pointer to a struct omap_hwmod_ocp_if record
2338 *
2339 * Add struct omap_hwmod_link records connecting the master IP block
2340 * specified in @oi->master to @oi, and connecting the slave IP block
2341 * specified in @oi->slave to @oi. This code is assumed to run before
2342 * preemption or SMP has been enabled, thus avoiding the need for
2343 * locking in this code. Changes to this assumption will require
2344 * additional locking. Returns 0.
2345 */
2346static int __init _add_link(struct omap_hwmod_ocp_if *oi)
2347{
2348 struct omap_hwmod_link *ml, *sl;
2349
2350 pr_debug("omap_hwmod: %s -> %s: adding link\n", oi->master->name,
2351 oi->slave->name);
2352
2353 _alloc_links(&ml, &sl);
2354
2355 ml->ocp_if = oi;
2356 INIT_LIST_HEAD(&ml->node);
2357 list_add(&ml->node, &oi->master->master_ports);
2358 oi->master->masters_cnt++;
2359
2360 sl->ocp_if = oi;
2361 INIT_LIST_HEAD(&sl->node);
2362 list_add(&sl->node, &oi->slave->slave_ports);
2363 oi->slave->slaves_cnt++;
2364
2365 return 0;
2366}
2367
2368/**
2369 * _register_link - register a struct omap_hwmod_ocp_if
2370 * @oi: struct omap_hwmod_ocp_if *
2371 *
2372 * Registers the omap_hwmod_ocp_if record @oi. Returns -EEXIST if it
2373 * has already been registered; -EINVAL if @oi is NULL or if the
2374 * record pointed to by @oi is missing required fields; or 0 upon
2375 * success.
2376 *
2377 * XXX The data should be copied into bootmem, so the original data
2378 * should be marked __initdata and freed after init. This would allow
2379 * unneeded omap_hwmods to be freed on multi-OMAP configurations.
2380 */
2381static int __init _register_link(struct omap_hwmod_ocp_if *oi)
2382{
2383 if (!oi || !oi->master || !oi->slave || !oi->user)
2384 return -EINVAL;
2385
2386 if (oi->_int_flags & _OCPIF_INT_FLAGS_REGISTERED)
2387 return -EEXIST;
2388
2389 pr_debug("omap_hwmod: registering link from %s to %s\n",
2390 oi->master->name, oi->slave->name);
2391
2392 /*
2393 * Register the connected hwmods, if they haven't been
2394 * registered already
2395 */
2396 if (oi->master->_state != _HWMOD_STATE_REGISTERED)
2397 _register(oi->master);
2398
2399 if (oi->slave->_state != _HWMOD_STATE_REGISTERED)
2400 _register(oi->slave);
2401
2402 _add_link(oi);
2403
2404 oi->_int_flags |= _OCPIF_INT_FLAGS_REGISTERED;
2405
2406 return 0;
2407}
2408
2409/**
2410 * _alloc_linkspace - allocate large block of hwmod links
2411 * @ois: pointer to an array of struct omap_hwmod_ocp_if records to count
2412 *
2413 * Allocate a large block of struct omap_hwmod_link records. This
2414 * improves boot time significantly by avoiding the need to allocate
2415 * individual records one by one. If the number of records to
2416 * allocate in the block hasn't been manually specified, this function
2417 * will count the number of struct omap_hwmod_ocp_if records in @ois
2418 * and use that to determine the allocation size. For SoC families
2419 * that require multiple list registrations, such as OMAP3xxx, this
2420 * estimation process isn't optimal, so manual estimation is advised
2421 * in those cases. Returns -EEXIST if the allocation has already occurred
2422 * or 0 upon success.
2423 */
2424static int __init _alloc_linkspace(struct omap_hwmod_ocp_if **ois)
2425{
2426 unsigned int i = 0;
2427 unsigned int sz;
2428
2429 if (linkspace) {
2430 WARN(1, "linkspace already allocated\n");
2431 return -EEXIST;
2432 }
2433
2434 if (max_ls == 0)
2435 while (ois[i++])
2436 max_ls += LINKS_PER_OCP_IF;
2437
2438 sz = sizeof(struct omap_hwmod_link) * max_ls;
2439
2440 pr_debug("omap_hwmod: %s: allocating %d byte linkspace (%d links)\n",
2441 __func__, sz, max_ls);
2442
2443 linkspace = alloc_bootmem(sz);
2444
2445 memset(linkspace, 0, sz);
2446
2447 return 0;
2448}
2449
2450/* Public functions */
2451
2452u32 omap_hwmod_read(struct omap_hwmod *oh, u16 reg_offs)
2453{
2454 if (oh->flags & HWMOD_16BIT_REG)
2455 return __raw_readw(oh->_mpu_rt_va + reg_offs);
2456 else
2457 return __raw_readl(oh->_mpu_rt_va + reg_offs);
2458}
2459
2460void omap_hwmod_write(u32 v, struct omap_hwmod *oh, u16 reg_offs)
2461{
2462 if (oh->flags & HWMOD_16BIT_REG)
2463 __raw_writew(v, oh->_mpu_rt_va + reg_offs);
2464 else
2465 __raw_writel(v, oh->_mpu_rt_va + reg_offs);
2466}
2467
2468/**
2469 * omap_hwmod_softreset - reset a module via SYSCONFIG.SOFTRESET bit
2470 * @oh: struct omap_hwmod *
2471 *
2472 * This is a public function exposed to drivers. Some drivers may need to do
2473 * some settings before and after resetting the device. Those drivers after
2474 * doing the necessary settings could use this function to start a reset by
2475 * setting the SYSCONFIG.SOFTRESET bit.
2476 */
2477int omap_hwmod_softreset(struct omap_hwmod *oh)
2478{
2479 u32 v;
2480 int ret;
2481
2482 if (!oh || !(oh->_sysc_cache))
2483 return -EINVAL;
2484
2485 v = oh->_sysc_cache;
2486 ret = _set_softreset(oh, &v);
2487 if (ret)
2488 goto error;
2489 _write_sysconfig(v, oh);
2490
2491error:
2492 return ret;
2493}
2494
2495/**
2496 * omap_hwmod_set_slave_idlemode - set the hwmod's OCP slave idlemode
2497 * @oh: struct omap_hwmod *
2498 * @idlemode: SIDLEMODE field bits (shifted to bit 0)
2499 *
2500 * Sets the IP block's OCP slave idlemode in hardware, and updates our
2501 * local copy. Intended to be used by drivers that have some erratum
2502 * that requires direct manipulation of the SIDLEMODE bits. Returns
2503 * -EINVAL if @oh is null, or passes along the return value from
2504 * _set_slave_idlemode().
2505 *
2506 * XXX Does this function have any current users? If not, we should
2507 * remove it; it is better to let the rest of the hwmod code handle this.
2508 * Any users of this function should be scrutinized carefully.
2509 */
2510int omap_hwmod_set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode)
2511{
2512 u32 v;
2513 int retval = 0;
2514
2515 if (!oh)
2516 return -EINVAL;
2517
2518 v = oh->_sysc_cache;
2519
2520 retval = _set_slave_idlemode(oh, idlemode, &v);
2521 if (!retval)
2522 _write_sysconfig(v, oh);
2523
2524 return retval;
2525}
2526
2527/**
2528 * omap_hwmod_lookup - look up a registered omap_hwmod by name
2529 * @name: name of the omap_hwmod to look up
2530 *
2531 * Given a @name of an omap_hwmod, return a pointer to the registered
2532 * struct omap_hwmod *, or NULL upon error.
2533 */
2534struct omap_hwmod *omap_hwmod_lookup(const char *name)
2535{
2536 struct omap_hwmod *oh;
2537
2538 if (!name)
2539 return NULL;
2540
2541 oh = _lookup(name);
2542
2543 return oh;
2544}
2545
2546/**
2547 * omap_hwmod_for_each - call function for each registered omap_hwmod
2548 * @fn: pointer to a callback function
2549 * @data: void * data to pass to callback function
2550 *
2551 * Call @fn for each registered omap_hwmod, passing @data to each
2552 * function. @fn must return 0 for success or any other value for
2553 * failure. If @fn returns non-zero, the iteration across omap_hwmods
2554 * will stop and the non-zero return value will be passed to the
2555 * caller of omap_hwmod_for_each(). @fn is called with
2556 * omap_hwmod_for_each() held.
2557 */
2558int omap_hwmod_for_each(int (*fn)(struct omap_hwmod *oh, void *data),
2559 void *data)
2560{
2561 struct omap_hwmod *temp_oh;
2562 int ret = 0;
2563
2564 if (!fn)
2565 return -EINVAL;
2566
2567 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
2568 ret = (*fn)(temp_oh, data);
2569 if (ret)
2570 break;
2571 }
2572
2573 return ret;
2574}
2575
2576/**
2577 * omap_hwmod_register_links - register an array of hwmod links
2578 * @ois: pointer to an array of omap_hwmod_ocp_if to register
2579 *
2580 * Intended to be called early in boot before the clock framework is
2581 * initialized. If @ois is not null, will register all omap_hwmods
2582 * listed in @ois that are valid for this chip. Returns 0.
2583 */
2584int __init omap_hwmod_register_links(struct omap_hwmod_ocp_if **ois)
2585{
2586 int r, i;
2587
2588 if (!ois)
2589 return 0;
2590
2591 if (!linkspace) {
2592 if (_alloc_linkspace(ois)) {
2593 pr_err("omap_hwmod: could not allocate link space\n");
2594 return -ENOMEM;
2595 }
2596 }
2597
2598 i = 0;
2599 do {
2600 r = _register_link(ois[i]);
2601 WARN(r && r != -EEXIST,
2602 "omap_hwmod: _register_link(%s -> %s) returned %d\n",
2603 ois[i]->master->name, ois[i]->slave->name, r);
2604 } while (ois[++i]);
2605
2606 return 0;
2607}
2608
2609/**
2610 * _ensure_mpu_hwmod_is_setup - ensure the MPU SS hwmod is init'ed and set up
2611 * @oh: pointer to the hwmod currently being set up (usually not the MPU)
2612 *
2613 * If the hwmod data corresponding to the MPU subsystem IP block
2614 * hasn't been initialized and set up yet, do so now. This must be
2615 * done first since sleep dependencies may be added from other hwmods
2616 * to the MPU. Intended to be called only by omap_hwmod_setup*(). No
2617 * return value.
2618 */
2619static void __init _ensure_mpu_hwmod_is_setup(struct omap_hwmod *oh)
2620{
2621 if (!mpu_oh || mpu_oh->_state == _HWMOD_STATE_UNKNOWN)
2622 pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",
2623 __func__, MPU_INITIATOR_NAME);
2624 else if (mpu_oh->_state == _HWMOD_STATE_REGISTERED && oh != mpu_oh)
2625 omap_hwmod_setup_one(MPU_INITIATOR_NAME);
2626}
2627
2628/**
2629 * omap_hwmod_setup_one - set up a single hwmod
2630 * @oh_name: const char * name of the already-registered hwmod to set up
2631 *
2632 * Initialize and set up a single hwmod. Intended to be used for a
2633 * small number of early devices, such as the timer IP blocks used for
2634 * the scheduler clock. Must be called after omap2_clk_init().
2635 * Resolves the struct clk names to struct clk pointers for each
2636 * registered omap_hwmod. Also calls _setup() on each hwmod. Returns
2637 * -EINVAL upon error or 0 upon success.
2638 */
2639int __init omap_hwmod_setup_one(const char *oh_name)
2640{
2641 struct omap_hwmod *oh;
2642
2643 pr_debug("omap_hwmod: %s: %s\n", oh_name, __func__);
2644
2645 oh = _lookup(oh_name);
2646 if (!oh) {
2647 WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name);
2648 return -EINVAL;
2649 }
2650
2651 _ensure_mpu_hwmod_is_setup(oh);
2652
2653 _init(oh, NULL);
2654 _setup(oh, NULL);
2655
2656 return 0;
2657}
2658
2659/**
2660 * omap_hwmod_setup_all - set up all registered IP blocks
2661 *
2662 * Initialize and set up all IP blocks registered with the hwmod code.
2663 * Must be called after omap2_clk_init(). Resolves the struct clk
2664 * names to struct clk pointers for each registered omap_hwmod. Also
2665 * calls _setup() on each hwmod. Returns 0 upon success.
2666 */
2667static int __init omap_hwmod_setup_all(void)
2668{
2669 _ensure_mpu_hwmod_is_setup(NULL);
2670
2671 omap_hwmod_for_each(_init, NULL);
2672 omap_hwmod_for_each(_setup, NULL);
2673
2674 return 0;
2675}
2676core_initcall(omap_hwmod_setup_all);
2677
2678/**
2679 * omap_hwmod_enable - enable an omap_hwmod
2680 * @oh: struct omap_hwmod *
2681 *
2682 * Enable an omap_hwmod @oh. Intended to be called by omap_device_enable().
2683 * Returns -EINVAL on error or passes along the return value from _enable().
2684 */
2685int omap_hwmod_enable(struct omap_hwmod *oh)
2686{
2687 int r;
2688 unsigned long flags;
2689
2690 if (!oh)
2691 return -EINVAL;
2692
2693 spin_lock_irqsave(&oh->_lock, flags);
2694 r = _enable(oh);
2695 spin_unlock_irqrestore(&oh->_lock, flags);
2696
2697 return r;
2698}
2699
2700/**
2701 * omap_hwmod_idle - idle an omap_hwmod
2702 * @oh: struct omap_hwmod *
2703 *
2704 * Idle an omap_hwmod @oh. Intended to be called by omap_device_idle().
2705 * Returns -EINVAL on error or passes along the return value from _idle().
2706 */
2707int omap_hwmod_idle(struct omap_hwmod *oh)
2708{
2709 unsigned long flags;
2710
2711 if (!oh)
2712 return -EINVAL;
2713
2714 spin_lock_irqsave(&oh->_lock, flags);
2715 _idle(oh);
2716 spin_unlock_irqrestore(&oh->_lock, flags);
2717
2718 return 0;
2719}
2720
2721/**
2722 * omap_hwmod_shutdown - shutdown an omap_hwmod
2723 * @oh: struct omap_hwmod *
2724 *
2725 * Shutdown an omap_hwmod @oh. Intended to be called by
2726 * omap_device_shutdown(). Returns -EINVAL on error or passes along
2727 * the return value from _shutdown().
2728 */
2729int omap_hwmod_shutdown(struct omap_hwmod *oh)
2730{
2731 unsigned long flags;
2732
2733 if (!oh)
2734 return -EINVAL;
2735
2736 spin_lock_irqsave(&oh->_lock, flags);
2737 _shutdown(oh);
2738 spin_unlock_irqrestore(&oh->_lock, flags);
2739
2740 return 0;
2741}
2742
2743/**
2744 * omap_hwmod_enable_clocks - enable main_clk, all interface clocks
2745 * @oh: struct omap_hwmod *oh
2746 *
2747 * Intended to be called by the omap_device code.
2748 */
2749int omap_hwmod_enable_clocks(struct omap_hwmod *oh)
2750{
2751 unsigned long flags;
2752
2753 spin_lock_irqsave(&oh->_lock, flags);
2754 _enable_clocks(oh);
2755 spin_unlock_irqrestore(&oh->_lock, flags);
2756
2757 return 0;
2758}
2759
2760/**
2761 * omap_hwmod_disable_clocks - disable main_clk, all interface clocks
2762 * @oh: struct omap_hwmod *oh
2763 *
2764 * Intended to be called by the omap_device code.
2765 */
2766int omap_hwmod_disable_clocks(struct omap_hwmod *oh)
2767{
2768 unsigned long flags;
2769
2770 spin_lock_irqsave(&oh->_lock, flags);
2771 _disable_clocks(oh);
2772 spin_unlock_irqrestore(&oh->_lock, flags);
2773
2774 return 0;
2775}
2776
2777/**
2778 * omap_hwmod_ocp_barrier - wait for posted writes against the hwmod to complete
2779 * @oh: struct omap_hwmod *oh
2780 *
2781 * Intended to be called by drivers and core code when all posted
2782 * writes to a device must complete before continuing further
2783 * execution (for example, after clearing some device IRQSTATUS
2784 * register bits)
2785 *
2786 * XXX what about targets with multiple OCP threads?
2787 */
2788void omap_hwmod_ocp_barrier(struct omap_hwmod *oh)
2789{
2790 BUG_ON(!oh);
2791
2792 if (!oh->class->sysc || !oh->class->sysc->sysc_flags) {
2793 WARN(1, "omap_device: %s: OCP barrier impossible due to device configuration\n",
2794 oh->name);
2795 return;
2796 }
2797
2798 /*
2799 * Forces posted writes to complete on the OCP thread handling
2800 * register writes
2801 */
2802 omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
2803}
2804
2805/**
2806 * omap_hwmod_reset - reset the hwmod
2807 * @oh: struct omap_hwmod *
2808 *
2809 * Under some conditions, a driver may wish to reset the entire device.
2810 * Called from omap_device code. Returns -EINVAL on error or passes along
2811 * the return value from _reset().
2812 */
2813int omap_hwmod_reset(struct omap_hwmod *oh)
2814{
2815 int r;
2816 unsigned long flags;
2817
2818 if (!oh)
2819 return -EINVAL;
2820
2821 spin_lock_irqsave(&oh->_lock, flags);
2822 r = _reset(oh);
2823 spin_unlock_irqrestore(&oh->_lock, flags);
2824
2825 return r;
2826}
2827
2828/*
2829 * IP block data retrieval functions
2830 */
2831
2832/**
2833 * omap_hwmod_count_resources - count number of struct resources needed by hwmod
2834 * @oh: struct omap_hwmod *
2835 * @res: pointer to the first element of an array of struct resource to fill
2836 *
2837 * Count the number of struct resource array elements necessary to
2838 * contain omap_hwmod @oh resources. Intended to be called by code
2839 * that registers omap_devices. Intended to be used to determine the
2840 * size of a dynamically-allocated struct resource array, before
2841 * calling omap_hwmod_fill_resources(). Returns the number of struct
2842 * resource array elements needed.
2843 *
2844 * XXX This code is not optimized. It could attempt to merge adjacent
2845 * resource IDs.
2846 *
2847 */
2848int omap_hwmod_count_resources(struct omap_hwmod *oh)
2849{
2850 struct omap_hwmod_ocp_if *os;
2851 struct list_head *p;
2852 int ret;
2853 int i = 0;
2854
2855 ret = _count_mpu_irqs(oh) + _count_sdma_reqs(oh);
2856
2857 p = oh->slave_ports.next;
2858
2859 while (i < oh->slaves_cnt) {
2860 os = _fetch_next_ocp_if(&p, &i);
2861 ret += _count_ocp_if_addr_spaces(os);
2862 }
2863
2864 return ret;
2865}
2866
2867/**
2868 * omap_hwmod_fill_resources - fill struct resource array with hwmod data
2869 * @oh: struct omap_hwmod *
2870 * @res: pointer to the first element of an array of struct resource to fill
2871 *
2872 * Fill the struct resource array @res with resource data from the
2873 * omap_hwmod @oh. Intended to be called by code that registers
2874 * omap_devices. See also omap_hwmod_count_resources(). Returns the
2875 * number of array elements filled.
2876 */
2877int omap_hwmod_fill_resources(struct omap_hwmod *oh, struct resource *res)
2878{
2879 struct omap_hwmod_ocp_if *os;
2880 struct list_head *p;
2881 int i, j, mpu_irqs_cnt, sdma_reqs_cnt, addr_cnt;
2882 int r = 0;
2883
2884 /* For each IRQ, DMA, memory area, fill in array.*/
2885
2886 mpu_irqs_cnt = _count_mpu_irqs(oh);
2887 for (i = 0; i < mpu_irqs_cnt; i++) {
2888 (res + r)->name = (oh->mpu_irqs + i)->name;
2889 (res + r)->start = (oh->mpu_irqs + i)->irq;
2890 (res + r)->end = (oh->mpu_irqs + i)->irq;
2891 (res + r)->flags = IORESOURCE_IRQ;
2892 r++;
2893 }
2894
2895 sdma_reqs_cnt = _count_sdma_reqs(oh);
2896 for (i = 0; i < sdma_reqs_cnt; i++) {
2897 (res + r)->name = (oh->sdma_reqs + i)->name;
2898 (res + r)->start = (oh->sdma_reqs + i)->dma_req;
2899 (res + r)->end = (oh->sdma_reqs + i)->dma_req;
2900 (res + r)->flags = IORESOURCE_DMA;
2901 r++;
2902 }
2903
2904 p = oh->slave_ports.next;
2905
2906 i = 0;
2907 while (i < oh->slaves_cnt) {
2908 os = _fetch_next_ocp_if(&p, &i);
2909 addr_cnt = _count_ocp_if_addr_spaces(os);
2910
2911 for (j = 0; j < addr_cnt; j++) {
2912 (res + r)->name = (os->addr + j)->name;
2913 (res + r)->start = (os->addr + j)->pa_start;
2914 (res + r)->end = (os->addr + j)->pa_end;
2915 (res + r)->flags = IORESOURCE_MEM;
2916 r++;
2917 }
2918 }
2919
2920 return r;
2921}
2922
2923/**
2924 * omap_hwmod_get_resource_byname - fetch IP block integration data by name
2925 * @oh: struct omap_hwmod * to operate on
2926 * @type: one of the IORESOURCE_* constants from include/linux/ioport.h
2927 * @name: pointer to the name of the data to fetch (optional)
2928 * @rsrc: pointer to a struct resource, allocated by the caller
2929 *
2930 * Retrieve MPU IRQ, SDMA request line, or address space start/end
2931 * data for the IP block pointed to by @oh. The data will be filled
2932 * into a struct resource record pointed to by @rsrc. The struct
2933 * resource must be allocated by the caller. When @name is non-null,
2934 * the data associated with the matching entry in the IRQ/SDMA/address
2935 * space hwmod data arrays will be returned. If @name is null, the
2936 * first array entry will be returned. Data order is not meaningful
2937 * in hwmod data, so callers are strongly encouraged to use a non-null
2938 * @name whenever possible to avoid unpredictable effects if hwmod
2939 * data is later added that causes data ordering to change. This
2940 * function is only intended for use by OMAP core code. Device
2941 * drivers should not call this function - the appropriate bus-related
2942 * data accessor functions should be used instead. Returns 0 upon
2943 * success or a negative error code upon error.
2944 */
2945int omap_hwmod_get_resource_byname(struct omap_hwmod *oh, unsigned int type,
2946 const char *name, struct resource *rsrc)
2947{
2948 int r;
2949 unsigned int irq, dma;
2950 u32 pa_start, pa_end;
2951
2952 if (!oh || !rsrc)
2953 return -EINVAL;
2954
2955 if (type == IORESOURCE_IRQ) {
2956 r = _get_mpu_irq_by_name(oh, name, &irq);
2957 if (r)
2958 return r;
2959
2960 rsrc->start = irq;
2961 rsrc->end = irq;
2962 } else if (type == IORESOURCE_DMA) {
2963 r = _get_sdma_req_by_name(oh, name, &dma);
2964 if (r)
2965 return r;
2966
2967 rsrc->start = dma;
2968 rsrc->end = dma;
2969 } else if (type == IORESOURCE_MEM) {
2970 r = _get_addr_space_by_name(oh, name, &pa_start, &pa_end);
2971 if (r)
2972 return r;
2973
2974 rsrc->start = pa_start;
2975 rsrc->end = pa_end;
2976 } else {
2977 return -EINVAL;
2978 }
2979
2980 rsrc->flags = type;
2981 rsrc->name = name;
2982
2983 return 0;
2984}
2985
2986/**
2987 * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
2988 * @oh: struct omap_hwmod *
2989 *
2990 * Return the powerdomain pointer associated with the OMAP module
2991 * @oh's main clock. If @oh does not have a main clk, return the
2992 * powerdomain associated with the interface clock associated with the
2993 * module's MPU port. (XXX Perhaps this should use the SDMA port
2994 * instead?) Returns NULL on error, or a struct powerdomain * on
2995 * success.
2996 */
2997struct powerdomain *omap_hwmod_get_pwrdm(struct omap_hwmod *oh)
2998{
2999 struct clk *c;
3000 struct omap_hwmod_ocp_if *oi;
3001
3002 if (!oh)
3003 return NULL;
3004
3005 if (oh->_clk) {
3006 c = oh->_clk;
3007 } else {
3008 oi = _find_mpu_rt_port(oh);
3009 if (!oi)
3010 return NULL;
3011 c = oi->_clk;
3012 }
3013
3014 if (!c->clkdm)
3015 return NULL;
3016
3017 return c->clkdm->pwrdm.ptr;
3018
3019}
3020
3021/**
3022 * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
3023 * @oh: struct omap_hwmod *
3024 *
3025 * Returns the virtual address corresponding to the beginning of the
3026 * module's register target, in the address range that is intended to
3027 * be used by the MPU. Returns the virtual address upon success or NULL
3028 * upon error.
3029 */
3030void __iomem *omap_hwmod_get_mpu_rt_va(struct omap_hwmod *oh)
3031{
3032 if (!oh)
3033 return NULL;
3034
3035 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
3036 return NULL;
3037
3038 if (oh->_state == _HWMOD_STATE_UNKNOWN)
3039 return NULL;
3040
3041 return oh->_mpu_rt_va;
3042}
3043
3044/**
3045 * omap_hwmod_add_initiator_dep - add sleepdep from @init_oh to @oh
3046 * @oh: struct omap_hwmod *
3047 * @init_oh: struct omap_hwmod * (initiator)
3048 *
3049 * Add a sleep dependency between the initiator @init_oh and @oh.
3050 * Intended to be called by DSP/Bridge code via platform_data for the
3051 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
3052 * code needs to add/del initiator dependencies dynamically
3053 * before/after accessing a device. Returns the return value from
3054 * _add_initiator_dep().
3055 *
3056 * XXX Keep a usecount in the clockdomain code
3057 */
3058int omap_hwmod_add_initiator_dep(struct omap_hwmod *oh,
3059 struct omap_hwmod *init_oh)
3060{
3061 return _add_initiator_dep(oh, init_oh);
3062}
3063
3064/*
3065 * XXX what about functions for drivers to save/restore ocp_sysconfig
3066 * for context save/restore operations?
3067 */
3068
3069/**
3070 * omap_hwmod_del_initiator_dep - remove sleepdep from @init_oh to @oh
3071 * @oh: struct omap_hwmod *
3072 * @init_oh: struct omap_hwmod * (initiator)
3073 *
3074 * Remove a sleep dependency between the initiator @init_oh and @oh.
3075 * Intended to be called by DSP/Bridge code via platform_data for the
3076 * DSP case; and by the DMA code in the sDMA case. DMA code, *Bridge
3077 * code needs to add/del initiator dependencies dynamically
3078 * before/after accessing a device. Returns the return value from
3079 * _del_initiator_dep().
3080 *
3081 * XXX Keep a usecount in the clockdomain code
3082 */
3083int omap_hwmod_del_initiator_dep(struct omap_hwmod *oh,
3084 struct omap_hwmod *init_oh)
3085{
3086 return _del_initiator_dep(oh, init_oh);
3087}
3088
3089/**
3090 * omap_hwmod_enable_wakeup - allow device to wake up the system
3091 * @oh: struct omap_hwmod *
3092 *
3093 * Sets the module OCP socket ENAWAKEUP bit to allow the module to
3094 * send wakeups to the PRCM, and enable I/O ring wakeup events for
3095 * this IP block if it has dynamic mux entries. Eventually this
3096 * should set PRCM wakeup registers to cause the PRCM to receive
3097 * wakeup events from the module. Does not set any wakeup routing
3098 * registers beyond this point - if the module is to wake up any other
3099 * module or subsystem, that must be set separately. Called by
3100 * omap_device code. Returns -EINVAL on error or 0 upon success.
3101 */
3102int omap_hwmod_enable_wakeup(struct omap_hwmod *oh)
3103{
3104 unsigned long flags;
3105 u32 v;
3106
3107 spin_lock_irqsave(&oh->_lock, flags);
3108
3109 if (oh->class->sysc &&
3110 (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)) {
3111 v = oh->_sysc_cache;
3112 _enable_wakeup(oh, &v);
3113 _write_sysconfig(v, oh);
3114 }
3115
3116 _set_idle_ioring_wakeup(oh, true);
3117 spin_unlock_irqrestore(&oh->_lock, flags);
3118
3119 return 0;
3120}
3121
3122/**
3123 * omap_hwmod_disable_wakeup - prevent device from waking the system
3124 * @oh: struct omap_hwmod *
3125 *
3126 * Clears the module OCP socket ENAWAKEUP bit to prevent the module
3127 * from sending wakeups to the PRCM, and disable I/O ring wakeup
3128 * events for this IP block if it has dynamic mux entries. Eventually
3129 * this should clear PRCM wakeup registers to cause the PRCM to ignore
3130 * wakeup events from the module. Does not set any wakeup routing
3131 * registers beyond this point - if the module is to wake up any other
3132 * module or subsystem, that must be set separately. Called by
3133 * omap_device code. Returns -EINVAL on error or 0 upon success.
3134 */
3135int omap_hwmod_disable_wakeup(struct omap_hwmod *oh)
3136{
3137 unsigned long flags;
3138 u32 v;
3139
3140 spin_lock_irqsave(&oh->_lock, flags);
3141
3142 if (oh->class->sysc &&
3143 (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)) {
3144 v = oh->_sysc_cache;
3145 _disable_wakeup(oh, &v);
3146 _write_sysconfig(v, oh);
3147 }
3148
3149 _set_idle_ioring_wakeup(oh, false);
3150 spin_unlock_irqrestore(&oh->_lock, flags);
3151
3152 return 0;
3153}
3154
3155/**
3156 * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
3157 * contained in the hwmod module.
3158 * @oh: struct omap_hwmod *
3159 * @name: name of the reset line to lookup and assert
3160 *
3161 * Some IP like dsp, ipu or iva contain processor that require
3162 * an HW reset line to be assert / deassert in order to enable fully
3163 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3164 * yet supported on this OMAP; otherwise, passes along the return value
3165 * from _assert_hardreset().
3166 */
3167int omap_hwmod_assert_hardreset(struct omap_hwmod *oh, const char *name)
3168{
3169 int ret;
3170 unsigned long flags;
3171
3172 if (!oh)
3173 return -EINVAL;
3174
3175 spin_lock_irqsave(&oh->_lock, flags);
3176 ret = _assert_hardreset(oh, name);
3177 spin_unlock_irqrestore(&oh->_lock, flags);
3178
3179 return ret;
3180}
3181
3182/**
3183 * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
3184 * contained in the hwmod module.
3185 * @oh: struct omap_hwmod *
3186 * @name: name of the reset line to look up and deassert
3187 *
3188 * Some IP like dsp, ipu or iva contain processor that require
3189 * an HW reset line to be assert / deassert in order to enable fully
3190 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3191 * yet supported on this OMAP; otherwise, passes along the return value
3192 * from _deassert_hardreset().
3193 */
3194int omap_hwmod_deassert_hardreset(struct omap_hwmod *oh, const char *name)
3195{
3196 int ret;
3197 unsigned long flags;
3198
3199 if (!oh)
3200 return -EINVAL;
3201
3202 spin_lock_irqsave(&oh->_lock, flags);
3203 ret = _deassert_hardreset(oh, name);
3204 spin_unlock_irqrestore(&oh->_lock, flags);
3205
3206 return ret;
3207}
3208
3209/**
3210 * omap_hwmod_read_hardreset - read the HW reset line state of submodules
3211 * contained in the hwmod module
3212 * @oh: struct omap_hwmod *
3213 * @name: name of the reset line to look up and read
3214 *
3215 * Return the current state of the hwmod @oh's reset line named @name:
3216 * returns -EINVAL upon parameter error or if this operation
3217 * is unsupported on the current OMAP; otherwise, passes along the return
3218 * value from _read_hardreset().
3219 */
3220int omap_hwmod_read_hardreset(struct omap_hwmod *oh, const char *name)
3221{
3222 int ret;
3223 unsigned long flags;
3224
3225 if (!oh)
3226 return -EINVAL;
3227
3228 spin_lock_irqsave(&oh->_lock, flags);
3229 ret = _read_hardreset(oh, name);
3230 spin_unlock_irqrestore(&oh->_lock, flags);
3231
3232 return ret;
3233}
3234
3235
3236/**
3237 * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
3238 * @classname: struct omap_hwmod_class name to search for
3239 * @fn: callback function pointer to call for each hwmod in class @classname
3240 * @user: arbitrary context data to pass to the callback function
3241 *
3242 * For each omap_hwmod of class @classname, call @fn.
3243 * If the callback function returns something other than
3244 * zero, the iterator is terminated, and the callback function's return
3245 * value is passed back to the caller. Returns 0 upon success, -EINVAL
3246 * if @classname or @fn are NULL, or passes back the error code from @fn.
3247 */
3248int omap_hwmod_for_each_by_class(const char *classname,
3249 int (*fn)(struct omap_hwmod *oh,
3250 void *user),
3251 void *user)
3252{
3253 struct omap_hwmod *temp_oh;
3254 int ret = 0;
3255
3256 if (!classname || !fn)
3257 return -EINVAL;
3258
3259 pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
3260 __func__, classname);
3261
3262 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
3263 if (!strcmp(temp_oh->class->name, classname)) {
3264 pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
3265 __func__, temp_oh->name);
3266 ret = (*fn)(temp_oh, user);
3267 if (ret)
3268 break;
3269 }
3270 }
3271
3272 if (ret)
3273 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
3274 __func__, ret);
3275
3276 return ret;
3277}
3278
3279/**
3280 * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
3281 * @oh: struct omap_hwmod *
3282 * @state: state that _setup() should leave the hwmod in
3283 *
3284 * Sets the hwmod state that @oh will enter at the end of _setup()
3285 * (called by omap_hwmod_setup_*()). See also the documentation
3286 * for _setup_postsetup(), above. Returns 0 upon success or
3287 * -EINVAL if there is a problem with the arguments or if the hwmod is
3288 * in the wrong state.
3289 */
3290int omap_hwmod_set_postsetup_state(struct omap_hwmod *oh, u8 state)
3291{
3292 int ret;
3293 unsigned long flags;
3294
3295 if (!oh)
3296 return -EINVAL;
3297
3298 if (state != _HWMOD_STATE_DISABLED &&
3299 state != _HWMOD_STATE_ENABLED &&
3300 state != _HWMOD_STATE_IDLE)
3301 return -EINVAL;
3302
3303 spin_lock_irqsave(&oh->_lock, flags);
3304
3305 if (oh->_state != _HWMOD_STATE_REGISTERED) {
3306 ret = -EINVAL;
3307 goto ohsps_unlock;
3308 }
3309
3310 oh->_postsetup_state = state;
3311 ret = 0;
3312
3313ohsps_unlock:
3314 spin_unlock_irqrestore(&oh->_lock, flags);
3315
3316 return ret;
3317}
3318
3319/**
3320 * omap_hwmod_get_context_loss_count - get lost context count
3321 * @oh: struct omap_hwmod *
3322 *
3323 * Query the powerdomain of of @oh to get the context loss
3324 * count for this device.
3325 *
3326 * Returns the context loss count of the powerdomain assocated with @oh
3327 * upon success, or zero if no powerdomain exists for @oh.
3328 */
3329int omap_hwmod_get_context_loss_count(struct omap_hwmod *oh)
3330{
3331 struct powerdomain *pwrdm;
3332 int ret = 0;
3333
3334 pwrdm = omap_hwmod_get_pwrdm(oh);
3335 if (pwrdm)
3336 ret = pwrdm_get_context_loss_count(pwrdm);
3337
3338 return ret;
3339}
3340
3341/**
3342 * omap_hwmod_no_setup_reset - prevent a hwmod from being reset upon setup
3343 * @oh: struct omap_hwmod *
3344 *
3345 * Prevent the hwmod @oh from being reset during the setup process.
3346 * Intended for use by board-*.c files on boards with devices that
3347 * cannot tolerate being reset. Must be called before the hwmod has
3348 * been set up. Returns 0 upon success or negative error code upon
3349 * failure.
3350 */
3351int omap_hwmod_no_setup_reset(struct omap_hwmod *oh)
3352{
3353 if (!oh)
3354 return -EINVAL;
3355
3356 if (oh->_state != _HWMOD_STATE_REGISTERED) {
3357 pr_err("omap_hwmod: %s: cannot prevent setup reset; in wrong state\n",
3358 oh->name);
3359 return -EINVAL;
3360 }
3361
3362 oh->flags |= HWMOD_INIT_NO_RESET;
3363
3364 return 0;
3365}
3366
3367/**
3368 * omap_hwmod_pad_route_irq - route an I/O pad wakeup to a particular MPU IRQ
3369 * @oh: struct omap_hwmod * containing hwmod mux entries
3370 * @pad_idx: array index in oh->mux of the hwmod mux entry to route wakeup
3371 * @irq_idx: the hwmod mpu_irqs array index of the IRQ to trigger on wakeup
3372 *
3373 * When an I/O pad wakeup arrives for the dynamic or wakeup hwmod mux
3374 * entry number @pad_idx for the hwmod @oh, trigger the interrupt
3375 * service routine for the hwmod's mpu_irqs array index @irq_idx. If
3376 * this function is not called for a given pad_idx, then the ISR
3377 * associated with @oh's first MPU IRQ will be triggered when an I/O
3378 * pad wakeup occurs on that pad. Note that @pad_idx is the index of
3379 * the _dynamic or wakeup_ entry: if there are other entries not
3380 * marked with OMAP_DEVICE_PAD_WAKEUP or OMAP_DEVICE_PAD_REMUX, these
3381 * entries are NOT COUNTED in the dynamic pad index. This function
3382 * must be called separately for each pad that requires its interrupt
3383 * to be re-routed this way. Returns -EINVAL if there is an argument
3384 * problem or if @oh does not have hwmod mux entries or MPU IRQs;
3385 * returns -ENOMEM if memory cannot be allocated; or 0 upon success.
3386 *
3387 * XXX This function interface is fragile. Rather than using array
3388 * indexes, which are subject to unpredictable change, it should be
3389 * using hwmod IRQ names, and some other stable key for the hwmod mux
3390 * pad records.
3391 */
3392int omap_hwmod_pad_route_irq(struct omap_hwmod *oh, int pad_idx, int irq_idx)
3393{
3394 int nr_irqs;
3395
3396 might_sleep();
3397
3398 if (!oh || !oh->mux || !oh->mpu_irqs || pad_idx < 0 ||
3399 pad_idx >= oh->mux->nr_pads_dynamic)
3400 return -EINVAL;
3401
3402 /* Check the number of available mpu_irqs */
3403 for (nr_irqs = 0; oh->mpu_irqs[nr_irqs].irq >= 0; nr_irqs++)
3404 ;
3405
3406 if (irq_idx >= nr_irqs)
3407 return -EINVAL;
3408
3409 if (!oh->mux->irqs) {
3410 /* XXX What frees this? */
3411 oh->mux->irqs = kzalloc(sizeof(int) * oh->mux->nr_pads_dynamic,
3412 GFP_KERNEL);
3413 if (!oh->mux->irqs)
3414 return -ENOMEM;
3415 }
3416 oh->mux->irqs[pad_idx] = irq_idx;
3417
3418 return 0;
3419}