xref: /qemu/hw/char/serial-pci.c (revision a81df1b6) 
1 /*
2  * QEMU 16550A UART emulation
3  *
4  * Copyright (c) 2003-2004 Fabrice Bellard
5  * Copyright (c) 2008 Citrix Systems, Inc.
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a copy
8  * of this software and associated documentation files (the "Software"), to deal
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  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23  * THE SOFTWARE.
24  */
25 
26 /* see docs/specs/pci-serial.txt */
27 
28 #include "qemu/osdep.h"
29 #include "qapi/error.h"
30 #include "qemu/module.h"
31 #include "hw/char/serial.h"
32 #include "hw/irq.h"
33 #include "hw/pci/pci.h"
34 #include "hw/qdev-properties.h"
35 #include "migration/vmstate.h"
36 
37 typedef struct PCISerialState {
38     PCIDevice dev;
39     SerialState state;
40     uint8_t prog_if;
41 } PCISerialState;
42 
43 #define TYPE_PCI_SERIAL "pci-serial"
44 #define PCI_SERIAL(s) OBJECT_CHECK(PCISerialState, (s), TYPE_PCI_SERIAL)
45 
46 static void serial_pci_realize(PCIDevice *dev, Error **errp)
47 {
48     PCISerialState *pci = DO_UPCAST(PCISerialState, dev, dev);
49     SerialState *s = &pci->state;
50 
51     if (!qdev_realize(DEVICE(s), NULL, errp)) {
52         return;
53     }
54 
55     pci->dev.config[PCI_CLASS_PROG] = pci->prog_if;
56     pci->dev.config[PCI_INTERRUPT_PIN] = 0x01;
57     s->irq = pci_allocate_irq(&pci->dev);
58 
59     memory_region_init_io(&s->io, OBJECT(pci), &serial_io_ops, s, "serial", 8);
60     pci_register_bar(&pci->dev, 0, PCI_BASE_ADDRESS_SPACE_IO, &s->io);
61 }
62 
63 static void serial_pci_exit(PCIDevice *dev)
64 {
65     PCISerialState *pci = DO_UPCAST(PCISerialState, dev, dev);
66     SerialState *s = &pci->state;
67 
68     qdev_unrealize(DEVICE(s));
69     qemu_free_irq(s->irq);
70 }
71 
72 static const VMStateDescription vmstate_pci_serial = {
73     .name = "pci-serial",
74     .version_id = 1,
75     .minimum_version_id = 1,
76     .fields = (VMStateField[]) {
77         VMSTATE_PCI_DEVICE(dev, PCISerialState),
78         VMSTATE_STRUCT(state, PCISerialState, 0, vmstate_serial, SerialState),
79         VMSTATE_END_OF_LIST()
80     }
81 };
82 
83 static Property serial_pci_properties[] = {
84     DEFINE_PROP_CHR("chardev",  PCISerialState, state.chr),
85     DEFINE_PROP_UINT8("prog_if",  PCISerialState, prog_if, 0x02),
86     DEFINE_PROP_END_OF_LIST(),
87 };
88 
89 static void serial_pci_class_initfn(ObjectClass *klass, void *data)
90 {
91     DeviceClass *dc = DEVICE_CLASS(klass);
92     PCIDeviceClass *pc = PCI_DEVICE_CLASS(klass);
93     pc->realize = serial_pci_realize;
94     pc->exit = serial_pci_exit;
95     pc->vendor_id = PCI_VENDOR_ID_REDHAT;
96     pc->device_id = PCI_DEVICE_ID_REDHAT_SERIAL;
97     pc->revision = 1;
98     pc->class_id = PCI_CLASS_COMMUNICATION_SERIAL;
99     dc->vmsd = &vmstate_pci_serial;
100     device_class_set_props(dc, serial_pci_properties);
101     set_bit(DEVICE_CATEGORY_INPUT, dc->categories);
102 }
103 
104 static void serial_pci_init(Object *o)
105 {
106     PCISerialState *ps = PCI_SERIAL(o);
107 
108     object_initialize_child(o, "serial", &ps->state, TYPE_SERIAL);
109 }
110 
111 static const TypeInfo serial_pci_info = {
112     .name          = TYPE_PCI_SERIAL,
113     .parent        = TYPE_PCI_DEVICE,
114     .instance_size = sizeof(PCISerialState),
115     .instance_init = serial_pci_init,
116     .class_init    = serial_pci_class_initfn,
117     .interfaces = (InterfaceInfo[]) {
118         { INTERFACE_CONVENTIONAL_PCI_DEVICE },
119         { },
120     },
121 };
122 
123 static void serial_pci_register_types(void)
124 {
125     type_register_static(&serial_pci_info);
126 }
127 
128 type_init(serial_pci_register_types)
129