[J-u-boot.git] / tools / mtk_image.h

/* SPDX-License-Identifier: GPL-2.0+ */
/*
 * MediaTek BootROM header definitions
 *
 * Copyright (C) 2018 MediaTek Inc.
 * Author: Weijie Gao <[email protected]>
 */

#ifndef _MTK_IMAGE_H
#define _MTK_IMAGE_H

/* Device header definitions, all fields are little-endian */

/* Header for NOR/SD/eMMC */
union gen_boot_header {
	struct {
		char name[12];
		uint32_t version;
		uint32_t size;
	};

	uint8_t pad[0x200];
};

#define EMMC_BOOT_NAME		"EMMC_BOOT"
#define SF_BOOT_NAME		"SF_BOOT"
#define SDMMC_BOOT_NAME		"SDMMC_BOOT"

/* Header for NAND */
union nand_boot_header {
	struct {
		char name[12];
		char version[4];
		char id[8];
		uint16_t ioif;
		uint16_t pagesize;
		uint16_t addrcycles;
		uint16_t oobsize;
		uint16_t pages_of_block;
		uint16_t numblocks;
		uint16_t writesize_shift;
		uint16_t erasesize_shift;
		uint8_t dummy[60];
		uint8_t ecc_parity[28];
	};

	uint8_t data[0x80];
};

#define NAND_BOOT_NAME		"BOOTLOADER!"
#define NAND_BOOT_VERSION	"V006"
#define NAND_BOOT_ID		"NFIINFO"

/* BootROM layout header */
struct brom_layout_header {
	char name[8];
	uint32_t version;
	uint32_t header_size;
	uint32_t total_size;
	uint32_t magic;
	uint32_t type;
	uint32_t header_size_2;
	uint32_t total_size_2;
	uint32_t unused;
};

#define BRLYT_NAME		"BRLYT"
#define BRLYT_MAGIC		0x42424242

enum brlyt_img_type {
	BRLYT_TYPE_INVALID = 0,
	BRLYT_TYPE_NAND = 0x10002,
	BRLYT_TYPE_EMMC = 0x10005,
	BRLYT_TYPE_NOR = 0x10007,
	BRLYT_TYPE_SDMMC = 0x10008,
	BRLYT_TYPE_SNAND = 0x10009
};

/* Combined device header for NOR/SD/eMMC */
struct gen_device_header {
	union gen_boot_header boot;

	union {
		struct brom_layout_header brlyt;
		uint8_t brlyt_pad[0x400];
	};
};

/* BootROM header definitions */
struct gfh_common_header {
	uint8_t magic[3];
	uint8_t version;
	uint16_t size;
	uint16_t type;
};

#define GFH_HEADER_MAGIC	"MMM"

#define GFH_TYPE_FILE_INFO	0
#define GFH_TYPE_BL_INFO	1
#define GFH_TYPE_BROM_CFG	7
#define GFH_TYPE_BL_SEC_KEY	3
#define GFH_TYPE_ANTI_CLONE	2
#define GFH_TYPE_BROM_SEC_CFG	8

struct gfh_file_info {
	struct gfh_common_header gfh;
	char name[12];
	uint32_t unused;
	uint16_t file_type;
	uint8_t flash_type;
	uint8_t sig_type;
	uint32_t load_addr;
	uint32_t total_size;
	uint32_t max_size;
	uint32_t hdr_size;
	uint32_t sig_size;
	uint32_t jump_offset;
	uint32_t processed;
};

#define GFH_FILE_INFO_NAME	"FILE_INFO"

#define GFH_FLASH_TYPE_GEN	5
#define GFH_FLASH_TYPE_NAND	2

#define GFH_SIG_TYPE_NONE	0
#define GFH_SIG_TYPE_SHA256	1

struct gfh_bl_info {
	struct gfh_common_header gfh;
	uint32_t attr;
};

struct gfh_brom_cfg {
	struct gfh_common_header gfh;
	uint32_t cfg_bits;
	uint32_t usbdl_by_auto_detect_timeout_ms;
	uint8_t unused[0x45];
	uint8_t jump_bl_arm64;
	uint8_t unused2[2];
	uint32_t usbdl_by_kcol0_timeout_ms;
	uint32_t usbdl_by_flag_timeout_ms;
	uint32_t pad;
};

#define GFH_BROM_CFG_USBDL_BY_AUTO_DETECT_TIMEOUT_EN	0x02
#define GFH_BROM_CFG_USBDL_AUTO_DETECT_DIS		0x10
#define GFH_BROM_CFG_USBDL_BY_KCOL0_TIMEOUT_EN		0x80
#define GFH_BROM_CFG_USBDL_BY_FLAG_TIMEOUT_EN		0x100
#define GFH_BROM_CFG_JUMP_BL_ARM64_EN			0x1000
#define GFH_BROM_CFG_JUMP_BL_ARM64			0x64

struct gfh_bl_sec_key {
	struct gfh_common_header gfh;
	uint8_t pad[0x20c];
};

struct gfh_anti_clone {
	struct gfh_common_header gfh;
	uint8_t ac_b2k;
	uint8_t ac_b2c;
	uint16_t pad;
	uint32_t ac_offset;
	uint32_t ac_len;
};

struct gfh_brom_sec_cfg {
	struct gfh_common_header gfh;
	uint32_t cfg_bits;
	char customer_name[0x20];
	uint32_t pad;
};

#define BROM_SEC_CFG_JTAG_EN	1
#define BROM_SEC_CFG_UART_EN	2

struct gfh_header {
	struct gfh_file_info file_info;
	struct gfh_bl_info bl_info;
	struct gfh_brom_cfg brom_cfg;
	struct gfh_bl_sec_key bl_sec_key;
	struct gfh_anti_clone anti_clone;
	struct gfh_brom_sec_cfg brom_sec_cfg;
};

/* LK image header */

union lk_hdr {
	struct {
		uint32_t magic;
		uint32_t size;
		char name[32];
		uint32_t loadaddr;
		uint32_t mode;
	};

	uint8_t data[512];
};

#define LK_PART_MAGIC		0x58881688

#endif /* _MTK_IMAGE_H */
Commit	Line	Data
3b975a14 RL	1	/* SPDX-License-Identifier: GPL-2.0+ */
	2	/*
	3	* MediaTek BootROM header definitions
	4	*
	5	* Copyright (C) 2018 MediaTek Inc.
	6	* Author: Weijie Gao <[email protected]>
	7	*/
	8
	9	#ifndef _MTK_IMAGE_H
	10	#define _MTK_IMAGE_H
	11
a7c9a65e	12	/* Device header definitions, all fields are little-endian */
3b975a14 RL	13
	14	/* Header for NOR/SD/eMMC */
	15	union gen_boot_header {
	16	struct {
	17	char name[12];
a7c9a65e BM	18	uint32_t version;
a7c9a65e BM	19	uint32_t size;
3b975a14 RL	20	};
	21
	22	uint8_t pad[0x200];
	23	};
	24
	25	#define EMMC_BOOT_NAME "EMMC_BOOT"
	26	#define SF_BOOT_NAME "SF_BOOT"
	27	#define SDMMC_BOOT_NAME "SDMMC_BOOT"
	28
	29	/* Header for NAND */
	30	union nand_boot_header {
	31	struct {
	32	char name[12];
	33	char version[4];
	34	char id[8];
a7c9a65e BM	35	uint16_t ioif;
	36	uint16_t pagesize;
	37	uint16_t addrcycles;
	38	uint16_t oobsize;
	39	uint16_t pages_of_block;
	40	uint16_t numblocks;
	41	uint16_t writesize_shift;
	42	uint16_t erasesize_shift;
3b975a14 RL	43	uint8_t dummy[60];
	44	uint8_t ecc_parity[28];
	45	};
	46
	47	uint8_t data[0x80];
	48	};
	49
	50	#define NAND_BOOT_NAME "BOOTLOADER!"
	51	#define NAND_BOOT_VERSION "V006"
	52	#define NAND_BOOT_ID "NFIINFO"
	53
	54	/* BootROM layout header */
	55	struct brom_layout_header {
	56	char name[8];
a7c9a65e BM	57	uint32_t version;
	58	uint32_t header_size;
	59	uint32_t total_size;
	60	uint32_t magic;
	61	uint32_t type;
	62	uint32_t header_size_2;
	63	uint32_t total_size_2;
	64	uint32_t unused;
3b975a14 RL	65	};
	66
	67	#define BRLYT_NAME "BRLYT"
	68	#define BRLYT_MAGIC 0x42424242
	69
	70	enum brlyt_img_type {
	71	BRLYT_TYPE_INVALID = 0,
	72	BRLYT_TYPE_NAND = 0x10002,
	73	BRLYT_TYPE_EMMC = 0x10005,
	74	BRLYT_TYPE_NOR = 0x10007,
	75	BRLYT_TYPE_SDMMC = 0x10008,
	76	BRLYT_TYPE_SNAND = 0x10009
	77	};
	78
	79	/* Combined device header for NOR/SD/eMMC */
	80	struct gen_device_header {
	81	union gen_boot_header boot;
	82
	83	union {
	84	struct brom_layout_header brlyt;
	85	uint8_t brlyt_pad[0x400];
	86	};
	87	};
	88
	89	/* BootROM header definitions */
	90	struct gfh_common_header {
	91	uint8_t magic[3];
	92	uint8_t version;
a7c9a65e BM	93	uint16_t size;
a7c9a65e BM	94	uint16_t type;
3b975a14 RL	95	};
	96
	97	#define GFH_HEADER_MAGIC "MMM"
	98
	99	#define GFH_TYPE_FILE_INFO 0
	100	#define GFH_TYPE_BL_INFO 1
	101	#define GFH_TYPE_BROM_CFG 7
	102	#define GFH_TYPE_BL_SEC_KEY 3
	103	#define GFH_TYPE_ANTI_CLONE 2
	104	#define GFH_TYPE_BROM_SEC_CFG 8
	105
	106	struct gfh_file_info {
	107	struct gfh_common_header gfh;
	108	char name[12];
a7c9a65e BM	109	uint32_t unused;
a7c9a65e BM	110	uint16_t file_type;
3b975a14 RL	111	uint8_t flash_type;
3b975a14 RL	112	uint8_t sig_type;
a7c9a65e BM	113	uint32_t load_addr;
	114	uint32_t total_size;
	115	uint32_t max_size;
	116	uint32_t hdr_size;
	117	uint32_t sig_size;
	118	uint32_t jump_offset;
	119	uint32_t processed;
3b975a14 RL	120	};
	121
	122	#define GFH_FILE_INFO_NAME "FILE_INFO"
	123
	124	#define GFH_FLASH_TYPE_GEN 5
	125	#define GFH_FLASH_TYPE_NAND 2
	126
	127	#define GFH_SIG_TYPE_NONE 0
	128	#define GFH_SIG_TYPE_SHA256 1
	129
	130	struct gfh_bl_info {
	131	struct gfh_common_header gfh;
a7c9a65e	132	uint32_t attr;
3b975a14 RL	133	};
	134
	135	struct gfh_brom_cfg {
	136	struct gfh_common_header gfh;
a7c9a65e BM	137	uint32_t cfg_bits;
a7c9a65e BM	138	uint32_t usbdl_by_auto_detect_timeout_ms;
44165e4c FP	139	uint8_t unused[0x45];
	140	uint8_t jump_bl_arm64;
	141	uint8_t unused2[2];
a7c9a65e BM	142	uint32_t usbdl_by_kcol0_timeout_ms;
a7c9a65e BM	143	uint32_t usbdl_by_flag_timeout_ms;
3b975a14 RL	144	uint32_t pad;
	145	};
	146
	147	#define GFH_BROM_CFG_USBDL_BY_AUTO_DETECT_TIMEOUT_EN 0x02
	148	#define GFH_BROM_CFG_USBDL_AUTO_DETECT_DIS 0x10
	149	#define GFH_BROM_CFG_USBDL_BY_KCOL0_TIMEOUT_EN 0x80
	150	#define GFH_BROM_CFG_USBDL_BY_FLAG_TIMEOUT_EN 0x100
44165e4c FP	151	#define GFH_BROM_CFG_JUMP_BL_ARM64_EN 0x1000
44165e4c FP	152	#define GFH_BROM_CFG_JUMP_BL_ARM64 0x64
3b975a14 RL	153
	154	struct gfh_bl_sec_key {
	155	struct gfh_common_header gfh;
	156	uint8_t pad[0x20c];
	157	};
	158
	159	struct gfh_anti_clone {
	160	struct gfh_common_header gfh;
	161	uint8_t ac_b2k;
	162	uint8_t ac_b2c;
	163	uint16_t pad;
a7c9a65e BM	164	uint32_t ac_offset;
a7c9a65e BM	165	uint32_t ac_len;
3b975a14 RL	166	};
	167
	168	struct gfh_brom_sec_cfg {
	169	struct gfh_common_header gfh;
a7c9a65e	170	uint32_t cfg_bits;
3b975a14	171	char customer_name[0x20];
a7c9a65e	172	uint32_t pad;
3b975a14 RL	173	};
	174
	175	#define BROM_SEC_CFG_JTAG_EN 1
	176	#define BROM_SEC_CFG_UART_EN 2
	177
	178	struct gfh_header {
	179	struct gfh_file_info file_info;
	180	struct gfh_bl_info bl_info;
	181	struct gfh_brom_cfg brom_cfg;
	182	struct gfh_bl_sec_key bl_sec_key;
	183	struct gfh_anti_clone anti_clone;
	184	struct gfh_brom_sec_cfg brom_sec_cfg;
	185	};
	186
	187	/* LK image header */
	188
	189	union lk_hdr {
	190	struct {
a7c9a65e BM	191	uint32_t magic;
a7c9a65e BM	192	uint32_t size;
3b975a14	193	char name[32];
a7c9a65e BM	194	uint32_t loadaddr;
a7c9a65e BM	195	uint32_t mode;
3b975a14 RL	196	};
	197
	198	uint8_t data[512];
	199	};
	200
	201	#define LK_PART_MAGIC 0x58881688
	202
	203	#endif /* _MTK_IMAGE_H */