d1c5f696815cdbb519b1a40c0d95cf0c263d428f
[platform/kernel/u-boot.git] / arch / arm / mach-imx / hab.c
1 /*
2  * Copyright (C) 2010-2015 Freescale Semiconductor, Inc.
3  *
4  * SPDX-License-Identifier:    GPL-2.0+
5  */
6
7 #include <common.h>
8 #include <config.h>
9 #include <fuse.h>
10 #include <asm/io.h>
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>
15
16 /* -------- start of HAB API updates ------------*/
17
18 #define hab_rvt_report_event_p                                  \
19 (                                                               \
20         (is_mx6dqp()) ?                                         \
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)        \
27 )
28
29 #define hab_rvt_report_status_p                                 \
30 (                                                               \
31         (is_mx6dqp()) ?                                         \
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)      \
38 )
39
40 #define hab_rvt_authenticate_image_p                            \
41 (                                                               \
42         (is_mx6dqp()) ?                                         \
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)    \
49 )
50
51 #define hab_rvt_entry_p                                         \
52 (                                                               \
53         (is_mx6dqp()) ?                                         \
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)                      \
60 )
61
62 #define hab_rvt_exit_p                                          \
63 (                                                               \
64         (is_mx6dqp()) ?                                         \
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)                        \
71 )
72
73 static inline enum hab_status hab_rvt_check_target_new(enum hab_target target,
74                                                        const void *start,
75                                                        size_t bytes)
76 {
77         return HAB_SUCCESS;
78 }
79
80 #define hab_rvt_check_target_p                                  \
81 (                                                               \
82         (is_mx6dqp()) ?                                         \
83         ((hab_rvt_check_target_t *)hab_rvt_check_target_new) :  \
84         (is_mx6dq() && (soc_rev() >= CHIP_REV_1_5)) ?           \
85         ((hab_rvt_check_target_t *)hab_rvt_check_target_new) :  \
86         (is_mx6sdl() && (soc_rev() >= CHIP_REV_1_2)) ?          \
87         ((hab_rvt_check_target_t *)hab_rvt_check_target_new) :  \
88         ((hab_rvt_check_target_t *)HAB_RVT_CHECK_TARGET)        \
89 )
90
91 #define ALIGN_SIZE              0x1000
92 #define MX6DQ_PU_IROM_MMU_EN_VAR        0x009024a8
93 #define MX6DLS_PU_IROM_MMU_EN_VAR       0x00901dd0
94 #define MX6SL_PU_IROM_MMU_EN_VAR        0x00900a18
95 #define IS_HAB_ENABLED_BIT \
96         (is_soc_type(MXC_SOC_MX7ULP) ? 0x80000000 :     \
97          (is_soc_type(MXC_SOC_MX7) ? 0x2000000 : 0x2))
98
99 static int ivt_header_error(const char *err_str, struct ivt_header *ivt_hdr)
100 {
101         printf("%s magic=0x%x length=0x%02x version=0x%x\n", err_str,
102                ivt_hdr->magic, ivt_hdr->length, ivt_hdr->version);
103
104         return 1;
105 }
106
107 static int verify_ivt_header(struct ivt_header *ivt_hdr)
108 {
109         int result = 0;
110
111         if (ivt_hdr->magic != IVT_HEADER_MAGIC)
112                 result = ivt_header_error("bad magic", ivt_hdr);
113
114         if (be16_to_cpu(ivt_hdr->length) != IVT_TOTAL_LENGTH)
115                 result = ivt_header_error("bad length", ivt_hdr);
116
117         if (ivt_hdr->version != IVT_HEADER_V1 &&
118             ivt_hdr->version != IVT_HEADER_V2)
119                 result = ivt_header_error("bad version", ivt_hdr);
120
121         return result;
122 }
123
124 #if !defined(CONFIG_SPL_BUILD)
125
126 #define MAX_RECORD_BYTES     (8*1024) /* 4 kbytes */
127
128 struct record {
129         uint8_t  tag;                                           /* Tag */
130         uint8_t  len[2];                                        /* Length */
131         uint8_t  par;                                           /* Version */
132         uint8_t  contents[MAX_RECORD_BYTES];/* Record Data */
133         bool     any_rec_flag;
134 };
135
136 static char *rsn_str[] = {
137                           "RSN = HAB_RSN_ANY (0x00)\n",
138                           "RSN = HAB_ENG_FAIL (0x30)\n",
139                           "RSN = HAB_INV_ADDRESS (0x22)\n",
140                           "RSN = HAB_INV_ASSERTION (0x0C)\n",
141                           "RSN = HAB_INV_CALL (0x28)\n",
142                           "RSN = HAB_INV_CERTIFICATE (0x21)\n",
143                           "RSN = HAB_INV_COMMAND (0x06)\n",
144                           "RSN = HAB_INV_CSF (0x11)\n",
145                           "RSN = HAB_INV_DCD (0x27)\n",
146                           "RSN = HAB_INV_INDEX (0x0F)\n",
147                           "RSN = HAB_INV_IVT (0x05)\n",
148                           "RSN = HAB_INV_KEY (0x1D)\n",
149                           "RSN = HAB_INV_RETURN (0x1E)\n",
150                           "RSN = HAB_INV_SIGNATURE (0x18)\n",
151                           "RSN = HAB_INV_SIZE (0x17)\n",
152                           "RSN = HAB_MEM_FAIL (0x2E)\n",
153                           "RSN = HAB_OVR_COUNT (0x2B)\n",
154                           "RSN = HAB_OVR_STORAGE (0x2D)\n",
155                           "RSN = HAB_UNS_ALGORITHM (0x12)\n",
156                           "RSN = HAB_UNS_COMMAND (0x03)\n",
157                           "RSN = HAB_UNS_ENGINE (0x0A)\n",
158                           "RSN = HAB_UNS_ITEM (0x24)\n",
159                           "RSN = HAB_UNS_KEY (0x1B)\n",
160                           "RSN = HAB_UNS_PROTOCOL (0x14)\n",
161                           "RSN = HAB_UNS_STATE (0x09)\n",
162                           "RSN = INVALID\n",
163                           NULL
164 };
165
166 static char *sts_str[] = {
167                           "STS = HAB_SUCCESS (0xF0)\n",
168                           "STS = HAB_FAILURE (0x33)\n",
169                           "STS = HAB_WARNING (0x69)\n",
170                           "STS = INVALID\n",
171                           NULL
172 };
173
174 static char *eng_str[] = {
175                           "ENG = HAB_ENG_ANY (0x00)\n",
176                           "ENG = HAB_ENG_SCC (0x03)\n",
177                           "ENG = HAB_ENG_RTIC (0x05)\n",
178                           "ENG = HAB_ENG_SAHARA (0x06)\n",
179                           "ENG = HAB_ENG_CSU (0x0A)\n",
180                           "ENG = HAB_ENG_SRTC (0x0C)\n",
181                           "ENG = HAB_ENG_DCP (0x1B)\n",
182                           "ENG = HAB_ENG_CAAM (0x1D)\n",
183                           "ENG = HAB_ENG_SNVS (0x1E)\n",
184                           "ENG = HAB_ENG_OCOTP (0x21)\n",
185                           "ENG = HAB_ENG_DTCP (0x22)\n",
186                           "ENG = HAB_ENG_ROM (0x36)\n",
187                           "ENG = HAB_ENG_HDCP (0x24)\n",
188                           "ENG = HAB_ENG_RTL (0x77)\n",
189                           "ENG = HAB_ENG_SW (0xFF)\n",
190                           "ENG = INVALID\n",
191                           NULL
192 };
193
194 static char *ctx_str[] = {
195                           "CTX = HAB_CTX_ANY(0x00)\n",
196                           "CTX = HAB_CTX_FAB (0xFF)\n",
197                           "CTX = HAB_CTX_ENTRY (0xE1)\n",
198                           "CTX = HAB_CTX_TARGET (0x33)\n",
199                           "CTX = HAB_CTX_AUTHENTICATE (0x0A)\n",
200                           "CTX = HAB_CTX_DCD (0xDD)\n",
201                           "CTX = HAB_CTX_CSF (0xCF)\n",
202                           "CTX = HAB_CTX_COMMAND (0xC0)\n",
203                           "CTX = HAB_CTX_AUT_DAT (0xDB)\n",
204                           "CTX = HAB_CTX_ASSERT (0xA0)\n",
205                           "CTX = HAB_CTX_EXIT (0xEE)\n",
206                           "CTX = INVALID\n",
207                           NULL
208 };
209
210 static uint8_t hab_statuses[5] = {
211         HAB_STS_ANY,
212         HAB_FAILURE,
213         HAB_WARNING,
214         HAB_SUCCESS,
215         -1
216 };
217
218 static uint8_t hab_reasons[26] = {
219         HAB_RSN_ANY,
220         HAB_ENG_FAIL,
221         HAB_INV_ADDRESS,
222         HAB_INV_ASSERTION,
223         HAB_INV_CALL,
224         HAB_INV_CERTIFICATE,
225         HAB_INV_COMMAND,
226         HAB_INV_CSF,
227         HAB_INV_DCD,
228         HAB_INV_INDEX,
229         HAB_INV_IVT,
230         HAB_INV_KEY,
231         HAB_INV_RETURN,
232         HAB_INV_SIGNATURE,
233         HAB_INV_SIZE,
234         HAB_MEM_FAIL,
235         HAB_OVR_COUNT,
236         HAB_OVR_STORAGE,
237         HAB_UNS_ALGORITHM,
238         HAB_UNS_COMMAND,
239         HAB_UNS_ENGINE,
240         HAB_UNS_ITEM,
241         HAB_UNS_KEY,
242         HAB_UNS_PROTOCOL,
243         HAB_UNS_STATE,
244         -1
245 };
246
247 static uint8_t hab_contexts[12] = {
248         HAB_CTX_ANY,
249         HAB_CTX_FAB,
250         HAB_CTX_ENTRY,
251         HAB_CTX_TARGET,
252         HAB_CTX_AUTHENTICATE,
253         HAB_CTX_DCD,
254         HAB_CTX_CSF,
255         HAB_CTX_COMMAND,
256         HAB_CTX_AUT_DAT,
257         HAB_CTX_ASSERT,
258         HAB_CTX_EXIT,
259         -1
260 };
261
262 static uint8_t hab_engines[16] = {
263         HAB_ENG_ANY,
264         HAB_ENG_SCC,
265         HAB_ENG_RTIC,
266         HAB_ENG_SAHARA,
267         HAB_ENG_CSU,
268         HAB_ENG_SRTC,
269         HAB_ENG_DCP,
270         HAB_ENG_CAAM,
271         HAB_ENG_SNVS,
272         HAB_ENG_OCOTP,
273         HAB_ENG_DTCP,
274         HAB_ENG_ROM,
275         HAB_ENG_HDCP,
276         HAB_ENG_RTL,
277         HAB_ENG_SW,
278         -1
279 };
280
281 static inline uint8_t get_idx(uint8_t *list, uint8_t tgt)
282 {
283         uint8_t idx = 0;
284         uint8_t element = list[idx];
285         while (element != -1) {
286                 if (element == tgt)
287                         return idx;
288                 element = list[++idx];
289         }
290         return -1;
291 }
292
293 static void process_event_record(uint8_t *event_data, size_t bytes)
294 {
295         struct record *rec = (struct record *)event_data;
296
297         printf("\n\n%s", sts_str[get_idx(hab_statuses, rec->contents[0])]);
298         printf("%s", rsn_str[get_idx(hab_reasons, rec->contents[1])]);
299         printf("%s", ctx_str[get_idx(hab_contexts, rec->contents[2])]);
300         printf("%s", eng_str[get_idx(hab_engines, rec->contents[3])]);
301 }
302
303 static void display_event(uint8_t *event_data, size_t bytes)
304 {
305         uint32_t i;
306
307         if (!(event_data && bytes > 0))
308                 return;
309
310         for (i = 0; i < bytes; i++) {
311                 if (i == 0)
312                         printf("\t0x%02x", event_data[i]);
313                 else if ((i % 8) == 0)
314                         printf("\n\t0x%02x", event_data[i]);
315                 else
316                         printf(" 0x%02x", event_data[i]);
317         }
318
319         process_event_record(event_data, bytes);
320 }
321
322 static int get_hab_status(void)
323 {
324         uint32_t index = 0; /* Loop index */
325         uint8_t event_data[128]; /* Event data buffer */
326         size_t bytes = sizeof(event_data); /* Event size in bytes */
327         enum hab_config config = 0;
328         enum hab_state state = 0;
329         hab_rvt_report_event_t *hab_rvt_report_event;
330         hab_rvt_report_status_t *hab_rvt_report_status;
331
332         hab_rvt_report_event = hab_rvt_report_event_p;
333         hab_rvt_report_status = hab_rvt_report_status_p;
334
335         if (imx_hab_is_enabled())
336                 puts("\nSecure boot enabled\n");
337         else
338                 puts("\nSecure boot disabled\n");
339
340         /* Check HAB status */
341         if (hab_rvt_report_status(&config, &state) != HAB_SUCCESS) {
342                 printf("\nHAB Configuration: 0x%02x, HAB State: 0x%02x\n",
343                        config, state);
344
345                 /* Display HAB Error events */
346                 while (hab_rvt_report_event(HAB_FAILURE, index, event_data,
347                                         &bytes) == HAB_SUCCESS) {
348                         puts("\n");
349                         printf("--------- HAB Event %d -----------------\n",
350                                index + 1);
351                         puts("event data:\n");
352                         display_event(event_data, bytes);
353                         puts("\n");
354                         bytes = sizeof(event_data);
355                         index++;
356                 }
357         }
358         /* Display message if no HAB events are found */
359         else {
360                 printf("\nHAB Configuration: 0x%02x, HAB State: 0x%02x\n",
361                        config, state);
362                 puts("No HAB Events Found!\n\n");
363         }
364         return 0;
365 }
366
367 static int do_hab_status(cmd_tbl_t *cmdtp, int flag, int argc,
368                          char * const argv[])
369 {
370         if ((argc != 1)) {
371                 cmd_usage(cmdtp);
372                 return 1;
373         }
374
375         get_hab_status();
376
377         return 0;
378 }
379
380 static int do_authenticate_image(cmd_tbl_t *cmdtp, int flag, int argc,
381                                  char * const argv[])
382 {
383         ulong   addr, length, ivt_offset;
384         int     rcode = 0;
385
386         if (argc < 4)
387                 return CMD_RET_USAGE;
388
389         addr = simple_strtoul(argv[1], NULL, 16);
390         length = simple_strtoul(argv[2], NULL, 16);
391         ivt_offset = simple_strtoul(argv[3], NULL, 16);
392
393         rcode = imx_hab_authenticate_image(addr, length, ivt_offset);
394         if (rcode == 0)
395                 rcode = CMD_RET_SUCCESS;
396         else
397                 rcode = CMD_RET_FAILURE;
398
399         return rcode;
400 }
401
402 U_BOOT_CMD(
403                 hab_status, CONFIG_SYS_MAXARGS, 1, do_hab_status,
404                 "display HAB status",
405                 ""
406           );
407
408 U_BOOT_CMD(
409                 hab_auth_img, 4, 0, do_authenticate_image,
410                 "authenticate image via HAB",
411                 "addr length ivt_offset\n"
412                 "addr - image hex address\n"
413                 "length - image hex length\n"
414                 "ivt_offset - hex offset of IVT in the image"
415           );
416
417
418 #endif /* !defined(CONFIG_SPL_BUILD) */
419
420 bool imx_hab_is_enabled(void)
421 {
422         struct imx_sec_config_fuse_t *fuse =
423                 (struct imx_sec_config_fuse_t *)&imx_sec_config_fuse;
424         uint32_t reg;
425         int ret;
426
427         ret = fuse_read(fuse->bank, fuse->word, &reg);
428         if (ret) {
429                 puts("\nSecure boot fuse read error\n");
430                 return ret;
431         }
432
433         return (reg & IS_HAB_ENABLED_BIT) == IS_HAB_ENABLED_BIT;
434 }
435
436 int imx_hab_authenticate_image(uint32_t ddr_start, uint32_t image_size,
437                                uint32_t ivt_offset)
438 {
439         uint32_t load_addr = 0;
440         size_t bytes;
441         uint32_t ivt_addr = 0;
442         int result = 1;
443         ulong start;
444         hab_rvt_authenticate_image_t *hab_rvt_authenticate_image;
445         hab_rvt_entry_t *hab_rvt_entry;
446         hab_rvt_exit_t *hab_rvt_exit;
447         hab_rvt_check_target_t *hab_rvt_check_target;
448         struct ivt *ivt;
449         struct ivt_header *ivt_hdr;
450         enum hab_status status;
451
452         hab_rvt_authenticate_image = hab_rvt_authenticate_image_p;
453         hab_rvt_entry = hab_rvt_entry_p;
454         hab_rvt_exit = hab_rvt_exit_p;
455         hab_rvt_check_target = hab_rvt_check_target_p;
456
457         if (!imx_hab_is_enabled()) {
458                 puts("hab fuse not enabled\n");
459                 return 0;
460         }
461
462         printf("\nAuthenticate image from DDR location 0x%x...\n",
463                ddr_start);
464
465         hab_caam_clock_enable(1);
466
467         /* Calculate IVT address header */
468         ivt_addr = ddr_start + ivt_offset;
469         ivt = (struct ivt *)ivt_addr;
470         ivt_hdr = &ivt->hdr;
471
472         /* Verify IVT header bugging out on error */
473         if (verify_ivt_header(ivt_hdr))
474                 goto hab_caam_clock_disable;
475
476         /* Verify IVT body */
477         if (ivt->self != ivt_addr) {
478                 printf("ivt->self 0x%08x pointer is 0x%08x\n",
479                        ivt->self, ivt_addr);
480                 goto hab_caam_clock_disable;
481         }
482
483         start = ddr_start;
484         bytes = image_size;
485
486         if (hab_rvt_entry() != HAB_SUCCESS) {
487                 puts("hab entry function fail\n");
488                 goto hab_exit_failure_print_status;
489         }
490
491         status = hab_rvt_check_target(HAB_TGT_MEMORY, (void *)ddr_start, bytes);
492         if (status != HAB_SUCCESS) {
493                 printf("HAB check target 0x%08x-0x%08x fail\n",
494                        ddr_start, ddr_start + bytes);
495                 goto hab_exit_failure_print_status;
496         }
497 #ifdef DEBUG
498         printf("\nivt_offset = 0x%x, ivt addr = 0x%x\n", ivt_offset, ivt_addr);
499         printf("ivt entry = 0x%08x, dcd = 0x%08x, csf = 0x%08x\n", ivt->entry,
500                ivt->dcd, ivt->csf);
501         puts("Dumping IVT\n");
502         print_buffer(ivt_addr, (void *)(ivt_addr), 4, 0x8, 0);
503
504         puts("Dumping CSF Header\n");
505         print_buffer(ivt->csf, (void *)(ivt->csf), 4, 0x10, 0);
506
507 #if  !defined(CONFIG_SPL_BUILD)
508         get_hab_status();
509 #endif
510
511         puts("\nCalling authenticate_image in ROM\n");
512         printf("\tivt_offset = 0x%x\n", ivt_offset);
513         printf("\tstart = 0x%08lx\n", start);
514         printf("\tbytes = 0x%x\n", bytes);
515 #endif
516         /*
517          * If the MMU is enabled, we have to notify the ROM
518          * code, or it won't flush the caches when needed.
519          * This is done, by setting the "pu_irom_mmu_enabled"
520          * word to 1. You can find its address by looking in
521          * the ROM map. This is critical for
522          * authenticate_image(). If MMU is enabled, without
523          * setting this bit, authentication will fail and may
524          * crash.
525          */
526         /* Check MMU enabled */
527         if (is_soc_type(MXC_SOC_MX6) && get_cr() & CR_M) {
528                 if (is_mx6dq()) {
529                         /*
530                          * This won't work on Rev 1.0.0 of
531                          * i.MX6Q/D, since their ROM doesn't
532                          * do cache flushes. don't think any
533                          * exist, so we ignore them.
534                          */
535                         if (!is_mx6dqp())
536                                 writel(1, MX6DQ_PU_IROM_MMU_EN_VAR);
537                 } else if (is_mx6sdl()) {
538                         writel(1, MX6DLS_PU_IROM_MMU_EN_VAR);
539                 } else if (is_mx6sl()) {
540                         writel(1, MX6SL_PU_IROM_MMU_EN_VAR);
541                 }
542         }
543
544         load_addr = (uint32_t)hab_rvt_authenticate_image(
545                         HAB_CID_UBOOT,
546                         ivt_offset, (void **)&start,
547                         (size_t *)&bytes, NULL);
548         if (hab_rvt_exit() != HAB_SUCCESS) {
549                 puts("hab exit function fail\n");
550                 load_addr = 0;
551         }
552
553 hab_exit_failure_print_status:
554 #if !defined(CONFIG_SPL_BUILD)
555         get_hab_status();
556 #endif
557
558 hab_caam_clock_disable:
559         hab_caam_clock_enable(0);
560
561         if (load_addr != 0)
562                 result = 0;
563
564         return result;
565 }