AM263Px MCU+ SDK: sdl_esm.h Source File

| AM263Px MCU+ SDK 26.00.00 |

sdl_esm.h
Go to the documentation of this file.
1 /********************************************************************
2 * Copyright (C) 2022-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 */
49 #ifndef SDL_ESM_H_
50 #define SDL_ESM_H_
51
52 #ifdef __cplusplus
53 extern "C" {
54 #endif
55 #include <sdl/include/soc_config.h>
56
57 #if defined (IP_VERSION_ESM_V0)
58 #include <sdl/esm/v0/v0_0/sdl_ip_esm.h>
59 #include <sdl/esm/v0/sdl_esm.h>
60 #include <sdl/esm/v0/v0_0/sdl_esm_priv.h>
61 #endif
62
63 #if defined (IP_VERSION_ESM_V2_0)
64 #include <sdl/esm/v2/v2_0/sdl_ip_esm.h>
65 #include <sdl/esm/v2/sdl_esm.h>
66 #include <sdl/esm/v2/v2_0/sdl_esm_priv.h>
67 #endif
68
82 int32_t SDL_ESM_getNErrorStatus(SDL_ESM_Inst instance, uint32_t *pStatus);
83
98 int32_t SDL_ESM_getStaticRegisters(SDL_ESM_Inst instance, SDL_ESM_staticRegs *pStaticRegs);
99
113 int32_t SDL_ESM_verifyConfig(SDL_ESM_Inst instance, const SDL_ESM_config *pConfig);
114
124 int32_t SDL_ESM_clrNError(SDL_ESM_Inst instance);
125
135 int32_t SDL_ESM_setNError(SDL_ESM_Inst instance);
136
158 int32_t SDL_ESM_registerECCCallback(SDL_ESM_Inst instance, uint32_t eventBitMap[],
159 SDL_ESM_applicationCallback eccCallback,
160 void *callbackArg);
161
182 int32_t SDL_ESM_init(SDL_ESM_Inst instance, const SDL_ESM_config *pConfig,
183 SDL_ESM_applicationCallback applicationCallback, void *appArg);
184
187 #ifdef __cplusplus
188 }
189 #endif
190
191 #endif /* SDL_ESM_H_ */
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...
SDL_ESM_config
ESM init configuration.
Definition: esm/v2/sdl_esm.h:180
SDL_ESM_staticRegs
ESM static registers list.
Definition: esm.h:226
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_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.h
Header file contains enumerations, structure definitions and function declarations for SDL Error Sign...
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...
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_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...