spl.h 24 KB

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