drivers/firmware/psci.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright (C) 2017 Masahiro Yamada <yamada.masahiro@socionext.com>
   4  *
   5  * Based on drivers/firmware/psci.c from Linux:
   6  * Copyright (C) 2015 ARM Limited
   7  */
   8
   9 #include <common.h>
  10 #include <command.h>
  11 #include <dm.h>
  12 #include <efi_loader.h>
  13 #include <irq_func.h>
  14 #include <linker_lists.h>
  15 #include <log.h>
  16 #include <sysreset.h>
  17 #include <asm/system.h>
  18 #include <dm/device-internal.h>
  19 #include <dm/lists.h>
  20 #include <linux/arm-smccc.h>
  21 #include <linux/delay.h>
  22 #include <linux/errno.h>
  23 #include <linux/libfdt.h>
  24 #include <linux/printk.h>
  25 #include <linux/psci.h>
  26
  27 #define DRIVER_NAME "psci"
  28
  29 #define PSCI_METHOD_HVC 1
  30 #define PSCI_METHOD_SMC 2
  31
  32 /*
  33  * While a 64-bit OS can make calls with SMC32 calling conventions, for some
  34  * calls it is necessary to use SMC64 to pass or return 64-bit values.
  35  * For such calls PSCI_FN_NATIVE(version, name) will choose the appropriate
  36  * (native-width) function ID.
  37  */
  38 #if defined(CONFIG_ARM64)
  39 #define PSCI_FN_NATIVE(version, name)   PSCI_##version##_FN64_##name
  40 #else
  41 #define PSCI_FN_NATIVE(version, name)   PSCI_##version##_FN_##name
  42 #endif
  43
  44 #if CONFIG_IS_ENABLED(EFI_LOADER)
  45 int __efi_runtime_data psci_method;
  46 #else
  47 int psci_method __section(".data");
  48 #endif
  49
  50 unsigned long __efi_runtime invoke_psci_fn
  51                 (unsigned long function_id, unsigned long arg0,
  52                  unsigned long arg1, unsigned long arg2)
  53 {
  54         struct arm_smccc_res res;
  55
  56         /*
  57          * In the __efi_runtime we need to avoid the switch statement. In some
  58          * cases the compiler creates lookup tables to implement switch. These
  59          * tables are not correctly relocated when SetVirtualAddressMap is
  60          * called.
  61          */
  62         if (psci_method == PSCI_METHOD_SMC)
  63                 arm_smccc_smc(function_id, arg0, arg1, arg2, 0, 0, 0, 0, &res);
  64         else if (psci_method == PSCI_METHOD_HVC)
  65                 arm_smccc_hvc(function_id, arg0, arg1, arg2, 0, 0, 0, 0, &res);
  66         else
  67                 res.a0 = PSCI_RET_DISABLED;
  68         return res.a0;
  69 }
  70
  71 static int request_psci_features(u32 psci_func_id)
  72 {
  73         return invoke_psci_fn(PSCI_1_0_FN_PSCI_FEATURES,
  74                               psci_func_id, 0, 0);
  75 }
  76
  77 static u32 psci_0_2_get_version(void)
  78 {
  79         return invoke_psci_fn(PSCI_0_2_FN_PSCI_VERSION, 0, 0, 0);
  80 }
  81
  82 static bool psci_is_system_reset2_supported(void)
  83 {
  84         int ret;
  85         u32 ver;
  86
  87         ver = psci_0_2_get_version();
  88
  89         if (PSCI_VERSION_MAJOR(ver) >= 1) {
  90                 ret = request_psci_features(PSCI_FN_NATIVE(1_1,
  91                                                            SYSTEM_RESET2));
  92
  93                 if (ret != PSCI_RET_NOT_SUPPORTED)
  94                         return true;
  95         }
  96
  97         return false;
  98 }
  99
 100 static void smccc_invoke_hvc(unsigned long a0, unsigned long a1,
 101                              unsigned long a2, unsigned long a3,
 102                              unsigned long a4, unsigned long a5,
 103                              unsigned long a6, unsigned long a7,
 104                              struct arm_smccc_res *res)
 105 {
 106         arm_smccc_hvc(a0, a1, a2, a3, a4, a5, a6, a7, res);
 107 }
 108
 109 static void smccc_invoke_smc(unsigned long a0, unsigned long a1,
 110                              unsigned long a2, unsigned long a3,
 111                              unsigned long a4, unsigned long a5,
 112                              unsigned long a6, unsigned long a7,
 113                              struct arm_smccc_res *res)
 114 {
 115         arm_smccc_smc(a0, a1, a2, a3, a4, a5, a6, a7, res);
 116 }
 117
 118 static int bind_smccc_features(struct udevice *dev, int psci_method)
 119 {
 120         struct psci_plat_data *pdata = dev_get_plat(dev);
 121         struct arm_smccc_feature *feature;
 122         size_t feature_cnt, n;
 123
 124         if (!IS_ENABLED(CONFIG_ARM_SMCCC_FEATURES))
 125                 return 0;
 126
 127         /*
 128          * SMCCC features discovery invoke SMCCC standard function ID
 129          * ARM_SMCCC_ARCH_FEATURES but this sequence requires that this
 130          * standard ARM_SMCCC_ARCH_FEATURES function ID itself is supported.
 131          * It is queried here with invoking PSCI_FEATURES known available
 132          * from PSCI 1.0.
 133          */
 134         if (!device_is_compatible(dev, "arm,psci-1.0") ||
 135             PSCI_VERSION_MAJOR(psci_0_2_get_version()) == 0)
 136                 return 0;
 137
 138         if (request_psci_features(ARM_SMCCC_ARCH_FEATURES) ==
 139             PSCI_RET_NOT_SUPPORTED)
 140                 return 0;
 141
 142         if (psci_method == PSCI_METHOD_HVC)
 143                 pdata->invoke_fn = smccc_invoke_hvc;
 144         else
 145                 pdata->invoke_fn = smccc_invoke_smc;
 146
 147         feature_cnt = ll_entry_count(struct arm_smccc_feature, arm_smccc_feature);
 148         feature = ll_entry_start(struct arm_smccc_feature, arm_smccc_feature);
 149
 150         for (n = 0; n < feature_cnt; n++, feature++) {
 151                 const char *drv_name = feature->driver_name;
 152                 struct udevice *dev2;
 153                 int ret;
 154
 155                 if (!feature->is_supported || !feature->is_supported(pdata->invoke_fn))
 156                         continue;
 157
 158                 ret = device_bind_driver(dev, drv_name, drv_name, &dev2);
 159                 if (ret) {
 160                         pr_warn("%s was not bound: %d, ignore\n", drv_name, ret);
 161                         continue;
 162                 }
 163
 164                 dev_set_parent_plat(dev2, dev_get_plat(dev));
 165         }
 166
 167         return 0;
 168 }
 169
 170 static int psci_bind(struct udevice *dev)
 171 {
 172         /* No SYSTEM_RESET support for PSCI 0.1 */
 173         if (device_is_compatible(dev, "arm,psci-0.2") ||
 174             device_is_compatible(dev, "arm,psci-1.0")) {
 175                 int ret;
 176
 177                 /* bind psci-sysreset optionally */
 178                 ret = device_bind_driver(dev, "psci-sysreset", "psci-sysreset",
 179                                          NULL);
 180                 if (ret)
 181                         pr_debug("PSCI System Reset was not bound.\n");
 182         }
 183
 184         /* From PSCI v1.0 onward we can discover services through ARM_SMCCC_FEATURE */
 185         if (IS_ENABLED(CONFIG_ARM_SMCCC_FEATURES) && device_is_compatible(dev, "arm,psci-1.0"))
 186                 dev_or_flags(dev, DM_FLAG_PROBE_AFTER_BIND);
 187
 188         return 0;
 189 }
 190
 191 static int psci_probe(struct udevice *dev)
 192 {
 193         const char *method;
 194
 195 #if defined(CONFIG_ARM64)
 196         if (current_el() == 3)
 197                 return -EINVAL;
 198 #endif
 199
 200         method = ofnode_read_string(dev_ofnode(dev), "method");
 201         if (!method) {
 202                 pr_warn("missing \"method\" property\n");
 203                 return -ENXIO;
 204         }
 205
 206         if (!strcmp("hvc", method)) {
 207                 psci_method = PSCI_METHOD_HVC;
 208         } else if (!strcmp("smc", method)) {
 209                 psci_method = PSCI_METHOD_SMC;
 210         } else {
 211                 pr_warn("invalid \"method\" property: %s\n", method);
 212                 return -EINVAL;
 213         }
 214
 215         return bind_smccc_features(dev, psci_method);
 216 }
 217
 218 /**
 219  * void do_psci_probe() - probe PSCI firmware driver
 220  *
 221  * Ensure that psci_method is initialized.
 222  */
 223 static void __maybe_unused do_psci_probe(void)
 224 {
 225         struct udevice *dev;
 226
 227         uclass_get_device_by_name(UCLASS_FIRMWARE, DRIVER_NAME, &dev);
 228 }
 229
 230 #if IS_ENABLED(CONFIG_EFI_LOADER) && IS_ENABLED(CONFIG_PSCI_RESET)
 231 efi_status_t efi_reset_system_init(void)
 232 {
 233         do_psci_probe();
 234         return EFI_SUCCESS;
 235 }
 236
 237 void __efi_runtime EFIAPI efi_reset_system(enum efi_reset_type reset_type,
 238                                            efi_status_t reset_status,
 239                                            unsigned long data_size,
 240                                            void *reset_data)
 241 {
 242         if (reset_type == EFI_RESET_COLD ||
 243             reset_type == EFI_RESET_WARM ||
 244             reset_type == EFI_RESET_PLATFORM_SPECIFIC) {
 245                 invoke_psci_fn(PSCI_0_2_FN_SYSTEM_RESET, 0, 0, 0);
 246         } else if (reset_type == EFI_RESET_SHUTDOWN) {
 247                 invoke_psci_fn(PSCI_0_2_FN_SYSTEM_OFF, 0, 0, 0);
 248         }
 249         while (1)
 250                 ;
 251 }
 252 #endif /* IS_ENABLED(CONFIG_EFI_LOADER) && IS_ENABLED(CONFIG_PSCI_RESET) */
 253
 254 #ifdef CONFIG_PSCI_RESET
 255 void reset_misc(void)
 256 {
 257         do_psci_probe();
 258         invoke_psci_fn(PSCI_0_2_FN_SYSTEM_RESET, 0, 0, 0);
 259 }
 260 #endif /* CONFIG_PSCI_RESET */
 261
 262 void psci_sys_reset(u32 type)
 263 {
 264         bool reset2_supported;
 265
 266         do_psci_probe();
 267
 268         reset2_supported = psci_is_system_reset2_supported();
 269
 270         if (type == SYSRESET_WARM && reset2_supported) {
 271                 /*
 272                  * reset_type[31] = 0 (architectural)
 273                  * reset_type[30:0] = 0 (SYSTEM_WARM_RESET)
 274                  * cookie = 0 (ignored by the implementation)
 275                  */
 276                 invoke_psci_fn(PSCI_FN_NATIVE(1_1, SYSTEM_RESET2), 0, 0, 0);
 277         } else {
 278                 invoke_psci_fn(PSCI_0_2_FN_SYSTEM_RESET, 0, 0, 0);
 279         }
 280 }
 281
 282 void psci_sys_poweroff(void)
 283 {
 284         do_psci_probe();
 285
 286         invoke_psci_fn(PSCI_0_2_FN_SYSTEM_OFF, 0, 0, 0);
 287 }
 288
 289 #if IS_ENABLED(CONFIG_CMD_POWEROFF) && !IS_ENABLED(CONFIG_SYSRESET_CMD_POWEROFF)
 290 int do_poweroff(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
 291 {
 292         do_psci_probe();
 293
 294         puts("poweroff ...\n");
 295         udelay(50000); /* wait 50 ms */
 296
 297         disable_interrupts();
 298         invoke_psci_fn(PSCI_0_2_FN_SYSTEM_OFF, 0, 0, 0);
 299         enable_interrupts();
 300
 301         log_err("Power off not supported on this platform\n");
 302         return CMD_RET_FAILURE;
 303 }
 304 #endif
 305
 306 static const struct udevice_id psci_of_match[] = {
 307         { .compatible = "arm,psci" },
 308         { .compatible = "arm,psci-0.2" },
 309         { .compatible = "arm,psci-1.0" },
 310         {},
 311 };
 312
 313 U_BOOT_DRIVER(psci) = {
 314         .name = DRIVER_NAME,
 315         .id = UCLASS_FIRMWARE,
 316         .of_match = psci_of_match,
 317         .bind = psci_bind,
 318         .probe = psci_probe,
 319 #ifdef CONFIG_ARM_SMCCC_FEATURES
 320         .plat_auto = sizeof(struct psci_plat_data),
 321 #endif
 322         .flags = DM_FLAG_PRE_RELOC,
 323 };