176b35943SToomas Soome /*
2199767f8SToomas Soome  * Copyright (c) 1998 Michael Smith <msmith@freebsd.org>
3199767f8SToomas Soome  * All rights reserved.
4199767f8SToomas Soome  *
5199767f8SToomas Soome  * Redistribution and use in source and binary forms, with or without
6199767f8SToomas Soome  * modification, are permitted provided that the following conditions
7199767f8SToomas Soome  * are met:
8199767f8SToomas Soome  * 1. Redistributions of source code must retain the above copyright
9199767f8SToomas Soome  *    notice, this list of conditions and the following disclaimer.
10199767f8SToomas Soome  * 2. Redistributions in binary form must reproduce the above copyright
11199767f8SToomas Soome  *    notice, this list of conditions and the following disclaimer in the
12199767f8SToomas Soome  *    documentation and/or other materials provided with the distribution.
13199767f8SToomas Soome  *
14199767f8SToomas Soome  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15199767f8SToomas Soome  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16199767f8SToomas Soome  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17199767f8SToomas Soome  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18199767f8SToomas Soome  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19199767f8SToomas Soome  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20199767f8SToomas Soome  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21199767f8SToomas Soome  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22199767f8SToomas Soome  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23199767f8SToomas Soome  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24199767f8SToomas Soome  * SUCH DAMAGE.
25199767f8SToomas Soome  */
26199767f8SToomas Soome 
27199767f8SToomas Soome #include <sys/cdefs.h>
28199767f8SToomas Soome 
29199767f8SToomas Soome #include <stand.h>
30199767f8SToomas Soome #include <sys/param.h>
31199767f8SToomas Soome #include <sys/reboot.h>
32199767f8SToomas Soome #include <sys/linker.h>
33199767f8SToomas Soome #include <machine/bootinfo.h>
34199767f8SToomas Soome #include "bootstrap.h"
35199767f8SToomas Soome #include "libi386.h"
36199767f8SToomas Soome #include "btxv86.h"
37199767f8SToomas Soome 
38199767f8SToomas Soome static struct bootinfo  bi;
39199767f8SToomas Soome 
40199767f8SToomas Soome /*
41199767f8SToomas Soome  * Copy module-related data into the load area, where it can be
42199767f8SToomas Soome  * used as a directory for loaded modules.
43199767f8SToomas Soome  *
44199767f8SToomas Soome  * Module data is presented in a self-describing format.  Each datum
45199767f8SToomas Soome  * is preceded by a 32-bit identifier and a 32-bit size field.
46199767f8SToomas Soome  *
47199767f8SToomas Soome  * Currently, the following data are saved:
48199767f8SToomas Soome  *
49199767f8SToomas Soome  * MOD_NAME	(variable)		module name (string)
50199767f8SToomas Soome  * MOD_TYPE	(variable)		module type (string)
51199767f8SToomas Soome  * MOD_ARGS	(variable)		module parameters (string)
52199767f8SToomas Soome  * MOD_ADDR	sizeof(vm_offset_t)	module load address
53199767f8SToomas Soome  * MOD_SIZE	sizeof(size_t)		module size
54199767f8SToomas Soome  * MOD_METADATA	(variable)		type-specific metadata
55199767f8SToomas Soome  */
56199767f8SToomas Soome #define COPY32(v, a, c) {			\
57199767f8SToomas Soome     u_int32_t	x = (v);			\
58199767f8SToomas Soome     if (c)					\
59199767f8SToomas Soome 	i386_copyin(&x, a, sizeof(x));		\
60199767f8SToomas Soome     a += sizeof(x);				\
61199767f8SToomas Soome }
62199767f8SToomas Soome 
63199767f8SToomas Soome #define MOD_STR(t, a, s, c) {			\
64199767f8SToomas Soome     COPY32(t, a, c);				\
65199767f8SToomas Soome     COPY32(strlen(s) + 1, a, c);		\
66199767f8SToomas Soome     if (c)					\
67199767f8SToomas Soome 	i386_copyin(s, a, strlen(s) + 1);	\
68199767f8SToomas Soome     a += roundup(strlen(s) + 1, sizeof(u_long));\
69199767f8SToomas Soome }
70199767f8SToomas Soome 
71199767f8SToomas Soome #define MOD_NAME(a, s, c)	MOD_STR(MODINFO_NAME, a, s, c)
72199767f8SToomas Soome #define MOD_TYPE(a, s, c)	MOD_STR(MODINFO_TYPE, a, s, c)
73199767f8SToomas Soome #define MOD_ARGS(a, s, c)	MOD_STR(MODINFO_ARGS, a, s, c)
74199767f8SToomas Soome 
75199767f8SToomas Soome #define MOD_VAR(t, a, s, c) {			\
76199767f8SToomas Soome     COPY32(t, a, c);				\
77199767f8SToomas Soome     COPY32(sizeof(s), a, c);			\
78199767f8SToomas Soome     if (c)					\
79199767f8SToomas Soome 	i386_copyin(&s, a, sizeof(s));		\
80199767f8SToomas Soome     a += roundup(sizeof(s), sizeof(u_long));	\
81199767f8SToomas Soome }
82199767f8SToomas Soome 
83199767f8SToomas Soome #define MOD_ADDR(a, s, c)	MOD_VAR(MODINFO_ADDR, a, s, c)
84199767f8SToomas Soome #define MOD_SIZE(a, s, c)	MOD_VAR(MODINFO_SIZE, a, s, c)
85199767f8SToomas Soome 
86199767f8SToomas Soome #define MOD_METADATA(a, mm, c) {		\
87199767f8SToomas Soome     COPY32(MODINFO_METADATA | mm->md_type, a, c); \
88199767f8SToomas Soome     COPY32(mm->md_size, a, c);			\
89199767f8SToomas Soome     if (c)					\
90199767f8SToomas Soome 	i386_copyin(mm->md_data, a, mm->md_size); \
91199767f8SToomas Soome     a += roundup(mm->md_size, sizeof(u_long));\
92199767f8SToomas Soome }
93199767f8SToomas Soome 
94199767f8SToomas Soome #define MOD_END(a, c) {				\
95199767f8SToomas Soome     COPY32(MODINFO_END, a, c);			\
96199767f8SToomas Soome     COPY32(0, a, c);				\
97199767f8SToomas Soome }
98199767f8SToomas Soome 
99199767f8SToomas Soome static vm_offset_t
bi_copymodules32(vm_offset_t addr)100199767f8SToomas Soome bi_copymodules32(vm_offset_t addr)
101199767f8SToomas Soome {
102199767f8SToomas Soome     struct preloaded_file	*fp;
103199767f8SToomas Soome     struct file_metadata	*md;
104199767f8SToomas Soome     int				c;
105199767f8SToomas Soome 
106199767f8SToomas Soome     c = addr != 0;
107199767f8SToomas Soome     /* start with the first module on the list, should be the kernel */
108199767f8SToomas Soome     for (fp = file_findfile(NULL, NULL); fp != NULL; fp = fp->f_next) {
109199767f8SToomas Soome 
110199767f8SToomas Soome 	MOD_NAME(addr, fp->f_name, c);	/* this field must come first */
111199767f8SToomas Soome 	MOD_TYPE(addr, fp->f_type, c);
112199767f8SToomas Soome 	if (fp->f_args)
113199767f8SToomas Soome 	    MOD_ARGS(addr, fp->f_args, c);
114199767f8SToomas Soome 	MOD_ADDR(addr, fp->f_addr, c);
115199767f8SToomas Soome 	MOD_SIZE(addr, fp->f_size, c);
116199767f8SToomas Soome 	for (md = fp->f_metadata; md != NULL; md = md->md_next)
117199767f8SToomas Soome 	    if (!(md->md_type & MODINFOMD_NOCOPY))
118199767f8SToomas Soome 		MOD_METADATA(addr, md, c);
119199767f8SToomas Soome     }
120199767f8SToomas Soome     MOD_END(addr, c);
121199767f8SToomas Soome     return(addr);
122199767f8SToomas Soome }
123199767f8SToomas Soome 
124199767f8SToomas Soome /*
125199767f8SToomas Soome  * Load the information expected by an i386 kernel.
126199767f8SToomas Soome  *
127199767f8SToomas Soome  * - The 'boothowto' argument is constructed
128199767f8SToomas Soome  * - The 'bootdev' argument is constructed
129199767f8SToomas Soome  * - The 'bootinfo' struct is constructed, and copied into the kernel space.
130199767f8SToomas Soome  * - The kernel environment is copied into kernel space.
131199767f8SToomas Soome  * - Module metadata are formatted and placed in kernel space.
132199767f8SToomas Soome  */
133199767f8SToomas Soome int
bi_load32(char * args,int * howtop,int * bootdevp,vm_offset_t * bip,vm_offset_t * modulep,vm_offset_t * kernendp)134199767f8SToomas Soome bi_load32(char *args, int *howtop, int *bootdevp, vm_offset_t *bip, vm_offset_t *modulep, vm_offset_t *kernendp)
135199767f8SToomas Soome {
136199767f8SToomas Soome     struct preloaded_file	*xp, *kfp;
137199767f8SToomas Soome     struct i386_devdesc		*rootdev;
138199767f8SToomas Soome     struct file_metadata	*md;
139199767f8SToomas Soome     vm_offset_t			addr;
140199767f8SToomas Soome     vm_offset_t			kernend;
141199767f8SToomas Soome     vm_offset_t			envp;
142199767f8SToomas Soome     vm_offset_t			size;
143199767f8SToomas Soome     vm_offset_t			ssym, esym;
144199767f8SToomas Soome     char			*rootdevname;
145199767f8SToomas Soome     int				bootdevnr, i, howto;
146199767f8SToomas Soome     char			*kernelname;
147199767f8SToomas Soome     const char			*kernelpath;
148199767f8SToomas Soome 
149199767f8SToomas Soome     howto = bi_getboothowto(args);
150199767f8SToomas Soome 
151c142ce19SToomas Soome     /*
152c142ce19SToomas Soome      * Allow the environment variable 'rootdev' to override the supplied device
153199767f8SToomas Soome      * This should perhaps go to MI code and/or have $rootdev tested/set by
154199767f8SToomas Soome      * MI code before launching the kernel.
155199767f8SToomas Soome      */
156199767f8SToomas Soome     rootdevname = getenv("rootdev");
157199767f8SToomas Soome     i386_getdev((void **)(&rootdev), rootdevname, NULL);
158199767f8SToomas Soome     if (rootdev == NULL) {		/* bad $rootdev/$currdev */
159199767f8SToomas Soome 	printf("can't determine root device\n");
160199767f8SToomas Soome 	return(EINVAL);
161199767f8SToomas Soome     }
162199767f8SToomas Soome 
163199767f8SToomas Soome     /* Try reading the /etc/fstab file to select the root device */
164199767f8SToomas Soome     getrootmount(i386_fmtdev((void *)rootdev));
165199767f8SToomas Soome 
166199767f8SToomas Soome     /* Do legacy rootdev guessing */
167199767f8SToomas Soome 
168199767f8SToomas Soome     /* XXX - use a default bootdev of 0.  Is this ok??? */
169199767f8SToomas Soome     bootdevnr = 0;
170199767f8SToomas Soome 
171c142ce19SToomas Soome     switch(rootdev->dd.d_dev->dv_type) {
172199767f8SToomas Soome     case DEVT_CD:
173199767f8SToomas Soome     case DEVT_DISK:
174199767f8SToomas Soome 	/* pass in the BIOS device number of the current disk */
175863275a4SToomas Soome 	bi.bi_bios_dev = bd_unit2bios(rootdev);
176199767f8SToomas Soome 	bootdevnr = bd_getdev(rootdev);
177199767f8SToomas Soome 	break;
178199767f8SToomas Soome 
179199767f8SToomas Soome     case DEVT_NET:
180199767f8SToomas Soome     case DEVT_ZFS:
181199767f8SToomas Soome 	    break;
18276b35943SToomas Soome 
183199767f8SToomas Soome     default:
18476b35943SToomas Soome 	printf("WARNING - don't know how to boot from device type %d\n",
185c142ce19SToomas Soome 	    rootdev->dd.d_dev->dv_type);
186199767f8SToomas Soome     }
187199767f8SToomas Soome     if (bootdevnr == -1) {
188199767f8SToomas Soome 	printf("root device %s invalid\n", i386_fmtdev(rootdev));
189199767f8SToomas Soome 	return (EINVAL);
190199767f8SToomas Soome     }
191199767f8SToomas Soome     free(rootdev);
192199767f8SToomas Soome 
193199767f8SToomas Soome     /* find the last module in the chain */
194199767f8SToomas Soome     addr = 0;
195199767f8SToomas Soome     for (xp = file_findfile(NULL, NULL); xp != NULL; xp = xp->f_next) {
196199767f8SToomas Soome 	if (addr < (xp->f_addr + xp->f_size))
197199767f8SToomas Soome 	    addr = xp->f_addr + xp->f_size;
198199767f8SToomas Soome     }
199199767f8SToomas Soome     /* pad to a page boundary */
200199767f8SToomas Soome     addr = roundup(addr, PAGE_SIZE);
201199767f8SToomas Soome 
202199767f8SToomas Soome     /* copy our environment */
203199767f8SToomas Soome     envp = addr;
204199767f8SToomas Soome     addr = bi_copyenv(addr);
205199767f8SToomas Soome 
206199767f8SToomas Soome     /* pad to a page boundary */
207199767f8SToomas Soome     addr = roundup(addr, PAGE_SIZE);
208199767f8SToomas Soome 
209199767f8SToomas Soome     kfp = file_findfile(NULL, "elf kernel");
210199767f8SToomas Soome     if (kfp == NULL)
211199767f8SToomas Soome       kfp = file_findfile(NULL, "elf32 kernel");
212199767f8SToomas Soome     if (kfp == NULL)
213199767f8SToomas Soome 	panic("can't find kernel file");
214199767f8SToomas Soome     kernend = 0;	/* fill it in later */
215199767f8SToomas Soome     file_addmetadata(kfp, MODINFOMD_HOWTO, sizeof howto, &howto);
216199767f8SToomas Soome     file_addmetadata(kfp, MODINFOMD_ENVP, sizeof envp, &envp);
217199767f8SToomas Soome     file_addmetadata(kfp, MODINFOMD_KERNEND, sizeof kernend, &kernend);
218199767f8SToomas Soome     bios_addsmapdata(kfp);
219199767f8SToomas Soome 
220199767f8SToomas Soome     /* Figure out the size and location of the metadata */
221199767f8SToomas Soome     *modulep = addr;
222199767f8SToomas Soome     size = bi_copymodules32(0);
223199767f8SToomas Soome     kernend = roundup(addr + size, PAGE_SIZE);
224199767f8SToomas Soome     *kernendp = kernend;
225199767f8SToomas Soome 
226199767f8SToomas Soome     /* patch MODINFOMD_KERNEND */
227199767f8SToomas Soome     md = file_findmetadata(kfp, MODINFOMD_KERNEND);
228199767f8SToomas Soome     bcopy(&kernend, md->md_data, sizeof kernend);
229199767f8SToomas Soome 
230199767f8SToomas Soome     /* copy module list and metadata */
231199767f8SToomas Soome     (void)bi_copymodules32(addr);
232199767f8SToomas Soome 
233199767f8SToomas Soome     ssym = esym = 0;
234199767f8SToomas Soome     md = file_findmetadata(kfp, MODINFOMD_SSYM);
235199767f8SToomas Soome     if (md != NULL)
23657aea934SToomas Soome 	bcopy(&md->md_data, &ssym, sizeof (vm_offset_t));
237199767f8SToomas Soome     md = file_findmetadata(kfp, MODINFOMD_ESYM);
238199767f8SToomas Soome     if (md != NULL)
23957aea934SToomas Soome 	bcopy(&md->md_data, &esym, sizeof (vm_offset_t));
240199767f8SToomas Soome     if (ssym == 0 || esym == 0)
241199767f8SToomas Soome 	ssym = esym = 0;		/* sanity */
242199767f8SToomas Soome 
243199767f8SToomas Soome     /* legacy bootinfo structure */
244199767f8SToomas Soome     kernelname = getenv("kernelname");
245199767f8SToomas Soome     i386_getdev(NULL, kernelname, &kernelpath);
246199767f8SToomas Soome     bi.bi_version = BOOTINFO_VERSION;
247199767f8SToomas Soome     bi.bi_kernelname = 0;		/* XXX char * -> kernel name */
248199767f8SToomas Soome     bi.bi_nfs_diskless = 0;		/* struct nfs_diskless * */
249199767f8SToomas Soome     bi.bi_n_bios_used = 0;		/* XXX would have to hook biosdisk driver for these */
250199767f8SToomas Soome     for (i = 0; i < N_BIOS_GEOM; i++)
251199767f8SToomas Soome         bi.bi_bios_geom[i] = bd_getbigeom(i);
252199767f8SToomas Soome     bi.bi_size = sizeof(bi);
253199767f8SToomas Soome     bi.bi_memsizes_valid = 1;
254199767f8SToomas Soome     bi.bi_basemem = bios_basemem / 1024;
255199767f8SToomas Soome     bi.bi_extmem = bios_extmem / 1024;
256199767f8SToomas Soome     bi.bi_envp = envp;
257199767f8SToomas Soome     bi.bi_modulep = *modulep;
258199767f8SToomas Soome     bi.bi_kernend = kernend;
259199767f8SToomas Soome     bi.bi_kernelname = VTOP(kernelpath);
260199767f8SToomas Soome     bi.bi_symtab = ssym;       /* XXX this is only the primary kernel symtab */
261199767f8SToomas Soome     bi.bi_esymtab = esym;
262199767f8SToomas Soome 
263199767f8SToomas Soome     /* legacy boot arguments */
264199767f8SToomas Soome     *howtop = howto | RB_BOOTINFO;
265199767f8SToomas Soome     *bootdevp = bootdevnr;
266199767f8SToomas Soome     *bip = VTOP(&bi);
267199767f8SToomas Soome 
268199767f8SToomas Soome     return(0);
269199767f8SToomas Soome }
270