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