API's for HWA

Introduction

Overview

HWA Test API's:

1. SDL_HWA_DMA0_secExecute()
2. SDL_HWA_DMA1_secExecute()
3. SDL_HWA_DMA0_dedExecute()
4. SDL_HWA_DMA1_dedExecute()
5. SDL_HWA_DMA0_redExecute()
6. SDL_HWA_DMA1_redExecute()
7. SDL_HWA_memParityExecute()
8. SDL_HWA_fsmLockStepExecute()

Files
file	hwa/v0/sdl_hwa.h
	This file contains the prototypes of the APIs present in the device abstraction layer file of HWA. This also contains some related macros.

Functions
void	SDL_HWA_DMA0_secExecute (void)
	This API is used for SEC test on DMA0. More...
void	SDL_HWA_DMA1_secExecute (void)
	This API is used for SEC test on DMA1. More...
void	SDL_HWA_DMA0_dedExecute (void)
	This API is used for DED test on DMA0. More...
void	SDL_HWA_DMA1_dedExecute (void)
	This API is used for DED test on DMA1. More...
int32_t	SDL_HWA_DMA0_redExecute (SDL_HWA_busSftyFiType fiType, SDL_HWA_busSftyFiRedType redType)
	This API is used for RED test on DMA0. More...
int32_t	SDL_HWA_DMA1_redExecute (SDL_HWA_busSftyFiType fiType, SDL_HWA_busSftyFiRedType redType)
	This API is used for RED test on DMA1. More...
void	SDL_HWA_DMA0_secErrorClear (void)
	This API is used to clear SEC error from DMA0. More...
void	SDL_HWA_DMA1_secErrorClear (void)
	This API is used to clear SEC error from DMA1. More...
void	SDL_HWA_DMA0_dedErrorClear (void)
	This API is used to clear DED error from DMA0. More...
void	SDL_HWA_DMA1_dedErrorClear (void)
	This API is used to clear DED error from DMA1. More...
void	SDL_HWA_DMA0_redErrorClear (void)
	This API is used to clear RED error from DMA0. More...
void	SDL_HWA_DMA1_redErrorClear (void)
	This API is used to clear red error from DMA1. More...
uint32_t	SDL_HWA_DMA0_secErrorStatus (void)
	This API is used to get SEC error status from DMA0. More...
uint32_t	SDL_HWA_DMA1_secErrorStatus (void)
	This API is used to get SEC error status from DMA1. More...
uint32_t	SDL_HWA_DMA0_dedErrorStatus (void)
	This API is used to get DED error status from DMA0. More...
uint32_t	SDL_HWA_DMA1_dedErrorStatus (void)
	This API is used to get DED error status from DMA1. More...
uint32_t	SDL_HWA_DMA0_redErrorStatus (void)
	This API is used to get RED error status from DMA0. More...
uint32_t	SDL_HWA_DMA1_redErrorStatus (void)
	This API is used to get RED error status from DMA1. More...
int32_t	SDL_HWA_memParityExecute (SDL_HWA_MemID memID, SDL_HWA_MemBlock memBlock)
	This API is used for configuring and testing parity of the HWA memory. More...
int32_t	SDL_HWA_fsmLockStepExecute (void)
	This API is used to induce the error in the fsm lockstep for HWA. More...
int32_t	SDL_HWA_getMemblockBaseaddr (SDL_HWA_MemID memID, SDL_HWA_MemBlock memBlock, uint32_t *baseAddr)
	This API is used to get the memory block base address. More...

Enumerations
enum	SDL_HWA_busSftyFiType {   SDL_HWA_FI_MAIN =0, SDL_HWA_FI_SAFE = 1, SDL_HWA_FI_GLOBAL_MAIN =2, SDL_HWA_FI_GLOBAL_SAFE =3,   SDL_HWA_FI_INVALID = 4 }
enum	SDL_HWA_busSftyFiRedType {   SDL_HWA_MAIN_CMD_INTERFACE =0, SDL_HWA_MAIN_WRITE_INTERFACE =1, SDL_HWA_MAIN_WRITE_STATUS_INTERFACE =2, SDL_HWA_MAIN_READ_INTERFACE =3,   SDL_HWA_FI_TYPE_INVALID =4 }
enum	SDL_HWA_MemBlock {   SDL_HWA_DMEM0 = 0, SDL_HWA_DMEM1 = 1, SDL_HWA_DMEM2 = 2, SDL_HWA_DMEM3 = 3,   SDL_HWA_DMEM4 = 4, SDL_HWA_DMEM5 = 5, SDL_HWA_DMEM6 = 6, SDL_HWA_DMEM7 = 7,   SDL_HWA_WINDOW_RAM = 8, SDL_HWA_FSM_LOCKSTEP = 9, SDL_HWA_INVALID = 10 }
	This enumerator defines the HWA memories. More...
enum	SDL_HWA_MemID { SDL_HWA_DMA0_MEM_ID = 0, SDL_HWA_DMA1_MEM_ID = 1, SDL_HWA_WINDOW_RAM_MEM_ID = 2, SDL_HWA_INVALID_ID = 3 }
	This enumerator defines the HWA IDs. More...

Macros
#define	SDL_HWA_CFG   (uint32_t)SDL_DSS_HWA_CFG_U_BASE
#define	SDL_HWA_BUS_CFG   (uint32_t)SDL_DSS_CTRL_U_BASE
#define	SDL_HWA_DMA0_ADDRESS   (uint32_t)SDL_DSS_HWA_DMA0_U_BASE
#define	SDL_HWA_DMA1_ADDRESS   (uint32_t)SDL_DSS_HWA_DMA1_U_BASE

Macro Definition Documentation

SDL_HWA_CFG

#define SDL_HWA_CFG   (uint32_t)SDL_DSS_HWA_CFG_U_BASE

SDL_HWA_BUS_CFG

#define SDL_HWA_BUS_CFG   (uint32_t)SDL_DSS_CTRL_U_BASE

SDL_HWA_DMA0_ADDRESS

#define SDL_HWA_DMA0_ADDRESS   (uint32_t)SDL_DSS_HWA_DMA0_U_BASE

SDL_HWA_DMA1_ADDRESS

#define SDL_HWA_DMA1_ADDRESS   (uint32_t)SDL_DSS_HWA_DMA1_U_BASE

Enumeration Type Documentation

SDL_HWA_busSftyFiType

enum SDL_HWA_busSftyFiType

Enumerator
SDL_HWA_FI_MAIN
SDL_HWA_FI_SAFE
SDL_HWA_FI_GLOBAL_MAIN
SDL_HWA_FI_GLOBAL_SAFE
SDL_HWA_FI_INVALID

SDL_HWA_busSftyFiRedType

enum SDL_HWA_busSftyFiRedType

Enumerator
SDL_HWA_MAIN_CMD_INTERFACE
SDL_HWA_MAIN_WRITE_INTERFACE
SDL_HWA_MAIN_WRITE_STATUS_INTERFACE
SDL_HWA_MAIN_READ_INTERFACE
SDL_HWA_FI_TYPE_INVALID

SDL_HWA_MemBlock

enum SDL_HWA_MemBlock

This enumerator defines the HWA memories.

Enumerator
SDL_HWA_DMEM0	HWA Data memories 0
SDL_HWA_DMEM1	HWA Data memories 1
SDL_HWA_DMEM2	HWA Data memories 2
SDL_HWA_DMEM3	HWA Data memories 3
SDL_HWA_DMEM4	HWA Data memories 4
SDL_HWA_DMEM5	HWA Data memories 5
SDL_HWA_DMEM6	HWA Data memories 6
SDL_HWA_DMEM7	HWA Data memories 7
SDL_HWA_WINDOW_RAM	Window RAM memories
SDL_HWA_FSM_LOCKSTEP	HWA FSM Lockstep
SDL_HWA_INVALID

SDL_HWA_MemID

enum SDL_HWA_MemID

This enumerator defines the HWA IDs.

Enumerator
SDL_HWA_DMA0_MEM_ID	HWA DMA 0
SDL_HWA_DMA1_MEM_ID	HWA DMA 1
SDL_HWA_WINDOW_RAM_MEM_ID	Window RAM
SDL_HWA_INVALID_ID

Function Documentation

SDL_HWA_DMA0_secExecute()

void SDL_HWA_DMA0_secExecute

(

void

)

This API is used for SEC test on DMA0.

SDL_HWA_DMA1_secExecute()

void SDL_HWA_DMA1_secExecute

(

void

)

This API is used for SEC test on DMA1.

SDL_HWA_DMA0_dedExecute()

void SDL_HWA_DMA0_dedExecute

(

void

)

This API is used for DED test on DMA0.

SDL_HWA_DMA1_dedExecute()

void SDL_HWA_DMA1_dedExecute

(

void

)

This API is used for DED test on DMA1.

SDL_HWA_DMA0_redExecute()

int32_t SDL_HWA_DMA0_redExecute	(	SDL_HWA_busSftyFiType	fiType,
		SDL_HWA_busSftyFiRedType	redType
	)

This API is used for RED test on DMA0.

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_HWA_DMA1_redExecute()

int32_t SDL_HWA_DMA1_redExecute	(	SDL_HWA_busSftyFiType	fiType,
		SDL_HWA_busSftyFiRedType	redType
	)

This API is used for RED test on DMA1.

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_HWA_DMA0_secErrorClear()

void SDL_HWA_DMA0_secErrorClear

(

void

)

This API is used to clear SEC error from DMA0.

SDL_HWA_DMA1_secErrorClear()

void SDL_HWA_DMA1_secErrorClear

(

void

)

This API is used to clear SEC error from DMA1.

SDL_HWA_DMA0_dedErrorClear()

void SDL_HWA_DMA0_dedErrorClear

(

void

)

This API is used to clear DED error from DMA0.

SDL_HWA_DMA1_dedErrorClear()

void SDL_HWA_DMA1_dedErrorClear

(

void

)

This API is used to clear DED error from DMA1.

SDL_HWA_DMA0_redErrorClear()

void SDL_HWA_DMA0_redErrorClear

(

void

)

This API is used to clear RED error from DMA0.

SDL_HWA_DMA1_redErrorClear()

void SDL_HWA_DMA1_redErrorClear

(

void

)

This API is used to clear red error from DMA1.

SDL_HWA_DMA0_secErrorStatus()

uint32_t SDL_HWA_DMA0_secErrorStatus

(

void

)

This API is used to get SEC error status from DMA0.

SDL_HWA_DMA1_secErrorStatus()

uint32_t SDL_HWA_DMA1_secErrorStatus

(

void

)

This API is used to get SEC error status from DMA1.

Returns

status returns error status.

SDL_HWA_DMA0_dedErrorStatus()

uint32_t SDL_HWA_DMA0_dedErrorStatus

(

void

)

This API is used to get DED error status from DMA0.

Returns

status returns error status.

SDL_HWA_DMA1_dedErrorStatus()

uint32_t SDL_HWA_DMA1_dedErrorStatus

(

void

)

This API is used to get DED error status from DMA1.

Returns

status returns error status.

SDL_HWA_DMA0_redErrorStatus()

uint32_t SDL_HWA_DMA0_redErrorStatus

(

void

)

This API is used to get RED error status from DMA0.

Returns

status returns error status.

SDL_HWA_DMA1_redErrorStatus()

uint32_t SDL_HWA_DMA1_redErrorStatus

(

void

)

This API is used to get RED error status from DMA1.

Returns

status returns error status.

SDL_HWA_memParityExecute()

int32_t SDL_HWA_memParityExecute	(	SDL_HWA_MemID	memID,
		SDL_HWA_MemBlock	memBlock
	)

This API is used for configuring and testing parity of the HWA memory.

Parameters

memID	indicates the memory in the HWA
memBlock	indicates the memory block in the HWA memory

Returns

status return the base address of th instance. SDL_PASS: success SDL_EBADARGS: failure, indicate the bad input arguments SDL_EFAIL: failure, indicate verify failed

SDL_HWA_fsmLockStepExecute()

int32_t SDL_HWA_fsmLockStepExecute

(

void

)

This API is used to induce the error in the fsm lockstep for HWA.

Returns

status return the base address of th instance. SDL_PASS: success SDL_EBADARGS: failure, indicate the bad input arguments SDL_EFAIL: failure, indicate verify failed

SDL_HWA_getMemblockBaseaddr()

int32_t SDL_HWA_getMemblockBaseaddr	(	SDL_HWA_MemID	memID,
		SDL_HWA_MemBlock	memBlock,
		uint32_t *	baseAddr
	)

This API is used to get the memory block base address.

Parameters

memID	HWA IDs for DMA0, DMA1 and Window RAM
memBlock	HWA memories for DMA0/DMA1's block
baseAddr	pointer to base addressof the memories

Returns

status return the base address of th instance. SDL_PASS: success SDL_EBADARGS: failure, indicate the bad input arguments SDL_EFAIL: failure, indicate verify failed