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