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