2 * Copyright (C) 2010-2015 Freescale Semiconductor, Inc.
4 * SPDX-License-Identifier: GPL-2.0+
11 #include <asm/system.h>
12 #include <asm/arch/clock.h>
13 #include <asm/arch/sys_proto.h>
14 #include <asm/imx-common/hab.h>
16 /* -------- start of HAB API updates ------------*/
18 #define hab_rvt_report_event_p \
21 ((hab_rvt_report_event_t *)HAB_RVT_REPORT_EVENT_NEW) : \
22 (is_mx6dq() && (soc_rev() >= CHIP_REV_1_5)) ? \
23 ((hab_rvt_report_event_t *)HAB_RVT_REPORT_EVENT_NEW) : \
24 (is_mx6sdl() && (soc_rev() >= CHIP_REV_1_2)) ? \
25 ((hab_rvt_report_event_t *)HAB_RVT_REPORT_EVENT_NEW) : \
26 ((hab_rvt_report_event_t *)HAB_RVT_REPORT_EVENT) \
29 #define hab_rvt_report_status_p \
32 ((hab_rvt_report_status_t *)HAB_RVT_REPORT_STATUS_NEW) :\
33 (is_mx6dq() && (soc_rev() >= CHIP_REV_1_5)) ? \
34 ((hab_rvt_report_status_t *)HAB_RVT_REPORT_STATUS_NEW) :\
35 (is_mx6sdl() && (soc_rev() >= CHIP_REV_1_2)) ? \
36 ((hab_rvt_report_status_t *)HAB_RVT_REPORT_STATUS_NEW) :\
37 ((hab_rvt_report_status_t *)HAB_RVT_REPORT_STATUS) \
40 #define hab_rvt_authenticate_image_p \
43 ((hab_rvt_authenticate_image_t *)HAB_RVT_AUTHENTICATE_IMAGE_NEW) : \
44 (is_mx6dq() && (soc_rev() >= CHIP_REV_1_5)) ? \
45 ((hab_rvt_authenticate_image_t *)HAB_RVT_AUTHENTICATE_IMAGE_NEW) : \
46 (is_mx6sdl() && (soc_rev() >= CHIP_REV_1_2)) ? \
47 ((hab_rvt_authenticate_image_t *)HAB_RVT_AUTHENTICATE_IMAGE_NEW) : \
48 ((hab_rvt_authenticate_image_t *)HAB_RVT_AUTHENTICATE_IMAGE) \
51 #define hab_rvt_entry_p \
54 ((hab_rvt_entry_t *)HAB_RVT_ENTRY_NEW) : \
55 (is_mx6dq() && (soc_rev() >= CHIP_REV_1_5)) ? \
56 ((hab_rvt_entry_t *)HAB_RVT_ENTRY_NEW) : \
57 (is_mx6sdl() && (soc_rev() >= CHIP_REV_1_2)) ? \
58 ((hab_rvt_entry_t *)HAB_RVT_ENTRY_NEW) : \
59 ((hab_rvt_entry_t *)HAB_RVT_ENTRY) \
62 #define hab_rvt_exit_p \
65 ((hab_rvt_exit_t *)HAB_RVT_EXIT_NEW) : \
66 (is_mx6dq() && (soc_rev() >= CHIP_REV_1_5)) ? \
67 ((hab_rvt_exit_t *)HAB_RVT_EXIT_NEW) : \
68 (is_mx6sdl() && (soc_rev() >= CHIP_REV_1_2)) ? \
69 ((hab_rvt_exit_t *)HAB_RVT_EXIT_NEW) : \
70 ((hab_rvt_exit_t *)HAB_RVT_EXIT) \
74 #define ALIGN_SIZE 0x1000
75 #define CSF_PAD_SIZE 0x2000
76 #define MX6DQ_PU_IROM_MMU_EN_VAR 0x009024a8
77 #define MX6DLS_PU_IROM_MMU_EN_VAR 0x00901dd0
78 #define MX6SL_PU_IROM_MMU_EN_VAR 0x00900a18
79 #define IS_HAB_ENABLED_BIT \
80 (is_soc_type(MXC_SOC_MX7) ? 0x2000000 : 0x2)
83 * +------------+ 0x0 (DDR_UIMAGE_START) -
85 * +------------+ 0x40 |
92 * . | > Stuff to be authenticated ----+
100 * +------------+ Align to ALIGN_SIZE | |
102 * +------------+ + IVT_SIZE - |
104 * | CSF DATA | <---------------------------------------------------------+
110 * +------------+ + CSF_PAD_SIZE
113 static bool is_hab_enabled(void);
115 #if !defined(CONFIG_SPL_BUILD)
117 #define MAX_RECORD_BYTES (8*1024) /* 4 kbytes */
120 uint8_t tag; /* Tag */
121 uint8_t len[2]; /* Length */
122 uint8_t par; /* Version */
123 uint8_t contents[MAX_RECORD_BYTES];/* Record Data */
127 char *rsn_str[] = {"RSN = HAB_RSN_ANY (0x00)\n",
128 "RSN = HAB_ENG_FAIL (0x30)\n",
129 "RSN = HAB_INV_ADDRESS (0x22)\n",
130 "RSN = HAB_INV_ASSERTION (0x0C)\n",
131 "RSN = HAB_INV_CALL (0x28)\n",
132 "RSN = HAB_INV_CERTIFICATE (0x21)\n",
133 "RSN = HAB_INV_COMMAND (0x06)\n",
134 "RSN = HAB_INV_CSF (0x11)\n",
135 "RSN = HAB_INV_DCD (0x27)\n",
136 "RSN = HAB_INV_INDEX (0x0F)\n",
137 "RSN = HAB_INV_IVT (0x05)\n",
138 "RSN = HAB_INV_KEY (0x1D)\n",
139 "RSN = HAB_INV_RETURN (0x1E)\n",
140 "RSN = HAB_INV_SIGNATURE (0x18)\n",
141 "RSN = HAB_INV_SIZE (0x17)\n",
142 "RSN = HAB_MEM_FAIL (0x2E)\n",
143 "RSN = HAB_OVR_COUNT (0x2B)\n",
144 "RSN = HAB_OVR_STORAGE (0x2D)\n",
145 "RSN = HAB_UNS_ALGORITHM (0x12)\n",
146 "RSN = HAB_UNS_COMMAND (0x03)\n",
147 "RSN = HAB_UNS_ENGINE (0x0A)\n",
148 "RSN = HAB_UNS_ITEM (0x24)\n",
149 "RSN = HAB_UNS_KEY (0x1B)\n",
150 "RSN = HAB_UNS_PROTOCOL (0x14)\n",
151 "RSN = HAB_UNS_STATE (0x09)\n",
155 char *sts_str[] = {"STS = HAB_SUCCESS (0xF0)\n",
156 "STS = HAB_FAILURE (0x33)\n",
157 "STS = HAB_WARNING (0x69)\n",
161 char *eng_str[] = {"ENG = HAB_ENG_ANY (0x00)\n",
162 "ENG = HAB_ENG_SCC (0x03)\n",
163 "ENG = HAB_ENG_RTIC (0x05)\n",
164 "ENG = HAB_ENG_SAHARA (0x06)\n",
165 "ENG = HAB_ENG_CSU (0x0A)\n",
166 "ENG = HAB_ENG_SRTC (0x0C)\n",
167 "ENG = HAB_ENG_DCP (0x1B)\n",
168 "ENG = HAB_ENG_CAAM (0x1D)\n",
169 "ENG = HAB_ENG_SNVS (0x1E)\n",
170 "ENG = HAB_ENG_OCOTP (0x21)\n",
171 "ENG = HAB_ENG_DTCP (0x22)\n",
172 "ENG = HAB_ENG_ROM (0x36)\n",
173 "ENG = HAB_ENG_HDCP (0x24)\n",
174 "ENG = HAB_ENG_RTL (0x77)\n",
175 "ENG = HAB_ENG_SW (0xFF)\n",
179 char *ctx_str[] = {"CTX = HAB_CTX_ANY(0x00)\n",
180 "CTX = HAB_CTX_FAB (0xFF)\n",
181 "CTX = HAB_CTX_ENTRY (0xE1)\n",
182 "CTX = HAB_CTX_TARGET (0x33)\n",
183 "CTX = HAB_CTX_AUTHENTICATE (0x0A)\n",
184 "CTX = HAB_CTX_DCD (0xDD)\n",
185 "CTX = HAB_CTX_CSF (0xCF)\n",
186 "CTX = HAB_CTX_COMMAND (0xC0)\n",
187 "CTX = HAB_CTX_AUT_DAT (0xDB)\n",
188 "CTX = HAB_CTX_ASSERT (0xA0)\n",
189 "CTX = HAB_CTX_EXIT (0xEE)\n",
193 uint8_t hab_statuses[5] = {
201 uint8_t hab_reasons[26] = {
230 uint8_t hab_contexts[12] = {
235 HAB_CTX_AUTHENTICATE,
245 uint8_t hab_engines[16] = {
264 static inline uint8_t get_idx(uint8_t *list, uint8_t tgt)
267 uint8_t element = list[idx];
268 while (element != -1) {
271 element = list[++idx];
276 void process_event_record(uint8_t *event_data, size_t bytes)
278 struct record *rec = (struct record *)event_data;
280 printf("\n\n%s", sts_str[get_idx(hab_statuses, rec->contents[0])]);
281 printf("%s", rsn_str[get_idx(hab_reasons, rec->contents[1])]);
282 printf("%s", ctx_str[get_idx(hab_contexts, rec->contents[2])]);
283 printf("%s", eng_str[get_idx(hab_engines, rec->contents[3])]);
286 void display_event(uint8_t *event_data, size_t bytes)
290 if (!(event_data && bytes > 0))
293 for (i = 0; i < bytes; i++) {
295 printf("\t0x%02x", event_data[i]);
296 else if ((i % 8) == 0)
297 printf("\n\t0x%02x", event_data[i]);
299 printf(" 0x%02x", event_data[i]);
302 process_event_record(event_data, bytes);
305 int get_hab_status(void)
307 uint32_t index = 0; /* Loop index */
308 uint8_t event_data[128]; /* Event data buffer */
309 size_t bytes = sizeof(event_data); /* Event size in bytes */
310 enum hab_config config = 0;
311 enum hab_state state = 0;
312 hab_rvt_report_event_t *hab_rvt_report_event;
313 hab_rvt_report_status_t *hab_rvt_report_status;
315 hab_rvt_report_event = hab_rvt_report_event_p;
316 hab_rvt_report_status = hab_rvt_report_status_p;
318 if (is_hab_enabled())
319 puts("\nSecure boot enabled\n");
321 puts("\nSecure boot disabled\n");
323 /* Check HAB status */
324 if (hab_rvt_report_status(&config, &state) != HAB_SUCCESS) {
325 printf("\nHAB Configuration: 0x%02x, HAB State: 0x%02x\n",
328 /* Display HAB Error events */
329 while (hab_rvt_report_event(HAB_FAILURE, index, event_data,
330 &bytes) == HAB_SUCCESS) {
332 printf("--------- HAB Event %d -----------------\n",
334 puts("event data:\n");
335 display_event(event_data, bytes);
337 bytes = sizeof(event_data);
341 /* Display message if no HAB events are found */
343 printf("\nHAB Configuration: 0x%02x, HAB State: 0x%02x\n",
345 puts("No HAB Events Found!\n\n");
350 int do_hab_status(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
362 static int do_authenticate_image(cmd_tbl_t *cmdtp, int flag, int argc,
365 ulong addr, ivt_offset;
369 return CMD_RET_USAGE;
371 addr = simple_strtoul(argv[1], NULL, 16);
372 ivt_offset = simple_strtoul(argv[2], NULL, 16);
374 rcode = authenticate_image(addr, ivt_offset);
380 hab_status, CONFIG_SYS_MAXARGS, 1, do_hab_status,
381 "display HAB status",
386 hab_auth_img, 3, 0, do_authenticate_image,
387 "authenticate image via HAB",
389 "addr - image hex address\n"
390 "ivt_offset - hex offset of IVT in the image"
394 #endif /* !defined(CONFIG_SPL_BUILD) */
396 static bool is_hab_enabled(void)
398 struct imx_sec_config_fuse_t *fuse =
399 (struct imx_sec_config_fuse_t *)&imx_sec_config_fuse;
403 ret = fuse_read(fuse->bank, fuse->word, ®);
405 puts("\nSecure boot fuse read error\n");
409 return (reg & IS_HAB_ENABLED_BIT) == IS_HAB_ENABLED_BIT;
412 uint32_t authenticate_image(uint32_t ddr_start, uint32_t image_size)
414 uint32_t load_addr = 0;
416 ptrdiff_t ivt_offset = 0;
419 hab_rvt_authenticate_image_t *hab_rvt_authenticate_image;
420 hab_rvt_entry_t *hab_rvt_entry;
421 hab_rvt_exit_t *hab_rvt_exit;
423 hab_rvt_authenticate_image = hab_rvt_authenticate_image_p;
424 hab_rvt_entry = hab_rvt_entry_p;
425 hab_rvt_exit = hab_rvt_exit_p;
427 if (is_hab_enabled()) {
428 printf("\nAuthenticate image from DDR location 0x%x...\n",
431 hab_caam_clock_enable(1);
433 if (hab_rvt_entry() == HAB_SUCCESS) {
434 /* If not already aligned, Align to ALIGN_SIZE */
435 ivt_offset = (image_size + ALIGN_SIZE - 1) &
439 bytes = ivt_offset + IVT_SIZE + CSF_PAD_SIZE;
441 printf("\nivt_offset = 0x%x, ivt addr = 0x%x\n",
442 ivt_offset, ddr_start + ivt_offset);
443 puts("Dumping IVT\n");
444 print_buffer(ddr_start + ivt_offset,
445 (void *)(ddr_start + ivt_offset),
448 puts("Dumping CSF Header\n");
449 print_buffer(ddr_start + ivt_offset+IVT_SIZE,
450 (void *)(ddr_start + ivt_offset+IVT_SIZE),
453 #if !defined(CONFIG_SPL_BUILD)
457 puts("\nCalling authenticate_image in ROM\n");
458 printf("\tivt_offset = 0x%x\n", ivt_offset);
459 printf("\tstart = 0x%08lx\n", start);
460 printf("\tbytes = 0x%x\n", bytes);
463 * If the MMU is enabled, we have to notify the ROM
464 * code, or it won't flush the caches when needed.
465 * This is done, by setting the "pu_irom_mmu_enabled"
466 * word to 1. You can find its address by looking in
467 * the ROM map. This is critical for
468 * authenticate_image(). If MMU is enabled, without
469 * setting this bit, authentication will fail and may
472 /* Check MMU enabled */
473 if (is_soc_type(MXC_SOC_MX6) && get_cr() & CR_M) {
476 * This won't work on Rev 1.0.0 of
477 * i.MX6Q/D, since their ROM doesn't
478 * do cache flushes. don't think any
479 * exist, so we ignore them.
482 writel(1, MX6DQ_PU_IROM_MMU_EN_VAR);
483 } else if (is_mx6sdl()) {
484 writel(1, MX6DLS_PU_IROM_MMU_EN_VAR);
485 } else if (is_mx6sl()) {
486 writel(1, MX6SL_PU_IROM_MMU_EN_VAR);
490 load_addr = (uint32_t)hab_rvt_authenticate_image(
492 ivt_offset, (void **)&start,
493 (size_t *)&bytes, NULL);
494 if (hab_rvt_exit() != HAB_SUCCESS) {
495 puts("hab exit function fail\n");
499 puts("hab entry function fail\n");
502 hab_caam_clock_enable(0);
504 #if !defined(CONFIG_SPL_BUILD)
508 puts("hab fuse not enabled\n");
511 if ((!is_hab_enabled()) || (load_addr != 0))