imagetool.h 10 KB

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