Tom Rini | 10e4779 | 2018-05-06 17:58:06 -0400 | [diff] [blame] | 1 | /* SPDX-License-Identifier: GPL-2.0+ */ |
Stefano Babic | 7b07f09 | 2010-01-20 18:19:10 +0100 | [diff] [blame] | 2 | /* |
| 3 | * (C) Copyright 2009 |
| 4 | * Stefano Babic, DENX Software Engineering, sbabic@denx.de. |
Stefano Babic | 7b07f09 | 2010-01-20 18:19:10 +0100 | [diff] [blame] | 5 | */ |
| 6 | |
| 7 | #ifndef _IMXIMAGE_H_ |
| 8 | #define _IMXIMAGE_H_ |
| 9 | |
Fabio Estevam | 7b9849f | 2014-09-01 09:56:23 -0300 | [diff] [blame] | 10 | #define MAX_HW_CFG_SIZE_V2 220 /* Max number of registers imx can set for v2 */ |
Peng Fan | 334de96 | 2016-10-11 14:29:09 +0800 | [diff] [blame] | 11 | #define MAX_PLUGIN_CODE_SIZE (64 * 1024) |
Liu Hui-R64343 | 4aa360a | 2011-01-19 09:40:26 +0000 | [diff] [blame] | 12 | #define MAX_HW_CFG_SIZE_V1 60 /* Max number of registers imx can set for v1 */ |
Stefano Babic | 7b07f09 | 2010-01-20 18:19:10 +0100 | [diff] [blame] | 13 | #define APP_CODE_BARKER 0xB1 |
| 14 | #define DCD_BARKER 0xB17219E9 |
Stefano Babic | 7b07f09 | 2010-01-20 18:19:10 +0100 | [diff] [blame] | 15 | |
Bryan O'Donoghue | 6170aad | 2018-04-24 18:46:31 +0100 | [diff] [blame] | 16 | /* Specify the offset of the IVT in the IMX header as expected by BootROM */ |
| 17 | #define BOOTROM_IVT_HDR_OFFSET 0xC00 |
| 18 | |
Marek Vasut | d45fd73 | 2013-04-25 10:16:02 +0000 | [diff] [blame] | 19 | /* |
| 20 | * NOTE: This file must be kept in sync with arch/arm/include/asm/\ |
Stefano Babic | 33731bc | 2017-06-29 10:16:06 +0200 | [diff] [blame] | 21 | * mach-imx/imximage.cfg because tools/imximage.c can not |
Marek Vasut | d45fd73 | 2013-04-25 10:16:02 +0000 | [diff] [blame] | 22 | * cross-include headers from arch/arm/ and vice-versa. |
| 23 | */ |
Stefano Babic | 7b07f09 | 2010-01-20 18:19:10 +0100 | [diff] [blame] | 24 | #define CMD_DATA_STR "DATA" |
Stefano Babic | dc39a3e | 2013-06-26 23:50:06 +0200 | [diff] [blame] | 25 | |
| 26 | /* Initial Vector Table Offset */ |
Dirk Behme | 14a98cd | 2012-02-22 22:50:19 +0000 | [diff] [blame] | 27 | #define FLASH_OFFSET_UNDEFINED 0xFFFFFFFF |
Stefano Babic | 7b07f09 | 2010-01-20 18:19:10 +0100 | [diff] [blame] | 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 |
Dirk Behme | dfbf6ce | 2012-01-11 23:28:31 +0000 | [diff] [blame] | 33 | #define FLASH_OFFSET_NOR 0x1000 |
| 34 | #define FLASH_OFFSET_SATA FLASH_OFFSET_STANDARD |
Ye.Li | f16cde0 | 2015-01-13 15:53:06 +0800 | [diff] [blame] | 35 | #define FLASH_OFFSET_QSPI 0x1000 |
Peng Fan | 31c51da | 2018-11-20 10:19:36 +0000 | [diff] [blame] | 36 | #define FLASH_OFFSET_FLEXSPI 0x1000 |
Stefano Babic | 7b07f09 | 2010-01-20 18:19:10 +0100 | [diff] [blame] | 37 | |
Stefano Babic | dc39a3e | 2013-06-26 23:50:06 +0200 | [diff] [blame] | 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 |
Ye.Li | f16cde0 | 2015-01-13 15:53:06 +0800 | [diff] [blame] | 47 | #define FLASH_LOADSIZE_QSPI 0x0 /* entire image */ |
Stefano Babic | dc39a3e | 2013-06-26 23:50:06 +0200 | [diff] [blame] | 48 | |
Adrian Alonso | 73e5732 | 2015-07-20 19:04:55 -0500 | [diff] [blame] | 49 | /* Command tags and parameters */ |
| 50 | #define IVT_HEADER_TAG 0xD1 |
| 51 | #define IVT_VERSION 0x40 |
Peng Fan | 31c51da | 2018-11-20 10:19:36 +0000 | [diff] [blame] | 52 | #define IVT_VERSION_V3 0x41 |
Adrian Alonso | 73e5732 | 2015-07-20 19:04:55 -0500 | [diff] [blame] | 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 |
Peng Fan | 2687474 | 2017-03-16 14:35:06 +0800 | [diff] [blame] | 57 | #define DCD_WRITE_CLR_BIT_PARAM 0xC |
| 58 | #define DCD_WRITE_SET_BIT_PARAM 0x1C |
Adrian Alonso | 73e5732 | 2015-07-20 19:04:55 -0500 | [diff] [blame] | 59 | #define DCD_CHECK_DATA_COMMAND_TAG 0xCF |
| 60 | #define DCD_CHECK_BITS_SET_PARAM 0x14 |
| 61 | #define DCD_CHECK_BITS_CLR_PARAM 0x04 |
Liu Hui-R64343 | 4aa360a | 2011-01-19 09:40:26 +0000 | [diff] [blame] | 62 | |
Bryan O'Donoghue | 8a889ff | 2018-03-26 15:36:45 +0100 | [diff] [blame] | 63 | #ifndef __ASSEMBLY__ |
Stefano Babic | 7b07f09 | 2010-01-20 18:19:10 +0100 | [diff] [blame] | 64 | enum imximage_cmd { |
| 65 | CMD_INVALID, |
Liu Hui-R64343 | 4aa360a | 2011-01-19 09:40:26 +0000 | [diff] [blame] | 66 | CMD_IMAGE_VERSION, |
Stefano Babic | 7b07f09 | 2010-01-20 18:19:10 +0100 | [diff] [blame] | 67 | CMD_BOOT_FROM, |
Marek Vasut | d45fd73 | 2013-04-25 10:16:02 +0000 | [diff] [blame] | 68 | CMD_BOOT_OFFSET, |
Adrian Alonso | 73e5732 | 2015-07-20 19:04:55 -0500 | [diff] [blame] | 69 | CMD_WRITE_DATA, |
| 70 | CMD_WRITE_CLR_BIT, |
Peng Fan | 2687474 | 2017-03-16 14:35:06 +0800 | [diff] [blame] | 71 | CMD_WRITE_SET_BIT, |
Adrian Alonso | 73e5732 | 2015-07-20 19:04:55 -0500 | [diff] [blame] | 72 | CMD_CHECK_BITS_SET, |
| 73 | CMD_CHECK_BITS_CLR, |
Stefano Babic | 4aa9749 | 2013-06-27 11:42:38 +0200 | [diff] [blame] | 74 | CMD_CSF, |
Peng Fan | 334de96 | 2016-10-11 14:29:09 +0800 | [diff] [blame] | 75 | CMD_PLUGIN, |
Flavio Suligoi | 5b08187 | 2020-01-16 11:32:18 +0100 | [diff] [blame^] | 76 | /* Following on i.MX8MQ/MM */ |
Peng Fan | 31c51da | 2018-11-20 10:19:36 +0000 | [diff] [blame] | 77 | CMD_FIT, |
| 78 | CMD_SIGNED_HDMI, |
| 79 | CMD_LOADER, |
| 80 | CMD_SECOND_LOADER, |
| 81 | CMD_DDR_FW, |
Peng Fan | 7be85a7 | 2019-09-16 03:09:39 +0000 | [diff] [blame] | 82 | CMD_ROM_VERSION, |
Stefano Babic | 7b07f09 | 2010-01-20 18:19:10 +0100 | [diff] [blame] | 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 | |
Liu Hui-R64343 | 4aa360a | 2011-01-19 09:40:26 +0000 | [diff] [blame] | 93 | enum imximage_version { |
| 94 | IMXIMAGE_VER_INVALID = -1, |
| 95 | IMXIMAGE_V1 = 1, |
Peng Fan | 31c51da | 2018-11-20 10:19:36 +0000 | [diff] [blame] | 96 | IMXIMAGE_V2, |
| 97 | IMXIMAGE_V3 |
Liu Hui-R64343 | 4aa360a | 2011-01-19 09:40:26 +0000 | [diff] [blame] | 98 | }; |
Stefano Babic | 7b07f09 | 2010-01-20 18:19:10 +0100 | [diff] [blame] | 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; |
Liu Hui-R64343 | 4aa360a | 2011-01-19 09:40:26 +0000 | [diff] [blame] | 113 | dcd_type_addr_data_t addr_data[MAX_HW_CFG_SIZE_V1]; |
| 114 | } dcd_v1_t; |
Stefano Babic | 7b07f09 | 2010-01-20 18:19:10 +0100 | [diff] [blame] | 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; |
Stefano Babic | 5cdde80 | 2010-02-05 15:16:02 +0100 | [diff] [blame] | 121 | uint32_t super_root_key; |
Stefano Babic | 7b07f09 | 2010-01-20 18:19:10 +0100 | [diff] [blame] | 122 | uint32_t dcd_ptr; |
| 123 | uint32_t app_dest_ptr; |
Liu Hui-R64343 | 4aa360a | 2011-01-19 09:40:26 +0000 | [diff] [blame] | 124 | } flash_header_v1_t; |
Stefano Babic | 7b07f09 | 2010-01-20 18:19:10 +0100 | [diff] [blame] | 125 | |
| 126 | typedef struct { |
| 127 | uint32_t length; /* Length of data to be read from flash */ |
| 128 | } flash_cfg_parms_t; |
| 129 | |
Liu Hui-R64343 | 4aa360a | 2011-01-19 09:40:26 +0000 | [diff] [blame] | 130 | typedef struct { |
| 131 | flash_header_v1_t fhdr; |
| 132 | dcd_v1_t dcd_table; |
Stefano Babic | 7b07f09 | 2010-01-20 18:19:10 +0100 | [diff] [blame] | 133 | flash_cfg_parms_t ext_header; |
Liu Hui-R64343 | 4aa360a | 2011-01-19 09:40:26 +0000 | [diff] [blame] | 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 | |
Troy Kisky | f575ab4 | 2015-09-14 18:06:31 -0700 | [diff] [blame] | 153 | struct dcd_v2_cmd { |
Liu Hui-R64343 | 4aa360a | 2011-01-19 09:40:26 +0000 | [diff] [blame] | 154 | write_dcd_command_t write_dcd_command; |
| 155 | dcd_addr_data_t addr_data[MAX_HW_CFG_SIZE_V2]; |
Troy Kisky | f575ab4 | 2015-09-14 18:06:31 -0700 | [diff] [blame] | 156 | }; |
| 157 | |
| 158 | typedef struct { |
| 159 | ivt_header_t header; |
| 160 | struct dcd_v2_cmd dcd_cmd; |
Albert ARIBAUD \(3ADEV\) | b7c3fcf | 2015-06-19 14:18:30 +0200 | [diff] [blame] | 161 | uint32_t padding[1]; /* end up on an 8-byte boundary */ |
Liu Hui-R64343 | 4aa360a | 2011-01-19 09:40:26 +0000 | [diff] [blame] | 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; |
Peng Fan | 334de96 | 2016-10-11 14:29:09 +0800 | [diff] [blame] | 184 | union { |
| 185 | dcd_v2_t dcd_table; |
| 186 | char plugin_code[MAX_PLUGIN_CODE_SIZE]; |
| 187 | } data; |
Liu Hui-R64343 | 4aa360a | 2011-01-19 09:40:26 +0000 | [diff] [blame] | 188 | } imx_header_v2_t; |
| 189 | |
Peng Fan | 31c51da | 2018-11-20 10:19:36 +0000 | [diff] [blame] | 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 | |
Marek Vasut | 3d1acc6 | 2013-04-21 05:52:22 +0000 | [diff] [blame] | 196 | /* The header must be aligned to 4k on MX53 for NAND boot */ |
Liu Hui-R64343 | 4aa360a | 2011-01-19 09:40:26 +0000 | [diff] [blame] | 197 | struct imx_header { |
| 198 | union { |
| 199 | imx_header_v1_t hdr_v1; |
| 200 | imx_header_v2_t hdr_v2; |
| 201 | } header; |
Stefano Babic | dc39a3e | 2013-06-26 23:50:06 +0200 | [diff] [blame] | 202 | }; |
Stefano Babic | 7b07f09 | 2010-01-20 18:19:10 +0100 | [diff] [blame] | 203 | |
Liu Hui-R64343 | 4aa360a | 2011-01-19 09:40:26 +0000 | [diff] [blame] | 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 | |
Adrian Alonso | 73e5732 | 2015-07-20 19:04:55 -0500 | [diff] [blame] | 209 | typedef void (*set_dcd_param_t)(struct imx_header *imxhdr, uint32_t dcd_len, |
| 210 | int32_t cmd); |
| 211 | |
Liu Hui-R64343 | 4aa360a | 2011-01-19 09:40:26 +0000 | [diff] [blame] | 212 | typedef void (*set_dcd_rst_t)(struct imx_header *imxhdr, |
| 213 | uint32_t dcd_len, |
| 214 | char *name, int lineno); |
| 215 | |
Troy Kisky | 7bb9220 | 2012-10-03 15:47:08 +0000 | [diff] [blame] | 216 | typedef void (*set_imx_hdr_t)(struct imx_header *imxhdr, uint32_t dcd_len, |
| 217 | uint32_t entry_point, uint32_t flash_offset); |
Stefano Babic | 7b07f09 | 2010-01-20 18:19:10 +0100 | [diff] [blame] | 218 | |
Bryan O'Donoghue | 8a889ff | 2018-03-26 15:36:45 +0100 | [diff] [blame] | 219 | #endif /* __ASSEMBLY__ */ |
Stefano Babic | 7b07f09 | 2010-01-20 18:19:10 +0100 | [diff] [blame] | 220 | #endif /* _IMXIMAGE_H_ */ |