mkimage.h 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148
  1. /*
  2. * (C) Copyright 2000-2004
  3. * DENX Software Engineering
  4. * Wolfgang Denk, wd@denx.de
  5. *
  6. * This program is free software; you can redistribute it and/or
  7. * modify it under the terms of the GNU General Public License as
  8. * published by the Free Software Foundation; either version 2 of
  9. * the License, or (at your option) any later version.
  10. *
  11. * This program is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. * GNU General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU General Public License
  17. * along with this program; if not, write to the Free Software
  18. * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  19. * MA 02111-1307 USA
  20. */
  21. #ifndef _MKIIMAGE_H_
  22. #define _MKIIMAGE_H_
  23. #include "os_support.h"
  24. #include <errno.h>
  25. #include <fcntl.h>
  26. #include <stdio.h>
  27. #include <stdlib.h>
  28. #include <string.h>
  29. #include <sys/stat.h>
  30. #include <time.h>
  31. #include <unistd.h>
  32. #include <sha1.h>
  33. #include "fdt_host.h"
  34. #undef MKIMAGE_DEBUG
  35. #ifdef MKIMAGE_DEBUG
  36. #define debug(fmt,args...) printf (fmt ,##args)
  37. #else
  38. #define debug(fmt,args...)
  39. #endif /* MKIMAGE_DEBUG */
  40. #define MKIMAGE_TMPFILE_SUFFIX ".tmp"
  41. #define MKIMAGE_MAX_TMPFILE_LEN 256
  42. #define MKIMAGE_DEFAULT_DTC_OPTIONS "-I dts -O dtb -p 500"
  43. #define MKIMAGE_MAX_DTC_CMDLINE_LEN 512
  44. #define MKIMAGE_DTC "dtc" /* assume dtc is in $PATH */
  45. /*
  46. * This structure defines all such variables those are initialized by
  47. * mkimage main core and need to be referred by image type specific
  48. * functions
  49. */
  50. struct mkimage_params {
  51. int dflag;
  52. int eflag;
  53. int fflag;
  54. int lflag;
  55. int vflag;
  56. int xflag;
  57. int os;
  58. int arch;
  59. int type;
  60. int comp;
  61. char *dtc;
  62. unsigned int addr;
  63. unsigned int ep;
  64. char *imagename;
  65. char *datafile;
  66. char *imagefile;
  67. char *cmdname;
  68. };
  69. /*
  70. * image type specific variables and callback functions
  71. */
  72. struct image_type_params {
  73. /* name is an identification tag string for added support */
  74. char *name;
  75. /*
  76. * header size is local to the specific image type to be supported,
  77. * mkimage core treats this as number of bytes
  78. */
  79. uint32_t header_size;
  80. /* Image type header pointer */
  81. void *hdr;
  82. /*
  83. * There are several arguments that are passed on the command line
  84. * and are registered as flags in mkimage_params structure.
  85. * This callback function can be used to check the passed arguments
  86. * are in-lined with the image type to be supported
  87. *
  88. * Returns 1 if parameter check is successful
  89. */
  90. int (*check_params) (struct mkimage_params *);
  91. /*
  92. * This function is used by list command (i.e. mkimage -l <filename>)
  93. * image type verification code must be put here
  94. *
  95. * Returns 0 if image header verification is successful
  96. * otherwise, returns respective negative error codes
  97. */
  98. int (*verify_header) (unsigned char *, int, struct mkimage_params *);
  99. /* Prints image information abstracting from image header */
  100. void (*print_header) (const void *);
  101. /*
  102. * The header or image contents need to be set as per image type to
  103. * be generated using this callback function.
  104. * further output file post processing (for ex. checksum calculation,
  105. * padding bytes etc..) can also be done in this callback function.
  106. */
  107. void (*set_header) (void *, struct stat *, int,
  108. struct mkimage_params *);
  109. /*
  110. * Some image generation support for ex (default image type) supports
  111. * more than one type_ids, this callback function is used to check
  112. * whether input (-T <image_type>) is supported by registered image
  113. * generation/list low level code
  114. */
  115. int (*check_image_type) (uint8_t);
  116. /* This callback function will be executed if fflag is defined */
  117. int (*fflag_handle) (struct mkimage_params *);
  118. /* pointer to the next registered entry in linked list */
  119. struct image_type_params *next;
  120. };
  121. /*
  122. * Exported functions
  123. */
  124. void mkimage_register (struct image_type_params *tparams);
  125. /*
  126. * There is a c file associated with supported image type low level code
  127. * for ex. default_image.c, fit_image.c
  128. * init is the only function referred by mkimage core.
  129. * to avoid a single lined header file, you can define them here
  130. *
  131. * Supported image types init functions
  132. */
  133. void init_kwb_image_type (void);
  134. void init_imx_image_type (void);
  135. void init_default_image_type (void);
  136. void init_fit_image_type (void);
  137. void init_ubl_image_type(void);
  138. #endif /* _MKIIMAGE_H_ */