1199767f8SToomas Soome /*-
2199767f8SToomas Soome * Copyright (c) 1998 Michael Smith <msmith@freebsd.org>
3199767f8SToomas Soome * Copyright (c) 2006 Marcel Moolenaar
4199767f8SToomas Soome * All rights reserved.
5199767f8SToomas Soome *
6199767f8SToomas Soome * Redistribution and use in source and binary forms, with or without
7199767f8SToomas Soome * modification, are permitted provided that the following conditions
8199767f8SToomas Soome * are met:
9199767f8SToomas Soome * 1. Redistributions of source code must retain the above copyright
10199767f8SToomas Soome * notice, this list of conditions and the following disclaimer.
11199767f8SToomas Soome * 2. Redistributions in binary form must reproduce the above copyright
12199767f8SToomas Soome * notice, this list of conditions and the following disclaimer in the
13199767f8SToomas Soome * documentation and/or other materials provided with the distribution.
14199767f8SToomas Soome *
15199767f8SToomas Soome * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16199767f8SToomas Soome * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17199767f8SToomas Soome * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18199767f8SToomas Soome * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19199767f8SToomas Soome * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20199767f8SToomas Soome * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21199767f8SToomas Soome * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22199767f8SToomas Soome * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23199767f8SToomas Soome * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24199767f8SToomas Soome * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25199767f8SToomas Soome * SUCH DAMAGE.
26199767f8SToomas Soome */
27199767f8SToomas Soome
28199767f8SToomas Soome #include <sys/cdefs.h>
29199767f8SToomas Soome __FBSDID("$FreeBSD$");
30199767f8SToomas Soome
31199767f8SToomas Soome #include <stand.h>
32199767f8SToomas Soome #include <string.h>
33199767f8SToomas Soome #include <sys/param.h>
34199767f8SToomas Soome #include <sys/reboot.h>
35199767f8SToomas Soome #include <sys/linker.h>
36199767f8SToomas Soome #include <sys/boot.h>
37199767f8SToomas Soome
38199767f8SToomas Soome #include <efi.h>
39199767f8SToomas Soome #include <efilib.h>
40199767f8SToomas Soome
41199767f8SToomas Soome #include "bootstrap.h"
42199767f8SToomas Soome #include "libi386.h"
43199767f8SToomas Soome #include <machine/bootinfo.h>
44199767f8SToomas Soome
45199767f8SToomas Soome static const char howto_switches[] = "aCdrgDmphsv";
46199767f8SToomas Soome static int howto_masks[] = {
47199767f8SToomas Soome RB_ASKNAME, RB_CDROM, RB_KDB, RB_DFLTROOT, RB_GDB, RB_MULTIPLE,
48199767f8SToomas Soome RB_MUTE, RB_PAUSE, RB_SERIAL, RB_SINGLE, RB_VERBOSE
49199767f8SToomas Soome };
50199767f8SToomas Soome
51199767f8SToomas Soome int
bi_getboothowto(char * kargs)52199767f8SToomas Soome bi_getboothowto(char *kargs)
53199767f8SToomas Soome {
54199767f8SToomas Soome const char *sw;
55199767f8SToomas Soome char *opts;
56199767f8SToomas Soome int howto, i;
57199767f8SToomas Soome
58199767f8SToomas Soome howto = 0;
59199767f8SToomas Soome
60199767f8SToomas Soome /* Get the boot options from the environment first. */
61199767f8SToomas Soome for (i = 0; howto_names[i].ev != NULL; i++) {
62199767f8SToomas Soome if (getenv(howto_names[i].ev) != NULL)
63199767f8SToomas Soome howto |= howto_names[i].mask;
64199767f8SToomas Soome }
65199767f8SToomas Soome
66199767f8SToomas Soome /* Parse kargs */
67199767f8SToomas Soome if (kargs == NULL)
68199767f8SToomas Soome return (howto);
69199767f8SToomas Soome
70199767f8SToomas Soome opts = strchr(kargs, '-');
71199767f8SToomas Soome while (opts != NULL) {
72199767f8SToomas Soome while (*(++opts) != '\0') {
73199767f8SToomas Soome sw = strchr(howto_switches, *opts);
74199767f8SToomas Soome if (sw == NULL)
75199767f8SToomas Soome break;
76199767f8SToomas Soome howto |= howto_masks[sw - howto_switches];
77199767f8SToomas Soome }
78199767f8SToomas Soome opts = strchr(opts, '-');
79199767f8SToomas Soome }
80199767f8SToomas Soome
81199767f8SToomas Soome return (howto);
82199767f8SToomas Soome }
83199767f8SToomas Soome
84199767f8SToomas Soome /*
85199767f8SToomas Soome * Copy the environment into the load area starting at (addr).
86199767f8SToomas Soome * Each variable is formatted as <name>=<value>, with a single nul
87199767f8SToomas Soome * separating each variable, and a double nul terminating the environment.
88199767f8SToomas Soome */
89199767f8SToomas Soome vm_offset_t
bi_copyenv(vm_offset_t start)90199767f8SToomas Soome bi_copyenv(vm_offset_t start)
91199767f8SToomas Soome {
92199767f8SToomas Soome struct env_var *ep;
93199767f8SToomas Soome vm_offset_t addr, last;
94199767f8SToomas Soome size_t len;
95199767f8SToomas Soome
96199767f8SToomas Soome addr = last = start;
97199767f8SToomas Soome
98199767f8SToomas Soome /* Traverse the environment. */
99199767f8SToomas Soome for (ep = environ; ep != NULL; ep = ep->ev_next) {
100199767f8SToomas Soome len = strlen(ep->ev_name);
101199767f8SToomas Soome if (i386_copyin(ep->ev_name, addr, len) != len)
102199767f8SToomas Soome break;
103199767f8SToomas Soome addr += len;
104199767f8SToomas Soome if (i386_copyin("=", addr, 1) != 1)
105199767f8SToomas Soome break;
106199767f8SToomas Soome addr++;
107199767f8SToomas Soome if (ep->ev_value != NULL) {
108199767f8SToomas Soome len = strlen(ep->ev_value);
109199767f8SToomas Soome if (i386_copyin(ep->ev_value, addr, len) != len)
110199767f8SToomas Soome break;
111199767f8SToomas Soome addr += len;
112199767f8SToomas Soome }
113199767f8SToomas Soome if (i386_copyin("", addr, 1) != 1)
114199767f8SToomas Soome break;
115199767f8SToomas Soome last = ++addr;
116199767f8SToomas Soome }
117199767f8SToomas Soome
118199767f8SToomas Soome if (i386_copyin("", last++, 1) != 1)
119199767f8SToomas Soome last = start;
120199767f8SToomas Soome return(last);
121199767f8SToomas Soome }
122199767f8SToomas Soome
123199767f8SToomas Soome /*
124199767f8SToomas Soome * Copy module-related data into the load area, where it can be
125199767f8SToomas Soome * used as a directory for loaded modules.
126199767f8SToomas Soome *
127199767f8SToomas Soome * Module data is presented in a self-describing format. Each datum
128199767f8SToomas Soome * is preceded by a 32-bit identifier and a 32-bit size field.
129199767f8SToomas Soome *
130199767f8SToomas Soome * Currently, the following data are saved:
131199767f8SToomas Soome *
132199767f8SToomas Soome * MOD_NAME (variable) module name (string)
133199767f8SToomas Soome * MOD_TYPE (variable) module type (string)
134199767f8SToomas Soome * MOD_ARGS (variable) module parameters (string)
135199767f8SToomas Soome * MOD_ADDR sizeof(vm_offset_t) module load address
136199767f8SToomas Soome * MOD_SIZE sizeof(size_t) module size
137199767f8SToomas Soome * MOD_METADATA (variable) type-specific metadata
138199767f8SToomas Soome */
139199767f8SToomas Soome #define COPY32(v, a) { \
140199767f8SToomas Soome u_int32_t x = (v); \
141199767f8SToomas Soome i386_copyin(&x, a, sizeof(x)); \
142199767f8SToomas Soome a += sizeof(x); \
143199767f8SToomas Soome }
144199767f8SToomas Soome
145199767f8SToomas Soome #define MOD_STR(t, a, s) { \
146199767f8SToomas Soome COPY32(t, a); \
147199767f8SToomas Soome COPY32(strlen(s) + 1, a); \
148199767f8SToomas Soome i386_copyin(s, a, strlen(s) + 1); \
149199767f8SToomas Soome a += roundup(strlen(s) + 1, sizeof(u_int64_t));\
150199767f8SToomas Soome }
151199767f8SToomas Soome
152199767f8SToomas Soome #define MOD_NAME(a, s) MOD_STR(MODINFO_NAME, a, s)
153199767f8SToomas Soome #define MOD_TYPE(a, s) MOD_STR(MODINFO_TYPE, a, s)
154199767f8SToomas Soome #define MOD_ARGS(a, s) MOD_STR(MODINFO_ARGS, a, s)
155199767f8SToomas Soome
156199767f8SToomas Soome #define MOD_VAR(t, a, s) { \
157199767f8SToomas Soome COPY32(t, a); \
158199767f8SToomas Soome COPY32(sizeof(s), a); \
159199767f8SToomas Soome i386_copyin(&s, a, sizeof(s)); \
160199767f8SToomas Soome a += roundup(sizeof(s), sizeof(u_int64_t)); \
161199767f8SToomas Soome }
162199767f8SToomas Soome
163199767f8SToomas Soome #define MOD_ADDR(a, s) MOD_VAR(MODINFO_ADDR, a, s)
164199767f8SToomas Soome #define MOD_SIZE(a, s) MOD_VAR(MODINFO_SIZE, a, s)
165199767f8SToomas Soome
166199767f8SToomas Soome #define MOD_METADATA(a, mm) { \
167199767f8SToomas Soome COPY32(MODINFO_METADATA | mm->md_type, a); \
168199767f8SToomas Soome COPY32(mm->md_size, a); \
169199767f8SToomas Soome i386_copyin(mm->md_data, a, mm->md_size); \
170199767f8SToomas Soome a += roundup(mm->md_size, sizeof(u_int64_t));\
171199767f8SToomas Soome }
172199767f8SToomas Soome
173199767f8SToomas Soome #define MOD_END(a) { \
174199767f8SToomas Soome COPY32(MODINFO_END, a); \
175199767f8SToomas Soome COPY32(0, a); \
176199767f8SToomas Soome }
177199767f8SToomas Soome
178199767f8SToomas Soome vm_offset_t
bi_copymodules(vm_offset_t addr)179199767f8SToomas Soome bi_copymodules(vm_offset_t addr)
180199767f8SToomas Soome {
181199767f8SToomas Soome struct preloaded_file *fp;
182199767f8SToomas Soome struct file_metadata *md;
183199767f8SToomas Soome
184199767f8SToomas Soome /* Start with the first module on the list, should be the kernel. */
185199767f8SToomas Soome for (fp = file_findfile(NULL, NULL); fp != NULL; fp = fp->f_next) {
186199767f8SToomas Soome /* The name field must come first. */
187199767f8SToomas Soome MOD_NAME(addr, fp->f_name);
188199767f8SToomas Soome MOD_TYPE(addr, fp->f_type);
189199767f8SToomas Soome if (fp->f_args)
190199767f8SToomas Soome MOD_ARGS(addr, fp->f_args);
191199767f8SToomas Soome MOD_ADDR(addr, fp->f_addr);
192199767f8SToomas Soome MOD_SIZE(addr, fp->f_size);
193199767f8SToomas Soome for (md = fp->f_metadata; md != NULL; md = md->md_next) {
194199767f8SToomas Soome if (!(md->md_type & MODINFOMD_NOCOPY))
195199767f8SToomas Soome MOD_METADATA(addr, md);
196199767f8SToomas Soome }
197199767f8SToomas Soome }
198199767f8SToomas Soome MOD_END(addr);
199199767f8SToomas Soome return(addr);
200199767f8SToomas Soome }
201199767f8SToomas Soome
202199767f8SToomas Soome /*
203199767f8SToomas Soome * Load the information expected by the kernel.
204199767f8SToomas Soome *
205199767f8SToomas Soome * - The kernel environment is copied into kernel space.
206199767f8SToomas Soome * - Module metadata are formatted and placed in kernel space.
207199767f8SToomas Soome */
208199767f8SToomas Soome int
bi_load(struct preloaded_file * fp,uint64_t * bi_addr)209199767f8SToomas Soome bi_load(struct preloaded_file *fp, uint64_t *bi_addr)
210199767f8SToomas Soome {
211199767f8SToomas Soome struct bootinfo bi;
212199767f8SToomas Soome struct preloaded_file *xp;
213199767f8SToomas Soome struct file_metadata *md;
214199767f8SToomas Soome struct devdesc *rootdev;
215199767f8SToomas Soome char *rootdevname;
216199767f8SToomas Soome vm_offset_t addr, ssym, esym;
217199767f8SToomas Soome
218199767f8SToomas Soome bzero(&bi, sizeof(struct bootinfo));
219199767f8SToomas Soome bi.bi_version = 1;
220199767f8SToomas Soome // bi.bi_boothowto = bi_getboothowto(fp->f_args);
221199767f8SToomas Soome
222199767f8SToomas Soome /*
223199767f8SToomas Soome * Allow the environment variable 'rootdev' to override the supplied
224199767f8SToomas Soome * device. This should perhaps go to MI code and/or have $rootdev
225199767f8SToomas Soome * tested/set by MI code before launching the kernel.
226199767f8SToomas Soome */
227199767f8SToomas Soome rootdevname = getenv("rootdev");
228199767f8SToomas Soome i386_getdev((void**)&rootdev, rootdevname, NULL);
229199767f8SToomas Soome if (rootdev != NULL) {
230199767f8SToomas Soome /* Try reading /etc/fstab to select the root device. */
231199767f8SToomas Soome getrootmount(i386_fmtdev(rootdev));
232199767f8SToomas Soome free(rootdev);
233199767f8SToomas Soome }
234199767f8SToomas Soome
235199767f8SToomas Soome md = file_findmetadata(fp, MODINFOMD_SSYM);
236199767f8SToomas Soome ssym = (md != NULL) ? *((vm_offset_t *)&(md->md_data)) : 0;
237199767f8SToomas Soome md = file_findmetadata(fp, MODINFOMD_ESYM);
238199767f8SToomas Soome esym = (md != NULL) ? *((vm_offset_t *)&(md->md_data)) : 0;
239199767f8SToomas Soome if (ssym != 0 && esym != 0) {
240199767f8SToomas Soome bi.bi_symtab = ssym;
241199767f8SToomas Soome bi.bi_esymtab = esym;
242199767f8SToomas Soome }
243199767f8SToomas Soome
244199767f8SToomas Soome /* Find the last module in the chain. */
245199767f8SToomas Soome addr = 0;
246199767f8SToomas Soome for (xp = file_findfile(NULL, NULL); xp != NULL; xp = xp->f_next) {
247199767f8SToomas Soome if (addr < (xp->f_addr + xp->f_size))
248199767f8SToomas Soome addr = xp->f_addr + xp->f_size;
249199767f8SToomas Soome }
250199767f8SToomas Soome
251199767f8SToomas Soome addr = (addr + 15) & ~15;
252199767f8SToomas Soome
253199767f8SToomas Soome /* Copy module list and metadata. */
254199767f8SToomas Soome bi.bi_modulep = addr;
255199767f8SToomas Soome addr = bi_copymodules(addr);
256199767f8SToomas Soome if (addr <= bi.bi_modulep) {
257199767f8SToomas Soome addr = bi.bi_modulep;
258199767f8SToomas Soome bi.bi_modulep = 0;
259199767f8SToomas Soome }
260199767f8SToomas Soome
261199767f8SToomas Soome addr = (addr + 15) & ~15;
262199767f8SToomas Soome
263199767f8SToomas Soome /* Copy our environment. */
264199767f8SToomas Soome bi.bi_envp = addr;
265199767f8SToomas Soome addr = bi_copyenv(addr);
266199767f8SToomas Soome if (addr <= bi.bi_envp) {
267199767f8SToomas Soome addr = bi.bi_envp;
268199767f8SToomas Soome bi.bi_envp = 0;
269199767f8SToomas Soome }
270199767f8SToomas Soome
271199767f8SToomas Soome addr = (addr + PAGE_MASK) & ~PAGE_MASK;
272199767f8SToomas Soome bi.bi_kernend = addr;
273199767f8SToomas Soome
274199767f8SToomas Soome return (ldr_bootinfo(&bi, bi_addr));
275199767f8SToomas Soome }
276