include/sysemu/char.h

   1 #ifndef QEMU_CHAR_H
   2 #define QEMU_CHAR_H
   3
   4 #include "qemu-common.h"
   5 #include "qemu/queue.h"
   6 #include "qemu/option.h"
   7 #include "qemu/config-file.h"
   8 #include "block/aio.h"
   9 #include "qapi/qmp/qobject.h"
  10 #include "qapi/qmp/qstring.h"
  11 #include "qemu/main-loop.h"
  12
  13 /* character device */
  14
  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 */
  21
  22
  23 #define CHR_IOCTL_SERIAL_SET_PARAMS   1
  24 typedef struct {
  25     int speed;
  26     int parity;
  27     int data_bits;
  28     int stop_bits;
  29 } QEMUSerialSetParams;
  30
  31 #define CHR_IOCTL_SERIAL_SET_BREAK    2
  32
  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
  43
  44 #define CHR_IOCTL_SERIAL_SET_TIOCM   13
  45 #define CHR_IOCTL_SERIAL_GET_TIOCM   14
  46
  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
  53
  54 typedef void IOEventHandler(void *opaque, int event);
  55
  56 struct CharDriverState {
  57     void (*init)(struct CharDriverState *s);
  58     int (*chr_write)(struct CharDriverState *s, const uint8_t *buf, int len);
  59     GSource *(*chr_add_watch)(struct CharDriverState *s, GIOCondition cond);
  60     void (*chr_update_read_handler)(struct CharDriverState *s);
  61     int (*chr_ioctl)(struct CharDriverState *s, int cmd, void *arg);
  62     int (*get_msgfd)(struct CharDriverState *s);
  63     int (*chr_add_client)(struct CharDriverState *chr, int fd);
  64     IOEventHandler *chr_event;
  65     IOCanReadHandler *chr_can_read;
  66     IOReadHandler *chr_read;
  67     void *handler_opaque;
  68     void (*chr_close)(struct CharDriverState *chr);
  69     void (*chr_accept_input)(struct CharDriverState *chr);
  70     void (*chr_set_echo)(struct CharDriverState *chr, bool echo);
  71     void (*chr_set_fe_open)(struct CharDriverState *chr, int fe_open);
  72     void *opaque;
  73     char *label;
  74     char *filename;
  75     int be_open;
  76     int fe_open;
  77     int explicit_fe_open;
  78     int explicit_be_open;
  79     int avail_connections;
  80     int is_mux;
  81     QemuOpts *opts;
  82     QTAILQ_ENTRY(CharDriverState) next;
  83 };
  84
  85 /**
  86  * @qemu_chr_new_from_opts:
  87  *
  88  * Create a new character backend from a QemuOpts list.
  89  *
  90  * @opts see qemu-config.c for a list of valid options
  91  * @init not sure..
  92  *
  93  * Returns: a new character backend
  94  */
  95 CharDriverState *qemu_chr_new_from_opts(QemuOpts *opts,
  96                                     void (*init)(struct CharDriverState *s),
  97                                     Error **errp);
  98
  99 /**
 100  * @qemu_chr_new:
 101  *
 102  * Create a new character backend from a URI.
 103  *
 104  * @label the name of the backend
 105  * @filename the URI
 106  * @init not sure..
 107  *
 108  * Returns: a new character backend
 109  */
 110 CharDriverState *qemu_chr_new(const char *label, const char *filename,
 111                               void (*init)(struct CharDriverState *s));
 112
 113 /**
 114  * @qemu_chr_delete:
 115  *
 116  * Destroy a character backend.
 117  */
 118 void qemu_chr_delete(CharDriverState *chr);
 119
 120 /**
 121  * @qemu_chr_fe_set_echo:
 122  *
 123  * Ask the backend to override its normal echo setting.  This only really
 124  * applies to the stdio backend and is used by the QMP server such that you
 125  * can see what you type if you try to type QMP commands.
 126  *
 127  * @echo true to enable echo, false to disable echo
 128  */
 129 void qemu_chr_fe_set_echo(struct CharDriverState *chr, bool echo);
 130
 131 /**
 132  * @qemu_chr_fe_set_open:
 133  *
 134  * Set character frontend open status.  This is an indication that the
 135  * front end is ready (or not) to begin doing I/O.
 136  */
 137 void qemu_chr_fe_set_open(struct CharDriverState *chr, int fe_open);
 138
 139 /**
 140  * @qemu_chr_fe_printf:
 141  *
 142  * Write to a character backend using a printf style interface.
 143  *
 144  * @fmt see #printf
 145  */
 146 void qemu_chr_fe_printf(CharDriverState *s, const char *fmt, ...)
 147     GCC_FMT_ATTR(2, 3);
 148
 149 int qemu_chr_fe_add_watch(CharDriverState *s, GIOCondition cond,
 150                           GIOFunc func, void *user_data);
 151
 152 /**
 153  * @qemu_chr_fe_write:
 154  *
 155  * Write data to a character backend from the front end.  This function will
 156  * send data from the front end to the back end.
 157  *
 158  * @buf the data
 159  * @len the number of bytes to send
 160  *
 161  * Returns: the number of bytes consumed
 162  */
 163 int qemu_chr_fe_write(CharDriverState *s, const uint8_t *buf, int len);
 164
 165 /**
 166  * @qemu_chr_fe_write_all:
 167  *
 168  * Write data to a character backend from the front end.  This function will
 169  * send data from the front end to the back end.  Unlike @qemu_chr_fe_write,
 170  * this function will block if the back end cannot consume all of the data
 171  * attempted to be written.
 172  *
 173  * @buf the data
 174  * @len the number of bytes to send
 175  *
 176  * Returns: the number of bytes consumed
 177  */
 178 int qemu_chr_fe_write_all(CharDriverState *s, const uint8_t *buf, int len);
 179
 180 /**
 181  * @qemu_chr_fe_ioctl:
 182  *
 183  * Issue a device specific ioctl to a backend.
 184  *
 185  * @cmd see CHR_IOCTL_*
 186  * @arg the data associated with @cmd
 187  *
 188  * Returns: if @cmd is not supported by the backend, -ENOTSUP, otherwise the
 189  *          return value depends on the semantics of @cmd
 190  */
 191 int qemu_chr_fe_ioctl(CharDriverState *s, int cmd, void *arg);
 192
 193 /**
 194  * @qemu_chr_fe_get_msgfd:
 195  *
 196  * For backends capable of fd passing, return the latest file descriptor passed
 197  * by a client.
 198  *
 199  * Returns: -1 if fd passing isn't supported or there is no pending file
 200  *          descriptor.  If a file descriptor is returned, subsequent calls to
 201  *          this function will return -1 until a client sends a new file
 202  *          descriptor.
 203  */
 204 int qemu_chr_fe_get_msgfd(CharDriverState *s);
 205
 206 /**
 207  * @qemu_chr_fe_claim:
 208  *
 209  * Claim a backend before using it, should be called before calling
 210  * qemu_chr_add_handlers().
 211  *
 212  * Returns: -1 if the backend is already in use by another frontend, 0 on
 213  *          success.
 214  */
 215 int qemu_chr_fe_claim(CharDriverState *s);
 216
 217 /**
 218  * @qemu_chr_fe_claim_no_fail:
 219  *
 220  * Like qemu_chr_fe_claim, but will exit qemu with an error when the
 221  * backend is already in use.
 222  */
 223 void qemu_chr_fe_claim_no_fail(CharDriverState *s);
 224
 225 /**
 226  * @qemu_chr_fe_claim:
 227  *
 228  * Release a backend for use by another frontend.
 229  *
 230  * Returns: -1 if the backend is already in use by another frontend, 0 on
 231  *          success.
 232  */
 233 void qemu_chr_fe_release(CharDriverState *s);
 234
 235 /**
 236  * @qemu_chr_be_can_write:
 237  *
 238  * Determine how much data the front end can currently accept.  This function
 239  * returns the number of bytes the front end can accept.  If it returns 0, the
 240  * front end cannot receive data at the moment.  The function must be polled
 241  * to determine when data can be received.
 242  *
 243  * Returns: the number of bytes the front end can receive via @qemu_chr_be_write
 244  */
 245 int qemu_chr_be_can_write(CharDriverState *s);
 246
 247 /**
 248  * @qemu_chr_be_write:
 249  *
 250  * Write data from the back end to the front end.  Before issuing this call,
 251  * the caller should call @qemu_chr_be_can_write to determine how much data
 252  * the front end can currently accept.
 253  *
 254  * @buf a buffer to receive data from the front end
 255  * @len the number of bytes to receive from the front end
 256  */
 257 void qemu_chr_be_write(CharDriverState *s, uint8_t *buf, int len);
 258
 259
 260 /**
 261  * @qemu_chr_be_event:
 262  *
 263  * Send an event from the back end to the front end.
 264  *
 265  * @event the event to send
 266  */
 267 void qemu_chr_be_event(CharDriverState *s, int event);
 268
 269 void qemu_chr_add_handlers(CharDriverState *s,
 270                            IOCanReadHandler *fd_can_read,
 271                            IOReadHandler *fd_read,
 272                            IOEventHandler *fd_event,
 273                            void *opaque);
 274
 275 void qemu_chr_be_generic_open(CharDriverState *s);
 276 void qemu_chr_accept_input(CharDriverState *s);
 277 int qemu_chr_add_client(CharDriverState *s, int fd);
 278 void qemu_chr_info_print(Monitor *mon, const QObject *ret_data);
 279 void qemu_chr_info(Monitor *mon, QObject **ret_data);
 280 CharDriverState *qemu_chr_find(const char *name);
 281
 282 QemuOpts *qemu_chr_parse_compat(const char *label, const char *filename);
 283
 284 void register_char_driver(const char *name, CharDriverState *(*open)(QemuOpts *));
 285 void register_char_driver_qapi(const char *name, ChardevBackendKind kind,
 286         void (*parse)(QemuOpts *opts, ChardevBackend *backend, Error **errp));
 287
 288 /* add an eventfd to the qemu devices that are polled */
 289 CharDriverState *qemu_chr_open_eventfd(int eventfd);
 290
 291 extern int term_escape_char;
 292
 293 CharDriverState *qemu_char_get_next_serial(void);
 294
 295 /* msmouse */
 296 CharDriverState *qemu_chr_open_msmouse(void);
 297
 298 /* baum.c */
 299 CharDriverState *chr_baum_init(void);
 300
 301 #endif