blob: 72c457b0d22a943f0e8946263968fc0a79799d28 [file] [log] [blame]
pbrook87ecb682007-11-17 17:14:51 +00001#ifndef QEMU_CHAR_H
2#define QEMU_CHAR_H
3
aliguori376253e2009-03-05 23:01:23 +00004#include "qemu-common.h"
Blue Swirl72cf2d42009-09-12 07:36:22 +00005#include "qemu-queue.h"
Gerd Hoffmann191bc012009-09-10 10:58:35 +02006#include "qemu-option.h"
7#include "qemu-config.h"
Luiz Capitulino588b3832009-12-10 17:16:08 -02008#include "qobject.h"
Luiz Capitulino999bd672010-10-22 16:09:05 -02009#include "qstring.h"
aliguori376253e2009-03-05 23:01:23 +000010
pbrook87ecb682007-11-17 17:14:51 +000011/* character device */
12
aliguori2724b182009-03-05 23:01:47 +000013#define CHR_EVENT_BREAK 0 /* serial break char */
14#define CHR_EVENT_FOCUS 1 /* focus to this terminal (modal input needed) */
Amit Shahb6b8df52009-10-07 18:31:16 +053015#define CHR_EVENT_OPENED 2 /* new connection established */
aliguori2724b182009-03-05 23:01:47 +000016#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 */
Amit Shah793cbfb2009-08-11 21:27:48 +053018#define CHR_EVENT_CLOSED 5 /* connection closed */
pbrook87ecb682007-11-17 17:14:51 +000019
20
21#define CHR_IOCTL_SERIAL_SET_PARAMS 1
22typedef 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
aurel32563e3c62008-08-22 08:57:09 +000040#define CHR_IOCTL_PP_DATA_DIR 12
pbrook87ecb682007-11-17 17:14:51 +000041
aurel32f0664042008-08-22 21:25:00 +000042#define CHR_IOCTL_SERIAL_SET_TIOCM 13
43#define CHR_IOCTL_SERIAL_GET_TIOCM 14
aliguori81174da2008-08-11 14:17:04 +000044
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
pbrook87ecb682007-11-17 17:14:51 +000052typedef void IOEventHandler(void *opaque, int event);
53
54struct CharDriverState {
aurel32ceecf1d2009-01-18 14:08:04 +000055 void (*init)(struct CharDriverState *s);
pbrook87ecb682007-11-17 17:14:51 +000056 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);
Mark McLoughlin7d174052009-07-22 09:11:39 +010059 int (*get_msgfd)(struct CharDriverState *s);
Daniel P. Berrange13661082011-06-23 13:31:42 +010060 int (*chr_add_client)(struct CharDriverState *chr, int fd);
pbrook87ecb682007-11-17 17:14:51 +000061 IOEventHandler *chr_event;
Juan Quintela7b27a762010-03-11 17:55:39 +010062 IOCanReadHandler *chr_can_read;
pbrook87ecb682007-11-17 17:14:51 +000063 IOReadHandler *chr_read;
64 void *handler_opaque;
65 void (*chr_send_event)(struct CharDriverState *chr, int event);
66 void (*chr_close)(struct CharDriverState *chr);
balrogbd9bdce2007-11-25 00:55:06 +000067 void (*chr_accept_input)(struct CharDriverState *chr);
Paolo Bonzinic48855e2010-12-23 13:42:48 +010068 void (*chr_set_echo)(struct CharDriverState *chr, bool echo);
Hans de Goede7c32c4f2011-03-24 11:12:02 +010069 void (*chr_guest_open)(struct CharDriverState *chr);
70 void (*chr_guest_close)(struct CharDriverState *chr);
pbrook87ecb682007-11-17 17:14:51 +000071 void *opaque;
pbrook87ecb682007-11-17 17:14:51 +000072 QEMUBH *bh;
aliguori5ccfae12008-10-31 17:31:29 +000073 char *label;
74 char *filename;
Alexander Graf73cdf3f2010-04-01 18:42:39 +020075 int opened;
Kusanagi Kouichid5b27162011-04-26 19:19:26 +090076 int avail_connections;
Blue Swirl72cf2d42009-09-12 07:36:22 +000077 QTAILQ_ENTRY(CharDriverState) next;
pbrook87ecb682007-11-17 17:14:51 +000078};
79
Gerd Hoffmann33521632009-12-08 13:11:49 +010080QemuOpts *qemu_chr_parse_compat(const char *label, const char *filename);
Gerd Hoffmann191bc012009-09-10 10:58:35 +020081CharDriverState *qemu_chr_open_opts(QemuOpts *opts,
82 void (*init)(struct CharDriverState *s));
aurel32ceecf1d2009-01-18 14:08:04 +000083CharDriverState *qemu_chr_open(const char *label, const char *filename, void (*init)(struct CharDriverState *s));
Paolo Bonzinic48855e2010-12-23 13:42:48 +010084void qemu_chr_set_echo(struct CharDriverState *chr, bool echo);
Hans de Goede7c32c4f2011-03-24 11:12:02 +010085void qemu_chr_guest_open(struct CharDriverState *chr);
86void qemu_chr_guest_close(struct CharDriverState *chr);
pbrook9596ebb2007-11-18 01:44:38 +000087void qemu_chr_close(CharDriverState *chr);
Anthony Liguorie7e71b02011-08-15 11:17:29 -050088void qemu_chr_fe_printf(CharDriverState *s, const char *fmt, ...)
Stefan Weil8b7968f2010-09-23 21:28:05 +020089 GCC_FMT_ATTR(2, 3);
Anthony Liguori2cc6e0a2011-08-15 11:17:28 -050090int qemu_chr_fe_write(CharDriverState *s, const uint8_t *buf, int len);
pbrook87ecb682007-11-17 17:14:51 +000091void qemu_chr_send_event(CharDriverState *s, int event);
92void qemu_chr_add_handlers(CharDriverState *s,
Juan Quintela7b27a762010-03-11 17:55:39 +010093 IOCanReadHandler *fd_can_read,
pbrook87ecb682007-11-17 17:14:51 +000094 IOReadHandler *fd_read,
95 IOEventHandler *fd_event,
96 void *opaque);
97int qemu_chr_ioctl(CharDriverState *s, int cmd, void *arg);
Amit Shah127338e2009-11-03 19:59:56 +053098void qemu_chr_generic_open(CharDriverState *s);
pbrook87ecb682007-11-17 17:14:51 +000099int qemu_chr_can_read(CharDriverState *s);
100void qemu_chr_read(CharDriverState *s, uint8_t *buf, int len);
Mark McLoughlin7d174052009-07-22 09:11:39 +0100101int qemu_chr_get_msgfd(CharDriverState *s);
balrogbd9bdce2007-11-25 00:55:06 +0000102void qemu_chr_accept_input(CharDriverState *s);
Daniel P. Berrange13661082011-06-23 13:31:42 +0100103int qemu_chr_add_client(CharDriverState *s, int fd);
Luiz Capitulino588b3832009-12-10 17:16:08 -0200104void qemu_chr_info_print(Monitor *mon, const QObject *ret_data);
105void qemu_chr_info(Monitor *mon, QObject **ret_data);
Gerd Hoffmannc845f402009-09-10 10:58:52 +0200106CharDriverState *qemu_chr_find(const char *name);
pbrook87ecb682007-11-17 17:14:51 +0000107
Cam Macdonell6cbf4c82010-07-27 10:54:13 -0600108/* add an eventfd to the qemu devices that are polled */
109CharDriverState *qemu_chr_open_eventfd(int eventfd);
110
aliguori0e82f342008-10-31 18:44:40 +0000111extern int term_escape_char;
112
Luiz Capitulino999bd672010-10-22 16:09:05 -0200113/* memory chardev */
114void qemu_chr_init_mem(CharDriverState *chr);
115void qemu_chr_close_mem(CharDriverState *chr);
116QString *qemu_chr_mem_to_qs(CharDriverState *chr);
117size_t qemu_chr_mem_osize(const CharDriverState *chr);
118
pbrook87ecb682007-11-17 17:14:51 +0000119/* async I/O support */
120
121int qemu_set_fd_handler2(int fd,
Juan Quintela7b27a762010-03-11 17:55:39 +0100122 IOCanReadHandler *fd_read_poll,
pbrook87ecb682007-11-17 17:14:51 +0000123 IOHandler *fd_read,
124 IOHandler *fd_write,
125 void *opaque);
126int qemu_set_fd_handler(int fd,
127 IOHandler *fd_read,
128 IOHandler *fd_write,
129 void *opaque);
pbrook87ecb682007-11-17 17:14:51 +0000130#endif