spl.h 18 KB

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