2 * Copyright (c) 2011 Doug Rabson
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * USERBOOT interface versions
32 #define USERBOOT_VERSION_1 1
35 * Exit codes from the loader
37 #define USERBOOT_EXIT_QUIT 1
38 #define USERBOOT_EXIT_REBOOT 2
40 struct loader_callbacks_v1 {
46 * Wait until a key is pressed on the console and then return it
48 int (*getc)(void *arg);
51 * Write the character ch to the console
53 void (*putc)(void *arg, int ch);
56 * Return non-zero if a key can be read from the console
58 int (*poll)(void *arg);
65 * Open a file in the host filesystem
67 int (*open)(void *arg, const char *filename, void **h_return);
72 int (*close)(void *arg, void *h);
75 * Return non-zero if the file is a directory
77 int (*isdir)(void *arg, void *h);
80 * Read size bytes from a file. The number of bytes remaining
81 * in dst after reading is returned in *resid_return
83 int (*read)(void *arg, void *h, void *dst, size_t size,
84 size_t *resid_return);
87 * Read an entry from a directory. The entry's inode number is
88 * returned in *fileno_return, its type in *type_return and
89 * the name length in *namelen_return. The name itself is
90 * copied to the buffer name which must be at least PATH_MAX
93 int (*readdir)(void *arg, void *h, uint32_t *fileno_return,
94 uint8_t *type_return, size_t *namelen_return, char *name);
97 * Seek to a location within an open file
99 int (*seek)(void *arg, void *h, uint64_t offset,
103 * Return some stat(2) related information about the file
105 int (*stat)(void *arg, void *h, int *mode_return,
106 int *uid_return, int *gid_return, uint64_t *size_return);
113 * Read from a disk image at the given offset
115 int (*diskread)(void *arg, int unit, uint64_t offset,
116 void *dst, size_t size, size_t *resid_return);
119 * Guest virtual machine i/o
123 * Copy to the guest address space
125 int (*copyin)(void *arg, const void *from,
126 uint64_t to, size_t size);
129 * Copy from the guest address space
131 int (*copyout)(void *arg, uint64_t from,
132 void *to, size_t size);
135 * Set a guest register value
137 void (*setreg)(void *arg, int, uint64_t);
140 * Set a guest MSR value
142 void (*setmsr)(void *arg, int, uint64_t);
145 * Set a guest CR value
147 void (*setcr)(void *arg, int, uint64_t);
150 * Set the guest GDT address
152 void (*setgdt)(void *arg, uint64_t, size_t);
155 * Transfer control to the guest at the given address
157 void (*exec)(void *arg, uint64_t pc);
164 * Sleep for usec microseconds
166 void (*delay)(void *arg, int usec);
169 * Exit with the given exit code
171 void (*exit)(void *arg, int v);
174 * Return guest physical memory map details
176 void (*getmem)(void *arg, uint64_t *lowmem,