[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / linux / lguest_launcher.h

#ifndef _LINUX_LGUEST_LAUNCHER
#define _LINUX_LGUEST_LAUNCHER
/* Everything the "lguest" userspace program needs to know. */
#include <linux/types.h>

/*D:010
 * Drivers
 *
 * The Guest needs devices to do anything useful.  Since we don't let it touch
 * real devices (think of the damage it could do!) we provide virtual devices.
 * We could emulate a PCI bus with various devices on it, but that is a fairly
 * complex burden for the Host and suboptimal for the Guest, so we have our own
 * simple lguest bus and we use "virtio" drivers.  These drivers need a set of
 * routines from us which will actually do the virtual I/O, but they handle all
 * the net/block/console stuff themselves.  This means that if we want to add
 * a new device, we simply need to write a new virtio driver and create support
 * for it in the Launcher: this code won't need to change.
 *
 * Virtio devices are also used by kvm, so we can simply reuse their optimized
 * device drivers.  And one day when everyone uses virtio, my plan will be
 * complete.  Bwahahahah!
 *
 * Devices are described by a simplified ID, a status byte, and some "config"
 * bytes which describe this device's configuration.  This is placed by the
 * Launcher just above the top of physical memory:
 */
struct lguest_device_desc {
	/* The device type: console, network, disk etc.  Type 0 terminates. */
	__u8 type;
	/* The number of virtqueues (first in config array) */
	__u8 num_vq;
	/*
	 * The number of bytes of feature bits.  Multiply by 2: one for host
	 * features and one for Guest acknowledgements.
	 */
	__u8 feature_len;
	/* The number of bytes of the config array after virtqueues. */
	__u8 config_len;
	/* A status byte, written by the Guest. */
	__u8 status;
	__u8 config[0];
};

/*D:135
 * This is how we expect the device configuration field for a virtqueue
 * to be laid out in config space.
 */
struct lguest_vqconfig {
	/* The number of entries in the virtio_ring */
	__u16 num;
	/* The interrupt we get when something happens. */
	__u16 irq;
	/* The page number of the virtio ring for this device. */
	__u32 pfn;
};
/*:*/

/* Write command first word is a request. */
enum lguest_req
{
	LHREQ_INITIALIZE, /* + base, pfnlimit, start */
	LHREQ_GETDMA, /* No longer used */
	LHREQ_IRQ, /* + irq */
	LHREQ_BREAK, /* No longer used */
	LHREQ_EVENTFD, /* + address, fd. */
};

/*
 * The alignment to use between consumer and producer parts of vring.
 * x86 pagesize for historical reasons.
 */
#define LGUEST_VRING_ALIGN	4096
#endif /* _LINUX_LGUEST_LAUNCHER */
Commit	Line	Data
7334492b RR	1	#ifndef _LINUX_LGUEST_LAUNCHER
7334492b RR	2	#define _LINUX_LGUEST_LAUNCHER
d7e28ffe	3	/* Everything the "lguest" userspace program needs to know. */
b45d8cb0	4	#include <linux/types.h>
d7e28ffe	5
e2c97843 RR	6	/*D:010
	7	* Drivers
	8	*
	9	* The Guest needs devices to do anything useful. Since we don't let it touch
	10	* real devices (think of the damage it could do!) we provide virtual devices.
	11	* We could emulate a PCI bus with various devices on it, but that is a fairly
	12	* complex burden for the Host and suboptimal for the Guest, so we have our own
e1e72965 RR	13	* simple lguest bus and we use "virtio" drivers. These drivers need a set of
	14	* routines from us which will actually do the virtual I/O, but they handle all
	15	* the net/block/console stuff themselves. This means that if we want to add
	16	* a new device, we simply need to write a new virtio driver and create support
	17	* for it in the Launcher: this code won't need to change.
e2c97843	18	*
a6bd8e13 RR	19	* Virtio devices are also used by kvm, so we can simply reuse their optimized
	20	* device drivers. And one day when everyone uses virtio, my plan will be
	21	* complete. Bwahahahah!
	22	*
19f1537b RR	23	* Devices are described by a simplified ID, a status byte, and some "config"
	24	* bytes which describe this device's configuration. This is placed by the
	25	* Launcher just above the top of physical memory:
e2c97843	26	*/
d7e28ffe	27	struct lguest_device_desc {
19f1537b RR	28	/* The device type: console, network, disk etc. Type 0 terminates. */
19f1537b RR	29	__u8 type;
a586d4f6 RR	30	/* The number of virtqueues (first in config array) */
a586d4f6 RR	31	__u8 num_vq;
2e04ef76 RR	32	/*
	33	* The number of bytes of feature bits. Multiply by 2: one for host
	34	* features and one for Guest acknowledgements.
	35	*/
a586d4f6 RR	36	__u8 feature_len;
a586d4f6 RR	37	/* The number of bytes of the config array after virtqueues. */
19f1537b RR	38	__u8 config_len;
	39	/* A status byte, written by the Guest. */
	40	__u8 status;
	41	__u8 config[0];
	42	};
d7e28ffe	43
2e04ef76 RR	44	/*D:135
	45	* This is how we expect the device configuration field for a virtqueue
	46	* to be laid out in config space.
	47	*/
19f1537b RR	48	struct lguest_vqconfig {
	49	/* The number of entries in the virtio_ring */
	50	__u16 num;
	51	/* The interrupt we get when something happens. */
	52	__u16 irq;
	53	/* The page number of the virtio ring for this device. */
b45d8cb0	54	__u32 pfn;
d7e28ffe	55	};
e2c97843	56	/:/
d7e28ffe RR	57
	58	/* Write command first word is a request. */
	59	enum lguest_req
	60	{
58a24566	61	LHREQ_INITIALIZE, /* + base, pfnlimit, start */
15045275	62	LHREQ_GETDMA, /* No longer used */
d7e28ffe	63	LHREQ_IRQ, /* + irq */
5dac051b	64	LHREQ_BREAK, /* No longer used */
df60aeef	65	LHREQ_EVENTFD, /* + address, fd. */
d7e28ffe	66	};
2966af73	67
2e04ef76 RR	68	/*
	69	* The alignment to use between consumer and producer parts of vring.
	70	* x86 pagesize for historical reasons.
	71	*/
2966af73	72	#define LGUEST_VRING_ALIGN 4096
7334492b	73	#endif /* _LINUX_LGUEST_LAUNCHER */