1 /* 2 * Copyright (c) 2013-2020, Arm Limited and Contributors. All rights reserved. 3 * Copyright (c) 2019-2022, Xilinx, Inc. All rights reserved. 4 * Copyright (c) 2022-2024, Advanced Micro Devices, Inc. All rights reserved. 5 * 6 * SPDX-License-Identifier: BSD-3-Clause 7 */ 8 9 10 #include <arch_helpers.h> 11 #include <lib/bakery_lock.h> 12 #include <lib/mmio.h> 13 #include <lib/spinlock.h> 14 #include <plat/common/platform.h> 15 16 #include <ipi.h> 17 #include <plat_ipi.h> 18 #include <plat_private.h> 19 #include "pm_defs.h" 20 #include "pm_ipi.h" 21 22 #define ERROR_CODE_MASK (0xFFFFU) 23 #define PM_OFFSET (0U) 24 25 /* 26 * ARM v8.2, the cache will turn off automatically when cpu 27 * power down. Therefore, there is no doubt to use the spin_lock here. 28 */ 29 #if !HW_ASSISTED_COHERENCY 30 DEFINE_BAKERY_LOCK(pm_secure_lock); 31 static inline void pm_ipi_lock_get(void) 32 { 33 bakery_lock_get(&pm_secure_lock); 34 } 35 36 static inline void pm_ipi_lock_release(void) 37 { 38 bakery_lock_release(&pm_secure_lock); 39 } 40 #else 41 spinlock_t pm_secure_lock; 42 static inline void pm_ipi_lock_get(void) 43 { 44 spin_lock(&pm_secure_lock); 45 } 46 47 static inline void pm_ipi_lock_release(void) 48 { 49 spin_unlock(&pm_secure_lock); 50 } 51 #endif 52 53 /** 54 * pm_ipi_init() - Initialize IPI peripheral for communication with 55 * remote processor. 56 * @proc: Pointer to the processor who is initiating request. 57 * 58 * Return: On success, the initialization function must return 0. 59 * Any other return value will cause the framework to ignore 60 * the service. 61 * 62 * Called from pm_setup initialization function. 63 */ 64 void pm_ipi_init(const struct pm_proc *proc) 65 { 66 ipi_mb_open(proc->ipi->local_ipi_id, proc->ipi->remote_ipi_id); 67 } 68 69 /** 70 * pm_ipi_send_common() - Sends IPI request to the remote processor. 71 * @proc: Pointer to the processor who is initiating request. 72 * @payload: API id and call arguments to be written in IPI buffer. 73 * @is_blocking: if to trigger the notification in blocking mode or not. 74 * 75 * Send an IPI request to the power controller. Caller needs to hold 76 * the 'pm_secure_lock' lock. 77 * 78 * Return: Returns status, either success or error+reason. 79 * 80 */ 81 static enum pm_ret_status pm_ipi_send_common(const struct pm_proc *proc, 82 uint32_t payload[PAYLOAD_ARG_CNT], 83 uint32_t is_blocking) 84 { 85 uint32_t offset = PM_OFFSET; 86 uintptr_t buffer_base = proc->ipi->buffer_base + 87 IPI_BUFFER_TARGET_REMOTE_OFFSET + 88 IPI_BUFFER_REQ_OFFSET; 89 #if IPI_CRC_CHECK 90 payload[PAYLOAD_CRC_POS] = calculate_crc(payload, IPI_W0_TO_W6_SIZE); 91 #endif 92 93 /* Write payload into IPI buffer */ 94 for (size_t i = 0; i < PAYLOAD_ARG_CNT; i++) { 95 mmio_write_32(buffer_base + offset, payload[i]); 96 offset += PAYLOAD_ARG_SIZE; 97 } 98 99 /* Generate IPI to remote processor */ 100 ipi_mb_notify(proc->ipi->local_ipi_id, proc->ipi->remote_ipi_id, 101 is_blocking); 102 103 return PM_RET_SUCCESS; 104 } 105 106 /** 107 * pm_ipi_send_non_blocking() - Sends IPI request to the remote processor 108 * without blocking notification. 109 * @proc: Pointer to the processor who is initiating request. 110 * @payload: API id and call arguments to be written in IPI buffer. 111 * 112 * Send an IPI request to the power controller. 113 * 114 * Return: Returns status, either success or error+reason. 115 * 116 */ 117 enum pm_ret_status pm_ipi_send_non_blocking(const struct pm_proc *proc, 118 uint32_t payload[PAYLOAD_ARG_CNT]) 119 { 120 enum pm_ret_status ret; 121 122 pm_ipi_lock_get(); 123 124 ret = pm_ipi_send_common(proc, payload, IPI_NON_BLOCKING); 125 126 pm_ipi_lock_release(); 127 128 return ret; 129 } 130 131 /** 132 * pm_ipi_send() - Sends IPI request to the remote processor. 133 * @proc: Pointer to the processor who is initiating request. 134 * @payload: API id and call arguments to be written in IPI buffer. 135 * 136 * Send an IPI request to the power controller. 137 * 138 * Return: Returns status, either success or error+reason. 139 * 140 */ 141 enum pm_ret_status pm_ipi_send(const struct pm_proc *proc, 142 uint32_t payload[PAYLOAD_ARG_CNT]) 143 { 144 enum pm_ret_status ret; 145 146 pm_ipi_lock_get(); 147 148 ret = pm_ipi_send_common(proc, payload, IPI_BLOCKING); 149 150 pm_ipi_lock_release(); 151 152 return ret; 153 } 154 155 156 /** 157 * pm_ipi_buff_read() - Reads IPI response after remote processor has handled 158 * interrupt. 159 * @proc: Pointer to the processor who is waiting and reading response. 160 * @value: Used to return value from IPI buffer element (optional). 161 * @count: Number of values to return in @value. 162 * 163 * Return: Returns status, either success or error+reason. 164 * 165 */ 166 static enum pm_ret_status pm_ipi_buff_read(const struct pm_proc *proc, 167 uint32_t value[PAYLOAD_ARG_CNT]) 168 { 169 size_t i; 170 enum pm_ret_status ret; 171 uintptr_t buffer_base = proc->ipi->buffer_base + 172 IPI_BUFFER_TARGET_REMOTE_OFFSET + 173 IPI_BUFFER_RESP_OFFSET; 174 175 /* 176 * Read response from IPI buffer 177 * buf-0: success or error+reason 178 * buf-1: value 179 * buf-2: unused 180 * buf-3: unused 181 */ 182 for (i = 0; i < PAYLOAD_ARG_CNT; i++) { 183 value[i] = mmio_read_32(buffer_base + (i * PAYLOAD_ARG_SIZE)); 184 } 185 186 ret = value[0]; 187 #if IPI_CRC_CHECK 188 if (value[PAYLOAD_CRC_POS] != 189 calculate_crc(value, IPI_W0_TO_W6_SIZE)) { 190 NOTICE("ERROR in CRC response payload value:0x%x\n", 191 value[PAYLOAD_CRC_POS]); 192 ret = PM_RET_ERROR_INVALID_CRC; 193 /* Payload data is invalid as CRC validation failed 194 * Clear the payload to avoid leakage of data to upper layers 195 */ 196 memset(value, 0, PAYLOAD_ARG_CNT); 197 } 198 #endif 199 200 return ret; 201 } 202 203 /** 204 * pm_ipi_buff_read_callb() - Callback function that reads value from 205 * ipi response buffer. 206 * @value: Used to return value from IPI buffer element. 207 * @count: Number of values to return in @value. 208 * 209 * This callback function fills requested data in @value from ipi response 210 * buffer. 211 * 212 * Return: Returns status, either success or error. 213 * 214 */ 215 enum pm_ret_status pm_ipi_buff_read_callb(uint32_t *value, size_t count) 216 { 217 size_t i; 218 #if IPI_CRC_CHECK 219 uint32_t *payload_ptr = value; 220 size_t j; 221 unsigned int response_payload[PAYLOAD_ARG_CNT] = {0}; 222 #endif 223 uintptr_t buffer_base = IPI_BUFFER_REMOTE_BASE + 224 IPI_BUFFER_TARGET_LOCAL_OFFSET + 225 IPI_BUFFER_REQ_OFFSET; 226 enum pm_ret_status ret = PM_RET_SUCCESS; 227 228 if (count > IPI_BUFFER_MAX_WORDS) { 229 count = IPI_BUFFER_MAX_WORDS; 230 } 231 232 for (i = 0; i < count; i++) { 233 *value = mmio_read_32(buffer_base + (i * PAYLOAD_ARG_SIZE)); 234 value++; 235 } 236 #if IPI_CRC_CHECK 237 for (j = 0; j < PAYLOAD_ARG_CNT; j++) { 238 response_payload[j] = mmio_read_32(buffer_base + 239 (j * PAYLOAD_ARG_SIZE)); 240 } 241 242 if (response_payload[PAYLOAD_CRC_POS] != 243 calculate_crc(response_payload, IPI_W0_TO_W6_SIZE)) { 244 NOTICE("ERROR in CRC response payload value:0x%x\n", 245 response_payload[PAYLOAD_CRC_POS]); 246 ret = PM_RET_ERROR_INVALID_CRC; 247 /* Payload data is invalid as CRC validation failed 248 * Clear the payload to avoid leakage of data to upper layers 249 */ 250 memset(payload_ptr, 0, count); 251 } 252 #endif 253 return ret; 254 } 255 256 /** 257 * pm_ipi_send_sync() - Sends IPI request to the remote processor. 258 * @proc: Pointer to the processor who is initiating request. 259 * @payload: API id and call arguments to be written in IPI buffer. 260 * @value: Used to return value from IPI buffer element (optional). 261 * @count: Number of values to return in @value. 262 * 263 * Send an IPI request to the power controller and wait for it to be handled. 264 * 265 * Return: Returns status, either success or error+reason and, optionally, 266 * @value. 267 * 268 */ 269 enum pm_ret_status pm_ipi_send_sync(const struct pm_proc *proc, 270 uint32_t payload[PAYLOAD_ARG_CNT], 271 uint32_t *value, size_t count) 272 { 273 enum pm_ret_status ret; 274 uint32_t i, ret_payload[PAYLOAD_ARG_CNT] = {0U}; 275 276 pm_ipi_lock_get(); 277 278 ret = pm_ipi_send_common(proc, payload, IPI_BLOCKING); 279 if (ret != PM_RET_SUCCESS) { 280 goto unlock; 281 } 282 283 ret = ERROR_CODE_MASK & (pm_ipi_buff_read(proc, ret_payload)); 284 285 for (i = 1U; i <= count; i++) { 286 *value = ret_payload[i]; 287 value++; 288 } 289 290 unlock: 291 pm_ipi_lock_release(); 292 293 return ret; 294 } 295 296 void pm_ipi_irq_enable(const struct pm_proc *proc) 297 { 298 ipi_mb_enable_irq(proc->ipi->local_ipi_id, proc->ipi->remote_ipi_id); 299 } 300 301 void pm_ipi_irq_clear(const struct pm_proc *proc) 302 { 303 ipi_mb_ack(proc->ipi->local_ipi_id, proc->ipi->remote_ipi_id); 304 } 305 306 uint32_t pm_ipi_irq_status(const struct pm_proc *proc) 307 { 308 int32_t ret; 309 310 ret = ipi_mb_enquire_status(proc->ipi->local_ipi_id, 311 proc->ipi->remote_ipi_id); 312 if (ret & IPI_MB_STATUS_RECV_PENDING) { 313 return 1; 314 } else { 315 return 0; 316 } 317 } 318 319 #if IPI_CRC_CHECK 320 uint32_t calculate_crc(uint32_t payload[PAYLOAD_ARG_CNT], uint32_t bufsize) 321 { 322 uint32_t crcinit = CRC_INIT_VALUE; 323 uint32_t order = CRC_ORDER; 324 uint32_t polynom = CRC_POLYNOM; 325 uint32_t i, j, c, bit, datain, crcmask, crchighbit; 326 uint32_t crc = crcinit; 327 328 crcmask = ((uint32_t)((1U << (order - 1U)) - 1U) << 1U) | 1U; 329 crchighbit = (uint32_t)(1U << (order - 1U)); 330 331 for (i = 0U; i < bufsize; i++) { 332 datain = mmio_read_8((unsigned long)payload + i); 333 c = datain; 334 j = 0x80U; 335 while (j != 0U) { 336 bit = crc & crchighbit; 337 crc <<= 1U; 338 if (0U != (c & j)) 339 bit ^= crchighbit; 340 if (bit != 0U) 341 crc ^= polynom; 342 j >>= 1U; 343 } 344 crc &= crcmask; 345 } 346 return crc; 347 } 348 #endif 349