Collaboration diagram for Lrfd_api:

Macros
#define	LRFD_NUM_CLK_DEP 2

#define	LRFD_CLK_DEP_POWER 0
	LRFD Clock dependency set to be used by the Power driver. More...

#define	LRFD_CLK_DEP_RCL 1
	LRFD Clock dependency set to be used by the RCL. More...

Functions
void	LRFDSetClockDependency (uint16_t mask, uint8_t dependencySetId)
	Set clock dependency on a set of modules in LRFD. More...

void	LRFDReleaseClockDependency (uint16_t mask, uint8_t dependencySetId)
	Release clock dependency on a set of modules in LRFD. More...

void	LRFDApplyClockDependencies (void)
	Apply the currently set clock dependencies. More...

Detailed Description

Macro Definition Documentation

§ LRFD_NUM_CLK_DEP

#define LRFD_NUM_CLK_DEP 2

Referenced by LRFDApplyClockDependencies(), LRFDReleaseClockDependency(), and LRFDSetClockDependency().

§ LRFD_CLK_DEP_POWER

#define LRFD_CLK_DEP_POWER 0

LRFD Clock dependency set to be used by the Power driver.

§ LRFD_CLK_DEP_RCL

#define LRFD_CLK_DEP_RCL 1

LRFD Clock dependency set to be used by the RCL.

Function Documentation

§ LRFDSetClockDependency()

void LRFDSetClockDependency	(	uint16_t	mask,
		uint8_t	dependencySetId
	)

Set clock dependency on a set of modules in LRFD.

Warning: This API uses internal state, and is not thread safe.

This API supports multiple clock dependency sets. For any given LRFD module, it will be clocked if any of the dependency sets has a dependency for that LRFD module. If any dependency set has a dependency on at least one LRFD module, the LRFD module itself will be clocked, otherwise it will not be clocked.

Parameters

mask	bitmask defining the set of LRFD modules to set clock dependency on. LRFDDBELL_O_CLKCTL
dependencySetId	ID for the clock dependency set to use. LRFD_CLK_DEP_POWER LRFD_CLK_DEP_RCL

See also: LRFDReleaseClockDependency()

Returns: None

References LRFD_NUM_CLK_DEP, LRFDApplyClockDependencies(), and lrfdClockDependencySets.

§ LRFDReleaseClockDependency()

void LRFDReleaseClockDependency	(	uint16_t	mask,
		uint8_t	dependencySetId
	)

Release clock dependency on a set of modules in LRFD.

Warning: This API uses internal state, and is not thread safe.

This API supports multiple clock dependency sets. See description of LRFDSetClockDependency()

Parameters

mask	bitmask defining the set of LRFD modules to release clock dependency from. LRFDDBELL_O_CLKCTL
dependencySetId	ID for the clock dependency set to use. LRFD_CLK_DEP_POWER LRFD_CLK_DEP_RCL

See also: LRFDSetClockDependency()

Returns: None

References LRFD_NUM_CLK_DEP, LRFDApplyClockDependencies(), and lrfdClockDependencySets.

§ LRFDApplyClockDependencies()

void LRFDApplyClockDependencies ( void )

Apply the currently set clock dependencies.

Warning: This API uses internal state, and is not thread safe.

Note: The dependencies automatically being applied when setting and releasing dependencies using LRFDSetClockDependency() and LRFDReleaseClockDependency(). This API is mainly intended for when the enabled clocks gets out of sync with the current dependencies. For example, after the device wakes up from standby.

This will update the LRFD clock control based on the currently set clock dependencies. If there is a clock dependency on any module in LRFD, the LRFD module itself will be clocked, otherwise it will not be clocked.

Returns: None

References CLKCTL_BASE, CLKCTL_CLKENCLR0_LRFD, CLKCTL_CLKENSET0_LRFD, CLKCTL_O_CLKENCLR0, CLKCTL_O_CLKENSET0, HWREG, LRFD_NUM_CLK_DEP, lrfdClockDependencySets, lrfdClocked, LRFDDBELL_BASE, LRFDDBELL_CLKCTL_BRIDGE_M, and LRFDDBELL_O_CLKCTL.

Referenced by LRFDReleaseClockDependency(), and LRFDSetClockDependency().

Macros

Functions