AM64x MCU+ SDK  10.00.00
sdl_esm.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2023-2024 Texas Instruments Incorporated
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  */
69 #ifndef INCLUDE_SDL_ESM_H_
70 #define INCLUDE_SDL_ESM_H_
71 
72 #include <stdint.h>
73 #include <stdbool.h>
74 #include <sdl/esm/soc/sdl_esm_soc.h>
75 #include <sdl/esm/v0/esm.h>
76 #include <sdl/esm/sdlr_esm.h>
77 
78 #ifdef __cplusplus
79 extern "C" {
80 #endif
81 
82 typedef int32_t SDL_Result;
83 
89 typedef enum {
99 
100 
102 #define SDL_ESM_INTNUMBER_INVALID (0xffffffffu)
103 
105 #define SDL_ESM_INST_INVALID (0xfffffffeu)
106 
108 #define SDL_ESM_ERRORADDR_INVALID (0xffffffffu)
109 
111 #define SDL_ESM_ERRORRAMID_INVALID (0xffffffffu)
112 
114 #define SDL_ESM_ERRORBITOFFSET_INVALID (0xffffffffffffffffu)
115 
117 #define SDL_ESM_ERRORBITGROUP_INVALID (0xffffffffu)
118 
120 #define SDL_ESM_MAX_EVENT_MAP_NUM_WORDS (32u)
121 
130 typedef uint32_t sdlEsmEccErrorSource_t;
131 
133 #define SDL_ESM_ECC_PARAM_MCU_CPU0_SEC_ERROR (1u)
134 
135 #define SDL_ESM_ECC_PARAM_MCU_CPU0_DED_ERROR (2u)
136 
137 #define SDL_ESM_ECC_PARAM_MCU_CPU1_SEC_ERROR (3u)
138 
139 #define SDL_ESM_ECC_PARAM_MCU_CPU1_DED_ERROR (4u)
140 
141 #define SDL_ESM_ECC_PARAM_MCU_CBASS_SEC_ERROR (5u)
142 
143 #define SDL_ESM_ECC_PARAM_MCU_CBASS_DED_ERROR (6u)
144 
148 #define SDL_ESM_ECC_PARAM_MAIN_MSMC_AGGR0_SEC_ERROR (10001u)
149 
150 #define SDL_ESM_ECC_PARAM_MAIN_MSMC_AGGR0_DED_ERROR (10002u)
151 
152 #define SDL_ESM_ECC_PARAM_MAIN_A72_AGGR0_SEC_ERROR (10003u)
153 
154 #define SDL_ESM_ECC_PARAM_MAIN_A72_AGGR0_DED_ERROR (10004u)
155 
156 typedef int32_t (* SDL_ESM_applicationCallback) (SDL_ESM_Inst instance, SDL_ESM_IntType intrType, uint32_t grpChannel, uint32_t index, uint32_t intSrc, void *arg);
157 
164 typedef struct SDL_ESM_Errorconfig_s
165 {
166  uint32_t groupNumber;
168  uint32_t bitNumber;
171 
178 typedef struct SDL_ESM_InitConfig_s
179 {
182  uint32_t enableBitmap[SDL_ESM_MAX_EVENT_MAP_NUM_WORDS];
184  uint32_t priorityBitmap[SDL_ESM_MAX_EVENT_MAP_NUM_WORDS];
186  uint32_t errorpinBitmap[SDL_ESM_MAX_EVENT_MAP_NUM_WORDS];
191  uint32_t pinmininterval;
193 
208 int32_t SDL_ESM_getNErrorStatus(SDL_ESM_Inst instance, uint32_t *pStatus);
209 
224 int32_t SDL_ESM_getStaticRegisters(SDL_ESM_Inst instance, SDL_ESM_staticRegs *pStaticRegs);
225 
239 int32_t SDL_ESM_verifyConfig(SDL_ESM_Inst instance, const SDL_ESM_config *pConfig);
240 
250 int32_t SDL_ESM_clrNError(SDL_ESM_Inst instance);
251 
261 int32_t SDL_ESM_setNError(SDL_ESM_Inst instance);
262 
280 int32_t SDL_ESM_setPinOutMode(SDL_ESM_Inst instance, esmErrOutMode_t pinOutMode);
281 
303 int32_t SDL_ESM_registerECCCallback(SDL_ESM_Inst instance, uint32_t eventBitMap[],
304  SDL_ESM_applicationCallback eccCallback,
305  void *callbackArg);
306 
328 int32_t SDL_ESM_registerCCMCallback(SDL_ESM_Inst instance, uint32_t eventBitMap[],
329  SDL_ESM_applicationCallback ccmCallback,
330  void *callbackArg);
331 
352 int32_t SDL_ESM_init(SDL_ESM_Inst instance, const SDL_ESM_config *pConfig,
353  SDL_ESM_applicationCallback applicationCallback, void *appArg);
354 
361 void SDL_ESM_hiInterruptHandler (void *arg);
362 
369 void SDL_ESM_loInterruptHandler (void *arg);
370 
378 
389 int32_t SDL_ESM_getIntNumber(SDL_ESM_Inst esmInstType,
390  SDL_ESM_IntType esmIntType);
391 
392 
395 #ifdef __cplusplus
396 }
397 #endif /* extern "C" */
398 
399 #endif /* INCLUDE_SDL_ESM_H_ */
SDL_ESM_ErrorConfig_t
ESM error configuration.
Definition: sdl_esm.h:165
SDL_ESM_IntType
SDL_ESM_IntType
Definition: sdl_esm.h:89
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 se...
sdlEsmEccErrorSource_t
uint32_t sdlEsmEccErrorSource_t
Source of the ECC error which maps to the ESM interrupt source.
Definition: sdl_esm.h:130
SDL_ESM_config
ESM init configuration.
Definition: sdl_esm.h:179
index
uint16_t index
Definition: tisci_rm_proxy.h:3
SDL_ESM_INT_TYPE_CFG
@ SDL_ESM_INT_TYPE_CFG
Definition: sdl_esm.h:94
SDL_ESM_staticRegs
ESM static registers list.
Definition: sdl/esm/v0/esm.h:226
SDL_ESM_INT_TYPE_LO
@ SDL_ESM_INT_TYPE_LO
Definition: sdl_esm.h:92
SDL_Result
int32_t SDL_Result
Definition: sdl_esm.h:82
SDL_ESM_registerCCMCallback
int32_t SDL_ESM_registerCCMCallback(SDL_ESM_Inst instance, uint32_t eventBitMap[], SDL_ESM_applicationCallback ccmCallback, void *callbackArg)
There are modules within SDL which will generate ESM errors intentionally in the course of running se...
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.
SDL_ESM_setPinOutMode
int32_t SDL_ESM_setPinOutMode(SDL_ESM_Inst instance, esmErrOutMode_t pinOutMode)
This API is use to set error pin out mode(LEVEL or PWM). This API must be called after the below API-...
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.
SDL_ESM_config::pinmininterval
uint32_t pinmininterval
Definition: sdl_esm.h:191
SDL_ESM_hiInterruptHandler
void SDL_ESM_hiInterruptHandler(void *arg)
Esm Hi Interrupt Handler for MCU Esm Instance.
SDL_ESM_loInterruptHandler
void SDL_ESM_loInterruptHandler(void *arg)
Esm Lo Interrupt Handler for MCU Esm Instance.
SDL_ESM_configInterruptHandler
void SDL_ESM_configInterruptHandler(void *arg)
Esm Config Interrupt Handler for MCU Instance.
SDL_ESM_getIntNumber
int32_t SDL_ESM_getIntNumber(SDL_ESM_Inst esmInstType, SDL_ESM_IntType esmIntType)
Esm get Interrupt Number corresponding to the input interrupt type.
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...
esmErrOutMode_t
uint32_t esmErrOutMode_t
ESM Error Output Mode type.
Definition: sdl/esm/v0/esm.h:110
SDL_ESM_MAX_EVENT_MAP_NUM_WORDS
#define SDL_ESM_MAX_EVENT_MAP_NUM_WORDS
Maximum number of EVENT words.
Definition: sdl_esm.h:120
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 confi...
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.
SDL_ESM_applicationCallback
int32_t(* SDL_ESM_applicationCallback)(SDL_ESM_Inst instance, SDL_ESM_IntType intrType, uint32_t grpChannel, uint32_t index, uint32_t intSrc, void *arg)
Definition: sdl_esm.h:156
SDL_ESM_config::esmErrorConfig
SDL_ESM_ErrorConfig_t esmErrorConfig
Definition: sdl_esm.h:180
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 pr...
SDL_ESM_INT_TYPE_HI
@ SDL_ESM_INT_TYPE_HI
Definition: sdl_esm.h:90
SDL_ESM_INT_TYPE_MAX
@ SDL_ESM_INT_TYPE_MAX
Definition: sdl_esm.h:96
SDL_ESM_ErrorConfig_t::bitNumber
uint32_t bitNumber
Definition: sdl_esm.h:168
SDL_ESM_ErrorConfig_t::groupNumber
uint32_t groupNumber
Definition: sdl_esm.h:166
esm.h
This file contains the prototypes of the APIs present in the device abstraction layer file of ESM....