1 /* 2 * (C) Copyright 2015 Google, Inc 3 * Written by Simon Glass <sjg@chromium.org> 4 * 5 * (C) 2017 Theobroma Systems Design und Consulting GmbH 6 * 7 * SPDX-License-Identifier: GPL-2.0+ 8 * 9 * Helper functions for Rockchip images 10 */ 11 12 #include "imagetool.h" 13 #include <image.h> 14 #include <rc4.h> 15 #include "mkimage.h" 16 #include "rkcommon.h" 17 18 #define DIV_ROUND_UP(n, d) (((n) + (d) - 1) / (d)) 19 20 enum { 21 RK_SIGNATURE = 0x0ff0aa55, 22 }; 23 24 /** 25 * struct header0_info - header block for boot ROM 26 * 27 * This is stored at SD card block 64 (where each block is 512 bytes, or at 28 * the start of SPI flash. It is encoded with RC4. 29 * 30 * @signature: Signature (must be RKSD_SIGNATURE) 31 * @disable_rc4: 0 to use rc4 for boot image, 1 to use plain binary 32 * @init_offset: Offset in blocks of the SPL code from this header 33 * block. E.g. 4 means 2KB after the start of this header. 34 * Other fields are not used by U-Boot 35 */ 36 struct header0_info { 37 uint32_t signature; 38 uint8_t reserved[4]; 39 uint32_t disable_rc4; 40 uint16_t init_offset; 41 uint8_t reserved1[492]; 42 uint16_t init_size; 43 uint16_t init_boot_size; 44 uint8_t reserved2[2]; 45 }; 46 47 /** 48 * struct header1 info 49 */ 50 struct header1_info { 51 uint32_t magic; 52 }; 53 54 /** 55 * struct spl_info - spl info for each chip 56 * 57 * @imagename: Image name(passed by "mkimage -n") 58 * @spl_hdr: Boot ROM requires a 4-bytes spl header 59 * @spl_size: Spl size(include extra 4-bytes spl header) 60 * @spl_rc4: RC4 encode the SPL binary (same key as header) 61 */ 62 63 struct spl_info { 64 const char *imagename; 65 const char *spl_hdr; 66 const uint32_t spl_size; 67 const bool spl_rc4; 68 }; 69 70 static struct spl_info spl_infos[] = { 71 { "rk3036", "RK30", 0x1000, false }, 72 { "rk3066", "RK30", 0x8000, true, }, 73 { "rk3128", "RK31", 0x1800, false }, 74 { "rk3188", "RK31", 0x8000 - 0x800, true }, 75 { "rk322x", "RK32", 0x8000 - 0x1000, false }, 76 { "rk3288", "RK32", 0x8000, false }, 77 { "rk3308", "RK33", 0x40000 - 0x1000, false}, 78 { "rk3328", "RK32", 0x8000 - 0x1000, false }, 79 { "rk3368", "RK33", 0x8000 - 0x1000, false }, 80 { "rk3399", "RK33", 0x30000 - 0x2000, false }, 81 { "px30", "RK33", 0x2800, false }, 82 { "rv1108", "RK11", 0x1800, false }, 83 }; 84 85 static unsigned char rc4_key[16] = { 86 124, 78, 3, 4, 85, 5, 9, 7, 87 45, 44, 123, 56, 23, 13, 23, 17 88 }; 89 90 static struct spl_info *rkcommon_get_spl_info(char *imagename) 91 { 92 int i; 93 94 if (!imagename) 95 return NULL; 96 97 for (i = 0; i < ARRAY_SIZE(spl_infos); i++) 98 if (!strncmp(imagename, spl_infos[i].imagename, 6)) 99 return spl_infos + i; 100 101 return NULL; 102 } 103 104 int rkcommon_check_params(struct image_tool_params *params) 105 { 106 int i; 107 108 if (rkcommon_get_spl_info(params->imagename) != NULL) 109 return EXIT_SUCCESS; 110 111 /* 112 * If this is a operation (list or extract), the don't require 113 * imagename to be set. 114 */ 115 if (params->lflag || params->iflag) 116 return EXIT_SUCCESS; 117 118 fprintf(stderr, "ERROR: imagename (%s) is not supported!\n", 119 params->imagename ? params->imagename : "NULL"); 120 121 fprintf(stderr, "Available imagename:"); 122 for (i = 0; i < ARRAY_SIZE(spl_infos); i++) 123 fprintf(stderr, "\t%s", spl_infos[i].imagename); 124 fprintf(stderr, "\n"); 125 126 return EXIT_FAILURE; 127 } 128 129 const char *rkcommon_get_spl_hdr(struct image_tool_params *params) 130 { 131 struct spl_info *info = rkcommon_get_spl_info(params->imagename); 132 133 /* 134 * info would not be NULL, because of we checked params before. 135 */ 136 return info->spl_hdr; 137 } 138 139 140 int rkcommon_get_spl_size(struct image_tool_params *params) 141 { 142 struct spl_info *info = rkcommon_get_spl_info(params->imagename); 143 144 /* 145 * info would not be NULL, because of we checked params before. 146 */ 147 return info->spl_size; 148 } 149 150 bool rkcommon_need_rc4_spl(struct image_tool_params *params) 151 { 152 struct spl_info *info = rkcommon_get_spl_info(params->imagename); 153 154 /* 155 * info would not be NULL, because of we checked params before. 156 */ 157 return info->spl_rc4; 158 } 159 160 static void rkcommon_set_header0(void *buf, uint file_size, uint max_size, 161 struct image_tool_params *params) 162 { 163 struct header0_info *hdr = buf; 164 165 memset(buf, '\0', RK_INIT_OFFSET * RK_BLK_SIZE); 166 hdr->signature = RK_SIGNATURE; 167 hdr->disable_rc4 = !rkcommon_need_rc4_spl(params); 168 hdr->init_offset = RK_INIT_OFFSET; 169 170 hdr->init_size = DIV_ROUND_UP(file_size, RK_BLK_SIZE); 171 /* 172 * The init_size has to be a multiple of 4 blocks (i.e. of 2K) 173 * or the BootROM will not boot the image. 174 * 175 * Note: To verify that this is not a legacy constraint, we 176 * rechecked this against the RK3399 BootROM. 177 */ 178 hdr->init_size = ROUND(hdr->init_size, 4); 179 /* 180 * init_boot_size needs to be set, as it is read by the BootROM 181 * to determine the size of the next-stage bootloader (e.g. U-Boot 182 * proper), when used with the back-to-bootrom functionality. 183 * 184 * see https://lists.denx.de/pipermail/u-boot/2017-May/293267.html 185 * for a more detailed explanation by Andy Yan 186 */ 187 hdr->init_boot_size = hdr->init_size + DIV_ROUND_UP(max_size, RK_BLK_SIZE); 188 hdr->init_boot_size = ROUND(hdr->init_boot_size, 4); 189 190 rc4_encode(buf, RK_BLK_SIZE, rc4_key); 191 } 192 193 int rkcommon_set_header(void *buf, uint file_size, uint max_size, 194 struct image_tool_params *params) 195 { 196 struct header1_info *hdr = buf + RK_SPL_HDR_START; 197 198 if (file_size > rkcommon_get_spl_size(params)) 199 return -ENOSPC; 200 201 rkcommon_set_header0(buf, file_size, max_size, params); 202 203 /* Set up the SPL name (i.e. copy spl_hdr over) */ 204 memcpy(&hdr->magic, rkcommon_get_spl_hdr(params), RK_SPL_HDR_SIZE); 205 206 if (rkcommon_need_rc4_spl(params)) 207 rkcommon_rc4_encode_spl(buf, RK_SPL_HDR_START, 208 params->file_size - RK_SPL_HDR_START); 209 210 return 0; 211 } 212 213 static inline unsigned rkcommon_offset_to_spi(unsigned offset) 214 { 215 /* 216 * While SD/MMC images use a flat addressing, SPI images are padded 217 * to use the first 2K of every 4K sector only. 218 */ 219 return ((offset & ~0x7ff) << 1) + (offset & 0x7ff); 220 } 221 222 static int rkcommon_parse_header(const void *buf, struct header0_info *header0, 223 struct spl_info **spl_info) 224 { 225 unsigned hdr1_offset; 226 struct header1_info *hdr1_sdmmc, *hdr1_spi; 227 int i; 228 229 if (spl_info) 230 *spl_info = NULL; 231 232 /* 233 * The first header (hdr0) is always RC4 encoded, so try to decrypt 234 * with the well-known key. 235 */ 236 memcpy((void *)header0, buf, sizeof(struct header0_info)); 237 rc4_encode((void *)header0, sizeof(struct header0_info), rc4_key); 238 239 if (header0->signature != RK_SIGNATURE) 240 return -EPROTO; 241 242 /* We don't support RC4 encoded image payloads here, yet... */ 243 if (header0->disable_rc4 == 0) 244 return -ENOSYS; 245 246 hdr1_offset = header0->init_offset * RK_BLK_SIZE; 247 hdr1_sdmmc = (struct header1_info *)(buf + hdr1_offset); 248 hdr1_spi = (struct header1_info *)(buf + 249 rkcommon_offset_to_spi(hdr1_offset)); 250 251 for (i = 0; i < ARRAY_SIZE(spl_infos); i++) { 252 if (!memcmp(&hdr1_sdmmc->magic, spl_infos[i].spl_hdr, 4)) { 253 if (spl_info) 254 *spl_info = &spl_infos[i]; 255 return IH_TYPE_RKSD; 256 } else if (!memcmp(&hdr1_spi->magic, spl_infos[i].spl_hdr, 4)) { 257 if (spl_info) 258 *spl_info = &spl_infos[i]; 259 return IH_TYPE_RKSPI; 260 } 261 } 262 263 return -1; 264 } 265 266 int rkcommon_verify_header(unsigned char *buf, int size, 267 struct image_tool_params *params) 268 { 269 struct header0_info header0; 270 struct spl_info *img_spl_info, *spl_info; 271 int ret; 272 273 ret = rkcommon_parse_header(buf, &header0, &img_spl_info); 274 275 /* If this is the (unimplemented) RC4 case, then rewrite the result */ 276 if (ret == -ENOSYS) 277 return 0; 278 279 if (ret < 0) 280 return ret; 281 282 /* 283 * If no 'imagename' is specified via the commandline (e.g. if this is 284 * 'dumpimage -l' w/o any further constraints), we accept any spl_info. 285 */ 286 if (params->imagename == NULL) 287 return 0; 288 289 /* Match the 'imagename' against the 'spl_hdr' found */ 290 spl_info = rkcommon_get_spl_info(params->imagename); 291 if (spl_info && img_spl_info) 292 return strcmp(spl_info->spl_hdr, img_spl_info->spl_hdr); 293 294 return -ENOENT; 295 } 296 297 void rkcommon_print_header(const void *buf) 298 { 299 struct header0_info header0; 300 struct spl_info *spl_info; 301 uint8_t image_type; 302 int ret; 303 304 ret = rkcommon_parse_header(buf, &header0, &spl_info); 305 306 /* If this is the (unimplemented) RC4 case, then fail silently */ 307 if (ret == -ENOSYS) 308 return; 309 310 if (ret < 0) { 311 fprintf(stderr, "Error: image verification failed\n"); 312 return; 313 } 314 315 image_type = ret; 316 317 printf("Image Type: Rockchip %s (%s) boot image\n", 318 spl_info->spl_hdr, 319 (image_type == IH_TYPE_RKSD) ? "SD/MMC" : "SPI"); 320 printf("Data Size: %d bytes\n", header0.init_size * RK_BLK_SIZE); 321 } 322 323 void rkcommon_rc4_encode_spl(void *buf, unsigned int offset, unsigned int size) 324 { 325 unsigned int remaining = size; 326 327 while (remaining > 0) { 328 int step = (remaining > RK_BLK_SIZE) ? RK_BLK_SIZE : remaining; 329 330 rc4_encode(buf + offset, step, rc4_key); 331 offset += RK_BLK_SIZE; 332 remaining -= step; 333 } 334 } 335 336 int rkcommon_vrec_header(struct image_tool_params *params, 337 struct image_type_params *tparams, 338 unsigned int alignment) 339 { 340 unsigned int unpadded_size; 341 unsigned int padded_size; 342 343 /* 344 * The SPL image looks as follows: 345 * 346 * 0x0 header0 (see rkcommon.c) 347 * 0x800 spl_name ('RK30', ..., 'RK33') 348 * (start of the payload for AArch64 payloads: we expect the 349 * first 4 bytes to be available for overwriting with our 350 * spl_name) 351 * 0x804 first instruction to be executed 352 * (start of the image/payload for 32bit payloads) 353 * 354 * For AArch64 (ARMv8) payloads, natural alignment (8-bytes) is 355 * required for its sections (so the image we receive needs to 356 * have the first 4 bytes reserved for the spl_name). Reserving 357 * these 4 bytes is done using the BOOT0_HOOK infrastructure. 358 * 359 * The header is always at 0x800 (as we now use a payload 360 * prepadded using the boot0 hook for all targets): the first 361 * 4 bytes of these images can safely be overwritten using the 362 * boot magic. 363 */ 364 tparams->header_size = RK_SPL_HDR_START; 365 366 /* Allocate, clear and install the header */ 367 tparams->hdr = malloc(tparams->header_size); 368 if (!tparams->hdr) 369 return -ENOMEM; 370 memset(tparams->hdr, 0, tparams->header_size); 371 372 /* 373 * If someone passed in 0 for the alignment, we'd better handle 374 * it correctly... 375 */ 376 if (!alignment) 377 alignment = 1; 378 379 unpadded_size = tparams->header_size + params->file_size; 380 padded_size = ROUND(unpadded_size, alignment); 381 382 return padded_size - unpadded_size; 383 } 384