Merge git://git.kernel.org/pub/scm/linux/kernel/git/kyle/parisc-2.6
[linux-2.6] / include / linux / lguest_launcher.h
1 #ifndef _LINUX_LGUEST_LAUNCHER
2 #define _LINUX_LGUEST_LAUNCHER
3 /* Everything the "lguest" userspace program needs to know. */
4 #include <linux/types.h>
5
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
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.
18  *
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:
22  */
23 struct lguest_device_desc {
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 };
32
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. */
41         __u32 pfn;
42 };
43 /*:*/
44
45 /* Write command first word is a request. */
46 enum lguest_req
47 {
48         LHREQ_INITIALIZE, /* + base, pfnlimit, pgdir, start */
49         LHREQ_GETDMA, /* No longer used */
50         LHREQ_IRQ, /* + irq */
51         LHREQ_BREAK, /* + on/off flag (on blocks until someone does off) */
52 };
53 #endif /* _LINUX_LGUEST_LAUNCHER */