initial commit
[freebsd-arm:freebsd-arm.git] / boot / powerpc / ofw / metadata.c
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  *      from: FreeBSD: src/sys/boot/sparc64/loader/metadata.c,v 1.6
27  */
28
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
31
32 #include <stand.h>
33 #include <sys/param.h>
34 #include <sys/reboot.h>
35 #include <sys/linker.h>
36
37 #include <machine/metadata.h>
38
39 #include "bootstrap.h"
40 #include "libofw.h"
41
42 /*
43  * Return a 'boothowto' value corresponding to the kernel arguments in
44  * (kargs) and any relevant environment variables.
45  */
46 static struct 
47 {
48     const char  *ev;
49     int         mask;
50 } howto_names[] = {
51     {"boot_askname",    RB_ASKNAME},
52     {"boot_cdrom",      RB_CDROM},
53     {"boot_ddb",        RB_KDB},
54     {"boot_dfltroot",   RB_DFLTROOT},
55     {"boot_gdb",        RB_GDB},
56     {"boot_multicons",  RB_MULTIPLE},
57     {"boot_mute",       RB_MUTE},
58     {"boot_pause",      RB_PAUSE},
59     {"boot_serial",     RB_SERIAL},
60     {"boot_single",     RB_SINGLE},
61     {"boot_verbose",    RB_VERBOSE},
62     {NULL,      0}
63 };
64
65 int
66 md_getboothowto(char *kargs)
67 {
68     char        *cp;
69     int         howto;
70     int         active;
71     int         i;
72     
73     /* Parse kargs */
74     howto = 0;
75     if (kargs != NULL) {
76         cp = kargs;
77         active = 0;
78         while (*cp != 0) {
79             if (!active && (*cp == '-')) {
80                 active = 1;
81             } else if (active)
82                 switch (*cp) {
83                 case 'a':
84                     howto |= RB_ASKNAME;
85                     break;
86                 case 'C':
87                     howto |= RB_CDROM;
88                     break;
89                 case 'd':
90                     howto |= RB_KDB;
91                     break;
92                 case 'D':
93                     howto |= RB_MULTIPLE;
94                     break;
95                 case 'm':
96                     howto |= RB_MUTE;
97                     break;
98                 case 'g':
99                     howto |= RB_GDB;
100                     break;
101                 case 'h':
102                     howto |= RB_SERIAL;
103                     break;
104                 case 'p':
105                     howto |= RB_PAUSE;
106                     break;
107                 case 'r':
108                     howto |= RB_DFLTROOT;
109                     break;
110                 case 's':
111                     howto |= RB_SINGLE;
112                     break;
113                 case 'v':
114                     howto |= RB_VERBOSE;
115                     break;
116                 default:
117                     active = 0;
118                     break;
119                 }
120             cp++;
121         }
122     }
123     /* get equivalents from the environment */
124     for (i = 0; howto_names[i].ev != NULL; i++)
125         if (getenv(howto_names[i].ev) != NULL)
126             howto |= howto_names[i].mask;
127     if (!strcmp(getenv("console"), "comconsole"))
128         howto |= RB_SERIAL;
129     if (!strcmp(getenv("console"), "nullconsole"))
130         howto |= RB_MUTE;
131     return(howto);
132 }
133
134 /*
135  * Copy the environment into the load area starting at (addr).
136  * Each variable is formatted as <name>=<value>, with a single nul
137  * separating each variable, and a double nul terminating the environment.
138  */
139 vm_offset_t
140 md_copyenv(vm_offset_t addr)
141 {
142     struct env_var      *ep;
143     
144     /* traverse the environment */
145     for (ep = environ; ep != NULL; ep = ep->ev_next) {
146         archsw.arch_copyin(ep->ev_name, addr, strlen(ep->ev_name));
147         addr += strlen(ep->ev_name);
148         archsw.arch_copyin("=", addr, 1);
149         addr++;
150         if (ep->ev_value != NULL) {
151             archsw.arch_copyin(ep->ev_value, addr, strlen(ep->ev_value));
152             addr += strlen(ep->ev_value);
153         }
154         archsw.arch_copyin("", addr, 1);
155         addr++;
156     }
157     archsw.arch_copyin("", addr, 1);
158     addr++;
159     return(addr);
160 }
161
162 /*
163  * Copy module-related data into the load area, where it can be
164  * used as a directory for loaded modules.
165  *
166  * Module data is presented in a self-describing format.  Each datum
167  * is preceded by a 32-bit identifier and a 32-bit size field.
168  *
169  * Currently, the following data are saved:
170  *
171  * MOD_NAME     (variable)              module name (string)
172  * MOD_TYPE     (variable)              module type (string)
173  * MOD_ARGS     (variable)              module parameters (string)
174  * MOD_ADDR     sizeof(vm_offset_t)     module load address
175  * MOD_SIZE     sizeof(size_t)          module size
176  * MOD_METADATA (variable)              type-specific metadata
177  */
178 #define COPY32(v, a, c) {                       \
179     u_int32_t   x = (v);                        \
180     if (c)                                      \
181         archsw.arch_copyin(&x, a, sizeof(x));   \
182     a += sizeof(x);                             \
183 }
184
185 #define MOD_STR(t, a, s, c) {                   \
186     COPY32(t, a, c);                            \
187     COPY32(strlen(s) + 1, a, c)                 \
188     if (c)                                      \
189         archsw.arch_copyin(s, a, strlen(s) + 1);\
190     a += roundup(strlen(s) + 1, sizeof(u_long));\
191 }
192
193 #define MOD_NAME(a, s, c)       MOD_STR(MODINFO_NAME, a, s, c)
194 #define MOD_TYPE(a, s, c)       MOD_STR(MODINFO_TYPE, a, s, c)
195 #define MOD_ARGS(a, s, c)       MOD_STR(MODINFO_ARGS, a, s, c)
196
197 #define MOD_VAR(t, a, s, c) {                   \
198     COPY32(t, a, c);                            \
199     COPY32(sizeof(s), a, c);                    \
200     if (c)                                      \
201         archsw.arch_copyin(&s, a, sizeof(s));   \
202     a += roundup(sizeof(s), sizeof(u_long));    \
203 }
204
205 #define MOD_ADDR(a, s, c)       MOD_VAR(MODINFO_ADDR, a, s, c)
206 #define MOD_SIZE(a, s, c)       MOD_VAR(MODINFO_SIZE, a, s, c)
207
208 #define MOD_METADATA(a, mm, c) {                \
209     COPY32(MODINFO_METADATA | mm->md_type, a, c);\
210     COPY32(mm->md_size, a, c);                  \
211     if (c)                                      \
212         archsw.arch_copyin(mm->md_data, a, mm->md_size);\
213     a += roundup(mm->md_size, sizeof(u_long));  \
214 }
215
216 #define MOD_END(a, c) {                         \
217     COPY32(MODINFO_END, a, c);                  \
218     COPY32(0, a, c);                            \
219 }
220
221 vm_offset_t
222 md_copymodules(vm_offset_t addr)
223 {
224     struct preloaded_file       *fp;
225     struct file_metadata        *md;
226     int                         c;
227
228     c = addr != 0;
229     /* start with the first module on the list, should be the kernel */
230     for (fp = file_findfile(NULL, NULL); fp != NULL; fp = fp->f_next) {
231
232         MOD_NAME(addr, fp->f_name, c);  /* this field must come first */
233         MOD_TYPE(addr, fp->f_type, c);
234         if (fp->f_args)
235             MOD_ARGS(addr, fp->f_args, c);
236         MOD_ADDR(addr, fp->f_addr, c);
237         MOD_SIZE(addr, fp->f_size, c);
238         for (md = fp->f_metadata; md != NULL; md = md->md_next) {
239             if (!(md->md_type & MODINFOMD_NOCOPY)) {
240                 MOD_METADATA(addr, md, c);
241             }
242         }
243     }
244     MOD_END(addr, c);
245     return(addr);
246 }
247
248 /*
249  * Load the information expected by a powerpc kernel.
250  *
251  * - The 'boothowto' argument is constructed
252  * - The 'bootdev' argument is constructed
253  * - The kernel environment is copied into kernel space.
254  * - Module metadata are formatted and placed in kernel space.
255  */
256 int
257 md_load(char *args, vm_offset_t *modulep)
258 {
259     struct preloaded_file       *kfp;
260     struct preloaded_file       *xp;
261     struct file_metadata        *md;
262     vm_offset_t                 kernend;
263     vm_offset_t                 addr;
264     vm_offset_t                 envp;
265     vm_offset_t                 size;
266     char                        *rootdevname;
267     int                         howto;
268     int                         dtlb_slots;
269     int                         itlb_slots;
270
271     howto = md_getboothowto(args);
272
273     /* 
274      * Allow the environment variable 'rootdev' to override the supplied device 
275      * This should perhaps go to MI code and/or have $rootdev tested/set by
276      * MI code before launching the kernel.
277      */
278     rootdevname = getenv("rootdev");
279     if (rootdevname == NULL)
280             rootdevname = getenv("currdev");
281     /* Try reading the /etc/fstab file to select the root device */
282     getrootmount(rootdevname);
283
284     /* find the last module in the chain */
285     addr = 0;
286     for (xp = file_findfile(NULL, NULL); xp != NULL; xp = xp->f_next) {
287         if (addr < (xp->f_addr + xp->f_size))
288             addr = xp->f_addr + xp->f_size;
289     }
290     /* pad to a page boundary */
291     addr = roundup(addr, PAGE_SIZE);
292
293     /* copy our environment */
294     envp = addr;
295     addr = md_copyenv(addr);
296
297     /* pad to a page boundary */
298     addr = roundup(addr, PAGE_SIZE);
299
300     kernend = 0;
301     kfp = file_findfile(NULL, "elf32 kernel");
302     if (kfp == NULL)
303         kfp = file_findfile(NULL, "elf kernel");
304     if (kfp == NULL)
305         panic("can't find kernel file");
306     file_addmetadata(kfp, MODINFOMD_HOWTO, sizeof howto, &howto);
307     file_addmetadata(kfp, MODINFOMD_ENVP, sizeof envp, &envp);
308     file_addmetadata(kfp, MODINFOMD_KERNEND, sizeof kernend, &kernend);
309
310     *modulep = addr;
311     size = md_copymodules(0);
312     kernend = roundup(addr + size, PAGE_SIZE);
313
314     md = file_findmetadata(kfp, MODINFOMD_KERNEND);
315     bcopy(&kernend, md->md_data, sizeof kernend);
316
317     (void)md_copymodules(addr);
318
319     return(0);
320 }