[mirror_qemu.git] / hw / pci / pci_bridge.c

/*
 * QEMU PCI bus manager
 *
 * Copyright (c) 2004 Fabrice Bellard
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to dea

 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM

 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
/*
 * split out from pci.c
 * Copyright (c) 2010 Isaku Yamahata <yamahata at valinux co jp>
 *                    VA Linux Systems Japan K.K.
 */

#include "qemu/osdep.h"
#include "qemu/units.h"
#include "hw/pci/pci_bridge.h"
#include "hw/pci/pci_bus.h"
#include "qemu/module.h"
#include "qemu/range.h"
#include "qapi/error.h"

/* PCI bridge subsystem vendor ID helper functions */
#define PCI_SSVID_SIZEOF        8
#define PCI_SSVID_SVID          4
#define PCI_SSVID_SSID          6

int pci_bridge_ssvid_init(PCIDevice *dev, uint8_t offset,
                          uint16_t svid, uint16_t ssid,
                          Error **errp)
{
    int pos;

    pos = pci_add_capability(dev, PCI_CAP_ID_SSVID, offset,
                             PCI_SSVID_SIZEOF, errp);
    if (pos < 0) {
        return pos;
    }

    pci_set_word(dev->config + pos + PCI_SSVID_SVID, svid);
    pci_set_word(dev->config + pos + PCI_SSVID_SSID, ssid);
    return pos;
}

/* Accessor function to get parent bridge device from pci bus. */
PCIDevice *pci_bridge_get_device(PCIBus *bus)
{
    return bus->parent_dev;
}

/* Accessor function to get secondary bus from pci-to-pci bridge device */
PCIBus *pci_bridge_get_sec_bus(PCIBridge *br)
{
    return &br->sec_bus;
}

static uint32_t pci_config_get_io_base(const PCIDevice *d,
                                       uint32_t base, uint32_t base_upper16)
{
    uint32_t val;

    val = ((uint32_t)d->config[base] & PCI_IO_RANGE_MASK) << 8;
    if (d->config[base] & PCI_IO_RANGE_TYPE_32) {
        val |= (uint32_t)pci_get_word(d->config + base_upper16) << 16;
    }
    return val;
}

static pcibus_t pci_config_get_memory_base(const PCIDevice *d, uint32_t base)
{
    return ((pcibus_t)pci_get_word(d->config + base) & PCI_MEMORY_RANGE_MASK)
        << 16;
}

static pcibus_t pci_config_get_pref_base(const PCIDevice *d,
                                         uint32_t base, uint32_t upper)
{
    pcibus_t tmp;
    pcibus_t val;

    tmp = (pcibus_t)pci_get_word(d->config + base);
    val = (tmp & PCI_PREF_RANGE_MASK) << 16;
    if (tmp & PCI_PREF_RANGE_TYPE_64) {
        val |= (pcibus_t)pci_get_long(d->config + upper) << 32;
    }
    return val;
}

/* accessor function to get bridge filtering base address */
pcibus_t pci_bridge_get_base(const PCIDevice *bridge, uint8_t type)
{
    pcibus_t base;
    if (type & PCI_BASE_ADDRESS_SPACE_IO) {
        base = pci_config_get_io_base(bridge,
                                      PCI_IO_BASE, PCI_IO_BASE_UPPER16);
    } else {
        if (type & PCI_BASE_ADDRESS_MEM_PREFETCH) {
            base = pci_config_get_pref_base(
                bridge, PCI_PREF_MEMORY_BASE, PCI_PREF_BASE_UPPER32);
        } else {
            base = pci_config_get_memory_base(bridge, PCI_MEMORY_BASE);
        }
    }

    return base;
}

/* accessor function to get bridge filtering limit */
pcibus_t pci_bridge_get_limit(const PCIDevice *bridge, uint8_t type)
{
    pcibus_t limit;
    if (type & PCI_BASE_ADDRESS_SPACE_IO) {
        limit = pci_config_get_io_base(bridge,
                                      PCI_IO_LIMIT, PCI_IO_LIMIT_UPPER16);
        limit |= 0xfff;         /* PCI bridge spec 3.2.5.6. */
    } else {
        if (type & PCI_BASE_ADDRESS_MEM_PREFETCH) {
            limit = pci_config_get_pref_base(
                bridge, PCI_PREF_MEMORY_LIMIT, PCI_PREF_LIMIT_UPPER32);
        } else {
            limit = pci_config_get_memory_base(bridge, PCI_MEMORY_LIMIT);
        }
        limit |= 0xfffff;       /* PCI bridge spec 3.2.5.{1, 8}. */
    }
    return limit;
}

static void pci_bridge_init_alias(PCIBridge *bridge, MemoryRegion *alias,
                                  uint8_t type, const char *name,
                                  MemoryRegion *space,
                                  MemoryRegion *parent_space,
                                  bool enabled)
{
    PCIDevice *bridge_dev = PCI_DEVICE(bridge);
    pcibus_t base = pci_bridge_get_base(bridge_dev, type);
    pcibus_t limit = pci_bridge_get_limit(bridge_dev, type);
    /* TODO: this doesn't handle base = 0 limit = 2^64 - 1 correctly.
     * Apparently no way to do this with existing memory APIs. */
    pcibus_t size = enabled && limit >= base ? limit + 1 - base : 0;

    memory_region_init_alias(alias, OBJECT(bridge), name, space, base, size);
    memory_region_add_subregion_overlap(parent_space, base, alias, 1);
}

static void pci_bridge_init_vga_aliases(PCIBridge *br, PCIBus *parent,
                                        MemoryRegion *alias_vga)
{
    PCIDevice *pd = PCI_DEVICE(br);
    uint16_t brctl = pci_get_word(pd->config + PCI_BRIDGE_CONTROL);

    memory_region_init_alias(&alias_vga[QEMU_PCI_VGA_IO_LO], OBJECT(br),
                             "pci_bridge_vga_io_lo", &br->address_space_io,
                             QEMU_PCI_VGA_IO_LO_BASE, QEMU_PCI_VGA_IO_LO_SIZE);
    memory_region_init_alias(&alias_vga[QEMU_PCI_VGA_IO_HI], OBJECT(br),
                             "pci_bridge_vga_io_hi", &br->address_space_io,
                             QEMU_PCI_VGA_IO_HI_BASE, QEMU_PCI_VGA_IO_HI_SIZE);
    memory_region_init_alias(&alias_vga[QEMU_PCI_VGA_MEM], OBJECT(br),
                             "pci_bridge_vga_mem", &br->address_space_mem,
                             QEMU_PCI_VGA_MEM_BASE, QEMU_PCI_VGA_MEM_SIZE);

    if (brctl & PCI_BRIDGE_CTL_VGA) {
        pci_register_vga(pd, &alias_vga[QEMU_PCI_VGA_MEM],
                         &alias_vga[QEMU_PCI_VGA_IO_LO],
                         &alias_vga[QEMU_PCI_VGA_IO_HI]);
    }
}

static PCIBridgeWindows *pci_bridge_region_init(PCIBridge *br)
{
    PCIDevice *pd = PCI_DEVICE(br);
    PCIBus *parent = pci_get_bus(pd);
    PCIBridgeWindows *w = g_new(PCIBridgeWindows, 1);
    uint16_t cmd = pci_get_word(pd->config + PCI_COMMAND);

    pci_bridge_init_alias(br, &w->alias_pref_mem,
                          PCI_BASE_ADDRESS_MEM_PREFETCH,
                          "pci_bridge_pref_mem",
                          &br->address_space_mem,
                          parent->address_space_mem,
                          cmd & PCI_COMMAND_MEMORY);
    pci_bridge_init_alias(br, &w->alias_mem,
                          PCI_BASE_ADDRESS_SPACE_MEMORY,
                          "pci_bridge_mem",
                          &br->address_space_mem,
                          parent->address_space_mem,
                          cmd & PCI_COMMAND_MEMORY);
    pci_bridge_init_alias(br, &w->alias_io,
                          PCI_BASE_ADDRESS_SPACE_IO,
                          "pci_bridge_io",
                          &br->address_space_io,
                          parent->address_space_io,
                          cmd & PCI_COMMAND_IO);

    pci_bridge_init_vga_aliases(br, parent, w->alias_vga);

    return w;
}

static void pci_bridge_region_del(PCIBridge *br, PCIBridgeWindows *w)
{
    PCIDevice *pd = PCI_DEVICE(br);
    PCIBus *parent = pci_get_bus(pd);

    memory_region_del_subregion(parent->address_space_io, &w->alias_io);
    memory_region_del_subregion(parent->address_space_mem, &w->alias_mem);
    memory_region_del_subregion(parent->address_space_mem, &w->alias_pref_mem);
    pci_unregister_vga(pd);
}

static void pci_bridge_region_cleanup(PCIBridge *br, PCIBridgeWindows *w)
{
    object_unparent(OBJECT(&w->alias_io));
    object_unparent(OBJECT(&w->alias_mem));
    object_unparent(OBJECT(&w->alias_pref_mem));
    object_unparent(OBJECT(&w->alias_vga[QEMU_PCI_VGA_IO_LO]));
    object_unparent(OBJECT(&w->alias_vga[QEMU_PCI_VGA_IO_HI]));
    object_unparent(OBJECT(&w->alias_vga[QEMU_PCI_VGA_MEM]));
    g_free(w);
}

void pci_bridge_update_mappings(PCIBridge *br)
{
    PCIBridgeWindows *w = br->windows;

    /* Make updates atomic to: handle the case of one VCPU updating the bridge
     * while another accesses an unaffected region. */
    memory_region_transaction_begin();
    pci_bridge_region_del(br, br->windows);
    pci_bridge_region_cleanup(br, w);
    br->windows = pci_bridge_region_init(br);
    memory_region_transaction_commit();
}

/* default write_config function for PCI-to-PCI bridge */
void pci_bridge_write_config(PCIDevice *d,
                             uint32_t address, uint32_t val, int len)
{
    PCIBridge *s = PCI_BRIDGE(d);
    uint16_t oldctl = pci_get_word(d->config + PCI_BRIDGE_CONTROL);
    uint16_t newctl;

    pci_default_write_config(d, address, val, len);

    if (ranges_overlap(address, len, PCI_COMMAND, 2) ||

        /* io base/limit */
        ranges_overlap(address, len, PCI_IO_BASE, 2) ||

        /* memory base/limit, prefetchable base/limit and
           io base/limit upper 16 */
        ranges_overlap(address, len, PCI_MEMORY_BASE, 20) ||

        /* vga enable */
        ranges_overlap(address, len, PCI_BRIDGE_CONTROL, 2)) {
        pci_bridge_update_mappings(s);
    }

    newctl = pci_get_word(d->config + PCI_BRIDGE_CONTROL);
    if (~oldctl & newctl & PCI_BRIDGE_CTL_BUS_RESET) {
        /* Trigger hot reset on 0->1 transition. */
        qbus_reset_all(BUS(&s->sec_bus));
    }
}

void pci_bridge_disable_base_limit(PCIDevice *dev)
{
    uint8_t *conf = dev->config;

    pci_byte_test_and_set_mask(conf + PCI_IO_BASE,
                               PCI_IO_RANGE_MASK & 0xff);
    pci_byte_test_and_clear_mask(conf + PCI_IO_LIMIT,
                                 PCI_IO_RANGE_MASK & 0xff);
    pci_word_test_and_set_mask(conf + PCI_MEMORY_BASE,
                               PCI_MEMORY_RANGE_MASK & 0xffff);
    pci_word_test_and_clear_mask(conf + PCI_MEMORY_LIMIT,
                                 PCI_MEMORY_RANGE_MASK & 0xffff);
    pci_word_test_and_set_mask(conf + PCI_PREF_MEMORY_BASE,
                               PCI_PREF_RANGE_MASK & 0xffff);
    pci_word_test_and_clear_mask(conf + PCI_PREF_MEMORY_LIMIT,
                                 PCI_PREF_RANGE_MASK & 0xffff);
    pci_set_long(conf + PCI_PREF_BASE_UPPER32, 0);
    pci_set_long(conf + PCI_PREF_LIMIT_UPPER32, 0);
}

/* reset bridge specific configuration registers */
void pci_bridge_reset(DeviceState *qdev)
{
    PCIDevice *dev = PCI_DEVICE(qdev);
    uint8_t *conf = dev->config;

    conf[PCI_PRIMARY_BUS] = 0;
    conf[PCI_SECONDARY_BUS] = 0;
    conf[PCI_SUBORDINATE_BUS] = 0;
    conf[PCI_SEC_LATENCY_TIMER] = 0;

    /*
     * the default values for base/limit registers aren't specified
     * in the PCI-to-PCI-bridge spec. So we don't touch them here.
     * Each implementation can override it.
     * typical implementation does
     * zero base/limit registers or
     * disable forwarding: pci_bridge_disable_base_limit()
     * If disable forwarding is wanted, call pci_bridge_disable_base_limit()
     * after this function.
     */
    pci_byte_test_and_clear_mask(conf + PCI_IO_BASE,
                                 PCI_IO_RANGE_MASK & 0xff);
    pci_byte_test_and_clear_mask(conf + PCI_IO_LIMIT,
                                 PCI_IO_RANGE_MASK & 0xff);
    pci_word_test_and_clear_mask(conf + PCI_MEMORY_BASE,
                                 PCI_MEMORY_RANGE_MASK & 0xffff);
    pci_word_test_and_clear_mask(conf + PCI_MEMORY_LIMIT,
                                 PCI_MEMORY_RANGE_MASK & 0xffff);
    pci_word_test_and_clear_mask(conf + PCI_PREF_MEMORY_BASE,
                                 PCI_PREF_RANGE_MASK & 0xffff);
    pci_word_test_and_clear_mask(conf + PCI_PREF_MEMORY_LIMIT,
                                 PCI_PREF_RANGE_MASK & 0xffff);
    pci_set_long(conf + PCI_PREF_BASE_UPPER32, 0);
    pci_set_long(conf + PCI_PREF_LIMIT_UPPER32, 0);

    pci_set_word(conf + PCI_BRIDGE_CONTROL, 0);
}

/* default qdev initialization function for PCI-to-PCI bridge */
void pci_bridge_initfn(PCIDevice *dev, const char *typename)
{
    PCIBus *parent = pci_get_bus(dev);
    PCIBridge *br = PCI_BRIDGE(dev);
    PCIBus *sec_bus = &br->sec_bus;

    pci_word_test_and_set_mask(dev->config + PCI_STATUS,
                               PCI_STATUS_66MHZ | PCI_STATUS_FAST_BACK);

    /*
     * TODO: We implement VGA Enable in the Bridge Control Register
     * therefore per the PCI to PCI bridge spec we must also implement
     * VGA Palette Snooping.  When done, set this bit writable:
     *
     * pci_word_test_and_set_mask(dev->wmask + PCI_COMMAND,
     *                            PCI_COMMAND_VGA_PALETTE);
     */

    pci_config_set_class(dev->config, PCI_CLASS_BRIDGE_PCI);
    dev->config[PCI_HEADER_TYPE] =
        (dev->config[PCI_HEADER_TYPE] & PCI_HEADER_TYPE_MULTI_FUNCTION) |
        PCI_HEADER_TYPE_BRIDGE;
    pci_set_word(dev->config + PCI_SEC_STATUS,
                 PCI_STATUS_66MHZ | PCI_STATUS_FAST_BACK);

    /*
     * If we don't specify the name, the bus will be addressed as <id>.0, where
     * id is the device id.
     * Since PCI Bridge devices have a single bus each, we don't need the index:
     * let users address the bus using the device name.
     */
    if (!br->bus_name && dev->qdev.id && *dev->qdev.id) {
            br->bus_name = dev->qdev.id;
    }

    qbus_init(sec_bus, sizeof(br->sec_bus), typename, DEVICE(dev),
              br->bus_name);
    sec_bus->parent_dev = dev;
    sec_bus->map_irq = br->map_irq ? br->map_irq : pci_swizzle_map_irq_fn;
    sec_bus->address_space_mem = &br->address_space_mem;
    memory_region_init(&br->address_space_mem, OBJECT(br), "pci_bridge_pci", UINT64_MAX);
    sec_bus->address_space_io = &br->address_space_io;
    memory_region_init(&br->address_space_io, OBJECT(br), "pci_bridge_io",
                       4 * GiB);
    br->windows = pci_bridge_region_init(br);
    QLIST_INIT(&sec_bus->child);
    QLIST_INSERT_HEAD(&parent->child, sec_bus, sibling);
}

/* default qdev clean up function for PCI-to-PCI bridge */
void pci_bridge_exitfn(PCIDevice *pci_dev)
{
    PCIBridge *s = PCI_BRIDGE(pci_dev);
    assert(QLIST_EMPTY(&s->sec_bus.child));
    QLIST_REMOVE(&s->sec_bus, sibling);
    pci_bridge_region_del(s, s->windows);
    pci_bridge_region_cleanup(s, s->windows);
    /* object_unparent() is called automatically during device deletion */
}

/*
 * before qdev initialization(qdev_init()), this function sets bus_name and
 * map_irq callback which are necessary for pci_bridge_initfn() to
 * initialize bus.
 */
void pci_bridge_map_irq(PCIBridge *br, const char* bus_name,
                        pci_map_irq_fn map_irq)
{
    br->map_irq = map_irq;
    br->bus_name = bus_name;
}


int pci_bridge_qemu_reserve_cap_init(PCIDevice *dev, int cap_offset,
                                     PCIResReserve res_reserve, Error **errp)
{
    if (res_reserve.mem_pref_32 != (uint64_t)-1 &&
        res_reserve.mem_pref_64 != (uint64_t)-1) {
        error_setg(errp,
                   "PCI resource reserve cap: PREF32 and PREF64 conflict");
        return -EINVAL;
    }

    if (res_reserve.mem_non_pref != (uint64_t)-1 &&
        res_reserve.mem_non_pref >= 4 * GiB) {
        error_setg(errp,
                   "PCI resource reserve cap: mem-reserve must be less than 4G");
        return -EINVAL;
    }

    if (res_reserve.mem_pref_32 != (uint64_t)-1 &&
        res_reserve.mem_pref_32 >= 4 * GiB) {
        error_setg(errp,
                   "PCI resource reserve cap: pref32-reserve  must be less than 4G");
        return -EINVAL;
    }

    if (res_reserve.bus == (uint32_t)-1 &&
        res_reserve.io == (uint64_t)-1 &&
        res_reserve.mem_non_pref == (uint64_t)-1 &&
        res_reserve.mem_pref_32 == (uint64_t)-1 &&
        res_reserve.mem_pref_64 == (uint64_t)-1) {
        return 0;
    }

    size_t cap_len = sizeof(PCIBridgeQemuCap);
    PCIBridgeQemuCap cap = {
            .len = cap_len,
            .type = REDHAT_PCI_CAP_RESOURCE_RESERVE,
            .bus_res = cpu_to_le32(res_reserve.bus),
            .io = cpu_to_le64(res_reserve.io),
            .mem = cpu_to_le32(res_reserve.mem_non_pref),
            .mem_pref_32 = cpu_to_le32(res_reserve.mem_pref_32),
            .mem_pref_64 = cpu_to_le64(res_reserve.mem_pref_64)
    };

    int offset = pci_add_capability(dev, PCI_CAP_ID_VNDR,
                                    cap_offset, cap_len, errp);
    if (offset < 0) {
        return offset;
    }

    memcpy(dev->config + offset + PCI_CAP_FLAGS,
           (char *)&cap + PCI_CAP_FLAGS,
           cap_len - PCI_CAP_FLAGS);
    return 0;
}

static const TypeInfo pci_bridge_type_info = {
    .name = TYPE_PCI_BRIDGE,
    .parent = TYPE_PCI_DEVICE,
    .instance_size = sizeof(PCIBridge),
    .abstract = true,
};

static void pci_bridge_register_types(void)
{
    type_register_static(&pci_bridge_type_info);
}

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