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 struct ParallelIOArg {
  45     void *buffer;
  46     int count;
  47 };
  48
  49 #define CHR_IOCTL_SERIAL_SET_TIOCM   13
  50 #define CHR_IOCTL_SERIAL_GET_TIOCM   14
  51
  52 #define CHR_TIOCM_CTS   0x020
  53 #define CHR_TIOCM_CAR   0x040
  54 #define CHR_TIOCM_DSR   0x100
  55 #define CHR_TIOCM_RI    0x080
  56 #define CHR_TIOCM_DTR   0x002
  57 #define CHR_TIOCM_RTS   0x004
  58
  59 typedef void IOEventHandler(void *opaque, int event);
  60
  61 struct CharDriverState {
  62     QemuMutex chr_write_lock;
  63     void (*init)(struct CharDriverState *s);
  64     int (*chr_write)(struct CharDriverState *s, const uint8_t *buf, int len);
  65     int (*chr_sync_read)(struct CharDriverState *s,
  66                          const uint8_t *buf, int len);
  67     GSource *(*chr_add_watch)(struct CharDriverState *s, GIOCondition cond);
  68     void (*chr_update_read_handler)(struct CharDriverState *s);
  69     int (*chr_ioctl)(struct CharDriverState *s, int cmd, void *arg);
  70     int (*get_msgfds)(struct CharDriverState *s, int* fds, int num);
  71     int (*set_msgfds)(struct CharDriverState *s, int *fds, int num);
  72     int (*chr_add_client)(struct CharDriverState *chr, int fd);
  73     int (*chr_wait_connected)(struct CharDriverState *chr, Error **errp);
  74     IOEventHandler *chr_event;
  75     IOCanReadHandler *chr_can_read;
  76     IOReadHandler *chr_read;
  77     void *handler_opaque;
  78     void (*chr_close)(struct CharDriverState *chr);
  79     void (*chr_disconnect)(struct CharDriverState *chr);
  80     void (*chr_accept_input)(struct CharDriverState *chr);
  81     void (*chr_set_echo)(struct CharDriverState *chr, bool echo);
  82     void (*chr_set_fe_open)(struct CharDriverState *chr, int fe_open);
  83     void (*chr_fe_event)(struct CharDriverState *chr, int event);
  84     void *opaque;
  85     char *label;
  86     char *filename;
  87     int logfd;
  88     int be_open;
  89     int fe_open;
  90     int explicit_fe_open;
  91     int explicit_be_open;
  92     int avail_connections;
  93     int is_mux;
  94     guint fd_in_tag;
  95     QemuOpts *opts;
  96     bool replay;
  97     QTAILQ_ENTRY(CharDriverState) next;
  98 };
  99
 100 /**
 101  * qemu_chr_alloc:
 102  * @backend: the common backend config
 103  * @errp: pointer to a NULL-initialized error object
 104  *
 105  * Allocate and initialize a new CharDriverState.
 106  *
 107  * Returns: a newly allocated CharDriverState, or NULL on error.
 108  */
 109 CharDriverState *qemu_chr_alloc(ChardevCommon *backend, Error **errp);
 110
 111 /**
 112  * @qemu_chr_new_from_opts:
 113  *
 114  * Create a new character backend from a QemuOpts list.
 115  *
 116  * @opts see qemu-config.c for a list of valid options
 117  * @init not sure..
 118  *
 119  * Returns: a new character backend
 120  */
 121 CharDriverState *qemu_chr_new_from_opts(QemuOpts *opts,
 122                                     void (*init)(struct CharDriverState *s),
 123                                     Error **errp);
 124
 125 /**
 126  * @qemu_chr_parse_common:
 127  *
 128  * Parse the common options available to all character backends.
 129  *
 130  * @opts the options that still need parsing
 131  * @backend a new backend
 132  */
 133 void qemu_chr_parse_common(QemuOpts *opts, ChardevCommon *backend);
 134
 135 /**
 136  * @qemu_chr_new:
 137  *
 138  * Create a new character backend from a URI.
 139  *
 140  * @label the name of the backend
 141  * @filename the URI
 142  * @init not sure..
 143  *
 144  * Returns: a new character backend
 145  */
 146 CharDriverState *qemu_chr_new(const char *label, const char *filename,
 147                               void (*init)(struct CharDriverState *s));
 148 /**
 149  * @qemu_chr_disconnect:
 150  *
 151  * Close a fd accpeted by character backend.
 152  */
 153 void qemu_chr_disconnect(CharDriverState *chr);
 154
 155 /**
 156  * @qemu_chr_cleanup:
 157  *
 158  * Delete all chardevs (when leaving qemu)
 159  */
 160 void qemu_chr_cleanup(void);
 161
 162 /**
 163  * @qemu_chr_wait_connected:
 164  *
 165  * Wait for characted backend to be connected.
 166  */
 167 int qemu_chr_wait_connected(CharDriverState *chr, Error **errp);
 168
 169 /**
 170  * @qemu_chr_new_noreplay:
 171  *
 172  * Create a new character backend from a URI.
 173  * Character device communications are not written
 174  * into the replay log.
 175  *
 176  * @label the name of the backend
 177  * @filename the URI
 178  * @init not sure..
 179  *
 180  * Returns: a new character backend
 181  */
 182 CharDriverState *qemu_chr_new_noreplay(const char *label, const char *filename,
 183                                        void (*init)(struct CharDriverState *s));
 184
 185 /**
 186  * @qemu_chr_delete:
 187  *
 188  * Destroy a character backend and remove it from the list of
 189  * identified character backends.
 190  */
 191 void qemu_chr_delete(CharDriverState *chr);
 192
 193 /**
 194  * @qemu_chr_free:
 195  *
 196  * Destroy a character backend.
 197  */
 198 void qemu_chr_free(CharDriverState *chr);
 199
 200 /**
 201  * @qemu_chr_fe_set_echo:
 202  *
 203  * Ask the backend to override its normal echo setting.  This only really
 204  * applies to the stdio backend and is used by the QMP server such that you
 205  * can see what you type if you try to type QMP commands.
 206  *
 207  * @echo true to enable echo, false to disable echo
 208  */
 209 void qemu_chr_fe_set_echo(struct CharDriverState *chr, bool echo);
 210
 211 /**
 212  * @qemu_chr_fe_set_open:
 213  *
 214  * Set character frontend open status.  This is an indication that the
 215  * front end is ready (or not) to begin doing I/O.
 216  */
 217 void qemu_chr_fe_set_open(struct CharDriverState *chr, int fe_open);
 218
 219 /**
 220  * @qemu_chr_fe_event:
 221  *
 222  * Send an event from the front end to the back end.
 223  *
 224  * @event the event to send
 225  */
 226 void qemu_chr_fe_event(CharDriverState *s, int event);
 227
 228 /**
 229  * @qemu_chr_fe_printf:
 230  *
 231  * Write to a character backend using a printf style interface.
 232  * This function is thread-safe.
 233  *
 234  * @fmt see #printf
 235  */
 236 void qemu_chr_fe_printf(CharDriverState *s, const char *fmt, ...)
 237     GCC_FMT_ATTR(2, 3);
 238
 239 /**
 240  * @qemu_chr_fe_add_watch:
 241  *
 242  * If the backend is connected, create and add a #GSource that fires
 243  * when the given condition (typically G_IO_OUT|G_IO_HUP or G_IO_HUP)
 244  * is active; return the #GSource's tag.  If it is disconnected,
 245  * return 0.
 246  *
 247  * @cond the condition to poll for
 248  * @func the function to call when the condition happens
 249  * @user_data the opaque pointer to pass to @func
 250  */
 251 guint qemu_chr_fe_add_watch(CharDriverState *s, GIOCondition cond,
 252                             GIOFunc func, void *user_data);
 253
 254 /**
 255  * @qemu_chr_fe_write:
 256  *
 257  * Write data to a character backend from the front end.  This function
 258  * will send data from the front end to the back end.  This function
 259  * is thread-safe.
 260  *
 261  * @buf the data
 262  * @len the number of bytes to send
 263  *
 264  * Returns: the number of bytes consumed
 265  */
 266 int qemu_chr_fe_write(CharDriverState *s, const uint8_t *buf, int len);
 267
 268 /**
 269  * @qemu_chr_fe_write_all:
 270  *
 271  * Write data to a character backend from the front end.  This function will
 272  * send data from the front end to the back end.  Unlike @qemu_chr_fe_write,
 273  * this function will block if the back end cannot consume all of the data
 274  * attempted to be written.  This function is thread-safe.
 275  *
 276  * @buf the data
 277  * @len the number of bytes to send
 278  *
 279  * Returns: the number of bytes consumed
 280  */
 281 int qemu_chr_fe_write_all(CharDriverState *s, const uint8_t *buf, int len);
 282
 283 /**
 284  * @qemu_chr_fe_read_all:
 285  *
 286  * Read data to a buffer from the back end.
 287  *
 288  * @buf the data buffer
 289  * @len the number of bytes to read
 290  *
 291  * Returns: the number of bytes read
 292  */
 293 int qemu_chr_fe_read_all(CharDriverState *s, uint8_t *buf, int len);
 294
 295 /**
 296  * @qemu_chr_fe_ioctl:
 297  *
 298  * Issue a device specific ioctl to a backend.  This function is thread-safe.
 299  *
 300  * @cmd see CHR_IOCTL_*
 301  * @arg the data associated with @cmd
 302  *
 303  * Returns: if @cmd is not supported by the backend, -ENOTSUP, otherwise the
 304  *          return value depends on the semantics of @cmd
 305  */
 306 int qemu_chr_fe_ioctl(CharDriverState *s, int cmd, void *arg);
 307
 308 /**
 309  * @qemu_chr_fe_get_msgfd:
 310  *
 311  * For backends capable of fd passing, return the latest file descriptor passed
 312  * by a client.
 313  *
 314  * Returns: -1 if fd passing isn't supported or there is no pending file
 315  *          descriptor.  If a file descriptor is returned, subsequent calls to
 316  *          this function will return -1 until a client sends a new file
 317  *          descriptor.
 318  */
 319 int qemu_chr_fe_get_msgfd(CharDriverState *s);
 320
 321 /**
 322  * @qemu_chr_fe_get_msgfds:
 323  *
 324  * For backends capable of fd passing, return the number of file received
 325  * descriptors and fills the fds array up to num elements
 326  *
 327  * Returns: -1 if fd passing isn't supported or there are no pending file
 328  *          descriptors.  If file descriptors are returned, subsequent calls to
 329  *          this function will return -1 until a client sends a new set of file
 330  *          descriptors.
 331  */
 332 int qemu_chr_fe_get_msgfds(CharDriverState *s, int *fds, int num);
 333
 334 /**
 335  * @qemu_chr_fe_set_msgfds:
 336  *
 337  * For backends capable of fd passing, set an array of fds to be passed with
 338  * the next send operation.
 339  * A subsequent call to this function before calling a write function will
 340  * result in overwriting the fd array with the new value without being send.
 341  * Upon writing the message the fd array is freed.
 342  *
 343  * Returns: -1 if fd passing isn't supported.
 344  */
 345 int qemu_chr_fe_set_msgfds(CharDriverState *s, int *fds, int num);
 346
 347 /**
 348  * @qemu_chr_fe_claim:
 349  *
 350  * Claim a backend before using it, should be called before calling
 351  * qemu_chr_add_handlers().
 352  *
 353  * Returns: -1 if the backend is already in use by another frontend, 0 on
 354  *          success.
 355  */
 356 int qemu_chr_fe_claim(CharDriverState *s);
 357
 358 /**
 359  * @qemu_chr_fe_claim_no_fail:
 360  *
 361  * Like qemu_chr_fe_claim, but will exit qemu with an error when the
 362  * backend is already in use.
 363  */
 364 void qemu_chr_fe_claim_no_fail(CharDriverState *s);
 365
 366 /**
 367  * @qemu_chr_fe_claim:
 368  *
 369  * Release a backend for use by another frontend.
 370  *
 371  * Returns: -1 if the backend is already in use by another frontend, 0 on
 372  *          success.
 373  */
 374 void qemu_chr_fe_release(CharDriverState *s);
 375
 376 /**
 377  * @qemu_chr_be_can_write:
 378  *
 379  * Determine how much data the front end can currently accept.  This function
 380  * returns the number of bytes the front end can accept.  If it returns 0, the
 381  * front end cannot receive data at the moment.  The function must be polled
 382  * to determine when data can be received.
 383  *
 384  * Returns: the number of bytes the front end can receive via @qemu_chr_be_write
 385  */
 386 int qemu_chr_be_can_write(CharDriverState *s);
 387
 388 /**
 389  * @qemu_chr_be_write:
 390  *
 391  * Write data from the back end to the front end.  Before issuing this call,
 392  * the caller should call @qemu_chr_be_can_write to determine how much data
 393  * the front end can currently accept.
 394  *
 395  * @buf a buffer to receive data from the front end
 396  * @len the number of bytes to receive from the front end
 397  */
 398 void qemu_chr_be_write(CharDriverState *s, uint8_t *buf, int len);
 399
 400 /**
 401  * @qemu_chr_be_write_impl:
 402  *
 403  * Implementation of back end writing. Used by replay module.
 404  *
 405  * @buf a buffer to receive data from the front end
 406  * @len the number of bytes to receive from the front end
 407  */
 408 void qemu_chr_be_write_impl(CharDriverState *s, uint8_t *buf, int len);
 409
 410 /**
 411  * @qemu_chr_be_event:
 412  *
 413  * Send an event from the back end to the front end.
 414  *
 415  * @event the event to send
 416  */
 417 void qemu_chr_be_event(CharDriverState *s, int event);
 418
 419 void qemu_chr_add_handlers(CharDriverState *s,
 420                            IOCanReadHandler *fd_can_read,
 421                            IOReadHandler *fd_read,
 422                            IOEventHandler *fd_event,
 423                            void *opaque);
 424
 425 void qemu_chr_be_generic_open(CharDriverState *s);
 426 void qemu_chr_accept_input(CharDriverState *s);
 427 int qemu_chr_add_client(CharDriverState *s, int fd);
 428 CharDriverState *qemu_chr_find(const char *name);
 429 bool chr_is_ringbuf(const CharDriverState *chr);
 430
 431 QemuOpts *qemu_chr_parse_compat(const char *label, const char *filename);
 432
 433 void register_char_driver(const char *name, ChardevBackendKind kind,
 434         void (*parse)(QemuOpts *opts, ChardevBackend *backend, Error **errp),
 435         CharDriverState *(*create)(const char *id, ChardevBackend *backend,
 436                                    ChardevReturn *ret, Error **errp));
 437
 438 extern int term_escape_char;
 439
 440
 441 /* console.c */
 442 typedef CharDriverState *(VcHandler)(ChardevVC *vc, Error **errp);
 443 void register_vc_handler(VcHandler *handler);
 444
 445 #endif