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
53 /* Feature check status */
54 #define PM_FEATURE_INVALID -1
55 #define PM_FEATURE_UNCHECKED 0
58 * Firmware FPGA Manager flags
59 * XILINX_ZYNQMP_PM_FPGA_FULL: FPGA full reconfiguration
60 * XILINX_ZYNQMP_PM_FPGA_PARTIAL: FPGA partial reconfiguration
62 #define XILINX_ZYNQMP_PM_FPGA_FULL 0x0U
63 #define XILINX_ZYNQMP_PM_FPGA_PARTIAL BIT(0)
66 PM_GET_API_VERSION = 1,
67 PM_SYSTEM_SHUTDOWN = 12,
73 PM_PM_INIT_FINALIZE = 21,
89 PM_FEATURE_CHECK = 63,
93 /* PMU-FW return status codes */
96 XST_PM_NO_FEATURE = 19,
97 XST_PM_INTERNAL = 2000,
102 XST_PM_ABORT_SUSPEND,
103 XST_PM_MULT_USER = 2008,
107 IOCTL_SD_DLL_RESET = 6,
108 IOCTL_SET_SD_TAPDELAY,
109 IOCTL_SET_PLL_FRAC_MODE,
110 IOCTL_GET_PLL_FRAC_MODE,
111 IOCTL_SET_PLL_FRAC_DATA,
112 IOCTL_GET_PLL_FRAC_DATA,
113 IOCTL_WRITE_GGS = 12,
115 IOCTL_WRITE_PGGS = 14,
116 IOCTL_READ_PGGS = 15,
117 /* Set healthy bit value */
118 IOCTL_SET_BOOT_HEALTH_STATUS = 17,
123 PM_QID_CLOCK_GET_NAME,
124 PM_QID_CLOCK_GET_TOPOLOGY,
125 PM_QID_CLOCK_GET_FIXEDFACTOR_PARAMS,
126 PM_QID_CLOCK_GET_PARENTS,
127 PM_QID_CLOCK_GET_ATTRIBUTES,
128 PM_QID_CLOCK_GET_NUM_CLOCKS = 12,
129 PM_QID_CLOCK_GET_MAX_DIVISOR,
132 enum zynqmp_pm_reset_action {
133 PM_RESET_ACTION_RELEASE,
134 PM_RESET_ACTION_ASSERT,
135 PM_RESET_ACTION_PULSE,
138 enum zynqmp_pm_reset {
139 ZYNQMP_PM_RESET_START = 1000,
140 ZYNQMP_PM_RESET_PCIE_CFG = ZYNQMP_PM_RESET_START,
141 ZYNQMP_PM_RESET_PCIE_BRIDGE,
142 ZYNQMP_PM_RESET_PCIE_CTRL,
144 ZYNQMP_PM_RESET_SWDT_CRF,
145 ZYNQMP_PM_RESET_AFI_FM5,
146 ZYNQMP_PM_RESET_AFI_FM4,
147 ZYNQMP_PM_RESET_AFI_FM3,
148 ZYNQMP_PM_RESET_AFI_FM2,
149 ZYNQMP_PM_RESET_AFI_FM1,
150 ZYNQMP_PM_RESET_AFI_FM0,
151 ZYNQMP_PM_RESET_GDMA,
152 ZYNQMP_PM_RESET_GPU_PP1,
153 ZYNQMP_PM_RESET_GPU_PP0,
156 ZYNQMP_PM_RESET_SATA,
157 ZYNQMP_PM_RESET_ACPU3_PWRON,
158 ZYNQMP_PM_RESET_ACPU2_PWRON,
159 ZYNQMP_PM_RESET_ACPU1_PWRON,
160 ZYNQMP_PM_RESET_ACPU0_PWRON,
161 ZYNQMP_PM_RESET_APU_L2,
162 ZYNQMP_PM_RESET_ACPU3,
163 ZYNQMP_PM_RESET_ACPU2,
164 ZYNQMP_PM_RESET_ACPU1,
165 ZYNQMP_PM_RESET_ACPU0,
167 ZYNQMP_PM_RESET_APM_FPD,
168 ZYNQMP_PM_RESET_SOFT,
169 ZYNQMP_PM_RESET_GEM0,
170 ZYNQMP_PM_RESET_GEM1,
171 ZYNQMP_PM_RESET_GEM2,
172 ZYNQMP_PM_RESET_GEM3,
173 ZYNQMP_PM_RESET_QSPI,
174 ZYNQMP_PM_RESET_UART0,
175 ZYNQMP_PM_RESET_UART1,
176 ZYNQMP_PM_RESET_SPI0,
177 ZYNQMP_PM_RESET_SPI1,
178 ZYNQMP_PM_RESET_SDIO0,
179 ZYNQMP_PM_RESET_SDIO1,
180 ZYNQMP_PM_RESET_CAN0,
181 ZYNQMP_PM_RESET_CAN1,
182 ZYNQMP_PM_RESET_I2C0,
183 ZYNQMP_PM_RESET_I2C1,
184 ZYNQMP_PM_RESET_TTC0,
185 ZYNQMP_PM_RESET_TTC1,
186 ZYNQMP_PM_RESET_TTC2,
187 ZYNQMP_PM_RESET_TTC3,
188 ZYNQMP_PM_RESET_SWDT_CRL,
189 ZYNQMP_PM_RESET_NAND,
190 ZYNQMP_PM_RESET_ADMA,
191 ZYNQMP_PM_RESET_GPIO,
192 ZYNQMP_PM_RESET_IOU_CC,
193 ZYNQMP_PM_RESET_TIMESTAMP,
194 ZYNQMP_PM_RESET_RPU_R50,
195 ZYNQMP_PM_RESET_RPU_R51,
196 ZYNQMP_PM_RESET_RPU_AMBA,
198 ZYNQMP_PM_RESET_RPU_PGE,
199 ZYNQMP_PM_RESET_USB0_CORERESET,
200 ZYNQMP_PM_RESET_USB1_CORERESET,
201 ZYNQMP_PM_RESET_USB0_HIBERRESET,
202 ZYNQMP_PM_RESET_USB1_HIBERRESET,
203 ZYNQMP_PM_RESET_USB0_APB,
204 ZYNQMP_PM_RESET_USB1_APB,
206 ZYNQMP_PM_RESET_APM_LPD,
208 ZYNQMP_PM_RESET_SYSMON,
209 ZYNQMP_PM_RESET_AFI_FM6,
210 ZYNQMP_PM_RESET_LPD_SWDT,
212 ZYNQMP_PM_RESET_RPU_DBG1,
213 ZYNQMP_PM_RESET_RPU_DBG0,
214 ZYNQMP_PM_RESET_DBG_LPD,
215 ZYNQMP_PM_RESET_DBG_FPD,
216 ZYNQMP_PM_RESET_APLL,
217 ZYNQMP_PM_RESET_DPLL,
218 ZYNQMP_PM_RESET_VPLL,
219 ZYNQMP_PM_RESET_IOPLL,
220 ZYNQMP_PM_RESET_RPLL,
221 ZYNQMP_PM_RESET_GPO3_PL_0,
222 ZYNQMP_PM_RESET_GPO3_PL_1,
223 ZYNQMP_PM_RESET_GPO3_PL_2,
224 ZYNQMP_PM_RESET_GPO3_PL_3,
225 ZYNQMP_PM_RESET_GPO3_PL_4,
226 ZYNQMP_PM_RESET_GPO3_PL_5,
227 ZYNQMP_PM_RESET_GPO3_PL_6,
228 ZYNQMP_PM_RESET_GPO3_PL_7,
229 ZYNQMP_PM_RESET_GPO3_PL_8,
230 ZYNQMP_PM_RESET_GPO3_PL_9,
231 ZYNQMP_PM_RESET_GPO3_PL_10,
232 ZYNQMP_PM_RESET_GPO3_PL_11,
233 ZYNQMP_PM_RESET_GPO3_PL_12,
234 ZYNQMP_PM_RESET_GPO3_PL_13,
235 ZYNQMP_PM_RESET_GPO3_PL_14,
236 ZYNQMP_PM_RESET_GPO3_PL_15,
237 ZYNQMP_PM_RESET_GPO3_PL_16,
238 ZYNQMP_PM_RESET_GPO3_PL_17,
239 ZYNQMP_PM_RESET_GPO3_PL_18,
240 ZYNQMP_PM_RESET_GPO3_PL_19,
241 ZYNQMP_PM_RESET_GPO3_PL_20,
242 ZYNQMP_PM_RESET_GPO3_PL_21,
243 ZYNQMP_PM_RESET_GPO3_PL_22,
244 ZYNQMP_PM_RESET_GPO3_PL_23,
245 ZYNQMP_PM_RESET_GPO3_PL_24,
246 ZYNQMP_PM_RESET_GPO3_PL_25,
247 ZYNQMP_PM_RESET_GPO3_PL_26,
248 ZYNQMP_PM_RESET_GPO3_PL_27,
249 ZYNQMP_PM_RESET_GPO3_PL_28,
250 ZYNQMP_PM_RESET_GPO3_PL_29,
251 ZYNQMP_PM_RESET_GPO3_PL_30,
252 ZYNQMP_PM_RESET_GPO3_PL_31,
253 ZYNQMP_PM_RESET_RPU_LS,
254 ZYNQMP_PM_RESET_PS_ONLY,
256 ZYNQMP_PM_RESET_PS_PL0,
257 ZYNQMP_PM_RESET_PS_PL1,
258 ZYNQMP_PM_RESET_PS_PL2,
259 ZYNQMP_PM_RESET_PS_PL3,
260 ZYNQMP_PM_RESET_END = ZYNQMP_PM_RESET_PS_PL3
263 enum zynqmp_pm_suspend_reason {
264 SUSPEND_POWER_REQUEST = 201,
266 SUSPEND_SYSTEM_SHUTDOWN,
269 enum zynqmp_pm_request_ack {
270 ZYNQMP_PM_REQUEST_ACK_NO = 1,
271 ZYNQMP_PM_REQUEST_ACK_BLOCKING,
272 ZYNQMP_PM_REQUEST_ACK_NON_BLOCKING,
280 enum tap_delay_type {
281 PM_TAPDELAY_INPUT = 0,
285 enum dll_reset_type {
287 PM_DLL_RESET_RELEASE,
291 enum zynqmp_pm_shutdown_type {
292 ZYNQMP_PM_SHUTDOWN_TYPE_SHUTDOWN,
293 ZYNQMP_PM_SHUTDOWN_TYPE_RESET,
294 ZYNQMP_PM_SHUTDOWN_TYPE_SETSCOPE_ONLY,
297 enum zynqmp_pm_shutdown_subtype {
298 ZYNQMP_PM_SHUTDOWN_SUBTYPE_SUBSYSTEM,
299 ZYNQMP_PM_SHUTDOWN_SUBTYPE_PS_ONLY,
300 ZYNQMP_PM_SHUTDOWN_SUBTYPE_SYSTEM,
304 * struct zynqmp_pm_query_data - PM query data
306 * @arg1: Argument 1 of query data
307 * @arg2: Argument 2 of query data
308 * @arg3: Argument 3 of query data
310 struct zynqmp_pm_query_data {
318 int zynqmp_pm_invoke_fn(u32 pm_api_id, u32 arg0, u32 arg1,
319 u32 arg2, u32 arg3, u32 *ret_payload);
321 #if IS_REACHABLE(CONFIG_ZYNQMP_FIRMWARE)
322 int zynqmp_pm_get_api_version(u32 *version);
323 int zynqmp_pm_get_chipid(u32 *idcode, u32 *version);
324 int zynqmp_pm_query_data(struct zynqmp_pm_query_data qdata, u32 *out);
325 int zynqmp_pm_clock_enable(u32 clock_id);
326 int zynqmp_pm_clock_disable(u32 clock_id);
327 int zynqmp_pm_clock_getstate(u32 clock_id, u32 *state);
328 int zynqmp_pm_clock_setdivider(u32 clock_id, u32 divider);
329 int zynqmp_pm_clock_getdivider(u32 clock_id, u32 *divider);
330 int zynqmp_pm_clock_setrate(u32 clock_id, u64 rate);
331 int zynqmp_pm_clock_getrate(u32 clock_id, u64 *rate);
332 int zynqmp_pm_clock_setparent(u32 clock_id, u32 parent_id);
333 int zynqmp_pm_clock_getparent(u32 clock_id, u32 *parent_id);
334 int zynqmp_pm_set_pll_frac_mode(u32 clk_id, u32 mode);
335 int zynqmp_pm_get_pll_frac_mode(u32 clk_id, u32 *mode);
336 int zynqmp_pm_set_pll_frac_data(u32 clk_id, u32 data);
337 int zynqmp_pm_get_pll_frac_data(u32 clk_id, u32 *data);
338 int zynqmp_pm_set_sd_tapdelay(u32 node_id, u32 type, u32 value);
339 int zynqmp_pm_sd_dll_reset(u32 node_id, u32 type);
340 int zynqmp_pm_reset_assert(const enum zynqmp_pm_reset reset,
341 const enum zynqmp_pm_reset_action assert_flag);
342 int zynqmp_pm_reset_get_status(const enum zynqmp_pm_reset reset, u32 *status);
343 int zynqmp_pm_init_finalize(void);
344 int zynqmp_pm_set_suspend_mode(u32 mode);
345 int zynqmp_pm_request_node(const u32 node, const u32 capabilities,
346 const u32 qos, const enum zynqmp_pm_request_ack ack);
347 int zynqmp_pm_release_node(const u32 node);
348 int zynqmp_pm_set_requirement(const u32 node, const u32 capabilities,
350 const enum zynqmp_pm_request_ack ack);
351 int zynqmp_pm_aes_engine(const u64 address, u32 *out);
352 int zynqmp_pm_fpga_load(const u64 address, const u32 size, const u32 flags);
353 int zynqmp_pm_fpga_get_status(u32 *value);
354 int zynqmp_pm_write_ggs(u32 index, u32 value);
355 int zynqmp_pm_read_ggs(u32 index, u32 *value);
356 int zynqmp_pm_write_pggs(u32 index, u32 value);
357 int zynqmp_pm_read_pggs(u32 index, u32 *value);
358 int zynqmp_pm_system_shutdown(const u32 type, const u32 subtype);
359 int zynqmp_pm_set_boot_health_status(u32 value);
361 static inline struct zynqmp_eemi_ops *zynqmp_pm_get_eemi_ops(void)
363 return ERR_PTR(-ENODEV);
365 static inline int zynqmp_pm_get_api_version(u32 *version)
369 static inline int zynqmp_pm_get_chipid(u32 *idcode, u32 *version)
373 static inline int zynqmp_pm_query_data(struct zynqmp_pm_query_data qdata,
378 static inline int zynqmp_pm_clock_enable(u32 clock_id)
382 static inline int zynqmp_pm_clock_disable(u32 clock_id)
386 static inline int zynqmp_pm_clock_getstate(u32 clock_id, u32 *state)
390 static inline int zynqmp_pm_clock_setdivider(u32 clock_id, u32 divider)
394 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)
402 static inline int zynqmp_pm_clock_getrate(u32 clock_id, u64 *rate)
406 static inline int zynqmp_pm_clock_setparent(u32 clock_id, u32 parent_id)
410 static inline int zynqmp_pm_clock_getparent(u32 clock_id, u32 *parent_id)
414 static inline int zynqmp_pm_set_pll_frac_mode(u32 clk_id, u32 mode)
418 static inline int zynqmp_pm_get_pll_frac_mode(u32 clk_id, u32 *mode)
422 static inline int zynqmp_pm_set_pll_frac_data(u32 clk_id, u32 data)
426 static inline int zynqmp_pm_get_pll_frac_data(u32 clk_id, u32 *data)
430 static inline int zynqmp_pm_set_sd_tapdelay(u32 node_id, u32 type, u32 value)
434 static inline int zynqmp_pm_sd_dll_reset(u32 node_id, u32 type)
438 static inline int zynqmp_pm_reset_assert(const enum zynqmp_pm_reset reset,
439 const enum zynqmp_pm_reset_action assert_flag)
443 static inline int zynqmp_pm_reset_get_status(const enum zynqmp_pm_reset reset,
448 static inline int zynqmp_pm_init_finalize(void)
452 static inline int zynqmp_pm_set_suspend_mode(u32 mode)
456 static inline int zynqmp_pm_request_node(const u32 node, const u32 capabilities,
458 const enum zynqmp_pm_request_ack ack)
462 static inline int zynqmp_pm_release_node(const u32 node)
466 static inline int zynqmp_pm_set_requirement(const u32 node,
467 const u32 capabilities,
469 const enum zynqmp_pm_request_ack ack)
473 static inline int zynqmp_pm_aes_engine(const u64 address, u32 *out)
477 static inline int zynqmp_pm_fpga_load(const u64 address, const u32 size,
482 static inline int zynqmp_pm_fpga_get_status(u32 *value)
486 static inline int zynqmp_pm_write_ggs(u32 index, u32 value)
490 static inline int zynqmp_pm_read_ggs(u32 index, u32 *value)
494 static inline int zynqmp_pm_write_pggs(u32 index, u32 value)
498 static inline int zynqmp_pm_read_pggs(u32 index, u32 *value)
502 static inline int zynqmp_pm_system_shutdown(const u32 type, const u32 subtype)
506 static inline int zynqmp_pm_set_boot_health_status(u32 value)
512 #endif /* __FIRMWARE_ZYNQMP_H__ */