mtk_image.h 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * MediaTek BootROM header definitions
  4. *
  5. * Copyright (C) 2018 MediaTek Inc.
  6. * Author: Weijie Gao <weijie.gao@mediatek.com>
  7. */
  8. #ifndef _MTK_IMAGE_H
  9. #define _MTK_IMAGE_H
  10. /* Device header definitions, all fields are little-endian */
  11. /* Header for NOR/SD/eMMC */
  12. union gen_boot_header {
  13. struct {
  14. char name[12];
  15. uint32_t version;
  16. uint32_t size;
  17. };
  18. uint8_t pad[0x200];
  19. };
  20. #define EMMC_BOOT_NAME "EMMC_BOOT"
  21. #define SF_BOOT_NAME "SF_BOOT"
  22. #define SDMMC_BOOT_NAME "SDMMC_BOOT"
  23. /* Header for NAND */
  24. union nand_boot_header {
  25. struct {
  26. char name[12];
  27. char version[4];
  28. char id[8];
  29. uint16_t ioif;
  30. uint16_t pagesize;
  31. uint16_t addrcycles;
  32. uint16_t oobsize;
  33. uint16_t pages_of_block;
  34. uint16_t numblocks;
  35. uint16_t writesize_shift;
  36. uint16_t erasesize_shift;
  37. uint8_t dummy[60];
  38. uint8_t ecc_parity[28];
  39. };
  40. uint8_t data[0x80];
  41. };
  42. #define NAND_BOOT_NAME "BOOTLOADER!"
  43. #define NAND_BOOT_VERSION "V006"
  44. #define NAND_BOOT_ID "NFIINFO"
  45. /* BootROM layout header */
  46. struct brom_layout_header {
  47. char name[8];
  48. uint32_t version;
  49. uint32_t header_size;
  50. uint32_t total_size;
  51. uint32_t magic;
  52. uint32_t type;
  53. uint32_t header_size_2;
  54. uint32_t total_size_2;
  55. uint32_t unused;
  56. };
  57. #define BRLYT_NAME "BRLYT"
  58. #define BRLYT_MAGIC 0x42424242
  59. enum brlyt_img_type {
  60. BRLYT_TYPE_INVALID = 0,
  61. BRLYT_TYPE_NAND = 0x10002,
  62. BRLYT_TYPE_EMMC = 0x10005,
  63. BRLYT_TYPE_NOR = 0x10007,
  64. BRLYT_TYPE_SDMMC = 0x10008,
  65. BRLYT_TYPE_SNAND = 0x10009
  66. };
  67. /* Combined device header for NOR/SD/eMMC */
  68. struct gen_device_header {
  69. union gen_boot_header boot;
  70. union {
  71. struct brom_layout_header brlyt;
  72. uint8_t brlyt_pad[0x400];
  73. };
  74. };
  75. /* BootROM header definitions */
  76. struct gfh_common_header {
  77. uint8_t magic[3];
  78. uint8_t version;
  79. uint16_t size;
  80. uint16_t type;
  81. };
  82. #define GFH_HEADER_MAGIC "MMM"
  83. #define GFH_TYPE_FILE_INFO 0
  84. #define GFH_TYPE_BL_INFO 1
  85. #define GFH_TYPE_BROM_CFG 7
  86. #define GFH_TYPE_BL_SEC_KEY 3
  87. #define GFH_TYPE_ANTI_CLONE 2
  88. #define GFH_TYPE_BROM_SEC_CFG 8
  89. struct gfh_file_info {
  90. struct gfh_common_header gfh;
  91. char name[12];
  92. uint32_t unused;
  93. uint16_t file_type;
  94. uint8_t flash_type;
  95. uint8_t sig_type;
  96. uint32_t load_addr;
  97. uint32_t total_size;
  98. uint32_t max_size;
  99. uint32_t hdr_size;
  100. uint32_t sig_size;
  101. uint32_t jump_offset;
  102. uint32_t processed;
  103. };
  104. #define GFH_FILE_INFO_NAME "FILE_INFO"
  105. #define GFH_FLASH_TYPE_GEN 5
  106. #define GFH_FLASH_TYPE_NAND 2
  107. #define GFH_SIG_TYPE_NONE 0
  108. #define GFH_SIG_TYPE_SHA256 1
  109. struct gfh_bl_info {
  110. struct gfh_common_header gfh;
  111. uint32_t attr;
  112. };
  113. struct gfh_brom_cfg {
  114. struct gfh_common_header gfh;
  115. uint32_t cfg_bits;
  116. uint32_t usbdl_by_auto_detect_timeout_ms;
  117. uint8_t unused[0x45];
  118. uint8_t jump_bl_arm64;
  119. uint8_t unused2[2];
  120. uint32_t usbdl_by_kcol0_timeout_ms;
  121. uint32_t usbdl_by_flag_timeout_ms;
  122. uint32_t pad;
  123. };
  124. #define GFH_BROM_CFG_USBDL_BY_AUTO_DETECT_TIMEOUT_EN 0x02
  125. #define GFH_BROM_CFG_USBDL_AUTO_DETECT_DIS 0x10
  126. #define GFH_BROM_CFG_USBDL_BY_KCOL0_TIMEOUT_EN 0x80
  127. #define GFH_BROM_CFG_USBDL_BY_FLAG_TIMEOUT_EN 0x100
  128. #define GFH_BROM_CFG_JUMP_BL_ARM64_EN 0x1000
  129. #define GFH_BROM_CFG_JUMP_BL_ARM64 0x64
  130. struct gfh_bl_sec_key {
  131. struct gfh_common_header gfh;
  132. uint8_t pad[0x20c];
  133. };
  134. struct gfh_anti_clone {
  135. struct gfh_common_header gfh;
  136. uint8_t ac_b2k;
  137. uint8_t ac_b2c;
  138. uint16_t pad;
  139. uint32_t ac_offset;
  140. uint32_t ac_len;
  141. };
  142. struct gfh_brom_sec_cfg {
  143. struct gfh_common_header gfh;
  144. uint32_t cfg_bits;
  145. char customer_name[0x20];
  146. uint32_t pad;
  147. };
  148. #define BROM_SEC_CFG_JTAG_EN 1
  149. #define BROM_SEC_CFG_UART_EN 2
  150. struct gfh_header {
  151. struct gfh_file_info file_info;
  152. struct gfh_bl_info bl_info;
  153. struct gfh_brom_cfg brom_cfg;
  154. struct gfh_bl_sec_key bl_sec_key;
  155. struct gfh_anti_clone anti_clone;
  156. struct gfh_brom_sec_cfg brom_sec_cfg;
  157. };
  158. /* LK image header */
  159. union lk_hdr {
  160. struct {
  161. uint32_t magic;
  162. uint32_t size;
  163. char name[32];
  164. uint32_t loadaddr;
  165. uint32_t mode;
  166. };
  167. uint8_t data[512];
  168. };
  169. #define LK_PART_MAGIC 0x58881688
  170. #endif /* _MTK_IMAGE_H */