2 * Virtio Console and Generic Serial Port Devices
4 * Copyright Red Hat, Inc. 2009, 2010
7 * Amit Shah <amit.shah@redhat.com>
9 * This work is licensed under the terms of the GNU GPL, version 2. See
10 * the COPYING file in the top-level directory.
13 #include "qemu/osdep.h"
14 #include "sysemu/char.h"
15 #include "qemu/error-report.h"
17 #include "hw/virtio/virtio-serial.h"
18 #include "qapi-event.h"
20 #define TYPE_VIRTIO_CONSOLE_SERIAL_PORT "virtserialport"
21 #define VIRTIO_CONSOLE(obj) \
22 OBJECT_CHECK(VirtConsole, (obj), TYPE_VIRTIO_CONSOLE_SERIAL_PORT)
24 typedef struct VirtConsole {
25 VirtIOSerialPort parent_obj;
32 * Callback function that's called from chardevs when backend becomes
35 static gboolean chr_write_unblocked(GIOChannel *chan, GIOCondition cond,
38 VirtConsole *vcon = opaque;
41 virtio_serial_throttle_port(VIRTIO_SERIAL_PORT(vcon), false);
45 /* Callback function that's called when the guest sends us data */
46 static ssize_t flush_buf(VirtIOSerialPort *port,
47 const uint8_t *buf, ssize_t len)
49 VirtConsole *vcon = VIRTIO_CONSOLE(port);
53 /* If there's no backend, we can just say we consumed all data. */
57 ret = qemu_chr_fe_write(vcon->chr, buf, len);
58 trace_virtio_console_flush_buf(port->id, len, ret);
61 VirtIOSerialPortClass *k = VIRTIO_SERIAL_PORT_GET_CLASS(port);
64 * Ideally we'd get a better error code than just -1, but
65 * that's what the chardev interface gives us right now. If
66 * we had a finer-grained message, like -EPIPE, we could close
72 virtio_serial_throttle_port(port, true);
74 vcon->watch = qemu_chr_fe_add_watch(vcon->chr,
76 chr_write_unblocked, vcon);
83 /* Callback function that's called when the guest opens/closes the port */
84 static void set_guest_connected(VirtIOSerialPort *port, int guest_connected)
86 VirtConsole *vcon = VIRTIO_CONSOLE(port);
87 DeviceState *dev = DEVICE(port);
90 qemu_chr_fe_set_open(vcon->chr, guest_connected);
94 qapi_event_send_vserport_change(dev->id, guest_connected,
99 static void guest_writable(VirtIOSerialPort *port)
101 VirtConsole *vcon = VIRTIO_CONSOLE(port);
104 qemu_chr_accept_input(vcon->chr);
108 /* Readiness of the guest to accept data on a port */
109 static int chr_can_read(void *opaque)
111 VirtConsole *vcon = opaque;
113 return virtio_serial_guest_ready(VIRTIO_SERIAL_PORT(vcon));
116 /* Send data from a char device over to the guest */
117 static void chr_read(void *opaque, const uint8_t *buf, int size)
119 VirtConsole *vcon = opaque;
120 VirtIOSerialPort *port = VIRTIO_SERIAL_PORT(vcon);
122 trace_virtio_console_chr_read(port->id, size);
123 virtio_serial_write(port, buf, size);
126 static void chr_event(void *opaque, int event)
128 VirtConsole *vcon = opaque;
129 VirtIOSerialPort *port = VIRTIO_SERIAL_PORT(vcon);
131 trace_virtio_console_chr_event(port->id, event);
133 case CHR_EVENT_OPENED:
134 virtio_serial_open(port);
136 case CHR_EVENT_CLOSED:
138 g_source_remove(vcon->watch);
141 virtio_serial_close(port);
146 static void virtconsole_realize(DeviceState *dev, Error **errp)
148 VirtIOSerialPort *port = VIRTIO_SERIAL_PORT(dev);
149 VirtConsole *vcon = VIRTIO_CONSOLE(dev);
150 VirtIOSerialPortClass *k = VIRTIO_SERIAL_PORT_GET_CLASS(dev);
152 if (port->id == 0 && !k->is_console) {
153 error_setg(errp, "Port number 0 on virtio-serial devices reserved "
154 "for virtconsole devices for backward compatibility.");
159 vcon->chr->explicit_fe_open = 1;
160 qemu_chr_add_handlers(vcon->chr, chr_can_read, chr_read, chr_event,
165 static void virtconsole_unrealize(DeviceState *dev, Error **errp)
167 VirtConsole *vcon = VIRTIO_CONSOLE(dev);
170 g_source_remove(vcon->watch);
174 static void virtconsole_class_init(ObjectClass *klass, void *data)
176 VirtIOSerialPortClass *k = VIRTIO_SERIAL_PORT_CLASS(klass);
178 k->is_console = true;
181 static const TypeInfo virtconsole_info = {
182 .name = "virtconsole",
183 .parent = TYPE_VIRTIO_CONSOLE_SERIAL_PORT,
184 .class_init = virtconsole_class_init,
187 static Property virtserialport_properties[] = {
188 DEFINE_PROP_CHR("chardev", VirtConsole, chr),
189 DEFINE_PROP_END_OF_LIST(),
192 static void virtserialport_class_init(ObjectClass *klass, void *data)
194 DeviceClass *dc = DEVICE_CLASS(klass);
195 VirtIOSerialPortClass *k = VIRTIO_SERIAL_PORT_CLASS(klass);
197 k->realize = virtconsole_realize;
198 k->unrealize = virtconsole_unrealize;
199 k->have_data = flush_buf;
200 k->set_guest_connected = set_guest_connected;
201 k->guest_writable = guest_writable;
202 dc->props = virtserialport_properties;
205 static const TypeInfo virtserialport_info = {
206 .name = TYPE_VIRTIO_CONSOLE_SERIAL_PORT,
207 .parent = TYPE_VIRTIO_SERIAL_PORT,
208 .instance_size = sizeof(VirtConsole),
209 .class_init = virtserialport_class_init,
212 static void virtconsole_register_types(void)
214 type_register_static(&virtserialport_info);
215 type_register_static(&virtconsole_info);
218 type_init(virtconsole_register_types)