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