Fork of the vendor (Boundary Devices) u-boot for Reform 2, with minor tweaks. The goal is to migrate to mainstream u-boot or barebox ASAP. The main impediment so far is the 4GB RAM config.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.
 
 
 
 
 
 

307 lines
9.4 KiB

  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. 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_save_subimage - store data into a file
  173. * @file_name: name of the destination file
  174. * @file_data: data to be written
  175. * @file_len: the amount of data to store
  176. *
  177. * imagetool_save_subimage() store file_len bytes of data pointed by file_data
  178. * into the file name by file_name.
  179. *
  180. * returns:
  181. * zero in case of success or a negative value if fail.
  182. */
  183. int imagetool_save_subimage(
  184. const char *file_name,
  185. ulong file_data,
  186. ulong file_len);
  187. /**
  188. * imagetool_get_filesize() - Utility function to obtain the size of a file
  189. *
  190. * This function prints a message if an error occurs, showing the error that
  191. * was obtained.
  192. *
  193. * @params: mkimage parameters
  194. * @fname: filename to check
  195. * @return size of file, or -ve value on error
  196. */
  197. int imagetool_get_filesize(struct image_tool_params *params, const char *fname);
  198. /**
  199. * imagetool_get_source_date() - Get timestamp for build output.
  200. *
  201. * Gets a timestamp for embedding it in a build output. If set
  202. * SOURCE_DATE_EPOCH is used. Else the given fallback value is returned. Prints
  203. * an error message if SOURCE_DATE_EPOCH contains an invalid value and returns
  204. * 0.
  205. *
  206. * @params: mkimage parameters
  207. * @fallback: timestamp to use if SOURCE_DATE_EPOCH isn't set
  208. * @return timestamp based on SOURCE_DATE_EPOCH
  209. */
  210. time_t imagetool_get_source_date(
  211. struct image_tool_params *params,
  212. time_t fallback);
  213. /*
  214. * There is a c file associated with supported image type low level code
  215. * for ex. default_image.c, fit_image.c
  216. */
  217. void pbl_load_uboot(int fd, struct image_tool_params *mparams);
  218. #define ___cat(a, b) a ## b
  219. #define __cat(a, b) ___cat(a, b)
  220. /* we need some special handling for this host tool running eventually on
  221. * Darwin. The Mach-O section handling is a bit different than ELF section
  222. * handling. The differnces in detail are:
  223. * a) we have segments which have sections
  224. * b) we need a API call to get the respective section symbols */
  225. #if defined(__MACH__)
  226. #include <mach-o/getsect.h>
  227. #define INIT_SECTION(name) do { \
  228. unsigned long name ## _len; \
  229. char *__cat(pstart_, name) = getsectdata("__TEXT", \
  230. #name, &__cat(name, _len)); \
  231. char *__cat(pstop_, name) = __cat(pstart_, name) + \
  232. __cat(name, _len); \
  233. __cat(__start_, name) = (void *)__cat(pstart_, name); \
  234. __cat(__stop_, name) = (void *)__cat(pstop_, name); \
  235. } while (0)
  236. #define SECTION(name) __attribute__((section("__TEXT, " #name)))
  237. struct image_type_params **__start_image_type, **__stop_image_type;
  238. #else
  239. #define INIT_SECTION(name) /* no-op for ELF */
  240. #define SECTION(name) __attribute__((section(#name)))
  241. /* We construct a table of pointers in an ELF section (pointers generally
  242. * go unpadded by gcc). ld creates boundary syms for us. */
  243. extern struct image_type_params *__start_image_type[], *__stop_image_type[];
  244. #endif /* __MACH__ */
  245. #if !defined(__used)
  246. # if __GNUC__ == 3 && __GNUC_MINOR__ < 3
  247. # define __used __attribute__((__unused__))
  248. # else
  249. # define __used __attribute__((__used__))
  250. # endif
  251. #endif
  252. #define U_BOOT_IMAGE_TYPE( \
  253. _id, \
  254. _name, \
  255. _header_size, \
  256. _header, \
  257. _check_params, \
  258. _verify_header, \
  259. _print_header, \
  260. _set_header, \
  261. _extract_subimage, \
  262. _check_image_type, \
  263. _fflag_handle, \
  264. _vrec_header \
  265. ) \
  266. static struct image_type_params __cat(image_type_, _id) = \
  267. { \
  268. .name = _name, \
  269. .header_size = _header_size, \
  270. .hdr = _header, \
  271. .check_params = _check_params, \
  272. .verify_header = _verify_header, \
  273. .print_header = _print_header, \
  274. .set_header = _set_header, \
  275. .extract_subimage = _extract_subimage, \
  276. .check_image_type = _check_image_type, \
  277. .fflag_handle = _fflag_handle, \
  278. .vrec_header = _vrec_header \
  279. }; \
  280. static struct image_type_params *SECTION(image_type) __used \
  281. __cat(image_type_ptr_, _id) = &__cat(image_type_, _id)
  282. #endif /* _IMAGETOOL_H_ */