Loading...
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}
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 * | ({read,write}l_relaxed, 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/clk-provider.h>
135#include <linux/delay.h>
136#include <linux/err.h>
137#include <linux/list.h>
138#include <linux/mutex.h>
139#include <linux/spinlock.h>
140#include <linux/slab.h>
141#include <linux/cpu.h>
142#include <linux/of.h>
143#include <linux/of_address.h>
144#include <linux/bootmem.h>
145
146#include <linux/platform_data/ti-sysc.h>
147
148#include <dt-bindings/bus/ti-sysc.h>
149
150#include <asm/system_misc.h>
151
152#include "clock.h"
153#include "omap_hwmod.h"
154
155#include "soc.h"
156#include "common.h"
157#include "clockdomain.h"
158#include "powerdomain.h"
159#include "cm2xxx.h"
160#include "cm3xxx.h"
161#include "cm33xx.h"
162#include "prm.h"
163#include "prm3xxx.h"
164#include "prm44xx.h"
165#include "prm33xx.h"
166#include "prminst44xx.h"
167#include "pm.h"
168
169/* Name of the OMAP hwmod for the MPU */
170#define MPU_INITIATOR_NAME "mpu"
171
172/*
173 * Number of struct omap_hwmod_link records per struct
174 * omap_hwmod_ocp_if record (master->slave and slave->master)
175 */
176#define LINKS_PER_OCP_IF 2
177
178/*
179 * Address offset (in bytes) between the reset control and the reset
180 * status registers: 4 bytes on OMAP4
181 */
182#define OMAP4_RST_CTRL_ST_OFFSET 4
183
184/*
185 * Maximum length for module clock handle names
186 */
187#define MOD_CLK_MAX_NAME_LEN 32
188
189/**
190 * struct clkctrl_provider - clkctrl provider mapping data
191 * @addr: base address for the provider
192 * @size: size of the provider address space
193 * @offset: offset of the provider from PRCM instance base
194 * @node: device node associated with the provider
195 * @link: list link
196 */
197struct clkctrl_provider {
198 u32 addr;
199 u32 size;
200 u16 offset;
201 struct device_node *node;
202 struct list_head link;
203};
204
205static LIST_HEAD(clkctrl_providers);
206
207/**
208 * struct omap_hwmod_soc_ops - fn ptrs for some SoC-specific operations
209 * @enable_module: function to enable a module (via MODULEMODE)
210 * @disable_module: function to disable a module (via MODULEMODE)
211 *
212 * XXX Eventually this functionality will be hidden inside the PRM/CM
213 * device drivers. Until then, this should avoid huge blocks of cpu_is_*()
214 * conditionals in this code.
215 */
216struct omap_hwmod_soc_ops {
217 void (*enable_module)(struct omap_hwmod *oh);
218 int (*disable_module)(struct omap_hwmod *oh);
219 int (*wait_target_ready)(struct omap_hwmod *oh);
220 int (*assert_hardreset)(struct omap_hwmod *oh,
221 struct omap_hwmod_rst_info *ohri);
222 int (*deassert_hardreset)(struct omap_hwmod *oh,
223 struct omap_hwmod_rst_info *ohri);
224 int (*is_hardreset_asserted)(struct omap_hwmod *oh,
225 struct omap_hwmod_rst_info *ohri);
226 int (*init_clkdm)(struct omap_hwmod *oh);
227 void (*update_context_lost)(struct omap_hwmod *oh);
228 int (*get_context_lost)(struct omap_hwmod *oh);
229 int (*disable_direct_prcm)(struct omap_hwmod *oh);
230 u32 (*xlate_clkctrl)(struct omap_hwmod *oh);
231};
232
233/* soc_ops: adapts the omap_hwmod code to the currently-booted SoC */
234static struct omap_hwmod_soc_ops soc_ops;
235
236/* omap_hwmod_list contains all registered struct omap_hwmods */
237static LIST_HEAD(omap_hwmod_list);
238
239/* mpu_oh: used to add/remove MPU initiator from sleepdep list */
240static struct omap_hwmod *mpu_oh;
241
242/* inited: set to true once the hwmod code is initialized */
243static bool inited;
244
245/* Private functions */
246
247/**
248 * _update_sysc_cache - return the module OCP_SYSCONFIG register, keep copy
249 * @oh: struct omap_hwmod *
250 *
251 * Load the current value of the hwmod OCP_SYSCONFIG register into the
252 * struct omap_hwmod for later use. Returns -EINVAL if the hwmod has no
253 * OCP_SYSCONFIG register or 0 upon success.
254 */
255static int _update_sysc_cache(struct omap_hwmod *oh)
256{
257 if (!oh->class->sysc) {
258 WARN(1, "omap_hwmod: %s: cannot read OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
259 return -EINVAL;
260 }
261
262 /* XXX ensure module interface clock is up */
263
264 oh->_sysc_cache = omap_hwmod_read(oh, oh->class->sysc->sysc_offs);
265
266 if (!(oh->class->sysc->sysc_flags & SYSC_NO_CACHE))
267 oh->_int_flags |= _HWMOD_SYSCONFIG_LOADED;
268
269 return 0;
270}
271
272/**
273 * _write_sysconfig - write a value to the module's OCP_SYSCONFIG register
274 * @v: OCP_SYSCONFIG value to write
275 * @oh: struct omap_hwmod *
276 *
277 * Write @v into the module class' OCP_SYSCONFIG register, if it has
278 * one. No return value.
279 */
280static void _write_sysconfig(u32 v, struct omap_hwmod *oh)
281{
282 if (!oh->class->sysc) {
283 WARN(1, "omap_hwmod: %s: cannot write OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);
284 return;
285 }
286
287 /* XXX ensure module interface clock is up */
288
289 /* Module might have lost context, always update cache and register */
290 oh->_sysc_cache = v;
291
292 /*
293 * Some IP blocks (such as RTC) require unlocking of IP before
294 * accessing its registers. If a function pointer is present
295 * to unlock, then call it before accessing sysconfig and
296 * call lock after writing sysconfig.
297 */
298 if (oh->class->unlock)
299 oh->class->unlock(oh);
300
301 omap_hwmod_write(v, oh, oh->class->sysc->sysc_offs);
302
303 if (oh->class->lock)
304 oh->class->lock(oh);
305}
306
307/**
308 * _set_master_standbymode: set the OCP_SYSCONFIG MIDLEMODE field in @v
309 * @oh: struct omap_hwmod *
310 * @standbymode: MIDLEMODE field bits
311 * @v: pointer to register contents to modify
312 *
313 * Update the master standby mode bits in @v to be @standbymode for
314 * the @oh hwmod. Does not write to the hardware. Returns -EINVAL
315 * upon error or 0 upon success.
316 */
317static int _set_master_standbymode(struct omap_hwmod *oh, u8 standbymode,
318 u32 *v)
319{
320 u32 mstandby_mask;
321 u8 mstandby_shift;
322
323 if (!oh->class->sysc ||
324 !(oh->class->sysc->sysc_flags & SYSC_HAS_MIDLEMODE))
325 return -EINVAL;
326
327 if (!oh->class->sysc->sysc_fields) {
328 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
329 return -EINVAL;
330 }
331
332 mstandby_shift = oh->class->sysc->sysc_fields->midle_shift;
333 mstandby_mask = (0x3 << mstandby_shift);
334
335 *v &= ~mstandby_mask;
336 *v |= __ffs(standbymode) << mstandby_shift;
337
338 return 0;
339}
340
341/**
342 * _set_slave_idlemode: set the OCP_SYSCONFIG SIDLEMODE field in @v
343 * @oh: struct omap_hwmod *
344 * @idlemode: SIDLEMODE field bits
345 * @v: pointer to register contents to modify
346 *
347 * Update the slave idle mode bits in @v to be @idlemode for the @oh
348 * hwmod. Does not write to the hardware. Returns -EINVAL upon error
349 * or 0 upon success.
350 */
351static int _set_slave_idlemode(struct omap_hwmod *oh, u8 idlemode, u32 *v)
352{
353 u32 sidle_mask;
354 u8 sidle_shift;
355
356 if (!oh->class->sysc ||
357 !(oh->class->sysc->sysc_flags & SYSC_HAS_SIDLEMODE))
358 return -EINVAL;
359
360 if (!oh->class->sysc->sysc_fields) {
361 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
362 return -EINVAL;
363 }
364
365 sidle_shift = oh->class->sysc->sysc_fields->sidle_shift;
366 sidle_mask = (0x3 << sidle_shift);
367
368 *v &= ~sidle_mask;
369 *v |= __ffs(idlemode) << sidle_shift;
370
371 return 0;
372}
373
374/**
375 * _set_clockactivity: set OCP_SYSCONFIG.CLOCKACTIVITY bits in @v
376 * @oh: struct omap_hwmod *
377 * @clockact: CLOCKACTIVITY field bits
378 * @v: pointer to register contents to modify
379 *
380 * Update the clockactivity mode bits in @v to be @clockact for the
381 * @oh hwmod. Used for additional powersaving on some modules. Does
382 * not write to the hardware. Returns -EINVAL upon error or 0 upon
383 * success.
384 */
385static int _set_clockactivity(struct omap_hwmod *oh, u8 clockact, u32 *v)
386{
387 u32 clkact_mask;
388 u8 clkact_shift;
389
390 if (!oh->class->sysc ||
391 !(oh->class->sysc->sysc_flags & SYSC_HAS_CLOCKACTIVITY))
392 return -EINVAL;
393
394 if (!oh->class->sysc->sysc_fields) {
395 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
396 return -EINVAL;
397 }
398
399 clkact_shift = oh->class->sysc->sysc_fields->clkact_shift;
400 clkact_mask = (0x3 << clkact_shift);
401
402 *v &= ~clkact_mask;
403 *v |= clockact << clkact_shift;
404
405 return 0;
406}
407
408/**
409 * _set_softreset: set OCP_SYSCONFIG.SOFTRESET bit in @v
410 * @oh: struct omap_hwmod *
411 * @v: pointer to register contents to modify
412 *
413 * Set the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
414 * error or 0 upon success.
415 */
416static int _set_softreset(struct omap_hwmod *oh, u32 *v)
417{
418 u32 softrst_mask;
419
420 if (!oh->class->sysc ||
421 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
422 return -EINVAL;
423
424 if (!oh->class->sysc->sysc_fields) {
425 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
426 return -EINVAL;
427 }
428
429 softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
430
431 *v |= softrst_mask;
432
433 return 0;
434}
435
436/**
437 * _clear_softreset: clear OCP_SYSCONFIG.SOFTRESET bit in @v
438 * @oh: struct omap_hwmod *
439 * @v: pointer to register contents to modify
440 *
441 * Clear the SOFTRESET bit in @v for hwmod @oh. Returns -EINVAL upon
442 * error or 0 upon success.
443 */
444static int _clear_softreset(struct omap_hwmod *oh, u32 *v)
445{
446 u32 softrst_mask;
447
448 if (!oh->class->sysc ||
449 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
450 return -EINVAL;
451
452 if (!oh->class->sysc->sysc_fields) {
453 WARN(1,
454 "omap_hwmod: %s: sysc_fields absent for sysconfig class\n",
455 oh->name);
456 return -EINVAL;
457 }
458
459 softrst_mask = (0x1 << oh->class->sysc->sysc_fields->srst_shift);
460
461 *v &= ~softrst_mask;
462
463 return 0;
464}
465
466/**
467 * _wait_softreset_complete - wait for an OCP softreset to complete
468 * @oh: struct omap_hwmod * to wait on
469 *
470 * Wait until the IP block represented by @oh reports that its OCP
471 * softreset is complete. This can be triggered by software (see
472 * _ocp_softreset()) or by hardware upon returning from off-mode (one
473 * example is HSMMC). Waits for up to MAX_MODULE_SOFTRESET_WAIT
474 * microseconds. Returns the number of microseconds waited.
475 */
476static int _wait_softreset_complete(struct omap_hwmod *oh)
477{
478 struct omap_hwmod_class_sysconfig *sysc;
479 u32 softrst_mask;
480 int c = 0;
481
482 sysc = oh->class->sysc;
483
484 if (sysc->sysc_flags & SYSS_HAS_RESET_STATUS)
485 omap_test_timeout((omap_hwmod_read(oh, sysc->syss_offs)
486 & SYSS_RESETDONE_MASK),
487 MAX_MODULE_SOFTRESET_WAIT, c);
488 else if (sysc->sysc_flags & SYSC_HAS_RESET_STATUS) {
489 softrst_mask = (0x1 << sysc->sysc_fields->srst_shift);
490 omap_test_timeout(!(omap_hwmod_read(oh, sysc->sysc_offs)
491 & softrst_mask),
492 MAX_MODULE_SOFTRESET_WAIT, c);
493 }
494
495 return c;
496}
497
498/**
499 * _set_dmadisable: set OCP_SYSCONFIG.DMADISABLE bit in @v
500 * @oh: struct omap_hwmod *
501 *
502 * The DMADISABLE bit is a semi-automatic bit present in sysconfig register
503 * of some modules. When the DMA must perform read/write accesses, the
504 * DMADISABLE bit is cleared by the hardware. But when the DMA must stop
505 * for power management, software must set the DMADISABLE bit back to 1.
506 *
507 * Set the DMADISABLE bit in @v for hwmod @oh. Returns -EINVAL upon
508 * error or 0 upon success.
509 */
510static int _set_dmadisable(struct omap_hwmod *oh)
511{
512 u32 v;
513 u32 dmadisable_mask;
514
515 if (!oh->class->sysc ||
516 !(oh->class->sysc->sysc_flags & SYSC_HAS_DMADISABLE))
517 return -EINVAL;
518
519 if (!oh->class->sysc->sysc_fields) {
520 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
521 return -EINVAL;
522 }
523
524 /* clocks must be on for this operation */
525 if (oh->_state != _HWMOD_STATE_ENABLED) {
526 pr_warn("omap_hwmod: %s: dma can be disabled only from enabled state\n", oh->name);
527 return -EINVAL;
528 }
529
530 pr_debug("omap_hwmod: %s: setting DMADISABLE\n", oh->name);
531
532 v = oh->_sysc_cache;
533 dmadisable_mask =
534 (0x1 << oh->class->sysc->sysc_fields->dmadisable_shift);
535 v |= dmadisable_mask;
536 _write_sysconfig(v, oh);
537
538 return 0;
539}
540
541/**
542 * _set_module_autoidle: set the OCP_SYSCONFIG AUTOIDLE field in @v
543 * @oh: struct omap_hwmod *
544 * @autoidle: desired AUTOIDLE bitfield value (0 or 1)
545 * @v: pointer to register contents to modify
546 *
547 * Update the module autoidle bit in @v to be @autoidle for the @oh
548 * hwmod. The autoidle bit controls whether the module can gate
549 * internal clocks automatically when it isn't doing anything; the
550 * exact function of this bit varies on a per-module basis. This
551 * function does not write to the hardware. Returns -EINVAL upon
552 * error or 0 upon success.
553 */
554static int _set_module_autoidle(struct omap_hwmod *oh, u8 autoidle,
555 u32 *v)
556{
557 u32 autoidle_mask;
558 u8 autoidle_shift;
559
560 if (!oh->class->sysc ||
561 !(oh->class->sysc->sysc_flags & SYSC_HAS_AUTOIDLE))
562 return -EINVAL;
563
564 if (!oh->class->sysc->sysc_fields) {
565 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
566 return -EINVAL;
567 }
568
569 autoidle_shift = oh->class->sysc->sysc_fields->autoidle_shift;
570 autoidle_mask = (0x1 << autoidle_shift);
571
572 *v &= ~autoidle_mask;
573 *v |= autoidle << autoidle_shift;
574
575 return 0;
576}
577
578/**
579 * _enable_wakeup: set OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
580 * @oh: struct omap_hwmod *
581 *
582 * Allow the hardware module @oh to send wakeups. Returns -EINVAL
583 * upon error or 0 upon success.
584 */
585static int _enable_wakeup(struct omap_hwmod *oh, u32 *v)
586{
587 if (!oh->class->sysc ||
588 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
589 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
590 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
591 return -EINVAL;
592
593 if (!oh->class->sysc->sysc_fields) {
594 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
595 return -EINVAL;
596 }
597
598 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
599 *v |= 0x1 << oh->class->sysc->sysc_fields->enwkup_shift;
600
601 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
602 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
603 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
604 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART_WKUP, v);
605
606 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
607
608 return 0;
609}
610
611/**
612 * _disable_wakeup: clear OCP_SYSCONFIG.ENAWAKEUP bit in the hardware
613 * @oh: struct omap_hwmod *
614 *
615 * Prevent the hardware module @oh to send wakeups. Returns -EINVAL
616 * upon error or 0 upon success.
617 */
618static int _disable_wakeup(struct omap_hwmod *oh, u32 *v)
619{
620 if (!oh->class->sysc ||
621 !((oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP) ||
622 (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP) ||
623 (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)))
624 return -EINVAL;
625
626 if (!oh->class->sysc->sysc_fields) {
627 WARN(1, "omap_hwmod: %s: offset struct for sysconfig not provided in class\n", oh->name);
628 return -EINVAL;
629 }
630
631 if (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)
632 *v &= ~(0x1 << oh->class->sysc->sysc_fields->enwkup_shift);
633
634 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
635 _set_slave_idlemode(oh, HWMOD_IDLEMODE_SMART, v);
636 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
637 _set_master_standbymode(oh, HWMOD_IDLEMODE_SMART, v);
638
639 /* XXX test pwrdm_get_wken for this hwmod's subsystem */
640
641 return 0;
642}
643
644static struct clockdomain *_get_clkdm(struct omap_hwmod *oh)
645{
646 struct clk_hw_omap *clk;
647
648 if (oh->clkdm) {
649 return oh->clkdm;
650 } else if (oh->_clk) {
651 if (__clk_get_flags(oh->_clk) & CLK_IS_BASIC)
652 return NULL;
653 clk = to_clk_hw_omap(__clk_get_hw(oh->_clk));
654 return clk->clkdm;
655 }
656 return NULL;
657}
658
659/**
660 * _add_initiator_dep: prevent @oh from smart-idling while @init_oh is active
661 * @oh: struct omap_hwmod *
662 *
663 * Prevent the hardware module @oh from entering idle while the
664 * hardare module initiator @init_oh is active. Useful when a module
665 * will be accessed by a particular initiator (e.g., if a module will
666 * be accessed by the IVA, there should be a sleepdep between the IVA
667 * initiator and the module). Only applies to modules in smart-idle
668 * mode. If the clockdomain is marked as not needing autodeps, return
669 * 0 without doing anything. Otherwise, returns -EINVAL upon error or
670 * passes along clkdm_add_sleepdep() value upon success.
671 */
672static int _add_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
673{
674 struct clockdomain *clkdm, *init_clkdm;
675
676 clkdm = _get_clkdm(oh);
677 init_clkdm = _get_clkdm(init_oh);
678
679 if (!clkdm || !init_clkdm)
680 return -EINVAL;
681
682 if (clkdm && clkdm->flags & CLKDM_NO_AUTODEPS)
683 return 0;
684
685 return clkdm_add_sleepdep(clkdm, init_clkdm);
686}
687
688/**
689 * _del_initiator_dep: allow @oh to smart-idle even if @init_oh is active
690 * @oh: struct omap_hwmod *
691 *
692 * Allow the hardware module @oh to enter idle while the hardare
693 * module initiator @init_oh is active. Useful when a module will not
694 * be accessed by a particular initiator (e.g., if a module will not
695 * be accessed by the IVA, there should be no sleepdep between the IVA
696 * initiator and the module). Only applies to modules in smart-idle
697 * mode. If the clockdomain is marked as not needing autodeps, return
698 * 0 without doing anything. Returns -EINVAL upon error or passes
699 * along clkdm_del_sleepdep() value upon success.
700 */
701static int _del_initiator_dep(struct omap_hwmod *oh, struct omap_hwmod *init_oh)
702{
703 struct clockdomain *clkdm, *init_clkdm;
704
705 clkdm = _get_clkdm(oh);
706 init_clkdm = _get_clkdm(init_oh);
707
708 if (!clkdm || !init_clkdm)
709 return -EINVAL;
710
711 if (clkdm && clkdm->flags & CLKDM_NO_AUTODEPS)
712 return 0;
713
714 return clkdm_del_sleepdep(clkdm, init_clkdm);
715}
716
717static const struct of_device_id ti_clkctrl_match_table[] __initconst = {
718 { .compatible = "ti,clkctrl" },
719 { }
720};
721
722static int __init _setup_clkctrl_provider(struct device_node *np)
723{
724 const __be32 *addrp;
725 struct clkctrl_provider *provider;
726 u64 size;
727
728 provider = memblock_virt_alloc(sizeof(*provider), 0);
729 if (!provider)
730 return -ENOMEM;
731
732 addrp = of_get_address(np, 0, &size, NULL);
733 provider->addr = (u32)of_translate_address(np, addrp);
734 addrp = of_get_address(np->parent, 0, NULL, NULL);
735 provider->offset = provider->addr -
736 (u32)of_translate_address(np->parent, addrp);
737 provider->addr &= ~0xff;
738 provider->size = size | 0xff;
739 provider->node = np;
740
741 pr_debug("%s: %s: %x...%x [+%x]\n", __func__, np->parent->name,
742 provider->addr, provider->addr + provider->size,
743 provider->offset);
744
745 list_add(&provider->link, &clkctrl_providers);
746
747 return 0;
748}
749
750static int __init _init_clkctrl_providers(void)
751{
752 struct device_node *np;
753 int ret = 0;
754
755 for_each_matching_node(np, ti_clkctrl_match_table) {
756 ret = _setup_clkctrl_provider(np);
757 if (ret)
758 break;
759 }
760
761 return ret;
762}
763
764static u32 _omap4_xlate_clkctrl(struct omap_hwmod *oh)
765{
766 if (!oh->prcm.omap4.modulemode)
767 return 0;
768
769 return omap_cm_xlate_clkctrl(oh->clkdm->prcm_partition,
770 oh->clkdm->cm_inst,
771 oh->prcm.omap4.clkctrl_offs);
772}
773
774static struct clk *_lookup_clkctrl_clk(struct omap_hwmod *oh)
775{
776 struct clkctrl_provider *provider;
777 struct clk *clk;
778 u32 addr;
779
780 if (!soc_ops.xlate_clkctrl)
781 return NULL;
782
783 addr = soc_ops.xlate_clkctrl(oh);
784 if (!addr)
785 return NULL;
786
787 pr_debug("%s: %s: addr=%x\n", __func__, oh->name, addr);
788
789 list_for_each_entry(provider, &clkctrl_providers, link) {
790 if (provider->addr <= addr &&
791 provider->addr + provider->size >= addr) {
792 struct of_phandle_args clkspec;
793
794 clkspec.np = provider->node;
795 clkspec.args_count = 2;
796 clkspec.args[0] = addr - provider->addr -
797 provider->offset;
798 clkspec.args[1] = 0;
799
800 clk = of_clk_get_from_provider(&clkspec);
801
802 pr_debug("%s: %s got %p (offset=%x, provider=%s)\n",
803 __func__, oh->name, clk, clkspec.args[0],
804 provider->node->parent->name);
805
806 return clk;
807 }
808 }
809
810 return NULL;
811}
812
813/**
814 * _init_main_clk - get a struct clk * for the the hwmod's main functional clk
815 * @oh: struct omap_hwmod *
816 *
817 * Called from _init_clocks(). Populates the @oh _clk (main
818 * functional clock pointer) if a clock matching the hwmod name is found,
819 * or a main_clk is present. Returns 0 on success or -EINVAL on error.
820 */
821static int _init_main_clk(struct omap_hwmod *oh)
822{
823 int ret = 0;
824 struct clk *clk = NULL;
825
826 clk = _lookup_clkctrl_clk(oh);
827
828 if (!IS_ERR_OR_NULL(clk)) {
829 pr_debug("%s: mapped main_clk %s for %s\n", __func__,
830 __clk_get_name(clk), oh->name);
831 oh->main_clk = __clk_get_name(clk);
832 oh->_clk = clk;
833 soc_ops.disable_direct_prcm(oh);
834 } else {
835 if (!oh->main_clk)
836 return 0;
837
838 oh->_clk = clk_get(NULL, oh->main_clk);
839 }
840
841 if (IS_ERR(oh->_clk)) {
842 pr_warn("omap_hwmod: %s: cannot clk_get main_clk %s\n",
843 oh->name, oh->main_clk);
844 return -EINVAL;
845 }
846 /*
847 * HACK: This needs a re-visit once clk_prepare() is implemented
848 * to do something meaningful. Today its just a no-op.
849 * If clk_prepare() is used at some point to do things like
850 * voltage scaling etc, then this would have to be moved to
851 * some point where subsystems like i2c and pmic become
852 * available.
853 */
854 clk_prepare(oh->_clk);
855
856 if (!_get_clkdm(oh))
857 pr_debug("omap_hwmod: %s: missing clockdomain for %s.\n",
858 oh->name, oh->main_clk);
859
860 return ret;
861}
862
863/**
864 * _init_interface_clks - get a struct clk * for the the hwmod's interface clks
865 * @oh: struct omap_hwmod *
866 *
867 * Called from _init_clocks(). Populates the @oh OCP slave interface
868 * clock pointers. Returns 0 on success or -EINVAL on error.
869 */
870static int _init_interface_clks(struct omap_hwmod *oh)
871{
872 struct omap_hwmod_ocp_if *os;
873 struct clk *c;
874 int ret = 0;
875
876 list_for_each_entry(os, &oh->slave_ports, node) {
877 if (!os->clk)
878 continue;
879
880 c = clk_get(NULL, os->clk);
881 if (IS_ERR(c)) {
882 pr_warn("omap_hwmod: %s: cannot clk_get interface_clk %s\n",
883 oh->name, os->clk);
884 ret = -EINVAL;
885 continue;
886 }
887 os->_clk = c;
888 /*
889 * HACK: This needs a re-visit once clk_prepare() is implemented
890 * to do something meaningful. Today its just a no-op.
891 * If clk_prepare() is used at some point to do things like
892 * voltage scaling etc, then this would have to be moved to
893 * some point where subsystems like i2c and pmic become
894 * available.
895 */
896 clk_prepare(os->_clk);
897 }
898
899 return ret;
900}
901
902/**
903 * _init_opt_clk - get a struct clk * for the the hwmod's optional clocks
904 * @oh: struct omap_hwmod *
905 *
906 * Called from _init_clocks(). Populates the @oh omap_hwmod_opt_clk
907 * clock pointers. Returns 0 on success or -EINVAL on error.
908 */
909static int _init_opt_clks(struct omap_hwmod *oh)
910{
911 struct omap_hwmod_opt_clk *oc;
912 struct clk *c;
913 int i;
914 int ret = 0;
915
916 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++) {
917 c = clk_get(NULL, oc->clk);
918 if (IS_ERR(c)) {
919 pr_warn("omap_hwmod: %s: cannot clk_get opt_clk %s\n",
920 oh->name, oc->clk);
921 ret = -EINVAL;
922 continue;
923 }
924 oc->_clk = c;
925 /*
926 * HACK: This needs a re-visit once clk_prepare() is implemented
927 * to do something meaningful. Today its just a no-op.
928 * If clk_prepare() is used at some point to do things like
929 * voltage scaling etc, then this would have to be moved to
930 * some point where subsystems like i2c and pmic become
931 * available.
932 */
933 clk_prepare(oc->_clk);
934 }
935
936 return ret;
937}
938
939static void _enable_optional_clocks(struct omap_hwmod *oh)
940{
941 struct omap_hwmod_opt_clk *oc;
942 int i;
943
944 pr_debug("omap_hwmod: %s: enabling optional clocks\n", oh->name);
945
946 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
947 if (oc->_clk) {
948 pr_debug("omap_hwmod: enable %s:%s\n", oc->role,
949 __clk_get_name(oc->_clk));
950 clk_enable(oc->_clk);
951 }
952}
953
954static void _disable_optional_clocks(struct omap_hwmod *oh)
955{
956 struct omap_hwmod_opt_clk *oc;
957 int i;
958
959 pr_debug("omap_hwmod: %s: disabling optional clocks\n", oh->name);
960
961 for (i = oh->opt_clks_cnt, oc = oh->opt_clks; i > 0; i--, oc++)
962 if (oc->_clk) {
963 pr_debug("omap_hwmod: disable %s:%s\n", oc->role,
964 __clk_get_name(oc->_clk));
965 clk_disable(oc->_clk);
966 }
967}
968
969/**
970 * _enable_clocks - enable hwmod main clock and interface clocks
971 * @oh: struct omap_hwmod *
972 *
973 * Enables all clocks necessary for register reads and writes to succeed
974 * on the hwmod @oh. Returns 0.
975 */
976static int _enable_clocks(struct omap_hwmod *oh)
977{
978 struct omap_hwmod_ocp_if *os;
979
980 pr_debug("omap_hwmod: %s: enabling clocks\n", oh->name);
981
982 if (oh->flags & HWMOD_OPT_CLKS_NEEDED)
983 _enable_optional_clocks(oh);
984
985 if (oh->_clk)
986 clk_enable(oh->_clk);
987
988 list_for_each_entry(os, &oh->slave_ports, node) {
989 if (os->_clk && (os->flags & OCPIF_SWSUP_IDLE))
990 clk_enable(os->_clk);
991 }
992
993 /* The opt clocks are controlled by the device driver. */
994
995 return 0;
996}
997
998/**
999 * _omap4_clkctrl_managed_by_clkfwk - true if clkctrl managed by clock framework
1000 * @oh: struct omap_hwmod *
1001 */
1002static bool _omap4_clkctrl_managed_by_clkfwk(struct omap_hwmod *oh)
1003{
1004 if (oh->prcm.omap4.flags & HWMOD_OMAP4_CLKFWK_CLKCTR_CLOCK)
1005 return true;
1006
1007 return false;
1008}
1009
1010/**
1011 * _omap4_has_clkctrl_clock - returns true if a module has clkctrl clock
1012 * @oh: struct omap_hwmod *
1013 */
1014static bool _omap4_has_clkctrl_clock(struct omap_hwmod *oh)
1015{
1016 if (oh->prcm.omap4.clkctrl_offs)
1017 return true;
1018
1019 if (!oh->prcm.omap4.clkctrl_offs &&
1020 oh->prcm.omap4.flags & HWMOD_OMAP4_ZERO_CLKCTRL_OFFSET)
1021 return true;
1022
1023 return false;
1024}
1025
1026/**
1027 * _disable_clocks - disable hwmod main clock and interface clocks
1028 * @oh: struct omap_hwmod *
1029 *
1030 * Disables the hwmod @oh main functional and interface clocks. Returns 0.
1031 */
1032static int _disable_clocks(struct omap_hwmod *oh)
1033{
1034 struct omap_hwmod_ocp_if *os;
1035
1036 pr_debug("omap_hwmod: %s: disabling clocks\n", oh->name);
1037
1038 if (oh->_clk)
1039 clk_disable(oh->_clk);
1040
1041 list_for_each_entry(os, &oh->slave_ports, node) {
1042 if (os->_clk && (os->flags & OCPIF_SWSUP_IDLE))
1043 clk_disable(os->_clk);
1044 }
1045
1046 if (oh->flags & HWMOD_OPT_CLKS_NEEDED)
1047 _disable_optional_clocks(oh);
1048
1049 /* The opt clocks are controlled by the device driver. */
1050
1051 return 0;
1052}
1053
1054/**
1055 * _omap4_enable_module - enable CLKCTRL modulemode on OMAP4
1056 * @oh: struct omap_hwmod *
1057 *
1058 * Enables the PRCM module mode related to the hwmod @oh.
1059 * No return value.
1060 */
1061static void _omap4_enable_module(struct omap_hwmod *oh)
1062{
1063 if (!oh->clkdm || !oh->prcm.omap4.modulemode ||
1064 _omap4_clkctrl_managed_by_clkfwk(oh))
1065 return;
1066
1067 pr_debug("omap_hwmod: %s: %s: %d\n",
1068 oh->name, __func__, oh->prcm.omap4.modulemode);
1069
1070 omap_cm_module_enable(oh->prcm.omap4.modulemode,
1071 oh->clkdm->prcm_partition,
1072 oh->clkdm->cm_inst, oh->prcm.omap4.clkctrl_offs);
1073}
1074
1075/**
1076 * _omap4_wait_target_disable - wait for a module to be disabled on OMAP4
1077 * @oh: struct omap_hwmod *
1078 *
1079 * Wait for a module @oh to enter slave idle. Returns 0 if the module
1080 * does not have an IDLEST bit or if the module successfully enters
1081 * slave idle; otherwise, pass along the return value of the
1082 * appropriate *_cm*_wait_module_idle() function.
1083 */
1084static int _omap4_wait_target_disable(struct omap_hwmod *oh)
1085{
1086 if (!oh)
1087 return -EINVAL;
1088
1089 if (oh->_int_flags & _HWMOD_NO_MPU_PORT || !oh->clkdm)
1090 return 0;
1091
1092 if (oh->flags & HWMOD_NO_IDLEST)
1093 return 0;
1094
1095 if (_omap4_clkctrl_managed_by_clkfwk(oh))
1096 return 0;
1097
1098 if (!_omap4_has_clkctrl_clock(oh))
1099 return 0;
1100
1101 return omap_cm_wait_module_idle(oh->clkdm->prcm_partition,
1102 oh->clkdm->cm_inst,
1103 oh->prcm.omap4.clkctrl_offs, 0);
1104}
1105
1106/**
1107 * _save_mpu_port_index - find and save the index to @oh's MPU port
1108 * @oh: struct omap_hwmod *
1109 *
1110 * Determines the array index of the OCP slave port that the MPU uses
1111 * to address the device, and saves it into the struct omap_hwmod.
1112 * Intended to be called during hwmod registration only. No return
1113 * value.
1114 */
1115static void __init _save_mpu_port_index(struct omap_hwmod *oh)
1116{
1117 struct omap_hwmod_ocp_if *os = NULL;
1118
1119 if (!oh)
1120 return;
1121
1122 oh->_int_flags |= _HWMOD_NO_MPU_PORT;
1123
1124 list_for_each_entry(os, &oh->slave_ports, node) {
1125 if (os->user & OCP_USER_MPU) {
1126 oh->_mpu_port = os;
1127 oh->_int_flags &= ~_HWMOD_NO_MPU_PORT;
1128 break;
1129 }
1130 }
1131
1132 return;
1133}
1134
1135/**
1136 * _find_mpu_rt_port - return omap_hwmod_ocp_if accessible by the MPU
1137 * @oh: struct omap_hwmod *
1138 *
1139 * Given a pointer to a struct omap_hwmod record @oh, return a pointer
1140 * to the struct omap_hwmod_ocp_if record that is used by the MPU to
1141 * communicate with the IP block. This interface need not be directly
1142 * connected to the MPU (and almost certainly is not), but is directly
1143 * connected to the IP block represented by @oh. Returns a pointer
1144 * to the struct omap_hwmod_ocp_if * upon success, or returns NULL upon
1145 * error or if there does not appear to be a path from the MPU to this
1146 * IP block.
1147 */
1148static struct omap_hwmod_ocp_if *_find_mpu_rt_port(struct omap_hwmod *oh)
1149{
1150 if (!oh || oh->_int_flags & _HWMOD_NO_MPU_PORT || oh->slaves_cnt == 0)
1151 return NULL;
1152
1153 return oh->_mpu_port;
1154};
1155
1156/**
1157 * _enable_sysc - try to bring a module out of idle via OCP_SYSCONFIG
1158 * @oh: struct omap_hwmod *
1159 *
1160 * Ensure that the OCP_SYSCONFIG register for the IP block represented
1161 * by @oh is set to indicate to the PRCM that the IP block is active.
1162 * Usually this means placing the module into smart-idle mode and
1163 * smart-standby, but if there is a bug in the automatic idle handling
1164 * for the IP block, it may need to be placed into the force-idle or
1165 * no-idle variants of these modes. No return value.
1166 */
1167static void _enable_sysc(struct omap_hwmod *oh)
1168{
1169 u8 idlemode, sf;
1170 u32 v;
1171 bool clkdm_act;
1172 struct clockdomain *clkdm;
1173
1174 if (!oh->class->sysc)
1175 return;
1176
1177 /*
1178 * Wait until reset has completed, this is needed as the IP
1179 * block is reset automatically by hardware in some cases
1180 * (off-mode for example), and the drivers require the
1181 * IP to be ready when they access it
1182 */
1183 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1184 _enable_optional_clocks(oh);
1185 _wait_softreset_complete(oh);
1186 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1187 _disable_optional_clocks(oh);
1188
1189 v = oh->_sysc_cache;
1190 sf = oh->class->sysc->sysc_flags;
1191
1192 clkdm = _get_clkdm(oh);
1193 if (sf & SYSC_HAS_SIDLEMODE) {
1194 if (oh->flags & HWMOD_SWSUP_SIDLE ||
1195 oh->flags & HWMOD_SWSUP_SIDLE_ACT) {
1196 idlemode = HWMOD_IDLEMODE_NO;
1197 } else {
1198 if (sf & SYSC_HAS_ENAWAKEUP)
1199 _enable_wakeup(oh, &v);
1200 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
1201 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1202 else
1203 idlemode = HWMOD_IDLEMODE_SMART;
1204 }
1205
1206 /*
1207 * This is special handling for some IPs like
1208 * 32k sync timer. Force them to idle!
1209 */
1210 clkdm_act = (clkdm && clkdm->flags & CLKDM_ACTIVE_WITH_MPU);
1211 if (clkdm_act && !(oh->class->sysc->idlemodes &
1212 (SIDLE_SMART | SIDLE_SMART_WKUP)))
1213 idlemode = HWMOD_IDLEMODE_FORCE;
1214
1215 _set_slave_idlemode(oh, idlemode, &v);
1216 }
1217
1218 if (sf & SYSC_HAS_MIDLEMODE) {
1219 if (oh->flags & HWMOD_FORCE_MSTANDBY) {
1220 idlemode = HWMOD_IDLEMODE_FORCE;
1221 } else if (oh->flags & HWMOD_SWSUP_MSTANDBY) {
1222 idlemode = HWMOD_IDLEMODE_NO;
1223 } else {
1224 if (sf & SYSC_HAS_ENAWAKEUP)
1225 _enable_wakeup(oh, &v);
1226 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1227 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1228 else
1229 idlemode = HWMOD_IDLEMODE_SMART;
1230 }
1231 _set_master_standbymode(oh, idlemode, &v);
1232 }
1233
1234 /*
1235 * XXX The clock framework should handle this, by
1236 * calling into this code. But this must wait until the
1237 * clock structures are tagged with omap_hwmod entries
1238 */
1239 if ((oh->flags & HWMOD_SET_DEFAULT_CLOCKACT) &&
1240 (sf & SYSC_HAS_CLOCKACTIVITY))
1241 _set_clockactivity(oh, CLOCKACT_TEST_ICLK, &v);
1242
1243 _write_sysconfig(v, oh);
1244
1245 /*
1246 * Set the autoidle bit only after setting the smartidle bit
1247 * Setting this will not have any impact on the other modules.
1248 */
1249 if (sf & SYSC_HAS_AUTOIDLE) {
1250 idlemode = (oh->flags & HWMOD_NO_OCP_AUTOIDLE) ?
1251 0 : 1;
1252 _set_module_autoidle(oh, idlemode, &v);
1253 _write_sysconfig(v, oh);
1254 }
1255}
1256
1257/**
1258 * _idle_sysc - try to put a module into idle via OCP_SYSCONFIG
1259 * @oh: struct omap_hwmod *
1260 *
1261 * If module is marked as SWSUP_SIDLE, force the module into slave
1262 * idle; otherwise, configure it for smart-idle. If module is marked
1263 * as SWSUP_MSUSPEND, force the module into master standby; otherwise,
1264 * configure it for smart-standby. No return value.
1265 */
1266static void _idle_sysc(struct omap_hwmod *oh)
1267{
1268 u8 idlemode, sf;
1269 u32 v;
1270
1271 if (!oh->class->sysc)
1272 return;
1273
1274 v = oh->_sysc_cache;
1275 sf = oh->class->sysc->sysc_flags;
1276
1277 if (sf & SYSC_HAS_SIDLEMODE) {
1278 if (oh->flags & HWMOD_SWSUP_SIDLE) {
1279 idlemode = HWMOD_IDLEMODE_FORCE;
1280 } else {
1281 if (sf & SYSC_HAS_ENAWAKEUP)
1282 _enable_wakeup(oh, &v);
1283 if (oh->class->sysc->idlemodes & SIDLE_SMART_WKUP)
1284 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1285 else
1286 idlemode = HWMOD_IDLEMODE_SMART;
1287 }
1288 _set_slave_idlemode(oh, idlemode, &v);
1289 }
1290
1291 if (sf & SYSC_HAS_MIDLEMODE) {
1292 if ((oh->flags & HWMOD_SWSUP_MSTANDBY) ||
1293 (oh->flags & HWMOD_FORCE_MSTANDBY)) {
1294 idlemode = HWMOD_IDLEMODE_FORCE;
1295 } else {
1296 if (sf & SYSC_HAS_ENAWAKEUP)
1297 _enable_wakeup(oh, &v);
1298 if (oh->class->sysc->idlemodes & MSTANDBY_SMART_WKUP)
1299 idlemode = HWMOD_IDLEMODE_SMART_WKUP;
1300 else
1301 idlemode = HWMOD_IDLEMODE_SMART;
1302 }
1303 _set_master_standbymode(oh, idlemode, &v);
1304 }
1305
1306 /* If the cached value is the same as the new value, skip the write */
1307 if (oh->_sysc_cache != v)
1308 _write_sysconfig(v, oh);
1309}
1310
1311/**
1312 * _shutdown_sysc - force a module into idle via OCP_SYSCONFIG
1313 * @oh: struct omap_hwmod *
1314 *
1315 * Force the module into slave idle and master suspend. No return
1316 * value.
1317 */
1318static void _shutdown_sysc(struct omap_hwmod *oh)
1319{
1320 u32 v;
1321 u8 sf;
1322
1323 if (!oh->class->sysc)
1324 return;
1325
1326 v = oh->_sysc_cache;
1327 sf = oh->class->sysc->sysc_flags;
1328
1329 if (sf & SYSC_HAS_SIDLEMODE)
1330 _set_slave_idlemode(oh, HWMOD_IDLEMODE_FORCE, &v);
1331
1332 if (sf & SYSC_HAS_MIDLEMODE)
1333 _set_master_standbymode(oh, HWMOD_IDLEMODE_FORCE, &v);
1334
1335 if (sf & SYSC_HAS_AUTOIDLE)
1336 _set_module_autoidle(oh, 1, &v);
1337
1338 _write_sysconfig(v, oh);
1339}
1340
1341/**
1342 * _lookup - find an omap_hwmod by name
1343 * @name: find an omap_hwmod by name
1344 *
1345 * Return a pointer to an omap_hwmod by name, or NULL if not found.
1346 */
1347static struct omap_hwmod *_lookup(const char *name)
1348{
1349 struct omap_hwmod *oh, *temp_oh;
1350
1351 oh = NULL;
1352
1353 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
1354 if (!strcmp(name, temp_oh->name)) {
1355 oh = temp_oh;
1356 break;
1357 }
1358 }
1359
1360 return oh;
1361}
1362
1363/**
1364 * _init_clkdm - look up a clockdomain name, store pointer in omap_hwmod
1365 * @oh: struct omap_hwmod *
1366 *
1367 * Convert a clockdomain name stored in a struct omap_hwmod into a
1368 * clockdomain pointer, and save it into the struct omap_hwmod.
1369 * Return -EINVAL if the clkdm_name lookup failed.
1370 */
1371static int _init_clkdm(struct omap_hwmod *oh)
1372{
1373 if (!oh->clkdm_name) {
1374 pr_debug("omap_hwmod: %s: missing clockdomain\n", oh->name);
1375 return 0;
1376 }
1377
1378 oh->clkdm = clkdm_lookup(oh->clkdm_name);
1379 if (!oh->clkdm) {
1380 pr_warn("omap_hwmod: %s: could not associate to clkdm %s\n",
1381 oh->name, oh->clkdm_name);
1382 return 0;
1383 }
1384
1385 pr_debug("omap_hwmod: %s: associated to clkdm %s\n",
1386 oh->name, oh->clkdm_name);
1387
1388 return 0;
1389}
1390
1391/**
1392 * _init_clocks - clk_get() all clocks associated with this hwmod. Retrieve as
1393 * well the clockdomain.
1394 * @oh: struct omap_hwmod *
1395 * @np: device_node mapped to this hwmod
1396 *
1397 * Called by omap_hwmod_setup_*() (after omap2_clk_init()).
1398 * Resolves all clock names embedded in the hwmod. Returns 0 on
1399 * success, or a negative error code on failure.
1400 */
1401static int _init_clocks(struct omap_hwmod *oh, struct device_node *np)
1402{
1403 int ret = 0;
1404
1405 if (oh->_state != _HWMOD_STATE_REGISTERED)
1406 return 0;
1407
1408 pr_debug("omap_hwmod: %s: looking up clocks\n", oh->name);
1409
1410 if (soc_ops.init_clkdm)
1411 ret |= soc_ops.init_clkdm(oh);
1412
1413 ret |= _init_main_clk(oh);
1414 ret |= _init_interface_clks(oh);
1415 ret |= _init_opt_clks(oh);
1416
1417 if (!ret)
1418 oh->_state = _HWMOD_STATE_CLKS_INITED;
1419 else
1420 pr_warn("omap_hwmod: %s: cannot _init_clocks\n", oh->name);
1421
1422 return ret;
1423}
1424
1425/**
1426 * _lookup_hardreset - fill register bit info for this hwmod/reset line
1427 * @oh: struct omap_hwmod *
1428 * @name: name of the reset line in the context of this hwmod
1429 * @ohri: struct omap_hwmod_rst_info * that this function will fill in
1430 *
1431 * Return the bit position of the reset line that match the
1432 * input name. Return -ENOENT if not found.
1433 */
1434static int _lookup_hardreset(struct omap_hwmod *oh, const char *name,
1435 struct omap_hwmod_rst_info *ohri)
1436{
1437 int i;
1438
1439 for (i = 0; i < oh->rst_lines_cnt; i++) {
1440 const char *rst_line = oh->rst_lines[i].name;
1441 if (!strcmp(rst_line, name)) {
1442 ohri->rst_shift = oh->rst_lines[i].rst_shift;
1443 ohri->st_shift = oh->rst_lines[i].st_shift;
1444 pr_debug("omap_hwmod: %s: %s: %s: rst %d st %d\n",
1445 oh->name, __func__, rst_line, ohri->rst_shift,
1446 ohri->st_shift);
1447
1448 return 0;
1449 }
1450 }
1451
1452 return -ENOENT;
1453}
1454
1455/**
1456 * _assert_hardreset - assert the HW reset line of submodules
1457 * contained in the hwmod module.
1458 * @oh: struct omap_hwmod *
1459 * @name: name of the reset line to lookup and assert
1460 *
1461 * Some IP like dsp, ipu or iva contain processor that require an HW
1462 * reset line to be assert / deassert in order to enable fully the IP.
1463 * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1464 * asserting the hardreset line on the currently-booted SoC, or passes
1465 * along the return value from _lookup_hardreset() or the SoC's
1466 * assert_hardreset code.
1467 */
1468static int _assert_hardreset(struct omap_hwmod *oh, const char *name)
1469{
1470 struct omap_hwmod_rst_info ohri;
1471 int ret = -EINVAL;
1472
1473 if (!oh)
1474 return -EINVAL;
1475
1476 if (!soc_ops.assert_hardreset)
1477 return -ENOSYS;
1478
1479 ret = _lookup_hardreset(oh, name, &ohri);
1480 if (ret < 0)
1481 return ret;
1482
1483 ret = soc_ops.assert_hardreset(oh, &ohri);
1484
1485 return ret;
1486}
1487
1488/**
1489 * _deassert_hardreset - deassert the HW reset line of submodules contained
1490 * in the hwmod module.
1491 * @oh: struct omap_hwmod *
1492 * @name: name of the reset line to look up and deassert
1493 *
1494 * Some IP like dsp, ipu or iva contain processor that require an HW
1495 * reset line to be assert / deassert in order to enable fully the IP.
1496 * Returns -EINVAL if @oh is null, -ENOSYS if we have no way of
1497 * deasserting the hardreset line on the currently-booted SoC, or passes
1498 * along the return value from _lookup_hardreset() or the SoC's
1499 * deassert_hardreset code.
1500 */
1501static int _deassert_hardreset(struct omap_hwmod *oh, const char *name)
1502{
1503 struct omap_hwmod_rst_info ohri;
1504 int ret = -EINVAL;
1505
1506 if (!oh)
1507 return -EINVAL;
1508
1509 if (!soc_ops.deassert_hardreset)
1510 return -ENOSYS;
1511
1512 ret = _lookup_hardreset(oh, name, &ohri);
1513 if (ret < 0)
1514 return ret;
1515
1516 if (oh->clkdm) {
1517 /*
1518 * A clockdomain must be in SW_SUP otherwise reset
1519 * might not be completed. The clockdomain can be set
1520 * in HW_AUTO only when the module become ready.
1521 */
1522 clkdm_deny_idle(oh->clkdm);
1523 ret = clkdm_hwmod_enable(oh->clkdm, oh);
1524 if (ret) {
1525 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1526 oh->name, oh->clkdm->name, ret);
1527 return ret;
1528 }
1529 }
1530
1531 _enable_clocks(oh);
1532 if (soc_ops.enable_module)
1533 soc_ops.enable_module(oh);
1534
1535 ret = soc_ops.deassert_hardreset(oh, &ohri);
1536
1537 if (soc_ops.disable_module)
1538 soc_ops.disable_module(oh);
1539 _disable_clocks(oh);
1540
1541 if (ret == -EBUSY)
1542 pr_warn("omap_hwmod: %s: failed to hardreset\n", oh->name);
1543
1544 if (oh->clkdm) {
1545 /*
1546 * Set the clockdomain to HW_AUTO, assuming that the
1547 * previous state was HW_AUTO.
1548 */
1549 clkdm_allow_idle(oh->clkdm);
1550
1551 clkdm_hwmod_disable(oh->clkdm, oh);
1552 }
1553
1554 return ret;
1555}
1556
1557/**
1558 * _read_hardreset - read the HW reset line state of submodules
1559 * contained in the hwmod module
1560 * @oh: struct omap_hwmod *
1561 * @name: name of the reset line to look up and read
1562 *
1563 * Return the state of the reset line. Returns -EINVAL if @oh is
1564 * null, -ENOSYS if we have no way of reading the hardreset line
1565 * status on the currently-booted SoC, or passes along the return
1566 * value from _lookup_hardreset() or the SoC's is_hardreset_asserted
1567 * code.
1568 */
1569static int _read_hardreset(struct omap_hwmod *oh, const char *name)
1570{
1571 struct omap_hwmod_rst_info ohri;
1572 int ret = -EINVAL;
1573
1574 if (!oh)
1575 return -EINVAL;
1576
1577 if (!soc_ops.is_hardreset_asserted)
1578 return -ENOSYS;
1579
1580 ret = _lookup_hardreset(oh, name, &ohri);
1581 if (ret < 0)
1582 return ret;
1583
1584 return soc_ops.is_hardreset_asserted(oh, &ohri);
1585}
1586
1587/**
1588 * _are_all_hardreset_lines_asserted - return true if the @oh is hard-reset
1589 * @oh: struct omap_hwmod *
1590 *
1591 * If all hardreset lines associated with @oh are asserted, then return true.
1592 * Otherwise, if part of @oh is out hardreset or if no hardreset lines
1593 * associated with @oh are asserted, then return false.
1594 * This function is used to avoid executing some parts of the IP block
1595 * enable/disable sequence if its hardreset line is set.
1596 */
1597static bool _are_all_hardreset_lines_asserted(struct omap_hwmod *oh)
1598{
1599 int i, rst_cnt = 0;
1600
1601 if (oh->rst_lines_cnt == 0)
1602 return false;
1603
1604 for (i = 0; i < oh->rst_lines_cnt; i++)
1605 if (_read_hardreset(oh, oh->rst_lines[i].name) > 0)
1606 rst_cnt++;
1607
1608 if (oh->rst_lines_cnt == rst_cnt)
1609 return true;
1610
1611 return false;
1612}
1613
1614/**
1615 * _are_any_hardreset_lines_asserted - return true if any part of @oh is
1616 * hard-reset
1617 * @oh: struct omap_hwmod *
1618 *
1619 * If any hardreset lines associated with @oh are asserted, then
1620 * return true. Otherwise, if no hardreset lines associated with @oh
1621 * are asserted, or if @oh has no hardreset lines, then return false.
1622 * This function is used to avoid executing some parts of the IP block
1623 * enable/disable sequence if any hardreset line is set.
1624 */
1625static bool _are_any_hardreset_lines_asserted(struct omap_hwmod *oh)
1626{
1627 int rst_cnt = 0;
1628 int i;
1629
1630 for (i = 0; i < oh->rst_lines_cnt && rst_cnt == 0; i++)
1631 if (_read_hardreset(oh, oh->rst_lines[i].name) > 0)
1632 rst_cnt++;
1633
1634 return (rst_cnt) ? true : false;
1635}
1636
1637/**
1638 * _omap4_disable_module - enable CLKCTRL modulemode on OMAP4
1639 * @oh: struct omap_hwmod *
1640 *
1641 * Disable the PRCM module mode related to the hwmod @oh.
1642 * Return EINVAL if the modulemode is not supported and 0 in case of success.
1643 */
1644static int _omap4_disable_module(struct omap_hwmod *oh)
1645{
1646 int v;
1647
1648 if (!oh->clkdm || !oh->prcm.omap4.modulemode ||
1649 _omap4_clkctrl_managed_by_clkfwk(oh))
1650 return -EINVAL;
1651
1652 /*
1653 * Since integration code might still be doing something, only
1654 * disable if all lines are under hardreset.
1655 */
1656 if (_are_any_hardreset_lines_asserted(oh))
1657 return 0;
1658
1659 pr_debug("omap_hwmod: %s: %s\n", oh->name, __func__);
1660
1661 omap_cm_module_disable(oh->clkdm->prcm_partition, oh->clkdm->cm_inst,
1662 oh->prcm.omap4.clkctrl_offs);
1663
1664 v = _omap4_wait_target_disable(oh);
1665 if (v)
1666 pr_warn("omap_hwmod: %s: _wait_target_disable failed\n",
1667 oh->name);
1668
1669 return 0;
1670}
1671
1672/**
1673 * _ocp_softreset - reset an omap_hwmod via the OCP_SYSCONFIG bit
1674 * @oh: struct omap_hwmod *
1675 *
1676 * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit. hwmod must be
1677 * enabled for this to work. Returns -ENOENT if the hwmod cannot be
1678 * reset this way, -EINVAL if the hwmod is in the wrong state,
1679 * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1680 *
1681 * In OMAP3 a specific SYSSTATUS register is used to get the reset status.
1682 * Starting in OMAP4, some IPs do not have SYSSTATUS registers and instead
1683 * use the SYSCONFIG softreset bit to provide the status.
1684 *
1685 * Note that some IP like McBSP do have reset control but don't have
1686 * reset status.
1687 */
1688static int _ocp_softreset(struct omap_hwmod *oh)
1689{
1690 u32 v;
1691 int c = 0;
1692 int ret = 0;
1693
1694 if (!oh->class->sysc ||
1695 !(oh->class->sysc->sysc_flags & SYSC_HAS_SOFTRESET))
1696 return -ENOENT;
1697
1698 /* clocks must be on for this operation */
1699 if (oh->_state != _HWMOD_STATE_ENABLED) {
1700 pr_warn("omap_hwmod: %s: reset can only be entered from enabled state\n",
1701 oh->name);
1702 return -EINVAL;
1703 }
1704
1705 /* For some modules, all optionnal clocks need to be enabled as well */
1706 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1707 _enable_optional_clocks(oh);
1708
1709 pr_debug("omap_hwmod: %s: resetting via OCP SOFTRESET\n", oh->name);
1710
1711 v = oh->_sysc_cache;
1712 ret = _set_softreset(oh, &v);
1713 if (ret)
1714 goto dis_opt_clks;
1715
1716 _write_sysconfig(v, oh);
1717
1718 if (oh->class->sysc->srst_udelay)
1719 udelay(oh->class->sysc->srst_udelay);
1720
1721 c = _wait_softreset_complete(oh);
1722 if (c == MAX_MODULE_SOFTRESET_WAIT) {
1723 pr_warn("omap_hwmod: %s: softreset failed (waited %d usec)\n",
1724 oh->name, MAX_MODULE_SOFTRESET_WAIT);
1725 ret = -ETIMEDOUT;
1726 goto dis_opt_clks;
1727 } else {
1728 pr_debug("omap_hwmod: %s: softreset in %d usec\n", oh->name, c);
1729 }
1730
1731 ret = _clear_softreset(oh, &v);
1732 if (ret)
1733 goto dis_opt_clks;
1734
1735 _write_sysconfig(v, oh);
1736
1737 /*
1738 * XXX add _HWMOD_STATE_WEDGED for modules that don't come back from
1739 * _wait_target_ready() or _reset()
1740 */
1741
1742dis_opt_clks:
1743 if (oh->flags & HWMOD_CONTROL_OPT_CLKS_IN_RESET)
1744 _disable_optional_clocks(oh);
1745
1746 return ret;
1747}
1748
1749/**
1750 * _reset - reset an omap_hwmod
1751 * @oh: struct omap_hwmod *
1752 *
1753 * Resets an omap_hwmod @oh. If the module has a custom reset
1754 * function pointer defined, then call it to reset the IP block, and
1755 * pass along its return value to the caller. Otherwise, if the IP
1756 * block has an OCP_SYSCONFIG register with a SOFTRESET bitfield
1757 * associated with it, call a function to reset the IP block via that
1758 * method, and pass along the return value to the caller. Finally, if
1759 * the IP block has some hardreset lines associated with it, assert
1760 * all of those, but do _not_ deassert them. (This is because driver
1761 * authors have expressed an apparent requirement to control the
1762 * deassertion of the hardreset lines themselves.)
1763 *
1764 * The default software reset mechanism for most OMAP IP blocks is
1765 * triggered via the OCP_SYSCONFIG.SOFTRESET bit. However, some
1766 * hwmods cannot be reset via this method. Some are not targets and
1767 * therefore have no OCP header registers to access. Others (like the
1768 * IVA) have idiosyncratic reset sequences. So for these relatively
1769 * rare cases, custom reset code can be supplied in the struct
1770 * omap_hwmod_class .reset function pointer.
1771 *
1772 * _set_dmadisable() is called to set the DMADISABLE bit so that it
1773 * does not prevent idling of the system. This is necessary for cases
1774 * where ROMCODE/BOOTLOADER uses dma and transfers control to the
1775 * kernel without disabling dma.
1776 *
1777 * Passes along the return value from either _ocp_softreset() or the
1778 * custom reset function - these must return -EINVAL if the hwmod
1779 * cannot be reset this way or if the hwmod is in the wrong state,
1780 * -ETIMEDOUT if the module did not reset in time, or 0 upon success.
1781 */
1782static int _reset(struct omap_hwmod *oh)
1783{
1784 int i, r;
1785
1786 pr_debug("omap_hwmod: %s: resetting\n", oh->name);
1787
1788 if (oh->class->reset) {
1789 r = oh->class->reset(oh);
1790 } else {
1791 if (oh->rst_lines_cnt > 0) {
1792 for (i = 0; i < oh->rst_lines_cnt; i++)
1793 _assert_hardreset(oh, oh->rst_lines[i].name);
1794 return 0;
1795 } else {
1796 r = _ocp_softreset(oh);
1797 if (r == -ENOENT)
1798 r = 0;
1799 }
1800 }
1801
1802 _set_dmadisable(oh);
1803
1804 /*
1805 * OCP_SYSCONFIG bits need to be reprogrammed after a
1806 * softreset. The _enable() function should be split to avoid
1807 * the rewrite of the OCP_SYSCONFIG register.
1808 */
1809 if (oh->class->sysc) {
1810 _update_sysc_cache(oh);
1811 _enable_sysc(oh);
1812 }
1813
1814 return r;
1815}
1816
1817/**
1818 * _omap4_update_context_lost - increment hwmod context loss counter if
1819 * hwmod context was lost, and clear hardware context loss reg
1820 * @oh: hwmod to check for context loss
1821 *
1822 * If the PRCM indicates that the hwmod @oh lost context, increment
1823 * our in-memory context loss counter, and clear the RM_*_CONTEXT
1824 * bits. No return value.
1825 */
1826static void _omap4_update_context_lost(struct omap_hwmod *oh)
1827{
1828 if (oh->prcm.omap4.flags & HWMOD_OMAP4_NO_CONTEXT_LOSS_BIT)
1829 return;
1830
1831 if (!prm_was_any_context_lost_old(oh->clkdm->pwrdm.ptr->prcm_partition,
1832 oh->clkdm->pwrdm.ptr->prcm_offs,
1833 oh->prcm.omap4.context_offs))
1834 return;
1835
1836 oh->prcm.omap4.context_lost_counter++;
1837 prm_clear_context_loss_flags_old(oh->clkdm->pwrdm.ptr->prcm_partition,
1838 oh->clkdm->pwrdm.ptr->prcm_offs,
1839 oh->prcm.omap4.context_offs);
1840}
1841
1842/**
1843 * _omap4_get_context_lost - get context loss counter for a hwmod
1844 * @oh: hwmod to get context loss counter for
1845 *
1846 * Returns the in-memory context loss counter for a hwmod.
1847 */
1848static int _omap4_get_context_lost(struct omap_hwmod *oh)
1849{
1850 return oh->prcm.omap4.context_lost_counter;
1851}
1852
1853/**
1854 * _enable_preprogram - Pre-program an IP block during the _enable() process
1855 * @oh: struct omap_hwmod *
1856 *
1857 * Some IP blocks (such as AESS) require some additional programming
1858 * after enable before they can enter idle. If a function pointer to
1859 * do so is present in the hwmod data, then call it and pass along the
1860 * return value; otherwise, return 0.
1861 */
1862static int _enable_preprogram(struct omap_hwmod *oh)
1863{
1864 if (!oh->class->enable_preprogram)
1865 return 0;
1866
1867 return oh->class->enable_preprogram(oh);
1868}
1869
1870/**
1871 * _enable - enable an omap_hwmod
1872 * @oh: struct omap_hwmod *
1873 *
1874 * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
1875 * register target. Returns -EINVAL if the hwmod is in the wrong
1876 * state or passes along the return value of _wait_target_ready().
1877 */
1878static int _enable(struct omap_hwmod *oh)
1879{
1880 int r;
1881
1882 pr_debug("omap_hwmod: %s: enabling\n", oh->name);
1883
1884 /*
1885 * hwmods with HWMOD_INIT_NO_IDLE flag set are left in enabled
1886 * state at init.
1887 */
1888 if (oh->_int_flags & _HWMOD_SKIP_ENABLE) {
1889 oh->_int_flags &= ~_HWMOD_SKIP_ENABLE;
1890 return 0;
1891 }
1892
1893 if (oh->_state != _HWMOD_STATE_INITIALIZED &&
1894 oh->_state != _HWMOD_STATE_IDLE &&
1895 oh->_state != _HWMOD_STATE_DISABLED) {
1896 WARN(1, "omap_hwmod: %s: enabled state can only be entered from initialized, idle, or disabled state\n",
1897 oh->name);
1898 return -EINVAL;
1899 }
1900
1901 /*
1902 * If an IP block contains HW reset lines and all of them are
1903 * asserted, we let integration code associated with that
1904 * block handle the enable. We've received very little
1905 * information on what those driver authors need, and until
1906 * detailed information is provided and the driver code is
1907 * posted to the public lists, this is probably the best we
1908 * can do.
1909 */
1910 if (_are_all_hardreset_lines_asserted(oh))
1911 return 0;
1912
1913 _add_initiator_dep(oh, mpu_oh);
1914
1915 if (oh->clkdm) {
1916 /*
1917 * A clockdomain must be in SW_SUP before enabling
1918 * completely the module. The clockdomain can be set
1919 * in HW_AUTO only when the module become ready.
1920 */
1921 clkdm_deny_idle(oh->clkdm);
1922 r = clkdm_hwmod_enable(oh->clkdm, oh);
1923 if (r) {
1924 WARN(1, "omap_hwmod: %s: could not enable clockdomain %s: %d\n",
1925 oh->name, oh->clkdm->name, r);
1926 return r;
1927 }
1928 }
1929
1930 _enable_clocks(oh);
1931 if (soc_ops.enable_module)
1932 soc_ops.enable_module(oh);
1933 if (oh->flags & HWMOD_BLOCK_WFI)
1934 cpu_idle_poll_ctrl(true);
1935
1936 if (soc_ops.update_context_lost)
1937 soc_ops.update_context_lost(oh);
1938
1939 r = (soc_ops.wait_target_ready) ? soc_ops.wait_target_ready(oh) :
1940 -EINVAL;
1941 if (oh->clkdm && !(oh->flags & HWMOD_CLKDM_NOAUTO))
1942 clkdm_allow_idle(oh->clkdm);
1943
1944 if (!r) {
1945 oh->_state = _HWMOD_STATE_ENABLED;
1946
1947 /* Access the sysconfig only if the target is ready */
1948 if (oh->class->sysc) {
1949 if (!(oh->_int_flags & _HWMOD_SYSCONFIG_LOADED))
1950 _update_sysc_cache(oh);
1951 _enable_sysc(oh);
1952 }
1953 r = _enable_preprogram(oh);
1954 } else {
1955 if (soc_ops.disable_module)
1956 soc_ops.disable_module(oh);
1957 _disable_clocks(oh);
1958 pr_err("omap_hwmod: %s: _wait_target_ready failed: %d\n",
1959 oh->name, r);
1960
1961 if (oh->clkdm)
1962 clkdm_hwmod_disable(oh->clkdm, oh);
1963 }
1964
1965 return r;
1966}
1967
1968/**
1969 * _idle - idle an omap_hwmod
1970 * @oh: struct omap_hwmod *
1971 *
1972 * Idles an omap_hwmod @oh. This should be called once the hwmod has
1973 * no further work. Returns -EINVAL if the hwmod is in the wrong
1974 * state or returns 0.
1975 */
1976static int _idle(struct omap_hwmod *oh)
1977{
1978 if (oh->flags & HWMOD_NO_IDLE) {
1979 oh->_int_flags |= _HWMOD_SKIP_ENABLE;
1980 return 0;
1981 }
1982
1983 pr_debug("omap_hwmod: %s: idling\n", oh->name);
1984
1985 if (_are_all_hardreset_lines_asserted(oh))
1986 return 0;
1987
1988 if (oh->_state != _HWMOD_STATE_ENABLED) {
1989 WARN(1, "omap_hwmod: %s: idle state can only be entered from enabled state\n",
1990 oh->name);
1991 return -EINVAL;
1992 }
1993
1994 if (oh->class->sysc)
1995 _idle_sysc(oh);
1996 _del_initiator_dep(oh, mpu_oh);
1997
1998 /*
1999 * If HWMOD_CLKDM_NOAUTO is set then we don't
2000 * deny idle the clkdm again since idle was already denied
2001 * in _enable()
2002 */
2003 if (oh->clkdm && !(oh->flags & HWMOD_CLKDM_NOAUTO))
2004 clkdm_deny_idle(oh->clkdm);
2005
2006 if (oh->flags & HWMOD_BLOCK_WFI)
2007 cpu_idle_poll_ctrl(false);
2008 if (soc_ops.disable_module)
2009 soc_ops.disable_module(oh);
2010
2011 /*
2012 * The module must be in idle mode before disabling any parents
2013 * clocks. Otherwise, the parent clock might be disabled before
2014 * the module transition is done, and thus will prevent the
2015 * transition to complete properly.
2016 */
2017 _disable_clocks(oh);
2018 if (oh->clkdm) {
2019 clkdm_allow_idle(oh->clkdm);
2020 clkdm_hwmod_disable(oh->clkdm, oh);
2021 }
2022
2023 oh->_state = _HWMOD_STATE_IDLE;
2024
2025 return 0;
2026}
2027
2028/**
2029 * _shutdown - shutdown an omap_hwmod
2030 * @oh: struct omap_hwmod *
2031 *
2032 * Shut down an omap_hwmod @oh. This should be called when the driver
2033 * used for the hwmod is removed or unloaded or if the driver is not
2034 * used by the system. Returns -EINVAL if the hwmod is in the wrong
2035 * state or returns 0.
2036 */
2037static int _shutdown(struct omap_hwmod *oh)
2038{
2039 int ret, i;
2040 u8 prev_state;
2041
2042 if (_are_all_hardreset_lines_asserted(oh))
2043 return 0;
2044
2045 if (oh->_state != _HWMOD_STATE_IDLE &&
2046 oh->_state != _HWMOD_STATE_ENABLED) {
2047 WARN(1, "omap_hwmod: %s: disabled state can only be entered from idle, or enabled state\n",
2048 oh->name);
2049 return -EINVAL;
2050 }
2051
2052 pr_debug("omap_hwmod: %s: disabling\n", oh->name);
2053
2054 if (oh->class->pre_shutdown) {
2055 prev_state = oh->_state;
2056 if (oh->_state == _HWMOD_STATE_IDLE)
2057 _enable(oh);
2058 ret = oh->class->pre_shutdown(oh);
2059 if (ret) {
2060 if (prev_state == _HWMOD_STATE_IDLE)
2061 _idle(oh);
2062 return ret;
2063 }
2064 }
2065
2066 if (oh->class->sysc) {
2067 if (oh->_state == _HWMOD_STATE_IDLE)
2068 _enable(oh);
2069 _shutdown_sysc(oh);
2070 }
2071
2072 /* clocks and deps are already disabled in idle */
2073 if (oh->_state == _HWMOD_STATE_ENABLED) {
2074 _del_initiator_dep(oh, mpu_oh);
2075 /* XXX what about the other system initiators here? dma, dsp */
2076 if (oh->flags & HWMOD_BLOCK_WFI)
2077 cpu_idle_poll_ctrl(false);
2078 if (soc_ops.disable_module)
2079 soc_ops.disable_module(oh);
2080 _disable_clocks(oh);
2081 if (oh->clkdm)
2082 clkdm_hwmod_disable(oh->clkdm, oh);
2083 }
2084 /* XXX Should this code also force-disable the optional clocks? */
2085
2086 for (i = 0; i < oh->rst_lines_cnt; i++)
2087 _assert_hardreset(oh, oh->rst_lines[i].name);
2088
2089 oh->_state = _HWMOD_STATE_DISABLED;
2090
2091 return 0;
2092}
2093
2094static int of_dev_find_hwmod(struct device_node *np,
2095 struct omap_hwmod *oh)
2096{
2097 int count, i, res;
2098 const char *p;
2099
2100 count = of_property_count_strings(np, "ti,hwmods");
2101 if (count < 1)
2102 return -ENODEV;
2103
2104 for (i = 0; i < count; i++) {
2105 res = of_property_read_string_index(np, "ti,hwmods",
2106 i, &p);
2107 if (res)
2108 continue;
2109 if (!strcmp(p, oh->name)) {
2110 pr_debug("omap_hwmod: dt %s[%i] uses hwmod %s\n",
2111 np->name, i, oh->name);
2112 return i;
2113 }
2114 }
2115
2116 return -ENODEV;
2117}
2118
2119/**
2120 * of_dev_hwmod_lookup - look up needed hwmod from dt blob
2121 * @np: struct device_node *
2122 * @oh: struct omap_hwmod *
2123 * @index: index of the entry found
2124 * @found: struct device_node * found or NULL
2125 *
2126 * Parse the dt blob and find out needed hwmod. Recursive function is
2127 * implemented to take care hierarchical dt blob parsing.
2128 * Return: Returns 0 on success, -ENODEV when not found.
2129 */
2130static int of_dev_hwmod_lookup(struct device_node *np,
2131 struct omap_hwmod *oh,
2132 int *index,
2133 struct device_node **found)
2134{
2135 struct device_node *np0 = NULL;
2136 int res;
2137
2138 res = of_dev_find_hwmod(np, oh);
2139 if (res >= 0) {
2140 *found = np;
2141 *index = res;
2142 return 0;
2143 }
2144
2145 for_each_child_of_node(np, np0) {
2146 struct device_node *fc;
2147 int i;
2148
2149 res = of_dev_hwmod_lookup(np0, oh, &i, &fc);
2150 if (res == 0) {
2151 *found = fc;
2152 *index = i;
2153 return 0;
2154 }
2155 }
2156
2157 *found = NULL;
2158 *index = 0;
2159
2160 return -ENODEV;
2161}
2162
2163/**
2164 * omap_hwmod_parse_module_range - map module IO range from device tree
2165 * @oh: struct omap_hwmod *
2166 * @np: struct device_node *
2167 *
2168 * Parse the device tree range an interconnect target module provides
2169 * for it's child device IP blocks. This way we can support the old
2170 * "ti,hwmods" property with just dts data without a need for platform
2171 * data for IO resources. And we don't need all the child IP device
2172 * nodes available in the dts.
2173 */
2174int omap_hwmod_parse_module_range(struct omap_hwmod *oh,
2175 struct device_node *np,
2176 struct resource *res)
2177{
2178 struct property *prop;
2179 const __be32 *ranges;
2180 const char *name;
2181 u32 nr_addr, nr_size;
2182 u64 base, size;
2183 int len, error;
2184
2185 if (!res)
2186 return -EINVAL;
2187
2188 ranges = of_get_property(np, "ranges", &len);
2189 if (!ranges)
2190 return -ENOENT;
2191
2192 len /= sizeof(*ranges);
2193
2194 if (len < 3)
2195 return -EINVAL;
2196
2197 of_property_for_each_string(np, "compatible", prop, name)
2198 if (!strncmp("ti,sysc-", name, 8))
2199 break;
2200
2201 if (!name)
2202 return -ENOENT;
2203
2204 error = of_property_read_u32(np, "#address-cells", &nr_addr);
2205 if (error)
2206 return -ENOENT;
2207
2208 error = of_property_read_u32(np, "#size-cells", &nr_size);
2209 if (error)
2210 return -ENOENT;
2211
2212 if (nr_addr != 1 || nr_size != 1) {
2213 pr_err("%s: invalid range for %s->%s\n", __func__,
2214 oh->name, np->name);
2215 return -EINVAL;
2216 }
2217
2218 ranges++;
2219 base = of_translate_address(np, ranges++);
2220 size = be32_to_cpup(ranges);
2221
2222 pr_debug("omap_hwmod: %s %s at 0x%llx size 0x%llx\n",
2223 oh->name, np->name, base, size);
2224
2225 res->start = base;
2226 res->end = base + size - 1;
2227 res->flags = IORESOURCE_MEM;
2228
2229 return 0;
2230}
2231
2232/**
2233 * _init_mpu_rt_base - populate the virtual address for a hwmod
2234 * @oh: struct omap_hwmod * to locate the virtual address
2235 * @data: (unused, caller should pass NULL)
2236 * @index: index of the reg entry iospace in device tree
2237 * @np: struct device_node * of the IP block's device node in the DT data
2238 *
2239 * Cache the virtual address used by the MPU to access this IP block's
2240 * registers. This address is needed early so the OCP registers that
2241 * are part of the device's address space can be ioremapped properly.
2242 *
2243 * If SYSC access is not needed, the registers will not be remapped
2244 * and non-availability of MPU access is not treated as an error.
2245 *
2246 * Returns 0 on success, -EINVAL if an invalid hwmod is passed, and
2247 * -ENXIO on absent or invalid register target address space.
2248 */
2249static int __init _init_mpu_rt_base(struct omap_hwmod *oh, void *data,
2250 int index, struct device_node *np)
2251{
2252 void __iomem *va_start = NULL;
2253 struct resource res;
2254 int error;
2255
2256 if (!oh)
2257 return -EINVAL;
2258
2259 _save_mpu_port_index(oh);
2260
2261 /* if we don't need sysc access we don't need to ioremap */
2262 if (!oh->class->sysc)
2263 return 0;
2264
2265 /* we can't continue without MPU PORT if we need sysc access */
2266 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
2267 return -ENXIO;
2268
2269 if (!np) {
2270 pr_err("omap_hwmod: %s: no dt node\n", oh->name);
2271 return -ENXIO;
2272 }
2273
2274 /* Do we have a dts range for the interconnect target module? */
2275 error = omap_hwmod_parse_module_range(oh, np, &res);
2276 if (!error)
2277 va_start = ioremap(res.start, resource_size(&res));
2278
2279 /* No ranges, rely on device reg entry */
2280 if (!va_start)
2281 va_start = of_iomap(np, index + oh->mpu_rt_idx);
2282 if (!va_start) {
2283 pr_err("omap_hwmod: %s: Missing dt reg%i for %pOF\n",
2284 oh->name, index, np);
2285 return -ENXIO;
2286 }
2287
2288 pr_debug("omap_hwmod: %s: MPU register target at va %p\n",
2289 oh->name, va_start);
2290
2291 oh->_mpu_rt_va = va_start;
2292 return 0;
2293}
2294
2295/**
2296 * _init - initialize internal data for the hwmod @oh
2297 * @oh: struct omap_hwmod *
2298 * @n: (unused)
2299 *
2300 * Look up the clocks and the address space used by the MPU to access
2301 * registers belonging to the hwmod @oh. @oh must already be
2302 * registered at this point. This is the first of two phases for
2303 * hwmod initialization. Code called here does not touch any hardware
2304 * registers, it simply prepares internal data structures. Returns 0
2305 * upon success or if the hwmod isn't registered or if the hwmod's
2306 * address space is not defined, or -EINVAL upon failure.
2307 */
2308static int __init _init(struct omap_hwmod *oh, void *data)
2309{
2310 int r, index;
2311 struct device_node *np = NULL;
2312 struct device_node *bus;
2313
2314 if (oh->_state != _HWMOD_STATE_REGISTERED)
2315 return 0;
2316
2317 bus = of_find_node_by_name(NULL, "ocp");
2318 if (!bus)
2319 return -ENODEV;
2320
2321 r = of_dev_hwmod_lookup(bus, oh, &index, &np);
2322 if (r)
2323 pr_debug("omap_hwmod: %s missing dt data\n", oh->name);
2324 else if (np && index)
2325 pr_warn("omap_hwmod: %s using broken dt data from %s\n",
2326 oh->name, np->name);
2327
2328 r = _init_mpu_rt_base(oh, NULL, index, np);
2329 if (r < 0) {
2330 WARN(1, "omap_hwmod: %s: doesn't have mpu register target base\n",
2331 oh->name);
2332 return 0;
2333 }
2334
2335 r = _init_clocks(oh, np);
2336 if (r < 0) {
2337 WARN(1, "omap_hwmod: %s: couldn't init clocks\n", oh->name);
2338 return -EINVAL;
2339 }
2340
2341 if (np) {
2342 if (of_find_property(np, "ti,no-reset-on-init", NULL))
2343 oh->flags |= HWMOD_INIT_NO_RESET;
2344 if (of_find_property(np, "ti,no-idle-on-init", NULL))
2345 oh->flags |= HWMOD_INIT_NO_IDLE;
2346 if (of_find_property(np, "ti,no-idle", NULL))
2347 oh->flags |= HWMOD_NO_IDLE;
2348 }
2349
2350 oh->_state = _HWMOD_STATE_INITIALIZED;
2351
2352 return 0;
2353}
2354
2355/**
2356 * _setup_iclk_autoidle - configure an IP block's interface clocks
2357 * @oh: struct omap_hwmod *
2358 *
2359 * Set up the module's interface clocks. XXX This function is still mostly
2360 * a stub; implementing this properly requires iclk autoidle usecounting in
2361 * the clock code. No return value.
2362 */
2363static void __init _setup_iclk_autoidle(struct omap_hwmod *oh)
2364{
2365 struct omap_hwmod_ocp_if *os;
2366
2367 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2368 return;
2369
2370 list_for_each_entry(os, &oh->slave_ports, node) {
2371 if (!os->_clk)
2372 continue;
2373
2374 if (os->flags & OCPIF_SWSUP_IDLE) {
2375 /* XXX omap_iclk_deny_idle(c); */
2376 } else {
2377 /* XXX omap_iclk_allow_idle(c); */
2378 clk_enable(os->_clk);
2379 }
2380 }
2381
2382 return;
2383}
2384
2385/**
2386 * _setup_reset - reset an IP block during the setup process
2387 * @oh: struct omap_hwmod *
2388 *
2389 * Reset the IP block corresponding to the hwmod @oh during the setup
2390 * process. The IP block is first enabled so it can be successfully
2391 * reset. Returns 0 upon success or a negative error code upon
2392 * failure.
2393 */
2394static int __init _setup_reset(struct omap_hwmod *oh)
2395{
2396 int r;
2397
2398 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2399 return -EINVAL;
2400
2401 if (oh->flags & HWMOD_EXT_OPT_MAIN_CLK)
2402 return -EPERM;
2403
2404 if (oh->rst_lines_cnt == 0) {
2405 r = _enable(oh);
2406 if (r) {
2407 pr_warn("omap_hwmod: %s: cannot be enabled for reset (%d)\n",
2408 oh->name, oh->_state);
2409 return -EINVAL;
2410 }
2411 }
2412
2413 if (!(oh->flags & HWMOD_INIT_NO_RESET))
2414 r = _reset(oh);
2415
2416 return r;
2417}
2418
2419/**
2420 * _setup_postsetup - transition to the appropriate state after _setup
2421 * @oh: struct omap_hwmod *
2422 *
2423 * Place an IP block represented by @oh into a "post-setup" state --
2424 * either IDLE, ENABLED, or DISABLED. ("post-setup" simply means that
2425 * this function is called at the end of _setup().) The postsetup
2426 * state for an IP block can be changed by calling
2427 * omap_hwmod_enter_postsetup_state() early in the boot process,
2428 * before one of the omap_hwmod_setup*() functions are called for the
2429 * IP block.
2430 *
2431 * The IP block stays in this state until a PM runtime-based driver is
2432 * loaded for that IP block. A post-setup state of IDLE is
2433 * appropriate for almost all IP blocks with runtime PM-enabled
2434 * drivers, since those drivers are able to enable the IP block. A
2435 * post-setup state of ENABLED is appropriate for kernels with PM
2436 * runtime disabled. The DISABLED state is appropriate for unusual IP
2437 * blocks such as the MPU WDTIMER on kernels without WDTIMER drivers
2438 * included, since the WDTIMER starts running on reset and will reset
2439 * the MPU if left active.
2440 *
2441 * This post-setup mechanism is deprecated. Once all of the OMAP
2442 * drivers have been converted to use PM runtime, and all of the IP
2443 * block data and interconnect data is available to the hwmod code, it
2444 * should be possible to replace this mechanism with a "lazy reset"
2445 * arrangement. In a "lazy reset" setup, each IP block is enabled
2446 * when the driver first probes, then all remaining IP blocks without
2447 * drivers are either shut down or enabled after the drivers have
2448 * loaded. However, this cannot take place until the above
2449 * preconditions have been met, since otherwise the late reset code
2450 * has no way of knowing which IP blocks are in use by drivers, and
2451 * which ones are unused.
2452 *
2453 * No return value.
2454 */
2455static void __init _setup_postsetup(struct omap_hwmod *oh)
2456{
2457 u8 postsetup_state;
2458
2459 if (oh->rst_lines_cnt > 0)
2460 return;
2461
2462 postsetup_state = oh->_postsetup_state;
2463 if (postsetup_state == _HWMOD_STATE_UNKNOWN)
2464 postsetup_state = _HWMOD_STATE_ENABLED;
2465
2466 /*
2467 * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -
2468 * it should be set by the core code as a runtime flag during startup
2469 */
2470 if ((oh->flags & (HWMOD_INIT_NO_IDLE | HWMOD_NO_IDLE)) &&
2471 (postsetup_state == _HWMOD_STATE_IDLE)) {
2472 oh->_int_flags |= _HWMOD_SKIP_ENABLE;
2473 postsetup_state = _HWMOD_STATE_ENABLED;
2474 }
2475
2476 if (postsetup_state == _HWMOD_STATE_IDLE)
2477 _idle(oh);
2478 else if (postsetup_state == _HWMOD_STATE_DISABLED)
2479 _shutdown(oh);
2480 else if (postsetup_state != _HWMOD_STATE_ENABLED)
2481 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
2482 oh->name, postsetup_state);
2483
2484 return;
2485}
2486
2487/**
2488 * _setup - prepare IP block hardware for use
2489 * @oh: struct omap_hwmod *
2490 * @n: (unused, pass NULL)
2491 *
2492 * Configure the IP block represented by @oh. This may include
2493 * enabling the IP block, resetting it, and placing it into a
2494 * post-setup state, depending on the type of IP block and applicable
2495 * flags. IP blocks are reset to prevent any previous configuration
2496 * by the bootloader or previous operating system from interfering
2497 * with power management or other parts of the system. The reset can
2498 * be avoided; see omap_hwmod_no_setup_reset(). This is the second of
2499 * two phases for hwmod initialization. Code called here generally
2500 * affects the IP block hardware, or system integration hardware
2501 * associated with the IP block. Returns 0.
2502 */
2503static int _setup(struct omap_hwmod *oh, void *data)
2504{
2505 if (oh->_state != _HWMOD_STATE_INITIALIZED)
2506 return 0;
2507
2508 if (oh->parent_hwmod) {
2509 int r;
2510
2511 r = _enable(oh->parent_hwmod);
2512 WARN(r, "hwmod: %s: setup: failed to enable parent hwmod %s\n",
2513 oh->name, oh->parent_hwmod->name);
2514 }
2515
2516 _setup_iclk_autoidle(oh);
2517
2518 if (!_setup_reset(oh))
2519 _setup_postsetup(oh);
2520
2521 if (oh->parent_hwmod) {
2522 u8 postsetup_state;
2523
2524 postsetup_state = oh->parent_hwmod->_postsetup_state;
2525
2526 if (postsetup_state == _HWMOD_STATE_IDLE)
2527 _idle(oh->parent_hwmod);
2528 else if (postsetup_state == _HWMOD_STATE_DISABLED)
2529 _shutdown(oh->parent_hwmod);
2530 else if (postsetup_state != _HWMOD_STATE_ENABLED)
2531 WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",
2532 oh->parent_hwmod->name, postsetup_state);
2533 }
2534
2535 return 0;
2536}
2537
2538/**
2539 * _register - register a struct omap_hwmod
2540 * @oh: struct omap_hwmod *
2541 *
2542 * Registers the omap_hwmod @oh. Returns -EEXIST if an omap_hwmod
2543 * already has been registered by the same name; -EINVAL if the
2544 * omap_hwmod is in the wrong state, if @oh is NULL, if the
2545 * omap_hwmod's class field is NULL; if the omap_hwmod is missing a
2546 * name, or if the omap_hwmod's class is missing a name; or 0 upon
2547 * success.
2548 *
2549 * XXX The data should be copied into bootmem, so the original data
2550 * should be marked __initdata and freed after init. This would allow
2551 * unneeded omap_hwmods to be freed on multi-OMAP configurations. Note
2552 * that the copy process would be relatively complex due to the large number
2553 * of substructures.
2554 */
2555static int __init _register(struct omap_hwmod *oh)
2556{
2557 if (!oh || !oh->name || !oh->class || !oh->class->name ||
2558 (oh->_state != _HWMOD_STATE_UNKNOWN))
2559 return -EINVAL;
2560
2561 pr_debug("omap_hwmod: %s: registering\n", oh->name);
2562
2563 if (_lookup(oh->name))
2564 return -EEXIST;
2565
2566 list_add_tail(&oh->node, &omap_hwmod_list);
2567
2568 INIT_LIST_HEAD(&oh->slave_ports);
2569 spin_lock_init(&oh->_lock);
2570 lockdep_set_class(&oh->_lock, &oh->hwmod_key);
2571
2572 oh->_state = _HWMOD_STATE_REGISTERED;
2573
2574 /*
2575 * XXX Rather than doing a strcmp(), this should test a flag
2576 * set in the hwmod data, inserted by the autogenerator code.
2577 */
2578 if (!strcmp(oh->name, MPU_INITIATOR_NAME))
2579 mpu_oh = oh;
2580
2581 return 0;
2582}
2583
2584/**
2585 * _add_link - add an interconnect between two IP blocks
2586 * @oi: pointer to a struct omap_hwmod_ocp_if record
2587 *
2588 * Add struct omap_hwmod_link records connecting the slave IP block
2589 * specified in @oi->slave to @oi. This code is assumed to run before
2590 * preemption or SMP has been enabled, thus avoiding the need for
2591 * locking in this code. Changes to this assumption will require
2592 * additional locking. Returns 0.
2593 */
2594static int __init _add_link(struct omap_hwmod_ocp_if *oi)
2595{
2596 pr_debug("omap_hwmod: %s -> %s: adding link\n", oi->master->name,
2597 oi->slave->name);
2598
2599 list_add(&oi->node, &oi->slave->slave_ports);
2600 oi->slave->slaves_cnt++;
2601
2602 return 0;
2603}
2604
2605/**
2606 * _register_link - register a struct omap_hwmod_ocp_if
2607 * @oi: struct omap_hwmod_ocp_if *
2608 *
2609 * Registers the omap_hwmod_ocp_if record @oi. Returns -EEXIST if it
2610 * has already been registered; -EINVAL if @oi is NULL or if the
2611 * record pointed to by @oi is missing required fields; or 0 upon
2612 * success.
2613 *
2614 * XXX The data should be copied into bootmem, so the original data
2615 * should be marked __initdata and freed after init. This would allow
2616 * unneeded omap_hwmods to be freed on multi-OMAP configurations.
2617 */
2618static int __init _register_link(struct omap_hwmod_ocp_if *oi)
2619{
2620 if (!oi || !oi->master || !oi->slave || !oi->user)
2621 return -EINVAL;
2622
2623 if (oi->_int_flags & _OCPIF_INT_FLAGS_REGISTERED)
2624 return -EEXIST;
2625
2626 pr_debug("omap_hwmod: registering link from %s to %s\n",
2627 oi->master->name, oi->slave->name);
2628
2629 /*
2630 * Register the connected hwmods, if they haven't been
2631 * registered already
2632 */
2633 if (oi->master->_state != _HWMOD_STATE_REGISTERED)
2634 _register(oi->master);
2635
2636 if (oi->slave->_state != _HWMOD_STATE_REGISTERED)
2637 _register(oi->slave);
2638
2639 _add_link(oi);
2640
2641 oi->_int_flags |= _OCPIF_INT_FLAGS_REGISTERED;
2642
2643 return 0;
2644}
2645
2646/* Static functions intended only for use in soc_ops field function pointers */
2647
2648/**
2649 * _omap2xxx_3xxx_wait_target_ready - wait for a module to leave slave idle
2650 * @oh: struct omap_hwmod *
2651 *
2652 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2653 * does not have an IDLEST bit or if the module successfully leaves
2654 * slave idle; otherwise, pass along the return value of the
2655 * appropriate *_cm*_wait_module_ready() function.
2656 */
2657static int _omap2xxx_3xxx_wait_target_ready(struct omap_hwmod *oh)
2658{
2659 if (!oh)
2660 return -EINVAL;
2661
2662 if (oh->flags & HWMOD_NO_IDLEST)
2663 return 0;
2664
2665 if (!_find_mpu_rt_port(oh))
2666 return 0;
2667
2668 /* XXX check module SIDLEMODE, hardreset status, enabled clocks */
2669
2670 return omap_cm_wait_module_ready(0, oh->prcm.omap2.module_offs,
2671 oh->prcm.omap2.idlest_reg_id,
2672 oh->prcm.omap2.idlest_idle_bit);
2673}
2674
2675/**
2676 * _omap4_wait_target_ready - wait for a module to leave slave idle
2677 * @oh: struct omap_hwmod *
2678 *
2679 * Wait for a module @oh to leave slave idle. Returns 0 if the module
2680 * does not have an IDLEST bit or if the module successfully leaves
2681 * slave idle; otherwise, pass along the return value of the
2682 * appropriate *_cm*_wait_module_ready() function.
2683 */
2684static int _omap4_wait_target_ready(struct omap_hwmod *oh)
2685{
2686 if (!oh)
2687 return -EINVAL;
2688
2689 if (oh->flags & HWMOD_NO_IDLEST || !oh->clkdm)
2690 return 0;
2691
2692 if (!_find_mpu_rt_port(oh))
2693 return 0;
2694
2695 if (_omap4_clkctrl_managed_by_clkfwk(oh))
2696 return 0;
2697
2698 if (!_omap4_has_clkctrl_clock(oh))
2699 return 0;
2700
2701 /* XXX check module SIDLEMODE, hardreset status */
2702
2703 return omap_cm_wait_module_ready(oh->clkdm->prcm_partition,
2704 oh->clkdm->cm_inst,
2705 oh->prcm.omap4.clkctrl_offs, 0);
2706}
2707
2708/**
2709 * _omap2_assert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2710 * @oh: struct omap_hwmod * to assert hardreset
2711 * @ohri: hardreset line data
2712 *
2713 * Call omap2_prm_assert_hardreset() with parameters extracted from
2714 * the hwmod @oh and the hardreset line data @ohri. Only intended for
2715 * use as an soc_ops function pointer. Passes along the return value
2716 * from omap2_prm_assert_hardreset(). XXX This function is scheduled
2717 * for removal when the PRM code is moved into drivers/.
2718 */
2719static int _omap2_assert_hardreset(struct omap_hwmod *oh,
2720 struct omap_hwmod_rst_info *ohri)
2721{
2722 return omap_prm_assert_hardreset(ohri->rst_shift, 0,
2723 oh->prcm.omap2.module_offs, 0);
2724}
2725
2726/**
2727 * _omap2_deassert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2728 * @oh: struct omap_hwmod * to deassert hardreset
2729 * @ohri: hardreset line data
2730 *
2731 * Call omap2_prm_deassert_hardreset() with parameters extracted from
2732 * the hwmod @oh and the hardreset line data @ohri. Only intended for
2733 * use as an soc_ops function pointer. Passes along the return value
2734 * from omap2_prm_deassert_hardreset(). XXX This function is
2735 * scheduled for removal when the PRM code is moved into drivers/.
2736 */
2737static int _omap2_deassert_hardreset(struct omap_hwmod *oh,
2738 struct omap_hwmod_rst_info *ohri)
2739{
2740 return omap_prm_deassert_hardreset(ohri->rst_shift, ohri->st_shift, 0,
2741 oh->prcm.omap2.module_offs, 0, 0);
2742}
2743
2744/**
2745 * _omap2_is_hardreset_asserted - call OMAP2 PRM hardreset fn with hwmod args
2746 * @oh: struct omap_hwmod * to test hardreset
2747 * @ohri: hardreset line data
2748 *
2749 * Call omap2_prm_is_hardreset_asserted() with parameters extracted
2750 * from the hwmod @oh and the hardreset line data @ohri. Only
2751 * intended for use as an soc_ops function pointer. Passes along the
2752 * return value from omap2_prm_is_hardreset_asserted(). XXX This
2753 * function is scheduled for removal when the PRM code is moved into
2754 * drivers/.
2755 */
2756static int _omap2_is_hardreset_asserted(struct omap_hwmod *oh,
2757 struct omap_hwmod_rst_info *ohri)
2758{
2759 return omap_prm_is_hardreset_asserted(ohri->st_shift, 0,
2760 oh->prcm.omap2.module_offs, 0);
2761}
2762
2763/**
2764 * _omap4_assert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
2765 * @oh: struct omap_hwmod * to assert hardreset
2766 * @ohri: hardreset line data
2767 *
2768 * Call omap4_prminst_assert_hardreset() with parameters extracted
2769 * from the hwmod @oh and the hardreset line data @ohri. Only
2770 * intended for use as an soc_ops function pointer. Passes along the
2771 * return value from omap4_prminst_assert_hardreset(). XXX This
2772 * function is scheduled for removal when the PRM code is moved into
2773 * drivers/.
2774 */
2775static int _omap4_assert_hardreset(struct omap_hwmod *oh,
2776 struct omap_hwmod_rst_info *ohri)
2777{
2778 if (!oh->clkdm)
2779 return -EINVAL;
2780
2781 return omap_prm_assert_hardreset(ohri->rst_shift,
2782 oh->clkdm->pwrdm.ptr->prcm_partition,
2783 oh->clkdm->pwrdm.ptr->prcm_offs,
2784 oh->prcm.omap4.rstctrl_offs);
2785}
2786
2787/**
2788 * _omap4_deassert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
2789 * @oh: struct omap_hwmod * to deassert hardreset
2790 * @ohri: hardreset line data
2791 *
2792 * Call omap4_prminst_deassert_hardreset() with parameters extracted
2793 * from the hwmod @oh and the hardreset line data @ohri. Only
2794 * intended for use as an soc_ops function pointer. Passes along the
2795 * return value from omap4_prminst_deassert_hardreset(). XXX This
2796 * function is scheduled for removal when the PRM code is moved into
2797 * drivers/.
2798 */
2799static int _omap4_deassert_hardreset(struct omap_hwmod *oh,
2800 struct omap_hwmod_rst_info *ohri)
2801{
2802 if (!oh->clkdm)
2803 return -EINVAL;
2804
2805 if (ohri->st_shift)
2806 pr_err("omap_hwmod: %s: %s: hwmod data error: OMAP4 does not support st_shift\n",
2807 oh->name, ohri->name);
2808 return omap_prm_deassert_hardreset(ohri->rst_shift, ohri->rst_shift,
2809 oh->clkdm->pwrdm.ptr->prcm_partition,
2810 oh->clkdm->pwrdm.ptr->prcm_offs,
2811 oh->prcm.omap4.rstctrl_offs,
2812 oh->prcm.omap4.rstctrl_offs +
2813 OMAP4_RST_CTRL_ST_OFFSET);
2814}
2815
2816/**
2817 * _omap4_is_hardreset_asserted - call OMAP4 PRM hardreset fn with hwmod args
2818 * @oh: struct omap_hwmod * to test hardreset
2819 * @ohri: hardreset line data
2820 *
2821 * Call omap4_prminst_is_hardreset_asserted() with parameters
2822 * extracted from the hwmod @oh and the hardreset line data @ohri.
2823 * Only intended for use as an soc_ops function pointer. Passes along
2824 * the return value from omap4_prminst_is_hardreset_asserted(). XXX
2825 * This function is scheduled for removal when the PRM code is moved
2826 * into drivers/.
2827 */
2828static int _omap4_is_hardreset_asserted(struct omap_hwmod *oh,
2829 struct omap_hwmod_rst_info *ohri)
2830{
2831 if (!oh->clkdm)
2832 return -EINVAL;
2833
2834 return omap_prm_is_hardreset_asserted(ohri->rst_shift,
2835 oh->clkdm->pwrdm.ptr->
2836 prcm_partition,
2837 oh->clkdm->pwrdm.ptr->prcm_offs,
2838 oh->prcm.omap4.rstctrl_offs);
2839}
2840
2841/**
2842 * _omap4_disable_direct_prcm - disable direct PRCM control for hwmod
2843 * @oh: struct omap_hwmod * to disable control for
2844 *
2845 * Disables direct PRCM clkctrl done by hwmod core. Instead, the hwmod
2846 * will be using its main_clk to enable/disable the module. Returns
2847 * 0 if successful.
2848 */
2849static int _omap4_disable_direct_prcm(struct omap_hwmod *oh)
2850{
2851 if (!oh)
2852 return -EINVAL;
2853
2854 oh->prcm.omap4.flags |= HWMOD_OMAP4_CLKFWK_CLKCTR_CLOCK;
2855
2856 return 0;
2857}
2858
2859/**
2860 * _am33xx_deassert_hardreset - call AM33XX PRM hardreset fn with hwmod args
2861 * @oh: struct omap_hwmod * to deassert hardreset
2862 * @ohri: hardreset line data
2863 *
2864 * Call am33xx_prminst_deassert_hardreset() with parameters extracted
2865 * from the hwmod @oh and the hardreset line data @ohri. Only
2866 * intended for use as an soc_ops function pointer. Passes along the
2867 * return value from am33xx_prminst_deassert_hardreset(). XXX This
2868 * function is scheduled for removal when the PRM code is moved into
2869 * drivers/.
2870 */
2871static int _am33xx_deassert_hardreset(struct omap_hwmod *oh,
2872 struct omap_hwmod_rst_info *ohri)
2873{
2874 return omap_prm_deassert_hardreset(ohri->rst_shift, ohri->st_shift,
2875 oh->clkdm->pwrdm.ptr->prcm_partition,
2876 oh->clkdm->pwrdm.ptr->prcm_offs,
2877 oh->prcm.omap4.rstctrl_offs,
2878 oh->prcm.omap4.rstst_offs);
2879}
2880
2881/* Public functions */
2882
2883u32 omap_hwmod_read(struct omap_hwmod *oh, u16 reg_offs)
2884{
2885 if (oh->flags & HWMOD_16BIT_REG)
2886 return readw_relaxed(oh->_mpu_rt_va + reg_offs);
2887 else
2888 return readl_relaxed(oh->_mpu_rt_va + reg_offs);
2889}
2890
2891void omap_hwmod_write(u32 v, struct omap_hwmod *oh, u16 reg_offs)
2892{
2893 if (oh->flags & HWMOD_16BIT_REG)
2894 writew_relaxed(v, oh->_mpu_rt_va + reg_offs);
2895 else
2896 writel_relaxed(v, oh->_mpu_rt_va + reg_offs);
2897}
2898
2899/**
2900 * omap_hwmod_softreset - reset a module via SYSCONFIG.SOFTRESET bit
2901 * @oh: struct omap_hwmod *
2902 *
2903 * This is a public function exposed to drivers. Some drivers may need to do
2904 * some settings before and after resetting the device. Those drivers after
2905 * doing the necessary settings could use this function to start a reset by
2906 * setting the SYSCONFIG.SOFTRESET bit.
2907 */
2908int omap_hwmod_softreset(struct omap_hwmod *oh)
2909{
2910 u32 v;
2911 int ret;
2912
2913 if (!oh || !(oh->_sysc_cache))
2914 return -EINVAL;
2915
2916 v = oh->_sysc_cache;
2917 ret = _set_softreset(oh, &v);
2918 if (ret)
2919 goto error;
2920 _write_sysconfig(v, oh);
2921
2922 ret = _clear_softreset(oh, &v);
2923 if (ret)
2924 goto error;
2925 _write_sysconfig(v, oh);
2926
2927error:
2928 return ret;
2929}
2930
2931/**
2932 * omap_hwmod_lookup - look up a registered omap_hwmod by name
2933 * @name: name of the omap_hwmod to look up
2934 *
2935 * Given a @name of an omap_hwmod, return a pointer to the registered
2936 * struct omap_hwmod *, or NULL upon error.
2937 */
2938struct omap_hwmod *omap_hwmod_lookup(const char *name)
2939{
2940 struct omap_hwmod *oh;
2941
2942 if (!name)
2943 return NULL;
2944
2945 oh = _lookup(name);
2946
2947 return oh;
2948}
2949
2950/**
2951 * omap_hwmod_for_each - call function for each registered omap_hwmod
2952 * @fn: pointer to a callback function
2953 * @data: void * data to pass to callback function
2954 *
2955 * Call @fn for each registered omap_hwmod, passing @data to each
2956 * function. @fn must return 0 for success or any other value for
2957 * failure. If @fn returns non-zero, the iteration across omap_hwmods
2958 * will stop and the non-zero return value will be passed to the
2959 * caller of omap_hwmod_for_each(). @fn is called with
2960 * omap_hwmod_for_each() held.
2961 */
2962int omap_hwmod_for_each(int (*fn)(struct omap_hwmod *oh, void *data),
2963 void *data)
2964{
2965 struct omap_hwmod *temp_oh;
2966 int ret = 0;
2967
2968 if (!fn)
2969 return -EINVAL;
2970
2971 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
2972 ret = (*fn)(temp_oh, data);
2973 if (ret)
2974 break;
2975 }
2976
2977 return ret;
2978}
2979
2980/**
2981 * omap_hwmod_register_links - register an array of hwmod links
2982 * @ois: pointer to an array of omap_hwmod_ocp_if to register
2983 *
2984 * Intended to be called early in boot before the clock framework is
2985 * initialized. If @ois is not null, will register all omap_hwmods
2986 * listed in @ois that are valid for this chip. Returns -EINVAL if
2987 * omap_hwmod_init() hasn't been called before calling this function,
2988 * -ENOMEM if the link memory area can't be allocated, or 0 upon
2989 * success.
2990 */
2991int __init omap_hwmod_register_links(struct omap_hwmod_ocp_if **ois)
2992{
2993 int r, i;
2994
2995 if (!inited)
2996 return -EINVAL;
2997
2998 if (!ois)
2999 return 0;
3000
3001 if (ois[0] == NULL) /* Empty list */
3002 return 0;
3003
3004 i = 0;
3005 do {
3006 r = _register_link(ois[i]);
3007 WARN(r && r != -EEXIST,
3008 "omap_hwmod: _register_link(%s -> %s) returned %d\n",
3009 ois[i]->master->name, ois[i]->slave->name, r);
3010 } while (ois[++i]);
3011
3012 return 0;
3013}
3014
3015/**
3016 * _ensure_mpu_hwmod_is_setup - ensure the MPU SS hwmod is init'ed and set up
3017 * @oh: pointer to the hwmod currently being set up (usually not the MPU)
3018 *
3019 * If the hwmod data corresponding to the MPU subsystem IP block
3020 * hasn't been initialized and set up yet, do so now. This must be
3021 * done first since sleep dependencies may be added from other hwmods
3022 * to the MPU. Intended to be called only by omap_hwmod_setup*(). No
3023 * return value.
3024 */
3025static void __init _ensure_mpu_hwmod_is_setup(struct omap_hwmod *oh)
3026{
3027 if (!mpu_oh || mpu_oh->_state == _HWMOD_STATE_UNKNOWN)
3028 pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",
3029 __func__, MPU_INITIATOR_NAME);
3030 else if (mpu_oh->_state == _HWMOD_STATE_REGISTERED && oh != mpu_oh)
3031 omap_hwmod_setup_one(MPU_INITIATOR_NAME);
3032}
3033
3034/**
3035 * omap_hwmod_setup_one - set up a single hwmod
3036 * @oh_name: const char * name of the already-registered hwmod to set up
3037 *
3038 * Initialize and set up a single hwmod. Intended to be used for a
3039 * small number of early devices, such as the timer IP blocks used for
3040 * the scheduler clock. Must be called after omap2_clk_init().
3041 * Resolves the struct clk names to struct clk pointers for each
3042 * registered omap_hwmod. Also calls _setup() on each hwmod. Returns
3043 * -EINVAL upon error or 0 upon success.
3044 */
3045int __init omap_hwmod_setup_one(const char *oh_name)
3046{
3047 struct omap_hwmod *oh;
3048
3049 pr_debug("omap_hwmod: %s: %s\n", oh_name, __func__);
3050
3051 oh = _lookup(oh_name);
3052 if (!oh) {
3053 WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name);
3054 return -EINVAL;
3055 }
3056
3057 _ensure_mpu_hwmod_is_setup(oh);
3058
3059 _init(oh, NULL);
3060 _setup(oh, NULL);
3061
3062 return 0;
3063}
3064
3065static void omap_hwmod_check_one(struct device *dev,
3066 const char *name, s8 v1, u8 v2)
3067{
3068 if (v1 < 0)
3069 return;
3070
3071 if (v1 != v2)
3072 dev_warn(dev, "%s %d != %d\n", name, v1, v2);
3073}
3074
3075/**
3076 * omap_hwmod_check_sysc - check sysc against platform sysc
3077 * @dev: struct device
3078 * @data: module data
3079 * @sysc_fields: new sysc configuration
3080 */
3081static int omap_hwmod_check_sysc(struct device *dev,
3082 const struct ti_sysc_module_data *data,
3083 struct sysc_regbits *sysc_fields)
3084{
3085 const struct sysc_regbits *regbits = data->cap->regbits;
3086
3087 omap_hwmod_check_one(dev, "dmadisable_shift",
3088 regbits->dmadisable_shift,
3089 sysc_fields->dmadisable_shift);
3090 omap_hwmod_check_one(dev, "midle_shift",
3091 regbits->midle_shift,
3092 sysc_fields->midle_shift);
3093 omap_hwmod_check_one(dev, "sidle_shift",
3094 regbits->sidle_shift,
3095 sysc_fields->sidle_shift);
3096 omap_hwmod_check_one(dev, "clkact_shift",
3097 regbits->clkact_shift,
3098 sysc_fields->clkact_shift);
3099 omap_hwmod_check_one(dev, "enwkup_shift",
3100 regbits->enwkup_shift,
3101 sysc_fields->enwkup_shift);
3102 omap_hwmod_check_one(dev, "srst_shift",
3103 regbits->srst_shift,
3104 sysc_fields->srst_shift);
3105 omap_hwmod_check_one(dev, "autoidle_shift",
3106 regbits->autoidle_shift,
3107 sysc_fields->autoidle_shift);
3108
3109 return 0;
3110}
3111
3112/**
3113 * omap_hwmod_init_regbits - init sysconfig specific register bits
3114 * @dev: struct device
3115 * @data: module data
3116 * @sysc_fields: new sysc configuration
3117 */
3118static int omap_hwmod_init_regbits(struct device *dev,
3119 const struct ti_sysc_module_data *data,
3120 struct sysc_regbits **sysc_fields)
3121{
3122 *sysc_fields = NULL;
3123
3124 switch (data->cap->type) {
3125 case TI_SYSC_OMAP2:
3126 case TI_SYSC_OMAP2_TIMER:
3127 *sysc_fields = &omap_hwmod_sysc_type1;
3128 break;
3129 case TI_SYSC_OMAP3_SHAM:
3130 *sysc_fields = &omap3_sham_sysc_fields;
3131 break;
3132 case TI_SYSC_OMAP3_AES:
3133 *sysc_fields = &omap3xxx_aes_sysc_fields;
3134 break;
3135 case TI_SYSC_OMAP4:
3136 case TI_SYSC_OMAP4_TIMER:
3137 *sysc_fields = &omap_hwmod_sysc_type2;
3138 break;
3139 case TI_SYSC_OMAP4_SIMPLE:
3140 *sysc_fields = &omap_hwmod_sysc_type3;
3141 break;
3142 case TI_SYSC_OMAP34XX_SR:
3143 *sysc_fields = &omap34xx_sr_sysc_fields;
3144 break;
3145 case TI_SYSC_OMAP36XX_SR:
3146 *sysc_fields = &omap36xx_sr_sysc_fields;
3147 break;
3148 case TI_SYSC_OMAP4_SR:
3149 *sysc_fields = &omap36xx_sr_sysc_fields;
3150 break;
3151 case TI_SYSC_OMAP4_MCASP:
3152 *sysc_fields = &omap_hwmod_sysc_type_mcasp;
3153 break;
3154 case TI_SYSC_OMAP4_USB_HOST_FS:
3155 *sysc_fields = &omap_hwmod_sysc_type_usb_host_fs;
3156 break;
3157 default:
3158 return -EINVAL;
3159 }
3160
3161 return omap_hwmod_check_sysc(dev, data, *sysc_fields);
3162}
3163
3164/**
3165 * omap_hwmod_init_reg_offs - initialize sysconfig register offsets
3166 * @dev: struct device
3167 * @data: module data
3168 * @rev_offs: revision register offset
3169 * @sysc_offs: sysc register offset
3170 * @syss_offs: syss register offset
3171 */
3172int omap_hwmod_init_reg_offs(struct device *dev,
3173 const struct ti_sysc_module_data *data,
3174 u32 *rev_offs, u32 *sysc_offs, u32 *syss_offs)
3175{
3176 *rev_offs = 0;
3177 *sysc_offs = 0;
3178 *syss_offs = 0;
3179
3180 if (data->offsets[SYSC_REVISION] > 0)
3181 *rev_offs = data->offsets[SYSC_REVISION];
3182
3183 if (data->offsets[SYSC_SYSCONFIG] > 0)
3184 *sysc_offs = data->offsets[SYSC_SYSCONFIG];
3185
3186 if (data->offsets[SYSC_SYSSTATUS] > 0)
3187 *syss_offs = data->offsets[SYSC_SYSSTATUS];
3188
3189 return 0;
3190}
3191
3192/**
3193 * omap_hwmod_init_sysc_flags - initialize sysconfig features
3194 * @dev: struct device
3195 * @data: module data
3196 * @sysc_flags: module configuration
3197 */
3198int omap_hwmod_init_sysc_flags(struct device *dev,
3199 const struct ti_sysc_module_data *data,
3200 u32 *sysc_flags)
3201{
3202 *sysc_flags = 0;
3203
3204 switch (data->cap->type) {
3205 case TI_SYSC_OMAP2:
3206 case TI_SYSC_OMAP2_TIMER:
3207 /* See SYSC_OMAP2_* in include/dt-bindings/bus/ti-sysc.h */
3208 if (data->cfg->sysc_val & SYSC_OMAP2_CLOCKACTIVITY)
3209 *sysc_flags |= SYSC_HAS_CLOCKACTIVITY;
3210 if (data->cfg->sysc_val & SYSC_OMAP2_EMUFREE)
3211 *sysc_flags |= SYSC_HAS_EMUFREE;
3212 if (data->cfg->sysc_val & SYSC_OMAP2_ENAWAKEUP)
3213 *sysc_flags |= SYSC_HAS_ENAWAKEUP;
3214 if (data->cfg->sysc_val & SYSC_OMAP2_SOFTRESET)
3215 *sysc_flags |= SYSC_HAS_SOFTRESET;
3216 if (data->cfg->sysc_val & SYSC_OMAP2_AUTOIDLE)
3217 *sysc_flags |= SYSC_HAS_AUTOIDLE;
3218 break;
3219 case TI_SYSC_OMAP4:
3220 case TI_SYSC_OMAP4_TIMER:
3221 /* See SYSC_OMAP4_* in include/dt-bindings/bus/ti-sysc.h */
3222 if (data->cfg->sysc_val & SYSC_OMAP4_DMADISABLE)
3223 *sysc_flags |= SYSC_HAS_DMADISABLE;
3224 if (data->cfg->sysc_val & SYSC_OMAP4_FREEEMU)
3225 *sysc_flags |= SYSC_HAS_EMUFREE;
3226 if (data->cfg->sysc_val & SYSC_OMAP4_SOFTRESET)
3227 *sysc_flags |= SYSC_HAS_SOFTRESET;
3228 break;
3229 case TI_SYSC_OMAP34XX_SR:
3230 case TI_SYSC_OMAP36XX_SR:
3231 /* See SYSC_OMAP3_SR_* in include/dt-bindings/bus/ti-sysc.h */
3232 if (data->cfg->sysc_val & SYSC_OMAP3_SR_ENAWAKEUP)
3233 *sysc_flags |= SYSC_HAS_ENAWAKEUP;
3234 break;
3235 default:
3236 if (data->cap->regbits->emufree_shift >= 0)
3237 *sysc_flags |= SYSC_HAS_EMUFREE;
3238 if (data->cap->regbits->enwkup_shift >= 0)
3239 *sysc_flags |= SYSC_HAS_ENAWAKEUP;
3240 if (data->cap->regbits->srst_shift >= 0)
3241 *sysc_flags |= SYSC_HAS_SOFTRESET;
3242 if (data->cap->regbits->autoidle_shift >= 0)
3243 *sysc_flags |= SYSC_HAS_AUTOIDLE;
3244 break;
3245 }
3246
3247 if (data->cap->regbits->midle_shift >= 0 &&
3248 data->cfg->midlemodes)
3249 *sysc_flags |= SYSC_HAS_MIDLEMODE;
3250
3251 if (data->cap->regbits->sidle_shift >= 0 &&
3252 data->cfg->sidlemodes)
3253 *sysc_flags |= SYSC_HAS_SIDLEMODE;
3254
3255 if (data->cfg->quirks & SYSC_QUIRK_UNCACHED)
3256 *sysc_flags |= SYSC_NO_CACHE;
3257 if (data->cfg->quirks & SYSC_QUIRK_RESET_STATUS)
3258 *sysc_flags |= SYSC_HAS_RESET_STATUS;
3259
3260 if (data->cfg->syss_mask & 1)
3261 *sysc_flags |= SYSS_HAS_RESET_STATUS;
3262
3263 return 0;
3264}
3265
3266/**
3267 * omap_hwmod_init_idlemodes - initialize module idle modes
3268 * @dev: struct device
3269 * @data: module data
3270 * @idlemodes: module supported idle modes
3271 */
3272int omap_hwmod_init_idlemodes(struct device *dev,
3273 const struct ti_sysc_module_data *data,
3274 u32 *idlemodes)
3275{
3276 *idlemodes = 0;
3277
3278 if (data->cfg->midlemodes & BIT(SYSC_IDLE_FORCE))
3279 *idlemodes |= MSTANDBY_FORCE;
3280 if (data->cfg->midlemodes & BIT(SYSC_IDLE_NO))
3281 *idlemodes |= MSTANDBY_NO;
3282 if (data->cfg->midlemodes & BIT(SYSC_IDLE_SMART))
3283 *idlemodes |= MSTANDBY_SMART;
3284 if (data->cfg->midlemodes & BIT(SYSC_IDLE_SMART_WKUP))
3285 *idlemodes |= MSTANDBY_SMART_WKUP;
3286
3287 if (data->cfg->sidlemodes & BIT(SYSC_IDLE_FORCE))
3288 *idlemodes |= SIDLE_FORCE;
3289 if (data->cfg->sidlemodes & BIT(SYSC_IDLE_NO))
3290 *idlemodes |= SIDLE_NO;
3291 if (data->cfg->sidlemodes & BIT(SYSC_IDLE_SMART))
3292 *idlemodes |= SIDLE_SMART;
3293 if (data->cfg->sidlemodes & BIT(SYSC_IDLE_SMART_WKUP))
3294 *idlemodes |= SIDLE_SMART_WKUP;
3295
3296 return 0;
3297}
3298
3299/**
3300 * omap_hwmod_check_module - check new module against platform data
3301 * @dev: struct device
3302 * @oh: module
3303 * @data: new module data
3304 * @sysc_fields: sysc register bits
3305 * @rev_offs: revision register offset
3306 * @sysc_offs: sysconfig register offset
3307 * @syss_offs: sysstatus register offset
3308 * @sysc_flags: sysc specific flags
3309 * @idlemodes: sysc supported idlemodes
3310 */
3311static int omap_hwmod_check_module(struct device *dev,
3312 struct omap_hwmod *oh,
3313 const struct ti_sysc_module_data *data,
3314 struct sysc_regbits *sysc_fields,
3315 u32 rev_offs, u32 sysc_offs,
3316 u32 syss_offs, u32 sysc_flags,
3317 u32 idlemodes)
3318{
3319 if (!oh->class->sysc)
3320 return -ENODEV;
3321
3322 if (sysc_fields != oh->class->sysc->sysc_fields)
3323 dev_warn(dev, "sysc_fields %p != %p\n", sysc_fields,
3324 oh->class->sysc->sysc_fields);
3325
3326 if (rev_offs != oh->class->sysc->rev_offs)
3327 dev_warn(dev, "rev_offs %08x != %08x\n", rev_offs,
3328 oh->class->sysc->rev_offs);
3329 if (sysc_offs != oh->class->sysc->sysc_offs)
3330 dev_warn(dev, "sysc_offs %08x != %08x\n", sysc_offs,
3331 oh->class->sysc->sysc_offs);
3332 if (syss_offs != oh->class->sysc->syss_offs)
3333 dev_warn(dev, "syss_offs %08x != %08x\n", syss_offs,
3334 oh->class->sysc->syss_offs);
3335
3336 if (sysc_flags != oh->class->sysc->sysc_flags)
3337 dev_warn(dev, "sysc_flags %08x != %08x\n", sysc_flags,
3338 oh->class->sysc->sysc_flags);
3339
3340 if (idlemodes != oh->class->sysc->idlemodes)
3341 dev_warn(dev, "idlemodes %08x != %08x\n", idlemodes,
3342 oh->class->sysc->idlemodes);
3343
3344 if (data->cfg->srst_udelay != oh->class->sysc->srst_udelay)
3345 dev_warn(dev, "srst_udelay %i != %i\n",
3346 data->cfg->srst_udelay,
3347 oh->class->sysc->srst_udelay);
3348
3349 return 0;
3350}
3351
3352/**
3353 * omap_hwmod_allocate_module - allocate new module
3354 * @dev: struct device
3355 * @oh: module
3356 * @sysc_fields: sysc register bits
3357 * @rev_offs: revision register offset
3358 * @sysc_offs: sysconfig register offset
3359 * @syss_offs: sysstatus register offset
3360 * @sysc_flags: sysc specific flags
3361 * @idlemodes: sysc supported idlemodes
3362 *
3363 * Note that the allocations here cannot use devm as ti-sysc can rebind.
3364 */
3365int omap_hwmod_allocate_module(struct device *dev, struct omap_hwmod *oh,
3366 const struct ti_sysc_module_data *data,
3367 struct sysc_regbits *sysc_fields,
3368 u32 rev_offs, u32 sysc_offs, u32 syss_offs,
3369 u32 sysc_flags, u32 idlemodes)
3370{
3371 struct omap_hwmod_class_sysconfig *sysc;
3372 struct omap_hwmod_class *class;
3373 void __iomem *regs = NULL;
3374 unsigned long flags;
3375
3376 sysc = kzalloc(sizeof(*sysc), GFP_KERNEL);
3377 if (!sysc)
3378 return -ENOMEM;
3379
3380 sysc->sysc_fields = sysc_fields;
3381 sysc->rev_offs = rev_offs;
3382 sysc->sysc_offs = sysc_offs;
3383 sysc->syss_offs = syss_offs;
3384 sysc->sysc_flags = sysc_flags;
3385 sysc->idlemodes = idlemodes;
3386 sysc->srst_udelay = data->cfg->srst_udelay;
3387
3388 if (!oh->_mpu_rt_va) {
3389 regs = ioremap(data->module_pa,
3390 data->module_size);
3391 if (!regs)
3392 return -ENOMEM;
3393 }
3394
3395 /*
3396 * We need new oh->class as the other devices in the same class
3397 * may not yet have ioremapped their registers.
3398 */
3399 class = kmemdup(oh->class, sizeof(*oh->class), GFP_KERNEL);
3400 if (!class)
3401 return -ENOMEM;
3402
3403 class->sysc = sysc;
3404
3405 spin_lock_irqsave(&oh->_lock, flags);
3406 if (regs)
3407 oh->_mpu_rt_va = regs;
3408 oh->class = class;
3409 oh->_state = _HWMOD_STATE_INITIALIZED;
3410 _setup(oh, NULL);
3411 spin_unlock_irqrestore(&oh->_lock, flags);
3412
3413 return 0;
3414}
3415
3416/**
3417 * omap_hwmod_init_module - initialize new module
3418 * @dev: struct device
3419 * @data: module data
3420 * @cookie: cookie for the caller to use for later calls
3421 */
3422int omap_hwmod_init_module(struct device *dev,
3423 const struct ti_sysc_module_data *data,
3424 struct ti_sysc_cookie *cookie)
3425{
3426 struct omap_hwmod *oh;
3427 struct sysc_regbits *sysc_fields;
3428 u32 rev_offs, sysc_offs, syss_offs, sysc_flags, idlemodes;
3429 int error;
3430
3431 if (!dev || !data)
3432 return -EINVAL;
3433
3434 oh = _lookup(data->name);
3435 if (!oh)
3436 return -ENODEV;
3437
3438 cookie->data = oh;
3439
3440 error = omap_hwmod_init_regbits(dev, data, &sysc_fields);
3441 if (error)
3442 return error;
3443
3444 error = omap_hwmod_init_reg_offs(dev, data, &rev_offs,
3445 &sysc_offs, &syss_offs);
3446 if (error)
3447 return error;
3448
3449 error = omap_hwmod_init_sysc_flags(dev, data, &sysc_flags);
3450 if (error)
3451 return error;
3452
3453 error = omap_hwmod_init_idlemodes(dev, data, &idlemodes);
3454 if (error)
3455 return error;
3456
3457 if (data->cfg->quirks & SYSC_QUIRK_NO_IDLE_ON_INIT)
3458 oh->flags |= HWMOD_INIT_NO_IDLE;
3459 if (data->cfg->quirks & SYSC_QUIRK_NO_RESET_ON_INIT)
3460 oh->flags |= HWMOD_INIT_NO_RESET;
3461
3462 error = omap_hwmod_check_module(dev, oh, data, sysc_fields,
3463 rev_offs, sysc_offs, syss_offs,
3464 sysc_flags, idlemodes);
3465 if (!error)
3466 return error;
3467
3468 return omap_hwmod_allocate_module(dev, oh, data, sysc_fields,
3469 rev_offs, sysc_offs, syss_offs,
3470 sysc_flags, idlemodes);
3471}
3472
3473/**
3474 * omap_hwmod_setup_earlycon_flags - set up flags for early console
3475 *
3476 * Enable DEBUG_OMAPUART_FLAGS for uart hwmod that is being used as
3477 * early concole so that hwmod core doesn't reset and keep it in idle
3478 * that specific uart.
3479 */
3480#ifdef CONFIG_SERIAL_EARLYCON
3481static void __init omap_hwmod_setup_earlycon_flags(void)
3482{
3483 struct device_node *np;
3484 struct omap_hwmod *oh;
3485 const char *uart;
3486
3487 np = of_find_node_by_path("/chosen");
3488 if (np) {
3489 uart = of_get_property(np, "stdout-path", NULL);
3490 if (uart) {
3491 np = of_find_node_by_path(uart);
3492 if (np) {
3493 uart = of_get_property(np, "ti,hwmods", NULL);
3494 oh = omap_hwmod_lookup(uart);
3495 if (!oh) {
3496 uart = of_get_property(np->parent,
3497 "ti,hwmods",
3498 NULL);
3499 oh = omap_hwmod_lookup(uart);
3500 }
3501 if (oh)
3502 oh->flags |= DEBUG_OMAPUART_FLAGS;
3503 }
3504 }
3505 }
3506}
3507#endif
3508
3509/**
3510 * omap_hwmod_setup_all - set up all registered IP blocks
3511 *
3512 * Initialize and set up all IP blocks registered with the hwmod code.
3513 * Must be called after omap2_clk_init(). Resolves the struct clk
3514 * names to struct clk pointers for each registered omap_hwmod. Also
3515 * calls _setup() on each hwmod. Returns 0 upon success.
3516 */
3517static int __init omap_hwmod_setup_all(void)
3518{
3519 _ensure_mpu_hwmod_is_setup(NULL);
3520
3521 omap_hwmod_for_each(_init, NULL);
3522#ifdef CONFIG_SERIAL_EARLYCON
3523 omap_hwmod_setup_earlycon_flags();
3524#endif
3525 omap_hwmod_for_each(_setup, NULL);
3526
3527 return 0;
3528}
3529omap_postcore_initcall(omap_hwmod_setup_all);
3530
3531/**
3532 * omap_hwmod_enable - enable an omap_hwmod
3533 * @oh: struct omap_hwmod *
3534 *
3535 * Enable an omap_hwmod @oh. Intended to be called by omap_device_enable().
3536 * Returns -EINVAL on error or passes along the return value from _enable().
3537 */
3538int omap_hwmod_enable(struct omap_hwmod *oh)
3539{
3540 int r;
3541 unsigned long flags;
3542
3543 if (!oh)
3544 return -EINVAL;
3545
3546 spin_lock_irqsave(&oh->_lock, flags);
3547 r = _enable(oh);
3548 spin_unlock_irqrestore(&oh->_lock, flags);
3549
3550 return r;
3551}
3552
3553/**
3554 * omap_hwmod_idle - idle an omap_hwmod
3555 * @oh: struct omap_hwmod *
3556 *
3557 * Idle an omap_hwmod @oh. Intended to be called by omap_device_idle().
3558 * Returns -EINVAL on error or passes along the return value from _idle().
3559 */
3560int omap_hwmod_idle(struct omap_hwmod *oh)
3561{
3562 int r;
3563 unsigned long flags;
3564
3565 if (!oh)
3566 return -EINVAL;
3567
3568 spin_lock_irqsave(&oh->_lock, flags);
3569 r = _idle(oh);
3570 spin_unlock_irqrestore(&oh->_lock, flags);
3571
3572 return r;
3573}
3574
3575/**
3576 * omap_hwmod_shutdown - shutdown an omap_hwmod
3577 * @oh: struct omap_hwmod *
3578 *
3579 * Shutdown an omap_hwmod @oh. Intended to be called by
3580 * omap_device_shutdown(). Returns -EINVAL on error or passes along
3581 * the return value from _shutdown().
3582 */
3583int omap_hwmod_shutdown(struct omap_hwmod *oh)
3584{
3585 int r;
3586 unsigned long flags;
3587
3588 if (!oh)
3589 return -EINVAL;
3590
3591 spin_lock_irqsave(&oh->_lock, flags);
3592 r = _shutdown(oh);
3593 spin_unlock_irqrestore(&oh->_lock, flags);
3594
3595 return r;
3596}
3597
3598/*
3599 * IP block data retrieval functions
3600 */
3601
3602/**
3603 * omap_hwmod_get_pwrdm - return pointer to this module's main powerdomain
3604 * @oh: struct omap_hwmod *
3605 *
3606 * Return the powerdomain pointer associated with the OMAP module
3607 * @oh's main clock. If @oh does not have a main clk, return the
3608 * powerdomain associated with the interface clock associated with the
3609 * module's MPU port. (XXX Perhaps this should use the SDMA port
3610 * instead?) Returns NULL on error, or a struct powerdomain * on
3611 * success.
3612 */
3613struct powerdomain *omap_hwmod_get_pwrdm(struct omap_hwmod *oh)
3614{
3615 struct clk *c;
3616 struct omap_hwmod_ocp_if *oi;
3617 struct clockdomain *clkdm;
3618 struct clk_hw_omap *clk;
3619
3620 if (!oh)
3621 return NULL;
3622
3623 if (oh->clkdm)
3624 return oh->clkdm->pwrdm.ptr;
3625
3626 if (oh->_clk) {
3627 c = oh->_clk;
3628 } else {
3629 oi = _find_mpu_rt_port(oh);
3630 if (!oi)
3631 return NULL;
3632 c = oi->_clk;
3633 }
3634
3635 clk = to_clk_hw_omap(__clk_get_hw(c));
3636 clkdm = clk->clkdm;
3637 if (!clkdm)
3638 return NULL;
3639
3640 return clkdm->pwrdm.ptr;
3641}
3642
3643/**
3644 * omap_hwmod_get_mpu_rt_va - return the module's base address (for the MPU)
3645 * @oh: struct omap_hwmod *
3646 *
3647 * Returns the virtual address corresponding to the beginning of the
3648 * module's register target, in the address range that is intended to
3649 * be used by the MPU. Returns the virtual address upon success or NULL
3650 * upon error.
3651 */
3652void __iomem *omap_hwmod_get_mpu_rt_va(struct omap_hwmod *oh)
3653{
3654 if (!oh)
3655 return NULL;
3656
3657 if (oh->_int_flags & _HWMOD_NO_MPU_PORT)
3658 return NULL;
3659
3660 if (oh->_state == _HWMOD_STATE_UNKNOWN)
3661 return NULL;
3662
3663 return oh->_mpu_rt_va;
3664}
3665
3666/*
3667 * XXX what about functions for drivers to save/restore ocp_sysconfig
3668 * for context save/restore operations?
3669 */
3670
3671/**
3672 * omap_hwmod_enable_wakeup - allow device to wake up the system
3673 * @oh: struct omap_hwmod *
3674 *
3675 * Sets the module OCP socket ENAWAKEUP bit to allow the module to
3676 * send wakeups to the PRCM, and enable I/O ring wakeup events for
3677 * this IP block if it has dynamic mux entries. Eventually this
3678 * should set PRCM wakeup registers to cause the PRCM to receive
3679 * wakeup events from the module. Does not set any wakeup routing
3680 * registers beyond this point - if the module is to wake up any other
3681 * module or subsystem, that must be set separately. Called by
3682 * omap_device code. Returns -EINVAL on error or 0 upon success.
3683 */
3684int omap_hwmod_enable_wakeup(struct omap_hwmod *oh)
3685{
3686 unsigned long flags;
3687 u32 v;
3688
3689 spin_lock_irqsave(&oh->_lock, flags);
3690
3691 if (oh->class->sysc &&
3692 (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)) {
3693 v = oh->_sysc_cache;
3694 _enable_wakeup(oh, &v);
3695 _write_sysconfig(v, oh);
3696 }
3697
3698 spin_unlock_irqrestore(&oh->_lock, flags);
3699
3700 return 0;
3701}
3702
3703/**
3704 * omap_hwmod_disable_wakeup - prevent device from waking the system
3705 * @oh: struct omap_hwmod *
3706 *
3707 * Clears the module OCP socket ENAWAKEUP bit to prevent the module
3708 * from sending wakeups to the PRCM, and disable I/O ring wakeup
3709 * events for this IP block if it has dynamic mux entries. Eventually
3710 * this should clear PRCM wakeup registers to cause the PRCM to ignore
3711 * wakeup events from the module. Does not set any wakeup routing
3712 * registers beyond this point - if the module is to wake up any other
3713 * module or subsystem, that must be set separately. Called by
3714 * omap_device code. Returns -EINVAL on error or 0 upon success.
3715 */
3716int omap_hwmod_disable_wakeup(struct omap_hwmod *oh)
3717{
3718 unsigned long flags;
3719 u32 v;
3720
3721 spin_lock_irqsave(&oh->_lock, flags);
3722
3723 if (oh->class->sysc &&
3724 (oh->class->sysc->sysc_flags & SYSC_HAS_ENAWAKEUP)) {
3725 v = oh->_sysc_cache;
3726 _disable_wakeup(oh, &v);
3727 _write_sysconfig(v, oh);
3728 }
3729
3730 spin_unlock_irqrestore(&oh->_lock, flags);
3731
3732 return 0;
3733}
3734
3735/**
3736 * omap_hwmod_assert_hardreset - assert the HW reset line of submodules
3737 * contained in the hwmod module.
3738 * @oh: struct omap_hwmod *
3739 * @name: name of the reset line to lookup and assert
3740 *
3741 * Some IP like dsp, ipu or iva contain processor that require
3742 * an HW reset line to be assert / deassert in order to enable fully
3743 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3744 * yet supported on this OMAP; otherwise, passes along the return value
3745 * from _assert_hardreset().
3746 */
3747int omap_hwmod_assert_hardreset(struct omap_hwmod *oh, const char *name)
3748{
3749 int ret;
3750 unsigned long flags;
3751
3752 if (!oh)
3753 return -EINVAL;
3754
3755 spin_lock_irqsave(&oh->_lock, flags);
3756 ret = _assert_hardreset(oh, name);
3757 spin_unlock_irqrestore(&oh->_lock, flags);
3758
3759 return ret;
3760}
3761
3762/**
3763 * omap_hwmod_deassert_hardreset - deassert the HW reset line of submodules
3764 * contained in the hwmod module.
3765 * @oh: struct omap_hwmod *
3766 * @name: name of the reset line to look up and deassert
3767 *
3768 * Some IP like dsp, ipu or iva contain processor that require
3769 * an HW reset line to be assert / deassert in order to enable fully
3770 * the IP. Returns -EINVAL if @oh is null or if the operation is not
3771 * yet supported on this OMAP; otherwise, passes along the return value
3772 * from _deassert_hardreset().
3773 */
3774int omap_hwmod_deassert_hardreset(struct omap_hwmod *oh, const char *name)
3775{
3776 int ret;
3777 unsigned long flags;
3778
3779 if (!oh)
3780 return -EINVAL;
3781
3782 spin_lock_irqsave(&oh->_lock, flags);
3783 ret = _deassert_hardreset(oh, name);
3784 spin_unlock_irqrestore(&oh->_lock, flags);
3785
3786 return ret;
3787}
3788
3789/**
3790 * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
3791 * @classname: struct omap_hwmod_class name to search for
3792 * @fn: callback function pointer to call for each hwmod in class @classname
3793 * @user: arbitrary context data to pass to the callback function
3794 *
3795 * For each omap_hwmod of class @classname, call @fn.
3796 * If the callback function returns something other than
3797 * zero, the iterator is terminated, and the callback function's return
3798 * value is passed back to the caller. Returns 0 upon success, -EINVAL
3799 * if @classname or @fn are NULL, or passes back the error code from @fn.
3800 */
3801int omap_hwmod_for_each_by_class(const char *classname,
3802 int (*fn)(struct omap_hwmod *oh,
3803 void *user),
3804 void *user)
3805{
3806 struct omap_hwmod *temp_oh;
3807 int ret = 0;
3808
3809 if (!classname || !fn)
3810 return -EINVAL;
3811
3812 pr_debug("omap_hwmod: %s: looking for modules of class %s\n",
3813 __func__, classname);
3814
3815 list_for_each_entry(temp_oh, &omap_hwmod_list, node) {
3816 if (!strcmp(temp_oh->class->name, classname)) {
3817 pr_debug("omap_hwmod: %s: %s: calling callback fn\n",
3818 __func__, temp_oh->name);
3819 ret = (*fn)(temp_oh, user);
3820 if (ret)
3821 break;
3822 }
3823 }
3824
3825 if (ret)
3826 pr_debug("omap_hwmod: %s: iterator terminated early: %d\n",
3827 __func__, ret);
3828
3829 return ret;
3830}
3831
3832/**
3833 * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
3834 * @oh: struct omap_hwmod *
3835 * @state: state that _setup() should leave the hwmod in
3836 *
3837 * Sets the hwmod state that @oh will enter at the end of _setup()
3838 * (called by omap_hwmod_setup_*()). See also the documentation
3839 * for _setup_postsetup(), above. Returns 0 upon success or
3840 * -EINVAL if there is a problem with the arguments or if the hwmod is
3841 * in the wrong state.
3842 */
3843int omap_hwmod_set_postsetup_state(struct omap_hwmod *oh, u8 state)
3844{
3845 int ret;
3846 unsigned long flags;
3847
3848 if (!oh)
3849 return -EINVAL;
3850
3851 if (state != _HWMOD_STATE_DISABLED &&
3852 state != _HWMOD_STATE_ENABLED &&
3853 state != _HWMOD_STATE_IDLE)
3854 return -EINVAL;
3855
3856 spin_lock_irqsave(&oh->_lock, flags);
3857
3858 if (oh->_state != _HWMOD_STATE_REGISTERED) {
3859 ret = -EINVAL;
3860 goto ohsps_unlock;
3861 }
3862
3863 oh->_postsetup_state = state;
3864 ret = 0;
3865
3866ohsps_unlock:
3867 spin_unlock_irqrestore(&oh->_lock, flags);
3868
3869 return ret;
3870}
3871
3872/**
3873 * omap_hwmod_get_context_loss_count - get lost context count
3874 * @oh: struct omap_hwmod *
3875 *
3876 * Returns the context loss count of associated @oh
3877 * upon success, or zero if no context loss data is available.
3878 *
3879 * On OMAP4, this queries the per-hwmod context loss register,
3880 * assuming one exists. If not, or on OMAP2/3, this queries the
3881 * enclosing powerdomain context loss count.
3882 */
3883int omap_hwmod_get_context_loss_count(struct omap_hwmod *oh)
3884{
3885 struct powerdomain *pwrdm;
3886 int ret = 0;
3887
3888 if (soc_ops.get_context_lost)
3889 return soc_ops.get_context_lost(oh);
3890
3891 pwrdm = omap_hwmod_get_pwrdm(oh);
3892 if (pwrdm)
3893 ret = pwrdm_get_context_loss_count(pwrdm);
3894
3895 return ret;
3896}
3897
3898/**
3899 * omap_hwmod_init - initialize the hwmod code
3900 *
3901 * Sets up some function pointers needed by the hwmod code to operate on the
3902 * currently-booted SoC. Intended to be called once during kernel init
3903 * before any hwmods are registered. No return value.
3904 */
3905void __init omap_hwmod_init(void)
3906{
3907 if (cpu_is_omap24xx()) {
3908 soc_ops.wait_target_ready = _omap2xxx_3xxx_wait_target_ready;
3909 soc_ops.assert_hardreset = _omap2_assert_hardreset;
3910 soc_ops.deassert_hardreset = _omap2_deassert_hardreset;
3911 soc_ops.is_hardreset_asserted = _omap2_is_hardreset_asserted;
3912 } else if (cpu_is_omap34xx()) {
3913 soc_ops.wait_target_ready = _omap2xxx_3xxx_wait_target_ready;
3914 soc_ops.assert_hardreset = _omap2_assert_hardreset;
3915 soc_ops.deassert_hardreset = _omap2_deassert_hardreset;
3916 soc_ops.is_hardreset_asserted = _omap2_is_hardreset_asserted;
3917 soc_ops.init_clkdm = _init_clkdm;
3918 } else if (cpu_is_omap44xx() || soc_is_omap54xx() || soc_is_dra7xx()) {
3919 soc_ops.enable_module = _omap4_enable_module;
3920 soc_ops.disable_module = _omap4_disable_module;
3921 soc_ops.wait_target_ready = _omap4_wait_target_ready;
3922 soc_ops.assert_hardreset = _omap4_assert_hardreset;
3923 soc_ops.deassert_hardreset = _omap4_deassert_hardreset;
3924 soc_ops.is_hardreset_asserted = _omap4_is_hardreset_asserted;
3925 soc_ops.init_clkdm = _init_clkdm;
3926 soc_ops.update_context_lost = _omap4_update_context_lost;
3927 soc_ops.get_context_lost = _omap4_get_context_lost;
3928 soc_ops.disable_direct_prcm = _omap4_disable_direct_prcm;
3929 soc_ops.xlate_clkctrl = _omap4_xlate_clkctrl;
3930 } else if (cpu_is_ti814x() || cpu_is_ti816x() || soc_is_am33xx() ||
3931 soc_is_am43xx()) {
3932 soc_ops.enable_module = _omap4_enable_module;
3933 soc_ops.disable_module = _omap4_disable_module;
3934 soc_ops.wait_target_ready = _omap4_wait_target_ready;
3935 soc_ops.assert_hardreset = _omap4_assert_hardreset;
3936 soc_ops.deassert_hardreset = _am33xx_deassert_hardreset;
3937 soc_ops.is_hardreset_asserted = _omap4_is_hardreset_asserted;
3938 soc_ops.init_clkdm = _init_clkdm;
3939 soc_ops.disable_direct_prcm = _omap4_disable_direct_prcm;
3940 soc_ops.xlate_clkctrl = _omap4_xlate_clkctrl;
3941 } else {
3942 WARN(1, "omap_hwmod: unknown SoC type\n");
3943 }
3944
3945 _init_clkctrl_providers();
3946
3947 inited = true;
3948}
3949
3950/**
3951 * omap_hwmod_get_main_clk - get pointer to main clock name
3952 * @oh: struct omap_hwmod *
3953 *
3954 * Returns the main clock name assocated with @oh upon success,
3955 * or NULL if @oh is NULL.
3956 */
3957const char *omap_hwmod_get_main_clk(struct omap_hwmod *oh)
3958{
3959 if (!oh)
3960 return NULL;
3961
3962 return oh->main_clk;
3963}