imx8image.h 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * Copyright 2018 NXP
  4. *
  5. * Peng Fan <peng.fan@nxp.com>
  6. */
  7. #ifndef _IMX8IMAGE_H_
  8. #define _IMX8IMAGE_H_
  9. #include <image.h>
  10. #include <inttypes.h>
  11. #include "imagetool.h"
  12. #define __packed __attribute__((packed))
  13. #define IV_MAX_LEN 32
  14. #define HASH_MAX_LEN 64
  15. #define MAX_NUM_IMGS 6
  16. #define MAX_NUM_SRK_RECORDS 4
  17. #define IVT_HEADER_TAG_B0 0x87
  18. #define IVT_VERSION_B0 0x00
  19. #define IMG_FLAG_HASH_SHA256 0x000
  20. #define IMG_FLAG_HASH_SHA384 0x100
  21. #define IMG_FLAG_HASH_SHA512 0x200
  22. #define IMG_FLAG_ENCRYPTED_MASK 0x400
  23. #define IMG_FLAG_ENCRYPTED_SHIFT 0x0A
  24. #define IMG_FLAG_BOOTFLAGS_MASK 0xFFFF0000
  25. #define IMG_FLAG_BOOTFLAGS_SHIFT 0x10
  26. #define IMG_ARRAY_ENTRY_SIZE 128
  27. #define HEADER_IMG_ARRAY_OFFSET 0x10
  28. #define HASH_TYPE_SHA_256 256
  29. #define HASH_TYPE_SHA_384 384
  30. #define HASH_TYPE_SHA_512 512
  31. #define IMAGE_HASH_ALGO_DEFAULT 384
  32. #define IMAGE_PADDING_DEFAULT 0x1000
  33. #define DCD_ENTRY_ADDR_IN_SCFW 0x240
  34. #define CONTAINER_ALIGNMENT 0x400
  35. #define CONTAINER_FLAGS_DEFAULT 0x10
  36. #define CONTAINER_FUSE_DEFAULT 0x0
  37. #define SIGNATURE_BLOCK_HEADER_LENGTH 0x10
  38. #define MAX_NUM_OF_CONTAINER 2
  39. #define FIRST_CONTAINER_HEADER_LENGTH 0x400
  40. #define BOOT_IMG_META_MU_RID_SHIFT 10
  41. #define BOOT_IMG_META_PART_ID_SHIFT 20
  42. #define IMAGE_A35_DEFAULT_META(PART) (((PART == 0) ? \
  43. PARTITION_ID_AP : PART) << \
  44. BOOT_IMG_META_PART_ID_SHIFT | \
  45. SC_R_MU_0A << \
  46. BOOT_IMG_META_MU_RID_SHIFT | \
  47. SC_R_A35_0)
  48. #define IMAGE_A53_DEFAULT_META(PART) (((PART == 0) ? \
  49. PARTITION_ID_AP : PART) << \
  50. BOOT_IMG_META_PART_ID_SHIFT | \
  51. SC_R_MU_0A << \
  52. BOOT_IMG_META_MU_RID_SHIFT | \
  53. SC_R_A53_0)
  54. #define IMAGE_A72_DEFAULT_META(PART) (((PART == 0) ? \
  55. PARTITION_ID_AP : PART) << \
  56. BOOT_IMG_META_PART_ID_SHIFT | \
  57. SC_R_MU_0A << \
  58. BOOT_IMG_META_MU_RID_SHIFT | \
  59. SC_R_A72_0)
  60. #define IMAGE_M4_0_DEFAULT_META(PART) (((PART == 0) ? \
  61. PARTITION_ID_M4 : PART) << \
  62. BOOT_IMG_META_PART_ID_SHIFT | \
  63. SC_R_M4_0_MU_1A << \
  64. BOOT_IMG_META_MU_RID_SHIFT | \
  65. SC_R_M4_0_PID0)
  66. #define IMAGE_M4_1_DEFAULT_META(PART) (((PART == 0) ? \
  67. PARTITION_ID_M4 : PART) << \
  68. BOOT_IMG_META_PART_ID_SHIFT | \
  69. SC_R_M4_1_MU_1A << \
  70. BOOT_IMG_META_MU_RID_SHIFT | \
  71. SC_R_M4_1_PID0)
  72. #define CONTAINER_IMAGE_ARRAY_START_OFFSET 0x2000
  73. typedef struct {
  74. uint8_t version;
  75. uint16_t length;
  76. uint8_t tag;
  77. uint16_t srk_table_offset;
  78. uint16_t cert_offset;
  79. uint16_t blob_offset;
  80. uint16_t signature_offset;
  81. uint32_t reserved;
  82. } __packed sig_blk_hdr_t;
  83. typedef struct {
  84. uint32_t offset;
  85. uint32_t size;
  86. uint64_t dst;
  87. uint64_t entry;
  88. uint32_t hab_flags;
  89. uint32_t meta;
  90. uint8_t hash[HASH_MAX_LEN];
  91. uint8_t iv[IV_MAX_LEN];
  92. } __packed boot_img_t;
  93. typedef struct {
  94. uint8_t version;
  95. uint16_t length;
  96. uint8_t tag;
  97. uint32_t flags;
  98. uint16_t sw_version;
  99. uint8_t fuse_version;
  100. uint8_t num_images;
  101. uint16_t sig_blk_offset;
  102. uint16_t reserved;
  103. boot_img_t img[MAX_NUM_IMGS];
  104. sig_blk_hdr_t sig_blk_hdr;
  105. uint32_t sigblk_size;
  106. uint32_t padding;
  107. } __packed flash_header_v3_t;
  108. typedef struct {
  109. flash_header_v3_t fhdr[MAX_NUM_OF_CONTAINER];
  110. } __packed imx_header_v3_t;
  111. struct image_array {
  112. char *name;
  113. unsigned int core_type;
  114. unsigned int core_id;
  115. unsigned int load_addr;
  116. };
  117. enum imx8image_cmd {
  118. CMD_INVALID,
  119. CMD_BOOT_FROM,
  120. CMD_FUSE_VERSION,
  121. CMD_SW_VERSION,
  122. CMD_MSG_BLOCK,
  123. CMD_FILEOFF,
  124. CMD_FLAG,
  125. CMD_APPEND,
  126. CMD_PARTITION,
  127. CMD_SOC_TYPE,
  128. CMD_CONTAINER,
  129. CMD_IMAGE,
  130. CMD_DATA
  131. };
  132. enum imx8image_core_type {
  133. CFG_CORE_INVALID,
  134. CFG_SCU,
  135. CFG_M40,
  136. CFG_M41,
  137. CFG_A35,
  138. CFG_A53,
  139. CFG_A72
  140. };
  141. enum imx8image_fld_types {
  142. CFG_INVALID = -1,
  143. CFG_COMMAND,
  144. CFG_CORE_TYPE,
  145. CFG_IMAGE_NAME,
  146. CFG_LOAD_ADDR
  147. };
  148. typedef enum SOC_TYPE {
  149. NONE = 0,
  150. QX,
  151. QM
  152. } soc_type_t;
  153. typedef enum option_type {
  154. NO_IMG = 0,
  155. DCD,
  156. SCFW,
  157. SECO,
  158. M40,
  159. M41,
  160. AP,
  161. OUTPUT,
  162. SCD,
  163. CSF,
  164. FLAG,
  165. DEVICE,
  166. NEW_CONTAINER,
  167. APPEND,
  168. DATA,
  169. PARTITION,
  170. FILEOFF,
  171. MSG_BLOCK
  172. } option_type_t;
  173. typedef struct {
  174. option_type_t option;
  175. char *filename;
  176. uint64_t src;
  177. uint64_t dst;
  178. uint64_t entry;
  179. uint64_t ext;
  180. } image_t;
  181. #define CORE_SC 1
  182. #define CORE_CM4_0 2
  183. #define CORE_CM4_1 3
  184. #define CORE_CA53 4
  185. #define CORE_CA35 4
  186. #define CORE_CA72 5
  187. #define CORE_SECO 6
  188. #define SC_R_OTP 357U
  189. #define SC_R_DEBUG 354U
  190. #define SC_R_ROM_0 236U
  191. #define MSG_DEBUG_EN SC_R_DEBUG
  192. #define MSG_FUSE SC_R_OTP
  193. #define MSG_FIELD SC_R_ROM_0
  194. #define IMG_TYPE_CSF 0x01 /* CSF image type */
  195. #define IMG_TYPE_SCD 0x02 /* SCD image type */
  196. #define IMG_TYPE_EXEC 0x03 /* Executable image type */
  197. #define IMG_TYPE_DATA 0x04 /* Data image type */
  198. #define IMG_TYPE_DCD_DDR 0x05 /* DCD/DDR image type */
  199. #define IMG_TYPE_SECO 0x06 /* SECO image type */
  200. #define IMG_TYPE_PROV 0x07 /* Provisioning image type */
  201. #define IMG_TYPE_DEK 0x08 /* DEK validation type */
  202. #define IMG_TYPE_SHIFT 0
  203. #define IMG_TYPE_MASK 0x1f
  204. #define IMG_TYPE(x) (((x) & IMG_TYPE_MASK) >> IMG_TYPE_SHIFT)
  205. #define BOOT_IMG_FLAGS_CORE_MASK 0xF
  206. #define BOOT_IMG_FLAGS_CORE_SHIFT 0x04
  207. #define BOOT_IMG_FLAGS_CPU_RID_MASK 0x3FF0
  208. #define BOOT_IMG_FLAGS_CPU_RID_SHIFT 4
  209. #define BOOT_IMG_FLAGS_MU_RID_MASK 0xFFC000
  210. #define BOOT_IMG_FLAGS_MU_RID_SHIFT 14
  211. #define BOOT_IMG_FLAGS_PARTITION_ID_MASK 0x1F000000
  212. #define BOOT_IMG_FLAGS_PARTITION_ID_SHIFT 24
  213. /* Resource id used in scfw */
  214. #define SC_R_A35_0 508
  215. #define SC_R_A53_0 1
  216. #define SC_R_A72_0 6
  217. #define SC_R_MU_0A 213
  218. #define SC_R_M4_0_PID0 278
  219. #define SC_R_M4_0_MU_1A 297
  220. #define SC_R_M4_1_PID0 298
  221. #define SC_R_M4_1_MU_1A 317
  222. #define PARTITION_ID_M4 0
  223. #define PARTITION_ID_AP 1
  224. #define IMG_STACK_SIZE 32
  225. #define append(p, s, l) do { \
  226. memcpy((p), (uint8_t *)(s), (l)); (p) += (l); \
  227. } while (0)
  228. #endif