sys/boot/arc/lib/bootinfo.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  * $FreeBSD: src/sys/boot/arc/lib/bootinfo.c,v 1.2.2.1 2001/03/04 04:40:41 obrien Exp $
  27  * $DragonFly: src/sys/boot/arc/lib/Attic/bootinfo.c,v 1.2 2003/06/17 04:28:16 dillon Exp $
  28  */
  29
  30 #include <stand.h>
  31 #include <string.h>
  32 #include <sys/param.h>
  33 #include <sys/reboot.h>
  34 #include <sys/linker.h>
  35 #include <machine/elf.h>
  36 #include <machine/prom.h>
  37 #include <machine/rpb.h>
  38 #include <machine/bootinfo.h>
  39 #include "bootstrap.h"
  40
  41 /*
  42  * Copy the environment into the load area starting at (addr).
  43  * Each variable is formatted as <name>=<value>, with a single nul
  44  * separating each variable, and a double nul terminating the environment.
  45  */
  46 vm_offset_t
  47 bi_copyenv(vm_offset_t addr)
  48 {
  49     struct env_var      *ep;
  50
  51     /* traverse the environment */
  52     for (ep = environ; ep != NULL; ep = ep->ev_next) {
  53         alpha_copyin(ep->ev_name, addr, strlen(ep->ev_name));
  54         addr += strlen(ep->ev_name);
  55         alpha_copyin("=", addr, 1);
  56         addr++;
  57         if (ep->ev_value != NULL) {
  58             alpha_copyin(ep->ev_value, addr, strlen(ep->ev_value));
  59             addr += strlen(ep->ev_value);
  60         }
  61         alpha_copyin("", addr, 1);
  62         addr++;
  63     }
  64     alpha_copyin("", addr, 1);
  65     addr++;
  66     return(addr);
  67 }
  68
  69 /*
  70  * Copy module-related data into the load area, where it can be
  71  * used as a directory for loaded modules.
  72  *
  73  * Module data is presented in a self-describing format.  Each datum
  74  * is preceded by a 32-bit identifier and a 32-bit size field.
  75  *
  76  * Currently, the following data are saved:
  77  *
  78  * MOD_NAME     (variable)              module name (string)
  79  * MOD_TYPE     (variable)              module type (string)
  80  * MOD_ADDR     sizeof(vm_offset_t)     module load address
  81  * MOD_SIZE     sizeof(size_t)          module size
  82  * MOD_METADATA (variable)              type-specific metadata
  83  */
  84 #define COPY32(v, a) {                          \
  85     u_int32_t   x = (v);                        \
  86     alpha_copyin(&x, a, sizeof(x));             \
  87     a += sizeof(x);                             \
  88 }
  89
  90 #define MOD_STR(t, a, s) {                      \
  91     COPY32(t, a);                               \
  92     COPY32(strlen(s) + 1, a);                   \
  93     alpha_copyin(s, a, strlen(s) + 1);          \
  94     a += roundup(strlen(s) + 1, sizeof(u_int64_t));\
  95 }
  96
  97 #define MOD_NAME(a, s)  MOD_STR(MODINFO_NAME, a, s)
  98 #define MOD_TYPE(a, s)  MOD_STR(MODINFO_TYPE, a, s)
  99
 100 #define MOD_VAR(t, a, s) {                      \
 101     COPY32(t, a);                               \
 102     COPY32(sizeof(s), a);                       \
 103     alpha_copyin(&s, a, sizeof(s));             \
 104     a += roundup(sizeof(s), sizeof(u_int64_t)); \
 105 }
 106
 107 #define MOD_ADDR(a, s)  MOD_VAR(MODINFO_ADDR, a, s)
 108 #define MOD_SIZE(a, s)  MOD_VAR(MODINFO_SIZE, a, s)
 109
 110 #define MOD_METADATA(a, mm) {                   \
 111     COPY32(MODINFO_METADATA | mm->md_type, a);  \
 112     COPY32(mm->md_size, a);                     \
 113     alpha_copyin(mm->md_data, a, mm->md_size);  \
 114     a += roundup(mm->md_size, sizeof(u_int64_t));\
 115 }
 116
 117 #define MOD_END(a) {                            \
 118     COPY32(MODINFO_END, a);                     \
 119     COPY32(0, a);                               \
 120 }
 121
 122 vm_offset_t
 123 bi_copymodules(vm_offset_t addr)
 124 {
 125     struct loaded_module        *mp;
 126     struct module_metadata      *md;
 127
 128     /* start with the first module on the list, should be the kernel */
 129     for (mp = mod_findmodule(NULL, NULL); mp != NULL; mp = mp->m_next) {
 130
 131         MOD_NAME(addr, mp->m_name);     /* this field must come first */
 132         MOD_TYPE(addr, mp->m_type);
 133         MOD_ADDR(addr, mp->m_addr);
 134         MOD_SIZE(addr, mp->m_size);
 135         for (md = mp->m_metadata; md != NULL; md = md->md_next)
 136             if (!(md->md_type & MODINFOMD_NOCOPY))
 137                 MOD_METADATA(addr, md);
 138     }
 139     MOD_END(addr);
 140     return(addr);
 141 }
 142
 143 /*
 144  * Load the information expected by an alpha kernel.
 145  *
 146  * - The kernel environment is copied into kernel space.
 147  * - Module metadata are formatted and placed in kernel space.
 148  */
 149 int
 150 bi_load(struct bootinfo_v1 *bi, vm_offset_t *ffp_save,
 151         struct loaded_module *mp)
 152 {
 153     struct loaded_module        *xp;
 154     vm_offset_t                 addr, bootinfo_addr;
 155     u_int                       pad;
 156     vm_offset_t                 ssym, esym;
 157     struct module_metadata      *md;
 158
 159     ssym = esym = 0;
 160     if ((md = mod_findmetadata(mp, MODINFOMD_SSYM)) != NULL)
 161         ssym = *((vm_offset_t *)&(md->md_data));
 162     if ((md = mod_findmetadata(mp, MODINFOMD_ESYM)) != NULL)
 163         esym = *((vm_offset_t *)&(md->md_data));
 164     if (ssym == 0 || esym == 0)
 165         ssym = esym = 0;                /* sanity */
 166
 167     bi->ssym = ssym;
 168     bi->esym = esym;
 169
 170     /* find the last module in the chain */
 171     addr = 0;
 172     for (xp = mod_findmodule(NULL, NULL); xp != NULL; xp = xp->m_next) {
 173         if (addr < (xp->m_addr + xp->m_size))
 174             addr = xp->m_addr + xp->m_size;
 175     }
 176     /* pad to a page boundary */
 177     pad = (u_int)addr & PAGE_MASK;
 178     if (pad != 0) {
 179         pad = PAGE_SIZE - pad;
 180         addr += pad;
 181     }
 182
 183     /* copy our environment */
 184     bi->envp = (char *)addr;
 185     addr = bi_copyenv(addr);
 186
 187     /* pad to a page boundary */
 188     pad = (u_int)addr & PAGE_MASK;
 189     if (pad != 0) {
 190         pad = PAGE_SIZE - pad;
 191         addr += pad;
 192     }
 193     /* copy module list and metadata */
 194     bi->modptr = addr;
 195     addr = bi_copymodules(addr);
 196
 197     /* all done copying stuff in, save end of loaded object space */
 198     bi->kernend = addr;
 199
 200     *ffp_save = ALPHA_K0SEG_TO_PHYS((addr + PAGE_MASK) & ~PAGE_MASK)
 201         >> PAGE_SHIFT;
 202     *ffp_save += 2;             /* XXX OSF/1 does this, no idea why. */
 203
 204     return(0);
 205 }