AM263Px MCU+ SDK: sdl_ip_ccm.h File Reference

| AM263Px MCU+ SDK 26.00.00 |

Data Structures | Macros | Typedefs | Enumerations | Functions
sdl_ip_ccm.h File Reference
APIs for SDL Module » APIs for CCM MODULE » CCM API

## Introduction

Header file contains enumerations, structure definitions and function declarations for SDL CCM interface.

Go to the source code of this file.

## Data Structures
struct | SDL_CCM_staticRegs
| CCM Static Register. More...
struct | SDL_CCM_ErrorStatus_t
| Structure for CCM error status. More...
struct | SDL_vimStaticRegs_GRP
| This structure defines the group registers identified for VIM static registers. More...
struct | SDL_vimStaticRegs
| This structure defines the static register groups identified for VIM. More...

## Macros
#define | SDL_VIM_MAX_INTR_GROUPS (32U)
#define | SDL_VIM_NUM_INTRS_PER_GROUP (32U)
#define | SDL_VIM_INTR_MAP_IRQ ((uint32_t)0U)
#define | SDL_VIM_INTR_MAP_FIQ ((uint32_t)1U)
#define | SDL_VIM_INTR_MAP_ALL ((uint32_t)2U)
#define | SDL_VIM_INTR_TYPE_LEVEL ((uint32_t)0U)
#define | SDL_VIM_INTR_TYPE_PULSE ((uint32_t)1U)

## Typedefs
typedef uint32_t | SDL_VimIntrMap
| This enumerator defines the possible output interrupt types. Each source interrupt can be configured to drive either the IRQ or FIQ output signal. More...
typedef uint32_t | SDL_VimIntrType
| This enumerator defines the possible interrupt types. Each source interrupt is either an active high level or active high pulse. More...

## Enumerations
enum | SDL_CCM_MonitorType { SDL_CCM_MONITOR_TYPE_NONE = 0, SDL_CCM_MONITOR_TYPE_OUTPUT_COMPARE_BLOCK = 1, SDL_CCM_MONITOR_TYPE_VIM = 2, SDL_CCM_MONITOR_TYPE_INACTIVITY_MONITOR = 3, SDL_CCM_MONITOR_TYPE_INVALID = 4 }
| This enumerator defines the type of CCM Monitor type. More...
enum | SDL_CCM_SelfTestType { SDL_CCM_SELFTEST_TYPE_NORMAL = 1, SDL_CCM_SELFTEST_TYPE_ERROR_FORCING = 2, SDL_CCM_SELFTEST_POLARITY_INVERSION = 3, SDL_CCM_SELFTEST_TYPE_INVALID = 4 }
| This enumerator defines the type of CCM Self-test type. More...

## Functions
int32_t | SDL_CCM_init (SDL_CCM_Inst instance, uint32_t index)
| Initialization API for CCM module. More...
int32_t | SDL_CCM_verifyConfig (SDL_CCM_Inst instance)
| Verifies the configuration done as part of SDL_CCM_init is as expected. More...
int32_t | SDL_CCM_selfTest (SDL_CCM_Inst instance, SDL_CCM_MonitorType monitorType, SDL_CCM_SelfTestType testType, uint32_t polarityInversionMask, uint32_t timeoutCnt)
| Executes a self-test of the CCM module. The types of self-tests supported are described in detail in SDL_CCM_SelfTestType. More...
int32_t | SDL_CCM_injectError (SDL_CCM_Inst instance, SDL_CCM_MonitorType monitorType)
| Forces an error to be generated for the selected monitor type. After injecting the error, an ESM error event is generated and the application will receive notification via ESM application callback. More...
int32_t | SDL_CCM_getStaticRegisters (SDL_CCM_Inst instance, SDL_CCM_staticRegs *pStaticRegs)
| Retrieves the static register configuration. The values returned in staticRegs can be saved by the application and periodically checked for changes. Note: This API should not be called while running any self-test or during error injection, as this will change the values of the static registers temporarily. It should be called only when in normal operating mode. More...
int32_t | SDL_CCM_getErrorType (SDL_CCM_Inst instance, uint32_t intSrc, SDL_CCM_MonitorType *monitorType)
| Gets the monitor type for which the CCM error was generated. Takes the ESM interrupt source as input. More...
int32_t | SDL_CCM_clearError (SDL_CCM_Inst instance, SDL_CCM_MonitorType monitorType)
| Clears the compare error for the selected monitor type. More...
int32_t | SDL_VIM_cfgIntr (SDL_vimRegs *pRegs, uint32_t intrNum, uint32_t pri, SDL_VimIntrMap intrMap, SDL_VimIntrType intrType, uint32_t vecAddr)
| Configure a source interrupt using VIM. More...
int32_t | SDL_VIM_verifyCfgIntr (SDL_vimRegs *pRegs, uint32_t intrNum, uint32_t pri, SDL_VimIntrMap intrMap, SDL_VimIntrType intrType, uint32_t vecAddr)
| Read back Verify Configure a source interrupt. More...
int32_t | SDL_VIM_getStaticRegs (SDL_vimRegs *pRegs, SDL_vimStaticRegs *pStaticRegs)
| Read back of static registers for VIM. More...