hw/xen/xen_platform.c

   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 <assert.h>
  27
  28 #include "hw/hw.h"
  29 #include "hw/i386/pc.h"
  30 #include "hw/pci/pci.h"
  31 #include "hw/irq.h"
  32 #include "hw/xen/xen_common.h"
  33 #include "hw/xen/xen_backend.h"
  34 #include "trace.h"
  35 #include "exec/address-spaces.h"
  36
  37 #include <xenguest.h>
  38
  39 //#define DEBUG_PLATFORM
  40
  41 #ifdef DEBUG_PLATFORM
  42 #define DPRINTF(fmt, ...) do { \
  43     fprintf(stderr, "xen_platform: " fmt, ## __VA_ARGS__); \
  44 } while (0)
  45 #else
  46 #define DPRINTF(fmt, ...) do { } while (0)
  47 #endif
  48
  49 #define PFFLAG_ROM_LOCK 1 /* Sets whether ROM memory area is RW or RO */
  50
  51 typedef struct PCIXenPlatformState {
  52     PCIDevice  pci_dev;
  53     MemoryRegion fixed_io;
  54     MemoryRegion bar;
  55     MemoryRegion mmio_bar;
  56     uint8_t flags; /* used only for version_id == 2 */
  57     int drivers_blacklisted;
  58     uint16_t driver_product_version;
  59
  60     /* Log from guest drivers */
  61     char log_buffer[4096];
  62     int log_buffer_off;
  63 } PCIXenPlatformState;
  64
  65 #define TYPE_XEN_PLATFORM "xen-platform"
  66 #define XEN_PLATFORM(obj) \
  67     OBJECT_CHECK(PCIXenPlatformState, (obj), TYPE_XEN_PLATFORM)
  68
  69 #define XEN_PLATFORM_IOPORT 0x10
  70
  71 /* Send bytes to syslog */
  72 static void log_writeb(PCIXenPlatformState *s, char val)
  73 {
  74     if (val == '\n' || s->log_buffer_off == sizeof(s->log_buffer) - 1) {
  75         /* Flush buffer */
  76         s->log_buffer[s->log_buffer_off] = 0;
  77         trace_xen_platform_log(s->log_buffer);
  78         s->log_buffer_off = 0;
  79     } else {
  80         s->log_buffer[s->log_buffer_off++] = val;
  81     }
  82 }
  83
  84 /* Xen Platform, Fixed IOPort */
  85 #define UNPLUG_ALL_IDE_DISKS 1
  86 #define UNPLUG_ALL_NICS 2
  87 #define UNPLUG_AUX_IDE_DISKS 4
  88
  89 static void unplug_nic(PCIBus *b, PCIDevice *d, void *o)
  90 {
  91     /* We have to ignore passthrough devices */
  92     if (pci_get_word(d->config + PCI_CLASS_DEVICE) ==
  93             PCI_CLASS_NETWORK_ETHERNET
  94             && strcmp(d->name, "xen-pci-passthrough") != 0) {
  95         qdev_free(DEVICE(d));
  96     }
  97 }
  98
  99 static void pci_unplug_nics(PCIBus *bus)
 100 {
 101     pci_for_each_device(bus, 0, unplug_nic, NULL);
 102 }
 103
 104 static void unplug_disks(PCIBus *b, PCIDevice *d, void *o)
 105 {
 106     /* We have to ignore passthrough devices */
 107     if (pci_get_word(d->config + PCI_CLASS_DEVICE) ==
 108             PCI_CLASS_STORAGE_IDE
 109             && strcmp(d->name, "xen-pci-passthrough") != 0) {
 110         qdev_unplug(DEVICE(d), NULL);
 111     }
 112 }
 113
 114 static void pci_unplug_disks(PCIBus *bus)
 115 {
 116     pci_for_each_device(bus, 0, unplug_disks, NULL);
 117 }
 118
 119 static void platform_fixed_ioport_writew(void *opaque, uint32_t addr, uint32_t val)
 120 {
 121     PCIXenPlatformState *s = opaque;
 122
 123     switch (addr) {
 124     case 0:
 125         /* Unplug devices.  Value is a bitmask of which devices to
 126            unplug, with bit 0 the IDE devices, bit 1 the network
 127            devices, and bit 2 the non-primary-master IDE devices. */
 128         if (val & UNPLUG_ALL_IDE_DISKS) {
 129             DPRINTF("unplug disks\n");
 130             bdrv_drain_all();
 131             bdrv_flush_all();
 132             pci_unplug_disks(s->pci_dev.bus);
 133         }
 134         if (val & UNPLUG_ALL_NICS) {
 135             DPRINTF("unplug nics\n");
 136             pci_unplug_nics(s->pci_dev.bus);
 137         }
 138         if (val & UNPLUG_AUX_IDE_DISKS) {
 139             DPRINTF("unplug auxiliary disks not supported\n");
 140         }
 141         break;
 142     case 2:
 143         switch (val) {
 144         case 1:
 145             DPRINTF("Citrix Windows PV drivers loaded in guest\n");
 146             break;
 147         case 0:
 148             DPRINTF("Guest claimed to be running PV product 0?\n");
 149             break;
 150         default:
 151             DPRINTF("Unknown PV product %d loaded in guest\n", val);
 152             break;
 153         }
 154         s->driver_product_version = val;
 155         break;
 156     }
 157 }
 158
 159 static void platform_fixed_ioport_writel(void *opaque, uint32_t addr,
 160                                          uint32_t val)
 161 {
 162     switch (addr) {
 163     case 0:
 164         /* PV driver version */
 165         break;
 166     }
 167 }
 168
 169 static void platform_fixed_ioport_writeb(void *opaque, uint32_t addr, uint32_t val)
 170 {
 171     PCIXenPlatformState *s = opaque;
 172
 173     switch (addr) {
 174     case 0: /* Platform flags */ {
 175         hvmmem_type_t mem_type = (val & PFFLAG_ROM_LOCK) ?
 176             HVMMEM_ram_ro : HVMMEM_ram_rw;
 177         if (xc_hvm_set_mem_type(xen_xc, xen_domid, mem_type, 0xc0, 0x40)) {
 178             DPRINTF("unable to change ro/rw state of ROM memory area!\n");
 179         } else {
 180             s->flags = val & PFFLAG_ROM_LOCK;
 181             DPRINTF("changed ro/rw state of ROM memory area. now is %s state.\n",
 182                     (mem_type == HVMMEM_ram_ro ? "ro":"rw"));
 183         }
 184         break;
 185     }
 186     case 2:
 187         log_writeb(s, val);
 188         break;
 189     }
 190 }
 191
 192 static uint32_t platform_fixed_ioport_readw(void *opaque, uint32_t addr)
 193 {
 194     PCIXenPlatformState *s = opaque;
 195
 196     switch (addr) {
 197     case 0:
 198         if (s->drivers_blacklisted) {
 199             /* The drivers will recognise this magic number and refuse
 200              * to do anything. */
 201             return 0xd249;
 202         } else {
 203             /* Magic value so that you can identify the interface. */
 204             return 0x49d2;
 205         }
 206     default:
 207         return 0xffff;
 208     }
 209 }
 210
 211 static uint32_t platform_fixed_ioport_readb(void *opaque, uint32_t addr)
 212 {
 213     PCIXenPlatformState *s = opaque;
 214
 215     switch (addr) {
 216     case 0:
 217         /* Platform flags */
 218         return s->flags;
 219     case 2:
 220         /* Version number */
 221         return 1;
 222     default:
 223         return 0xff;
 224     }
 225 }
 226
 227 static void platform_fixed_ioport_reset(void *opaque)
 228 {
 229     PCIXenPlatformState *s = opaque;
 230
 231     platform_fixed_ioport_writeb(s, 0, 0);
 232 }
 233
 234 static uint64_t platform_fixed_ioport_read(void *opaque,
 235                                            hwaddr addr,
 236                                            unsigned size)
 237 {
 238     switch (size) {
 239     case 1:
 240         return platform_fixed_ioport_readb(opaque, addr);
 241     case 2:
 242         return platform_fixed_ioport_readw(opaque, addr);
 243     default:
 244         return -1;
 245     }
 246 }
 247
 248 static void platform_fixed_ioport_write(void *opaque, hwaddr addr,
 249
 250                                         uint64_t val, unsigned size)
 251 {
 252     switch (size) {
 253     case 1:
 254         platform_fixed_ioport_writeb(opaque, addr, val);
 255         break;
 256     case 2:
 257         platform_fixed_ioport_writew(opaque, addr, val);
 258         break;
 259     case 4:
 260         platform_fixed_ioport_writel(opaque, addr, val);
 261         break;
 262     }
 263 }
 264
 265
 266 static const MemoryRegionOps platform_fixed_io_ops = {
 267     .read = platform_fixed_ioport_read,
 268     .write = platform_fixed_ioport_write,
 269     .valid = {
 270         .unaligned = true,
 271     },
 272     .impl = {
 273         .min_access_size = 1,
 274         .max_access_size = 4,
 275         .unaligned = true,
 276     },
 277     .endianness = DEVICE_LITTLE_ENDIAN,
 278 };
 279
 280 static void platform_fixed_ioport_init(PCIXenPlatformState* s)
 281 {
 282     memory_region_init_io(&s->fixed_io, OBJECT(s), &platform_fixed_io_ops, s,
 283                           "xen-fixed", 16);
 284     memory_region_add_subregion(get_system_io(), XEN_PLATFORM_IOPORT,
 285                                 &s->fixed_io);
 286 }
 287
 288 /* Xen Platform PCI Device */
 289
 290 static uint64_t xen_platform_ioport_readb(void *opaque, hwaddr addr,
 291                                           unsigned int size)
 292 {
 293     if (addr == 0) {
 294         return platform_fixed_ioport_readb(opaque, 0);
 295     } else {
 296         return ~0u;
 297     }
 298 }
 299
 300 static void xen_platform_ioport_writeb(void *opaque, hwaddr addr,
 301                                        uint64_t val, unsigned int size)
 302 {
 303     PCIXenPlatformState *s = opaque;
 304
 305     switch (addr) {
 306     case 0: /* Platform flags */
 307         platform_fixed_ioport_writeb(opaque, 0, (uint32_t)val);
 308         break;
 309     case 8:
 310         log_writeb(s, (uint32_t)val);
 311         break;
 312     default:
 313         break;
 314     }
 315 }
 316
 317 static const MemoryRegionOps xen_pci_io_ops = {
 318     .read  = xen_platform_ioport_readb,
 319     .write = xen_platform_ioport_writeb,
 320     .impl.min_access_size = 1,
 321     .impl.max_access_size = 1,
 322 };
 323
 324 static void platform_ioport_bar_setup(PCIXenPlatformState *d)
 325 {
 326     memory_region_init_io(&d->bar, OBJECT(d), &xen_pci_io_ops, d,
 327                           "xen-pci", 0x100);
 328 }
 329
 330 static uint64_t platform_mmio_read(void *opaque, hwaddr addr,
 331                                    unsigned size)
 332 {
 333     DPRINTF("Warning: attempted read from physical address "
 334             "0x" TARGET_FMT_plx " in xen platform mmio space\n", addr);
 335
 336     return 0;
 337 }
 338
 339 static void platform_mmio_write(void *opaque, hwaddr addr,
 340                                 uint64_t val, unsigned size)
 341 {
 342     DPRINTF("Warning: attempted write of 0x%"PRIx64" to physical "
 343             "address 0x" TARGET_FMT_plx " in xen platform mmio space\n",
 344             val, addr);
 345 }
 346
 347 static const MemoryRegionOps platform_mmio_handler = {
 348     .read = &platform_mmio_read,
 349     .write = &platform_mmio_write,
 350     .endianness = DEVICE_NATIVE_ENDIAN,
 351 };
 352
 353 static void platform_mmio_setup(PCIXenPlatformState *d)
 354 {
 355     memory_region_init_io(&d->mmio_bar, OBJECT(d), &platform_mmio_handler, d,
 356                           "xen-mmio", 0x1000000);
 357 }
 358
 359 static int xen_platform_post_load(void *opaque, int version_id)
 360 {
 361     PCIXenPlatformState *s = opaque;
 362
 363     platform_fixed_ioport_writeb(s, 0, s->flags);
 364
 365     return 0;
 366 }
 367
 368 static const VMStateDescription vmstate_xen_platform = {
 369     .name = "platform",
 370     .version_id = 4,
 371     .minimum_version_id = 4,
 372     .minimum_version_id_old = 4,
 373     .post_load = xen_platform_post_load,
 374     .fields = (VMStateField []) {
 375         VMSTATE_PCI_DEVICE(pci_dev, PCIXenPlatformState),
 376         VMSTATE_UINT8(flags, PCIXenPlatformState),
 377         VMSTATE_END_OF_LIST()
 378     }
 379 };
 380
 381 static int xen_platform_initfn(PCIDevice *dev)
 382 {
 383     PCIXenPlatformState *d = XEN_PLATFORM(dev);
 384     uint8_t *pci_conf;
 385
 386     pci_conf = d->pci_dev.config;
 387
 388     pci_set_word(pci_conf + PCI_COMMAND, PCI_COMMAND_IO | PCI_COMMAND_MEMORY);
 389
 390     pci_config_set_prog_interface(pci_conf, 0);
 391
 392     pci_conf[PCI_INTERRUPT_PIN] = 1;
 393
 394     platform_ioport_bar_setup(d);
 395     pci_register_bar(&d->pci_dev, 0, PCI_BASE_ADDRESS_SPACE_IO, &d->bar);
 396
 397     /* reserve 16MB mmio address for share memory*/
 398     platform_mmio_setup(d);
 399     pci_register_bar(&d->pci_dev, 1, PCI_BASE_ADDRESS_MEM_PREFETCH,
 400                      &d->mmio_bar);
 401
 402     platform_fixed_ioport_init(d);
 403
 404     return 0;
 405 }
 406
 407 static void platform_reset(DeviceState *dev)
 408 {
 409     PCIXenPlatformState *s = XEN_PLATFORM(dev);
 410
 411     platform_fixed_ioport_reset(s);
 412 }
 413
 414 static void xen_platform_class_init(ObjectClass *klass, void *data)
 415 {
 416     DeviceClass *dc = DEVICE_CLASS(klass);
 417     PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
 418
 419     k->init = xen_platform_initfn;
 420     k->vendor_id = PCI_VENDOR_ID_XEN;
 421     k->device_id = PCI_DEVICE_ID_XEN_PLATFORM;
 422     k->class_id = PCI_CLASS_OTHERS << 8 | 0x80;
 423     k->subsystem_vendor_id = PCI_VENDOR_ID_XEN;
 424     k->subsystem_id = PCI_DEVICE_ID_XEN_PLATFORM;
 425     k->revision = 1;
 426     dc->desc = "XEN platform pci device";
 427     dc->reset = platform_reset;
 428     dc->vmsd = &vmstate_xen_platform;
 429 }
 430
 431 static const TypeInfo xen_platform_info = {
 432     .name          = TYPE_XEN_PLATFORM,
 433     .parent        = TYPE_PCI_DEVICE,
 434     .instance_size = sizeof(PCIXenPlatformState),
 435     .class_init    = xen_platform_class_init,
 436 };
 437
 438 static void xen_platform_register_types(void)
 439 {
 440     type_register_static(&xen_platform_info);
 441 }
 442
 443 type_init(xen_platform_register_types)