APIs for SDL ESM

Introduction

This module contains APIs for using the ESM module. The APIs can be used to configure the ESM instances for notification when error events occur and also to set the error pin.

Files
file	sdl_esm.h
	This file contains the SDL ESM API's.

Functions
int32_t	SDL_ESM_getNErrorStatus (SDL_ESM_Inst instance, uint32_t *pStatus)
	SDL ESM API to get the status of the nError pin for the specified ESM instance. More...
int32_t	SDL_ESM_getStaticRegisters (SDL_ESM_Inst instance, SDL_ESM_staticRegs *pStaticRegs)
	SDL ESM API to read the static registers. The API reads and returns the static register configuration for the ESM module for the specified instance. This API can be used by the application to read back the static configuration. Comparision of the static configuration registers against expected values is the responsibility of the application. More...
int32_t	SDL_ESM_verifyConfig (SDL_ESM_Inst instance, const SDL_ESM_config *pConfig)
	SDL ESM API to verify the written configuration of the ESM module. The API verifies the written config that was done during SDL_ESM_init against the provided configuration. More...
int32_t	SDL_ESM_clrNError (SDL_ESM_Inst instance)
	SDL ESM API to clear the nError pin for the specified ESM instance. More...
int32_t	SDL_ESM_setNError (SDL_ESM_Inst instance)
	SDL ESM API to set the nError pin for the specified ESM instance. More...
int32_t	SDL_ESM_registerECCCallback (SDL_ESM_Inst instance, uint32_t eventBitMap[], SDL_ESM_applicationCallback eccCallback, void *callbackArg)
	There are modules within SDL which will generate ESM errors intentionally in the course of running self-tests. The ECC module is one such module. To allow these modules to get the notification when the ESM error occurs, callback registration APIs are provided. The following APIs allow registration of a callback for specific events. This API is used by other SDL modules and not by the application. More...
int32_t	SDL_ESM_init (SDL_ESM_Inst instance, const SDL_ESM_config *pConfig, SDL_ESM_applicationCallback applicationCallback, void *appArg)
	SDL ESM API to initialize an ESM instance. The API initializes the specified ESM instance with the provided configuration. The configuration will allow the application to specify for each event whether the interrupt is enabled or disabled, the priority of the event, and whether the nErrorPin assertion is enabled or disabled for the event. More...

Function Documentation

SDL_ESM_getNErrorStatus()

int32_t SDL_ESM_getNErrorStatus	(	SDL_ESM_Inst	instance,
		uint32_t *	pStatus
	)

SDL ESM API to get the status of the nError pin for the specified ESM instance.

============================================================================

Parameters

instance	ESM Instance
pStatus	Pointer to variable to store the status. If status is 1, then error pin is not active. If status is 0, then error pin is active.

Returns

SDL_PASS if nError pin status is successfully retrieved. SDL_EBADARGS if instance or pStatus pointer are invalid. SDL_EFAIL if fail to read the error pin.

SDL_ESM_getStaticRegisters()

int32_t SDL_ESM_getStaticRegisters	(	SDL_ESM_Inst	instance,
		SDL_ESM_staticRegs *	pStaticRegs
	)

SDL ESM API to read the static registers. The API reads and returns the static register configuration for the ESM module for the specified instance. This API can be used by the application to read back the static configuration. Comparision of the static configuration registers against expected values is the responsibility of the application.

============================================================================

Parameters

instance	ESM Instance
pStaticRegs	Pointer to the static config register structure

Returns

SDL_PASS if registers are successfully read. SDL_EBADARGS if instance or pStaticRegs are invalid.

SDL_ESM_verifyConfig()

int32_t SDL_ESM_verifyConfig	(	SDL_ESM_Inst	instance,
		const SDL_ESM_config *	pConfig
	)

SDL ESM API to verify the written configuration of the ESM module. The API verifies the written config that was done during SDL_ESM_init against the provided configuration.

============================================================================

Parameters

instance	ESM Instance
pConfig	Pointer to the ESM configuration to be used for verification.

Returns

SDL_PASS if Verification passed SDL_EBADARGS if instance or pConfig are invalid. SDL_EFAIL if verification failed.

SDL_ESM_clrNError()

int32_t SDL_ESM_clrNError

(

SDL_ESM_Inst

instance

)

SDL ESM API to clear the nError pin for the specified ESM instance.

============================================================================

Parameters

instance

ESM Instance

Returns

SDL_PASS if nError pin status is successfully cleared. SDL_EBADARGS if instance is invalid.

SDL_ESM_setNError()

int32_t SDL_ESM_setNError

(

SDL_ESM_Inst

instance

)

SDL ESM API to set the nError pin for the specified ESM instance.

============================================================================

Parameters

instance

ESM Instance

Returns

SDL_PASS if nError pin status is successfully set. SDL_EBADARGS if instance is invalid.

SDL_ESM_registerECCCallback()

int32_t SDL_ESM_registerECCCallback	(	SDL_ESM_Inst	instance,
		uint32_t	eventBitMap[],
		SDL_ESM_applicationCallback	eccCallback,
		void *	callbackArg
	)

There are modules within SDL which will generate ESM errors intentionally in the course of running self-tests. The ECC module is one such module. To allow these modules to get the notification when the ESM error occurs, callback registration APIs are provided. The following APIs allow registration of a callback for specific events. This API is used by other SDL modules and not by the application.

============================================================================

Parameters

instance	ESM Instance
eventBitMap	Bitmap for ESM error event of interest for this callback. Array of uint32_t type with each bit representing one ESM error event.
eccCallback	Pointer to the callback to be called by the ESM Handler to notify the ECC module of an ESM error event
callbackArg	Argument that will be passed along with the callback.

Returns

SDL_PASS if success. SDL_EBADARGS if invalid argument is passed. SDL_EFAIL if other failure.

SDL_ESM_init()

int32_t SDL_ESM_init	(	SDL_ESM_Inst	instance,
		const SDL_ESM_config *	pConfig,
		SDL_ESM_applicationCallback	applicationCallback,
		void *	appArg
	)

SDL ESM API to initialize an ESM instance. The API initializes the specified ESM instance with the provided configuration. The configuration will allow the application to specify for each event whether the interrupt is enabled or disabled, the priority of the event, and whether the nErrorPin assertion is enabled or disabled for the event.

============================================================================

Parameters

instance	ESM Instance
pConfig	Pointer to the ESM configuration structure
applicationCallback	Pointer to the callback to be called by the ESM Handler to notify the application of an ESM error event.
appArg	Application argument that will passed to the application when the application callback is called.

Returns

SDL_PASS if success. SDL_EBADARGS if invalid argument is passed. SDL_EFAIL if other failure.