1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2010-2015 Freescale Semiconductor, Inc.
13 #include <asm/system.h>
14 #include <asm/arch/clock.h>
15 #include <asm/arch/sys_proto.h>
16 #include <asm/mach-imx/hab.h>
18 #define ALIGN_SIZE 0x1000
19 #define MX6DQ_PU_IROM_MMU_EN_VAR 0x009024a8
20 #define MX6DLS_PU_IROM_MMU_EN_VAR 0x00901dd0
21 #define MX6SL_PU_IROM_MMU_EN_VAR 0x00901c60
22 #define IS_HAB_ENABLED_BIT \
23 (is_soc_type(MXC_SOC_MX7ULP) ? 0x80000000 : \
24 (is_soc_type(MXC_SOC_MX7) ? 0x2000000 : 0x2))
26 static int ivt_header_error(const char *err_str, struct ivt_header *ivt_hdr)
28 printf("%s magic=0x%x length=0x%02x version=0x%x\n", err_str,
29 ivt_hdr->magic, ivt_hdr->length, ivt_hdr->version);
34 static int verify_ivt_header(struct ivt_header *ivt_hdr)
38 if (ivt_hdr->magic != IVT_HEADER_MAGIC)
39 result = ivt_header_error("bad magic", ivt_hdr);
41 if (be16_to_cpu(ivt_hdr->length) != IVT_TOTAL_LENGTH)
42 result = ivt_header_error("bad length", ivt_hdr);
44 if (ivt_hdr->version != IVT_HEADER_V1 &&
45 ivt_hdr->version != IVT_HEADER_V2)
46 result = ivt_header_error("bad version", ivt_hdr);
51 #if !defined(CONFIG_SPL_BUILD)
53 #define MAX_RECORD_BYTES (8*1024) /* 4 kbytes */
56 uint8_t tag; /* Tag */
57 uint8_t len[2]; /* Length */
58 uint8_t par; /* Version */
59 uint8_t contents[MAX_RECORD_BYTES];/* Record Data */
63 static char *rsn_str[] = {
64 "RSN = HAB_RSN_ANY (0x00)\n",
65 "RSN = HAB_ENG_FAIL (0x30)\n",
66 "RSN = HAB_INV_ADDRESS (0x22)\n",
67 "RSN = HAB_INV_ASSERTION (0x0C)\n",
68 "RSN = HAB_INV_CALL (0x28)\n",
69 "RSN = HAB_INV_CERTIFICATE (0x21)\n",
70 "RSN = HAB_INV_COMMAND (0x06)\n",
71 "RSN = HAB_INV_CSF (0x11)\n",
72 "RSN = HAB_INV_DCD (0x27)\n",
73 "RSN = HAB_INV_INDEX (0x0F)\n",
74 "RSN = HAB_INV_IVT (0x05)\n",
75 "RSN = HAB_INV_KEY (0x1D)\n",
76 "RSN = HAB_INV_RETURN (0x1E)\n",
77 "RSN = HAB_INV_SIGNATURE (0x18)\n",
78 "RSN = HAB_INV_SIZE (0x17)\n",
79 "RSN = HAB_MEM_FAIL (0x2E)\n",
80 "RSN = HAB_OVR_COUNT (0x2B)\n",
81 "RSN = HAB_OVR_STORAGE (0x2D)\n",
82 "RSN = HAB_UNS_ALGORITHM (0x12)\n",
83 "RSN = HAB_UNS_COMMAND (0x03)\n",
84 "RSN = HAB_UNS_ENGINE (0x0A)\n",
85 "RSN = HAB_UNS_ITEM (0x24)\n",
86 "RSN = HAB_UNS_KEY (0x1B)\n",
87 "RSN = HAB_UNS_PROTOCOL (0x14)\n",
88 "RSN = HAB_UNS_STATE (0x09)\n",
93 static char *sts_str[] = {
94 "STS = HAB_SUCCESS (0xF0)\n",
95 "STS = HAB_FAILURE (0x33)\n",
96 "STS = HAB_WARNING (0x69)\n",
101 static char *eng_str[] = {
102 "ENG = HAB_ENG_ANY (0x00)\n",
103 "ENG = HAB_ENG_SCC (0x03)\n",
104 "ENG = HAB_ENG_RTIC (0x05)\n",
105 "ENG = HAB_ENG_SAHARA (0x06)\n",
106 "ENG = HAB_ENG_CSU (0x0A)\n",
107 "ENG = HAB_ENG_SRTC (0x0C)\n",
108 "ENG = HAB_ENG_DCP (0x1B)\n",
109 "ENG = HAB_ENG_CAAM (0x1D)\n",
110 "ENG = HAB_ENG_SNVS (0x1E)\n",
111 "ENG = HAB_ENG_OCOTP (0x21)\n",
112 "ENG = HAB_ENG_DTCP (0x22)\n",
113 "ENG = HAB_ENG_ROM (0x36)\n",
114 "ENG = HAB_ENG_HDCP (0x24)\n",
115 "ENG = HAB_ENG_RTL (0x77)\n",
116 "ENG = HAB_ENG_SW (0xFF)\n",
121 static char *ctx_str[] = {
122 "CTX = HAB_CTX_ANY(0x00)\n",
123 "CTX = HAB_CTX_FAB (0xFF)\n",
124 "CTX = HAB_CTX_ENTRY (0xE1)\n",
125 "CTX = HAB_CTX_TARGET (0x33)\n",
126 "CTX = HAB_CTX_AUTHENTICATE (0x0A)\n",
127 "CTX = HAB_CTX_DCD (0xDD)\n",
128 "CTX = HAB_CTX_CSF (0xCF)\n",
129 "CTX = HAB_CTX_COMMAND (0xC0)\n",
130 "CTX = HAB_CTX_AUT_DAT (0xDB)\n",
131 "CTX = HAB_CTX_ASSERT (0xA0)\n",
132 "CTX = HAB_CTX_EXIT (0xEE)\n",
137 static uint8_t hab_statuses[5] = {
145 static uint8_t hab_reasons[26] = {
174 static uint8_t hab_contexts[12] = {
179 HAB_CTX_AUTHENTICATE,
189 static uint8_t hab_engines[16] = {
208 static inline uint8_t get_idx(uint8_t *list, uint8_t tgt)
211 uint8_t element = list[idx];
212 while (element != -1) {
215 element = list[++idx];
220 static void process_event_record(uint8_t *event_data, size_t bytes)
222 struct record *rec = (struct record *)event_data;
224 printf("\n\n%s", sts_str[get_idx(hab_statuses, rec->contents[0])]);
225 printf("%s", rsn_str[get_idx(hab_reasons, rec->contents[1])]);
226 printf("%s", ctx_str[get_idx(hab_contexts, rec->contents[2])]);
227 printf("%s", eng_str[get_idx(hab_engines, rec->contents[3])]);
230 static void display_event(uint8_t *event_data, size_t bytes)
234 if (!(event_data && bytes > 0))
237 for (i = 0; i < bytes; i++) {
239 printf("\t0x%02x", event_data[i]);
240 else if ((i % 8) == 0)
241 printf("\n\t0x%02x", event_data[i]);
243 printf(" 0x%02x", event_data[i]);
246 process_event_record(event_data, bytes);
249 static int get_hab_status(void)
251 uint32_t index = 0; /* Loop index */
252 uint8_t event_data[128]; /* Event data buffer */
253 size_t bytes = sizeof(event_data); /* Event size in bytes */
254 enum hab_config config = 0;
255 enum hab_state state = 0;
256 hab_rvt_report_event_t *hab_rvt_report_event;
257 hab_rvt_report_status_t *hab_rvt_report_status;
259 hab_rvt_report_event = (hab_rvt_report_event_t *)HAB_RVT_REPORT_EVENT;
260 hab_rvt_report_status =
261 (hab_rvt_report_status_t *)HAB_RVT_REPORT_STATUS;
263 if (imx_hab_is_enabled())
264 puts("\nSecure boot enabled\n");
266 puts("\nSecure boot disabled\n");
268 /* Check HAB status */
269 if (hab_rvt_report_status(&config, &state) != HAB_SUCCESS) {
270 printf("\nHAB Configuration: 0x%02x, HAB State: 0x%02x\n",
273 /* Display HAB Error events */
274 while (hab_rvt_report_event(HAB_FAILURE, index, event_data,
275 &bytes) == HAB_SUCCESS) {
277 printf("--------- HAB Event %d -----------------\n",
279 puts("event data:\n");
280 display_event(event_data, bytes);
282 bytes = sizeof(event_data);
286 /* Display message if no HAB events are found */
288 printf("\nHAB Configuration: 0x%02x, HAB State: 0x%02x\n",
290 puts("No HAB Events Found!\n\n");
295 static int do_hab_status(struct cmd_tbl *cmdtp, int flag, int argc,
308 static ulong get_image_ivt_offset(ulong img_addr)
312 buf = map_sysmem(img_addr, 0);
313 switch (genimg_get_format(buf)) {
314 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
315 case IMAGE_FORMAT_LEGACY:
316 return (image_get_image_size((image_header_t *)img_addr)
317 + 0x1000 - 1) & ~(0x1000 - 1);
320 case IMAGE_FORMAT_FIT:
321 return (fit_get_size(buf) + 0x1000 - 1) & ~(0x1000 - 1);
328 static int do_authenticate_image(struct cmd_tbl *cmdtp, int flag, int argc,
331 ulong addr, length, ivt_offset;
335 return CMD_RET_USAGE;
337 addr = simple_strtoul(argv[1], NULL, 16);
338 length = simple_strtoul(argv[2], NULL, 16);
340 ivt_offset = get_image_ivt_offset(addr);
342 ivt_offset = simple_strtoul(argv[3], NULL, 16);
344 rcode = imx_hab_authenticate_image(addr, length, ivt_offset);
346 rcode = CMD_RET_SUCCESS;
348 rcode = CMD_RET_FAILURE;
353 static int do_hab_failsafe(struct cmd_tbl *cmdtp, int flag, int argc,
356 hab_rvt_failsafe_t *hab_rvt_failsafe;
363 hab_rvt_failsafe = (hab_rvt_failsafe_t *)HAB_RVT_FAILSAFE;
369 static int do_hab_version(struct cmd_tbl *cmdtp, int flag, int argc,
372 struct hab_hdr *hdr = (struct hab_hdr *)HAB_RVT_BASE;
374 if (hdr->tag != HAB_TAG_RVT) {
375 printf("Unexpected header tag: %x\n", hdr->tag);
376 return CMD_RET_FAILURE;
379 printf("HAB version: %d.%d\n", hdr->par >> 4, hdr->par & 0xf);
384 static int do_authenticate_image_or_failover(struct cmd_tbl *cmdtp, int flag,
385 int argc, char *const argv[])
387 int ret = CMD_RET_FAILURE;
394 if (!imx_hab_is_enabled()) {
395 printf("error: secure boot disabled\n");
399 if (do_authenticate_image(NULL, flag, argc, argv) != CMD_RET_SUCCESS) {
400 fprintf(stderr, "authentication fail -> %s %s %s %s\n",
401 argv[0], argv[1], argv[2], argv[3]);
402 do_hab_failsafe(0, 0, 1, NULL);
404 ret = CMD_RET_SUCCESS;
410 hab_status, CONFIG_SYS_MAXARGS, 1, do_hab_status,
411 "display HAB status",
416 hab_auth_img, 4, 0, do_authenticate_image,
417 "authenticate image via HAB",
418 "addr length ivt_offset\n"
419 "addr - image hex address\n"
420 "length - image hex length\n"
421 "ivt_offset - hex offset of IVT in the image"
425 hab_failsafe, CONFIG_SYS_MAXARGS, 1, do_hab_failsafe,
426 "run BootROM failsafe routine",
431 hab_auth_img_or_fail, 4, 0,
432 do_authenticate_image_or_failover,
433 "authenticate image via HAB on failure drop to USB BootROM mode",
434 "addr length ivt_offset\n"
435 "addr - image hex address\n"
436 "length - image hex length\n"
437 "ivt_offset - hex offset of IVT in the image"
441 hab_version, 1, 0, do_hab_version,
442 "print HAB major/minor version",
446 #endif /* !defined(CONFIG_SPL_BUILD) */
448 /* Get CSF Header length */
449 static int get_hab_hdr_len(struct hab_hdr *hdr)
451 return (size_t)((hdr->len[0] << 8) + (hdr->len[1]));
454 /* Check whether addr lies between start and
455 * end and is within the length of the image
457 static int chk_bounds(u8 *addr, size_t bytes, u8 *start, u8 *end)
459 size_t csf_size = (size_t)((end + 1) - addr);
461 return (addr && (addr >= start) && (addr <= end) &&
462 (csf_size >= bytes));
465 /* Get Length of each command in CSF */
466 static int get_csf_cmd_hdr_len(u8 *csf_hdr)
468 if (*csf_hdr == HAB_CMD_HDR)
469 return sizeof(struct hab_hdr);
471 return get_hab_hdr_len((struct hab_hdr *)csf_hdr);
474 /* Check if CSF is valid */
475 static bool csf_is_valid(struct ivt *ivt, ulong start_addr, size_t bytes)
477 u8 *start = (u8 *)start_addr;
486 end = start + bytes - 1;
490 /* Verify if CSF pointer content is zero */
492 puts("Error: CSF pointer is NULL\n");
496 csf_hdr = (u8 *)ivt->csf;
498 /* Verify if CSF Header exist */
499 if (*csf_hdr != HAB_CMD_HDR) {
500 puts("Error: CSF header command not found\n");
504 csf_hdr_len = get_hab_hdr_len((struct hab_hdr *)csf_hdr);
506 /* Check if the CSF lies within the image bounds */
507 if (!chk_bounds(csf_hdr, csf_hdr_len, start, end)) {
508 puts("Error: CSF lies outside the image bounds\n");
515 cmd = (struct hab_hdr *)&csf_hdr[offset];
518 case (HAB_CMD_WRT_DAT):
519 puts("Error: Deprecated write command found\n");
521 case (HAB_CMD_CHK_DAT):
522 puts("Error: Deprecated check command found\n");
525 if (cmd->par == HAB_PAR_MID) {
526 puts("Error: Deprecated Set MID command found\n");
533 cmd_hdr_len = get_csf_cmd_hdr_len(&csf_hdr[offset]);
535 puts("Error: Invalid command length\n");
538 offset += cmd_hdr_len;
540 } while (offset < csf_hdr_len);
545 bool imx_hab_is_enabled(void)
547 struct imx_sec_config_fuse_t *fuse =
548 (struct imx_sec_config_fuse_t *)&imx_sec_config_fuse;
552 ret = fuse_read(fuse->bank, fuse->word, ®);
554 puts("\nSecure boot fuse read error\n");
558 return (reg & IS_HAB_ENABLED_BIT) == IS_HAB_ENABLED_BIT;
561 int imx_hab_authenticate_image(uint32_t ddr_start, uint32_t image_size,
564 uint32_t load_addr = 0;
566 uint32_t ivt_addr = 0;
569 hab_rvt_authenticate_image_t *hab_rvt_authenticate_image;
570 hab_rvt_entry_t *hab_rvt_entry;
571 hab_rvt_exit_t *hab_rvt_exit;
572 hab_rvt_check_target_t *hab_rvt_check_target;
574 struct ivt_header *ivt_hdr;
575 enum hab_status status;
577 hab_rvt_authenticate_image =
578 (hab_rvt_authenticate_image_t *)HAB_RVT_AUTHENTICATE_IMAGE;
579 hab_rvt_entry = (hab_rvt_entry_t *)HAB_RVT_ENTRY;
580 hab_rvt_exit = (hab_rvt_exit_t *)HAB_RVT_EXIT;
581 hab_rvt_check_target = (hab_rvt_check_target_t *)HAB_RVT_CHECK_TARGET;
583 if (!imx_hab_is_enabled()) {
584 puts("hab fuse not enabled\n");
588 printf("\nAuthenticate image from DDR location 0x%x...\n",
591 hab_caam_clock_enable(1);
593 /* Calculate IVT address header */
594 ivt_addr = ddr_start + ivt_offset;
595 ivt = (struct ivt *)ivt_addr;
598 /* Verify IVT header bugging out on error */
599 if (verify_ivt_header(ivt_hdr))
600 goto hab_authentication_exit;
602 /* Verify IVT body */
603 if (ivt->self != ivt_addr) {
604 printf("ivt->self 0x%08x pointer is 0x%08x\n",
605 ivt->self, ivt_addr);
606 goto hab_authentication_exit;
609 /* Verify if IVT DCD pointer is NULL */
611 puts("Error: DCD pointer must be NULL\n");
612 goto hab_authentication_exit;
619 if (!csf_is_valid(ivt, start, bytes))
620 goto hab_authentication_exit;
622 if (hab_rvt_entry() != HAB_SUCCESS) {
623 puts("hab entry function fail\n");
624 goto hab_exit_failure_print_status;
627 status = hab_rvt_check_target(HAB_TGT_MEMORY, (void *)ddr_start, bytes);
628 if (status != HAB_SUCCESS) {
629 printf("HAB check target 0x%08x-0x%08x fail\n",
630 ddr_start, ddr_start + bytes);
631 goto hab_exit_failure_print_status;
634 printf("\nivt_offset = 0x%x, ivt addr = 0x%x\n", ivt_offset, ivt_addr);
635 printf("ivt entry = 0x%08x, dcd = 0x%08x, csf = 0x%08x\n", ivt->entry,
637 puts("Dumping IVT\n");
638 print_buffer(ivt_addr, (void *)(ivt_addr), 4, 0x8, 0);
640 puts("Dumping CSF Header\n");
641 print_buffer(ivt->csf, (void *)(ivt->csf), 4, 0x10, 0);
643 #if !defined(CONFIG_SPL_BUILD)
647 puts("\nCalling authenticate_image in ROM\n");
648 printf("\tivt_offset = 0x%x\n", ivt_offset);
649 printf("\tstart = 0x%08lx\n", start);
650 printf("\tbytes = 0x%x\n", bytes);
653 * If the MMU is enabled, we have to notify the ROM
654 * code, or it won't flush the caches when needed.
655 * This is done, by setting the "pu_irom_mmu_enabled"
656 * word to 1. You can find its address by looking in
657 * the ROM map. This is critical for
658 * authenticate_image(). If MMU is enabled, without
659 * setting this bit, authentication will fail and may
662 /* Check MMU enabled */
663 if (is_soc_type(MXC_SOC_MX6) && get_cr() & CR_M) {
666 * This won't work on Rev 1.0.0 of
667 * i.MX6Q/D, since their ROM doesn't
668 * do cache flushes. don't think any
669 * exist, so we ignore them.
672 writel(1, MX6DQ_PU_IROM_MMU_EN_VAR);
673 } else if (is_mx6sdl()) {
674 writel(1, MX6DLS_PU_IROM_MMU_EN_VAR);
675 } else if (is_mx6sl()) {
676 writel(1, MX6SL_PU_IROM_MMU_EN_VAR);
680 load_addr = (uint32_t)hab_rvt_authenticate_image(
682 ivt_offset, (void **)&start,
683 (size_t *)&bytes, NULL);
684 if (hab_rvt_exit() != HAB_SUCCESS) {
685 puts("hab exit function fail\n");
689 hab_exit_failure_print_status:
690 #if !defined(CONFIG_SPL_BUILD)
694 hab_authentication_exit: