Sentinel

Overview

Macros
#define	SENTINEL_BASELINE_API_CMD_PING   (0x01U)
	sentinel command definition. More...

Functions
void	SENTINEL_Init (void)
	Initialize MU interface for Sentinel access.
void	SENTINEL_Deinit (void)
	Deinitialize MU interface for Sentinel access.
void	SENTINEL_SendMessage (uint32_t *param, uint32_t paramCount)
	Send message to Sentinel. More...
void	SENTINEL_ReceiveMessage (uint32_t *pParam, uint32_t *pParamCount)
	Receive message from Sentinel. More...
uint32_t	SENTINEL_Command (uint32_t *cmdParam, uint32_t cmdParamCount, uint32_t *pRespParam, uint32_t *pRespParamCount)
	Send command to Sentinel and receive response. More...
uint32_t	SENTINEL_Ping (void)
	Ping Sentinel to see if it is alive. More...
uint32_t	SENTINEL_GetFirmwareVersion (uint32_t *pVersion, uint32_t *pCommitSha)
	Get Sentinel firmware version. More...
uint32_t	SENTINEL_GetFirmwareStatus (uint8_t *pStatus)
	Get Sentinel firmware status. More...
uint32_t	SENTINEL_SetPowerDown (uint32_t resumeAddr, uint32_t size)
	Request Sentinel to enter power down. More...
uint32_t	SENTINEL_GetSocInfo (uint16_t *pSoc_id, uint16_t *pSoc_rev)
	Get Sentinel cpu version. More...

Driver version
#define	FSL_SENTINEL_DRIVER_VERSION   (MAKE_VERSION(2, 0, 3))
	sentinel driver version 2.0.3. More...

Macro Definition Documentation

#define SENTINEL_BASELINE_API_CMD_PING   (0x01U)

#define FSL_SENTINEL_DRIVER_VERSION   (MAKE_VERSION(2, 0, 3))

Function Documentation

void SENTINEL_SendMessage	(	uint32_t *	param,
		uint32_t	paramCount
	)

Parameters

param	Command parameters pointer. Each parameter is a 32bit word.
paramCount	Command parameter count.

void SENTINEL_ReceiveMessage	(	uint32_t *	pParam,
		uint32_t *	pParamCount
	)

Parameters

pParam	Pointer to save command parameters. Each parameter is a 32bit word.
pParamCount	Inout pointer to command parameter count.

uint32_t SENTINEL_Command	(	uint32_t *	cmdParam,
		uint32_t	cmdParamCount,
		uint32_t *	pRespParam,
		uint32_t *	pRespParamCount
	)

Parameters

cmdParam	Command parameters pointer. Each parameter is a 32bit word.
cmdParamCount	Command parameter count.
pRespParam	Pointer to save response parameters. Each parameter is a 32bit word.
pRespParamCount	Inout pointer to response parameter count.

Returns

0 for success, otherwise return error code.

uint32_t SENTINEL_Ping

(

void

)

Returns

0 for success, otherwise return error code.

uint32_t SENTINEL_GetFirmwareVersion	(	uint32_t *	pVersion,
		uint32_t *	pCommitSha
	)

Parameters

pVersion	Pointer to save firmware version.
pCommitSha	Pointer to save first 4 bytes of the git commit ID.

Returns

0 for success, otherwise return error code.

uint32_t SENTINEL_GetFirmwareStatus

(

uint8_t *

pStatus

)

Parameters

pStatus

Pointer to save firmware status. 0: No firmware in place. 1: Firmware authenticated and operational.

Returns

0 for success, otherwise return error code.

uint32_t SENTINEL_SetPowerDown	(	uint32_t	resumeAddr,
		uint32_t	size
	)

Parameters

resumeAddr	Base address in memory for resume code
size	Length of resume code in memory

Returns

0 for success, otherwise return error code.

uint32_t SENTINEL_GetSocInfo	(	uint16_t *	pSoc_id,
		uint16_t *	pSoc_rev
	)

Parameters

pSoc_id	Pointer to soc id.
pSoc_rev	Pointer to soc revision number.

Returns

0 for success, otherwise return error code.