This module contains the APIs to program and use the CCM module.
|
| file | sdl_ip_ccm.h |
| | Header file contains enumerations, structure definitions and function declarations for SDL CCM interface.
|
| |
|
| int32_t | SDL_CCM_init (SDL_CCM_Inst instance) |
| | 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...
|
| |
◆ SDL_CCM_MonitorType
This enumerator defines the type of CCM Monitor type.
| Enumerator |
|---|
| SDL_CCM_MONITOR_TYPE_NONE | CCM Monitor None
|
| SDL_CCM_MONITOR_TYPE_OUTPUT_COMPARE_BLOCK | CCM output compare block monitor type
|
| SDL_CCM_MONITOR_TYPE_VIM | CCM VIM block monitor type
|
| SDL_CCM_MONITOR_TYPE_INACTIVITY_MONITOR | CCM inacitivty monitor type
|
| SDL_CCM_MONITOR_TYPE_INVALID | CCM invalid type
|
◆ SDL_CCM_SelfTestType
This enumerator defines the type of CCM Self-test type.
| Enumerator |
|---|
| SDL_CCM_SELFTEST_TYPE_NORMAL | Self-test for a particular monitor type
|
| SDL_CCM_SELFTEST_TYPE_ERROR_FORCING | Error-forcing self-test for a particular monitor type
|
| SDL_CCM_SELFTEST_POLARITY_INVERSION | Polarity inversion self-test for a particular monitor type
|
| SDL_CCM_SELFTEST_TYPE_INVALID | CCM invalid type
|
◆ SDL_CCM_init()
Initialization API for CCM module.
- Parameters
-
| instance | [IN] CCM Instance |
- Returns
- The SDL error code for the API SDL_PASS : Success; SDL_EFAIL : if error happened during initialization
◆ SDL_CCM_verifyConfig()
Verifies the configuration done as part of SDL_CCM_init is as expected.
- Parameters
-
| instance | [IN] CCM Instance |
- Returns
- The SDL error code for the API SDL_PASS : Success; SDL_EFAIL : Verification failed
◆ SDL_CCM_selfTest()
Executes a self-test of the CCM module. The types of self-tests supported are described in detail in SDL_CCM_SelfTestType.
- Parameters
-
| instance | [IN] CCM Instance |
| monitorType | [IN] Monitor type for which to run the self-test |
| testType | [IN] Test type to run for the selected monitor type. |
| polarityInversionMask | [IN] Mask used to invert polarity of selected signals. For meaning of signals, refer to hardware manuals. This parameter is used only for the polarity inversion self-test type |
| timeoutCnt | [IN] Number of times to check for self-test completion in a loop before timing out |
- Returns
- The SDL error code for the API SDL_PASS : Self-test passed SDL_EBADARGS : Returned if input paramter is invalid SDL_EFAIL : Self-test failed
◆ SDL_CCM_injectError()
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.
- Parameters
-
| instance | [IN] CCM Instance |
| monitorType | [IN] Monitor type for which to inject the error |
- Returns
- The SDL error code for the API SDL_PASS : Error injection passed SDL_EBADARGS : Returned if input paramter is invalid SDL_EFAIL : Error injection failed
◆ SDL_CCM_getStaticRegisters()
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.
- Parameters
-
| instance | [IN] CCM Instance |
| pStaticRegs | [OUT] Pointer to the variable to store the static register information |
- Returns
- The SDL error code for the API SDL_PASS : Static registers successfully read SDL_EBADARGS : Invalid pointer passed
◆ SDL_CCM_getErrorType()
Gets the monitor type for which the CCM error was generated. Takes the ESM interrupt source as input.
- Parameters
-
| instance | [IN] CCM Instance |
| intSrc | [IN] ESM interrupt source used to check for monitorType that generated the error |
| monitorType | [OUT] Monitor type which generated the error |
- Returns
- The SDL error code for the API SDL_PASS : Monitor type retrieved SDL_EBADARGS : Invalid parameter
◆ SDL_CCM_clearError()
Clears the compare error for the selected monitor type.
- Parameters
-
| instance | [IN] CCM Instance |
| monitorType | [IN] Monitor type for which to clear the error |
- Returns
- The SDL error code for the API SDL_PASS : Event cleared SDL_EBADARGS : Invalid parameter SDL_EFAIL : Failed to clear the error
1.8.20