AM64x MCU+ SDK  09.02.01
sdl_soc_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 
42 #ifndef SDL_SOC_POK_H_
43 #define SDL_SOC_POK_H_
44 
45 #include <sdl/esm/v0/v0_0/sdl_ip_esm.h>
46 #include <sdl/dpl/sdl_dpl.h>
47 
48 
49 #include <sdl/include/am64x_am243x/sdlr_soc_baseaddress.h>
50 #include <sdl/include/am64x_am243x/sdlr_mcu_ctrl_mmr.h>
51 
52 
53 #ifdef __cplusplus
54 extern "C" {
55 #endif
56 
74 /**************************************************************************
75 * Register Macros
76 **************************************************************************/
77 
78 typedef int8_t SDL_POK_Inst ;
79 
81 #define SDL_FIRST_POK_ID (0)
82 /* PMIC POK ID */
83 #define SDL_POK_VDDA_PMIC_IN_ID (SDL_FIRST_POK_ID)
84 /* VDDS DDRIO Under Voltage/Over Voltage POK ID */
85 #define SDL_POK_VDDS_DDRIO_ID (1)
86 /* VDDR CORE Under Voltage/Over Voltage POK ID */
87 #define SDL_POK_VDDR_CORE_ID (2)
88 /* VDDSHV MCU 3P3 Under Voltage/Over Voltage POK ID */
89 #define SDL_POK_VDDSHV_MCU_3P3_ID (3)
90 /* VDDSHV MCU 1P8 Under Voltage/Over Voltage POK ID */
91 #define SDL_POK_VDDSHV_MCU_1P8_ID (4)
92  /* VMON CAP MCU Under Voltage/Over Voltage POK ID */
93 #define SDL_POK_VMON_CAP_MCU_GENERAL_ID (5)
94 /* VDDSHV MAIN 1P8 Under Voltage/Over Voltage POK ID */
95 #define SDL_POK_VDDSHV_MAIN_1P8_ID (6)
96 /* VDDSHV MAIN 3P3 Under Voltage/Over Voltage POK ID */
97 #define SDL_POK_VDDSHV_MAIN_3P3_ID (7)
98 /* CORE Over Voltage POK ID */
99 #define SDL_POK_VDD_MCU_OV_ID (8)
100 /* VDDA MCU Under Voltage POK ID */
101 #define SDL_POR_VDDA_MCU_UV_ID (9)
102 /* VDD Under Voltage POK ID */
103 #define SDL_POR_VDD_MCU_UV_ID (10)
104 /* VDDA MCU Over Voltage POK ID */
105 #define SDL_POR_VDDA_MCU_OV_ID (11)
106 
107 /* LAST POK ID */
108 #define SDL_LAST_POK_ID (SDL_POR_VDDA_MCU_OV_ID)
109 
110 
111 typedef int8_t SDL_PRG_Inst;
112 
114 #define SDL_POK_PRG_FIRST_ID (0)
115 
116 #define SDL_POK_PRG_PP_0_ID (1)
117 
118 #define SDL_POK_PRG_PP_1_ID (2)
119 
121 #define SDL_POK_PRG_LAST_ID (SDL_POK_PRG_PP_1_ID)
122 
123 
124 
125 
126 
127 
128 #define SDL_POK_MMR_BASE (SDL_MCU_CTRL_MMR0_CFG0_BASE)
129 
130 #if defined (SOC_AM64X)
131 #if defined (M4F_CORE)
132 #define MCU_ESM_INSTANCE (SDL_MCU_ESM0_CFG_BASE)
133 #define MCU_ESM_INTID (SDLR_MCU_ESM0_ESM_LVL_EVENT_ESM0_ESM_INT_HI_LVL_0)
134 #endif
135 
136 #if defined (R5F_CORE)
137 #define MCU_ESM_INSTANCE (SDL_ESM0_CFG_BASE)
138 #define MCU_ESM_INTID (SDLR_ESM0_ESM_LVL_EVENT_MCU_ESM0_ESM_INT_HI_LVL_0)
139 #endif
140 #endif
141 
142 
143 #define MCU_ESM_ERR_SIG_VDDA_PMIC_IN_UV (SDLR_MCU_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU0_POK_PGOOD_UV_OUT_N_TO_ESM_3)
144 #define MCU_ESM_ERR_SIG_VDD_MCU_UV (SDLR_MCU_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU0_POK_PGOOD_UV_OUT_N_TO_ESM_0)
145 #define MCU_ESM_ERR_SIG_VDD_MCU_OV (SDLR_MCU_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU0_POK_PGOOD_UV_OUT_N_TO_ESM_4)
146 #define MCU_ESM_ERR_SIG_VDDS_DDRIO_UV (SDLR_MCU_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU_7POKS0_POK_PGOOD_UV_OUT_N_TO_ESM_6)
147 #define MCU_ESM_ERR_SIG_VDDS_DDRIO_OV (SDLR_MCU_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU_7POKS0_POK_PGOOD_OV_OUT_N_TO_ESM_6)
148 #define MCU_ESM_ERR_SIG_VDDR_CORE_UV (SDLR_MCU_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU_7POKS0_POK_PGOOD_UV_OUT_N_TO_ESM_5)
149 #define MCU_ESM_ERR_SIG_VDDR_CORE_OV (SDLR_MCU_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU_7POKS0_POK_PGOOD_OV_OUT_N_TO_ESM_5)
150 #define MCU_ESM_ERR_SIG_VDDSHV_MCU_3P3_UV (SDLR_MCU_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU_7POKS0_POK_PGOOD_UV_OUT_N_TO_ESM_4) //- 75
151 #define MCU_ESM_ERR_SIG_VDDSHV_MCU_3P3_OV (SDLR_MCU_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU_7POKS0_POK_PGOOD_OV_OUT_N_TO_ESM_4)// 68
152 #define MCU_ESM_ERR_SIG_VDDSHV_MCU_1P8_UV (SDLR_MCU_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU_7POKS0_POK_PGOOD_UV_OUT_N_TO_ESM_3 ) //74
153 #define MCU_ESM_ERR_SIG_VDDSHV_MCU_1P8_OV (SDLR_MCU_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU_7POKS0_POK_PGOOD_OV_OUT_N_TO_ESM_3)//67
154 #define MCU_ESM_ERR_SIG_VMON_CAP_MCU_GENERAL_UV (SDLR_MCU_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU_7POKS0_POK_PGOOD_UV_OUT_N_TO_ESM_2 )
155 #define MCU_ESM_ERR_SIG_VMON_CAP_MCU_GENERAL_OV (SDLR_MCU_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU_7POKS0_POK_PGOOD_OV_OUT_N_TO_ESM_2)
156 #define MCU_ESM_ERR_SIG_VDDSHV_MAIN_1P8_UV (SDLR_MCU_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU_7POKS0_POK_PGOOD_UV_OUT_N_TO_ESM_1)
157 #define MCU_ESM_ERR_SIG_VDDSHV_MAIN_1P8_OV (SDLR_MCU_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU_7POKS0_POK_PGOOD_OV_OUT_N_TO_ESM_1)
158 #define MCU_ESM_ERR_SIG_VDDSHV_MAIN_3P3_UV (SDLR_MCU_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU_7POKS0_POK_PGOOD_UV_OUT_N_TO_ESM_0)
159 #define MCU_ESM_ERR_SIG_VDDSHV_MAIN_3P3_OV (SDLR_MCU_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU_7POKS0_POK_PGOOD_OV_OUT_N_TO_ESM_0)
160 #define MCU_ESM_ERR_SIG_VDDA_MCU_UV (SDLR_MCU_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU0_POK_PGOOD_UV_OUT_N_TO_ESM_2)
161 #define MCU_ESM_ERR_SIG_VDDA_MCU_OV (SDLR_MCU_ESM0_ESM_PLS_EVENT0_MCU_PRG_MCU0_POK_PGOOD_UV_OUT_N_TO_ESM_1)
162 
163 
164 
165 #define ESM_ERR_SIG_VDDA_PMIC_IN_UV MCU_ESM_ERR_SIG_VDDA_PMIC_IN_UV
166 #define ESM_ERR_SIG_VDD_MCU_UV MCU_ESM_ERR_SIG_VDD_MCU_UV
167 #define ESM_ERR_SIG_VDD_MCU_OV MCU_ESM_ERR_SIG_VDD_MCU_OV
168 #define ESM_ERR_SIG_VDDS_DDRIO_UV MCU_ESM_ERR_SIG_VDDS_DDRIO_UV
169 #define ESM_ERR_SIG_VDDS_DDRIO_OV MCU_ESM_ERR_SIG_VDDS_DDRIO_OV
170 #define ESM_ERR_SIG_VDDR_CORE_UV MCU_ESM_ERR_SIG_VDDR_CORE_UV
171 #define ESM_ERR_SIG_VDDR_CORE_OV MCU_ESM_ERR_SIG_VDDR_CORE_OV
172 #define ESM_ERR_SIG_VDDSHV_MCU_3P3_UV MCU_ESM_ERR_SIG_VDDSHV_MCU_3P3_UV
173 #define ESM_ERR_SIG_VDDSHV_MCU_3P3_OV MCU_ESM_ERR_SIG_VDDSHV_MCU_3P3_OV
174 #define ESM_ERR_SIG_VDDSHV_MCU_1P8_UV MCU_ESM_ERR_SIG_VDDSHV_MCU_1P8_UV
175 #define ESM_ERR_SIG_VDDSHV_MCU_1P8_OV MCU_ESM_ERR_SIG_VDDSHV_MCU_1P8_OV
176 #define ESM_ERR_SIG_VMON_CAP_MCU_GENERAL_UV MCU_ESM_ERR_SIG_VMON_CAP_MCU_GENERAL_UV
177 #define ESM_ERR_SIG_VMON_CAP_MCU_GENERAL_OV MCU_ESM_ERR_SIG_VMON_CAP_MCU_GENERAL_OV
178 #define ESM_ERR_SIG_VDDSHV_MAIN_1P8_UV MCU_ESM_ERR_SIG_VDDSHV_MAIN_1P8_UV
179 #define ESM_ERR_SIG_VDDSHV_MAIN_1P8_OV MCU_ESM_ERR_SIG_VDDSHV_MAIN_1P8_OV
180 #define ESM_ERR_SIG_VDDSHV_MAIN_3P3_UV MCU_ESM_ERR_SIG_VDDSHV_MAIN_3P3_UV
181 #define ESM_ERR_SIG_VDDSHV_MAIN_3P3_OV MCU_ESM_ERR_SIG_VDDSHV_MAIN_3P3_OV
182 #define ESM_ERR_SIG_VDDA_MCU_UV MCU_ESM_ERR_SIG_VDDA_MCU_UV
183 #define ESM_ERR_SIG_VDDA_MCU_OV MCU_ESM_ERR_SIG_VDDA_MCU_OV
184 
185 
186 
187 
188 
189 #define ESM_INSTANCE MCU_ESM_INSTANCE
190 #define ESM_INTID MCU_ESM_INTID
191 
192 
193 
194 
195 
196 
197 typedef enum{
198  SDL_POK_MCU_CTRL_MMR0,
199 
200 }SDL_POK_InstanceType;
201 
202 bool SDL_POK_getBaseaddr(SDL_POK_InstanceType instance, uint32_t *pbaseAddress);
203 
204 
205 
206 
207 #ifdef __cplusplus
208 }
209 #endif
210 #endif /* SDL_SOC_POK_H_ */
211 
212 
SDL_PRG_Inst
int8_t SDL_PRG_Inst
Definition: sdl_soc_pok.h:111
SDL_POK_InstanceType
SDL_POK_InstanceType
Definition: sdl_soc_pok.h:197
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:198
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:78