hw/pci/pci.c

   1 /*
   2  * QEMU PCI bus manager
   3  *
   4  * Copyright (c) 2004 Fabrice Bellard
   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  */
  24 #include "hw/hw.h"
  25 #include "hw/pci/pci.h"
  26 #include "hw/pci/pci_bridge.h"
  27 #include "hw/pci/pci_bus.h"
  28 #include "hw/pci/pci_host.h"
  29 #include "monitor/monitor.h"
  30 #include "net/net.h"
  31 #include "sysemu/sysemu.h"
  32 #include "hw/loader.h"
  33 #include "qemu/range.h"
  34 #include "qmp-commands.h"
  35 #include "hw/pci/msi.h"
  36 #include "hw/pci/msix.h"
  37 #include "exec/address-spaces.h"
  38
  39 //#define DEBUG_PCI
  40 #ifdef DEBUG_PCI
  41 # define PCI_DPRINTF(format, ...)       printf(format, ## __VA_ARGS__)
  42 #else
  43 # define PCI_DPRINTF(format, ...)       do { } while (0)
  44 #endif
  45
  46 static void pcibus_dev_print(Monitor *mon, DeviceState *dev, int indent);
  47 static char *pcibus_get_dev_path(DeviceState *dev);
  48 static char *pcibus_get_fw_dev_path(DeviceState *dev);
  49 static int pcibus_reset(BusState *qbus);
  50
  51 static Property pci_props[] = {
  52     DEFINE_PROP_PCI_DEVFN("addr", PCIDevice, devfn, -1),
  53     DEFINE_PROP_STRING("romfile", PCIDevice, romfile),
  54     DEFINE_PROP_UINT32("rombar",  PCIDevice, rom_bar, 1),
  55     DEFINE_PROP_BIT("multifunction", PCIDevice, cap_present,
  56                     QEMU_PCI_CAP_MULTIFUNCTION_BITNR, false),
  57     DEFINE_PROP_BIT("command_serr_enable", PCIDevice, cap_present,
  58                     QEMU_PCI_CAP_SERR_BITNR, true),
  59     DEFINE_PROP_END_OF_LIST()
  60 };
  61
  62 static void pci_bus_class_init(ObjectClass *klass, void *data)
  63 {
  64     BusClass *k = BUS_CLASS(klass);
  65
  66     k->print_dev = pcibus_dev_print;
  67     k->get_dev_path = pcibus_get_dev_path;
  68     k->get_fw_dev_path = pcibus_get_fw_dev_path;
  69     k->reset = pcibus_reset;
  70 }
  71
  72 static const TypeInfo pci_bus_info = {
  73     .name = TYPE_PCI_BUS,
  74     .parent = TYPE_BUS,
  75     .instance_size = sizeof(PCIBus),
  76     .class_init = pci_bus_class_init,
  77 };
  78
  79 static const TypeInfo pcie_bus_info = {
  80     .name = TYPE_PCIE_BUS,
  81     .parent = TYPE_PCI_BUS,
  82 };
  83
  84 static PCIBus *pci_find_bus_nr(PCIBus *bus, int bus_num);
  85 static void pci_update_mappings(PCIDevice *d);
  86 static void pci_set_irq(void *opaque, int irq_num, int level);
  87 static int pci_add_option_rom(PCIDevice *pdev, bool is_default_rom);
  88 static void pci_del_option_rom(PCIDevice *pdev);
  89
  90 static uint16_t pci_default_sub_vendor_id = PCI_SUBVENDOR_ID_REDHAT_QUMRANET;
  91 static uint16_t pci_default_sub_device_id = PCI_SUBDEVICE_ID_QEMU;
  92
  93 static QLIST_HEAD(, PCIHostState) pci_host_bridges;
  94
  95 static const VMStateDescription vmstate_pcibus = {
  96     .name = "PCIBUS",
  97     .version_id = 1,
  98     .minimum_version_id = 1,
  99     .minimum_version_id_old = 1,
 100     .fields      = (VMStateField []) {
 101         VMSTATE_INT32_EQUAL(nirq, PCIBus),
 102         VMSTATE_VARRAY_INT32(irq_count, PCIBus, nirq, 0, vmstate_info_int32, int32_t),
 103         VMSTATE_END_OF_LIST()
 104     }
 105 };
 106 static int pci_bar(PCIDevice *d, int reg)
 107 {
 108     uint8_t type;
 109
 110     if (reg != PCI_ROM_SLOT)
 111         return PCI_BASE_ADDRESS_0 + reg * 4;
 112
 113     type = d->config[PCI_HEADER_TYPE] & ~PCI_HEADER_TYPE_MULTI_FUNCTION;
 114     return type == PCI_HEADER_TYPE_BRIDGE ? PCI_ROM_ADDRESS1 : PCI_ROM_ADDRESS;
 115 }
 116
 117 static inline int pci_irq_state(PCIDevice *d, int irq_num)
 118 {
 119         return (d->irq_state >> irq_num) & 0x1;
 120 }
 121
 122 static inline void pci_set_irq_state(PCIDevice *d, int irq_num, int level)
 123 {
 124         d->irq_state &= ~(0x1 << irq_num);
 125         d->irq_state |= level << irq_num;
 126 }
 127
 128 static void pci_change_irq_level(PCIDevice *pci_dev, int irq_num, int change)
 129 {
 130     PCIBus *bus;
 131     for (;;) {
 132         bus = pci_dev->bus;
 133         irq_num = bus->map_irq(pci_dev, irq_num);
 134         if (bus->set_irq)
 135             break;
 136         pci_dev = bus->parent_dev;
 137     }
 138     bus->irq_count[irq_num] += change;
 139     bus->set_irq(bus->irq_opaque, irq_num, bus->irq_count[irq_num] != 0);
 140 }
 141
 142 int pci_bus_get_irq_level(PCIBus *bus, int irq_num)
 143 {
 144     assert(irq_num >= 0);
 145     assert(irq_num < bus->nirq);
 146     return !!bus->irq_count[irq_num];
 147 }
 148
 149 /* Update interrupt status bit in config space on interrupt
 150  * state change. */
 151 static void pci_update_irq_status(PCIDevice *dev)
 152 {
 153     if (dev->irq_state) {
 154         dev->config[PCI_STATUS] |= PCI_STATUS_INTERRUPT;
 155     } else {
 156         dev->config[PCI_STATUS] &= ~PCI_STATUS_INTERRUPT;
 157     }
 158 }
 159
 160 void pci_device_deassert_intx(PCIDevice *dev)
 161 {
 162     int i;
 163     for (i = 0; i < PCI_NUM_PINS; ++i) {
 164         qemu_set_irq(dev->irq[i], 0);
 165     }
 166 }
 167
 168 /*
 169  * This function is called on #RST and FLR.
 170  * FLR if PCI_EXP_DEVCTL_BCR_FLR is set
 171  */
 172 void pci_device_reset(PCIDevice *dev)
 173 {
 174     int r;
 175
 176     qdev_reset_all(&dev->qdev);
 177
 178     dev->irq_state = 0;
 179     pci_update_irq_status(dev);
 180     pci_device_deassert_intx(dev);
 181     /* Clear all writable bits */
 182     pci_word_test_and_clear_mask(dev->config + PCI_COMMAND,
 183                                  pci_get_word(dev->wmask + PCI_COMMAND) |
 184                                  pci_get_word(dev->w1cmask + PCI_COMMAND));
 185     pci_word_test_and_clear_mask(dev->config + PCI_STATUS,
 186                                  pci_get_word(dev->wmask + PCI_STATUS) |
 187                                  pci_get_word(dev->w1cmask + PCI_STATUS));
 188     dev->config[PCI_CACHE_LINE_SIZE] = 0x0;
 189     dev->config[PCI_INTERRUPT_LINE] = 0x0;
 190     for (r = 0; r < PCI_NUM_REGIONS; ++r) {
 191         PCIIORegion *region = &dev->io_regions[r];
 192         if (!region->size) {
 193             continue;
 194         }
 195
 196         if (!(region->type & PCI_BASE_ADDRESS_SPACE_IO) &&
 197             region->type & PCI_BASE_ADDRESS_MEM_TYPE_64) {
 198             pci_set_quad(dev->config + pci_bar(dev, r), region->type);
 199         } else {
 200             pci_set_long(dev->config + pci_bar(dev, r), region->type);
 201         }
 202     }
 203     pci_update_mappings(dev);
 204
 205     msi_reset(dev);
 206     msix_reset(dev);
 207 }
 208
 209 /*
 210  * Trigger pci bus reset under a given bus.
 211  * To be called on RST# assert.
 212  */
 213 void pci_bus_reset(PCIBus *bus)
 214 {
 215     int i;
 216
 217     for (i = 0; i < bus->nirq; i++) {
 218         bus->irq_count[i] = 0;
 219     }
 220     for (i = 0; i < ARRAY_SIZE(bus->devices); ++i) {
 221         if (bus->devices[i]) {
 222             pci_device_reset(bus->devices[i]);
 223         }
 224     }
 225 }
 226
 227 static int pcibus_reset(BusState *qbus)
 228 {
 229     pci_bus_reset(DO_UPCAST(PCIBus, qbus, qbus));
 230
 231     /* topology traverse is done by pci_bus_reset().
 232        Tell qbus/qdev walker not to traverse the tree */
 233     return 1;
 234 }
 235
 236 static void pci_host_bus_register(PCIBus *bus, DeviceState *parent)
 237 {
 238     PCIHostState *host_bridge = PCI_HOST_BRIDGE(parent);
 239
 240     QLIST_INSERT_HEAD(&pci_host_bridges, host_bridge, next);
 241 }
 242
 243 PCIBus *pci_find_primary_bus(void)
 244 {
 245     PCIBus *primary_bus = NULL;
 246     PCIHostState *host;
 247
 248     QLIST_FOREACH(host, &pci_host_bridges, next) {
 249         if (primary_bus) {
 250             /* We have multiple root buses, refuse to select a primary */
 251             return NULL;
 252         }
 253         primary_bus = host->bus;
 254     }
 255
 256     return primary_bus;
 257 }
 258
 259 PCIBus *pci_device_root_bus(const PCIDevice *d)
 260 {
 261     PCIBus *bus = d->bus;
 262
 263     while ((d = bus->parent_dev) != NULL) {
 264         bus = d->bus;
 265     }
 266
 267     return bus;
 268 }
 269
 270 const char *pci_root_bus_path(PCIDevice *dev)
 271 {
 272     PCIBus *rootbus = pci_device_root_bus(dev);
 273     PCIHostState *host_bridge = PCI_HOST_BRIDGE(rootbus->qbus.parent);
 274     PCIHostBridgeClass *hc = PCI_HOST_BRIDGE_GET_CLASS(host_bridge);
 275
 276     assert(!rootbus->parent_dev);
 277     assert(host_bridge->bus == rootbus);
 278
 279     if (hc->root_bus_path) {
 280         return (*hc->root_bus_path)(host_bridge, rootbus);
 281     }
 282
 283     return rootbus->qbus.name;
 284 }
 285
 286 static void pci_bus_init(PCIBus *bus, DeviceState *parent,
 287                          const char *name,
 288                          MemoryRegion *address_space_mem,
 289                          MemoryRegion *address_space_io,
 290                          uint8_t devfn_min)
 291 {
 292     assert(PCI_FUNC(devfn_min) == 0);
 293     bus->devfn_min = devfn_min;
 294     bus->address_space_mem = address_space_mem;
 295     bus->address_space_io = address_space_io;
 296
 297     /* host bridge */
 298     QLIST_INIT(&bus->child);
 299
 300     pci_host_bus_register(bus, parent);
 301
 302     vmstate_register(NULL, -1, &vmstate_pcibus, bus);
 303 }
 304
 305 bool pci_bus_is_express(PCIBus *bus)
 306 {
 307     return object_dynamic_cast(OBJECT(bus), TYPE_PCIE_BUS);
 308 }
 309
 310 bool pci_bus_is_root(PCIBus *bus)
 311 {
 312     return !bus->parent_dev;
 313 }
 314
 315 void pci_bus_new_inplace(PCIBus *bus, DeviceState *parent,
 316                          const char *name,
 317                          MemoryRegion *address_space_mem,
 318                          MemoryRegion *address_space_io,
 319                          uint8_t devfn_min, const char *typename)
 320 {
 321     qbus_create_inplace(bus, typename, parent, name);
 322     pci_bus_init(bus, parent, name, address_space_mem,
 323                  address_space_io, devfn_min);
 324 }
 325
 326 PCIBus *pci_bus_new(DeviceState *parent, const char *name,
 327                     MemoryRegion *address_space_mem,
 328                     MemoryRegion *address_space_io,
 329                     uint8_t devfn_min, const char *typename)
 330 {
 331     PCIBus *bus;
 332
 333     bus = PCI_BUS(qbus_create(typename, parent, name));
 334     pci_bus_init(bus, parent, name, address_space_mem,
 335                  address_space_io, devfn_min);
 336     return bus;
 337 }
 338
 339 void pci_bus_irqs(PCIBus *bus, pci_set_irq_fn set_irq, pci_map_irq_fn map_irq,
 340                   void *irq_opaque, int nirq)
 341 {
 342     bus->set_irq = set_irq;
 343     bus->map_irq = map_irq;
 344     bus->irq_opaque = irq_opaque;
 345     bus->nirq = nirq;
 346     bus->irq_count = g_malloc0(nirq * sizeof(bus->irq_count[0]));
 347 }
 348
 349 void pci_bus_hotplug(PCIBus *bus, pci_hotplug_fn hotplug, DeviceState *qdev)
 350 {
 351     bus->qbus.allow_hotplug = 1;
 352     bus->hotplug = hotplug;
 353     bus->hotplug_qdev = qdev;
 354 }
 355
 356 PCIBus *pci_register_bus(DeviceState *parent, const char *name,
 357                          pci_set_irq_fn set_irq, pci_map_irq_fn map_irq,
 358                          void *irq_opaque,
 359                          MemoryRegion *address_space_mem,
 360                          MemoryRegion *address_space_io,
 361                          uint8_t devfn_min, int nirq, const char *typename)
 362 {
 363     PCIBus *bus;
 364
 365     bus = pci_bus_new(parent, name, address_space_mem,
 366                       address_space_io, devfn_min, typename);
 367     pci_bus_irqs(bus, set_irq, map_irq, irq_opaque, nirq);
 368     return bus;
 369 }
 370
 371 int pci_bus_num(PCIBus *s)
 372 {
 373     if (pci_bus_is_root(s))
 374         return 0;       /* pci host bridge */
 375     return s->parent_dev->config[PCI_SECONDARY_BUS];
 376 }
 377
 378 static int get_pci_config_device(QEMUFile *f, void *pv, size_t size)
 379 {
 380     PCIDevice *s = container_of(pv, PCIDevice, config);
 381     PCIDeviceClass *pc = PCI_DEVICE_GET_CLASS(s);
 382     uint8_t *config;
 383     int i;
 384
 385     assert(size == pci_config_size(s));
 386     config = g_malloc(size);
 387
 388     qemu_get_buffer(f, config, size);
 389     for (i = 0; i < size; ++i) {
 390         if ((config[i] ^ s->config[i]) &
 391             s->cmask[i] & ~s->wmask[i] & ~s->w1cmask[i]) {
 392             g_free(config);
 393             return -EINVAL;
 394         }
 395     }
 396     memcpy(s->config, config, size);
 397
 398     pci_update_mappings(s);
 399     if (pc->is_bridge) {
 400         PCIBridge *b = PCI_BRIDGE(s);
 401         pci_bridge_update_mappings(b);
 402     }
 403
 404     memory_region_set_enabled(&s->bus_master_enable_region,
 405                               pci_get_word(s->config + PCI_COMMAND)
 406                               & PCI_COMMAND_MASTER);
 407
 408     g_free(config);
 409     return 0;
 410 }
 411
 412 /* just put buffer */
 413 static void put_pci_config_device(QEMUFile *f, void *pv, size_t size)
 414 {
 415     const uint8_t **v = pv;
 416     assert(size == pci_config_size(container_of(pv, PCIDevice, config)));
 417     qemu_put_buffer(f, *v, size);
 418 }
 419
 420 static VMStateInfo vmstate_info_pci_config = {
 421     .name = "pci config",
 422     .get  = get_pci_config_device,
 423     .put  = put_pci_config_device,
 424 };
 425
 426 static int get_pci_irq_state(QEMUFile *f, void *pv, size_t size)
 427 {
 428     PCIDevice *s = container_of(pv, PCIDevice, irq_state);
 429     uint32_t irq_state[PCI_NUM_PINS];
 430     int i;
 431     for (i = 0; i < PCI_NUM_PINS; ++i) {
 432         irq_state[i] = qemu_get_be32(f);
 433         if (irq_state[i] != 0x1 && irq_state[i] != 0) {
 434             fprintf(stderr, "irq state %d: must be 0 or 1.\n",
 435                     irq_state[i]);
 436             return -EINVAL;
 437         }
 438     }
 439
 440     for (i = 0; i < PCI_NUM_PINS; ++i) {
 441         pci_set_irq_state(s, i, irq_state[i]);
 442     }
 443
 444     return 0;
 445 }
 446
 447 static void put_pci_irq_state(QEMUFile *f, void *pv, size_t size)
 448 {
 449     int i;
 450     PCIDevice *s = container_of(pv, PCIDevice, irq_state);
 451
 452     for (i = 0; i < PCI_NUM_PINS; ++i) {
 453         qemu_put_be32(f, pci_irq_state(s, i));
 454     }
 455 }
 456
 457 static VMStateInfo vmstate_info_pci_irq_state = {
 458     .name = "pci irq state",
 459     .get  = get_pci_irq_state,
 460     .put  = put_pci_irq_state,
 461 };
 462
 463 const VMStateDescription vmstate_pci_device = {
 464     .name = "PCIDevice",
 465     .version_id = 2,
 466     .minimum_version_id = 1,
 467     .minimum_version_id_old = 1,
 468     .fields      = (VMStateField []) {
 469         VMSTATE_INT32_LE(version_id, PCIDevice),
 470         VMSTATE_BUFFER_UNSAFE_INFO(config, PCIDevice, 0,
 471                                    vmstate_info_pci_config,
 472                                    PCI_CONFIG_SPACE_SIZE),
 473         VMSTATE_BUFFER_UNSAFE_INFO(irq_state, PCIDevice, 2,
 474                                    vmstate_info_pci_irq_state,
 475                                    PCI_NUM_PINS * sizeof(int32_t)),
 476         VMSTATE_END_OF_LIST()
 477     }
 478 };
 479
 480 const VMStateDescription vmstate_pcie_device = {
 481     .name = "PCIEDevice",
 482     .version_id = 2,
 483     .minimum_version_id = 1,
 484     .minimum_version_id_old = 1,
 485     .fields      = (VMStateField []) {
 486         VMSTATE_INT32_LE(version_id, PCIDevice),
 487         VMSTATE_BUFFER_UNSAFE_INFO(config, PCIDevice, 0,
 488                                    vmstate_info_pci_config,
 489                                    PCIE_CONFIG_SPACE_SIZE),
 490         VMSTATE_BUFFER_UNSAFE_INFO(irq_state, PCIDevice, 2,
 491                                    vmstate_info_pci_irq_state,
 492                                    PCI_NUM_PINS * sizeof(int32_t)),
 493         VMSTATE_END_OF_LIST()
 494     }
 495 };
 496
 497 static inline const VMStateDescription *pci_get_vmstate(PCIDevice *s)
 498 {
 499     return pci_is_express(s) ? &vmstate_pcie_device : &vmstate_pci_device;
 500 }
 501
 502 void pci_device_save(PCIDevice *s, QEMUFile *f)
 503 {
 504     /* Clear interrupt status bit: it is implicit
 505      * in irq_state which we are saving.
 506      * This makes us compatible with old devices
 507      * which never set or clear this bit. */
 508     s->config[PCI_STATUS] &= ~PCI_STATUS_INTERRUPT;
 509     vmstate_save_state(f, pci_get_vmstate(s), s);
 510     /* Restore the interrupt status bit. */
 511     pci_update_irq_status(s);
 512 }
 513
 514 int pci_device_load(PCIDevice *s, QEMUFile *f)
 515 {
 516     int ret;
 517     ret = vmstate_load_state(f, pci_get_vmstate(s), s, s->version_id);
 518     /* Restore the interrupt status bit. */
 519     pci_update_irq_status(s);
 520     return ret;
 521 }
 522
 523 static void pci_set_default_subsystem_id(PCIDevice *pci_dev)
 524 {
 525     pci_set_word(pci_dev->config + PCI_SUBSYSTEM_VENDOR_ID,
 526                  pci_default_sub_vendor_id);
 527     pci_set_word(pci_dev->config + PCI_SUBSYSTEM_ID,
 528                  pci_default_sub_device_id);
 529 }
 530
 531 /*
 532  * Parse [[<domain>:]<bus>:]<slot>, return -1 on error if funcp == NULL
 533  *       [[<domain>:]<bus>:]<slot>.<func>, return -1 on error
 534  */
 535 int pci_parse_devaddr(const char *addr, int *domp, int *busp,
 536                       unsigned int *slotp, unsigned int *funcp)
 537 {
 538     const char *p;
 539     char *e;
 540     unsigned long val;
 541     unsigned long dom = 0, bus = 0;
 542     unsigned int slot = 0;
 543     unsigned int func = 0;
 544
 545     p = addr;
 546     val = strtoul(p, &e, 16);
 547     if (e == p)
 548         return -1;
 549     if (*e == ':') {
 550         bus = val;
 551         p = e + 1;
 552         val = strtoul(p, &e, 16);
 553         if (e == p)
 554             return -1;
 555         if (*e == ':') {
 556             dom = bus;
 557             bus = val;
 558             p = e + 1;
 559             val = strtoul(p, &e, 16);
 560             if (e == p)
 561                 return -1;
 562         }
 563     }
 564
 565     slot = val;
 566
 567     if (funcp != NULL) {
 568         if (*e != '.')
 569             return -1;
 570
 571         p = e + 1;
 572         val = strtoul(p, &e, 16);
 573         if (e == p)
 574             return -1;
 575
 576         func = val;
 577     }
 578
 579     /* if funcp == NULL func is 0 */
 580     if (dom > 0xffff || bus > 0xff || slot > 0x1f || func > 7)
 581         return -1;
 582
 583     if (*e)
 584         return -1;
 585
 586     *domp = dom;
 587     *busp = bus;
 588     *slotp = slot;
 589     if (funcp != NULL)
 590         *funcp = func;
 591     return 0;
 592 }
 593
 594 PCIBus *pci_get_bus_devfn(int *devfnp, PCIBus *root, const char *devaddr)
 595 {
 596     int dom, bus;
 597     unsigned slot;
 598
 599     assert(!root->parent_dev);
 600
 601     if (!root) {
 602         fprintf(stderr, "No primary PCI bus\n");
 603         return NULL;
 604     }
 605
 606     if (!devaddr) {
 607         *devfnp = -1;
 608         return pci_find_bus_nr(root, 0);
 609     }
 610
 611     if (pci_parse_devaddr(devaddr, &dom, &bus, &slot, NULL) < 0) {
 612         return NULL;
 613     }
 614
 615     if (dom != 0) {
 616         fprintf(stderr, "No support for non-zero PCI domains\n");
 617         return NULL;
 618     }
 619
 620     *devfnp = PCI_DEVFN(slot, 0);
 621     return pci_find_bus_nr(root, bus);
 622 }
 623
 624 static void pci_init_cmask(PCIDevice *dev)
 625 {
 626     pci_set_word(dev->cmask + PCI_VENDOR_ID, 0xffff);
 627     pci_set_word(dev->cmask + PCI_DEVICE_ID, 0xffff);
 628     dev->cmask[PCI_STATUS] = PCI_STATUS_CAP_LIST;
 629     dev->cmask[PCI_REVISION_ID] = 0xff;
 630     dev->cmask[PCI_CLASS_PROG] = 0xff;
 631     pci_set_word(dev->cmask + PCI_CLASS_DEVICE, 0xffff);
 632     dev->cmask[PCI_HEADER_TYPE] = 0xff;
 633     dev->cmask[PCI_CAPABILITY_LIST] = 0xff;
 634 }
 635
 636 static void pci_init_wmask(PCIDevice *dev)
 637 {
 638     int config_size = pci_config_size(dev);
 639
 640     dev->wmask[PCI_CACHE_LINE_SIZE] = 0xff;
 641     dev->wmask[PCI_INTERRUPT_LINE] = 0xff;
 642     pci_set_word(dev->wmask + PCI_COMMAND,
 643                  PCI_COMMAND_IO | PCI_COMMAND_MEMORY | PCI_COMMAND_MASTER |
 644                  PCI_COMMAND_INTX_DISABLE);
 645     if (dev->cap_present & QEMU_PCI_CAP_SERR) {
 646         pci_word_test_and_set_mask(dev->wmask + PCI_COMMAND, PCI_COMMAND_SERR);
 647     }
 648
 649     memset(dev->wmask + PCI_CONFIG_HEADER_SIZE, 0xff,
 650            config_size - PCI_CONFIG_HEADER_SIZE);
 651 }
 652
 653 static void pci_init_w1cmask(PCIDevice *dev)
 654 {
 655     /*
 656      * Note: It's okay to set w1cmask even for readonly bits as
 657      * long as their value is hardwired to 0.
 658      */
 659     pci_set_word(dev->w1cmask + PCI_STATUS,
 660                  PCI_STATUS_PARITY | PCI_STATUS_SIG_TARGET_ABORT |
 661                  PCI_STATUS_REC_TARGET_ABORT | PCI_STATUS_REC_MASTER_ABORT |
 662                  PCI_STATUS_SIG_SYSTEM_ERROR | PCI_STATUS_DETECTED_PARITY);
 663 }
 664
 665 static void pci_init_mask_bridge(PCIDevice *d)
 666 {
 667     /* PCI_PRIMARY_BUS, PCI_SECONDARY_BUS, PCI_SUBORDINATE_BUS and
 668        PCI_SEC_LETENCY_TIMER */
 669     memset(d->wmask + PCI_PRIMARY_BUS, 0xff, 4);
 670
 671     /* base and limit */
 672     d->wmask[PCI_IO_BASE] = PCI_IO_RANGE_MASK & 0xff;
 673     d->wmask[PCI_IO_LIMIT] = PCI_IO_RANGE_MASK & 0xff;
 674     pci_set_word(d->wmask + PCI_MEMORY_BASE,
 675                  PCI_MEMORY_RANGE_MASK & 0xffff);
 676     pci_set_word(d->wmask + PCI_MEMORY_LIMIT,
 677                  PCI_MEMORY_RANGE_MASK & 0xffff);
 678     pci_set_word(d->wmask + PCI_PREF_MEMORY_BASE,
 679                  PCI_PREF_RANGE_MASK & 0xffff);
 680     pci_set_word(d->wmask + PCI_PREF_MEMORY_LIMIT,
 681                  PCI_PREF_RANGE_MASK & 0xffff);
 682
 683     /* PCI_PREF_BASE_UPPER32 and PCI_PREF_LIMIT_UPPER32 */
 684     memset(d->wmask + PCI_PREF_BASE_UPPER32, 0xff, 8);
 685
 686     /* Supported memory and i/o types */
 687     d->config[PCI_IO_BASE] |= PCI_IO_RANGE_TYPE_16;
 688     d->config[PCI_IO_LIMIT] |= PCI_IO_RANGE_TYPE_16;
 689     pci_word_test_and_set_mask(d->config + PCI_PREF_MEMORY_BASE,
 690                                PCI_PREF_RANGE_TYPE_64);
 691     pci_word_test_and_set_mask(d->config + PCI_PREF_MEMORY_LIMIT,
 692                                PCI_PREF_RANGE_TYPE_64);
 693
 694     /*
 695      * TODO: Bridges default to 10-bit VGA decoding but we currently only
 696      * implement 16-bit decoding (no alias support).
 697      */
 698     pci_set_word(d->wmask + PCI_BRIDGE_CONTROL,
 699                  PCI_BRIDGE_CTL_PARITY |
 700                  PCI_BRIDGE_CTL_SERR |
 701                  PCI_BRIDGE_CTL_ISA |
 702                  PCI_BRIDGE_CTL_VGA |
 703                  PCI_BRIDGE_CTL_VGA_16BIT |
 704                  PCI_BRIDGE_CTL_MASTER_ABORT |
 705                  PCI_BRIDGE_CTL_BUS_RESET |
 706                  PCI_BRIDGE_CTL_FAST_BACK |
 707                  PCI_BRIDGE_CTL_DISCARD |
 708                  PCI_BRIDGE_CTL_SEC_DISCARD |
 709                  PCI_BRIDGE_CTL_DISCARD_SERR);
 710     /* Below does not do anything as we never set this bit, put here for
 711      * completeness. */
 712     pci_set_word(d->w1cmask + PCI_BRIDGE_CONTROL,
 713                  PCI_BRIDGE_CTL_DISCARD_STATUS);
 714     d->cmask[PCI_IO_BASE] |= PCI_IO_RANGE_TYPE_MASK;
 715     d->cmask[PCI_IO_LIMIT] |= PCI_IO_RANGE_TYPE_MASK;
 716     pci_word_test_and_set_mask(d->cmask + PCI_PREF_MEMORY_BASE,
 717                                PCI_PREF_RANGE_TYPE_MASK);
 718     pci_word_test_and_set_mask(d->cmask + PCI_PREF_MEMORY_LIMIT,
 719                                PCI_PREF_RANGE_TYPE_MASK);
 720 }
 721
 722 static int pci_init_multifunction(PCIBus *bus, PCIDevice *dev)
 723 {
 724     uint8_t slot = PCI_SLOT(dev->devfn);
 725     uint8_t func;
 726
 727     if (dev->cap_present & QEMU_PCI_CAP_MULTIFUNCTION) {
 728         dev->config[PCI_HEADER_TYPE] |= PCI_HEADER_TYPE_MULTI_FUNCTION;
 729     }
 730
 731     /*
 732      * multifunction bit is interpreted in two ways as follows.
 733      *   - all functions must set the bit to 1.
 734      *     Example: Intel X53
 735      *   - function 0 must set the bit, but the rest function (> 0)
 736      *     is allowed to leave the bit to 0.
 737      *     Example: PIIX3(also in qemu), PIIX4(also in qemu), ICH10,
 738      *
 739      * So OS (at least Linux) checks the bit of only function 0,
 740      * and doesn't see the bit of function > 0.
 741      *
 742      * The below check allows both interpretation.
 743      */
 744     if (PCI_FUNC(dev->devfn)) {
 745         PCIDevice *f0 = bus->devices[PCI_DEVFN(slot, 0)];
 746         if (f0 && !(f0->cap_present & QEMU_PCI_CAP_MULTIFUNCTION)) {
 747             /* function 0 should set multifunction bit */
 748             error_report("PCI: single function device can't be populated "
 749                          "in function %x.%x", slot, PCI_FUNC(dev->devfn));
 750             return -1;
 751         }
 752         return 0;
 753     }
 754
 755     if (dev->cap_present & QEMU_PCI_CAP_MULTIFUNCTION) {
 756         return 0;
 757     }
 758     /* function 0 indicates single function, so function > 0 must be NULL */
 759     for (func = 1; func < PCI_FUNC_MAX; ++func) {
 760         if (bus->devices[PCI_DEVFN(slot, func)]) {
 761             error_report("PCI: %x.0 indicates single function, "
 762                          "but %x.%x is already populated.",
 763                          slot, slot, func);
 764             return -1;
 765         }
 766     }
 767     return 0;
 768 }
 769
 770 static void pci_config_alloc(PCIDevice *pci_dev)
 771 {
 772     int config_size = pci_config_size(pci_dev);
 773
 774     pci_dev->config = g_malloc0(config_size);
 775     pci_dev->cmask = g_malloc0(config_size);
 776     pci_dev->wmask = g_malloc0(config_size);
 777     pci_dev->w1cmask = g_malloc0(config_size);
 778     pci_dev->used = g_malloc0(config_size);
 779 }
 780
 781 static void pci_config_free(PCIDevice *pci_dev)
 782 {
 783     g_free(pci_dev->config);
 784     g_free(pci_dev->cmask);
 785     g_free(pci_dev->wmask);
 786     g_free(pci_dev->w1cmask);
 787     g_free(pci_dev->used);
 788 }
 789
 790 /* -1 for devfn means auto assign */
 791 static PCIDevice *do_pci_register_device(PCIDevice *pci_dev, PCIBus *bus,
 792                                          const char *name, int devfn)
 793 {
 794     PCIDeviceClass *pc = PCI_DEVICE_GET_CLASS(pci_dev);
 795     PCIConfigReadFunc *config_read = pc->config_read;
 796     PCIConfigWriteFunc *config_write = pc->config_write;
 797     AddressSpace *dma_as;
 798
 799     if (devfn < 0) {
 800         for(devfn = bus->devfn_min ; devfn < ARRAY_SIZE(bus->devices);
 801             devfn += PCI_FUNC_MAX) {
 802             if (!bus->devices[devfn])
 803                 goto found;
 804         }
 805         error_report("PCI: no slot/function available for %s, all in use", name);
 806         return NULL;
 807     found: ;
 808     } else if (bus->devices[devfn]) {
 809         error_report("PCI: slot %d function %d not available for %s, in use by %s",
 810                      PCI_SLOT(devfn), PCI_FUNC(devfn), name, bus->devices[devfn]->name);
 811         return NULL;
 812     }
 813
 814     pci_dev->bus = bus;
 815     if (bus->iommu_fn) {
 816         dma_as = bus->iommu_fn(bus, bus->iommu_opaque, devfn);
 817     } else {
 818         /* FIXME: inherit memory region from bus creator */
 819         dma_as = &address_space_memory;
 820     }
 821
 822     memory_region_init_alias(&pci_dev->bus_master_enable_region,
 823                              OBJECT(pci_dev), "bus master",
 824                              dma_as->root, 0, memory_region_size(dma_as->root));
 825     memory_region_set_enabled(&pci_dev->bus_master_enable_region, false);
 826     address_space_init(&pci_dev->bus_master_as, &pci_dev->bus_master_enable_region,
 827                        name);
 828
 829     pci_dev->devfn = devfn;
 830     pstrcpy(pci_dev->name, sizeof(pci_dev->name), name);
 831     pci_dev->irq_state = 0;
 832     pci_config_alloc(pci_dev);
 833
 834     pci_config_set_vendor_id(pci_dev->config, pc->vendor_id);
 835     pci_config_set_device_id(pci_dev->config, pc->device_id);
 836     pci_config_set_revision(pci_dev->config, pc->revision);
 837     pci_config_set_class(pci_dev->config, pc->class_id);
 838
 839     if (!pc->is_bridge) {
 840         if (pc->subsystem_vendor_id || pc->subsystem_id) {
 841             pci_set_word(pci_dev->config + PCI_SUBSYSTEM_VENDOR_ID,
 842                          pc->subsystem_vendor_id);
 843             pci_set_word(pci_dev->config + PCI_SUBSYSTEM_ID,
 844                          pc->subsystem_id);
 845         } else {
 846             pci_set_default_subsystem_id(pci_dev);
 847         }
 848     } else {
 849         /* subsystem_vendor_id/subsystem_id are only for header type 0 */
 850         assert(!pc->subsystem_vendor_id);
 851         assert(!pc->subsystem_id);
 852     }
 853     pci_init_cmask(pci_dev);
 854     pci_init_wmask(pci_dev);
 855     pci_init_w1cmask(pci_dev);
 856     if (pc->is_bridge) {
 857         pci_init_mask_bridge(pci_dev);
 858     }
 859     if (pci_init_multifunction(bus, pci_dev)) {
 860         pci_config_free(pci_dev);
 861         return NULL;
 862     }
 863
 864     if (!config_read)
 865         config_read = pci_default_read_config;
 866     if (!config_write)
 867         config_write = pci_default_write_config;
 868     pci_dev->config_read = config_read;
 869     pci_dev->config_write = config_write;
 870     bus->devices[devfn] = pci_dev;
 871     pci_dev->irq = qemu_allocate_irqs(pci_set_irq, pci_dev, PCI_NUM_PINS);
 872     pci_dev->version_id = 2; /* Current pci device vmstate version */
 873     return pci_dev;
 874 }
 875
 876 static void do_pci_unregister_device(PCIDevice *pci_dev)
 877 {
 878     qemu_free_irqs(pci_dev->irq);
 879     pci_dev->bus->devices[pci_dev->devfn] = NULL;
 880     pci_config_free(pci_dev);
 881
 882     address_space_destroy(&pci_dev->bus_master_as);
 883     memory_region_destroy(&pci_dev->bus_master_enable_region);
 884 }
 885
 886 static void pci_unregister_io_regions(PCIDevice *pci_dev)
 887 {
 888     PCIIORegion *r;
 889     int i;
 890
 891     for(i = 0; i < PCI_NUM_REGIONS; i++) {
 892         r = &pci_dev->io_regions[i];
 893         if (!r->size || r->addr == PCI_BAR_UNMAPPED)
 894             continue;
 895         memory_region_del_subregion(r->address_space, r->memory);
 896     }
 897
 898     pci_unregister_vga(pci_dev);
 899 }
 900
 901 static int pci_unregister_device(DeviceState *dev)
 902 {
 903     PCIDevice *pci_dev = PCI_DEVICE(dev);
 904     PCIDeviceClass *pc = PCI_DEVICE_GET_CLASS(pci_dev);
 905
 906     pci_unregister_io_regions(pci_dev);
 907     pci_del_option_rom(pci_dev);
 908
 909     if (pc->exit) {
 910         pc->exit(pci_dev);
 911     }
 912
 913     do_pci_unregister_device(pci_dev);
 914     return 0;
 915 }
 916
 917 void pci_register_bar(PCIDevice *pci_dev, int region_num,
 918                       uint8_t type, MemoryRegion *memory)
 919 {
 920     PCIIORegion *r;
 921     uint32_t addr;
 922     uint64_t wmask;
 923     pcibus_t size = memory_region_size(memory);
 924
 925     assert(region_num >= 0);
 926     assert(region_num < PCI_NUM_REGIONS);
 927     if (size & (size-1)) {
 928         fprintf(stderr, "ERROR: PCI region size must be pow2 "
 929                     "type=0x%x, size=0x%"FMT_PCIBUS"\n", type, size);
 930         exit(1);
 931     }
 932
 933     r = &pci_dev->io_regions[region_num];
 934     r->addr = PCI_BAR_UNMAPPED;
 935     r->size = size;
 936     r->type = type;
 937     r->memory = NULL;
 938
 939     wmask = ~(size - 1);
 940     addr = pci_bar(pci_dev, region_num);
 941     if (region_num == PCI_ROM_SLOT) {
 942         /* ROM enable bit is writable */
 943         wmask |= PCI_ROM_ADDRESS_ENABLE;
 944     }
 945     pci_set_long(pci_dev->config + addr, type);
 946     if (!(r->type & PCI_BASE_ADDRESS_SPACE_IO) &&
 947         r->type & PCI_BASE_ADDRESS_MEM_TYPE_64) {
 948         pci_set_quad(pci_dev->wmask + addr, wmask);
 949         pci_set_quad(pci_dev->cmask + addr, ~0ULL);
 950     } else {
 951         pci_set_long(pci_dev->wmask + addr, wmask & 0xffffffff);
 952         pci_set_long(pci_dev->cmask + addr, 0xffffffff);
 953     }
 954     pci_dev->io_regions[region_num].memory = memory;
 955     pci_dev->io_regions[region_num].address_space
 956         = type & PCI_BASE_ADDRESS_SPACE_IO
 957         ? pci_dev->bus->address_space_io
 958         : pci_dev->bus->address_space_mem;
 959 }
 960
 961 static void pci_update_vga(PCIDevice *pci_dev)
 962 {
 963     uint16_t cmd;
 964
 965     if (!pci_dev->has_vga) {
 966         return;
 967     }
 968
 969     cmd = pci_get_word(pci_dev->config + PCI_COMMAND);
 970
 971     memory_region_set_enabled(pci_dev->vga_regions[QEMU_PCI_VGA_MEM],
 972                               cmd & PCI_COMMAND_MEMORY);
 973     memory_region_set_enabled(pci_dev->vga_regions[QEMU_PCI_VGA_IO_LO],
 974                               cmd & PCI_COMMAND_IO);
 975     memory_region_set_enabled(pci_dev->vga_regions[QEMU_PCI_VGA_IO_HI],
 976                               cmd & PCI_COMMAND_IO);
 977 }
 978
 979 void pci_register_vga(PCIDevice *pci_dev, MemoryRegion *mem,
 980                       MemoryRegion *io_lo, MemoryRegion *io_hi)
 981 {
 982     assert(!pci_dev->has_vga);
 983
 984     assert(memory_region_size(mem) == QEMU_PCI_VGA_MEM_SIZE);
 985     pci_dev->vga_regions[QEMU_PCI_VGA_MEM] = mem;
 986     memory_region_add_subregion_overlap(pci_dev->bus->address_space_mem,
 987                                         QEMU_PCI_VGA_MEM_BASE, mem, 1);
 988
 989     assert(memory_region_size(io_lo) == QEMU_PCI_VGA_IO_LO_SIZE);
 990     pci_dev->vga_regions[QEMU_PCI_VGA_IO_LO] = io_lo;
 991     memory_region_add_subregion_overlap(pci_dev->bus->address_space_io,
 992                                         QEMU_PCI_VGA_IO_LO_BASE, io_lo, 1);
 993
 994     assert(memory_region_size(io_hi) == QEMU_PCI_VGA_IO_HI_SIZE);
 995     pci_dev->vga_regions[QEMU_PCI_VGA_IO_HI] = io_hi;
 996     memory_region_add_subregion_overlap(pci_dev->bus->address_space_io,
 997                                         QEMU_PCI_VGA_IO_HI_BASE, io_hi, 1);
 998     pci_dev->has_vga = true;
 999
1000     pci_update_vga(pci_dev);
1001 }
1002
1003 void pci_unregister_vga(PCIDevice *pci_dev)
1004 {
1005     if (!pci_dev->has_vga) {
1006         return;
1007     }
1008
1009     memory_region_del_subregion(pci_dev->bus->address_space_mem,
1010                                 pci_dev->vga_regions[QEMU_PCI_VGA_MEM]);
1011     memory_region_del_subregion(pci_dev->bus->address_space_io,
1012                                 pci_dev->vga_regions[QEMU_PCI_VGA_IO_LO]);
1013     memory_region_del_subregion(pci_dev->bus->address_space_io,
1014                                 pci_dev->vga_regions[QEMU_PCI_VGA_IO_HI]);
1015     pci_dev->has_vga = false;
1016 }
1017
1018 pcibus_t pci_get_bar_addr(PCIDevice *pci_dev, int region_num)
1019 {
1020     return pci_dev->io_regions[region_num].addr;
1021 }
1022
1023 static pcibus_t pci_bar_address(PCIDevice *d,
1024                                 int reg, uint8_t type, pcibus_t size)
1025 {
1026     pcibus_t new_addr, last_addr;
1027     int bar = pci_bar(d, reg);
1028     uint16_t cmd = pci_get_word(d->config + PCI_COMMAND);
1029
1030     if (type & PCI_BASE_ADDRESS_SPACE_IO) {
1031         if (!(cmd & PCI_COMMAND_IO)) {
1032             return PCI_BAR_UNMAPPED;
1033         }
1034         new_addr = pci_get_long(d->config + bar) & ~(size - 1);
1035         last_addr = new_addr + size - 1;
1036         /* NOTE: we have only 64K ioports on PC */
1037         if (last_addr <= new_addr || new_addr == 0 || last_addr > UINT16_MAX) {
1038             return PCI_BAR_UNMAPPED;
1039         }
1040         return new_addr;
1041     }
1042
1043     if (!(cmd & PCI_COMMAND_MEMORY)) {
1044         return PCI_BAR_UNMAPPED;
1045     }
1046     if (type & PCI_BASE_ADDRESS_MEM_TYPE_64) {
1047         new_addr = pci_get_quad(d->config + bar);
1048     } else {
1049         new_addr = pci_get_long(d->config + bar);
1050     }
1051     /* the ROM slot has a specific enable bit */
1052     if (reg == PCI_ROM_SLOT && !(new_addr & PCI_ROM_ADDRESS_ENABLE)) {
1053         return PCI_BAR_UNMAPPED;
1054     }
1055     new_addr &= ~(size - 1);
1056     last_addr = new_addr + size - 1;
1057     /* NOTE: we do not support wrapping */
1058     /* XXX: as we cannot support really dynamic
1059        mappings, we handle specific values as invalid
1060        mappings. */
1061     if (last_addr <= new_addr || new_addr == 0 ||
1062         last_addr == PCI_BAR_UNMAPPED) {
1063         return PCI_BAR_UNMAPPED;
1064     }
1065
1066     /* Now pcibus_t is 64bit.
1067      * Check if 32 bit BAR wraps around explicitly.
1068      * Without this, PC ide doesn't work well.
1069      * TODO: remove this work around.
1070      */
1071     if  (!(type & PCI_BASE_ADDRESS_MEM_TYPE_64) && last_addr >= UINT32_MAX) {
1072         return PCI_BAR_UNMAPPED;
1073     }
1074
1075     /*
1076      * OS is allowed to set BAR beyond its addressable
1077      * bits. For example, 32 bit OS can set 64bit bar
1078      * to >4G. Check it. TODO: we might need to support
1079      * it in the future for e.g. PAE.
1080      */
1081     if (last_addr >= HWADDR_MAX) {
1082         return PCI_BAR_UNMAPPED;
1083     }
1084
1085     return new_addr;
1086 }
1087
1088 static void pci_update_mappings(PCIDevice *d)
1089 {
1090     PCIIORegion *r;
1091     int i;
1092     pcibus_t new_addr;
1093
1094     for(i = 0; i < PCI_NUM_REGIONS; i++) {
1095         r = &d->io_regions[i];
1096
1097         /* this region isn't registered */
1098         if (!r->size)
1099             continue;
1100
1101         new_addr = pci_bar_address(d, i, r->type, r->size);
1102
1103         /* This bar isn't changed */
1104         if (new_addr == r->addr)
1105             continue;
1106
1107         /* now do the real mapping */
1108         if (r->addr != PCI_BAR_UNMAPPED) {
1109             memory_region_del_subregion(r->address_space, r->memory);
1110         }
1111         r->addr = new_addr;
1112         if (r->addr != PCI_BAR_UNMAPPED) {
1113             memory_region_add_subregion_overlap(r->address_space,
1114                                                 r->addr, r->memory, 1);
1115         }
1116     }
1117
1118     pci_update_vga(d);
1119 }
1120
1121 static inline int pci_irq_disabled(PCIDevice *d)
1122 {
1123     return pci_get_word(d->config + PCI_COMMAND) & PCI_COMMAND_INTX_DISABLE;
1124 }
1125
1126 /* Called after interrupt disabled field update in config space,
1127  * assert/deassert interrupts if necessary.
1128  * Gets original interrupt disable bit value (before update). */
1129 static void pci_update_irq_disabled(PCIDevice *d, int was_irq_disabled)
1130 {
1131     int i, disabled = pci_irq_disabled(d);
1132     if (disabled == was_irq_disabled)
1133         return;
1134     for (i = 0; i < PCI_NUM_PINS; ++i) {
1135         int state = pci_irq_state(d, i);
1136         pci_change_irq_level(d, i, disabled ? -state : state);
1137     }
1138 }
1139
1140 uint32_t pci_default_read_config(PCIDevice *d,
1141                                  uint32_t address, int len)
1142 {
1143     uint32_t val = 0;
1144
1145     memcpy(&val, d->config + address, len);
1146     return le32_to_cpu(val);
1147 }
1148
1149 void pci_default_write_config(PCIDevice *d, uint32_t addr, uint32_t val, int l)
1150 {
1151     int i, was_irq_disabled = pci_irq_disabled(d);
1152
1153     for (i = 0; i < l; val >>= 8, ++i) {
1154         uint8_t wmask = d->wmask[addr + i];
1155         uint8_t w1cmask = d->w1cmask[addr + i];
1156         assert(!(wmask & w1cmask));
1157         d->config[addr + i] = (d->config[addr + i] & ~wmask) | (val & wmask);
1158         d->config[addr + i] &= ~(val & w1cmask); /* W1C: Write 1 to Clear */
1159     }
1160     if (ranges_overlap(addr, l, PCI_BASE_ADDRESS_0, 24) ||
1161         ranges_overlap(addr, l, PCI_ROM_ADDRESS, 4) ||
1162         ranges_overlap(addr, l, PCI_ROM_ADDRESS1, 4) ||
1163         range_covers_byte(addr, l, PCI_COMMAND))
1164         pci_update_mappings(d);
1165
1166     if (range_covers_byte(addr, l, PCI_COMMAND)) {
1167         pci_update_irq_disabled(d, was_irq_disabled);
1168         memory_region_set_enabled(&d->bus_master_enable_region,
1169                                   pci_get_word(d->config + PCI_COMMAND)
1170                                     & PCI_COMMAND_MASTER);
1171     }
1172
1173     msi_write_config(d, addr, val, l);
1174     msix_write_config(d, addr, val, l);
1175 }
1176
1177 /***********************************************************/
1178 /* generic PCI irq support */
1179
1180 /* 0 <= irq_num <= 3. level must be 0 or 1 */
1181 static void pci_set_irq(void *opaque, int irq_num, int level)
1182 {
1183     PCIDevice *pci_dev = opaque;
1184     int change;
1185
1186     change = level - pci_irq_state(pci_dev, irq_num);
1187     if (!change)
1188         return;
1189
1190     pci_set_irq_state(pci_dev, irq_num, level);
1191     pci_update_irq_status(pci_dev);
1192     if (pci_irq_disabled(pci_dev))
1193         return;
1194     pci_change_irq_level(pci_dev, irq_num, change);
1195 }
1196
1197 /* Special hooks used by device assignment */
1198 void pci_bus_set_route_irq_fn(PCIBus *bus, pci_route_irq_fn route_intx_to_irq)
1199 {
1200     assert(pci_bus_is_root(bus));
1201     bus->route_intx_to_irq = route_intx_to_irq;
1202 }
1203
1204 PCIINTxRoute pci_device_route_intx_to_irq(PCIDevice *dev, int pin)
1205 {
1206     PCIBus *bus;
1207
1208     do {
1209          bus = dev->bus;
1210          pin = bus->map_irq(dev, pin);
1211          dev = bus->parent_dev;
1212     } while (dev);
1213
1214     if (!bus->route_intx_to_irq) {
1215         error_report("PCI: Bug - unimplemented PCI INTx routing (%s)",
1216                      object_get_typename(OBJECT(bus->qbus.parent)));
1217         return (PCIINTxRoute) { PCI_INTX_DISABLED, -1 };
1218     }
1219
1220     return bus->route_intx_to_irq(bus->irq_opaque, pin);
1221 }
1222
1223 bool pci_intx_route_changed(PCIINTxRoute *old, PCIINTxRoute *new)
1224 {
1225     return old->mode != new->mode || old->irq != new->irq;
1226 }
1227
1228 void pci_bus_fire_intx_routing_notifier(PCIBus *bus)
1229 {
1230     PCIDevice *dev;
1231     PCIBus *sec;
1232     int i;
1233
1234     for (i = 0; i < ARRAY_SIZE(bus->devices); ++i) {
1235         dev = bus->devices[i];
1236         if (dev && dev->intx_routing_notifier) {
1237             dev->intx_routing_notifier(dev);
1238         }
1239     }
1240
1241     QLIST_FOREACH(sec, &bus->child, sibling) {
1242         pci_bus_fire_intx_routing_notifier(sec);
1243     }
1244 }
1245
1246 void pci_device_set_intx_routing_notifier(PCIDevice *dev,
1247                                           PCIINTxRoutingNotifier notifier)
1248 {
1249     dev->intx_routing_notifier = notifier;
1250 }
1251
1252 /*
1253  * PCI-to-PCI bridge specification
1254  * 9.1: Interrupt routing. Table 9-1
1255  *
1256  * the PCI Express Base Specification, Revision 2.1
1257  * 2.2.8.1: INTx interrutp signaling - Rules
1258  *          the Implementation Note
1259  *          Table 2-20
1260  */
1261 /*
1262  * 0 <= pin <= 3 0 = INTA, 1 = INTB, 2 = INTC, 3 = INTD
1263  * 0-origin unlike PCI interrupt pin register.
1264  */
1265 int pci_swizzle_map_irq_fn(PCIDevice *pci_dev, int pin)
1266 {
1267     return (pin + PCI_SLOT(pci_dev->devfn)) % PCI_NUM_PINS;
1268 }
1269
1270 /***********************************************************/
1271 /* monitor info on PCI */
1272
1273 typedef struct {
1274     uint16_t class;
1275     const char *desc;
1276     const char *fw_name;
1277     uint16_t fw_ign_bits;
1278 } pci_class_desc;
1279
1280 static const pci_class_desc pci_class_descriptions[] =
1281 {
1282     { 0x0001, "VGA controller", "display"},
1283     { 0x0100, "SCSI controller", "scsi"},
1284     { 0x0101, "IDE controller", "ide"},
1285     { 0x0102, "Floppy controller", "fdc"},
1286     { 0x0103, "IPI controller", "ipi"},
1287     { 0x0104, "RAID controller", "raid"},
1288     { 0x0106, "SATA controller"},
1289     { 0x0107, "SAS controller"},
1290     { 0x0180, "Storage controller"},
1291     { 0x0200, "Ethernet controller", "ethernet"},
1292     { 0x0201, "Token Ring controller", "token-ring"},
1293     { 0x0202, "FDDI controller", "fddi"},
1294     { 0x0203, "ATM controller", "atm"},
1295     { 0x0280, "Network controller"},
1296     { 0x0300, "VGA controller", "display", 0x00ff},
1297     { 0x0301, "XGA controller"},
1298     { 0x0302, "3D controller"},
1299     { 0x0380, "Display controller"},
1300     { 0x0400, "Video controller", "video"},
1301     { 0x0401, "Audio controller", "sound"},
1302     { 0x0402, "Phone"},
1303     { 0x0403, "Audio controller", "sound"},
1304     { 0x0480, "Multimedia controller"},
1305     { 0x0500, "RAM controller", "memory"},
1306     { 0x0501, "Flash controller", "flash"},
1307     { 0x0580, "Memory controller"},
1308     { 0x0600, "Host bridge", "host"},
1309     { 0x0601, "ISA bridge", "isa"},
1310     { 0x0602, "EISA bridge", "eisa"},
1311     { 0x0603, "MC bridge", "mca"},
1312     { 0x0604, "PCI bridge", "pci"},
1313     { 0x0605, "PCMCIA bridge", "pcmcia"},
1314     { 0x0606, "NUBUS bridge", "nubus"},
1315     { 0x0607, "CARDBUS bridge", "cardbus"},
1316     { 0x0608, "RACEWAY bridge"},
1317     { 0x0680, "Bridge"},
1318     { 0x0700, "Serial port", "serial"},
1319     { 0x0701, "Parallel port", "parallel"},
1320     { 0x0800, "Interrupt controller", "interrupt-controller"},
1321     { 0x0801, "DMA controller", "dma-controller"},
1322     { 0x0802, "Timer", "timer"},
1323     { 0x0803, "RTC", "rtc"},
1324     { 0x0900, "Keyboard", "keyboard"},
1325     { 0x0901, "Pen", "pen"},
1326     { 0x0902, "Mouse", "mouse"},
1327     { 0x0A00, "Dock station", "dock", 0x00ff},
1328     { 0x0B00, "i386 cpu", "cpu", 0x00ff},
1329     { 0x0c00, "Fireware contorller", "fireware"},
1330     { 0x0c01, "Access bus controller", "access-bus"},
1331     { 0x0c02, "SSA controller", "ssa"},
1332     { 0x0c03, "USB controller", "usb"},
1333     { 0x0c04, "Fibre channel controller", "fibre-channel"},
1334     { 0x0c05, "SMBus"},
1335     { 0, NULL}
1336 };
1337
1338 static void pci_for_each_device_under_bus(PCIBus *bus,
1339                                           void (*fn)(PCIBus *b, PCIDevice *d,
1340                                                      void *opaque),
1341                                           void *opaque)
1342 {
1343     PCIDevice *d;
1344     int devfn;
1345
1346     for(devfn = 0; devfn < ARRAY_SIZE(bus->devices); devfn++) {
1347         d = bus->devices[devfn];
1348         if (d) {
1349             fn(bus, d, opaque);
1350         }
1351     }
1352 }
1353
1354 void pci_for_each_device(PCIBus *bus, int bus_num,
1355                          void (*fn)(PCIBus *b, PCIDevice *d, void *opaque),
1356                          void *opaque)
1357 {
1358     bus = pci_find_bus_nr(bus, bus_num);
1359
1360     if (bus) {
1361         pci_for_each_device_under_bus(bus, fn, opaque);
1362     }
1363 }
1364
1365 static const pci_class_desc *get_class_desc(int class)
1366 {
1367     const pci_class_desc *desc;
1368
1369     desc = pci_class_descriptions;
1370     while (desc->desc && class != desc->class) {
1371         desc++;
1372     }
1373
1374     return desc;
1375 }
1376
1377 static PciDeviceInfoList *qmp_query_pci_devices(PCIBus *bus, int bus_num);
1378
1379 static PciMemoryRegionList *qmp_query_pci_regions(const PCIDevice *dev)
1380 {
1381     PciMemoryRegionList *head = NULL, *cur_item = NULL;
1382     int i;
1383
1384     for (i = 0; i < PCI_NUM_REGIONS; i++) {
1385         const PCIIORegion *r = &dev->io_regions[i];
1386         PciMemoryRegionList *region;
1387
1388         if (!r->size) {
1389             continue;
1390         }
1391
1392         region = g_malloc0(sizeof(*region));
1393         region->value = g_malloc0(sizeof(*region->value));
1394
1395         if (r->type & PCI_BASE_ADDRESS_SPACE_IO) {
1396             region->value->type = g_strdup("io");
1397         } else {
1398             region->value->type = g_strdup("memory");
1399             region->value->has_prefetch = true;
1400             region->value->prefetch = !!(r->type & PCI_BASE_ADDRESS_MEM_PREFETCH);
1401             region->value->has_mem_type_64 = true;
1402             region->value->mem_type_64 = !!(r->type & PCI_BASE_ADDRESS_MEM_TYPE_64);
1403         }
1404
1405         region->value->bar = i;
1406         region->value->address = r->addr;
1407         region->value->size = r->size;
1408
1409         /* XXX: waiting for the qapi to support GSList */
1410         if (!cur_item) {
1411             head = cur_item = region;
1412         } else {
1413             cur_item->next = region;
1414             cur_item = region;
1415         }
1416     }
1417
1418     return head;
1419 }
1420
1421 static PciBridgeInfo *qmp_query_pci_bridge(PCIDevice *dev, PCIBus *bus,
1422                                            int bus_num)
1423 {
1424     PciBridgeInfo *info;
1425
1426     info = g_malloc0(sizeof(*info));
1427
1428     info->bus.number = dev->config[PCI_PRIMARY_BUS];
1429     info->bus.secondary = dev->config[PCI_SECONDARY_BUS];
1430     info->bus.subordinate = dev->config[PCI_SUBORDINATE_BUS];
1431
1432     info->bus.io_range = g_malloc0(sizeof(*info->bus.io_range));
1433     info->bus.io_range->base = pci_bridge_get_base(dev, PCI_BASE_ADDRESS_SPACE_IO);
1434     info->bus.io_range->limit = pci_bridge_get_limit(dev, PCI_BASE_ADDRESS_SPACE_IO);
1435
1436     info->bus.memory_range = g_malloc0(sizeof(*info->bus.memory_range));
1437     info->bus.memory_range->base = pci_bridge_get_base(dev, PCI_BASE_ADDRESS_SPACE_MEMORY);
1438     info->bus.memory_range->limit = pci_bridge_get_limit(dev, PCI_BASE_ADDRESS_SPACE_MEMORY);
1439
1440     info->bus.prefetchable_range = g_malloc0(sizeof(*info->bus.prefetchable_range));
1441     info->bus.prefetchable_range->base = pci_bridge_get_base(dev, PCI_BASE_ADDRESS_MEM_PREFETCH);
1442     info->bus.prefetchable_range->limit = pci_bridge_get_limit(dev, PCI_BASE_ADDRESS_MEM_PREFETCH);
1443
1444     if (dev->config[PCI_SECONDARY_BUS] != 0) {
1445         PCIBus *child_bus = pci_find_bus_nr(bus, dev->config[PCI_SECONDARY_BUS]);
1446         if (child_bus) {
1447             info->has_devices = true;
1448             info->devices = qmp_query_pci_devices(child_bus, dev->config[PCI_SECONDARY_BUS]);
1449         }
1450     }
1451
1452     return info;
1453 }
1454
1455 static PciDeviceInfo *qmp_query_pci_device(PCIDevice *dev, PCIBus *bus,
1456                                            int bus_num)
1457 {
1458     const pci_class_desc *desc;
1459     PciDeviceInfo *info;
1460     uint8_t type;
1461     int class;
1462
1463     info = g_malloc0(sizeof(*info));
1464     info->bus = bus_num;
1465     info->slot = PCI_SLOT(dev->devfn);
1466     info->function = PCI_FUNC(dev->devfn);
1467
1468     class = pci_get_word(dev->config + PCI_CLASS_DEVICE);
1469     info->class_info.class = class;
1470     desc = get_class_desc(class);
1471     if (desc->desc) {
1472         info->class_info.has_desc = true;
1473         info->class_info.desc = g_strdup(desc->desc);
1474     }
1475
1476     info->id.vendor = pci_get_word(dev->config + PCI_VENDOR_ID);
1477     info->id.device = pci_get_word(dev->config + PCI_DEVICE_ID);
1478     info->regions = qmp_query_pci_regions(dev);
1479     info->qdev_id = g_strdup(dev->qdev.id ? dev->qdev.id : "");
1480
1481     if (dev->config[PCI_INTERRUPT_PIN] != 0) {
1482         info->has_irq = true;
1483         info->irq = dev->config[PCI_INTERRUPT_LINE];
1484     }
1485
1486     type = dev->config[PCI_HEADER_TYPE] & ~PCI_HEADER_TYPE_MULTI_FUNCTION;
1487     if (type == PCI_HEADER_TYPE_BRIDGE) {
1488         info->has_pci_bridge = true;
1489         info->pci_bridge = qmp_query_pci_bridge(dev, bus, bus_num);
1490     }
1491
1492     return info;
1493 }
1494
1495 static PciDeviceInfoList *qmp_query_pci_devices(PCIBus *bus, int bus_num)
1496 {
1497     PciDeviceInfoList *info, *head = NULL, *cur_item = NULL;
1498     PCIDevice *dev;
1499     int devfn;
1500
1501     for (devfn = 0; devfn < ARRAY_SIZE(bus->devices); devfn++) {
1502         dev = bus->devices[devfn];
1503         if (dev) {
1504             info = g_malloc0(sizeof(*info));
1505             info->value = qmp_query_pci_device(dev, bus, bus_num);
1506
1507             /* XXX: waiting for the qapi to support GSList */
1508             if (!cur_item) {
1509                 head = cur_item = info;
1510             } else {
1511                 cur_item->next = info;
1512                 cur_item = info;
1513             }
1514         }
1515     }
1516
1517     return head;
1518 }
1519
1520 static PciInfo *qmp_query_pci_bus(PCIBus *bus, int bus_num)
1521 {
1522     PciInfo *info = NULL;
1523
1524     bus = pci_find_bus_nr(bus, bus_num);
1525     if (bus) {
1526         info = g_malloc0(sizeof(*info));
1527         info->bus = bus_num;
1528         info->devices = qmp_query_pci_devices(bus, bus_num);
1529     }
1530
1531     return info;
1532 }
1533
1534 PciInfoList *qmp_query_pci(Error **errp)
1535 {
1536     PciInfoList *info, *head = NULL, *cur_item = NULL;
1537     PCIHostState *host_bridge;
1538
1539     QLIST_FOREACH(host_bridge, &pci_host_bridges, next) {
1540         info = g_malloc0(sizeof(*info));
1541         info->value = qmp_query_pci_bus(host_bridge->bus, 0);
1542
1543         /* XXX: waiting for the qapi to support GSList */
1544         if (!cur_item) {
1545             head = cur_item = info;
1546         } else {
1547             cur_item->next = info;
1548             cur_item = info;
1549         }
1550     }
1551
1552     return head;
1553 }
1554
1555 static const char * const pci_nic_models[] = {
1556     "ne2k_pci",
1557     "i82551",
1558     "i82557b",
1559     "i82559er",
1560     "rtl8139",
1561     "e1000",
1562     "pcnet",
1563     "virtio",
1564     NULL
1565 };
1566
1567 static const char * const pci_nic_names[] = {
1568     "ne2k_pci",
1569     "i82551",
1570     "i82557b",
1571     "i82559er",
1572     "rtl8139",
1573     "e1000",
1574     "pcnet",
1575     "virtio-net-pci",
1576     NULL
1577 };
1578
1579 /* Initialize a PCI NIC.  */
1580 /* FIXME callers should check for failure, but don't */
1581 PCIDevice *pci_nic_init(NICInfo *nd, PCIBus *rootbus,
1582                         const char *default_model,
1583                         const char *default_devaddr)
1584 {
1585     const char *devaddr = nd->devaddr ? nd->devaddr : default_devaddr;
1586     PCIBus *bus;
1587     int devfn;
1588     PCIDevice *pci_dev;
1589     DeviceState *dev;
1590     int i;
1591
1592     i = qemu_find_nic_model(nd, pci_nic_models, default_model);
1593     if (i < 0)
1594         return NULL;
1595
1596     bus = pci_get_bus_devfn(&devfn, rootbus, devaddr);
1597     if (!bus) {
1598         error_report("Invalid PCI device address %s for device %s",
1599                      devaddr, pci_nic_names[i]);
1600         return NULL;
1601     }
1602
1603     pci_dev = pci_create(bus, devfn, pci_nic_names[i]);
1604     dev = &pci_dev->qdev;
1605     qdev_set_nic_properties(dev, nd);
1606     if (qdev_init(dev) < 0)
1607         return NULL;
1608     return pci_dev;
1609 }
1610
1611 PCIDevice *pci_nic_init_nofail(NICInfo *nd, PCIBus *rootbus,
1612                                const char *default_model,
1613                                const char *default_devaddr)
1614 {
1615     PCIDevice *res;
1616
1617     if (qemu_show_nic_models(nd->model, pci_nic_models))
1618         exit(0);
1619
1620     res = pci_nic_init(nd, rootbus, default_model, default_devaddr);
1621     if (!res)
1622         exit(1);
1623     return res;
1624 }
1625
1626 PCIDevice *pci_vga_init(PCIBus *bus)
1627 {
1628     switch (vga_interface_type) {
1629     case VGA_CIRRUS:
1630         return pci_create_simple(bus, -1, "cirrus-vga");
1631     case VGA_QXL:
1632         return pci_create_simple(bus, -1, "qxl-vga");
1633     case VGA_STD:
1634         return pci_create_simple(bus, -1, "VGA");
1635     case VGA_VMWARE:
1636         return pci_create_simple(bus, -1, "vmware-svga");
1637     case VGA_NONE:
1638     default: /* Other non-PCI types. Checking for unsupported types is already
1639                 done in vl.c. */
1640         return NULL;
1641     }
1642 }
1643
1644 /* Whether a given bus number is in range of the secondary
1645  * bus of the given bridge device. */
1646 static bool pci_secondary_bus_in_range(PCIDevice *dev, int bus_num)
1647 {
1648     return !(pci_get_word(dev->config + PCI_BRIDGE_CONTROL) &
1649              PCI_BRIDGE_CTL_BUS_RESET) /* Don't walk the bus if it's reset. */ &&
1650         dev->config[PCI_SECONDARY_BUS] < bus_num &&
1651         bus_num <= dev->config[PCI_SUBORDINATE_BUS];
1652 }
1653
1654 static PCIBus *pci_find_bus_nr(PCIBus *bus, int bus_num)
1655 {
1656     PCIBus *sec;
1657
1658     if (!bus) {
1659         return NULL;
1660     }
1661
1662     if (pci_bus_num(bus) == bus_num) {
1663         return bus;
1664     }
1665
1666     /* Consider all bus numbers in range for the host pci bridge. */
1667     if (!pci_bus_is_root(bus) &&
1668         !pci_secondary_bus_in_range(bus->parent_dev, bus_num)) {
1669         return NULL;
1670     }
1671
1672     /* try child bus */
1673     for (; bus; bus = sec) {
1674         QLIST_FOREACH(sec, &bus->child, sibling) {
1675             assert(!pci_bus_is_root(sec));
1676             if (sec->parent_dev->config[PCI_SECONDARY_BUS] == bus_num) {
1677                 return sec;
1678             }
1679             if (pci_secondary_bus_in_range(sec->parent_dev, bus_num)) {
1680                 break;
1681             }
1682         }
1683     }
1684
1685     return NULL;
1686 }
1687
1688 PCIDevice *pci_find_device(PCIBus *bus, int bus_num, uint8_t devfn)
1689 {
1690     bus = pci_find_bus_nr(bus, bus_num);
1691
1692     if (!bus)
1693         return NULL;
1694
1695     return bus->devices[devfn];
1696 }
1697
1698 static int pci_qdev_init(DeviceState *qdev)
1699 {
1700     PCIDevice *pci_dev = (PCIDevice *)qdev;
1701     PCIDeviceClass *pc = PCI_DEVICE_GET_CLASS(pci_dev);
1702     PCIBus *bus;
1703     int rc;
1704     bool is_default_rom;
1705
1706     /* initialize cap_present for pci_is_express() and pci_config_size() */
1707     if (pc->is_express) {
1708         pci_dev->cap_present |= QEMU_PCI_CAP_EXPRESS;
1709     }
1710
1711     bus = PCI_BUS(qdev_get_parent_bus(qdev));
1712     pci_dev = do_pci_register_device(pci_dev, bus,
1713                                      object_get_typename(OBJECT(qdev)),
1714                                      pci_dev->devfn);
1715     if (pci_dev == NULL)
1716         return -1;
1717     if (qdev->hotplugged && pc->no_hotplug) {
1718         qerror_report(QERR_DEVICE_NO_HOTPLUG, object_get_typename(OBJECT(pci_dev)));
1719         do_pci_unregister_device(pci_dev);
1720         return -1;
1721     }
1722     if (pc->init) {
1723         rc = pc->init(pci_dev);
1724         if (rc != 0) {
1725             do_pci_unregister_device(pci_dev);
1726             return rc;
1727         }
1728     }
1729
1730     /* rom loading */
1731     is_default_rom = false;
1732     if (pci_dev->romfile == NULL && pc->romfile != NULL) {
1733         pci_dev->romfile = g_strdup(pc->romfile);
1734         is_default_rom = true;
1735     }
1736     pci_add_option_rom(pci_dev, is_default_rom);
1737
1738     if (bus->hotplug) {
1739         /* Let buses differentiate between hotplug and when device is
1740          * enabled during qemu machine creation. */
1741         rc = bus->hotplug(bus->hotplug_qdev, pci_dev,
1742                           qdev->hotplugged ? PCI_HOTPLUG_ENABLED:
1743                           PCI_COLDPLUG_ENABLED);
1744         if (rc != 0) {
1745             int r = pci_unregister_device(&pci_dev->qdev);
1746             assert(!r);
1747             return rc;
1748         }
1749     }
1750     return 0;
1751 }
1752
1753 static int pci_unplug_device(DeviceState *qdev)
1754 {
1755     PCIDevice *dev = PCI_DEVICE(qdev);
1756     PCIDeviceClass *pc = PCI_DEVICE_GET_CLASS(dev);
1757
1758     if (pc->no_hotplug) {
1759         qerror_report(QERR_DEVICE_NO_HOTPLUG, object_get_typename(OBJECT(dev)));
1760         return -1;
1761     }
1762     return dev->bus->hotplug(dev->bus->hotplug_qdev, dev,
1763                              PCI_HOTPLUG_DISABLED);
1764 }
1765
1766 PCIDevice *pci_create_multifunction(PCIBus *bus, int devfn, bool multifunction,
1767                                     const char *name)
1768 {
1769     DeviceState *dev;
1770
1771     dev = qdev_create(&bus->qbus, name);
1772     qdev_prop_set_int32(dev, "addr", devfn);
1773     qdev_prop_set_bit(dev, "multifunction", multifunction);
1774     return PCI_DEVICE(dev);
1775 }
1776
1777 PCIDevice *pci_create_simple_multifunction(PCIBus *bus, int devfn,
1778                                            bool multifunction,
1779                                            const char *name)
1780 {
1781     PCIDevice *dev = pci_create_multifunction(bus, devfn, multifunction, name);
1782     qdev_init_nofail(&dev->qdev);
1783     return dev;
1784 }
1785
1786 PCIDevice *pci_create(PCIBus *bus, int devfn, const char *name)
1787 {
1788     return pci_create_multifunction(bus, devfn, false, name);
1789 }
1790
1791 PCIDevice *pci_create_simple(PCIBus *bus, int devfn, const char *name)
1792 {
1793     return pci_create_simple_multifunction(bus, devfn, false, name);
1794 }
1795
1796 static uint8_t pci_find_space(PCIDevice *pdev, uint8_t size)
1797 {
1798     int offset = PCI_CONFIG_HEADER_SIZE;
1799     int i;
1800     for (i = PCI_CONFIG_HEADER_SIZE; i < PCI_CONFIG_SPACE_SIZE; ++i) {
1801         if (pdev->used[i])
1802             offset = i + 1;
1803         else if (i - offset + 1 == size)
1804             return offset;
1805     }
1806     return 0;
1807 }
1808
1809 static uint8_t pci_find_capability_list(PCIDevice *pdev, uint8_t cap_id,
1810                                         uint8_t *prev_p)
1811 {
1812     uint8_t next, prev;
1813
1814     if (!(pdev->config[PCI_STATUS] & PCI_STATUS_CAP_LIST))
1815         return 0;
1816
1817     for (prev = PCI_CAPABILITY_LIST; (next = pdev->config[prev]);
1818          prev = next + PCI_CAP_LIST_NEXT)
1819         if (pdev->config[next + PCI_CAP_LIST_ID] == cap_id)
1820             break;
1821
1822     if (prev_p)
1823         *prev_p = prev;
1824     return next;
1825 }
1826
1827 static uint8_t pci_find_capability_at_offset(PCIDevice *pdev, uint8_t offset)
1828 {
1829     uint8_t next, prev, found = 0;
1830
1831     if (!(pdev->used[offset])) {
1832         return 0;
1833     }
1834
1835     assert(pdev->config[PCI_STATUS] & PCI_STATUS_CAP_LIST);
1836
1837     for (prev = PCI_CAPABILITY_LIST; (next = pdev->config[prev]);
1838          prev = next + PCI_CAP_LIST_NEXT) {
1839         if (next <= offset && next > found) {
1840             found = next;
1841         }
1842     }
1843     return found;
1844 }
1845
1846 /* Patch the PCI vendor and device ids in a PCI rom image if necessary.
1847    This is needed for an option rom which is used for more than one device. */
1848 static void pci_patch_ids(PCIDevice *pdev, uint8_t *ptr, int size)
1849 {
1850     uint16_t vendor_id;
1851     uint16_t device_id;
1852     uint16_t rom_vendor_id;
1853     uint16_t rom_device_id;
1854     uint16_t rom_magic;
1855     uint16_t pcir_offset;
1856     uint8_t checksum;
1857
1858     /* Words in rom data are little endian (like in PCI configuration),
1859        so they can be read / written with pci_get_word / pci_set_word. */
1860
1861     /* Only a valid rom will be patched. */
1862     rom_magic = pci_get_word(ptr);
1863     if (rom_magic != 0xaa55) {
1864         PCI_DPRINTF("Bad ROM magic %04x\n", rom_magic);
1865         return;
1866     }
1867     pcir_offset = pci_get_word(ptr + 0x18);
1868     if (pcir_offset + 8 >= size || memcmp(ptr + pcir_offset, "PCIR", 4)) {
1869         PCI_DPRINTF("Bad PCIR offset 0x%x or signature\n", pcir_offset);
1870         return;
1871     }
1872
1873     vendor_id = pci_get_word(pdev->config + PCI_VENDOR_ID);
1874     device_id = pci_get_word(pdev->config + PCI_DEVICE_ID);
1875     rom_vendor_id = pci_get_word(ptr + pcir_offset + 4);
1876     rom_device_id = pci_get_word(ptr + pcir_offset + 6);
1877
1878     PCI_DPRINTF("%s: ROM id %04x%04x / PCI id %04x%04x\n", pdev->romfile,
1879                 vendor_id, device_id, rom_vendor_id, rom_device_id);
1880
1881     checksum = ptr[6];
1882
1883     if (vendor_id != rom_vendor_id) {
1884         /* Patch vendor id and checksum (at offset 6 for etherboot roms). */
1885         checksum += (uint8_t)rom_vendor_id + (uint8_t)(rom_vendor_id >> 8);
1886         checksum -= (uint8_t)vendor_id + (uint8_t)(vendor_id >> 8);
1887         PCI_DPRINTF("ROM checksum %02x / %02x\n", ptr[6], checksum);
1888         ptr[6] = checksum;
1889         pci_set_word(ptr + pcir_offset + 4, vendor_id);
1890     }
1891
1892     if (device_id != rom_device_id) {
1893         /* Patch device id and checksum (at offset 6 for etherboot roms). */
1894         checksum += (uint8_t)rom_device_id + (uint8_t)(rom_device_id >> 8);
1895         checksum -= (uint8_t)device_id + (uint8_t)(device_id >> 8);
1896         PCI_DPRINTF("ROM checksum %02x / %02x\n", ptr[6], checksum);
1897         ptr[6] = checksum;
1898         pci_set_word(ptr + pcir_offset + 6, device_id);
1899     }
1900 }
1901
1902 /* Add an option rom for the device */
1903 static int pci_add_option_rom(PCIDevice *pdev, bool is_default_rom)
1904 {
1905     int size;
1906     char *path;
1907     void *ptr;
1908     char name[32];
1909     const VMStateDescription *vmsd;
1910
1911     if (!pdev->romfile)
1912         return 0;
1913     if (strlen(pdev->romfile) == 0)
1914         return 0;
1915
1916     if (!pdev->rom_bar) {
1917         /*
1918          * Load rom via fw_cfg instead of creating a rom bar,
1919          * for 0.11 compatibility.
1920          */
1921         int class = pci_get_word(pdev->config + PCI_CLASS_DEVICE);
1922         if (class == 0x0300) {
1923             rom_add_vga(pdev->romfile);
1924         } else {
1925             rom_add_option(pdev->romfile, -1);
1926         }
1927         return 0;
1928     }
1929
1930     path = qemu_find_file(QEMU_FILE_TYPE_BIOS, pdev->romfile);
1931     if (path == NULL) {
1932         path = g_strdup(pdev->romfile);
1933     }
1934
1935     size = get_image_size(path);
1936     if (size < 0) {
1937         error_report("%s: failed to find romfile \"%s\"",
1938                      __func__, pdev->romfile);
1939         g_free(path);
1940         return -1;
1941     } else if (size == 0) {
1942         error_report("%s: ignoring empty romfile \"%s\"",
1943                      __func__, pdev->romfile);
1944         g_free(path);
1945         return -1;
1946     }
1947     if (size & (size - 1)) {
1948         size = 1 << qemu_fls(size);
1949     }
1950
1951     vmsd = qdev_get_vmsd(DEVICE(pdev));
1952
1953     if (vmsd) {
1954         snprintf(name, sizeof(name), "%s.rom", vmsd->name);
1955     } else {
1956         snprintf(name, sizeof(name), "%s.rom", object_get_typename(OBJECT(pdev)));
1957     }
1958     pdev->has_rom = true;
1959     memory_region_init_ram(&pdev->rom, OBJECT(pdev), name, size);
1960     vmstate_register_ram(&pdev->rom, &pdev->qdev);
1961     ptr = memory_region_get_ram_ptr(&pdev->rom);
1962     load_image(path, ptr);
1963     g_free(path);
1964
1965     if (is_default_rom) {
1966         /* Only the default rom images will be patched (if needed). */
1967         pci_patch_ids(pdev, ptr, size);
1968     }
1969
1970     pci_register_bar(pdev, PCI_ROM_SLOT, 0, &pdev->rom);
1971
1972     return 0;
1973 }
1974
1975 static void pci_del_option_rom(PCIDevice *pdev)
1976 {
1977     if (!pdev->has_rom)
1978         return;
1979
1980     vmstate_unregister_ram(&pdev->rom, &pdev->qdev);
1981     memory_region_destroy(&pdev->rom);
1982     pdev->has_rom = false;
1983 }
1984
1985 /*
1986  * if !offset
1987  * Reserve space and add capability to the linked list in pci config space
1988  *
1989  * if offset = 0,
1990  * Find and reserve space and add capability to the linked list
1991  * in pci config space */
1992 int pci_add_capability(PCIDevice *pdev, uint8_t cap_id,
1993                        uint8_t offset, uint8_t size)
1994 {
1995     uint8_t *config;
1996     int i, overlapping_cap;
1997
1998     if (!offset) {
1999         offset = pci_find_space(pdev, size);
2000         if (!offset) {
2001             return -ENOSPC;
2002         }
2003     } else {
2004         /* Verify that capabilities don't overlap.  Note: device assignment
2005          * depends on this check to verify that the device is not broken.
2006          * Should never trigger for emulated devices, but it's helpful
2007          * for debugging these. */
2008         for (i = offset; i < offset + size; i++) {
2009             overlapping_cap = pci_find_capability_at_offset(pdev, i);
2010             if (overlapping_cap) {
2011                 fprintf(stderr, "ERROR: %s:%02x:%02x.%x "
2012                         "Attempt to add PCI capability %x at offset "
2013                         "%x overlaps existing capability %x at offset %x\n",
2014                         pci_root_bus_path(pdev), pci_bus_num(pdev->bus),
2015                         PCI_SLOT(pdev->devfn), PCI_FUNC(pdev->devfn),
2016                         cap_id, offset, overlapping_cap, i);
2017                 return -EINVAL;
2018             }
2019         }
2020     }
2021
2022     config = pdev->config + offset;
2023     config[PCI_CAP_LIST_ID] = cap_id;
2024     config[PCI_CAP_LIST_NEXT] = pdev->config[PCI_CAPABILITY_LIST];
2025     pdev->config[PCI_CAPABILITY_LIST] = offset;
2026     pdev->config[PCI_STATUS] |= PCI_STATUS_CAP_LIST;
2027     memset(pdev->used + offset, 0xFF, QEMU_ALIGN_UP(size, 4));
2028     /* Make capability read-only by default */
2029     memset(pdev->wmask + offset, 0, size);
2030     /* Check capability by default */
2031     memset(pdev->cmask + offset, 0xFF, size);
2032     return offset;
2033 }
2034
2035 /* Unlink capability from the pci config space. */
2036 void pci_del_capability(PCIDevice *pdev, uint8_t cap_id, uint8_t size)
2037 {
2038     uint8_t prev, offset = pci_find_capability_list(pdev, cap_id, &prev);
2039     if (!offset)
2040         return;
2041     pdev->config[prev] = pdev->config[offset + PCI_CAP_LIST_NEXT];
2042     /* Make capability writable again */
2043     memset(pdev->wmask + offset, 0xff, size);
2044     memset(pdev->w1cmask + offset, 0, size);
2045     /* Clear cmask as device-specific registers can't be checked */
2046     memset(pdev->cmask + offset, 0, size);
2047     memset(pdev->used + offset, 0, QEMU_ALIGN_UP(size, 4));
2048
2049     if (!pdev->config[PCI_CAPABILITY_LIST])
2050         pdev->config[PCI_STATUS] &= ~PCI_STATUS_CAP_LIST;
2051 }
2052
2053 uint8_t pci_find_capability(PCIDevice *pdev, uint8_t cap_id)
2054 {
2055     return pci_find_capability_list(pdev, cap_id, NULL);
2056 }
2057
2058 static void pcibus_dev_print(Monitor *mon, DeviceState *dev, int indent)
2059 {
2060     PCIDevice *d = (PCIDevice *)dev;
2061     const pci_class_desc *desc;
2062     char ctxt[64];
2063     PCIIORegion *r;
2064     int i, class;
2065
2066     class = pci_get_word(d->config + PCI_CLASS_DEVICE);
2067     desc = pci_class_descriptions;
2068     while (desc->desc && class != desc->class)
2069         desc++;
2070     if (desc->desc) {
2071         snprintf(ctxt, sizeof(ctxt), "%s", desc->desc);
2072     } else {
2073         snprintf(ctxt, sizeof(ctxt), "Class %04x", class);
2074     }
2075
2076     monitor_printf(mon, "%*sclass %s, addr %02x:%02x.%x, "
2077                    "pci id %04x:%04x (sub %04x:%04x)\n",
2078                    indent, "", ctxt, pci_bus_num(d->bus),
2079                    PCI_SLOT(d->devfn), PCI_FUNC(d->devfn),
2080                    pci_get_word(d->config + PCI_VENDOR_ID),
2081                    pci_get_word(d->config + PCI_DEVICE_ID),
2082                    pci_get_word(d->config + PCI_SUBSYSTEM_VENDOR_ID),
2083                    pci_get_word(d->config + PCI_SUBSYSTEM_ID));
2084     for (i = 0; i < PCI_NUM_REGIONS; i++) {
2085         r = &d->io_regions[i];
2086         if (!r->size)
2087             continue;
2088         monitor_printf(mon, "%*sbar %d: %s at 0x%"FMT_PCIBUS
2089                        " [0x%"FMT_PCIBUS"]\n",
2090                        indent, "",
2091                        i, r->type & PCI_BASE_ADDRESS_SPACE_IO ? "i/o" : "mem",
2092                        r->addr, r->addr + r->size - 1);
2093     }
2094 }
2095
2096 static char *pci_dev_fw_name(DeviceState *dev, char *buf, int len)
2097 {
2098     PCIDevice *d = (PCIDevice *)dev;
2099     const char *name = NULL;
2100     const pci_class_desc *desc =  pci_class_descriptions;
2101     int class = pci_get_word(d->config + PCI_CLASS_DEVICE);
2102
2103     while (desc->desc &&
2104           (class & ~desc->fw_ign_bits) !=
2105           (desc->class & ~desc->fw_ign_bits)) {
2106         desc++;
2107     }
2108
2109     if (desc->desc) {
2110         name = desc->fw_name;
2111     }
2112
2113     if (name) {
2114         pstrcpy(buf, len, name);
2115     } else {
2116         snprintf(buf, len, "pci%04x,%04x",
2117                  pci_get_word(d->config + PCI_VENDOR_ID),
2118                  pci_get_word(d->config + PCI_DEVICE_ID));
2119     }
2120
2121     return buf;
2122 }
2123
2124 static char *pcibus_get_fw_dev_path(DeviceState *dev)
2125 {
2126     PCIDevice *d = (PCIDevice *)dev;
2127     char path[50], name[33];
2128     int off;
2129
2130     off = snprintf(path, sizeof(path), "%s@%x",
2131                    pci_dev_fw_name(dev, name, sizeof name),
2132                    PCI_SLOT(d->devfn));
2133     if (PCI_FUNC(d->devfn))
2134         snprintf(path + off, sizeof(path) + off, ",%x", PCI_FUNC(d->devfn));
2135     return g_strdup(path);
2136 }
2137
2138 static char *pcibus_get_dev_path(DeviceState *dev)
2139 {
2140     PCIDevice *d = container_of(dev, PCIDevice, qdev);
2141     PCIDevice *t;
2142     int slot_depth;
2143     /* Path format: Domain:00:Slot.Function:Slot.Function....:Slot.Function.
2144      * 00 is added here to make this format compatible with
2145      * domain:Bus:Slot.Func for systems without nested PCI bridges.
2146      * Slot.Function list specifies the slot and function numbers for all
2147      * devices on the path from root to the specific device. */
2148     const char *root_bus_path;
2149     int root_bus_len;
2150     char slot[] = ":SS.F";
2151     int slot_len = sizeof slot - 1 /* For '\0' */;
2152     int path_len;
2153     char *path, *p;
2154     int s;
2155
2156     root_bus_path = pci_root_bus_path(d);
2157     root_bus_len = strlen(root_bus_path);
2158
2159     /* Calculate # of slots on path between device and root. */;
2160     slot_depth = 0;
2161     for (t = d; t; t = t->bus->parent_dev) {
2162         ++slot_depth;
2163     }
2164
2165     path_len = root_bus_len + slot_len * slot_depth;
2166
2167     /* Allocate memory, fill in the terminating null byte. */
2168     path = g_malloc(path_len + 1 /* For '\0' */);
2169     path[path_len] = '\0';
2170
2171     memcpy(path, root_bus_path, root_bus_len);
2172
2173     /* Fill in slot numbers. We walk up from device to root, so need to print
2174      * them in the reverse order, last to first. */
2175     p = path + path_len;
2176     for (t = d; t; t = t->bus->parent_dev) {
2177         p -= slot_len;
2178         s = snprintf(slot, sizeof slot, ":%02x.%x",
2179                      PCI_SLOT(t->devfn), PCI_FUNC(t->devfn));
2180         assert(s == slot_len);
2181         memcpy(p, slot, slot_len);
2182     }
2183
2184     return path;
2185 }
2186
2187 static int pci_qdev_find_recursive(PCIBus *bus,
2188                                    const char *id, PCIDevice **pdev)
2189 {
2190     DeviceState *qdev = qdev_find_recursive(&bus->qbus, id);
2191     if (!qdev) {
2192         return -ENODEV;
2193     }
2194
2195     /* roughly check if given qdev is pci device */
2196     if (object_dynamic_cast(OBJECT(qdev), TYPE_PCI_DEVICE)) {
2197         *pdev = PCI_DEVICE(qdev);
2198         return 0;
2199     }
2200     return -EINVAL;
2201 }
2202
2203 int pci_qdev_find_device(const char *id, PCIDevice **pdev)
2204 {
2205     PCIHostState *host_bridge;
2206     int rc = -ENODEV;
2207
2208     QLIST_FOREACH(host_bridge, &pci_host_bridges, next) {
2209         int tmp = pci_qdev_find_recursive(host_bridge->bus, id, pdev);
2210         if (!tmp) {
2211             rc = 0;
2212             break;
2213         }
2214         if (tmp != -ENODEV) {
2215             rc = tmp;
2216         }
2217     }
2218
2219     return rc;
2220 }
2221
2222 MemoryRegion *pci_address_space(PCIDevice *dev)
2223 {
2224     return dev->bus->address_space_mem;
2225 }
2226
2227 MemoryRegion *pci_address_space_io(PCIDevice *dev)
2228 {
2229     return dev->bus->address_space_io;
2230 }
2231
2232 static void pci_device_class_init(ObjectClass *klass, void *data)
2233 {
2234     DeviceClass *k = DEVICE_CLASS(klass);
2235     k->init = pci_qdev_init;
2236     k->unplug = pci_unplug_device;
2237     k->exit = pci_unregister_device;
2238     k->bus_type = TYPE_PCI_BUS;
2239     k->props = pci_props;
2240 }
2241
2242 void pci_setup_iommu(PCIBus *bus, PCIIOMMUFunc fn, void *opaque)
2243 {
2244     bus->iommu_fn = fn;
2245     bus->iommu_opaque = opaque;
2246 }
2247
2248 static const TypeInfo pci_device_type_info = {
2249     .name = TYPE_PCI_DEVICE,
2250     .parent = TYPE_DEVICE,
2251     .instance_size = sizeof(PCIDevice),
2252     .abstract = true,
2253     .class_size = sizeof(PCIDeviceClass),
2254     .class_init = pci_device_class_init,
2255 };
2256
2257 static void pci_register_types(void)
2258 {
2259     type_register_static(&pci_bus_info);
2260     type_register_static(&pcie_bus_info);
2261     type_register_static(&pci_device_type_info);
2262 }
2263
2264 type_init(pci_register_types)