xref: /openbmc/qemu/hw/char/serial-pci.c (revision 650d103d3ea959212f826acb9d3fe80cf30e347b)
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 "migration/vmstate.h"
35 
36 typedef struct PCISerialState {
37     PCIDevice dev;
38     SerialState state;
39     uint8_t prog_if;
40 } PCISerialState;
41 
42 
43 static void serial_pci_realize(PCIDevice *dev, Error **errp)
44 {
45     PCISerialState *pci = DO_UPCAST(PCISerialState, dev, dev);
46     SerialState *s = &pci->state;
47     Error *err = NULL;
48 
49     s->baudbase = 115200;
50     serial_realize_core(s, &err);
51     if (err != NULL) {
52         error_propagate(errp, err);
53         return;
54     }
55 
56     pci->dev.config[PCI_CLASS_PROG] = pci->prog_if;
57     pci->dev.config[PCI_INTERRUPT_PIN] = 0x01;
58     s->irq = pci_allocate_irq(&pci->dev);
59 
60     memory_region_init_io(&s->io, OBJECT(pci), &serial_io_ops, s, "serial", 8);
61     pci_register_bar(&pci->dev, 0, PCI_BASE_ADDRESS_SPACE_IO, &s->io);
62 }
63 
64 static void serial_pci_exit(PCIDevice *dev)
65 {
66     PCISerialState *pci = DO_UPCAST(PCISerialState, dev, dev);
67     SerialState *s = &pci->state;
68 
69     serial_exit_core(s);
70     qemu_free_irq(s->irq);
71 }
72 
73 static const VMStateDescription vmstate_pci_serial = {
74     .name = "pci-serial",
75     .version_id = 1,
76     .minimum_version_id = 1,
77     .fields = (VMStateField[]) {
78         VMSTATE_PCI_DEVICE(dev, PCISerialState),
79         VMSTATE_STRUCT(state, PCISerialState, 0, vmstate_serial, SerialState),
80         VMSTATE_END_OF_LIST()
81     }
82 };
83 
84 static Property serial_pci_properties[] = {
85     DEFINE_PROP_CHR("chardev",  PCISerialState, state.chr),
86     DEFINE_PROP_UINT8("prog_if",  PCISerialState, prog_if, 0x02),
87     DEFINE_PROP_END_OF_LIST(),
88 };
89 
90 static void serial_pci_class_initfn(ObjectClass *klass, void *data)
91 {
92     DeviceClass *dc = DEVICE_CLASS(klass);
93     PCIDeviceClass *pc = PCI_DEVICE_CLASS(klass);
94     pc->realize = serial_pci_realize;
95     pc->exit = serial_pci_exit;
96     pc->vendor_id = PCI_VENDOR_ID_REDHAT;
97     pc->device_id = PCI_DEVICE_ID_REDHAT_SERIAL;
98     pc->revision = 1;
99     pc->class_id = PCI_CLASS_COMMUNICATION_SERIAL;
100     dc->vmsd = &vmstate_pci_serial;
101     dc->props = serial_pci_properties;
102     set_bit(DEVICE_CATEGORY_INPUT, dc->categories);
103 }
104 
105 static const TypeInfo serial_pci_info = {
106     .name          = "pci-serial",
107     .parent        = TYPE_PCI_DEVICE,
108     .instance_size = sizeof(PCISerialState),
109     .class_init    = serial_pci_class_initfn,
110     .interfaces = (InterfaceInfo[]) {
111         { INTERFACE_CONVENTIONAL_PCI_DEVICE },
112         { },
113     },
114 };
115 
116 static void serial_pci_register_types(void)
117 {
118     type_register_static(&serial_pci_info);
119 }
120 
121 type_init(serial_pci_register_types)
122