GNU Linux-libre 6.9.2-gnu
[releases.git] / include / uapi / linux / virtio_console.h
1 /*
2  * This header, excluding the #ifdef __KERNEL__ part, is BSD licensed so
3  * anyone can use the definitions to implement compatible drivers/servers:
4  *
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. Neither the name of IBM nor the names of its contributors
15  *    may be used to endorse or promote products derived from this software
16  *    without specific prior written permission.
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL IBM OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * Copyright (C) Red Hat, Inc., 2009, 2010, 2011
30  * Copyright (C) Amit Shah <amit.shah@redhat.com>, 2009, 2010, 2011
31  */
32 #ifndef _UAPI_LINUX_VIRTIO_CONSOLE_H
33 #define _UAPI_LINUX_VIRTIO_CONSOLE_H
34 #include <linux/types.h>
35 #include <linux/virtio_types.h>
36 #include <linux/virtio_ids.h>
37 #include <linux/virtio_config.h>
38
39 /* Feature bits */
40 #define VIRTIO_CONSOLE_F_SIZE   0       /* Does host provide console size? */
41 #define VIRTIO_CONSOLE_F_MULTIPORT 1    /* Does host provide multiple ports? */
42 #define VIRTIO_CONSOLE_F_EMERG_WRITE 2 /* Does host support emergency write? */
43
44 #define VIRTIO_CONSOLE_BAD_ID           (~(__u32)0)
45
46 struct virtio_console_config {
47         /* colums of the screens */
48         __virtio16 cols;
49         /* rows of the screens */
50         __virtio16 rows;
51         /* max. number of ports this device can hold */
52         __virtio32 max_nr_ports;
53         /* emergency write register */
54         __virtio32 emerg_wr;
55 } __attribute__((packed));
56
57 /*
58  * A message that's passed between the Host and the Guest for a
59  * particular port.
60  */
61 struct virtio_console_control {
62         __virtio32 id;          /* Port number */
63         __virtio16 event;       /* The kind of control event (see below) */
64         __virtio16 value;       /* Extra information for the key */
65 };
66
67 /* Some events for control messages */
68 #define VIRTIO_CONSOLE_DEVICE_READY     0
69 #define VIRTIO_CONSOLE_PORT_ADD         1
70 #define VIRTIO_CONSOLE_PORT_REMOVE      2
71 #define VIRTIO_CONSOLE_PORT_READY       3
72 #define VIRTIO_CONSOLE_CONSOLE_PORT     4
73 #define VIRTIO_CONSOLE_RESIZE           5
74 #define VIRTIO_CONSOLE_PORT_OPEN        6
75 #define VIRTIO_CONSOLE_PORT_NAME        7
76
77
78 #endif /* _UAPI_LINUX_VIRTIO_CONSOLE_H */