imagetool.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * (C) Copyright 2013
  4. *
  5. * Written by Guilherme Maciel Ferreira <guilherme.maciel.ferreira@gmail.com>
  6. */
  7. #ifndef _IMAGETOOL_H_
  8. #define _IMAGETOOL_H_
  9. #include "os_support.h"
  10. #include <errno.h>
  11. #include <fcntl.h>
  12. #include <stdbool.h>
  13. #include <stdio.h>
  14. #include <stdlib.h>
  15. #include <string.h>
  16. #include <sys/stat.h>
  17. #include <sys/types.h>
  18. #include <time.h>
  19. #include <unistd.h>
  20. #include <u-boot/sha1.h>
  21. #include <image.h>
  22. #include "fdt_host.h"
  23. #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
  24. #define __ALIGN_MASK(x, mask) (((x) + (mask)) & ~(mask))
  25. #define ALIGN(x, a) __ALIGN_MASK((x), (typeof(x))(a) - 1)
  26. #define IH_ARCH_DEFAULT IH_ARCH_INVALID
  27. /* Information about a file that needs to be placed into the FIT */
  28. struct content_info {
  29. struct content_info *next;
  30. int type; /* File type (IH_TYPE_...) */
  31. const char *fname;
  32. };
  33. /*
  34. * This structure defines all such variables those are initialized by
  35. * mkimage and dumpimage main core and need to be referred by image
  36. * type specific functions
  37. */
  38. struct image_tool_params {
  39. int dflag;
  40. int eflag;
  41. int fflag;
  42. int iflag;
  43. int lflag;
  44. int pflag;
  45. int vflag;
  46. int xflag;
  47. int skipcpy;
  48. int os;
  49. int arch;
  50. int type;
  51. int comp;
  52. char *dtc;
  53. unsigned int addr;
  54. unsigned int ep;
  55. char *imagename;
  56. char *imagename2;
  57. char *datafile;
  58. char *imagefile;
  59. char *cmdname;
  60. const char *outfile; /* Output filename */
  61. const char *keydir; /* Directory holding private keys */
  62. const char *keydest; /* Destination .dtb for public key */
  63. const char *keyfile; /* Filename of private or public key */
  64. const char *comment; /* Comment to add to signature node */
  65. /* Algorithm name to use for hashing/signing or NULL to use the one
  66. * specified in the its */
  67. const char *algo_name;
  68. int require_keys; /* 1 to mark signing keys as 'required' */
  69. int file_size; /* Total size of output file */
  70. int orig_file_size; /* Original size for file before padding */
  71. bool auto_its; /* Automatically create the .its file */
  72. int fit_image_type; /* Image type to put into the FIT */
  73. char *fit_ramdisk; /* Ramdisk file to include */
  74. struct content_info *content_head; /* List of files to include */
  75. struct content_info *content_tail;
  76. bool external_data; /* Store data outside the FIT */
  77. bool quiet; /* Don't output text in normal operation */
  78. unsigned int external_offset; /* Add padding to external data */
  79. int bl_len; /* Block length in byte for external data */
  80. const char *engine_id; /* Engine to use for signing */
  81. bool reset_timestamp; /* Reset the timestamp on an existing image */
  82. struct image_summary summary; /* results of signing process */
  83. };
  84. /*
  85. * image type specific variables and callback functions
  86. */
  87. struct image_type_params {
  88. /* name is an identification tag string for added support */
  89. char *name;
  90. /*
  91. * header size is local to the specific image type to be supported,
  92. * mkimage core treats this as number of bytes
  93. */
  94. uint32_t header_size;
  95. /* Image type header pointer */
  96. void *hdr;
  97. /*
  98. * There are several arguments that are passed on the command line
  99. * and are registered as flags in image_tool_params structure.
  100. * This callback function can be used to check the passed arguments
  101. * are in-lined with the image type to be supported
  102. *
  103. * Returns 1 if parameter check is successful
  104. */
  105. int (*check_params) (struct image_tool_params *);
  106. /*
  107. * This function is used by list command (i.e. mkimage -l <filename>)
  108. * image type verification code must be put here
  109. *
  110. * Returns 0 if image header verification is successful
  111. * otherwise, returns respective negative error codes
  112. */
  113. int (*verify_header) (unsigned char *, int, struct image_tool_params *);
  114. /* Prints image information abstracting from image header */
  115. void (*print_header) (const void *);
  116. /*
  117. * The header or image contents need to be set as per image type to
  118. * be generated using this callback function.
  119. * further output file post processing (for ex. checksum calculation,
  120. * padding bytes etc..) can also be done in this callback function.
  121. */
  122. void (*set_header) (void *, struct stat *, int,
  123. struct image_tool_params *);
  124. /*
  125. * This function is used by the command to retrieve a component
  126. * (sub-image) from the image (i.e. dumpimage -p <position>
  127. * -o <component-outfile> <image>). Thus the code to extract a file
  128. * from an image must be put here.
  129. *
  130. * Returns 0 if the file was successfully retrieved from the image,
  131. * or a negative value on error.
  132. */
  133. int (*extract_subimage)(void *, struct image_tool_params *);
  134. /*
  135. * Some image generation support for ex (default image type) supports
  136. * more than one type_ids, this callback function is used to check
  137. * whether input (-T <image_type>) is supported by registered image
  138. * generation/list low level code
  139. */
  140. int (*check_image_type) (uint8_t);
  141. /* This callback function will be executed if fflag is defined */
  142. int (*fflag_handle) (struct image_tool_params *);
  143. /*
  144. * This callback function will be executed for variable size record
  145. * It is expected to build this header in memory and return its length
  146. * and a pointer to it by using image_type_params.header_size and
  147. * image_type_params.hdr. The return value shall indicate if an
  148. * additional padding should be used when copying the data image
  149. * by returning the padding length.
  150. */
  151. int (*vrec_header) (struct image_tool_params *,
  152. struct image_type_params *);
  153. };
  154. /**
  155. * imagetool_get_type() - find the image type params for a given image type
  156. *
  157. * It scans all registers image type supports
  158. * checks the input type for each supported image type
  159. *
  160. * if successful,
  161. * returns respective image_type_params pointer if success
  162. * if input type_id is not supported by any of image_type_support
  163. * returns NULL
  164. */
  165. struct image_type_params *imagetool_get_type(int type);
  166. /*
  167. * imagetool_verify_print_header() - verifies the image header
  168. *
  169. * Scan registered image types and verify the image_header for each
  170. * supported image type. If verification is successful, this prints
  171. * the respective header.
  172. *
  173. * Return: 0 on success, negative if input image format does not match with
  174. * any of supported image types
  175. */
  176. int imagetool_verify_print_header(
  177. void *ptr,
  178. struct stat *sbuf,
  179. struct image_type_params *tparams,
  180. struct image_tool_params *params);
  181. /*
  182. * imagetool_verify_print_header_by_type() - verifies the image header
  183. *
  184. * Verify the image_header for the image type given by tparams.
  185. * If verification is successful, this prints the respective header.
  186. * @ptr: pointer the the image header
  187. * @sbuf: stat information about the file pointed to by ptr
  188. * @tparams: image type parameters
  189. * @params: mkimage parameters
  190. *
  191. * Return: 0 on success, negative if input image format does not match with
  192. * the given image type
  193. */
  194. int imagetool_verify_print_header_by_type(
  195. void *ptr,
  196. struct stat *sbuf,
  197. struct image_type_params *tparams,
  198. struct image_tool_params *params);
  199. /**
  200. * imagetool_save_subimage - store data into a file
  201. * @file_name: name of the destination file
  202. * @file_data: data to be written
  203. * @file_len: the amount of data to store
  204. *
  205. * imagetool_save_subimage() store file_len bytes of data pointed by file_data
  206. * into the file name by file_name.
  207. *
  208. * returns:
  209. * zero in case of success or a negative value if fail.
  210. */
  211. int imagetool_save_subimage(
  212. const char *file_name,
  213. ulong file_data,
  214. ulong file_len);
  215. /**
  216. * imagetool_get_filesize() - Utility function to obtain the size of a file
  217. *
  218. * This function prints a message if an error occurs, showing the error that
  219. * was obtained.
  220. *
  221. * @params: mkimage parameters
  222. * @fname: filename to check
  223. * Return: size of file, or -ve value on error
  224. */
  225. int imagetool_get_filesize(struct image_tool_params *params, const char *fname);
  226. /**
  227. * imagetool_get_source_date() - Get timestamp for build output.
  228. *
  229. * Gets a timestamp for embedding it in a build output. If set
  230. * SOURCE_DATE_EPOCH is used. Else the given fallback value is returned. Prints
  231. * an error message if SOURCE_DATE_EPOCH contains an invalid value and returns
  232. * 0.
  233. *
  234. * @cmdname: command name
  235. * @fallback: timestamp to use if SOURCE_DATE_EPOCH isn't set
  236. * Return: timestamp based on SOURCE_DATE_EPOCH
  237. */
  238. time_t imagetool_get_source_date(
  239. const char *cmdname,
  240. time_t fallback);
  241. /*
  242. * There is a c file associated with supported image type low level code
  243. * for ex. default_image.c, fit_image.c
  244. */
  245. void pbl_load_uboot(int fd, struct image_tool_params *mparams);
  246. int zynqmpbif_copy_image(int fd, struct image_tool_params *mparams);
  247. int imx8image_copy_image(int fd, struct image_tool_params *mparams);
  248. int imx8mimage_copy_image(int fd, struct image_tool_params *mparams);
  249. int rockchip_copy_image(int fd, struct image_tool_params *mparams);
  250. #define ___cat(a, b) a ## b
  251. #define __cat(a, b) ___cat(a, b)
  252. /* we need some special handling for this host tool running eventually on
  253. * Darwin. The Mach-O section handling is a bit different than ELF section
  254. * handling. The differnces in detail are:
  255. * a) we have segments which have sections
  256. * b) we need a API call to get the respective section symbols */
  257. #if defined(__MACH__)
  258. #include <mach-o/getsect.h>
  259. #include <mach-o/dyld.h>
  260. #define INIT_SECTION(name) do { \
  261. unsigned long name ## _len; \
  262. char *__cat(pstart_, name) = getsectdata("__DATA", \
  263. #name, &__cat(name, _len)); \
  264. __cat(pstart_, name) += _dyld_get_image_vmaddr_slide(0);\
  265. char *__cat(pstop_, name) = __cat(pstart_, name) + \
  266. __cat(name, _len); \
  267. __cat(__start_, name) = (void *)__cat(pstart_, name); \
  268. __cat(__stop_, name) = (void *)__cat(pstop_, name); \
  269. } while (0)
  270. #define SECTION(name) __attribute__((section("__DATA, " #name)))
  271. struct image_type_params **__start_image_type, **__stop_image_type;
  272. #else
  273. #define INIT_SECTION(name) /* no-op for ELF */
  274. #define SECTION(name) __attribute__((section(#name)))
  275. /* We construct a table of pointers in an ELF section (pointers generally
  276. * go unpadded by gcc). ld creates boundary syms for us. */
  277. extern struct image_type_params *__start_image_type[], *__stop_image_type[];
  278. #endif /* __MACH__ */
  279. #if !defined(__used)
  280. # if __GNUC__ == 3 && __GNUC_MINOR__ < 3
  281. # define __used __attribute__((__unused__))
  282. # else
  283. # define __used __attribute__((__used__))
  284. # endif
  285. #endif
  286. #define U_BOOT_IMAGE_TYPE( \
  287. _id, \
  288. _name, \
  289. _header_size, \
  290. _header, \
  291. _check_params, \
  292. _verify_header, \
  293. _print_header, \
  294. _set_header, \
  295. _extract_subimage, \
  296. _check_image_type, \
  297. _fflag_handle, \
  298. _vrec_header \
  299. ) \
  300. static struct image_type_params __cat(image_type_, _id) = \
  301. { \
  302. .name = _name, \
  303. .header_size = _header_size, \
  304. .hdr = _header, \
  305. .check_params = _check_params, \
  306. .verify_header = _verify_header, \
  307. .print_header = _print_header, \
  308. .set_header = _set_header, \
  309. .extract_subimage = _extract_subimage, \
  310. .check_image_type = _check_image_type, \
  311. .fflag_handle = _fflag_handle, \
  312. .vrec_header = _vrec_header \
  313. }; \
  314. static struct image_type_params *SECTION(image_type) __used \
  315. __cat(image_type_ptr_, _id) = &__cat(image_type_, _id)
  316. #endif /* _IMAGETOOL_H_ */