1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Xilinx Zynq MPSoC Firmware layer
5 * Copyright (C) 2014-2019 Xilinx
7 * Michal Simek <michal.simek@xilinx.com>
8 * Davorin Mista <davorin.mista@aggios.com>
9 * Jolly Shah <jollys@xilinx.com>
10 * Rajan Vaja <rajanv@xilinx.com>
13 #ifndef __FIRMWARE_ZYNQMP_H__
14 #define __FIRMWARE_ZYNQMP_H__
16 #define ZYNQMP_PM_VERSION_MAJOR 1
17 #define ZYNQMP_PM_VERSION_MINOR 0
19 #define ZYNQMP_PM_VERSION ((ZYNQMP_PM_VERSION_MAJOR << 16) | \
20 ZYNQMP_PM_VERSION_MINOR)
22 #define ZYNQMP_TZ_VERSION_MAJOR 1
23 #define ZYNQMP_TZ_VERSION_MINOR 0
25 #define ZYNQMP_TZ_VERSION ((ZYNQMP_TZ_VERSION_MAJOR << 16) | \
26 ZYNQMP_TZ_VERSION_MINOR)
28 /* SMC SIP service Call Function Identifier Prefix */
29 #define PM_SIP_SVC 0xC2000000
30 #define PM_GET_TRUSTZONE_VERSION 0xa03
31 #define PM_SET_SUSPEND_MODE 0xa02
32 #define GET_CALLBACK_DATA 0xa01
34 /* Number of 32bits values in payload */
35 #define PAYLOAD_ARG_CNT 4U
37 /* Number of arguments for a callback */
40 /* Payload size (consists of callback API ID + arguments) */
41 #define CB_PAYLOAD_SIZE (CB_ARG_CNT + 1)
43 #define ZYNQMP_PM_MAX_QOS 100U
45 #define GSS_NUM_REGS (4)
47 /* Node capabilities */
48 #define ZYNQMP_PM_CAPABILITY_ACCESS 0x1U
49 #define ZYNQMP_PM_CAPABILITY_CONTEXT 0x2U
50 #define ZYNQMP_PM_CAPABILITY_WAKEUP 0x4U
51 #define ZYNQMP_PM_CAPABILITY_UNUSABLE 0x8U
54 * Firmware FPGA Manager flags
55 * XILINX_ZYNQMP_PM_FPGA_FULL: FPGA full reconfiguration
56 * XILINX_ZYNQMP_PM_FPGA_PARTIAL: FPGA partial reconfiguration
58 #define XILINX_ZYNQMP_PM_FPGA_FULL 0x0U
59 #define XILINX_ZYNQMP_PM_FPGA_PARTIAL BIT(0)
62 PM_GET_API_VERSION = 1,
63 PM_SYSTEM_SHUTDOWN = 12,
69 PM_PM_INIT_FINALIZE = 21,
85 PM_FEATURE_CHECK = 63,
89 /* PMU-FW return status codes */
92 XST_PM_NO_FEATURE = 19,
93 XST_PM_INTERNAL = 2000,
99 XST_PM_MULT_USER = 2008,
103 IOCTL_SD_DLL_RESET = 6,
104 IOCTL_SET_SD_TAPDELAY,
105 IOCTL_SET_PLL_FRAC_MODE,
106 IOCTL_GET_PLL_FRAC_MODE,
107 IOCTL_SET_PLL_FRAC_DATA,
108 IOCTL_GET_PLL_FRAC_DATA,
109 IOCTL_WRITE_GGS = 12,
111 IOCTL_WRITE_PGGS = 14,
112 IOCTL_READ_PGGS = 15,
113 /* Set healthy bit value */
114 IOCTL_SET_BOOT_HEALTH_STATUS = 17,
119 PM_QID_CLOCK_GET_NAME,
120 PM_QID_CLOCK_GET_TOPOLOGY,
121 PM_QID_CLOCK_GET_FIXEDFACTOR_PARAMS,
122 PM_QID_CLOCK_GET_PARENTS,
123 PM_QID_CLOCK_GET_ATTRIBUTES,
124 PM_QID_CLOCK_GET_NUM_CLOCKS = 12,
125 PM_QID_CLOCK_GET_MAX_DIVISOR,
128 enum zynqmp_pm_reset_action {
129 PM_RESET_ACTION_RELEASE,
130 PM_RESET_ACTION_ASSERT,
131 PM_RESET_ACTION_PULSE,
134 enum zynqmp_pm_reset {
135 ZYNQMP_PM_RESET_START = 1000,
136 ZYNQMP_PM_RESET_PCIE_CFG = ZYNQMP_PM_RESET_START,
137 ZYNQMP_PM_RESET_PCIE_BRIDGE,
138 ZYNQMP_PM_RESET_PCIE_CTRL,
140 ZYNQMP_PM_RESET_SWDT_CRF,
141 ZYNQMP_PM_RESET_AFI_FM5,
142 ZYNQMP_PM_RESET_AFI_FM4,
143 ZYNQMP_PM_RESET_AFI_FM3,
144 ZYNQMP_PM_RESET_AFI_FM2,
145 ZYNQMP_PM_RESET_AFI_FM1,
146 ZYNQMP_PM_RESET_AFI_FM0,
147 ZYNQMP_PM_RESET_GDMA,
148 ZYNQMP_PM_RESET_GPU_PP1,
149 ZYNQMP_PM_RESET_GPU_PP0,
152 ZYNQMP_PM_RESET_SATA,
153 ZYNQMP_PM_RESET_ACPU3_PWRON,
154 ZYNQMP_PM_RESET_ACPU2_PWRON,
155 ZYNQMP_PM_RESET_ACPU1_PWRON,
156 ZYNQMP_PM_RESET_ACPU0_PWRON,
157 ZYNQMP_PM_RESET_APU_L2,
158 ZYNQMP_PM_RESET_ACPU3,
159 ZYNQMP_PM_RESET_ACPU2,
160 ZYNQMP_PM_RESET_ACPU1,
161 ZYNQMP_PM_RESET_ACPU0,
163 ZYNQMP_PM_RESET_APM_FPD,
164 ZYNQMP_PM_RESET_SOFT,
165 ZYNQMP_PM_RESET_GEM0,
166 ZYNQMP_PM_RESET_GEM1,
167 ZYNQMP_PM_RESET_GEM2,
168 ZYNQMP_PM_RESET_GEM3,
169 ZYNQMP_PM_RESET_QSPI,
170 ZYNQMP_PM_RESET_UART0,
171 ZYNQMP_PM_RESET_UART1,
172 ZYNQMP_PM_RESET_SPI0,
173 ZYNQMP_PM_RESET_SPI1,
174 ZYNQMP_PM_RESET_SDIO0,
175 ZYNQMP_PM_RESET_SDIO1,
176 ZYNQMP_PM_RESET_CAN0,
177 ZYNQMP_PM_RESET_CAN1,
178 ZYNQMP_PM_RESET_I2C0,
179 ZYNQMP_PM_RESET_I2C1,
180 ZYNQMP_PM_RESET_TTC0,
181 ZYNQMP_PM_RESET_TTC1,
182 ZYNQMP_PM_RESET_TTC2,
183 ZYNQMP_PM_RESET_TTC3,
184 ZYNQMP_PM_RESET_SWDT_CRL,
185 ZYNQMP_PM_RESET_NAND,
186 ZYNQMP_PM_RESET_ADMA,
187 ZYNQMP_PM_RESET_GPIO,
188 ZYNQMP_PM_RESET_IOU_CC,
189 ZYNQMP_PM_RESET_TIMESTAMP,
190 ZYNQMP_PM_RESET_RPU_R50,
191 ZYNQMP_PM_RESET_RPU_R51,
192 ZYNQMP_PM_RESET_RPU_AMBA,
194 ZYNQMP_PM_RESET_RPU_PGE,
195 ZYNQMP_PM_RESET_USB0_CORERESET,
196 ZYNQMP_PM_RESET_USB1_CORERESET,
197 ZYNQMP_PM_RESET_USB0_HIBERRESET,
198 ZYNQMP_PM_RESET_USB1_HIBERRESET,
199 ZYNQMP_PM_RESET_USB0_APB,
200 ZYNQMP_PM_RESET_USB1_APB,
202 ZYNQMP_PM_RESET_APM_LPD,
204 ZYNQMP_PM_RESET_SYSMON,
205 ZYNQMP_PM_RESET_AFI_FM6,
206 ZYNQMP_PM_RESET_LPD_SWDT,
208 ZYNQMP_PM_RESET_RPU_DBG1,
209 ZYNQMP_PM_RESET_RPU_DBG0,
210 ZYNQMP_PM_RESET_DBG_LPD,
211 ZYNQMP_PM_RESET_DBG_FPD,
212 ZYNQMP_PM_RESET_APLL,
213 ZYNQMP_PM_RESET_DPLL,
214 ZYNQMP_PM_RESET_VPLL,
215 ZYNQMP_PM_RESET_IOPLL,
216 ZYNQMP_PM_RESET_RPLL,
217 ZYNQMP_PM_RESET_GPO3_PL_0,
218 ZYNQMP_PM_RESET_GPO3_PL_1,
219 ZYNQMP_PM_RESET_GPO3_PL_2,
220 ZYNQMP_PM_RESET_GPO3_PL_3,
221 ZYNQMP_PM_RESET_GPO3_PL_4,
222 ZYNQMP_PM_RESET_GPO3_PL_5,
223 ZYNQMP_PM_RESET_GPO3_PL_6,
224 ZYNQMP_PM_RESET_GPO3_PL_7,
225 ZYNQMP_PM_RESET_GPO3_PL_8,
226 ZYNQMP_PM_RESET_GPO3_PL_9,
227 ZYNQMP_PM_RESET_GPO3_PL_10,
228 ZYNQMP_PM_RESET_GPO3_PL_11,
229 ZYNQMP_PM_RESET_GPO3_PL_12,
230 ZYNQMP_PM_RESET_GPO3_PL_13,
231 ZYNQMP_PM_RESET_GPO3_PL_14,
232 ZYNQMP_PM_RESET_GPO3_PL_15,
233 ZYNQMP_PM_RESET_GPO3_PL_16,
234 ZYNQMP_PM_RESET_GPO3_PL_17,
235 ZYNQMP_PM_RESET_GPO3_PL_18,
236 ZYNQMP_PM_RESET_GPO3_PL_19,
237 ZYNQMP_PM_RESET_GPO3_PL_20,
238 ZYNQMP_PM_RESET_GPO3_PL_21,
239 ZYNQMP_PM_RESET_GPO3_PL_22,
240 ZYNQMP_PM_RESET_GPO3_PL_23,
241 ZYNQMP_PM_RESET_GPO3_PL_24,
242 ZYNQMP_PM_RESET_GPO3_PL_25,
243 ZYNQMP_PM_RESET_GPO3_PL_26,
244 ZYNQMP_PM_RESET_GPO3_PL_27,
245 ZYNQMP_PM_RESET_GPO3_PL_28,
246 ZYNQMP_PM_RESET_GPO3_PL_29,
247 ZYNQMP_PM_RESET_GPO3_PL_30,
248 ZYNQMP_PM_RESET_GPO3_PL_31,
249 ZYNQMP_PM_RESET_RPU_LS,
250 ZYNQMP_PM_RESET_PS_ONLY,
252 ZYNQMP_PM_RESET_PS_PL0,
253 ZYNQMP_PM_RESET_PS_PL1,
254 ZYNQMP_PM_RESET_PS_PL2,
255 ZYNQMP_PM_RESET_PS_PL3,
256 ZYNQMP_PM_RESET_END = ZYNQMP_PM_RESET_PS_PL3
259 enum zynqmp_pm_suspend_reason {
260 SUSPEND_POWER_REQUEST = 201,
262 SUSPEND_SYSTEM_SHUTDOWN,
265 enum zynqmp_pm_request_ack {
266 ZYNQMP_PM_REQUEST_ACK_NO = 1,
267 ZYNQMP_PM_REQUEST_ACK_BLOCKING,
268 ZYNQMP_PM_REQUEST_ACK_NON_BLOCKING,
276 enum tap_delay_type {
277 PM_TAPDELAY_INPUT = 0,
281 enum dll_reset_type {
283 PM_DLL_RESET_RELEASE,
287 enum zynqmp_pm_shutdown_type {
288 ZYNQMP_PM_SHUTDOWN_TYPE_SHUTDOWN,
289 ZYNQMP_PM_SHUTDOWN_TYPE_RESET,
290 ZYNQMP_PM_SHUTDOWN_TYPE_SETSCOPE_ONLY,
293 enum zynqmp_pm_shutdown_subtype {
294 ZYNQMP_PM_SHUTDOWN_SUBTYPE_SUBSYSTEM,
295 ZYNQMP_PM_SHUTDOWN_SUBTYPE_PS_ONLY,
296 ZYNQMP_PM_SHUTDOWN_SUBTYPE_SYSTEM,
300 * struct zynqmp_pm_query_data - PM query data
302 * @arg1: Argument 1 of query data
303 * @arg2: Argument 2 of query data
304 * @arg3: Argument 3 of query data
306 struct zynqmp_pm_query_data {
314 int zynqmp_pm_invoke_fn(u32 pm_api_id, u32 arg0, u32 arg1,
315 u32 arg2, u32 arg3, u32 *ret_payload);
317 #if IS_REACHABLE(CONFIG_ZYNQMP_FIRMWARE)
318 int zynqmp_pm_get_api_version(u32 *version);
319 int zynqmp_pm_get_chipid(u32 *idcode, u32 *version);
320 int zynqmp_pm_query_data(struct zynqmp_pm_query_data qdata, u32 *out);
321 int zynqmp_pm_clock_enable(u32 clock_id);
322 int zynqmp_pm_clock_disable(u32 clock_id);
323 int zynqmp_pm_clock_getstate(u32 clock_id, u32 *state);
324 int zynqmp_pm_clock_setdivider(u32 clock_id, u32 divider);
325 int zynqmp_pm_clock_getdivider(u32 clock_id, u32 *divider);
326 int zynqmp_pm_clock_setrate(u32 clock_id, u64 rate);
327 int zynqmp_pm_clock_getrate(u32 clock_id, u64 *rate);
328 int zynqmp_pm_clock_setparent(u32 clock_id, u32 parent_id);
329 int zynqmp_pm_clock_getparent(u32 clock_id, u32 *parent_id);
330 int zynqmp_pm_set_pll_frac_mode(u32 clk_id, u32 mode);
331 int zynqmp_pm_get_pll_frac_mode(u32 clk_id, u32 *mode);
332 int zynqmp_pm_set_pll_frac_data(u32 clk_id, u32 data);
333 int zynqmp_pm_get_pll_frac_data(u32 clk_id, u32 *data);
334 int zynqmp_pm_set_sd_tapdelay(u32 node_id, u32 type, u32 value);
335 int zynqmp_pm_sd_dll_reset(u32 node_id, u32 type);
336 int zynqmp_pm_reset_assert(const enum zynqmp_pm_reset reset,
337 const enum zynqmp_pm_reset_action assert_flag);
338 int zynqmp_pm_reset_get_status(const enum zynqmp_pm_reset reset, u32 *status);
339 int zynqmp_pm_init_finalize(void);
340 int zynqmp_pm_set_suspend_mode(u32 mode);
341 int zynqmp_pm_request_node(const u32 node, const u32 capabilities,
342 const u32 qos, const enum zynqmp_pm_request_ack ack);
343 int zynqmp_pm_release_node(const u32 node);
344 int zynqmp_pm_set_requirement(const u32 node, const u32 capabilities,
346 const enum zynqmp_pm_request_ack ack);
347 int zynqmp_pm_aes_engine(const u64 address, u32 *out);
348 int zynqmp_pm_fpga_load(const u64 address, const u32 size, const u32 flags);
349 int zynqmp_pm_fpga_get_status(u32 *value);
350 int zynqmp_pm_write_ggs(u32 index, u32 value);
351 int zynqmp_pm_read_ggs(u32 index, u32 *value);
352 int zynqmp_pm_write_pggs(u32 index, u32 value);
353 int zynqmp_pm_read_pggs(u32 index, u32 *value);
354 int zynqmp_pm_system_shutdown(const u32 type, const u32 subtype);
355 int zynqmp_pm_set_boot_health_status(u32 value);
357 static inline int zynqmp_pm_get_api_version(u32 *version)
362 static inline int zynqmp_pm_get_chipid(u32 *idcode, u32 *version)
367 static inline int zynqmp_pm_query_data(struct zynqmp_pm_query_data qdata,
373 static inline int zynqmp_pm_clock_enable(u32 clock_id)
378 static inline int zynqmp_pm_clock_disable(u32 clock_id)
383 static inline int zynqmp_pm_clock_getstate(u32 clock_id, u32 *state)
388 static inline int zynqmp_pm_clock_setdivider(u32 clock_id, u32 divider)
393 static inline int zynqmp_pm_clock_getdivider(u32 clock_id, u32 *divider)
398 static inline int zynqmp_pm_clock_setrate(u32 clock_id, u64 rate)
403 static inline int zynqmp_pm_clock_getrate(u32 clock_id, u64 *rate)
408 static inline int zynqmp_pm_clock_setparent(u32 clock_id, u32 parent_id)
413 static inline int zynqmp_pm_clock_getparent(u32 clock_id, u32 *parent_id)
418 static inline int zynqmp_pm_set_pll_frac_mode(u32 clk_id, u32 mode)
423 static inline int zynqmp_pm_get_pll_frac_mode(u32 clk_id, u32 *mode)
428 static inline int zynqmp_pm_set_pll_frac_data(u32 clk_id, u32 data)
433 static inline int zynqmp_pm_get_pll_frac_data(u32 clk_id, u32 *data)
438 static inline int zynqmp_pm_set_sd_tapdelay(u32 node_id, u32 type, u32 value)
443 static inline int zynqmp_pm_sd_dll_reset(u32 node_id, u32 type)
448 static inline int zynqmp_pm_reset_assert(const enum zynqmp_pm_reset reset,
449 const enum zynqmp_pm_reset_action assert_flag)
454 static inline int zynqmp_pm_reset_get_status(const enum zynqmp_pm_reset reset,
460 static inline int zynqmp_pm_init_finalize(void)
465 static inline int zynqmp_pm_set_suspend_mode(u32 mode)
470 static inline int zynqmp_pm_request_node(const u32 node, const u32 capabilities,
472 const enum zynqmp_pm_request_ack ack)
477 static inline int zynqmp_pm_release_node(const u32 node)
482 static inline int zynqmp_pm_set_requirement(const u32 node,
483 const u32 capabilities,
485 const enum zynqmp_pm_request_ack ack)
490 static inline int zynqmp_pm_aes_engine(const u64 address, u32 *out)
495 static inline int zynqmp_pm_fpga_load(const u64 address, const u32 size,
501 static inline int zynqmp_pm_fpga_get_status(u32 *value)
506 static inline int zynqmp_pm_write_ggs(u32 index, u32 value)
511 static inline int zynqmp_pm_read_ggs(u32 index, u32 *value)
516 static inline int zynqmp_pm_write_pggs(u32 index, u32 value)
521 static inline int zynqmp_pm_read_pggs(u32 index, u32 *value)
526 static inline int zynqmp_pm_system_shutdown(const u32 type, const u32 subtype)
531 static inline int zynqmp_pm_set_boot_health_status(u32 value)
537 #endif /* __FIRMWARE_ZYNQMP_H__ */