hw/pci/pci_bridge.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 dea
   8
   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
  23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  24  * THE SOFTWARE.
  25  */
  26 /*
  27  * split out from pci.c
  28  * Copyright (c) 2010 Isaku Yamahata <yamahata at valinux co jp>
  29  *                    VA Linux Systems Japan K.K.
  30  */
  31
  32 #include "qemu/osdep.h"
  33 #include "qemu/units.h"
  34 #include "hw/pci/pci_bridge.h"
  35 #include "hw/pci/pci_bus.h"
  36 #include "qemu/module.h"
  37 #include "qemu/range.h"
  38 #include "qapi/error.h"
  39 #include "hw/acpi/acpi_aml_interface.h"
  40 #include "hw/acpi/pci.h"
  41
  42 /* PCI bridge subsystem vendor ID helper functions */
  43 #define PCI_SSVID_SIZEOF        8
  44 #define PCI_SSVID_SVID          4
  45 #define PCI_SSVID_SSID          6
  46
  47 int pci_bridge_ssvid_init(PCIDevice *dev, uint8_t offset,
  48                           uint16_t svid, uint16_t ssid,
  49                           Error **errp)
  50 {
  51     int pos;
  52
  53     pos = pci_add_capability(dev, PCI_CAP_ID_SSVID, offset,
  54                              PCI_SSVID_SIZEOF, errp);
  55     if (pos < 0) {
  56         return pos;
  57     }
  58
  59     pci_set_word(dev->config + pos + PCI_SSVID_SVID, svid);
  60     pci_set_word(dev->config + pos + PCI_SSVID_SSID, ssid);
  61     return pos;
  62 }
  63
  64 /* Accessor function to get parent bridge device from pci bus. */
  65 PCIDevice *pci_bridge_get_device(PCIBus *bus)
  66 {
  67     return bus->parent_dev;
  68 }
  69
  70 /* Accessor function to get secondary bus from pci-to-pci bridge device */
  71 PCIBus *pci_bridge_get_sec_bus(PCIBridge *br)
  72 {
  73     return &br->sec_bus;
  74 }
  75
  76 static uint32_t pci_config_get_io_base(const PCIDevice *d,
  77                                        uint32_t base, uint32_t base_upper16)
  78 {
  79     uint32_t val;
  80
  81     val = ((uint32_t)d->config[base] & PCI_IO_RANGE_MASK) << 8;
  82     if (d->config[base] & PCI_IO_RANGE_TYPE_32) {
  83         val |= (uint32_t)pci_get_word(d->config + base_upper16) << 16;
  84     }
  85     return val;
  86 }
  87
  88 static pcibus_t pci_config_get_memory_base(const PCIDevice *d, uint32_t base)
  89 {
  90     return ((pcibus_t)pci_get_word(d->config + base) & PCI_MEMORY_RANGE_MASK)
  91         << 16;
  92 }
  93
  94 static pcibus_t pci_config_get_pref_base(const PCIDevice *d,
  95                                          uint32_t base, uint32_t upper)
  96 {
  97     pcibus_t tmp;
  98     pcibus_t val;
  99
 100     tmp = (pcibus_t)pci_get_word(d->config + base);
 101     val = (tmp & PCI_PREF_RANGE_MASK) << 16;
 102     if (tmp & PCI_PREF_RANGE_TYPE_64) {
 103         val |= (pcibus_t)pci_get_long(d->config + upper) << 32;
 104     }
 105     return val;
 106 }
 107
 108 /* accessor function to get bridge filtering base address */
 109 pcibus_t pci_bridge_get_base(const PCIDevice *bridge, uint8_t type)
 110 {
 111     pcibus_t base;
 112     if (type & PCI_BASE_ADDRESS_SPACE_IO) {
 113         base = pci_config_get_io_base(bridge,
 114                                       PCI_IO_BASE, PCI_IO_BASE_UPPER16);
 115     } else {
 116         if (type & PCI_BASE_ADDRESS_MEM_PREFETCH) {
 117             base = pci_config_get_pref_base(
 118                 bridge, PCI_PREF_MEMORY_BASE, PCI_PREF_BASE_UPPER32);
 119         } else {
 120             base = pci_config_get_memory_base(bridge, PCI_MEMORY_BASE);
 121         }
 122     }
 123
 124     return base;
 125 }
 126
 127 /* accessor function to get bridge filtering limit */
 128 pcibus_t pci_bridge_get_limit(const PCIDevice *bridge, uint8_t type)
 129 {
 130     pcibus_t limit;
 131     if (type & PCI_BASE_ADDRESS_SPACE_IO) {
 132         limit = pci_config_get_io_base(bridge,
 133                                       PCI_IO_LIMIT, PCI_IO_LIMIT_UPPER16);
 134         limit |= 0xfff;         /* PCI bridge spec 3.2.5.6. */
 135     } else {
 136         if (type & PCI_BASE_ADDRESS_MEM_PREFETCH) {
 137             limit = pci_config_get_pref_base(
 138                 bridge, PCI_PREF_MEMORY_LIMIT, PCI_PREF_LIMIT_UPPER32);
 139         } else {
 140             limit = pci_config_get_memory_base(bridge, PCI_MEMORY_LIMIT);
 141         }
 142         limit |= 0xfffff;       /* PCI bridge spec 3.2.5.{1, 8}. */
 143     }
 144     return limit;
 145 }
 146
 147 static void pci_bridge_init_alias(PCIBridge *bridge, MemoryRegion *alias,
 148                                   uint8_t type, const char *name,
 149                                   MemoryRegion *space,
 150                                   MemoryRegion *parent_space,
 151                                   bool enabled)
 152 {
 153     PCIDevice *bridge_dev = PCI_DEVICE(bridge);
 154     pcibus_t base = pci_bridge_get_base(bridge_dev, type);
 155     pcibus_t limit = pci_bridge_get_limit(bridge_dev, type);
 156     /* TODO: this doesn't handle base = 0 limit = 2^64 - 1 correctly.
 157      * Apparently no way to do this with existing memory APIs. */
 158     pcibus_t size = enabled && limit >= base ? limit + 1 - base : 0;
 159
 160     memory_region_init_alias(alias, OBJECT(bridge), name, space, base, size);
 161     memory_region_add_subregion_overlap(parent_space, base, alias, 1);
 162 }
 163
 164 static void pci_bridge_init_vga_aliases(PCIBridge *br, PCIBus *parent,
 165                                         MemoryRegion *alias_vga)
 166 {
 167     PCIDevice *pd = PCI_DEVICE(br);
 168     uint16_t brctl = pci_get_word(pd->config + PCI_BRIDGE_CONTROL);
 169
 170     memory_region_init_alias(&alias_vga[QEMU_PCI_VGA_IO_LO], OBJECT(br),
 171                              "pci_bridge_vga_io_lo", &br->address_space_io,
 172                              QEMU_PCI_VGA_IO_LO_BASE, QEMU_PCI_VGA_IO_LO_SIZE);
 173     memory_region_init_alias(&alias_vga[QEMU_PCI_VGA_IO_HI], OBJECT(br),
 174                              "pci_bridge_vga_io_hi", &br->address_space_io,
 175                              QEMU_PCI_VGA_IO_HI_BASE, QEMU_PCI_VGA_IO_HI_SIZE);
 176     memory_region_init_alias(&alias_vga[QEMU_PCI_VGA_MEM], OBJECT(br),
 177                              "pci_bridge_vga_mem", &br->address_space_mem,
 178                              QEMU_PCI_VGA_MEM_BASE, QEMU_PCI_VGA_MEM_SIZE);
 179
 180     if (brctl & PCI_BRIDGE_CTL_VGA) {
 181         pci_register_vga(pd, &alias_vga[QEMU_PCI_VGA_MEM],
 182                          &alias_vga[QEMU_PCI_VGA_IO_LO],
 183                          &alias_vga[QEMU_PCI_VGA_IO_HI]);
 184     }
 185 }
 186
 187 static PCIBridgeWindows *pci_bridge_region_init(PCIBridge *br)
 188 {
 189     PCIDevice *pd = PCI_DEVICE(br);
 190     PCIBus *parent = pci_get_bus(pd);
 191     PCIBridgeWindows *w = g_new(PCIBridgeWindows, 1);
 192     uint16_t cmd = pci_get_word(pd->config + PCI_COMMAND);
 193
 194     pci_bridge_init_alias(br, &w->alias_pref_mem,
 195                           PCI_BASE_ADDRESS_MEM_PREFETCH,
 196                           "pci_bridge_pref_mem",
 197                           &br->address_space_mem,
 198                           parent->address_space_mem,
 199                           cmd & PCI_COMMAND_MEMORY);
 200     pci_bridge_init_alias(br, &w->alias_mem,
 201                           PCI_BASE_ADDRESS_SPACE_MEMORY,
 202                           "pci_bridge_mem",
 203                           &br->address_space_mem,
 204                           parent->address_space_mem,
 205                           cmd & PCI_COMMAND_MEMORY);
 206     pci_bridge_init_alias(br, &w->alias_io,
 207                           PCI_BASE_ADDRESS_SPACE_IO,
 208                           "pci_bridge_io",
 209                           &br->address_space_io,
 210                           parent->address_space_io,
 211                           cmd & PCI_COMMAND_IO);
 212
 213     pci_bridge_init_vga_aliases(br, parent, w->alias_vga);
 214
 215     return w;
 216 }
 217
 218 static void pci_bridge_region_del(PCIBridge *br, PCIBridgeWindows *w)
 219 {
 220     PCIDevice *pd = PCI_DEVICE(br);
 221     PCIBus *parent = pci_get_bus(pd);
 222
 223     memory_region_del_subregion(parent->address_space_io, &w->alias_io);
 224     memory_region_del_subregion(parent->address_space_mem, &w->alias_mem);
 225     memory_region_del_subregion(parent->address_space_mem, &w->alias_pref_mem);
 226     pci_unregister_vga(pd);
 227 }
 228
 229 static void pci_bridge_region_cleanup(PCIBridge *br, PCIBridgeWindows *w)
 230 {
 231     object_unparent(OBJECT(&w->alias_io));
 232     object_unparent(OBJECT(&w->alias_mem));
 233     object_unparent(OBJECT(&w->alias_pref_mem));
 234     object_unparent(OBJECT(&w->alias_vga[QEMU_PCI_VGA_IO_LO]));
 235     object_unparent(OBJECT(&w->alias_vga[QEMU_PCI_VGA_IO_HI]));
 236     object_unparent(OBJECT(&w->alias_vga[QEMU_PCI_VGA_MEM]));
 237     g_free(w);
 238 }
 239
 240 void pci_bridge_update_mappings(PCIBridge *br)
 241 {
 242     PCIBridgeWindows *w = br->windows;
 243
 244     /* Make updates atomic to: handle the case of one VCPU updating the bridge
 245      * while another accesses an unaffected region. */
 246     memory_region_transaction_begin();
 247     pci_bridge_region_del(br, br->windows);
 248     pci_bridge_region_cleanup(br, w);
 249     br->windows = pci_bridge_region_init(br);
 250     memory_region_transaction_commit();
 251 }
 252
 253 /* default write_config function for PCI-to-PCI bridge */
 254 void pci_bridge_write_config(PCIDevice *d,
 255                              uint32_t address, uint32_t val, int len)
 256 {
 257     PCIBridge *s = PCI_BRIDGE(d);
 258     uint16_t oldctl = pci_get_word(d->config + PCI_BRIDGE_CONTROL);
 259     uint16_t newctl;
 260
 261     pci_default_write_config(d, address, val, len);
 262
 263     if (ranges_overlap(address, len, PCI_COMMAND, 2) ||
 264
 265         /* io base/limit */
 266         ranges_overlap(address, len, PCI_IO_BASE, 2) ||
 267
 268         /* memory base/limit, prefetchable base/limit and
 269            io base/limit upper 16 */
 270         ranges_overlap(address, len, PCI_MEMORY_BASE, 20) ||
 271
 272         /* vga enable */
 273         ranges_overlap(address, len, PCI_BRIDGE_CONTROL, 2)) {
 274         pci_bridge_update_mappings(s);
 275     }
 276
 277     newctl = pci_get_word(d->config + PCI_BRIDGE_CONTROL);
 278     if (~oldctl & newctl & PCI_BRIDGE_CTL_BUS_RESET) {
 279         /* Trigger hot reset on 0->1 transition. */
 280         bus_cold_reset(BUS(&s->sec_bus));
 281     }
 282 }
 283
 284 void pci_bridge_disable_base_limit(PCIDevice *dev)
 285 {
 286     uint8_t *conf = dev->config;
 287
 288     pci_byte_test_and_set_mask(conf + PCI_IO_BASE,
 289                                PCI_IO_RANGE_MASK & 0xff);
 290     pci_byte_test_and_clear_mask(conf + PCI_IO_LIMIT,
 291                                  PCI_IO_RANGE_MASK & 0xff);
 292     pci_word_test_and_set_mask(conf + PCI_MEMORY_BASE,
 293                                PCI_MEMORY_RANGE_MASK & 0xffff);
 294     pci_word_test_and_clear_mask(conf + PCI_MEMORY_LIMIT,
 295                                  PCI_MEMORY_RANGE_MASK & 0xffff);
 296     pci_word_test_and_set_mask(conf + PCI_PREF_MEMORY_BASE,
 297                                PCI_PREF_RANGE_MASK & 0xffff);
 298     pci_word_test_and_clear_mask(conf + PCI_PREF_MEMORY_LIMIT,
 299                                  PCI_PREF_RANGE_MASK & 0xffff);
 300     pci_set_long(conf + PCI_PREF_BASE_UPPER32, 0);
 301     pci_set_long(conf + PCI_PREF_LIMIT_UPPER32, 0);
 302 }
 303
 304 /* reset bridge specific configuration registers */
 305 void pci_bridge_reset(DeviceState *qdev)
 306 {
 307     PCIDevice *dev = PCI_DEVICE(qdev);
 308     uint8_t *conf = dev->config;
 309
 310     conf[PCI_PRIMARY_BUS] = 0;
 311     conf[PCI_SECONDARY_BUS] = 0;
 312     conf[PCI_SUBORDINATE_BUS] = 0;
 313     conf[PCI_SEC_LATENCY_TIMER] = 0;
 314
 315     /*
 316      * the default values for base/limit registers aren't specified
 317      * in the PCI-to-PCI-bridge spec. So we don't touch them here.
 318      * Each implementation can override it.
 319      * typical implementation does
 320      * zero base/limit registers or
 321      * disable forwarding: pci_bridge_disable_base_limit()
 322      * If disable forwarding is wanted, call pci_bridge_disable_base_limit()
 323      * after this function.
 324      */
 325     pci_byte_test_and_clear_mask(conf + PCI_IO_BASE,
 326                                  PCI_IO_RANGE_MASK & 0xff);
 327     pci_byte_test_and_clear_mask(conf + PCI_IO_LIMIT,
 328                                  PCI_IO_RANGE_MASK & 0xff);
 329     pci_word_test_and_clear_mask(conf + PCI_MEMORY_BASE,
 330                                  PCI_MEMORY_RANGE_MASK & 0xffff);
 331     pci_word_test_and_clear_mask(conf + PCI_MEMORY_LIMIT,
 332                                  PCI_MEMORY_RANGE_MASK & 0xffff);
 333     pci_word_test_and_clear_mask(conf + PCI_PREF_MEMORY_BASE,
 334                                  PCI_PREF_RANGE_MASK & 0xffff);
 335     pci_word_test_and_clear_mask(conf + PCI_PREF_MEMORY_LIMIT,
 336                                  PCI_PREF_RANGE_MASK & 0xffff);
 337     pci_set_long(conf + PCI_PREF_BASE_UPPER32, 0);
 338     pci_set_long(conf + PCI_PREF_LIMIT_UPPER32, 0);
 339
 340     pci_set_word(conf + PCI_BRIDGE_CONTROL, 0);
 341 }
 342
 343 /* default qdev initialization function for PCI-to-PCI bridge */
 344 void pci_bridge_initfn(PCIDevice *dev, const char *typename)
 345 {
 346     PCIBus *parent = pci_get_bus(dev);
 347     PCIBridge *br = PCI_BRIDGE(dev);
 348     PCIBus *sec_bus = &br->sec_bus;
 349
 350     pci_word_test_and_set_mask(dev->config + PCI_STATUS,
 351                                PCI_STATUS_66MHZ | PCI_STATUS_FAST_BACK);
 352
 353     /*
 354      * TODO: We implement VGA Enable in the Bridge Control Register
 355      * therefore per the PCI to PCI bridge spec we must also implement
 356      * VGA Palette Snooping.  When done, set this bit writable:
 357      *
 358      * pci_word_test_and_set_mask(dev->wmask + PCI_COMMAND,
 359      *                            PCI_COMMAND_VGA_PALETTE);
 360      */
 361
 362     pci_config_set_class(dev->config, PCI_CLASS_BRIDGE_PCI);
 363     dev->config[PCI_HEADER_TYPE] =
 364         (dev->config[PCI_HEADER_TYPE] & PCI_HEADER_TYPE_MULTI_FUNCTION) |
 365         PCI_HEADER_TYPE_BRIDGE;
 366     pci_set_word(dev->config + PCI_SEC_STATUS,
 367                  PCI_STATUS_66MHZ | PCI_STATUS_FAST_BACK);
 368
 369     /*
 370      * If we don't specify the name, the bus will be addressed as <id>.0, where
 371      * id is the device id.
 372      * Since PCI Bridge devices have a single bus each, we don't need the index:
 373      * let users address the bus using the device name.
 374      */
 375     if (!br->bus_name && dev->qdev.id && *dev->qdev.id) {
 376             br->bus_name = dev->qdev.id;
 377     }
 378
 379     qbus_init(sec_bus, sizeof(br->sec_bus), typename, DEVICE(dev),
 380               br->bus_name);
 381     sec_bus->parent_dev = dev;
 382     sec_bus->map_irq = br->map_irq ? br->map_irq : pci_swizzle_map_irq_fn;
 383     sec_bus->address_space_mem = &br->address_space_mem;
 384     memory_region_init(&br->address_space_mem, OBJECT(br), "pci_bridge_pci", UINT64_MAX);
 385     sec_bus->address_space_io = &br->address_space_io;
 386     memory_region_init(&br->address_space_io, OBJECT(br), "pci_bridge_io",
 387                        4 * GiB);
 388     br->windows = pci_bridge_region_init(br);
 389     QLIST_INIT(&sec_bus->child);
 390     QLIST_INSERT_HEAD(&parent->child, sec_bus, sibling);
 391 }
 392
 393 /* default qdev clean up function for PCI-to-PCI bridge */
 394 void pci_bridge_exitfn(PCIDevice *pci_dev)
 395 {
 396     PCIBridge *s = PCI_BRIDGE(pci_dev);
 397     assert(QLIST_EMPTY(&s->sec_bus.child));
 398     QLIST_REMOVE(&s->sec_bus, sibling);
 399     pci_bridge_region_del(s, s->windows);
 400     pci_bridge_region_cleanup(s, s->windows);
 401     /* object_unparent() is called automatically during device deletion */
 402 }
 403
 404 /*
 405  * before qdev initialization(qdev_init()), this function sets bus_name and
 406  * map_irq callback which are necessary for pci_bridge_initfn() to
 407  * initialize bus.
 408  */
 409 void pci_bridge_map_irq(PCIBridge *br, const char* bus_name,
 410                         pci_map_irq_fn map_irq)
 411 {
 412     br->map_irq = map_irq;
 413     br->bus_name = bus_name;
 414 }
 415
 416
 417 int pci_bridge_qemu_reserve_cap_init(PCIDevice *dev, int cap_offset,
 418                                      PCIResReserve res_reserve, Error **errp)
 419 {
 420     if (res_reserve.mem_pref_32 != (uint64_t)-1 &&
 421         res_reserve.mem_pref_64 != (uint64_t)-1) {
 422         error_setg(errp,
 423                    "PCI resource reserve cap: PREF32 and PREF64 conflict");
 424         return -EINVAL;
 425     }
 426
 427     if (res_reserve.mem_non_pref != (uint64_t)-1 &&
 428         res_reserve.mem_non_pref >= 4 * GiB) {
 429         error_setg(errp,
 430                    "PCI resource reserve cap: mem-reserve must be less than 4G");
 431         return -EINVAL;
 432     }
 433
 434     if (res_reserve.mem_pref_32 != (uint64_t)-1 &&
 435         res_reserve.mem_pref_32 >= 4 * GiB) {
 436         error_setg(errp,
 437                    "PCI resource reserve cap: pref32-reserve  must be less than 4G");
 438         return -EINVAL;
 439     }
 440
 441     if (res_reserve.bus == (uint32_t)-1 &&
 442         res_reserve.io == (uint64_t)-1 &&
 443         res_reserve.mem_non_pref == (uint64_t)-1 &&
 444         res_reserve.mem_pref_32 == (uint64_t)-1 &&
 445         res_reserve.mem_pref_64 == (uint64_t)-1) {
 446         return 0;
 447     }
 448
 449     size_t cap_len = sizeof(PCIBridgeQemuCap);
 450     PCIBridgeQemuCap cap = {
 451             .len = cap_len,
 452             .type = REDHAT_PCI_CAP_RESOURCE_RESERVE,
 453             .bus_res = cpu_to_le32(res_reserve.bus),
 454             .io = cpu_to_le64(res_reserve.io),
 455             .mem = cpu_to_le32(res_reserve.mem_non_pref),
 456             .mem_pref_32 = cpu_to_le32(res_reserve.mem_pref_32),
 457             .mem_pref_64 = cpu_to_le64(res_reserve.mem_pref_64)
 458     };
 459
 460     int offset = pci_add_capability(dev, PCI_CAP_ID_VNDR,
 461                                     cap_offset, cap_len, errp);
 462     if (offset < 0) {
 463         return offset;
 464     }
 465
 466     memcpy(dev->config + offset + PCI_CAP_FLAGS,
 467            (char *)&cap + PCI_CAP_FLAGS,
 468            cap_len - PCI_CAP_FLAGS);
 469     return 0;
 470 }
 471
 472 static void pci_bridge_class_init(ObjectClass *klass, void *data)
 473 {
 474     AcpiDevAmlIfClass *adevc = ACPI_DEV_AML_IF_CLASS(klass);
 475
 476     adevc->build_dev_aml = build_pci_bridge_aml;
 477 }
 478
 479 static const TypeInfo pci_bridge_type_info = {
 480     .name = TYPE_PCI_BRIDGE,
 481     .parent = TYPE_PCI_DEVICE,
 482     .instance_size = sizeof(PCIBridge),
 483     .class_init = pci_bridge_class_init,
 484     .abstract = true,
 485     .interfaces = (InterfaceInfo[]) {
 486         { TYPE_ACPI_DEV_AML_IF },
 487         { },
 488     },
 489 };
 490
 491 static void pci_bridge_register_types(void)
 492 {
 493     type_register_static(&pci_bridge_type_info);
 494 }
 495
 496 type_init(pci_bridge_register_types)