sys/boot/alpha/libalpha/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/alpha/libalpha/bootinfo.c,v 1.9.2.1 2001/03/04 05:20:26 obrien Exp $
  27  * $DragonFly: src/sys/boot/alpha/libalpha/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 extern char *alpha_fmtdev(void *vdev);
  42
  43 /*
  44  * Copy the environment into the load area starting at (addr).
  45  * Each variable is formatted as <name>=<value>, with a single nul
  46  * separating each variable, and a double nul terminating the environment.
  47  */
  48 vm_offset_t
  49 bi_copyenv(vm_offset_t addr)
  50 {
  51     struct env_var      *ep;
  52
  53     /* traverse the environment */
  54     for (ep = environ; ep != NULL; ep = ep->ev_next) {
  55         alpha_copyin(ep->ev_name, addr, strlen(ep->ev_name));
  56         addr += strlen(ep->ev_name);
  57         alpha_copyin("=", addr, 1);
  58         addr++;
  59         if (ep->ev_value != NULL) {
  60             alpha_copyin(ep->ev_value, addr, strlen(ep->ev_value));
  61             addr += strlen(ep->ev_value);
  62         }
  63         alpha_copyin("", addr, 1);
  64         addr++;
  65     }
  66     alpha_copyin("", addr, 1);
  67     addr++;
  68     return(addr);
  69 }
  70
  71 /*
  72  * Copy module-related data into the load area, where it can be
  73  * used as a directory for loaded modules.
  74  *
  75  * Module data is presented in a self-describing format.  Each datum
  76  * is preceded by a 32-bit identifier and a 32-bit size field.
  77  *
  78  * Currently, the following data are saved:
  79  *
  80  * MOD_NAME     (variable)              module name (string)
  81  * MOD_TYPE     (variable)              module type (string)
  82  * MOD_ARGS     (variable)              module parameters (string)
  83  * MOD_ADDR     sizeof(vm_offset_t)     module load address
  84  * MOD_SIZE     sizeof(size_t)          module size
  85  * MOD_METADATA (variable)              type-specific metadata
  86  */
  87 #define COPY32(v, a) {                          \
  88     u_int32_t   x = (v);                        \
  89     alpha_copyin(&x, a, sizeof(x));             \
  90     a += sizeof(x);                             \
  91 }
  92
  93 #define MOD_STR(t, a, s) {                      \
  94     COPY32(t, a);                               \
  95     COPY32(strlen(s) + 1, a);                   \
  96     alpha_copyin(s, a, strlen(s) + 1);          \
  97     a += roundup(strlen(s) + 1, sizeof(u_int64_t));\
  98 }
  99
 100 #define MOD_NAME(a, s)  MOD_STR(MODINFO_NAME, a, s)
 101 #define MOD_TYPE(a, s)  MOD_STR(MODINFO_TYPE, a, s)
 102 #define MOD_ARGS(a, s)  MOD_STR(MODINFO_ARGS, a, s)
 103
 104 #define MOD_VAR(t, a, s) {                      \
 105     COPY32(t, a);                               \
 106     COPY32(sizeof(s), a);                       \
 107     alpha_copyin(&s, a, sizeof(s));             \
 108     a += roundup(sizeof(s), sizeof(u_int64_t)); \
 109 }
 110
 111 #define MOD_ADDR(a, s)  MOD_VAR(MODINFO_ADDR, a, s)
 112 #define MOD_SIZE(a, s)  MOD_VAR(MODINFO_SIZE, a, s)
 113
 114 #define MOD_METADATA(a, mm) {                   \
 115     COPY32(MODINFO_METADATA | mm->md_type, a);  \
 116     COPY32(mm->md_size, a);                     \
 117     alpha_copyin(mm->md_data, a, mm->md_size);  \
 118     a += roundup(mm->md_size, sizeof(u_int64_t));\
 119 }
 120
 121 #define MOD_END(a) {                            \
 122     COPY32(MODINFO_END, a);                     \
 123     COPY32(0, a);                               \
 124 }
 125
 126 vm_offset_t
 127 bi_copymodules(vm_offset_t addr)
 128 {
 129     struct loaded_module        *mp;
 130     struct module_metadata      *md;
 131
 132     /* start with the first module on the list, should be the kernel */
 133     for (mp = mod_findmodule(NULL, NULL); mp != NULL; mp = mp->m_next) {
 134
 135         MOD_NAME(addr, mp->m_name);     /* this field must come first */
 136         MOD_TYPE(addr, mp->m_type);
 137         if (mp->m_args)
 138             MOD_ARGS(addr, mp->m_args);
 139         MOD_ADDR(addr, mp->m_addr);
 140         MOD_SIZE(addr, mp->m_size);
 141         for (md = mp->m_metadata; md != NULL; md = md->md_next)
 142             if (!(md->md_type & MODINFOMD_NOCOPY))
 143                 MOD_METADATA(addr, md);
 144     }
 145     MOD_END(addr);
 146     return(addr);
 147 }
 148
 149 /*
 150  * Load the information expected by an alpha kernel.
 151  *
 152  * - The kernel environment is copied into kernel space.
 153  * - Module metadata are formatted and placed in kernel space.
 154  */
 155 int
 156 bi_load(struct bootinfo_v1 *bi, vm_offset_t *ffp_save,
 157         struct loaded_module *mp)
 158 {
 159     char                        *rootdevname;
 160     struct alpha_devdesc        *rootdev;
 161     struct loaded_module        *xp;
 162     vm_offset_t                 addr, bootinfo_addr;
 163     u_int                       pad;
 164     char                        *kernelname;
 165     vm_offset_t                 ssym, esym;
 166     struct module_metadata      *md;
 167
 168     /*
 169      * Allow the environment variable 'rootdev' to override the supplied device
 170      * This should perhaps go to MI code and/or have $rootdev tested/set by
 171      * MI code before launching the kernel.
 172      */
 173     rootdevname = getenv("rootdev");
 174     alpha_getdev((void **)(&rootdev), rootdevname, NULL);
 175     if (rootdev == NULL) {              /* bad $rootdev/$currdev */
 176         printf("can't determine root device\n");
 177         return(EINVAL);
 178     }
 179
 180     /* Try reading the /etc/fstab file to select the root device */
 181     getrootmount(alpha_fmtdev((void *)rootdev));
 182     free(rootdev);
 183
 184     ssym = esym = 0;
 185     if ((md = mod_findmetadata(mp, MODINFOMD_SSYM)) != NULL)
 186         ssym = *((vm_offset_t *)&(md->md_data));
 187     if ((md = mod_findmetadata(mp, MODINFOMD_ESYM)) != NULL)
 188         esym = *((vm_offset_t *)&(md->md_data));
 189     if (ssym == 0 || esym == 0)
 190         ssym = esym = 0;                /* sanity */
 191
 192     bi->ssym = ssym;
 193     bi->esym = esym;
 194
 195     /* find the last module in the chain */
 196     addr = 0;
 197     for (xp = mod_findmodule(NULL, NULL); xp != NULL; xp = xp->m_next) {
 198         if (addr < (xp->m_addr + xp->m_size))
 199             addr = xp->m_addr + xp->m_size;
 200     }
 201     /* pad to a page boundary */
 202     pad = (u_int)addr & PAGE_MASK;
 203     if (pad != 0) {
 204         pad = PAGE_SIZE - pad;
 205         addr += pad;
 206     }
 207
 208     /* copy our environment */
 209     bi->envp = (char *)addr;
 210     addr = bi_copyenv(addr);
 211
 212     /* pad to a page boundary */
 213     pad = (u_int)addr & PAGE_MASK;
 214     if (pad != 0) {
 215         pad = PAGE_SIZE - pad;
 216         addr += pad;
 217     }
 218     /* copy module list and metadata */
 219     bi->modptr = addr;
 220     addr = bi_copymodules(addr);
 221
 222     /* all done copying stuff in, save end of loaded object space */
 223     bi->kernend = addr;
 224
 225     *ffp_save = ALPHA_K0SEG_TO_PHYS((addr + PAGE_MASK) & ~PAGE_MASK)
 226         >> PAGE_SHIFT;
 227     *ffp_save += 2;             /* XXX OSF/1 does this, no idea why. */
 228
 229     kernelname = getenv("kernelname");
 230     if (kernelname) {
 231         strncpy(bi->booted_kernel, kernelname, sizeof(bi->booted_kernel) - 1);
 232     }
 233
 234     return(0);
 235 }