include/char/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     void (*init)(struct CharDriverState *s);
  58     int (*chr_write)(struct CharDriverState *s, const uint8_t *buf, int len);
  59     GSource *(*chr_add_watch)(struct CharDriverState *s, GIOCondition cond);
  60     void (*chr_update_read_handler)(struct CharDriverState *s);
  61     int (*chr_ioctl)(struct CharDriverState *s, int cmd, void *arg);
  62     int (*get_msgfd)(struct CharDriverState *s);
  63     int (*chr_add_client)(struct CharDriverState *chr, int fd);
  64     IOEventHandler *chr_event;
  65     IOCanReadHandler *chr_can_read;
  66     IOReadHandler *chr_read;
  67     void *handler_opaque;
  68     void (*chr_close)(struct CharDriverState *chr);
  69     void (*chr_accept_input)(struct CharDriverState *chr);
  70     void (*chr_set_echo)(struct CharDriverState *chr, bool echo);
  71     void (*chr_guest_open)(struct CharDriverState *chr);
  72     void (*chr_guest_close)(struct CharDriverState *chr);
  73     void *opaque;
  74     int idle_tag;
  75     char *label;
  76     char *filename;
  77     int be_open;
  78     int fe_open;
  79     int avail_connections;
  80     QemuOpts *opts;
  81     QTAILQ_ENTRY(CharDriverState) next;
  82 };
  83
  84 /**
  85  * @qemu_chr_new_from_opts:
  86  *
  87  * Create a new character backend from a QemuOpts list.
  88  *
  89  * @opts see qemu-config.c for a list of valid options
  90  * @init not sure..
  91  *
  92  * Returns: a new character backend
  93  */
  94 CharDriverState *qemu_chr_new_from_opts(QemuOpts *opts,
  95                                     void (*init)(struct CharDriverState *s),
  96                                     Error **errp);
  97
  98 /**
  99  * @qemu_chr_new:
 100  *
 101  * Create a new character backend from a URI.
 102  *
 103  * @label the name of the backend
 104  * @filename the URI
 105  * @init not sure..
 106  *
 107  * Returns: a new character backend
 108  */
 109 CharDriverState *qemu_chr_new(const char *label, const char *filename,
 110                               void (*init)(struct CharDriverState *s));
 111
 112 /**
 113  * @qemu_chr_delete:
 114  *
 115  * Destroy a character backend.
 116  */
 117 void qemu_chr_delete(CharDriverState *chr);
 118
 119 /**
 120  * @qemu_chr_fe_set_echo:
 121  *
 122  * Ask the backend to override its normal echo setting.  This only really
 123  * applies to the stdio backend and is used by the QMP server such that you
 124  * can see what you type if you try to type QMP commands.
 125  *
 126  * @echo true to enable echo, false to disable echo
 127  */
 128 void qemu_chr_fe_set_echo(struct CharDriverState *chr, bool echo);
 129
 130 /**
 131  * @qemu_chr_fe_open:
 132  *
 133  * Open a character backend.  This function call is an indication that the
 134  * front end is ready to begin doing I/O.
 135  */
 136 void qemu_chr_fe_open(struct CharDriverState *chr);
 137
 138 /**
 139  * @qemu_chr_fe_close:
 140  *
 141  * Close a character backend.  This function call indicates that the front end
 142  * no longer is able to process I/O.  To process I/O again, the front end will
 143  * call @qemu_chr_fe_open.
 144  */
 145 void qemu_chr_fe_close(struct CharDriverState *chr);
 146
 147 /**
 148  * @qemu_chr_fe_printf:
 149  *
 150  * Write to a character backend using a printf style interface.
 151  *
 152  * @fmt see #printf
 153  */
 154 void qemu_chr_fe_printf(CharDriverState *s, const char *fmt, ...)
 155     GCC_FMT_ATTR(2, 3);
 156
 157 int qemu_chr_fe_add_watch(CharDriverState *s, GIOCondition cond,
 158                           GIOFunc func, void *user_data);
 159
 160 /**
 161  * @qemu_chr_fe_write:
 162  *
 163  * Write data to a character backend from the front end.  This function will
 164  * send data from the front end to the back end.
 165  *
 166  * @buf the data
 167  * @len the number of bytes to send
 168  *
 169  * Returns: the number of bytes consumed
 170  */
 171 int qemu_chr_fe_write(CharDriverState *s, const uint8_t *buf, int len);
 172
 173 /**
 174  * @qemu_chr_fe_write_all:
 175  *
 176  * Write data to a character backend from the front end.  This function will
 177  * send data from the front end to the back end.  Unlike @qemu_chr_fe_write,
 178  * this function will block if the back end cannot consume all of the data
 179  * attempted to be written.
 180  *
 181  * @buf the data
 182  * @len the number of bytes to send
 183  *
 184  * Returns: the number of bytes consumed
 185  */
 186 int qemu_chr_fe_write_all(CharDriverState *s, const uint8_t *buf, int len);
 187
 188 /**
 189  * @qemu_chr_fe_ioctl:
 190  *
 191  * Issue a device specific ioctl to a backend.
 192  *
 193  * @cmd see CHR_IOCTL_*
 194  * @arg the data associated with @cmd
 195  *
 196  * Returns: if @cmd is not supported by the backend, -ENOTSUP, otherwise the
 197  *          return value depends on the semantics of @cmd
 198  */
 199 int qemu_chr_fe_ioctl(CharDriverState *s, int cmd, void *arg);
 200
 201 /**
 202  * @qemu_chr_fe_get_msgfd:
 203  *
 204  * For backends capable of fd passing, return the latest file descriptor passed
 205  * by a client.
 206  *
 207  * Returns: -1 if fd passing isn't supported or there is no pending file
 208  *          descriptor.  If a file descriptor is returned, subsequent calls to
 209  *          this function will return -1 until a client sends a new file
 210  *          descriptor.
 211  */
 212 int qemu_chr_fe_get_msgfd(CharDriverState *s);
 213
 214 /**
 215  * @qemu_chr_be_can_write:
 216  *
 217  * Determine how much data the front end can currently accept.  This function
 218  * returns the number of bytes the front end can accept.  If it returns 0, the
 219  * front end cannot receive data at the moment.  The function must be polled
 220  * to determine when data can be received.
 221  *
 222  * Returns: the number of bytes the front end can receive via @qemu_chr_be_write
 223  */
 224 int qemu_chr_be_can_write(CharDriverState *s);
 225
 226 /**
 227  * @qemu_chr_be_write:
 228  *
 229  * Write data from the back end to the front end.  Before issuing this call,
 230  * the caller should call @qemu_chr_be_can_write to determine how much data
 231  * the front end can currently accept.
 232  *
 233  * @buf a buffer to receive data from the front end
 234  * @len the number of bytes to receive from the front end
 235  */
 236 void qemu_chr_be_write(CharDriverState *s, uint8_t *buf, int len);
 237
 238
 239 /**
 240  * @qemu_chr_be_event:
 241  *
 242  * Send an event from the back end to the front end.
 243  *
 244  * @event the event to send
 245  */
 246 void qemu_chr_be_event(CharDriverState *s, int event);
 247
 248 void qemu_chr_add_handlers(CharDriverState *s,
 249                            IOCanReadHandler *fd_can_read,
 250                            IOReadHandler *fd_read,
 251                            IOEventHandler *fd_event,
 252                            void *opaque);
 253
 254 void qemu_chr_be_generic_open(CharDriverState *s);
 255 void qemu_chr_accept_input(CharDriverState *s);
 256 int qemu_chr_add_client(CharDriverState *s, int fd);
 257 void qemu_chr_info_print(Monitor *mon, const QObject *ret_data);
 258 void qemu_chr_info(Monitor *mon, QObject **ret_data);
 259 CharDriverState *qemu_chr_find(const char *name);
 260
 261 QemuOpts *qemu_chr_parse_compat(const char *label, const char *filename);
 262
 263 void register_char_driver(const char *name, CharDriverState *(*open)(QemuOpts *));
 264 void register_char_driver_qapi(const char *name, int kind,
 265         void (*parse)(QemuOpts *opts, ChardevBackend *backend, Error **errp));
 266
 267 /* add an eventfd to the qemu devices that are polled */
 268 CharDriverState *qemu_chr_open_eventfd(int eventfd);
 269
 270 extern int term_escape_char;
 271
 272 /* memory chardev */
 273 void qemu_chr_init_mem(CharDriverState *chr);
 274 void qemu_chr_close_mem(CharDriverState *chr);
 275 QString *qemu_chr_mem_to_qs(CharDriverState *chr);
 276 size_t qemu_chr_mem_osize(const CharDriverState *chr);
 277
 278 CharDriverState *qemu_char_get_next_serial(void);
 279
 280 /* msmouse */
 281 CharDriverState *qemu_chr_open_msmouse(void);
 282
 283 /* baum.c */
 284 CharDriverState *chr_baum_init(void);
 285
 286 #endif