tools/rkcommon.c

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