include/bootm.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * (C) Copyright 2000-2009
   4  * Wolfgang Denk, DENX Software Engineering, [email protected].
   5  */
   6
   7 #ifndef _BOOTM_H
   8 #define _BOOTM_H
   9
  10 #include <image.h>
  11
  12 struct boot_params;
  13 struct cmd_tbl;
  14
  15 #define BOOTM_ERR_RESET         (-1)
  16 #define BOOTM_ERR_OVERLAP               (-2)
  17 #define BOOTM_ERR_UNIMPLEMENTED (-3)
  18
  19 /*
  20  *  Continue booting an OS image; caller already has:
  21  *  - copied image header to global variable `header'
  22  *  - checked header magic number, checksums (both header & image),
  23  *  - verified image architecture (PPC) and type (KERNEL or MULTI),
  24  *  - loaded (first part of) image to header load address,
  25  *  - disabled interrupts.
  26  *
  27  * @flag: Flags indicating what to do (BOOTM_STATE_...)
  28  * @argc: Number of arguments. Note that the arguments are shifted down
  29  *       so that 0 is the first argument not processed by U-Boot, and
  30  *       argc is adjusted accordingly. This avoids confusion as to how
  31  *       many arguments are available for the OS.
  32  * @images: Pointers to os/initrd/fdt
  33  * Return: 1 on error. On success the OS boots so this function does
  34  * not return.
  35  */
  36 typedef int boot_os_fn(int flag, int argc, char *const argv[],
  37                         struct bootm_headers *images);
  38
  39 extern boot_os_fn do_bootm_linux;
  40 extern boot_os_fn do_bootm_vxworks;
  41
  42 int do_bootelf(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[]);
  43
  44 boot_os_fn *bootm_os_get_boot_func(int os);
  45
  46 #if defined(CONFIG_FIT_SIGNATURE)
  47 int bootm_host_load_images(const void *fit, int cfg_noffset);
  48 #endif
  49
  50 int boot_selected_os(int argc, char *const argv[], int state,
  51                      struct bootm_headers *images, boot_os_fn *boot_fn);
  52
  53 ulong bootm_disable_interrupts(void);
  54
  55 /* This is a special function used by booti/bootz */
  56 int bootm_find_images(int flag, int argc, char *const argv[], ulong start,
  57                       ulong size);
  58
  59 /*
  60  * Measure the boot images. Measurement is the process of hashing some binary
  61  * data and storing it into secure memory, i.e. TPM PCRs. In addition, each
  62  * measurement is logged into the platform event log such that the operating
  63  * system can access it and perform attestation of the boot.
  64  *
  65  * @images:     The structure containing the various images to boot (linux,
  66  *              initrd, dts, etc.)
  67  */
  68 int bootm_measure(struct bootm_headers *images);
  69
  70 int do_bootm_states(struct cmd_tbl *cmdtp, int flag, int argc,
  71                     char *const argv[], int states, struct bootm_headers *images,
  72                     int boot_progress);
  73
  74 void arch_preboot_os(void);
  75
  76 /*
  77  * boards should define this to disable devices when EFI exits from boot
  78  * services.
  79  *
  80  * TODO([email protected]>): Update this to use driver model's device_remove().
  81  */
  82 void board_quiesce_devices(void);
  83
  84 /**
  85  * switch_to_non_secure_mode() - switch to non-secure mode
  86  */
  87 void switch_to_non_secure_mode(void);
  88
  89 /* Flags to control bootm_process_cmdline() */
  90 enum bootm_cmdline_t {
  91         BOOTM_CL_SILENT = 1 << 0,       /* Do silent console processing */
  92         BOOTM_CL_SUBST  = 1 << 1,       /* Do substitution */
  93
  94         BOOTM_CL_ALL    = 3,            /* All substitutions */
  95 };
  96
  97 /**
  98  * arch_preboot_os() - arch specific configuration before booting
  99  */
 100 void arch_preboot_os(void);
 101
 102 /**
 103  * board_preboot_os() - board specific configuration before booting
 104  */
 105 void board_preboot_os(void);
 106
 107 /*
 108  * bootm_process_cmdline() - Process fix-ups for the command line
 109  *
 110  * This handles:
 111  *
 112  *  - making Linux boot silently if requested ('silent_linux' envvar)
 113  *  - performing substitutions in the command line ('bootargs_subst' envvar)
 114  *
 115  * @maxlen must provide enough space for the string being processed plus the
 116  * resulting string
 117  *
 118  * @buf: buffer holding commandline string to adjust
 119  * @maxlen: Maximum length of buffer at @buf (including \0)
 120  * @flags: Flags to control what happens (see bootm_cmdline_t)
 121  * Return: 0 if OK, -ENOMEM if out of memory, -ENOSPC if the commandline is too
 122  *      long
 123  */
 124 int bootm_process_cmdline(char *buf, int maxlen, int flags);
 125
 126 /**
 127  * bootm_process_cmdline_env() - Process fix-ups for the command line
 128  *
 129  * Updates the 'bootargs' envvar as required. This handles:
 130  *
 131  *  - making Linux boot silently if requested ('silent_linux' envvar)
 132  *  - performing substitutions in the command line ('bootargs_subst' envvar)
 133  *
 134  * @flags: Flags to control what happens (see bootm_cmdline_t)
 135  * Return: 0 if OK, -ENOMEM if out of memory
 136  */
 137 int bootm_process_cmdline_env(int flags);
 138
 139 /**
 140  * zboot_run() - Run through the various steps to boot a zimage
 141  *
 142  * Boot a zimage, given the component parts
 143  *
 144  * @addr: Address where the bzImage is moved before booting, either
 145  *      BZIMAGE_LOAD_ADDR or ZIMAGE_LOAD_ADDR
 146  * @base: Pointer to the boot parameters, typically at address
 147  *      DEFAULT_SETUP_BASE
 148  * @initrd: Address of the initial ramdisk, or 0 if none
 149  * @initrd_size: Size of the initial ramdisk, or 0 if none
 150  * @cmdline: Command line to use for booting
 151  * Return: -EFAULT on error (normally it does not return)
 152  */
 153 int zboot_run(ulong addr, ulong size, ulong initrd, ulong initrd_size,
 154               ulong base, char *cmdline);
 155
 156 /*
 157  * zimage_get_kernel_version() - Get the version string from a kernel
 158  *
 159  * @params: boot_params pointer
 160  * @kernel_base: base address of kernel
 161  * Return: Kernel version as a NUL-terminated string
 162  */
 163 const char *zimage_get_kernel_version(struct boot_params *params,
 164                                       void *kernel_base);
 165
 166 /**
 167  * zimage_dump() - Dump the metadata of a zimage
 168  *
 169  * This shows all available information in a zimage that has been loaded.
 170  *
 171  * @base_ptr: Pointer to the boot parameters, typically at address
 172  *      DEFAULT_SETUP_BASE
 173  * @show_cmdline: true to show the full command line
 174  */
 175 void zimage_dump(struct boot_params *base_ptr, bool show_cmdline);
 176
 177 /*
 178  * bootm_boot_start() - Boot an image at the given address
 179  *
 180  * @addr: Image address
 181  * @cmdline: Command line to set
 182  */
 183 int bootm_boot_start(ulong addr, const char *cmdline);
 184
 185 #endif