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