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