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 #include "elilo_debug.h"
  35
  36 #include "fileops.h"
  37 #include "chooser.h"
  38
  39 #include "strops.h"
  40
  41 #include "sysdeps.h"
  42
  43 #define MB              (1024*1024) /* 1 megabyte */
  44
  45 /* Round X up/down to A, which must be an integer power of two.  */
  46 #define ROUNDUP(x,a)    (((x) + (a) - 1) & ~((a) - 1))
  47 #define ROUNDDOWN(x,a)  ((x) & ~((a) - 1))
  48
  49 /*
  50  * Elilo Boot modes
  51  */
  52 #define ELILO_LOAD_SUCCESS      0
  53 #define ELILO_LOAD_ABORTED      1
  54 #define ELILO_LOAD_ERROR        2
  55 #define ELILO_LOAD_RETRY        3
  56
  57 #define ELILO_DEFAULT_TIMEOUT   ELILO_TIMEOUT_INFINITY
  58 #define ELILO_TIMEOUT_INFINITY  (~0UL)
  59
  60 #define CMDLINE_MAXLEN          512 /* needed by ia32 */
  61 #define FILENAME_MAXLEN         256
  62 #define MAX_ARGS                256
  63 /* Just pick an arbitrary number that's high enough for now :o) */
  64 #define MAX_DEFAULT_CONFIGS     16
  65
  66 typedef struct {
  67         UINT8 nothing_yet;
  68 } image_opt_t;
  69
  70 typedef struct config_file {
  71         CHAR16 fname[FILENAME_MAXLEN];
  72 } config_file_t;
  73
  74 typedef struct {
  75         /*
  76          * list of options controllable from both the command line
  77          * and the config file
  78          */
  79         UINTN alt_check;        /* always check for alternate kernel */
  80         UINTN debug;            /* debug print() on */
  81         UINTN delay;            /* delay before booting the image */
  82         UINTN verbose;          /* verbosity level [1-5] */
  83         CHAR16 initrd[FILENAME_MAXLEN];         /* name of file for initial ramdisk */
  84         CHAR16 vmcode[FILENAME_MAXLEN]; /* name of file for boot time module*/
  85         UINT8 delay_set;        /* mark whether or not delay was specified on cmdline */
  86         UINT8 edd30_on;         /* true is EDD30 variable is TRUE */
  87         UINT8 edd30_no_force;   /* don't force EDD30 variable to true */
  88         /*
  89          * list of options controllable from either the command line
  90          * or the config file
  91          */
  92         UINTN prompt;           /* enter interactive mode */
  93         UINTN parse_only;       /* only parses the config file */
  94         UINTN timeout;          /* timeout before leaving interactive mode*/
  95
  96         image_opt_t img_opt;    /* architecture independent per image options*/
  97
  98         sys_img_options_t *sys_img_opts;        /* architecture depdendent per image options */
  99
 100         CHAR16 default_kernel[FILENAME_MAXLEN];
 101         /* CHAR16 default_config[FILENAME_MAXLEN]; */
 102         config_file_t default_configs[MAX_DEFAULT_CONFIGS];
 103
 104         CHAR16 config[FILENAME_MAXLEN];         /* name of config file */
 105         CHAR16 chooser[FILENAME_MAXLEN];        /* image chooser to use */
 106 } elilo_config_t;
 107
 108
 109 extern elilo_config_t elilo_opt;
 110
 111 extern EFI_SYSTEM_TABLE *systab;
 112
 113 typedef struct {
 114         VOID    *start_addr;
 115         UINTN   pgcnt;
 116         UINTN   size;
 117 } memdesc_t;
 118
 119 typedef struct {
 120         VOID *kstart;
 121         VOID *kend;
 122         VOID *kentry;
 123 } kdesc_t;
 124
 125 typedef struct {
 126         EFI_MEMORY_DESCRIPTOR   *md;
 127         UINTN                   map_size;
 128         UINTN                   desc_size;
 129         UINTN                   cookie;
 130         UINT32                  desc_version;
 131 } mmap_desc_t;
 132
 133 #ifndef MAX
 134 #define MAX(a,b)        ((a)>(b) ? (a) : (b))
 135 #endif
 136
 137 #ifndef MIN
 138 #define MIN(a,b)        ((a)>(b) ? (b) : (a))
 139 #endif
 140
 141 #define VERB_PRT(n,cmd) \
 142         { if (elilo_opt.verbose >= (n)) { cmd; } }
 143
 144
 145 /* from alloc.c */
 146 extern INTN alloc_init(VOID);
 147 extern VOID *alloc(UINTN, EFI_MEMORY_TYPE);
 148 extern VOID free(VOID *);
 149 extern VOID *alloc_pages(UINTN, EFI_MEMORY_TYPE, EFI_ALLOCATE_TYPE, VOID *);
 150 extern VOID free_pages(VOID *);
 151 extern VOID free_all(VOID);
 152 extern INTN alloc_kmem(VOID *, UINTN);
 153 extern VOID free_kmem(VOID);
 154 extern VOID free_all_memory(VOID);
 155
 156 /* from util.c */
 157 extern INTN read_file(UINTN fd, UINTN, CHAR8 *);
 158 extern EFI_STATUS check_abort(VOID);
 159 extern VOID reset_input(VOID);
 160 extern INTN wait_timeout(UINTN);
 161 extern INTN argify(CHAR16 *, UINTN, CHAR16 **);
 162 extern VOID unargify(CHAR16 **, CHAR16 **);
 163 extern void split_args(CHAR16 *, CHAR16 *, CHAR16 *);
 164 extern INTN get_memmap(mmap_desc_t *);
 165 extern VOID free_memmap(mmap_desc_t *);
 166 extern INTN find_kernel_memory(VOID *low_addr, VOID *max_addr, UINTN alignment, VOID ** start);
 167 extern VOID print_memmap(mmap_desc_t *);
 168 extern VOID ascii2U(CHAR8 *, CHAR16 *, UINTN);
 169 extern VOID U2ascii(CHAR16 *, CHAR8 *, UINTN);
 170
 171 /* from config.c (more in config.h) */
 172 extern EFI_STATUS read_config(CHAR16 *);
 173 extern VOID print_config_options(VOID);
 174 extern INTN find_label(CHAR16 *, CHAR16 *, CHAR16 *, CHAR16 *, CHAR16 *);
 175 extern VOID print_label_list(VOID);
 176 extern INTN config_init(VOID);
 177 extern CHAR16 *get_message_filename(INTN which);
 178 extern CHAR16 *find_description(CHAR16 *label);
 179 extern VOID *get_next_description(VOID *prev, CHAR16 **label, CHAR16 **description);
 180 extern CHAR16 *get_config_file(VOID);
 181
 182 /* from initrd.c */
 183 extern INTN load_file(CHAR16 *, memdesc_t *);
 184
 185 /* from alternate.c */
 186 extern INTN alternate_kernel(CHAR16 *, INTN);
 187
 188 /* from bootparams.c */
 189 extern VOID *create_boot_params (CHAR16 *, memdesc_t *, memdesc_t *, UINTN *);
 190 extern VOID free_boot_params(VOID *bp);
 191
 192 /*
 193  * architecture-specific API
 194  */
 195
 196
 197 extern INTN sysdeps_create_boot_params(boot_params_t *, CHAR8 *, memdesc_t *, memdesc_t *, UINTN *);
 198 extern VOID sysdeps_free_boot_params(boot_params_t *);
 199 extern INTN sysdeps_init(EFI_HANDLE dev);
 200 extern INTN sysdeps_initrd_get_addr(kdesc_t *, memdesc_t *);
 201 extern INTN sysdeps_preloop_actions(EFI_HANDLE, CHAR16 **, INTN, INTN, EFI_HANDLE);
 202 extern CHAR16 *sysdeps_get_cmdline_opts(VOID);
 203 extern INTN sysdeps_getopt(INTN, INTN, CHAR16 *);
 204 extern VOID sysdeps_print_cmdline_opts(VOID);
 205 extern INTN sysdeps_register_options(VOID);
 206
 207 #define CHAR_SLASH      L'/'
 208 #define CHAR_BACKSLASH  L'\\'
 209
 210 #endif /* __ELILO_H__ */