spl.h 18 KB

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