xref: /openbmc/qemu/hw/i386/xen/xen_pvdevice.c (revision 911a4efd)
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 "hw/hw.h"
33 #include "hw/pci/pci.h"
34 #include "trace.h"
35 
36 #define TYPE_XEN_PV_DEVICE  "xen-pvdevice"
37 
38 #define XEN_PV_DEVICE(obj) \
39      OBJECT_CHECK(XenPVDevice, (obj), TYPE_XEN_PV_DEVICE)
40 
41 typedef struct XenPVDevice {
42     /*< private >*/
43     PCIDevice       parent_obj;
44     /*< public >*/
45     uint16_t        vendor_id;
46     uint16_t        device_id;
47     uint8_t         revision;
48     uint32_t        size;
49     MemoryRegion    mmio;
50 } XenPVDevice;
51 
52 static uint64_t xen_pv_mmio_read(void *opaque, hwaddr addr,
53                                  unsigned size)
54 {
55     trace_xen_pv_mmio_read(addr);
56 
57     return ~(uint64_t)0;
58 }
59 
60 static void xen_pv_mmio_write(void *opaque, hwaddr addr,
61                               uint64_t val, unsigned size)
62 {
63     trace_xen_pv_mmio_write(addr);
64 }
65 
66 static const MemoryRegionOps xen_pv_mmio_ops = {
67     .read = &xen_pv_mmio_read,
68     .write = &xen_pv_mmio_write,
69     .endianness = DEVICE_LITTLE_ENDIAN,
70 };
71 
72 static void xen_pv_realize(PCIDevice *pci_dev, Error **errp)
73 {
74     XenPVDevice *d = XEN_PV_DEVICE(pci_dev);
75     uint8_t *pci_conf;
76 
77     /* device-id property must always be supplied */
78     if (d->device_id == 0xffff) {
79         error_setg(errp, "Device ID invalid, it must always be supplied");
80         return;
81     }
82 
83     pci_conf = pci_dev->config;
84 
85     pci_set_word(pci_conf + PCI_VENDOR_ID, d->vendor_id);
86     pci_set_word(pci_conf + PCI_SUBSYSTEM_VENDOR_ID, d->vendor_id);
87     pci_set_word(pci_conf + PCI_DEVICE_ID, d->device_id);
88     pci_set_word(pci_conf + PCI_SUBSYSTEM_ID, d->device_id);
89     pci_set_byte(pci_conf + PCI_REVISION_ID, d->revision);
90 
91     pci_set_word(pci_conf + PCI_COMMAND, PCI_COMMAND_MEMORY);
92 
93     pci_config_set_prog_interface(pci_conf, 0);
94 
95     pci_conf[PCI_INTERRUPT_PIN] = 1;
96 
97     memory_region_init_io(&d->mmio, NULL, &xen_pv_mmio_ops, d,
98                           "mmio", d->size);
99 
100     pci_register_bar(pci_dev, 1, PCI_BASE_ADDRESS_MEM_PREFETCH,
101                      &d->mmio);
102 }
103 
104 static Property xen_pv_props[] = {
105     DEFINE_PROP_UINT16("vendor-id", XenPVDevice, vendor_id, PCI_VENDOR_ID_XEN),
106     DEFINE_PROP_UINT16("device-id", XenPVDevice, device_id, 0xffff),
107     DEFINE_PROP_UINT8("revision", XenPVDevice, revision, 0x01),
108     DEFINE_PROP_UINT32("size", XenPVDevice, size, 0x400000),
109     DEFINE_PROP_END_OF_LIST()
110 };
111 
112 static void xen_pv_class_init(ObjectClass *klass, void *data)
113 {
114     DeviceClass *dc = DEVICE_CLASS(klass);
115     PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
116 
117     k->realize = xen_pv_realize;
118     k->class_id = PCI_CLASS_SYSTEM_OTHER;
119     dc->desc = "Xen PV Device";
120     dc->props = xen_pv_props;
121 }
122 
123 static const TypeInfo xen_pv_type_info = {
124     .name          = TYPE_XEN_PV_DEVICE,
125     .parent        = TYPE_PCI_DEVICE,
126     .instance_size = sizeof(XenPVDevice),
127     .class_init    = xen_pv_class_init,
128 };
129 
130 static void xen_pv_register_types(void)
131 {
132     type_register_static(&xen_pv_type_info);
133 }
134 
135 type_init(xen_pv_register_types)
136