tools/rkcommon.c

   1 /*
   2  * (C) Copyright 2015 Google,  Inc
   3  * Written by Simon Glass <sjg@chromium.org>
   4  *
   5  * SPDX-License-Identifier:     GPL-2.0+
   6  *
   7  * Helper functions for Rockchip images
   8  */
   9
  10 #include "imagetool.h"
  11 #include <image.h>
  12 #include <rc4.h>
  13 #include "mkimage.h"
  14 #include "rkcommon.h"
  15
  16 enum {
  17         RK_SIGNATURE            = 0x0ff0aa55,
  18 };
  19
  20 /**
  21  * struct header0_info - header block for boot ROM
  22  *
  23  * This is stored at SD card block 64 (where each block is 512 bytes, or at
  24  * the start of SPI flash. It is encoded with RC4.
  25  *
  26  * @signature:          Signature (must be RKSD_SIGNATURE)
  27  * @disable_rc4:        0 to use rc4 for boot image,  1 to use plain binary
  28  * @init_offset:        Offset in blocks of the SPL code from this header
  29  *                      block. E.g. 4 means 2KB after the start of this header.
  30  * Other fields are not used by U-Boot
  31  */
  32 struct header0_info {
  33         uint32_t signature;
  34         uint8_t reserved[4];
  35         uint32_t disable_rc4;
  36         uint16_t init_offset;
  37         uint8_t reserved1[492];
  38         uint16_t init_size;
  39         uint16_t init_boot_size;
  40         uint8_t reserved2[2];
  41 };
  42
  43 /**
  44  * struct spl_info - spl info for each chip
  45  *
  46  * @imagename:          Image name(passed by "mkimage -n")
  47  * @spl_hdr:            Boot ROM requires a 4-bytes spl header
  48  * @spl_size:           Spl size(include extra 4-bytes spl header)
  49  * @spl_rc4:            RC4 encode the SPL binary (same key as header)
  50  */
  51 struct spl_info {
  52         const char *imagename;
  53         const char *spl_hdr;
  54         const uint32_t spl_size;
  55         const bool spl_rc4;
  56 };
  57
  58 static struct spl_info spl_infos[] = {
  59         { "rk3036", "RK30", 0x1000, false },
  60         { "rk3288", "RK32", 0x8000, false },
  61         { "rk3399", "RK33", 0x20000, false },
  62 };
  63
  64 static unsigned char rc4_key[16] = {
  65         124, 78, 3, 4, 85, 5, 9, 7,
  66         45, 44, 123, 56, 23, 13, 23, 17
  67 };
  68
  69 static struct spl_info *rkcommon_get_spl_info(char *imagename)
  70 {
  71         int i;
  72
  73         for (i = 0; i < ARRAY_SIZE(spl_infos); i++)
  74                 if (!strncmp(imagename, spl_infos[i].imagename, 6))
  75                         return spl_infos + i;
  76
  77         return NULL;
  78 }
  79
  80 int rkcommon_check_params(struct image_tool_params *params)
  81 {
  82         int i;
  83
  84         if (rkcommon_get_spl_info(params->imagename) != NULL)
  85                 return 0;
  86
  87         fprintf(stderr, "ERROR: imagename (%s) is not supported!\n",
  88                 strlen(params->imagename) > 0 ? params->imagename : "NULL");
  89
  90         fprintf(stderr, "Available imagename:");
  91         for (i = 0; i < ARRAY_SIZE(spl_infos); i++)
  92                 fprintf(stderr, "\t%s", spl_infos[i].imagename);
  93         fprintf(stderr, "\n");
  94
  95         return -1;
  96 }
  97
  98 const char *rkcommon_get_spl_hdr(struct image_tool_params *params)
  99 {
 100         struct spl_info *info = rkcommon_get_spl_info(params->imagename);
 101
 102         /*
 103          * info would not be NULL, because of we checked params before.
 104          */
 105         return info->spl_hdr;
 106 }
 107
 108 int rkcommon_get_spl_size(struct image_tool_params *params)
 109 {
 110         struct spl_info *info = rkcommon_get_spl_info(params->imagename);
 111
 112         /*
 113          * info would not be NULL, because of we checked params before.
 114          */
 115         return info->spl_size;
 116 }
 117
 118 bool rkcommon_need_rc4_spl(struct image_tool_params *params)
 119 {
 120         struct spl_info *info = rkcommon_get_spl_info(params->imagename);
 121
 122         /*
 123          * info would not be NULL, because of we checked params before.
 124          */
 125         return info->spl_rc4;
 126 }
 127
 128 int rkcommon_set_header(void *buf, uint file_size,
 129                         struct image_tool_params *params)
 130 {
 131         struct header0_info *hdr;
 132
 133         if (file_size > rkcommon_get_spl_size(params))
 134                 return -ENOSPC;
 135
 136         memset(buf,  '\0', RK_INIT_OFFSET * RK_BLK_SIZE);
 137         hdr = (struct header0_info *)buf;
 138         hdr->signature = RK_SIGNATURE;
 139         hdr->disable_rc4 = !rkcommon_need_rc4_spl(params);
 140         hdr->init_offset = RK_INIT_OFFSET;
 141
 142         hdr->init_size = (file_size + RK_BLK_SIZE - 1) / RK_BLK_SIZE;
 143         hdr->init_size = (hdr->init_size + 3) & ~3;
 144         hdr->init_boot_size = hdr->init_size + RK_MAX_BOOT_SIZE / RK_BLK_SIZE;
 145
 146         rc4_encode(buf, RK_BLK_SIZE, rc4_key);
 147
 148         return 0;
 149 }
 150
 151 void rkcommon_rc4_encode_spl(void *buf, unsigned int offset, unsigned int size)
 152 {
 153         unsigned int remaining = size;
 154
 155         while (remaining > 0) {
 156                 int step = (remaining > RK_BLK_SIZE) ? RK_BLK_SIZE : remaining;
 157
 158                 rc4_encode(buf + offset, step, rc4_key);
 159                 offset += RK_BLK_SIZE;
 160                 remaining -= step;
 161         }
 162 }