imagetool.h 10 KB

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