2 * XEN platform pci device, formerly known as the event channel device
4 * Copyright (c) 2003-2004 Intel Corp.
5 * Copyright (c) 2006 XenSource
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
26 #include "qemu/osdep.h"
27 #include "qapi/error.h"
29 #include "hw/i386/pc.h"
31 #include "hw/pci/pci.h"
33 #include "hw/xen/xen_common.h"
34 #include "hw/xen/xen_backend.h"
36 #include "exec/address-spaces.h"
37 #include "sysemu/block-backend.h"
38 #include "qemu/error-report.h"
42 //#define DEBUG_PLATFORM
45 #define DPRINTF(fmt, ...) do { \
46 fprintf(stderr, "xen_platform: " fmt, ## __VA_ARGS__); \
49 #define DPRINTF(fmt, ...) do { } while (0)
52 #define PFFLAG_ROM_LOCK 1 /* Sets whether ROM memory area is RW or RO */
54 typedef struct PCIXenPlatformState {
59 MemoryRegion fixed_io;
61 MemoryRegion mmio_bar;
62 uint8_t flags; /* used only for version_id == 2 */
63 int drivers_blacklisted;
64 uint16_t driver_product_version;
66 /* Log from guest drivers */
67 char log_buffer[4096];
69 } PCIXenPlatformState;
71 #define TYPE_XEN_PLATFORM "xen-platform"
72 #define XEN_PLATFORM(obj) \
73 OBJECT_CHECK(PCIXenPlatformState, (obj), TYPE_XEN_PLATFORM)
75 #define XEN_PLATFORM_IOPORT 0x10
77 /* Send bytes to syslog */
78 static void log_writeb(PCIXenPlatformState *s, char val)
80 if (val == '\n' || s->log_buffer_off == sizeof(s->log_buffer) - 1) {
82 s->log_buffer[s->log_buffer_off] = 0;
83 trace_xen_platform_log(s->log_buffer);
84 s->log_buffer_off = 0;
86 s->log_buffer[s->log_buffer_off++] = val;
90 /* Xen Platform, Fixed IOPort */
91 #define UNPLUG_ALL_IDE_DISKS 1
92 #define UNPLUG_ALL_NICS 2
93 #define UNPLUG_AUX_IDE_DISKS 4
95 static void unplug_nic(PCIBus *b, PCIDevice *d, void *o)
97 /* We have to ignore passthrough devices */
98 if (pci_get_word(d->config + PCI_CLASS_DEVICE) ==
99 PCI_CLASS_NETWORK_ETHERNET
100 && strcmp(d->name, "xen-pci-passthrough") != 0) {
101 object_unparent(OBJECT(d));
105 static void pci_unplug_nics(PCIBus *bus)
107 pci_for_each_device(bus, 0, unplug_nic, NULL);
110 static void unplug_disks(PCIBus *b, PCIDevice *d, void *o)
112 /* We have to ignore passthrough devices */
113 if (pci_get_word(d->config + PCI_CLASS_DEVICE) ==
114 PCI_CLASS_STORAGE_IDE
115 && strcmp(d->name, "xen-pci-passthrough") != 0) {
116 pci_piix3_xen_ide_unplug(DEVICE(d));
120 static void pci_unplug_disks(PCIBus *bus)
122 pci_for_each_device(bus, 0, unplug_disks, NULL);
125 static void platform_fixed_ioport_writew(void *opaque, uint32_t addr, uint32_t val)
127 PCIXenPlatformState *s = opaque;
131 PCIDevice *pci_dev = PCI_DEVICE(s);
132 /* Unplug devices. Value is a bitmask of which devices to
133 unplug, with bit 0 the IDE devices, bit 1 the network
134 devices, and bit 2 the non-primary-master IDE devices. */
135 if (val & UNPLUG_ALL_IDE_DISKS) {
136 DPRINTF("unplug disks\n");
139 pci_unplug_disks(pci_dev->bus);
141 if (val & UNPLUG_ALL_NICS) {
142 DPRINTF("unplug nics\n");
143 pci_unplug_nics(pci_dev->bus);
145 if (val & UNPLUG_AUX_IDE_DISKS) {
146 DPRINTF("unplug auxiliary disks not supported\n");
153 DPRINTF("Citrix Windows PV drivers loaded in guest\n");
156 DPRINTF("Guest claimed to be running PV product 0?\n");
159 DPRINTF("Unknown PV product %d loaded in guest\n", val);
162 s->driver_product_version = val;
167 static void platform_fixed_ioport_writel(void *opaque, uint32_t addr,
172 /* PV driver version */
177 static void platform_fixed_ioport_writeb(void *opaque, uint32_t addr, uint32_t val)
179 PCIXenPlatformState *s = opaque;
182 case 0: /* Platform flags */ {
183 hvmmem_type_t mem_type = (val & PFFLAG_ROM_LOCK) ?
184 HVMMEM_ram_ro : HVMMEM_ram_rw;
185 if (xc_hvm_set_mem_type(xen_xc, xen_domid, mem_type, 0xc0, 0x40)) {
186 DPRINTF("unable to change ro/rw state of ROM memory area!\n");
188 s->flags = val & PFFLAG_ROM_LOCK;
189 DPRINTF("changed ro/rw state of ROM memory area. now is %s state.\n",
190 (mem_type == HVMMEM_ram_ro ? "ro":"rw"));
200 static uint32_t platform_fixed_ioport_readw(void *opaque, uint32_t addr)
202 PCIXenPlatformState *s = opaque;
206 if (s->drivers_blacklisted) {
207 /* The drivers will recognise this magic number and refuse
211 /* Magic value so that you can identify the interface. */
219 static uint32_t platform_fixed_ioport_readb(void *opaque, uint32_t addr)
221 PCIXenPlatformState *s = opaque;
235 static void platform_fixed_ioport_reset(void *opaque)
237 PCIXenPlatformState *s = opaque;
239 platform_fixed_ioport_writeb(s, 0, 0);
242 static uint64_t platform_fixed_ioport_read(void *opaque,
248 return platform_fixed_ioport_readb(opaque, addr);
250 return platform_fixed_ioport_readw(opaque, addr);
256 static void platform_fixed_ioport_write(void *opaque, hwaddr addr,
258 uint64_t val, unsigned size)
262 platform_fixed_ioport_writeb(opaque, addr, val);
265 platform_fixed_ioport_writew(opaque, addr, val);
268 platform_fixed_ioport_writel(opaque, addr, val);
274 static const MemoryRegionOps platform_fixed_io_ops = {
275 .read = platform_fixed_ioport_read,
276 .write = platform_fixed_ioport_write,
281 .min_access_size = 1,
282 .max_access_size = 4,
285 .endianness = DEVICE_LITTLE_ENDIAN,
288 static void platform_fixed_ioport_init(PCIXenPlatformState* s)
290 memory_region_init_io(&s->fixed_io, OBJECT(s), &platform_fixed_io_ops, s,
292 memory_region_add_subregion(get_system_io(), XEN_PLATFORM_IOPORT,
296 /* Xen Platform PCI Device */
298 static uint64_t xen_platform_ioport_readb(void *opaque, hwaddr addr,
302 return platform_fixed_ioport_readb(opaque, 0);
308 static void xen_platform_ioport_writeb(void *opaque, hwaddr addr,
309 uint64_t val, unsigned int size)
311 PCIXenPlatformState *s = opaque;
314 case 0: /* Platform flags */
315 platform_fixed_ioport_writeb(opaque, 0, (uint32_t)val);
318 log_writeb(s, (uint32_t)val);
325 static const MemoryRegionOps xen_pci_io_ops = {
326 .read = xen_platform_ioport_readb,
327 .write = xen_platform_ioport_writeb,
328 .impl.min_access_size = 1,
329 .impl.max_access_size = 1,
332 static void platform_ioport_bar_setup(PCIXenPlatformState *d)
334 memory_region_init_io(&d->bar, OBJECT(d), &xen_pci_io_ops, d,
338 static uint64_t platform_mmio_read(void *opaque, hwaddr addr,
341 DPRINTF("Warning: attempted read from physical address "
342 "0x" TARGET_FMT_plx " in xen platform mmio space\n", addr);
347 static void platform_mmio_write(void *opaque, hwaddr addr,
348 uint64_t val, unsigned size)
350 DPRINTF("Warning: attempted write of 0x%"PRIx64" to physical "
351 "address 0x" TARGET_FMT_plx " in xen platform mmio space\n",
355 static const MemoryRegionOps platform_mmio_handler = {
356 .read = &platform_mmio_read,
357 .write = &platform_mmio_write,
358 .endianness = DEVICE_NATIVE_ENDIAN,
361 static void platform_mmio_setup(PCIXenPlatformState *d)
363 memory_region_init_io(&d->mmio_bar, OBJECT(d), &platform_mmio_handler, d,
364 "xen-mmio", 0x1000000);
367 static int xen_platform_post_load(void *opaque, int version_id)
369 PCIXenPlatformState *s = opaque;
371 platform_fixed_ioport_writeb(s, 0, s->flags);
376 static const VMStateDescription vmstate_xen_platform = {
379 .minimum_version_id = 4,
380 .post_load = xen_platform_post_load,
381 .fields = (VMStateField[]) {
382 VMSTATE_PCI_DEVICE(parent_obj, PCIXenPlatformState),
383 VMSTATE_UINT8(flags, PCIXenPlatformState),
384 VMSTATE_END_OF_LIST()
388 static void xen_platform_realize(PCIDevice *dev, Error **errp)
390 PCIXenPlatformState *d = XEN_PLATFORM(dev);
393 /* Device will crash on reset if xen is not initialized */
394 if (!xen_enabled()) {
395 error_setg(errp, "xen-platform device requires the Xen accelerator");
399 pci_conf = dev->config;
401 pci_set_word(pci_conf + PCI_COMMAND, PCI_COMMAND_IO | PCI_COMMAND_MEMORY);
403 pci_config_set_prog_interface(pci_conf, 0);
405 pci_conf[PCI_INTERRUPT_PIN] = 1;
407 platform_ioport_bar_setup(d);
408 pci_register_bar(dev, 0, PCI_BASE_ADDRESS_SPACE_IO, &d->bar);
410 /* reserve 16MB mmio address for share memory*/
411 platform_mmio_setup(d);
412 pci_register_bar(dev, 1, PCI_BASE_ADDRESS_MEM_PREFETCH,
415 platform_fixed_ioport_init(d);
418 static void platform_reset(DeviceState *dev)
420 PCIXenPlatformState *s = XEN_PLATFORM(dev);
422 platform_fixed_ioport_reset(s);
425 static void xen_platform_class_init(ObjectClass *klass, void *data)
427 DeviceClass *dc = DEVICE_CLASS(klass);
428 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
430 k->realize = xen_platform_realize;
431 k->vendor_id = PCI_VENDOR_ID_XEN;
432 k->device_id = PCI_DEVICE_ID_XEN_PLATFORM;
433 k->class_id = PCI_CLASS_OTHERS << 8 | 0x80;
434 k->subsystem_vendor_id = PCI_VENDOR_ID_XEN;
435 k->subsystem_id = PCI_DEVICE_ID_XEN_PLATFORM;
437 set_bit(DEVICE_CATEGORY_MISC, dc->categories);
438 dc->desc = "XEN platform pci device";
439 dc->reset = platform_reset;
440 dc->vmsd = &vmstate_xen_platform;
443 static const TypeInfo xen_platform_info = {
444 .name = TYPE_XEN_PLATFORM,
445 .parent = TYPE_PCI_DEVICE,
446 .instance_size = sizeof(PCIXenPlatformState),
447 .class_init = xen_platform_class_init,
450 static void xen_platform_register_types(void)
452 type_register_static(&xen_platform_info);
455 type_init(xen_platform_register_types)