]>
Commit | Line | Data |
---|---|---|
98b19252 AS |
1 | /* |
2 | * Virtio Serial / Console Support | |
3 | * | |
4 | * Copyright IBM, Corp. 2008 | |
5 | * Copyright Red Hat, Inc. 2009 | |
6 | * | |
7 | * Authors: | |
8 | * Christian Ehrhardt <ehrhardt@linux.vnet.ibm.com> | |
9 | * Amit Shah <amit.shah@redhat.com> | |
10 | * | |
11 | * This work is licensed under the terms of the GNU GPL, version 2. See | |
12 | * the COPYING file in the top-level directory. | |
13 | * | |
14 | */ | |
15 | #ifndef _QEMU_VIRTIO_SERIAL_H | |
16 | #define _QEMU_VIRTIO_SERIAL_H | |
17 | ||
18 | #include <stdbool.h> | |
19 | #include "qdev.h" | |
20 | #include "virtio.h" | |
21 | ||
22 | /* == Interface shared between the guest kernel and qemu == */ | |
23 | ||
24 | /* The Virtio ID for virtio console / serial ports */ | |
25 | #define VIRTIO_ID_CONSOLE 3 | |
26 | ||
27 | /* Features supported */ | |
28 | #define VIRTIO_CONSOLE_F_MULTIPORT 1 | |
29 | ||
30 | struct virtio_console_config { | |
31 | /* | |
32 | * These two fields are used by VIRTIO_CONSOLE_F_SIZE which | |
33 | * isn't implemented here yet | |
34 | */ | |
35 | uint16_t cols; | |
36 | uint16_t rows; | |
37 | ||
38 | uint32_t max_nr_ports; | |
39 | uint32_t nr_ports; | |
40 | } __attribute__((packed)); | |
41 | ||
42 | struct virtio_console_control { | |
43 | uint32_t id; /* Port number */ | |
44 | uint16_t event; /* The kind of control event (see below) */ | |
45 | uint16_t value; /* Extra information for the key */ | |
46 | }; | |
47 | ||
48 | /* Some events for the internal messages (control packets) */ | |
49 | #define VIRTIO_CONSOLE_PORT_READY 0 | |
50 | #define VIRTIO_CONSOLE_CONSOLE_PORT 1 | |
51 | #define VIRTIO_CONSOLE_RESIZE 2 | |
6663a195 | 52 | #define VIRTIO_CONSOLE_PORT_OPEN 3 |
98b19252 AS |
53 | |
54 | /* == In-qemu interface == */ | |
55 | ||
56 | typedef struct VirtIOSerial VirtIOSerial; | |
57 | typedef struct VirtIOSerialBus VirtIOSerialBus; | |
58 | typedef struct VirtIOSerialPort VirtIOSerialPort; | |
59 | typedef struct VirtIOSerialPortInfo VirtIOSerialPortInfo; | |
60 | ||
61 | typedef struct VirtIOSerialDevice { | |
62 | DeviceState qdev; | |
63 | VirtIOSerialPortInfo *info; | |
64 | } VirtIOSerialDevice; | |
65 | ||
66 | /* | |
67 | * This is the state that's shared between all the ports. Some of the | |
68 | * state is configurable via command-line options. Some of it can be | |
69 | * set by individual devices in their initfn routines. Some of the | |
70 | * state is set by the generic qdev device init routine. | |
71 | */ | |
72 | struct VirtIOSerialPort { | |
73 | DeviceState dev; | |
74 | VirtIOSerialPortInfo *info; | |
75 | ||
76 | QTAILQ_ENTRY(VirtIOSerialPort) next; | |
77 | ||
78 | /* | |
79 | * This field gives us the virtio device as well as the qdev bus | |
80 | * that we are associated with | |
81 | */ | |
82 | VirtIOSerial *vser; | |
83 | ||
84 | VirtQueue *ivq, *ovq; | |
85 | ||
86 | /* | |
87 | * This id helps identify ports between the guest and the host. | |
88 | * The guest sends a "header" with this id with each data packet | |
89 | * that it sends and the host can then find out which associated | |
90 | * device to send out this data to | |
91 | */ | |
92 | uint32_t id; | |
93 | ||
94 | /* Identify if this is a port that binds with hvc in the guest */ | |
95 | uint8_t is_console; | |
6663a195 AS |
96 | |
97 | /* Is the corresponding guest device open? */ | |
98 | bool guest_connected; | |
99 | /* Is this device open for IO on the host? */ | |
100 | bool host_connected; | |
98b19252 AS |
101 | }; |
102 | ||
103 | struct VirtIOSerialPortInfo { | |
104 | DeviceInfo qdev; | |
105 | /* | |
106 | * The per-port (or per-app) init function that's called when a | |
107 | * new device is found on the bus. | |
108 | */ | |
109 | int (*init)(VirtIOSerialDevice *dev); | |
110 | /* | |
111 | * Per-port exit function that's called when a port gets | |
112 | * hot-unplugged or removed. | |
113 | */ | |
114 | int (*exit)(VirtIOSerialDevice *dev); | |
115 | ||
116 | /* Callbacks for guest events */ | |
117 | /* Guest opened device. */ | |
118 | void (*guest_open)(VirtIOSerialPort *port); | |
119 | /* Guest closed device. */ | |
120 | void (*guest_close)(VirtIOSerialPort *port); | |
121 | ||
122 | /* Guest is now ready to accept data (virtqueues set up). */ | |
123 | void (*guest_ready)(VirtIOSerialPort *port); | |
124 | ||
125 | /* | |
126 | * Guest wrote some data to the port. This data is handed over to | |
127 | * the app via this callback. The app should return the number of | |
128 | * bytes it successfully consumed. | |
129 | */ | |
130 | size_t (*have_data)(VirtIOSerialPort *port, const uint8_t *buf, size_t len); | |
131 | }; | |
132 | ||
133 | /* Interface to the virtio-serial bus */ | |
134 | ||
135 | /* | |
136 | * Individual ports/apps should call this function to register the port | |
137 | * with the virtio-serial bus | |
138 | */ | |
139 | void virtio_serial_port_qdev_register(VirtIOSerialPortInfo *info); | |
140 | ||
141 | /* | |
142 | * Open a connection to the port | |
143 | * Returns 0 on success (always). | |
144 | */ | |
145 | int virtio_serial_open(VirtIOSerialPort *port); | |
146 | ||
147 | /* | |
148 | * Close the connection to the port | |
149 | * Returns 0 on success (always). | |
150 | */ | |
151 | int virtio_serial_close(VirtIOSerialPort *port); | |
152 | ||
153 | /* | |
154 | * Send data to Guest | |
155 | */ | |
156 | ssize_t virtio_serial_write(VirtIOSerialPort *port, const uint8_t *buf, | |
157 | size_t size); | |
158 | ||
159 | /* | |
160 | * Query whether a guest is ready to receive data. | |
161 | */ | |
162 | size_t virtio_serial_guest_ready(VirtIOSerialPort *port); | |
163 | ||
164 | #endif |