1*0c333f8cSAndrew Turner /*-
2*0c333f8cSAndrew Turner * SPDX-License-Identifier: BSD-2-Clause
3*0c333f8cSAndrew Turner *
4*0c333f8cSAndrew Turner * Copyright (c) 2024 Arm Ltd
5*0c333f8cSAndrew Turner *
6*0c333f8cSAndrew Turner * Redistribution and use in source and binary forms, with or without
7*0c333f8cSAndrew Turner * modification, are permitted provided that the following conditions
8*0c333f8cSAndrew Turner * are met:
9*0c333f8cSAndrew Turner * 1. Redistributions of source code must retain the above copyright
10*0c333f8cSAndrew Turner * notice, this list of conditions and the following disclaimer.
11*0c333f8cSAndrew Turner * 2. Redistributions in binary form must reproduce the above copyright
12*0c333f8cSAndrew Turner * notice, this list of conditions and the following disclaimer in the
13*0c333f8cSAndrew Turner * documentation and/or other materials provided with the distribution.
14*0c333f8cSAndrew Turner *
15*0c333f8cSAndrew Turner * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16*0c333f8cSAndrew Turner * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17*0c333f8cSAndrew Turner * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18*0c333f8cSAndrew Turner * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19*0c333f8cSAndrew Turner * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20*0c333f8cSAndrew Turner * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21*0c333f8cSAndrew Turner * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22*0c333f8cSAndrew Turner * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23*0c333f8cSAndrew Turner * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24*0c333f8cSAndrew Turner * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25*0c333f8cSAndrew Turner * SUCH DAMAGE.
26*0c333f8cSAndrew Turner */
27*0c333f8cSAndrew Turner
28*0c333f8cSAndrew Turner /*
29*0c333f8cSAndrew Turner * A driver for the Arm Errata Management Firmware Interface (Errata ABI).
30*0c333f8cSAndrew Turner * This queries into the SMCCC firmware for the status of errata using the
31*0c333f8cSAndrew Turner * interface documented in den0100 [1].
32*0c333f8cSAndrew Turner *
33*0c333f8cSAndrew Turner * [1] https://developer.arm.com/documentation/den0100/latest
34*0c333f8cSAndrew Turner */
35*0c333f8cSAndrew Turner
36*0c333f8cSAndrew Turner #include <sys/param.h>
37*0c333f8cSAndrew Turner #include <sys/systm.h>
38*0c333f8cSAndrew Turner #include <sys/bus.h>
39*0c333f8cSAndrew Turner #include <sys/eventhandler.h>
40*0c333f8cSAndrew Turner #include <sys/kernel.h>
41*0c333f8cSAndrew Turner #include <sys/malloc.h>
42*0c333f8cSAndrew Turner #include <sys/module.h>
43*0c333f8cSAndrew Turner #include <sys/random.h>
44*0c333f8cSAndrew Turner
45*0c333f8cSAndrew Turner #include <dev/psci/psci.h>
46*0c333f8cSAndrew Turner #include <dev/psci/smccc.h>
47*0c333f8cSAndrew Turner
48*0c333f8cSAndrew Turner #include <machine/cpu_feat.h>
49*0c333f8cSAndrew Turner
50*0c333f8cSAndrew Turner #define ERRATA_HIGHER_EL_MITIGATION 3
51*0c333f8cSAndrew Turner #define ERRATA_NOT_AFFECTED 2
52*0c333f8cSAndrew Turner #define ERRATA_AFFECTED 1
53*0c333f8cSAndrew Turner
54*0c333f8cSAndrew Turner #define EM_VERSION SMCCC_FUNC_ID(SMCCC_FAST_CALL, \
55*0c333f8cSAndrew Turner SMCCC_32BIT_CALL, SMCCC_STD_SECURE_SERVICE_CALLS, 0xf0u)
56*0c333f8cSAndrew Turner #define EM_VERSION_MIN 0x10000L
57*0c333f8cSAndrew Turner #define EM_FEATURES SMCCC_FUNC_ID(SMCCC_FAST_CALL, \
58*0c333f8cSAndrew Turner SMCCC_32BIT_CALL, SMCCC_STD_SECURE_SERVICE_CALLS, 0xf1u)
59*0c333f8cSAndrew Turner #define EM_CPU_ERRATUM_FEATURES SMCCC_FUNC_ID(SMCCC_FAST_CALL, \
60*0c333f8cSAndrew Turner SMCCC_32BIT_CALL, SMCCC_STD_SECURE_SERVICE_CALLS, 0xf2u)
61*0c333f8cSAndrew Turner
62*0c333f8cSAndrew Turner static device_identify_t errata_identify;
63*0c333f8cSAndrew Turner static device_probe_t errata_probe;
64*0c333f8cSAndrew Turner static device_attach_t errata_attach;
65*0c333f8cSAndrew Turner static cpu_feat_errata errata_cpu_feat_errata_check(const struct cpu_feat *,
66*0c333f8cSAndrew Turner u_int);
67*0c333f8cSAndrew Turner
68*0c333f8cSAndrew Turner static void
errata_identify(driver_t * driver,device_t parent)69*0c333f8cSAndrew Turner errata_identify(driver_t *driver, device_t parent)
70*0c333f8cSAndrew Turner {
71*0c333f8cSAndrew Turner int32_t version;
72*0c333f8cSAndrew Turner
73*0c333f8cSAndrew Turner if (smccc_get_version() < SMCCC_MAKE_VERSION(1, 1))
74*0c333f8cSAndrew Turner return;
75*0c333f8cSAndrew Turner
76*0c333f8cSAndrew Turner /* Check we have Errata 1.0 or later */
77*0c333f8cSAndrew Turner version = psci_call(EM_VERSION, 0, 0, 0);
78*0c333f8cSAndrew Turner if (version < EM_VERSION_MIN)
79*0c333f8cSAndrew Turner return;
80*0c333f8cSAndrew Turner
81*0c333f8cSAndrew Turner if (BUS_ADD_CHILD(parent, 0, "errata", -1) == NULL)
82*0c333f8cSAndrew Turner device_printf(parent, "add errata child failed\n");
83*0c333f8cSAndrew Turner }
84*0c333f8cSAndrew Turner
85*0c333f8cSAndrew Turner static int
errata_probe(device_t dev)86*0c333f8cSAndrew Turner errata_probe(device_t dev)
87*0c333f8cSAndrew Turner {
88*0c333f8cSAndrew Turner device_set_desc(dev, "Arm SMCCC Errata Management");
89*0c333f8cSAndrew Turner return (BUS_PROBE_NOWILDCARD);
90*0c333f8cSAndrew Turner }
91*0c333f8cSAndrew Turner
92*0c333f8cSAndrew Turner static int
errata_attach(device_t dev)93*0c333f8cSAndrew Turner errata_attach(device_t dev)
94*0c333f8cSAndrew Turner {
95*0c333f8cSAndrew Turner /* Check for EM_CPU_ERRATUM_FEATURES. It's mandatory, so should exist */
96*0c333f8cSAndrew Turner if (arm_smccc_invoke(EM_FEATURES, EM_CPU_ERRATUM_FEATURES, NULL) < 0) {
97*0c333f8cSAndrew Turner device_printf(dev,
98*0c333f8cSAndrew Turner "EM_CPU_ERRATUM_FEATURES is not implemented\n");
99*0c333f8cSAndrew Turner return (ENXIO);
100*0c333f8cSAndrew Turner }
101*0c333f8cSAndrew Turner
102*0c333f8cSAndrew Turner cpu_feat_register_errata_check(errata_cpu_feat_errata_check);
103*0c333f8cSAndrew Turner
104*0c333f8cSAndrew Turner return (0);
105*0c333f8cSAndrew Turner }
106*0c333f8cSAndrew Turner
107*0c333f8cSAndrew Turner static cpu_feat_errata
errata_cpu_feat_errata_check(const struct cpu_feat * feat __unused,u_int errata_id)108*0c333f8cSAndrew Turner errata_cpu_feat_errata_check(const struct cpu_feat *feat __unused, u_int errata_id)
109*0c333f8cSAndrew Turner {
110*0c333f8cSAndrew Turner struct arm_smccc_res res;
111*0c333f8cSAndrew Turner
112*0c333f8cSAndrew Turner switch(arm_smccc_invoke(EM_CPU_ERRATUM_FEATURES, errata_id, 0, &res)) {
113*0c333f8cSAndrew Turner default:
114*0c333f8cSAndrew Turner return (ERRATA_UNKNOWN);
115*0c333f8cSAndrew Turner case ERRATA_NOT_AFFECTED:
116*0c333f8cSAndrew Turner return (ERRATA_NONE);
117*0c333f8cSAndrew Turner case ERRATA_AFFECTED:
118*0c333f8cSAndrew Turner return (ERRATA_AFFECTED);
119*0c333f8cSAndrew Turner case ERRATA_HIGHER_EL_MITIGATION:
120*0c333f8cSAndrew Turner return (ERRATA_FW_MITIGAION);
121*0c333f8cSAndrew Turner }
122*0c333f8cSAndrew Turner }
123*0c333f8cSAndrew Turner
124*0c333f8cSAndrew Turner static device_method_t errata_methods[] = {
125*0c333f8cSAndrew Turner DEVMETHOD(device_identify, errata_identify),
126*0c333f8cSAndrew Turner DEVMETHOD(device_probe, errata_probe),
127*0c333f8cSAndrew Turner DEVMETHOD(device_attach, errata_attach),
128*0c333f8cSAndrew Turner
129*0c333f8cSAndrew Turner DEVMETHOD_END
130*0c333f8cSAndrew Turner };
131*0c333f8cSAndrew Turner
132*0c333f8cSAndrew Turner static driver_t errata_driver = {
133*0c333f8cSAndrew Turner "errata",
134*0c333f8cSAndrew Turner errata_methods,
135*0c333f8cSAndrew Turner 0
136*0c333f8cSAndrew Turner };
137*0c333f8cSAndrew Turner
138*0c333f8cSAndrew Turner DRIVER_MODULE(errata, smccc, errata_driver, 0, 0);
139