[thirdparty/u-boot.git] / include / imximage.h

/* SPDX-License-Identifier: GPL-2.0+ */
/*
 * (C) Copyright 2009
 * Stefano Babic, DENX Software Engineering, sbabic@denx.de.
 */

#ifndef _IMXIMAGE_H_
#define _IMXIMAGE_H_

#define MAX_HW_CFG_SIZE_V2 220 /* Max number of registers imx can set for v2 */
#define MAX_PLUGIN_CODE_SIZE (64 * 1024)
#define MAX_HW_CFG_SIZE_V1 60  /* Max number of registers imx can set for v1 */
#define APP_CODE_BARKER	0xB1
#define DCD_BARKER	0xB17219E9

/* Specify the offset of the IVT in the IMX header as expected by BootROM */
#define BOOTROM_IVT_HDR_OFFSET	0xC00

/*
 * NOTE: This file must be kept in sync with arch/arm/include/asm/\
 *       mach-imx/imximage.cfg because tools/imximage.c can not
 *       cross-include headers from arch/arm/ and vice-versa.
 */
#define CMD_DATA_STR	"DATA"

/* Initial Vector Table Offset */
#define FLASH_OFFSET_UNDEFINED	0xFFFFFFFF
#define FLASH_OFFSET_STANDARD	0x400
#define FLASH_OFFSET_NAND	FLASH_OFFSET_STANDARD
#define FLASH_OFFSET_SD		FLASH_OFFSET_STANDARD
#define FLASH_OFFSET_SPI	FLASH_OFFSET_STANDARD
#define FLASH_OFFSET_ONENAND	0x100
#define FLASH_OFFSET_NOR	0x1000
#define FLASH_OFFSET_SATA	FLASH_OFFSET_STANDARD
#define FLASH_OFFSET_QSPI	0x1000
#define FLASH_OFFSET_FLEXSPI	0x1000

/* Initial Load Region Size */
#define FLASH_LOADSIZE_UNDEFINED	0xFFFFFFFF
#define FLASH_LOADSIZE_STANDARD		0x1000
#define FLASH_LOADSIZE_NAND		FLASH_LOADSIZE_STANDARD
#define FLASH_LOADSIZE_SD		FLASH_LOADSIZE_STANDARD
#define FLASH_LOADSIZE_SPI		FLASH_LOADSIZE_STANDARD
#define FLASH_LOADSIZE_ONENAND		0x400
#define FLASH_LOADSIZE_NOR		0x0 /* entire image */
#define FLASH_LOADSIZE_SATA		FLASH_LOADSIZE_STANDARD
#define FLASH_LOADSIZE_QSPI		0x0 /* entire image */

/* Command tags and parameters */
#define IVT_HEADER_TAG			0xD1
#define IVT_VERSION			0x40
#define IVT_VERSION_V3			0x41
#define DCD_HEADER_TAG			0xD2
#define DCD_VERSION			0x40
#define DCD_WRITE_DATA_COMMAND_TAG	0xCC
#define DCD_WRITE_DATA_PARAM		0x4
#define DCD_WRITE_CLR_BIT_PARAM		0xC
#define DCD_WRITE_SET_BIT_PARAM		0x1C
#define DCD_CHECK_DATA_COMMAND_TAG	0xCF
#define DCD_CHECK_BITS_SET_PARAM	0x14
#define DCD_CHECK_BITS_CLR_PARAM	0x04

#ifndef __ASSEMBLY__
enum imximage_cmd {
	CMD_INVALID,
	CMD_IMAGE_VERSION,
	CMD_BOOT_FROM,
	CMD_BOOT_OFFSET,
	CMD_WRITE_DATA,
	CMD_WRITE_CLR_BIT,
	CMD_WRITE_SET_BIT,
	CMD_CHECK_BITS_SET,
	CMD_CHECK_BITS_CLR,
	CMD_CSF,
	CMD_PLUGIN,
	/* Following on i.MX8MQ/MM */
	CMD_FIT,
	CMD_SIGNED_HDMI,
	CMD_LOADER,
	CMD_SECOND_LOADER,
	CMD_DDR_FW,
	CMD_ROM_VERSION,
};

enum imximage_fld_types {
	CFG_INVALID = -1,
	CFG_COMMAND,
	CFG_REG_SIZE,
	CFG_REG_ADDRESS,
	CFG_REG_VALUE
};

enum imximage_version {
	IMXIMAGE_VER_INVALID = -1,
	IMXIMAGE_V1 = 1,
	IMXIMAGE_V2,
	IMXIMAGE_V3
};

typedef struct {
	uint32_t type; /* Type of pointer (byte, halfword, word, wait/read) */
	uint32_t addr; /* Address to write to */
	uint32_t value; /* Data to write */
} dcd_type_addr_data_t;

typedef struct {
	uint32_t barker; /* Barker for sanity check */
	uint32_t length; /* Device configuration length (without preamble) */
} dcd_preamble_t;

typedef struct {
	dcd_preamble_t preamble;
	dcd_type_addr_data_t addr_data[MAX_HW_CFG_SIZE_V1];
} dcd_v1_t;

typedef struct {
	uint32_t app_code_jump_vector;
	uint32_t app_code_barker;
	uint32_t app_code_csf;
	uint32_t dcd_ptr_ptr;
	uint32_t super_root_key;
	uint32_t dcd_ptr;
	uint32_t app_dest_ptr;
} flash_header_v1_t;

typedef struct {
	uint32_t length; 	/* Length of data to be read from flash */
} flash_cfg_parms_t;

typedef struct {
	flash_header_v1_t fhdr;
	dcd_v1_t dcd_table;
	flash_cfg_parms_t ext_header;
} imx_header_v1_t;

typedef struct {
	uint32_t addr;
	uint32_t value;
} dcd_addr_data_t;

typedef struct {
	uint8_t tag;
	uint16_t length;
	uint8_t version;
} __attribute__((packed)) ivt_header_t;

typedef struct {
	uint8_t tag;
	uint16_t length;
	uint8_t param;
} __attribute__((packed)) write_dcd_command_t;

struct dcd_v2_cmd {
	write_dcd_command_t write_dcd_command;
	dcd_addr_data_t addr_data[MAX_HW_CFG_SIZE_V2];
};

typedef struct {
	ivt_header_t header;
	struct dcd_v2_cmd dcd_cmd;
	uint32_t padding[1]; /* end up on an 8-byte boundary */
} dcd_v2_t;

typedef struct {
	uint32_t start;
	uint32_t size;
	uint32_t plugin;
} boot_data_t;

typedef struct {
	ivt_header_t header;
	uint32_t entry;
	uint32_t reserved1;
	uint32_t dcd_ptr;
	uint32_t boot_data_ptr;
	uint32_t self;
	uint32_t csf;
	uint32_t reserved2;
} flash_header_v2_t;

typedef struct {
	flash_header_v2_t fhdr;
	boot_data_t boot_data;
	union {
		dcd_v2_t dcd_table;
		char plugin_code[MAX_PLUGIN_CODE_SIZE];
	} data;
} imx_header_v2_t;

typedef struct {
	flash_header_v2_t fhdr;
	boot_data_t boot_data;
	uint32_t padding[5];
} imx_header_v3_t;

/* The header must be aligned to 4k on MX53 for NAND boot */
struct imx_header {
	union {
		imx_header_v1_t hdr_v1;
		imx_header_v2_t hdr_v2;
	} header;
};

typedef void (*set_dcd_val_t)(struct imx_header *imxhdr,
					char *name, int lineno,
					int fld, uint32_t value,
					uint32_t off);

typedef void (*set_dcd_param_t)(struct imx_header *imxhdr, uint32_t dcd_len,
					int32_t cmd);

typedef void (*set_dcd_rst_t)(struct imx_header *imxhdr,
					uint32_t dcd_len,
					char *name, int lineno);

typedef void (*set_imx_hdr_t)(struct imx_header *imxhdr, uint32_t dcd_len,
		uint32_t entry_point, uint32_t flash_offset);

#endif /* __ASSEMBLY__ */
#endif /* _IMXIMAGE_H_ */
Commit	Line	Data
83d290c5	1	/* SPDX-License-Identifier: GPL-2.0+ */
8edcde5e SB	2	/*
	3	* (C) Copyright 2009
	4	* Stefano Babic, DENX Software Engineering, sbabic@denx.de.
8edcde5e SB	5	*/
	6
	7	#ifndef _IMXIMAGE_H_
	8	#define _IMXIMAGE_H_
	9
021e79c8	10	#define MAX_HW_CFG_SIZE_V2 220 /* Max number of registers imx can set for v2 */
b55e4f48	11	#define MAX_PLUGIN_CODE_SIZE (64 * 1024)
8a1edd7d	12	#define MAX_HW_CFG_SIZE_V1 60 /* Max number of registers imx can set for v1 */
8edcde5e SB	13	#define APP_CODE_BARKER 0xB1
8edcde5e SB	14	#define DCD_BARKER 0xB17219E9
8edcde5e	15
69f06950 BD	16	/* Specify the offset of the IVT in the IMX header as expected by BootROM */
	17	#define BOOTROM_IVT_HDR_OFFSET 0xC00
	18
6cb83829 MV	19	/*
6cb83829 MV	20	* NOTE: This file must be kept in sync with arch/arm/include/asm/\
552a848e	21	* mach-imx/imximage.cfg because tools/imximage.c can not
6cb83829 MV	22	* cross-include headers from arch/arm/ and vice-versa.
6cb83829 MV	23	*/
8edcde5e	24	#define CMD_DATA_STR "DATA"
377e367a SB	25
377e367a SB	26	/* Initial Vector Table Offset */
49d3e272	27	#define FLASH_OFFSET_UNDEFINED 0xFFFFFFFF
8edcde5e SB	28	#define FLASH_OFFSET_STANDARD 0x400
	29	#define FLASH_OFFSET_NAND FLASH_OFFSET_STANDARD
	30	#define FLASH_OFFSET_SD FLASH_OFFSET_STANDARD
	31	#define FLASH_OFFSET_SPI FLASH_OFFSET_STANDARD
	32	#define FLASH_OFFSET_ONENAND 0x100
19b409c0 DB	33	#define FLASH_OFFSET_NOR 0x1000
19b409c0 DB	34	#define FLASH_OFFSET_SATA FLASH_OFFSET_STANDARD
9598f8c3	35	#define FLASH_OFFSET_QSPI 0x1000
6609c266	36	#define FLASH_OFFSET_FLEXSPI 0x1000
8edcde5e	37
377e367a SB	38	/* Initial Load Region Size */
	39	#define FLASH_LOADSIZE_UNDEFINED 0xFFFFFFFF
	40	#define FLASH_LOADSIZE_STANDARD 0x1000
	41	#define FLASH_LOADSIZE_NAND FLASH_LOADSIZE_STANDARD
	42	#define FLASH_LOADSIZE_SD FLASH_LOADSIZE_STANDARD
	43	#define FLASH_LOADSIZE_SPI FLASH_LOADSIZE_STANDARD
	44	#define FLASH_LOADSIZE_ONENAND 0x400
	45	#define FLASH_LOADSIZE_NOR 0x0 /* entire image */
	46	#define FLASH_LOADSIZE_SATA FLASH_LOADSIZE_STANDARD
9598f8c3	47	#define FLASH_LOADSIZE_QSPI 0x0 /* entire image */
377e367a	48
0b7f7c33 AA	49	/* Command tags and parameters */
	50	#define IVT_HEADER_TAG 0xD1
	51	#define IVT_VERSION 0x40
6609c266	52	#define IVT_VERSION_V3 0x41
0b7f7c33 AA	53	#define DCD_HEADER_TAG 0xD2
	54	#define DCD_VERSION 0x40
	55	#define DCD_WRITE_DATA_COMMAND_TAG 0xCC
	56	#define DCD_WRITE_DATA_PARAM 0x4
3e0a71c1 PF	57	#define DCD_WRITE_CLR_BIT_PARAM 0xC
3e0a71c1 PF	58	#define DCD_WRITE_SET_BIT_PARAM 0x1C
0b7f7c33 AA	59	#define DCD_CHECK_DATA_COMMAND_TAG 0xCF
	60	#define DCD_CHECK_BITS_SET_PARAM 0x14
	61	#define DCD_CHECK_BITS_CLR_PARAM 0x04
8a1edd7d	62
f4d8fccd	63	#ifndef __ASSEMBLY__
8edcde5e SB	64	enum imximage_cmd {
8edcde5e SB	65	CMD_INVALID,
8a1edd7d	66	CMD_IMAGE_VERSION,
8edcde5e	67	CMD_BOOT_FROM,
6cb83829	68	CMD_BOOT_OFFSET,
0b7f7c33 AA	69	CMD_WRITE_DATA,
0b7f7c33 AA	70	CMD_WRITE_CLR_BIT,
3e0a71c1	71	CMD_WRITE_SET_BIT,
0b7f7c33 AA	72	CMD_CHECK_BITS_SET,
0b7f7c33 AA	73	CMD_CHECK_BITS_CLR,
0187c985	74	CMD_CSF,
b55e4f48	75	CMD_PLUGIN,
7132d38c	76	/* Following on i.MX8MQ/MM */
6609c266 PF	77	CMD_FIT,
	78	CMD_SIGNED_HDMI,
	79	CMD_LOADER,
	80	CMD_SECOND_LOADER,
	81	CMD_DDR_FW,
b8f16834	82	CMD_ROM_VERSION,
8edcde5e SB	83	};
	84
	85	enum imximage_fld_types {
	86	CFG_INVALID = -1,
	87	CFG_COMMAND,
	88	CFG_REG_SIZE,
	89	CFG_REG_ADDRESS,
	90	CFG_REG_VALUE
	91	};
	92
8a1edd7d LHR	93	enum imximage_version {
	94	IMXIMAGE_VER_INVALID = -1,
	95	IMXIMAGE_V1 = 1,
6609c266 PF	96	IMXIMAGE_V2,
6609c266 PF	97	IMXIMAGE_V3
8a1edd7d	98	};
8edcde5e SB	99
	100	typedef struct {
	101	uint32_t type; /* Type of pointer (byte, halfword, word, wait/read) */
	102	uint32_t addr; /* Address to write to */
	103	uint32_t value; /* Data to write */
	104	} dcd_type_addr_data_t;
	105
	106	typedef struct {
	107	uint32_t barker; /* Barker for sanity check */
	108	uint32_t length; /* Device configuration length (without preamble) */
	109	} dcd_preamble_t;
	110
	111	typedef struct {
	112	dcd_preamble_t preamble;
8a1edd7d LHR	113	dcd_type_addr_data_t addr_data[MAX_HW_CFG_SIZE_V1];
8a1edd7d LHR	114	} dcd_v1_t;
8edcde5e SB	115
	116	typedef struct {
	117	uint32_t app_code_jump_vector;
	118	uint32_t app_code_barker;
	119	uint32_t app_code_csf;
	120	uint32_t dcd_ptr_ptr;
5b28e913	121	uint32_t super_root_key;
8edcde5e SB	122	uint32_t dcd_ptr;
8edcde5e SB	123	uint32_t app_dest_ptr;
8a1edd7d	124	} flash_header_v1_t;
8edcde5e SB	125
	126	typedef struct {
	127	uint32_t length; /* Length of data to be read from flash */
	128	} flash_cfg_parms_t;
	129
8a1edd7d LHR	130	typedef struct {
	131	flash_header_v1_t fhdr;
	132	dcd_v1_t dcd_table;
8edcde5e	133	flash_cfg_parms_t ext_header;
8a1edd7d LHR	134	} imx_header_v1_t;
	135
	136	typedef struct {
	137	uint32_t addr;
	138	uint32_t value;
	139	} dcd_addr_data_t;
	140
	141	typedef struct {
	142	uint8_t tag;
	143	uint16_t length;
	144	uint8_t version;
	145	} __attribute__((packed)) ivt_header_t;
	146
	147	typedef struct {
	148	uint8_t tag;
	149	uint16_t length;
	150	uint8_t param;
	151	} __attribute__((packed)) write_dcd_command_t;
	152
61903b75	153	struct dcd_v2_cmd {
8a1edd7d LHR	154	write_dcd_command_t write_dcd_command;
8a1edd7d LHR	155	dcd_addr_data_t addr_data[MAX_HW_CFG_SIZE_V2];
61903b75 TK	156	};
	157
	158	typedef struct {
	159	ivt_header_t header;
	160	struct dcd_v2_cmd dcd_cmd;
699279ca	161	uint32_t padding[1]; /* end up on an 8-byte boundary */
8a1edd7d LHR	162	} dcd_v2_t;
	163
	164	typedef struct {
	165	uint32_t start;
	166	uint32_t size;
	167	uint32_t plugin;
	168	} boot_data_t;
	169
	170	typedef struct {
	171	ivt_header_t header;
	172	uint32_t entry;
	173	uint32_t reserved1;
	174	uint32_t dcd_ptr;
	175	uint32_t boot_data_ptr;
	176	uint32_t self;
	177	uint32_t csf;
	178	uint32_t reserved2;
	179	} flash_header_v2_t;
	180
	181	typedef struct {
	182	flash_header_v2_t fhdr;
	183	boot_data_t boot_data;
b55e4f48 PF	184	union {
	185	dcd_v2_t dcd_table;
	186	char plugin_code[MAX_PLUGIN_CODE_SIZE];
	187	} data;
8a1edd7d LHR	188	} imx_header_v2_t;
8a1edd7d LHR	189
6609c266 PF	190	typedef struct {
	191	flash_header_v2_t fhdr;
	192	boot_data_t boot_data;
	193	uint32_t padding[5];
	194	} imx_header_v3_t;
	195
895d9966	196	/* The header must be aligned to 4k on MX53 for NAND boot */
8a1edd7d LHR	197	struct imx_header {
	198	union {
	199	imx_header_v1_t hdr_v1;
	200	imx_header_v2_t hdr_v2;
	201	} header;
377e367a	202	};
8edcde5e	203
8a1edd7d LHR	204	typedef void (set_dcd_val_t)(struct imx_header imxhdr,
	205	char *name, int lineno,
	206	int fld, uint32_t value,
	207	uint32_t off);
	208
0b7f7c33 AA	209	typedef void (set_dcd_param_t)(struct imx_header imxhdr, uint32_t dcd_len,
	210	int32_t cmd);
	211
8a1edd7d LHR	212	typedef void (set_dcd_rst_t)(struct imx_header imxhdr,
	213	uint32_t dcd_len,
	214	char *name, int lineno);
	215
ad0826dc TK	216	typedef void (set_imx_hdr_t)(struct imx_header imxhdr, uint32_t dcd_len,
ad0826dc TK	217	uint32_t entry_point, uint32_t flash_offset);
8edcde5e	218
f4d8fccd	219	#endif /* __ASSEMBLY__ */
8edcde5e	220	#endif /* _IMXIMAGE_H_ */