xref: /openbmc/qemu/include/hw/acpi/pcihp.h (revision cc1838c2)
1 /*
2  * QEMU<->ACPI BIOS PCI hotplug interface
3  *
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
7  *
8  * Copyright (c) 2013, Red Hat Inc, Michael S. Tsirkin (mst@redhat.com)
9  * Copyright (c) 2006 Fabrice Bellard
10  *
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.
14  *
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.
19  *
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/>
22  *
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.
25  */
26 
27 #ifndef HW_ACPI_PCIHP_H
28 #define HW_ACPI_PCIHP_H
29 
30 #include "hw/acpi/acpi.h"
31 #include "hw/hotplug.h"
32 
33 #define ACPI_PCIHP_IO_BASE_PROP "acpi-pcihp-io-base"
34 #define ACPI_PCIHP_IO_LEN_PROP "acpi-pcihp-io-len"
35 
36 typedef struct AcpiPciHpPciStatus {
37     uint32_t up;
38     uint32_t down;
39     uint32_t hotplug_enable;
40 } AcpiPciHpPciStatus;
41 
42 #define ACPI_PCIHP_PROP_BSEL "acpi-pcihp-bsel"
43 #define ACPI_PCIHP_MAX_HOTPLUG_BUS 256
44 #define ACPI_PCIHP_BSEL_DEFAULT 0x0
45 
46 typedef struct AcpiPciHpState {
47     AcpiPciHpPciStatus acpi_pcihp_pci_status[ACPI_PCIHP_MAX_HOTPLUG_BUS];
48     uint32_t hotplug_select;
49     uint32_t acpi_index;
50     PCIBus *root;
51     MemoryRegion io;
52     bool legacy_piix;
53     uint16_t io_base;
54     uint16_t io_len;
55 } AcpiPciHpState;
56 
57 void acpi_pcihp_init(Object *owner, AcpiPciHpState *, PCIBus *root,
58                      MemoryRegion *address_space_io, bool bridges_enabled,
59                      uint16_t io_base);
60 
61 void acpi_pcihp_device_pre_plug_cb(HotplugHandler *hotplug_dev,
62                                    DeviceState *dev, Error **errp);
63 void acpi_pcihp_device_plug_cb(HotplugHandler *hotplug_dev, AcpiPciHpState *s,
64                                DeviceState *dev, Error **errp);
65 void acpi_pcihp_device_unplug_cb(HotplugHandler *hotplug_dev, AcpiPciHpState *s,
66                                  DeviceState *dev, Error **errp);
67 void acpi_pcihp_device_unplug_request_cb(HotplugHandler *hotplug_dev,
68                                          AcpiPciHpState *s, DeviceState *dev,
69                                          Error **errp);
70 
71 /* Called on reset */
72 void acpi_pcihp_reset(AcpiPciHpState *s, bool acpihp_root_off);
73 
74 extern const VMStateDescription vmstate_acpi_pcihp_pci_status;
75 
76 bool vmstate_acpi_pcihp_use_acpi_index(void *opaque, int version_id);
77 
78 #define VMSTATE_PCI_HOTPLUG(pcihp, state, test_pcihp, test_acpi_index) \
79         VMSTATE_UINT32_TEST(pcihp.hotplug_select, state, \
80                             test_pcihp), \
81         VMSTATE_STRUCT_ARRAY_TEST(pcihp.acpi_pcihp_pci_status, state, \
82                                   ACPI_PCIHP_MAX_HOTPLUG_BUS, \
83                                   test_pcihp, 1, \
84                                   vmstate_acpi_pcihp_pci_status, \
85                                   AcpiPciHpPciStatus), \
86         VMSTATE_UINT32_TEST(pcihp.acpi_index, state, \
87                             test_acpi_index)
88 
89 #endif
90