1 // SPDX-License-Identifier: GPL-2.0
3 * Xilinx Zynq MPSoC Firmware driver
5 * Copyright (C) 2018-2019 Xilinx, Inc.
13 #include <zynqmp_firmware.h>
14 #include <asm/cache.h>
15 #include <asm/ptrace.h>
17 #if defined(CONFIG_ZYNQMP_IPI)
19 #include <asm/arch/sys_proto.h>
21 #define PMUFW_PAYLOAD_ARG_CNT 8
23 #define XST_PM_NO_ACCESS 2002L
24 #define XST_PM_ALREADY_CONFIGURED 2009L
26 static struct zynqmp_power {
27 struct mbox_chan tx_chan;
28 struct mbox_chan rx_chan;
29 } zynqmp_power __section(".data");
31 #define NODE_ID_LOCATION 5
33 static unsigned int xpm_configobject[] = {
34 /**********************************************************************/
36 2, /* Number of remaining words in the header */
37 1, /* Number of sections included in config object */
38 PM_CONFIG_OBJECT_TYPE_OVERLAY, /* Type of Config object as overlay */
39 /**********************************************************************/
42 PM_CONFIG_SLAVE_SECTION_ID, /* Section ID */
43 1, /* Number of slaves */
45 0, /* Node ID which will be changed below */
46 PM_SLAVE_FLAG_IS_SHAREABLE,
47 PM_CONFIG_IPI_PSU_CORTEXA53_0_MASK |
48 PM_CONFIG_IPI_PSU_CORTEXR5_0_MASK |
49 PM_CONFIG_IPI_PSU_CORTEXR5_1_MASK, /* IPI Mask */
52 static unsigned int xpm_configobject_close[] = {
53 /**********************************************************************/
55 2, /* Number of remaining words in the header */
56 1, /* Number of sections included in config object */
57 PM_CONFIG_OBJECT_TYPE_OVERLAY, /* Type of Config object as overlay */
58 /**********************************************************************/
59 /* SET CONFIG SECTION */
60 PM_CONFIG_SET_CONFIG_SECTION_ID,
61 0U, /* Loading permission to Overlay config object */
64 int zynqmp_pmufw_config_close(void)
66 return zynqmp_pmufw_load_config_object(xpm_configobject_close,
67 sizeof(xpm_configobject_close));
70 int zynqmp_pmufw_node(u32 id)
72 static bool check = true;
73 static bool permission = true;
78 if (zynqmp_pmufw_node(NODE_OCM_BANK_0) == -EACCES) {
79 printf("PMUFW: No permission to change config object\n");
87 /* Record power domain id */
88 xpm_configobject[NODE_ID_LOCATION] = id;
90 return zynqmp_pmufw_load_config_object(xpm_configobject,
91 sizeof(xpm_configobject));
94 static int do_pm_probe(void)
99 ret = uclass_get_device_by_driver(UCLASS_FIRMWARE,
100 DM_DRIVER_GET(zynqmp_power),
103 debug("%s: Probing device failed: %d\n", __func__, ret);
108 static int ipi_req(const u32 *req, size_t req_len, u32 *res, size_t res_maxlen)
110 struct zynqmp_ipi_msg msg;
112 u32 buffer[PAYLOAD_ARG_CNT];
117 if (req_len > PMUFW_PAYLOAD_ARG_CNT ||
118 res_maxlen > PMUFW_PAYLOAD_ARG_CNT)
121 if (!(zynqmp_power.tx_chan.dev) || !(zynqmp_power.rx_chan.dev)) {
127 debug("%s, Sending IPI message with ID: 0x%0x\n", __func__, req[0]);
128 msg.buf = (u32 *)req;
130 ret = mbox_send(&zynqmp_power.tx_chan, &msg);
132 debug("%s: Sending message failed\n", __func__);
137 msg.len = res_maxlen;
138 ret = mbox_recv(&zynqmp_power.rx_chan, &msg, 100);
140 debug("%s: Receiving message failed\n", __func__);
145 unsigned int zynqmp_firmware_version(void)
148 u32 ret_payload[PAYLOAD_ARG_CNT];
149 static u32 pm_api_version = ZYNQMP_PM_VERSION_INVALID;
152 * Get PMU version only once and later
153 * just return stored values instead of
154 * asking PMUFW again.
156 if (pm_api_version == ZYNQMP_PM_VERSION_INVALID) {
158 ret = xilinx_pm_request(PM_GET_API_VERSION, 0, 0, 0, 0,
161 panic("PMUFW is not found - Please load it!\n");
163 pm_api_version = ret_payload[1];
164 if (pm_api_version < ZYNQMP_PM_VERSION)
165 panic("PMUFW version error. Expected: v%d.%d\n",
166 ZYNQMP_PM_VERSION_MAJOR, ZYNQMP_PM_VERSION_MINOR);
169 return pm_api_version;
172 int zynqmp_pm_set_gem_config(u32 node, enum pm_gem_config_type config, u32 value)
176 ret = xilinx_pm_request(PM_IOCTL, node, IOCTL_SET_GEM_CONFIG,
177 config, value, NULL);
179 printf("%s: node %d: set_gem_config %d failed\n",
180 __func__, node, config);
185 int zynqmp_pm_set_sd_config(u32 node, enum pm_sd_config_type config, u32 value)
189 ret = xilinx_pm_request(PM_IOCTL, node, IOCTL_SET_SD_CONFIG,
190 config, value, NULL);
192 printf("%s: node %d: set_sd_config %d failed\n",
193 __func__, node, config);
198 int zynqmp_pm_is_function_supported(const u32 api_id, const u32 id)
202 u32 ret_payload[PAYLOAD_ARG_CNT];
204 /* Input arguments validation */
205 if (id >= 64 || (api_id != PM_IOCTL && api_id != PM_QUERY_DATA))
208 /* Check feature check API version */
209 ret = xilinx_pm_request(PM_FEATURE_CHECK, PM_FEATURE_CHECK, 0, 0, 0,
214 /* Check if feature check version 2 is supported or not */
215 if ((ret_payload[1] & FIRMWARE_VERSION_MASK) == PM_API_VERSION_2) {
217 * Call feature check for IOCTL/QUERY API to get IOCTL ID or
218 * QUERY ID feature status.
221 ret = xilinx_pm_request(PM_FEATURE_CHECK, api_id, 0, 0, 0,
226 bit_mask = &ret_payload[2];
227 if ((bit_mask[(id / 32)] & BIT((id % 32))) == 0)
237 * Send a configuration object to the PMU firmware.
239 * @cfg_obj: Pointer to the configuration object
240 * @size: Size of @cfg_obj in bytes
241 * Return: 0 on success otherwise negative errno.
243 int zynqmp_pmufw_load_config_object(const void *cfg_obj, size_t size)
246 u32 ret_payload[PAYLOAD_ARG_CNT];
248 if (IS_ENABLED(CONFIG_SPL_BUILD))
249 printf("Loading new PMUFW cfg obj (%ld bytes)\n", size);
251 flush_dcache_range((ulong)cfg_obj, (ulong)(cfg_obj + size));
253 err = xilinx_pm_request(PM_SET_CONFIGURATION, (u32)(u64)cfg_obj, 0, 0,
255 if (err == XST_PM_NO_ACCESS) {
259 if (err == XST_PM_ALREADY_CONFIGURED) {
260 debug("PMUFW Node is already configured\n");
265 printf("Cannot load PMUFW configuration object (%d)\n", err);
268 printf("PMUFW returned 0x%08x status!\n", ret_payload[0]);
270 if ((err || ret_payload[0]) && IS_ENABLED(CONFIG_SPL_BUILD))
271 panic("PMUFW config object loading failed in EL3\n");
276 static int zynqmp_power_probe(struct udevice *dev)
280 debug("%s, (dev=%p)\n", __func__, dev);
282 ret = mbox_get_by_name(dev, "tx", &zynqmp_power.tx_chan);
284 debug("%s: Cannot find tx mailbox\n", __func__);
288 ret = mbox_get_by_name(dev, "rx", &zynqmp_power.rx_chan);
290 debug("%s: Cannot find rx mailbox\n", __func__);
294 ret = zynqmp_firmware_version();
295 printf("PMUFW:\tv%d.%d\n",
296 ret >> ZYNQMP_PM_VERSION_MAJOR_SHIFT,
297 ret & ZYNQMP_PM_VERSION_MINOR_MASK);
302 static const struct udevice_id zynqmp_power_ids[] = {
303 { .compatible = "xlnx,zynqmp-power" },
307 U_BOOT_DRIVER(zynqmp_power) = {
308 .name = "zynqmp_power",
309 .id = UCLASS_FIRMWARE,
310 .of_match = zynqmp_power_ids,
311 .probe = zynqmp_power_probe,
315 int __maybe_unused xilinx_pm_request(u32 api_id, u32 arg0, u32 arg1, u32 arg2,
316 u32 arg3, u32 *ret_payload)
318 debug("%s at EL%d, API ID: 0x%0x, 0x%0x, 0x%0x, 0x%0x, 0x%0x\n",
319 __func__, current_el(), api_id, arg0, arg1, arg2, arg3);
321 if (IS_ENABLED(CONFIG_SPL_BUILD) || current_el() == 3) {
322 #if defined(CONFIG_ZYNQMP_IPI)
324 * Use fixed payload and arg size as the EL2 call. The firmware
325 * is capable to handle PMUFW_PAYLOAD_ARG_CNT bytes but the
326 * firmware API is limited by the SMC call size
328 u32 regs[] = {api_id, arg0, arg1, arg2, arg3};
331 if (api_id == PM_FPGA_LOAD) {
332 /* Swap addr_hi/low because of incompatibility */
339 ret = ipi_req(regs, PAYLOAD_ARG_CNT, ret_payload,
348 * Added SIP service call Function Identifier
349 * Make sure to stay in x0 register
353 regs.regs[0] = PM_SIP_SVC | api_id;
354 regs.regs[1] = ((u64)arg1 << 32) | arg0;
355 regs.regs[2] = ((u64)arg3 << 32) | arg2;
360 ret_payload[0] = (u32)regs.regs[0];
361 ret_payload[1] = upper_32_bits(regs.regs[0]);
362 ret_payload[2] = (u32)regs.regs[1];
363 ret_payload[3] = upper_32_bits(regs.regs[1]);
364 ret_payload[4] = (u32)regs.regs[2];
368 return (ret_payload) ? ret_payload[0] : 0;
371 static const struct udevice_id zynqmp_firmware_ids[] = {
372 { .compatible = "xlnx,zynqmp-firmware" },
373 { .compatible = "xlnx,versal-firmware"},
374 { .compatible = "xlnx,versal-net-firmware"},
378 static int zynqmp_firmware_bind(struct udevice *dev)
381 struct udevice *child;
383 if ((IS_ENABLED(CONFIG_SPL_BUILD) &&
384 IS_ENABLED(CONFIG_SPL_POWER_DOMAIN) &&
385 IS_ENABLED(CONFIG_ZYNQMP_POWER_DOMAIN)) ||
386 (!IS_ENABLED(CONFIG_SPL_BUILD) &&
387 IS_ENABLED(CONFIG_ZYNQMP_POWER_DOMAIN))) {
388 ret = device_bind_driver_to_node(dev, "zynqmp_power_domain",
389 "zynqmp_power_domain",
390 dev_ofnode(dev), &child);
392 printf("zynqmp power domain driver is not bound: %d\n", ret);
400 U_BOOT_DRIVER(zynqmp_firmware) = {
401 .id = UCLASS_FIRMWARE,
402 .name = "zynqmp_firmware",
403 .of_match = zynqmp_firmware_ids,
404 .bind = zynqmp_firmware_bind,