blob: c41fd483af34442e9cb6e198d4cc6809c336afdd [file] [log] [blame]
Rusty Russell73344922007-10-25 14:12:20 +10001#ifndef _LINUX_LGUEST_LAUNCHER
2#define _LINUX_LGUEST_LAUNCHER
Rusty Russelld7e28ff2007-07-19 01:49:23 -07003/* Everything the "lguest" userspace program needs to know. */
Rusty Russellb45d8cb2007-10-22 10:56:24 +10004#include <linux/types.h>
Rusty Russelld7e28ff2007-07-19 01:49:23 -07005
Rusty Russelle2c97842007-07-26 10:41:03 -07006/*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 * "lguest" bus and simple drivers.
14 *
Rusty Russell19f15372007-10-22 11:24:21 +100015 * Devices are described by a simplified ID, a status byte, and some "config"
16 * bytes which describe this device's configuration. This is placed by the
17 * Launcher just above the top of physical memory:
Rusty Russelle2c97842007-07-26 10:41:03 -070018 */
Rusty Russelld7e28ff2007-07-19 01:49:23 -070019struct lguest_device_desc {
Rusty Russell19f15372007-10-22 11:24:21 +100020 /* The device type: console, network, disk etc. Type 0 terminates. */
21 __u8 type;
22 /* The number of bytes of the config array. */
23 __u8 config_len;
24 /* A status byte, written by the Guest. */
25 __u8 status;
26 __u8 config[0];
27};
Rusty Russelld7e28ff2007-07-19 01:49:23 -070028
Rusty Russell19f15372007-10-22 11:24:21 +100029/*D:135 This is how we expect the device configuration field for a virtqueue
30 * (type VIRTIO_CONFIG_F_VIRTQUEUE) to be laid out: */
31struct lguest_vqconfig {
32 /* The number of entries in the virtio_ring */
33 __u16 num;
34 /* The interrupt we get when something happens. */
35 __u16 irq;
36 /* The page number of the virtio ring for this device. */
Rusty Russellb45d8cb2007-10-22 10:56:24 +100037 __u32 pfn;
Rusty Russelld7e28ff2007-07-19 01:49:23 -070038};
Rusty Russelle2c97842007-07-26 10:41:03 -070039/*:*/
Rusty Russelld7e28ff2007-07-19 01:49:23 -070040
41/* Write command first word is a request. */
42enum lguest_req
43{
Rusty Russell73344922007-10-25 14:12:20 +100044 LHREQ_INITIALIZE, /* + base, pfnlimit, pgdir, start */
Rusty Russell15045272007-10-22 11:24:10 +100045 LHREQ_GETDMA, /* No longer used */
Rusty Russelld7e28ff2007-07-19 01:49:23 -070046 LHREQ_IRQ, /* + irq */
47 LHREQ_BREAK, /* + on/off flag (on blocks until someone does off) */
48};
Rusty Russell73344922007-10-25 14:12:20 +100049#endif /* _LINUX_LGUEST_LAUNCHER */