mirror of
https://github.com/AsahiLinux/u-boot
synced 2024-12-03 18:10:13 +00:00
29ef48efe1
The Rockchip boot ROM expects little-endian values in the image header. When running mkimage on a big-endian machine, these values need to be byteswapped before writing or verifying the header. This change fixes cross-compiling U-Boot SPL for the RK3399 SoC from a big-endian ppc64 host machine. Signed-off-by: Samuel Holland <samuel@sholland.org> Reviewed-by: Kever Yang<kever.yang@rock-chips.com>
543 lines
14 KiB
C
543 lines
14 KiB
C
// SPDX-License-Identifier: GPL-2.0+
|
|
/*
|
|
* (C) Copyright 2015 Google, Inc
|
|
* Written by Simon Glass <sjg@chromium.org>
|
|
*
|
|
* (C) 2017 Theobroma Systems Design und Consulting GmbH
|
|
*
|
|
* Helper functions for Rockchip images
|
|
*/
|
|
|
|
#include "imagetool.h"
|
|
#include <image.h>
|
|
#include <rc4.h>
|
|
#include "mkimage.h"
|
|
#include "rkcommon.h"
|
|
|
|
enum {
|
|
RK_SIGNATURE = 0x0ff0aa55,
|
|
};
|
|
|
|
/**
|
|
* struct header0_info - header block for boot ROM
|
|
*
|
|
* This is stored at SD card block 64 (where each block is 512 bytes, or at
|
|
* the start of SPI flash. It is encoded with RC4.
|
|
*
|
|
* @signature: Signature (must be RKSD_SIGNATURE)
|
|
* @disable_rc4: 0 to use rc4 for boot image, 1 to use plain binary
|
|
* @init_offset: Offset in blocks of the SPL code from this header
|
|
* block. E.g. 4 means 2KB after the start of this header.
|
|
* Other fields are not used by U-Boot
|
|
*/
|
|
struct header0_info {
|
|
uint32_t signature;
|
|
uint8_t reserved[4];
|
|
uint32_t disable_rc4;
|
|
uint16_t init_offset;
|
|
uint8_t reserved1[492];
|
|
uint16_t init_size;
|
|
uint16_t init_boot_size;
|
|
uint8_t reserved2[2];
|
|
};
|
|
|
|
/**
|
|
* struct header1_info
|
|
*/
|
|
struct header1_info {
|
|
uint32_t magic;
|
|
};
|
|
|
|
/**
|
|
* struct spl_info - spl info for each chip
|
|
*
|
|
* @imagename: Image name(passed by "mkimage -n")
|
|
* @spl_hdr: Boot ROM requires a 4-bytes spl header
|
|
* @spl_size: Spl size(include extra 4-bytes spl header)
|
|
* @spl_rc4: RC4 encode the SPL binary (same key as header)
|
|
*/
|
|
|
|
struct spl_info {
|
|
const char *imagename;
|
|
const char *spl_hdr;
|
|
const uint32_t spl_size;
|
|
const bool spl_rc4;
|
|
};
|
|
|
|
static struct spl_info spl_infos[] = {
|
|
{ "px30", "RK33", 0x2800, false },
|
|
{ "rk3036", "RK30", 0x1000, false },
|
|
{ "rk3128", "RK31", 0x1800, false },
|
|
{ "rk3188", "RK31", 0x8000 - 0x800, true },
|
|
{ "rk322x", "RK32", 0x8000 - 0x1000, false },
|
|
{ "rk3288", "RK32", 0x8000, false },
|
|
{ "rk3308", "RK33", 0x40000 - 0x1000, false},
|
|
{ "rk3328", "RK32", 0x8000 - 0x1000, false },
|
|
{ "rk3368", "RK33", 0x8000 - 0x1000, false },
|
|
{ "rk3399", "RK33", 0x30000 - 0x2000, false },
|
|
{ "rv1108", "RK11", 0x1800, false },
|
|
};
|
|
|
|
/**
|
|
* struct spl_params - spl params parsed in check_params()
|
|
*
|
|
* @init_file: Init data file path
|
|
* @init_size: Aligned size of init data in bytes
|
|
* @boot_file: Boot data file path
|
|
* @boot_size: Aligned size of boot data in bytes
|
|
*/
|
|
|
|
struct spl_params {
|
|
char *init_file;
|
|
uint32_t init_size;
|
|
char *boot_file;
|
|
uint32_t boot_size;
|
|
};
|
|
|
|
static struct spl_params spl_params = { 0 };
|
|
|
|
static unsigned char rc4_key[16] = {
|
|
124, 78, 3, 4, 85, 5, 9, 7,
|
|
45, 44, 123, 56, 23, 13, 23, 17
|
|
};
|
|
|
|
static struct spl_info *rkcommon_get_spl_info(char *imagename)
|
|
{
|
|
int i;
|
|
|
|
if (!imagename)
|
|
return NULL;
|
|
|
|
for (i = 0; i < ARRAY_SIZE(spl_infos); i++)
|
|
if (!strncmp(imagename, spl_infos[i].imagename, 6))
|
|
return spl_infos + i;
|
|
|
|
return NULL;
|
|
}
|
|
|
|
static int rkcommon_get_aligned_size(struct image_tool_params *params,
|
|
const char *fname)
|
|
{
|
|
int size;
|
|
|
|
size = imagetool_get_filesize(params, fname);
|
|
if (size < 0)
|
|
return -1;
|
|
|
|
/*
|
|
* Pad to a 2KB alignment, as required for init/boot size by the ROM
|
|
* (see https://lists.denx.de/pipermail/u-boot/2017-May/293268.html)
|
|
*/
|
|
return ROUND(size, RK_SIZE_ALIGN);
|
|
}
|
|
|
|
int rkcommon_check_params(struct image_tool_params *params)
|
|
{
|
|
int i, size;
|
|
|
|
/*
|
|
* If this is a operation (list or extract), the don't require
|
|
* imagename to be set.
|
|
*/
|
|
if (params->lflag || params->iflag)
|
|
return EXIT_SUCCESS;
|
|
|
|
if (!rkcommon_get_spl_info(params->imagename))
|
|
goto err_spl_info;
|
|
|
|
spl_params.init_file = params->datafile;
|
|
|
|
spl_params.boot_file = strchr(spl_params.init_file, ':');
|
|
if (spl_params.boot_file) {
|
|
*spl_params.boot_file = '\0';
|
|
spl_params.boot_file += 1;
|
|
}
|
|
|
|
size = rkcommon_get_aligned_size(params, spl_params.init_file);
|
|
if (size < 0)
|
|
return EXIT_FAILURE;
|
|
spl_params.init_size = size;
|
|
|
|
/* Boot file is optional, and only for back-to-bootrom functionality. */
|
|
if (spl_params.boot_file) {
|
|
size = rkcommon_get_aligned_size(params, spl_params.boot_file);
|
|
if (size < 0)
|
|
return EXIT_FAILURE;
|
|
spl_params.boot_size = size;
|
|
}
|
|
|
|
if (spl_params.init_size > rkcommon_get_spl_size(params)) {
|
|
fprintf(stderr,
|
|
"Error: SPL image is too large (size %#x than %#x)\n",
|
|
spl_params.init_size, rkcommon_get_spl_size(params));
|
|
return EXIT_FAILURE;
|
|
}
|
|
|
|
return EXIT_SUCCESS;
|
|
|
|
err_spl_info:
|
|
fprintf(stderr, "ERROR: imagename (%s) is not supported!\n",
|
|
params->imagename ? params->imagename : "NULL");
|
|
|
|
fprintf(stderr, "Available imagename:");
|
|
for (i = 0; i < ARRAY_SIZE(spl_infos); i++)
|
|
fprintf(stderr, "\t%s", spl_infos[i].imagename);
|
|
fprintf(stderr, "\n");
|
|
|
|
return EXIT_FAILURE;
|
|
}
|
|
|
|
const char *rkcommon_get_spl_hdr(struct image_tool_params *params)
|
|
{
|
|
struct spl_info *info = rkcommon_get_spl_info(params->imagename);
|
|
|
|
/*
|
|
* info would not be NULL, because of we checked params before.
|
|
*/
|
|
return info->spl_hdr;
|
|
}
|
|
|
|
|
|
int rkcommon_get_spl_size(struct image_tool_params *params)
|
|
{
|
|
struct spl_info *info = rkcommon_get_spl_info(params->imagename);
|
|
|
|
/*
|
|
* info would not be NULL, because of we checked params before.
|
|
*/
|
|
return info->spl_size;
|
|
}
|
|
|
|
bool rkcommon_need_rc4_spl(struct image_tool_params *params)
|
|
{
|
|
struct spl_info *info = rkcommon_get_spl_info(params->imagename);
|
|
|
|
/*
|
|
* info would not be NULL, because of we checked params before.
|
|
*/
|
|
return info->spl_rc4;
|
|
}
|
|
|
|
static void rkcommon_set_header0(void *buf, struct image_tool_params *params)
|
|
{
|
|
struct header0_info *hdr = buf;
|
|
uint32_t init_boot_size;
|
|
|
|
memset(buf, '\0', RK_INIT_OFFSET * RK_BLK_SIZE);
|
|
hdr->signature = cpu_to_le32(RK_SIGNATURE);
|
|
hdr->disable_rc4 = cpu_to_le32(!rkcommon_need_rc4_spl(params));
|
|
hdr->init_offset = cpu_to_le16(RK_INIT_OFFSET);
|
|
hdr->init_size = cpu_to_le16(spl_params.init_size / RK_BLK_SIZE);
|
|
|
|
/*
|
|
* init_boot_size needs to be set, as it is read by the BootROM
|
|
* to determine the size of the next-stage bootloader (e.g. U-Boot
|
|
* proper), when used with the back-to-bootrom functionality.
|
|
*
|
|
* see https://lists.denx.de/pipermail/u-boot/2017-May/293267.html
|
|
* for a more detailed explanation by Andy Yan
|
|
*/
|
|
if (spl_params.boot_file)
|
|
init_boot_size = spl_params.init_size + spl_params.boot_size;
|
|
else
|
|
init_boot_size = spl_params.init_size + RK_MAX_BOOT_SIZE;
|
|
hdr->init_boot_size = cpu_to_le16(init_boot_size / RK_BLK_SIZE);
|
|
|
|
rc4_encode(buf, RK_BLK_SIZE, rc4_key);
|
|
}
|
|
|
|
void rkcommon_set_header(void *buf, struct stat *sbuf, int ifd,
|
|
struct image_tool_params *params)
|
|
{
|
|
struct header1_info *hdr = buf + RK_SPL_HDR_START;
|
|
|
|
rkcommon_set_header0(buf, params);
|
|
|
|
/* Set up the SPL name (i.e. copy spl_hdr over) */
|
|
memcpy(&hdr->magic, rkcommon_get_spl_hdr(params), RK_SPL_HDR_SIZE);
|
|
|
|
if (rkcommon_need_rc4_spl(params))
|
|
rkcommon_rc4_encode_spl(buf, RK_SPL_HDR_START,
|
|
spl_params.init_size);
|
|
|
|
if (spl_params.boot_file) {
|
|
if (rkcommon_need_rc4_spl(params))
|
|
rkcommon_rc4_encode_spl(buf + RK_SPL_HDR_START,
|
|
spl_params.init_size,
|
|
spl_params.boot_size);
|
|
}
|
|
}
|
|
|
|
static inline unsigned rkcommon_offset_to_spi(unsigned offset)
|
|
{
|
|
/*
|
|
* While SD/MMC images use a flat addressing, SPI images are padded
|
|
* to use the first 2K of every 4K sector only.
|
|
*/
|
|
return ((offset & ~0x7ff) << 1) + (offset & 0x7ff);
|
|
}
|
|
|
|
static int rkcommon_parse_header(const void *buf, struct header0_info *header0,
|
|
struct spl_info **spl_info)
|
|
{
|
|
unsigned hdr1_offset;
|
|
struct header1_info *hdr1_sdmmc, *hdr1_spi;
|
|
int i;
|
|
|
|
if (spl_info)
|
|
*spl_info = NULL;
|
|
|
|
/*
|
|
* The first header (hdr0) is always RC4 encoded, so try to decrypt
|
|
* with the well-known key.
|
|
*/
|
|
memcpy((void *)header0, buf, sizeof(struct header0_info));
|
|
rc4_encode((void *)header0, sizeof(struct header0_info), rc4_key);
|
|
|
|
if (le32_to_cpu(header0->signature) != RK_SIGNATURE)
|
|
return -EPROTO;
|
|
|
|
/* We don't support RC4 encoded image payloads here, yet... */
|
|
if (le32_to_cpu(header0->disable_rc4) == 0)
|
|
return -ENOSYS;
|
|
|
|
hdr1_offset = le16_to_cpu(header0->init_offset) * RK_BLK_SIZE;
|
|
hdr1_sdmmc = (struct header1_info *)(buf + hdr1_offset);
|
|
hdr1_spi = (struct header1_info *)(buf +
|
|
rkcommon_offset_to_spi(hdr1_offset));
|
|
|
|
for (i = 0; i < ARRAY_SIZE(spl_infos); i++) {
|
|
if (!memcmp(&hdr1_sdmmc->magic, spl_infos[i].spl_hdr,
|
|
RK_SPL_HDR_SIZE)) {
|
|
if (spl_info)
|
|
*spl_info = &spl_infos[i];
|
|
return IH_TYPE_RKSD;
|
|
} else if (!memcmp(&hdr1_spi->magic, spl_infos[i].spl_hdr,
|
|
RK_SPL_HDR_SIZE)) {
|
|
if (spl_info)
|
|
*spl_info = &spl_infos[i];
|
|
return IH_TYPE_RKSPI;
|
|
}
|
|
}
|
|
|
|
return -1;
|
|
}
|
|
|
|
int rkcommon_verify_header(unsigned char *buf, int size,
|
|
struct image_tool_params *params)
|
|
{
|
|
struct header0_info header0;
|
|
struct spl_info *img_spl_info, *spl_info;
|
|
int ret;
|
|
|
|
ret = rkcommon_parse_header(buf, &header0, &img_spl_info);
|
|
|
|
/* If this is the (unimplemented) RC4 case, then rewrite the result */
|
|
if (ret == -ENOSYS)
|
|
return 0;
|
|
|
|
if (ret < 0)
|
|
return ret;
|
|
|
|
/*
|
|
* If no 'imagename' is specified via the commandline (e.g. if this is
|
|
* 'dumpimage -l' w/o any further constraints), we accept any spl_info.
|
|
*/
|
|
if (params->imagename == NULL)
|
|
return 0;
|
|
|
|
/* Match the 'imagename' against the 'spl_hdr' found */
|
|
spl_info = rkcommon_get_spl_info(params->imagename);
|
|
if (spl_info && img_spl_info)
|
|
return strcmp(spl_info->spl_hdr, img_spl_info->spl_hdr);
|
|
|
|
return -ENOENT;
|
|
}
|
|
|
|
void rkcommon_print_header(const void *buf)
|
|
{
|
|
struct header0_info header0;
|
|
struct spl_info *spl_info;
|
|
uint8_t image_type;
|
|
int ret, boot_size, init_size;
|
|
|
|
ret = rkcommon_parse_header(buf, &header0, &spl_info);
|
|
|
|
/* If this is the (unimplemented) RC4 case, then fail silently */
|
|
if (ret == -ENOSYS)
|
|
return;
|
|
|
|
if (ret < 0) {
|
|
fprintf(stderr, "Error: image verification failed\n");
|
|
return;
|
|
}
|
|
|
|
image_type = ret;
|
|
|
|
printf("Image Type: Rockchip %s (%s) boot image\n",
|
|
spl_info->spl_hdr,
|
|
(image_type == IH_TYPE_RKSD) ? "SD/MMC" : "SPI");
|
|
init_size = le16_to_cpu(header0.init_size) * RK_BLK_SIZE;
|
|
printf("Init Data Size: %d bytes\n", init_size);
|
|
|
|
boot_size = le16_to_cpu(header0.init_boot_size) * RK_BLK_SIZE - init_size;
|
|
if (boot_size != RK_MAX_BOOT_SIZE)
|
|
printf("Boot Data Size: %d bytes\n", boot_size);
|
|
}
|
|
|
|
void rkcommon_rc4_encode_spl(void *buf, unsigned int offset, unsigned int size)
|
|
{
|
|
unsigned int remaining = size;
|
|
|
|
while (remaining > 0) {
|
|
int step = (remaining > RK_BLK_SIZE) ? RK_BLK_SIZE : remaining;
|
|
|
|
rc4_encode(buf + offset, step, rc4_key);
|
|
offset += RK_BLK_SIZE;
|
|
remaining -= step;
|
|
}
|
|
}
|
|
|
|
int rkcommon_vrec_header(struct image_tool_params *params,
|
|
struct image_type_params *tparams)
|
|
{
|
|
/*
|
|
* The SPL image looks as follows:
|
|
*
|
|
* 0x0 header0 (see rkcommon.c)
|
|
* 0x800 spl_name ('RK30', ..., 'RK33')
|
|
* (start of the payload for AArch64 payloads: we expect the
|
|
* first 4 bytes to be available for overwriting with our
|
|
* spl_name)
|
|
* 0x804 first instruction to be executed
|
|
* (start of the image/payload for 32bit payloads)
|
|
*
|
|
* For AArch64 (ARMv8) payloads, natural alignment (8-bytes) is
|
|
* required for its sections (so the image we receive needs to
|
|
* have the first 4 bytes reserved for the spl_name). Reserving
|
|
* these 4 bytes is done using the BOOT0_HOOK infrastructure.
|
|
*
|
|
* The header is always at 0x800 (as we now use a payload
|
|
* prepadded using the boot0 hook for all targets): the first
|
|
* 4 bytes of these images can safely be overwritten using the
|
|
* boot magic.
|
|
*/
|
|
tparams->header_size = RK_SPL_HDR_START;
|
|
|
|
/* Allocate, clear and install the header */
|
|
tparams->hdr = malloc(tparams->header_size);
|
|
if (!tparams->hdr) {
|
|
fprintf(stderr, "%s: Can't alloc header: %s\n",
|
|
params->cmdname, strerror(errno));
|
|
exit(EXIT_FAILURE);
|
|
}
|
|
memset(tparams->hdr, 0, tparams->header_size);
|
|
|
|
/*
|
|
* We need to store the original file-size (i.e. before padding), as
|
|
* imagetool does not set this during its adjustment of file_size.
|
|
*/
|
|
params->orig_file_size = tparams->header_size +
|
|
spl_params.init_size + spl_params.boot_size;
|
|
|
|
params->file_size = ROUND(params->orig_file_size, RK_SIZE_ALIGN);
|
|
|
|
/* Ignoring pad len, since we are using our own copy_image() */
|
|
return 0;
|
|
}
|
|
|
|
static int pad_file(struct image_tool_params *params, int ifd, int pad)
|
|
{
|
|
uint8_t zeros[4096];
|
|
|
|
memset(zeros, 0, sizeof(zeros));
|
|
|
|
while (pad > 0) {
|
|
int todo = sizeof(zeros);
|
|
|
|
if (todo > pad)
|
|
todo = pad;
|
|
if (write(ifd, (char *)&zeros, todo) != todo) {
|
|
fprintf(stderr, "%s: Write error on %s: %s\n",
|
|
params->cmdname, params->imagefile,
|
|
strerror(errno));
|
|
return -1;
|
|
}
|
|
pad -= todo;
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int copy_file(struct image_tool_params *params, int ifd,
|
|
const char *file, int padded_size)
|
|
{
|
|
int dfd;
|
|
struct stat sbuf;
|
|
unsigned char *ptr;
|
|
int size;
|
|
|
|
if (params->vflag)
|
|
fprintf(stderr, "Adding Image %s\n", file);
|
|
|
|
dfd = open(file, O_RDONLY | O_BINARY);
|
|
if (dfd < 0) {
|
|
fprintf(stderr, "%s: Can't open %s: %s\n",
|
|
params->cmdname, file, strerror(errno));
|
|
return -1;
|
|
}
|
|
|
|
if (fstat(dfd, &sbuf) < 0) {
|
|
fprintf(stderr, "%s: Can't stat %s: %s\n",
|
|
params->cmdname, file, strerror(errno));
|
|
goto err_close;
|
|
}
|
|
|
|
if (params->vflag)
|
|
fprintf(stderr, "Size %u(pad to %u)\n",
|
|
(int)sbuf.st_size, padded_size);
|
|
|
|
ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, dfd, 0);
|
|
if (ptr == MAP_FAILED) {
|
|
fprintf(stderr, "%s: Can't read %s: %s\n",
|
|
params->cmdname, file, strerror(errno));
|
|
goto err_munmap;
|
|
}
|
|
|
|
size = sbuf.st_size;
|
|
if (write(ifd, ptr, size) != size) {
|
|
fprintf(stderr, "%s: Write error on %s: %s\n",
|
|
params->cmdname, params->imagefile, strerror(errno));
|
|
goto err_munmap;
|
|
}
|
|
|
|
munmap((void *)ptr, sbuf.st_size);
|
|
close(dfd);
|
|
return pad_file(params, ifd, padded_size - size);
|
|
|
|
err_munmap:
|
|
munmap((void *)ptr, sbuf.st_size);
|
|
err_close:
|
|
close(dfd);
|
|
return -1;
|
|
}
|
|
|
|
int rockchip_copy_image(int ifd, struct image_tool_params *params)
|
|
{
|
|
int ret;
|
|
|
|
ret = copy_file(params, ifd, spl_params.init_file,
|
|
spl_params.init_size);
|
|
if (ret)
|
|
return ret;
|
|
|
|
if (spl_params.boot_file) {
|
|
ret = copy_file(params, ifd, spl_params.boot_file,
|
|
spl_params.boot_size);
|
|
if (ret)
|
|
return ret;
|
|
}
|
|
|
|
return pad_file(params, ifd,
|
|
params->file_size - params->orig_file_size);
|
|
}
|