virt/kvm/arm/psci.c

   1 /*
   2  * Copyright (C) 2012 - ARM Ltd
   3  * Author: Marc Zyngier <marc.zyngier@arm.com>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License version 2 as
   7  * published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #include <linux/preempt.h>
  19 #include <linux/kvm_host.h>
  20 #include <linux/wait.h>
  21
  22 #include <asm/cputype.h>
  23 #include <asm/kvm_emulate.h>
  24 #include <asm/kvm_psci.h>
  25 #include <asm/kvm_host.h>
  26
  27 #include <uapi/linux/psci.h>
  28
  29 /*
  30  * This is an implementation of the Power State Coordination Interface
  31  * as described in ARM document number ARM DEN 0022A.
  32  */
  33
  34 #define AFFINITY_MASK(level)    ~((0x1UL << ((level) * MPIDR_LEVEL_BITS)) - 1)
  35
  36 static unsigned long psci_affinity_mask(unsigned long affinity_level)
  37 {
  38         if (affinity_level <= 3)
  39                 return MPIDR_HWID_BITMASK & AFFINITY_MASK(affinity_level);
  40
  41         return 0;
  42 }
  43
  44 static unsigned long kvm_psci_vcpu_suspend(struct kvm_vcpu *vcpu)
  45 {
  46         /*
  47          * NOTE: For simplicity, we make VCPU suspend emulation to be
  48          * same-as WFI (Wait-for-interrupt) emulation.
  49          *
  50          * This means for KVM the wakeup events are interrupts and
  51          * this is consistent with intended use of StateID as described
  52          * in section 5.4.1 of PSCI v0.2 specification (ARM DEN 0022A).
  53          *
  54          * Further, we also treat power-down request to be same as
  55          * stand-by request as-per section 5.4.2 clause 3 of PSCI v0.2
  56          * specification (ARM DEN 0022A). This means all suspend states
  57          * for KVM will preserve the register state.
  58          */
  59         kvm_vcpu_block(vcpu);
  60         kvm_clear_request(KVM_REQ_UNHALT, vcpu);
  61
  62         return PSCI_RET_SUCCESS;
  63 }
  64
  65 static void kvm_psci_vcpu_off(struct kvm_vcpu *vcpu)
  66 {
  67         vcpu->arch.power_off = true;
  68 }
  69
  70 static unsigned long kvm_psci_vcpu_on(struct kvm_vcpu *source_vcpu)
  71 {
  72         struct kvm *kvm = source_vcpu->kvm;
  73         struct kvm_vcpu *vcpu = NULL;
  74         struct swait_queue_head *wq;
  75         unsigned long cpu_id;
  76         unsigned long context_id;
  77         phys_addr_t target_pc;
  78
  79         cpu_id = vcpu_get_reg(source_vcpu, 1) & MPIDR_HWID_BITMASK;
  80         if (vcpu_mode_is_32bit(source_vcpu))
  81                 cpu_id &= ~((u32) 0);
  82
  83         vcpu = kvm_mpidr_to_vcpu(kvm, cpu_id);
  84
  85         /*
  86          * Make sure the caller requested a valid CPU and that the CPU is
  87          * turned off.
  88          */
  89         if (!vcpu)
  90                 return PSCI_RET_INVALID_PARAMS;
  91         if (!vcpu->arch.power_off) {
  92                 if (kvm_psci_version(source_vcpu) != KVM_ARM_PSCI_0_1)
  93                         return PSCI_RET_ALREADY_ON;
  94                 else
  95                         return PSCI_RET_INVALID_PARAMS;
  96         }
  97
  98         target_pc = vcpu_get_reg(source_vcpu, 2);
  99         context_id = vcpu_get_reg(source_vcpu, 3);
 100
 101         kvm_reset_vcpu(vcpu);
 102
 103         /* Gracefully handle Thumb2 entry point */
 104         if (vcpu_mode_is_32bit(vcpu) && (target_pc & 1)) {
 105                 target_pc &= ~((phys_addr_t) 1);
 106                 vcpu_set_thumb(vcpu);
 107         }
 108
 109         /* Propagate caller endianness */
 110         if (kvm_vcpu_is_be(source_vcpu))
 111                 kvm_vcpu_set_be(vcpu);
 112
 113         *vcpu_pc(vcpu) = target_pc;
 114         /*
 115          * NOTE: We always update r0 (or x0) because for PSCI v0.1
 116          * the general puspose registers are undefined upon CPU_ON.
 117          */
 118         vcpu_set_reg(vcpu, 0, context_id);
 119         vcpu->arch.power_off = false;
 120         smp_mb();               /* Make sure the above is visible */
 121
 122         wq = kvm_arch_vcpu_wq(vcpu);
 123         swake_up(wq);
 124
 125         return PSCI_RET_SUCCESS;
 126 }
 127
 128 static unsigned long kvm_psci_vcpu_affinity_info(struct kvm_vcpu *vcpu)
 129 {
 130         int i, matching_cpus = 0;
 131         unsigned long mpidr;
 132         unsigned long target_affinity;
 133         unsigned long target_affinity_mask;
 134         unsigned long lowest_affinity_level;
 135         struct kvm *kvm = vcpu->kvm;
 136         struct kvm_vcpu *tmp;
 137
 138         target_affinity = vcpu_get_reg(vcpu, 1);
 139         lowest_affinity_level = vcpu_get_reg(vcpu, 2);
 140
 141         /* Determine target affinity mask */
 142         target_affinity_mask = psci_affinity_mask(lowest_affinity_level);
 143         if (!target_affinity_mask)
 144                 return PSCI_RET_INVALID_PARAMS;
 145
 146         /* Ignore other bits of target affinity */
 147         target_affinity &= target_affinity_mask;
 148
 149         /*
 150          * If one or more VCPU matching target affinity are running
 151          * then ON else OFF
 152          */
 153         kvm_for_each_vcpu(i, tmp, kvm) {
 154                 mpidr = kvm_vcpu_get_mpidr_aff(tmp);
 155                 if ((mpidr & target_affinity_mask) == target_affinity) {
 156                         matching_cpus++;
 157                         if (!tmp->arch.power_off)
 158                                 return PSCI_0_2_AFFINITY_LEVEL_ON;
 159                 }
 160         }
 161
 162         if (!matching_cpus)
 163                 return PSCI_RET_INVALID_PARAMS;
 164
 165         return PSCI_0_2_AFFINITY_LEVEL_OFF;
 166 }
 167
 168 static void kvm_prepare_system_event(struct kvm_vcpu *vcpu, u32 type)
 169 {
 170         int i;
 171         struct kvm_vcpu *tmp;
 172
 173         /*
 174          * The KVM ABI specifies that a system event exit may call KVM_RUN
 175          * again and may perform shutdown/reboot at a later time that when the
 176          * actual request is made.  Since we are implementing PSCI and a
 177          * caller of PSCI reboot and shutdown expects that the system shuts
 178          * down or reboots immediately, let's make sure that VCPUs are not run
 179          * after this call is handled and before the VCPUs have been
 180          * re-initialized.
 181          */
 182         kvm_for_each_vcpu(i, tmp, vcpu->kvm)
 183                 tmp->arch.power_off = true;
 184         kvm_make_all_cpus_request(vcpu->kvm, KVM_REQ_VCPU_EXIT);
 185
 186         memset(&vcpu->run->system_event, 0, sizeof(vcpu->run->system_event));
 187         vcpu->run->system_event.type = type;
 188         vcpu->run->exit_reason = KVM_EXIT_SYSTEM_EVENT;
 189 }
 190
 191 static void kvm_psci_system_off(struct kvm_vcpu *vcpu)
 192 {
 193         kvm_prepare_system_event(vcpu, KVM_SYSTEM_EVENT_SHUTDOWN);
 194 }
 195
 196 static void kvm_psci_system_reset(struct kvm_vcpu *vcpu)
 197 {
 198         kvm_prepare_system_event(vcpu, KVM_SYSTEM_EVENT_RESET);
 199 }
 200
 201 int kvm_psci_version(struct kvm_vcpu *vcpu)
 202 {
 203         if (test_bit(KVM_ARM_VCPU_PSCI_0_2, vcpu->arch.features))
 204                 return KVM_ARM_PSCI_0_2;
 205
 206         return KVM_ARM_PSCI_0_1;
 207 }
 208
 209 static int kvm_psci_0_2_call(struct kvm_vcpu *vcpu)
 210 {
 211         struct kvm *kvm = vcpu->kvm;
 212         unsigned long psci_fn = vcpu_get_reg(vcpu, 0) & ~((u32) 0);
 213         unsigned long val;
 214         int ret = 1;
 215
 216         switch (psci_fn) {
 217         case PSCI_0_2_FN_PSCI_VERSION:
 218                 /*
 219                  * Bits[31:16] = Major Version = 0
 220                  * Bits[15:0] = Minor Version = 2
 221                  */
 222                 val = 2;
 223                 break;
 224         case PSCI_0_2_FN_CPU_SUSPEND:
 225         case PSCI_0_2_FN64_CPU_SUSPEND:
 226                 val = kvm_psci_vcpu_suspend(vcpu);
 227                 break;
 228         case PSCI_0_2_FN_CPU_OFF:
 229                 kvm_psci_vcpu_off(vcpu);
 230                 val = PSCI_RET_SUCCESS;
 231                 break;
 232         case PSCI_0_2_FN_CPU_ON:
 233         case PSCI_0_2_FN64_CPU_ON:
 234                 mutex_lock(&kvm->lock);
 235                 val = kvm_psci_vcpu_on(vcpu);
 236                 mutex_unlock(&kvm->lock);
 237                 break;
 238         case PSCI_0_2_FN_AFFINITY_INFO:
 239         case PSCI_0_2_FN64_AFFINITY_INFO:
 240                 val = kvm_psci_vcpu_affinity_info(vcpu);
 241                 break;
 242         case PSCI_0_2_FN_MIGRATE_INFO_TYPE:
 243                 /*
 244                  * Trusted OS is MP hence does not require migration
 245                  * or
 246                  * Trusted OS is not present
 247                  */
 248                 val = PSCI_0_2_TOS_MP;
 249                 break;
 250         case PSCI_0_2_FN_SYSTEM_OFF:
 251                 kvm_psci_system_off(vcpu);
 252                 /*
 253                  * We should'nt be going back to guest VCPU after
 254                  * receiving SYSTEM_OFF request.
 255                  *
 256                  * If user space accidently/deliberately resumes
 257                  * guest VCPU after SYSTEM_OFF request then guest
 258                  * VCPU should see internal failure from PSCI return
 259                  * value. To achieve this, we preload r0 (or x0) with
 260                  * PSCI return value INTERNAL_FAILURE.
 261                  */
 262                 val = PSCI_RET_INTERNAL_FAILURE;
 263                 ret = 0;
 264                 break;
 265         case PSCI_0_2_FN_SYSTEM_RESET:
 266                 kvm_psci_system_reset(vcpu);
 267                 /*
 268                  * Same reason as SYSTEM_OFF for preloading r0 (or x0)
 269                  * with PSCI return value INTERNAL_FAILURE.
 270                  */
 271                 val = PSCI_RET_INTERNAL_FAILURE;
 272                 ret = 0;
 273                 break;
 274         default:
 275                 val = PSCI_RET_NOT_SUPPORTED;
 276                 break;
 277         }
 278
 279         vcpu_set_reg(vcpu, 0, val);
 280         return ret;
 281 }
 282
 283 static int kvm_psci_0_1_call(struct kvm_vcpu *vcpu)
 284 {
 285         struct kvm *kvm = vcpu->kvm;
 286         unsigned long psci_fn = vcpu_get_reg(vcpu, 0) & ~((u32) 0);
 287         unsigned long val;
 288
 289         switch (psci_fn) {
 290         case KVM_PSCI_FN_CPU_OFF:
 291                 kvm_psci_vcpu_off(vcpu);
 292                 val = PSCI_RET_SUCCESS;
 293                 break;
 294         case KVM_PSCI_FN_CPU_ON:
 295                 mutex_lock(&kvm->lock);
 296                 val = kvm_psci_vcpu_on(vcpu);
 297                 mutex_unlock(&kvm->lock);
 298                 break;
 299         default:
 300                 val = PSCI_RET_NOT_SUPPORTED;
 301                 break;
 302         }
 303
 304         vcpu_set_reg(vcpu, 0, val);
 305         return 1;
 306 }
 307
 308 /**
 309  * kvm_psci_call - handle PSCI call if r0 value is in range
 310  * @vcpu: Pointer to the VCPU struct
 311  *
 312  * Handle PSCI calls from guests through traps from HVC instructions.
 313  * The calling convention is similar to SMC calls to the secure world
 314  * where the function number is placed in r0.
 315  *
 316  * This function returns: > 0 (success), 0 (success but exit to user
 317  * space), and < 0 (errors)
 318  *
 319  * Errors:
 320  * -EINVAL: Unrecognized PSCI function
 321  */
 322 int kvm_psci_call(struct kvm_vcpu *vcpu)
 323 {
 324         switch (kvm_psci_version(vcpu)) {
 325         case KVM_ARM_PSCI_0_2:
 326                 return kvm_psci_0_2_call(vcpu);
 327         case KVM_ARM_PSCI_0_1:
 328                 return kvm_psci_0_1_call(vcpu);
 329         default:
 330                 return -EINVAL;
 331         };
 332 }