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/mach-imx/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) \
73 static inline void hab_rvt_failsafe_new(void)
77 #define hab_rvt_failsafe_p \
80 ((hab_rvt_failsafe_t *)hab_rvt_failsafe_new) : \
81 (is_mx6dq() && (soc_rev() >= CHIP_REV_1_5)) ? \
82 ((hab_rvt_failsafe_t *)hab_rvt_failsafe_new) : \
83 (is_mx6sdl() && (soc_rev() >= CHIP_REV_1_2)) ? \
84 ((hab_rvt_failsafe_t *)hab_rvt_failsafe_new) : \
85 ((hab_rvt_failsafe_t *)HAB_RVT_FAILSAFE) \
88 static inline enum hab_status hab_rvt_check_target_new(enum hab_target target,
95 #define hab_rvt_check_target_p \
98 ((hab_rvt_check_target_t *)hab_rvt_check_target_new) : \
99 (is_mx6dq() && (soc_rev() >= CHIP_REV_1_5)) ? \
100 ((hab_rvt_check_target_t *)hab_rvt_check_target_new) : \
101 (is_mx6sdl() && (soc_rev() >= CHIP_REV_1_2)) ? \
102 ((hab_rvt_check_target_t *)hab_rvt_check_target_new) : \
103 ((hab_rvt_check_target_t *)HAB_RVT_CHECK_TARGET) \
106 #define ALIGN_SIZE 0x1000
107 #define MX6DQ_PU_IROM_MMU_EN_VAR 0x009024a8
108 #define MX6DLS_PU_IROM_MMU_EN_VAR 0x00901dd0
109 #define MX6SL_PU_IROM_MMU_EN_VAR 0x00900a18
110 #define IS_HAB_ENABLED_BIT \
111 (is_soc_type(MXC_SOC_MX7ULP) ? 0x80000000 : \
112 (is_soc_type(MXC_SOC_MX7) ? 0x2000000 : 0x2))
114 static int ivt_header_error(const char *err_str, struct ivt_header *ivt_hdr)
116 printf("%s magic=0x%x length=0x%02x version=0x%x\n", err_str,
117 ivt_hdr->magic, ivt_hdr->length, ivt_hdr->version);
122 static int verify_ivt_header(struct ivt_header *ivt_hdr)
126 if (ivt_hdr->magic != IVT_HEADER_MAGIC)
127 result = ivt_header_error("bad magic", ivt_hdr);
129 if (be16_to_cpu(ivt_hdr->length) != IVT_TOTAL_LENGTH)
130 result = ivt_header_error("bad length", ivt_hdr);
132 if (ivt_hdr->version != IVT_HEADER_V1 &&
133 ivt_hdr->version != IVT_HEADER_V2)
134 result = ivt_header_error("bad version", ivt_hdr);
139 #if !defined(CONFIG_SPL_BUILD)
141 #define MAX_RECORD_BYTES (8*1024) /* 4 kbytes */
144 uint8_t tag; /* Tag */
145 uint8_t len[2]; /* Length */
146 uint8_t par; /* Version */
147 uint8_t contents[MAX_RECORD_BYTES];/* Record Data */
151 static char *rsn_str[] = {
152 "RSN = HAB_RSN_ANY (0x00)\n",
153 "RSN = HAB_ENG_FAIL (0x30)\n",
154 "RSN = HAB_INV_ADDRESS (0x22)\n",
155 "RSN = HAB_INV_ASSERTION (0x0C)\n",
156 "RSN = HAB_INV_CALL (0x28)\n",
157 "RSN = HAB_INV_CERTIFICATE (0x21)\n",
158 "RSN = HAB_INV_COMMAND (0x06)\n",
159 "RSN = HAB_INV_CSF (0x11)\n",
160 "RSN = HAB_INV_DCD (0x27)\n",
161 "RSN = HAB_INV_INDEX (0x0F)\n",
162 "RSN = HAB_INV_IVT (0x05)\n",
163 "RSN = HAB_INV_KEY (0x1D)\n",
164 "RSN = HAB_INV_RETURN (0x1E)\n",
165 "RSN = HAB_INV_SIGNATURE (0x18)\n",
166 "RSN = HAB_INV_SIZE (0x17)\n",
167 "RSN = HAB_MEM_FAIL (0x2E)\n",
168 "RSN = HAB_OVR_COUNT (0x2B)\n",
169 "RSN = HAB_OVR_STORAGE (0x2D)\n",
170 "RSN = HAB_UNS_ALGORITHM (0x12)\n",
171 "RSN = HAB_UNS_COMMAND (0x03)\n",
172 "RSN = HAB_UNS_ENGINE (0x0A)\n",
173 "RSN = HAB_UNS_ITEM (0x24)\n",
174 "RSN = HAB_UNS_KEY (0x1B)\n",
175 "RSN = HAB_UNS_PROTOCOL (0x14)\n",
176 "RSN = HAB_UNS_STATE (0x09)\n",
181 static char *sts_str[] = {
182 "STS = HAB_SUCCESS (0xF0)\n",
183 "STS = HAB_FAILURE (0x33)\n",
184 "STS = HAB_WARNING (0x69)\n",
189 static char *eng_str[] = {
190 "ENG = HAB_ENG_ANY (0x00)\n",
191 "ENG = HAB_ENG_SCC (0x03)\n",
192 "ENG = HAB_ENG_RTIC (0x05)\n",
193 "ENG = HAB_ENG_SAHARA (0x06)\n",
194 "ENG = HAB_ENG_CSU (0x0A)\n",
195 "ENG = HAB_ENG_SRTC (0x0C)\n",
196 "ENG = HAB_ENG_DCP (0x1B)\n",
197 "ENG = HAB_ENG_CAAM (0x1D)\n",
198 "ENG = HAB_ENG_SNVS (0x1E)\n",
199 "ENG = HAB_ENG_OCOTP (0x21)\n",
200 "ENG = HAB_ENG_DTCP (0x22)\n",
201 "ENG = HAB_ENG_ROM (0x36)\n",
202 "ENG = HAB_ENG_HDCP (0x24)\n",
203 "ENG = HAB_ENG_RTL (0x77)\n",
204 "ENG = HAB_ENG_SW (0xFF)\n",
209 static char *ctx_str[] = {
210 "CTX = HAB_CTX_ANY(0x00)\n",
211 "CTX = HAB_CTX_FAB (0xFF)\n",
212 "CTX = HAB_CTX_ENTRY (0xE1)\n",
213 "CTX = HAB_CTX_TARGET (0x33)\n",
214 "CTX = HAB_CTX_AUTHENTICATE (0x0A)\n",
215 "CTX = HAB_CTX_DCD (0xDD)\n",
216 "CTX = HAB_CTX_CSF (0xCF)\n",
217 "CTX = HAB_CTX_COMMAND (0xC0)\n",
218 "CTX = HAB_CTX_AUT_DAT (0xDB)\n",
219 "CTX = HAB_CTX_ASSERT (0xA0)\n",
220 "CTX = HAB_CTX_EXIT (0xEE)\n",
225 static uint8_t hab_statuses[5] = {
233 static uint8_t hab_reasons[26] = {
262 static uint8_t hab_contexts[12] = {
267 HAB_CTX_AUTHENTICATE,
277 static uint8_t hab_engines[16] = {
296 static inline uint8_t get_idx(uint8_t *list, uint8_t tgt)
299 uint8_t element = list[idx];
300 while (element != -1) {
303 element = list[++idx];
308 static void process_event_record(uint8_t *event_data, size_t bytes)
310 struct record *rec = (struct record *)event_data;
312 printf("\n\n%s", sts_str[get_idx(hab_statuses, rec->contents[0])]);
313 printf("%s", rsn_str[get_idx(hab_reasons, rec->contents[1])]);
314 printf("%s", ctx_str[get_idx(hab_contexts, rec->contents[2])]);
315 printf("%s", eng_str[get_idx(hab_engines, rec->contents[3])]);
318 static void display_event(uint8_t *event_data, size_t bytes)
322 if (!(event_data && bytes > 0))
325 for (i = 0; i < bytes; i++) {
327 printf("\t0x%02x", event_data[i]);
328 else if ((i % 8) == 0)
329 printf("\n\t0x%02x", event_data[i]);
331 printf(" 0x%02x", event_data[i]);
334 process_event_record(event_data, bytes);
337 static int get_hab_status(void)
339 uint32_t index = 0; /* Loop index */
340 uint8_t event_data[128]; /* Event data buffer */
341 size_t bytes = sizeof(event_data); /* Event size in bytes */
342 enum hab_config config = 0;
343 enum hab_state state = 0;
344 hab_rvt_report_event_t *hab_rvt_report_event;
345 hab_rvt_report_status_t *hab_rvt_report_status;
347 hab_rvt_report_event = hab_rvt_report_event_p;
348 hab_rvt_report_status = hab_rvt_report_status_p;
350 if (imx_hab_is_enabled())
351 puts("\nSecure boot enabled\n");
353 puts("\nSecure boot disabled\n");
355 /* Check HAB status */
356 if (hab_rvt_report_status(&config, &state) != HAB_SUCCESS) {
357 printf("\nHAB Configuration: 0x%02x, HAB State: 0x%02x\n",
360 /* Display HAB Error events */
361 while (hab_rvt_report_event(HAB_FAILURE, index, event_data,
362 &bytes) == HAB_SUCCESS) {
364 printf("--------- HAB Event %d -----------------\n",
366 puts("event data:\n");
367 display_event(event_data, bytes);
369 bytes = sizeof(event_data);
373 /* Display message if no HAB events are found */
375 printf("\nHAB Configuration: 0x%02x, HAB State: 0x%02x\n",
377 puts("No HAB Events Found!\n\n");
382 static int do_hab_status(cmd_tbl_t *cmdtp, int flag, int argc,
395 static int do_authenticate_image(cmd_tbl_t *cmdtp, int flag, int argc,
398 ulong addr, length, ivt_offset;
402 return CMD_RET_USAGE;
404 addr = simple_strtoul(argv[1], NULL, 16);
405 length = simple_strtoul(argv[2], NULL, 16);
406 ivt_offset = simple_strtoul(argv[3], NULL, 16);
408 rcode = imx_hab_authenticate_image(addr, length, ivt_offset);
410 rcode = CMD_RET_SUCCESS;
412 rcode = CMD_RET_FAILURE;
418 hab_status, CONFIG_SYS_MAXARGS, 1, do_hab_status,
419 "display HAB status",
424 hab_auth_img, 4, 0, do_authenticate_image,
425 "authenticate image via HAB",
426 "addr length ivt_offset\n"
427 "addr - image hex address\n"
428 "length - image hex length\n"
429 "ivt_offset - hex offset of IVT in the image"
433 #endif /* !defined(CONFIG_SPL_BUILD) */
435 bool imx_hab_is_enabled(void)
437 struct imx_sec_config_fuse_t *fuse =
438 (struct imx_sec_config_fuse_t *)&imx_sec_config_fuse;
442 ret = fuse_read(fuse->bank, fuse->word, ®);
444 puts("\nSecure boot fuse read error\n");
448 return (reg & IS_HAB_ENABLED_BIT) == IS_HAB_ENABLED_BIT;
451 int imx_hab_authenticate_image(uint32_t ddr_start, uint32_t image_size,
454 uint32_t load_addr = 0;
456 uint32_t ivt_addr = 0;
459 hab_rvt_authenticate_image_t *hab_rvt_authenticate_image;
460 hab_rvt_entry_t *hab_rvt_entry;
461 hab_rvt_exit_t *hab_rvt_exit;
462 hab_rvt_check_target_t *hab_rvt_check_target;
464 struct ivt_header *ivt_hdr;
465 enum hab_status status;
467 hab_rvt_authenticate_image = hab_rvt_authenticate_image_p;
468 hab_rvt_entry = hab_rvt_entry_p;
469 hab_rvt_exit = hab_rvt_exit_p;
470 hab_rvt_check_target = hab_rvt_check_target_p;
472 if (!imx_hab_is_enabled()) {
473 puts("hab fuse not enabled\n");
477 printf("\nAuthenticate image from DDR location 0x%x...\n",
480 hab_caam_clock_enable(1);
482 /* Calculate IVT address header */
483 ivt_addr = ddr_start + ivt_offset;
484 ivt = (struct ivt *)ivt_addr;
487 /* Verify IVT header bugging out on error */
488 if (verify_ivt_header(ivt_hdr))
489 goto hab_caam_clock_disable;
491 /* Verify IVT body */
492 if (ivt->self != ivt_addr) {
493 printf("ivt->self 0x%08x pointer is 0x%08x\n",
494 ivt->self, ivt_addr);
495 goto hab_caam_clock_disable;
501 if (hab_rvt_entry() != HAB_SUCCESS) {
502 puts("hab entry function fail\n");
503 goto hab_exit_failure_print_status;
506 status = hab_rvt_check_target(HAB_TGT_MEMORY, (void *)ddr_start, bytes);
507 if (status != HAB_SUCCESS) {
508 printf("HAB check target 0x%08x-0x%08x fail\n",
509 ddr_start, ddr_start + bytes);
510 goto hab_exit_failure_print_status;
513 printf("\nivt_offset = 0x%x, ivt addr = 0x%x\n", ivt_offset, ivt_addr);
514 printf("ivt entry = 0x%08x, dcd = 0x%08x, csf = 0x%08x\n", ivt->entry,
516 puts("Dumping IVT\n");
517 print_buffer(ivt_addr, (void *)(ivt_addr), 4, 0x8, 0);
519 puts("Dumping CSF Header\n");
520 print_buffer(ivt->csf, (void *)(ivt->csf), 4, 0x10, 0);
522 #if !defined(CONFIG_SPL_BUILD)
526 puts("\nCalling authenticate_image in ROM\n");
527 printf("\tivt_offset = 0x%x\n", ivt_offset);
528 printf("\tstart = 0x%08lx\n", start);
529 printf("\tbytes = 0x%x\n", bytes);
532 * If the MMU is enabled, we have to notify the ROM
533 * code, or it won't flush the caches when needed.
534 * This is done, by setting the "pu_irom_mmu_enabled"
535 * word to 1. You can find its address by looking in
536 * the ROM map. This is critical for
537 * authenticate_image(). If MMU is enabled, without
538 * setting this bit, authentication will fail and may
541 /* Check MMU enabled */
542 if (is_soc_type(MXC_SOC_MX6) && get_cr() & CR_M) {
545 * This won't work on Rev 1.0.0 of
546 * i.MX6Q/D, since their ROM doesn't
547 * do cache flushes. don't think any
548 * exist, so we ignore them.
551 writel(1, MX6DQ_PU_IROM_MMU_EN_VAR);
552 } else if (is_mx6sdl()) {
553 writel(1, MX6DLS_PU_IROM_MMU_EN_VAR);
554 } else if (is_mx6sl()) {
555 writel(1, MX6SL_PU_IROM_MMU_EN_VAR);
559 load_addr = (uint32_t)hab_rvt_authenticate_image(
561 ivt_offset, (void **)&start,
562 (size_t *)&bytes, NULL);
563 if (hab_rvt_exit() != HAB_SUCCESS) {
564 puts("hab exit function fail\n");
568 hab_exit_failure_print_status:
569 #if !defined(CONFIG_SPL_BUILD)
573 hab_caam_clock_disable:
574 hab_caam_clock_enable(0);