AM62x MCU+ SDK  09.02.01
pok/v1/sdl_pok.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) Texas Instruments Incorporated 2023
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 
47 #ifndef SDL_POK_H_
48 #define SDL_POK_H_
49 #include <sdl/dpl/sdl_dpl.h>
50 #include <sdl/pok/v1/sdl_pok_def.h>
51 #include <sdl/pok/v1/sdl_ip_pok.h>
52 
53 #ifdef __cplusplus
54 extern "C" {
55 #endif
56 
89 typedef struct SDL_Pok_Static_Reg_read{
90  uint8_t hystCtrl;
92  uint8_t hystCtrlOV;
94  uint8_t voltDetMode;
96  uint8_t trim;
98  uint8_t trimOV;
100  uint8_t deglitch;
102  bool porBGapOK;
107 
118 int32_t SDL_POK_enablePP(SDL_PRG_Inst instance, bool enable);
119 
134 
144 int32_t SDL_POK_init(SDL_POK_Inst instance, SDL_POK_config *pConfig);
145 
159 
162 #ifdef __cplusplus
163 }
164 #endif
165 #endif /* SDL_POK_H_ */
sdl_pok_def.h
Header file containing various enumerations, structure definitions and function declarations for the ...
SDL_POK_staticRegs::porBGapOK
bool porBGapOK
Definition: pok/v1/sdl_pok.h:102
SDL_POK_staticRegs::hystCtrl
uint8_t hystCtrl
Definition: pok/v1/sdl_pok.h:90
SDL_PRG_Inst
int8_t SDL_PRG_Inst
Definition: sdl_soc_pok.h:104
SDL_POK_config
POK Configuration structure.
Definition: sdl_pok_def.h:418
SDL_POK_getStaticRegisters
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...
SDL_POK_staticRegs
POK Static Registers structure.
Definition: pok/v1/sdl_pok.h:89
sdl_dpl.h
This file contains the SDL DPL API's.
SDL_POK_staticRegs::hystCtrlOV
uint8_t hystCtrlOV
Definition: pok/v1/sdl_pok.h:92
SDL_POK_staticRegs::trimOV
uint8_t trimOV
Definition: pok/v1/sdl_pok.h:98
SDL_POK_verifyConfig
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...
SDL_POK_staticRegs::trim
uint8_t trim
Definition: pok/v1/sdl_pok.h:96
SDL_POK_staticRegs::voltDetMode
uint8_t voltDetMode
Definition: pok/v1/sdl_pok.h:94
SDL_POK_staticRegs::deglitch
uint8_t deglitch
Definition: pok/v1/sdl_pok.h:100
SDL_POK_staticRegs::porModuleStatus
uint8_t porModuleStatus
Definition: pok/v1/sdl_pok.h:104
SDL_POK_enablePP
int32_t SDL_POK_enablePP(SDL_PRG_Inst instance, bool enable)
POK Function to enable or disable ping/pong mode for a specified PRG. Only supported for v1 version o...
SDL_POK_init
int32_t SDL_POK_init(SDL_POK_Inst instance, SDL_POK_config *pConfig)
POK module configuration API.
SDL_POK_Inst
int8_t SDL_POK_Inst
Definition: sdl_soc_pok.h:75