spl.h 9.4 KB

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