image.h 49 KB

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