build: fix missing trace dep on GENERATED_HEADERS
[qemu.git] / qemu-char.h
blobeebbdd8f019f611a39fe0abd70c98043c1702dac
1 #ifndef QEMU_CHAR_H
2 #define QEMU_CHAR_H
4 #include "qemu-common.h"
5 #include "qemu-queue.h"
6 #include "qemu-option.h"
7 #include "qemu-config.h"
8 #include "qobject.h"
9 #include "qstring.h"
11 /* character device */
13 #define CHR_EVENT_BREAK 0 /* serial break char */
14 #define CHR_EVENT_FOCUS 1 /* focus to this terminal (modal input needed) */
15 #define CHR_EVENT_OPENED 2 /* new connection established */
16 #define CHR_EVENT_MUX_IN 3 /* mux-focus was set to this terminal */
17 #define CHR_EVENT_MUX_OUT 4 /* mux-focus will move on */
18 #define CHR_EVENT_CLOSED 5 /* connection closed */
21 #define CHR_IOCTL_SERIAL_SET_PARAMS 1
22 typedef struct {
23 int speed;
24 int parity;
25 int data_bits;
26 int stop_bits;
27 } QEMUSerialSetParams;
29 #define CHR_IOCTL_SERIAL_SET_BREAK 2
31 #define CHR_IOCTL_PP_READ_DATA 3
32 #define CHR_IOCTL_PP_WRITE_DATA 4
33 #define CHR_IOCTL_PP_READ_CONTROL 5
34 #define CHR_IOCTL_PP_WRITE_CONTROL 6
35 #define CHR_IOCTL_PP_READ_STATUS 7
36 #define CHR_IOCTL_PP_EPP_READ_ADDR 8
37 #define CHR_IOCTL_PP_EPP_READ 9
38 #define CHR_IOCTL_PP_EPP_WRITE_ADDR 10
39 #define CHR_IOCTL_PP_EPP_WRITE 11
40 #define CHR_IOCTL_PP_DATA_DIR 12
42 #define CHR_IOCTL_SERIAL_SET_TIOCM 13
43 #define CHR_IOCTL_SERIAL_GET_TIOCM 14
45 #define CHR_TIOCM_CTS 0x020
46 #define CHR_TIOCM_CAR 0x040
47 #define CHR_TIOCM_DSR 0x100
48 #define CHR_TIOCM_RI 0x080
49 #define CHR_TIOCM_DTR 0x002
50 #define CHR_TIOCM_RTS 0x004
52 typedef void IOEventHandler(void *opaque, int event);
54 struct CharDriverState {
55 void (*init)(struct CharDriverState *s);
56 int (*chr_write)(struct CharDriverState *s, const uint8_t *buf, int len);
57 void (*chr_update_read_handler)(struct CharDriverState *s);
58 int (*chr_ioctl)(struct CharDriverState *s, int cmd, void *arg);
59 int (*get_msgfd)(struct CharDriverState *s);
60 int (*chr_add_client)(struct CharDriverState *chr, int fd);
61 IOEventHandler *chr_event;
62 IOCanReadHandler *chr_can_read;
63 IOReadHandler *chr_read;
64 void *handler_opaque;
65 void (*chr_close)(struct CharDriverState *chr);
66 void (*chr_accept_input)(struct CharDriverState *chr);
67 void (*chr_set_echo)(struct CharDriverState *chr, bool echo);
68 void (*chr_guest_open)(struct CharDriverState *chr);
69 void (*chr_guest_close)(struct CharDriverState *chr);
70 void *opaque;
71 QEMUBH *bh;
72 char *label;
73 char *filename;
74 int opened;
75 int avail_connections;
76 QTAILQ_ENTRY(CharDriverState) next;
79 /**
80 * @qemu_chr_new_from_opts:
82 * Create a new character backend from a QemuOpts list.
84 * @opts see qemu-config.c for a list of valid options
85 * @init not sure..
87 * Returns: a new character backend
89 CharDriverState *qemu_chr_new_from_opts(QemuOpts *opts,
90 void (*init)(struct CharDriverState *s));
92 /**
93 * @qemu_chr_new:
95 * Create a new character backend from a URI.
97 * @label the name of the backend
98 * @filename the URI
99 * @init not sure..
101 * Returns: a new character backend
103 CharDriverState *qemu_chr_new(const char *label, const char *filename,
104 void (*init)(struct CharDriverState *s));
107 * @qemu_chr_delete:
109 * Destroy a character backend.
111 void qemu_chr_delete(CharDriverState *chr);
114 * @qemu_chr_fe_set_echo:
116 * Ask the backend to override its normal echo setting. This only really
117 * applies to the stdio backend and is used by the QMP server such that you
118 * can see what you type if you try to type QMP commands.
120 * @echo true to enable echo, false to disable echo
122 void qemu_chr_fe_set_echo(struct CharDriverState *chr, bool echo);
125 * @qemu_chr_fe_open:
127 * Open a character backend. This function call is an indication that the
128 * front end is ready to begin doing I/O.
130 void qemu_chr_fe_open(struct CharDriverState *chr);
133 * @qemu_chr_fe_close:
135 * Close a character backend. This function call indicates that the front end
136 * no longer is able to process I/O. To process I/O again, the front end will
137 * call @qemu_chr_fe_open.
139 void qemu_chr_fe_close(struct CharDriverState *chr);
142 * @qemu_chr_fe_printf:
144 * Write to a character backend using a printf style interface.
146 * @fmt see #printf
148 void qemu_chr_fe_printf(CharDriverState *s, const char *fmt, ...)
149 GCC_FMT_ATTR(2, 3);
152 * @qemu_chr_fe_write:
154 * Write data to a character backend from the front end. This function will
155 * send data from the front end to the back end.
157 * @buf the data
158 * @len the number of bytes to send
160 * Returns: the number of bytes consumed
162 int qemu_chr_fe_write(CharDriverState *s, const uint8_t *buf, int len);
165 * @qemu_chr_fe_ioctl:
167 * Issue a device specific ioctl to a backend.
169 * @cmd see CHR_IOCTL_*
170 * @arg the data associated with @cmd
172 * Returns: if @cmd is not supported by the backend, -ENOTSUP, otherwise the
173 * return value depends on the semantics of @cmd
175 int qemu_chr_fe_ioctl(CharDriverState *s, int cmd, void *arg);
178 * @qemu_chr_fe_get_msgfd:
180 * For backends capable of fd passing, return the latest file descriptor passed
181 * by a client.
183 * Returns: -1 if fd passing isn't supported or there is no pending file
184 * descriptor. If a file descriptor is returned, subsequent calls to
185 * this function will return -1 until a client sends a new file
186 * descriptor.
188 int qemu_chr_fe_get_msgfd(CharDriverState *s);
191 * @qemu_chr_be_can_write:
193 * Determine how much data the front end can currently accept. This function
194 * returns the number of bytes the front end can accept. If it returns 0, the
195 * front end cannot receive data at the moment. The function must be polled
196 * to determine when data can be received.
198 * Returns: the number of bytes the front end can receive via @qemu_chr_be_write
200 int qemu_chr_be_can_write(CharDriverState *s);
203 * @qemu_chr_be_write:
205 * Write data from the back end to the front end. Before issuing this call,
206 * the caller should call @qemu_chr_be_can_write to determine how much data
207 * the front end can currently accept.
209 * @buf a buffer to receive data from the front end
210 * @len the number of bytes to receive from the front end
212 void qemu_chr_be_write(CharDriverState *s, uint8_t *buf, int len);
214 void qemu_chr_add_handlers(CharDriverState *s,
215 IOCanReadHandler *fd_can_read,
216 IOReadHandler *fd_read,
217 IOEventHandler *fd_event,
218 void *opaque);
220 void qemu_chr_generic_open(CharDriverState *s);
221 void qemu_chr_accept_input(CharDriverState *s);
222 int qemu_chr_add_client(CharDriverState *s, int fd);
223 void qemu_chr_info_print(Monitor *mon, const QObject *ret_data);
224 void qemu_chr_info(Monitor *mon, QObject **ret_data);
225 CharDriverState *qemu_chr_find(const char *name);
227 QemuOpts *qemu_chr_parse_compat(const char *label, const char *filename);
229 /* add an eventfd to the qemu devices that are polled */
230 CharDriverState *qemu_chr_open_eventfd(int eventfd);
232 extern int term_escape_char;
234 /* memory chardev */
235 void qemu_chr_init_mem(CharDriverState *chr);
236 void qemu_chr_close_mem(CharDriverState *chr);
237 QString *qemu_chr_mem_to_qs(CharDriverState *chr);
238 size_t qemu_chr_mem_osize(const CharDriverState *chr);
240 /* async I/O support */
242 int qemu_set_fd_handler2(int fd,
243 IOCanReadHandler *fd_read_poll,
244 IOHandler *fd_read,
245 IOHandler *fd_write,
246 void *opaque);
247 int qemu_set_fd_handler(int fd,
248 IOHandler *fd_read,
249 IOHandler *fd_write,
250 void *opaque);
251 #endif