Merge tag 'xilinx-for-v2020.01' of https://gitlab.denx.de/u-boot/custodians/u-boot...
[platform/kernel/u-boot.git] / drivers / firmware / firmware-zynqmp.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Xilinx Zynq MPSoC Firmware driver
4  *
5  * Copyright (C) 2018-2019 Xilinx, Inc.
6  */
7
8 #include <common.h>
9 #include <dm.h>
10
11 #if defined(CONFIG_ZYNQMP_IPI)
12 #include <mailbox.h>
13 #include <zynqmp_firmware.h>
14 #include <asm/arch/sys_proto.h>
15
16 #define PMUFW_PAYLOAD_ARG_CNT   8
17
18 struct zynqmp_power {
19         struct mbox_chan tx_chan;
20         struct mbox_chan rx_chan;
21 } zynqmp_power;
22
23 static int ipi_req(const u32 *req, size_t req_len, u32 *res, size_t res_maxlen)
24 {
25         struct zynqmp_ipi_msg msg;
26         int ret;
27
28         if (req_len > PMUFW_PAYLOAD_ARG_CNT ||
29             res_maxlen > PMUFW_PAYLOAD_ARG_CNT)
30                 return -EINVAL;
31
32         if (!(zynqmp_power.tx_chan.dev) || !(&zynqmp_power.rx_chan.dev))
33                 return -EINVAL;
34
35         msg.buf = (u32 *)req;
36         msg.len = req_len;
37         ret = mbox_send(&zynqmp_power.tx_chan, &msg);
38         if (ret) {
39                 debug("%s: Sending message failed\n", __func__);
40                 return ret;
41         }
42
43         msg.buf = res;
44         msg.len = res_maxlen;
45         ret = mbox_recv(&zynqmp_power.rx_chan, &msg, 100);
46         if (ret)
47                 debug("%s: Receiving message failed\n", __func__);
48
49         return ret;
50 }
51
52 static int send_req(const u32 *req, size_t req_len, u32 *res, size_t res_maxlen)
53 {
54         if (IS_ENABLED(CONFIG_SPL_BUILD))
55                 return ipi_req(req, req_len, res, res_maxlen);
56
57         return invoke_smc(req[0] + PM_SIP_SVC, 0, 0, 0, 0, res);
58 }
59
60 unsigned int zynqmp_firmware_version(void)
61 {
62         int ret;
63         u32 ret_payload[PAYLOAD_ARG_CNT];
64         static u32 pm_api_version = ZYNQMP_PM_VERSION_INVALID;
65
66         /*
67          * Get PMU version only once and later
68          * just return stored values instead of
69          * asking PMUFW again.
70          **/
71         if (pm_api_version == ZYNQMP_PM_VERSION_INVALID) {
72                 const u32 request[] = { PM_GET_API_VERSION };
73
74                 ret = send_req(request, ARRAY_SIZE(request), ret_payload, 2);
75                 if (ret)
76                         panic("PMUFW is not found - Please load it!\n");
77
78                 pm_api_version = ret_payload[1];
79                 if (pm_api_version < ZYNQMP_PM_VERSION)
80                         panic("PMUFW version error. Expected: v%d.%d\n",
81                               ZYNQMP_PM_VERSION_MAJOR, ZYNQMP_PM_VERSION_MINOR);
82         }
83
84         return pm_api_version;
85 };
86
87 /**
88  * Send a configuration object to the PMU firmware.
89  *
90  * @cfg_obj: Pointer to the configuration object
91  * @size:    Size of @cfg_obj in bytes
92  */
93 void zynqmp_pmufw_load_config_object(const void *cfg_obj, size_t size)
94 {
95         const u32 request[] = {
96                 PM_SET_CONFIGURATION,
97                 (u32)((u64)cfg_obj)
98         };
99         u32 response;
100         int err;
101
102         printf("Loading new PMUFW cfg obj (%ld bytes)\n", size);
103
104         err = send_req(request, ARRAY_SIZE(request), &response, 1);
105         if (err)
106                 panic("Cannot load PMUFW configuration object (%d)\n", err);
107         if (response != 0)
108                 panic("PMUFW returned 0x%08x status!\n", response);
109 }
110
111 static int zynqmp_power_probe(struct udevice *dev)
112 {
113         int ret = 0;
114
115         debug("%s, (dev=%p)\n", __func__, dev);
116
117         ret = mbox_get_by_name(dev, "tx", &zynqmp_power.tx_chan);
118         if (ret) {
119                 debug("%s, cannot tx mailbox\n", __func__);
120                 return ret;
121         }
122
123         ret = mbox_get_by_name(dev, "rx", &zynqmp_power.rx_chan);
124         if (ret) {
125                 debug("%s, cannot rx mailbox\n", __func__);
126                 return ret;
127         }
128
129         ret = zynqmp_firmware_version();
130         printf("PMUFW:\tv%d.%d\n",
131                ret >> ZYNQMP_PM_VERSION_MAJOR_SHIFT,
132                ret & ZYNQMP_PM_VERSION_MINOR_MASK);
133
134         return 0;
135 };
136
137 static const struct udevice_id zynqmp_power_ids[] = {
138         { .compatible = "xlnx,zynqmp-power" },
139         { }
140 };
141
142 U_BOOT_DRIVER(zynqmp_power) = {
143         .name = "zynqmp_power",
144         .id = UCLASS_FIRMWARE,
145         .of_match = zynqmp_power_ids,
146         .probe = zynqmp_power_probe,
147 };
148 #endif
149
150 static const struct udevice_id zynqmp_firmware_ids[] = {
151         { .compatible = "xlnx,zynqmp-firmware" },
152         { .compatible = "xlnx,versal-firmware"},
153         { }
154 };
155
156 U_BOOT_DRIVER(zynqmp_firmware) = {
157         .id = UCLASS_FIRMWARE,
158         .name = "zynqmp-firmware",
159         .probe = dm_scan_fdt_dev,
160         .of_match = zynqmp_firmware_ids,
161 };