xref: /rk3399_ARM-atf/lib/extensions/ras/ras_common.c (revision 30a8d96e4689be30b2caeb23fd071fadd1ec87cd)
1362599ecSJeenu Viswambharan /*
2362599ecSJeenu Viswambharan  * Copyright (c) 2018, ARM Limited and Contributors. All rights reserved.
3362599ecSJeenu Viswambharan  *
4362599ecSJeenu Viswambharan  * SPDX-License-Identifier: BSD-3-Clause
5362599ecSJeenu Viswambharan  */
6362599ecSJeenu Viswambharan 
7362599ecSJeenu Viswambharan #include <arch_helpers.h>
8362599ecSJeenu Viswambharan #include <debug.h>
9362599ecSJeenu Viswambharan #include <ea_handle.h>
10362599ecSJeenu Viswambharan #include <ehf.h>
11362599ecSJeenu Viswambharan #include <platform.h>
12362599ecSJeenu Viswambharan #include <ras.h>
13362599ecSJeenu Viswambharan #include <ras_arch.h>
14*30a8d96eSJeenu Viswambharan #include <stdbool.h>
15362599ecSJeenu Viswambharan 
16ca6d9185SJeenu Viswambharan #ifndef PLAT_RAS_PRI
17ca6d9185SJeenu Viswambharan # error Platform must define RAS priority value
18ca6d9185SJeenu Viswambharan #endif
19ca6d9185SJeenu Viswambharan 
20362599ecSJeenu Viswambharan /* Handler that receives External Aborts on RAS-capable systems */
21362599ecSJeenu Viswambharan int ras_ea_handler(unsigned int ea_reason, uint64_t syndrome, void *cookie,
22362599ecSJeenu Viswambharan 		void *handle, uint64_t flags)
23362599ecSJeenu Viswambharan {
24*30a8d96eSJeenu Viswambharan 	unsigned int i, n_handled = 0;
25*30a8d96eSJeenu Viswambharan 	int probe_data, ret;
26362599ecSJeenu Viswambharan 	struct err_record_info *info;
27362599ecSJeenu Viswambharan 
28362599ecSJeenu Viswambharan 	const struct err_handler_data err_data = {
29362599ecSJeenu Viswambharan 		.version = ERR_HANDLER_VERSION,
30362599ecSJeenu Viswambharan 		.ea_reason = ea_reason,
31ca6d9185SJeenu Viswambharan 		.interrupt = 0,
32*30a8d96eSJeenu Viswambharan 		.syndrome = (uint32_t) syndrome,
33362599ecSJeenu Viswambharan 		.flags = flags,
34362599ecSJeenu Viswambharan 		.cookie = cookie,
35362599ecSJeenu Viswambharan 		.handle = handle
36362599ecSJeenu Viswambharan 	};
37362599ecSJeenu Viswambharan 
38362599ecSJeenu Viswambharan 	for_each_err_record_info(i, info) {
39362599ecSJeenu Viswambharan 		assert(info->probe != NULL);
40362599ecSJeenu Viswambharan 		assert(info->handler != NULL);
41362599ecSJeenu Viswambharan 
42362599ecSJeenu Viswambharan 		/* Continue probing until the record group signals no error */
43*30a8d96eSJeenu Viswambharan 		while (true) {
44362599ecSJeenu Viswambharan 			if (info->probe(info, &probe_data) == 0)
45362599ecSJeenu Viswambharan 				break;
46362599ecSJeenu Viswambharan 
47362599ecSJeenu Viswambharan 			/* Handle error */
48362599ecSJeenu Viswambharan 			ret = info->handler(info, probe_data, &err_data);
49362599ecSJeenu Viswambharan 			if (ret != 0)
50362599ecSJeenu Viswambharan 				return ret;
51362599ecSJeenu Viswambharan 
52362599ecSJeenu Viswambharan 			n_handled++;
53362599ecSJeenu Viswambharan 		}
54362599ecSJeenu Viswambharan 	}
55362599ecSJeenu Viswambharan 
56*30a8d96eSJeenu Viswambharan 	return (n_handled != 0U) ? 1 : 0;
57362599ecSJeenu Viswambharan }
58ca6d9185SJeenu Viswambharan 
59ca6d9185SJeenu Viswambharan #if ENABLE_ASSERTIONS
60ca6d9185SJeenu Viswambharan static void assert_interrupts_sorted(void)
61ca6d9185SJeenu Viswambharan {
62ca6d9185SJeenu Viswambharan 	unsigned int i, last;
63*30a8d96eSJeenu Viswambharan 	struct ras_interrupt *start = ras_interrupt_mappings.intrs;
64ca6d9185SJeenu Viswambharan 
65*30a8d96eSJeenu Viswambharan 	if (ras_interrupt_mappings.num_intrs == 0UL)
66ca6d9185SJeenu Viswambharan 		return;
67ca6d9185SJeenu Viswambharan 
68ca6d9185SJeenu Viswambharan 	last = start[0].intr_number;
69*30a8d96eSJeenu Viswambharan 	for (i = 1; i < ras_interrupt_mappings.num_intrs; i++) {
70ca6d9185SJeenu Viswambharan 		assert(start[i].intr_number > last);
71ca6d9185SJeenu Viswambharan 		last = start[i].intr_number;
72ca6d9185SJeenu Viswambharan 	}
73ca6d9185SJeenu Viswambharan }
74ca6d9185SJeenu Viswambharan #endif
75ca6d9185SJeenu Viswambharan 
76ca6d9185SJeenu Viswambharan /*
77ca6d9185SJeenu Viswambharan  * Given an RAS interrupt number, locate the registered handler and call it. If
78ca6d9185SJeenu Viswambharan  * no handler was found for the interrupt number, this function panics.
79ca6d9185SJeenu Viswambharan  */
80ca6d9185SJeenu Viswambharan static int ras_interrupt_handler(uint32_t intr_raw, uint32_t flags,
81ca6d9185SJeenu Viswambharan 		void *handle, void *cookie)
82ca6d9185SJeenu Viswambharan {
83*30a8d96eSJeenu Viswambharan 	struct ras_interrupt *ras_inrs = ras_interrupt_mappings.intrs;
84ca6d9185SJeenu Viswambharan 	struct ras_interrupt *selected = NULL;
85ca6d9185SJeenu Viswambharan 	int start, end, mid, probe_data, ret __unused;
86ca6d9185SJeenu Viswambharan 
87ca6d9185SJeenu Viswambharan 	const struct err_handler_data err_data = {
88ca6d9185SJeenu Viswambharan 		.version = ERR_HANDLER_VERSION,
89ca6d9185SJeenu Viswambharan 		.interrupt = intr_raw,
90ca6d9185SJeenu Viswambharan 		.flags = flags,
91ca6d9185SJeenu Viswambharan 		.cookie = cookie,
92ca6d9185SJeenu Viswambharan 		.handle = handle
93ca6d9185SJeenu Viswambharan 	};
94ca6d9185SJeenu Viswambharan 
95*30a8d96eSJeenu Viswambharan 	assert(ras_interrupt_mappings.num_intrs > 0UL);
96ca6d9185SJeenu Viswambharan 
97ca6d9185SJeenu Viswambharan 	start = 0;
98*30a8d96eSJeenu Viswambharan 	end = (int) ras_interrupt_mappings.num_intrs;
99ca6d9185SJeenu Viswambharan 	while (start <= end) {
100ca6d9185SJeenu Viswambharan 		mid = ((end + start) / 2);
101ca6d9185SJeenu Viswambharan 		if (intr_raw == ras_inrs[mid].intr_number) {
102ca6d9185SJeenu Viswambharan 			selected = &ras_inrs[mid];
103ca6d9185SJeenu Viswambharan 			break;
104ca6d9185SJeenu Viswambharan 		} else if (intr_raw < ras_inrs[mid].intr_number) {
105ca6d9185SJeenu Viswambharan 			/* Move left */
106ca6d9185SJeenu Viswambharan 			end = mid - 1;
107ca6d9185SJeenu Viswambharan 		} else {
108ca6d9185SJeenu Viswambharan 			/* Move right */
109ca6d9185SJeenu Viswambharan 			start = mid + 1;
110ca6d9185SJeenu Viswambharan 		}
111ca6d9185SJeenu Viswambharan 	}
112ca6d9185SJeenu Viswambharan 
113ca6d9185SJeenu Viswambharan 	if (selected == NULL) {
114ca6d9185SJeenu Viswambharan 		ERROR("RAS interrupt %u has no handler!\n", intr_raw);
115ca6d9185SJeenu Viswambharan 		panic();
116ca6d9185SJeenu Viswambharan 	}
117ca6d9185SJeenu Viswambharan 
118*30a8d96eSJeenu Viswambharan 	if (selected->err_record->probe != NULL) {
119ca6d9185SJeenu Viswambharan 		ret = selected->err_record->probe(selected->err_record, &probe_data);
120ca6d9185SJeenu Viswambharan 		assert(ret != 0);
1214576f73cSSughosh Ganu 	}
122ca6d9185SJeenu Viswambharan 
123ca6d9185SJeenu Viswambharan 	/* Call error handler for the record group */
124ca6d9185SJeenu Viswambharan 	assert(selected->err_record->handler != NULL);
125*30a8d96eSJeenu Viswambharan 	(void) selected->err_record->handler(selected->err_record, probe_data,
126ca6d9185SJeenu Viswambharan 			&err_data);
127ca6d9185SJeenu Viswambharan 
128ca6d9185SJeenu Viswambharan 	return 0;
129ca6d9185SJeenu Viswambharan }
130ca6d9185SJeenu Viswambharan 
131ca6d9185SJeenu Viswambharan void ras_init(void)
132ca6d9185SJeenu Viswambharan {
133ca6d9185SJeenu Viswambharan #if ENABLE_ASSERTIONS
134ca6d9185SJeenu Viswambharan 	/* Check RAS interrupts are sorted */
135ca6d9185SJeenu Viswambharan 	assert_interrupts_sorted();
136ca6d9185SJeenu Viswambharan #endif
137ca6d9185SJeenu Viswambharan 
138ca6d9185SJeenu Viswambharan 	/* Register RAS priority handler */
139ca6d9185SJeenu Viswambharan 	ehf_register_priority_handler(PLAT_RAS_PRI, ras_interrupt_handler);
140ca6d9185SJeenu Viswambharan }
141