xref: /openbmc/u-boot/include/bootm.h (revision 1bad5e14)
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 <command.h>
11 #include <image.h>
12 
13 #define BOOTM_ERR_RESET		(-1)
14 #define BOOTM_ERR_OVERLAP		(-2)
15 #define BOOTM_ERR_UNIMPLEMENTED	(-3)
16 
17 /*
18  *  Continue booting an OS image; caller already has:
19  *  - copied image header to global variable `header'
20  *  - checked header magic number, checksums (both header & image),
21  *  - verified image architecture (PPC) and type (KERNEL or MULTI),
22  *  - loaded (first part of) image to header load address,
23  *  - disabled interrupts.
24  *
25  * @flag: Flags indicating what to do (BOOTM_STATE_...)
26  * @argc: Number of arguments. Note that the arguments are shifted down
27  *	 so that 0 is the first argument not processed by U-Boot, and
28  *	 argc is adjusted accordingly. This avoids confusion as to how
29  *	 many arguments are available for the OS.
30  * @images: Pointers to os/initrd/fdt
31  * @return 1 on error. On success the OS boots so this function does
32  * not return.
33  */
34 typedef int boot_os_fn(int flag, int argc, char * const argv[],
35 			bootm_headers_t *images);
36 
37 extern boot_os_fn do_bootm_linux;
38 int do_bootelf(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
39 void lynxkdi_boot(image_header_t *hdr);
40 
41 boot_os_fn *bootm_os_get_boot_func(int os);
42 
43 int bootm_host_load_images(const void *fit, int cfg_noffset);
44 
45 int boot_selected_os(int argc, char * const argv[], int state,
46 		     bootm_headers_t *images, boot_os_fn *boot_fn);
47 
48 ulong bootm_disable_interrupts(void);
49 
50 /* This is a special function used by booti/bootz */
51 int bootm_find_images(int flag, int argc, char * const argv[]);
52 
53 int do_bootm_states(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
54 		    int states, bootm_headers_t *images, int boot_progress);
55 
56 void arch_preboot_os(void);
57 
58 /**
59  * bootm_decomp_image() - decompress the operating system
60  *
61  * @comp:	Compression algorithm that is used (IH_COMP_...)
62  * @load:	Destination load address in U-Boot memory
63  * @image_start Image start address (where we are decompressing from)
64  * @type:	OS type (IH_OS_...)
65  * @load_bug:	Place to decompress to
66  * @image_buf:	Address to decompress from
67  * @image_len:	Number of bytes in @image_buf to decompress
68  * @unc_len:	Available space for decompression
69  * @return 0 if OK, -ve on error (BOOTM_ERR_...)
70  */
71 int bootm_decomp_image(int comp, ulong load, ulong image_start, int type,
72 		       void *load_buf, void *image_buf, ulong image_len,
73 		       uint unc_len, ulong *load_end);
74 
75 /*
76  * boards should define this to disable devices when EFI exits from boot
77  * services.
78  *
79  * TODO(sjg@chromium.org>): Update this to use driver model's device_remove().
80  */
81 void board_quiesce_devices(void);
82 
83 #endif
84