1 /*
2 * Copyright (c) 2017-2025, Arm Limited and Contributors. All rights reserved.
3 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6
7 /* Runtime firmware routines to report errata status for the current CPU. */
8
9 #include <assert.h>
10 #include <stdbool.h>
11
12 #include <arch_helpers.h>
13 #include <common/debug.h>
14 #include <lib/cpus/cpu_ops.h>
15 #include <lib/cpus/errata.h>
16 #include <lib/el3_runtime/cpu_data.h>
17 #include <lib/spinlock.h>
18
19 #ifdef IMAGE_BL1
20 # define BL_STRING "BL1"
21 #elif defined(__aarch64__) && defined(IMAGE_BL31)
22 # define BL_STRING "BL31"
23 #elif !defined(__aarch64__) && defined(IMAGE_BL32)
24 # define BL_STRING "BL32"
25 #elif defined(IMAGE_BL2) && RESET_TO_BL2
26 # define BL_STRING "BL2"
27 #else
28 # error This image should not be printing errata status
29 #endif
30
31 /* Errata format: BL stage, CPU, errata ID, message */
32 #define ERRATA_FORMAT "%s: %s: CPU workaround for %s was %s\n"
33
34 #define CVE_FORMAT "%s: %s: CPU workaround for CVE %u_%04u was %s\n"
35 #define ERRATUM_FORMAT "%s: %s: CPU workaround for erratum %u was %s\n"
36
37
print_status(int status,char * cpu_str,uint16_t cve,uint32_t id)38 static __unused void print_status(int status, char *cpu_str, uint16_t cve, uint32_t id)
39 {
40 if (status == ERRATA_MISSING) {
41 if (cve) {
42 WARN(CVE_FORMAT, BL_STRING, cpu_str, cve, id, "missing!");
43 } else {
44 WARN(ERRATUM_FORMAT, BL_STRING, cpu_str, id, "missing!");
45 }
46 } else if (status == ERRATA_APPLIES) {
47 if (cve) {
48 INFO(CVE_FORMAT, BL_STRING, cpu_str, cve, id, "applied");
49 } else {
50 INFO(ERRATUM_FORMAT, BL_STRING, cpu_str, id, "applied");
51 }
52 } else {
53 if (cve) {
54 VERBOSE(CVE_FORMAT, BL_STRING, cpu_str, cve, id, "not applicable");
55 } else {
56 VERBOSE(ERRATUM_FORMAT, BL_STRING, cpu_str, id, "not applicable");
57 }
58 }
59 }
60
61 #if !REPORT_ERRATA
print_errata_status(void)62 void print_errata_status(void) {}
63 #else /* !REPORT_ERRATA */
64 /*
65 * New errata status message printer
66 */
generic_errata_report(struct cpu_ops * cpu_ops)67 static void generic_errata_report(struct cpu_ops *cpu_ops)
68 {
69 struct erratum_entry *entry = cpu_ops->errata_list_start;
70 struct erratum_entry *end = cpu_ops->errata_list_end;
71 long rev_var = cpu_get_rev_var();
72
73 for (; entry != end; entry += 1) {
74 uint64_t status = entry->check_func(rev_var);
75
76 assert(entry->id != 0);
77
78 /*
79 * Errata workaround has not been compiled in. If the errata
80 * would have applied had it been compiled in, print its status
81 * as missing.
82 */
83 if (status == ERRATA_APPLIES && entry->chosen == 0) {
84 status = ERRATA_MISSING;
85 }
86
87 print_status(status, cpu_ops->cpu_str, entry->cve, entry->id);
88 }
89 }
90
91 /*
92 * Function to print errata status for the calling CPU (and others of the same
93 * type). Must be called only:
94 * - when MMU and data caches are enabled;
95 * - after cpu_ops have been initialized in per-CPU data.
96 */
print_errata_status(void)97 void print_errata_status(void)
98 {
99 #if IMAGE_BL1
100 struct cpu_ops *cpu_ops = get_cpu_ops_ptr();
101 #else
102 struct cpu_ops *cpu_ops = get_cpu_data(cpu_ops_ptr);
103 #endif
104
105 assert(cpu_ops != NULL);
106
107 #if !IMAGE_BL1
108 /*
109 * Try to acquire the lock. The first CPU of each type to do so will
110 * report errata. The others need not do anything. Never release the
111 * lock as there are no other users.
112 */
113 if (!spin_trylock(cpu_ops->errata_reported)) {
114 return;
115 }
116 #endif
117
118 generic_errata_report(cpu_ops);
119 }
120 #endif /* !REPORT_ERRATA */
121