spl.h 17 KB

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