Introduction

Functions
int32_t	SDL_armR5ReadCCMRegister (uintptr_t baseAddress, SDL_McuArmssCcmR5RegId regId, uint32_t pValToBeRead, int32_t pMetaInfo)
	Read CCM Regiser. More...

int32_t	SDL_armR5ConfigureCCMRegister (uintptr_t baseAddress, SDL_McuArmssCcmR5RegId regId, uint32_t valToBeWritten, int32_t *pMetaInfo)
	Configure CCM Regiser. More...

int32_t	SDL_armR5CCMSetOperationModeKey (uintptr_t baseAddress, SDL_McuArmssCcmR5ModuleId moduleId, SDL_McuArmssCcmR5OpModeKey opModeKey, int32_t *pMetaInfo)
	Configure Operating mode for CPU, VIM, CCM Inactivity monitor. More...

int32_t	SDL_armR5CCMGetCompareError (uintptr_t baseAddress, SDL_McuArmssCcmR5ModuleId moduleId, uint32_t pCmpError, int32_t pMetaInfo)
	Read Compare Error status for CPU, VIM, CCM Inactivity monitor. More...

int32_t	SDL_armR5CCMGetOperationModeKey (uintptr_t baseAddress, SDL_McuArmssCcmR5ModuleId moduleId, SDL_McuArmssCcmR5OpModeKey pOpModeKey, int32_t pMetaInfo)
	Get Operation mode key value for CPU, VIM, CCM Inactivity monitor. More...

int32_t	SDL_armR5CCMClearCompareError (uintptr_t baseAddress, SDL_McuArmssCcmR5ModuleId moduleId, int32_t *pMetaInfo)
	Clear Compare Error value for CPU, VIM, CCM Inactivity monitor. More...

Function Documentation

◆ SDL_armR5ReadCCMRegister()

int32_t SDL_armR5ReadCCMRegister	(	uintptr_t	baseAddress,
		SDL_McuArmssCcmR5RegId	regId,
		uint32_t *	pValToBeRead,
		int32_t *	pMetaInfo
	)

Read CCM Regiser.

This function reads the contents of a given CCM register and returns the status of the operation for API caller to indicate success or failure on the operation.

Consult the CCM module documentation for a description of the registers under MCU_ARMSS_CCMR5 registers section of the techinical reference manual https://www.ti.com/lit/pdf/spruid7

Parameters

baseAddress	[IN] Base address of MCU_ARMSS_CCMR5 registers
regId	[IN] CCMR5 register ID to be read
pValToBeRead	[OUT] pointer to address of Register value read
pMetaInfo	[OUT] pointer to meta info (Optional) for SDL_EFAIL: reason for API failure as defined under SDL_ErrType_t for SDL_PASS: Not applicable

Returns: The SDL error code for the API. Success: SDL_PASS Fail : SDL_EFAIL

◆ SDL_armR5ConfigureCCMRegister()

int32_t SDL_armR5ConfigureCCMRegister	(	uintptr_t	baseAddress,
		SDL_McuArmssCcmR5RegId	regId,
		uint32_t	valToBeWritten,
		int32_t *	pMetaInfo
	)

Configure CCM Regiser.

This function configures a given CCM register and returns the status of the operation for API caller to indicate success or failure on the operation.

Consult the CCM module documentation for a description of the registers under MCU_ARMSS_CCMR5 registers section of the techinical reference manual https://www.ti.com/lit/pdf/spruid7

Parameters

baseAddress	[IN] Base address of MCU_ARMSS_CCMR5 registers
regId	[IN] CCMR5 register ID to be configured
valToBeWritten	[OUT] Register value to be written to
pMetaInfo	[OUT] pointer to meta info (Optional) for SDL_EFAIL: reason for API failure as defined under SDL_ErrType_t for SDL_PASS: Not applicable

Returns: The SDL error code for the API. Success: SDL_PASS Fail : SDL_EFAIL

◆ SDL_armR5CCMSetOperationModeKey()

int32_t SDL_armR5CCMSetOperationModeKey	(	uintptr_t	baseAddress,
		SDL_McuArmssCcmR5ModuleId	moduleId,
		SDL_McuArmssCcmR5OpModeKey	opModeKey,
		int32_t *	pMetaInfo
	)

Configure Operating mode for CPU, VIM, CCM Inactivity monitor.

This function configures a Operation mode key and returns the status of the operation for API caller to indicate success or failure on the operation.

Consult the CCM module documentation for a description of the registers under MCU_ARMSS_CCMR5 registers section of the techinical reference manual https://www.ti.com/lit/pdf/spruid7

Parameters

baseAddress	[IN] Base address of MCU_ARMSS_CCMR5 registers
moduleId	[IN] CCMR5 module ID to be configured
opModeKey	[OUT] Operating mode to be set in KEY register
pMetaInfo	[OUT] pointer to meta info (Optional) for SDL_EFAIL: reason for API failure as defined under SDL_ErrType_t for SDL_PASS: Not applicable

Returns: The SDL error code for the API. Success: SDL_PASS Fail : SDL_EFAIL

◆ SDL_armR5CCMGetCompareError()

int32_t SDL_armR5CCMGetCompareError	(	uintptr_t	baseAddress,
		SDL_McuArmssCcmR5ModuleId	moduleId,
		uint32_t *	pCmpError,
		int32_t *	pMetaInfo
	)

Read Compare Error status for CPU, VIM, CCM Inactivity monitor.

This function reads the a Compare Error status and returns the status of the operation for API caller to indicate success or failure on the operation.

Consult the CCM module documentation for a description of the registers under MCU_ARMSS_CCMR5 registers section of the techinical reference manual https://www.ti.com/lit/pdf/spruid7

Parameters

baseAddress	[IN] Base address of MCU_ARMSS_CCMR5 registers
moduleId	[IN] CCMR5 module ID to be configured
pCmpError	[OUT] Pointer to Compare Error for the module
pMetaInfo	[OUT] pointer to meta info (Optional) for SDL_EFAIL: reason for API failure as defined under SDL_ErrType_t for SDL_PASS: Not applicable

Returns: The SDL error code for the API. Success: SDL_PASS Fail : SDL_EFAIL

◆ SDL_armR5CCMGetOperationModeKey()

int32_t SDL_armR5CCMGetOperationModeKey	(	uintptr_t	baseAddress,
		SDL_McuArmssCcmR5ModuleId	moduleId,
		SDL_McuArmssCcmR5OpModeKey *	pOpModeKey,
		int32_t *	pMetaInfo
	)

Get Operation mode key value for CPU, VIM, CCM Inactivity monitor.

This function reads the a Operation mode key and returns the status of the operation for API caller to indicate success or failure on the operation.

Consult the CCM module documentation for a description of the registers under MCU_ARMSS_CCMR5 registers section of the techinical reference manual https://www.ti.com/lit/pdf/spruid7

Parameters

baseAddress	[IN] Base address of MCU_ARMSS_CCMR5 registers
moduleId	[IN] CCMR5 module ID to be configured
pOpModeKey	[OUT] Pointer to Operation Mode for the module
pMetaInfo	[OUT] pointer to meta info (Optional) for SDL_EFAIL: reason for API failure as defined under SDL_ErrType_t for SDL_PASS: Not applicable

Returns

The SDL error code for the API. Success: SDL_PASS Fail : SDL_EFAIL Note: Please note that we cannot read the value that is written to the MKEY register unless the programmed key value is lockstep mode Additional information: Only 4 valid key values are expected to be programmed

LOCK_STEP_MODE
SELF_TEST_MODE
ERR_FORCE_MODE
ST_ERR_FORCE_MODE For any other value that is programmed the CCMKEYR register would reflect LOCK_STEP MODE. Also the error forcing/self test error forcing mode operates for 1 cpuclk cycle and after that the key register would reflect the LOCK STEP mode, even though the ERR FORCE & SELF TEST ERR FORCE mode would not complete in 1 cycle

◆ SDL_armR5CCMClearCompareError()

int32_t SDL_armR5CCMClearCompareError	(	uintptr_t	baseAddress,
		SDL_McuArmssCcmR5ModuleId	moduleId,
		int32_t *	pMetaInfo
	)

Clear Compare Error value for CPU, VIM, CCM Inactivity monitor.

This function clears the a Compare Error Statusand returns the status of the operation for API caller to indicate success or failure on the operation.

Consult the CCM module documentation for a description of the registers under MCU_ARMSS_CCMR5 registers section of the techinical reference manual https://www.ti.com/lit/pdf/spruid7

Parameters

baseAddress	[IN] Base address of MCU_ARMSS_CCMR5 registers
moduleId	[IN] CCMR5 module ID to be configured
pMetaInfo	[OUT] pointer to meta info (Optional) for SDL_EFAIL: reason for API failure as defined under SDL_ErrType_t for SDL_PASS: Not applicable

Returns: The SDL error code for the API. Success: SDL_PASS Fail : SDL_EFAIL

Introduction

Functions

Function Documentation

◆ SDL_armR5ReadCCMRegister()

◆ SDL_armR5ConfigureCCMRegister()

◆ SDL_armR5CCMSetOperationModeKey()

◆ SDL_armR5CCMGetCompareError()

◆ SDL_armR5CCMGetOperationModeKey()

◆ SDL_armR5CCMClearCompareError()