AM275 FreeRTOS SDK  10.01.00
sdl_soc_pok.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) Texas Instruments Incorporated 2024
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_SOC_POK_H_
43 #define SDL_SOC_POK_H_
44 #include <sdl/esm/sdl_ip_esm.h>
45 #include <sdl/dpl/sdl_dpl.h>
46 #include <sdl/include/am275x/sdlr_soc_baseaddress.h>
47 #include <sdl/include/am275x/sdlr_mcu_ctrl_mmr.h>
48 #include <sdl/include/am275x/sdlr_intr_wkup_esm0.h>
49 
50 #ifdef __cplusplus
51 extern "C" {
52 #endif
53 
71 /**************************************************************************
72 * Register Macros
73 **************************************************************************/
74 
75 typedef int8_t SDL_POK_Inst ;
76 
78 #define SDL_FIRST_POK_ID (0)
79 /* PMIC POK ID */
80 #define SDL_POK_VDDA_PMIC_IN_ID (SDL_FIRST_POK_ID)
81 /* VDDR CORE Under Voltage/Over Voltage POK ID */
82 #define SDL_POK_VDDR_CORE_ID (1)
83  /* VMON CAP MCU Under Voltage/Over Voltage POK ID */
84 #define SDL_POK_VMON_CAP_MCU_GENERAL_ID (2)
85 /* VDDSHV MAIN 1P8 Under Voltage/Over Voltage POK ID */
86 #define SDL_POK_VDDSHV_MAIN_1P8_ID (3)
87 /* VDDSHV MAIN 3P3 Under Voltage/Over Voltage POK ID */
88 #define SDL_POK_VDDSHV_MAIN_3P3_ID (4)
89 /* CORE Over Voltage POK ID */
90 #define SDL_POK_VDD_MCU_OV_ID (5)
91 /* VDDA MCU Under Voltage POK ID */
92 #define SDL_POR_VDDA_MCU_UV_ID (6)
93 /* VDD Under Voltage POK ID */
94 #define SDL_POR_VDD_MCU_UV_ID (7)
95 /* VDDA MCU Over Voltage POK ID */
96 #define SDL_POR_VDDA_MCU_OV_ID (8)
97 
98 /* LAST POK ID */
99 #define SDL_LAST_POK_ID (SDL_POR_VDDA_MCU_OV_ID)
100 
101 
102 typedef int8_t SDL_PRG_Inst;
103 
105 #define SDL_POK_PRG_FIRST_ID (0)
106 
107 #define SDL_POK_PRG_PP_0_ID (1)
108 
109 #define SDL_POK_PRG_PP_1_ID (2)
110 
112 #define SDL_POK_PRG_LAST_ID (SDL_POK_PRG_PP_1_ID)
113 
114 
115 
116 
117 #define SDL_POK_MMR_BASE (SDL_WKUP_CTRL_MMR1_CFG0_BASE)
118 #define MCU_ESM_INSTANCE (SDL_WKUP_ESM0_CFG_BASE)
119 #define MCU_ESM_INTID (SDLR_WKUP_ESM0_ESM_LVL_EVENT_ESM0_ESM_INT_HI_LVL_0)
120 
121 #define MCU_ESM_ERR_SIG_VDDA_PMIC_IN_UV (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU0_POK_PGOOD_UV_OUT_N_TO_ESM_3)
122 #define MCU_ESM_ERR_SIG_VDD_MCU_UV (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU0_POK_PGOOD_UV_OUT_N_TO_ESM_0 )
123 #define MCU_ESM_ERR_SIG_VDD_MCU_OV (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU0_POK_PGOOD_UV_OUT_N_TO_ESM_4)
124 #define MCU_ESM_ERR_SIG_VDDR_CORE_UV (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU_5POKS0_POK_PGOOD_UV_OUT_N_TO_ESM_3)
125 #define MCU_ESM_ERR_SIG_VDDR_CORE_OV (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU_5POKS0_POK_PGOOD_OV_OUT_N_TO_ESM_3)
126 #define MCU_ESM_ERR_SIG_VMON_CAP_MCU_GENERAL_UV (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU_5POKS0_POK_PGOOD_UV_OUT_N_TO_ESM_2 )
127 #define MCU_ESM_ERR_SIG_VMON_CAP_MCU_GENERAL_OV (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU_5POKS0_POK_PGOOD_OV_OUT_N_TO_ESM_2)
128 #define MCU_ESM_ERR_SIG_VDDSHV_MAIN_1P8_UV (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU_5POKS0_POK_PGOOD_UV_OUT_N_TO_ESM_1)
129 #define MCU_ESM_ERR_SIG_VDDSHV_MAIN_1P8_OV (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU_5POKS0_POK_PGOOD_OV_OUT_N_TO_ESM_1)
130 #define MCU_ESM_ERR_SIG_VDDSHV_MAIN_3P3_UV (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU_5POKS0_POK_PGOOD_UV_OUT_N_TO_ESM_0)
131 #define MCU_ESM_ERR_SIG_VDDSHV_MAIN_3P3_OV (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU_5POKS0_POK_PGOOD_OV_OUT_N_TO_ESM_0)
132 #define MCU_ESM_ERR_SIG_VDDA_MCU_UV (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU0_POK_PGOOD_UV_OUT_N_TO_ESM_2)
133 #define MCU_ESM_ERR_SIG_VDDA_MCU_OV (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU0_POK_PGOOD_UV_OUT_N_TO_ESM_1)
134 
135 
136 
137 #define ESM_ERR_SIG_VDDA_PMIC_IN_UV MCU_ESM_ERR_SIG_VDDA_PMIC_IN_UV
138 #define ESM_ERR_SIG_VDD_MCU_UV MCU_ESM_ERR_SIG_VDD_MCU_UV
139 #define ESM_ERR_SIG_VDD_MCU_OV MCU_ESM_ERR_SIG_VDD_MCU_OV
140 #define ESM_ERR_SIG_VDDR_CORE_UV MCU_ESM_ERR_SIG_VDDR_CORE_UV
141 #define ESM_ERR_SIG_VDDR_CORE_OV MCU_ESM_ERR_SIG_VDDR_CORE_OV
142 #define ESM_ERR_SIG_VMON_CAP_MCU_GENERAL_UV MCU_ESM_ERR_SIG_VMON_CAP_MCU_GENERAL_UV
143 #define ESM_ERR_SIG_VMON_CAP_MCU_GENERAL_OV MCU_ESM_ERR_SIG_VMON_CAP_MCU_GENERAL_OV
144 #define ESM_ERR_SIG_VDDSHV_MAIN_1P8_UV MCU_ESM_ERR_SIG_VDDSHV_MAIN_1P8_UV
145 #define ESM_ERR_SIG_VDDSHV_MAIN_1P8_OV MCU_ESM_ERR_SIG_VDDSHV_MAIN_1P8_OV
146 #define ESM_ERR_SIG_VDDSHV_MAIN_3P3_UV MCU_ESM_ERR_SIG_VDDSHV_MAIN_3P3_UV
147 #define ESM_ERR_SIG_VDDSHV_MAIN_3P3_OV MCU_ESM_ERR_SIG_VDDSHV_MAIN_3P3_OV
148 #define ESM_ERR_SIG_VDDA_MCU_UV MCU_ESM_ERR_SIG_VDDA_MCU_UV
149 #define ESM_ERR_SIG_VDDA_MCU_OV MCU_ESM_ERR_SIG_VDDA_MCU_OV
150 
151 
152 
153 
154 
155 #define ESM_INSTANCE MCU_ESM_INSTANCE
156 #define ESM_INTID MCU_ESM_INTID
157 
158 
159 
160 
161 
162 
163 typedef enum{
165 
167 
168 bool SDL_POK_getBaseaddr(SDL_POK_InstanceType instance, uint32_t *pbaseAddress);
169 
170 
171 
172 
173 #ifdef __cplusplus
174 }
175 #endif
176 #endif /* SDL_SOC_POK_H_ */
177 
178 
SDL_PRG_Inst
int8_t SDL_PRG_Inst
Definition: sdl_soc_pok.h:102
SDL_POK_InstanceType
SDL_POK_InstanceType
Definition: sdl_soc_pok.h:163
sdl_dpl.h
This file contains the SDL DPL API's.
SDL_POK_MCU_CTRL_MMR0
@ SDL_POK_MCU_CTRL_MMR0
Definition: sdl_soc_pok.h:164
SDL_POK_getBaseaddr
bool SDL_POK_getBaseaddr(SDL_POK_InstanceType instance, uint32_t *pbaseAddress)
SDL_POK_Inst
int8_t SDL_POK_Inst
Definition: sdl_soc_pok.h:75