imagetool.h 10 KB

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