blob: 5dcceaea258187b6ee03a3f79d513225ee8ee6d2 [file] [log] [blame]
Soren Brinkmann76fcae32016-03-06 20:16:27 -08001/*
Venkatesh Yadav Abbarapu35a8be92019-04-04 14:23:32 +05302 * Copyright (c) 2013-2020, ARM Limited and Contributors. All rights reserved.
Soren Brinkmann76fcae32016-03-06 20:16:27 -08003 *
dp-armfa3cf0b2017-05-03 09:38:09 +01004 * SPDX-License-Identifier: BSD-3-Clause
Soren Brinkmann76fcae32016-03-06 20:16:27 -08005 */
6
Jolly Shah259afe52019-01-09 12:37:57 -08007
Isla Mitchelle3631462017-07-14 10:46:32 +01008#include <arch_helpers.h>
Jolly Shah259afe52019-01-09 12:37:57 -08009
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000010#include <lib/bakery_lock.h>
11#include <lib/mmio.h>
Jolly Shahc2583ab2019-01-08 11:31:49 -080012
13#include <ipi.h>
Jolly Shah4c172372019-01-08 11:21:29 -080014#include <plat_ipi.h>
Jolly Shah0bfd7002019-01-08 11:10:47 -080015#include <plat_private.h>
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000016#include <plat/common/platform.h>
17
Isla Mitchelle3631462017-07-14 10:46:32 +010018#include "pm_ipi.h"
Soren Brinkmann76fcae32016-03-06 20:16:27 -080019
Tejas Patelaf4b10e2018-02-09 02:42:59 -080020
Ravi Patel65123712020-11-23 04:19:08 -080021#define ERROR_CODE_MASK 0xFFFFU
22
Stefan Krsmanovicc5e9f662016-05-20 15:51:08 +020023DEFINE_BAKERY_LOCK(pm_secure_lock);
Soren Brinkmann76fcae32016-03-06 20:16:27 -080024
Soren Brinkmann76fcae32016-03-06 20:16:27 -080025/**
Jolly Shah9bb628d2019-01-07 12:53:32 -080026 * pm_ipi_init() - Initialize IPI peripheral for communication with
27 * remote processor
Soren Brinkmann76fcae32016-03-06 20:16:27 -080028 *
Wendy Liang328105c2017-10-03 23:21:11 -070029 * @proc Pointer to the processor who is initiating request
Soren Brinkmann76fcae32016-03-06 20:16:27 -080030 * @return On success, the initialization function must return 0.
31 * Any other return value will cause the framework to ignore
32 * the service
33 *
Soren Brinkmann76fcae32016-03-06 20:16:27 -080034 * Called from pm_setup initialization function
35 */
Wendy Liang328105c2017-10-03 23:21:11 -070036int pm_ipi_init(const struct pm_proc *proc)
Soren Brinkmann76fcae32016-03-06 20:16:27 -080037{
38 bakery_lock_init(&pm_secure_lock);
Jolly Shah36c930b2019-01-07 12:51:40 -080039 ipi_mb_open(proc->ipi->local_ipi_id, proc->ipi->remote_ipi_id);
Soren Brinkmann76fcae32016-03-06 20:16:27 -080040
41 return 0;
42}
43
44/**
Jolly Shah9bb628d2019-01-07 12:53:32 -080045 * pm_ipi_send_common() - Sends IPI request to the remote processor
Soren Brinkmann76fcae32016-03-06 20:16:27 -080046 * @proc Pointer to the processor who is initiating request
47 * @payload API id and call arguments to be written in IPI buffer
48 *
49 * Send an IPI request to the power controller. Caller needs to hold
50 * the 'pm_secure_lock' lock.
51 *
52 * @return Returns status, either success or error+reason
53 */
54static enum pm_ret_status pm_ipi_send_common(const struct pm_proc *proc,
Tejas Patelaf4b10e2018-02-09 02:42:59 -080055 uint32_t payload[PAYLOAD_ARG_CNT],
56 uint32_t is_blocking)
Soren Brinkmann76fcae32016-03-06 20:16:27 -080057{
58 unsigned int offset = 0;
59 uintptr_t buffer_base = proc->ipi->buffer_base +
Jolly Shah9bb628d2019-01-07 12:53:32 -080060 IPI_BUFFER_TARGET_REMOTE_OFFSET +
Soren Brinkmann76fcae32016-03-06 20:16:27 -080061 IPI_BUFFER_REQ_OFFSET;
Venkatesh Yadav Abbarapu35a8be92019-04-04 14:23:32 +053062#if ZYNQMP_IPI_CRC_CHECK
63 payload[PAYLOAD_CRC_POS] = calculate_crc(payload, IPI_W0_TO_W6_SIZE);
64#endif
Soren Brinkmann76fcae32016-03-06 20:16:27 -080065
Soren Brinkmann76fcae32016-03-06 20:16:27 -080066 /* Write payload into IPI buffer */
67 for (size_t i = 0; i < PAYLOAD_ARG_CNT; i++) {
68 mmio_write_32(buffer_base + offset, payload[i]);
69 offset += PAYLOAD_ARG_SIZE;
70 }
Tejas Patelaf4b10e2018-02-09 02:42:59 -080071
Jolly Shah9bb628d2019-01-07 12:53:32 -080072 /* Generate IPI to remote processor */
Jolly Shah36c930b2019-01-07 12:51:40 -080073 ipi_mb_notify(proc->ipi->local_ipi_id, proc->ipi->remote_ipi_id,
Tejas Patelaf4b10e2018-02-09 02:42:59 -080074 is_blocking);
Soren Brinkmann76fcae32016-03-06 20:16:27 -080075
76 return PM_RET_SUCCESS;
77}
78
79/**
Jolly Shah9bb628d2019-01-07 12:53:32 -080080 * pm_ipi_send_non_blocking() - Sends IPI request to the remote processor
81 * without blocking notification
Tejas Patelaf4b10e2018-02-09 02:42:59 -080082 * @proc Pointer to the processor who is initiating request
83 * @payload API id and call arguments to be written in IPI buffer
84 *
85 * Send an IPI request to the power controller.
86 *
87 * @return Returns status, either success or error+reason
88 */
89enum pm_ret_status pm_ipi_send_non_blocking(const struct pm_proc *proc,
90 uint32_t payload[PAYLOAD_ARG_CNT])
91{
92 enum pm_ret_status ret;
93
94 bakery_lock_get(&pm_secure_lock);
95
96 ret = pm_ipi_send_common(proc, payload, IPI_NON_BLOCKING);
97
98 bakery_lock_release(&pm_secure_lock);
99
100 return ret;
101}
102
103/**
Jolly Shah9bb628d2019-01-07 12:53:32 -0800104 * pm_ipi_send() - Sends IPI request to the remote processor
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800105 * @proc Pointer to the processor who is initiating request
106 * @payload API id and call arguments to be written in IPI buffer
107 *
108 * Send an IPI request to the power controller.
109 *
110 * @return Returns status, either success or error+reason
111 */
112enum pm_ret_status pm_ipi_send(const struct pm_proc *proc,
113 uint32_t payload[PAYLOAD_ARG_CNT])
114{
115 enum pm_ret_status ret;
116
117 bakery_lock_get(&pm_secure_lock);
118
Tejas Patelaf4b10e2018-02-09 02:42:59 -0800119 ret = pm_ipi_send_common(proc, payload, IPI_BLOCKING);
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800120
121 bakery_lock_release(&pm_secure_lock);
122
123 return ret;
124}
125
126
127/**
Jolly Shah9bb628d2019-01-07 12:53:32 -0800128 * pm_ipi_buff_read() - Reads IPI response after remote processor has handled
129 * interrupt
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800130 * @proc Pointer to the processor who is waiting and reading response
Soren Brinkmannd6c9e032016-09-22 11:35:47 -0700131 * @value Used to return value from IPI buffer element (optional)
132 * @count Number of values to return in @value
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800133 *
134 * @return Returns status, either success or error+reason
135 */
136static enum pm_ret_status pm_ipi_buff_read(const struct pm_proc *proc,
Soren Brinkmannd6c9e032016-09-22 11:35:47 -0700137 unsigned int *value, size_t count)
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800138{
Soren Brinkmannd6c9e032016-09-22 11:35:47 -0700139 size_t i;
Venkatesh Yadav Abbarapu35a8be92019-04-04 14:23:32 +0530140#if ZYNQMP_IPI_CRC_CHECK
141 size_t j;
142 unsigned int response_payload[PAYLOAD_ARG_CNT];
143#endif
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800144 uintptr_t buffer_base = proc->ipi->buffer_base +
Jolly Shah9bb628d2019-01-07 12:53:32 -0800145 IPI_BUFFER_TARGET_REMOTE_OFFSET +
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800146 IPI_BUFFER_RESP_OFFSET;
147
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800148 /*
149 * Read response from IPI buffer
150 * buf-0: success or error+reason
151 * buf-1: value
152 * buf-2: unused
153 * buf-3: unused
154 */
Soren Brinkmannd6c9e032016-09-22 11:35:47 -0700155 for (i = 1; i <= count; i++) {
156 *value = mmio_read_32(buffer_base + (i * PAYLOAD_ARG_SIZE));
157 value++;
158 }
Venkatesh Yadav Abbarapu35a8be92019-04-04 14:23:32 +0530159#if ZYNQMP_IPI_CRC_CHECK
160 for (j = 0; j < PAYLOAD_ARG_CNT; j++)
161 response_payload[j] = mmio_read_32(buffer_base +
162 (j * PAYLOAD_ARG_SIZE));
163
164 if (response_payload[PAYLOAD_CRC_POS] !=
165 calculate_crc(response_payload, IPI_W0_TO_W6_SIZE))
166 NOTICE("ERROR in CRC response payload value:0x%x\n",
167 response_payload[PAYLOAD_CRC_POS]);
168#endif
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800169
170 return mmio_read_32(buffer_base);
171}
172
173/**
Jolly Shah9bb628d2019-01-07 12:53:32 -0800174 * pm_ipi_buff_read_callb() - Reads IPI response after remote processor has
175 * handled interrupt
Soren Brinkmann84f0af42016-09-30 14:24:25 -0700176 * @value Used to return value from IPI buffer element (optional)
177 * @count Number of values to return in @value
178 *
179 * @return Returns status, either success or error+reason
180 */
181void pm_ipi_buff_read_callb(unsigned int *value, size_t count)
182{
183 size_t i;
Venkatesh Yadav Abbarapu35a8be92019-04-04 14:23:32 +0530184#if ZYNQMP_IPI_CRC_CHECK
185 size_t j;
186 unsigned int response_payload[PAYLOAD_ARG_CNT];
187#endif
Jolly Shah9bb628d2019-01-07 12:53:32 -0800188 uintptr_t buffer_base = IPI_BUFFER_REMOTE_BASE +
189 IPI_BUFFER_TARGET_LOCAL_OFFSET +
Soren Brinkmann84f0af42016-09-30 14:24:25 -0700190 IPI_BUFFER_REQ_OFFSET;
191
192 if (count > IPI_BUFFER_MAX_WORDS)
193 count = IPI_BUFFER_MAX_WORDS;
194
195 for (i = 0; i <= count; i++) {
196 *value = mmio_read_32(buffer_base + (i * PAYLOAD_ARG_SIZE));
197 value++;
198 }
Venkatesh Yadav Abbarapu35a8be92019-04-04 14:23:32 +0530199#if ZYNQMP_IPI_CRC_CHECK
200 for (j = 0; j < PAYLOAD_ARG_CNT; j++)
201 response_payload[j] = mmio_read_32(buffer_base +
202 (j * PAYLOAD_ARG_SIZE));
203
204 if (response_payload[PAYLOAD_CRC_POS] !=
205 calculate_crc(response_payload, IPI_W0_TO_W6_SIZE))
206 NOTICE("ERROR in CRC response payload value:0x%x\n",
207 response_payload[PAYLOAD_CRC_POS]);
208#endif
Soren Brinkmann84f0af42016-09-30 14:24:25 -0700209}
210
211/**
Jolly Shah9bb628d2019-01-07 12:53:32 -0800212 * pm_ipi_send_sync() - Sends IPI request to the remote processor
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800213 * @proc Pointer to the processor who is initiating request
214 * @payload API id and call arguments to be written in IPI buffer
Soren Brinkmannd6c9e032016-09-22 11:35:47 -0700215 * @value Used to return value from IPI buffer element (optional)
216 * @count Number of values to return in @value
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800217 *
218 * Send an IPI request to the power controller and wait for it to be handled.
219 *
220 * @return Returns status, either success or error+reason and, optionally,
221 * @value
222 */
223enum pm_ret_status pm_ipi_send_sync(const struct pm_proc *proc,
224 uint32_t payload[PAYLOAD_ARG_CNT],
Soren Brinkmannd6c9e032016-09-22 11:35:47 -0700225 unsigned int *value, size_t count)
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800226{
227 enum pm_ret_status ret;
228
229 bakery_lock_get(&pm_secure_lock);
230
Tejas Patelaf4b10e2018-02-09 02:42:59 -0800231 ret = pm_ipi_send_common(proc, payload, IPI_BLOCKING);
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800232 if (ret != PM_RET_SUCCESS)
233 goto unlock;
234
Ravi Patel65123712020-11-23 04:19:08 -0800235 ret = ERROR_CODE_MASK & (pm_ipi_buff_read(proc, value, count));
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800236
237unlock:
238 bakery_lock_release(&pm_secure_lock);
239
240 return ret;
241}
Soren Brinkmanna1b0a902016-09-30 11:30:21 -0700242
Wendy Liang328105c2017-10-03 23:21:11 -0700243void pm_ipi_irq_enable(const struct pm_proc *proc)
Soren Brinkmanna1b0a902016-09-30 11:30:21 -0700244{
Jolly Shah36c930b2019-01-07 12:51:40 -0800245 ipi_mb_enable_irq(proc->ipi->local_ipi_id, proc->ipi->remote_ipi_id);
Soren Brinkmanna1b0a902016-09-30 11:30:21 -0700246}
Soren Brinkmann84f0af42016-09-30 14:24:25 -0700247
Wendy Liang328105c2017-10-03 23:21:11 -0700248void pm_ipi_irq_clear(const struct pm_proc *proc)
Soren Brinkmann84f0af42016-09-30 14:24:25 -0700249{
Jolly Shah36c930b2019-01-07 12:51:40 -0800250 ipi_mb_ack(proc->ipi->local_ipi_id, proc->ipi->remote_ipi_id);
Soren Brinkmann84f0af42016-09-30 14:24:25 -0700251}
Jolly Shah259afe52019-01-09 12:37:57 -0800252
253uint32_t pm_ipi_irq_status(const struct pm_proc *proc)
254{
255 int ret;
256
257 ret = ipi_mb_enquire_status(proc->ipi->local_ipi_id,
258 proc->ipi->remote_ipi_id);
259 if (ret & IPI_MB_STATUS_RECV_PENDING)
260 return 1;
261 else
262 return 0;
263}
Venkatesh Yadav Abbarapu35a8be92019-04-04 14:23:32 +0530264
265#if ZYNQMP_IPI_CRC_CHECK
266uint32_t calculate_crc(uint32_t *payload, uint32_t bufsize)
267{
268 uint32_t crcinit = CRC_INIT_VALUE;
269 uint32_t order = CRC_ORDER;
270 uint32_t polynom = CRC_POLYNOM;
271 uint32_t i, j, c, bit, datain, crcmask, crchighbit;
272 uint32_t crc = crcinit;
273
274 crcmask = ((uint32_t)((1U << (order - 1U)) - 1U) << 1U) | 1U;
275 crchighbit = (uint32_t)(1U << (order - 1U));
276
277 for (i = 0U; i < bufsize; i++) {
278 datain = mmio_read_8((unsigned long)payload + i);
279 c = datain;
280 j = 0x80U;
281 while (j != 0U) {
282 bit = crc & crchighbit;
283 crc <<= 1U;
284 if (0U != (c & j))
285 bit ^= crchighbit;
286 if (bit != 0U)
287 crc ^= polynom;
288 j >>= 1U;
289 }
290 crc &= crcmask;
291 }
292 return crc;
293}
294#endif