1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2010-2015 Freescale Semiconductor, Inc.
12 #include <asm/system.h>
13 #include <asm/arch/clock.h>
14 #include <asm/arch/sys_proto.h>
15 #include <asm/mach-imx/hab.h>
17 #define ALIGN_SIZE 0x1000
18 #define MX6DQ_PU_IROM_MMU_EN_VAR 0x009024a8
19 #define MX6DLS_PU_IROM_MMU_EN_VAR 0x00901dd0
20 #define MX6SL_PU_IROM_MMU_EN_VAR 0x00901c60
21 #define IS_HAB_ENABLED_BIT \
22 (is_soc_type(MXC_SOC_MX7ULP) ? 0x80000000 : \
23 (is_soc_type(MXC_SOC_MX7) ? 0x2000000 : 0x2))
25 static int ivt_header_error(const char *err_str, struct ivt_header *ivt_hdr)
27 printf("%s magic=0x%x length=0x%02x version=0x%x\n", err_str,
28 ivt_hdr->magic, ivt_hdr->length, ivt_hdr->version);
33 static int verify_ivt_header(struct ivt_header *ivt_hdr)
37 if (ivt_hdr->magic != IVT_HEADER_MAGIC)
38 result = ivt_header_error("bad magic", ivt_hdr);
40 if (be16_to_cpu(ivt_hdr->length) != IVT_TOTAL_LENGTH)
41 result = ivt_header_error("bad length", ivt_hdr);
43 if (ivt_hdr->version != IVT_HEADER_V1 &&
44 ivt_hdr->version != IVT_HEADER_V2)
45 result = ivt_header_error("bad version", ivt_hdr);
50 #if !defined(CONFIG_SPL_BUILD)
52 #define MAX_RECORD_BYTES (8*1024) /* 4 kbytes */
55 uint8_t tag; /* Tag */
56 uint8_t len[2]; /* Length */
57 uint8_t par; /* Version */
58 uint8_t contents[MAX_RECORD_BYTES];/* Record Data */
62 static char *rsn_str[] = {
63 "RSN = HAB_RSN_ANY (0x00)\n",
64 "RSN = HAB_ENG_FAIL (0x30)\n",
65 "RSN = HAB_INV_ADDRESS (0x22)\n",
66 "RSN = HAB_INV_ASSERTION (0x0C)\n",
67 "RSN = HAB_INV_CALL (0x28)\n",
68 "RSN = HAB_INV_CERTIFICATE (0x21)\n",
69 "RSN = HAB_INV_COMMAND (0x06)\n",
70 "RSN = HAB_INV_CSF (0x11)\n",
71 "RSN = HAB_INV_DCD (0x27)\n",
72 "RSN = HAB_INV_INDEX (0x0F)\n",
73 "RSN = HAB_INV_IVT (0x05)\n",
74 "RSN = HAB_INV_KEY (0x1D)\n",
75 "RSN = HAB_INV_RETURN (0x1E)\n",
76 "RSN = HAB_INV_SIGNATURE (0x18)\n",
77 "RSN = HAB_INV_SIZE (0x17)\n",
78 "RSN = HAB_MEM_FAIL (0x2E)\n",
79 "RSN = HAB_OVR_COUNT (0x2B)\n",
80 "RSN = HAB_OVR_STORAGE (0x2D)\n",
81 "RSN = HAB_UNS_ALGORITHM (0x12)\n",
82 "RSN = HAB_UNS_COMMAND (0x03)\n",
83 "RSN = HAB_UNS_ENGINE (0x0A)\n",
84 "RSN = HAB_UNS_ITEM (0x24)\n",
85 "RSN = HAB_UNS_KEY (0x1B)\n",
86 "RSN = HAB_UNS_PROTOCOL (0x14)\n",
87 "RSN = HAB_UNS_STATE (0x09)\n",
92 static char *sts_str[] = {
93 "STS = HAB_SUCCESS (0xF0)\n",
94 "STS = HAB_FAILURE (0x33)\n",
95 "STS = HAB_WARNING (0x69)\n",
100 static char *eng_str[] = {
101 "ENG = HAB_ENG_ANY (0x00)\n",
102 "ENG = HAB_ENG_SCC (0x03)\n",
103 "ENG = HAB_ENG_RTIC (0x05)\n",
104 "ENG = HAB_ENG_SAHARA (0x06)\n",
105 "ENG = HAB_ENG_CSU (0x0A)\n",
106 "ENG = HAB_ENG_SRTC (0x0C)\n",
107 "ENG = HAB_ENG_DCP (0x1B)\n",
108 "ENG = HAB_ENG_CAAM (0x1D)\n",
109 "ENG = HAB_ENG_SNVS (0x1E)\n",
110 "ENG = HAB_ENG_OCOTP (0x21)\n",
111 "ENG = HAB_ENG_DTCP (0x22)\n",
112 "ENG = HAB_ENG_ROM (0x36)\n",
113 "ENG = HAB_ENG_HDCP (0x24)\n",
114 "ENG = HAB_ENG_RTL (0x77)\n",
115 "ENG = HAB_ENG_SW (0xFF)\n",
120 static char *ctx_str[] = {
121 "CTX = HAB_CTX_ANY(0x00)\n",
122 "CTX = HAB_CTX_FAB (0xFF)\n",
123 "CTX = HAB_CTX_ENTRY (0xE1)\n",
124 "CTX = HAB_CTX_TARGET (0x33)\n",
125 "CTX = HAB_CTX_AUTHENTICATE (0x0A)\n",
126 "CTX = HAB_CTX_DCD (0xDD)\n",
127 "CTX = HAB_CTX_CSF (0xCF)\n",
128 "CTX = HAB_CTX_COMMAND (0xC0)\n",
129 "CTX = HAB_CTX_AUT_DAT (0xDB)\n",
130 "CTX = HAB_CTX_ASSERT (0xA0)\n",
131 "CTX = HAB_CTX_EXIT (0xEE)\n",
136 static uint8_t hab_statuses[5] = {
144 static uint8_t hab_reasons[26] = {
173 static uint8_t hab_contexts[12] = {
178 HAB_CTX_AUTHENTICATE,
188 static uint8_t hab_engines[16] = {
207 static inline uint8_t get_idx(uint8_t *list, uint8_t tgt)
210 uint8_t element = list[idx];
211 while (element != -1) {
214 element = list[++idx];
219 static void process_event_record(uint8_t *event_data, size_t bytes)
221 struct record *rec = (struct record *)event_data;
223 printf("\n\n%s", sts_str[get_idx(hab_statuses, rec->contents[0])]);
224 printf("%s", rsn_str[get_idx(hab_reasons, rec->contents[1])]);
225 printf("%s", ctx_str[get_idx(hab_contexts, rec->contents[2])]);
226 printf("%s", eng_str[get_idx(hab_engines, rec->contents[3])]);
229 static void display_event(uint8_t *event_data, size_t bytes)
233 if (!(event_data && bytes > 0))
236 for (i = 0; i < bytes; i++) {
238 printf("\t0x%02x", event_data[i]);
239 else if ((i % 8) == 0)
240 printf("\n\t0x%02x", event_data[i]);
242 printf(" 0x%02x", event_data[i]);
245 process_event_record(event_data, bytes);
248 static int get_hab_status(void)
250 uint32_t index = 0; /* Loop index */
251 uint8_t event_data[128]; /* Event data buffer */
252 size_t bytes = sizeof(event_data); /* Event size in bytes */
253 enum hab_config config = 0;
254 enum hab_state state = 0;
255 hab_rvt_report_event_t *hab_rvt_report_event;
256 hab_rvt_report_status_t *hab_rvt_report_status;
258 hab_rvt_report_event = (hab_rvt_report_event_t *)HAB_RVT_REPORT_EVENT;
259 hab_rvt_report_status =
260 (hab_rvt_report_status_t *)HAB_RVT_REPORT_STATUS;
262 if (imx_hab_is_enabled())
263 puts("\nSecure boot enabled\n");
265 puts("\nSecure boot disabled\n");
267 /* Check HAB status */
268 if (hab_rvt_report_status(&config, &state) != HAB_SUCCESS) {
269 printf("\nHAB Configuration: 0x%02x, HAB State: 0x%02x\n",
272 /* Display HAB Error events */
273 while (hab_rvt_report_event(HAB_FAILURE, index, event_data,
274 &bytes) == HAB_SUCCESS) {
276 printf("--------- HAB Event %d -----------------\n",
278 puts("event data:\n");
279 display_event(event_data, bytes);
281 bytes = sizeof(event_data);
285 /* Display message if no HAB events are found */
287 printf("\nHAB Configuration: 0x%02x, HAB State: 0x%02x\n",
289 puts("No HAB Events Found!\n\n");
294 static int do_hab_status(cmd_tbl_t *cmdtp, int flag, int argc,
307 static ulong get_image_ivt_offset(ulong img_addr)
311 buf = map_sysmem(img_addr, 0);
312 switch (genimg_get_format(buf)) {
313 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
314 case IMAGE_FORMAT_LEGACY:
315 return (image_get_image_size((image_header_t *)img_addr)
316 + 0x1000 - 1) & ~(0x1000 - 1);
319 case IMAGE_FORMAT_FIT:
320 return (fit_get_size(buf) + 0x1000 - 1) & ~(0x1000 - 1);
327 static int do_authenticate_image(cmd_tbl_t *cmdtp, int flag, int argc,
330 ulong addr, length, ivt_offset;
334 return CMD_RET_USAGE;
336 addr = simple_strtoul(argv[1], NULL, 16);
337 length = simple_strtoul(argv[2], NULL, 16);
339 ivt_offset = get_image_ivt_offset(addr);
341 ivt_offset = simple_strtoul(argv[3], NULL, 16);
343 rcode = imx_hab_authenticate_image(addr, length, ivt_offset);
345 rcode = CMD_RET_SUCCESS;
347 rcode = CMD_RET_FAILURE;
352 static int do_hab_failsafe(cmd_tbl_t *cmdtp, int flag, int argc,
355 hab_rvt_failsafe_t *hab_rvt_failsafe;
362 hab_rvt_failsafe = (hab_rvt_failsafe_t *)HAB_RVT_FAILSAFE;
368 static int do_hab_version(cmd_tbl_t *cmdtp, int flag, int argc,
371 struct hab_hdr *hdr = (struct hab_hdr *)HAB_RVT_BASE;
373 if (hdr->tag != HAB_TAG_RVT) {
374 printf("Unexpected header tag: %x\n", hdr->tag);
375 return CMD_RET_FAILURE;
378 printf("HAB version: %d.%d\n", hdr->par >> 4, hdr->par & 0xf);
383 static int do_authenticate_image_or_failover(cmd_tbl_t *cmdtp, int flag,
384 int argc, char * const argv[])
386 int ret = CMD_RET_FAILURE;
393 if (!imx_hab_is_enabled()) {
394 printf("error: secure boot disabled\n");
398 if (do_authenticate_image(NULL, flag, argc, argv) != CMD_RET_SUCCESS) {
399 fprintf(stderr, "authentication fail -> %s %s %s %s\n",
400 argv[0], argv[1], argv[2], argv[3]);
401 do_hab_failsafe(0, 0, 1, NULL);
403 ret = CMD_RET_SUCCESS;
409 hab_status, CONFIG_SYS_MAXARGS, 1, do_hab_status,
410 "display HAB status",
415 hab_auth_img, 4, 0, do_authenticate_image,
416 "authenticate image via HAB",
417 "addr length ivt_offset\n"
418 "addr - image hex address\n"
419 "length - image hex length\n"
420 "ivt_offset - hex offset of IVT in the image"
424 hab_failsafe, CONFIG_SYS_MAXARGS, 1, do_hab_failsafe,
425 "run BootROM failsafe routine",
430 hab_auth_img_or_fail, 4, 0,
431 do_authenticate_image_or_failover,
432 "authenticate image via HAB on failure drop to USB BootROM mode",
433 "addr length ivt_offset\n"
434 "addr - image hex address\n"
435 "length - image hex length\n"
436 "ivt_offset - hex offset of IVT in the image"
440 hab_version, 1, 0, do_hab_version,
441 "print HAB major/minor version",
445 #endif /* !defined(CONFIG_SPL_BUILD) */
447 /* Get CSF Header length */
448 static int get_hab_hdr_len(struct hab_hdr *hdr)
450 return (size_t)((hdr->len[0] << 8) + (hdr->len[1]));
453 /* Check whether addr lies between start and
454 * end and is within the length of the image
456 static int chk_bounds(u8 *addr, size_t bytes, u8 *start, u8 *end)
458 size_t csf_size = (size_t)((end + 1) - addr);
460 return (addr && (addr >= start) && (addr <= end) &&
461 (csf_size >= bytes));
464 /* Get Length of each command in CSF */
465 static int get_csf_cmd_hdr_len(u8 *csf_hdr)
467 if (*csf_hdr == HAB_CMD_HDR)
468 return sizeof(struct hab_hdr);
470 return get_hab_hdr_len((struct hab_hdr *)csf_hdr);
473 /* Check if CSF is valid */
474 static bool csf_is_valid(struct ivt *ivt, ulong start_addr, size_t bytes)
476 u8 *start = (u8 *)start_addr;
485 end = start + bytes - 1;
489 /* Verify if CSF pointer content is zero */
491 puts("Error: CSF pointer is NULL\n");
495 csf_hdr = (u8 *)ivt->csf;
497 /* Verify if CSF Header exist */
498 if (*csf_hdr != HAB_CMD_HDR) {
499 puts("Error: CSF header command not found\n");
503 csf_hdr_len = get_hab_hdr_len((struct hab_hdr *)csf_hdr);
505 /* Check if the CSF lies within the image bounds */
506 if (!chk_bounds(csf_hdr, csf_hdr_len, start, end)) {
507 puts("Error: CSF lies outside the image bounds\n");
514 cmd = (struct hab_hdr *)&csf_hdr[offset];
517 case (HAB_CMD_WRT_DAT):
518 puts("Error: Deprecated write command found\n");
520 case (HAB_CMD_CHK_DAT):
521 puts("Error: Deprecated check command found\n");
524 if (cmd->par == HAB_PAR_MID) {
525 puts("Error: Deprecated Set MID command found\n");
532 cmd_hdr_len = get_csf_cmd_hdr_len(&csf_hdr[offset]);
534 puts("Error: Invalid command length\n");
537 offset += cmd_hdr_len;
539 } while (offset < csf_hdr_len);
544 bool imx_hab_is_enabled(void)
546 struct imx_sec_config_fuse_t *fuse =
547 (struct imx_sec_config_fuse_t *)&imx_sec_config_fuse;
551 ret = fuse_read(fuse->bank, fuse->word, ®);
553 puts("\nSecure boot fuse read error\n");
557 return (reg & IS_HAB_ENABLED_BIT) == IS_HAB_ENABLED_BIT;
560 int imx_hab_authenticate_image(uint32_t ddr_start, uint32_t image_size,
563 uint32_t load_addr = 0;
565 uint32_t ivt_addr = 0;
568 hab_rvt_authenticate_image_t *hab_rvt_authenticate_image;
569 hab_rvt_entry_t *hab_rvt_entry;
570 hab_rvt_exit_t *hab_rvt_exit;
571 hab_rvt_check_target_t *hab_rvt_check_target;
573 struct ivt_header *ivt_hdr;
574 enum hab_status status;
576 hab_rvt_authenticate_image =
577 (hab_rvt_authenticate_image_t *)HAB_RVT_AUTHENTICATE_IMAGE;
578 hab_rvt_entry = (hab_rvt_entry_t *)HAB_RVT_ENTRY;
579 hab_rvt_exit = (hab_rvt_exit_t *)HAB_RVT_EXIT;
580 hab_rvt_check_target = (hab_rvt_check_target_t *)HAB_RVT_CHECK_TARGET;
582 if (!imx_hab_is_enabled()) {
583 puts("hab fuse not enabled\n");
587 printf("\nAuthenticate image from DDR location 0x%x...\n",
590 hab_caam_clock_enable(1);
592 /* Calculate IVT address header */
593 ivt_addr = ddr_start + ivt_offset;
594 ivt = (struct ivt *)ivt_addr;
597 /* Verify IVT header bugging out on error */
598 if (verify_ivt_header(ivt_hdr))
599 goto hab_authentication_exit;
601 /* Verify IVT body */
602 if (ivt->self != ivt_addr) {
603 printf("ivt->self 0x%08x pointer is 0x%08x\n",
604 ivt->self, ivt_addr);
605 goto hab_authentication_exit;
608 /* Verify if IVT DCD pointer is NULL */
610 puts("Error: DCD pointer must be NULL\n");
611 goto hab_authentication_exit;
618 if (!csf_is_valid(ivt, start, bytes))
619 goto hab_authentication_exit;
621 if (hab_rvt_entry() != HAB_SUCCESS) {
622 puts("hab entry function fail\n");
623 goto hab_exit_failure_print_status;
626 status = hab_rvt_check_target(HAB_TGT_MEMORY, (void *)ddr_start, bytes);
627 if (status != HAB_SUCCESS) {
628 printf("HAB check target 0x%08x-0x%08x fail\n",
629 ddr_start, ddr_start + bytes);
630 goto hab_exit_failure_print_status;
633 printf("\nivt_offset = 0x%x, ivt addr = 0x%x\n", ivt_offset, ivt_addr);
634 printf("ivt entry = 0x%08x, dcd = 0x%08x, csf = 0x%08x\n", ivt->entry,
636 puts("Dumping IVT\n");
637 print_buffer(ivt_addr, (void *)(ivt_addr), 4, 0x8, 0);
639 puts("Dumping CSF Header\n");
640 print_buffer(ivt->csf, (void *)(ivt->csf), 4, 0x10, 0);
642 #if !defined(CONFIG_SPL_BUILD)
646 puts("\nCalling authenticate_image in ROM\n");
647 printf("\tivt_offset = 0x%x\n", ivt_offset);
648 printf("\tstart = 0x%08lx\n", start);
649 printf("\tbytes = 0x%x\n", bytes);
652 * If the MMU is enabled, we have to notify the ROM
653 * code, or it won't flush the caches when needed.
654 * This is done, by setting the "pu_irom_mmu_enabled"
655 * word to 1. You can find its address by looking in
656 * the ROM map. This is critical for
657 * authenticate_image(). If MMU is enabled, without
658 * setting this bit, authentication will fail and may
661 /* Check MMU enabled */
662 if (is_soc_type(MXC_SOC_MX6) && get_cr() & CR_M) {
665 * This won't work on Rev 1.0.0 of
666 * i.MX6Q/D, since their ROM doesn't
667 * do cache flushes. don't think any
668 * exist, so we ignore them.
671 writel(1, MX6DQ_PU_IROM_MMU_EN_VAR);
672 } else if (is_mx6sdl()) {
673 writel(1, MX6DLS_PU_IROM_MMU_EN_VAR);
674 } else if (is_mx6sl()) {
675 writel(1, MX6SL_PU_IROM_MMU_EN_VAR);
679 load_addr = (uint32_t)hab_rvt_authenticate_image(
681 ivt_offset, (void **)&start,
682 (size_t *)&bytes, NULL);
683 if (hab_rvt_exit() != HAB_SUCCESS) {
684 puts("hab exit function fail\n");
688 hab_exit_failure_print_status:
689 #if !defined(CONFIG_SPL_BUILD)
693 hab_authentication_exit: