AM261x MCU+ SDK: sdl_esm.h Source File

| AM261x MCU+ SDK 26.00.00 |

esm/v2/sdl_esm.h
Go to the documentation of this file.
1 /*
2 * Copyright (C) 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 */
32
70 #ifndef INCLUDE_SDL_ESM_H_
71 #define INCLUDE_SDL_ESM_H_
72
73 #include <stdint.h>
74 #include <stdbool.h>
75 #include <sdl/esm/soc/sdl_esm_soc.h>
76 #include <sdl/esm/v2/esm.h>
77 #include <sdl/esm/sdlr_esm.h>
78
79 #ifdef __cplusplus
80 extern "C" {
81 #endif
82
83 typedef int32_t SDL_Result;
84
90 typedef enum {
91 SDL_ESM_INT_TYPE_HI = 1,
93 SDL_ESM_INT_TYPE_LO = 2,
95 SDL_ESM_INT_TYPE_CFG = 3,
97 SDL_ESM_INT_TYPE_MAX = 4,
99 } SDL_ESM_IntType;
100
101
103 #define SDL_ESM_INTNUMBER_INVALID (0xffffffffu)
104
106 #define SDL_ESM_INST_INVALID (0xfffffffeu)
107
109 #define SDL_ESM_ERRORADDR_INVALID (0xffffffffu)
110
112 #define SDL_ESM_ERRORRAMID_INVALID (0xffffffffu)
113
115 #define SDL_ESM_ERRORBITOFFSET_INVALID (0xffffffffffffffffu)
116
118 #define SDL_ESM_ERRORBITGROUP_INVALID (0xffffffffu)
119
121 #define SDL_ESM_MAX_EVENT_MAP_NUM_WORDS (32u)
122
131 typedef uint32_t sdlEsmEccErrorSource_t;
132
134 #define SDL_ESM_ECC_PARAM_MCU_CPU0_SEC_ERROR (1u)
135
136 #define SDL_ESM_ECC_PARAM_MCU_CPU0_DED_ERROR (2u)
137
138 #define SDL_ESM_ECC_PARAM_MCU_CPU1_SEC_ERROR (3u)
139
140 #define SDL_ESM_ECC_PARAM_MCU_CPU1_DED_ERROR (4u)
141
142 #define SDL_ESM_ECC_PARAM_MCU_CBASS_SEC_ERROR (5u)
143
144 #define SDL_ESM_ECC_PARAM_MCU_CBASS_DED_ERROR (6u)
145
149 #define SDL_ESM_ECC_PARAM_MAIN_MSMC_AGGR0_SEC_ERROR (10001u)
150
151 #define SDL_ESM_ECC_PARAM_MAIN_MSMC_AGGR0_DED_ERROR (10002u)
152
153 #define SDL_ESM_ECC_PARAM_MAIN_A72_AGGR0_SEC_ERROR (10003u)
154
155 #define SDL_ESM_ECC_PARAM_MAIN_A72_AGGR0_DED_ERROR (10004u)
156
157 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);
158
165 typedef struct SDL_ESM_Errorconfig_s
166 {
167 uint32_t groupNumber;
169 uint32_t bitNumber;
171 } SDL_ESM_ErrorConfig_t;
172
179 typedef struct SDL_ESM_InitConfig_s
180 {
181 SDL_ESM_ErrorConfig_t esmErrorConfig;
183 uint32_t enableBitmap[SDL_ESM_MAX_EVENT_MAP_NUM_WORDS];
185 uint32_t priorityBitmap[SDL_ESM_MAX_EVENT_MAP_NUM_WORDS];
187 uint32_t errorpinBitmap[SDL_ESM_MAX_EVENT_MAP_NUM_WORDS];
192 uint32_t enableCriticalBitmap[SDL_ESM_MAX_EVENT_MAP_NUM_WORDS];
194 uint32_t criticalInterruptDelayCounter;
196 uint32_t pinmininterval;
198 } SDL_ESM_config;
199
214 int32_t SDL_ESM_getNErrorStatus(SDL_ESM_Inst instance, uint32_t *pStatus);
215
230 int32_t SDL_ESM_getStaticRegisters(SDL_ESM_Inst instance, SDL_ESM_staticRegs *pStaticRegs);
231
245 int32_t SDL_ESM_verifyConfig(SDL_ESM_Inst instance, const SDL_ESM_config *pConfig);
246
256 int32_t SDL_ESM_clrNError(SDL_ESM_Inst instance);
257
267 int32_t SDL_ESM_setNError(SDL_ESM_Inst instance);
268
286 int32_t SDL_ESM_setPinOutMode(SDL_ESM_Inst instance, esmErrOutMode_t pinOutMode);
287
309 int32_t SDL_ESM_registerECCCallback(SDL_ESM_Inst instance, uint32_t eventBitMap[],
310 SDL_ESM_applicationCallback eccCallback,
311 void *callbackArg);
312
334 int32_t SDL_ESM_registerCCMCallback(SDL_ESM_Inst instance, uint32_t eventBitMap[],
335 SDL_ESM_applicationCallback ccmCallback,
336 void *callbackArg);
337
358 int32_t SDL_ESM_init(SDL_ESM_Inst instance, const SDL_ESM_config *pConfig,
359 SDL_ESM_applicationCallback applicationCallback, void *appArg);
360
367 void SDL_ESM_hiInterruptHandler (void *arg);
368
375 void SDL_ESM_loInterruptHandler (void *arg);
376
383 void SDL_ESM_configInterruptHandler(void *arg);
384
395 int32_t SDL_ESM_getIntNumber(SDL_ESM_Inst esmInstType,
396 SDL_ESM_IntType esmIntType);
397
398
407 int32_t SDL_ESM_getWarmResetReason(void);
408
413 void SDL_ESM_enableESMWarmReset(void);
414
417 #ifdef __cplusplus
418 }
419 #endif /* extern "C" */
420
421 #endif /* INCLUDE_SDL_ESM_H_ */
SDL_ESM_ErrorConfig_t
ESM error configuration.
Definition: esm/v2/sdl_esm.h:166
SDL_ESM_IntType
SDL_ESM_IntType
Definition: esm/v2/sdl_esm.h:90
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: esm/v2/sdl_esm.h:131
SDL_ESM_config
ESM init configuration.
Definition: esm/v2/sdl_esm.h:180
SDL_ESM_INT_TYPE_CFG
@ SDL_ESM_INT_TYPE_CFG
Definition: esm/v2/sdl_esm.h:95
SDL_ESM_staticRegs
ESM static registers list.
Definition: esm.h:226
esm.h
This file contains the prototypes of the APIs present in the device abstraction layer file of ESM....
SDL_ESM_INT_TYPE_LO
@ SDL_ESM_INT_TYPE_LO
Definition: esm/v2/sdl_esm.h:93
SDL_Result
int32_t SDL_Result
Definition: esm/v2/sdl_esm.h:83
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: esm/v2/sdl_esm.h:196
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_enableESMWarmReset
void SDL_ESM_enableESMWarmReset(void)
Enable ESM warm reset reason.
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: esm.h:111
SDL_ESM_MAX_EVENT_MAP_NUM_WORDS
#define SDL_ESM_MAX_EVENT_MAP_NUM_WORDS
Maximum number of EVENT words.
Definition: esm/v2/sdl_esm.h:121
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_Inst
SDL_ESM_Inst
Definition: sdl_esm_soc.h:65
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: esm/v2/sdl_esm.h:157
SDL_ESM_config::esmErrorConfig
SDL_ESM_ErrorConfig_t esmErrorConfig
Definition: esm/v2/sdl_esm.h:181
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: esm/v2/sdl_esm.h:91
SDL_ESM_INT_TYPE_MAX
@ SDL_ESM_INT_TYPE_MAX
Definition: esm/v2/sdl_esm.h:97
SDL_ESM_ErrorConfig_t::bitNumber
uint32_t bitNumber
Definition: esm/v2/sdl_esm.h:169
SDL_ESM_config::criticalInterruptDelayCounter
uint32_t criticalInterruptDelayCounter
Definition: esm/v2/sdl_esm.h:194
SDL_ESM_ErrorConfig_t::groupNumber
uint32_t groupNumber
Definition: esm/v2/sdl_esm.h:167
SDL_ESM_getWarmResetReason
int32_t SDL_ESM_getWarmResetReason(void)
Get the warm reset reason if it is generated by ESM.