hab.h 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150
  1. /*
  2. * Copyright (C) 2012-2015 Freescale Semiconductor, Inc. All Rights Reserved.
  3. *
  4. * SPDX-License-Identifier: GPL-2.0+
  5. *
  6. */
  7. #ifndef __SECURE_MX6Q_H__
  8. #define __SECURE_MX6Q_H__
  9. #include <linux/types.h>
  10. /* -------- start of HAB API updates ------------*/
  11. /* The following are taken from HAB4 SIS */
  12. /* Status definitions */
  13. enum hab_status {
  14. HAB_STS_ANY = 0x00,
  15. HAB_FAILURE = 0x33,
  16. HAB_WARNING = 0x69,
  17. HAB_SUCCESS = 0xf0
  18. };
  19. /* Security Configuration definitions */
  20. enum hab_config {
  21. HAB_CFG_RETURN = 0x33, /* < Field Return IC */
  22. HAB_CFG_OPEN = 0xf0, /* < Non-secure IC */
  23. HAB_CFG_CLOSED = 0xcc /* < Secure IC */
  24. };
  25. /* State definitions */
  26. enum hab_state {
  27. HAB_STATE_INITIAL = 0x33, /* Initialising state (transitory) */
  28. HAB_STATE_CHECK = 0x55, /* Check state (non-secure) */
  29. HAB_STATE_NONSECURE = 0x66, /* Non-secure state */
  30. HAB_STATE_TRUSTED = 0x99, /* Trusted state */
  31. HAB_STATE_SECURE = 0xaa, /* Secure state */
  32. HAB_STATE_FAIL_SOFT = 0xcc, /* Soft fail state */
  33. HAB_STATE_FAIL_HARD = 0xff, /* Hard fail state (terminal) */
  34. HAB_STATE_NONE = 0xf0, /* No security state machine */
  35. HAB_STATE_MAX
  36. };
  37. enum hab_reason {
  38. HAB_RSN_ANY = 0x00, /* Match any reason */
  39. HAB_ENG_FAIL = 0x30, /* Engine failure */
  40. HAB_INV_ADDRESS = 0x22, /* Invalid address: access denied */
  41. HAB_INV_ASSERTION = 0x0c, /* Invalid assertion */
  42. HAB_INV_CALL = 0x28, /* Function called out of sequence */
  43. HAB_INV_CERTIFICATE = 0x21, /* Invalid certificate */
  44. HAB_INV_COMMAND = 0x06, /* Invalid command: command malformed */
  45. HAB_INV_CSF = 0x11, /* Invalid csf */
  46. HAB_INV_DCD = 0x27, /* Invalid dcd */
  47. HAB_INV_INDEX = 0x0f, /* Invalid index: access denied */
  48. HAB_INV_IVT = 0x05, /* Invalid ivt */
  49. HAB_INV_KEY = 0x1d, /* Invalid key */
  50. HAB_INV_RETURN = 0x1e, /* Failed callback function */
  51. HAB_INV_SIGNATURE = 0x18, /* Invalid signature */
  52. HAB_INV_SIZE = 0x17, /* Invalid data size */
  53. HAB_MEM_FAIL = 0x2e, /* Memory failure */
  54. HAB_OVR_COUNT = 0x2b, /* Expired poll count */
  55. HAB_OVR_STORAGE = 0x2d, /* Exhausted storage region */
  56. HAB_UNS_ALGORITHM = 0x12, /* Unsupported algorithm */
  57. HAB_UNS_COMMAND = 0x03, /* Unsupported command */
  58. HAB_UNS_ENGINE = 0x0a, /* Unsupported engine */
  59. HAB_UNS_ITEM = 0x24, /* Unsupported configuration item */
  60. HAB_UNS_KEY = 0x1b, /* Unsupported key type/parameters */
  61. HAB_UNS_PROTOCOL = 0x14, /* Unsupported protocol */
  62. HAB_UNS_STATE = 0x09, /* Unsuitable state */
  63. HAB_RSN_MAX
  64. };
  65. enum hab_context {
  66. HAB_CTX_ANY = 0x00, /* Match any context */
  67. HAB_CTX_FAB = 0xff, /* Event logged in hab_fab_test() */
  68. HAB_CTX_ENTRY = 0xe1, /* Event logged in hab_rvt.entry() */
  69. HAB_CTX_TARGET = 0x33, /* Event logged in hab_rvt.check_target() */
  70. HAB_CTX_AUTHENTICATE = 0x0a,/* Logged in hab_rvt.authenticate_image() */
  71. HAB_CTX_DCD = 0xdd, /* Event logged in hab_rvt.run_dcd() */
  72. HAB_CTX_CSF = 0xcf, /* Event logged in hab_rvt.run_csf() */
  73. HAB_CTX_COMMAND = 0xc0, /* Event logged executing csf/dcd command */
  74. HAB_CTX_AUT_DAT = 0xdb, /* Authenticated data block */
  75. HAB_CTX_ASSERT = 0xa0, /* Event logged in hab_rvt.assert() */
  76. HAB_CTX_EXIT = 0xee, /* Event logged in hab_rvt.exit() */
  77. HAB_CTX_MAX
  78. };
  79. struct imx_sec_config_fuse_t {
  80. int bank;
  81. int word;
  82. };
  83. #if defined(CONFIG_SECURE_BOOT)
  84. extern struct imx_sec_config_fuse_t const imx_sec_config_fuse;
  85. #endif
  86. /*Function prototype description*/
  87. typedef enum hab_status hab_rvt_report_event_t(enum hab_status, uint32_t,
  88. uint8_t* , size_t*);
  89. typedef enum hab_status hab_rvt_report_status_t(enum hab_config *,
  90. enum hab_state *);
  91. typedef enum hab_status hab_loader_callback_f_t(void**, size_t*, const void*);
  92. typedef enum hab_status hab_rvt_entry_t(void);
  93. typedef enum hab_status hab_rvt_exit_t(void);
  94. typedef void *hab_rvt_authenticate_image_t(uint8_t, ptrdiff_t,
  95. void **, size_t *, hab_loader_callback_f_t);
  96. typedef void hapi_clock_init_t(void);
  97. #define HAB_ENG_ANY 0x00 /* Select first compatible engine */
  98. #define HAB_ENG_SCC 0x03 /* Security controller */
  99. #define HAB_ENG_RTIC 0x05 /* Run-time integrity checker */
  100. #define HAB_ENG_SAHARA 0x06 /* Crypto accelerator */
  101. #define HAB_ENG_CSU 0x0a /* Central Security Unit */
  102. #define HAB_ENG_SRTC 0x0c /* Secure clock */
  103. #define HAB_ENG_DCP 0x1b /* Data Co-Processor */
  104. #define HAB_ENG_CAAM 0x1d /* CAAM */
  105. #define HAB_ENG_SNVS 0x1e /* Secure Non-Volatile Storage */
  106. #define HAB_ENG_OCOTP 0x21 /* Fuse controller */
  107. #define HAB_ENG_DTCP 0x22 /* DTCP co-processor */
  108. #define HAB_ENG_ROM 0x36 /* Protected ROM area */
  109. #define HAB_ENG_HDCP 0x24 /* HDCP co-processor */
  110. #define HAB_ENG_RTL 0x77 /* RTL simulation engine */
  111. #define HAB_ENG_SW 0xff /* Software engine */
  112. #ifdef CONFIG_ROM_UNIFIED_SECTIONS
  113. #define HAB_RVT_BASE 0x00000100
  114. #else
  115. #define HAB_RVT_BASE 0x00000094
  116. #endif
  117. #define HAB_RVT_ENTRY (*(uint32_t *)(HAB_RVT_BASE + 0x04))
  118. #define HAB_RVT_EXIT (*(uint32_t *)(HAB_RVT_BASE + 0x08))
  119. #define HAB_RVT_AUTHENTICATE_IMAGE (*(uint32_t *)(HAB_RVT_BASE + 0x10))
  120. #define HAB_RVT_REPORT_EVENT (*(uint32_t *)(HAB_RVT_BASE + 0x20))
  121. #define HAB_RVT_REPORT_STATUS (*(uint32_t *)(HAB_RVT_BASE + 0x24))
  122. #define HAB_RVT_REPORT_EVENT_NEW (*(uint32_t *)0x000000B8)
  123. #define HAB_RVT_REPORT_STATUS_NEW (*(uint32_t *)0x000000BC)
  124. #define HAB_RVT_AUTHENTICATE_IMAGE_NEW (*(uint32_t *)0x000000A8)
  125. #define HAB_RVT_ENTRY_NEW (*(uint32_t *)0x0000009C)
  126. #define HAB_RVT_EXIT_NEW (*(uint32_t *)0x000000A0)
  127. #define HAB_CID_ROM 0 /**< ROM Caller ID */
  128. #define HAB_CID_UBOOT 1 /**< UBOOT Caller ID*/
  129. /* ----------- end of HAB API updates ------------*/
  130. uint32_t authenticate_image(uint32_t ddr_start, uint32_t image_size);
  131. #endif