spl.h 22 KB

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