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