xref: /openbmc/qemu/chardev/chardev-internal.h (revision 7b72c7dd)
1 /*
2  * QEMU Character device internals
3  *
4  * Copyright (c) 2003-2008 Fabrice Bellard
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22  * THE SOFTWARE.
23  */
24 
25 #ifndef CHARDEV_INTERNAL_H
26 #define CHARDEV_INTERNAL_H
27 
28 #include "chardev/char.h"
29 #include "chardev/char-fe.h"
30 #include "qom/object.h"
31 
32 #define MAX_MUX 4
33 #define MUX_BUFFER_SIZE 32 /* Must be a power of 2.  */
34 #define MUX_BUFFER_MASK (MUX_BUFFER_SIZE - 1)
35 
36 struct MuxChardev {
37     Chardev parent;
38     CharBackend *backends[MAX_MUX];
39     CharBackend chr;
40     unsigned long mux_bitset;
41     int focus;
42     bool term_got_escape;
43     /* Intermediate input buffer catches escape sequences even if the
44        currently active device is not accepting any input - but only until it
45        is full as well. */
46     unsigned char buffer[MAX_MUX][MUX_BUFFER_SIZE];
47     unsigned int prod[MAX_MUX];
48     unsigned int cons[MAX_MUX];
49     int timestamps;
50 
51     /* Protected by the Chardev chr_write_lock.  */
52     bool linestart;
53     int64_t timestamps_start;
54 };
55 typedef struct MuxChardev MuxChardev;
56 
57 DECLARE_INSTANCE_CHECKER(MuxChardev, MUX_CHARDEV,
58                          TYPE_CHARDEV_MUX)
59 #define CHARDEV_IS_MUX(chr)                             \
60     object_dynamic_cast(OBJECT(chr), TYPE_CHARDEV_MUX)
61 
62 bool mux_chr_attach_frontend(MuxChardev *d, CharBackend *b,
63                              unsigned int *tag, Error **errp);
64 bool mux_chr_detach_frontend(MuxChardev *d, unsigned int tag);
65 void mux_set_focus(Chardev *chr, unsigned int focus);
66 void mux_chr_send_all_event(Chardev *chr, QEMUChrEvent event);
67 
68 Object *get_chardevs_root(void);
69 
70 #endif /* CHARDEV_INTERNAL_H */
71