[thirdparty/u-boot.git] / tools / mxsimage.h

/* SPDX-License-Identifier: GPL-2.0+ */
/*
 * Freescale i.MX28 SB image generator
 *
 * Copyright (C) 2012 Marek Vasut <marex@denx.de>
 */

#ifndef __MXSSB_H__
#define __MXSSB_H__

#include <stdint.h>
#include <arpa/inet.h>

#define SB_BLOCK_SIZE		16

#define roundup(x, y)		((((x) + ((y) - 1)) / (y)) * (y))
#define ARRAY_SIZE(x)		(sizeof(x) / sizeof((x)[0]))

struct sb_boot_image_version {
	uint16_t	major;
	uint16_t	pad0;
	uint16_t	minor;
	uint16_t	pad1;
	uint16_t	revision;
	uint16_t	pad2;
};

struct sb_boot_image_header {
	union {
		/* SHA1 of the header. */
		uint8_t	digest[20];
		struct {
			/* CBC-MAC initialization vector. */
			uint8_t iv[16];
			uint8_t extra[4];
		};
	};
	/* 'STMP' */
	uint8_t		signature1[4];
	/* Major version of the image format. */
	uint8_t		major_version;
	/* Minor version of the image format. */
	uint8_t		minor_version;
	/* Flags associated with the image. */
	uint16_t	flags;
	/* Size of the image in 16b blocks. */
	uint32_t	image_blocks;
	/* Offset of the first tag in 16b blocks. */
	uint32_t	first_boot_tag_block;
	/* ID of the section to boot from. */
	uint32_t	first_boot_section_id;
	/* Amount of crypto keys. */
	uint16_t	key_count;
	/* Offset to the key dictionary in 16b blocks. */
	uint16_t	key_dictionary_block;
	/* Size of this header in 16b blocks. */
	uint16_t	header_blocks;
	/* Amount of section headers. */
	uint16_t	section_count;
	/* Section header size in 16b blocks. */
	uint16_t	section_header_size;
	/* Padding to align timestamp to uint64_t. */
	uint8_t		padding0[2];
	/* 'sgtl' (since v1.1) */
	uint8_t		signature2[4];
	/* Image generation date, in microseconds since 1.1.2000 . */
	uint64_t	timestamp_us;
	/* Product version. */
	struct sb_boot_image_version
			product_version;
	/* Component version. */
	struct sb_boot_image_version
			component_version;
	/* Drive tag for the system drive. (since v1.1) */
	uint16_t	drive_tag;
	/* Padding. */
	uint8_t		padding1[6];
};

#define	SB_VERSION_MAJOR	1
#define	SB_VERSION_MINOR	1

/* Enable to HTLLC boot report. */
#define SB_IMAGE_FLAG_DISPLAY_PROGRESS	(1 << 0)
#define SB_IMAGE_FLAGS_MASK SB_IMAGE_FLAG_DISPLAY_PROGRESS

struct sb_key_dictionary_key {
	/* The CBC-MAC of image and sections header. */
	uint8_t		cbc_mac[SB_BLOCK_SIZE];
	/* The AES key encrypted by image key (zero). */
	uint8_t		key[SB_BLOCK_SIZE];
};

struct sb_ivt_header {
	uint32_t	header;
	uint32_t	entry;
	uint32_t	reserved1;
	uint32_t	dcd;
	uint32_t	boot_data;
	uint32_t	self;
	uint32_t	csf;
	uint32_t	reserved2;
};

#define	SB_HAB_IVT_TAG			0xd1UL
#define	SB_HAB_DCD_TAG			0xd2UL

#define	SB_HAB_VERSION			0x40UL

/*
 * The "size" field in the IVT header is not naturally aligned,
 * use this macro to fill first 4 bytes of the IVT header without
 * causing issues on some systems (esp. M68k, PPC, MIPS-BE, ARM-BE).
 */
static inline uint32_t sb_hab_ivt_header(void)
{
	uint32_t ret = 0;
	ret |= SB_HAB_IVT_TAG << 24;
	ret |= sizeof(struct sb_ivt_header) << 16;
	ret |= SB_HAB_VERSION;
	return htonl(ret);
}

struct sb_sections_header {
	/* Section number. */
	uint32_t	section_number;
	/* Offset of this sections first instruction after "TAG". */
	uint32_t	section_offset;
	/* Size of the section in 16b blocks. */
	uint32_t	section_size;
	/* Section flags. */
	uint32_t	section_flags;
};

#define	SB_SECTION_FLAG_BOOTABLE	(1 << 0)

struct sb_command {
	struct {
		uint8_t		checksum;
		uint8_t		tag;
		uint16_t	flags;
#define ROM_TAG_CMD_FLAG_ROM_LAST_TAG	0x1
#define ROM_LOAD_CMD_FLAG_DCD_LOAD	0x1	/* MX28 only */
#define ROM_JUMP_CMD_FLAG_HAB		0x1	/* MX28 only */
#define ROM_CALL_CMD_FLAG_HAB		0x1	/* MX28 only */
	} header;

	union {
	struct {
		uint32_t	reserved[3];
	} nop;
	struct {
		uint32_t	section_number;
		uint32_t	section_length;
		uint32_t	section_flags;
	} tag;
	struct {
		uint32_t	address;
		uint32_t	count;
		uint32_t	crc32;
	} load;
	struct {
		uint32_t	address;
		uint32_t	count;
		uint32_t	pattern;
	} fill;
	struct {
		uint32_t	address;
		uint32_t	reserved;
		/* Passed in register r0 before JUMP */
		uint32_t	argument;
	} jump;
	struct {
		uint32_t	address;
		uint32_t	reserved;
		/* Passed in register r0 before CALL */
		uint32_t	argument;
	} call;
	struct {
		uint32_t	reserved1;
		uint32_t	reserved2;
		uint32_t	mode;
	} mode;

	};
};

/*
 * Most of the mode names are same or at least similar
 * on i.MX23 and i.MX28, but some of the mode names
 * differ. The "name" field represents the mode name
 * on i.MX28 as seen in Table 12-2 of the datasheet.
 * The "altname" field represents the differently named
 * fields on i.MX23 as seen in Table 35-3 of the
 * datasheet.
 */
static const struct {
	const char	*name;
	const char	*altname;
	const uint8_t	mode;
} modetable[] = {
	{ "USB",		NULL,		0x00 },
	{ "I2C",		NULL,		0x01 },
	{ "SPI2_FLASH",		"SPI1_FLASH",	0x02 },
	{ "SPI3_FLASH",		"SPI2_FLASH",	0x03 },
	{ "NAND_BCH",		NULL,		0x04 },
	{ "JTAG",		NULL,		0x06 },
	{ "SPI3_EEPROM",	"SPI2_EEPROM",	0x08 },
	{ "SD_SSP0",		NULL,		0x09 },
	{ "SD_SSP1",		NULL,		0x0A }
};

enum sb_tag {
	ROM_NOP_CMD	= 0x00,
	ROM_TAG_CMD	= 0x01,
	ROM_LOAD_CMD	= 0x02,
	ROM_FILL_CMD	= 0x03,
	ROM_JUMP_CMD	= 0x04,
	ROM_CALL_CMD	= 0x05,
	ROM_MODE_CMD	= 0x06
};

struct sb_source_entry {
	uint8_t		tag;
	uint32_t	address;
	uint32_t	flags;
	char		*filename;
};

#endif	/* __MXSSB_H__ */
Commit	Line	Data
83d290c5	1	/* SPDX-License-Identifier: GPL-2.0+ */
bce88370 MV	2	/*
	3	* Freescale i.MX28 SB image generator
	4	*
	5	* Copyright (C) 2012 Marek Vasut <marex@denx.de>
bce88370 MV	6	*/
	7
	8	#ifndef __MXSSB_H__
	9	#define __MXSSB_H__
	10
	11	#include <stdint.h>
	12	#include <arpa/inet.h>
	13
	14	#define SB_BLOCK_SIZE 16
	15
	16	#define roundup(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
	17	#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
	18
	19	struct sb_boot_image_version {
	20	uint16_t major;
	21	uint16_t pad0;
	22	uint16_t minor;
	23	uint16_t pad1;
	24	uint16_t revision;
	25	uint16_t pad2;
	26	};
	27
	28	struct sb_boot_image_header {
	29	union {
	30	/* SHA1 of the header. */
	31	uint8_t digest[20];
	32	struct {
	33	/* CBC-MAC initialization vector. */
	34	uint8_t iv[16];
	35	uint8_t extra[4];
	36	};
	37	};
	38	/* 'STMP' */
	39	uint8_t signature1[4];
	40	/* Major version of the image format. */
	41	uint8_t major_version;
	42	/* Minor version of the image format. */
	43	uint8_t minor_version;
	44	/* Flags associated with the image. */
	45	uint16_t flags;
	46	/* Size of the image in 16b blocks. */
	47	uint32_t image_blocks;
	48	/* Offset of the first tag in 16b blocks. */
	49	uint32_t first_boot_tag_block;
	50	/* ID of the section to boot from. */
	51	uint32_t first_boot_section_id;
	52	/* Amount of crypto keys. */
	53	uint16_t key_count;
	54	/* Offset to the key dictionary in 16b blocks. */
	55	uint16_t key_dictionary_block;
	56	/* Size of this header in 16b blocks. */
	57	uint16_t header_blocks;
	58	/* Amount of section headers. */
	59	uint16_t section_count;
	60	/* Section header size in 16b blocks. */
	61	uint16_t section_header_size;
	62	/* Padding to align timestamp to uint64_t. */
	63	uint8_t padding0[2];
	64	/* 'sgtl' (since v1.1) */
	65	uint8_t signature2[4];
	66	/* Image generation date, in microseconds since 1.1.2000 . */
	67	uint64_t timestamp_us;
	68	/* Product version. */
	69	struct sb_boot_image_version
70	product_version;
71	/* Component version. */
72	struct sb_boot_image_version
73	component_version;
74	/* Drive tag for the system drive. (since v1.1) */
75	uint16_t drive_tag;
76	/* Padding. */
77	uint8_t padding1[6];
78	};
79
80	#define SB_VERSION_MAJOR 1
81	#define SB_VERSION_MINOR 1
82
7a139959 AI	83	/* Enable to HTLLC boot report. */
	84	#define SB_IMAGE_FLAG_DISPLAY_PROGRESS (1 << 0)
	85	#define SB_IMAGE_FLAGS_MASK SB_IMAGE_FLAG_DISPLAY_PROGRESS
bce88370 MV	86
	87	struct sb_key_dictionary_key {
	88	/* The CBC-MAC of image and sections header. */
	89	uint8_t cbc_mac[SB_BLOCK_SIZE];
	90	/* The AES key encrypted by image key (zero). */
	91	uint8_t key[SB_BLOCK_SIZE];
	92	};
	93
	94	struct sb_ivt_header {
	95	uint32_t header;
	96	uint32_t entry;
	97	uint32_t reserved1;
	98	uint32_t dcd;
	99	uint32_t boot_data;
	100	uint32_t self;
	101	uint32_t csf;
	102	uint32_t reserved2;
	103	};
	104
	105	#define SB_HAB_IVT_TAG 0xd1UL
	106	#define SB_HAB_DCD_TAG 0xd2UL
	107
	108	#define SB_HAB_VERSION 0x40UL
	109
	110	/*
	111	* The "size" field in the IVT header is not naturally aligned,
	112	* use this macro to fill first 4 bytes of the IVT header without
	113	* causing issues on some systems (esp. M68k, PPC, MIPS-BE, ARM-BE).
	114	*/
	115	static inline uint32_t sb_hab_ivt_header(void)
	116	{
	117	uint32_t ret = 0;
	118	ret \|= SB_HAB_IVT_TAG << 24;
	119	ret \|= sizeof(struct sb_ivt_header) << 16;
	120	ret \|= SB_HAB_VERSION;
	121	return htonl(ret);
	122	}
	123
	124	struct sb_sections_header {
	125	/* Section number. */
	126	uint32_t section_number;
	127	/* Offset of this sections first instruction after "TAG". */
	128	uint32_t section_offset;
	129	/* Size of the section in 16b blocks. */
	130	uint32_t section_size;
	131	/* Section flags. */
	132	uint32_t section_flags;
	133	};
	134
	135	#define SB_SECTION_FLAG_BOOTABLE (1 << 0)
	136
	137	struct sb_command {
	138	struct {
	139	uint8_t checksum;
	140	uint8_t tag;
	141	uint16_t flags;
	142	#define ROM_TAG_CMD_FLAG_ROM_LAST_TAG 0x1
	143	#define ROM_LOAD_CMD_FLAG_DCD_LOAD 0x1 /* MX28 only */
	144	#define ROM_JUMP_CMD_FLAG_HAB 0x1 /* MX28 only */
	145	#define ROM_CALL_CMD_FLAG_HAB 0x1 /* MX28 only */
	146	} header;
	147
	148	union {
	149	struct {
150	uint32_t reserved[3];
151	} nop;
152	struct {
153	uint32_t section_number;
154	uint32_t section_length;
155	uint32_t section_flags;
156	} tag;
157	struct {
158	uint32_t address;
159	uint32_t count;
160	uint32_t crc32;
161	} load;
162	struct {
163	uint32_t address;
164	uint32_t count;
165	uint32_t pattern;
166	} fill;
167	struct {
168	uint32_t address;
169	uint32_t reserved;
170	/* Passed in register r0 before JUMP */
171	uint32_t argument;
172	} jump;
173	struct {
174	uint32_t address;
175	uint32_t reserved;
176	/* Passed in register r0 before CALL */
177	uint32_t argument;
178	} call;
179	struct {
180	uint32_t reserved1;
181	uint32_t reserved2;
182	uint32_t mode;
183	} mode;
184
185	};
186	};
187
188	/*
189	* Most of the mode names are same or at least similar
190	* on i.MX23 and i.MX28, but some of the mode names
191	* differ. The "name" field represents the mode name
192	* on i.MX28 as seen in Table 12-2 of the datasheet.
193	* The "altname" field represents the differently named
194	* fields on i.MX23 as seen in Table 35-3 of the
195	* datasheet.
196	*/
197	static const struct {
198	const char *name;
199	const char *altname;
200	const uint8_t mode;
201	} modetable[] = {
202	{ "USB", NULL, 0x00 },
203	{ "I2C", NULL, 0x01 },
204	{ "SPI2_FLASH", "SPI1_FLASH", 0x02 },
205	{ "SPI3_FLASH", "SPI2_FLASH", 0x03 },
206	{ "NAND_BCH", NULL, 0x04 },
207	{ "JTAG", NULL, 0x06 },
208	{ "SPI3_EEPROM", "SPI2_EEPROM", 0x08 },
209	{ "SD_SSP0", NULL, 0x09 },
210	{ "SD_SSP1", NULL, 0x0A }
211	};
212
213	enum sb_tag {
214	ROM_NOP_CMD = 0x00,
215	ROM_TAG_CMD = 0x01,
216	ROM_LOAD_CMD = 0x02,
217	ROM_FILL_CMD = 0x03,
218	ROM_JUMP_CMD = 0x04,
219	ROM_CALL_CMD = 0x05,
220	ROM_MODE_CMD = 0x06
221	};
222
223	struct sb_source_entry {
224	uint8_t tag;
225	uint32_t address;
226	uint32_t flags;
227	char *filename;
228	};
229
230	#endif /* __MXSSB_H__ */