git.gag.com Git - debian/elilo/blob - elilo.h

   1 /*
   2  *  Copyright (C) 2001-2003 Hewlett-Packard Co.
   3  *      Contributed by Stephane Eranian <eranian@hpl.hp.com>
   4  *
   5  *  Copyright (C) 2001 Silicon Graphics, Inc.
   6  *      Contributed by Brent Casavant <bcasavan@sgi.com>
   7  *
   8  * This file is part of the ELILO, the EFI Linux boot loader.
   9  *
  10  *  GNU EFI is free software; you can redistribute it and/or modify
  11  *  it under the terms of the GNU General Public License as published by
  12  *  the Free Software Foundation; either version 2, or (at your option)
  13  *  any later version.
  14  *
  15  *  GNU EFI is distributed in the hope that it will be useful,
  16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  *  GNU General Public License for more details.
  19  *
  20  *  You should have received a copy of the GNU General Public License
  21  *  along with GNU EFI; see the file COPYING.  If not, write to the Free
  22  *  Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  23  *  02111-1307, USA.
  24  *
  25  * Please check out the elilo.txt for complete documentation on how
  26  * to use this program.
  27  */
  28
  29 #ifndef __ELILO_H__
  30 #define __ELILO_H__
  31
  32 #include <efi.h>
  33
  34 #ifdef CONFIG_ia32
  35 #define PTR_FMT L"0x%x"
  36 #else
  37 #define PTR_FMT L"0x%lx"
  38 #endif
  39
  40 #include "elilo_debug.h"
  41
  42 #include "fileops.h"
  43 #include "chooser.h"
  44
  45 #include "strops.h"
  46
  47 #include "sysdeps.h"
  48
  49 #define MB              (1024*1024) /* 1 megabyte */
  50
  51 /* Round X up/down to A, which must be an integer power of two.  */
  52 #define ROUNDUP(x,a)    (((x) + (a) - 1) & ~((a) - 1))
  53 #define ROUNDDOWN(x,a)  ((x) & ~((a) - 1))
  54
  55 /*
  56  * Elilo Boot modes
  57  */
  58 #define ELILO_LOAD_SUCCESS      0
  59 #define ELILO_LOAD_ABORTED      1
  60 #define ELILO_LOAD_ERROR        2
  61 #define ELILO_LOAD_RETRY        3
  62
  63 #define ELILO_DEFAULT_TIMEOUT   ELILO_TIMEOUT_INFINITY
  64 #define ELILO_TIMEOUT_INFINITY  (~0UL)
  65
  66 #define CMDLINE_MAXLEN          512 /* needed by ia32 */
  67 #define FILENAME_MAXLEN         256
  68 #define MAX_ARGS                256
  69 /* Just pick an arbitrary number that's high enough for now :o) */
  70 #define MAX_DEFAULT_CONFIGS     16
  71
  72 typedef struct {
  73         UINT8 nothing_yet;
  74 } image_opt_t;
  75
  76 typedef struct config_file {
  77         CHAR16 fname[FILENAME_MAXLEN];
  78 } config_file_t;
  79
  80 typedef struct {
  81         /*
  82          * list of options controllable from both the command line
  83          * and the config file
  84          */
  85         UINTN alt_check;        /* always check for alternate kernel */
  86         UINTN debug;            /* debug print() on */
  87         UINTN delay;            /* delay before booting the image */
  88         UINTN verbose;          /* verbosity level [1-5] */
  89         CHAR16 initrd[FILENAME_MAXLEN];         /* name of file for initial ramdisk */
  90         CHAR16 vmcode[FILENAME_MAXLEN]; /* name of file for boot time module*/
  91         UINT8 delay_set;        /* mark whether or not delay was specified on cmdline */
  92         UINT8 edd30_on;         /* true is EDD30 variable is TRUE */
  93         UINT8 edd30_no_force;   /* don't force EDD30 variable to true */
  94         /*
  95          * list of options controllable from either the command line
  96          * or the config file
  97          */
  98         UINTN prompt;           /* enter interactive mode */
  99         UINTN parse_only;       /* only parses the config file */
 100         UINTN timeout;          /* timeout before leaving interactive mode*/
 101
 102         image_opt_t img_opt;    /* architecture independent per image options*/
 103
 104         sys_img_options_t *sys_img_opts;        /* architecture depdendent per image options */
 105
 106         CHAR16 default_kernel[FILENAME_MAXLEN];
 107         /* CHAR16 default_config[FILENAME_MAXLEN]; */
 108         config_file_t default_configs[MAX_DEFAULT_CONFIGS];
 109
 110         CHAR16 config[FILENAME_MAXLEN];         /* name of config file */
 111         CHAR16 chooser[FILENAME_MAXLEN];        /* image chooser to use */
 112 } elilo_config_t;
 113
 114
 115 extern elilo_config_t elilo_opt;
 116
 117 extern EFI_SYSTEM_TABLE *systab;
 118
 119 typedef struct {
 120         VOID    *start_addr;
 121         UINTN   pgcnt;
 122         UINTN   size;
 123 } memdesc_t;
 124
 125 typedef struct {
 126         VOID *kstart;
 127         VOID *kend;
 128         VOID *kentry;
 129 } kdesc_t;
 130
 131 typedef struct {
 132         EFI_MEMORY_DESCRIPTOR   *md;
 133         UINTN                   map_size;
 134         UINTN                   desc_size;
 135         UINTN                   cookie;
 136         UINT32                  desc_version;
 137 } mmap_desc_t;
 138
 139 #ifndef MAX
 140 #define MAX(a,b)        ((a)>(b) ? (a) : (b))
 141 #endif
 142
 143 #ifndef MIN
 144 #define MIN(a,b)        ((a)>(b) ? (b) : (a))
 145 #endif
 146
 147 #define VERB_PRT(n,cmd) \
 148         { if (elilo_opt.verbose >= (n)) { cmd; } }
 149
 150
 151 /* from alloc.c */
 152 extern INTN alloc_init(VOID);
 153 extern VOID *alloc(UINTN, EFI_MEMORY_TYPE);
 154 extern VOID free(VOID *);
 155 extern VOID *alloc_pages(UINTN, EFI_MEMORY_TYPE, EFI_ALLOCATE_TYPE, VOID *);
 156 extern VOID free_pages(VOID *);
 157 extern VOID free_all(VOID);
 158 extern INTN alloc_kmem(VOID *, UINTN);
 159 extern INTN alloc_kmem_anywhere(VOID **, UINTN);
 160 extern VOID free_kmem(VOID);
 161 extern VOID free_all_memory(VOID);
 162
 163 /* from util.c */
 164 extern INTN read_file(UINTN fd, UINTN, CHAR8 *);
 165 extern EFI_STATUS check_abort(VOID);
 166 extern VOID reset_input(VOID);
 167 extern INTN wait_timeout(UINTN);
 168 extern INTN argify(CHAR16 *, UINTN, CHAR16 **);
 169 extern VOID unargify(CHAR16 **, CHAR16 **);
 170 extern void split_args(CHAR16 *, CHAR16 *, CHAR16 *);
 171 extern INTN get_memmap(mmap_desc_t *);
 172 extern VOID free_memmap(mmap_desc_t *);
 173 extern INTN find_kernel_memory(VOID *low_addr, VOID *max_addr, UINTN alignment, VOID ** start);
 174 extern VOID print_memmap(mmap_desc_t *);
 175 extern VOID ascii2U(CHAR8 *, CHAR16 *, UINTN);
 176 extern VOID U2ascii(CHAR16 *, CHAR8 *, UINTN);
 177
 178 /* from config.c (more in config.h) */
 179 extern EFI_STATUS read_config(CHAR16 *);
 180 extern VOID print_config_options(VOID);
 181 extern INTN find_label(CHAR16 *, CHAR16 *, CHAR16 *, CHAR16 *, CHAR16 *);
 182 extern VOID print_label_list(VOID);
 183 extern INTN config_init(VOID);
 184 extern CHAR16 *get_message_filename(INTN which);
 185 extern CHAR16 *find_description(CHAR16 *label);
 186 extern VOID *get_next_description(VOID *prev, CHAR16 **label, CHAR16 **description);
 187 extern CHAR16 *get_config_file(VOID);
 188
 189 /* from initrd.c */
 190 extern INTN load_file(CHAR16 *, memdesc_t *);
 191
 192 /* from alternate.c */
 193 extern INTN alternate_kernel(CHAR16 *, UINTN);
 194
 195 /* from bootparams.c */
 196 extern VOID *create_boot_params (CHAR16 *, memdesc_t *, memdesc_t *, UINTN *);
 197 extern VOID free_boot_params(VOID *bp);
 198
 199 /*
 200  * architecture-specific API
 201  */
 202
 203
 204 extern INTN sysdeps_create_boot_params(boot_params_t *, CHAR8 *, memdesc_t *, memdesc_t *, UINTN *);
 205 extern VOID sysdeps_free_boot_params(boot_params_t *);
 206 extern INTN sysdeps_init(EFI_HANDLE dev);
 207 extern INTN sysdeps_initrd_get_addr(kdesc_t *, memdesc_t *);
 208 extern INTN sysdeps_preloop_actions(EFI_HANDLE, CHAR16 **, INTN, INTN, EFI_HANDLE);
 209 extern CHAR16 *sysdeps_get_cmdline_opts(VOID);
 210 extern INTN sysdeps_getopt(INTN, INTN, CHAR16 *);
 211 extern VOID sysdeps_print_cmdline_opts(VOID);
 212 extern INTN sysdeps_register_options(VOID);
 213
 214 #define CHAR_SLASH      L'/'
 215 #define CHAR_BACKSLASH  L'\\'
 216
 217 #endif /* __ELILO_H__ */