blob: 6cdb749c4ca80018898b038d870817f26c08d9f3 [file] [log] [blame]
Simon Glassa131c1f2015-08-30 16:55:24 -06001/*
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
16enum {
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
Jeffy Chen36413392015-11-17 14:20:30 +080028 * @init_offset: Offset in blocks of the SPL code from this header
Simon Glassa131c1f2015-08-30 16:55:24 -060029 * block. E.g. 4 means 2KB after the start of this header.
30 * Other fields are not used by U-Boot
31 */
32struct header0_info {
33 uint32_t signature;
34 uint8_t reserved[4];
35 uint32_t disable_rc4;
Jeffy Chen36413392015-11-17 14:20:30 +080036 uint16_t init_offset;
37 uint8_t reserved1[492];
38 uint16_t init_size;
39 uint16_t init_boot_size;
Simon Glassa131c1f2015-08-30 16:55:24 -060040 uint8_t reserved2[2];
41};
42
Jeffy Chen7bf274b2015-11-27 12:07:17 +080043/**
Philipp Tomsich111bcc42017-03-15 12:08:43 +010044 * struct header1_info
45 */
46struct header1_info {
47 uint32_t magic;
Philipp Tomsich111bcc42017-03-15 12:08:43 +010048};
49
50/**
Jeffy Chen7bf274b2015-11-27 12:07:17 +080051 * struct spl_info - spl info for each chip
52 *
53 * @imagename: Image name(passed by "mkimage -n")
54 * @spl_hdr: Boot ROM requires a 4-bytes spl header
55 * @spl_size: Spl size(include extra 4-bytes spl header)
Heiko Stübnercfbcdad2017-02-18 19:46:27 +010056 * @spl_rc4: RC4 encode the SPL binary (same key as header)
Philipp Tomsich30827752017-03-15 12:08:45 +010057 * @spl_boot0: A new-style (ARM_SOC_BOOT0_HOOK) image that should
58 * have the boot magic (e.g. 'RK33') written to its first
59 * word.
Jeffy Chen7bf274b2015-11-27 12:07:17 +080060 */
Philipp Tomsich111bcc42017-03-15 12:08:43 +010061
Jeffy Chen7bf274b2015-11-27 12:07:17 +080062struct spl_info {
63 const char *imagename;
64 const char *spl_hdr;
65 const uint32_t spl_size;
Heiko Stübnercfbcdad2017-02-18 19:46:27 +010066 const bool spl_rc4;
Philipp Tomsich30827752017-03-15 12:08:45 +010067 const bool spl_boot0;
Jeffy Chen7bf274b2015-11-27 12:07:17 +080068};
69
70static struct spl_info spl_infos[] = {
Philipp Tomsich111bcc42017-03-15 12:08:43 +010071 { "rk3036", "RK30", 0x1000, false, false },
72 { "rk3188", "RK31", 0x8000 - 0x800, true, false },
73 { "rk3288", "RK32", 0x8000, false, false },
74 { "rk3399", "RK33", 0x20000, false, true },
Jeffy Chen7bf274b2015-11-27 12:07:17 +080075};
76
Simon Glassa131c1f2015-08-30 16:55:24 -060077static unsigned char rc4_key[16] = {
78 124, 78, 3, 4, 85, 5, 9, 7,
79 45, 44, 123, 56, 23, 13, 23, 17
80};
81
Jeffy Chen7bf274b2015-11-27 12:07:17 +080082static struct spl_info *rkcommon_get_spl_info(char *imagename)
83{
84 int i;
85
86 for (i = 0; i < ARRAY_SIZE(spl_infos); i++)
87 if (!strncmp(imagename, spl_infos[i].imagename, 6))
88 return spl_infos + i;
89
90 return NULL;
91}
92
93int rkcommon_check_params(struct image_tool_params *params)
94{
95 int i;
96
97 if (rkcommon_get_spl_info(params->imagename) != NULL)
98 return 0;
99
100 fprintf(stderr, "ERROR: imagename (%s) is not supported!\n",
101 strlen(params->imagename) > 0 ? params->imagename : "NULL");
102
103 fprintf(stderr, "Available imagename:");
104 for (i = 0; i < ARRAY_SIZE(spl_infos); i++)
105 fprintf(stderr, "\t%s", spl_infos[i].imagename);
106 fprintf(stderr, "\n");
107
108 return -1;
109}
110
111const char *rkcommon_get_spl_hdr(struct image_tool_params *params)
112{
113 struct spl_info *info = rkcommon_get_spl_info(params->imagename);
114
115 /*
116 * info would not be NULL, because of we checked params before.
117 */
118 return info->spl_hdr;
119}
120
Philipp Tomsich111bcc42017-03-15 12:08:43 +0100121
Jeffy Chen7bf274b2015-11-27 12:07:17 +0800122int rkcommon_get_spl_size(struct image_tool_params *params)
123{
124 struct spl_info *info = rkcommon_get_spl_info(params->imagename);
125
126 /*
127 * info would not be NULL, because of we checked params before.
128 */
129 return info->spl_size;
130}
131
Heiko Stübnercfbcdad2017-02-18 19:46:27 +0100132bool rkcommon_need_rc4_spl(struct image_tool_params *params)
133{
134 struct spl_info *info = rkcommon_get_spl_info(params->imagename);
135
136 /*
137 * info would not be NULL, because of we checked params before.
138 */
139 return info->spl_rc4;
140}
141
Philipp Tomsich30827752017-03-15 12:08:45 +0100142bool rkcommon_spl_is_boot0(struct image_tool_params *params)
143{
144 struct spl_info *info = rkcommon_get_spl_info(params->imagename);
145
146 /*
147 * info would not be NULL, because of we checked params before.
148 */
149 return info->spl_boot0;
150}
151
Philipp Tomsich111bcc42017-03-15 12:08:43 +0100152static void rkcommon_set_header0(void *buf, uint file_size,
153 struct image_tool_params *params)
Simon Glassa131c1f2015-08-30 16:55:24 -0600154{
Philipp Tomsich111bcc42017-03-15 12:08:43 +0100155 struct header0_info *hdr = buf;
Simon Glassa131c1f2015-08-30 16:55:24 -0600156
Philipp Tomsich111bcc42017-03-15 12:08:43 +0100157 memset(buf, '\0', RK_INIT_OFFSET * RK_BLK_SIZE);
Simon Glassa131c1f2015-08-30 16:55:24 -0600158 hdr->signature = RK_SIGNATURE;
Heiko Stübnercfbcdad2017-02-18 19:46:27 +0100159 hdr->disable_rc4 = !rkcommon_need_rc4_spl(params);
Jeffy Chen36413392015-11-17 14:20:30 +0800160 hdr->init_offset = RK_INIT_OFFSET;
Simon Glassa131c1f2015-08-30 16:55:24 -0600161
Jeffy Chen36413392015-11-17 14:20:30 +0800162 hdr->init_size = (file_size + RK_BLK_SIZE - 1) / RK_BLK_SIZE;
163 hdr->init_size = (hdr->init_size + 3) & ~3;
164 hdr->init_boot_size = hdr->init_size + RK_MAX_BOOT_SIZE / RK_BLK_SIZE;
Simon Glassa131c1f2015-08-30 16:55:24 -0600165
166 rc4_encode(buf, RK_BLK_SIZE, rc4_key);
Philipp Tomsich111bcc42017-03-15 12:08:43 +0100167}
168
169int rkcommon_set_header(void *buf, uint file_size,
170 struct image_tool_params *params)
171{
172 struct header1_info *hdr = buf + RK_SPL_HDR_START;
173
174 if (file_size > rkcommon_get_spl_size(params))
175 return -ENOSPC;
176
177 rkcommon_set_header0(buf, file_size, params);
178
179 /* Set up the SPL name and add the AArch64 'nop' padding, if needed */
180 memcpy(&hdr->magic, rkcommon_get_spl_hdr(params), RK_SPL_HDR_SIZE);
181
Philipp Tomsich111bcc42017-03-15 12:08:43 +0100182 if (rkcommon_need_rc4_spl(params))
183 rkcommon_rc4_encode_spl(buf, RK_SPL_HDR_START,
184 params->file_size - RK_SPL_HDR_START);
Simon Glassa131c1f2015-08-30 16:55:24 -0600185
186 return 0;
187}
Heiko Stübnercfbcdad2017-02-18 19:46:27 +0100188
189void rkcommon_rc4_encode_spl(void *buf, unsigned int offset, unsigned int size)
190{
191 unsigned int remaining = size;
192
193 while (remaining > 0) {
194 int step = (remaining > RK_BLK_SIZE) ? RK_BLK_SIZE : remaining;
195
196 rc4_encode(buf + offset, step, rc4_key);
197 offset += RK_BLK_SIZE;
198 remaining -= step;
199 }
200}
Philipp Tomsich111bcc42017-03-15 12:08:43 +0100201
202void rkcommon_vrec_header(struct image_tool_params *params,
203 struct image_type_params *tparams)
204{
205 /*
206 * The SPL image looks as follows:
207 *
208 * 0x0 header0 (see rkcommon.c)
209 * 0x800 spl_name ('RK30', ..., 'RK33')
210 * 0x804 first instruction to be executed
211 * (image start for AArch32, 'nop' for AArch64))
212 * 0x808 second instruction to be executed
213 * (image start for AArch64)
214 *
215 * For AArch64 (ARMv8) payloads, we receive an input file that
216 * needs to start on an 8-byte boundary (natural alignment), so
217 * we need to put a NOP at 0x804.
218 *
219 * Depending on this, the header is either 0x804 or 0x808 bytes
220 * in length.
221 */
Philipp Tomsich30827752017-03-15 12:08:45 +0100222 if (rkcommon_spl_is_boot0(params))
223 tparams->header_size = RK_SPL_HDR_START;
Philipp Tomsich111bcc42017-03-15 12:08:43 +0100224 else
225 tparams->header_size = RK_SPL_HDR_START + 4;
226
227 /* Allocate, clear and install the header */
228 tparams->hdr = malloc(tparams->header_size);
229 memset(tparams->hdr, 0, tparams->header_size);
230 tparams->header_size = tparams->header_size;
231}