image.h 52 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * (C) Copyright 2008 Semihalf
  4. *
  5. * (C) Copyright 2000-2005
  6. * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
  7. ********************************************************************
  8. * NOTE: This header file defines an interface to U-Boot. Including
  9. * this (unmodified) header file in another file is considered normal
  10. * use of U-Boot, and does *not* fall under the heading of "derived
  11. * work".
  12. ********************************************************************
  13. */
  14. #ifndef __IMAGE_H__
  15. #define __IMAGE_H__
  16. #include "compiler.h"
  17. #include <asm/byteorder.h>
  18. #include <stdbool.h>
  19. /* Define this to avoid #ifdefs later on */
  20. struct lmb;
  21. struct fdt_region;
  22. #ifdef USE_HOSTCC
  23. #include <sys/types.h>
  24. /* new uImage format support enabled on host */
  25. #define IMAGE_ENABLE_FIT 1
  26. #define IMAGE_ENABLE_OF_LIBFDT 1
  27. #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */
  28. #define CONFIG_FIT_ENABLE_RSASSA_PSS_SUPPORT 1
  29. #define CONFIG_FIT_ENABLE_SHA256_SUPPORT
  30. #define CONFIG_FIT_ENABLE_SHA384_SUPPORT
  31. #define CONFIG_FIT_ENABLE_SHA512_SUPPORT
  32. #define CONFIG_SHA1
  33. #define CONFIG_SHA256
  34. #define CONFIG_SHA384
  35. #define CONFIG_SHA512
  36. #define IMAGE_ENABLE_IGNORE 0
  37. #define IMAGE_INDENT_STRING ""
  38. #else
  39. #include <lmb.h>
  40. #include <asm/u-boot.h>
  41. #include <command.h>
  42. /* Take notice of the 'ignore' property for hashes */
  43. #define IMAGE_ENABLE_IGNORE 1
  44. #define IMAGE_INDENT_STRING " "
  45. #define IMAGE_ENABLE_FIT CONFIG_IS_ENABLED(FIT)
  46. #define IMAGE_ENABLE_OF_LIBFDT CONFIG_IS_ENABLED(OF_LIBFDT)
  47. #endif /* USE_HOSTCC */
  48. #if IMAGE_ENABLE_FIT
  49. #include <hash.h>
  50. #include <linux/libfdt.h>
  51. #include <fdt_support.h>
  52. # ifdef CONFIG_SPL_BUILD
  53. # ifdef CONFIG_SPL_CRC32_SUPPORT
  54. # define IMAGE_ENABLE_CRC32 1
  55. # endif
  56. # ifdef CONFIG_SPL_MD5_SUPPORT
  57. # define IMAGE_ENABLE_MD5 1
  58. # endif
  59. # ifdef CONFIG_SPL_SHA1_SUPPORT
  60. # define IMAGE_ENABLE_SHA1 1
  61. # endif
  62. # else
  63. # define IMAGE_ENABLE_CRC32 1
  64. # define IMAGE_ENABLE_MD5 1
  65. # define IMAGE_ENABLE_SHA1 1
  66. # endif
  67. #ifndef IMAGE_ENABLE_CRC32
  68. #define IMAGE_ENABLE_CRC32 0
  69. #endif
  70. #ifndef IMAGE_ENABLE_MD5
  71. #define IMAGE_ENABLE_MD5 0
  72. #endif
  73. #ifndef IMAGE_ENABLE_SHA1
  74. #define IMAGE_ENABLE_SHA1 0
  75. #endif
  76. #if defined(CONFIG_FIT_ENABLE_SHA256_SUPPORT) || \
  77. defined(CONFIG_SPL_SHA256_SUPPORT)
  78. #define IMAGE_ENABLE_SHA256 1
  79. #else
  80. #define IMAGE_ENABLE_SHA256 0
  81. #endif
  82. #if defined(CONFIG_FIT_ENABLE_SHA384_SUPPORT) || \
  83. defined(CONFIG_SPL_SHA384_SUPPORT)
  84. #define IMAGE_ENABLE_SHA384 1
  85. #else
  86. #define IMAGE_ENABLE_SHA384 0
  87. #endif
  88. #if defined(CONFIG_FIT_ENABLE_SHA512_SUPPORT) || \
  89. defined(CONFIG_SPL_SHA512_SUPPORT)
  90. #define IMAGE_ENABLE_SHA512 1
  91. #else
  92. #define IMAGE_ENABLE_SHA512 0
  93. #endif
  94. #endif /* IMAGE_ENABLE_FIT */
  95. #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
  96. # define IMAGE_BOOT_GET_CMDLINE 1
  97. #else
  98. # define IMAGE_BOOT_GET_CMDLINE 0
  99. #endif
  100. #ifdef CONFIG_OF_BOARD_SETUP
  101. # define IMAGE_OF_BOARD_SETUP 1
  102. #else
  103. # define IMAGE_OF_BOARD_SETUP 0
  104. #endif
  105. #ifdef CONFIG_OF_SYSTEM_SETUP
  106. # define IMAGE_OF_SYSTEM_SETUP 1
  107. #else
  108. # define IMAGE_OF_SYSTEM_SETUP 0
  109. #endif
  110. extern ulong image_load_addr; /* Default Load Address */
  111. extern ulong image_save_addr; /* Default Save Address */
  112. extern ulong image_save_size; /* Default Save Size */
  113. /* An invalid size, meaning that the image size is not known */
  114. #define IMAGE_SIZE_INVAL (-1UL)
  115. enum ih_category {
  116. IH_ARCH,
  117. IH_COMP,
  118. IH_OS,
  119. IH_TYPE,
  120. IH_COUNT,
  121. };
  122. /*
  123. * Operating System Codes
  124. *
  125. * The following are exposed to uImage header.
  126. * New IDs *MUST* be appended at the end of the list and *NEVER*
  127. * inserted for backward compatibility.
  128. */
  129. enum {
  130. IH_OS_INVALID = 0, /* Invalid OS */
  131. IH_OS_OPENBSD, /* OpenBSD */
  132. IH_OS_NETBSD, /* NetBSD */
  133. IH_OS_FREEBSD, /* FreeBSD */
  134. IH_OS_4_4BSD, /* 4.4BSD */
  135. IH_OS_LINUX, /* Linux */
  136. IH_OS_SVR4, /* SVR4 */
  137. IH_OS_ESIX, /* Esix */
  138. IH_OS_SOLARIS, /* Solaris */
  139. IH_OS_IRIX, /* Irix */
  140. IH_OS_SCO, /* SCO */
  141. IH_OS_DELL, /* Dell */
  142. IH_OS_NCR, /* NCR */
  143. IH_OS_LYNXOS, /* LynxOS */
  144. IH_OS_VXWORKS, /* VxWorks */
  145. IH_OS_PSOS, /* pSOS */
  146. IH_OS_QNX, /* QNX */
  147. IH_OS_U_BOOT, /* Firmware */
  148. IH_OS_RTEMS, /* RTEMS */
  149. IH_OS_ARTOS, /* ARTOS */
  150. IH_OS_UNITY, /* Unity OS */
  151. IH_OS_INTEGRITY, /* INTEGRITY */
  152. IH_OS_OSE, /* OSE */
  153. IH_OS_PLAN9, /* Plan 9 */
  154. IH_OS_OPENRTOS, /* OpenRTOS */
  155. IH_OS_ARM_TRUSTED_FIRMWARE, /* ARM Trusted Firmware */
  156. IH_OS_TEE, /* Trusted Execution Environment */
  157. IH_OS_OPENSBI, /* RISC-V OpenSBI */
  158. IH_OS_EFI, /* EFI Firmware (e.g. GRUB2) */
  159. IH_OS_COUNT,
  160. };
  161. /*
  162. * CPU Architecture Codes (supported by Linux)
  163. *
  164. * The following are exposed to uImage header.
  165. * New IDs *MUST* be appended at the end of the list and *NEVER*
  166. * inserted for backward compatibility.
  167. */
  168. enum {
  169. IH_ARCH_INVALID = 0, /* Invalid CPU */
  170. IH_ARCH_ALPHA, /* Alpha */
  171. IH_ARCH_ARM, /* ARM */
  172. IH_ARCH_I386, /* Intel x86 */
  173. IH_ARCH_IA64, /* IA64 */
  174. IH_ARCH_MIPS, /* MIPS */
  175. IH_ARCH_MIPS64, /* MIPS 64 Bit */
  176. IH_ARCH_PPC, /* PowerPC */
  177. IH_ARCH_S390, /* IBM S390 */
  178. IH_ARCH_SH, /* SuperH */
  179. IH_ARCH_SPARC, /* Sparc */
  180. IH_ARCH_SPARC64, /* Sparc 64 Bit */
  181. IH_ARCH_M68K, /* M68K */
  182. IH_ARCH_NIOS, /* Nios-32 */
  183. IH_ARCH_MICROBLAZE, /* MicroBlaze */
  184. IH_ARCH_NIOS2, /* Nios-II */
  185. IH_ARCH_BLACKFIN, /* Blackfin */
  186. IH_ARCH_AVR32, /* AVR32 */
  187. IH_ARCH_ST200, /* STMicroelectronics ST200 */
  188. IH_ARCH_SANDBOX, /* Sandbox architecture (test only) */
  189. IH_ARCH_NDS32, /* ANDES Technology - NDS32 */
  190. IH_ARCH_OPENRISC, /* OpenRISC 1000 */
  191. IH_ARCH_ARM64, /* ARM64 */
  192. IH_ARCH_ARC, /* Synopsys DesignWare ARC */
  193. IH_ARCH_X86_64, /* AMD x86_64, Intel and Via */
  194. IH_ARCH_XTENSA, /* Xtensa */
  195. IH_ARCH_RISCV, /* RISC-V */
  196. IH_ARCH_COUNT,
  197. };
  198. /*
  199. * Image Types
  200. *
  201. * "Standalone Programs" are directly runnable in the environment
  202. * provided by U-Boot; it is expected that (if they behave
  203. * well) you can continue to work in U-Boot after return from
  204. * the Standalone Program.
  205. * "OS Kernel Images" are usually images of some Embedded OS which
  206. * will take over control completely. Usually these programs
  207. * will install their own set of exception handlers, device
  208. * drivers, set up the MMU, etc. - this means, that you cannot
  209. * expect to re-enter U-Boot except by resetting the CPU.
  210. * "RAMDisk Images" are more or less just data blocks, and their
  211. * parameters (address, size) are passed to an OS kernel that is
  212. * being started.
  213. * "Multi-File Images" contain several images, typically an OS
  214. * (Linux) kernel image and one or more data images like
  215. * RAMDisks. This construct is useful for instance when you want
  216. * to boot over the network using BOOTP etc., where the boot
  217. * server provides just a single image file, but you want to get
  218. * for instance an OS kernel and a RAMDisk image.
  219. *
  220. * "Multi-File Images" start with a list of image sizes, each
  221. * image size (in bytes) specified by an "uint32_t" in network
  222. * byte order. This list is terminated by an "(uint32_t)0".
  223. * Immediately after the terminating 0 follow the images, one by
  224. * one, all aligned on "uint32_t" boundaries (size rounded up to
  225. * a multiple of 4 bytes - except for the last file).
  226. *
  227. * "Firmware Images" are binary images containing firmware (like
  228. * U-Boot or FPGA images) which usually will be programmed to
  229. * flash memory.
  230. *
  231. * "Script files" are command sequences that will be executed by
  232. * U-Boot's command interpreter; this feature is especially
  233. * useful when you configure U-Boot to use a real shell (hush)
  234. * as command interpreter (=> Shell Scripts).
  235. *
  236. * The following are exposed to uImage header.
  237. * New IDs *MUST* be appended at the end of the list and *NEVER*
  238. * inserted for backward compatibility.
  239. */
  240. enum {
  241. IH_TYPE_INVALID = 0, /* Invalid Image */
  242. IH_TYPE_STANDALONE, /* Standalone Program */
  243. IH_TYPE_KERNEL, /* OS Kernel Image */
  244. IH_TYPE_RAMDISK, /* RAMDisk Image */
  245. IH_TYPE_MULTI, /* Multi-File Image */
  246. IH_TYPE_FIRMWARE, /* Firmware Image */
  247. IH_TYPE_SCRIPT, /* Script file */
  248. IH_TYPE_FILESYSTEM, /* Filesystem Image (any type) */
  249. IH_TYPE_FLATDT, /* Binary Flat Device Tree Blob */
  250. IH_TYPE_KWBIMAGE, /* Kirkwood Boot Image */
  251. IH_TYPE_IMXIMAGE, /* Freescale IMXBoot Image */
  252. IH_TYPE_UBLIMAGE, /* Davinci UBL Image */
  253. IH_TYPE_OMAPIMAGE, /* TI OMAP Config Header Image */
  254. IH_TYPE_AISIMAGE, /* TI Davinci AIS Image */
  255. /* OS Kernel Image, can run from any load address */
  256. IH_TYPE_KERNEL_NOLOAD,
  257. IH_TYPE_PBLIMAGE, /* Freescale PBL Boot Image */
  258. IH_TYPE_MXSIMAGE, /* Freescale MXSBoot Image */
  259. IH_TYPE_GPIMAGE, /* TI Keystone GPHeader Image */
  260. IH_TYPE_ATMELIMAGE, /* ATMEL ROM bootable Image */
  261. IH_TYPE_SOCFPGAIMAGE, /* Altera SOCFPGA CV/AV Preloader */
  262. IH_TYPE_X86_SETUP, /* x86 setup.bin Image */
  263. IH_TYPE_LPC32XXIMAGE, /* x86 setup.bin Image */
  264. IH_TYPE_LOADABLE, /* A list of typeless images */
  265. IH_TYPE_RKIMAGE, /* Rockchip Boot Image */
  266. IH_TYPE_RKSD, /* Rockchip SD card */
  267. IH_TYPE_RKSPI, /* Rockchip SPI image */
  268. IH_TYPE_ZYNQIMAGE, /* Xilinx Zynq Boot Image */
  269. IH_TYPE_ZYNQMPIMAGE, /* Xilinx ZynqMP Boot Image */
  270. IH_TYPE_ZYNQMPBIF, /* Xilinx ZynqMP Boot Image (bif) */
  271. IH_TYPE_FPGA, /* FPGA Image */
  272. IH_TYPE_VYBRIDIMAGE, /* VYBRID .vyb Image */
  273. IH_TYPE_TEE, /* Trusted Execution Environment OS Image */
  274. IH_TYPE_FIRMWARE_IVT, /* Firmware Image with HABv4 IVT */
  275. IH_TYPE_PMMC, /* TI Power Management Micro-Controller Firmware */
  276. IH_TYPE_STM32IMAGE, /* STMicroelectronics STM32 Image */
  277. IH_TYPE_SOCFPGAIMAGE_V1, /* Altera SOCFPGA A10 Preloader */
  278. IH_TYPE_MTKIMAGE, /* MediaTek BootROM loadable Image */
  279. IH_TYPE_IMX8MIMAGE, /* Freescale IMX8MBoot Image */
  280. IH_TYPE_IMX8IMAGE, /* Freescale IMX8Boot Image */
  281. IH_TYPE_COPRO, /* Coprocessor Image for remoteproc*/
  282. IH_TYPE_SUNXI_EGON, /* Allwinner eGON Boot Image */
  283. IH_TYPE_COUNT, /* Number of image types */
  284. };
  285. /*
  286. * Compression Types
  287. *
  288. * The following are exposed to uImage header.
  289. * New IDs *MUST* be appended at the end of the list and *NEVER*
  290. * inserted for backward compatibility.
  291. */
  292. enum {
  293. IH_COMP_NONE = 0, /* No Compression Used */
  294. IH_COMP_GZIP, /* gzip Compression Used */
  295. IH_COMP_BZIP2, /* bzip2 Compression Used */
  296. IH_COMP_LZMA, /* lzma Compression Used */
  297. IH_COMP_LZO, /* lzo Compression Used */
  298. IH_COMP_LZ4, /* lz4 Compression Used */
  299. IH_COMP_ZSTD, /* zstd Compression Used */
  300. IH_COMP_COUNT,
  301. };
  302. #define LZ4F_MAGIC 0x184D2204 /* LZ4 Magic Number */
  303. #define IH_MAGIC 0x27051956 /* Image Magic Number */
  304. #define IH_NMLEN 32 /* Image Name Length */
  305. /* Reused from common.h */
  306. #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1))
  307. /*
  308. * Legacy format image header,
  309. * all data in network byte order (aka natural aka bigendian).
  310. */
  311. typedef struct image_header {
  312. uint32_t ih_magic; /* Image Header Magic Number */
  313. uint32_t ih_hcrc; /* Image Header CRC Checksum */
  314. uint32_t ih_time; /* Image Creation Timestamp */
  315. uint32_t ih_size; /* Image Data Size */
  316. uint32_t ih_load; /* Data Load Address */
  317. uint32_t ih_ep; /* Entry Point Address */
  318. uint32_t ih_dcrc; /* Image Data CRC Checksum */
  319. uint8_t ih_os; /* Operating System */
  320. uint8_t ih_arch; /* CPU architecture */
  321. uint8_t ih_type; /* Image Type */
  322. uint8_t ih_comp; /* Compression Type */
  323. uint8_t ih_name[IH_NMLEN]; /* Image Name */
  324. } image_header_t;
  325. typedef struct image_info {
  326. ulong start, end; /* start/end of blob */
  327. ulong image_start, image_len; /* start of image within blob, len of image */
  328. ulong load; /* load addr for the image */
  329. uint8_t comp, type, os; /* compression, type of image, os type */
  330. uint8_t arch; /* CPU architecture */
  331. } image_info_t;
  332. /*
  333. * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>()
  334. * routines.
  335. */
  336. typedef struct bootm_headers {
  337. /*
  338. * Legacy os image header, if it is a multi component image
  339. * then boot_get_ramdisk() and get_fdt() will attempt to get
  340. * data from second and third component accordingly.
  341. */
  342. image_header_t *legacy_hdr_os; /* image header pointer */
  343. image_header_t legacy_hdr_os_copy; /* header copy */
  344. ulong legacy_hdr_valid;
  345. #if IMAGE_ENABLE_FIT
  346. const char *fit_uname_cfg; /* configuration node unit name */
  347. void *fit_hdr_os; /* os FIT image header */
  348. const char *fit_uname_os; /* os subimage node unit name */
  349. int fit_noffset_os; /* os subimage node offset */
  350. void *fit_hdr_rd; /* init ramdisk FIT image header */
  351. const char *fit_uname_rd; /* init ramdisk subimage node unit name */
  352. int fit_noffset_rd; /* init ramdisk subimage node offset */
  353. void *fit_hdr_fdt; /* FDT blob FIT image header */
  354. const char *fit_uname_fdt; /* FDT blob subimage node unit name */
  355. int fit_noffset_fdt;/* FDT blob subimage node offset */
  356. void *fit_hdr_setup; /* x86 setup FIT image header */
  357. const char *fit_uname_setup; /* x86 setup subimage node name */
  358. int fit_noffset_setup;/* x86 setup subimage node offset */
  359. #endif
  360. #ifndef USE_HOSTCC
  361. image_info_t os; /* os image info */
  362. ulong ep; /* entry point of OS */
  363. ulong rd_start, rd_end;/* ramdisk start/end */
  364. char *ft_addr; /* flat dev tree address */
  365. ulong ft_len; /* length of flat device tree */
  366. ulong initrd_start;
  367. ulong initrd_end;
  368. ulong cmdline_start;
  369. ulong cmdline_end;
  370. struct bd_info *kbd;
  371. #endif
  372. int verify; /* env_get("verify")[0] != 'n' */
  373. #define BOOTM_STATE_START (0x00000001)
  374. #define BOOTM_STATE_FINDOS (0x00000002)
  375. #define BOOTM_STATE_FINDOTHER (0x00000004)
  376. #define BOOTM_STATE_LOADOS (0x00000008)
  377. #define BOOTM_STATE_RAMDISK (0x00000010)
  378. #define BOOTM_STATE_FDT (0x00000020)
  379. #define BOOTM_STATE_OS_CMDLINE (0x00000040)
  380. #define BOOTM_STATE_OS_BD_T (0x00000080)
  381. #define BOOTM_STATE_OS_PREP (0x00000100)
  382. #define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */
  383. #define BOOTM_STATE_OS_GO (0x00000400)
  384. int state;
  385. #ifdef CONFIG_LMB
  386. struct lmb lmb; /* for memory mgmt */
  387. #endif
  388. } bootm_headers_t;
  389. extern bootm_headers_t images;
  390. /*
  391. * Some systems (for example LWMON) have very short watchdog periods;
  392. * we must make sure to split long operations like memmove() or
  393. * checksum calculations into reasonable chunks.
  394. */
  395. #ifndef CHUNKSZ
  396. #define CHUNKSZ (64 * 1024)
  397. #endif
  398. #ifndef CHUNKSZ_CRC32
  399. #define CHUNKSZ_CRC32 (64 * 1024)
  400. #endif
  401. #ifndef CHUNKSZ_MD5
  402. #define CHUNKSZ_MD5 (64 * 1024)
  403. #endif
  404. #ifndef CHUNKSZ_SHA1
  405. #define CHUNKSZ_SHA1 (64 * 1024)
  406. #endif
  407. #define uimage_to_cpu(x) be32_to_cpu(x)
  408. #define cpu_to_uimage(x) cpu_to_be32(x)
  409. /*
  410. * Translation table for entries of a specific type; used by
  411. * get_table_entry_id() and get_table_entry_name().
  412. */
  413. typedef struct table_entry {
  414. int id;
  415. char *sname; /* short (input) name to find table entry */
  416. char *lname; /* long (output) name to print for messages */
  417. } table_entry_t;
  418. /*
  419. * Compression type and magic number mapping table.
  420. */
  421. struct comp_magic_map {
  422. int comp_id;
  423. const char *name;
  424. unsigned char magic[2];
  425. };
  426. /*
  427. * get_table_entry_id() scans the translation table trying to find an
  428. * entry that matches the given short name. If a matching entry is
  429. * found, it's id is returned to the caller.
  430. */
  431. int get_table_entry_id(const table_entry_t *table,
  432. const char *table_name, const char *name);
  433. /*
  434. * get_table_entry_name() scans the translation table trying to find
  435. * an entry that matches the given id. If a matching entry is found,
  436. * its long name is returned to the caller.
  437. */
  438. char *get_table_entry_name(const table_entry_t *table, char *msg, int id);
  439. const char *genimg_get_os_name(uint8_t os);
  440. /**
  441. * genimg_get_os_short_name() - get the short name for an OS
  442. *
  443. * @param os OS (IH_OS_...)
  444. * @return OS short name, or "unknown" if unknown
  445. */
  446. const char *genimg_get_os_short_name(uint8_t comp);
  447. const char *genimg_get_arch_name(uint8_t arch);
  448. /**
  449. * genimg_get_arch_short_name() - get the short name for an architecture
  450. *
  451. * @param arch Architecture type (IH_ARCH_...)
  452. * @return architecture short name, or "unknown" if unknown
  453. */
  454. const char *genimg_get_arch_short_name(uint8_t arch);
  455. const char *genimg_get_type_name(uint8_t type);
  456. /**
  457. * genimg_get_type_short_name() - get the short name for an image type
  458. *
  459. * @param type Image type (IH_TYPE_...)
  460. * @return image short name, or "unknown" if unknown
  461. */
  462. const char *genimg_get_type_short_name(uint8_t type);
  463. const char *genimg_get_comp_name(uint8_t comp);
  464. /**
  465. * genimg_get_comp_short_name() - get the short name for a compression method
  466. *
  467. * @param comp compression method (IH_COMP_...)
  468. * @return compression method short name, or "unknown" if unknown
  469. */
  470. const char *genimg_get_comp_short_name(uint8_t comp);
  471. /**
  472. * genimg_get_cat_name() - Get the name of an item in a category
  473. *
  474. * @category: Category of item
  475. * @id: Item ID
  476. * @return name of item, or "Unknown ..." if unknown
  477. */
  478. const char *genimg_get_cat_name(enum ih_category category, uint id);
  479. /**
  480. * genimg_get_cat_short_name() - Get the short name of an item in a category
  481. *
  482. * @category: Category of item
  483. * @id: Item ID
  484. * @return short name of item, or "Unknown ..." if unknown
  485. */
  486. const char *genimg_get_cat_short_name(enum ih_category category, uint id);
  487. /**
  488. * genimg_get_cat_count() - Get the number of items in a category
  489. *
  490. * @category: Category to check
  491. * @return the number of items in the category (IH_xxx_COUNT)
  492. */
  493. int genimg_get_cat_count(enum ih_category category);
  494. /**
  495. * genimg_get_cat_desc() - Get the description of a category
  496. *
  497. * @category: Category to check
  498. * @return the description of a category, e.g. "architecture". This
  499. * effectively converts the enum to a string.
  500. */
  501. const char *genimg_get_cat_desc(enum ih_category category);
  502. /**
  503. * genimg_cat_has_id() - Check whether a category has an item
  504. *
  505. * @category: Category to check
  506. * @id: Item ID
  507. * @return true or false as to whether a category has an item
  508. */
  509. bool genimg_cat_has_id(enum ih_category category, uint id);
  510. int genimg_get_os_id(const char *name);
  511. int genimg_get_arch_id(const char *name);
  512. int genimg_get_type_id(const char *name);
  513. int genimg_get_comp_id(const char *name);
  514. void genimg_print_size(uint32_t size);
  515. #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \
  516. defined(USE_HOSTCC)
  517. #define IMAGE_ENABLE_TIMESTAMP 1
  518. #else
  519. #define IMAGE_ENABLE_TIMESTAMP 0
  520. #endif
  521. void genimg_print_time(time_t timestamp);
  522. /* What to do with a image load address ('load = <> 'in the FIT) */
  523. enum fit_load_op {
  524. FIT_LOAD_IGNORED, /* Ignore load address */
  525. FIT_LOAD_OPTIONAL, /* Can be provided, but optional */
  526. FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */
  527. FIT_LOAD_REQUIRED, /* Must be provided */
  528. };
  529. int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start,
  530. ulong *setup_len);
  531. #ifndef USE_HOSTCC
  532. /* Image format types, returned by _get_format() routine */
  533. #define IMAGE_FORMAT_INVALID 0x00
  534. #if defined(CONFIG_LEGACY_IMAGE_FORMAT)
  535. #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */
  536. #endif
  537. #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */
  538. #define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */
  539. ulong genimg_get_kernel_addr_fit(char * const img_addr,
  540. const char **fit_uname_config,
  541. const char **fit_uname_kernel);
  542. ulong genimg_get_kernel_addr(char * const img_addr);
  543. int genimg_get_format(const void *img_addr);
  544. int genimg_has_config(bootm_headers_t *images);
  545. int boot_get_fpga(int argc, char *const argv[], bootm_headers_t *images,
  546. uint8_t arch, const ulong *ld_start, ulong * const ld_len);
  547. int boot_get_ramdisk(int argc, char *const argv[], bootm_headers_t *images,
  548. uint8_t arch, ulong *rd_start, ulong *rd_end);
  549. /**
  550. * boot_get_loadable - routine to load a list of binaries to memory
  551. * @argc: Ignored Argument
  552. * @argv: Ignored Argument
  553. * @images: pointer to the bootm images structure
  554. * @arch: expected architecture for the image
  555. * @ld_start: Ignored Argument
  556. * @ld_len: Ignored Argument
  557. *
  558. * boot_get_loadable() will take the given FIT configuration, and look
  559. * for a field named "loadables". Loadables, is a list of elements in
  560. * the FIT given as strings. exe:
  561. * loadables = "linux_kernel", "fdt-2";
  562. * this function will attempt to parse each string, and load the
  563. * corresponding element from the FIT into memory. Once placed,
  564. * no aditional actions are taken.
  565. *
  566. * @return:
  567. * 0, if only valid images or no images are found
  568. * error code, if an error occurs during fit_image_load
  569. */
  570. int boot_get_loadable(int argc, char *const argv[], bootm_headers_t *images,
  571. uint8_t arch, const ulong *ld_start, ulong *const ld_len);
  572. #endif /* !USE_HOSTCC */
  573. int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch,
  574. ulong *setup_start, ulong *setup_len);
  575. /**
  576. * boot_get_fdt_fit() - load a DTB from a FIT file (applying overlays)
  577. *
  578. * This deals with all aspects of loading an DTB from a FIT.
  579. * The correct base image based on configuration will be selected, and
  580. * then any overlays specified will be applied (as present in fit_uname_configp).
  581. *
  582. * @param images Boot images structure
  583. * @param addr Address of FIT in memory
  584. * @param fit_unamep On entry this is the requested image name
  585. * (e.g. "kernel") or NULL to use the default. On exit
  586. * points to the selected image name
  587. * @param fit_uname_configp On entry this is the requested configuration
  588. * name (e.g. "conf-1") or NULL to use the default. On
  589. * exit points to the selected configuration name.
  590. * @param arch Expected architecture (IH_ARCH_...)
  591. * @param datap Returns address of loaded image
  592. * @param lenp Returns length of loaded image
  593. *
  594. * @return node offset of base image, or -ve error code on error
  595. */
  596. int boot_get_fdt_fit(bootm_headers_t *images, ulong addr,
  597. const char **fit_unamep, const char **fit_uname_configp,
  598. int arch, ulong *datap, ulong *lenp);
  599. /**
  600. * fit_image_load() - load an image from a FIT
  601. *
  602. * This deals with all aspects of loading an image from a FIT, including
  603. * selecting the right image based on configuration, verifying it, printing
  604. * out progress messages, checking the type/arch/os and optionally copying it
  605. * to the right load address.
  606. *
  607. * The property to look up is defined by image_type.
  608. *
  609. * @param images Boot images structure
  610. * @param addr Address of FIT in memory
  611. * @param fit_unamep On entry this is the requested image name
  612. * (e.g. "kernel") or NULL to use the default. On exit
  613. * points to the selected image name
  614. * @param fit_uname_configp On entry this is the requested configuration
  615. * name (e.g. "conf-1") or NULL to use the default. On
  616. * exit points to the selected configuration name.
  617. * @param arch Expected architecture (IH_ARCH_...)
  618. * @param image_type Required image type (IH_TYPE_...). If this is
  619. * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD
  620. * also.
  621. * @param bootstage_id ID of starting bootstage to use for progress updates.
  622. * This will be added to the BOOTSTAGE_SUB values when
  623. * calling bootstage_mark()
  624. * @param load_op Decribes what to do with the load address
  625. * @param datap Returns address of loaded image
  626. * @param lenp Returns length of loaded image
  627. * @return node offset of image, or -ve error code on error
  628. */
  629. int fit_image_load(bootm_headers_t *images, ulong addr,
  630. const char **fit_unamep, const char **fit_uname_configp,
  631. int arch, int image_type, int bootstage_id,
  632. enum fit_load_op load_op, ulong *datap, ulong *lenp);
  633. /**
  634. * image_source_script() - Execute a script
  635. *
  636. * Executes a U-Boot script at a particular address in memory. The script should
  637. * have a header (FIT or legacy) with the script type (IH_TYPE_SCRIPT).
  638. *
  639. * @addr: Address of script
  640. * @fit_uname: FIT subimage name
  641. * @return result code (enum command_ret_t)
  642. */
  643. int image_source_script(ulong addr, const char *fit_uname);
  644. #ifndef USE_HOSTCC
  645. /**
  646. * fit_get_node_from_config() - Look up an image a FIT by type
  647. *
  648. * This looks in the selected conf- node (images->fit_uname_cfg) for a
  649. * particular image type (e.g. "kernel") and then finds the image that is
  650. * referred to.
  651. *
  652. * For example, for something like:
  653. *
  654. * images {
  655. * kernel {
  656. * ...
  657. * };
  658. * };
  659. * configurations {
  660. * conf-1 {
  661. * kernel = "kernel";
  662. * };
  663. * };
  664. *
  665. * the function will return the node offset of the kernel@1 node, assuming
  666. * that conf-1 is the chosen configuration.
  667. *
  668. * @param images Boot images structure
  669. * @param prop_name Property name to look up (FIT_..._PROP)
  670. * @param addr Address of FIT in memory
  671. */
  672. int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name,
  673. ulong addr);
  674. int boot_get_fdt(int flag, int argc, char *const argv[], uint8_t arch,
  675. bootm_headers_t *images,
  676. char **of_flat_tree, ulong *of_size);
  677. void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob);
  678. int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size);
  679. int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
  680. ulong *initrd_start, ulong *initrd_end);
  681. int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end);
  682. #ifdef CONFIG_SYS_BOOT_GET_KBD
  683. int boot_get_kbd(struct lmb *lmb, struct bd_info **kbd);
  684. #endif /* CONFIG_SYS_BOOT_GET_KBD */
  685. #endif /* !USE_HOSTCC */
  686. /*******************************************************************/
  687. /* Legacy format specific code (prefixed with image_) */
  688. /*******************************************************************/
  689. static inline uint32_t image_get_header_size(void)
  690. {
  691. return (sizeof(image_header_t));
  692. }
  693. #define image_get_hdr_l(f) \
  694. static inline uint32_t image_get_##f(const image_header_t *hdr) \
  695. { \
  696. return uimage_to_cpu(hdr->ih_##f); \
  697. }
  698. image_get_hdr_l(magic) /* image_get_magic */
  699. image_get_hdr_l(hcrc) /* image_get_hcrc */
  700. image_get_hdr_l(time) /* image_get_time */
  701. image_get_hdr_l(size) /* image_get_size */
  702. image_get_hdr_l(load) /* image_get_load */
  703. image_get_hdr_l(ep) /* image_get_ep */
  704. image_get_hdr_l(dcrc) /* image_get_dcrc */
  705. #define image_get_hdr_b(f) \
  706. static inline uint8_t image_get_##f(const image_header_t *hdr) \
  707. { \
  708. return hdr->ih_##f; \
  709. }
  710. image_get_hdr_b(os) /* image_get_os */
  711. image_get_hdr_b(arch) /* image_get_arch */
  712. image_get_hdr_b(type) /* image_get_type */
  713. image_get_hdr_b(comp) /* image_get_comp */
  714. static inline char *image_get_name(const image_header_t *hdr)
  715. {
  716. return (char *)hdr->ih_name;
  717. }
  718. static inline uint32_t image_get_data_size(const image_header_t *hdr)
  719. {
  720. return image_get_size(hdr);
  721. }
  722. /**
  723. * image_get_data - get image payload start address
  724. * @hdr: image header
  725. *
  726. * image_get_data() returns address of the image payload. For single
  727. * component images it is image data start. For multi component
  728. * images it points to the null terminated table of sub-images sizes.
  729. *
  730. * returns:
  731. * image payload data start address
  732. */
  733. static inline ulong image_get_data(const image_header_t *hdr)
  734. {
  735. return ((ulong)hdr + image_get_header_size());
  736. }
  737. static inline uint32_t image_get_image_size(const image_header_t *hdr)
  738. {
  739. return (image_get_size(hdr) + image_get_header_size());
  740. }
  741. static inline ulong image_get_image_end(const image_header_t *hdr)
  742. {
  743. return ((ulong)hdr + image_get_image_size(hdr));
  744. }
  745. #define image_set_hdr_l(f) \
  746. static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
  747. { \
  748. hdr->ih_##f = cpu_to_uimage(val); \
  749. }
  750. image_set_hdr_l(magic) /* image_set_magic */
  751. image_set_hdr_l(hcrc) /* image_set_hcrc */
  752. image_set_hdr_l(time) /* image_set_time */
  753. image_set_hdr_l(size) /* image_set_size */
  754. image_set_hdr_l(load) /* image_set_load */
  755. image_set_hdr_l(ep) /* image_set_ep */
  756. image_set_hdr_l(dcrc) /* image_set_dcrc */
  757. #define image_set_hdr_b(f) \
  758. static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
  759. { \
  760. hdr->ih_##f = val; \
  761. }
  762. image_set_hdr_b(os) /* image_set_os */
  763. image_set_hdr_b(arch) /* image_set_arch */
  764. image_set_hdr_b(type) /* image_set_type */
  765. image_set_hdr_b(comp) /* image_set_comp */
  766. static inline void image_set_name(image_header_t *hdr, const char *name)
  767. {
  768. strncpy(image_get_name(hdr), name, IH_NMLEN);
  769. }
  770. int image_check_hcrc(const image_header_t *hdr);
  771. int image_check_dcrc(const image_header_t *hdr);
  772. #ifndef USE_HOSTCC
  773. ulong env_get_bootm_low(void);
  774. phys_size_t env_get_bootm_size(void);
  775. phys_size_t env_get_bootm_mapsize(void);
  776. #endif
  777. void memmove_wd(void *to, void *from, size_t len, ulong chunksz);
  778. static inline int image_check_magic(const image_header_t *hdr)
  779. {
  780. return (image_get_magic(hdr) == IH_MAGIC);
  781. }
  782. static inline int image_check_type(const image_header_t *hdr, uint8_t type)
  783. {
  784. return (image_get_type(hdr) == type);
  785. }
  786. static inline int image_check_arch(const image_header_t *hdr, uint8_t arch)
  787. {
  788. return (image_get_arch(hdr) == arch) ||
  789. (image_get_arch(hdr) == IH_ARCH_ARM && arch == IH_ARCH_ARM64);
  790. }
  791. static inline int image_check_os(const image_header_t *hdr, uint8_t os)
  792. {
  793. return (image_get_os(hdr) == os);
  794. }
  795. ulong image_multi_count(const image_header_t *hdr);
  796. void image_multi_getimg(const image_header_t *hdr, ulong idx,
  797. ulong *data, ulong *len);
  798. void image_print_contents(const void *hdr);
  799. #ifndef USE_HOSTCC
  800. static inline int image_check_target_arch(const image_header_t *hdr)
  801. {
  802. #ifndef IH_ARCH_DEFAULT
  803. # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h"
  804. #endif
  805. return image_check_arch(hdr, IH_ARCH_DEFAULT);
  806. }
  807. #endif /* USE_HOSTCC */
  808. /**
  809. * image_decomp_type() - Find out compression type of an image
  810. *
  811. * @buf: Address in U-Boot memory where image is loaded.
  812. * @len: Length of the compressed image.
  813. * @return compression type or IH_COMP_NONE if not compressed.
  814. *
  815. * Note: Only following compression types are supported now.
  816. * lzo, lzma, gzip, bzip2
  817. */
  818. int image_decomp_type(const unsigned char *buf, ulong len);
  819. /**
  820. * image_decomp() - decompress an image
  821. *
  822. * @comp: Compression algorithm that is used (IH_COMP_...)
  823. * @load: Destination load address in U-Boot memory
  824. * @image_start Image start address (where we are decompressing from)
  825. * @type: OS type (IH_OS_...)
  826. * @load_bug: Place to decompress to
  827. * @image_buf: Address to decompress from
  828. * @image_len: Number of bytes in @image_buf to decompress
  829. * @unc_len: Available space for decompression
  830. * @return 0 if OK, -ve on error (BOOTM_ERR_...)
  831. */
  832. int image_decomp(int comp, ulong load, ulong image_start, int type,
  833. void *load_buf, void *image_buf, ulong image_len,
  834. uint unc_len, ulong *load_end);
  835. /**
  836. * Set up properties in the FDT
  837. *
  838. * This sets up properties in the FDT that is to be passed to linux.
  839. *
  840. * @images: Images information
  841. * @blob: FDT to update
  842. * @of_size: Size of the FDT
  843. * @lmb: Points to logical memory block structure
  844. * @return 0 if ok, <0 on failure
  845. */
  846. int image_setup_libfdt(bootm_headers_t *images, void *blob,
  847. int of_size, struct lmb *lmb);
  848. /**
  849. * Set up the FDT to use for booting a kernel
  850. *
  851. * This performs ramdisk setup, sets up the FDT if required, and adds
  852. * paramters to the FDT if libfdt is available.
  853. *
  854. * @param images Images information
  855. * @return 0 if ok, <0 on failure
  856. */
  857. int image_setup_linux(bootm_headers_t *images);
  858. /**
  859. * bootz_setup() - Extract stat and size of a Linux xImage
  860. *
  861. * @image: Address of image
  862. * @start: Returns start address of image
  863. * @end : Returns end address of image
  864. * @return 0 if OK, 1 if the image was not recognised
  865. */
  866. int bootz_setup(ulong image, ulong *start, ulong *end);
  867. /**
  868. * Return the correct start address and size of a Linux aarch64 Image.
  869. *
  870. * @image: Address of image
  871. * @start: Returns start address of image
  872. * @size : Returns size image
  873. * @force_reloc: Ignore image->ep field, always place image to RAM start
  874. * @return 0 if OK, 1 if the image was not recognised
  875. */
  876. int booti_setup(ulong image, ulong *relocated_addr, ulong *size,
  877. bool force_reloc);
  878. /*******************************************************************/
  879. /* New uImage format specific code (prefixed with fit_) */
  880. /*******************************************************************/
  881. #define FIT_IMAGES_PATH "/images"
  882. #define FIT_CONFS_PATH "/configurations"
  883. /* hash/signature/key node */
  884. #define FIT_HASH_NODENAME "hash"
  885. #define FIT_ALGO_PROP "algo"
  886. #define FIT_VALUE_PROP "value"
  887. #define FIT_IGNORE_PROP "uboot-ignore"
  888. #define FIT_SIG_NODENAME "signature"
  889. #define FIT_KEY_REQUIRED "required"
  890. #define FIT_KEY_HINT "key-name-hint"
  891. /* cipher node */
  892. #define FIT_CIPHER_NODENAME "cipher"
  893. #define FIT_ALGO_PROP "algo"
  894. /* image node */
  895. #define FIT_DATA_PROP "data"
  896. #define FIT_DATA_POSITION_PROP "data-position"
  897. #define FIT_DATA_OFFSET_PROP "data-offset"
  898. #define FIT_DATA_SIZE_PROP "data-size"
  899. #define FIT_TIMESTAMP_PROP "timestamp"
  900. #define FIT_DESC_PROP "description"
  901. #define FIT_ARCH_PROP "arch"
  902. #define FIT_TYPE_PROP "type"
  903. #define FIT_OS_PROP "os"
  904. #define FIT_COMP_PROP "compression"
  905. #define FIT_ENTRY_PROP "entry"
  906. #define FIT_LOAD_PROP "load"
  907. /* configuration node */
  908. #define FIT_KERNEL_PROP "kernel"
  909. #define FIT_RAMDISK_PROP "ramdisk"
  910. #define FIT_FDT_PROP "fdt"
  911. #define FIT_LOADABLE_PROP "loadables"
  912. #define FIT_DEFAULT_PROP "default"
  913. #define FIT_SETUP_PROP "setup"
  914. #define FIT_FPGA_PROP "fpga"
  915. #define FIT_FIRMWARE_PROP "firmware"
  916. #define FIT_STANDALONE_PROP "standalone"
  917. #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE
  918. #if IMAGE_ENABLE_FIT
  919. /* cmdline argument format parsing */
  920. int fit_parse_conf(const char *spec, ulong addr_curr,
  921. ulong *addr, const char **conf_name);
  922. int fit_parse_subimage(const char *spec, ulong addr_curr,
  923. ulong *addr, const char **image_name);
  924. int fit_get_subimage_count(const void *fit, int images_noffset);
  925. void fit_print_contents(const void *fit);
  926. void fit_image_print(const void *fit, int noffset, const char *p);
  927. /**
  928. * fit_get_end - get FIT image size
  929. * @fit: pointer to the FIT format image header
  930. *
  931. * returns:
  932. * size of the FIT image (blob) in memory
  933. */
  934. static inline ulong fit_get_size(const void *fit)
  935. {
  936. return fdt_totalsize(fit);
  937. }
  938. /**
  939. * fit_get_end - get FIT image end
  940. * @fit: pointer to the FIT format image header
  941. *
  942. * returns:
  943. * end address of the FIT image (blob) in memory
  944. */
  945. ulong fit_get_end(const void *fit);
  946. /**
  947. * fit_get_name - get FIT node name
  948. * @fit: pointer to the FIT format image header
  949. *
  950. * returns:
  951. * NULL, on error
  952. * pointer to node name, on success
  953. */
  954. static inline const char *fit_get_name(const void *fit_hdr,
  955. int noffset, int *len)
  956. {
  957. return fdt_get_name(fit_hdr, noffset, len);
  958. }
  959. int fit_get_desc(const void *fit, int noffset, char **desc);
  960. int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp);
  961. int fit_image_get_node(const void *fit, const char *image_uname);
  962. int fit_image_get_os(const void *fit, int noffset, uint8_t *os);
  963. int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch);
  964. int fit_image_get_type(const void *fit, int noffset, uint8_t *type);
  965. int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp);
  966. int fit_image_get_load(const void *fit, int noffset, ulong *load);
  967. int fit_image_get_entry(const void *fit, int noffset, ulong *entry);
  968. int fit_image_get_data(const void *fit, int noffset,
  969. const void **data, size_t *size);
  970. int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset);
  971. int fit_image_get_data_position(const void *fit, int noffset,
  972. int *data_position);
  973. int fit_image_get_data_size(const void *fit, int noffset, int *data_size);
  974. int fit_image_get_data_size_unciphered(const void *fit, int noffset,
  975. size_t *data_size);
  976. int fit_image_get_data_and_size(const void *fit, int noffset,
  977. const void **data, size_t *size);
  978. int fit_image_hash_get_algo(const void *fit, int noffset, char **algo);
  979. int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value,
  980. int *value_len);
  981. int fit_set_timestamp(void *fit, int noffset, time_t timestamp);
  982. int fit_cipher_data(const char *keydir, void *keydest, void *fit,
  983. const char *comment, int require_keys,
  984. const char *engine_id, const char *cmdname);
  985. /**
  986. * fit_add_verification_data() - add verification data to FIT image nodes
  987. *
  988. * @keydir: Directory containing keys
  989. * @kwydest: FDT blob to write public key information to
  990. * @fit: Pointer to the FIT format image header
  991. * @comment: Comment to add to signature nodes
  992. * @require_keys: Mark all keys as 'required'
  993. * @engine_id: Engine to use for signing
  994. * @cmdname: Command name used when reporting errors
  995. *
  996. * Adds hash values for all component images in the FIT blob.
  997. * Hashes are calculated for all component images which have hash subnodes
  998. * with algorithm property set to one of the supported hash algorithms.
  999. *
  1000. * Also add signatures if signature nodes are present.
  1001. *
  1002. * returns
  1003. * 0, on success
  1004. * libfdt error code, on failure
  1005. */
  1006. int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
  1007. const char *comment, int require_keys,
  1008. const char *engine_id, const char *cmdname);
  1009. int fit_image_verify_with_data(const void *fit, int image_noffset,
  1010. const void *data, size_t size);
  1011. int fit_image_verify(const void *fit, int noffset);
  1012. int fit_config_verify(const void *fit, int conf_noffset);
  1013. int fit_all_image_verify(const void *fit);
  1014. int fit_config_decrypt(const void *fit, int conf_noffset);
  1015. int fit_image_check_os(const void *fit, int noffset, uint8_t os);
  1016. int fit_image_check_arch(const void *fit, int noffset, uint8_t arch);
  1017. int fit_image_check_type(const void *fit, int noffset, uint8_t type);
  1018. int fit_image_check_comp(const void *fit, int noffset, uint8_t comp);
  1019. /**
  1020. * fit_check_format() - Check that the FIT is valid
  1021. *
  1022. * This performs various checks on the FIT to make sure it is suitable for
  1023. * use, looking for mandatory properties, nodes, etc.
  1024. *
  1025. * If FIT_FULL_CHECK is enabled, it also runs it through libfdt to make
  1026. * sure that there are no strange tags or broken nodes in the FIT.
  1027. *
  1028. * @fit: pointer to the FIT format image header
  1029. * @return 0 if OK, -ENOEXEC if not an FDT file, -EINVAL if the full FDT check
  1030. * failed (e.g. due to bad structure), -ENOMSG if the description is
  1031. * missing, -ENODATA if the timestamp is missing, -ENOENT if the /images
  1032. * path is missing
  1033. */
  1034. int fit_check_format(const void *fit, ulong size);
  1035. int fit_conf_find_compat(const void *fit, const void *fdt);
  1036. /**
  1037. * fit_conf_get_node - get node offset for configuration of a given unit name
  1038. * @fit: pointer to the FIT format image header
  1039. * @conf_uname: configuration node unit name (NULL to use default)
  1040. *
  1041. * fit_conf_get_node() finds a configuration (within the '/configurations'
  1042. * parent node) of a provided unit name. If configuration is found its node
  1043. * offset is returned to the caller.
  1044. *
  1045. * When NULL is provided in second argument fit_conf_get_node() will search
  1046. * for a default configuration node instead. Default configuration node unit
  1047. * name is retrieved from FIT_DEFAULT_PROP property of the '/configurations'
  1048. * node.
  1049. *
  1050. * returns:
  1051. * configuration node offset when found (>=0)
  1052. * negative number on failure (FDT_ERR_* code)
  1053. */
  1054. int fit_conf_get_node(const void *fit, const char *conf_uname);
  1055. int fit_conf_get_prop_node_count(const void *fit, int noffset,
  1056. const char *prop_name);
  1057. int fit_conf_get_prop_node_index(const void *fit, int noffset,
  1058. const char *prop_name, int index);
  1059. /**
  1060. * fit_conf_get_prop_node() - Get node refered to by a configuration
  1061. * @fit: FIT to check
  1062. * @noffset: Offset of conf@xxx node to check
  1063. * @prop_name: Property to read from the conf node
  1064. *
  1065. * The conf- nodes contain references to other nodes, using properties
  1066. * like 'kernel = "kernel"'. Given such a property name (e.g. "kernel"),
  1067. * return the offset of the node referred to (e.g. offset of node
  1068. * "/images/kernel".
  1069. */
  1070. int fit_conf_get_prop_node(const void *fit, int noffset,
  1071. const char *prop_name);
  1072. int fit_check_ramdisk(const void *fit, int os_noffset,
  1073. uint8_t arch, int verify);
  1074. #endif /* IMAGE_ENABLE_FIT */
  1075. int calculate_hash(const void *data, int data_len, const char *algo,
  1076. uint8_t *value, int *value_len);
  1077. /*
  1078. * At present we only support signing on the host, and verification on the
  1079. * device
  1080. */
  1081. #if defined(USE_HOSTCC)
  1082. # if defined(CONFIG_FIT_SIGNATURE)
  1083. # define IMAGE_ENABLE_SIGN 1
  1084. # define IMAGE_ENABLE_VERIFY 1
  1085. # define FIT_IMAGE_ENABLE_VERIFY 1
  1086. # include <openssl/evp.h>
  1087. # else
  1088. # define IMAGE_ENABLE_SIGN 0
  1089. # define IMAGE_ENABLE_VERIFY 0
  1090. # define FIT_IMAGE_ENABLE_VERIFY 0
  1091. # endif
  1092. #else
  1093. # define IMAGE_ENABLE_SIGN 0
  1094. # define IMAGE_ENABLE_VERIFY CONFIG_IS_ENABLED(RSA_VERIFY)
  1095. # define FIT_IMAGE_ENABLE_VERIFY CONFIG_IS_ENABLED(FIT_SIGNATURE)
  1096. #endif
  1097. #if IMAGE_ENABLE_FIT
  1098. #ifdef USE_HOSTCC
  1099. void *image_get_host_blob(void);
  1100. void image_set_host_blob(void *host_blob);
  1101. # define gd_fdt_blob() image_get_host_blob()
  1102. #else
  1103. # define gd_fdt_blob() (gd->fdt_blob)
  1104. #endif
  1105. #ifdef CONFIG_FIT_BEST_MATCH
  1106. #define IMAGE_ENABLE_BEST_MATCH 1
  1107. #else
  1108. #define IMAGE_ENABLE_BEST_MATCH 0
  1109. #endif
  1110. #endif /* IMAGE_ENABLE_FIT */
  1111. /* Information passed to the signing routines */
  1112. struct image_sign_info {
  1113. const char *keydir; /* Directory conaining keys */
  1114. const char *keyname; /* Name of key to use */
  1115. void *fit; /* Pointer to FIT blob */
  1116. int node_offset; /* Offset of signature node */
  1117. const char *name; /* Algorithm name */
  1118. struct checksum_algo *checksum; /* Checksum algorithm information */
  1119. struct padding_algo *padding; /* Padding algorithm information */
  1120. struct crypto_algo *crypto; /* Crypto algorithm information */
  1121. const void *fdt_blob; /* FDT containing public keys */
  1122. int required_keynode; /* Node offset of key to use: -1=any */
  1123. const char *require_keys; /* Value for 'required' property */
  1124. const char *engine_id; /* Engine to use for signing */
  1125. /*
  1126. * Note: the following two fields are always valid even w/o
  1127. * RSA_VERIFY_WITH_PKEY in order to make sure this structure is
  1128. * the same on target and host. Otherwise, vboot test may fail.
  1129. */
  1130. const void *key; /* Pointer to public key in DER */
  1131. int keylen; /* Length of public key */
  1132. };
  1133. /* A part of an image, used for hashing */
  1134. struct image_region {
  1135. const void *data;
  1136. int size;
  1137. };
  1138. #if IMAGE_ENABLE_VERIFY
  1139. # include <u-boot/rsa-checksum.h>
  1140. #endif
  1141. struct checksum_algo {
  1142. const char *name;
  1143. const int checksum_len;
  1144. const int der_len;
  1145. const uint8_t *der_prefix;
  1146. #if IMAGE_ENABLE_SIGN
  1147. const EVP_MD *(*calculate_sign)(void);
  1148. #endif
  1149. int (*calculate)(const char *name,
  1150. const struct image_region region[],
  1151. int region_count, uint8_t *checksum);
  1152. };
  1153. struct crypto_algo {
  1154. const char *name; /* Name of algorithm */
  1155. const int key_len;
  1156. /**
  1157. * sign() - calculate and return signature for given input data
  1158. *
  1159. * @info: Specifies key and FIT information
  1160. * @data: Pointer to the input data
  1161. * @data_len: Data length
  1162. * @sigp: Set to an allocated buffer holding the signature
  1163. * @sig_len: Set to length of the calculated hash
  1164. *
  1165. * This computes input data signature according to selected algorithm.
  1166. * Resulting signature value is placed in an allocated buffer, the
  1167. * pointer is returned as *sigp. The length of the calculated
  1168. * signature is returned via the sig_len pointer argument. The caller
  1169. * should free *sigp.
  1170. *
  1171. * @return: 0, on success, -ve on error
  1172. */
  1173. int (*sign)(struct image_sign_info *info,
  1174. const struct image_region region[],
  1175. int region_count, uint8_t **sigp, uint *sig_len);
  1176. /**
  1177. * add_verify_data() - Add verification information to FDT
  1178. *
  1179. * Add public key information to the FDT node, suitable for
  1180. * verification at run-time. The information added depends on the
  1181. * algorithm being used.
  1182. *
  1183. * @info: Specifies key and FIT information
  1184. * @keydest: Destination FDT blob for public key data
  1185. * @return: 0, on success, -ve on error
  1186. */
  1187. int (*add_verify_data)(struct image_sign_info *info, void *keydest);
  1188. /**
  1189. * verify() - Verify a signature against some data
  1190. *
  1191. * @info: Specifies key and FIT information
  1192. * @data: Pointer to the input data
  1193. * @data_len: Data length
  1194. * @sig: Signature
  1195. * @sig_len: Number of bytes in signature
  1196. * @return 0 if verified, -ve on error
  1197. */
  1198. int (*verify)(struct image_sign_info *info,
  1199. const struct image_region region[], int region_count,
  1200. uint8_t *sig, uint sig_len);
  1201. };
  1202. struct padding_algo {
  1203. const char *name;
  1204. int (*verify)(struct image_sign_info *info,
  1205. uint8_t *pad, int pad_len,
  1206. const uint8_t *hash, int hash_len);
  1207. };
  1208. /**
  1209. * image_get_checksum_algo() - Look up a checksum algorithm
  1210. *
  1211. * @param full_name Name of algorithm in the form "checksum,crypto"
  1212. * @return pointer to algorithm information, or NULL if not found
  1213. */
  1214. struct checksum_algo *image_get_checksum_algo(const char *full_name);
  1215. /**
  1216. * image_get_crypto_algo() - Look up a cryptosystem algorithm
  1217. *
  1218. * @param full_name Name of algorithm in the form "checksum,crypto"
  1219. * @return pointer to algorithm information, or NULL if not found
  1220. */
  1221. struct crypto_algo *image_get_crypto_algo(const char *full_name);
  1222. /**
  1223. * image_get_padding_algo() - Look up a padding algorithm
  1224. *
  1225. * @param name Name of padding algorithm
  1226. * @return pointer to algorithm information, or NULL if not found
  1227. */
  1228. struct padding_algo *image_get_padding_algo(const char *name);
  1229. #if IMAGE_ENABLE_FIT
  1230. /**
  1231. * fit_image_verify_required_sigs() - Verify signatures marked as 'required'
  1232. *
  1233. * @fit: FIT to check
  1234. * @image_noffset: Offset of image node to check
  1235. * @data: Image data to check
  1236. * @size: Size of image data
  1237. * @sig_blob: FDT containing public keys
  1238. * @no_sigsp: Returns 1 if no signatures were required, and
  1239. * therefore nothing was checked. The caller may wish
  1240. * to fall back to other mechanisms, or refuse to
  1241. * boot.
  1242. * @return 0 if all verified ok, <0 on error
  1243. */
  1244. int fit_image_verify_required_sigs(const void *fit, int image_noffset,
  1245. const char *data, size_t size, const void *sig_blob,
  1246. int *no_sigsp);
  1247. /**
  1248. * fit_image_check_sig() - Check a single image signature node
  1249. *
  1250. * @fit: FIT to check
  1251. * @noffset: Offset of signature node to check
  1252. * @data: Image data to check
  1253. * @size: Size of image data
  1254. * @required_keynode: Offset in the control FDT of the required key node,
  1255. * if any. If this is given, then the image wil not
  1256. * pass verification unless that key is used. If this is
  1257. * -1 then any signature will do.
  1258. * @err_msgp: In the event of an error, this will be pointed to a
  1259. * help error string to display to the user.
  1260. * @return 0 if all verified ok, <0 on error
  1261. */
  1262. int fit_image_check_sig(const void *fit, int noffset, const void *data,
  1263. size_t size, int required_keynode, char **err_msgp);
  1264. int fit_image_decrypt_data(const void *fit,
  1265. int image_noffset, int cipher_noffset,
  1266. const void *data, size_t size,
  1267. void **data_unciphered, size_t *size_unciphered);
  1268. /**
  1269. * fit_region_make_list() - Make a list of regions to hash
  1270. *
  1271. * Given a list of FIT regions (offset, size) provided by libfdt, create
  1272. * a list of regions (void *, size) for use by the signature creationg
  1273. * and verification code.
  1274. *
  1275. * @fit: FIT image to process
  1276. * @fdt_regions: Regions as returned by libfdt
  1277. * @count: Number of regions returned by libfdt
  1278. * @region: Place to put list of regions (NULL to allocate it)
  1279. * @return pointer to list of regions, or NULL if out of memory
  1280. */
  1281. struct image_region *fit_region_make_list(const void *fit,
  1282. struct fdt_region *fdt_regions, int count,
  1283. struct image_region *region);
  1284. static inline int fit_image_check_target_arch(const void *fdt, int node)
  1285. {
  1286. #ifndef USE_HOSTCC
  1287. return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT);
  1288. #else
  1289. return 0;
  1290. #endif
  1291. }
  1292. /*
  1293. * At present we only support ciphering on the host, and unciphering on the
  1294. * device
  1295. */
  1296. #if defined(USE_HOSTCC)
  1297. # if defined(CONFIG_FIT_CIPHER)
  1298. # define IMAGE_ENABLE_ENCRYPT 1
  1299. # define IMAGE_ENABLE_DECRYPT 1
  1300. # include <openssl/evp.h>
  1301. # else
  1302. # define IMAGE_ENABLE_ENCRYPT 0
  1303. # define IMAGE_ENABLE_DECRYPT 0
  1304. # endif
  1305. #else
  1306. # define IMAGE_ENABLE_ENCRYPT 0
  1307. # define IMAGE_ENABLE_DECRYPT CONFIG_IS_ENABLED(FIT_CIPHER)
  1308. #endif
  1309. /* Information passed to the ciphering routines */
  1310. struct image_cipher_info {
  1311. const char *keydir; /* Directory containing keys */
  1312. const char *keyname; /* Name of key to use */
  1313. const char *ivname; /* Name of IV to use */
  1314. const void *fit; /* Pointer to FIT blob */
  1315. int node_noffset; /* Offset of the cipher node */
  1316. const char *name; /* Algorithm name */
  1317. struct cipher_algo *cipher; /* Cipher algorithm information */
  1318. const void *fdt_blob; /* FDT containing key and IV */
  1319. const void *key; /* Value of the key */
  1320. const void *iv; /* Value of the IV */
  1321. size_t size_unciphered; /* Size of the unciphered data */
  1322. };
  1323. struct cipher_algo {
  1324. const char *name; /* Name of algorithm */
  1325. int key_len; /* Length of the key */
  1326. int iv_len; /* Length of the IV */
  1327. #if IMAGE_ENABLE_ENCRYPT
  1328. const EVP_CIPHER * (*calculate_type)(void);
  1329. #endif
  1330. int (*encrypt)(struct image_cipher_info *info,
  1331. const unsigned char *data, int data_len,
  1332. unsigned char **cipher, int *cipher_len);
  1333. int (*add_cipher_data)(struct image_cipher_info *info,
  1334. void *keydest, void *fit, int node_noffset);
  1335. int (*decrypt)(struct image_cipher_info *info,
  1336. const void *cipher, size_t cipher_len,
  1337. void **data, size_t *data_len);
  1338. };
  1339. int fit_image_cipher_get_algo(const void *fit, int noffset, char **algo);
  1340. struct cipher_algo *image_get_cipher_algo(const char *full_name);
  1341. #ifdef CONFIG_FIT_VERBOSE
  1342. #define fit_unsupported(msg) printf("! %s:%d " \
  1343. "FIT images not supported for '%s'\n", \
  1344. __FILE__, __LINE__, (msg))
  1345. #define fit_unsupported_reset(msg) printf("! %s:%d " \
  1346. "FIT images not supported for '%s' " \
  1347. "- must reset board to recover!\n", \
  1348. __FILE__, __LINE__, (msg))
  1349. #else
  1350. #define fit_unsupported(msg)
  1351. #define fit_unsupported_reset(msg)
  1352. #endif /* CONFIG_FIT_VERBOSE */
  1353. #endif /* CONFIG_FIT */
  1354. #if !defined(USE_HOSTCC)
  1355. #if defined(CONFIG_ANDROID_BOOT_IMAGE)
  1356. struct andr_img_hdr;
  1357. int android_image_check_header(const struct andr_img_hdr *hdr);
  1358. int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify,
  1359. ulong *os_data, ulong *os_len);
  1360. int android_image_get_ramdisk(const struct andr_img_hdr *hdr,
  1361. ulong *rd_data, ulong *rd_len);
  1362. int android_image_get_second(const struct andr_img_hdr *hdr,
  1363. ulong *second_data, ulong *second_len);
  1364. bool android_image_get_dtbo(ulong hdr_addr, ulong *addr, u32 *size);
  1365. bool android_image_get_dtb_by_index(ulong hdr_addr, u32 index, ulong *addr,
  1366. u32 *size);
  1367. ulong android_image_get_end(const struct andr_img_hdr *hdr);
  1368. ulong android_image_get_kload(const struct andr_img_hdr *hdr);
  1369. ulong android_image_get_kcomp(const struct andr_img_hdr *hdr);
  1370. void android_print_contents(const struct andr_img_hdr *hdr);
  1371. #if !defined(CONFIG_SPL_BUILD)
  1372. bool android_image_print_dtb_contents(ulong hdr_addr);
  1373. #endif
  1374. #endif /* CONFIG_ANDROID_BOOT_IMAGE */
  1375. #endif /* !USE_HOSTCC */
  1376. /**
  1377. * board_fit_config_name_match() - Check for a matching board name
  1378. *
  1379. * This is used when SPL loads a FIT containing multiple device tree files
  1380. * and wants to work out which one to use. The description of each one is
  1381. * passed to this function. The description comes from the 'description' field
  1382. * in each (FDT) image node.
  1383. *
  1384. * @name: Device tree description
  1385. * @return 0 if this device tree should be used, non-zero to try the next
  1386. */
  1387. int board_fit_config_name_match(const char *name);
  1388. /**
  1389. * board_fit_image_post_process() - Do any post-process on FIT binary data
  1390. *
  1391. * This is used to do any sort of image manipulation, verification, decryption
  1392. * etc. in a platform or board specific way. Obviously, anything done here would
  1393. * need to be comprehended in how the images were prepared before being injected
  1394. * into the FIT creation (i.e. the binary blobs would have been pre-processed
  1395. * before being added to the FIT image).
  1396. *
  1397. * @image: pointer to the image start pointer
  1398. * @size: pointer to the image size
  1399. * @return no return value (failure should be handled internally)
  1400. */
  1401. void board_fit_image_post_process(void **p_image, size_t *p_size);
  1402. #define FDT_ERROR ((ulong)(-1))
  1403. ulong fdt_getprop_u32(const void *fdt, int node, const char *prop);
  1404. /**
  1405. * fit_find_config_node() - Find the node for the best DTB in a FIT image
  1406. *
  1407. * A FIT image contains one or more DTBs. This function parses the
  1408. * configurations described in the FIT images and returns the node of
  1409. * the first matching DTB. To check if a DTB matches a board, this function
  1410. * calls board_fit_config_name_match(). If no matching DTB is found, it returns
  1411. * the node described by the default configuration if it exists.
  1412. *
  1413. * @fdt: pointer to flat device tree
  1414. * @return the node if found, -ve otherwise
  1415. */
  1416. int fit_find_config_node(const void *fdt);
  1417. /**
  1418. * Mapping of image types to function handlers to be invoked on the associated
  1419. * loaded images
  1420. *
  1421. * @type: Type of image, I.E. IH_TYPE_*
  1422. * @handler: Function to call on loaded image
  1423. */
  1424. struct fit_loadable_tbl {
  1425. int type;
  1426. /**
  1427. * handler() - Process a loaded image
  1428. *
  1429. * @data: Pointer to start of loaded image data
  1430. * @size: Size of loaded image data
  1431. */
  1432. void (*handler)(ulong data, size_t size);
  1433. };
  1434. /*
  1435. * Define a FIT loadable image type handler
  1436. *
  1437. * _type is a valid uimage_type ID as defined in the "Image Type" enum above
  1438. * _handler is the handler function to call after this image type is loaded
  1439. */
  1440. #define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \
  1441. ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \
  1442. .type = _type, \
  1443. .handler = _handler, \
  1444. }
  1445. /**
  1446. * fit_update - update storage with FIT image
  1447. * @fit: Pointer to FIT image
  1448. *
  1449. * Update firmware on storage using FIT image as input.
  1450. * The storage area to be update will be identified by the name
  1451. * in FIT and matching it to "dfu_alt_info" variable.
  1452. *
  1453. * Return: 0 on success, non-zero otherwise
  1454. */
  1455. int fit_update(const void *fit);
  1456. #endif /* __IMAGE_H__ */