xref: /openbmc/qemu/hw/i386/xen/xen_pvdevice.c (revision 500eb6db)
1 /* Copyright (c) Citrix Systems Inc.
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms,
5  * with or without modification, are permitted provided
6  * that the following conditions are met:
7  *
8  * *   Redistributions of source code must retain the above
9  *     copyright notice, this list of conditions and the
10  *     following disclaimer.
11  * *   Redistributions in binary form must reproduce the above
12  *     copyright notice, this list of conditions and the
13  *     following disclaimer in the documentation and/or other
14  *     materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
17  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
18  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
21  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
23  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
27  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 #include "qemu/osdep.h"
33 #include "qapi/error.h"
34 #include "qemu/module.h"
35 #include "hw/hw.h"
36 #include "hw/pci/pci.h"
37 #include "trace.h"
38 
39 #define TYPE_XEN_PV_DEVICE  "xen-pvdevice"
40 
41 #define XEN_PV_DEVICE(obj) \
42      OBJECT_CHECK(XenPVDevice, (obj), TYPE_XEN_PV_DEVICE)
43 
44 typedef struct XenPVDevice {
45     /*< private >*/
46     PCIDevice       parent_obj;
47     /*< public >*/
48     uint16_t        vendor_id;
49     uint16_t        device_id;
50     uint8_t         revision;
51     uint32_t        size;
52     MemoryRegion    mmio;
53 } XenPVDevice;
54 
55 static uint64_t xen_pv_mmio_read(void *opaque, hwaddr addr,
56                                  unsigned size)
57 {
58     trace_xen_pv_mmio_read(addr);
59 
60     return ~(uint64_t)0;
61 }
62 
63 static void xen_pv_mmio_write(void *opaque, hwaddr addr,
64                               uint64_t val, unsigned size)
65 {
66     trace_xen_pv_mmio_write(addr);
67 }
68 
69 static const MemoryRegionOps xen_pv_mmio_ops = {
70     .read = &xen_pv_mmio_read,
71     .write = &xen_pv_mmio_write,
72     .endianness = DEVICE_LITTLE_ENDIAN,
73 };
74 
75 static const VMStateDescription vmstate_xen_pvdevice = {
76     .name = "xen-pvdevice",
77     .version_id = 1,
78     .minimum_version_id = 1,
79     .fields = (VMStateField[]) {
80         VMSTATE_PCI_DEVICE(parent_obj, XenPVDevice),
81         VMSTATE_END_OF_LIST()
82     }
83 };
84 
85 static void xen_pv_realize(PCIDevice *pci_dev, Error **errp)
86 {
87     XenPVDevice *d = XEN_PV_DEVICE(pci_dev);
88     uint8_t *pci_conf;
89 
90     /* device-id property must always be supplied */
91     if (d->device_id == 0xffff) {
92         error_setg(errp, "Device ID invalid, it must always be supplied");
93         return;
94     }
95 
96     pci_conf = pci_dev->config;
97 
98     pci_set_word(pci_conf + PCI_VENDOR_ID, d->vendor_id);
99     pci_set_word(pci_conf + PCI_SUBSYSTEM_VENDOR_ID, d->vendor_id);
100     pci_set_word(pci_conf + PCI_DEVICE_ID, d->device_id);
101     pci_set_word(pci_conf + PCI_SUBSYSTEM_ID, d->device_id);
102     pci_set_byte(pci_conf + PCI_REVISION_ID, d->revision);
103 
104     pci_set_word(pci_conf + PCI_COMMAND, PCI_COMMAND_MEMORY);
105 
106     pci_config_set_prog_interface(pci_conf, 0);
107 
108     pci_conf[PCI_INTERRUPT_PIN] = 1;
109 
110     memory_region_init_io(&d->mmio, NULL, &xen_pv_mmio_ops, d,
111                           "mmio", d->size);
112 
113     pci_register_bar(pci_dev, 1, PCI_BASE_ADDRESS_MEM_PREFETCH,
114                      &d->mmio);
115 }
116 
117 static Property xen_pv_props[] = {
118     DEFINE_PROP_UINT16("vendor-id", XenPVDevice, vendor_id, PCI_VENDOR_ID_XEN),
119     DEFINE_PROP_UINT16("device-id", XenPVDevice, device_id, 0xffff),
120     DEFINE_PROP_UINT8("revision", XenPVDevice, revision, 0x01),
121     DEFINE_PROP_UINT32("size", XenPVDevice, size, 0x400000),
122     DEFINE_PROP_END_OF_LIST()
123 };
124 
125 static void xen_pv_class_init(ObjectClass *klass, void *data)
126 {
127     DeviceClass *dc = DEVICE_CLASS(klass);
128     PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
129 
130     k->realize = xen_pv_realize;
131     k->class_id = PCI_CLASS_SYSTEM_OTHER;
132     dc->desc = "Xen PV Device";
133     dc->props = xen_pv_props;
134     dc->vmsd = &vmstate_xen_pvdevice;
135 }
136 
137 static const TypeInfo xen_pv_type_info = {
138     .name          = TYPE_XEN_PV_DEVICE,
139     .parent        = TYPE_PCI_DEVICE,
140     .instance_size = sizeof(XenPVDevice),
141     .class_init    = xen_pv_class_init,
142     .interfaces = (InterfaceInfo[]) {
143         { INTERFACE_CONVENTIONAL_PCI_DEVICE },
144         { },
145     },
146 };
147 
148 static void xen_pv_register_types(void)
149 {
150     type_register_static(&xen_pv_type_info);
151 }
152 
153 type_init(xen_pv_register_types)
154