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