4 #include "qemu-common.h"
5 #include "qemu/queue.h"
6 #include "qemu/option.h"
7 #include "qemu/config-file.h"
9 #include "qapi/qmp/qobject.h"
10 #include "qapi/qmp/qstring.h"
11 #include "qemu/main-loop.h"
13 /* character device */
15 #define CHR_EVENT_BREAK 0 /* serial break char */
16 #define CHR_EVENT_FOCUS 1 /* focus to this terminal (modal input needed) */
17 #define CHR_EVENT_OPENED 2 /* new connection established */
18 #define CHR_EVENT_MUX_IN 3 /* mux-focus was set to this terminal */
19 #define CHR_EVENT_MUX_OUT 4 /* mux-focus will move on */
20 #define CHR_EVENT_CLOSED 5 /* connection closed */
23 #define CHR_IOCTL_SERIAL_SET_PARAMS 1
29 } QEMUSerialSetParams
;
31 #define CHR_IOCTL_SERIAL_SET_BREAK 2
33 #define CHR_IOCTL_PP_READ_DATA 3
34 #define CHR_IOCTL_PP_WRITE_DATA 4
35 #define CHR_IOCTL_PP_READ_CONTROL 5
36 #define CHR_IOCTL_PP_WRITE_CONTROL 6
37 #define CHR_IOCTL_PP_READ_STATUS 7
38 #define CHR_IOCTL_PP_EPP_READ_ADDR 8
39 #define CHR_IOCTL_PP_EPP_READ 9
40 #define CHR_IOCTL_PP_EPP_WRITE_ADDR 10
41 #define CHR_IOCTL_PP_EPP_WRITE 11
42 #define CHR_IOCTL_PP_DATA_DIR 12
44 #define CHR_IOCTL_SERIAL_SET_TIOCM 13
45 #define CHR_IOCTL_SERIAL_GET_TIOCM 14
47 #define CHR_TIOCM_CTS 0x020
48 #define CHR_TIOCM_CAR 0x040
49 #define CHR_TIOCM_DSR 0x100
50 #define CHR_TIOCM_RI 0x080
51 #define CHR_TIOCM_DTR 0x002
52 #define CHR_TIOCM_RTS 0x004
54 typedef void IOEventHandler(void *opaque
, int event
);
56 struct CharDriverState
{
57 QemuMutex chr_write_lock
;
58 void (*init
)(struct CharDriverState
*s
);
59 int (*chr_write
)(struct CharDriverState
*s
, const uint8_t *buf
, int len
);
60 int (*chr_sync_read
)(struct CharDriverState
*s
,
61 const uint8_t *buf
, int len
);
62 GSource
*(*chr_add_watch
)(struct CharDriverState
*s
, GIOCondition cond
);
63 void (*chr_update_read_handler
)(struct CharDriverState
*s
);
64 int (*chr_ioctl
)(struct CharDriverState
*s
, int cmd
, void *arg
);
65 int (*get_msgfds
)(struct CharDriverState
*s
, int* fds
, int num
);
66 int (*set_msgfds
)(struct CharDriverState
*s
, int *fds
, int num
);
67 int (*chr_add_client
)(struct CharDriverState
*chr
, int fd
);
68 IOEventHandler
*chr_event
;
69 IOCanReadHandler
*chr_can_read
;
70 IOReadHandler
*chr_read
;
72 void (*chr_close
)(struct CharDriverState
*chr
);
73 void (*chr_accept_input
)(struct CharDriverState
*chr
);
74 void (*chr_set_echo
)(struct CharDriverState
*chr
, bool echo
);
75 void (*chr_set_fe_open
)(struct CharDriverState
*chr
, int fe_open
);
76 void (*chr_fe_event
)(struct CharDriverState
*chr
, int event
);
84 int avail_connections
;
88 QTAILQ_ENTRY(CharDriverState
) next
;
94 * Allocate and initialize a new CharDriverState.
96 * Returns: a newly allocated CharDriverState.
98 CharDriverState
*qemu_chr_alloc(void);
101 * @qemu_chr_new_from_opts:
103 * Create a new character backend from a QemuOpts list.
105 * @opts see qemu-config.c for a list of valid options
108 * Returns: a new character backend
110 CharDriverState
*qemu_chr_new_from_opts(QemuOpts
*opts
,
111 void (*init
)(struct CharDriverState
*s
),
117 * Create a new character backend from a URI.
119 * @label the name of the backend
123 * Returns: a new character backend
125 CharDriverState
*qemu_chr_new(const char *label
, const char *filename
,
126 void (*init
)(struct CharDriverState
*s
));
131 * Destroy a character backend and remove it from the list of
132 * identified character backends.
134 void qemu_chr_delete(CharDriverState
*chr
);
139 * Destroy a character backend.
141 void qemu_chr_free(CharDriverState
*chr
);
144 * @qemu_chr_fe_set_echo:
146 * Ask the backend to override its normal echo setting. This only really
147 * applies to the stdio backend and is used by the QMP server such that you
148 * can see what you type if you try to type QMP commands.
150 * @echo true to enable echo, false to disable echo
152 void qemu_chr_fe_set_echo(struct CharDriverState
*chr
, bool echo
);
155 * @qemu_chr_fe_set_open:
157 * Set character frontend open status. This is an indication that the
158 * front end is ready (or not) to begin doing I/O.
160 void qemu_chr_fe_set_open(struct CharDriverState
*chr
, int fe_open
);
163 * @qemu_chr_fe_event:
165 * Send an event from the front end to the back end.
167 * @event the event to send
169 void qemu_chr_fe_event(CharDriverState
*s
, int event
);
172 * @qemu_chr_fe_printf:
174 * Write to a character backend using a printf style interface.
175 * This function is thread-safe.
179 void qemu_chr_fe_printf(CharDriverState
*s
, const char *fmt
, ...)
182 int qemu_chr_fe_add_watch(CharDriverState
*s
, GIOCondition cond
,
183 GIOFunc func
, void *user_data
);
186 * @qemu_chr_fe_write:
188 * Write data to a character backend from the front end. This function
189 * will send data from the front end to the back end. This function
193 * @len the number of bytes to send
195 * Returns: the number of bytes consumed
197 int qemu_chr_fe_write(CharDriverState
*s
, const uint8_t *buf
, int len
);
200 * @qemu_chr_fe_write_all:
202 * Write data to a character backend from the front end. This function will
203 * send data from the front end to the back end. Unlike @qemu_chr_fe_write,
204 * this function will block if the back end cannot consume all of the data
205 * attempted to be written. This function is thread-safe.
208 * @len the number of bytes to send
210 * Returns: the number of bytes consumed
212 int qemu_chr_fe_write_all(CharDriverState
*s
, const uint8_t *buf
, int len
);
215 * @qemu_chr_fe_read_all:
217 * Read data to a buffer from the back end.
219 * @buf the data buffer
220 * @len the number of bytes to read
222 * Returns: the number of bytes read
224 int qemu_chr_fe_read_all(CharDriverState
*s
, uint8_t *buf
, int len
);
227 * @qemu_chr_fe_ioctl:
229 * Issue a device specific ioctl to a backend. This function is thread-safe.
231 * @cmd see CHR_IOCTL_*
232 * @arg the data associated with @cmd
234 * Returns: if @cmd is not supported by the backend, -ENOTSUP, otherwise the
235 * return value depends on the semantics of @cmd
237 int qemu_chr_fe_ioctl(CharDriverState
*s
, int cmd
, void *arg
);
240 * @qemu_chr_fe_get_msgfd:
242 * For backends capable of fd passing, return the latest file descriptor passed
245 * Returns: -1 if fd passing isn't supported or there is no pending file
246 * descriptor. If a file descriptor is returned, subsequent calls to
247 * this function will return -1 until a client sends a new file
250 int qemu_chr_fe_get_msgfd(CharDriverState
*s
);
253 * @qemu_chr_fe_get_msgfds:
255 * For backends capable of fd passing, return the number of file received
256 * descriptors and fills the fds array up to num elements
258 * Returns: -1 if fd passing isn't supported or there are no pending file
259 * descriptors. If file descriptors are returned, subsequent calls to
260 * this function will return -1 until a client sends a new set of file
263 int qemu_chr_fe_get_msgfds(CharDriverState
*s
, int *fds
, int num
);
266 * @qemu_chr_fe_set_msgfds:
268 * For backends capable of fd passing, set an array of fds to be passed with
269 * the next send operation.
270 * A subsequent call to this function before calling a write function will
271 * result in overwriting the fd array with the new value without being send.
272 * Upon writing the message the fd array is freed.
274 * Returns: -1 if fd passing isn't supported.
276 int qemu_chr_fe_set_msgfds(CharDriverState
*s
, int *fds
, int num
);
279 * @qemu_chr_fe_claim:
281 * Claim a backend before using it, should be called before calling
282 * qemu_chr_add_handlers().
284 * Returns: -1 if the backend is already in use by another frontend, 0 on
287 int qemu_chr_fe_claim(CharDriverState
*s
);
290 * @qemu_chr_fe_claim_no_fail:
292 * Like qemu_chr_fe_claim, but will exit qemu with an error when the
293 * backend is already in use.
295 void qemu_chr_fe_claim_no_fail(CharDriverState
*s
);
298 * @qemu_chr_fe_claim:
300 * Release a backend for use by another frontend.
302 * Returns: -1 if the backend is already in use by another frontend, 0 on
305 void qemu_chr_fe_release(CharDriverState
*s
);
308 * @qemu_chr_be_can_write:
310 * Determine how much data the front end can currently accept. This function
311 * returns the number of bytes the front end can accept. If it returns 0, the
312 * front end cannot receive data at the moment. The function must be polled
313 * to determine when data can be received.
315 * Returns: the number of bytes the front end can receive via @qemu_chr_be_write
317 int qemu_chr_be_can_write(CharDriverState
*s
);
320 * @qemu_chr_be_write:
322 * Write data from the back end to the front end. Before issuing this call,
323 * the caller should call @qemu_chr_be_can_write to determine how much data
324 * the front end can currently accept.
326 * @buf a buffer to receive data from the front end
327 * @len the number of bytes to receive from the front end
329 void qemu_chr_be_write(CharDriverState
*s
, uint8_t *buf
, int len
);
333 * @qemu_chr_be_event:
335 * Send an event from the back end to the front end.
337 * @event the event to send
339 void qemu_chr_be_event(CharDriverState
*s
, int event
);
341 void qemu_chr_add_handlers(CharDriverState
*s
,
342 IOCanReadHandler
*fd_can_read
,
343 IOReadHandler
*fd_read
,
344 IOEventHandler
*fd_event
,
347 void qemu_chr_be_generic_open(CharDriverState
*s
);
348 void qemu_chr_accept_input(CharDriverState
*s
);
349 int qemu_chr_add_client(CharDriverState
*s
, int fd
);
350 CharDriverState
*qemu_chr_find(const char *name
);
351 bool chr_is_ringbuf(const CharDriverState
*chr
);
353 QemuOpts
*qemu_chr_parse_compat(const char *label
, const char *filename
);
355 void register_char_driver(const char *name
, ChardevBackendKind kind
,
356 void (*parse
)(QemuOpts
*opts
, ChardevBackend
*backend
, Error
**errp
),
357 CharDriverState
*(*create
)(const char *id
, ChardevBackend
*backend
,
358 ChardevReturn
*ret
, Error
**errp
));
360 /* add an eventfd to the qemu devices that are polled */
361 CharDriverState
*qemu_chr_open_eventfd(int eventfd
);
363 extern int term_escape_char
;
365 CharDriverState
*qemu_char_get_next_serial(void);
368 typedef CharDriverState
*(VcHandler
)(ChardevVC
*vc
, Error
**errp
);
369 void register_vc_handler(VcHandler
*handler
);