SDL API Guide for J721E
sdl_pok.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) Texas Instruments Incorporated 2021
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  */
33 
42 #ifndef SDL_POK_H_
43 #define SDL_POK_H_
44 
45 #include <src/ip/sdl_ip_pok.h>
46 #include <src/ip/sdl_ip_esm.h>
47 #include <osal/sdl_osal.h>
48 
49 #if defined (SOC_J721E)
50 #include <src/sdl/pok/soc/j721e/sdl_soc_pok.h>
51 #endif /* SOC_J721E */
52 
53 #if defined (SOC_J7200)
54 #include <src/sdl/pok/soc/j7200/sdl_soc_pok.h>
55 #include <src/sdl/pok/v1/sdl_pok_v1.h>
56 #endif /* SOC_J7200 */
57 
58 #if defined (SOC_J721S2)
59 #include <src/sdl/pok/soc/j721s2/sdl_soc_pok.h>
60 #include <src/sdl/pok/v1/sdl_pok_v1.h>
61 #endif /* SOC_J721S2 */
62 
63 #if defined (SOC_J784S4)
64 #include <src/sdl/pok/soc/j784s4/sdl_soc_pok.h>
65 #include <src/sdl/pok/v1/sdl_pok_v1.h>
66 #endif /* SOC_J784S4 */
67 
68 #ifdef __cplusplus
69 extern "C" {
70 #endif
71 
90 /* ========================================================================== */
91 /* Structures and Enums */
92 /* ========================================================================== */
93 
94 /* ========================================================================== */
95 /* Function Declarations */
96 /* ========================================================================== */
97 
116 int32_t SDL_POK_getStaticRegisters(SDL_POK_Inst Instance, SDL_POK_staticRegs *pStaticRegs);
117 
127 int32_t SDL_POK_init(SDL_POK_Inst instance, SDL_POK_config *pConfig);
128 
141 int32_t SDL_POK_verifyConfig(SDL_POK_Inst instance, SDL_POK_config *pConfig);
142 
145 #ifdef __cplusplus
146 }
147 #endif
148 #endif /* SDL_POK_H_ */
149 
POK Configuration structure.
Definition: sdl_pok_def.h:457
int32_t SDL_POK_getStaticRegisters(SDL_POK_Inst Instance, SDL_POK_staticRegs *pStaticRegs)
POK Function to get the Static Registers. This function reads the values of the static registers such...
This file contains the SDL OSAL API's.
int32_t SDL_POK_init(SDL_POK_Inst instance, SDL_POK_config *pConfig)
POK module configuration API.
int32_t SDL_POK_verifyConfig(SDL_POK_Inst instance, SDL_POK_config *pConfig)
POK Function to verify the written configuration. This function checks the provided config against th...