include/bootm.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * (C) Copyright 2000-2009
   4  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   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 /**
  56  * bootm_find_images() - find and locate various images
  57  *
  58  * @img_addr: Address of image being loaded
  59  * @conf_ramdisk: Indicates the ramdisk to use (typically second arg of bootm)
  60  * @conf_fdt: Indicates the FDT to use (typically third arg of bootm)
  61  * @start: OS image start address
  62  * @size: OS image size
  63  *
  64  * boot_find_images() will attempt to load an available ramdisk,
  65  * flattened device tree, as well as specifically marked
  66  * "loadable" images (loadables are FIT only)
  67  *
  68  * Note: bootm_find_images will skip an image if it is not found
  69  *
  70  * This is a special function used by booti/bootz
  71  *
  72  * Return:
  73  *     0, if all existing images were loaded correctly
  74  *     1, if an image is found but corrupted, or invalid
  75  */
  76 int bootm_find_images(ulong img_addr, const char *conf_ramdisk,
  77                       const char *conf_fdt, ulong start, ulong size);
  78
  79 /*
  80  * Measure the boot images. Measurement is the process of hashing some binary
  81  * data and storing it into secure memory, i.e. TPM PCRs. In addition, each
  82  * measurement is logged into the platform event log such that the operating
  83  * system can access it and perform attestation of the boot.
  84  *
  85  * @images:     The structure containing the various images to boot (linux,
  86  *              initrd, dts, etc.)
  87  */
  88 int bootm_measure(struct bootm_headers *images);
  89
  90 int do_bootm_states(struct cmd_tbl *cmdtp, int flag, int argc,
  91                     char *const argv[], int states, struct bootm_headers *images,
  92                     int boot_progress);
  93
  94 void arch_preboot_os(void);
  95
  96 /*
  97  * boards should define this to disable devices when EFI exits from boot
  98  * services.
  99  *
 100  * TODO(sjg@chromium.org>): Update this to use driver model's device_remove().
 101  */
 102 void board_quiesce_devices(void);
 103
 104 /**
 105  * switch_to_non_secure_mode() - switch to non-secure mode
 106  */
 107 void switch_to_non_secure_mode(void);
 108
 109 /* Flags to control bootm_process_cmdline() */
 110 enum bootm_cmdline_t {
 111         BOOTM_CL_SILENT = 1 << 0,       /* Do silent console processing */
 112         BOOTM_CL_SUBST  = 1 << 1,       /* Do substitution */
 113
 114         BOOTM_CL_ALL    = 3,            /* All substitutions */
 115 };
 116
 117 /**
 118  * arch_preboot_os() - arch specific configuration before booting
 119  */
 120 void arch_preboot_os(void);
 121
 122 /**
 123  * board_preboot_os() - board specific configuration before booting
 124  */
 125 void board_preboot_os(void);
 126
 127 /*
 128  * bootm_process_cmdline() - Process fix-ups for the command line
 129  *
 130  * This handles:
 131  *
 132  *  - making Linux boot silently if requested ('silent_linux' envvar)
 133  *  - performing substitutions in the command line ('bootargs_subst' envvar)
 134  *
 135  * @maxlen must provide enough space for the string being processed plus the
 136  * resulting string
 137  *
 138  * @buf: buffer holding commandline string to adjust
 139  * @maxlen: Maximum length of buffer at @buf (including \0)
 140  * @flags: Flags to control what happens (see bootm_cmdline_t)
 141  * Return: 0 if OK, -ENOMEM if out of memory, -ENOSPC if the commandline is too
 142  *      long
 143  */
 144 int bootm_process_cmdline(char *buf, int maxlen, int flags);
 145
 146 /**
 147  * bootm_process_cmdline_env() - Process fix-ups for the command line
 148  *
 149  * Updates the 'bootargs' envvar as required. This handles:
 150  *
 151  *  - making Linux boot silently if requested ('silent_linux' envvar)
 152  *  - performing substitutions in the command line ('bootargs_subst' envvar)
 153  *
 154  * @flags: Flags to control what happens (see bootm_cmdline_t)
 155  * Return: 0 if OK, -ENOMEM if out of memory
 156  */
 157 int bootm_process_cmdline_env(int flags);
 158
 159 /**
 160  * zboot_start() - Boot a zimage
 161  *
 162  * Boot a zimage, given the component parts
 163  *
 164  * @addr: Address where the bzImage is moved before booting, either
 165  *      BZIMAGE_LOAD_ADDR or ZIMAGE_LOAD_ADDR
 166  * @base: Pointer to the boot parameters, typically at address
 167  *      DEFAULT_SETUP_BASE
 168  * @initrd: Address of the initial ramdisk, or 0 if none
 169  * @initrd_size: Size of the initial ramdisk, or 0 if none
 170  * @cmdline: Command line to use for booting
 171  * Return: -EFAULT on error (normally it does not return)
 172  */
 173 int zboot_start(ulong addr, ulong size, ulong initrd, ulong initrd_size,
 174                 ulong base, char *cmdline);
 175
 176 /*
 177  * zimage_get_kernel_version() - Get the version string from a kernel
 178  *
 179  * @params: boot_params pointer
 180  * @kernel_base: base address of kernel
 181  * Return: Kernel version as a NUL-terminated string
 182  */
 183 const char *zimage_get_kernel_version(struct boot_params *params,
 184                                       void *kernel_base);
 185
 186 /**
 187  * zimage_dump() - Dump the metadata of a zimage
 188  *
 189  * This shows all available information in a zimage that has been loaded.
 190  *
 191  * @base_ptr: Pointer to the boot parameters, typically at address
 192  *      DEFAULT_SETUP_BASE
 193  * @show_cmdline: true to show the full command line
 194  */
 195 void zimage_dump(struct boot_params *base_ptr, bool show_cmdline);
 196
 197 /*
 198  * bootm_boot_start() - Boot an image at the given address
 199  *
 200  * @addr: Image address
 201  * @cmdline: Command line to set
 202  */
 203 int bootm_boot_start(ulong addr, const char *cmdline);
 204
 205 #endif