spl.h 14 KB

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