xref: /illumos-kvm-cmd/qemu-char.h (revision 68396ea9)
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.h"
8 #include "qobject.h"
9 #include "qstring.h"
10 
11 /* character device */
12 
13 #define CHR_EVENT_BREAK   0 /* serial break char */
14 #define CHR_EVENT_FOCUS   1 /* focus to this terminal (modal input needed) */
15 #define CHR_EVENT_OPENED  2 /* new connection established */
16 #define CHR_EVENT_MUX_IN  3 /* mux-focus was set to this terminal */
17 #define CHR_EVENT_MUX_OUT 4 /* mux-focus will move on */
18 #define CHR_EVENT_CLOSED  5 /* connection closed */
19 
20 
21 #define CHR_IOCTL_SERIAL_SET_PARAMS   1
22 typedef struct {
23     int speed;
24     int parity;
25     int data_bits;
26     int stop_bits;
27 } QEMUSerialSetParams;
28 
29 #define CHR_IOCTL_SERIAL_SET_BREAK    2
30 
31 #define CHR_IOCTL_PP_READ_DATA        3
32 #define CHR_IOCTL_PP_WRITE_DATA       4
33 #define CHR_IOCTL_PP_READ_CONTROL     5
34 #define CHR_IOCTL_PP_WRITE_CONTROL    6
35 #define CHR_IOCTL_PP_READ_STATUS      7
36 #define CHR_IOCTL_PP_EPP_READ_ADDR    8
37 #define CHR_IOCTL_PP_EPP_READ         9
38 #define CHR_IOCTL_PP_EPP_WRITE_ADDR  10
39 #define CHR_IOCTL_PP_EPP_WRITE       11
40 #define CHR_IOCTL_PP_DATA_DIR        12
41 
42 #define CHR_IOCTL_SERIAL_SET_TIOCM   13
43 #define CHR_IOCTL_SERIAL_GET_TIOCM   14
44 
45 #define CHR_TIOCM_CTS	0x020
46 #define CHR_TIOCM_CAR	0x040
47 #define CHR_TIOCM_DSR	0x100
48 #define CHR_TIOCM_RI	0x080
49 #define CHR_TIOCM_DTR	0x002
50 #define CHR_TIOCM_RTS	0x004
51 
52 typedef void IOEventHandler(void *opaque, int event);
53 
54 struct CharDriverState {
55     void (*init)(struct CharDriverState *s);
56     int (*chr_write)(struct CharDriverState *s, const uint8_t *buf, int len);
57     void (*chr_update_read_handler)(struct CharDriverState *s);
58     int (*chr_ioctl)(struct CharDriverState *s, int cmd, void *arg);
59     int (*get_msgfd)(struct CharDriverState *s);
60     IOEventHandler *chr_event;
61     IOCanReadHandler *chr_can_read;
62     IOReadHandler *chr_read;
63     void *handler_opaque;
64     void (*chr_send_event)(struct CharDriverState *chr, int event);
65     void (*chr_close)(struct CharDriverState *chr);
66     void (*chr_accept_input)(struct CharDriverState *chr);
67     void (*chr_set_echo)(struct CharDriverState *chr, bool echo);
68     void *opaque;
69     QEMUBH *bh;
70     char *label;
71     char *filename;
72     int opened;
73     QTAILQ_ENTRY(CharDriverState) next;
74 };
75 
76 QemuOpts *qemu_chr_parse_compat(const char *label, const char *filename);
77 CharDriverState *qemu_chr_open_opts(QemuOpts *opts,
78                                     void (*init)(struct CharDriverState *s));
79 CharDriverState *qemu_chr_open(const char *label, const char *filename, void (*init)(struct CharDriverState *s));
80 void qemu_chr_set_echo(struct CharDriverState *chr, bool echo);
81 void qemu_chr_close(CharDriverState *chr);
82 void qemu_chr_printf(CharDriverState *s, const char *fmt, ...)
83     GCC_FMT_ATTR(2, 3);
84 int qemu_chr_write(CharDriverState *s, const uint8_t *buf, int len);
85 void qemu_chr_send_event(CharDriverState *s, int event);
86 void qemu_chr_add_handlers(CharDriverState *s,
87                            IOCanReadHandler *fd_can_read,
88                            IOReadHandler *fd_read,
89                            IOEventHandler *fd_event,
90                            void *opaque);
91 int qemu_chr_ioctl(CharDriverState *s, int cmd, void *arg);
92 void qemu_chr_generic_open(CharDriverState *s);
93 int qemu_chr_can_read(CharDriverState *s);
94 void qemu_chr_read(CharDriverState *s, uint8_t *buf, int len);
95 int qemu_chr_get_msgfd(CharDriverState *s);
96 void qemu_chr_accept_input(CharDriverState *s);
97 void qemu_chr_info_print(Monitor *mon, const QObject *ret_data);
98 void qemu_chr_info(Monitor *mon, QObject **ret_data);
99 CharDriverState *qemu_chr_find(const char *name);
100 
101 /* add an eventfd to the qemu devices that are polled */
102 CharDriverState *qemu_chr_open_eventfd(int eventfd);
103 
104 extern int term_escape_char;
105 
106 /* memory chardev */
107 void qemu_chr_init_mem(CharDriverState *chr);
108 void qemu_chr_close_mem(CharDriverState *chr);
109 QString *qemu_chr_mem_to_qs(CharDriverState *chr);
110 size_t qemu_chr_mem_osize(const CharDriverState *chr);
111 
112 /* async I/O support */
113 
114 int qemu_set_fd_handler2(int fd,
115                          IOCanReadHandler *fd_read_poll,
116                          IOHandler *fd_read,
117                          IOHandler *fd_write,
118                          void *opaque);
119 int qemu_set_fd_handler(int fd,
120                         IOHandler *fd_read,
121                         IOHandler *fd_write,
122                         void *opaque);
123 #endif
124