2 * Virtio Serial / Console Support
4 * Copyright IBM, Corp. 2008
5 * Copyright Red Hat, Inc. 2009
8 * Christian Ehrhardt <ehrhardt@linux.vnet.ibm.com>
9 * Amit Shah <amit.shah@redhat.com>
11 * This work is licensed under the terms of the GNU GPL, version 2. See
12 * the COPYING file in the top-level directory.
15 #ifndef _QEMU_VIRTIO_SERIAL_H
16 #define _QEMU_VIRTIO_SERIAL_H
22 /* == Interface shared between the guest kernel and qemu == */
24 /* The Virtio ID for virtio console / serial ports */
25 #define VIRTIO_ID_CONSOLE 3
27 /* Features supported */
28 #define VIRTIO_CONSOLE_F_MULTIPORT 1
30 #define VIRTIO_CONSOLE_BAD_ID (~(uint32_t)0)
32 struct virtio_console_config
{
34 * These two fields are used by VIRTIO_CONSOLE_F_SIZE which
35 * isn't implemented here yet
40 uint32_t max_nr_ports
;
41 } __attribute__((packed
));
43 struct virtio_console_control
{
44 uint32_t id
; /* Port number */
45 uint16_t event
; /* The kind of control event (see below) */
46 uint16_t value
; /* Extra information for the key */
49 /* Some events for the internal messages (control packets) */
50 #define VIRTIO_CONSOLE_DEVICE_READY 0
51 #define VIRTIO_CONSOLE_PORT_ADD 1
52 #define VIRTIO_CONSOLE_PORT_REMOVE 2
53 #define VIRTIO_CONSOLE_PORT_READY 3
54 #define VIRTIO_CONSOLE_CONSOLE_PORT 4
55 #define VIRTIO_CONSOLE_RESIZE 5
56 #define VIRTIO_CONSOLE_PORT_OPEN 6
57 #define VIRTIO_CONSOLE_PORT_NAME 7
59 /* == In-qemu interface == */
61 typedef struct VirtIOSerial VirtIOSerial
;
62 typedef struct VirtIOSerialBus VirtIOSerialBus
;
63 typedef struct VirtIOSerialPort VirtIOSerialPort
;
64 typedef struct VirtIOSerialPortInfo VirtIOSerialPortInfo
;
66 typedef struct VirtIOSerialDevice
{
68 VirtIOSerialPortInfo
*info
;
72 * This is the state that's shared between all the ports. Some of the
73 * state is configurable via command-line options. Some of it can be
74 * set by individual devices in their initfn routines. Some of the
75 * state is set by the generic qdev device init routine.
77 struct VirtIOSerialPort
{
79 VirtIOSerialPortInfo
*info
;
81 QTAILQ_ENTRY(VirtIOSerialPort
) next
;
84 * This field gives us the virtio device as well as the qdev bus
85 * that we are associated with
92 * This name is sent to the guest and exported via sysfs.
93 * The guest could create symlinks based on this information.
94 * The name is in the reverse fqdn format, like org.qemu.console.0
99 * This id helps identify ports between the guest and the host.
100 * The guest sends a "header" with this id with each data packet
101 * that it sends and the host can then find out which associated
102 * device to send out this data to
106 /* Identify if this is a port that binds with hvc in the guest */
109 /* Is the corresponding guest device open? */
110 bool guest_connected
;
111 /* Is this device open for IO on the host? */
115 struct VirtIOSerialPortInfo
{
118 * The per-port (or per-app) init function that's called when a
119 * new device is found on the bus.
121 int (*init
)(VirtIOSerialDevice
*dev
);
123 * Per-port exit function that's called when a port gets
124 * hot-unplugged or removed.
126 int (*exit
)(VirtIOSerialDevice
*dev
);
128 /* Callbacks for guest events */
129 /* Guest opened device. */
130 void (*guest_open
)(VirtIOSerialPort
*port
);
131 /* Guest closed device. */
132 void (*guest_close
)(VirtIOSerialPort
*port
);
134 /* Guest is now ready to accept data (virtqueues set up). */
135 void (*guest_ready
)(VirtIOSerialPort
*port
);
138 * Guest wrote some data to the port. This data is handed over to
139 * the app via this callback. The app should return the number of
140 * bytes it successfully consumed.
142 size_t (*have_data
)(VirtIOSerialPort
*port
, const uint8_t *buf
, size_t len
);
145 /* Interface to the virtio-serial bus */
148 * Individual ports/apps should call this function to register the port
149 * with the virtio-serial bus
151 void virtio_serial_port_qdev_register(VirtIOSerialPortInfo
*info
);
154 * Open a connection to the port
155 * Returns 0 on success (always).
157 int virtio_serial_open(VirtIOSerialPort
*port
);
160 * Close the connection to the port
161 * Returns 0 on success (always).
163 int virtio_serial_close(VirtIOSerialPort
*port
);
168 ssize_t
virtio_serial_write(VirtIOSerialPort
*port
, const uint8_t *buf
,
172 * Query whether a guest is ready to receive data.
174 size_t virtio_serial_guest_ready(VirtIOSerialPort
*port
);