1/*-
2 * Copyright (c) 1998 Michael Smith <msmith@freebsd.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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.
13 *
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
24 * SUCH DAMAGE.
25 */
26
27#include <sys/cdefs.h>
28__FBSDID("$FreeBSD$");
29
30#include <stand.h>
31#include <sys/param.h>
32#include <sys/reboot.h>
33#include <sys/linker.h>
34#include <machine/bootinfo.h>
35#include "bootstrap.h"
36#include "libi386.h"
37#include "btxv86.h"
38
39static struct bootinfo  bi;
40
41/*
42 * Copy module-related data into the load area, where it can be
43 * used as a directory for loaded modules.
44 *
45 * Module data is presented in a self-describing format.  Each datum
46 * is preceded by a 32-bit identifier and a 32-bit size field.
47 *
48 * Currently, the following data are saved:
49 *
50 * MOD_NAME	(variable)		module name (string)
51 * MOD_TYPE	(variable)		module type (string)
52 * MOD_ARGS	(variable)		module parameters (string)
53 * MOD_ADDR	sizeof(vm_offset_t)	module load address
54 * MOD_SIZE	sizeof(size_t)		module size
55 * MOD_METADATA	(variable)		type-specific metadata
56 */
57#define COPY32(v, a, c) {			\
58    u_int32_t	x = (v);			\
59    if (c)					\
60	i386_copyin(&x, a, sizeof(x));		\
61    a += sizeof(x);				\
62}
63
64#define MOD_STR(t, a, s, c) {			\
65    COPY32(t, a, c);				\
66    COPY32(strlen(s) + 1, a, c);		\
67    if (c)					\
68	i386_copyin(s, a, strlen(s) + 1);	\
69    a += roundup(strlen(s) + 1, sizeof(u_long));\
70}
71
72#define MOD_NAME(a, s, c)	MOD_STR(MODINFO_NAME, a, s, c)
73#define MOD_TYPE(a, s, c)	MOD_STR(MODINFO_TYPE, a, s, c)
74#define MOD_ARGS(a, s, c)	MOD_STR(MODINFO_ARGS, a, s, c)
75
76#define MOD_VAR(t, a, s, c) {			\
77    COPY32(t, a, c);				\
78    COPY32(sizeof(s), a, c);			\
79    if (c)					\
80	i386_copyin(&s, a, sizeof(s));		\
81    a += roundup(sizeof(s), sizeof(u_long));	\
82}
83
84#define MOD_ADDR(a, s, c)	MOD_VAR(MODINFO_ADDR, a, s, c)
85#define MOD_SIZE(a, s, c)	MOD_VAR(MODINFO_SIZE, a, s, c)
86
87#define MOD_METADATA(a, mm, c) {		\
88    COPY32(MODINFO_METADATA | mm->md_type, a, c); \
89    COPY32(mm->md_size, a, c);			\
90    if (c)					\
91	i386_copyin(mm->md_data, a, mm->md_size); \
92    a += roundup(mm->md_size, sizeof(u_long));\
93}
94
95#define MOD_END(a, c) {				\
96    COPY32(MODINFO_END, a, c);			\
97    COPY32(0, a, c);				\
98}
99
100static vm_offset_t
101bi_copymodules32(vm_offset_t addr)
102{
103    struct preloaded_file	*fp;
104    struct file_metadata	*md;
105    int				c;
106
107    c = addr != 0;
108    /* start with the first module on the list, should be the kernel */
109    for (fp = file_findfile(NULL, NULL); fp != NULL; fp = fp->f_next) {
110
111	MOD_NAME(addr, fp->f_name, c);	/* this field must come first */
112	MOD_TYPE(addr, fp->f_type, c);
113	if (fp->f_args)
114	    MOD_ARGS(addr, fp->f_args, c);
115	MOD_ADDR(addr, fp->f_addr, c);
116	MOD_SIZE(addr, fp->f_size, c);
117	for (md = fp->f_metadata; md != NULL; md = md->md_next)
118	    if (!(md->md_type & MODINFOMD_NOCOPY))
119		MOD_METADATA(addr, md, c);
120    }
121    MOD_END(addr, c);
122    return(addr);
123}
124
125/*
126 * Load the information expected by an i386 kernel.
127 *
128 * - The 'boothowto' argument is constructed
129 * - The 'bootdev' argument is constructed
130 * - The 'bootinfo' struct is constructed, and copied into the kernel space.
131 * - The kernel environment is copied into kernel space.
132 * - Module metadata are formatted and placed in kernel space.
133 */
134int
135bi_load32(char *args, int *howtop, int *bootdevp, vm_offset_t *bip, vm_offset_t *modulep, vm_offset_t *kernendp)
136{
137    struct preloaded_file	*xp, *kfp;
138    struct i386_devdesc		*rootdev;
139    struct file_metadata	*md;
140    vm_offset_t			addr;
141    vm_offset_t			kernend;
142    vm_offset_t			envp;
143    vm_offset_t			size;
144    vm_offset_t			ssym, esym;
145    char			*rootdevname;
146    int				bootdevnr, i, howto;
147    char			*kernelname;
148    const char			*kernelpath;
149
150    howto = bi_getboothowto(args);
151
152    /*
153     * Allow the environment variable 'rootdev' to override the supplied device
154     * This should perhaps go to MI code and/or have $rootdev tested/set by
155     * MI code before launching the kernel.
156     */
157    rootdevname = getenv("rootdev");
158    i386_getdev((void **)(&rootdev), rootdevname, NULL);
159    if (rootdev == NULL) {		/* bad $rootdev/$currdev */
160	printf("can't determine root device\n");
161	return(EINVAL);
162    }
163
164    /* Try reading the /etc/fstab file to select the root device */
165    getrootmount(i386_fmtdev((void *)rootdev));
166
167    /* Do legacy rootdev guessing */
168
169    /* XXX - use a default bootdev of 0.  Is this ok??? */
170    bootdevnr = 0;
171
172    switch(rootdev->d_type) {
173    case DEVT_CD:
174	    /* Pass in BIOS device number. */
175	    bi.bi_bios_dev = bc_unit2bios(rootdev->d_unit);
176	    bootdevnr = bc_getdev(rootdev);
177	    break;
178
179    case DEVT_DISK:
180	/* pass in the BIOS device number of the current disk */
181	bi.bi_bios_dev = bd_unit2bios(rootdev->d_unit);
182	bootdevnr = bd_getdev(rootdev);
183	break;
184
185    case DEVT_NET:
186    case DEVT_ZFS:
187	    break;
188
189    default:
190	printf("WARNING - don't know how to boot from device type %d\n", rootdev->d_type);
191    }
192    if (bootdevnr == -1) {
193	printf("root device %s invalid\n", i386_fmtdev(rootdev));
194	return (EINVAL);
195    }
196    free(rootdev);
197
198    /* find the last module in the chain */
199    addr = 0;
200    for (xp = file_findfile(NULL, NULL); xp != NULL; xp = xp->f_next) {
201	if (addr < (xp->f_addr + xp->f_size))
202	    addr = xp->f_addr + xp->f_size;
203    }
204    /* pad to a page boundary */
205    addr = roundup(addr, PAGE_SIZE);
206
207    /* copy our environment */
208    envp = addr;
209    addr = bi_copyenv(addr);
210
211    /* pad to a page boundary */
212    addr = roundup(addr, PAGE_SIZE);
213
214    kfp = file_findfile(NULL, "elf kernel");
215    if (kfp == NULL)
216      kfp = file_findfile(NULL, "elf32 kernel");
217    if (kfp == NULL)
218	panic("can't find kernel file");
219    kernend = 0;	/* fill it in later */
220    file_addmetadata(kfp, MODINFOMD_HOWTO, sizeof howto, &howto);
221    file_addmetadata(kfp, MODINFOMD_ENVP, sizeof envp, &envp);
222    file_addmetadata(kfp, MODINFOMD_KERNEND, sizeof kernend, &kernend);
223    bios_addsmapdata(kfp);
224
225    /* Figure out the size and location of the metadata */
226    *modulep = addr;
227    size = bi_copymodules32(0);
228    kernend = roundup(addr + size, PAGE_SIZE);
229    *kernendp = kernend;
230
231    /* patch MODINFOMD_KERNEND */
232    md = file_findmetadata(kfp, MODINFOMD_KERNEND);
233    bcopy(&kernend, md->md_data, sizeof kernend);
234
235    /* copy module list and metadata */
236    (void)bi_copymodules32(addr);
237
238    ssym = esym = 0;
239    md = file_findmetadata(kfp, MODINFOMD_SSYM);
240    if (md != NULL)
241	ssym = *((vm_offset_t *)&(md->md_data));
242    md = file_findmetadata(kfp, MODINFOMD_ESYM);
243    if (md != NULL)
244	esym = *((vm_offset_t *)&(md->md_data));
245    if (ssym == 0 || esym == 0)
246	ssym = esym = 0;		/* sanity */
247
248    /* legacy bootinfo structure */
249    kernelname = getenv("kernelname");
250    i386_getdev(NULL, kernelname, &kernelpath);
251    bi.bi_version = BOOTINFO_VERSION;
252    bi.bi_kernelname = 0;		/* XXX char * -> kernel name */
253    bi.bi_nfs_diskless = 0;		/* struct nfs_diskless * */
254    bi.bi_n_bios_used = 0;		/* XXX would have to hook biosdisk driver for these */
255    for (i = 0; i < N_BIOS_GEOM; i++)
256        bi.bi_bios_geom[i] = bd_getbigeom(i);
257    bi.bi_size = sizeof(bi);
258    bi.bi_memsizes_valid = 1;
259    bi.bi_basemem = bios_basemem / 1024;
260    bi.bi_extmem = bios_extmem / 1024;
261    bi.bi_envp = envp;
262    bi.bi_modulep = *modulep;
263    bi.bi_kernend = kernend;
264    bi.bi_kernelname = VTOP(kernelpath);
265    bi.bi_symtab = ssym;       /* XXX this is only the primary kernel symtab */
266    bi.bi_esymtab = esym;
267
268    /* legacy boot arguments */
269    *howtop = howto | RB_BOOTINFO;
270    *bootdevp = bootdevnr;
271    *bip = VTOP(&bi);
272
273    return(0);
274}
275