[mirror_ubuntu-zesty-kernel.git] / include / linux / virtio_console.h

#ifndef _LINUX_VIRTIO_CONSOLE_H
#define _LINUX_VIRTIO_CONSOLE_H
#include <linux/types.h>
#include <linux/virtio_ids.h>
#include <linux/virtio_config.h>
/*
 * This header, excluding the #ifdef __KERNEL__ part, is BSD licensed so
 * anyone can use the definitions to implement compatible drivers/servers:
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of IBM nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL IBM OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * Copyright (C) Red Hat, Inc., 2009, 2010, 2011
 * Copyright (C) Amit Shah <amit.shah@redhat.com>, 2009, 2010, 2011
 */

/* Feature bits */
#define VIRTIO_CONSOLE_F_SIZE	0	/* Does host provide console size? */
#define VIRTIO_CONSOLE_F_MULTIPORT 1	/* Does host provide multiple ports? */

#define VIRTIO_CONSOLE_BAD_ID		(~(u32)0)

struct virtio_console_config {
	/* colums of the screens */
	__u16 cols;
	/* rows of the screens */
	__u16 rows;
	/* max. number of ports this device can hold */
	__u32 max_nr_ports;
} __attribute__((packed));

/*
 * A message that's passed between the Host and the Guest for a
 * particular port.
 */
struct virtio_console_control {
	__u32 id;		/* Port number */
	__u16 event;		/* The kind of control event (see below) */
	__u16 value;		/* Extra information for the key */
};

/* Some events for control messages */
#define VIRTIO_CONSOLE_DEVICE_READY	0
#define VIRTIO_CONSOLE_PORT_ADD		1
#define VIRTIO_CONSOLE_PORT_REMOVE	2
#define VIRTIO_CONSOLE_PORT_READY	3
#define VIRTIO_CONSOLE_CONSOLE_PORT	4
#define VIRTIO_CONSOLE_RESIZE		5
#define VIRTIO_CONSOLE_PORT_OPEN	6
#define VIRTIO_CONSOLE_PORT_NAME	7

#ifdef __KERNEL__
int __init virtio_cons_early_init(int (*put_chars)(u32, const char *, int));
#endif /* __KERNEL__ */

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