spl.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * (C) Copyright 2012
  4. * Texas Instruments, <www.ti.com>
  5. */
  6. #ifndef _SPL_H_
  7. #define _SPL_H_
  8. #include <binman_sym.h>
  9. /* Platform-specific defines */
  10. #include <linux/compiler.h>
  11. #include <asm/spl.h>
  12. #include <handoff.h>
  13. /* Value in r0 indicates we booted from U-Boot */
  14. #define UBOOT_NOT_LOADED_FROM_SPL 0x13578642
  15. /* Boot type */
  16. #define MMCSD_MODE_UNDEFINED 0
  17. #define MMCSD_MODE_RAW 1
  18. #define MMCSD_MODE_FS 2
  19. #define MMCSD_MODE_EMMCBOOT 3
  20. /*
  21. * u_boot_first_phase() - check if this is the first U-Boot phase
  22. *
  23. * U-Boot has up to three phases: TPL, SPL and U-Boot proper. Depending on the
  24. * build flags we can determine whether the current build is for the first
  25. * phase of U-Boot or not. If there is no SPL, then this is U-Boot proper. If
  26. * there is SPL but no TPL, the the first phase is SPL. If there is TPL, then
  27. * it is the first phase.
  28. *
  29. * @returns true if this is the first phase of U-Boot
  30. *
  31. */
  32. static inline bool u_boot_first_phase(void)
  33. {
  34. if (IS_ENABLED(CONFIG_TPL)) {
  35. if (IS_ENABLED(CONFIG_TPL_BUILD))
  36. return true;
  37. } else if (IS_ENABLED(CONFIG_SPL)) {
  38. if (IS_ENABLED(CONFIG_SPL_BUILD))
  39. return true;
  40. } else {
  41. return true;
  42. }
  43. return false;
  44. }
  45. /* A string name for SPL or TPL */
  46. #ifdef CONFIG_SPL_BUILD
  47. # ifdef CONFIG_TPL_BUILD
  48. # define SPL_TPL_NAME "TPL"
  49. # else
  50. # define SPL_TPL_NAME "SPL"
  51. # endif
  52. # define SPL_TPL_PROMPT SPL_TPL_NAME ": "
  53. #else
  54. # define SPL_TPL_NAME ""
  55. # define SPL_TPL_PROMPT ""
  56. #endif
  57. struct spl_image_info {
  58. const char *name;
  59. u8 os;
  60. uintptr_t load_addr;
  61. uintptr_t entry_point;
  62. #if CONFIG_IS_ENABLED(LOAD_FIT) || CONFIG_IS_ENABLED(LOAD_FIT_FULL)
  63. void *fdt_addr;
  64. #endif
  65. u32 boot_device;
  66. u32 size;
  67. u32 flags;
  68. void *arg;
  69. #ifdef CONFIG_SPL_LEGACY_IMAGE_CRC_CHECK
  70. ulong dcrc_data;
  71. ulong dcrc_length;
  72. ulong dcrc;
  73. #endif
  74. };
  75. /*
  76. * Information required to load data from a device
  77. *
  78. * @dev: Pointer to the device, e.g. struct mmc *
  79. * @priv: Private data for the device
  80. * @bl_len: Block length for reading in bytes
  81. * @filename: Name of the fit image file.
  82. * @read: Function to call to read from the device
  83. */
  84. struct spl_load_info {
  85. void *dev;
  86. void *priv;
  87. int bl_len;
  88. const char *filename;
  89. ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
  90. void *buf);
  91. };
  92. /*
  93. * We need to know the position of U-Boot in memory so we can jump to it. We
  94. * allow any U-Boot binary to be used (u-boot.bin, u-boot-nodtb.bin,
  95. * u-boot.img), hence the '_any'. These is no checking here that the correct
  96. * image is found. For * example if u-boot.img is used we don't check that
  97. * spl_parse_image_header() can parse a valid header.
  98. */
  99. binman_sym_extern(ulong, u_boot_any, image_pos);
  100. /**
  101. * spl_load_simple_fit_skip_processing() - Hook to allow skipping the FIT
  102. * image processing during spl_load_simple_fit().
  103. *
  104. * Return true to skip FIT processing, false to preserve the full code flow
  105. * of spl_load_simple_fit().
  106. */
  107. bool spl_load_simple_fit_skip_processing(void);
  108. /**
  109. * spl_load_simple_fit() - Loads a fit image from a device.
  110. * @spl_image: Image description to set up
  111. * @info: Structure containing the information required to load data.
  112. * @sector: Sector number where FIT image is located in the device
  113. * @fdt: Pointer to the copied FIT header.
  114. *
  115. * Reads the FIT image @sector in the device. Loads u-boot image to
  116. * specified load address and copies the dtb to end of u-boot image.
  117. * Returns 0 on success.
  118. */
  119. int spl_load_simple_fit(struct spl_image_info *spl_image,
  120. struct spl_load_info *info, ulong sector, void *fdt);
  121. #define SPL_COPY_PAYLOAD_ONLY 1
  122. #define SPL_FIT_FOUND 2
  123. /**
  124. * spl_load_imx_container() - Loads a imx container image from a device.
  125. * @spl_image: Image description to set up
  126. * @info: Structure containing the information required to load data.
  127. * @sector: Sector number where container image is located in the device
  128. *
  129. * Reads the container image @sector in the device. Loads u-boot image to
  130. * specified load address.
  131. */
  132. int spl_load_imx_container(struct spl_image_info *spl_image,
  133. struct spl_load_info *info, ulong sector);
  134. /* SPL common functions */
  135. void preloader_console_init(void);
  136. u32 spl_boot_device(void);
  137. u32 spl_boot_mode(const u32 boot_device);
  138. int spl_boot_partition(const u32 boot_device);
  139. void spl_set_bd(void);
  140. /**
  141. * spl_set_header_raw_uboot() - Set up a standard SPL image structure
  142. *
  143. * This sets up the given spl_image which the standard values obtained from
  144. * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START,
  145. * CONFIG_SYS_TEXT_BASE.
  146. *
  147. * @spl_image: Image description to set up
  148. */
  149. void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
  150. /**
  151. * spl_parse_image_header() - parse the image header and set up info
  152. *
  153. * This parses the legacy image header information at @header and sets up
  154. * @spl_image according to what is found. If no image header is found, then
  155. * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is
  156. * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not
  157. * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
  158. * spl_set_header_raw_uboot(), or possibly the bootz header.
  159. *
  160. * @spl_image: Image description to set up
  161. * @header image header to parse
  162. * @return 0 if a header was correctly parsed, -ve on error
  163. */
  164. int spl_parse_image_header(struct spl_image_info *spl_image,
  165. const struct image_header *header);
  166. void spl_board_prepare_for_linux(void);
  167. void spl_board_prepare_for_boot(void);
  168. int spl_board_ubi_load_image(u32 boot_device);
  169. /**
  170. * jump_to_image_linux() - Jump to a Linux kernel from SPL
  171. *
  172. * This jumps into a Linux kernel using the information in @spl_image.
  173. *
  174. * @spl_image: Image description to set up
  175. */
  176. void __noreturn jump_to_image_linux(struct spl_image_info *spl_image);
  177. /**
  178. * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
  179. *
  180. * This is called by the various SPL loaders to determine whether the board
  181. * wants to load the kernel or U-Boot. This function should be provided by
  182. * the board.
  183. *
  184. * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
  185. */
  186. int spl_start_uboot(void);
  187. /**
  188. * spl_display_print() - Display a board-specific message in SPL
  189. *
  190. * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
  191. * immediately after displaying the SPL console banner ("U-Boot SPL ...").
  192. * This function should be provided by the board.
  193. */
  194. void spl_display_print(void);
  195. /**
  196. * struct spl_boot_device - Describes a boot device used by SPL
  197. *
  198. * @boot_device: A number indicating the BOOT_DEVICE type. There are various
  199. * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
  200. * numbered.
  201. * @boot_device_name: Named boot device, or NULL if none.
  202. *
  203. * Note: Additional fields can be added here, bearing in mind that SPL is
  204. * size-sensitive and common fields will be present on all boards. This
  205. * struct can also be used to return additional information about the load
  206. * process if that becomes useful.
  207. */
  208. struct spl_boot_device {
  209. uint boot_device;
  210. const char *boot_device_name;
  211. };
  212. /**
  213. * Holds information about a way of loading an SPL image
  214. *
  215. * @name: User-friendly name for this method (e.g. "MMC")
  216. * @boot_device: Boot device that this loader supports
  217. * @load_image: Function to call to load image
  218. */
  219. struct spl_image_loader {
  220. #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
  221. const char *name;
  222. #endif
  223. uint boot_device;
  224. /**
  225. * load_image() - Load an SPL image
  226. *
  227. * @spl_image: place to put image information
  228. * @bootdev: describes the boot device to load from
  229. */
  230. int (*load_image)(struct spl_image_info *spl_image,
  231. struct spl_boot_device *bootdev);
  232. };
  233. /* Declare an SPL image loader */
  234. #define SPL_LOAD_IMAGE(__name) \
  235. ll_entry_declare(struct spl_image_loader, __name, spl_image_loader)
  236. /*
  237. * _priority is the priority of this method, 0 meaning it will be the top
  238. * choice for this device, 9 meaning it is the bottom choice.
  239. * _boot_device is the BOOT_DEVICE_... value
  240. * _method is the load_image function to call
  241. */
  242. #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
  243. #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
  244. SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \
  245. .name = _name, \
  246. .boot_device = _boot_device, \
  247. .load_image = _method, \
  248. }
  249. #else
  250. #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
  251. SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \
  252. .boot_device = _boot_device, \
  253. .load_image = _method, \
  254. }
  255. #endif
  256. /* SPL FAT image functions */
  257. int spl_load_image_fat(struct spl_image_info *spl_image,
  258. struct blk_desc *block_dev, int partition,
  259. const char *filename);
  260. int spl_load_image_fat_os(struct spl_image_info *spl_image,
  261. struct blk_desc *block_dev, int partition);
  262. void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
  263. /* SPL EXT image functions */
  264. int spl_load_image_ext(struct spl_image_info *spl_image,
  265. struct blk_desc *block_dev, int partition,
  266. const char *filename);
  267. int spl_load_image_ext_os(struct spl_image_info *spl_image,
  268. struct blk_desc *block_dev, int partition);
  269. /**
  270. * spl_early_init() - Set up device tree and driver model in SPL if enabled
  271. *
  272. * Call this function in board_init_f() if you want to use device tree and
  273. * driver model early, before board_init_r() is called.
  274. *
  275. * If this is not called, then driver model will be inactive in SPL's
  276. * board_init_f(), and no device tree will be available.
  277. */
  278. int spl_early_init(void);
  279. /**
  280. * spl_init() - Set up device tree and driver model in SPL if enabled
  281. *
  282. * You can optionally call spl_early_init(), then optionally call spl_init().
  283. * This function will be called from board_init_r() if not called earlier.
  284. *
  285. * Both spl_early_init() and spl_init() perform a similar function except that
  286. * the latter will not set up the malloc() area if
  287. * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to
  288. * already be done by a calll to spl_relocate_stack_gd() before board_init_r()
  289. * is reached.
  290. *
  291. * This function will be called from board_init_r() if not called earlier.
  292. *
  293. * If this is not called, then driver model will be inactive in SPL's
  294. * board_init_f(), and no device tree will be available.
  295. */
  296. int spl_init(void);
  297. #ifdef CONFIG_SPL_BOARD_INIT
  298. void spl_board_init(void);
  299. #endif
  300. /**
  301. * spl_was_boot_source() - check if U-Boot booted from SPL
  302. *
  303. * This will normally be true, but if U-Boot jumps to second U-Boot, it will
  304. * be false. This should be implemented by board-specific code.
  305. *
  306. * @return true if U-Boot booted from SPL, else false
  307. */
  308. bool spl_was_boot_source(void);
  309. /**
  310. * spl_dfu_cmd- run dfu command with chosen mmc device interface
  311. * @param usb_index - usb controller number
  312. * @param mmc_dev - mmc device nubmer
  313. *
  314. * @return 0 on success, otherwise error code
  315. */
  316. int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
  317. int spl_mmc_load_image(struct spl_image_info *spl_image,
  318. struct spl_boot_device *bootdev);
  319. /**
  320. * spl_mmc_load() - Load an image file from MMC/SD media
  321. *
  322. * @param spl_image Image data filled in by loading process
  323. * @param bootdev Describes which device to load from
  324. * @param filename Name of file to load (in FS mode)
  325. * @param raw_part Partition to load from (in RAW mode)
  326. * @param raw_sect Sector to load from (in RAW mode)
  327. *
  328. * @return 0 on success, otherwise error code
  329. */
  330. int spl_mmc_load(struct spl_image_info *spl_image,
  331. struct spl_boot_device *bootdev,
  332. const char *filename,
  333. int raw_part,
  334. unsigned long raw_sect);
  335. /**
  336. * spl_invoke_atf - boot using an ARM trusted firmware image
  337. */
  338. void spl_invoke_atf(struct spl_image_info *spl_image);
  339. /**
  340. * spl_optee_entry - entry function for optee
  341. *
  342. * args defind in op-tee project
  343. * https://github.com/OP-TEE/optee_os/
  344. * core/arch/arm/kernel/generic_entry_a32.S
  345. * @arg0: pagestore
  346. * @arg1: (ARMv7 standard bootarg #1)
  347. * @arg2: device tree address, (ARMv7 standard bootarg #2)
  348. * @arg3: non-secure entry address (ARMv7 bootarg #0)
  349. */
  350. void spl_optee_entry(void *arg0, void *arg1, void *arg2, void *arg3);
  351. /**
  352. * spl_invoke_opensbi - boot using a RISC-V OpenSBI image
  353. */
  354. void spl_invoke_opensbi(struct spl_image_info *spl_image);
  355. /**
  356. * board_return_to_bootrom - allow for boards to continue with the boot ROM
  357. *
  358. * If a board (e.g. the Rockchip RK3368 boards) provide some
  359. * supporting functionality for SPL in their boot ROM and the SPL
  360. * stage wants to return to the ROM code to continue booting, boards
  361. * can implement 'board_return_to_bootrom'.
  362. */
  363. int board_return_to_bootrom(struct spl_image_info *spl_image,
  364. struct spl_boot_device *bootdev);
  365. /**
  366. * board_spl_fit_post_load - allow process images after loading finished
  367. *
  368. */
  369. void board_spl_fit_post_load(ulong load_addr, size_t length);
  370. /**
  371. * board_spl_fit_size_align - specific size align before processing payload
  372. *
  373. */
  374. ulong board_spl_fit_size_align(ulong size);
  375. /**
  376. * spl_perform_fixups() - arch/board-specific callback before processing
  377. * the boot-payload
  378. */
  379. void spl_perform_fixups(struct spl_image_info *spl_image);
  380. /*
  381. * spl_get_load_buffer() - get buffer for loading partial image data
  382. *
  383. * Returns memory area which can be populated by partial image data,
  384. * ie. uImage or fitImage header.
  385. */
  386. struct image_header *spl_get_load_buffer(ssize_t offset, size_t size);
  387. #endif