1176349Smarcel/*- 2176349Smarcel * Copyright (c) 1998 Michael Smith <msmith@freebsd.org> 3182724Sraj * Copyright (C) 2006 Semihalf, Piotr Kruszynski <ppk@semihalf.com> 4182724Sraj * Copyright (C) 2007-2008 Semihalf, Rafal Jaworowski <raj@semihalf.com> 5176349Smarcel * All rights reserved. 6176349Smarcel * 7176349Smarcel * Redistribution and use in source and binary forms, with or without 8176349Smarcel * modification, are permitted provided that the following conditions 9176349Smarcel * are met: 10176349Smarcel * 1. Redistributions of source code must retain the above copyright 11176349Smarcel * notice, this list of conditions and the following disclaimer. 12176349Smarcel * 2. Redistributions in binary form must reproduce the above copyright 13176349Smarcel * notice, this list of conditions and the following disclaimer in the 14176349Smarcel * documentation and/or other materials provided with the distribution. 15176349Smarcel * 16176349Smarcel * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17176349Smarcel * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18176349Smarcel * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19176349Smarcel * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20176349Smarcel * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21176349Smarcel * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22176349Smarcel * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23176349Smarcel * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24176349Smarcel * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25176349Smarcel * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26176349Smarcel * SUCH DAMAGE. 27176349Smarcel */ 28176349Smarcel 29176349Smarcel#include <sys/cdefs.h> 30176349Smarcel__FBSDID("$FreeBSD$"); 31176349Smarcel 32176349Smarcel#include <stand.h> 33176349Smarcel#include <sys/param.h> 34176349Smarcel#include <sys/reboot.h> 35176349Smarcel#include <sys/linker.h> 36176349Smarcel 37176349Smarcel#include <machine/elf.h> 38176349Smarcel#include <machine/metadata.h> 39176349Smarcel 40176349Smarcel#include "api_public.h" 41176349Smarcel#include "bootstrap.h" 42176487Smarcel#include "glue.h" 43176349Smarcel 44208538Sraj#if defined(LOADER_FDT_SUPPORT) 45243693Sgonzoextern int fdt_copy(vm_offset_t); 46208538Sraj#endif 47208538Sraj 48176349Smarcel/* 49176349Smarcel * Return a 'boothowto' value corresponding to the kernel arguments in 50176349Smarcel * (kargs) and any relevant environment variables. 51176349Smarcel */ 52176489Smarcelstatic struct 53176349Smarcel{ 54176489Smarcel const char *ev; 55176489Smarcel int mask; 56176349Smarcel} howto_names[] = { 57176489Smarcel {"boot_askname", RB_ASKNAME}, 58176489Smarcel {"boot_cdrom", RB_CDROM}, 59176489Smarcel {"boot_ddb", RB_KDB}, 60176489Smarcel {"boot_dfltroot", RB_DFLTROOT}, 61176489Smarcel {"boot_gdb", RB_GDB}, 62176489Smarcel {"boot_multicons", RB_MULTIPLE}, 63176489Smarcel {"boot_mute", RB_MUTE}, 64176489Smarcel {"boot_pause", RB_PAUSE}, 65176489Smarcel {"boot_serial", RB_SERIAL}, 66176489Smarcel {"boot_single", RB_SINGLE}, 67176489Smarcel {"boot_verbose", RB_VERBOSE}, 68176489Smarcel {NULL, 0} 69176349Smarcel}; 70176349Smarcel 71176487Smarcelstatic int 72176349Smarcelmd_getboothowto(char *kargs) 73176349Smarcel{ 74176489Smarcel char *cp; 75235094Skientzle char *p; 76176489Smarcel int howto; 77176489Smarcel int active; 78176489Smarcel int i; 79176489Smarcel 80176489Smarcel /* Parse kargs */ 81176489Smarcel howto = 0; 82176489Smarcel if (kargs != NULL) { 83176489Smarcel cp = kargs; 84176489Smarcel active = 0; 85176489Smarcel while (*cp != 0) { 86176489Smarcel if (!active && (*cp == '-')) 87176489Smarcel active = 1; 88176489Smarcel else if (active) 89176489Smarcel switch (*cp) { 90176489Smarcel case 'a': 91176489Smarcel howto |= RB_ASKNAME; 92176489Smarcel break; 93176489Smarcel case 'C': 94176489Smarcel howto |= RB_CDROM; 95176489Smarcel break; 96176489Smarcel case 'd': 97176489Smarcel howto |= RB_KDB; 98176489Smarcel break; 99176489Smarcel case 'D': 100176489Smarcel howto |= RB_MULTIPLE; 101176489Smarcel break; 102176489Smarcel case 'm': 103176489Smarcel howto |= RB_MUTE; 104176489Smarcel break; 105176489Smarcel case 'g': 106176489Smarcel howto |= RB_GDB; 107176489Smarcel break; 108176489Smarcel case 'h': 109176489Smarcel howto |= RB_SERIAL; 110176489Smarcel break; 111176489Smarcel case 'p': 112176489Smarcel howto |= RB_PAUSE; 113176489Smarcel break; 114176489Smarcel case 'r': 115176489Smarcel howto |= RB_DFLTROOT; 116176489Smarcel break; 117176489Smarcel case 's': 118176489Smarcel howto |= RB_SINGLE; 119176489Smarcel break; 120176489Smarcel case 'v': 121176489Smarcel howto |= RB_VERBOSE; 122176489Smarcel break; 123176489Smarcel default: 124176489Smarcel active = 0; 125176489Smarcel break; 126176489Smarcel } 127176489Smarcel cp++; 128176349Smarcel } 129176349Smarcel } 130176489Smarcel 131176489Smarcel /* get equivalents from the environment */ 132176489Smarcel for (i = 0; howto_names[i].ev != NULL; i++) { 133176489Smarcel if (getenv(howto_names[i].ev) != NULL) 134176489Smarcel howto |= howto_names[i].mask; 135176489Smarcel } 136235094Skientzle if ((p = getenv("console"))) { 137235094Skientzle if (!strcmp(p, "comconsole")) 138235094Skientzle howto |= RB_SERIAL; 139235094Skientzle if (!strcmp(p, "nullconsole")) 140235094Skientzle howto |= RB_MUTE; 141235094Skientzle } 142176489Smarcel 143176489Smarcel return(howto); 144176349Smarcel} 145176349Smarcel 146176349Smarcel/* 147176349Smarcel * Copy the environment into the load area starting at (addr). 148176349Smarcel * Each variable is formatted as <name>=<value>, with a single nul 149176349Smarcel * separating each variable, and a double nul terminating the environment. 150176349Smarcel */ 151176487Smarcelstatic vm_offset_t 152176349Smarcelmd_copyenv(vm_offset_t addr) 153176349Smarcel{ 154176489Smarcel struct env_var *ep; 155176489Smarcel 156176489Smarcel /* traverse the environment */ 157176489Smarcel for (ep = environ; ep != NULL; ep = ep->ev_next) { 158176489Smarcel archsw.arch_copyin(ep->ev_name, addr, strlen(ep->ev_name)); 159176489Smarcel addr += strlen(ep->ev_name); 160176489Smarcel archsw.arch_copyin("=", addr, 1); 161176489Smarcel addr++; 162176489Smarcel if (ep->ev_value != NULL) { 163176489Smarcel archsw.arch_copyin(ep->ev_value, addr, 164176489Smarcel strlen(ep->ev_value)); 165176489Smarcel addr += strlen(ep->ev_value); 166176489Smarcel } 167176489Smarcel archsw.arch_copyin("", addr, 1); 168176489Smarcel addr++; 169176349Smarcel } 170176349Smarcel archsw.arch_copyin("", addr, 1); 171176349Smarcel addr++; 172176489Smarcel return(addr); 173176349Smarcel} 174176349Smarcel 175176349Smarcel/* 176176349Smarcel * Copy module-related data into the load area, where it can be 177176349Smarcel * used as a directory for loaded modules. 178176349Smarcel * 179176349Smarcel * Module data is presented in a self-describing format. Each datum 180176349Smarcel * is preceded by a 32-bit identifier and a 32-bit size field. 181176349Smarcel * 182176349Smarcel * Currently, the following data are saved: 183176349Smarcel * 184176349Smarcel * MOD_NAME (variable) module name (string) 185176349Smarcel * MOD_TYPE (variable) module type (string) 186176349Smarcel * MOD_ARGS (variable) module parameters (string) 187176349Smarcel * MOD_ADDR sizeof(vm_offset_t) module load address 188176349Smarcel * MOD_SIZE sizeof(size_t) module size 189176349Smarcel * MOD_METADATA (variable) type-specific metadata 190176349Smarcel */ 191176489Smarcel#define COPY32(v, a, c) { \ 192176349Smarcel u_int32_t x = (v); \ 193176349Smarcel if (c) \ 194176489Smarcel archsw.arch_copyin(&x, a, sizeof(x)); \ 195176349Smarcel a += sizeof(x); \ 196176349Smarcel} 197176349Smarcel 198176489Smarcel#define MOD_STR(t, a, s, c) { \ 199176349Smarcel COPY32(t, a, c); \ 200176349Smarcel COPY32(strlen(s) + 1, a, c) \ 201176349Smarcel if (c) \ 202176489Smarcel archsw.arch_copyin(s, a, strlen(s) + 1);\ 203176349Smarcel a += roundup(strlen(s) + 1, sizeof(u_long));\ 204176349Smarcel} 205176349Smarcel 206176489Smarcel#define MOD_NAME(a, s, c) MOD_STR(MODINFO_NAME, a, s, c) 207176489Smarcel#define MOD_TYPE(a, s, c) MOD_STR(MODINFO_TYPE, a, s, c) 208176489Smarcel#define MOD_ARGS(a, s, c) MOD_STR(MODINFO_ARGS, a, s, c) 209176349Smarcel 210176489Smarcel#define MOD_VAR(t, a, s, c) { \ 211176349Smarcel COPY32(t, a, c); \ 212176349Smarcel COPY32(sizeof(s), a, c); \ 213176349Smarcel if (c) \ 214176489Smarcel archsw.arch_copyin(&s, a, sizeof(s)); \ 215176349Smarcel a += roundup(sizeof(s), sizeof(u_long)); \ 216176349Smarcel} 217176349Smarcel 218176489Smarcel#define MOD_ADDR(a, s, c) MOD_VAR(MODINFO_ADDR, a, s, c) 219176489Smarcel#define MOD_SIZE(a, s, c) MOD_VAR(MODINFO_SIZE, a, s, c) 220176349Smarcel 221176489Smarcel#define MOD_METADATA(a, mm, c) { \ 222176349Smarcel COPY32(MODINFO_METADATA | mm->md_type, a, c);\ 223176349Smarcel COPY32(mm->md_size, a, c); \ 224176349Smarcel if (c) \ 225176489Smarcel archsw.arch_copyin(mm->md_data, a, mm->md_size);\ 226176349Smarcel a += roundup(mm->md_size, sizeof(u_long)); \ 227176349Smarcel} 228176349Smarcel 229176489Smarcel#define MOD_END(a, c) { \ 230176349Smarcel COPY32(MODINFO_END, a, c); \ 231176349Smarcel COPY32(0, a, c); \ 232176349Smarcel} 233176349Smarcel 234176487Smarcelstatic vm_offset_t 235176349Smarcelmd_copymodules(vm_offset_t addr) 236176349Smarcel{ 237176489Smarcel struct preloaded_file *fp; 238176489Smarcel struct file_metadata *md; 239176489Smarcel int c; 240199534Sraj vm_offset_t a; 241176349Smarcel 242176489Smarcel c = addr != 0; 243176489Smarcel /* start with the first module on the list, should be the kernel */ 244176489Smarcel for (fp = file_findfile(NULL, NULL); fp != NULL; fp = fp->f_next) { 245176349Smarcel 246176489Smarcel MOD_NAME(addr, fp->f_name, c); /* this field must be first */ 247176489Smarcel MOD_TYPE(addr, fp->f_type, c); 248176489Smarcel if (fp->f_args) 249176489Smarcel MOD_ARGS(addr, fp->f_args, c); 250199534Sraj a = fp->f_addr - __elfN(relocation_offset); 251199534Sraj MOD_ADDR(addr, a, c); 252176489Smarcel MOD_SIZE(addr, fp->f_size, c); 253176489Smarcel for (md = fp->f_metadata; md != NULL; md = md->md_next) { 254176489Smarcel if (!(md->md_type & MODINFOMD_NOCOPY)) 255176489Smarcel MOD_METADATA(addr, md, c); 256176489Smarcel } 257176349Smarcel } 258176489Smarcel MOD_END(addr, c); 259176489Smarcel return(addr); 260176349Smarcel} 261176349Smarcel 262176349Smarcel/* 263208538Sraj * Load the information expected by a kernel. 264176349Smarcel * 265176349Smarcel * - The 'boothowto' argument is constructed 266176349Smarcel * - The 'bootdev' argument is constructed 267176349Smarcel * - The kernel environment is copied into kernel space. 268176349Smarcel * - Module metadata are formatted and placed in kernel space. 269176349Smarcel */ 270176349Smarcelint 271176349Smarcelmd_load(char *args, vm_offset_t *modulep) 272176349Smarcel{ 273208538Sraj struct preloaded_file *kfp, *bfp; 274176489Smarcel struct preloaded_file *xp; 275176489Smarcel struct file_metadata *md; 276176489Smarcel struct bootinfo *bip; 277176489Smarcel vm_offset_t kernend; 278176489Smarcel vm_offset_t addr; 279176489Smarcel vm_offset_t envp; 280176489Smarcel vm_offset_t size; 281176489Smarcel vm_offset_t vaddr; 282243693Sgonzo#if defined(LOADER_FDT_SUPPORT) 283208538Sraj vm_offset_t dtbp; 284243693Sgonzo int dtb_size; 285243693Sgonzo#endif 286176489Smarcel char *rootdevname; 287176489Smarcel int howto; 288176489Smarcel int i; 289176349Smarcel 290176489Smarcel /* 291176489Smarcel * These metadata addreses must be converted for kernel after 292176489Smarcel * relocation. 293176489Smarcel */ 294176489Smarcel uint32_t mdt[] = { 295208538Sraj MODINFOMD_SSYM, MODINFOMD_ESYM, MODINFOMD_KERNEND, 296208538Sraj MODINFOMD_ENVP, 297208538Sraj#if defined(LOADER_FDT_SUPPORT) 298208538Sraj MODINFOMD_DTBP 299208538Sraj#endif 300176489Smarcel }; 301176349Smarcel 302176489Smarcel howto = md_getboothowto(args); 303176349Smarcel 304176489Smarcel /* 305176489Smarcel * Allow the environment variable 'rootdev' to override the supplied 306176489Smarcel * device. This should perhaps go to MI code and/or have $rootdev 307176489Smarcel * tested/set by MI code before launching the kernel. 308176489Smarcel */ 309176489Smarcel rootdevname = getenv("rootdev"); 310176489Smarcel if (rootdevname == NULL) 311176489Smarcel rootdevname = getenv("currdev"); 312176489Smarcel /* Try reading the /etc/fstab file to select the root device */ 313176489Smarcel getrootmount(rootdevname); 314176349Smarcel 315208538Sraj /* Find the last module in the chain */ 316176489Smarcel addr = 0; 317176489Smarcel for (xp = file_findfile(NULL, NULL); xp != NULL; xp = xp->f_next) { 318176489Smarcel if (addr < (xp->f_addr + xp->f_size)) 319176489Smarcel addr = xp->f_addr + xp->f_size; 320176489Smarcel } 321208538Sraj /* Pad to a page boundary */ 322176489Smarcel addr = roundup(addr, PAGE_SIZE); 323176349Smarcel 324208538Sraj /* Copy our environment */ 325176489Smarcel envp = addr; 326176489Smarcel addr = md_copyenv(addr); 327176349Smarcel 328208538Sraj /* Pad to a page boundary */ 329176489Smarcel addr = roundup(addr, PAGE_SIZE); 330176349Smarcel 331243693Sgonzo#if defined(LOADER_FDT_SUPPORT) 332243693Sgonzo /* Handle device tree blob */ 333243693Sgonzo dtbp = addr; 334243693Sgonzo dtb_size = fdt_copy(addr); 335243693Sgonzo 336243693Sgonzo /* Pad to a page boundary */ 337243693Sgonzo if (dtb_size) 338243693Sgonzo addr += roundup(dtb_size, PAGE_SIZE); 339243693Sgonzo#endif 340243693Sgonzo 341176489Smarcel kernend = 0; 342176489Smarcel kfp = file_findfile(NULL, "elf32 kernel"); 343176489Smarcel if (kfp == NULL) 344176489Smarcel kfp = file_findfile(NULL, "elf kernel"); 345176489Smarcel if (kfp == NULL) 346176489Smarcel panic("can't find kernel file"); 347176489Smarcel file_addmetadata(kfp, MODINFOMD_HOWTO, sizeof howto, &howto); 348208538Sraj file_addmetadata(kfp, MODINFOMD_ENVP, sizeof envp, &envp); 349208538Sraj 350208538Sraj#if defined(LOADER_FDT_SUPPORT) 351243693Sgonzo if (dtb_size) 352233230Sraj file_addmetadata(kfp, MODINFOMD_DTBP, sizeof dtbp, &dtbp); 353233230Sraj else 354233230Sraj pager_output("WARNING! Trying to fire up the kernel, but no " 355233230Sraj "device tree blob found!\n"); 356208538Sraj#endif 357208538Sraj 358176489Smarcel file_addmetadata(kfp, MODINFOMD_KERNEND, sizeof kernend, &kernend); 359176349Smarcel 360208538Sraj /* Figure out the size and location of the metadata */ 361176489Smarcel *modulep = addr; 362176489Smarcel size = md_copymodules(0); 363176489Smarcel kernend = roundup(addr + size, PAGE_SIZE); 364176349Smarcel 365208538Sraj /* Provide MODINFOMD_KERNEND */ 366176489Smarcel md = file_findmetadata(kfp, MODINFOMD_KERNEND); 367176489Smarcel bcopy(&kernend, md->md_data, sizeof kernend); 368176349Smarcel 369176489Smarcel /* Convert addresses to the final VA */ 370176489Smarcel *modulep -= __elfN(relocation_offset); 371176349Smarcel 372246135Sian /* Do relocation fixup on metadata of each module. */ 373246135Sian for (xp = file_findfile(NULL, NULL); xp != NULL; xp = xp->f_next) { 374246135Sian for (i = 0; i < sizeof mdt / sizeof mdt[0]; i++) { 375246135Sian md = file_findmetadata(xp, mdt[i]); 376246135Sian if (md) { 377246135Sian bcopy(md->md_data, &vaddr, sizeof vaddr); 378246135Sian vaddr -= __elfN(relocation_offset); 379246135Sian bcopy(&vaddr, md->md_data, sizeof vaddr); 380246135Sian } 381176489Smarcel } 382176489Smarcel } 383208538Sraj 384208538Sraj /* Only now copy actual modules and metadata */ 385176489Smarcel (void)md_copymodules(addr); 386176349Smarcel 387208538Sraj return (0); 388176349Smarcel} 389