]>
git.proxmox.com Git - mirror_qemu.git/blob - include/sysemu/char.h
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 struct ParallelIOArg
{
49 #define CHR_IOCTL_SERIAL_SET_TIOCM 13
50 #define CHR_IOCTL_SERIAL_GET_TIOCM 14
52 #define CHR_TIOCM_CTS 0x020
53 #define CHR_TIOCM_CAR 0x040
54 #define CHR_TIOCM_DSR 0x100
55 #define CHR_TIOCM_RI 0x080
56 #define CHR_TIOCM_DTR 0x002
57 #define CHR_TIOCM_RTS 0x004
59 typedef void IOEventHandler(void *opaque
, int event
);
61 struct CharDriverState
{
62 QemuMutex chr_write_lock
;
63 void (*init
)(struct CharDriverState
*s
);
64 int (*chr_write
)(struct CharDriverState
*s
, const uint8_t *buf
, int len
);
65 int (*chr_sync_read
)(struct CharDriverState
*s
,
66 const uint8_t *buf
, int len
);
67 GSource
*(*chr_add_watch
)(struct CharDriverState
*s
, GIOCondition cond
);
68 void (*chr_update_read_handler
)(struct CharDriverState
*s
);
69 int (*chr_ioctl
)(struct CharDriverState
*s
, int cmd
, void *arg
);
70 int (*get_msgfds
)(struct CharDriverState
*s
, int* fds
, int num
);
71 int (*set_msgfds
)(struct CharDriverState
*s
, int *fds
, int num
);
72 int (*chr_add_client
)(struct CharDriverState
*chr
, int fd
);
73 IOEventHandler
*chr_event
;
74 IOCanReadHandler
*chr_can_read
;
75 IOReadHandler
*chr_read
;
77 void (*chr_close
)(struct CharDriverState
*chr
);
78 void (*chr_accept_input
)(struct CharDriverState
*chr
);
79 void (*chr_set_echo
)(struct CharDriverState
*chr
, bool echo
);
80 void (*chr_set_fe_open
)(struct CharDriverState
*chr
, int fe_open
);
81 void (*chr_fe_event
)(struct CharDriverState
*chr
, int event
);
90 int avail_connections
;
95 QTAILQ_ENTRY(CharDriverState
) next
;
100 * @backend: the common backend config
101 * @errp: pointer to a NULL-initialized error object
103 * Allocate and initialize a new CharDriverState.
105 * Returns: a newly allocated CharDriverState, or NULL on error.
107 CharDriverState
*qemu_chr_alloc(ChardevCommon
*backend
, Error
**errp
);
110 * @qemu_chr_new_from_opts:
112 * Create a new character backend from a QemuOpts list.
114 * @opts see qemu-config.c for a list of valid options
117 * Returns: a new character backend
119 CharDriverState
*qemu_chr_new_from_opts(QemuOpts
*opts
,
120 void (*init
)(struct CharDriverState
*s
),
124 * @qemu_chr_parse_common:
126 * Parse the common options available to all character backends.
128 * @opts the options that still need parsing
129 * @backend a new backend
131 void qemu_chr_parse_common(QemuOpts
*opts
, ChardevCommon
*backend
);
136 * Create a new character backend from a URI.
138 * @label the name of the backend
142 * Returns: a new character backend
144 CharDriverState
*qemu_chr_new(const char *label
, const char *filename
,
145 void (*init
)(struct CharDriverState
*s
));
148 * @qemu_chr_new_noreplay:
150 * Create a new character backend from a URI.
151 * Character device communications are not written
152 * into the replay log.
154 * @label the name of the backend
158 * Returns: a new character backend
160 CharDriverState
*qemu_chr_new_noreplay(const char *label
, const char *filename
,
161 void (*init
)(struct CharDriverState
*s
));
166 * Destroy a character backend and remove it from the list of
167 * identified character backends.
169 void qemu_chr_delete(CharDriverState
*chr
);
174 * Destroy a character backend.
176 void qemu_chr_free(CharDriverState
*chr
);
179 * @qemu_chr_fe_set_echo:
181 * Ask the backend to override its normal echo setting. This only really
182 * applies to the stdio backend and is used by the QMP server such that you
183 * can see what you type if you try to type QMP commands.
185 * @echo true to enable echo, false to disable echo
187 void qemu_chr_fe_set_echo(struct CharDriverState
*chr
, bool echo
);
190 * @qemu_chr_fe_set_open:
192 * Set character frontend open status. This is an indication that the
193 * front end is ready (or not) to begin doing I/O.
195 void qemu_chr_fe_set_open(struct CharDriverState
*chr
, int fe_open
);
198 * @qemu_chr_fe_event:
200 * Send an event from the front end to the back end.
202 * @event the event to send
204 void qemu_chr_fe_event(CharDriverState
*s
, int event
);
207 * @qemu_chr_fe_printf:
209 * Write to a character backend using a printf style interface.
210 * This function is thread-safe.
214 void qemu_chr_fe_printf(CharDriverState
*s
, const char *fmt
, ...)
217 int qemu_chr_fe_add_watch(CharDriverState
*s
, GIOCondition cond
,
218 GIOFunc func
, void *user_data
);
221 * @qemu_chr_fe_write:
223 * Write data to a character backend from the front end. This function
224 * will send data from the front end to the back end. This function
228 * @len the number of bytes to send
230 * Returns: the number of bytes consumed
232 int qemu_chr_fe_write(CharDriverState
*s
, const uint8_t *buf
, int len
);
235 * @qemu_chr_fe_write_all:
237 * Write data to a character backend from the front end. This function will
238 * send data from the front end to the back end. Unlike @qemu_chr_fe_write,
239 * this function will block if the back end cannot consume all of the data
240 * attempted to be written. This function is thread-safe.
243 * @len the number of bytes to send
245 * Returns: the number of bytes consumed
247 int qemu_chr_fe_write_all(CharDriverState
*s
, const uint8_t *buf
, int len
);
250 * @qemu_chr_fe_read_all:
252 * Read data to a buffer from the back end.
254 * @buf the data buffer
255 * @len the number of bytes to read
257 * Returns: the number of bytes read
259 int qemu_chr_fe_read_all(CharDriverState
*s
, uint8_t *buf
, int len
);
262 * @qemu_chr_fe_ioctl:
264 * Issue a device specific ioctl to a backend. This function is thread-safe.
266 * @cmd see CHR_IOCTL_*
267 * @arg the data associated with @cmd
269 * Returns: if @cmd is not supported by the backend, -ENOTSUP, otherwise the
270 * return value depends on the semantics of @cmd
272 int qemu_chr_fe_ioctl(CharDriverState
*s
, int cmd
, void *arg
);
275 * @qemu_chr_fe_get_msgfd:
277 * For backends capable of fd passing, return the latest file descriptor passed
280 * Returns: -1 if fd passing isn't supported or there is no pending file
281 * descriptor. If a file descriptor is returned, subsequent calls to
282 * this function will return -1 until a client sends a new file
285 int qemu_chr_fe_get_msgfd(CharDriverState
*s
);
288 * @qemu_chr_fe_get_msgfds:
290 * For backends capable of fd passing, return the number of file received
291 * descriptors and fills the fds array up to num elements
293 * Returns: -1 if fd passing isn't supported or there are no pending file
294 * descriptors. If file descriptors are returned, subsequent calls to
295 * this function will return -1 until a client sends a new set of file
298 int qemu_chr_fe_get_msgfds(CharDriverState
*s
, int *fds
, int num
);
301 * @qemu_chr_fe_set_msgfds:
303 * For backends capable of fd passing, set an array of fds to be passed with
304 * the next send operation.
305 * A subsequent call to this function before calling a write function will
306 * result in overwriting the fd array with the new value without being send.
307 * Upon writing the message the fd array is freed.
309 * Returns: -1 if fd passing isn't supported.
311 int qemu_chr_fe_set_msgfds(CharDriverState
*s
, int *fds
, int num
);
314 * @qemu_chr_fe_claim:
316 * Claim a backend before using it, should be called before calling
317 * qemu_chr_add_handlers().
319 * Returns: -1 if the backend is already in use by another frontend, 0 on
322 int qemu_chr_fe_claim(CharDriverState
*s
);
325 * @qemu_chr_fe_claim_no_fail:
327 * Like qemu_chr_fe_claim, but will exit qemu with an error when the
328 * backend is already in use.
330 void qemu_chr_fe_claim_no_fail(CharDriverState
*s
);
333 * @qemu_chr_fe_claim:
335 * Release a backend for use by another frontend.
337 * Returns: -1 if the backend is already in use by another frontend, 0 on
340 void qemu_chr_fe_release(CharDriverState
*s
);
343 * @qemu_chr_be_can_write:
345 * Determine how much data the front end can currently accept. This function
346 * returns the number of bytes the front end can accept. If it returns 0, the
347 * front end cannot receive data at the moment. The function must be polled
348 * to determine when data can be received.
350 * Returns: the number of bytes the front end can receive via @qemu_chr_be_write
352 int qemu_chr_be_can_write(CharDriverState
*s
);
355 * @qemu_chr_be_write:
357 * Write data from the back end to the front end. Before issuing this call,
358 * the caller should call @qemu_chr_be_can_write to determine how much data
359 * the front end can currently accept.
361 * @buf a buffer to receive data from the front end
362 * @len the number of bytes to receive from the front end
364 void qemu_chr_be_write(CharDriverState
*s
, uint8_t *buf
, int len
);
367 * @qemu_chr_be_write_impl:
369 * Implementation of back end writing. Used by replay module.
371 * @buf a buffer to receive data from the front end
372 * @len the number of bytes to receive from the front end
374 void qemu_chr_be_write_impl(CharDriverState
*s
, uint8_t *buf
, int len
);
377 * @qemu_chr_be_event:
379 * Send an event from the back end to the front end.
381 * @event the event to send
383 void qemu_chr_be_event(CharDriverState
*s
, int event
);
385 void qemu_chr_add_handlers(CharDriverState
*s
,
386 IOCanReadHandler
*fd_can_read
,
387 IOReadHandler
*fd_read
,
388 IOEventHandler
*fd_event
,
391 void qemu_chr_be_generic_open(CharDriverState
*s
);
392 void qemu_chr_accept_input(CharDriverState
*s
);
393 int qemu_chr_add_client(CharDriverState
*s
, int fd
);
394 CharDriverState
*qemu_chr_find(const char *name
);
395 bool chr_is_ringbuf(const CharDriverState
*chr
);
397 QemuOpts
*qemu_chr_parse_compat(const char *label
, const char *filename
);
399 void register_char_driver(const char *name
, ChardevBackendKind kind
,
400 void (*parse
)(QemuOpts
*opts
, ChardevBackend
*backend
, Error
**errp
),
401 CharDriverState
*(*create
)(const char *id
, ChardevBackend
*backend
,
402 ChardevReturn
*ret
, Error
**errp
));
404 extern int term_escape_char
;
408 typedef CharDriverState
*(VcHandler
)(ChardevVC
*vc
, Error
**errp
);
409 void register_vc_handler(VcHandler
*handler
);