1217044Snwhitehorn/*- 2217044Snwhitehorn * Copyright (c) 1998 Michael Smith <msmith@freebsd.org> 3217044Snwhitehorn * All rights reserved. 4217044Snwhitehorn * 5217044Snwhitehorn * Redistribution and use in source and binary forms, with or without 6217044Snwhitehorn * modification, are permitted provided that the following conditions 7217044Snwhitehorn * are met: 8217044Snwhitehorn * 1. Redistributions of source code must retain the above copyright 9217044Snwhitehorn * notice, this list of conditions and the following disclaimer. 10217044Snwhitehorn * 2. Redistributions in binary form must reproduce the above copyright 11217044Snwhitehorn * notice, this list of conditions and the following disclaimer in the 12217044Snwhitehorn * documentation and/or other materials provided with the distribution. 13217044Snwhitehorn * 14217044Snwhitehorn * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15217044Snwhitehorn * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16217044Snwhitehorn * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17217044Snwhitehorn * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18217044Snwhitehorn * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19217044Snwhitehorn * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20217044Snwhitehorn * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21217044Snwhitehorn * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22217044Snwhitehorn * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23217044Snwhitehorn * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24217044Snwhitehorn * SUCH DAMAGE. 25217044Snwhitehorn * 26217044Snwhitehorn * from: FreeBSD: src/sys/boot/sparc64/loader/metadata.c,v 1.6 27217044Snwhitehorn */ 28217044Snwhitehorn 29217044Snwhitehorn#include <sys/cdefs.h> 30217044Snwhitehorn__FBSDID("$FreeBSD$"); 31217044Snwhitehorn 32217044Snwhitehorn#include <stand.h> 33217044Snwhitehorn#include <sys/param.h> 34217044Snwhitehorn#include <sys/reboot.h> 35217044Snwhitehorn#include <sys/linker.h> 36217044Snwhitehorn 37217044Snwhitehorn#include <machine/metadata.h> 38217044Snwhitehorn 39217044Snwhitehorn#include "bootstrap.h" 40217044Snwhitehorn 41217044Snwhitehorn/* 42217044Snwhitehorn * Return a 'boothowto' value corresponding to the kernel arguments in 43217044Snwhitehorn * (kargs) and any relevant environment variables. 44217044Snwhitehorn */ 45217044Snwhitehornstatic struct 46217044Snwhitehorn{ 47217044Snwhitehorn const char *ev; 48217044Snwhitehorn int mask; 49217044Snwhitehorn} howto_names[] = { 50217044Snwhitehorn {"boot_askname", RB_ASKNAME}, 51217044Snwhitehorn {"boot_cdrom", RB_CDROM}, 52217044Snwhitehorn {"boot_ddb", RB_KDB}, 53217044Snwhitehorn {"boot_dfltroot", RB_DFLTROOT}, 54217044Snwhitehorn {"boot_gdb", RB_GDB}, 55217044Snwhitehorn {"boot_multicons", RB_MULTIPLE}, 56217044Snwhitehorn {"boot_mute", RB_MUTE}, 57217044Snwhitehorn {"boot_pause", RB_PAUSE}, 58217044Snwhitehorn {"boot_serial", RB_SERIAL}, 59217044Snwhitehorn {"boot_single", RB_SINGLE}, 60217044Snwhitehorn {"boot_verbose", RB_VERBOSE}, 61217044Snwhitehorn {NULL, 0} 62217044Snwhitehorn}; 63217044Snwhitehorn 64217044Snwhitehornint 65217044Snwhitehornmd_getboothowto(char *kargs) 66217044Snwhitehorn{ 67217044Snwhitehorn char *cp; 68217044Snwhitehorn int howto; 69217044Snwhitehorn int active; 70217044Snwhitehorn int i; 71217044Snwhitehorn 72217044Snwhitehorn /* Parse kargs */ 73217044Snwhitehorn howto = 0; 74217044Snwhitehorn if (kargs != NULL) { 75217044Snwhitehorn cp = kargs; 76217044Snwhitehorn active = 0; 77217044Snwhitehorn while (*cp != 0) { 78217044Snwhitehorn if (!active && (*cp == '-')) { 79217044Snwhitehorn active = 1; 80217044Snwhitehorn } else if (active) 81217044Snwhitehorn switch (*cp) { 82217044Snwhitehorn case 'a': 83217044Snwhitehorn howto |= RB_ASKNAME; 84217044Snwhitehorn break; 85217044Snwhitehorn case 'C': 86217044Snwhitehorn howto |= RB_CDROM; 87217044Snwhitehorn break; 88217044Snwhitehorn case 'd': 89217044Snwhitehorn howto |= RB_KDB; 90217044Snwhitehorn break; 91217044Snwhitehorn case 'D': 92217044Snwhitehorn howto |= RB_MULTIPLE; 93217044Snwhitehorn break; 94217044Snwhitehorn case 'm': 95217044Snwhitehorn howto |= RB_MUTE; 96217044Snwhitehorn break; 97217044Snwhitehorn case 'g': 98217044Snwhitehorn howto |= RB_GDB; 99217044Snwhitehorn break; 100217044Snwhitehorn case 'h': 101217044Snwhitehorn howto |= RB_SERIAL; 102217044Snwhitehorn break; 103217044Snwhitehorn case 'p': 104217044Snwhitehorn howto |= RB_PAUSE; 105217044Snwhitehorn break; 106217044Snwhitehorn case 'r': 107217044Snwhitehorn howto |= RB_DFLTROOT; 108217044Snwhitehorn break; 109217044Snwhitehorn case 's': 110217044Snwhitehorn howto |= RB_SINGLE; 111217044Snwhitehorn break; 112217044Snwhitehorn case 'v': 113217044Snwhitehorn howto |= RB_VERBOSE; 114217044Snwhitehorn break; 115217044Snwhitehorn default: 116217044Snwhitehorn active = 0; 117217044Snwhitehorn break; 118217044Snwhitehorn } 119217044Snwhitehorn cp++; 120217044Snwhitehorn } 121217044Snwhitehorn } 122217044Snwhitehorn /* get equivalents from the environment */ 123217044Snwhitehorn for (i = 0; howto_names[i].ev != NULL; i++) 124217044Snwhitehorn if (getenv(howto_names[i].ev) != NULL) 125217044Snwhitehorn howto |= howto_names[i].mask; 126217044Snwhitehorn if (!strcmp(getenv("console"), "comconsole")) 127217044Snwhitehorn howto |= RB_SERIAL; 128217044Snwhitehorn if (!strcmp(getenv("console"), "nullconsole")) 129217044Snwhitehorn howto |= RB_MUTE; 130217044Snwhitehorn return(howto); 131217044Snwhitehorn} 132217044Snwhitehorn 133217044Snwhitehorn/* 134217044Snwhitehorn * Copy the environment into the load area starting at (addr). 135217044Snwhitehorn * Each variable is formatted as <name>=<value>, with a single nul 136217044Snwhitehorn * separating each variable, and a double nul terminating the environment. 137217044Snwhitehorn */ 138217044Snwhitehornvm_offset_t 139217044Snwhitehornmd_copyenv(vm_offset_t addr) 140217044Snwhitehorn{ 141217044Snwhitehorn struct env_var *ep; 142217044Snwhitehorn 143217044Snwhitehorn /* traverse the environment */ 144217044Snwhitehorn for (ep = environ; ep != NULL; ep = ep->ev_next) { 145217044Snwhitehorn archsw.arch_copyin(ep->ev_name, addr, strlen(ep->ev_name)); 146217044Snwhitehorn addr += strlen(ep->ev_name); 147217044Snwhitehorn archsw.arch_copyin("=", addr, 1); 148217044Snwhitehorn addr++; 149217044Snwhitehorn if (ep->ev_value != NULL) { 150217044Snwhitehorn archsw.arch_copyin(ep->ev_value, addr, strlen(ep->ev_value)); 151217044Snwhitehorn addr += strlen(ep->ev_value); 152217044Snwhitehorn } 153217044Snwhitehorn archsw.arch_copyin("", addr, 1); 154217044Snwhitehorn addr++; 155217044Snwhitehorn } 156217044Snwhitehorn archsw.arch_copyin("", addr, 1); 157217044Snwhitehorn addr++; 158217044Snwhitehorn return(addr); 159217044Snwhitehorn} 160217044Snwhitehorn 161217044Snwhitehorn/* 162217044Snwhitehorn * Copy module-related data into the load area, where it can be 163217044Snwhitehorn * used as a directory for loaded modules. 164217044Snwhitehorn * 165217044Snwhitehorn * Module data is presented in a self-describing format. Each datum 166217044Snwhitehorn * is preceded by a 32-bit identifier and a 32-bit size field. 167217044Snwhitehorn * 168217044Snwhitehorn * Currently, the following data are saved: 169217044Snwhitehorn * 170217044Snwhitehorn * MOD_NAME (variable) module name (string) 171217044Snwhitehorn * MOD_TYPE (variable) module type (string) 172217044Snwhitehorn * MOD_ARGS (variable) module parameters (string) 173217044Snwhitehorn * MOD_ADDR sizeof(vm_offset_t) module load address 174217044Snwhitehorn * MOD_SIZE sizeof(size_t) module size 175217044Snwhitehorn * MOD_METADATA (variable) type-specific metadata 176217044Snwhitehorn */ 177217044Snwhitehorn 178217044Snwhitehornstatic int align; 179217044Snwhitehorn 180217044Snwhitehorn#define COPY32(v, a, c) { \ 181217044Snwhitehorn u_int32_t x = (v); \ 182217044Snwhitehorn if (c) \ 183217044Snwhitehorn archsw.arch_copyin(&x, a, sizeof(x)); \ 184217044Snwhitehorn a += sizeof(x); \ 185217044Snwhitehorn} 186217044Snwhitehorn 187217044Snwhitehorn#define MOD_STR(t, a, s, c) { \ 188217044Snwhitehorn COPY32(t, a, c); \ 189217044Snwhitehorn COPY32(strlen(s) + 1, a, c) \ 190217044Snwhitehorn if (c) \ 191217044Snwhitehorn archsw.arch_copyin(s, a, strlen(s) + 1);\ 192217044Snwhitehorn a += roundup(strlen(s) + 1, align); \ 193217044Snwhitehorn} 194217044Snwhitehorn 195217044Snwhitehorn#define MOD_NAME(a, s, c) MOD_STR(MODINFO_NAME, a, s, c) 196217044Snwhitehorn#define MOD_TYPE(a, s, c) MOD_STR(MODINFO_TYPE, a, s, c) 197217044Snwhitehorn#define MOD_ARGS(a, s, c) MOD_STR(MODINFO_ARGS, a, s, c) 198217044Snwhitehorn 199217044Snwhitehorn#define MOD_VAR(t, a, s, c) { \ 200217044Snwhitehorn COPY32(t, a, c); \ 201217044Snwhitehorn COPY32(sizeof(s), a, c); \ 202217044Snwhitehorn if (c) \ 203217044Snwhitehorn archsw.arch_copyin(&s, a, sizeof(s)); \ 204217044Snwhitehorn a += roundup(sizeof(s), align); \ 205217044Snwhitehorn} 206217044Snwhitehorn 207217044Snwhitehorn#define MOD_ADDR(a, s, c) MOD_VAR(MODINFO_ADDR, a, s, c) 208217044Snwhitehorn#define MOD_SIZE(a, s, c) MOD_VAR(MODINFO_SIZE, a, s, c) 209217044Snwhitehorn 210217044Snwhitehorn#define MOD_METADATA(a, mm, c) { \ 211217044Snwhitehorn COPY32(MODINFO_METADATA | mm->md_type, a, c);\ 212217044Snwhitehorn COPY32(mm->md_size, a, c); \ 213217044Snwhitehorn if (c) \ 214217044Snwhitehorn archsw.arch_copyin(mm->md_data, a, mm->md_size);\ 215217044Snwhitehorn a += roundup(mm->md_size, align); \ 216217044Snwhitehorn} 217217044Snwhitehorn 218217044Snwhitehorn#define MOD_END(a, c) { \ 219217044Snwhitehorn COPY32(MODINFO_END, a, c); \ 220217044Snwhitehorn COPY32(0, a, c); \ 221217044Snwhitehorn} 222217044Snwhitehorn 223217044Snwhitehornvm_offset_t 224217044Snwhitehornmd_copymodules(vm_offset_t addr, int kern64) 225217044Snwhitehorn{ 226217044Snwhitehorn struct preloaded_file *fp; 227217044Snwhitehorn struct file_metadata *md; 228217044Snwhitehorn uint64_t scratch64; 229217044Snwhitehorn int c; 230217044Snwhitehorn 231217044Snwhitehorn c = addr != 0; 232217044Snwhitehorn /* start with the first module on the list, should be the kernel */ 233217044Snwhitehorn for (fp = file_findfile(NULL, NULL); fp != NULL; fp = fp->f_next) { 234217044Snwhitehorn 235217044Snwhitehorn MOD_NAME(addr, fp->f_name, c); /* this field must come first */ 236217044Snwhitehorn MOD_TYPE(addr, fp->f_type, c); 237217044Snwhitehorn if (fp->f_args) 238217044Snwhitehorn MOD_ARGS(addr, fp->f_args, c); 239217044Snwhitehorn if (kern64) { 240217044Snwhitehorn scratch64 = fp->f_addr; 241217044Snwhitehorn MOD_ADDR(addr, scratch64, c); 242217044Snwhitehorn scratch64 = fp->f_size; 243217044Snwhitehorn MOD_SIZE(addr, scratch64, c); 244217044Snwhitehorn } else { 245217044Snwhitehorn MOD_ADDR(addr, fp->f_addr, c); 246217044Snwhitehorn MOD_SIZE(addr, fp->f_size, c); 247217044Snwhitehorn } 248217044Snwhitehorn for (md = fp->f_metadata; md != NULL; md = md->md_next) { 249217044Snwhitehorn if (!(md->md_type & MODINFOMD_NOCOPY)) { 250217044Snwhitehorn MOD_METADATA(addr, md, c); 251217044Snwhitehorn } 252217044Snwhitehorn } 253217044Snwhitehorn } 254217044Snwhitehorn MOD_END(addr, c); 255217044Snwhitehorn return(addr); 256217044Snwhitehorn} 257217044Snwhitehorn 258217044Snwhitehorn/* 259217044Snwhitehorn * Load the information expected by a powerpc kernel. 260217044Snwhitehorn * 261217044Snwhitehorn * - The 'boothowto' argument is constructed 262217044Snwhitehorn * - The 'bootdev' argument is constructed 263217044Snwhitehorn * - The kernel environment is copied into kernel space. 264217044Snwhitehorn * - Module metadata are formatted and placed in kernel space. 265217044Snwhitehorn */ 266217044Snwhitehornint 267217044Snwhitehornmd_load_dual(char *args, vm_offset_t *modulep, int kern64) 268217044Snwhitehorn{ 269217044Snwhitehorn struct preloaded_file *kfp; 270217044Snwhitehorn struct preloaded_file *xp; 271217044Snwhitehorn struct file_metadata *md; 272217044Snwhitehorn vm_offset_t kernend; 273217044Snwhitehorn vm_offset_t addr; 274217044Snwhitehorn vm_offset_t envp; 275217044Snwhitehorn vm_offset_t size; 276217044Snwhitehorn uint64_t scratch64; 277217044Snwhitehorn char *rootdevname; 278217044Snwhitehorn int howto; 279217044Snwhitehorn 280217044Snwhitehorn align = kern64 ? 8 : 4; 281217044Snwhitehorn howto = md_getboothowto(args); 282217044Snwhitehorn 283217044Snwhitehorn /* 284217044Snwhitehorn * Allow the environment variable 'rootdev' to override the supplied device 285217044Snwhitehorn * This should perhaps go to MI code and/or have $rootdev tested/set by 286217044Snwhitehorn * MI code before launching the kernel. 287217044Snwhitehorn */ 288217044Snwhitehorn rootdevname = getenv("rootdev"); 289217044Snwhitehorn if (rootdevname == NULL) 290217044Snwhitehorn rootdevname = getenv("currdev"); 291217044Snwhitehorn /* Try reading the /etc/fstab file to select the root device */ 292217044Snwhitehorn getrootmount(rootdevname); 293217044Snwhitehorn 294217044Snwhitehorn /* find the last module in the chain */ 295217044Snwhitehorn addr = 0; 296217044Snwhitehorn for (xp = file_findfile(NULL, NULL); xp != NULL; xp = xp->f_next) { 297217044Snwhitehorn if (addr < (xp->f_addr + xp->f_size)) 298217044Snwhitehorn addr = xp->f_addr + xp->f_size; 299217044Snwhitehorn } 300217044Snwhitehorn /* pad to a page boundary */ 301217044Snwhitehorn addr = roundup(addr, PAGE_SIZE); 302217044Snwhitehorn 303217044Snwhitehorn /* copy our environment */ 304217044Snwhitehorn envp = addr; 305217044Snwhitehorn addr = md_copyenv(addr); 306217044Snwhitehorn 307217044Snwhitehorn /* pad to a page boundary */ 308217044Snwhitehorn addr = roundup(addr, PAGE_SIZE); 309217044Snwhitehorn 310217044Snwhitehorn kernend = 0; 311217044Snwhitehorn kfp = file_findfile(NULL, kern64 ? "elf64 kernel" : "elf32 kernel"); 312217044Snwhitehorn if (kfp == NULL) 313217044Snwhitehorn kfp = file_findfile(NULL, "elf kernel"); 314217044Snwhitehorn if (kfp == NULL) 315217044Snwhitehorn panic("can't find kernel file"); 316217044Snwhitehorn file_addmetadata(kfp, MODINFOMD_HOWTO, sizeof howto, &howto); 317217044Snwhitehorn if (kern64) { 318217044Snwhitehorn scratch64 = envp; 319217044Snwhitehorn file_addmetadata(kfp, MODINFOMD_ENVP, sizeof scratch64, &scratch64); 320217044Snwhitehorn scratch64 = kernend; 321217044Snwhitehorn file_addmetadata(kfp, MODINFOMD_KERNEND, sizeof scratch64, &scratch64); 322217044Snwhitehorn } else { 323217044Snwhitehorn file_addmetadata(kfp, MODINFOMD_ENVP, sizeof envp, &envp); 324217044Snwhitehorn file_addmetadata(kfp, MODINFOMD_KERNEND, sizeof kernend, &kernend); 325217044Snwhitehorn } 326217044Snwhitehorn 327217044Snwhitehorn *modulep = addr; 328217044Snwhitehorn size = md_copymodules(0, kern64); 329217044Snwhitehorn kernend = roundup(addr + size, PAGE_SIZE); 330217044Snwhitehorn 331217044Snwhitehorn md = file_findmetadata(kfp, MODINFOMD_KERNEND); 332217044Snwhitehorn if (kern64) { 333217044Snwhitehorn scratch64 = kernend; 334217044Snwhitehorn bcopy(&scratch64, md->md_data, sizeof scratch64); 335217044Snwhitehorn } else { 336217044Snwhitehorn bcopy(&kernend, md->md_data, sizeof kernend); 337217044Snwhitehorn } 338217044Snwhitehorn 339217044Snwhitehorn (void)md_copymodules(addr, kern64); 340217044Snwhitehorn 341217044Snwhitehorn return(0); 342217044Snwhitehorn} 343217044Snwhitehorn 344217044Snwhitehornint 345217044Snwhitehornmd_load(char *args, vm_offset_t *modulep) 346217044Snwhitehorn{ 347217044Snwhitehorn return (md_load_dual(args, modulep, 0)); 348217044Snwhitehorn} 349217044Snwhitehorn 350217044Snwhitehornint 351217044Snwhitehornmd_load64(char *args, vm_offset_t *modulep) 352217044Snwhitehorn{ 353217044Snwhitehorn return (md_load_dual(args, modulep, 1)); 354217044Snwhitehorn} 355217044Snwhitehorn 356