hab.h 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * Copyright (C) 2012-2015 Freescale Semiconductor, Inc. All Rights Reserved.
  4. *
  5. */
  6. #ifndef __SECURE_MX6Q_H__
  7. #define __SECURE_MX6Q_H__
  8. #include <linux/types.h>
  9. #include <linux/compiler.h>
  10. /*
  11. * IVT header definitions
  12. * Security Reference Manual for i.MX 7Dual and 7Solo Applications Processors,
  13. * Rev. 0, 03/2017
  14. * Section : 6.7.1.1
  15. */
  16. #define IVT_HEADER_MAGIC 0xD1
  17. #define IVT_TOTAL_LENGTH 0x20
  18. struct __packed ivt_header {
  19. uint8_t magic;
  20. uint16_t length;
  21. uint8_t version;
  22. };
  23. struct ivt {
  24. struct ivt_header hdr; /* IVT header above */
  25. uint32_t entry; /* Absolute address of first instruction */
  26. uint32_t reserved1; /* Reserved should be zero */
  27. uint32_t dcd; /* Absolute address of the image DCD */
  28. uint32_t boot; /* Absolute address of the boot data */
  29. uint32_t self; /* Absolute address of the IVT */
  30. uint32_t csf; /* Absolute address of the CSF */
  31. uint32_t reserved2; /* Reserved should be zero */
  32. };
  33. struct __packed hab_hdr {
  34. u8 tag; /* Tag field */
  35. u8 len[2]; /* Length field in bytes (big-endian) */
  36. u8 par; /* Parameters field */
  37. };
  38. /* Default event structure */
  39. struct __packed evt_def {
  40. struct hab_hdr hdr; /* Header */
  41. uint32_t sts; /* Status */
  42. uint32_t ctx; /* Default context */
  43. uint8_t *data; /* Default data location */
  44. size_t bytes; /* Size of default data */
  45. };
  46. /* -------- start of HAB API updates ------------*/
  47. /* The following are taken from HAB4 SIS */
  48. /* Status definitions */
  49. enum hab_status {
  50. HAB_STS_ANY = 0x00,
  51. HAB_FAILURE = 0x33,
  52. HAB_WARNING = 0x69,
  53. HAB_SUCCESS = 0xf0
  54. };
  55. /* Security Configuration definitions */
  56. enum hab_config {
  57. HAB_CFG_RETURN = 0x33, /* < Field Return IC */
  58. HAB_CFG_OPEN = 0xf0, /* < Non-secure IC */
  59. HAB_CFG_CLOSED = 0xcc /* < Secure IC */
  60. };
  61. /* State definitions */
  62. enum hab_state {
  63. HAB_STATE_INITIAL = 0x33, /* Initialising state (transitory) */
  64. HAB_STATE_CHECK = 0x55, /* Check state (non-secure) */
  65. HAB_STATE_NONSECURE = 0x66, /* Non-secure state */
  66. HAB_STATE_TRUSTED = 0x99, /* Trusted state */
  67. HAB_STATE_SECURE = 0xaa, /* Secure state */
  68. HAB_STATE_FAIL_SOFT = 0xcc, /* Soft fail state */
  69. HAB_STATE_FAIL_HARD = 0xff, /* Hard fail state (terminal) */
  70. HAB_STATE_NONE = 0xf0, /* No security state machine */
  71. HAB_STATE_MAX
  72. };
  73. enum hab_reason {
  74. HAB_RSN_ANY = 0x00, /* Match any reason */
  75. HAB_ENG_FAIL = 0x30, /* Engine failure */
  76. HAB_INV_ADDRESS = 0x22, /* Invalid address: access denied */
  77. HAB_INV_ASSERTION = 0x0c, /* Invalid assertion */
  78. HAB_INV_CALL = 0x28, /* Function called out of sequence */
  79. HAB_INV_CERTIFICATE = 0x21, /* Invalid certificate */
  80. HAB_INV_COMMAND = 0x06, /* Invalid command: command malformed */
  81. HAB_INV_CSF = 0x11, /* Invalid csf */
  82. HAB_INV_DCD = 0x27, /* Invalid dcd */
  83. HAB_INV_INDEX = 0x0f, /* Invalid index: access denied */
  84. HAB_INV_IVT = 0x05, /* Invalid ivt */
  85. HAB_INV_KEY = 0x1d, /* Invalid key */
  86. HAB_INV_RETURN = 0x1e, /* Failed callback function */
  87. HAB_INV_SIGNATURE = 0x18, /* Invalid signature */
  88. HAB_INV_SIZE = 0x17, /* Invalid data size */
  89. HAB_MEM_FAIL = 0x2e, /* Memory failure */
  90. HAB_OVR_COUNT = 0x2b, /* Expired poll count */
  91. HAB_OVR_STORAGE = 0x2d, /* Exhausted storage region */
  92. HAB_UNS_ALGORITHM = 0x12, /* Unsupported algorithm */
  93. HAB_UNS_COMMAND = 0x03, /* Unsupported command */
  94. HAB_UNS_ENGINE = 0x0a, /* Unsupported engine */
  95. HAB_UNS_ITEM = 0x24, /* Unsupported configuration item */
  96. HAB_UNS_KEY = 0x1b, /* Unsupported key type/parameters */
  97. HAB_UNS_PROTOCOL = 0x14, /* Unsupported protocol */
  98. HAB_UNS_STATE = 0x09, /* Unsuitable state */
  99. HAB_RSN_MAX
  100. };
  101. enum hab_context {
  102. HAB_CTX_ANY = 0x00, /* Match any context */
  103. HAB_CTX_FAB = 0xff, /* Event logged in hab_fab_test() */
  104. HAB_CTX_ENTRY = 0xe1, /* Event logged in hab_rvt.entry() */
  105. HAB_CTX_TARGET = 0x33, /* Event logged in hab_rvt.check_target() */
  106. HAB_CTX_AUTHENTICATE = 0x0a,/* Logged in hab_rvt.authenticate_image() */
  107. HAB_CTX_DCD = 0xdd, /* Event logged in hab_rvt.run_dcd() */
  108. HAB_CTX_CSF = 0xcf, /* Event logged in hab_rvt.run_csf() */
  109. HAB_CTX_COMMAND = 0xc0, /* Event logged executing csf/dcd command */
  110. HAB_CTX_AUT_DAT = 0xdb, /* Authenticated data block */
  111. HAB_CTX_ASSERT = 0xa0, /* Event logged in hab_rvt.assert() */
  112. HAB_CTX_EXIT = 0xee, /* Event logged in hab_rvt.exit() */
  113. HAB_CTX_MAX
  114. };
  115. enum hab_target {
  116. HAB_TGT_MEMORY = 0x0f,
  117. HAB_TGT_PERIPHERAL = 0xf0,
  118. HAB_TGT_ANY = 0x55,
  119. };
  120. struct imx_sec_config_fuse_t {
  121. int bank;
  122. int word;
  123. };
  124. #if defined(CONFIG_IMX_HAB)
  125. extern struct imx_sec_config_fuse_t const imx_sec_config_fuse;
  126. #endif
  127. /*Function prototype description*/
  128. typedef enum hab_status hab_rvt_report_event_t(enum hab_status, uint32_t,
  129. uint8_t* , size_t*);
  130. typedef enum hab_status hab_rvt_report_status_t(enum hab_config *,
  131. enum hab_state *);
  132. typedef enum hab_status hab_loader_callback_f_t(void**, size_t*, const void*);
  133. typedef enum hab_status hab_rvt_entry_t(void);
  134. typedef enum hab_status hab_rvt_exit_t(void);
  135. typedef void *hab_rvt_authenticate_image_t(uint8_t, ptrdiff_t,
  136. void **, size_t *, hab_loader_callback_f_t);
  137. typedef enum hab_status hab_rvt_check_target_t(enum hab_target, const void *,
  138. size_t);
  139. typedef void hab_rvt_failsafe_t(void);
  140. typedef void hapi_clock_init_t(void);
  141. #define HAB_ENG_ANY 0x00 /* Select first compatible engine */
  142. #define HAB_ENG_SCC 0x03 /* Security controller */
  143. #define HAB_ENG_RTIC 0x05 /* Run-time integrity checker */
  144. #define HAB_ENG_SAHARA 0x06 /* Crypto accelerator */
  145. #define HAB_ENG_CSU 0x0a /* Central Security Unit */
  146. #define HAB_ENG_SRTC 0x0c /* Secure clock */
  147. #define HAB_ENG_DCP 0x1b /* Data Co-Processor */
  148. #define HAB_ENG_CAAM 0x1d /* CAAM */
  149. #define HAB_ENG_SNVS 0x1e /* Secure Non-Volatile Storage */
  150. #define HAB_ENG_OCOTP 0x21 /* Fuse controller */
  151. #define HAB_ENG_DTCP 0x22 /* DTCP co-processor */
  152. #define HAB_ENG_ROM 0x36 /* Protected ROM area */
  153. #define HAB_ENG_HDCP 0x24 /* HDCP co-processor */
  154. #define HAB_ENG_RTL 0x77 /* RTL simulation engine */
  155. #define HAB_ENG_SW 0xff /* Software engine */
  156. #ifdef CONFIG_ARM64
  157. #ifdef CONFIG_IMX8MQ
  158. #define HAB_RVT_BASE 0x00000880
  159. #else
  160. #define HAB_RVT_BASE 0x00000900
  161. #endif
  162. #define HAB_RVT_ENTRY (*(ulong *)(HAB_RVT_BASE + 0x08))
  163. #define HAB_RVT_EXIT (*(ulong *)(HAB_RVT_BASE + 0x10))
  164. #define HAB_RVT_CHECK_TARGET (*(ulong *)(HAB_RVT_BASE + 0x18))
  165. #define HAB_RVT_AUTHENTICATE_IMAGE (*(ulong *)(HAB_RVT_BASE + 0x20))
  166. #define HAB_RVT_REPORT_EVENT (*(ulong *)(HAB_RVT_BASE + 0x40))
  167. #define HAB_RVT_REPORT_STATUS (*(ulong *)(HAB_RVT_BASE + 0x48))
  168. #define HAB_RVT_FAILSAFE (*(ulong *)(HAB_RVT_BASE + 0x50))
  169. #else
  170. #ifdef CONFIG_ROM_UNIFIED_SECTIONS
  171. #define HAB_RVT_BASE 0x00000100
  172. #else
  173. #define HAB_RVT_BASE_NEW 0x00000098
  174. #define HAB_RVT_BASE_OLD 0x00000094
  175. #define HAB_RVT_BASE ((is_mx6dqp()) ? \
  176. HAB_RVT_BASE_NEW : \
  177. (is_mx6dq() && (soc_rev() >= CHIP_REV_1_3)) ? \
  178. HAB_RVT_BASE_NEW : \
  179. (is_mx6sdl() && (soc_rev() >= CHIP_REV_1_2)) ? \
  180. HAB_RVT_BASE_NEW : HAB_RVT_BASE_OLD)
  181. #endif
  182. #define HAB_RVT_ENTRY (*(uint32_t *)(HAB_RVT_BASE + 0x04))
  183. #define HAB_RVT_EXIT (*(uint32_t *)(HAB_RVT_BASE + 0x08))
  184. #define HAB_RVT_CHECK_TARGET (*(uint32_t *)(HAB_RVT_BASE + 0x0C))
  185. #define HAB_RVT_AUTHENTICATE_IMAGE (*(uint32_t *)(HAB_RVT_BASE + 0x10))
  186. #define HAB_RVT_REPORT_EVENT (*(uint32_t *)(HAB_RVT_BASE + 0x20))
  187. #define HAB_RVT_REPORT_STATUS (*(uint32_t *)(HAB_RVT_BASE + 0x24))
  188. #define HAB_RVT_FAILSAFE (*(uint32_t *)(HAB_RVT_BASE + 0x28))
  189. #endif /*CONFIG_ARM64*/
  190. #define HAB_CID_ROM 0 /**< ROM Caller ID */
  191. #define HAB_CID_UBOOT 1 /**< UBOOT Caller ID*/
  192. #define HAB_TAG_RVT 0xDD /* ROM Vector Table */
  193. #define HAB_CMD_HDR 0xD4 /* CSF Header */
  194. #define HAB_CMD_WRT_DAT 0xCC /* Write Data command tag */
  195. #define HAB_CMD_CHK_DAT 0xCF /* Check Data command tag */
  196. #define HAB_CMD_SET 0xB1 /* Set command tag */
  197. #define HAB_PAR_MID 0x01 /* MID parameter value */
  198. #define IVT_SIZE 0x20
  199. #define CSF_PAD_SIZE 0x2000
  200. #define HAB_TAG_EVT 0xDB
  201. #define HAB_TAG_EVT_DEF 0x0C
  202. #define HAB_MAJ_VER 0x40
  203. #define HAB_MAJ_MASK 0xF0
  204. /* ----------- end of HAB API updates ------------*/
  205. int imx_hab_authenticate_image(uint32_t ddr_start, uint32_t image_size,
  206. uint32_t ivt_offset);
  207. bool imx_hab_is_enabled(void);
  208. #endif