Rusty Russell | d7e28ff | 2007-07-19 01:49:23 -0700 | [diff] [blame] | 1 | #ifndef _ASM_LGUEST_USER |
| 2 | #define _ASM_LGUEST_USER |
| 3 | /* Everything the "lguest" userspace program needs to know. */ |
Rusty Russell | b45d8cb | 2007-10-22 10:56:24 +1000 | [diff] [blame] | 4 | #include <linux/types.h> |
Rusty Russell | d7e28ff | 2007-07-19 01:49:23 -0700 | [diff] [blame] | 5 | /* They can register up to 32 arrays of lguest_dma. */ |
| 6 | #define LGUEST_MAX_DMA 32 |
| 7 | /* At most we can dma 16 lguest_dma in one op. */ |
| 8 | #define LGUEST_MAX_DMA_SECTIONS 16 |
| 9 | |
| 10 | /* How many devices? Assume each one wants up to two dma arrays per device. */ |
| 11 | #define LGUEST_MAX_DEVICES (LGUEST_MAX_DMA/2) |
| 12 | |
Rusty Russell | d7e28ff | 2007-07-19 01:49:23 -0700 | [diff] [blame] | 13 | /* Where the Host expects the Guest to SEND_DMA console output to. */ |
| 14 | #define LGUEST_CONSOLE_DMA_KEY 0 |
| 15 | |
Rusty Russell | e2c9784 | 2007-07-26 10:41:03 -0700 | [diff] [blame] | 16 | /*D:010 |
| 17 | * Drivers |
| 18 | * |
| 19 | * The Guest needs devices to do anything useful. Since we don't let it touch |
| 20 | * real devices (think of the damage it could do!) we provide virtual devices. |
| 21 | * We could emulate a PCI bus with various devices on it, but that is a fairly |
| 22 | * complex burden for the Host and suboptimal for the Guest, so we have our own |
| 23 | * "lguest" bus and simple drivers. |
| 24 | * |
Rusty Russell | 19f1537 | 2007-10-22 11:24:21 +1000 | [diff] [blame^] | 25 | * Devices are described by a simplified ID, a status byte, and some "config" |
| 26 | * bytes which describe this device's configuration. This is placed by the |
| 27 | * Launcher just above the top of physical memory: |
Rusty Russell | e2c9784 | 2007-07-26 10:41:03 -0700 | [diff] [blame] | 28 | */ |
Rusty Russell | d7e28ff | 2007-07-19 01:49:23 -0700 | [diff] [blame] | 29 | struct lguest_device_desc { |
Rusty Russell | 19f1537 | 2007-10-22 11:24:21 +1000 | [diff] [blame^] | 30 | /* The device type: console, network, disk etc. Type 0 terminates. */ |
| 31 | __u8 type; |
| 32 | /* The number of bytes of the config array. */ |
| 33 | __u8 config_len; |
| 34 | /* A status byte, written by the Guest. */ |
| 35 | __u8 status; |
| 36 | __u8 config[0]; |
| 37 | }; |
Rusty Russell | d7e28ff | 2007-07-19 01:49:23 -0700 | [diff] [blame] | 38 | |
Rusty Russell | 19f1537 | 2007-10-22 11:24:21 +1000 | [diff] [blame^] | 39 | /*D:135 This is how we expect the device configuration field for a virtqueue |
| 40 | * (type VIRTIO_CONFIG_F_VIRTQUEUE) to be laid out: */ |
| 41 | struct lguest_vqconfig { |
| 42 | /* The number of entries in the virtio_ring */ |
| 43 | __u16 num; |
| 44 | /* The interrupt we get when something happens. */ |
| 45 | __u16 irq; |
| 46 | /* The page number of the virtio ring for this device. */ |
Rusty Russell | b45d8cb | 2007-10-22 10:56:24 +1000 | [diff] [blame] | 47 | __u32 pfn; |
Rusty Russell | d7e28ff | 2007-07-19 01:49:23 -0700 | [diff] [blame] | 48 | }; |
Rusty Russell | e2c9784 | 2007-07-26 10:41:03 -0700 | [diff] [blame] | 49 | /*:*/ |
Rusty Russell | d7e28ff | 2007-07-19 01:49:23 -0700 | [diff] [blame] | 50 | |
| 51 | /* Write command first word is a request. */ |
| 52 | enum lguest_req |
| 53 | { |
| 54 | LHREQ_INITIALIZE, /* + pfnlimit, pgdir, start, pageoffset */ |
Rusty Russell | 1504527 | 2007-10-22 11:24:10 +1000 | [diff] [blame] | 55 | LHREQ_GETDMA, /* No longer used */ |
Rusty Russell | d7e28ff | 2007-07-19 01:49:23 -0700 | [diff] [blame] | 56 | LHREQ_IRQ, /* + irq */ |
| 57 | LHREQ_BREAK, /* + on/off flag (on blocks until someone does off) */ |
| 58 | }; |
| 59 | #endif /* _ASM_LGUEST_USER */ |