qemu/hw/i386/xen/xen_platform.c
<<
>>
Prefs
   1/*
   2 * XEN platform pci device, formerly known as the event channel device
   3 *
   4 * Copyright (c) 2003-2004 Intel Corp.
   5 * Copyright (c) 2006 XenSource
   6 *
   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:
  13 *
  14 * The above copyright notice and this permission notice shall be included in
  15 * all copies or substantial portions of the Software.
  16 *
  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
  23 * THE SOFTWARE.
  24 */
  25
  26#include "qemu/osdep.h"
  27#include "qapi/error.h"
  28#include "hw/hw.h"
  29#include "hw/i386/pc.h"
  30#include "hw/ide.h"
  31#include "hw/pci/pci.h"
  32#include "hw/irq.h"
  33#include "hw/xen/xen_common.h"
  34#include "hw/xen/xen_backend.h"
  35#include "trace.h"
  36#include "exec/address-spaces.h"
  37#include "sysemu/block-backend.h"
  38#include "qemu/error-report.h"
  39
  40#include <xenguest.h>
  41
  42//#define DEBUG_PLATFORM
  43
  44#ifdef DEBUG_PLATFORM
  45#define DPRINTF(fmt, ...) do { \
  46    fprintf(stderr, "xen_platform: " fmt, ## __VA_ARGS__); \
  47} while (0)
  48#else
  49#define DPRINTF(fmt, ...) do { } while (0)
  50#endif
  51
  52#define PFFLAG_ROM_LOCK 1 /* Sets whether ROM memory area is RW or RO */
  53
  54typedef struct PCIXenPlatformState {
  55    /*< private >*/
  56    PCIDevice parent_obj;
  57    /*< public >*/
  58
  59    MemoryRegion fixed_io;
  60    MemoryRegion bar;
  61    MemoryRegion mmio_bar;
  62    uint8_t flags; /* used only for version_id == 2 */
  63    int drivers_blacklisted;
  64    uint16_t driver_product_version;
  65
  66    /* Log from guest drivers */
  67    char log_buffer[4096];
  68    int log_buffer_off;
  69} PCIXenPlatformState;
  70
  71#define TYPE_XEN_PLATFORM "xen-platform"
  72#define XEN_PLATFORM(obj) \
  73    OBJECT_CHECK(PCIXenPlatformState, (obj), TYPE_XEN_PLATFORM)
  74
  75#define XEN_PLATFORM_IOPORT 0x10
  76
  77/* Send bytes to syslog */
  78static void log_writeb(PCIXenPlatformState *s, char val)
  79{
  80    if (val == '\n' || s->log_buffer_off == sizeof(s->log_buffer) - 1) {
  81        /* Flush buffer */
  82        s->log_buffer[s->log_buffer_off] = 0;
  83        trace_xen_platform_log(s->log_buffer);
  84        s->log_buffer_off = 0;
  85    } else {
  86        s->log_buffer[s->log_buffer_off++] = val;
  87    }
  88}
  89
  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
  94
  95static void unplug_nic(PCIBus *b, PCIDevice *d, void *o)
  96{
  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));
 102    }
 103}
 104
 105static void pci_unplug_nics(PCIBus *bus)
 106{
 107    pci_for_each_device(bus, 0, unplug_nic, NULL);
 108}
 109
 110static void unplug_disks(PCIBus *b, PCIDevice *d, void *o)
 111{
 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));
 117    }
 118}
 119
 120static void pci_unplug_disks(PCIBus *bus)
 121{
 122    pci_for_each_device(bus, 0, unplug_disks, NULL);
 123}
 124
 125static void platform_fixed_ioport_writew(void *opaque, uint32_t addr, uint32_t val)
 126{
 127    PCIXenPlatformState *s = opaque;
 128
 129    switch (addr) {
 130    case 0: {
 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");
 137            blk_drain_all();
 138            blk_flush_all();
 139            pci_unplug_disks(pci_dev->bus);
 140        }
 141        if (val & UNPLUG_ALL_NICS) {
 142            DPRINTF("unplug nics\n");
 143            pci_unplug_nics(pci_dev->bus);
 144        }
 145        if (val & UNPLUG_AUX_IDE_DISKS) {
 146            DPRINTF("unplug auxiliary disks not supported\n");
 147        }
 148        break;
 149    }
 150    case 2:
 151        switch (val) {
 152        case 1:
 153            DPRINTF("Citrix Windows PV drivers loaded in guest\n");
 154            break;
 155        case 0:
 156            DPRINTF("Guest claimed to be running PV product 0?\n");
 157            break;
 158        default:
 159            DPRINTF("Unknown PV product %d loaded in guest\n", val);
 160            break;
 161        }
 162        s->driver_product_version = val;
 163        break;
 164    }
 165}
 166
 167static void platform_fixed_ioport_writel(void *opaque, uint32_t addr,
 168                                         uint32_t val)
 169{
 170    switch (addr) {
 171    case 0:
 172        /* PV driver version */
 173        break;
 174    }
 175}
 176
 177static void platform_fixed_ioport_writeb(void *opaque, uint32_t addr, uint32_t val)
 178{
 179    PCIXenPlatformState *s = opaque;
 180
 181    switch (addr) {
 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");
 187        } else {
 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"));
 191        }
 192        break;
 193    }
 194    case 2:
 195        log_writeb(s, val);
 196        break;
 197    }
 198}
 199
 200static uint32_t platform_fixed_ioport_readw(void *opaque, uint32_t addr)
 201{
 202    PCIXenPlatformState *s = opaque;
 203
 204    switch (addr) {
 205    case 0:
 206        if (s->drivers_blacklisted) {
 207            /* The drivers will recognise this magic number and refuse
 208             * to do anything. */
 209            return 0xd249;
 210        } else {
 211            /* Magic value so that you can identify the interface. */
 212            return 0x49d2;
 213        }
 214    default:
 215        return 0xffff;
 216    }
 217}
 218
 219static uint32_t platform_fixed_ioport_readb(void *opaque, uint32_t addr)
 220{
 221    PCIXenPlatformState *s = opaque;
 222
 223    switch (addr) {
 224    case 0:
 225        /* Platform flags */
 226        return s->flags;
 227    case 2:
 228        /* Version number */
 229        return 1;
 230    default:
 231        return 0xff;
 232    }
 233}
 234
 235static void platform_fixed_ioport_reset(void *opaque)
 236{
 237    PCIXenPlatformState *s = opaque;
 238
 239    platform_fixed_ioport_writeb(s, 0, 0);
 240}
 241
 242static uint64_t platform_fixed_ioport_read(void *opaque,
 243                                           hwaddr addr,
 244                                           unsigned size)
 245{
 246    switch (size) {
 247    case 1:
 248        return platform_fixed_ioport_readb(opaque, addr);
 249    case 2:
 250        return platform_fixed_ioport_readw(opaque, addr);
 251    default:
 252        return -1;
 253    }
 254}
 255
 256static void platform_fixed_ioport_write(void *opaque, hwaddr addr,
 257
 258                                        uint64_t val, unsigned size)
 259{
 260    switch (size) {
 261    case 1:
 262        platform_fixed_ioport_writeb(opaque, addr, val);
 263        break;
 264    case 2:
 265        platform_fixed_ioport_writew(opaque, addr, val);
 266        break;
 267    case 4:
 268        platform_fixed_ioport_writel(opaque, addr, val);
 269        break;
 270    }
 271}
 272
 273
 274static const MemoryRegionOps platform_fixed_io_ops = {
 275    .read = platform_fixed_ioport_read,
 276    .write = platform_fixed_ioport_write,
 277    .valid = {
 278        .unaligned = true,
 279    },
 280    .impl = {
 281        .min_access_size = 1,
 282        .max_access_size = 4,
 283        .unaligned = true,
 284    },
 285    .endianness = DEVICE_LITTLE_ENDIAN,
 286};
 287
 288static void platform_fixed_ioport_init(PCIXenPlatformState* s)
 289{
 290    memory_region_init_io(&s->fixed_io, OBJECT(s), &platform_fixed_io_ops, s,
 291                          "xen-fixed", 16);
 292    memory_region_add_subregion(get_system_io(), XEN_PLATFORM_IOPORT,
 293                                &s->fixed_io);
 294}
 295
 296/* Xen Platform PCI Device */
 297
 298static uint64_t xen_platform_ioport_readb(void *opaque, hwaddr addr,
 299                                          unsigned int size)
 300{
 301    if (addr == 0) {
 302        return platform_fixed_ioport_readb(opaque, 0);
 303    } else {
 304        return ~0u;
 305    }
 306}
 307
 308static void xen_platform_ioport_writeb(void *opaque, hwaddr addr,
 309                                       uint64_t val, unsigned int size)
 310{
 311    PCIXenPlatformState *s = opaque;
 312
 313    switch (addr) {
 314    case 0: /* Platform flags */
 315        platform_fixed_ioport_writeb(opaque, 0, (uint32_t)val);
 316        break;
 317    case 8:
 318        log_writeb(s, (uint32_t)val);
 319        break;
 320    default:
 321        break;
 322    }
 323}
 324
 325static 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,
 330};
 331
 332static void platform_ioport_bar_setup(PCIXenPlatformState *d)
 333{
 334    memory_region_init_io(&d->bar, OBJECT(d), &xen_pci_io_ops, d,
 335                          "xen-pci", 0x100);
 336}
 337
 338static uint64_t platform_mmio_read(void *opaque, hwaddr addr,
 339                                   unsigned size)
 340{
 341    DPRINTF("Warning: attempted read from physical address "
 342            "0x" TARGET_FMT_plx " in xen platform mmio space\n", addr);
 343
 344    return 0;
 345}
 346
 347static void platform_mmio_write(void *opaque, hwaddr addr,
 348                                uint64_t val, unsigned size)
 349{
 350    DPRINTF("Warning: attempted write of 0x%"PRIx64" to physical "
 351            "address 0x" TARGET_FMT_plx " in xen platform mmio space\n",
 352            val, addr);
 353}
 354
 355static const MemoryRegionOps platform_mmio_handler = {
 356    .read = &platform_mmio_read,
 357    .write = &platform_mmio_write,
 358    .endianness = DEVICE_NATIVE_ENDIAN,
 359};
 360
 361static void platform_mmio_setup(PCIXenPlatformState *d)
 362{
 363    memory_region_init_io(&d->mmio_bar, OBJECT(d), &platform_mmio_handler, d,
 364                          "xen-mmio", 0x1000000);
 365}
 366
 367static int xen_platform_post_load(void *opaque, int version_id)
 368{
 369    PCIXenPlatformState *s = opaque;
 370
 371    platform_fixed_ioport_writeb(s, 0, s->flags);
 372
 373    return 0;
 374}
 375
 376static const VMStateDescription vmstate_xen_platform = {
 377    .name = "platform",
 378    .version_id = 4,
 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()
 385    }
 386};
 387
 388static void xen_platform_realize(PCIDevice *dev, Error **errp)
 389{
 390    PCIXenPlatformState *d = XEN_PLATFORM(dev);
 391    uint8_t *pci_conf;
 392
 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");
 396        return;
 397    }
 398
 399    pci_conf = dev->config;
 400
 401    pci_set_word(pci_conf + PCI_COMMAND, PCI_COMMAND_IO | PCI_COMMAND_MEMORY);
 402
 403    pci_config_set_prog_interface(pci_conf, 0);
 404
 405    pci_conf[PCI_INTERRUPT_PIN] = 1;
 406
 407    platform_ioport_bar_setup(d);
 408    pci_register_bar(dev, 0, PCI_BASE_ADDRESS_SPACE_IO, &d->bar);
 409
 410    /* reserve 16MB mmio address for share memory*/
 411    platform_mmio_setup(d);
 412    pci_register_bar(dev, 1, PCI_BASE_ADDRESS_MEM_PREFETCH,
 413                     &d->mmio_bar);
 414
 415    platform_fixed_ioport_init(d);
 416}
 417
 418static void platform_reset(DeviceState *dev)
 419{
 420    PCIXenPlatformState *s = XEN_PLATFORM(dev);
 421
 422    platform_fixed_ioport_reset(s);
 423}
 424
 425static void xen_platform_class_init(ObjectClass *klass, void *data)
 426{
 427    DeviceClass *dc = DEVICE_CLASS(klass);
 428    PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
 429
 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;
 436    k->revision = 1;
 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;
 441}
 442
 443static 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,
 448};
 449
 450static void xen_platform_register_types(void)
 451{
 452    type_register_static(&xen_platform_info);
 453}
 454
 455type_init(xen_platform_register_types)
 456