xref: /openbmc/qemu/hw/char/serial-pci.c (revision d49805ae)
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 "hw/char/serial.h"
29 #include "hw/pci/pci.h"
30 #include "qapi/qmp/qerror.h"
31 
32 #define PCI_SERIAL_MAX_PORTS 4
33 
34 typedef struct PCISerialState {
35     PCIDevice dev;
36     SerialState state;
37     uint8_t prog_if;
38 } PCISerialState;
39 
40 typedef struct PCIMultiSerialState {
41     PCIDevice    dev;
42     MemoryRegion iobar;
43     uint32_t     ports;
44     char         *name[PCI_SERIAL_MAX_PORTS];
45     SerialState  state[PCI_SERIAL_MAX_PORTS];
46     uint32_t     level[PCI_SERIAL_MAX_PORTS];
47     qemu_irq     *irqs;
48     uint8_t      prog_if;
49 } PCIMultiSerialState;
50 
51 static int serial_pci_init(PCIDevice *dev)
52 {
53     PCISerialState *pci = DO_UPCAST(PCISerialState, dev, dev);
54     SerialState *s = &pci->state;
55     Error *err = NULL;
56 
57     s->baudbase = 115200;
58     serial_realize_core(s, &err);
59     if (err != NULL) {
60         qerror_report_err(err);
61         error_free(err);
62         return -1;
63     }
64 
65     pci->dev.config[PCI_CLASS_PROG] = pci->prog_if;
66     pci->dev.config[PCI_INTERRUPT_PIN] = 0x01;
67     s->irq = pci_allocate_irq(&pci->dev);
68 
69     memory_region_init_io(&s->io, OBJECT(pci), &serial_io_ops, s, "serial", 8);
70     pci_register_bar(&pci->dev, 0, PCI_BASE_ADDRESS_SPACE_IO, &s->io);
71     return 0;
72 }
73 
74 static void multi_serial_irq_mux(void *opaque, int n, int level)
75 {
76     PCIMultiSerialState *pci = opaque;
77     int i, pending = 0;
78 
79     pci->level[n] = level;
80     for (i = 0; i < pci->ports; i++) {
81         if (pci->level[i]) {
82             pending = 1;
83         }
84     }
85     pci_set_irq(&pci->dev, pending);
86 }
87 
88 static int multi_serial_pci_init(PCIDevice *dev)
89 {
90     PCIDeviceClass *pc = PCI_DEVICE_GET_CLASS(dev);
91     PCIMultiSerialState *pci = DO_UPCAST(PCIMultiSerialState, dev, dev);
92     SerialState *s;
93     Error *err = NULL;
94     int i;
95 
96     switch (pc->device_id) {
97     case 0x0003:
98         pci->ports = 2;
99         break;
100     case 0x0004:
101         pci->ports = 4;
102         break;
103     }
104     assert(pci->ports > 0);
105     assert(pci->ports <= PCI_SERIAL_MAX_PORTS);
106 
107     pci->dev.config[PCI_CLASS_PROG] = pci->prog_if;
108     pci->dev.config[PCI_INTERRUPT_PIN] = 0x01;
109     memory_region_init(&pci->iobar, OBJECT(pci), "multiserial", 8 * pci->ports);
110     pci_register_bar(&pci->dev, 0, PCI_BASE_ADDRESS_SPACE_IO, &pci->iobar);
111     pci->irqs = qemu_allocate_irqs(multi_serial_irq_mux, pci,
112                                    pci->ports);
113 
114     for (i = 0; i < pci->ports; i++) {
115         s = pci->state + i;
116         s->baudbase = 115200;
117         serial_realize_core(s, &err);
118         if (err != NULL) {
119             qerror_report_err(err);
120             error_free(err);
121             return -1;
122         }
123         s->irq = pci->irqs[i];
124         pci->name[i] = g_strdup_printf("uart #%d", i+1);
125         memory_region_init_io(&s->io, OBJECT(pci), &serial_io_ops, s,
126                               pci->name[i], 8);
127         memory_region_add_subregion(&pci->iobar, 8 * i, &s->io);
128     }
129     return 0;
130 }
131 
132 static void serial_pci_exit(PCIDevice *dev)
133 {
134     PCISerialState *pci = DO_UPCAST(PCISerialState, dev, dev);
135     SerialState *s = &pci->state;
136 
137     serial_exit_core(s);
138     memory_region_destroy(&s->io);
139     qemu_free_irq(s->irq);
140 }
141 
142 static void multi_serial_pci_exit(PCIDevice *dev)
143 {
144     PCIMultiSerialState *pci = DO_UPCAST(PCIMultiSerialState, dev, dev);
145     SerialState *s;
146     int i;
147 
148     for (i = 0; i < pci->ports; i++) {
149         s = pci->state + i;
150         serial_exit_core(s);
151         memory_region_destroy(&s->io);
152         g_free(pci->name[i]);
153     }
154     memory_region_destroy(&pci->iobar);
155     qemu_free_irqs(pci->irqs);
156 }
157 
158 static const VMStateDescription vmstate_pci_serial = {
159     .name = "pci-serial",
160     .version_id = 1,
161     .minimum_version_id = 1,
162     .fields = (VMStateField[]) {
163         VMSTATE_PCI_DEVICE(dev, PCISerialState),
164         VMSTATE_STRUCT(state, PCISerialState, 0, vmstate_serial, SerialState),
165         VMSTATE_END_OF_LIST()
166     }
167 };
168 
169 static const VMStateDescription vmstate_pci_multi_serial = {
170     .name = "pci-serial-multi",
171     .version_id = 1,
172     .minimum_version_id = 1,
173     .fields = (VMStateField[]) {
174         VMSTATE_PCI_DEVICE(dev, PCIMultiSerialState),
175         VMSTATE_STRUCT_ARRAY(state, PCIMultiSerialState, PCI_SERIAL_MAX_PORTS,
176                              0, vmstate_serial, SerialState),
177         VMSTATE_UINT32_ARRAY(level, PCIMultiSerialState, PCI_SERIAL_MAX_PORTS),
178         VMSTATE_END_OF_LIST()
179     }
180 };
181 
182 static Property serial_pci_properties[] = {
183     DEFINE_PROP_CHR("chardev",  PCISerialState, state.chr),
184     DEFINE_PROP_UINT8("prog_if",  PCISerialState, prog_if, 0x02),
185     DEFINE_PROP_END_OF_LIST(),
186 };
187 
188 static Property multi_2x_serial_pci_properties[] = {
189     DEFINE_PROP_CHR("chardev1",  PCIMultiSerialState, state[0].chr),
190     DEFINE_PROP_CHR("chardev2",  PCIMultiSerialState, state[1].chr),
191     DEFINE_PROP_UINT8("prog_if",  PCIMultiSerialState, prog_if, 0x02),
192     DEFINE_PROP_END_OF_LIST(),
193 };
194 
195 static Property multi_4x_serial_pci_properties[] = {
196     DEFINE_PROP_CHR("chardev1",  PCIMultiSerialState, state[0].chr),
197     DEFINE_PROP_CHR("chardev2",  PCIMultiSerialState, state[1].chr),
198     DEFINE_PROP_CHR("chardev3",  PCIMultiSerialState, state[2].chr),
199     DEFINE_PROP_CHR("chardev4",  PCIMultiSerialState, state[3].chr),
200     DEFINE_PROP_UINT8("prog_if",  PCIMultiSerialState, prog_if, 0x02),
201     DEFINE_PROP_END_OF_LIST(),
202 };
203 
204 static void serial_pci_class_initfn(ObjectClass *klass, void *data)
205 {
206     DeviceClass *dc = DEVICE_CLASS(klass);
207     PCIDeviceClass *pc = PCI_DEVICE_CLASS(klass);
208     pc->init = serial_pci_init;
209     pc->exit = serial_pci_exit;
210     pc->vendor_id = PCI_VENDOR_ID_REDHAT;
211     pc->device_id = PCI_DEVICE_ID_REDHAT_SERIAL;
212     pc->revision = 1;
213     pc->class_id = PCI_CLASS_COMMUNICATION_SERIAL;
214     dc->vmsd = &vmstate_pci_serial;
215     dc->props = serial_pci_properties;
216     set_bit(DEVICE_CATEGORY_INPUT, dc->categories);
217 }
218 
219 static void multi_2x_serial_pci_class_initfn(ObjectClass *klass, void *data)
220 {
221     DeviceClass *dc = DEVICE_CLASS(klass);
222     PCIDeviceClass *pc = PCI_DEVICE_CLASS(klass);
223     pc->init = multi_serial_pci_init;
224     pc->exit = multi_serial_pci_exit;
225     pc->vendor_id = PCI_VENDOR_ID_REDHAT;
226     pc->device_id = PCI_DEVICE_ID_REDHAT_SERIAL2;
227     pc->revision = 1;
228     pc->class_id = PCI_CLASS_COMMUNICATION_SERIAL;
229     dc->vmsd = &vmstate_pci_multi_serial;
230     dc->props = multi_2x_serial_pci_properties;
231     set_bit(DEVICE_CATEGORY_INPUT, dc->categories);
232 }
233 
234 static void multi_4x_serial_pci_class_initfn(ObjectClass *klass, void *data)
235 {
236     DeviceClass *dc = DEVICE_CLASS(klass);
237     PCIDeviceClass *pc = PCI_DEVICE_CLASS(klass);
238     pc->init = multi_serial_pci_init;
239     pc->exit = multi_serial_pci_exit;
240     pc->vendor_id = PCI_VENDOR_ID_REDHAT;
241     pc->device_id = PCI_DEVICE_ID_REDHAT_SERIAL4;
242     pc->revision = 1;
243     pc->class_id = PCI_CLASS_COMMUNICATION_SERIAL;
244     dc->vmsd = &vmstate_pci_multi_serial;
245     dc->props = multi_4x_serial_pci_properties;
246     set_bit(DEVICE_CATEGORY_INPUT, dc->categories);
247 }
248 
249 static const TypeInfo serial_pci_info = {
250     .name          = "pci-serial",
251     .parent        = TYPE_PCI_DEVICE,
252     .instance_size = sizeof(PCISerialState),
253     .class_init    = serial_pci_class_initfn,
254 };
255 
256 static const TypeInfo multi_2x_serial_pci_info = {
257     .name          = "pci-serial-2x",
258     .parent        = TYPE_PCI_DEVICE,
259     .instance_size = sizeof(PCIMultiSerialState),
260     .class_init    = multi_2x_serial_pci_class_initfn,
261 };
262 
263 static const TypeInfo multi_4x_serial_pci_info = {
264     .name          = "pci-serial-4x",
265     .parent        = TYPE_PCI_DEVICE,
266     .instance_size = sizeof(PCIMultiSerialState),
267     .class_init    = multi_4x_serial_pci_class_initfn,
268 };
269 
270 static void serial_pci_register_types(void)
271 {
272     type_register_static(&serial_pci_info);
273     type_register_static(&multi_2x_serial_pci_info);
274     type_register_static(&multi_4x_serial_pci_info);
275 }
276 
277 type_init(serial_pci_register_types)
278