2 * Copyright (c) 2014 Robin Randhawa
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * This implements support for ARM's Power State Co-ordination Interface
30 * [PSCI]. The implementation adheres to version 0.2 of the PSCI specification
31 * but also supports v0.1. PSCI standardizes operations such as system reset, CPU
32 * on/off/suspend. PSCI requires a compliant firmware implementation.
34 * The PSCI specification used for this implementation is available at:
36 * <http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.den0022b/index.html>.
39 * - Add support for remaining PSCI calls [this implementation only
40 * supports get_version, system_reset and cpu_on].
43 #include <sys/cdefs.h>
44 __FBSDID("$FreeBSD$");
47 #include "opt_platform.h"
49 #include <sys/param.h>
50 #include <sys/systm.h>
52 #include <sys/eventhandler.h>
53 #include <sys/kernel.h>
54 #include <sys/module.h>
55 #include <sys/reboot.h>
57 #include <machine/bus.h>
58 #include <machine/machdep.h>
61 #include <contrib/dev/acpica/include/acpi.h>
62 #include <dev/acpica/acpivar.h>
66 #include <dev/fdt/fdt_common.h>
67 #include <dev/ofw/openfirm.h>
68 #include <dev/ofw/ofw_bus.h>
69 #include <dev/ofw/ofw_bus_subr.h>
72 #include <dev/psci/psci.h>
77 uint32_t psci_version;
78 uint32_t psci_fnids[PSCI_FN_MAX];
82 static int psci_v0_1_init(device_t dev, int default_version);
84 static int psci_v0_2_init(device_t dev, int default_version);
86 struct psci_softc *psci_softc = NULL;
91 #elif defined(__aarch64__)
92 #define USE_ACPI (arm64_bus_method == ARM64_BUS_ACPI)
93 #define USE_FDT (arm64_bus_method == ARM64_BUS_FDT)
95 #error Unknown architecture
99 struct psci_init_def {
101 psci_initfn_t psci_init;
104 static struct psci_init_def psci_v1_0_init_def = {
105 .default_version = (1 << 16) | 0,
106 .psci_init = psci_v0_2_init
109 static struct psci_init_def psci_v0_2_init_def = {
110 .default_version = (0 << 16) | 2,
111 .psci_init = psci_v0_2_init
114 static struct psci_init_def psci_v0_1_init_def = {
115 .default_version = (0 << 16) | 1,
116 .psci_init = psci_v0_1_init
119 static struct ofw_compat_data compat_data[] = {
120 {"arm,psci-1.0", (uintptr_t)&psci_v1_0_init_def},
121 {"arm,psci-0.2", (uintptr_t)&psci_v0_2_init_def},
122 {"arm,psci", (uintptr_t)&psci_v0_1_init_def},
127 static int psci_attach(device_t, psci_initfn_t, int);
128 static void psci_shutdown(void *, int);
130 static int psci_find_callfn(psci_callfn_t *);
131 static int psci_def_callfn(register_t, register_t, register_t, register_t,
132 register_t, register_t, register_t, register_t,
133 struct arm_smccc_res *res);
135 psci_callfn_t psci_callfn = psci_def_callfn;
138 psci_init(void *dummy)
140 psci_callfn_t new_callfn;
142 if (psci_find_callfn(&new_callfn) != PSCI_RETVAL_SUCCESS) {
143 printf("No PSCI/SMCCC call function found\n");
147 psci_callfn = new_callfn;
149 /* This needs to be before cpu_mp at SI_SUB_CPU, SI_ORDER_THIRD */
150 SYSINIT(psci_start, SI_SUB_CPU, SI_ORDER_FIRST, psci_init, NULL);
153 psci_def_callfn(register_t a __unused, register_t b __unused,
154 register_t c __unused, register_t d __unused,
155 register_t e __unused, register_t f __unused,
156 register_t g __unused, register_t h __unused,
157 struct arm_smccc_res *res __unused)
160 panic("No PSCI/SMCCC call function set");
164 static int psci_fdt_probe(device_t dev);
165 static int psci_fdt_attach(device_t dev);
167 static device_method_t psci_fdt_methods[] = {
168 DEVMETHOD(device_probe, psci_fdt_probe),
169 DEVMETHOD(device_attach, psci_fdt_attach),
174 static driver_t psci_fdt_driver = {
177 sizeof(struct psci_softc),
180 static devclass_t psci_fdt_devclass;
182 EARLY_DRIVER_MODULE(psci, simplebus, psci_fdt_driver, psci_fdt_devclass, 0, 0,
183 BUS_PASS_CPU + BUS_PASS_ORDER_FIRST);
184 EARLY_DRIVER_MODULE(psci, ofwbus, psci_fdt_driver, psci_fdt_devclass, 0, 0,
185 BUS_PASS_CPU + BUS_PASS_ORDER_FIRST);
188 psci_fdt_get_callfn(phandle_t node)
192 if ((OF_getprop(node, "method", method, sizeof(method))) > 0) {
193 if (strcmp(method, "hvc") == 0)
194 return (arm_smccc_hvc);
195 else if (strcmp(method, "smc") == 0)
196 return (arm_smccc_smc);
198 printf("psci: PSCI conduit \"%s\" invalid\n", method);
200 printf("psci: PSCI conduit not supplied in the device tree\n");
206 psci_fdt_probe(device_t dev)
208 const struct ofw_compat_data *ocd;
210 if (!ofw_bus_status_okay(dev))
213 ocd = ofw_bus_search_compatible(dev, compat_data);
214 if (ocd->ocd_str == NULL)
217 device_set_desc(dev, "ARM Power State Co-ordination Interface Driver");
219 return (BUS_PROBE_SPECIFIC);
223 psci_fdt_attach(device_t dev)
225 const struct ofw_compat_data *ocd;
226 struct psci_init_def *psci_init_def;
228 ocd = ofw_bus_search_compatible(dev, compat_data);
229 psci_init_def = (struct psci_init_def *)ocd->ocd_data;
231 return (psci_attach(dev, psci_init_def->psci_init,
232 psci_init_def->default_version));
237 static void psci_acpi_identify(driver_t *, device_t);
238 static int psci_acpi_probe(device_t);
239 static int psci_acpi_attach(device_t);
241 static device_method_t psci_acpi_methods[] = {
242 /* Device interface */
243 DEVMETHOD(device_identify, psci_acpi_identify),
244 DEVMETHOD(device_probe, psci_acpi_probe),
245 DEVMETHOD(device_attach, psci_acpi_attach),
250 static driver_t psci_acpi_driver = {
253 sizeof(struct psci_softc),
256 static devclass_t psci_acpi_devclass;
258 EARLY_DRIVER_MODULE(psci, acpi, psci_acpi_driver, psci_acpi_devclass, 0, 0,
259 BUS_PASS_CPU + BUS_PASS_ORDER_FIRST);
262 psci_acpi_bootflags(void)
264 ACPI_TABLE_FADT *fadt;
268 physaddr = acpi_find_table(ACPI_SIG_FADT);
272 fadt = acpi_map_table(physaddr, ACPI_SIG_FADT);
274 printf("psci: Unable to map the FADT\n");
278 flags = fadt->ArmBootFlags;
280 acpi_unmap_table(fadt);
285 psci_acpi_get_callfn(int flags)
288 if ((flags & ACPI_FADT_PSCI_COMPLIANT) != 0) {
289 if ((flags & ACPI_FADT_PSCI_USE_HVC) != 0)
290 return (arm_smccc_hvc);
292 return (arm_smccc_smc);
294 printf("psci: PSCI conduit not supplied in the device tree\n");
301 psci_acpi_identify(driver_t *driver, device_t parent)
306 flags = psci_acpi_bootflags();
307 if ((flags & ACPI_FADT_PSCI_COMPLIANT) != 0) {
308 dev = BUS_ADD_CHILD(parent,
309 BUS_PASS_CPU + BUS_PASS_ORDER_FIRST, "psci", -1);
312 acpi_set_private(dev, (void *)(uintptr_t)flags);
317 psci_acpi_probe(device_t dev)
321 flags = (uintptr_t)acpi_get_private(dev);
322 if ((flags & ACPI_FADT_PSCI_COMPLIANT) == 0)
325 device_set_desc(dev, "ARM Power State Co-ordination Interface Driver");
326 return (BUS_PROBE_SPECIFIC);
330 psci_acpi_attach(device_t dev)
333 return (psci_attach(dev, psci_v0_2_init, PSCI_RETVAL_NOT_SUPPORTED));
338 psci_attach(device_t dev, psci_initfn_t psci_init, int default_version)
340 struct psci_softc *sc = device_get_softc(dev);
342 if (psci_softc != NULL)
345 KASSERT(psci_init != NULL, ("PSCI init function cannot be NULL"));
346 if (psci_init(dev, default_version))
355 _psci_get_version(struct psci_softc *sc)
359 /* PSCI version wasn't supported in v0.1. */
360 fnid = sc->psci_fnids[PSCI_FN_VERSION];
362 return (psci_call(fnid, 0, 0, 0));
364 return (PSCI_RETVAL_NOT_SUPPORTED);
368 psci_get_version(void)
371 if (psci_softc == NULL)
372 return (PSCI_RETVAL_NOT_SUPPORTED);
373 return (_psci_get_version(psci_softc));
378 psci_fdt_callfn(psci_callfn_t *callfn)
382 node = ofw_bus_find_compatible(OF_peer(0), "arm,psci-0.2");
384 node = ofw_bus_find_compatible(OF_peer(0), "arm,psci-1.0");
386 return (PSCI_MISSING);
389 *callfn = psci_fdt_get_callfn(node);
396 psci_acpi_callfn(psci_callfn_t *callfn)
400 flags = psci_acpi_bootflags();
401 if ((flags & ACPI_FADT_PSCI_COMPLIANT) == 0)
402 return (PSCI_MISSING);
404 *callfn = psci_acpi_get_callfn(flags);
410 psci_find_callfn(psci_callfn_t *callfn)
417 error = psci_fdt_callfn(callfn);
423 if (*callfn == NULL && USE_ACPI) {
424 error = psci_acpi_callfn(callfn);
431 return (PSCI_MISSING);
433 return (PSCI_RETVAL_SUCCESS);
437 psci_features(uint32_t psci_func_id)
440 if (psci_softc == NULL)
441 return (PSCI_RETVAL_NOT_SUPPORTED);
443 /* The feature flags were added to PSCI 1.0 */
444 if (PSCI_VER_MAJOR(psci_softc->psci_version) < 1)
445 return (PSCI_RETVAL_NOT_SUPPORTED);
447 return (psci_call(PSCI_FNID_FEATURES, psci_func_id, 0, 0));
451 psci_cpu_on(unsigned long cpu, unsigned long entry, unsigned long context_id)
455 fnid = PSCI_FNID_CPU_ON;
456 if (psci_softc != NULL)
457 fnid = psci_softc->psci_fnids[PSCI_FN_CPU_ON];
459 /* PSCI v0.1 and v0.2 both support cpu_on. */
460 return (psci_call(fnid, cpu, entry, context_id));
464 psci_shutdown(void *xsc, int howto)
468 if (psci_softc == NULL)
471 /* PSCI system_off and system_reset werent't supported in v0.1. */
472 if ((howto & RB_POWEROFF) != 0)
473 fn = psci_softc->psci_fnids[PSCI_FN_SYSTEM_OFF];
474 else if ((howto & RB_HALT) == 0)
475 fn = psci_softc->psci_fnids[PSCI_FN_SYSTEM_RESET];
478 psci_call(fn, 0, 0, 0);
480 /* System reset and off do not return. */
487 psci_shutdown(NULL, 0);
491 /* Only support PSCI 0.1 on FDT */
493 psci_v0_1_init(device_t dev, int default_version __unused)
495 struct psci_softc *sc = device_get_softc(dev);
502 /* Zero out the function ID table - Is this needed ? */
503 for (psci_fn = PSCI_FN_VERSION, psci_fnid = PSCI_FNID_VERSION;
504 psci_fn < PSCI_FN_MAX; psci_fn++, psci_fnid++)
505 sc->psci_fnids[psci_fn] = 0;
507 /* PSCI v0.1 doesn't specify function IDs. Get them from DT */
508 node = ofw_bus_get_node(dev);
510 if ((len = OF_getproplen(node, "cpu_suspend")) > 0) {
511 OF_getencprop(node, "cpu_suspend", &psci_fnid, len);
512 sc->psci_fnids[PSCI_FN_CPU_SUSPEND] = psci_fnid;
515 if ((len = OF_getproplen(node, "cpu_on")) > 0) {
516 OF_getencprop(node, "cpu_on", &psci_fnid, len);
517 sc->psci_fnids[PSCI_FN_CPU_ON] = psci_fnid;
520 if ((len = OF_getproplen(node, "cpu_off")) > 0) {
521 OF_getencprop(node, "cpu_off", &psci_fnid, len);
522 sc->psci_fnids[PSCI_FN_CPU_OFF] = psci_fnid;
525 if ((len = OF_getproplen(node, "migrate")) > 0) {
526 OF_getencprop(node, "migrate", &psci_fnid, len);
527 sc->psci_fnids[PSCI_FN_MIGRATE] = psci_fnid;
530 sc->psci_version = (0 << 16) | 1;
532 device_printf(dev, "PSCI version 0.1 available\n");
539 psci_v0_2_init(device_t dev, int default_version)
541 struct psci_softc *sc = device_get_softc(dev);
544 /* PSCI v0.2 specifies explicit function IDs. */
545 sc->psci_fnids[PSCI_FN_VERSION] = PSCI_FNID_VERSION;
546 sc->psci_fnids[PSCI_FN_CPU_SUSPEND] = PSCI_FNID_CPU_SUSPEND;
547 sc->psci_fnids[PSCI_FN_CPU_OFF] = PSCI_FNID_CPU_OFF;
548 sc->psci_fnids[PSCI_FN_CPU_ON] = PSCI_FNID_CPU_ON;
549 sc->psci_fnids[PSCI_FN_AFFINITY_INFO] = PSCI_FNID_AFFINITY_INFO;
550 sc->psci_fnids[PSCI_FN_MIGRATE] = PSCI_FNID_MIGRATE;
551 sc->psci_fnids[PSCI_FN_MIGRATE_INFO_TYPE] = PSCI_FNID_MIGRATE_INFO_TYPE;
552 sc->psci_fnids[PSCI_FN_MIGRATE_INFO_UP_CPU] = PSCI_FNID_MIGRATE_INFO_UP_CPU;
553 sc->psci_fnids[PSCI_FN_SYSTEM_OFF] = PSCI_FNID_SYSTEM_OFF;
554 sc->psci_fnids[PSCI_FN_SYSTEM_RESET] = PSCI_FNID_SYSTEM_RESET;
556 version = _psci_get_version(sc);
559 * U-Boot PSCI implementation doesn't have psci_get_version()
560 * method implemented for many boards. In this case, use the version
561 * readed from FDT as fallback. No fallback method for ACPI.
563 if (version == PSCI_RETVAL_NOT_SUPPORTED) {
564 if (default_version == PSCI_RETVAL_NOT_SUPPORTED)
567 version = default_version;
568 printf("PSCI get_version() function is not implemented, "
569 " assuming v%d.%d\n", PSCI_VER_MAJOR(version),
570 PSCI_VER_MINOR(version));
573 sc->psci_version = version;
574 if ((PSCI_VER_MAJOR(version) == 0 && PSCI_VER_MINOR(version) == 2) ||
575 PSCI_VER_MAJOR(version) == 1) {
577 device_printf(dev, "PSCI version 0.2 compatible\n");
580 * We only register this for v0.2 since v0.1 doesn't support
583 EVENTHANDLER_REGISTER(shutdown_final, psci_shutdown, sc,
589 device_printf(dev, "PSCI version number mismatched with DT\n");