[u-boot.git] / tools / zynqmpimage.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * Copyright (C) 2016 Michal Simek <[email protected]>
 * Copyright (C) 2015 Nathan Rossi <[email protected]>
 *
 * The following Boot Header format/structures and values are defined in the
 * following documents:
 *   * ug1085 ZynqMP TRM doc v1.4 (Chapter 11, Table 11-4)
 *   * ug1137 ZynqMP Software Developer Guide v6.0 (Chapter 16)
 *
 * Expected Header Size = 0x9C0
 * Forced as 'little' endian, 32-bit words
 *
 *  0x  0 - Interrupt table (8 words)
 *  ...     (Default value = 0xeafffffe)
 *  0x 1f
 *  0x 20 - Width detection
 *         * DEFAULT_WIDTHDETECTION    0xaa995566
 *  0x 24 - Image identifier
 *         * DEFAULT_IMAGEIDENTIFIER   0x584c4e58
 *  0x 28 - Encryption
 *         * 0x00000000 - None
 *         * 0xa5c3c5a3 - eFuse
 *         * 0xa5c3c5a7 - obfuscated key in eFUSE
 *         * 0x3a5c3c5a - bbRam
 *         * 0xa35c7ca5 - obfuscated key in boot header
 *  0x 2C - Image load
 *  0x 30 - Image offset
 *  0x 34 - PFW image length
 *  0x 38 - Total PFW image length
 *  0x 3C - Image length
 *  0x 40 - Total image length
 *  0x 44 - Image attributes
 *  0x 48 - Header checksum
 *  0x 4c - Obfuscated key
 *  ...
 *  0x 68
 *  0x 6c - Reserved
 *  0x 70 - User defined
 *  ...
 *  0x 9c
 *  0x a0 - Secure header initialization vector
 *  ...
 *  0x a8
 *  0x ac - Obfuscated key initialization vector
 *  ...
 *  0x b4
 *  0x b8 - Register Initialization, 511 Address and Data word pairs
 *         * List is terminated with an address of 0xffffffff or
 *  ...    * at the max number of entries
 *  0x8b4
 *  0x8b8 - Reserved
 *  ...
 *  0x9bf
 *  0x9c0 - Data/Image starts here or above
 */

#include "imagetool.h"
#include "mkimage.h"
#include "zynqmpimage.h"
#include <image.h>

static struct zynqmp_header zynqmpimage_header;
static void *dynamic_header;
static FILE *fpmu;

static uint32_t zynqmpimage_checksum(struct zynqmp_header *ptr)
{
	uint32_t checksum = 0;

	if (ptr == NULL)
		return 0;

	checksum += le32_to_cpu(ptr->width_detection);
	checksum += le32_to_cpu(ptr->image_identifier);
	checksum += le32_to_cpu(ptr->encryption);
	checksum += le32_to_cpu(ptr->image_load);
	checksum += le32_to_cpu(ptr->image_offset);
	checksum += le32_to_cpu(ptr->pfw_image_length);
	checksum += le32_to_cpu(ptr->total_pfw_image_length);
	checksum += le32_to_cpu(ptr->image_size);
	checksum += le32_to_cpu(ptr->image_stored_size);
	checksum += le32_to_cpu(ptr->image_attributes);
	checksum = ~checksum;

	return cpu_to_le32(checksum);
}

void zynqmpimage_default_header(struct zynqmp_header *ptr)
{
	int i;

	if (ptr == NULL)
		return;

	ptr->width_detection = HEADER_WIDTHDETECTION;
	ptr->image_attributes = HEADER_CPU_SELECT_A53_64BIT;
	ptr->image_identifier = HEADER_IMAGEIDENTIFIER;
	ptr->encryption = cpu_to_le32(ENCRYPTION_NONE);

	/* Setup not-supported/constant/reserved fields */
	for (i = 0; i < HEADER_INTERRUPT_VECTORS; i++)
		ptr->interrupt_vectors[i] = HEADER_INTERRUPT_DEFAULT;

	for (i = 0; i < HEADER_REGINITS; i++) {
		ptr->register_init[i].address = HEADER_REGINIT_NULL;
		ptr->register_init[i].data = 0;
	}

	/*
	 * Certain reserved fields are required to be set to 0, ensure they are
	 * set as such.
	 */
	ptr->pfw_image_length = 0x0;
	ptr->total_pfw_image_length = 0x0;
}

/* mkimage glue functions */
static int zynqmpimage_verify_header(unsigned char *ptr, int image_size,
		struct image_tool_params *params)
{
	struct zynqmp_header *zynqhdr = (struct zynqmp_header *)ptr;

	if (image_size < sizeof(struct zynqmp_header))
		return -1;

	if (zynqhdr->width_detection != HEADER_WIDTHDETECTION)
		return -1;
	if (zynqhdr->image_identifier != HEADER_IMAGEIDENTIFIER)
		return -1;

	if (zynqmpimage_checksum(zynqhdr) != zynqhdr->checksum)
		return -1;

	return 0;
}

static struct image_header *
find_partition_image(const struct zynqmp_header *zynqhdr,
		     const struct partition_header *ph)
{
	struct partition_header *ph_walk;
	struct image_header *ih;
	int i;

	for_each_zynqmp_image(zynqhdr, ih) {
		for_each_zynqmp_part_in_image(zynqhdr, i, ph_walk, ih) {
			if (ph == ph_walk)
				return ih;
		}
	}

	return NULL;
}

static void print_partition_name(const struct zynqmp_header *zynqhdr,
				 const struct partition_header *ph)
{
	const struct image_header *ih;
	size_t word_len;
	char *name;
	int i;

	ih = find_partition_image(zynqhdr, ph);
	if (!ih)
		return;

	/* Name is stored in big-endian words, find the terminating word and
	 * byte-swap into a new buffer
	 */
	word_len = strlen((char *)ih->image_name);
	word_len = ALIGN(word_len + 1, 4);

	name = calloc(1, word_len);
	if (!name)
		return;

	for (i = 0; i < word_len / 4; i++)
		((uint32_t *)name)[i] = uswap_32(ih->image_name[i]);

	printf("    Image name : %s\n", name);
	free(name);
}

static void print_partition(const void *ptr, const struct partition_header *ph)
{
	uint32_t attr = le32_to_cpu(ph->attributes);
	unsigned long len = le32_to_cpu(ph->len) * 4;
	unsigned long len_enc = le32_to_cpu(ph->len_enc) * 4;
	unsigned long len_unenc = le32_to_cpu(ph->len_unenc) * 4;
	const char *part_owner;
	const char *dest_devs[0x8] = {
		"none", "PS", "PL", "PMU", "unknown", "unknown", "unknown",
		"unknown"
	};

	switch (attr & PART_ATTR_PART_OWNER_MASK) {
	case PART_ATTR_PART_OWNER_FSBL:
		part_owner = "FSBL";
		break;
	case PART_ATTR_PART_OWNER_UBOOT:
		part_owner = "U-Boot";
		break;
	default:
		part_owner = "Unknown";
		break;
	}

	printf("%s payload on CPU %s (%s):\n", part_owner,
	       dest_cpus[(attr & PART_ATTR_DEST_CPU_MASK) >> 8],
	       dest_devs[(attr & PART_ATTR_DEST_DEVICE_MASK) >> 4]);

	print_partition_name(ptr, ph);
	printf("    Offset     : 0x%08x\n", le32_to_cpu(ph->offset) * 4);
	printf("    Size       : %lu (0x%lx) bytes\n", len, len);
	if (len != len_unenc)
		printf("    Size Data  : %lu (0x%lx) bytes\n", len_unenc, len_unenc);
	if (len_unenc != len_enc)
		printf("    Size Enc   : %lu (0x%lx) bytes\n", len_unenc, len_unenc);
	printf("    Load       : 0x%08llx",
	       (unsigned long long)le64_to_cpu(ph->load_address));
	if (ph->load_address != ph->entry_point)
		printf(" (entry=0x%08llx)\n",
		       (unsigned long long)le64_to_cpu(ph->entry_point));
	else
		printf("\n");
	printf("    Attributes : ");

	if (attr & PART_ATTR_VEC_LOCATION)
		printf("vec ");

	if (attr & PART_ATTR_ENCRYPTED)
		printf("encrypted ");

	switch (attr & PART_ATTR_CHECKSUM_MASK) {
	case PART_ATTR_CHECKSUM_MD5:
		printf("md5 ");
		break;
	case PART_ATTR_CHECKSUM_SHA2:
		printf("sha2 ");
		break;
	case PART_ATTR_CHECKSUM_SHA3:
		printf("sha3 ");
		break;
	}

	if (attr & PART_ATTR_BIG_ENDIAN)
		printf("BigEndian ");

	if (attr & PART_ATTR_RSA_SIG)
		printf("RSA ");

	if (attr & PART_ATTR_A53_EXEC_AARCH32)
		printf("AArch32 ");

	if (attr & PART_ATTR_TARGET_EL_MASK)
		printf("EL%d ", (attr & PART_ATTR_TARGET_EL_MASK) >> 1);

	if (attr & PART_ATTR_TZ_SECURE)
		printf("secure ");
	printf("\n");

	printf("    Checksum   : 0x%08x\n", le32_to_cpu(ph->checksum));
}

void zynqmpimage_print_header(const void *ptr, struct image_tool_params *params)
{
	struct zynqmp_header *zynqhdr = (struct zynqmp_header *)ptr;
	struct partition_header *ph;
	int i;

	printf("Image Type   : Xilinx ZynqMP Boot Image support\n");
	printf("Image Offset : 0x%08x\n", le32_to_cpu(zynqhdr->image_offset));
	printf("Image Size   : %lu bytes (%lu bytes packed)\n",
	       (unsigned long)le32_to_cpu(zynqhdr->image_size),
	       (unsigned long)le32_to_cpu(zynqhdr->image_stored_size));

	if (zynqhdr->pfw_image_length)
		printf("PMUFW Size   : %lu bytes (%lu bytes packed)\n",
		       (unsigned long)le32_to_cpu(zynqhdr->pfw_image_length),
		       (unsigned long)le32_to_cpu(
				zynqhdr->total_pfw_image_length));

	printf("Image Load   : 0x%08x\n", le32_to_cpu(zynqhdr->image_load));
	printf("Checksum     : 0x%08x\n", le32_to_cpu(zynqhdr->checksum));

	for (i = 0; i < HEADER_INTERRUPT_VECTORS; i++) {
		if (zynqhdr->interrupt_vectors[i] == HEADER_INTERRUPT_DEFAULT)
			continue;

		printf("Modified Interrupt Vector Address [%d]: 0x%08x\n", i,
		       le32_to_cpu(zynqhdr->interrupt_vectors[i]));
	}

	for (i = 0; i < HEADER_REGINITS; i++) {
		if (zynqhdr->register_init[i].address == HEADER_REGINIT_NULL)
			break;

		if (i == 0)
			printf("Custom Register Initialization:\n");

		printf("    @ 0x%08x -> 0x%08x\n",
		       le32_to_cpu(zynqhdr->register_init[i].address),
		       le32_to_cpu(zynqhdr->register_init[i].data));
	}

	for_each_zynqmp_part(zynqhdr, i, ph) {
		print_partition(ptr, ph);
	}

	free(dynamic_header);
}

static int zynqmpimage_check_params(struct image_tool_params *params)
{
	if (!params)
		return 0;

	if (params->addr != 0x0) {
		fprintf(stderr, "Error: Load Address cannot be specified.\n");
		return -1;
	}

	/*
	 * If the entry point is specified ensure it is 64 byte aligned.
	 */
	if (params->eflag && (params->ep % 64 != 0)) {
		fprintf(stderr,
			"Error: Entry Point must be aligned to a 64-byte boundary.\n");
		return -1;
	}

	return !(params->lflag || params->dflag || params->outfile);
}

static int zynqmpimage_check_image_types(uint8_t type)
{
	if (type == IH_TYPE_ZYNQMPIMAGE)
		return EXIT_SUCCESS;
	return EXIT_FAILURE;
}

static uint32_t fsize(FILE *fp)
{
	int size, ret, origin;

	origin = ftell(fp);
	if (origin < 0) {
		fprintf(stderr, "Incorrect file size\n");
		fclose(fp);
		exit(2);
	}

	ret = fseek(fp, 0L, SEEK_END);
	if (ret) {
		fprintf(stderr, "Incorrect file SEEK_END\n");
		fclose(fp);
		exit(3);
	}

	size = ftell(fp);
	if (size < 0) {
		fprintf(stderr, "Incorrect file size\n");
		fclose(fp);
		exit(4);
	}

	/* going back */
	ret = fseek(fp, origin, SEEK_SET);
	if (ret) {
		fprintf(stderr, "Incorrect file SEEK_SET to %d\n", origin);
		fclose(fp);
		exit(3);
	}

	return size;
}

static void zynqmpimage_pmufw(struct zynqmp_header *zynqhdr,
			      const char *filename)
{
	uint32_t size;

	/* Setup PMU fw size */
	zynqhdr->pfw_image_length = fsize(fpmu);
	zynqhdr->total_pfw_image_length = zynqhdr->pfw_image_length;

	zynqhdr->image_size -= zynqhdr->pfw_image_length;
	zynqhdr->image_stored_size -= zynqhdr->total_pfw_image_length;

	/* Read the whole PMUFW to the header */
	size = fread(&zynqhdr->__reserved4[66], 1,
		     zynqhdr->pfw_image_length, fpmu);
	if (size != zynqhdr->pfw_image_length) {
		fprintf(stderr, "Cannot read PMUFW file: %s\n", filename);
		fclose(fpmu);
		exit(1);
	}

	fclose(fpmu);
}

static void zynqmpimage_parse_initparams(struct zynqmp_header *zynqhdr,
	const char *filename)
{
	FILE *fp;
	struct zynqmp_reginit reginit;
	unsigned int reg_count = 0;
	int r, err;
	struct stat path_stat;

	/* Expect a table of register-value pairs, e.g. "0x12345678 0x4321" */
	fp = fopen(filename, "r");
	if (!fp) {
		fprintf(stderr, "Cannot open initparams file: %s\n", filename);
		exit(1);
	}

	err = fstat(fileno(fp), &path_stat);
	if (err) {
		fclose(fp);
		return;
	}

	if (!S_ISREG(path_stat.st_mode)) {
		fclose(fp);
		return;
	}

	do {
		r = fscanf(fp, "%x %x", &reginit.address, &reginit.data);
		if (r == 2) {
			zynqhdr->register_init[reg_count] = reginit;
			++reg_count;
		}
		r = fscanf(fp, "%*[^\n]\n"); /* Skip to next line */
	} while ((r != EOF) && (reg_count < HEADER_REGINITS));
	fclose(fp);
}

static void zynqmpimage_set_header(void *ptr, struct stat *sbuf, int ifd,
		struct image_tool_params *params)
{
	struct zynqmp_header *zynqhdr = (struct zynqmp_header *)ptr;
	zynqmpimage_default_header(zynqhdr);

	/* place image directly after header */
	zynqhdr->image_offset =
		cpu_to_le32((uint32_t)sizeof(struct zynqmp_header));
	zynqhdr->image_size = cpu_to_le32(params->file_size -
					  sizeof(struct zynqmp_header));
	zynqhdr->image_stored_size = zynqhdr->image_size;
	zynqhdr->image_load = 0xfffc0000;
	if (params->eflag)
		zynqhdr->image_load = cpu_to_le32((uint32_t)params->ep);

	/* PMUFW */
	if (fpmu)
		zynqmpimage_pmufw(zynqhdr, params->imagename);

	/* User can pass in text file with init list */
	if (strlen(params->imagename2))
		zynqmpimage_parse_initparams(zynqhdr, params->imagename2);

	zynqhdr->checksum = zynqmpimage_checksum(zynqhdr);
}

static int zynqmpimage_partition_extract(struct zynqmp_header *zynqhdr,
					 const struct partition_header *ph,
					 const char *filename)
{
	ulong data = (ulong)zynqmp_get_offset(zynqhdr, ph->offset);
	unsigned long len = le32_to_cpu(ph->len_enc) * 4;

	return imagetool_save_subimage(filename, data, len);
}

/**
 * zynqmpimage_extract_contents - retrieve a sub-image component from the image
 * @ptr: pointer to the image header
 * @params: command line parameters
 *
 * returns:
 *     zero in case of success or a negative value if fail.
 */
static int zynqmpimage_extract_contents(void *ptr, struct image_tool_params *params)
{
	struct zynqmp_header *zynqhdr = (struct zynqmp_header *)ptr;
	struct partition_header *ph;
	int i;

	for_each_zynqmp_part(zynqhdr, i, ph) {
		if (i == params->pflag)
			return zynqmpimage_partition_extract(ptr, ph, params->outfile);
	}

	printf("No partition found\n");
	return -1;
}

static int zynqmpimage_vrec_header(struct image_tool_params *params,
				   struct image_type_params *tparams)
{
	struct stat path_stat;
	char *filename = params->imagename;
	int err;

	/* Handle static case without PMUFW */
	tparams->header_size = sizeof(struct zynqmp_header);
	tparams->hdr = (void *)&zynqmpimage_header;

	/* PMUFW name is passed via params->imagename */
	if (strlen(filename) == 0)
		return EXIT_SUCCESS;

	fpmu = fopen(filename, "r");
	if (!fpmu) {
		fprintf(stderr, "Cannot open PMUFW file: %s\n", filename);
		return EXIT_FAILURE;
	}

	err = fstat(fileno(fpmu), &path_stat);
	if (err) {
		fclose(fpmu);
		fpmu = NULL;
		return EXIT_FAILURE;
	}

	if (!S_ISREG(path_stat.st_mode)) {
		fclose(fpmu);
		fpmu = NULL;
		return EXIT_FAILURE;
	}

	/* Increase header size by PMUFW file size */
	tparams->header_size += fsize(fpmu);

	/* Allocate buffer with space for PMUFW */
	dynamic_header = calloc(1, tparams->header_size);
	tparams->hdr = dynamic_header;

	return EXIT_SUCCESS;
}

U_BOOT_IMAGE_TYPE(
	zynqmpimage,
	"Xilinx ZynqMP Boot Image support",
	sizeof(struct zynqmp_header),
	(void *)&zynqmpimage_header,
	zynqmpimage_check_params,
	zynqmpimage_verify_header,
	zynqmpimage_print_header,
	zynqmpimage_set_header,
	zynqmpimage_extract_contents,
	zynqmpimage_check_image_types,
	NULL,
	zynqmpimage_vrec_header
);
Commit	Line	Data
83d290c5	1	// SPDX-License-Identifier: GPL-2.0+
d9b58b30	2	/*
174d7284	3	* Copyright (C) 2016 Michal Simek <[email protected]>
d9b58b30 MS	4	* Copyright (C) 2015 Nathan Rossi <[email protected]>
d9b58b30 MS	5	*
d9b58b30 MS	6	* The following Boot Header format/structures and values are defined in the
d9b58b30 MS	7	* following documents:
df4950e3	8	* * ug1085 ZynqMP TRM doc v1.4 (Chapter 11, Table 11-4)
e9dbfb32	9	* * ug1137 ZynqMP Software Developer Guide v6.0 (Chapter 16)
d9b58b30 MS	10	*
	11	* Expected Header Size = 0x9C0
	12	* Forced as 'little' endian, 32-bit words
	13	*
	14	* 0x 0 - Interrupt table (8 words)
	15	* ... (Default value = 0xeafffffe)
	16	* 0x 1f
	17	* 0x 20 - Width detection
	18	* * DEFAULT_WIDTHDETECTION 0xaa995566
	19	* 0x 24 - Image identifier
	20	* * DEFAULT_IMAGEIDENTIFIER 0x584c4e58
	21	* 0x 28 - Encryption
	22	* * 0x00000000 - None
	23	* * 0xa5c3c5a3 - eFuse
	24	* * 0xa5c3c5a7 - obfuscated key in eFUSE
	25	* * 0x3a5c3c5a - bbRam
	26	* * 0xa35c7ca5 - obfuscated key in boot header
	27	* 0x 2C - Image load
	28	* 0x 30 - Image offset
	29	* 0x 34 - PFW image length
	30	* 0x 38 - Total PFW image length
	31	* 0x 3C - Image length
	32	* 0x 40 - Total image length
	33	* 0x 44 - Image attributes
	34	* 0x 48 - Header checksum
	35	* 0x 4c - Obfuscated key
	36	* ...
	37	* 0x 68
	38	* 0x 6c - Reserved
	39	* 0x 70 - User defined
	40	* ...
	41	* 0x 9c
	42	* 0x a0 - Secure header initialization vector
	43	* ...
	44	* 0x a8
	45	* 0x ac - Obfuscated key initialization vector
	46	* ...
	47	* 0x b4
	48	* 0x b8 - Register Initialization, 511 Address and Data word pairs
	49	* * List is terminated with an address of 0xffffffff or
	50	* ... * at the max number of entries
	51	* 0x8b4
	52	* 0x8b8 - Reserved
	53	* ...
	54	* 0x9bf
	55	* 0x9c0 - Data/Image starts here or above
	56	*/
	57
	58	#include "imagetool.h"
	59	#include "mkimage.h"
e384cdf8	60	#include "zynqmpimage.h"
d9b58b30 MS	61	#include <image.h>
d9b58b30 MS	62
d9b58b30	63	static struct zynqmp_header zynqmpimage_header;
c85a6b79 MS	64	static void *dynamic_header;
c85a6b79 MS	65	static FILE *fpmu;
d9b58b30 MS	66
	67	static uint32_t zynqmpimage_checksum(struct zynqmp_header *ptr)
	68	{
	69	uint32_t checksum = 0;
	70
	71	if (ptr == NULL)
	72	return 0;
	73
	74	checksum += le32_to_cpu(ptr->width_detection);
	75	checksum += le32_to_cpu(ptr->image_identifier);
	76	checksum += le32_to_cpu(ptr->encryption);
	77	checksum += le32_to_cpu(ptr->image_load);
	78	checksum += le32_to_cpu(ptr->image_offset);
	79	checksum += le32_to_cpu(ptr->pfw_image_length);
	80	checksum += le32_to_cpu(ptr->total_pfw_image_length);
	81	checksum += le32_to_cpu(ptr->image_size);
	82	checksum += le32_to_cpu(ptr->image_stored_size);
	83	checksum += le32_to_cpu(ptr->image_attributes);
	84	checksum = ~checksum;
	85
	86	return cpu_to_le32(checksum);
	87	}
	88
6915dcf3	89	void zynqmpimage_default_header(struct zynqmp_header *ptr)
d9b58b30 MS	90	{
	91	int i;
	92
	93	if (ptr == NULL)
	94	return;
	95
	96	ptr->width_detection = HEADER_WIDTHDETECTION;
e9dbfb32	97	ptr->image_attributes = HEADER_CPU_SELECT_A53_64BIT;
d9b58b30 MS	98	ptr->image_identifier = HEADER_IMAGEIDENTIFIER;
	99	ptr->encryption = cpu_to_le32(ENCRYPTION_NONE);
	100
	101	/* Setup not-supported/constant/reserved fields */
	102	for (i = 0; i < HEADER_INTERRUPT_VECTORS; i++)
	103	ptr->interrupt_vectors[i] = HEADER_INTERRUPT_DEFAULT;
	104
	105	for (i = 0; i < HEADER_REGINITS; i++) {
	106	ptr->register_init[i].address = HEADER_REGINIT_NULL;
	107	ptr->register_init[i].data = 0;
	108	}
	109
	110	/*
	111	* Certain reserved fields are required to be set to 0, ensure they are
	112	* set as such.
	113	*/
	114	ptr->pfw_image_length = 0x0;
	115	ptr->total_pfw_image_length = 0x0;
	116	}
	117
	118	/* mkimage glue functions */
	119	static int zynqmpimage_verify_header(unsigned char *ptr, int image_size,
	120	struct image_tool_params *params)
	121	{
	122	struct zynqmp_header zynqhdr = (struct zynqmp_header )ptr;
	123
	124	if (image_size < sizeof(struct zynqmp_header))
	125	return -1;
	126
	127	if (zynqhdr->width_detection != HEADER_WIDTHDETECTION)
	128	return -1;
	129	if (zynqhdr->image_identifier != HEADER_IMAGEIDENTIFIER)
	130	return -1;
	131
	132	if (zynqmpimage_checksum(zynqhdr) != zynqhdr->checksum)
	133	return -1;
	134
	135	return 0;
	136	}
	137
c9190693 BM	138	static struct image_header *
	139	find_partition_image(const struct zynqmp_header *zynqhdr,
	140	const struct partition_header *ph)
	141	{
	142	struct partition_header *ph_walk;
	143	struct image_header *ih;
	144	int i;
	145
	146	for_each_zynqmp_image(zynqhdr, ih) {
	147	for_each_zynqmp_part_in_image(zynqhdr, i, ph_walk, ih) {
	148	if (ph == ph_walk)
	149	return ih;
	150	}
	151	}
	152
	153	return NULL;
	154	}
	155
	156	static void print_partition_name(const struct zynqmp_header *zynqhdr,
	157	const struct partition_header *ph)
	158	{
	159	const struct image_header *ih;
	160	size_t word_len;
	161	char *name;
	162	int i;
	163
	164	ih = find_partition_image(zynqhdr, ph);
	165	if (!ih)
	166	return;
	167
	168	/* Name is stored in big-endian words, find the terminating word and
	169	* byte-swap into a new buffer
	170	*/
	171	word_len = strlen((char *)ih->image_name);
	172	word_len = ALIGN(word_len + 1, 4);
	173
	174	name = calloc(1, word_len);
	175	if (!name)
	176	return;
	177
	178	for (i = 0; i < word_len / 4; i++)
	179	((uint32_t *)name)[i] = uswap_32(ih->image_name[i]);
	180
	181	printf(" Image name : %s\n", name);
	182	free(name);
	183	}
	184
e9dbfb32 AG	185	static void print_partition(const void ptr, const struct partition_header ph)
	186	{
	187	uint32_t attr = le32_to_cpu(ph->attributes);
	188	unsigned long len = le32_to_cpu(ph->len) * 4;
2ddd0248 BM	189	unsigned long len_enc = le32_to_cpu(ph->len_enc) * 4;
2ddd0248 BM	190	unsigned long len_unenc = le32_to_cpu(ph->len_unenc) * 4;
e9dbfb32 AG	191	const char *part_owner;
	192	const char *dest_devs[0x8] = {
	193	"none", "PS", "PL", "PMU", "unknown", "unknown", "unknown",
	194	"unknown"
	195	};
	196
	197	switch (attr & PART_ATTR_PART_OWNER_MASK) {
	198	case PART_ATTR_PART_OWNER_FSBL:
	199	part_owner = "FSBL";
	200	break;
	201	case PART_ATTR_PART_OWNER_UBOOT:
	202	part_owner = "U-Boot";
	203	break;
	204	default:
	205	part_owner = "Unknown";
	206	break;
	207	}
	208
	209	printf("%s payload on CPU %s (%s):\n", part_owner,
	210	dest_cpus[(attr & PART_ATTR_DEST_CPU_MASK) >> 8],
	211	dest_devs[(attr & PART_ATTR_DEST_DEVICE_MASK) >> 4]);
	212
c9190693	213	print_partition_name(ptr, ph);
e9dbfb32 AG	214	printf(" Offset : 0x%08x\n", le32_to_cpu(ph->offset) * 4);
e9dbfb32 AG	215	printf(" Size : %lu (0x%lx) bytes\n", len, len);
2ddd0248 BM	216	if (len != len_unenc)
	217	printf(" Size Data : %lu (0x%lx) bytes\n", len_unenc, len_unenc);
	218	if (len_unenc != len_enc)
	219	printf(" Size Enc : %lu (0x%lx) bytes\n", len_unenc, len_unenc);
e9dbfb32 AG	220	printf(" Load : 0x%08llx",
	221	(unsigned long long)le64_to_cpu(ph->load_address));
	222	if (ph->load_address != ph->entry_point)
	223	printf(" (entry=0x%08llx)\n",
	224	(unsigned long long)le64_to_cpu(ph->entry_point));
	225	else
	226	printf("\n");
	227	printf(" Attributes : ");
	228
	229	if (attr & PART_ATTR_VEC_LOCATION)
	230	printf("vec ");
	231
	232	if (attr & PART_ATTR_ENCRYPTED)
	233	printf("encrypted ");
	234
	235	switch (attr & PART_ATTR_CHECKSUM_MASK) {
	236	case PART_ATTR_CHECKSUM_MD5:
	237	printf("md5 ");
	238	break;
	239	case PART_ATTR_CHECKSUM_SHA2:
	240	printf("sha2 ");
	241	break;
	242	case PART_ATTR_CHECKSUM_SHA3:
	243	printf("sha3 ");
	244	break;
	245	}
	246
	247	if (attr & PART_ATTR_BIG_ENDIAN)
	248	printf("BigEndian ");
	249
	250	if (attr & PART_ATTR_RSA_SIG)
	251	printf("RSA ");
	252
	253	if (attr & PART_ATTR_A53_EXEC_AARCH32)
	254	printf("AArch32 ");
	255
	256	if (attr & PART_ATTR_TARGET_EL_MASK)
	257	printf("EL%d ", (attr & PART_ATTR_TARGET_EL_MASK) >> 1);
	258
	259	if (attr & PART_ATTR_TZ_SECURE)
	260	printf("secure ");
	261	printf("\n");
	262
	263	printf(" Checksum : 0x%08x\n", le32_to_cpu(ph->checksum));
	264	}
	265
2972d7d6	266	void zynqmpimage_print_header(const void ptr, struct image_tool_params params)
d9b58b30 MS	267	{
d9b58b30 MS	268	struct zynqmp_header zynqhdr = (struct zynqmp_header )ptr;
d47935b3	269	struct partition_header *ph;
d9b58b30 MS	270	int i;
d9b58b30 MS	271
d28baea0	272	printf("Image Type : Xilinx ZynqMP Boot Image support\n");
d9b58b30 MS	273	printf("Image Offset : 0x%08x\n", le32_to_cpu(zynqhdr->image_offset));
	274	printf("Image Size : %lu bytes (%lu bytes packed)\n",
	275	(unsigned long)le32_to_cpu(zynqhdr->image_size),
	276	(unsigned long)le32_to_cpu(zynqhdr->image_stored_size));
c85a6b79 MS	277
	278	if (zynqhdr->pfw_image_length)
	279	printf("PMUFW Size : %lu bytes (%lu bytes packed)\n",
	280	(unsigned long)le32_to_cpu(zynqhdr->pfw_image_length),
	281	(unsigned long)le32_to_cpu(
	282	zynqhdr->total_pfw_image_length));
	283
d9b58b30 MS	284	printf("Image Load : 0x%08x\n", le32_to_cpu(zynqhdr->image_load));
	285	printf("Checksum : 0x%08x\n", le32_to_cpu(zynqhdr->checksum));
	286
	287	for (i = 0; i < HEADER_INTERRUPT_VECTORS; i++) {
	288	if (zynqhdr->interrupt_vectors[i] == HEADER_INTERRUPT_DEFAULT)
	289	continue;
	290
	291	printf("Modified Interrupt Vector Address [%d]: 0x%08x\n", i,
	292	le32_to_cpu(zynqhdr->interrupt_vectors[i]));
	293	}
	294
	295	for (i = 0; i < HEADER_REGINITS; i++) {
	296	if (zynqhdr->register_init[i].address == HEADER_REGINIT_NULL)
	297	break;
	298
	299	if (i == 0)
	300	printf("Custom Register Initialization:\n");
	301
	302	printf(" @ 0x%08x -> 0x%08x\n",
	303	le32_to_cpu(zynqhdr->register_init[i].address),
	304	le32_to_cpu(zynqhdr->register_init[i].data));
	305	}
c85a6b79	306
d47935b3 BM	307	for_each_zynqmp_part(zynqhdr, i, ph) {
d47935b3 BM	308	print_partition(ptr, ph);
e9dbfb32 AG	309	}
e9dbfb32 AG	310
c85a6b79	311	free(dynamic_header);
d9b58b30 MS	312	}
	313
	314	static int zynqmpimage_check_params(struct image_tool_params *params)
	315	{
	316	if (!params)
	317	return 0;
	318
	319	if (params->addr != 0x0) {
	320	fprintf(stderr, "Error: Load Address cannot be specified.\n");
	321	return -1;
	322	}
	323
	324	/*
	325	* If the entry point is specified ensure it is 64 byte aligned.
	326	*/
	327	if (params->eflag && (params->ep % 64 != 0)) {
	328	fprintf(stderr,
	329	"Error: Entry Point must be aligned to a 64-byte boundary.\n");
	330	return -1;
	331	}
	332
d47935b3	333	return !(params->lflag \|\| params->dflag \|\| params->outfile);
d9b58b30 MS	334	}
	335
	336	static int zynqmpimage_check_image_types(uint8_t type)
	337	{
	338	if (type == IH_TYPE_ZYNQMPIMAGE)
	339	return EXIT_SUCCESS;
	340	return EXIT_FAILURE;
	341	}
	342
6d0cbbd5	343	static uint32_t fsize(FILE *fp)
c85a6b79	344	{
6d0cbbd5 MS	345	int size, ret, origin;
	346
	347	origin = ftell(fp);
	348	if (origin < 0) {
	349	fprintf(stderr, "Incorrect file size\n");
	350	fclose(fp);
	351	exit(2);
	352	}
	353
	354	ret = fseek(fp, 0L, SEEK_END);
	355	if (ret) {
	356	fprintf(stderr, "Incorrect file SEEK_END\n");
	357	fclose(fp);
	358	exit(3);
	359	}
c85a6b79	360
c85a6b79	361	size = ftell(fp);
6d0cbbd5 MS	362	if (size < 0) {
	363	fprintf(stderr, "Incorrect file size\n");
	364	fclose(fp);
	365	exit(4);
	366	}
c85a6b79 MS	367
c85a6b79 MS	368	/* going back */
6d0cbbd5 MS	369	ret = fseek(fp, origin, SEEK_SET);
	370	if (ret) {
	371	fprintf(stderr, "Incorrect file SEEK_SET to %d\n", origin);
	372	fclose(fp);
	373	exit(3);
	374	}
c85a6b79 MS	375
	376	return size;
	377	}
	378
	379	static void zynqmpimage_pmufw(struct zynqmp_header *zynqhdr,
	380	const char *filename)
	381	{
	382	uint32_t size;
	383
	384	/* Setup PMU fw size */
	385	zynqhdr->pfw_image_length = fsize(fpmu);
	386	zynqhdr->total_pfw_image_length = zynqhdr->pfw_image_length;
	387
	388	zynqhdr->image_size -= zynqhdr->pfw_image_length;
	389	zynqhdr->image_stored_size -= zynqhdr->total_pfw_image_length;
	390
	391	/* Read the whole PMUFW to the header */
	392	size = fread(&zynqhdr->__reserved4[66], 1,
	393	zynqhdr->pfw_image_length, fpmu);
	394	if (size != zynqhdr->pfw_image_length) {
	395	fprintf(stderr, "Cannot read PMUFW file: %s\n", filename);
	396	fclose(fpmu);
	397	exit(1);
	398	}
	399
	400	fclose(fpmu);
	401	}
	402
3b646080 ML	403	static void zynqmpimage_parse_initparams(struct zynqmp_header *zynqhdr,
	404	const char *filename)
	405	{
56c7e801	406	FILE *fp;
3b646080 ML	407	struct zynqmp_reginit reginit;
3b646080 ML	408	unsigned int reg_count = 0;
ebe0f53f	409	int r, err;
56c7e801 MS	410	struct stat path_stat;
56c7e801 MS	411
56c7e801 MS	412	/* Expect a table of register-value pairs, e.g. "0x12345678 0x4321" */
56c7e801 MS	413	fp = fopen(filename, "r");
3b646080 ML	414	if (!fp) {
	415	fprintf(stderr, "Cannot open initparams file: %s\n", filename);
	416	exit(1);
	417	}
ebe0f53f MS	418
ebe0f53f MS	419	err = fstat(fileno(fp), &path_stat);
ac71d410 MS	420	if (err) {
ac71d410 MS	421	fclose(fp);
ebe0f53f	422	return;
ac71d410	423	}
ebe0f53f	424
ac71d410 MS	425	if (!S_ISREG(path_stat.st_mode)) {
ac71d410 MS	426	fclose(fp);
ebe0f53f	427	return;
ac71d410	428	}
ebe0f53f	429
3b646080 ML	430	do {
	431	r = fscanf(fp, "%x %x", &reginit.address, &reginit.data);
	432	if (r == 2) {
	433	zynqhdr->register_init[reg_count] = reginit;
	434	++reg_count;
	435	}
	436	r = fscanf(fp, "%[^\n]\n"); / Skip to next line */
	437	} while ((r != EOF) && (reg_count < HEADER_REGINITS));
	438	fclose(fp);
	439	}
	440
d9b58b30 MS	441	static void zynqmpimage_set_header(void ptr, struct stat sbuf, int ifd,
	442	struct image_tool_params *params)
	443	{
	444	struct zynqmp_header zynqhdr = (struct zynqmp_header )ptr;
	445	zynqmpimage_default_header(zynqhdr);
	446
	447	/* place image directly after header */
	448	zynqhdr->image_offset =
	449	cpu_to_le32((uint32_t)sizeof(struct zynqmp_header));
	450	zynqhdr->image_size = cpu_to_le32(params->file_size -
	451	sizeof(struct zynqmp_header));
	452	zynqhdr->image_stored_size = zynqhdr->image_size;
	453	zynqhdr->image_load = 0xfffc0000;
	454	if (params->eflag)
	455	zynqhdr->image_load = cpu_to_le32((uint32_t)params->ep);
	456
c85a6b79 MS	457	/* PMUFW */
	458	if (fpmu)
	459	zynqmpimage_pmufw(zynqhdr, params->imagename);
	460
3b646080 ML	461	/* User can pass in text file with init list */
	462	if (strlen(params->imagename2))
	463	zynqmpimage_parse_initparams(zynqhdr, params->imagename2);
	464
d9b58b30 MS	465	zynqhdr->checksum = zynqmpimage_checksum(zynqhdr);
	466	}
	467
d47935b3 BM	468	static int zynqmpimage_partition_extract(struct zynqmp_header *zynqhdr,
	469	const struct partition_header *ph,
	470	const char *filename)
	471	{
	472	ulong data = (ulong)zynqmp_get_offset(zynqhdr, ph->offset);
	473	unsigned long len = le32_to_cpu(ph->len_enc) * 4;
	474
	475	return imagetool_save_subimage(filename, data, len);
	476	}
	477
	478	/**
	479	* zynqmpimage_extract_contents - retrieve a sub-image component from the image
	480	* @ptr: pointer to the image header
	481	* @params: command line parameters
	482	*
	483	* returns:
	484	* zero in case of success or a negative value if fail.
	485	*/
	486	static int zynqmpimage_extract_contents(void ptr, struct image_tool_params params)
	487	{
	488	struct zynqmp_header zynqhdr = (struct zynqmp_header )ptr;
	489	struct partition_header *ph;
	490	int i;
	491
	492	for_each_zynqmp_part(zynqhdr, i, ph) {
	493	if (i == params->pflag)
	494	return zynqmpimage_partition_extract(ptr, ph, params->outfile);
	495	}
	496
	497	printf("No partition found\n");
	498	return -1;
	499	}
	500
c85a6b79 MS	501	static int zynqmpimage_vrec_header(struct image_tool_params *params,
	502	struct image_type_params *tparams)
	503	{
	504	struct stat path_stat;
	505	char *filename = params->imagename;
	506	int err;
	507
	508	/* Handle static case without PMUFW */
	509	tparams->header_size = sizeof(struct zynqmp_header);
	510	tparams->hdr = (void *)&zynqmpimage_header;
	511
	512	/* PMUFW name is passed via params->imagename */
	513	if (strlen(filename) == 0)
	514	return EXIT_SUCCESS;
	515
	516	fpmu = fopen(filename, "r");
	517	if (!fpmu) {
	518	fprintf(stderr, "Cannot open PMUFW file: %s\n", filename);
	519	return EXIT_FAILURE;
	520	}
	521
	522	err = fstat(fileno(fpmu), &path_stat);
	523	if (err) {
	524	fclose(fpmu);
	525	fpmu = NULL;
	526	return EXIT_FAILURE;
	527	}
	528
	529	if (!S_ISREG(path_stat.st_mode)) {
	530	fclose(fpmu);
	531	fpmu = NULL;
	532	return EXIT_FAILURE;
	533	}
	534
	535	/* Increase header size by PMUFW file size */
	536	tparams->header_size += fsize(fpmu);
	537
	538	/* Allocate buffer with space for PMUFW */
	539	dynamic_header = calloc(1, tparams->header_size);
	540	tparams->hdr = dynamic_header;
	541
	542	return EXIT_SUCCESS;
	543	}
	544
d9b58b30 MS	545	U_BOOT_IMAGE_TYPE(
	546	zynqmpimage,
	547	"Xilinx ZynqMP Boot Image support",
	548	sizeof(struct zynqmp_header),
	549	(void *)&zynqmpimage_header,
	550	zynqmpimage_check_params,
	551	zynqmpimage_verify_header,
	552	zynqmpimage_print_header,
	553	zynqmpimage_set_header,
d47935b3	554	zynqmpimage_extract_contents,
d9b58b30 MS	555	zynqmpimage_check_image_types,
d9b58b30 MS	556	NULL,
c85a6b79	557	zynqmpimage_vrec_header
d9b58b30	558	);