1281466Sandrew/*- 2281466Sandrew * Copyright (c) 2014 Robin Randhawa 3281466Sandrew * All rights reserved. 4281466Sandrew * 5281466Sandrew * Redistribution and use in source and binary forms, with or without 6281466Sandrew * modification, are permitted provided that the following conditions 7281466Sandrew * are met: 8281466Sandrew * 1. Redistributions of source code must retain the above copyright 9281466Sandrew * notice, this list of conditions and the following disclaimer. 10281466Sandrew * 2. Redistributions in binary form must reproduce the above copyright 11281466Sandrew * notice, this list of conditions and the following disclaimer in the 12281466Sandrew * documentation and/or other materials provided with the distribution. 13281466Sandrew * 14281466Sandrew * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15281466Sandrew * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16281466Sandrew * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17281466Sandrew * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18281466Sandrew * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19281466Sandrew * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20281466Sandrew * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21281466Sandrew * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22281466Sandrew * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23281466Sandrew * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24281466Sandrew * SUCH DAMAGE. 25281466Sandrew * 26281466Sandrew */ 27281466Sandrew 28281466Sandrew/* 29281466Sandrew * This implements support for ARM's Power State Co-ordination Interface 30281466Sandrew * [PSCI]. The implementation adheres to version 0.2 of the PSCI specification 31281466Sandrew * but also supports v0.1. PSCI standardizes operations such as system reset, CPU 32281466Sandrew * on/off/suspend. PSCI requires a compliant firmware implementation. 33281466Sandrew * 34281466Sandrew * The PSCI specification used for this implementation is available at: 35281466Sandrew * 36281466Sandrew * <http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.den0022b/index.html>. 37281466Sandrew * 38281466Sandrew * TODO: 39281466Sandrew * - Add support for remaining PSCI calls [this implementation only 40281466Sandrew * supports get_version, system_reset and cpu_on]. 41281466Sandrew */ 42281466Sandrew 43281466Sandrew#include <sys/cdefs.h> 44281466Sandrew__FBSDID("$FreeBSD: stable/11/sys/dev/psci/psci.c 319207 2017-05-30 13:26:37Z andrew $"); 45281466Sandrew 46281466Sandrew#include <sys/param.h> 47281466Sandrew#include <sys/systm.h> 48281466Sandrew#include <sys/bus.h> 49281466Sandrew#include <sys/eventhandler.h> 50281466Sandrew#include <sys/kernel.h> 51281466Sandrew#include <sys/module.h> 52281466Sandrew#include <sys/reboot.h> 53281466Sandrew 54281466Sandrew#include <machine/bus.h> 55281466Sandrew 56281466Sandrew#include <dev/fdt/fdt_common.h> 57281466Sandrew#include <dev/ofw/openfirm.h> 58281466Sandrew#include <dev/ofw/ofw_bus.h> 59281466Sandrew#include <dev/ofw/ofw_bus_subr.h> 60281466Sandrew 61281466Sandrew#include <dev/psci/psci.h> 62281466Sandrew 63281466Sandrewstruct psci_softc { 64281466Sandrew device_t dev; 65281466Sandrew 66281466Sandrew psci_callfn_t psci_call; 67281466Sandrew uint32_t psci_fnids[PSCI_FN_MAX]; 68281466Sandrew}; 69281466Sandrew 70281466Sandrewstatic int psci_v0_1_init(device_t dev); 71281466Sandrewstatic int psci_v0_2_init(device_t dev); 72281466Sandrew 73281466Sandrewstruct psci_softc *psci_softc = NULL; 74281466Sandrew 75281466Sandrewstatic struct ofw_compat_data compat_data[] = { 76281466Sandrew {"arm,psci-0.2", (uintptr_t)psci_v0_2_init}, 77281466Sandrew {"arm,psci", (uintptr_t)psci_v0_1_init}, 78281466Sandrew {NULL, 0} 79281466Sandrew}; 80281466Sandrew 81281466Sandrewstatic int psci_probe(device_t dev); 82281466Sandrewstatic int psci_attach(device_t dev); 83281466Sandrewstatic void psci_shutdown(void *, int); 84281466Sandrew 85281466Sandrewstatic device_method_t psci_methods[] = { 86281466Sandrew DEVMETHOD(device_probe, psci_probe), 87281466Sandrew DEVMETHOD(device_attach, psci_attach), 88281466Sandrew 89281466Sandrew DEVMETHOD_END 90281466Sandrew}; 91281466Sandrew 92281466Sandrewstatic driver_t psci_driver = { 93281466Sandrew "psci", 94281466Sandrew psci_methods, 95281466Sandrew sizeof(struct psci_softc), 96281466Sandrew}; 97281466Sandrew 98281466Sandrewstatic devclass_t psci_devclass; 99281466Sandrew 100281466SandrewEARLY_DRIVER_MODULE(psci, simplebus, psci_driver, psci_devclass, 0, 0, 101281466Sandrew BUS_PASS_CPU + BUS_PASS_ORDER_FIRST); 102281466SandrewEARLY_DRIVER_MODULE(psci, ofwbus, psci_driver, psci_devclass, 0, 0, 103281466Sandrew BUS_PASS_CPU + BUS_PASS_ORDER_FIRST); 104281466Sandrew 105283363Sandrewstatic psci_callfn_t 106283363Sandrewpsci_get_callfn(phandle_t node) 107283363Sandrew{ 108283363Sandrew char method[16]; 109283363Sandrew 110283363Sandrew if ((OF_getprop(node, "method", method, sizeof(method))) > 0) { 111283363Sandrew if (strcmp(method, "hvc") == 0) 112283363Sandrew return (psci_hvc_despatch); 113283363Sandrew else if (strcmp(method, "smc") == 0) 114283363Sandrew return (psci_smc_despatch); 115283363Sandrew else 116283363Sandrew printf("psci: PSCI conduit \"%s\" invalid\n", method); 117283363Sandrew } else 118283363Sandrew printf("psci: PSCI conduit not supplied in the device tree\n"); 119283363Sandrew 120283363Sandrew return (NULL); 121283363Sandrew} 122283363Sandrew 123281466Sandrewstatic int 124281466Sandrewpsci_probe(device_t dev) 125281466Sandrew{ 126281466Sandrew const struct ofw_compat_data *ocd; 127281466Sandrew 128281466Sandrew if (!ofw_bus_status_okay(dev)) 129281466Sandrew return (ENXIO); 130281466Sandrew 131281466Sandrew ocd = ofw_bus_search_compatible(dev, compat_data); 132281466Sandrew if (ocd->ocd_str == NULL) 133281466Sandrew return (ENXIO); 134281466Sandrew 135281466Sandrew device_set_desc(dev, "ARM Power State Co-ordination Interface Driver"); 136281466Sandrew 137281466Sandrew return (BUS_PROBE_SPECIFIC); 138281466Sandrew} 139281466Sandrew 140281466Sandrewstatic int 141281466Sandrewpsci_attach(device_t dev) 142281466Sandrew{ 143281466Sandrew struct psci_softc *sc = device_get_softc(dev); 144281466Sandrew const struct ofw_compat_data *ocd; 145281466Sandrew psci_initfn_t psci_init; 146281466Sandrew phandle_t node; 147281466Sandrew 148281466Sandrew if (psci_softc != NULL) 149281466Sandrew return (ENXIO); 150281466Sandrew 151281466Sandrew ocd = ofw_bus_search_compatible(dev, compat_data); 152281466Sandrew psci_init = (psci_initfn_t)ocd->ocd_data; 153281466Sandrew KASSERT(psci_init != NULL, ("PSCI init function cannot be NULL")); 154281466Sandrew 155281466Sandrew node = ofw_bus_get_node(dev); 156283363Sandrew sc->psci_call = psci_get_callfn(node); 157283363Sandrew if (sc->psci_call == NULL) 158281466Sandrew return (ENXIO); 159281466Sandrew 160281466Sandrew if (psci_init(dev)) 161281466Sandrew return (ENXIO); 162281466Sandrew 163281466Sandrew psci_softc = sc; 164281466Sandrew 165281466Sandrew return (0); 166281466Sandrew} 167281466Sandrew 168281466Sandrewstatic int 169281466Sandrewpsci_get_version(struct psci_softc *sc) 170281466Sandrew{ 171281466Sandrew uint32_t fnid; 172281466Sandrew 173281466Sandrew /* PSCI version wasn't supported in v0.1. */ 174281466Sandrew fnid = sc->psci_fnids[PSCI_FN_VERSION]; 175281466Sandrew if (fnid) 176281466Sandrew return (sc->psci_call(fnid, 0, 0, 0)); 177281466Sandrew 178281466Sandrew return (PSCI_RETVAL_NOT_SUPPORTED); 179281466Sandrew} 180281466Sandrew 181281466Sandrewint 182281466Sandrewpsci_cpu_on(unsigned long cpu, unsigned long entry, unsigned long context_id) 183281466Sandrew{ 184283363Sandrew psci_callfn_t callfn; 185283363Sandrew phandle_t node; 186283363Sandrew uint32_t fnid; 187281466Sandrew 188283363Sandrew if (psci_softc == NULL) { 189283363Sandrew node = ofw_bus_find_compatible(OF_peer(0), "arm,psci-0.2"); 190283363Sandrew if (node == 0) 191283363Sandrew /* TODO: Handle psci 0.1 */ 192283363Sandrew return (PSCI_RETVAL_INTERNAL_FAILURE); 193283363Sandrew 194283363Sandrew fnid = PSCI_FNID_CPU_ON; 195283363Sandrew callfn = psci_get_callfn(node); 196283363Sandrew if (callfn == NULL) 197283363Sandrew return (PSCI_RETVAL_INTERNAL_FAILURE); 198283363Sandrew } else { 199283363Sandrew callfn = psci_softc->psci_call; 200283363Sandrew fnid = psci_softc->psci_fnids[PSCI_FN_CPU_ON]; 201283363Sandrew } 202283363Sandrew 203281466Sandrew /* PSCI v0.1 and v0.2 both support cpu_on. */ 204283363Sandrew return (callfn(fnid, cpu, entry, context_id)); 205281466Sandrew} 206281466Sandrew 207281466Sandrewstatic void 208281466Sandrewpsci_shutdown(void *xsc, int howto) 209281466Sandrew{ 210281466Sandrew uint32_t fn = 0; 211281466Sandrew 212281466Sandrew /* PSCI system_off and system_reset werent't supported in v0.1. */ 213281466Sandrew if ((howto & RB_POWEROFF) != 0) 214281466Sandrew fn = psci_softc->psci_fnids[PSCI_FN_SYSTEM_OFF]; 215281466Sandrew else if ((howto & RB_HALT) == 0) 216281466Sandrew fn = psci_softc->psci_fnids[PSCI_FN_SYSTEM_RESET]; 217281466Sandrew 218281466Sandrew if (fn) 219281466Sandrew psci_softc->psci_call(fn, 0, 0, 0); 220281466Sandrew 221281466Sandrew /* System reset and off do not return. */ 222281466Sandrew} 223281466Sandrew 224319207Sandrewvoid 225319207Sandrewpsci_reset(void) 226319207Sandrew{ 227319207Sandrew 228319207Sandrew psci_shutdown(NULL, 0); 229319207Sandrew} 230319207Sandrew 231281466Sandrewstatic int 232281466Sandrewpsci_v0_1_init(device_t dev) 233281466Sandrew{ 234281466Sandrew struct psci_softc *sc = device_get_softc(dev); 235281466Sandrew int psci_fn; 236281466Sandrew uint32_t psci_fnid; 237281466Sandrew phandle_t node; 238281466Sandrew int len; 239281466Sandrew 240281466Sandrew 241281466Sandrew /* Zero out the function ID table - Is this needed ? */ 242281466Sandrew for (psci_fn = PSCI_FN_VERSION, psci_fnid = PSCI_FNID_VERSION; 243281466Sandrew psci_fn < PSCI_FN_MAX; psci_fn++, psci_fnid++) 244281466Sandrew sc->psci_fnids[psci_fn] = 0; 245281466Sandrew 246281466Sandrew /* PSCI v0.1 doesn't specify function IDs. Get them from DT */ 247281466Sandrew node = ofw_bus_get_node(dev); 248281466Sandrew 249281466Sandrew if ((len = OF_getproplen(node, "cpu_suspend")) > 0) { 250281466Sandrew OF_getencprop(node, "cpu_suspend", &psci_fnid, len); 251281466Sandrew sc->psci_fnids[PSCI_FN_CPU_SUSPEND] = psci_fnid; 252281466Sandrew } 253281466Sandrew 254281466Sandrew if ((len = OF_getproplen(node, "cpu_on")) > 0) { 255281466Sandrew OF_getencprop(node, "cpu_on", &psci_fnid, len); 256281466Sandrew sc->psci_fnids[PSCI_FN_CPU_ON] = psci_fnid; 257281466Sandrew } 258281466Sandrew 259281466Sandrew if ((len = OF_getproplen(node, "cpu_off")) > 0) { 260281466Sandrew OF_getencprop(node, "cpu_off", &psci_fnid, len); 261281466Sandrew sc->psci_fnids[PSCI_FN_CPU_OFF] = psci_fnid; 262281466Sandrew } 263281466Sandrew 264281466Sandrew if ((len = OF_getproplen(node, "migrate")) > 0) { 265281466Sandrew OF_getencprop(node, "migrate", &psci_fnid, len); 266281466Sandrew sc->psci_fnids[PSCI_FN_MIGRATE] = psci_fnid; 267281466Sandrew } 268281466Sandrew 269281466Sandrew if (bootverbose) 270281466Sandrew device_printf(dev, "PSCI version 0.1 available\n"); 271281466Sandrew 272281466Sandrew return(0); 273281466Sandrew} 274281466Sandrew 275281466Sandrewstatic int 276281466Sandrewpsci_v0_2_init(device_t dev) 277281466Sandrew{ 278281466Sandrew struct psci_softc *sc = device_get_softc(dev); 279281466Sandrew int version; 280281466Sandrew 281281466Sandrew /* PSCI v0.2 specifies explicit function IDs. */ 282281466Sandrew sc->psci_fnids[PSCI_FN_VERSION] = PSCI_FNID_VERSION; 283281466Sandrew sc->psci_fnids[PSCI_FN_CPU_SUSPEND] = PSCI_FNID_CPU_SUSPEND; 284281466Sandrew sc->psci_fnids[PSCI_FN_CPU_OFF] = PSCI_FNID_CPU_OFF; 285281466Sandrew sc->psci_fnids[PSCI_FN_CPU_ON] = PSCI_FNID_CPU_ON; 286281466Sandrew sc->psci_fnids[PSCI_FN_AFFINITY_INFO] = PSCI_FNID_AFFINITY_INFO; 287281466Sandrew sc->psci_fnids[PSCI_FN_MIGRATE] = PSCI_FNID_MIGRATE; 288281466Sandrew sc->psci_fnids[PSCI_FN_MIGRATE_INFO_TYPE] = PSCI_FNID_MIGRATE_INFO_TYPE; 289281466Sandrew sc->psci_fnids[PSCI_FN_MIGRATE_INFO_UP_CPU] = PSCI_FNID_MIGRATE_INFO_UP_CPU; 290281466Sandrew sc->psci_fnids[PSCI_FN_SYSTEM_OFF] = PSCI_FNID_SYSTEM_OFF; 291281466Sandrew sc->psci_fnids[PSCI_FN_SYSTEM_RESET] = PSCI_FNID_SYSTEM_RESET; 292281466Sandrew 293281466Sandrew version = psci_get_version(sc); 294281466Sandrew 295281466Sandrew if (version == PSCI_RETVAL_NOT_SUPPORTED) 296281466Sandrew return (1); 297281466Sandrew 298286630Sandrew if ((PSCI_VER_MAJOR(version) == 0 && PSCI_VER_MINOR(version) == 2) || 299286630Sandrew (PSCI_VER_MAJOR(version) == 1 && PSCI_VER_MINOR(version) == 0)) { 300286630Sandrew if (bootverbose) 301286630Sandrew device_printf(dev, "PSCI version 0.2 available\n"); 302281466Sandrew 303286630Sandrew /* 304286630Sandrew * We only register this for v0.2 since v0.1 doesn't support 305286630Sandrew * system_reset. 306286630Sandrew */ 307286630Sandrew EVENTHANDLER_REGISTER(shutdown_final, psci_shutdown, sc, 308286630Sandrew SHUTDOWN_PRI_LAST); 309281466Sandrew 310286630Sandrew return (0); 311286630Sandrew } 312281466Sandrew 313286630Sandrew device_printf(dev, "PSCI version number mismatched with DT\n"); 314286630Sandrew return (1); 315281466Sandrew} 316