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: releng/10.3/sys/boot/uboot/common/metadata.c 275763 2014-12-14 15:33:45Z andrew $"); 31176349Smarcel 32176349Smarcel#include <stand.h> 33176349Smarcel#include <sys/param.h> 34176349Smarcel#include <sys/reboot.h> 35176349Smarcel#include <sys/linker.h> 36271132Semaste#include <sys/boot.h> 37176349Smarcel 38176349Smarcel#include <machine/elf.h> 39176349Smarcel#include <machine/metadata.h> 40176349Smarcel 41176349Smarcel#include "api_public.h" 42176349Smarcel#include "bootstrap.h" 43176487Smarcel#include "glue.h" 44176349Smarcel 45208538Sraj#if defined(LOADER_FDT_SUPPORT) 46275763Sandrew#include <fdt_platform.h> 47208538Sraj#endif 48208538Sraj 49176487Smarcelstatic int 50176349Smarcelmd_getboothowto(char *kargs) 51176349Smarcel{ 52176489Smarcel char *cp; 53235094Skientzle char *p; 54176489Smarcel int howto; 55176489Smarcel int active; 56176489Smarcel int i; 57176489Smarcel 58176489Smarcel /* Parse kargs */ 59176489Smarcel howto = 0; 60176489Smarcel if (kargs != NULL) { 61176489Smarcel cp = kargs; 62176489Smarcel active = 0; 63176489Smarcel while (*cp != 0) { 64176489Smarcel if (!active && (*cp == '-')) 65176489Smarcel active = 1; 66176489Smarcel else if (active) 67176489Smarcel switch (*cp) { 68176489Smarcel case 'a': 69176489Smarcel howto |= RB_ASKNAME; 70176489Smarcel break; 71176489Smarcel case 'C': 72176489Smarcel howto |= RB_CDROM; 73176489Smarcel break; 74176489Smarcel case 'd': 75176489Smarcel howto |= RB_KDB; 76176489Smarcel break; 77176489Smarcel case 'D': 78176489Smarcel howto |= RB_MULTIPLE; 79176489Smarcel break; 80176489Smarcel case 'm': 81176489Smarcel howto |= RB_MUTE; 82176489Smarcel break; 83176489Smarcel case 'g': 84176489Smarcel howto |= RB_GDB; 85176489Smarcel break; 86176489Smarcel case 'h': 87176489Smarcel howto |= RB_SERIAL; 88176489Smarcel break; 89176489Smarcel case 'p': 90176489Smarcel howto |= RB_PAUSE; 91176489Smarcel break; 92176489Smarcel case 'r': 93176489Smarcel howto |= RB_DFLTROOT; 94176489Smarcel break; 95176489Smarcel case 's': 96176489Smarcel howto |= RB_SINGLE; 97176489Smarcel break; 98176489Smarcel case 'v': 99176489Smarcel howto |= RB_VERBOSE; 100176489Smarcel break; 101176489Smarcel default: 102176489Smarcel active = 0; 103176489Smarcel break; 104176489Smarcel } 105176489Smarcel cp++; 106176349Smarcel } 107176349Smarcel } 108176489Smarcel 109176489Smarcel /* get equivalents from the environment */ 110176489Smarcel for (i = 0; howto_names[i].ev != NULL; i++) { 111176489Smarcel if (getenv(howto_names[i].ev) != NULL) 112176489Smarcel howto |= howto_names[i].mask; 113176489Smarcel } 114235094Skientzle if ((p = getenv("console"))) { 115235094Skientzle if (!strcmp(p, "comconsole")) 116235094Skientzle howto |= RB_SERIAL; 117235094Skientzle if (!strcmp(p, "nullconsole")) 118235094Skientzle howto |= RB_MUTE; 119235094Skientzle } 120176489Smarcel 121176489Smarcel return(howto); 122176349Smarcel} 123176349Smarcel 124176349Smarcel/* 125176349Smarcel * Copy the environment into the load area starting at (addr). 126176349Smarcel * Each variable is formatted as <name>=<value>, with a single nul 127176349Smarcel * separating each variable, and a double nul terminating the environment. 128176349Smarcel */ 129176487Smarcelstatic vm_offset_t 130176349Smarcelmd_copyenv(vm_offset_t addr) 131176349Smarcel{ 132176489Smarcel struct env_var *ep; 133176489Smarcel 134176489Smarcel /* traverse the environment */ 135176489Smarcel for (ep = environ; ep != NULL; ep = ep->ev_next) { 136176489Smarcel archsw.arch_copyin(ep->ev_name, addr, strlen(ep->ev_name)); 137176489Smarcel addr += strlen(ep->ev_name); 138176489Smarcel archsw.arch_copyin("=", addr, 1); 139176489Smarcel addr++; 140176489Smarcel if (ep->ev_value != NULL) { 141176489Smarcel archsw.arch_copyin(ep->ev_value, addr, 142176489Smarcel strlen(ep->ev_value)); 143176489Smarcel addr += strlen(ep->ev_value); 144176489Smarcel } 145176489Smarcel archsw.arch_copyin("", addr, 1); 146176489Smarcel addr++; 147176349Smarcel } 148176349Smarcel archsw.arch_copyin("", addr, 1); 149176349Smarcel addr++; 150176489Smarcel return(addr); 151176349Smarcel} 152176349Smarcel 153176349Smarcel/* 154176349Smarcel * Copy module-related data into the load area, where it can be 155176349Smarcel * used as a directory for loaded modules. 156176349Smarcel * 157176349Smarcel * Module data is presented in a self-describing format. Each datum 158176349Smarcel * is preceded by a 32-bit identifier and a 32-bit size field. 159176349Smarcel * 160176349Smarcel * Currently, the following data are saved: 161176349Smarcel * 162176349Smarcel * MOD_NAME (variable) module name (string) 163176349Smarcel * MOD_TYPE (variable) module type (string) 164176349Smarcel * MOD_ARGS (variable) module parameters (string) 165176349Smarcel * MOD_ADDR sizeof(vm_offset_t) module load address 166176349Smarcel * MOD_SIZE sizeof(size_t) module size 167176349Smarcel * MOD_METADATA (variable) type-specific metadata 168176349Smarcel */ 169176489Smarcel#define COPY32(v, a, c) { \ 170176349Smarcel u_int32_t x = (v); \ 171176349Smarcel if (c) \ 172176489Smarcel archsw.arch_copyin(&x, a, sizeof(x)); \ 173176349Smarcel a += sizeof(x); \ 174176349Smarcel} 175176349Smarcel 176176489Smarcel#define MOD_STR(t, a, s, c) { \ 177176349Smarcel COPY32(t, a, c); \ 178176349Smarcel COPY32(strlen(s) + 1, a, c) \ 179176349Smarcel if (c) \ 180176489Smarcel archsw.arch_copyin(s, a, strlen(s) + 1);\ 181176349Smarcel a += roundup(strlen(s) + 1, sizeof(u_long));\ 182176349Smarcel} 183176349Smarcel 184176489Smarcel#define MOD_NAME(a, s, c) MOD_STR(MODINFO_NAME, a, s, c) 185176489Smarcel#define MOD_TYPE(a, s, c) MOD_STR(MODINFO_TYPE, a, s, c) 186176489Smarcel#define MOD_ARGS(a, s, c) MOD_STR(MODINFO_ARGS, a, s, c) 187176349Smarcel 188176489Smarcel#define MOD_VAR(t, a, s, c) { \ 189176349Smarcel COPY32(t, a, c); \ 190176349Smarcel COPY32(sizeof(s), a, c); \ 191176349Smarcel if (c) \ 192176489Smarcel archsw.arch_copyin(&s, a, sizeof(s)); \ 193176349Smarcel a += roundup(sizeof(s), sizeof(u_long)); \ 194176349Smarcel} 195176349Smarcel 196176489Smarcel#define MOD_ADDR(a, s, c) MOD_VAR(MODINFO_ADDR, a, s, c) 197176489Smarcel#define MOD_SIZE(a, s, c) MOD_VAR(MODINFO_SIZE, a, s, c) 198176349Smarcel 199176489Smarcel#define MOD_METADATA(a, mm, c) { \ 200176349Smarcel COPY32(MODINFO_METADATA | mm->md_type, a, c);\ 201176349Smarcel COPY32(mm->md_size, a, c); \ 202176349Smarcel if (c) \ 203176489Smarcel archsw.arch_copyin(mm->md_data, a, mm->md_size);\ 204176349Smarcel a += roundup(mm->md_size, sizeof(u_long)); \ 205176349Smarcel} 206176349Smarcel 207176489Smarcel#define MOD_END(a, c) { \ 208176349Smarcel COPY32(MODINFO_END, a, c); \ 209176349Smarcel COPY32(0, a, c); \ 210176349Smarcel} 211176349Smarcel 212176487Smarcelstatic vm_offset_t 213176349Smarcelmd_copymodules(vm_offset_t addr) 214176349Smarcel{ 215176489Smarcel struct preloaded_file *fp; 216176489Smarcel struct file_metadata *md; 217176489Smarcel int c; 218199534Sraj vm_offset_t a; 219176349Smarcel 220176489Smarcel c = addr != 0; 221176489Smarcel /* start with the first module on the list, should be the kernel */ 222176489Smarcel for (fp = file_findfile(NULL, NULL); fp != NULL; fp = fp->f_next) { 223176349Smarcel 224176489Smarcel MOD_NAME(addr, fp->f_name, c); /* this field must be first */ 225176489Smarcel MOD_TYPE(addr, fp->f_type, c); 226176489Smarcel if (fp->f_args) 227176489Smarcel MOD_ARGS(addr, fp->f_args, c); 228199534Sraj a = fp->f_addr - __elfN(relocation_offset); 229199534Sraj MOD_ADDR(addr, a, c); 230176489Smarcel MOD_SIZE(addr, fp->f_size, c); 231176489Smarcel for (md = fp->f_metadata; md != NULL; md = md->md_next) { 232176489Smarcel if (!(md->md_type & MODINFOMD_NOCOPY)) 233176489Smarcel MOD_METADATA(addr, md, c); 234176489Smarcel } 235176349Smarcel } 236176489Smarcel MOD_END(addr, c); 237176489Smarcel return(addr); 238176349Smarcel} 239176349Smarcel 240176349Smarcel/* 241208538Sraj * Load the information expected by a kernel. 242176349Smarcel * 243176349Smarcel * - The 'boothowto' argument is constructed 244176349Smarcel * - The 'bootdev' argument is constructed 245176349Smarcel * - The kernel environment is copied into kernel space. 246176349Smarcel * - Module metadata are formatted and placed in kernel space. 247176349Smarcel */ 248176349Smarcelint 249176349Smarcelmd_load(char *args, vm_offset_t *modulep) 250176349Smarcel{ 251208538Sraj struct preloaded_file *kfp, *bfp; 252176489Smarcel struct preloaded_file *xp; 253176489Smarcel struct file_metadata *md; 254176489Smarcel struct bootinfo *bip; 255176489Smarcel vm_offset_t kernend; 256176489Smarcel vm_offset_t addr; 257176489Smarcel vm_offset_t envp; 258176489Smarcel vm_offset_t size; 259176489Smarcel vm_offset_t vaddr; 260243693Sgonzo#if defined(LOADER_FDT_SUPPORT) 261208538Sraj vm_offset_t dtbp; 262243693Sgonzo int dtb_size; 263243693Sgonzo#endif 264176489Smarcel char *rootdevname; 265176489Smarcel int howto; 266176489Smarcel int i; 267176349Smarcel 268176489Smarcel /* 269176489Smarcel * These metadata addreses must be converted for kernel after 270176489Smarcel * relocation. 271176489Smarcel */ 272176489Smarcel uint32_t mdt[] = { 273208538Sraj MODINFOMD_SSYM, MODINFOMD_ESYM, MODINFOMD_KERNEND, 274208538Sraj MODINFOMD_ENVP, 275208538Sraj#if defined(LOADER_FDT_SUPPORT) 276208538Sraj MODINFOMD_DTBP 277208538Sraj#endif 278176489Smarcel }; 279176349Smarcel 280176489Smarcel howto = md_getboothowto(args); 281176349Smarcel 282176489Smarcel /* 283176489Smarcel * Allow the environment variable 'rootdev' to override the supplied 284176489Smarcel * device. This should perhaps go to MI code and/or have $rootdev 285176489Smarcel * tested/set by MI code before launching the kernel. 286176489Smarcel */ 287176489Smarcel rootdevname = getenv("rootdev"); 288176489Smarcel if (rootdevname == NULL) 289176489Smarcel rootdevname = getenv("currdev"); 290176489Smarcel /* Try reading the /etc/fstab file to select the root device */ 291176489Smarcel getrootmount(rootdevname); 292176349Smarcel 293208538Sraj /* Find the last module in the chain */ 294176489Smarcel addr = 0; 295176489Smarcel for (xp = file_findfile(NULL, NULL); xp != NULL; xp = xp->f_next) { 296176489Smarcel if (addr < (xp->f_addr + xp->f_size)) 297176489Smarcel addr = xp->f_addr + xp->f_size; 298176489Smarcel } 299208538Sraj /* Pad to a page boundary */ 300176489Smarcel addr = roundup(addr, PAGE_SIZE); 301176349Smarcel 302208538Sraj /* Copy our environment */ 303176489Smarcel envp = addr; 304176489Smarcel addr = md_copyenv(addr); 305176349Smarcel 306208538Sraj /* Pad to a page boundary */ 307176489Smarcel addr = roundup(addr, PAGE_SIZE); 308176349Smarcel 309243693Sgonzo#if defined(LOADER_FDT_SUPPORT) 310243693Sgonzo /* Handle device tree blob */ 311243693Sgonzo dtbp = addr; 312243693Sgonzo dtb_size = fdt_copy(addr); 313243693Sgonzo 314243693Sgonzo /* Pad to a page boundary */ 315243693Sgonzo if (dtb_size) 316243693Sgonzo addr += roundup(dtb_size, PAGE_SIZE); 317243693Sgonzo#endif 318243693Sgonzo 319176489Smarcel kernend = 0; 320176489Smarcel kfp = file_findfile(NULL, "elf32 kernel"); 321176489Smarcel if (kfp == NULL) 322176489Smarcel kfp = file_findfile(NULL, "elf kernel"); 323176489Smarcel if (kfp == NULL) 324176489Smarcel panic("can't find kernel file"); 325176489Smarcel file_addmetadata(kfp, MODINFOMD_HOWTO, sizeof howto, &howto); 326208538Sraj file_addmetadata(kfp, MODINFOMD_ENVP, sizeof envp, &envp); 327208538Sraj 328208538Sraj#if defined(LOADER_FDT_SUPPORT) 329243693Sgonzo if (dtb_size) 330233230Sraj file_addmetadata(kfp, MODINFOMD_DTBP, sizeof dtbp, &dtbp); 331233230Sraj else 332233230Sraj pager_output("WARNING! Trying to fire up the kernel, but no " 333233230Sraj "device tree blob found!\n"); 334208538Sraj#endif 335208538Sraj 336176489Smarcel file_addmetadata(kfp, MODINFOMD_KERNEND, sizeof kernend, &kernend); 337176349Smarcel 338208538Sraj /* Figure out the size and location of the metadata */ 339176489Smarcel *modulep = addr; 340176489Smarcel size = md_copymodules(0); 341176489Smarcel kernend = roundup(addr + size, PAGE_SIZE); 342176349Smarcel 343208538Sraj /* Provide MODINFOMD_KERNEND */ 344176489Smarcel md = file_findmetadata(kfp, MODINFOMD_KERNEND); 345176489Smarcel bcopy(&kernend, md->md_data, sizeof kernend); 346176349Smarcel 347176489Smarcel /* Convert addresses to the final VA */ 348176489Smarcel *modulep -= __elfN(relocation_offset); 349176349Smarcel 350246135Sian /* Do relocation fixup on metadata of each module. */ 351246135Sian for (xp = file_findfile(NULL, NULL); xp != NULL; xp = xp->f_next) { 352246135Sian for (i = 0; i < sizeof mdt / sizeof mdt[0]; i++) { 353246135Sian md = file_findmetadata(xp, mdt[i]); 354246135Sian if (md) { 355246135Sian bcopy(md->md_data, &vaddr, sizeof vaddr); 356246135Sian vaddr -= __elfN(relocation_offset); 357246135Sian bcopy(&vaddr, md->md_data, sizeof vaddr); 358246135Sian } 359176489Smarcel } 360176489Smarcel } 361208538Sraj 362208538Sraj /* Only now copy actual modules and metadata */ 363176489Smarcel (void)md_copymodules(addr); 364176349Smarcel 365208538Sraj return (0); 366176349Smarcel} 367