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