2 * QEMU<->ACPI BIOS PCI hotplug interface
4 * QEMU supports PCI hotplug via ACPI. This module
5 * implements the interface between QEMU and the ACPI BIOS.
6 * Interface specification - see docs/specs/acpi_pci_hotplug.txt
8 * Copyright (c) 2013, Red Hat Inc, Michael S. Tsirkin (mst@redhat.com)
9 * Copyright (c) 2006 Fabrice Bellard
11 * This library is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU Lesser General Public
13 * License version 2.1 as published by the Free Software Foundation.
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with this library; if not, see <http://www.gnu.org/licenses/>
23 * Contributions after 2012-01-13 are licensed under the terms of the
24 * GNU GPL, version 2 or (at your option) any later version.
27 #include "qemu/osdep.h"
28 #include "hw/acpi/pcihp.h"
30 #include "hw/pci-host/i440fx.h"
31 #include "hw/pci/pci.h"
32 #include "hw/pci/pci_bridge.h"
33 #include "hw/pci/pci_host.h"
34 #include "hw/pci/pcie_port.h"
35 #include "hw/pci-bridge/xio3130_downstream.h"
36 #include "hw/i386/acpi-build.h"
37 #include "hw/acpi/acpi.h"
38 #include "hw/pci/pci_bus.h"
39 #include "migration/vmstate.h"
40 #include "qapi/error.h"
41 #include "qom/qom-qobject.h"
44 #define ACPI_PCIHP_SIZE 0x0018
45 #define PCI_UP_BASE 0x0000
46 #define PCI_DOWN_BASE 0x0004
47 #define PCI_EJ_BASE 0x0008
48 #define PCI_RMV_BASE 0x000c
49 #define PCI_SEL_BASE 0x0010
50 #define PCI_AIDX_BASE 0x0014
52 typedef struct AcpiPciHpFind
{
57 static gint
g_cmp_uint32(gconstpointer a
, gconstpointer b
, gpointer user_data
)
62 static GSequence
*pci_acpi_index_list(void)
64 static GSequence
*used_acpi_index_list
;
66 if (!used_acpi_index_list
) {
67 used_acpi_index_list
= g_sequence_new(NULL
);
69 return used_acpi_index_list
;
72 static int acpi_pcihp_get_bsel(PCIBus
*bus
)
74 Error
*local_err
= NULL
;
75 uint64_t bsel
= object_property_get_uint(OBJECT(bus
), ACPI_PCIHP_PROP_BSEL
,
78 if (local_err
|| bsel
>= ACPI_PCIHP_MAX_HOTPLUG_BUS
) {
80 error_free(local_err
);
88 /* Assign BSEL property to all buses. In the future, this can be changed
89 * to only assign to buses that support hotplug.
91 static void *acpi_set_bsel(PCIBus
*bus
, void *opaque
)
93 unsigned *bsel_alloc
= opaque
;
96 if (qbus_is_hotpluggable(BUS(bus
))) {
97 bus_bsel
= g_malloc(sizeof *bus_bsel
);
99 *bus_bsel
= (*bsel_alloc
)++;
100 object_property_add_uint32_ptr(OBJECT(bus
), ACPI_PCIHP_PROP_BSEL
,
101 bus_bsel
, OBJ_PROP_FLAG_READ
);
107 static void acpi_set_pci_info(void)
109 static bool bsel_is_set
;
110 Object
*host
= acpi_get_i386_pci_host();
112 unsigned bsel_alloc
= ACPI_PCIHP_BSEL_DEFAULT
;
123 bus
= PCI_HOST_BRIDGE(host
)->bus
;
125 /* Scan all PCI buses. Set property to enable acpi based hotplug. */
126 pci_for_each_bus_depth_first(bus
, acpi_set_bsel
, NULL
, &bsel_alloc
);
130 static void acpi_pcihp_disable_root_bus(void)
132 Object
*host
= acpi_get_i386_pci_host();
135 bus
= PCI_HOST_BRIDGE(host
)->bus
;
136 if (bus
&& qbus_is_hotpluggable(BUS(bus
))) {
137 /* setting the hotplug handler to NULL makes the bus non-hotpluggable */
138 qbus_set_hotplug_handler(BUS(bus
), NULL
);
144 static void acpi_pcihp_test_hotplug_bus(PCIBus
*bus
, void *opaque
)
146 AcpiPciHpFind
*find
= opaque
;
147 if (find
->bsel
== acpi_pcihp_get_bsel(bus
)) {
152 static PCIBus
*acpi_pcihp_find_hotplug_bus(AcpiPciHpState
*s
, int bsel
)
154 AcpiPciHpFind find
= { .bsel
= bsel
, .bus
= NULL
};
160 pci_for_each_bus(s
->root
, acpi_pcihp_test_hotplug_bus
, &find
);
162 /* Make bsel 0 eject root bus if bsel property is not set,
163 * for compatibility with non acpi setups.
164 * TODO: really needed?
166 if (!bsel
&& !find
.bus
) {
171 * Check if find.bus is actually hotpluggable. If bsel is set to
172 * NULL for example on the root bus in order to make it
173 * non-hotpluggable, find.bus will match the root bus when bsel
174 * is 0. See acpi_pcihp_test_hotplug_bus() above. Since the
175 * bus is not hotpluggable however, we should not select the bus.
176 * Instead, we should set find.bus to NULL in that case. In the check
177 * below, we generalize this case for all buses, not just the root bus.
178 * The callers of this function check for a null return value and
179 * handle them appropriately.
181 if (find
.bus
&& !qbus_is_hotpluggable(BUS(find
.bus
))) {
187 static bool acpi_pcihp_pc_no_hotplug(AcpiPciHpState
*s
, PCIDevice
*dev
)
189 PCIDeviceClass
*pc
= PCI_DEVICE_GET_CLASS(dev
);
190 DeviceClass
*dc
= DEVICE_GET_CLASS(dev
);
192 * ACPI doesn't allow hotplug of bridge devices. Don't allow
193 * hot-unplug of bridge devices unless they were added by hotplug
194 * (and so, not described by acpi).
196 return (pc
->is_bridge
&& !dev
->qdev
.hotplugged
) || !dc
->hotpluggable
;
199 static void acpi_pcihp_eject_slot(AcpiPciHpState
*s
, unsigned bsel
, unsigned slots
)
201 HotplugHandler
*hotplug_ctrl
;
202 BusChild
*kid
, *next
;
203 int slot
= ctz32(slots
);
204 PCIBus
*bus
= acpi_pcihp_find_hotplug_bus(s
, bsel
);
206 trace_acpi_pci_eject_slot(bsel
, slot
);
208 if (!bus
|| slot
> 31) {
212 /* Mark request as complete */
213 s
->acpi_pcihp_pci_status
[bsel
].down
&= ~(1U << slot
);
214 s
->acpi_pcihp_pci_status
[bsel
].up
&= ~(1U << slot
);
216 QTAILQ_FOREACH_SAFE(kid
, &bus
->qbus
.children
, sibling
, next
) {
217 DeviceState
*qdev
= kid
->child
;
218 PCIDevice
*dev
= PCI_DEVICE(qdev
);
219 if (PCI_SLOT(dev
->devfn
) == slot
) {
220 if (!acpi_pcihp_pc_no_hotplug(s
, dev
)) {
222 * partially_hotplugged is used by virtio-net failover:
223 * failover has asked the guest OS to unplug the device
224 * but we need to keep some references to the device
225 * to be able to plug it back in case of failure so
226 * we don't execute hotplug_handler_unplug().
228 if (dev
->partially_hotplugged
) {
230 * pending_deleted_event is set to true when
231 * virtio-net failover asks to unplug the device,
232 * and set to false here when the operation is done
233 * This is used by the migration loop to detect the
234 * end of the operation and really start the migration.
236 qdev
->pending_deleted_event
= false;
238 hotplug_ctrl
= qdev_get_hotplug_handler(qdev
);
239 hotplug_handler_unplug(hotplug_ctrl
, qdev
, &error_abort
);
240 object_unparent(OBJECT(qdev
));
247 static void acpi_pcihp_update_hotplug_bus(AcpiPciHpState
*s
, int bsel
)
249 BusChild
*kid
, *next
;
250 PCIBus
*bus
= acpi_pcihp_find_hotplug_bus(s
, bsel
);
252 /* Execute any pending removes during reset */
253 while (s
->acpi_pcihp_pci_status
[bsel
].down
) {
254 acpi_pcihp_eject_slot(s
, bsel
, s
->acpi_pcihp_pci_status
[bsel
].down
);
257 s
->acpi_pcihp_pci_status
[bsel
].hotplug_enable
= ~0;
262 QTAILQ_FOREACH_SAFE(kid
, &bus
->qbus
.children
, sibling
, next
) {
263 DeviceState
*qdev
= kid
->child
;
264 PCIDevice
*pdev
= PCI_DEVICE(qdev
);
265 int slot
= PCI_SLOT(pdev
->devfn
);
267 if (acpi_pcihp_pc_no_hotplug(s
, pdev
)) {
268 s
->acpi_pcihp_pci_status
[bsel
].hotplug_enable
&= ~(1U << slot
);
273 static void acpi_pcihp_update(AcpiPciHpState
*s
)
277 for (i
= 0; i
< ACPI_PCIHP_MAX_HOTPLUG_BUS
; ++i
) {
278 acpi_pcihp_update_hotplug_bus(s
, i
);
282 void acpi_pcihp_reset(AcpiPciHpState
*s
, bool acpihp_root_off
)
284 if (acpihp_root_off
) {
285 acpi_pcihp_disable_root_bus();
288 acpi_pcihp_update(s
);
291 #define ONBOARD_INDEX_MAX (16 * 1024 - 1)
293 void acpi_pcihp_device_pre_plug_cb(HotplugHandler
*hotplug_dev
,
294 DeviceState
*dev
, Error
**errp
)
296 PCIDevice
*pdev
= PCI_DEVICE(dev
);
298 /* Only hotplugged devices need the hotplug capability. */
299 if (dev
->hotplugged
&&
300 acpi_pcihp_get_bsel(pci_get_bus(pdev
)) < 0) {
301 error_setg(errp
, "Unsupported bus. Bus doesn't have property '"
302 ACPI_PCIHP_PROP_BSEL
"' set");
307 * capped by systemd (see: udev-builtin-net_id.c)
308 * as it's the only known user honor it to avoid users
309 * misconfigure QEMU and then wonder why acpi-index doesn't work
311 if (pdev
->acpi_index
> ONBOARD_INDEX_MAX
) {
312 error_setg(errp
, "acpi-index should be less or equal to %u",
318 * make sure that acpi-index is unique across all present PCI devices
320 if (pdev
->acpi_index
) {
321 GSequence
*used_indexes
= pci_acpi_index_list();
323 if (g_sequence_lookup(used_indexes
, GINT_TO_POINTER(pdev
->acpi_index
),
324 g_cmp_uint32
, NULL
)) {
325 error_setg(errp
, "a PCI device with acpi-index = %" PRIu32
326 " already exist", pdev
->acpi_index
);
329 g_sequence_insert_sorted(used_indexes
,
330 GINT_TO_POINTER(pdev
->acpi_index
),
335 void acpi_pcihp_device_plug_cb(HotplugHandler
*hotplug_dev
, AcpiPciHpState
*s
,
336 DeviceState
*dev
, Error
**errp
)
338 PCIDevice
*pdev
= PCI_DEVICE(dev
);
339 int slot
= PCI_SLOT(pdev
->devfn
);
344 /* Don't send event when device is enabled during qemu machine creation:
345 * it is present on boot, no hotplug event is necessary. We do send an
346 * event when the device is disabled later. */
347 if (!dev
->hotplugged
) {
349 * Overwrite the default hotplug handler with the ACPI PCI one
350 * for cold plugged bridges only.
352 if (!s
->legacy_piix
&&
353 object_dynamic_cast(OBJECT(dev
), TYPE_PCI_BRIDGE
)) {
354 PCIBus
*sec
= pci_bridge_get_sec_bus(PCI_BRIDGE(pdev
));
356 /* Remove all hot-plug handlers if hot-plug is disabled on slot */
357 if (object_dynamic_cast(OBJECT(dev
), TYPE_PCIE_SLOT
) &&
358 !PCIE_SLOT(pdev
)->hotplug
) {
359 qbus_set_hotplug_handler(BUS(sec
), NULL
);
363 qbus_set_hotplug_handler(BUS(sec
), OBJECT(hotplug_dev
));
364 /* We don't have to overwrite any other hotplug handler yet */
365 assert(QLIST_EMPTY(&sec
->child
));
371 bus
= pci_get_bus(pdev
);
372 bridge
= pci_bridge_get_device(bus
);
373 if (object_dynamic_cast(OBJECT(bridge
), TYPE_PCIE_ROOT_PORT
) ||
374 object_dynamic_cast(OBJECT(bridge
), TYPE_XIO3130_DOWNSTREAM
)) {
375 pcie_cap_slot_enable_power(bridge
);
378 bsel
= acpi_pcihp_get_bsel(bus
);
380 s
->acpi_pcihp_pci_status
[bsel
].up
|= (1U << slot
);
381 acpi_send_event(DEVICE(hotplug_dev
), ACPI_PCI_HOTPLUG_STATUS
);
384 void acpi_pcihp_device_unplug_cb(HotplugHandler
*hotplug_dev
, AcpiPciHpState
*s
,
385 DeviceState
*dev
, Error
**errp
)
387 PCIDevice
*pdev
= PCI_DEVICE(dev
);
389 trace_acpi_pci_unplug(PCI_SLOT(pdev
->devfn
),
390 acpi_pcihp_get_bsel(pci_get_bus(pdev
)));
393 * clean up acpi-index so it could reused by another device
395 if (pdev
->acpi_index
) {
396 GSequence
*used_indexes
= pci_acpi_index_list();
398 g_sequence_remove(g_sequence_lookup(used_indexes
,
399 GINT_TO_POINTER(pdev
->acpi_index
),
400 g_cmp_uint32
, NULL
));
406 void acpi_pcihp_device_unplug_request_cb(HotplugHandler
*hotplug_dev
,
407 AcpiPciHpState
*s
, DeviceState
*dev
,
410 PCIDevice
*pdev
= PCI_DEVICE(dev
);
411 int slot
= PCI_SLOT(pdev
->devfn
);
412 int bsel
= acpi_pcihp_get_bsel(pci_get_bus(pdev
));
414 trace_acpi_pci_unplug_request(bsel
, slot
);
417 error_setg(errp
, "Unsupported bus. Bus doesn't have property '"
418 ACPI_PCIHP_PROP_BSEL
"' set");
423 * pending_deleted_event is used by virtio-net failover to detect the
424 * end of the unplug operation, the flag is set to false in
425 * acpi_pcihp_eject_slot() when the operation is completed.
427 pdev
->qdev
.pending_deleted_event
= true;
428 s
->acpi_pcihp_pci_status
[bsel
].down
|= (1U << slot
);
429 acpi_send_event(DEVICE(hotplug_dev
), ACPI_PCI_HOTPLUG_STATUS
);
432 static uint64_t pci_read(void *opaque
, hwaddr addr
, unsigned int size
)
434 AcpiPciHpState
*s
= opaque
;
436 int bsel
= s
->hotplug_select
;
438 if (bsel
< 0 || bsel
>= ACPI_PCIHP_MAX_HOTPLUG_BUS
) {
444 val
= s
->acpi_pcihp_pci_status
[bsel
].up
;
445 if (!s
->legacy_piix
) {
446 s
->acpi_pcihp_pci_status
[bsel
].up
= 0;
448 trace_acpi_pci_up_read(val
);
451 val
= s
->acpi_pcihp_pci_status
[bsel
].down
;
452 trace_acpi_pci_down_read(val
);
455 trace_acpi_pci_features_read(val
);
458 val
= s
->acpi_pcihp_pci_status
[bsel
].hotplug_enable
;
459 trace_acpi_pci_rmv_read(val
);
462 val
= s
->hotplug_select
;
463 trace_acpi_pci_sel_read(val
);
468 trace_acpi_pci_acpi_index_read(val
);
477 static void pci_write(void *opaque
, hwaddr addr
, uint64_t data
,
482 BusChild
*kid
, *next
;
483 AcpiPciHpState
*s
= opaque
;
489 * fetch acpi-index for specified slot so that follow up read from
490 * PCI_AIDX_BASE can return it to guest
494 if (s
->hotplug_select
>= ACPI_PCIHP_MAX_HOTPLUG_BUS
) {
498 bus
= acpi_pcihp_find_hotplug_bus(s
, s
->hotplug_select
);
502 QTAILQ_FOREACH_SAFE(kid
, &bus
->qbus
.children
, sibling
, next
) {
503 Object
*o
= OBJECT(kid
->child
);
504 PCIDevice
*dev
= PCI_DEVICE(o
);
505 if (PCI_SLOT(dev
->devfn
) == slot
) {
506 s
->acpi_index
= object_property_get_uint(o
, "acpi-index", NULL
);
510 trace_acpi_pci_acpi_index_write(s
->hotplug_select
, slot
, s
->acpi_index
);
513 if (s
->hotplug_select
>= ACPI_PCIHP_MAX_HOTPLUG_BUS
) {
516 acpi_pcihp_eject_slot(s
, s
->hotplug_select
, data
);
517 trace_acpi_pci_ej_write(addr
, data
);
520 s
->hotplug_select
= s
->legacy_piix
? ACPI_PCIHP_BSEL_DEFAULT
: data
;
521 trace_acpi_pci_sel_write(addr
, data
);
527 static const MemoryRegionOps acpi_pcihp_io_ops
= {
530 .endianness
= DEVICE_LITTLE_ENDIAN
,
532 .min_access_size
= 4,
533 .max_access_size
= 4,
537 void acpi_pcihp_init(Object
*owner
, AcpiPciHpState
*s
, PCIBus
*root_bus
,
538 MemoryRegion
*address_space_io
, bool bridges_enabled
,
541 s
->io_len
= ACPI_PCIHP_SIZE
;
542 s
->io_base
= io_base
;
545 s
->legacy_piix
= !bridges_enabled
;
547 memory_region_init_io(&s
->io
, owner
, &acpi_pcihp_io_ops
, s
,
548 "acpi-pci-hotplug", s
->io_len
);
549 memory_region_add_subregion(address_space_io
, s
->io_base
, &s
->io
);
551 object_property_add_uint16_ptr(owner
, ACPI_PCIHP_IO_BASE_PROP
, &s
->io_base
,
553 object_property_add_uint16_ptr(owner
, ACPI_PCIHP_IO_LEN_PROP
, &s
->io_len
,
557 const VMStateDescription vmstate_acpi_pcihp_pci_status
= {
558 .name
= "acpi_pcihp_pci_status",
560 .minimum_version_id
= 1,
561 .fields
= (VMStateField
[]) {
562 VMSTATE_UINT32(up
, AcpiPciHpPciStatus
),
563 VMSTATE_UINT32(down
, AcpiPciHpPciStatus
),
564 VMSTATE_END_OF_LIST()