AM273x MCU+ SDK  08.05.00
hwa/v0/sdl_hwa.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) Texas Instruments Incorporated 2022
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the
14  * distribution.
15  *
16  * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  */
56 #ifndef SDL_HWA_H_
57 #define SDL_HWA_H_
58 
59 /* ========================================================================== */
60 /* Include Files */
61 /* ========================================================================== */
62 #include "sdl_hwa_hw.h"
63 #include <sdl/hwa/v0/soc/sdl_hwa_soc.h>
64 
65 #ifdef _cplusplus
66 extern "C" {
67 #endif
68 
69 /* ========================================================================== */
70 /* Macros & Typedefs */
71 /* ========================================================================== */
72 
73 /* ========================================================================== */
74 /* Structure Declarations */
75 /* ========================================================================== */
76 typedef enum
77 {
84 
85 typedef enum
86 {
93 
94 /* ========================================================================== */
95 /* Variable Declarations */
96 /* ========================================================================== */
97 /* ========================================================================== */
98 /* Function Declarations */
99 /* ========================================================================== */
105 
111 
118 
125 
151 
157 
163 
170 
176 
182 
188 
194 
201 
208 
215 
222 
229 
245 
257 
258 #ifdef _cplusplus
259 }
260 #endif /*extern "C" */
261 #endif
262 
SDL_HWA_MemBlock
SDL_HWA_MemBlock
This enumerator defines the HWA memories.
Definition: sdl_hwa_soc.h:64
SDL_HWA_DMA0_secErrorClear
void SDL_HWA_DMA0_secErrorClear(void)
This API is used to clear SEC error from DMA0.
SDL_HWA_FI_TYPE_INVALID
@ SDL_HWA_FI_TYPE_INVALID
Definition: hwa/v0/sdl_hwa.h:91
SDL_HWA_FI_MAIN
@ SDL_HWA_FI_MAIN
Definition: hwa/v0/sdl_hwa.h:78
SDL_HWA_MAIN_CMD_INTERFACE
@ SDL_HWA_MAIN_CMD_INTERFACE
Definition: hwa/v0/sdl_hwa.h:87
SDL_HWA_fsmLockStepExecute
int32_t SDL_HWA_fsmLockStepExecute(void)
This API is used to induce the error in the fsm lockstep for HWA.
SDL_HWA_busSftyFiRedType
SDL_HWA_busSftyFiRedType
Definition: hwa/v0/sdl_hwa.h:86
SDL_HWA_DMA1_dedErrorStatus
uint32_t SDL_HWA_DMA1_dedErrorStatus(void)
This API is used to get DED error status from 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.
SDL_HWA_FI_SAFE
@ SDL_HWA_FI_SAFE
Definition: hwa/v0/sdl_hwa.h:79
SDL_HWA_DMA0_dedErrorClear
void SDL_HWA_DMA0_dedErrorClear(void)
This API is used to clear DED error from DMA0.
SDL_HWA_DMA1_dedExecute
void SDL_HWA_DMA1_dedExecute(void)
This API is used for DED test on DMA1.
SDL_HWA_DMA1_redErrorClear
void SDL_HWA_DMA1_redErrorClear(void)
This API is used to clear red error from DMA1.
SDL_HWA_DMA0_dedExecute
void SDL_HWA_DMA0_dedExecute(void)
This API is used for DED test on DMA0.
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.
SDL_HWA_FI_INVALID
@ SDL_HWA_FI_INVALID
Definition: hwa/v0/sdl_hwa.h:82
SDL_HWA_DMA0_dedErrorStatus
uint32_t SDL_HWA_DMA0_dedErrorStatus(void)
This API is used to get DED 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.
SDL_HWA_DMA0_redErrorClear
void SDL_HWA_DMA0_redErrorClear(void)
This API is used to clear RED error from DMA0.
SDL_HWA_busSftyFiType
SDL_HWA_busSftyFiType
Definition: hwa/v0/sdl_hwa.h:77
SDL_HWA_DMA1_redErrorStatus
uint32_t SDL_HWA_DMA1_redErrorStatus(void)
This API is used to get RED error status from DMA1.
SDL_HWA_FI_GLOBAL_MAIN
@ SDL_HWA_FI_GLOBAL_MAIN
Definition: hwa/v0/sdl_hwa.h:80
SDL_HWA_MemID
SDL_HWA_MemID
This enumerator defines the HWA IDs.
Definition: sdl_hwa_soc.h:93
SDL_HWA_FI_GLOBAL_SAFE
@ SDL_HWA_FI_GLOBAL_SAFE
Definition: hwa/v0/sdl_hwa.h:81
SDL_HWA_DMA1_secExecute
void SDL_HWA_DMA1_secExecute(void)
This API is used for SEC test on DMA1.
SDL_HWA_MAIN_WRITE_STATUS_INTERFACE
@ SDL_HWA_MAIN_WRITE_STATUS_INTERFACE
Definition: hwa/v0/sdl_hwa.h:89
SDL_HWA_DMA1_dedErrorClear
void SDL_HWA_DMA1_dedErrorClear(void)
This API is used to clear DED 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_secErrorClear
void SDL_HWA_DMA1_secErrorClear(void)
This API is used to clear SEC error from DMA1.
SDL_HWA_DMA0_redErrorStatus
uint32_t SDL_HWA_DMA0_redErrorStatus(void)
This API is used to get RED error status from DMA0.
SDL_HWA_MAIN_WRITE_INTERFACE
@ SDL_HWA_MAIN_WRITE_INTERFACE
Definition: hwa/v0/sdl_hwa.h:88
SDL_HWA_MAIN_READ_INTERFACE
@ SDL_HWA_MAIN_READ_INTERFACE
Definition: hwa/v0/sdl_hwa.h:90
SDL_HWA_DMA0_secExecute
void SDL_HWA_DMA0_secExecute(void)
This API is used for SEC test on DMA0.
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.