arm/mach-omap2/omap_hwmod.h

1 /* SPDX-License-Identifier: GPL-2.0-only */
5  * Copyright (C) 2009-2011 Nokia Corporation
6  * Copyright (C) 2011-2012 Texas Instruments, Inc.
13  * These headers and macros are used to define OMAP on-chip module
16  * omap_hwmod code, in arch/arm/mach-omap2/omap_hwmod.c (as of this
20  * - add interconnect error log structures
21  * - init_conn_id_bit (CONNID_BIT_VECTOR)
22  * - implement default hwmod SMS/SDRC flags?
23  * - move Linux-specific data ("non-ROM data") out
29 #include <linux/init.h>
155  * struct omap_hwmod_rst_info - IPs reset lines use by hwmod
156  * @name: name of the reset line (module local name)
157  * @rst_shift: Offset of the reset bit
158  * @st_shift: Offset of the reset status bit (OMAP2/3 only)
170  * struct omap_hwmod_opt_clk - optional clocks used by this hwmod
171  * @role: "sys", "32k", "tv", etc -- for use in clk_get()
190  * struct omap_hwmod_omap2_firewall - OMAP2/3 device firewall data
222  * struct omap_hwmod_ocp_if - OCP interface data
223  * @master: struct omap_hwmod that initiates OCP transactions on this link
224  * @slave: struct omap_hwmod that responds to OCP transactions on this link
290  * struct omap_hwmod_class_sysconfig - hwmod class OCP_SYS* data
303  * idle request based on the internal module functionality that has
309  * omap_hwmod_sysc_type2 defined in omap_hwmod_common_data.c depending on
326  * struct omap_hwmod_omap2_prcm - OMAP2/3-specific PRCM data
332  * WKEN, GRPSEL registers.  In an ideal world, no extra information
347  *     module-level context loss register associated with them; this
351  *	distinguish from hwmods that have no clkctrl offset.
360  * struct omap_hwmod_omap4_prcm - OMAP4-specific PRCM data
393  *     of idle, rather than relying on module smart-idle
395  *     out of standby, rather than relying on module smart-standby
396  * HWMOD_INIT_NO_RESET: don't reset this module at boot - important for
399  * HWMOD_INIT_NO_IDLE: don't idle this module at boot - important for SDRAM
406  * HWMOD_NO_IDLEST: this module does not have idle status - this is the case
407  *     only for few initiator modules on OMAP2 & 3.
408  * HWMOD_CONTROL_OPT_CLKS_IN_RESET: Enable all optional clocks during reset.
410  *     in order to complete the reset. Optional clocks will be disabled
411  *     again after the reset.
414  *     this IP block comes from an off-chip source and is not always
416  *     enable and reset the IP block early.  XXX Eventually it should
420  *     peripherals are active.  This is apparently true for the I2C on
421  *     OMAP2420, and also the EMAC on AM3517/3505.  It's unlikely that
422  *     this is really true -- we're probably not configuring something
424  *     issues -- but we're currently suffering from a shortage of
427  *     is kept in force-standby mode. Failing to do so causes PM problems
428  *     with musb on OMAP3630 at least. Note that musb has a dedicated register
429  *     to control MSTANDBY signal when MIDLEMODE is set to force-standby.
431  *     out of idle, but rely on smart-idle to the put it back in idle,
433  * HWMOD_RECONFIG_IO_CHAIN: omap_hwmod code needs to reconfigure wake-up
439  *     IPs like CPSW on DRA7, where clocks to this module cannot be disabled.
443  *     DCAN on DRA7x SoC needs this to workaround errata i893.
467  * _HWMOD_NO_MPU_PORT: no path exists for the MPU to write to this module
469  * _HWMOD_SKIP_ENABLE: set if hwmod enabled during init (HWMOD_INIT_NO_IDLE) -
479  * INITIALIZED: reset (optionally), initialized, enabled, disabled
499  * struct omap_hwmod_class - the type of an IP block
503  * @reset: ptr to fn to be executed in place of the standard hwmod reset fn
518  * If @reset is defined, then the function it points to will be
520  * mach-omap2/omap_hwmod.c.  This is needed for IP blocks which have
521  * unusual reset sequences - usually processor IP blocks like the IVA.
527 	int					(*reset)(struct omap_hwmod *oh);  member
533  * struct omap_hwmod - integration data for OMAP hardware "modules" (IP blocks)
543  * @_sysc_cache: internal-use hwmod flags
551  * @_int_flags: internal-use hwmod flags
552  * @_state: internal-use hwmod state
553  * @_postsetup_state: internal-use state to leave the hwmod in after _setup()
555  * @_lock: spinlock serializing operations on this hwmod
569  * @parent_hwmod is temporary; there should be no need for it, as this
663  * Chip variant-specific hwmod init routines - XXX should be converted