hw/arm/virt: formatting: memory map
[qemu/ar7.git] / target-arm / kvm_arm.h
blobaf9310551765da77b27fe8859f0f6c6821515159
1 /*
2 * QEMU KVM support -- ARM specific functions.
4 * Copyright (c) 2012 Linaro Limited
6 * This work is licensed under the terms of the GNU GPL, version 2 or later.
7 * See the COPYING file in the top-level directory.
9 */
11 #ifndef QEMU_KVM_ARM_H
12 #define QEMU_KVM_ARM_H
14 #include "sysemu/kvm.h"
15 #include "exec/memory.h"
17 /**
18 * kvm_arm_vcpu_init:
19 * @cs: CPUState
21 * Initialize (or reinitialize) the VCPU by invoking the
22 * KVM_ARM_VCPU_INIT ioctl with the CPU type and feature
23 * bitmask specified in the CPUState.
25 * Returns: 0 if success else < 0 error code
27 int kvm_arm_vcpu_init(CPUState *cs);
29 /**
30 * kvm_arm_register_device:
31 * @mr: memory region for this device
32 * @devid: the KVM device ID
33 * @group: device control API group for setting addresses
34 * @attr: device control API address type
35 * @dev_fd: device control device file descriptor (or -1 if not supported)
37 * Remember the memory region @mr, and when it is mapped by the
38 * machine model, tell the kernel that base address using the
39 * KVM_ARM_SET_DEVICE_ADDRESS ioctl or the newer device control API. @devid
40 * should be the ID of the device as defined by KVM_ARM_SET_DEVICE_ADDRESS or
41 * the arm-vgic device in the device control API.
42 * The machine model may map
43 * and unmap the device multiple times; the kernel will only be told the final
44 * address at the point where machine init is complete.
46 void kvm_arm_register_device(MemoryRegion *mr, uint64_t devid, uint64_t group,
47 uint64_t attr, int dev_fd);
49 /**
50 * write_list_to_kvmstate:
51 * @cpu: ARMCPU
53 * For each register listed in the ARMCPU cpreg_indexes list, write
54 * its value from the cpreg_values list into the kernel (via ioctl).
55 * This updates KVM's working data structures from TCG data or
56 * from incoming migration state.
58 * Returns: true if all register values were updated correctly,
59 * false if some register was unknown to the kernel or could not
60 * be written (eg constant register with the wrong value).
61 * Note that we do not stop early on failure -- we will attempt
62 * writing all registers in the list.
64 bool write_list_to_kvmstate(ARMCPU *cpu);
66 /**
67 * write_kvmstate_to_list:
68 * @cpu: ARMCPU
70 * For each register listed in the ARMCPU cpreg_indexes list, write
71 * its value from the kernel into the cpreg_values list. This is used to
72 * copy info from KVM's working data structures into TCG or
73 * for outbound migration.
75 * Returns: true if all register values were read correctly,
76 * false if some register was unknown or could not be read.
77 * Note that we do not stop early on failure -- we will attempt
78 * reading all registers in the list.
80 bool write_kvmstate_to_list(ARMCPU *cpu);
82 /**
83 * kvm_arm_reset_vcpu:
84 * @cpu: ARMCPU
86 * Called at reset time to kernel registers to their initial values.
88 void kvm_arm_reset_vcpu(ARMCPU *cpu);
90 #ifdef CONFIG_KVM
91 /**
92 * kvm_arm_create_scratch_host_vcpu:
93 * @cpus_to_try: array of QEMU_KVM_ARM_TARGET_* values (terminated with
94 * QEMU_KVM_ARM_TARGET_NONE) to try as fallback if the kernel does not
95 * know the PREFERRED_TARGET ioctl
96 * @fdarray: filled in with kvmfd, vmfd, cpufd file descriptors in that order
97 * @init: filled in with the necessary values for creating a host vcpu
99 * Create a scratch vcpu in its own VM of the type preferred by the host
100 * kernel (as would be used for '-cpu host'), for purposes of probing it
101 * for capabilities.
103 * Returns: true on success (and fdarray and init are filled in),
104 * false on failure (and fdarray and init are not valid).
106 bool kvm_arm_create_scratch_host_vcpu(const uint32_t *cpus_to_try,
107 int *fdarray,
108 struct kvm_vcpu_init *init);
111 * kvm_arm_destroy_scratch_host_vcpu:
112 * @fdarray: array of fds as set up by kvm_arm_create_scratch_host_vcpu
114 * Tear down the scratch vcpu created by kvm_arm_create_scratch_host_vcpu.
116 void kvm_arm_destroy_scratch_host_vcpu(int *fdarray);
118 #define TYPE_ARM_HOST_CPU "host-" TYPE_ARM_CPU
119 #define ARM_HOST_CPU_CLASS(klass) \
120 OBJECT_CLASS_CHECK(ARMHostCPUClass, (klass), TYPE_ARM_HOST_CPU)
121 #define ARM_HOST_CPU_GET_CLASS(obj) \
122 OBJECT_GET_CLASS(ARMHostCPUClass, (obj), TYPE_ARM_HOST_CPU)
124 typedef struct ARMHostCPUClass {
125 /*< private >*/
126 ARMCPUClass parent_class;
127 /*< public >*/
129 uint64_t features;
130 uint32_t target;
131 const char *dtb_compatible;
132 } ARMHostCPUClass;
135 * kvm_arm_get_host_cpu_features:
136 * @ahcc: ARMHostCPUClass to fill in
138 * Probe the capabilities of the host kernel's preferred CPU and fill
139 * in the ARMHostCPUClass struct accordingly.
141 bool kvm_arm_get_host_cpu_features(ARMHostCPUClass *ahcc);
143 #endif
145 #endif