[mirror_ubuntu-artful-kernel.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.
 *
 * 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 bytes of the config array. */
	__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
 * (type VIRTIO_CONFIG_F_VIRTQUEUE) to be laid out: */
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, pgdir, start */
	LHREQ_GETDMA, /* No longer used */
	LHREQ_IRQ, /* + irq */
	LHREQ_BREAK, /* + on/off flag (on blocks until someone does off) */
};
#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	*
19f1537b RR	19	* Devices are described by a simplified ID, a status byte, and some "config"
	20	* bytes which describe this device's configuration. This is placed by the
	21	* Launcher just above the top of physical memory:
e2c97843	22	*/
d7e28ffe	23	struct lguest_device_desc {
19f1537b RR	24	/* The device type: console, network, disk etc. Type 0 terminates. */
	25	__u8 type;
	26	/* The number of bytes of the config array. */
	27	__u8 config_len;
	28	/* A status byte, written by the Guest. */
	29	__u8 status;
	30	__u8 config[0];
	31	};
d7e28ffe	32
19f1537b RR	33	/*D:135 This is how we expect the device configuration field for a virtqueue
	34	* (type VIRTIO_CONFIG_F_VIRTQUEUE) to be laid out: */
	35	struct lguest_vqconfig {
	36	/* The number of entries in the virtio_ring */
	37	__u16 num;
	38	/* The interrupt we get when something happens. */
	39	__u16 irq;
	40	/* The page number of the virtio ring for this device. */
b45d8cb0	41	__u32 pfn;
d7e28ffe	42	};
e2c97843	43	/:/
d7e28ffe RR	44
	45	/* Write command first word is a request. */
	46	enum lguest_req
	47	{
7334492b	48	LHREQ_INITIALIZE, /* + base, pfnlimit, pgdir, start */
15045275	49	LHREQ_GETDMA, /* No longer used */
d7e28ffe RR	50	LHREQ_IRQ, /* + irq */
	51	LHREQ_BREAK, /* + on/off flag (on blocks until someone does off) */
	52	};
7334492b	53	#endif /* _LINUX_LGUEST_LAUNCHER */