imagetool.h 9.3 KB

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