]>
Commit | Line | Data |
---|---|---|
0975c304 TS |
1 | /* |
2 | * QEMU VMPort emulation | |
3 | * | |
bcc4e41f | 4 | * Copyright (C) 2007 Hervé Poussineau |
0975c304 TS |
5 | * |
6 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
7 | * of this software and associated documentation files (the "Software"), to deal | |
8 | * in the Software without restriction, including without limitation the rights | |
9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
10 | * copies of the Software, and to permit persons to whom the Software is | |
11 | * furnished to do so, subject to the following conditions: | |
12 | * | |
13 | * The above copyright notice and this permission notice shall be included in | |
14 | * all copies or substantial portions of the Software. | |
15 | * | |
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL | |
19 | * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |
22 | * THE SOFTWARE. | |
23 | */ | |
29282253 LA |
24 | |
25 | /* | |
26 | * Guest code that interacts with this virtual device can be found | |
27 | * in VMware open-vm-tools open-source project: | |
28 | * https://github.com/vmware/open-vm-tools | |
29 | */ | |
30 | ||
0d1c9782 | 31 | #include "qemu/osdep.h" |
0d09e41a | 32 | #include "hw/isa/isa.h" |
d8f23d61 | 33 | #include "hw/i386/vmport.h" |
c9ab24ce | 34 | #include "hw/qdev-properties.h" |
aaacf1c1 | 35 | #include "sysemu/sysemu.h" |
b3946626 | 36 | #include "sysemu/hw_accel.h" |
c781a2cc | 37 | #include "sysemu/qtest.h" |
43ab9a53 | 38 | #include "qemu/log.h" |
d8a05995 | 39 | #include "cpu.h" |
7299e1a4 | 40 | #include "trace.h" |
61ada15d | 41 | |
0975c304 TS |
42 | #define VMPORT_MAGIC 0x564D5868 |
43 | ||
b8892129 | 44 | /* Compatibility flags for migration */ |
0342ee76 LA |
45 | #define VMPORT_COMPAT_READ_SET_EAX_BIT 0 |
46 | #define VMPORT_COMPAT_SIGNAL_UNSUPPORTED_CMD_BIT 1 | |
f8bdc550 | 47 | #define VMPORT_COMPAT_REPORT_VMX_TYPE_BIT 2 |
aaacf1c1 | 48 | #define VMPORT_COMPAT_CMDS_V2_BIT 3 |
0342ee76 | 49 | #define VMPORT_COMPAT_READ_SET_EAX \ |
b8892129 | 50 | (1 << VMPORT_COMPAT_READ_SET_EAX_BIT) |
0342ee76 LA |
51 | #define VMPORT_COMPAT_SIGNAL_UNSUPPORTED_CMD \ |
52 | (1 << VMPORT_COMPAT_SIGNAL_UNSUPPORTED_CMD_BIT) | |
f8bdc550 LA |
53 | #define VMPORT_COMPAT_REPORT_VMX_TYPE \ |
54 | (1 << VMPORT_COMPAT_REPORT_VMX_TYPE_BIT) | |
aaacf1c1 LA |
55 | #define VMPORT_COMPAT_CMDS_V2 \ |
56 | (1 << VMPORT_COMPAT_CMDS_V2_BIT) | |
b8892129 | 57 | |
acacd355 LA |
58 | /* vCPU features reported by CMD_GET_VCPU_INFO */ |
59 | #define VCPU_INFO_SLC64_BIT 0 | |
60 | #define VCPU_INFO_SYNC_VTSCS_BIT 1 | |
61 | #define VCPU_INFO_HV_REPLAY_OK_BIT 2 | |
62 | #define VCPU_INFO_LEGACY_X2APIC_BIT 3 | |
63 | #define VCPU_INFO_RESERVED_BIT 31 | |
64 | ||
f02317ad AF |
65 | #define VMPORT(obj) OBJECT_CHECK(VMPortState, (obj), TYPE_VMPORT) |
66 | ||
323d7d1d | 67 | typedef struct VMPortState { |
f02317ad AF |
68 | ISADevice parent_obj; |
69 | ||
f75317b4 | 70 | MemoryRegion io; |
d67f679d | 71 | VMPortReadFunc *func[VMPORT_ENTRIES]; |
0975c304 | 72 | void *opaque[VMPORT_ENTRIES]; |
b8892129 | 73 | |
2fd2f799 | 74 | uint32_t vmware_vmx_version; |
f8bdc550 | 75 | uint8_t vmware_vmx_type; |
2fd2f799 | 76 | |
b8892129 | 77 | uint32_t compat_flags; |
0975c304 TS |
78 | } VMPortState; |
79 | ||
e14da0af | 80 | static VMPortState *port_state; |
0975c304 | 81 | |
dcd938f0 | 82 | void vmport_register(VMPortCommand command, VMPortReadFunc *func, void *opaque) |
0975c304 | 83 | { |
dcd938f0 | 84 | assert(command < VMPORT_ENTRIES); |
23accdf1 LA |
85 | assert(port_state); |
86 | ||
7299e1a4 | 87 | trace_vmport_register(command, func, opaque); |
e14da0af MT |
88 | port_state->func[command] = func; |
89 | port_state->opaque[command] = opaque; | |
0975c304 TS |
90 | } |
91 | ||
360d613e AG |
92 | static uint64_t vmport_ioport_read(void *opaque, hwaddr addr, |
93 | unsigned size) | |
0975c304 TS |
94 | { |
95 | VMPortState *s = opaque; | |
4917cf44 AF |
96 | CPUState *cs = current_cpu; |
97 | X86CPU *cpu = X86_CPU(cs); | |
c781a2cc | 98 | CPUX86State *env; |
0975c304 | 99 | unsigned char command; |
6dab28d5 | 100 | uint32_t eax; |
0975c304 | 101 | |
c781a2cc PMD |
102 | if (qtest_enabled()) { |
103 | return -1; | |
104 | } | |
105 | env = &cpu->env; | |
4917cf44 | 106 | cpu_synchronize_state(cs); |
03c63b94 | 107 | |
26fb5e48 | 108 | eax = env->regs[R_EAX]; |
323d7d1d | 109 | if (eax != VMPORT_MAGIC) { |
0342ee76 | 110 | goto err; |
323d7d1d | 111 | } |
0975c304 | 112 | |
26fb5e48 | 113 | command = env->regs[R_ECX]; |
7299e1a4 PMD |
114 | trace_vmport_command(command); |
115 | if (command >= VMPORT_ENTRIES || !s->func[command]) { | |
116 | qemu_log_mask(LOG_UNIMP, "vmport: unknown command %x\n", command); | |
0342ee76 | 117 | goto err; |
b8892129 LA |
118 | } |
119 | ||
120 | eax = s->func[command](s->opaque[command], addr); | |
0342ee76 LA |
121 | goto out; |
122 | ||
123 | err: | |
124 | if (s->compat_flags & VMPORT_COMPAT_SIGNAL_UNSUPPORTED_CMD) { | |
125 | eax = UINT32_MAX; | |
126 | } | |
b8892129 LA |
127 | |
128 | out: | |
129 | /* | |
130 | * The call above to cpu_synchronize_state() gets vCPU registers values | |
131 | * to QEMU but also cause QEMU to write QEMU vCPU registers values to | |
132 | * vCPU implementation (e.g. Accelerator such as KVM) just before | |
133 | * resuming guest. | |
134 | * | |
135 | * Therefore, in order to make IOPort return value propagate to | |
136 | * guest EAX, we need to explicitly update QEMU EAX register value. | |
137 | */ | |
138 | if (s->compat_flags & VMPORT_COMPAT_READ_SET_EAX) { | |
139 | cpu->env.regs[R_EAX] = eax; | |
0975c304 TS |
140 | } |
141 | ||
b8892129 | 142 | return eax; |
0975c304 TS |
143 | } |
144 | ||
360d613e AG |
145 | static void vmport_ioport_write(void *opaque, hwaddr addr, |
146 | uint64_t val, unsigned size) | |
e9396bde | 147 | { |
4917cf44 | 148 | X86CPU *cpu = X86_CPU(current_cpu); |
e9396bde | 149 | |
c781a2cc PMD |
150 | if (qtest_enabled()) { |
151 | return; | |
152 | } | |
4917cf44 | 153 | cpu->env.regs[R_EAX] = vmport_ioport_read(opaque, addr, 4); |
e9396bde AL |
154 | } |
155 | ||
0975c304 TS |
156 | static uint32_t vmport_cmd_get_version(void *opaque, uint32_t addr) |
157 | { | |
4917cf44 AF |
158 | X86CPU *cpu = X86_CPU(current_cpu); |
159 | ||
c781a2cc PMD |
160 | if (qtest_enabled()) { |
161 | return -1; | |
162 | } | |
4917cf44 | 163 | cpu->env.regs[R_EBX] = VMPORT_MAGIC; |
f8bdc550 LA |
164 | if (port_state->compat_flags & VMPORT_COMPAT_REPORT_VMX_TYPE) { |
165 | cpu->env.regs[R_ECX] = port_state->vmware_vmx_type; | |
166 | } | |
2fd2f799 | 167 | return port_state->vmware_vmx_version; |
0975c304 TS |
168 | } |
169 | ||
aaacf1c1 LA |
170 | static uint32_t vmport_cmd_get_bios_uuid(void *opaque, uint32_t addr) |
171 | { | |
172 | X86CPU *cpu = X86_CPU(current_cpu); | |
173 | uint32_t *uuid_parts = (uint32_t *)(qemu_uuid.data); | |
174 | ||
175 | cpu->env.regs[R_EAX] = le32_to_cpu(uuid_parts[0]); | |
176 | cpu->env.regs[R_EBX] = le32_to_cpu(uuid_parts[1]); | |
177 | cpu->env.regs[R_ECX] = le32_to_cpu(uuid_parts[2]); | |
178 | cpu->env.regs[R_EDX] = le32_to_cpu(uuid_parts[3]); | |
179 | return cpu->env.regs[R_EAX]; | |
180 | } | |
181 | ||
0975c304 TS |
182 | static uint32_t vmport_cmd_ram_size(void *opaque, uint32_t addr) |
183 | { | |
4917cf44 AF |
184 | X86CPU *cpu = X86_CPU(current_cpu); |
185 | ||
c781a2cc PMD |
186 | if (qtest_enabled()) { |
187 | return -1; | |
188 | } | |
4917cf44 | 189 | cpu->env.regs[R_EBX] = 0x1177; |
0975c304 TS |
190 | return ram_size; |
191 | } | |
192 | ||
d6048bfd LA |
193 | static uint32_t vmport_cmd_get_hz(void *opaque, uint32_t addr) |
194 | { | |
195 | X86CPU *cpu = X86_CPU(current_cpu); | |
196 | ||
197 | if (cpu->env.tsc_khz && cpu->env.apic_bus_freq) { | |
198 | uint64_t tsc_freq = (uint64_t)cpu->env.tsc_khz * 1000; | |
199 | ||
200 | cpu->env.regs[R_ECX] = cpu->env.apic_bus_freq; | |
201 | cpu->env.regs[R_EBX] = (uint32_t)(tsc_freq >> 32); | |
202 | cpu->env.regs[R_EAX] = (uint32_t)tsc_freq; | |
203 | } else { | |
204 | /* Signal cmd as not supported */ | |
205 | cpu->env.regs[R_EBX] = UINT32_MAX; | |
206 | } | |
207 | ||
208 | return cpu->env.regs[R_EAX]; | |
209 | } | |
210 | ||
acacd355 LA |
211 | static uint32_t vmport_cmd_get_vcpu_info(void *opaque, uint32_t addr) |
212 | { | |
7f9114b7 LA |
213 | X86CPU *cpu = X86_CPU(current_cpu); |
214 | uint32_t ret = 0; | |
215 | ||
216 | if (cpu->env.features[FEAT_1_ECX] & CPUID_EXT_X2APIC) { | |
217 | ret |= 1 << VCPU_INFO_LEGACY_X2APIC_BIT; | |
218 | } | |
219 | ||
220 | return ret; | |
acacd355 LA |
221 | } |
222 | ||
f75317b4 | 223 | static const MemoryRegionOps vmport_ops = { |
360d613e AG |
224 | .read = vmport_ioport_read, |
225 | .write = vmport_ioport_write, | |
226 | .impl = { | |
227 | .min_access_size = 4, | |
228 | .max_access_size = 4, | |
229 | }, | |
230 | .endianness = DEVICE_LITTLE_ENDIAN, | |
f75317b4 RH |
231 | }; |
232 | ||
db895a1e | 233 | static void vmport_realizefn(DeviceState *dev, Error **errp) |
0975c304 | 234 | { |
db895a1e | 235 | ISADevice *isadev = ISA_DEVICE(dev); |
f02317ad | 236 | VMPortState *s = VMPORT(dev); |
0975c304 | 237 | |
3c161542 | 238 | memory_region_init_io(&s->io, OBJECT(s), &vmport_ops, s, "vmport", 1); |
db895a1e | 239 | isa_register_ioport(isadev, &s->io, 0x5658); |
f75317b4 | 240 | |
e14da0af | 241 | port_state = s; |
aaacf1c1 | 242 | |
0975c304 | 243 | /* Register some generic port commands */ |
26fb5e48 AJ |
244 | vmport_register(VMPORT_CMD_GETVERSION, vmport_cmd_get_version, NULL); |
245 | vmport_register(VMPORT_CMD_GETRAMSIZE, vmport_cmd_ram_size, NULL); | |
aaacf1c1 LA |
246 | if (s->compat_flags & VMPORT_COMPAT_CMDS_V2) { |
247 | vmport_register(VMPORT_CMD_GETBIOSUUID, vmport_cmd_get_bios_uuid, NULL); | |
d6048bfd | 248 | vmport_register(VMPORT_CMD_GETHZ, vmport_cmd_get_hz, NULL); |
acacd355 LA |
249 | vmport_register(VMPORT_CMD_GET_VCPU_INFO, vmport_cmd_get_vcpu_info, |
250 | NULL); | |
aaacf1c1 | 251 | } |
0975c304 | 252 | } |
6872ef61 | 253 | |
c9ab24ce | 254 | static Property vmport_properties[] = { |
b8892129 LA |
255 | /* Used to enforce compatibility for migration */ |
256 | DEFINE_PROP_BIT("x-read-set-eax", VMPortState, compat_flags, | |
257 | VMPORT_COMPAT_READ_SET_EAX_BIT, true), | |
0342ee76 LA |
258 | DEFINE_PROP_BIT("x-signal-unsupported-cmd", VMPortState, compat_flags, |
259 | VMPORT_COMPAT_SIGNAL_UNSUPPORTED_CMD_BIT, true), | |
f8bdc550 LA |
260 | DEFINE_PROP_BIT("x-report-vmx-type", VMPortState, compat_flags, |
261 | VMPORT_COMPAT_REPORT_VMX_TYPE_BIT, true), | |
aaacf1c1 LA |
262 | DEFINE_PROP_BIT("x-cmds-v2", VMPortState, compat_flags, |
263 | VMPORT_COMPAT_CMDS_V2_BIT, true), | |
2fd2f799 LA |
264 | |
265 | /* Default value taken from open-vm-tools code VERSION_MAGIC definition */ | |
266 | DEFINE_PROP_UINT32("vmware-vmx-version", VMPortState, | |
267 | vmware_vmx_version, 6), | |
f8bdc550 LA |
268 | /* |
269 | * Value determines which VMware product type host report itself to guest. | |
270 | * | |
271 | * Most guests are fine with exposing host as VMware ESX server. | |
272 | * Some legacy/proprietary guests hard-code a given type. | |
273 | * | |
274 | * For a complete list of values, refer to enum VMXType at open-vm-tools | |
275 | * project (Defined at lib/include/vm_vmx_type.h). | |
276 | * | |
277 | * Reasonable options: | |
278 | * 0 - Unset | |
279 | * 1 - VMware Express (deprecated) | |
280 | * 2 - VMware ESX Server | |
281 | * 3 - VMware Server (Deprecated) | |
282 | * 4 - VMware Workstation | |
283 | * 5 - ACE 1.x (Deprecated) | |
284 | */ | |
285 | DEFINE_PROP_UINT8("vmware-vmx-type", VMPortState, vmware_vmx_type, 2), | |
2fd2f799 | 286 | |
c9ab24ce LA |
287 | DEFINE_PROP_END_OF_LIST(), |
288 | }; | |
289 | ||
8f04ee08 AL |
290 | static void vmport_class_initfn(ObjectClass *klass, void *data) |
291 | { | |
39bffca2 | 292 | DeviceClass *dc = DEVICE_CLASS(klass); |
db895a1e AF |
293 | |
294 | dc->realize = vmport_realizefn; | |
f3b17640 | 295 | /* Reason: realize sets global port_state */ |
e90f2a8c | 296 | dc->user_creatable = false; |
c9ab24ce | 297 | device_class_set_props(dc, vmport_properties); |
8f04ee08 AL |
298 | } |
299 | ||
8c43a6f0 | 300 | static const TypeInfo vmport_info = { |
f02317ad | 301 | .name = TYPE_VMPORT, |
39bffca2 AL |
302 | .parent = TYPE_ISA_DEVICE, |
303 | .instance_size = sizeof(VMPortState), | |
304 | .class_init = vmport_class_initfn, | |
6872ef61 BS |
305 | }; |
306 | ||
83f7d43a | 307 | static void vmport_register_types(void) |
6872ef61 | 308 | { |
39bffca2 | 309 | type_register_static(&vmport_info); |
6872ef61 | 310 | } |
83f7d43a AF |
311 | |
312 | type_init(vmport_register_types) |