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: releng/10.2/sys/boot/powerpc/ps3/metadata.c 271132 2014-09-04 20:47:14Z emaste $"); 31217044Snwhitehorn 32217044Snwhitehorn#include <stand.h> 33217044Snwhitehorn#include <sys/param.h> 34217044Snwhitehorn#include <sys/reboot.h> 35217044Snwhitehorn#include <sys/linker.h> 36271132Semaste#include <sys/boot.h> 37217044Snwhitehorn 38217044Snwhitehorn#include <machine/metadata.h> 39217044Snwhitehorn 40217044Snwhitehorn#include "bootstrap.h" 41217044Snwhitehorn 42217044Snwhitehornint 43217044Snwhitehornmd_getboothowto(char *kargs) 44217044Snwhitehorn{ 45217044Snwhitehorn char *cp; 46217044Snwhitehorn int howto; 47217044Snwhitehorn int active; 48217044Snwhitehorn int i; 49217044Snwhitehorn 50217044Snwhitehorn /* Parse kargs */ 51217044Snwhitehorn howto = 0; 52217044Snwhitehorn if (kargs != NULL) { 53217044Snwhitehorn cp = kargs; 54217044Snwhitehorn active = 0; 55217044Snwhitehorn while (*cp != 0) { 56217044Snwhitehorn if (!active && (*cp == '-')) { 57217044Snwhitehorn active = 1; 58217044Snwhitehorn } else if (active) 59217044Snwhitehorn switch (*cp) { 60217044Snwhitehorn case 'a': 61217044Snwhitehorn howto |= RB_ASKNAME; 62217044Snwhitehorn break; 63217044Snwhitehorn case 'C': 64217044Snwhitehorn howto |= RB_CDROM; 65217044Snwhitehorn break; 66217044Snwhitehorn case 'd': 67217044Snwhitehorn howto |= RB_KDB; 68217044Snwhitehorn break; 69217044Snwhitehorn case 'D': 70217044Snwhitehorn howto |= RB_MULTIPLE; 71217044Snwhitehorn break; 72217044Snwhitehorn case 'm': 73217044Snwhitehorn howto |= RB_MUTE; 74217044Snwhitehorn break; 75217044Snwhitehorn case 'g': 76217044Snwhitehorn howto |= RB_GDB; 77217044Snwhitehorn break; 78217044Snwhitehorn case 'h': 79217044Snwhitehorn howto |= RB_SERIAL; 80217044Snwhitehorn break; 81217044Snwhitehorn case 'p': 82217044Snwhitehorn howto |= RB_PAUSE; 83217044Snwhitehorn break; 84217044Snwhitehorn case 'r': 85217044Snwhitehorn howto |= RB_DFLTROOT; 86217044Snwhitehorn break; 87217044Snwhitehorn case 's': 88217044Snwhitehorn howto |= RB_SINGLE; 89217044Snwhitehorn break; 90217044Snwhitehorn case 'v': 91217044Snwhitehorn howto |= RB_VERBOSE; 92217044Snwhitehorn break; 93217044Snwhitehorn default: 94217044Snwhitehorn active = 0; 95217044Snwhitehorn break; 96217044Snwhitehorn } 97217044Snwhitehorn cp++; 98217044Snwhitehorn } 99217044Snwhitehorn } 100217044Snwhitehorn /* get equivalents from the environment */ 101217044Snwhitehorn for (i = 0; howto_names[i].ev != NULL; i++) 102217044Snwhitehorn if (getenv(howto_names[i].ev) != NULL) 103217044Snwhitehorn howto |= howto_names[i].mask; 104217044Snwhitehorn if (!strcmp(getenv("console"), "comconsole")) 105217044Snwhitehorn howto |= RB_SERIAL; 106217044Snwhitehorn if (!strcmp(getenv("console"), "nullconsole")) 107217044Snwhitehorn howto |= RB_MUTE; 108217044Snwhitehorn return(howto); 109217044Snwhitehorn} 110217044Snwhitehorn 111217044Snwhitehorn/* 112217044Snwhitehorn * Copy the environment into the load area starting at (addr). 113217044Snwhitehorn * Each variable is formatted as <name>=<value>, with a single nul 114217044Snwhitehorn * separating each variable, and a double nul terminating the environment. 115217044Snwhitehorn */ 116217044Snwhitehornvm_offset_t 117217044Snwhitehornmd_copyenv(vm_offset_t addr) 118217044Snwhitehorn{ 119217044Snwhitehorn struct env_var *ep; 120217044Snwhitehorn 121217044Snwhitehorn /* traverse the environment */ 122217044Snwhitehorn for (ep = environ; ep != NULL; ep = ep->ev_next) { 123217044Snwhitehorn archsw.arch_copyin(ep->ev_name, addr, strlen(ep->ev_name)); 124217044Snwhitehorn addr += strlen(ep->ev_name); 125217044Snwhitehorn archsw.arch_copyin("=", addr, 1); 126217044Snwhitehorn addr++; 127217044Snwhitehorn if (ep->ev_value != NULL) { 128217044Snwhitehorn archsw.arch_copyin(ep->ev_value, addr, strlen(ep->ev_value)); 129217044Snwhitehorn addr += strlen(ep->ev_value); 130217044Snwhitehorn } 131217044Snwhitehorn archsw.arch_copyin("", addr, 1); 132217044Snwhitehorn addr++; 133217044Snwhitehorn } 134217044Snwhitehorn archsw.arch_copyin("", addr, 1); 135217044Snwhitehorn addr++; 136217044Snwhitehorn return(addr); 137217044Snwhitehorn} 138217044Snwhitehorn 139217044Snwhitehorn/* 140217044Snwhitehorn * Copy module-related data into the load area, where it can be 141217044Snwhitehorn * used as a directory for loaded modules. 142217044Snwhitehorn * 143217044Snwhitehorn * Module data is presented in a self-describing format. Each datum 144217044Snwhitehorn * is preceded by a 32-bit identifier and a 32-bit size field. 145217044Snwhitehorn * 146217044Snwhitehorn * Currently, the following data are saved: 147217044Snwhitehorn * 148217044Snwhitehorn * MOD_NAME (variable) module name (string) 149217044Snwhitehorn * MOD_TYPE (variable) module type (string) 150217044Snwhitehorn * MOD_ARGS (variable) module parameters (string) 151217044Snwhitehorn * MOD_ADDR sizeof(vm_offset_t) module load address 152217044Snwhitehorn * MOD_SIZE sizeof(size_t) module size 153217044Snwhitehorn * MOD_METADATA (variable) type-specific metadata 154217044Snwhitehorn */ 155217044Snwhitehorn 156217044Snwhitehornstatic int align; 157217044Snwhitehorn 158217044Snwhitehorn#define COPY32(v, a, c) { \ 159217044Snwhitehorn u_int32_t x = (v); \ 160217044Snwhitehorn if (c) \ 161217044Snwhitehorn archsw.arch_copyin(&x, a, sizeof(x)); \ 162217044Snwhitehorn a += sizeof(x); \ 163217044Snwhitehorn} 164217044Snwhitehorn 165217044Snwhitehorn#define MOD_STR(t, a, s, c) { \ 166217044Snwhitehorn COPY32(t, a, c); \ 167217044Snwhitehorn COPY32(strlen(s) + 1, a, c) \ 168217044Snwhitehorn if (c) \ 169217044Snwhitehorn archsw.arch_copyin(s, a, strlen(s) + 1);\ 170217044Snwhitehorn a += roundup(strlen(s) + 1, align); \ 171217044Snwhitehorn} 172217044Snwhitehorn 173217044Snwhitehorn#define MOD_NAME(a, s, c) MOD_STR(MODINFO_NAME, a, s, c) 174217044Snwhitehorn#define MOD_TYPE(a, s, c) MOD_STR(MODINFO_TYPE, a, s, c) 175217044Snwhitehorn#define MOD_ARGS(a, s, c) MOD_STR(MODINFO_ARGS, a, s, c) 176217044Snwhitehorn 177217044Snwhitehorn#define MOD_VAR(t, a, s, c) { \ 178217044Snwhitehorn COPY32(t, a, c); \ 179217044Snwhitehorn COPY32(sizeof(s), a, c); \ 180217044Snwhitehorn if (c) \ 181217044Snwhitehorn archsw.arch_copyin(&s, a, sizeof(s)); \ 182217044Snwhitehorn a += roundup(sizeof(s), align); \ 183217044Snwhitehorn} 184217044Snwhitehorn 185217044Snwhitehorn#define MOD_ADDR(a, s, c) MOD_VAR(MODINFO_ADDR, a, s, c) 186217044Snwhitehorn#define MOD_SIZE(a, s, c) MOD_VAR(MODINFO_SIZE, a, s, c) 187217044Snwhitehorn 188217044Snwhitehorn#define MOD_METADATA(a, mm, c) { \ 189217044Snwhitehorn COPY32(MODINFO_METADATA | mm->md_type, a, c);\ 190217044Snwhitehorn COPY32(mm->md_size, a, c); \ 191217044Snwhitehorn if (c) \ 192217044Snwhitehorn archsw.arch_copyin(mm->md_data, a, mm->md_size);\ 193217044Snwhitehorn a += roundup(mm->md_size, align); \ 194217044Snwhitehorn} 195217044Snwhitehorn 196217044Snwhitehorn#define MOD_END(a, c) { \ 197217044Snwhitehorn COPY32(MODINFO_END, a, c); \ 198217044Snwhitehorn COPY32(0, a, c); \ 199217044Snwhitehorn} 200217044Snwhitehorn 201217044Snwhitehornvm_offset_t 202217044Snwhitehornmd_copymodules(vm_offset_t addr, int kern64) 203217044Snwhitehorn{ 204217044Snwhitehorn struct preloaded_file *fp; 205217044Snwhitehorn struct file_metadata *md; 206217044Snwhitehorn uint64_t scratch64; 207217044Snwhitehorn int c; 208217044Snwhitehorn 209217044Snwhitehorn c = addr != 0; 210217044Snwhitehorn /* start with the first module on the list, should be the kernel */ 211217044Snwhitehorn for (fp = file_findfile(NULL, NULL); fp != NULL; fp = fp->f_next) { 212217044Snwhitehorn 213217044Snwhitehorn MOD_NAME(addr, fp->f_name, c); /* this field must come first */ 214217044Snwhitehorn MOD_TYPE(addr, fp->f_type, c); 215217044Snwhitehorn if (fp->f_args) 216217044Snwhitehorn MOD_ARGS(addr, fp->f_args, c); 217217044Snwhitehorn if (kern64) { 218217044Snwhitehorn scratch64 = fp->f_addr; 219217044Snwhitehorn MOD_ADDR(addr, scratch64, c); 220217044Snwhitehorn scratch64 = fp->f_size; 221217044Snwhitehorn MOD_SIZE(addr, scratch64, c); 222217044Snwhitehorn } else { 223217044Snwhitehorn MOD_ADDR(addr, fp->f_addr, c); 224217044Snwhitehorn MOD_SIZE(addr, fp->f_size, c); 225217044Snwhitehorn } 226217044Snwhitehorn for (md = fp->f_metadata; md != NULL; md = md->md_next) { 227217044Snwhitehorn if (!(md->md_type & MODINFOMD_NOCOPY)) { 228217044Snwhitehorn MOD_METADATA(addr, md, c); 229217044Snwhitehorn } 230217044Snwhitehorn } 231217044Snwhitehorn } 232217044Snwhitehorn MOD_END(addr, c); 233217044Snwhitehorn return(addr); 234217044Snwhitehorn} 235217044Snwhitehorn 236217044Snwhitehorn/* 237217044Snwhitehorn * Load the information expected by a powerpc kernel. 238217044Snwhitehorn * 239217044Snwhitehorn * - The 'boothowto' argument is constructed 240217044Snwhitehorn * - The 'bootdev' argument is constructed 241217044Snwhitehorn * - The kernel environment is copied into kernel space. 242217044Snwhitehorn * - Module metadata are formatted and placed in kernel space. 243217044Snwhitehorn */ 244217044Snwhitehornint 245217044Snwhitehornmd_load_dual(char *args, vm_offset_t *modulep, int kern64) 246217044Snwhitehorn{ 247217044Snwhitehorn struct preloaded_file *kfp; 248217044Snwhitehorn struct preloaded_file *xp; 249217044Snwhitehorn struct file_metadata *md; 250217044Snwhitehorn vm_offset_t kernend; 251217044Snwhitehorn vm_offset_t addr; 252217044Snwhitehorn vm_offset_t envp; 253217044Snwhitehorn vm_offset_t size; 254217044Snwhitehorn uint64_t scratch64; 255217044Snwhitehorn char *rootdevname; 256217044Snwhitehorn int howto; 257217044Snwhitehorn 258217044Snwhitehorn align = kern64 ? 8 : 4; 259217044Snwhitehorn howto = md_getboothowto(args); 260217044Snwhitehorn 261217044Snwhitehorn /* 262217044Snwhitehorn * Allow the environment variable 'rootdev' to override the supplied device 263217044Snwhitehorn * This should perhaps go to MI code and/or have $rootdev tested/set by 264217044Snwhitehorn * MI code before launching the kernel. 265217044Snwhitehorn */ 266217044Snwhitehorn rootdevname = getenv("rootdev"); 267217044Snwhitehorn if (rootdevname == NULL) 268217044Snwhitehorn rootdevname = getenv("currdev"); 269217044Snwhitehorn /* Try reading the /etc/fstab file to select the root device */ 270217044Snwhitehorn getrootmount(rootdevname); 271217044Snwhitehorn 272217044Snwhitehorn /* find the last module in the chain */ 273217044Snwhitehorn addr = 0; 274217044Snwhitehorn for (xp = file_findfile(NULL, NULL); xp != NULL; xp = xp->f_next) { 275217044Snwhitehorn if (addr < (xp->f_addr + xp->f_size)) 276217044Snwhitehorn addr = xp->f_addr + xp->f_size; 277217044Snwhitehorn } 278217044Snwhitehorn /* pad to a page boundary */ 279217044Snwhitehorn addr = roundup(addr, PAGE_SIZE); 280217044Snwhitehorn 281217044Snwhitehorn /* copy our environment */ 282217044Snwhitehorn envp = addr; 283217044Snwhitehorn addr = md_copyenv(addr); 284217044Snwhitehorn 285217044Snwhitehorn /* pad to a page boundary */ 286217044Snwhitehorn addr = roundup(addr, PAGE_SIZE); 287217044Snwhitehorn 288217044Snwhitehorn kernend = 0; 289217044Snwhitehorn kfp = file_findfile(NULL, kern64 ? "elf64 kernel" : "elf32 kernel"); 290217044Snwhitehorn if (kfp == NULL) 291217044Snwhitehorn kfp = file_findfile(NULL, "elf kernel"); 292217044Snwhitehorn if (kfp == NULL) 293217044Snwhitehorn panic("can't find kernel file"); 294217044Snwhitehorn file_addmetadata(kfp, MODINFOMD_HOWTO, sizeof howto, &howto); 295217044Snwhitehorn if (kern64) { 296217044Snwhitehorn scratch64 = envp; 297217044Snwhitehorn file_addmetadata(kfp, MODINFOMD_ENVP, sizeof scratch64, &scratch64); 298217044Snwhitehorn scratch64 = kernend; 299217044Snwhitehorn file_addmetadata(kfp, MODINFOMD_KERNEND, sizeof scratch64, &scratch64); 300217044Snwhitehorn } else { 301217044Snwhitehorn file_addmetadata(kfp, MODINFOMD_ENVP, sizeof envp, &envp); 302217044Snwhitehorn file_addmetadata(kfp, MODINFOMD_KERNEND, sizeof kernend, &kernend); 303217044Snwhitehorn } 304217044Snwhitehorn 305217044Snwhitehorn *modulep = addr; 306217044Snwhitehorn size = md_copymodules(0, kern64); 307217044Snwhitehorn kernend = roundup(addr + size, PAGE_SIZE); 308217044Snwhitehorn 309217044Snwhitehorn md = file_findmetadata(kfp, MODINFOMD_KERNEND); 310217044Snwhitehorn if (kern64) { 311217044Snwhitehorn scratch64 = kernend; 312217044Snwhitehorn bcopy(&scratch64, md->md_data, sizeof scratch64); 313217044Snwhitehorn } else { 314217044Snwhitehorn bcopy(&kernend, md->md_data, sizeof kernend); 315217044Snwhitehorn } 316217044Snwhitehorn 317217044Snwhitehorn (void)md_copymodules(addr, kern64); 318217044Snwhitehorn 319217044Snwhitehorn return(0); 320217044Snwhitehorn} 321217044Snwhitehorn 322217044Snwhitehornint 323217044Snwhitehornmd_load(char *args, vm_offset_t *modulep) 324217044Snwhitehorn{ 325217044Snwhitehorn return (md_load_dual(args, modulep, 0)); 326217044Snwhitehorn} 327217044Snwhitehorn 328217044Snwhitehornint 329217044Snwhitehornmd_load64(char *args, vm_offset_t *modulep) 330217044Snwhitehorn{ 331217044Snwhitehorn return (md_load_dual(args, modulep, 1)); 332217044Snwhitehorn} 333217044Snwhitehorn 334