307 lines
8.9 KiB
C
307 lines
8.9 KiB
C
#ifndef QEMU_CHAR_H
|
|
#define QEMU_CHAR_H
|
|
|
|
#include "qemu-common.h"
|
|
#include "qemu/queue.h"
|
|
#include "qemu/option.h"
|
|
#include "qemu/config-file.h"
|
|
#include "block/aio.h"
|
|
#include "qapi/qmp/qobject.h"
|
|
#include "qapi/qmp/qstring.h"
|
|
#include "qemu/main-loop.h"
|
|
|
|
/* character device */
|
|
|
|
#define CHR_EVENT_BREAK 0 /* serial break char */
|
|
#define CHR_EVENT_FOCUS 1 /* focus to this terminal (modal input needed) */
|
|
#define CHR_EVENT_OPENED 2 /* new connection established */
|
|
#define CHR_EVENT_MUX_IN 3 /* mux-focus was set to this terminal */
|
|
#define CHR_EVENT_MUX_OUT 4 /* mux-focus will move on */
|
|
#define CHR_EVENT_CLOSED 5 /* connection closed */
|
|
|
|
|
|
#define CHR_IOCTL_SERIAL_SET_PARAMS 1
|
|
typedef struct {
|
|
int speed;
|
|
int parity;
|
|
int data_bits;
|
|
int stop_bits;
|
|
} QEMUSerialSetParams;
|
|
|
|
#define CHR_IOCTL_SERIAL_SET_BREAK 2
|
|
|
|
#define CHR_IOCTL_PP_READ_DATA 3
|
|
#define CHR_IOCTL_PP_WRITE_DATA 4
|
|
#define CHR_IOCTL_PP_READ_CONTROL 5
|
|
#define CHR_IOCTL_PP_WRITE_CONTROL 6
|
|
#define CHR_IOCTL_PP_READ_STATUS 7
|
|
#define CHR_IOCTL_PP_EPP_READ_ADDR 8
|
|
#define CHR_IOCTL_PP_EPP_READ 9
|
|
#define CHR_IOCTL_PP_EPP_WRITE_ADDR 10
|
|
#define CHR_IOCTL_PP_EPP_WRITE 11
|
|
#define CHR_IOCTL_PP_DATA_DIR 12
|
|
|
|
#define CHR_IOCTL_SERIAL_SET_TIOCM 13
|
|
#define CHR_IOCTL_SERIAL_GET_TIOCM 14
|
|
|
|
#define CHR_TIOCM_CTS 0x020
|
|
#define CHR_TIOCM_CAR 0x040
|
|
#define CHR_TIOCM_DSR 0x100
|
|
#define CHR_TIOCM_RI 0x080
|
|
#define CHR_TIOCM_DTR 0x002
|
|
#define CHR_TIOCM_RTS 0x004
|
|
|
|
typedef void IOEventHandler(void *opaque, int event);
|
|
|
|
struct CharDriverState {
|
|
void (*init)(struct CharDriverState *s);
|
|
int (*chr_write)(struct CharDriverState *s, const uint8_t *buf, int len);
|
|
GSource *(*chr_add_watch)(struct CharDriverState *s, GIOCondition cond);
|
|
void (*chr_update_read_handler)(struct CharDriverState *s);
|
|
int (*chr_ioctl)(struct CharDriverState *s, int cmd, void *arg);
|
|
int (*get_msgfd)(struct CharDriverState *s);
|
|
int (*chr_add_client)(struct CharDriverState *chr, int fd);
|
|
IOEventHandler *chr_event;
|
|
IOCanReadHandler *chr_can_read;
|
|
IOReadHandler *chr_read;
|
|
void *handler_opaque;
|
|
void (*chr_close)(struct CharDriverState *chr);
|
|
void (*chr_accept_input)(struct CharDriverState *chr);
|
|
void (*chr_set_echo)(struct CharDriverState *chr, bool echo);
|
|
void (*chr_set_fe_open)(struct CharDriverState *chr, int fe_open);
|
|
void *opaque;
|
|
int idle_tag;
|
|
char *label;
|
|
char *filename;
|
|
int be_open;
|
|
int fe_open;
|
|
int explicit_fe_open;
|
|
int avail_connections;
|
|
QemuOpts *opts;
|
|
QTAILQ_ENTRY(CharDriverState) next;
|
|
};
|
|
|
|
/**
|
|
* @qemu_chr_new_from_opts:
|
|
*
|
|
* Create a new character backend from a QemuOpts list.
|
|
*
|
|
* @opts see qemu-config.c for a list of valid options
|
|
* @init not sure..
|
|
*
|
|
* Returns: a new character backend
|
|
*/
|
|
CharDriverState *qemu_chr_new_from_opts(QemuOpts *opts,
|
|
void (*init)(struct CharDriverState *s),
|
|
Error **errp);
|
|
|
|
/**
|
|
* @qemu_chr_new:
|
|
*
|
|
* Create a new character backend from a URI.
|
|
*
|
|
* @label the name of the backend
|
|
* @filename the URI
|
|
* @init not sure..
|
|
*
|
|
* Returns: a new character backend
|
|
*/
|
|
CharDriverState *qemu_chr_new(const char *label, const char *filename,
|
|
void (*init)(struct CharDriverState *s));
|
|
|
|
/**
|
|
* @qemu_chr_delete:
|
|
*
|
|
* Destroy a character backend.
|
|
*/
|
|
void qemu_chr_delete(CharDriverState *chr);
|
|
|
|
/**
|
|
* @qemu_chr_fe_set_echo:
|
|
*
|
|
* Ask the backend to override its normal echo setting. This only really
|
|
* applies to the stdio backend and is used by the QMP server such that you
|
|
* can see what you type if you try to type QMP commands.
|
|
*
|
|
* @echo true to enable echo, false to disable echo
|
|
*/
|
|
void qemu_chr_fe_set_echo(struct CharDriverState *chr, bool echo);
|
|
|
|
/**
|
|
* @qemu_chr_fe_set_open:
|
|
*
|
|
* Set character frontend open status. This is an indication that the
|
|
* front end is ready (or not) to begin doing I/O.
|
|
*/
|
|
void qemu_chr_fe_set_open(struct CharDriverState *chr, int fe_open);
|
|
|
|
/**
|
|
* @qemu_chr_fe_printf:
|
|
*
|
|
* Write to a character backend using a printf style interface.
|
|
*
|
|
* @fmt see #printf
|
|
*/
|
|
void qemu_chr_fe_printf(CharDriverState *s, const char *fmt, ...)
|
|
GCC_FMT_ATTR(2, 3);
|
|
|
|
int qemu_chr_fe_add_watch(CharDriverState *s, GIOCondition cond,
|
|
GIOFunc func, void *user_data);
|
|
|
|
/**
|
|
* @qemu_chr_fe_write:
|
|
*
|
|
* Write data to a character backend from the front end. This function will
|
|
* send data from the front end to the back end.
|
|
*
|
|
* @buf the data
|
|
* @len the number of bytes to send
|
|
*
|
|
* Returns: the number of bytes consumed
|
|
*/
|
|
int qemu_chr_fe_write(CharDriverState *s, const uint8_t *buf, int len);
|
|
|
|
/**
|
|
* @qemu_chr_fe_write_all:
|
|
*
|
|
* Write data to a character backend from the front end. This function will
|
|
* send data from the front end to the back end. Unlike @qemu_chr_fe_write,
|
|
* this function will block if the back end cannot consume all of the data
|
|
* attempted to be written.
|
|
*
|
|
* @buf the data
|
|
* @len the number of bytes to send
|
|
*
|
|
* Returns: the number of bytes consumed
|
|
*/
|
|
int qemu_chr_fe_write_all(CharDriverState *s, const uint8_t *buf, int len);
|
|
|
|
/**
|
|
* @qemu_chr_fe_ioctl:
|
|
*
|
|
* Issue a device specific ioctl to a backend.
|
|
*
|
|
* @cmd see CHR_IOCTL_*
|
|
* @arg the data associated with @cmd
|
|
*
|
|
* Returns: if @cmd is not supported by the backend, -ENOTSUP, otherwise the
|
|
* return value depends on the semantics of @cmd
|
|
*/
|
|
int qemu_chr_fe_ioctl(CharDriverState *s, int cmd, void *arg);
|
|
|
|
/**
|
|
* @qemu_chr_fe_get_msgfd:
|
|
*
|
|
* For backends capable of fd passing, return the latest file descriptor passed
|
|
* by a client.
|
|
*
|
|
* Returns: -1 if fd passing isn't supported or there is no pending file
|
|
* descriptor. If a file descriptor is returned, subsequent calls to
|
|
* this function will return -1 until a client sends a new file
|
|
* descriptor.
|
|
*/
|
|
int qemu_chr_fe_get_msgfd(CharDriverState *s);
|
|
|
|
/**
|
|
* @qemu_chr_fe_claim:
|
|
*
|
|
* Claim a backend before using it, should be called before calling
|
|
* qemu_chr_add_handlers().
|
|
*
|
|
* Returns: -1 if the backend is already in use by another frontend, 0 on
|
|
* success.
|
|
*/
|
|
int qemu_chr_fe_claim(CharDriverState *s);
|
|
|
|
/**
|
|
* @qemu_chr_fe_claim_no_fail:
|
|
*
|
|
* Like qemu_chr_fe_claim, but will exit qemu with an error when the
|
|
* backend is already in use.
|
|
*/
|
|
void qemu_chr_fe_claim_no_fail(CharDriverState *s);
|
|
|
|
/**
|
|
* @qemu_chr_fe_claim:
|
|
*
|
|
* Release a backend for use by another frontend.
|
|
*
|
|
* Returns: -1 if the backend is already in use by another frontend, 0 on
|
|
* success.
|
|
*/
|
|
void qemu_chr_fe_release(CharDriverState *s);
|
|
|
|
/**
|
|
* @qemu_chr_be_can_write:
|
|
*
|
|
* Determine how much data the front end can currently accept. This function
|
|
* returns the number of bytes the front end can accept. If it returns 0, the
|
|
* front end cannot receive data at the moment. The function must be polled
|
|
* to determine when data can be received.
|
|
*
|
|
* Returns: the number of bytes the front end can receive via @qemu_chr_be_write
|
|
*/
|
|
int qemu_chr_be_can_write(CharDriverState *s);
|
|
|
|
/**
|
|
* @qemu_chr_be_write:
|
|
*
|
|
* Write data from the back end to the front end. Before issuing this call,
|
|
* the caller should call @qemu_chr_be_can_write to determine how much data
|
|
* the front end can currently accept.
|
|
*
|
|
* @buf a buffer to receive data from the front end
|
|
* @len the number of bytes to receive from the front end
|
|
*/
|
|
void qemu_chr_be_write(CharDriverState *s, uint8_t *buf, int len);
|
|
|
|
|
|
/**
|
|
* @qemu_chr_be_event:
|
|
*
|
|
* Send an event from the back end to the front end.
|
|
*
|
|
* @event the event to send
|
|
*/
|
|
void qemu_chr_be_event(CharDriverState *s, int event);
|
|
|
|
void qemu_chr_add_handlers(CharDriverState *s,
|
|
IOCanReadHandler *fd_can_read,
|
|
IOReadHandler *fd_read,
|
|
IOEventHandler *fd_event,
|
|
void *opaque);
|
|
|
|
void qemu_chr_be_generic_open(CharDriverState *s);
|
|
void qemu_chr_accept_input(CharDriverState *s);
|
|
int qemu_chr_add_client(CharDriverState *s, int fd);
|
|
void qemu_chr_info_print(Monitor *mon, const QObject *ret_data);
|
|
void qemu_chr_info(Monitor *mon, QObject **ret_data);
|
|
CharDriverState *qemu_chr_find(const char *name);
|
|
|
|
QemuOpts *qemu_chr_parse_compat(const char *label, const char *filename);
|
|
|
|
void register_char_driver(const char *name, CharDriverState *(*open)(QemuOpts *));
|
|
void register_char_driver_qapi(const char *name, int kind,
|
|
void (*parse)(QemuOpts *opts, ChardevBackend *backend, Error **errp));
|
|
|
|
/* add an eventfd to the qemu devices that are polled */
|
|
CharDriverState *qemu_chr_open_eventfd(int eventfd);
|
|
|
|
extern int term_escape_char;
|
|
|
|
/* memory chardev */
|
|
void qemu_chr_init_mem(CharDriverState *chr);
|
|
void qemu_chr_close_mem(CharDriverState *chr);
|
|
QString *qemu_chr_mem_to_qs(CharDriverState *chr);
|
|
size_t qemu_chr_mem_osize(const CharDriverState *chr);
|
|
|
|
CharDriverState *qemu_char_get_next_serial(void);
|
|
|
|
/* msmouse */
|
|
CharDriverState *qemu_chr_open_msmouse(void);
|
|
|
|
/* baum.c */
|
|
CharDriverState *chr_baum_init(void);
|
|
|
|
#endif
|