arm/mach-omap2/omap_hwmod.c

32  * OMAP hwmod provides a consistent way to describe the on-chip
35  * hardware database.  OMAP hwmod provides a standard, consistent API
37  * hwmod provides a way for other core code, such as the Linux device
41  * Using hwmod
43  * Drivers won't call hwmod functions directly.  That is done by the
47  * currently how hwmod data is communicated to drivers and to the
51  * From a layering perspective, here is where the OMAP hwmod code
82  * The OMAP hwmod code also will attempt to reset and idle all on-chip
91  * The hwmod code considers modules to be in one of several activity
93  * are registered via the hwmod code, proceed to the REGISTERED state.
97  * is entered.  The hwmod code will then place the module into either
120  * XXX add tests at the beginning of each function to ensure the hwmod is
169 /* Name of the OMAP hwmod for the MPU */
257 /* inited: set to true once the hwmod code is initialized */
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
273 		WARN(1, "omap_hwmod: %s: cannot read OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);  in _update_sysc_cache()
298 		WARN(1, "omap_hwmod: %s: cannot write OCP_SYSCONFIG: not defined on hwmod's class\n", oh->name);  in _write_sysconfig()
329  * the @oh hwmod.  Does not write to the hardware.  Returns -EINVAL
363  * hwmod.  Does not write to the hardware.  Returns -EINVAL upon error
396  * @oh hwmod.  Used for additional powersaving on some modules.  Does
428  * Set the SOFTRESET bit in @v for hwmod @oh.  Returns -EINVAL upon
456  * Clear the SOFTRESET bit in @v for hwmod @oh.  Returns -EINVAL upon
522  * Set the DMADISABLE bit in @v for hwmod @oh.  Returns -EINVAL upon
563  * hwmod.  The autoidle bit controls whether the module can gate
621 	/* XXX test pwrdm_get_wken for this hwmod's subsystem */  in _enable_wakeup()
814  * _init_main_clk - get a struct clk * for the hwmod's main functional clk
818  * functional clock pointer) if a clock matching the hwmod name is found,
864  * _init_interface_clks - get a struct clk * for the hwmod's interface clks
903  * _init_opt_clks - get a struct clk * for the hwmod's optional clocks
970  * _enable_clocks - enable hwmod main clock and interface clocks
974  * on the hwmod @oh.  Returns 0.
1029  * _disable_clocks - disable hwmod main clock and interface clocks
1032  * Disables the hwmod @oh main functional and interface clocks.  Returns 0.
1062  * Enables the PRCM module mode related to the hwmod @oh.
1116  * Intended to be called during hwmod registration only. No return
1396  * _init_clocks - clk_get() all clocks associated with this hwmod. Retrieve as
1399  * @np: device_node mapped to this hwmod
1402  * Resolves all clock names embedded in the hwmod.  Returns 0 on
1430  * _lookup_hardreset - fill register bit info for this hwmod/reset line
1432  * @name: name of the reset line in the context of this hwmod
1461  * contained in the hwmod module.
1494  * in the hwmod module.
1563  * contained in the hwmod module
1645  * Disable the PRCM module mode related to the hwmod @oh.
1680  * Resets an omap_hwmod @oh via the OCP_SYSCONFIG bit.  hwmod must be
1681  * enabled for this to work.  Returns -ENOENT if the hwmod cannot be
1682  * reset this way, -EINVAL if the hwmod is in the wrong state,
1782  * custom reset function - these must return -EINVAL if the hwmod
1783  * cannot be reset this way or if the hwmod is in the wrong state,
1822  * _omap4_update_context_lost - increment hwmod context loss counter if
1823  * hwmod context was lost, and clear hardware context loss reg
1824  * @oh: hwmod to check for context loss
1826  * If the PRCM indicates that the hwmod @oh lost context, increment
1847  * _omap4_get_context_lost - get context loss counter for a hwmod
1848  * @oh: hwmod to get context loss counter for
1850  * Returns the in-memory context loss counter for a hwmod.
1861  * Enables an omap_hwmod @oh such that the MPU can access the hwmod's
1862  * register target.  Returns -EINVAL if the hwmod is in the wrong
1958  * Idles an omap_hwmod @oh.  This should be called once the hwmod has
1959  * no further work.  Returns -EINVAL if the hwmod is in the wrong
2019  * used for the hwmod is removed or unloaded or if the driver is not
2020  * used by the system.  Returns -EINVAL if the hwmod is in the wrong
2096 			pr_debug("omap_hwmod: dt %pOFn[%i] uses hwmod %s\n",  in of_dev_find_hwmod()
2106  * of_dev_hwmod_lookup - look up needed hwmod from dt blob
2112  * Parse the dt blob and find out needed hwmod. Recursive function is
2158  * in device tree while still using legacy hwmod platform data
2161  * Can be removed when all cpsw hwmod platform data has been
2224  * _init_mpu_rt_base - populate the virtual address for a hwmod
2237  * Returns 0 on success, -EINVAL if an invalid hwmod is passed, and
2298  * _init - initialize internal data for the hwmod @oh
2303  * registers belonging to the hwmod @oh.  @oh must already be
2305  * hwmod initialization.  Code called here does not touch any hardware
2307  * upon success or if the hwmod isn't registered or if the hwmod's
2395  * Reset the IP block corresponding to the hwmod @oh during the setup
2449  * block data and interconnect data is available to the hwmod code, it
2473 	 * XXX HWMOD_INIT_NO_IDLE does not belong in hwmod data -  in _setup_postsetup()
2487 		WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",  in _setup_postsetup()
2505  * two phases for hwmod initialization.  Code called here generally
2518 		WARN(r, "hwmod: %s: setup: failed to enable parent hwmod %s\n",  in _setup()
2537 			WARN(1, "hwmod: %s: unknown postsetup state %d! defaulting to enabled\n",  in _setup()
2582 	 * set in the hwmod data, inserted by the autogenerator code.  in _register()
2715  * _omap2_assert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2720  * the hwmod @oh and the hardreset line data @ohri.  Only intended for
2733  * _omap2_deassert_hardreset - call OMAP2 PRM hardreset fn with hwmod args
2738  * the hwmod @oh and the hardreset line data @ohri.  Only intended for
2751  * _omap2_is_hardreset_asserted - call OMAP2 PRM hardreset fn with hwmod args
2756  * from the hwmod @oh and the hardreset line data @ohri.  Only
2770  * _omap4_assert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
2775  * from the hwmod @oh and the hardreset line data @ohri.  Only
2794  * _omap4_deassert_hardreset - call OMAP4 PRM hardreset fn with hwmod args
2799  * from the hwmod @oh and the hardreset line data @ohri.  Only
2812 		pr_err("omap_hwmod: %s: %s: hwmod data error: OMAP4 does not support st_shift\n",  in _omap4_deassert_hardreset()
2823  * _omap4_is_hardreset_asserted - call OMAP4 PRM hardreset fn with hwmod args
2828  * extracted from the hwmod @oh and the hardreset line data @ohri.
2848  * _omap4_disable_direct_prcm - disable direct PRCM control for hwmod
2851  * Disables direct PRCM clkctrl done by hwmod core. Instead, the hwmod
2866  * _am33xx_deassert_hardreset - call AM33XX PRM hardreset fn with hwmod args
2871  * from the hwmod @oh and the hardreset line data @ohri.  Only
2987  * omap_hwmod_register_links - register an array of hwmod links
3024  * _ensure_mpu_hwmod_is_setup - ensure the MPU SS hwmod is init'ed and set up
3025  * @oh: pointer to the hwmod currently being set up (usually not the MPU)
3027  * If the hwmod data corresponding to the MPU subsystem IP block
3036 		pr_err("omap_hwmod: %s: MPU initiator hwmod %s not yet registered\n",  in _ensure_mpu_hwmod_is_setup()
3043  * omap_hwmod_setup_one - set up a single hwmod
3044  * @oh_name: const char * name of the already-registered hwmod to set up
3046  * Initialize and set up a single hwmod.  Intended to be used for a
3050  * registered omap_hwmod.  Also calls _setup() on each hwmod.  Returns
3061 		WARN(1, "omap_hwmod: %s: hwmod not yet registered\n", oh_name);  in omap_hwmod_setup_one()
3604  * Enable DEBUG_OMAPUART_FLAGS for uart hwmod that is being used as
3605  * early concole so that hwmod core doesn't reset and keep it in idle
3640  * Initialize and set up all IP blocks registered with the hwmod code.
3643  * calls _setup() on each hwmod.  Returns 0 upon success.
3763  * contained in the hwmod module.
3790  * contained in the hwmod module.
3816  * omap_hwmod_for_each_by_class - call @fn for each hwmod of class @classname
3818  * @fn: callback function pointer to call for each hwmod in class @classname
3859  * omap_hwmod_set_postsetup_state - set the post-_setup() state for this hwmod
3861  * @state: state that _setup() should leave the hwmod in
3863  * Sets the hwmod state that @oh will enter at the end of _setup()
3866  * -EINVAL if there is a problem with the arguments or if the hwmod is
3899  * omap_hwmod_init - initialize the hwmod code
3901  * Sets up some function pointers needed by the hwmod code to operate on the