API's for MBOX

Introduction

Overview

MBOX Test API's:

1. SDL_MSS_MBOX_secExecute()
2. SDL_DSS_MBOX_secExecute()
3. SDL_RSS_MBOX_secExecute()
4. SDL_MSS_MBOX_dedExecute()
5. SDL_DSS_MBOX_dedExecute()
6. SDL_RSS_MBOX_dedExecute()
7. SDL_MSS_MBOX_redExecute()
8. SDL_DSS_MBOX_redExecute()
9. SDL_RSS_MBOX_redExecute()

Files
file	mbox/v0/sdl_mbox.h
	This file contains the prototypes of the APIs present in the device abstraction layer file of MBOX. This also contains some related macros.

Functions
void	SDL_MSS_MBOX_secExecute (void)
	This API is used for SEC test on MSS MBOX. More...
void	SDL_MSS_MBOX_dedExecute (void)
	This API is used for DED test on MSS MBOX. More...
int32_t	SDL_MSS_MBOX_redExecute (SDL_MBOX_busSftyFiType fiType, SDL_MBOX_busSftyFiRedType redType)
	This API is used for RED test on MSS MBOX. More...
void	SDL_MSS_MBOX_secErrorClear (void)
	This API is used to clear SEC error from MSS MBOX. More...
void	SDL_MSS_MBOX_dedErrorClear (void)
	This API is used to clear DED error from MSS MBOX. More...
void	SDL_MSS_MBOX_redErrorClear (void)
	This API is used to clear RED error from MSS MBOX. More...
void	SDL_DSS_MBOX_secExecute (void)
	This API is used for SEC test on DSS MBOX. More...
void	SDL_DSS_MBOX_dedExecute (void)
	This API is used for DED test on DSS MBOX. More...
int32_t	SDL_DSS_MBOX_redExecute (SDL_MBOX_busSftyFiType fiType, SDL_MBOX_busSftyFiRedType redType)
	This API is used for RED test on DSS MBOX. More...
void	SDL_DSS_MBOX_secErrorClear (void)
	This API is used to clear SEC error from DSS MBOX. More...
void	SDL_DSS_MBOX_dedErrorClear (void)
	This API is used to clear DED error from DSS MBOX. More...
void	SDL_DSS_MBOX_redErrorClear (void)
	This API is used to clear RED error from DSS MBOX. More...
void	SDL_RSS_MBOX_secExecute (void)
	This API is used for SEC test on RSS MBOX. More...
void	SDL_RSS_MBOX_dedExecute (void)
	This API is used for DED test on RSS MBOX. More...
int32_t	SDL_RSS_MBOX_redExecute (SDL_MBOX_busSftyFiType fiType, SDL_MBOX_busSftyFiRedType redType)
	This API is used for RED test on RSS MBOX. More...
void	SDL_RSS_MBOX_secErrorClear (void)
	This API is used to clear SEC error from RSS MBOX. More...
void	SDL_RSS_MBOX_dedErrorClear (void)
	This API is used to clear DED error from RSS MBOX. More...
void	SDL_RSS_MBOX_redErrorClear (void)
	This API is used to clear RED error from RSS MBOX. More...
uint32_t	SDL_DSS_MBOX_secErrorStatus (void)
	This API is used to get the SEC error status on DSS MBOX. More...
uint32_t	SDL_RSS_MBOX_secErrorStatus (void)
	This API is used to get the SEC error status on RSS MBOX. More...
uint32_t	SDL_DSS_MBOX_dedErrorStatus (void)
	This API is used to get the DED error status on MSS MBOX. More...
uint32_t	SDL_RSS_MBOX_dedErrorStatus (void)
	This API is used to get the DED error status on RSS MBOX. More...
uint32_t	SDL_DSS_MBOX_redErrorStatus (void)
	This API is used to get the RED error status on MSS MBOX. More...
uint32_t	SDL_RSS_MBOX_redErrorStatus (void)
	This API is used to get the RED error status on RSS MBOX. More...

Enumerations
enum	SDL_MBOX_busSftyFiType {   SDL_MBOX_FI_MAIN =0, SDL_MBOX_FI_SAFE = 1, SDL_MBOX_FI_GLOBAL_MAIN =2, SDL_MBOX_FI_GLOBAL_SAFE =3,   SDL_MBOX_FI_INVALID = 4 }
enum	SDL_MBOX_busSftyFiRedType {   SDL_MBOX_MAIN_CMD_INTERFACE =0, SDL_MBOX_MAIN_WRITE_INTERFACE =1, SDL_MBOX_MAIN_WRITE_STATUS_INTERFACE =2, SDL_MBOX_MAIN_READ_INTERFACE =3,   SDL_MBOX_FI_TYPE_INVALID =4 }

Macros
#define	SDL_MSS_MBOX_BUS_CFG   (uint32_t)SDL_MSS_CTRL_U_BASE
#define	SDL_DSS_MBOX_BUS_CFG   (uint32_t)SDL_DSS_CTRL_U_BASE

Macro Definition Documentation

SDL_MSS_MBOX_BUS_CFG

#define SDL_MSS_MBOX_BUS_CFG   (uint32_t)SDL_MSS_CTRL_U_BASE

SDL_DSS_MBOX_BUS_CFG

#define SDL_DSS_MBOX_BUS_CFG   (uint32_t)SDL_DSS_CTRL_U_BASE

Enumeration Type Documentation

SDL_MBOX_busSftyFiType

enum SDL_MBOX_busSftyFiType

Enumerator
SDL_MBOX_FI_MAIN
SDL_MBOX_FI_SAFE
SDL_MBOX_FI_GLOBAL_MAIN
SDL_MBOX_FI_GLOBAL_SAFE
SDL_MBOX_FI_INVALID

SDL_MBOX_busSftyFiRedType

enum SDL_MBOX_busSftyFiRedType

Enumerator
SDL_MBOX_MAIN_CMD_INTERFACE
SDL_MBOX_MAIN_WRITE_INTERFACE
SDL_MBOX_MAIN_WRITE_STATUS_INTERFACE
SDL_MBOX_MAIN_READ_INTERFACE
SDL_MBOX_FI_TYPE_INVALID

Function Documentation

SDL_MSS_MBOX_secExecute()

void SDL_MSS_MBOX_secExecute

(

void

)

This API is used for SEC test on MSS MBOX.

SDL_MSS_MBOX_dedExecute()

void SDL_MSS_MBOX_dedExecute

(

void

)

This API is used for DED test on MSS MBOX.

SDL_MSS_MBOX_redExecute()

int32_t SDL_MSS_MBOX_redExecute	(	SDL_MBOX_busSftyFiType	fiType,
		SDL_MBOX_busSftyFiRedType	redType
	)

This API is used for RED test on MSS MBOX.

Parameters

fiType	indicates the Fi type
redType	indicates interface type

Returns

status return the Test status. SDL_PASS: success SDL_EBADARGS: failure, indicate the bad input arguments SDL_EFAIL: failure, indicate verify failed

SDL_MSS_MBOX_secErrorClear()

void SDL_MSS_MBOX_secErrorClear

(

void

)

This API is used to clear SEC error from MSS MBOX.

SDL_MSS_MBOX_dedErrorClear()

void SDL_MSS_MBOX_dedErrorClear

(

void

)

This API is used to clear DED error from MSS MBOX.

SDL_MSS_MBOX_redErrorClear()

void SDL_MSS_MBOX_redErrorClear

(

void

)

This API is used to clear RED error from MSS MBOX.

SDL_DSS_MBOX_secExecute()

void SDL_DSS_MBOX_secExecute

(

void

)

This API is used for SEC test on DSS MBOX.

SDL_DSS_MBOX_dedExecute()

void SDL_DSS_MBOX_dedExecute

(

void

)

This API is used for DED test on DSS MBOX.

SDL_DSS_MBOX_redExecute()

int32_t SDL_DSS_MBOX_redExecute	(	SDL_MBOX_busSftyFiType	fiType,
		SDL_MBOX_busSftyFiRedType	redType
	)

This API is used for RED test on DSS MBOX.

Parameters

fiType	indicates the Fi type
redType	indicates interface type

Returns

status return the Test status. SDL_PASS: success SDL_EBADARGS: failure, indicate the bad input arguments SDL_EFAIL: failure, indicate verify failed

SDL_DSS_MBOX_secErrorClear()

void SDL_DSS_MBOX_secErrorClear

(

void

)

This API is used to clear SEC error from DSS MBOX.

SDL_DSS_MBOX_dedErrorClear()

void SDL_DSS_MBOX_dedErrorClear

(

void

)

This API is used to clear DED error from DSS MBOX.

SDL_DSS_MBOX_redErrorClear()

void SDL_DSS_MBOX_redErrorClear

(

void

)

This API is used to clear RED error from DSS MBOX.

SDL_RSS_MBOX_secExecute()

void SDL_RSS_MBOX_secExecute

(

void

)

This API is used for SEC test on RSS MBOX.

SDL_RSS_MBOX_dedExecute()

void SDL_RSS_MBOX_dedExecute

(

void

)

This API is used for DED test on RSS MBOX.

SDL_RSS_MBOX_redExecute()

int32_t SDL_RSS_MBOX_redExecute	(	SDL_MBOX_busSftyFiType	fiType,
		SDL_MBOX_busSftyFiRedType	redType
	)

This API is used for RED test on RSS MBOX.

Parameters

fiType	indicates the Fi type
redType	indicates interface type

Returns

status return the Test status. SDL_PASS: success SDL_EBADARGS: failure, indicate the bad input arguments SDL_EFAIL: failure, indicate verify failed

SDL_RSS_MBOX_secErrorClear()

void SDL_RSS_MBOX_secErrorClear

(

void

)

This API is used to clear SEC error from RSS MBOX.

SDL_RSS_MBOX_dedErrorClear()

void SDL_RSS_MBOX_dedErrorClear

(

void

)

This API is used to clear DED error from RSS MBOX.

SDL_RSS_MBOX_redErrorClear()

void SDL_RSS_MBOX_redErrorClear

(

void

)

This API is used to clear RED error from RSS MBOX.

SDL_DSS_MBOX_secErrorStatus()

uint32_t SDL_DSS_MBOX_secErrorStatus

(

void

)

This API is used to get the SEC error status on DSS MBOX.

Returns

status returns error status.

SDL_RSS_MBOX_secErrorStatus()

uint32_t SDL_RSS_MBOX_secErrorStatus

(

void

)

This API is used to get the SEC error status on RSS MBOX.

Returns

status returns error status.

SDL_DSS_MBOX_dedErrorStatus()

uint32_t SDL_DSS_MBOX_dedErrorStatus

(

void

)

This API is used to get the DED error status on MSS MBOX.

Returns

status returns error status.

SDL_RSS_MBOX_dedErrorStatus()

uint32_t SDL_RSS_MBOX_dedErrorStatus

(

void

)

This API is used to get the DED error status on RSS MBOX.

Returns

status returns error status.

SDL_DSS_MBOX_redErrorStatus()

uint32_t SDL_DSS_MBOX_redErrorStatus

(

void

)

This API is used to get the RED error status on MSS MBOX.

Returns

status returns error status.

SDL_RSS_MBOX_redErrorStatus()

uint32_t SDL_RSS_MBOX_redErrorStatus

(

void

)

This API is used to get the RED error status on RSS MBOX.

Returns

status returns error status.