blob: f752525a281253e95bf64452766dead9cbce8cae [file] [log] [blame]
Soren Brinkmann76fcae32016-03-06 20:16:27 -08001/*
Jolly Shah16fe5ab2019-01-08 11:16:16 -08002 * Copyright (c) 2013-2018, ARM Limited and Contributors. All rights reserved.
Jay Buddhabhatti26e138a2022-12-21 23:03:35 -08003 * Copyright (c) 2022-2023, Advanced Micro Devices, Inc. All rights reserved.
Soren Brinkmann76fcae32016-03-06 20:16:27 -08004 *
dp-armfa3cf0b2017-05-03 09:38:09 +01005 * SPDX-License-Identifier: BSD-3-Clause
Soren Brinkmann76fcae32016-03-06 20:16:27 -08006 */
7
8/*
9 * APU specific definition of processors in the subsystem as well as functions
10 * for getting information about and changing state of the APU.
11 */
12
Filip Drazic4c0765a2016-07-26 12:11:33 +020013#include <assert.h>
Filip Drazic4c0765a2016-07-26 12:11:33 +020014#include <string.h>
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000015
16#include <common/bl_common.h>
17#include <drivers/arm/gic_common.h>
18#include <drivers/arm/gicv2.h>
19#include <lib/bakery_lock.h>
20#include <lib/mmio.h>
21#include <lib/utils.h>
22
Jolly Shah259afe52019-01-09 12:37:57 -080023#include <plat_ipi.h>
Jolly Shah16fe5ab2019-01-08 11:16:16 -080024#include <zynqmp_def.h>
Soren Brinkmann76fcae32016-03-06 20:16:27 -080025#include "pm_client.h"
26#include "pm_ipi.h"
Jay Buddhabhatti26e138a2022-12-21 23:03:35 -080027#include "zynqmp_pm_api_sys.h"
Soren Brinkmann76fcae32016-03-06 20:16:27 -080028
HariBabu Gattemb0c70f52022-09-29 23:59:11 -070029#define IRQ_MAX 84U
30#define NUM_GICD_ISENABLER ((IRQ_MAX >> 5U) + 1U)
31#define UNDEFINED_CPUID (~0U)
Filip Drazic0bd9d0c2016-07-20 17:17:39 +020032
HariBabu Gattemb0c70f52022-09-29 23:59:11 -070033#define PM_SUSPEND_MODE_STD 0U
34#define PM_SUSPEND_MODE_POWER_OFF 1U
Siva Durga Prasad Paladugu43b23a32018-04-27 16:26:47 +053035
Stefan Krsmanovic2b783662016-05-20 15:51:09 +020036DEFINE_BAKERY_LOCK(pm_client_secure_lock);
Soren Brinkmann76fcae32016-03-06 20:16:27 -080037
Soren Brinkmann76fcae32016-03-06 20:16:27 -080038extern const struct pm_ipi apu_ipi;
39
Jolly Shah259afe52019-01-09 12:37:57 -080040const struct pm_ipi apu_ipi = {
41 .local_ipi_id = IPI_ID_APU,
42 .remote_ipi_id = IPI_ID_PMU0,
43 .buffer_base = IPI_BUFFER_APU_BASE,
44};
45
Siva Durga Prasad Paladugu43b23a32018-04-27 16:26:47 +053046static uint32_t suspend_mode = PM_SUSPEND_MODE_STD;
47
Soren Brinkmann76fcae32016-03-06 20:16:27 -080048/* Order in pm_procs_all array must match cpu ids */
Soren Brinkmann4ae19c42017-07-01 20:24:47 -070049static const struct pm_proc pm_procs_all[] = {
Soren Brinkmann76fcae32016-03-06 20:16:27 -080050 {
51 .node_id = NODE_APU_0,
52 .pwrdn_mask = APU_0_PWRCTL_CPUPWRDWNREQ_MASK,
53 .ipi = &apu_ipi,
54 },
55 {
56 .node_id = NODE_APU_1,
57 .pwrdn_mask = APU_1_PWRCTL_CPUPWRDWNREQ_MASK,
58 .ipi = &apu_ipi,
59 },
60 {
61 .node_id = NODE_APU_2,
62 .pwrdn_mask = APU_2_PWRCTL_CPUPWRDWNREQ_MASK,
63 .ipi = &apu_ipi,
64 },
65 {
66 .node_id = NODE_APU_3,
67 .pwrdn_mask = APU_3_PWRCTL_CPUPWRDWNREQ_MASK,
68 .ipi = &apu_ipi,
69 },
70};
71
Filip Drazic4c0765a2016-07-26 12:11:33 +020072/* Interrupt to PM node ID map */
HariBabu Gattemb0c70f52022-09-29 23:59:11 -070073static enum pm_node_id irq_node_map[IRQ_MAX + 1U] = {
Filip Drazic4c0765a2016-07-26 12:11:33 +020074 NODE_UNKNOWN,
75 NODE_UNKNOWN,
76 NODE_UNKNOWN,
77 NODE_UNKNOWN, /* 3 */
78 NODE_UNKNOWN,
79 NODE_UNKNOWN,
80 NODE_UNKNOWN,
81 NODE_UNKNOWN, /* 7 */
82 NODE_UNKNOWN,
83 NODE_UNKNOWN,
84 NODE_UNKNOWN,
85 NODE_UNKNOWN, /* 11 */
86 NODE_UNKNOWN,
87 NODE_UNKNOWN,
88 NODE_NAND,
89 NODE_QSPI, /* 15 */
90 NODE_GPIO,
91 NODE_I2C_0,
92 NODE_I2C_1,
93 NODE_SPI_0, /* 19 */
94 NODE_SPI_1,
95 NODE_UART_0,
96 NODE_UART_1,
97 NODE_CAN_0, /* 23 */
98 NODE_CAN_1,
99 NODE_UNKNOWN,
100 NODE_RTC,
101 NODE_RTC, /* 27 */
102 NODE_UNKNOWN,
103 NODE_UNKNOWN,
104 NODE_UNKNOWN,
105 NODE_UNKNOWN, /* 31 */
106 NODE_UNKNOWN,
107 NODE_UNKNOWN,
108 NODE_UNKNOWN,
109 NODE_UNKNOWN, /* 35, NODE_IPI_APU */
110 NODE_TTC_0,
111 NODE_TTC_0,
112 NODE_TTC_0,
113 NODE_TTC_1, /* 39 */
114 NODE_TTC_1,
115 NODE_TTC_1,
116 NODE_TTC_2,
117 NODE_TTC_2, /* 43 */
118 NODE_TTC_2,
119 NODE_TTC_3,
120 NODE_TTC_3,
121 NODE_TTC_3, /* 47 */
122 NODE_SD_0,
123 NODE_SD_1,
124 NODE_SD_0,
125 NODE_SD_1, /* 51 */
126 NODE_UNKNOWN,
127 NODE_UNKNOWN,
128 NODE_UNKNOWN,
129 NODE_UNKNOWN, /* 55 */
130 NODE_UNKNOWN,
131 NODE_ETH_0,
132 NODE_ETH_0,
133 NODE_ETH_1, /* 59 */
134 NODE_ETH_1,
135 NODE_ETH_2,
136 NODE_ETH_2,
137 NODE_ETH_3, /* 63 */
138 NODE_ETH_3,
139 NODE_USB_0,
140 NODE_USB_0,
141 NODE_USB_0, /* 67 */
142 NODE_USB_0,
143 NODE_USB_0,
144 NODE_USB_1,
145 NODE_USB_1, /* 71 */
146 NODE_USB_1,
147 NODE_USB_1,
148 NODE_USB_1,
149 NODE_USB_0, /* 75 */
150 NODE_USB_0,
151 NODE_ADMA,
152 NODE_ADMA,
153 NODE_ADMA, /* 79 */
154 NODE_ADMA,
155 NODE_ADMA,
156 NODE_ADMA,
157 NODE_ADMA, /* 83 */
158 NODE_ADMA,
159};
160
161/**
162 * irq_to_pm_node - Get PM node ID corresponding to the interrupt number
163 * @irq: Interrupt number
164 *
165 * Return: PM node ID corresponding to the specified interrupt
166 */
Venkatesh Yadav Abbarapue7c45382022-05-19 14:49:49 +0530167static enum pm_node_id irq_to_pm_node(uint32_t irq)
Filip Drazic4c0765a2016-07-26 12:11:33 +0200168{
169 assert(irq <= IRQ_MAX);
170 return irq_node_map[irq];
171}
172
173/**
174 * pm_client_set_wakeup_sources - Set all slaves with enabled interrupts as wake
175 * sources in the PMU firmware
176 */
177static void pm_client_set_wakeup_sources(void)
178{
179 uint32_t reg_num;
HariBabu Gattemaa811712022-10-07 00:07:49 -0700180 uint8_t pm_wakeup_nodes_set[NODE_MAX] = { 0 };
HariBabu Gattemb0c70f52022-09-29 23:59:11 -0700181 uintptr_t isenabler1 = BASE_GICD_BASE + GICD_ISENABLER + 4U;
Filip Drazic4c0765a2016-07-26 12:11:33 +0200182
Siva Durga Prasad Paladugu43b23a32018-04-27 16:26:47 +0530183 /* In case of power-off suspend, only NODE_EXTERN must be set */
184 if (suspend_mode == PM_SUSPEND_MODE_POWER_OFF) {
185 enum pm_ret_status ret;
186
HariBabu Gattemb0c70f52022-09-29 23:59:11 -0700187 ret = pm_set_wakeup_source(NODE_APU, NODE_EXTERN, 1U);
Siva Durga Prasad Paladugu43b23a32018-04-27 16:26:47 +0530188 /**
189 * If NODE_EXTERN could not be set as wake source, proceed with
190 * standard suspend (no one will wake the system otherwise)
191 */
Venkatesh Yadav Abbarapu987fad32022-04-29 13:52:00 +0530192 if (ret == PM_RET_SUCCESS) {
Siva Durga Prasad Paladugu43b23a32018-04-27 16:26:47 +0530193 return;
Venkatesh Yadav Abbarapu987fad32022-04-29 13:52:00 +0530194 }
Siva Durga Prasad Paladugu43b23a32018-04-27 16:26:47 +0530195 }
196
Douglas Raillarda8954fc2017-01-26 15:54:44 +0000197 zeromem(&pm_wakeup_nodes_set, sizeof(pm_wakeup_nodes_set));
Filip Drazic4c0765a2016-07-26 12:11:33 +0200198
HariBabu Gattemb0c70f52022-09-29 23:59:11 -0700199 for (reg_num = 0U; reg_num < NUM_GICD_ISENABLER; reg_num++) {
Filip Drazic4c0765a2016-07-26 12:11:33 +0200200 uint32_t base_irq = reg_num << ISENABLER_SHIFT;
HariBabu Gattemb0c70f52022-09-29 23:59:11 -0700201 uint32_t reg = mmio_read_32(isenabler1 + (reg_num << 2U));
Filip Drazic4c0765a2016-07-26 12:11:33 +0200202
HariBabu Gattemb0c70f52022-09-29 23:59:11 -0700203 if (reg == 0) {
Filip Drazic4c0765a2016-07-26 12:11:33 +0200204 continue;
Venkatesh Yadav Abbarapu987fad32022-04-29 13:52:00 +0530205 }
Filip Drazic4c0765a2016-07-26 12:11:33 +0200206
207 while (reg) {
208 enum pm_node_id node;
209 uint32_t idx, ret, irq, lowest_set = reg & (-reg);
210
211 idx = __builtin_ctz(lowest_set);
212 irq = base_irq + idx;
213
Venkatesh Yadav Abbarapu987fad32022-04-29 13:52:00 +0530214 if (irq > IRQ_MAX) {
Filip Drazic4c0765a2016-07-26 12:11:33 +0200215 break;
Venkatesh Yadav Abbarapu987fad32022-04-29 13:52:00 +0530216 }
Filip Drazic4c0765a2016-07-26 12:11:33 +0200217
218 node = irq_to_pm_node(irq);
219 reg &= ~lowest_set;
220
Ronak Jainf8414672022-05-11 02:48:52 -0700221 if (node > NODE_UNKNOWN && node < NODE_MAX) {
222 if (pm_wakeup_nodes_set[node] == 0U) {
223 ret = pm_set_wakeup_source(NODE_APU, node, 1U);
224 pm_wakeup_nodes_set[node] = (ret == PM_RET_SUCCESS) ? 1U : 0U;
225 }
Filip Drazic4c0765a2016-07-26 12:11:33 +0200226 }
227 }
228 }
229}
230
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800231/**
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800232 * pm_get_proc() - returns pointer to the proc structure
233 * @cpuid: id of the cpu whose proc struct pointer should be returned
234 *
235 * Return: pointer to a proc structure if proc is found, otherwise NULL
236 */
Venkatesh Yadav Abbarapue7c45382022-05-19 14:49:49 +0530237const struct pm_proc *pm_get_proc(uint32_t cpuid)
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800238{
Venkatesh Yadav Abbarapu987fad32022-04-29 13:52:00 +0530239 if (cpuid < ARRAY_SIZE(pm_procs_all)) {
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800240 return &pm_procs_all[cpuid];
Venkatesh Yadav Abbarapu987fad32022-04-29 13:52:00 +0530241 }
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800242
243 return NULL;
244}
245
246/**
247 * pm_get_proc_by_node() - returns pointer to the proc structure
248 * @nid: node id of the processor
249 *
250 * Return: pointer to a proc structure if proc is found, otherwise NULL
251 */
252const struct pm_proc *pm_get_proc_by_node(enum pm_node_id nid)
253{
254 for (size_t i = 0; i < ARRAY_SIZE(pm_procs_all); i++) {
Venkatesh Yadav Abbarapu987fad32022-04-29 13:52:00 +0530255 if (nid == pm_procs_all[i].node_id) {
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800256 return &pm_procs_all[i];
Venkatesh Yadav Abbarapu987fad32022-04-29 13:52:00 +0530257 }
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800258 }
259 return NULL;
260}
261
262/**
263 * pm_get_cpuid() - get the local cpu ID for a global node ID
264 * @nid: node id of the processor
265 *
266 * Return: the cpu ID (starting from 0) for the subsystem
267 */
Venkatesh Yadav Abbarapue7c45382022-05-19 14:49:49 +0530268static uint32_t pm_get_cpuid(enum pm_node_id nid)
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800269{
270 for (size_t i = 0; i < ARRAY_SIZE(pm_procs_all); i++) {
Venkatesh Yadav Abbarapu987fad32022-04-29 13:52:00 +0530271 if (pm_procs_all[i].node_id == nid) {
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800272 return i;
Venkatesh Yadav Abbarapu987fad32022-04-29 13:52:00 +0530273 }
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800274 }
275 return UNDEFINED_CPUID;
276}
277
278const struct pm_proc *primary_proc = &pm_procs_all[0];
279
280/**
281 * pm_client_suspend() - Client-specific suspend actions
282 *
283 * This function should contain any PU-specific actions
284 * required prior to sending suspend request to PMU
Filip Drazic4c0765a2016-07-26 12:11:33 +0200285 * Actions taken depend on the state system is suspending to.
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800286 */
Venkatesh Yadav Abbarapue7c45382022-05-19 14:49:49 +0530287void pm_client_suspend(const struct pm_proc *proc, uint32_t state)
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800288{
Stefan Krsmanovic2b783662016-05-20 15:51:09 +0200289 bakery_lock_get(&pm_client_secure_lock);
290
Venkatesh Yadav Abbarapu987fad32022-04-29 13:52:00 +0530291 if (state == PM_STATE_SUSPEND_TO_RAM) {
Filip Drazic4c0765a2016-07-26 12:11:33 +0200292 pm_client_set_wakeup_sources();
Venkatesh Yadav Abbarapu987fad32022-04-29 13:52:00 +0530293 }
Filip Drazic4c0765a2016-07-26 12:11:33 +0200294
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800295 /* Set powerdown request */
296 mmio_write_32(APU_PWRCTL, mmio_read_32(APU_PWRCTL) | proc->pwrdn_mask);
Stefan Krsmanovic2b783662016-05-20 15:51:09 +0200297
298 bakery_lock_release(&pm_client_secure_lock);
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800299}
300
301
302/**
303 * pm_client_abort_suspend() - Client-specific abort-suspend actions
304 *
305 * This function should contain any PU-specific actions
306 * required for aborting a prior suspend request
307 */
308void pm_client_abort_suspend(void)
309{
310 /* Enable interrupts at processor level (for current cpu) */
311 gicv2_cpuif_enable();
Stefan Krsmanovic2b783662016-05-20 15:51:09 +0200312
313 bakery_lock_get(&pm_client_secure_lock);
314
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800315 /* Clear powerdown request */
316 mmio_write_32(APU_PWRCTL,
317 mmio_read_32(APU_PWRCTL) & ~primary_proc->pwrdn_mask);
Stefan Krsmanovic2b783662016-05-20 15:51:09 +0200318
319 bakery_lock_release(&pm_client_secure_lock);
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800320}
321
322/**
323 * pm_client_wakeup() - Client-specific wakeup actions
324 *
325 * This function should contain any PU-specific actions
326 * required for waking up another APU core
327 */
328void pm_client_wakeup(const struct pm_proc *proc)
329{
Venkatesh Yadav Abbarapue7c45382022-05-19 14:49:49 +0530330 uint32_t cpuid = pm_get_cpuid(proc->node_id);
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800331
Venkatesh Yadav Abbarapu987fad32022-04-29 13:52:00 +0530332 if (cpuid == UNDEFINED_CPUID) {
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800333 return;
Venkatesh Yadav Abbarapu987fad32022-04-29 13:52:00 +0530334 }
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800335
Stefan Krsmanovic2b783662016-05-20 15:51:09 +0200336 bakery_lock_get(&pm_client_secure_lock);
337
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800338 /* clear powerdown bit for affected cpu */
339 uint32_t val = mmio_read_32(APU_PWRCTL);
340 val &= ~(proc->pwrdn_mask);
341 mmio_write_32(APU_PWRCTL, val);
Stefan Krsmanovic2b783662016-05-20 15:51:09 +0200342
343 bakery_lock_release(&pm_client_secure_lock);
Soren Brinkmann76fcae32016-03-06 20:16:27 -0800344}
Siva Durga Prasad Paladugu43b23a32018-04-27 16:26:47 +0530345
346enum pm_ret_status pm_set_suspend_mode(uint32_t mode)
347{
348 if ((mode != PM_SUSPEND_MODE_STD) &&
Venkatesh Yadav Abbarapu987fad32022-04-29 13:52:00 +0530349 (mode != PM_SUSPEND_MODE_POWER_OFF)) {
Siva Durga Prasad Paladugu43b23a32018-04-27 16:26:47 +0530350 return PM_RET_ERROR_ARGS;
Venkatesh Yadav Abbarapu987fad32022-04-29 13:52:00 +0530351 }
Siva Durga Prasad Paladugu43b23a32018-04-27 16:26:47 +0530352
353 suspend_mode = mode;
354 return PM_RET_SUCCESS;
355}