psci.c revision 281466
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: head/sys/dev/psci/psci.c 281466 2015-04-12 13:00:58Z 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 105281466Sandrewstatic int 106281466Sandrewpsci_probe(device_t dev) 107281466Sandrew{ 108281466Sandrew const struct ofw_compat_data *ocd; 109281466Sandrew 110281466Sandrew if (!ofw_bus_status_okay(dev)) 111281466Sandrew return (ENXIO); 112281466Sandrew 113281466Sandrew ocd = ofw_bus_search_compatible(dev, compat_data); 114281466Sandrew if (ocd->ocd_str == NULL) 115281466Sandrew return (ENXIO); 116281466Sandrew 117281466Sandrew device_set_desc(dev, "ARM Power State Co-ordination Interface Driver"); 118281466Sandrew 119281466Sandrew return (BUS_PROBE_SPECIFIC); 120281466Sandrew} 121281466Sandrew 122281466Sandrewstatic int 123281466Sandrewpsci_attach(device_t dev) 124281466Sandrew{ 125281466Sandrew struct psci_softc *sc = device_get_softc(dev); 126281466Sandrew const struct ofw_compat_data *ocd; 127281466Sandrew psci_initfn_t psci_init; 128281466Sandrew phandle_t node; 129281466Sandrew char method[16]; 130281466Sandrew 131281466Sandrew if (psci_softc != NULL) 132281466Sandrew return (ENXIO); 133281466Sandrew 134281466Sandrew ocd = ofw_bus_search_compatible(dev, compat_data); 135281466Sandrew psci_init = (psci_initfn_t)ocd->ocd_data; 136281466Sandrew KASSERT(psci_init != NULL, ("PSCI init function cannot be NULL")); 137281466Sandrew 138281466Sandrew node = ofw_bus_get_node(dev); 139281466Sandrew if ((OF_getprop(node, "method", method, sizeof(method))) > 0) { 140281466Sandrew if (strcmp(method, "hvc") == 0) 141281466Sandrew sc->psci_call = psci_hvc_despatch; 142281466Sandrew else if (strcmp(method, "smc") == 0) 143281466Sandrew sc->psci_call = psci_smc_despatch; 144281466Sandrew else { 145281466Sandrew device_printf(dev, 146281466Sandrew "psci_attach: PSCI conduit \"%s\" invalid\n", 147281466Sandrew method); 148281466Sandrew return (ENXIO); 149281466Sandrew } 150281466Sandrew } else { 151281466Sandrew device_printf(dev, 152281466Sandrew "psci_attach: PSCI conduit not supplied in the DT\n"); 153281466Sandrew return (ENXIO); 154281466Sandrew } 155281466Sandrew 156281466Sandrew if (psci_init(dev)) 157281466Sandrew return (ENXIO); 158281466Sandrew 159281466Sandrew psci_softc = sc; 160281466Sandrew 161281466Sandrew return (0); 162281466Sandrew} 163281466Sandrew 164281466Sandrewstatic int 165281466Sandrewpsci_get_version(struct psci_softc *sc) 166281466Sandrew{ 167281466Sandrew uint32_t fnid; 168281466Sandrew 169281466Sandrew /* PSCI version wasn't supported in v0.1. */ 170281466Sandrew fnid = sc->psci_fnids[PSCI_FN_VERSION]; 171281466Sandrew if (fnid) 172281466Sandrew return (sc->psci_call(fnid, 0, 0, 0)); 173281466Sandrew 174281466Sandrew return (PSCI_RETVAL_NOT_SUPPORTED); 175281466Sandrew} 176281466Sandrew 177281466Sandrewint 178281466Sandrewpsci_cpu_on(unsigned long cpu, unsigned long entry, unsigned long context_id) 179281466Sandrew{ 180281466Sandrew 181281466Sandrew /* PSCI v0.1 and v0.2 both support cpu_on. */ 182281466Sandrew return(psci_softc->psci_call(psci_softc->psci_fnids[PSCI_FN_CPU_ON], cpu, 183281466Sandrew entry, context_id)); 184281466Sandrew} 185281466Sandrew 186281466Sandrewstatic void 187281466Sandrewpsci_shutdown(void *xsc, int howto) 188281466Sandrew{ 189281466Sandrew uint32_t fn = 0; 190281466Sandrew 191281466Sandrew /* PSCI system_off and system_reset werent't supported in v0.1. */ 192281466Sandrew if ((howto & RB_POWEROFF) != 0) 193281466Sandrew fn = psci_softc->psci_fnids[PSCI_FN_SYSTEM_OFF]; 194281466Sandrew else if ((howto & RB_HALT) == 0) 195281466Sandrew fn = psci_softc->psci_fnids[PSCI_FN_SYSTEM_RESET]; 196281466Sandrew 197281466Sandrew if (fn) 198281466Sandrew psci_softc->psci_call(fn, 0, 0, 0); 199281466Sandrew 200281466Sandrew /* System reset and off do not return. */ 201281466Sandrew} 202281466Sandrew 203281466Sandrewstatic int 204281466Sandrewpsci_v0_1_init(device_t dev) 205281466Sandrew{ 206281466Sandrew struct psci_softc *sc = device_get_softc(dev); 207281466Sandrew int psci_fn; 208281466Sandrew uint32_t psci_fnid; 209281466Sandrew phandle_t node; 210281466Sandrew int len; 211281466Sandrew 212281466Sandrew 213281466Sandrew /* Zero out the function ID table - Is this needed ? */ 214281466Sandrew for (psci_fn = PSCI_FN_VERSION, psci_fnid = PSCI_FNID_VERSION; 215281466Sandrew psci_fn < PSCI_FN_MAX; psci_fn++, psci_fnid++) 216281466Sandrew sc->psci_fnids[psci_fn] = 0; 217281466Sandrew 218281466Sandrew /* PSCI v0.1 doesn't specify function IDs. Get them from DT */ 219281466Sandrew node = ofw_bus_get_node(dev); 220281466Sandrew 221281466Sandrew if ((len = OF_getproplen(node, "cpu_suspend")) > 0) { 222281466Sandrew OF_getencprop(node, "cpu_suspend", &psci_fnid, len); 223281466Sandrew sc->psci_fnids[PSCI_FN_CPU_SUSPEND] = psci_fnid; 224281466Sandrew } 225281466Sandrew 226281466Sandrew if ((len = OF_getproplen(node, "cpu_on")) > 0) { 227281466Sandrew OF_getencprop(node, "cpu_on", &psci_fnid, len); 228281466Sandrew sc->psci_fnids[PSCI_FN_CPU_ON] = psci_fnid; 229281466Sandrew } 230281466Sandrew 231281466Sandrew if ((len = OF_getproplen(node, "cpu_off")) > 0) { 232281466Sandrew OF_getencprop(node, "cpu_off", &psci_fnid, len); 233281466Sandrew sc->psci_fnids[PSCI_FN_CPU_OFF] = psci_fnid; 234281466Sandrew } 235281466Sandrew 236281466Sandrew if ((len = OF_getproplen(node, "migrate")) > 0) { 237281466Sandrew OF_getencprop(node, "migrate", &psci_fnid, len); 238281466Sandrew sc->psci_fnids[PSCI_FN_MIGRATE] = psci_fnid; 239281466Sandrew } 240281466Sandrew 241281466Sandrew if (bootverbose) 242281466Sandrew device_printf(dev, "PSCI version 0.1 available\n"); 243281466Sandrew 244281466Sandrew return(0); 245281466Sandrew} 246281466Sandrew 247281466Sandrewstatic int 248281466Sandrewpsci_v0_2_init(device_t dev) 249281466Sandrew{ 250281466Sandrew struct psci_softc *sc = device_get_softc(dev); 251281466Sandrew int version; 252281466Sandrew 253281466Sandrew /* PSCI v0.2 specifies explicit function IDs. */ 254281466Sandrew sc->psci_fnids[PSCI_FN_VERSION] = PSCI_FNID_VERSION; 255281466Sandrew sc->psci_fnids[PSCI_FN_CPU_SUSPEND] = PSCI_FNID_CPU_SUSPEND; 256281466Sandrew sc->psci_fnids[PSCI_FN_CPU_OFF] = PSCI_FNID_CPU_OFF; 257281466Sandrew sc->psci_fnids[PSCI_FN_CPU_ON] = PSCI_FNID_CPU_ON; 258281466Sandrew sc->psci_fnids[PSCI_FN_AFFINITY_INFO] = PSCI_FNID_AFFINITY_INFO; 259281466Sandrew sc->psci_fnids[PSCI_FN_MIGRATE] = PSCI_FNID_MIGRATE; 260281466Sandrew sc->psci_fnids[PSCI_FN_MIGRATE_INFO_TYPE] = PSCI_FNID_MIGRATE_INFO_TYPE; 261281466Sandrew sc->psci_fnids[PSCI_FN_MIGRATE_INFO_UP_CPU] = PSCI_FNID_MIGRATE_INFO_UP_CPU; 262281466Sandrew sc->psci_fnids[PSCI_FN_SYSTEM_OFF] = PSCI_FNID_SYSTEM_OFF; 263281466Sandrew sc->psci_fnids[PSCI_FN_SYSTEM_RESET] = PSCI_FNID_SYSTEM_RESET; 264281466Sandrew 265281466Sandrew version = psci_get_version(sc); 266281466Sandrew 267281466Sandrew if (version == PSCI_RETVAL_NOT_SUPPORTED) 268281466Sandrew return (1); 269281466Sandrew 270281466Sandrew if ((PSCI_VER_MAJOR(version) != 0) && (PSCI_VER_MINOR(version) != 2)) { 271281466Sandrew device_printf(dev, "PSCI version number mismatched with DT\n"); 272281466Sandrew return (1); 273281466Sandrew } 274281466Sandrew 275281466Sandrew if (bootverbose) 276281466Sandrew device_printf(dev, "PSCI version 0.2 available\n"); 277281466Sandrew 278281466Sandrew /* 279281466Sandrew * We only register this for v0.2 since v0.1 doesn't support 280281466Sandrew * system_reset. 281281466Sandrew */ 282281466Sandrew EVENTHANDLER_REGISTER(shutdown_final, psci_shutdown, sc, 283281466Sandrew SHUTDOWN_PRI_LAST); 284281466Sandrew 285281466Sandrew return (0); 286281466Sandrew} 287