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