spl.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328
  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/spl.h>
  12. /* Value in r0 indicates we booted from U-Boot */
  13. #define UBOOT_NOT_LOADED_FROM_SPL 0x13578642
  14. /* Boot type */
  15. #define MMCSD_MODE_UNDEFINED 0
  16. #define MMCSD_MODE_RAW 1
  17. #define MMCSD_MODE_FS 2
  18. #define MMCSD_MODE_EMMCBOOT 3
  19. struct spl_image_info {
  20. const char *name;
  21. u8 os;
  22. uintptr_t load_addr;
  23. uintptr_t entry_point;
  24. #if CONFIG_IS_ENABLED(LOAD_FIT)
  25. void *fdt_addr;
  26. #endif
  27. u32 boot_device;
  28. u32 size;
  29. u32 flags;
  30. void *arg;
  31. };
  32. /*
  33. * Information required to load data from a device
  34. *
  35. * @dev: Pointer to the device, e.g. struct mmc *
  36. * @priv: Private data for the device
  37. * @bl_len: Block length for reading in bytes
  38. * @filename: Name of the fit image file.
  39. * @read: Function to call to read from the device
  40. */
  41. struct spl_load_info {
  42. void *dev;
  43. void *priv;
  44. int bl_len;
  45. const char *filename;
  46. ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
  47. void *buf);
  48. };
  49. /*
  50. * We need to know the position of U-Boot in memory so we can jump to it. We
  51. * allow any U-Boot binary to be used (u-boot.bin, u-boot-nodtb.bin,
  52. * u-boot.img), hence the '_any'. These is no checking here that the correct
  53. * image is found. For * example if u-boot.img is used we don't check that
  54. * spl_parse_image_header() can parse a valid header.
  55. */
  56. binman_sym_extern(ulong, u_boot_any, image_pos);
  57. /**
  58. * spl_load_simple_fit() - Loads a fit image from a device.
  59. * @spl_image: Image description to set up
  60. * @info: Structure containing the information required to load data.
  61. * @sector: Sector number where FIT image is located in the device
  62. * @fdt: Pointer to the copied FIT header.
  63. *
  64. * Reads the FIT image @sector in the device. Loads u-boot image to
  65. * specified load address and copies the dtb to end of u-boot image.
  66. * Returns 0 on success.
  67. */
  68. int spl_load_simple_fit(struct spl_image_info *spl_image,
  69. struct spl_load_info *info, ulong sector, void *fdt);
  70. #define SPL_COPY_PAYLOAD_ONLY 1
  71. /* SPL common functions */
  72. void preloader_console_init(void);
  73. u32 spl_boot_device(void);
  74. u32 spl_boot_mode(const u32 boot_device);
  75. int spl_boot_partition(const u32 boot_device);
  76. void spl_set_bd(void);
  77. /**
  78. * spl_set_header_raw_uboot() - Set up a standard SPL image structure
  79. *
  80. * This sets up the given spl_image which the standard values obtained from
  81. * config options: CONFIG_SYS_MONITOR_LEN, CONFIG_SYS_UBOOT_START,
  82. * CONFIG_SYS_TEXT_BASE.
  83. *
  84. * @spl_image: Image description to set up
  85. */
  86. void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
  87. /**
  88. * spl_parse_image_header() - parse the image header and set up info
  89. *
  90. * This parses the legacy image header information at @header and sets up
  91. * @spl_image according to what is found. If no image header is found, then
  92. * a raw image or bootz is assumed. If CONFIG_SPL_PANIC_ON_RAW_IMAGE is
  93. * enabled, then this causes a panic. If CONFIG_SPL_RAW_IMAGE_SUPPORT is not
  94. * enabled then U-Boot gives up. Otherwise U-Boot sets up the image using
  95. * spl_set_header_raw_uboot(), or possibly the bootz header.
  96. *
  97. * @spl_image: Image description to set up
  98. * @header image header to parse
  99. * @return 0 if a header was correctly parsed, -ve on error
  100. */
  101. int spl_parse_image_header(struct spl_image_info *spl_image,
  102. const struct image_header *header);
  103. void spl_board_prepare_for_linux(void);
  104. void spl_board_prepare_for_boot(void);
  105. int spl_board_ubi_load_image(u32 boot_device);
  106. /**
  107. * jump_to_image_linux() - Jump to a Linux kernel from SPL
  108. *
  109. * This jumps into a Linux kernel using the information in @spl_image.
  110. *
  111. * @spl_image: Image description to set up
  112. */
  113. void __noreturn jump_to_image_linux(struct spl_image_info *spl_image);
  114. /**
  115. * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
  116. *
  117. * This is called by the various SPL loaders to determine whether the board
  118. * wants to load the kernel or U-Boot. This function should be provided by
  119. * the board.
  120. *
  121. * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
  122. */
  123. int spl_start_uboot(void);
  124. /**
  125. * spl_display_print() - Display a board-specific message in SPL
  126. *
  127. * If CONFIG_SPL_DISPLAY_PRINT is enabled, U-Boot will call this function
  128. * immediately after displaying the SPL console banner ("U-Boot SPL ...").
  129. * This function should be provided by the board.
  130. */
  131. void spl_display_print(void);
  132. /**
  133. * struct spl_boot_device - Describes a boot device used by SPL
  134. *
  135. * @boot_device: A number indicating the BOOT_DEVICE type. There are various
  136. * BOOT_DEVICE... #defines and enums in U-Boot and they are not consistently
  137. * numbered.
  138. * @boot_device_name: Named boot device, or NULL if none.
  139. *
  140. * Note: Additional fields can be added here, bearing in mind that SPL is
  141. * size-sensitive and common fields will be present on all boards. This
  142. * struct can also be used to return additional information about the load
  143. * process if that becomes useful.
  144. */
  145. struct spl_boot_device {
  146. uint boot_device;
  147. const char *boot_device_name;
  148. };
  149. /**
  150. * Holds information about a way of loading an SPL image
  151. *
  152. * @name: User-friendly name for this method (e.g. "MMC")
  153. * @boot_device: Boot device that this loader supports
  154. * @load_image: Function to call to load image
  155. */
  156. struct spl_image_loader {
  157. #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
  158. const char *name;
  159. #endif
  160. uint boot_device;
  161. /**
  162. * load_image() - Load an SPL image
  163. *
  164. * @spl_image: place to put image information
  165. * @bootdev: describes the boot device to load from
  166. */
  167. int (*load_image)(struct spl_image_info *spl_image,
  168. struct spl_boot_device *bootdev);
  169. };
  170. /* Declare an SPL image loader */
  171. #define SPL_LOAD_IMAGE(__name) \
  172. ll_entry_declare(struct spl_image_loader, __name, spl_image_loader)
  173. /*
  174. * _priority is the priority of this method, 0 meaning it will be the top
  175. * choice for this device, 9 meaning it is the bottom choice.
  176. * _boot_device is the BOOT_DEVICE_... value
  177. * _method is the load_image function to call
  178. */
  179. #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
  180. #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
  181. SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \
  182. .name = _name, \
  183. .boot_device = _boot_device, \
  184. .load_image = _method, \
  185. }
  186. #else
  187. #define SPL_LOAD_IMAGE_METHOD(_name, _priority, _boot_device, _method) \
  188. SPL_LOAD_IMAGE(_method ## _priority ## _boot_device) = { \
  189. .boot_device = _boot_device, \
  190. .load_image = _method, \
  191. }
  192. #endif
  193. /* SPL FAT image functions */
  194. int spl_load_image_fat(struct spl_image_info *spl_image,
  195. struct blk_desc *block_dev, int partition,
  196. const char *filename);
  197. int spl_load_image_fat_os(struct spl_image_info *spl_image,
  198. struct blk_desc *block_dev, int partition);
  199. void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image);
  200. /* SPL EXT image functions */
  201. int spl_load_image_ext(struct spl_image_info *spl_image,
  202. struct blk_desc *block_dev, int partition,
  203. const char *filename);
  204. int spl_load_image_ext_os(struct spl_image_info *spl_image,
  205. struct blk_desc *block_dev, int partition);
  206. /**
  207. * spl_early_init() - Set up device tree and driver model in SPL if enabled
  208. *
  209. * Call this function in board_init_f() if you want to use device tree and
  210. * driver model early, before board_init_r() is called.
  211. *
  212. * If this is not called, then driver model will be inactive in SPL's
  213. * board_init_f(), and no device tree will be available.
  214. */
  215. int spl_early_init(void);
  216. /**
  217. * spl_init() - Set up device tree and driver model in SPL if enabled
  218. *
  219. * You can optionally call spl_early_init(), then optionally call spl_init().
  220. * This function will be called from board_init_r() if not called earlier.
  221. *
  222. * Both spl_early_init() and spl_init() perform a similar function except that
  223. * the latter will not set up the malloc() area if
  224. * CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN is enabled, since it is assumed to
  225. * already be done by a calll to spl_relocate_stack_gd() before board_init_r()
  226. * is reached.
  227. *
  228. * This function will be called from board_init_r() if not called earlier.
  229. *
  230. * If this is not called, then driver model will be inactive in SPL's
  231. * board_init_f(), and no device tree will be available.
  232. */
  233. int spl_init(void);
  234. #ifdef CONFIG_SPL_BOARD_INIT
  235. void spl_board_init(void);
  236. #endif
  237. /**
  238. * spl_was_boot_source() - check if U-Boot booted from SPL
  239. *
  240. * This will normally be true, but if U-Boot jumps to second U-Boot, it will
  241. * be false. This should be implemented by board-specific code.
  242. *
  243. * @return true if U-Boot booted from SPL, else false
  244. */
  245. bool spl_was_boot_source(void);
  246. /**
  247. * spl_dfu_cmd- run dfu command with chosen mmc device interface
  248. * @param usb_index - usb controller number
  249. * @param mmc_dev - mmc device nubmer
  250. *
  251. * @return 0 on success, otherwise error code
  252. */
  253. int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
  254. int spl_mmc_load_image(struct spl_image_info *spl_image,
  255. struct spl_boot_device *bootdev);
  256. /**
  257. * spl_invoke_atf - boot using an ARM trusted firmware image
  258. */
  259. void spl_invoke_atf(struct spl_image_info *spl_image);
  260. /**
  261. * spl_optee_entry - entry function for optee
  262. *
  263. * args defind in op-tee project
  264. * https://github.com/OP-TEE/optee_os/
  265. * core/arch/arm/kernel/generic_entry_a32.S
  266. * @arg0: pagestore
  267. * @arg1: (ARMv7 standard bootarg #1)
  268. * @arg2: device tree address, (ARMv7 standard bootarg #2)
  269. * @arg3: non-secure entry address (ARMv7 bootarg #0)
  270. */
  271. void spl_optee_entry(void *arg0, void *arg1, void *arg2, void *arg3);
  272. /**
  273. * board_return_to_bootrom - allow for boards to continue with the boot ROM
  274. *
  275. * If a board (e.g. the Rockchip RK3368 boards) provide some
  276. * supporting functionality for SPL in their boot ROM and the SPL
  277. * stage wants to return to the ROM code to continue booting, boards
  278. * can implement 'board_return_to_bootrom'.
  279. */
  280. void board_return_to_bootrom(void);
  281. /**
  282. * spl_perform_fixups() - arch/board-specific callback before processing
  283. * the boot-payload
  284. */
  285. void spl_perform_fixups(struct spl_image_info *spl_image);
  286. /*
  287. * spl_get_load_buffer() - get buffer for loading partial image data
  288. *
  289. * Returns memory area which can be populated by partial image data,
  290. * ie. uImage or fitImage header.
  291. */
  292. struct image_header *spl_get_load_buffer(ssize_t offset, size_t size);
  293. #endif