imximage.h 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * (C) Copyright 2009
  4. * Stefano Babic, DENX Software Engineering, sbabic@denx.de.
  5. */
  6. #ifndef _IMXIMAGE_H_
  7. #define _IMXIMAGE_H_
  8. #define MAX_HW_CFG_SIZE_V2 220 /* Max number of registers imx can set for v2 */
  9. #define MAX_PLUGIN_CODE_SIZE (64 * 1024)
  10. #define MAX_HW_CFG_SIZE_V1 60 /* Max number of registers imx can set for v1 */
  11. #define APP_CODE_BARKER 0xB1
  12. #define DCD_BARKER 0xB17219E9
  13. /* Specify the offset of the IVT in the IMX header as expected by BootROM */
  14. #define BOOTROM_IVT_HDR_OFFSET 0xC00
  15. /*
  16. * NOTE: This file must be kept in sync with arch/arm/include/asm/\
  17. * mach-imx/imximage.cfg because tools/imximage.c can not
  18. * cross-include headers from arch/arm/ and vice-versa.
  19. */
  20. #define CMD_DATA_STR "DATA"
  21. /* Initial Vector Table Offset */
  22. #define FLASH_OFFSET_UNDEFINED 0xFFFFFFFF
  23. #define FLASH_OFFSET_STANDARD 0x400
  24. #define FLASH_OFFSET_NAND FLASH_OFFSET_STANDARD
  25. #define FLASH_OFFSET_SD FLASH_OFFSET_STANDARD
  26. #define FLASH_OFFSET_SPI FLASH_OFFSET_STANDARD
  27. #define FLASH_OFFSET_ONENAND 0x100
  28. #define FLASH_OFFSET_NOR 0x1000
  29. #define FLASH_OFFSET_SATA FLASH_OFFSET_STANDARD
  30. #define FLASH_OFFSET_QSPI 0x1000
  31. /* Initial Load Region Size */
  32. #define FLASH_LOADSIZE_UNDEFINED 0xFFFFFFFF
  33. #define FLASH_LOADSIZE_STANDARD 0x1000
  34. #define FLASH_LOADSIZE_NAND FLASH_LOADSIZE_STANDARD
  35. #define FLASH_LOADSIZE_SD FLASH_LOADSIZE_STANDARD
  36. #define FLASH_LOADSIZE_SPI FLASH_LOADSIZE_STANDARD
  37. #define FLASH_LOADSIZE_ONENAND 0x400
  38. #define FLASH_LOADSIZE_NOR 0x0 /* entire image */
  39. #define FLASH_LOADSIZE_SATA FLASH_LOADSIZE_STANDARD
  40. #define FLASH_LOADSIZE_QSPI 0x0 /* entire image */
  41. /* Command tags and parameters */
  42. #define IVT_HEADER_TAG 0xD1
  43. #define IVT_VERSION 0x40
  44. #define DCD_HEADER_TAG 0xD2
  45. #define DCD_VERSION 0x40
  46. #define DCD_WRITE_DATA_COMMAND_TAG 0xCC
  47. #define DCD_WRITE_DATA_PARAM 0x4
  48. #define DCD_WRITE_CLR_BIT_PARAM 0xC
  49. #define DCD_WRITE_SET_BIT_PARAM 0x1C
  50. #define DCD_CHECK_DATA_COMMAND_TAG 0xCF
  51. #define DCD_CHECK_BITS_SET_PARAM 0x14
  52. #define DCD_CHECK_BITS_CLR_PARAM 0x04
  53. #ifndef __ASSEMBLY__
  54. enum imximage_cmd {
  55. CMD_INVALID,
  56. CMD_IMAGE_VERSION,
  57. CMD_BOOT_FROM,
  58. CMD_BOOT_OFFSET,
  59. CMD_WRITE_DATA,
  60. CMD_WRITE_CLR_BIT,
  61. CMD_WRITE_SET_BIT,
  62. CMD_CHECK_BITS_SET,
  63. CMD_CHECK_BITS_CLR,
  64. CMD_CSF,
  65. CMD_PLUGIN,
  66. };
  67. enum imximage_fld_types {
  68. CFG_INVALID = -1,
  69. CFG_COMMAND,
  70. CFG_REG_SIZE,
  71. CFG_REG_ADDRESS,
  72. CFG_REG_VALUE
  73. };
  74. enum imximage_version {
  75. IMXIMAGE_VER_INVALID = -1,
  76. IMXIMAGE_V1 = 1,
  77. IMXIMAGE_V2
  78. };
  79. typedef struct {
  80. uint32_t type; /* Type of pointer (byte, halfword, word, wait/read) */
  81. uint32_t addr; /* Address to write to */
  82. uint32_t value; /* Data to write */
  83. } dcd_type_addr_data_t;
  84. typedef struct {
  85. uint32_t barker; /* Barker for sanity check */
  86. uint32_t length; /* Device configuration length (without preamble) */
  87. } dcd_preamble_t;
  88. typedef struct {
  89. dcd_preamble_t preamble;
  90. dcd_type_addr_data_t addr_data[MAX_HW_CFG_SIZE_V1];
  91. } dcd_v1_t;
  92. typedef struct {
  93. uint32_t app_code_jump_vector;
  94. uint32_t app_code_barker;
  95. uint32_t app_code_csf;
  96. uint32_t dcd_ptr_ptr;
  97. uint32_t super_root_key;
  98. uint32_t dcd_ptr;
  99. uint32_t app_dest_ptr;
  100. } flash_header_v1_t;
  101. typedef struct {
  102. uint32_t length; /* Length of data to be read from flash */
  103. } flash_cfg_parms_t;
  104. typedef struct {
  105. flash_header_v1_t fhdr;
  106. dcd_v1_t dcd_table;
  107. flash_cfg_parms_t ext_header;
  108. } imx_header_v1_t;
  109. typedef struct {
  110. uint32_t addr;
  111. uint32_t value;
  112. } dcd_addr_data_t;
  113. typedef struct {
  114. uint8_t tag;
  115. uint16_t length;
  116. uint8_t version;
  117. } __attribute__((packed)) ivt_header_t;
  118. typedef struct {
  119. uint8_t tag;
  120. uint16_t length;
  121. uint8_t param;
  122. } __attribute__((packed)) write_dcd_command_t;
  123. struct dcd_v2_cmd {
  124. write_dcd_command_t write_dcd_command;
  125. dcd_addr_data_t addr_data[MAX_HW_CFG_SIZE_V2];
  126. };
  127. typedef struct {
  128. ivt_header_t header;
  129. struct dcd_v2_cmd dcd_cmd;
  130. uint32_t padding[1]; /* end up on an 8-byte boundary */
  131. } dcd_v2_t;
  132. typedef struct {
  133. uint32_t start;
  134. uint32_t size;
  135. uint32_t plugin;
  136. } boot_data_t;
  137. typedef struct {
  138. ivt_header_t header;
  139. uint32_t entry;
  140. uint32_t reserved1;
  141. uint32_t dcd_ptr;
  142. uint32_t boot_data_ptr;
  143. uint32_t self;
  144. uint32_t csf;
  145. uint32_t reserved2;
  146. } flash_header_v2_t;
  147. typedef struct {
  148. flash_header_v2_t fhdr;
  149. boot_data_t boot_data;
  150. union {
  151. dcd_v2_t dcd_table;
  152. char plugin_code[MAX_PLUGIN_CODE_SIZE];
  153. } data;
  154. } imx_header_v2_t;
  155. /* The header must be aligned to 4k on MX53 for NAND boot */
  156. struct imx_header {
  157. union {
  158. imx_header_v1_t hdr_v1;
  159. imx_header_v2_t hdr_v2;
  160. } header;
  161. };
  162. typedef void (*set_dcd_val_t)(struct imx_header *imxhdr,
  163. char *name, int lineno,
  164. int fld, uint32_t value,
  165. uint32_t off);
  166. typedef void (*set_dcd_param_t)(struct imx_header *imxhdr, uint32_t dcd_len,
  167. int32_t cmd);
  168. typedef void (*set_dcd_rst_t)(struct imx_header *imxhdr,
  169. uint32_t dcd_len,
  170. char *name, int lineno);
  171. typedef void (*set_imx_hdr_t)(struct imx_header *imxhdr, uint32_t dcd_len,
  172. uint32_t entry_point, uint32_t flash_offset);
  173. #endif /* __ASSEMBLY__ */
  174. #endif /* _IMXIMAGE_H_ */