1 /*-
2 * Copyright (c) 2014 Robin Randhawa
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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.
13 *
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
24 * SUCH DAMAGE.
25 *
26 */
27
28 /*
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.
33 *
34 * The PSCI specification used for this implementation is available at:
35 *
36 * <http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.den0022b/index.html>.
37 *
38 * TODO:
39 * - Add support for remaining PSCI calls [this implementation only
40 * supports get_version, system_reset and cpu_on].
41 */
42
43 #include <sys/cdefs.h>
44 #include "opt_acpi.h"
45 #include "opt_platform.h"
46
47 #include <sys/param.h>
48 #include <sys/systm.h>
49 #include <sys/bus.h>
50 #include <sys/eventhandler.h>
51 #include <sys/kernel.h>
52 #include <sys/module.h>
53 #include <sys/reboot.h>
54
55 #include <machine/bus.h>
56 #include <machine/machdep.h>
57
58 #ifdef DEV_ACPI
59 #include <contrib/dev/acpica/include/acpi.h>
60 #include <dev/acpica/acpivar.h>
61 #endif
62
63 #ifdef FDT
64 #include <dev/fdt/fdt_common.h>
65 #include <dev/ofw/openfirm.h>
66 #include <dev/ofw/ofw_bus.h>
67 #include <dev/ofw/ofw_bus_subr.h>
68 #endif
69
70 #include <dev/psci/psci.h>
71
72 struct psci_softc {
73 device_t dev;
74 device_t smccc_dev;
75
76 uint32_t psci_version;
77 uint32_t psci_fnids[PSCI_FN_MAX];
78 };
79
80 #ifdef FDT
81 static int psci_v0_1_init(device_t dev, int default_version);
82 #endif
83 static int psci_v0_2_init(device_t dev, int default_version);
84
85 struct psci_softc *psci_softc = NULL;
86 bool psci_present;
87
88 #ifdef __arm__
89 #define USE_ACPI 0
90 #define USE_FDT 1
91 #elif defined(__aarch64__)
92 #define USE_ACPI (arm64_bus_method == ARM64_BUS_ACPI)
93 #define USE_FDT (arm64_bus_method == ARM64_BUS_FDT)
94 #else
95 #error Unknown architecture
96 #endif
97
98 #ifdef FDT
99 struct psci_init_def {
100 int default_version;
101 psci_initfn_t psci_init;
102 };
103
104 static struct psci_init_def psci_v1_0_init_def = {
105 .default_version = (1 << 16) | 0,
106 .psci_init = psci_v0_2_init
107 };
108
109 static struct psci_init_def psci_v0_2_init_def = {
110 .default_version = (0 << 16) | 2,
111 .psci_init = psci_v0_2_init
112 };
113
114 static struct psci_init_def psci_v0_1_init_def = {
115 .default_version = (0 << 16) | 1,
116 .psci_init = psci_v0_1_init
117 };
118
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},
123 {NULL, 0}
124 };
125 #endif
126
127 static int psci_attach(device_t, psci_initfn_t, int);
128
129 static int psci_find_callfn(psci_callfn_t *);
130 static int psci_def_callfn(register_t, register_t, register_t, register_t,
131 register_t, register_t, register_t, register_t,
132 struct arm_smccc_res *res);
133
134 psci_callfn_t psci_callfn = psci_def_callfn;
135
136 void
psci_init(void * dummy)137 psci_init(void *dummy)
138 {
139 psci_callfn_t new_callfn;
140
141 if (psci_find_callfn(&new_callfn) != PSCI_RETVAL_SUCCESS) {
142 printf("No PSCI/SMCCC call function found\n");
143 return;
144 }
145
146 psci_callfn = new_callfn;
147 psci_present = true;
148 }
149
150 #ifdef __arm__
151 /* This needs to be before cpu_mp at SI_SUB_CPU, SI_ORDER_THIRD */
152 SYSINIT(psci_start, SI_SUB_CPU, SI_ORDER_FIRST, psci_init, NULL);
153 #endif
154
155 static int
psci_def_callfn(register_t a __unused,register_t b __unused,register_t c __unused,register_t d __unused,register_t e __unused,register_t f __unused,register_t g __unused,register_t h __unused,struct arm_smccc_res * res __unused)156 psci_def_callfn(register_t a __unused, register_t b __unused,
157 register_t c __unused, register_t d __unused,
158 register_t e __unused, register_t f __unused,
159 register_t g __unused, register_t h __unused,
160 struct arm_smccc_res *res __unused)
161 {
162
163 panic("No PSCI/SMCCC call function set");
164 }
165
166 #ifdef FDT
167 static int psci_fdt_probe(device_t dev);
168 static int psci_fdt_attach(device_t dev);
169
170 static device_method_t psci_fdt_methods[] = {
171 DEVMETHOD(device_probe, psci_fdt_probe),
172 DEVMETHOD(device_attach, psci_fdt_attach),
173
174 DEVMETHOD_END
175 };
176
177 static driver_t psci_fdt_driver = {
178 "psci",
179 psci_fdt_methods,
180 sizeof(struct psci_softc),
181 };
182
183 EARLY_DRIVER_MODULE(psci, simplebus, psci_fdt_driver, 0, 0,
184 BUS_PASS_CPU + BUS_PASS_ORDER_FIRST);
185 EARLY_DRIVER_MODULE(psci, ofwbus, psci_fdt_driver, 0, 0,
186 BUS_PASS_CPU + BUS_PASS_ORDER_FIRST);
187
188 static psci_callfn_t
psci_fdt_get_callfn(phandle_t node)189 psci_fdt_get_callfn(phandle_t node)
190 {
191 char method[16];
192
193 if ((OF_getprop(node, "method", method, sizeof(method))) > 0) {
194 if (strcmp(method, "hvc") == 0)
195 return (arm_smccc_hvc);
196 else if (strcmp(method, "smc") == 0)
197 return (arm_smccc_smc);
198 else
199 printf("psci: PSCI conduit \"%s\" invalid\n", method);
200 } else
201 printf("psci: PSCI conduit not supplied in the device tree\n");
202
203 return (NULL);
204 }
205
206 static int
psci_fdt_probe(device_t dev)207 psci_fdt_probe(device_t dev)
208 {
209 const struct ofw_compat_data *ocd;
210
211 if (!ofw_bus_status_okay(dev))
212 return (ENXIO);
213
214 ocd = ofw_bus_search_compatible(dev, compat_data);
215 if (ocd->ocd_str == NULL)
216 return (ENXIO);
217
218 device_set_desc(dev, "ARM Power State Co-ordination Interface Driver");
219
220 return (BUS_PROBE_SPECIFIC);
221 }
222
223 static int
psci_fdt_attach(device_t dev)224 psci_fdt_attach(device_t dev)
225 {
226 const struct ofw_compat_data *ocd;
227 struct psci_init_def *psci_init_def;
228
229 ocd = ofw_bus_search_compatible(dev, compat_data);
230 psci_init_def = (struct psci_init_def *)ocd->ocd_data;
231
232 return (psci_attach(dev, psci_init_def->psci_init,
233 psci_init_def->default_version));
234 }
235 #endif
236
237 #ifdef DEV_ACPI
238 static void psci_acpi_identify(driver_t *, device_t);
239 static int psci_acpi_probe(device_t);
240 static int psci_acpi_attach(device_t);
241
242 static device_method_t psci_acpi_methods[] = {
243 /* Device interface */
244 DEVMETHOD(device_identify, psci_acpi_identify),
245 DEVMETHOD(device_probe, psci_acpi_probe),
246 DEVMETHOD(device_attach, psci_acpi_attach),
247
248 DEVMETHOD_END
249 };
250
251 static driver_t psci_acpi_driver = {
252 "psci",
253 psci_acpi_methods,
254 sizeof(struct psci_softc),
255 };
256
257 EARLY_DRIVER_MODULE(psci, acpi, psci_acpi_driver, 0, 0,
258 BUS_PASS_CPU + BUS_PASS_ORDER_FIRST);
259
260 static int
psci_acpi_bootflags(void)261 psci_acpi_bootflags(void)
262 {
263 ACPI_TABLE_FADT *fadt;
264 vm_paddr_t physaddr;
265 int flags;
266
267 physaddr = acpi_find_table(ACPI_SIG_FADT);
268 if (physaddr == 0)
269 return (0);
270
271 fadt = acpi_map_table(physaddr, ACPI_SIG_FADT);
272 if (fadt == NULL) {
273 printf("psci: Unable to map the FADT\n");
274 return (0);
275 }
276
277 flags = fadt->ArmBootFlags;
278
279 acpi_unmap_table(fadt);
280 return (flags);
281 }
282
283 static psci_callfn_t
psci_acpi_get_callfn(int flags)284 psci_acpi_get_callfn(int flags)
285 {
286
287 if ((flags & ACPI_FADT_PSCI_COMPLIANT) != 0) {
288 if ((flags & ACPI_FADT_PSCI_USE_HVC) != 0)
289 return (arm_smccc_hvc);
290 else
291 return (arm_smccc_smc);
292 } else {
293 printf("psci: PSCI conduit not supplied in the device tree\n");
294 }
295
296 return (NULL);
297 }
298
299 static void
psci_acpi_identify(driver_t * driver,device_t parent)300 psci_acpi_identify(driver_t *driver, device_t parent)
301 {
302 device_t dev;
303 int flags;
304
305 flags = psci_acpi_bootflags();
306 if ((flags & ACPI_FADT_PSCI_COMPLIANT) != 0) {
307 dev = BUS_ADD_CHILD(parent,
308 BUS_PASS_CPU + BUS_PASS_ORDER_FIRST, "psci", -1);
309
310 if (dev != NULL)
311 acpi_set_private(dev, (void *)(uintptr_t)flags);
312 }
313 }
314
315 static int
psci_acpi_probe(device_t dev)316 psci_acpi_probe(device_t dev)
317 {
318 uintptr_t flags;
319
320 flags = (uintptr_t)acpi_get_private(dev);
321 if ((flags & ACPI_FADT_PSCI_COMPLIANT) == 0)
322 return (ENXIO);
323
324 device_set_desc(dev, "ARM Power State Co-ordination Interface Driver");
325 return (BUS_PROBE_SPECIFIC);
326 }
327
328 static int
psci_acpi_attach(device_t dev)329 psci_acpi_attach(device_t dev)
330 {
331
332 return (psci_attach(dev, psci_v0_2_init, PSCI_RETVAL_NOT_SUPPORTED));
333 }
334 #endif
335
336 static int
psci_attach(device_t dev,psci_initfn_t psci_init,int default_version)337 psci_attach(device_t dev, psci_initfn_t psci_init, int default_version)
338 {
339 struct psci_softc *sc = device_get_softc(dev);
340
341 if (psci_softc != NULL)
342 return (ENXIO);
343
344 KASSERT(psci_init != NULL, ("PSCI init function cannot be NULL"));
345 if (psci_init(dev, default_version))
346 return (ENXIO);
347
348 psci_softc = sc;
349
350 #ifdef __aarch64__
351 smccc_init();
352 sc->smccc_dev = device_add_child(dev, "smccc", DEVICE_UNIT_ANY);
353 if (sc->smccc_dev == NULL)
354 device_printf(dev, "Unable to add SMCCC device\n");
355
356 bus_attach_children(dev);
357 #endif
358
359 return (0);
360 }
361
362 static int
_psci_get_version(struct psci_softc * sc)363 _psci_get_version(struct psci_softc *sc)
364 {
365 uint32_t fnid;
366
367 /* PSCI version wasn't supported in v0.1. */
368 fnid = sc->psci_fnids[PSCI_FN_VERSION];
369 if (fnid)
370 return (psci_call(fnid, 0, 0, 0));
371
372 return (PSCI_RETVAL_NOT_SUPPORTED);
373 }
374
375 int
psci_get_version(void)376 psci_get_version(void)
377 {
378
379 if (psci_softc == NULL)
380 return (PSCI_RETVAL_NOT_SUPPORTED);
381 return (_psci_get_version(psci_softc));
382 }
383
384 #ifdef FDT
385 static int
psci_fdt_callfn(psci_callfn_t * callfn)386 psci_fdt_callfn(psci_callfn_t *callfn)
387 {
388 phandle_t node;
389
390 /* XXX: This is suboptimal, we should walk the tree & check each
391 * node against compat_data, but we only have a few entries so
392 * it's ok for now.
393 */
394 for (int i = 0; compat_data[i].ocd_str != NULL; i++) {
395 node = ofw_bus_find_compatible(OF_peer(0),
396 compat_data[i].ocd_str);
397 if (node != 0)
398 break;
399 }
400 if (node == 0)
401 return (PSCI_MISSING);
402
403 if (!ofw_bus_node_status_okay(node))
404 return (PSCI_MISSING);
405
406 *callfn = psci_fdt_get_callfn(node);
407 return (0);
408 }
409 #endif
410
411 #ifdef DEV_ACPI
412 static int
psci_acpi_callfn(psci_callfn_t * callfn)413 psci_acpi_callfn(psci_callfn_t *callfn)
414 {
415 int flags;
416
417 flags = psci_acpi_bootflags();
418 if ((flags & ACPI_FADT_PSCI_COMPLIANT) == 0)
419 return (PSCI_MISSING);
420
421 *callfn = psci_acpi_get_callfn(flags);
422 return (0);
423 }
424 #endif
425
426 static int
psci_find_callfn(psci_callfn_t * callfn)427 psci_find_callfn(psci_callfn_t *callfn)
428 {
429 int error;
430
431 *callfn = NULL;
432 #ifdef FDT
433 if (USE_FDT) {
434 error = psci_fdt_callfn(callfn);
435 if (error != 0)
436 return (error);
437 }
438 #endif
439 #ifdef DEV_ACPI
440 if (*callfn == NULL && USE_ACPI) {
441 error = psci_acpi_callfn(callfn);
442 if (error != 0)
443 return (error);
444 }
445 #endif
446
447 if (*callfn == NULL)
448 return (PSCI_MISSING);
449
450 return (PSCI_RETVAL_SUCCESS);
451 }
452
453 int32_t
psci_features(uint32_t psci_func_id)454 psci_features(uint32_t psci_func_id)
455 {
456
457 if (psci_softc == NULL)
458 return (PSCI_RETVAL_NOT_SUPPORTED);
459
460 /* The feature flags were added to PSCI 1.0 */
461 if (PSCI_VER_MAJOR(psci_softc->psci_version) < 1)
462 return (PSCI_RETVAL_NOT_SUPPORTED);
463
464 return (psci_call(PSCI_FNID_FEATURES, psci_func_id, 0, 0));
465 }
466
467 int
psci_cpu_on(unsigned long cpu,unsigned long entry,unsigned long context_id)468 psci_cpu_on(unsigned long cpu, unsigned long entry, unsigned long context_id)
469 {
470 uint32_t fnid;
471
472 fnid = PSCI_FNID_CPU_ON;
473 if (psci_softc != NULL)
474 fnid = psci_softc->psci_fnids[PSCI_FN_CPU_ON];
475
476 /* PSCI v0.1 and v0.2 both support cpu_on. */
477 return (psci_call(fnid, cpu, entry, context_id));
478 }
479
480 int
psci_cpu_off(void)481 psci_cpu_off(void)
482 {
483 uint32_t fnid;
484
485 fnid = PSCI_FNID_CPU_OFF;
486 if (psci_softc != NULL)
487 fnid = psci_softc->psci_fnids[PSCI_FN_CPU_OFF];
488
489 /* Returns PSCI_RETVAL_DENIED on error. */
490 return (psci_call(fnid, 0, 0, 0));
491 }
492
493 static void
psci_shutdown(void * xsc,int howto)494 psci_shutdown(void *xsc, int howto)
495 {
496 uint32_t fn = 0;
497
498 if (psci_softc == NULL)
499 return;
500
501 if ((howto & RB_POWEROFF) != 0)
502 fn = psci_softc->psci_fnids[PSCI_FN_SYSTEM_OFF];
503 if (fn)
504 psci_call(fn, 0, 0, 0);
505
506 /* System reset and off do not return. */
507 }
508
509 static void
psci_reboot(void * xsc,int howto)510 psci_reboot(void *xsc, int howto)
511 {
512 uint32_t fn = 0;
513
514 if (psci_softc == NULL)
515 return;
516
517 if ((howto & RB_HALT) == 0)
518 fn = psci_softc->psci_fnids[PSCI_FN_SYSTEM_RESET];
519 if (fn)
520 psci_call(fn, 0, 0, 0);
521
522 /* System reset and off do not return. */
523 }
524
525 void
psci_reset(void)526 psci_reset(void)
527 {
528
529 psci_reboot(NULL, 0);
530 }
531
532 #ifdef FDT
533 /* Only support PSCI 0.1 on FDT */
534 static int
psci_v0_1_init(device_t dev,int default_version __unused)535 psci_v0_1_init(device_t dev, int default_version __unused)
536 {
537 struct psci_softc *sc = device_get_softc(dev);
538 int psci_fn;
539 uint32_t psci_fnid;
540 phandle_t node;
541 int len;
542
543 /* Zero out the function ID table - Is this needed ? */
544 for (psci_fn = PSCI_FN_VERSION, psci_fnid = PSCI_FNID_VERSION;
545 psci_fn < PSCI_FN_MAX; psci_fn++, psci_fnid++)
546 sc->psci_fnids[psci_fn] = 0;
547
548 /* PSCI v0.1 doesn't specify function IDs. Get them from DT */
549 node = ofw_bus_get_node(dev);
550
551 if ((len = OF_getproplen(node, "cpu_suspend")) > 0) {
552 OF_getencprop(node, "cpu_suspend", &psci_fnid, len);
553 sc->psci_fnids[PSCI_FN_CPU_SUSPEND] = psci_fnid;
554 }
555
556 if ((len = OF_getproplen(node, "cpu_on")) > 0) {
557 OF_getencprop(node, "cpu_on", &psci_fnid, len);
558 sc->psci_fnids[PSCI_FN_CPU_ON] = psci_fnid;
559 }
560
561 if ((len = OF_getproplen(node, "cpu_off")) > 0) {
562 OF_getencprop(node, "cpu_off", &psci_fnid, len);
563 sc->psci_fnids[PSCI_FN_CPU_OFF] = psci_fnid;
564 }
565
566 if ((len = OF_getproplen(node, "migrate")) > 0) {
567 OF_getencprop(node, "migrate", &psci_fnid, len);
568 sc->psci_fnids[PSCI_FN_MIGRATE] = psci_fnid;
569 }
570
571 sc->psci_version = (0 << 16) | 1;
572 if (bootverbose)
573 device_printf(dev, "PSCI version 0.1 available\n");
574
575 return(0);
576 }
577 #endif
578
579 static int
psci_v0_2_init(device_t dev,int default_version)580 psci_v0_2_init(device_t dev, int default_version)
581 {
582 struct psci_softc *sc = device_get_softc(dev);
583 int version;
584
585 /* PSCI v0.2 specifies explicit function IDs. */
586 sc->psci_fnids[PSCI_FN_VERSION] = PSCI_FNID_VERSION;
587 sc->psci_fnids[PSCI_FN_CPU_SUSPEND] = PSCI_FNID_CPU_SUSPEND;
588 sc->psci_fnids[PSCI_FN_CPU_OFF] = PSCI_FNID_CPU_OFF;
589 sc->psci_fnids[PSCI_FN_CPU_ON] = PSCI_FNID_CPU_ON;
590 sc->psci_fnids[PSCI_FN_AFFINITY_INFO] = PSCI_FNID_AFFINITY_INFO;
591 sc->psci_fnids[PSCI_FN_MIGRATE] = PSCI_FNID_MIGRATE;
592 sc->psci_fnids[PSCI_FN_MIGRATE_INFO_TYPE] = PSCI_FNID_MIGRATE_INFO_TYPE;
593 sc->psci_fnids[PSCI_FN_MIGRATE_INFO_UP_CPU] = PSCI_FNID_MIGRATE_INFO_UP_CPU;
594 sc->psci_fnids[PSCI_FN_SYSTEM_OFF] = PSCI_FNID_SYSTEM_OFF;
595 sc->psci_fnids[PSCI_FN_SYSTEM_RESET] = PSCI_FNID_SYSTEM_RESET;
596
597 version = _psci_get_version(sc);
598
599 /*
600 * U-Boot PSCI implementation doesn't have psci_get_version()
601 * method implemented for many boards. In this case, use the version
602 * readed from FDT as fallback. No fallback method for ACPI.
603 */
604 if (version == PSCI_RETVAL_NOT_SUPPORTED) {
605 if (default_version == PSCI_RETVAL_NOT_SUPPORTED)
606 return (1);
607
608 version = default_version;
609 printf("PSCI get_version() function is not implemented, "
610 " assuming v%d.%d\n", PSCI_VER_MAJOR(version),
611 PSCI_VER_MINOR(version));
612 }
613
614 sc->psci_version = version;
615 if ((PSCI_VER_MAJOR(version) == 0 && PSCI_VER_MINOR(version) == 2) ||
616 PSCI_VER_MAJOR(version) == 1) {
617 if (bootverbose)
618 device_printf(dev, "PSCI version 0.2 compatible\n");
619
620 /*
621 * We only register this for v0.2 since v0.1 doesn't support
622 * system_reset.
623 */
624 EVENTHANDLER_REGISTER(shutdown_final, psci_shutdown, sc,
625 SHUTDOWN_PRI_LAST);
626
627 /* Handle reboot after shutdown_panic. */
628 EVENTHANDLER_REGISTER(shutdown_final, psci_reboot, sc,
629 SHUTDOWN_PRI_LAST + 150);
630
631 return (0);
632 }
633
634 device_printf(dev, "PSCI version number mismatched with DT\n");
635 return (1);
636 }
637
638 bool
psci_conduit_is_smc(void)639 psci_conduit_is_smc(void)
640 {
641 return (psci_callfn == arm_smccc_smc);
642 }
643