imagetool.h 8.7 KB

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