]>
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 #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
);
85 int avail_connections
;
89 QTAILQ_ENTRY(CharDriverState
) next
;
94 * @backend: the common backend config
95 * @errp: pointer to a NULL-initialized error object
97 * Allocate and initialize a new CharDriverState.
99 * Returns: a newly allocated CharDriverState, or NULL on error.
101 CharDriverState
*qemu_chr_alloc(ChardevCommon
*backend
, Error
**errp
);
104 * @qemu_chr_new_from_opts:
106 * Create a new character backend from a QemuOpts list.
108 * @opts see qemu-config.c for a list of valid options
111 * Returns: a new character backend
113 CharDriverState
*qemu_chr_new_from_opts(QemuOpts
*opts
,
114 void (*init
)(struct CharDriverState
*s
),
120 * Create a new character backend from a URI.
122 * @label the name of the backend
126 * Returns: a new character backend
128 CharDriverState
*qemu_chr_new(const char *label
, const char *filename
,
129 void (*init
)(struct CharDriverState
*s
));
134 * Destroy a character backend and remove it from the list of
135 * identified character backends.
137 void qemu_chr_delete(CharDriverState
*chr
);
142 * Destroy a character backend.
144 void qemu_chr_free(CharDriverState
*chr
);
147 * @qemu_chr_fe_set_echo:
149 * Ask the backend to override its normal echo setting. This only really
150 * applies to the stdio backend and is used by the QMP server such that you
151 * can see what you type if you try to type QMP commands.
153 * @echo true to enable echo, false to disable echo
155 void qemu_chr_fe_set_echo(struct CharDriverState
*chr
, bool echo
);
158 * @qemu_chr_fe_set_open:
160 * Set character frontend open status. This is an indication that the
161 * front end is ready (or not) to begin doing I/O.
163 void qemu_chr_fe_set_open(struct CharDriverState
*chr
, int fe_open
);
166 * @qemu_chr_fe_event:
168 * Send an event from the front end to the back end.
170 * @event the event to send
172 void qemu_chr_fe_event(CharDriverState
*s
, int event
);
175 * @qemu_chr_fe_printf:
177 * Write to a character backend using a printf style interface.
178 * This function is thread-safe.
182 void qemu_chr_fe_printf(CharDriverState
*s
, const char *fmt
, ...)
185 int qemu_chr_fe_add_watch(CharDriverState
*s
, GIOCondition cond
,
186 GIOFunc func
, void *user_data
);
189 * @qemu_chr_fe_write:
191 * Write data to a character backend from the front end. This function
192 * will send data from the front end to the back end. This function
196 * @len the number of bytes to send
198 * Returns: the number of bytes consumed
200 int qemu_chr_fe_write(CharDriverState
*s
, const uint8_t *buf
, int len
);
203 * @qemu_chr_fe_write_all:
205 * Write data to a character backend from the front end. This function will
206 * send data from the front end to the back end. Unlike @qemu_chr_fe_write,
207 * this function will block if the back end cannot consume all of the data
208 * attempted to be written. This function is thread-safe.
211 * @len the number of bytes to send
213 * Returns: the number of bytes consumed
215 int qemu_chr_fe_write_all(CharDriverState
*s
, const uint8_t *buf
, int len
);
218 * @qemu_chr_fe_read_all:
220 * Read data to a buffer from the back end.
222 * @buf the data buffer
223 * @len the number of bytes to read
225 * Returns: the number of bytes read
227 int qemu_chr_fe_read_all(CharDriverState
*s
, uint8_t *buf
, int len
);
230 * @qemu_chr_fe_ioctl:
232 * Issue a device specific ioctl to a backend. This function is thread-safe.
234 * @cmd see CHR_IOCTL_*
235 * @arg the data associated with @cmd
237 * Returns: if @cmd is not supported by the backend, -ENOTSUP, otherwise the
238 * return value depends on the semantics of @cmd
240 int qemu_chr_fe_ioctl(CharDriverState
*s
, int cmd
, void *arg
);
243 * @qemu_chr_fe_get_msgfd:
245 * For backends capable of fd passing, return the latest file descriptor passed
248 * Returns: -1 if fd passing isn't supported or there is no pending file
249 * descriptor. If a file descriptor is returned, subsequent calls to
250 * this function will return -1 until a client sends a new file
253 int qemu_chr_fe_get_msgfd(CharDriverState
*s
);
256 * @qemu_chr_fe_get_msgfds:
258 * For backends capable of fd passing, return the number of file received
259 * descriptors and fills the fds array up to num elements
261 * Returns: -1 if fd passing isn't supported or there are no pending file
262 * descriptors. If file descriptors are returned, subsequent calls to
263 * this function will return -1 until a client sends a new set of file
266 int qemu_chr_fe_get_msgfds(CharDriverState
*s
, int *fds
, int num
);
269 * @qemu_chr_fe_set_msgfds:
271 * For backends capable of fd passing, set an array of fds to be passed with
272 * the next send operation.
273 * A subsequent call to this function before calling a write function will
274 * result in overwriting the fd array with the new value without being send.
275 * Upon writing the message the fd array is freed.
277 * Returns: -1 if fd passing isn't supported.
279 int qemu_chr_fe_set_msgfds(CharDriverState
*s
, int *fds
, int num
);
282 * @qemu_chr_fe_claim:
284 * Claim a backend before using it, should be called before calling
285 * qemu_chr_add_handlers().
287 * Returns: -1 if the backend is already in use by another frontend, 0 on
290 int qemu_chr_fe_claim(CharDriverState
*s
);
293 * @qemu_chr_fe_claim_no_fail:
295 * Like qemu_chr_fe_claim, but will exit qemu with an error when the
296 * backend is already in use.
298 void qemu_chr_fe_claim_no_fail(CharDriverState
*s
);
301 * @qemu_chr_fe_claim:
303 * Release a backend for use by another frontend.
305 * Returns: -1 if the backend is already in use by another frontend, 0 on
308 void qemu_chr_fe_release(CharDriverState
*s
);
311 * @qemu_chr_be_can_write:
313 * Determine how much data the front end can currently accept. This function
314 * returns the number of bytes the front end can accept. If it returns 0, the
315 * front end cannot receive data at the moment. The function must be polled
316 * to determine when data can be received.
318 * Returns: the number of bytes the front end can receive via @qemu_chr_be_write
320 int qemu_chr_be_can_write(CharDriverState
*s
);
323 * @qemu_chr_be_write:
325 * Write data from the back end to the front end. Before issuing this call,
326 * the caller should call @qemu_chr_be_can_write to determine how much data
327 * the front end can currently accept.
329 * @buf a buffer to receive data from the front end
330 * @len the number of bytes to receive from the front end
332 void qemu_chr_be_write(CharDriverState
*s
, uint8_t *buf
, int len
);
336 * @qemu_chr_be_event:
338 * Send an event from the back end to the front end.
340 * @event the event to send
342 void qemu_chr_be_event(CharDriverState
*s
, int event
);
344 void qemu_chr_add_handlers(CharDriverState
*s
,
345 IOCanReadHandler
*fd_can_read
,
346 IOReadHandler
*fd_read
,
347 IOEventHandler
*fd_event
,
350 void qemu_chr_be_generic_open(CharDriverState
*s
);
351 void qemu_chr_accept_input(CharDriverState
*s
);
352 int qemu_chr_add_client(CharDriverState
*s
, int fd
);
353 CharDriverState
*qemu_chr_find(const char *name
);
354 bool chr_is_ringbuf(const CharDriverState
*chr
);
356 QemuOpts
*qemu_chr_parse_compat(const char *label
, const char *filename
);
358 void register_char_driver(const char *name
, ChardevBackendKind kind
,
359 void (*parse
)(QemuOpts
*opts
, ChardevBackend
*backend
, Error
**errp
),
360 CharDriverState
*(*create
)(const char *id
, ChardevBackend
*backend
,
361 ChardevReturn
*ret
, Error
**errp
));
363 /* add an eventfd to the qemu devices that are polled */
364 CharDriverState
*qemu_chr_open_eventfd(int eventfd
);
366 extern int term_escape_char
;
368 CharDriverState
*qemu_char_get_next_serial(void);
371 typedef CharDriverState
*(VcHandler
)(ChardevVC
*vc
, Error
**errp
);
372 void register_vc_handler(VcHandler
*handler
);