[U-Boot] [PATCH v5 10/13] imx: imx7d: add hab secure boot support

[Stefano Babic <sbabic@denx.de>]

Hi Adrian,

On 11/08/2015 18:19, Adrian Alonso wrote:
> * HAB secure boot support
>   - get_hab_status: checks if secure boot is enabled or not
>   - authenticate_image: verifies image properly signed based
>     on CSF entry
> * Uboot command for hab authenticate
>   - hab_auth_img: authenticate image via HAB
>   - hab_status: display HAB status
> 
> Signed-off-by: Ye.Li <B37916@freescale.com>
> Signed-off-by: Peng Fan <Peng.Fan@freescale.com>
> Signed-off-by: Adrian Alonso <aalonso@freescale.com>
> ---
> Changes for V2: Split from patch imx: imx7d: initial arch level support
> Changes for V3: Resend
> Changes for V4: Resend
> Changes for V5: Add complete list of Signed-off's
> 

You have to convince me: this patch is a reworked version of hab.c in
the i.MX6 directory. I will not say that is identical, but most
functions are at least similar. It makes sense to add support for MX7 to
the current hab.c without duplicating it. Why do we need a complete new
implementation for MX7 ?

>  arch/arm/cpu/armv7/mx7/Makefile     |   9 ++
>  arch/arm/cpu/armv7/mx7/hab.c        | 277 ++++++++++++++++++++++++++++++++++++
>  arch/arm/include/asm/arch-mx7/hab.h |  69 +++++++++
>  3 files changed, 355 insertions(+)
>  create mode 100644 arch/arm/cpu/armv7/mx7/Makefile
>  create mode 100644 arch/arm/cpu/armv7/mx7/hab.c
>  create mode 100644 arch/arm/include/asm/arch-mx7/hab.h
> 
> diff --git a/arch/arm/cpu/armv7/mx7/Makefile b/arch/arm/cpu/armv7/mx7/Makefile
> new file mode 100644
> index 0000000..d36501d
> --- /dev/null
> +++ b/arch/arm/cpu/armv7/mx7/Makefile
> @@ -0,0 +1,9 @@
> +#
> +# (C) Copyright 2015 Freescale Semiconductor, Inc.
> +#
> +# SPDX-License-Identifier:	GPL-2.0+
> +#
> +#
> +
> +obj-y	:= soc.o clock.o clock_slice.o
> +obj-$(CONFIG_SECURE_BOOT)    += hab.o
> diff --git a/arch/arm/cpu/armv7/mx7/hab.c b/arch/arm/cpu/armv7/mx7/hab.c
> new file mode 100644
> index 0000000..43b06bd
> --- /dev/null
> +++ b/arch/arm/cpu/armv7/mx7/hab.c
> @@ -0,0 +1,277 @@
> +/*
> + * Copyright (C) 2015 Freescale Semiconductor, Inc.
> + *
> + * SPDX-License-Identifier:    GPL-2.0+
> + */
> +
> +#include <common.h>
> +#include <asm/io.h>
> +#include <asm/arch/hab.h>
> +#include <asm/arch/clock.h>
> +#include <asm/arch/sys_proto.h>
> +
> +/* -------- start of HAB API updates ------------*/
> +#define hab_rvt_report_event_p						\
> +(									\
> +	((hab_rvt_report_event_t *)HAB_RVT_REPORT_EVENT)		\
> +)
> +
> +#define hab_rvt_report_status_p						\
> +(									\
> +	((hab_rvt_report_status_t *)HAB_RVT_REPORT_STATUS)		\
> +)
> +
> +#define hab_rvt_authenticate_image_p					\
> +(									\
> +	((hab_rvt_authenticate_image_t *)HAB_RVT_AUTHENTICATE_IMAGE)	\
> +)
> +
> +#define hab_rvt_entry_p							\
> +(									\
> +	((hab_rvt_entry_t *)HAB_RVT_ENTRY)				\
> +)
> +
> +#define hab_rvt_exit_p							\
> +(									\
> +	((hab_rvt_exit_t *)HAB_RVT_EXIT)				\
> +)
> +
> +#define IVT_SIZE		0x20
> +#define ALIGN_SIZE		0x1000
> +#define CSF_PAD_SIZE		0x2000
> +
> +/*
> + * +------------+  0x0 (DDR_UIMAGE_START) -
> + * |   Header   |                          |
> + * +------------+  0x40                    |
> + * |            |                          |
> + * |            |                          |
> + * |            |                          |
> + * |            |                          |
> + * | Image Data |                          |
> + * .            |                          |
> + * .            |                           > Stuff to be authenticated ----+
> + * .            |                          |                                |
> + * |            |                          |                                |
> + * |            |                          |                                |
> + * +------------+                          |                                |
> + * |            |                          |                                |
> + * | Fill Data  |                          |                                |
> + * |            |                          |                                |
> + * +------------+ Align to ALIGN_SIZE      |                                |
> + * |    IVT     |                          |                                |
> + * +------------+ + IVT_SIZE              -                                 |
> + * |            |                                                           |
> + * |  CSF DATA  | <---------------------------------------------------------+
> + * |            |
> + * +------------+
> + * |            |
> + * | Fill Data  |
> + * |            |
> + * +------------+ + CSF_PAD_SIZE
> + */
> +
> +bool is_hab_enabled(void)
> +{
> +	struct ocotp_regs *ocotp = (struct ocotp_regs *)OCOTP_BASE_ADDR;
> +	struct fuse_bank *bank = &ocotp->bank[1];
> +	struct fuse_bank1_regs *fuse =
> +		(struct fuse_bank1_regs *)bank->fuse_regs;
> +	uint32_t reg = readl(&fuse->cfg0);
> +
> +	return (reg & 0x2000000) == 0x2000000;
> +}
> +
> +void display_event(uint8_t *event_data, size_t bytes)
> +{
> +	uint32_t i;
> +
> +	if (!(event_data && bytes > 0))
> +		return;
> +
> +	for (i = 0; i < bytes; i++) {
> +		if (i == 0)
> +			printf("\t0x%02x", event_data[i]);
> +		else if ((i % 8) == 0)
> +			printf("\n\t0x%02x", event_data[i]);
> +		else
> +			printf(" 0x%02x", event_data[i]);
> +	}
> +}
> +
> +int get_hab_status(void)
> +{
> +	uint32_t index = 0; /* Loop index */
> +	uint8_t event_data[128]; /* Event data buffer */
> +	size_t bytes = sizeof(event_data); /* Event size in bytes */
> +	enum hab_config config = 0;
> +	enum hab_state state = 0;
> +	hab_rvt_report_event_t *hab_rvt_report_event;
> +	hab_rvt_report_status_t *hab_rvt_report_status;
> +
> +	if (is_hab_enabled())
> +		puts("\nSecure boot enabled\n");
> +	else
> +		puts("\nSecure boot disabled\n");
> +
> +	hab_rvt_report_event = hab_rvt_report_event_p;
> +	hab_rvt_report_status = hab_rvt_report_status_p;
> +
> +	/* Check HAB status */
> +	if (hab_rvt_report_status(&config, &state) != HAB_SUCCESS) {
> +		printf("\nHAB Configuration: 0x%02x, HAB State: 0x%02x\n",
> +		       config, state);
> +
> +		/* Display HAB Error events */
> +		while (hab_rvt_report_event(HAB_FAILURE, index, event_data,
> +					&bytes) == HAB_SUCCESS) {
> +			puts("\n");
> +			printf("--------- HAB Event %d -----------------\n",
> +			       index + 1);
> +			puts("event data:\n");
> +			display_event(event_data, bytes);
> +			puts("\n");
> +			bytes = sizeof(event_data);
> +			index++;
> +		}
> +	}
> +	/* Display message if no HAB events are found */
> +	else {
> +		printf("\nHAB Configuration: 0x%02x, HAB State: 0x%02x\n",
> +		       config, state);
> +		puts("No HAB Events Found!\n\n");
> +	}
> +	return 0;
> +}
> +
> +#ifdef DEBUG_AUTHENTICATE_IMAGE
> +void dump_mem(uint32_t addr, int size)
> +{
> +	int i;
> +
> +	for (i = 0; i < size; i += 4) {
> +		if (i != 0) {
> +			if (i % 16 == 0)
> +				printf("\n");
> +			else
> +				printf(" ");
> +		}
> +
> +		printf("0x%08x", *(uint32_t *)addr);
> +		addr += 4;
> +	}
> +
> +	printf("\n");
> +
> +	return;
> +}
> +#endif
> +
> +uint32_t authenticate_image(uint32_t ddr_start, uint32_t image_size)
> +{
> +	uint32_t load_addr = 0;
> +	size_t bytes;
> +	ptrdiff_t ivt_offset = 0;
> +	int result = 0;
> +	ulong start;
> +	hab_rvt_authenticate_image_t *hab_rvt_authenticate_image;
> +	hab_rvt_entry_t *hab_rvt_entry;
> +	hab_rvt_exit_t *hab_rvt_exit;
> +
> +	hab_rvt_authenticate_image = hab_rvt_authenticate_image_p;
> +	hab_rvt_entry = hab_rvt_entry_p;
> +	hab_rvt_exit = hab_rvt_exit_p;
> +
> +	if (is_hab_enabled()) {
> +		printf("\nAuthenticate uImage from DDR location 0x%x...\n",
> +			ddr_start);
> +
> +		hab_caam_clock_enable(1);
> +
> +		if (hab_rvt_entry() == HAB_SUCCESS) {
> +			/* If not already aligned, Align to ALIGN_SIZE */
> +			ivt_offset = (image_size + ALIGN_SIZE - 1) &
> +					~(ALIGN_SIZE - 1);
> +
> +			start = ddr_start;
> +			bytes = ivt_offset + IVT_SIZE + CSF_PAD_SIZE;
> +
> +#ifdef DEBUG_AUTHENTICATE_IMAGE
> +			printf("\nivt_offset = 0x%x, ivt addr = 0x%x\n",
> +			       ivt_offset, ddr_start + ivt_offset);
> +			printf("Dumping IVT\n");
> +			dump_mem(ddr_start + ivt_offset, 0x20);
> +
> +			printf("Dumping CSF Header\n");
> +			dump_mem(ddr_start + ivt_offset + 0x20, 0x40);
> +
> +			get_hab_status();
> +
> +			printf("\nCalling authenticate_image in ROM\n");
> +			printf("\tivt_offset = 0x%x\n\tstart = 0x%08x"
> +			       "\n\tbytes = 0x%x\n", ivt_offset, start, bytes);
> +#endif
> +			load_addr = (uint32_t)hab_rvt_authenticate_image(
> +					HAB_CID_UBOOT,
> +					ivt_offset, (void **)&start,
> +					(size_t *)&bytes, NULL);
> +			if (hab_rvt_exit() != HAB_SUCCESS) {
> +				printf("hab exit function fail\n");
> +				load_addr = 0;
> +			}
> +		} else
> +			printf("hab entry function fail\n");
> +
> +		hab_caam_clock_enable(0);
> +
> +		get_hab_status();
> +	}
> +
> +	if ((!is_hab_enabled()) || (load_addr != 0))
> +		result = 1;
> +
> +	return result;
> +}
> +
> +int do_hab_status(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
> +{
> +	if ((argc != 1)) {
> +		cmd_usage(cmdtp);
> +		return 1;
> +	}
> +
> +	get_hab_status();
> +
> +	return 0;
> +}
> +
> +static int do_authenticate_image(cmd_tbl_t *cmdtp, int flag, int argc,
> +				char * const argv[])
> +{
> +	ulong	addr, ivt_offset;
> +	int	rcode = 0;
> +
> +	if (argc < 3)
> +		return CMD_RET_USAGE;
> +
> +	addr = simple_strtoul(argv[1], NULL, 16);
> +	ivt_offset = simple_strtoul(argv[2], NULL, 16);
> +
> +	rcode = authenticate_image(addr, ivt_offset);
> +
> +	return rcode;
> +}
> +
> +U_BOOT_CMD(
> +		hab_status, CONFIG_SYS_MAXARGS, 1, do_hab_status,
> +		"display HAB status",
> +		""
> +	  );
> +
> +U_BOOT_CMD(
> +		hab_auth_img, 3, 1, do_authenticate_image,
> +		"authenticate image via HAB",
> +		"addr ivt_offset\n"
> +		"addr - image hex address\n"
> +		"ivt_offset - hex offset of IVT in the image"
> +	  );
> diff --git a/arch/arm/include/asm/arch-mx7/hab.h b/arch/arm/include/asm/arch-mx7/hab.h
> new file mode 100644
> index 0000000..56a884e
> --- /dev/null
> +++ b/arch/arm/include/asm/arch-mx7/hab.h
> @@ -0,0 +1,69 @@
> +/*
> + * Copyright (C) 2015 Freescale Semiconductor, Inc. All Rights Reserved.
> + *
> + * SPDX-License-Identifier:    GPL-2.0+
> + *
> +*/
> +
> +#ifndef __SECURE_MX7_H__
> +#define __SECURE_MX7_H__
> +
> +#include <linux/types.h>
> +
> +/* -------- start of HAB API updates ------------*/
> +/* The following are taken from HAB4 SIS */
> +
> +/* Status definitions */
> +enum hab_status {
> +	HAB_STS_ANY = 0x00,
> +	HAB_FAILURE = 0x33,
> +	HAB_WARNING = 0x69,
> +	HAB_SUCCESS = 0xf0
> +};
> +
> +/* Security Configuration definitions */
> +enum hab_config {
> +	HAB_CFG_RETURN = 0x33, /**< Field Return IC */
> +	HAB_CFG_OPEN = 0xf0, /**< Non-secure IC */
> +	HAB_CFG_CLOSED = 0xcc /**< Secure IC */
> +};
> +
> +/* State definitions */
> +enum hab_state {
> +	HAB_STATE_INITIAL = 0x33, /**< Initialising state (transitory) */
> +	HAB_STATE_CHECK = 0x55, /**< Check state (non-secure) */
> +	HAB_STATE_NONSECURE = 0x66, /**< Non-secure state */
> +	HAB_STATE_TRUSTED = 0x99, /**< Trusted state */
> +	HAB_STATE_SECURE = 0xaa, /**< Secure state */
> +	HAB_STATE_FAIL_SOFT = 0xcc, /**< Soft fail state */
> +	HAB_STATE_FAIL_HARD = 0xff, /**< Hard fail state (terminal) */
> +	HAB_STATE_NONE = 0xf0, /**< No security state machine */
> +	HAB_STATE_MAX
> +};
> +
> +/*Function prototype description*/
> +typedef enum hab_status hab_rvt_report_event_t(enum hab_status, uint32_t,
> +		uint8_t* , size_t*);
> +typedef enum hab_status hab_rvt_report_status_t(enum hab_config *,
> +		enum hab_state *);
> +typedef enum hab_status hab_loader_callback_f_t(void**, size_t*, const void*);
> +typedef enum hab_status hab_rvt_entry_t(void);
> +typedef enum hab_status hab_rvt_exit_t(void);
> +typedef void *hab_rvt_authenticate_image_t(uint8_t, ptrdiff_t,
> +		void **, size_t *, hab_loader_callback_f_t);
> +typedef void hapi_clock_init_t(void);
> +
> +#define HAB_RVT_UNIFIED_BASE			0x00000100
> +#define HAB_RVT_ENTRY				(*(uint32_t *)(HAB_RVT_UNIFIED_BASE + 0x04))
> +#define HAB_RVT_EXIT				(*(uint32_t *)(HAB_RVT_UNIFIED_BASE + 0x08))
> +#define HAB_RVT_AUTHENTICATE_IMAGE		(*(uint32_t *)(HAB_RVT_UNIFIED_BASE + 0x10))
> +#define HAB_RVT_REPORT_EVENT			(*(uint32_t *)(HAB_RVT_UNIFIED_BASE + 0x20))
> +#define HAB_RVT_REPORT_STATUS			(*(uint32_t *)(HAB_RVT_UNIFIED_BASE + 0x24))
> +
> +#define HAB_RVT_CLOCK_INIT ((hapi_clock_init_t *)0x0000024D)
> +
> +#define HAB_CID_ROM 0 /**< ROM Caller ID */
> +#define HAB_CID_UBOOT 1 /**< UBOOT Caller ID*/
> +/* ----------- end of HAB API updates ------------*/
> +
> +#endif
> 

Best regards,
Stefano Babic

-- 
=====================================================================
DENX Software Engineering GmbH,      Managing Director: Wolfgang Denk
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: +49-8142-66989-53 Fax: +49-8142-66989-80 Email: sbabic at denx.de
=====================================================================