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