]>
git.ipfire.org Git - thirdparty/u-boot.git/blob - tools/rkcommon.c
2 * (C) Copyright 2015 Google, Inc
3 * Written by Simon Glass <sjg@chromium.org>
5 * (C) 2017 Theobroma Systems Design und Consulting GmbH
7 * SPDX-License-Identifier: GPL-2.0+
9 * Helper functions for Rockchip images
12 #include "imagetool.h"
18 #define DIV_ROUND_UP(n, d) (((n) + (d) - 1) / (d))
21 RK_SIGNATURE
= 0x0ff0aa55,
25 * struct header0_info - header block for boot ROM
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.
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
41 uint8_t reserved1
[492];
43 uint16_t init_boot_size
;
55 * struct spl_info - spl info for each chip
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
67 const char *imagename
;
69 const uint32_t spl_size
;
74 static struct spl_info spl_infos
[] = {
75 { "rk3036", "RK30", 0x1000, false, false },
76 { "rk3188", "RK31", 0x8000 - 0x800, true, false },
77 { "rk322x", "RK32", 0x8000 - 0x1000, false, false },
78 { "rk3288", "RK32", 0x8000, false, false },
79 { "rk3328", "RK32", 0x8000 - 0x1000, false, false },
80 { "rk3368", "RK33", 0x8000 - 0x1000, false, true },
81 { "rk3399", "RK33", 0x30000 - 0x2000, false, true },
82 { "rv1108", "RK11", 0x1800, false, false},
85 static unsigned char rc4_key
[16] = {
86 124, 78, 3, 4, 85, 5, 9, 7,
87 45, 44, 123, 56, 23, 13, 23, 17
90 static struct spl_info
*rkcommon_get_spl_info(char *imagename
)
97 for (i
= 0; i
< ARRAY_SIZE(spl_infos
); i
++)
98 if (!strncmp(imagename
, spl_infos
[i
].imagename
, 6))
104 int rkcommon_check_params(struct image_tool_params
*params
)
108 if (rkcommon_get_spl_info(params
->imagename
) != NULL
)
112 * If this is a operation (list or extract), the don't require
113 * imagename to be set.
115 if (params
->lflag
|| params
->iflag
)
118 fprintf(stderr
, "ERROR: imagename (%s) is not supported!\n",
119 params
->imagename
? params
->imagename
: "NULL");
121 fprintf(stderr
, "Available imagename:");
122 for (i
= 0; i
< ARRAY_SIZE(spl_infos
); i
++)
123 fprintf(stderr
, "\t%s", spl_infos
[i
].imagename
);
124 fprintf(stderr
, "\n");
129 const char *rkcommon_get_spl_hdr(struct image_tool_params
*params
)
131 struct spl_info
*info
= rkcommon_get_spl_info(params
->imagename
);
134 * info would not be NULL, because of we checked params before.
136 return info
->spl_hdr
;
140 int rkcommon_get_spl_size(struct image_tool_params
*params
)
142 struct spl_info
*info
= rkcommon_get_spl_info(params
->imagename
);
145 * info would not be NULL, because of we checked params before.
147 return info
->spl_size
;
150 bool rkcommon_need_rc4_spl(struct image_tool_params
*params
)
152 struct spl_info
*info
= rkcommon_get_spl_info(params
->imagename
);
155 * info would not be NULL, because of we checked params before.
157 return info
->spl_rc4
;
160 bool rkcommon_spl_is_boot0(struct image_tool_params
*params
)
162 struct spl_info
*info
= rkcommon_get_spl_info(params
->imagename
);
165 * info would not be NULL, because of we checked params before.
167 return info
->spl_boot0
;
170 static void rkcommon_set_header0(void *buf
, uint file_size
,
171 struct image_tool_params
*params
)
173 struct header0_info
*hdr
= buf
;
175 memset(buf
, '\0', RK_INIT_OFFSET
* RK_BLK_SIZE
);
176 hdr
->signature
= RK_SIGNATURE
;
177 hdr
->disable_rc4
= !rkcommon_need_rc4_spl(params
);
178 hdr
->init_offset
= RK_INIT_OFFSET
;
180 hdr
->init_size
= DIV_ROUND_UP(file_size
, RK_BLK_SIZE
);
182 * The init_size has to be a multiple of 4 blocks (i.e. of 2K)
183 * or the BootROM will not boot the image.
185 * Note: To verify that this is not a legacy constraint, we
186 * rechecked this against the RK3399 BootROM.
188 hdr
->init_size
= ROUND(hdr
->init_size
, 4);
190 * init_boot_size needs to be set, as it is read by the BootROM
191 * to determine the size of the next-stage bootloader (e.g. U-Boot
192 * proper), when used with the back-to-bootrom functionality.
194 * see https://lists.denx.de/pipermail/u-boot/2017-May/293267.html
195 * for a more detailed explanation by Andy Yan
197 hdr
->init_boot_size
= hdr
->init_size
+ RK_MAX_BOOT_SIZE
/ RK_BLK_SIZE
;
199 rc4_encode(buf
, RK_BLK_SIZE
, rc4_key
);
202 int rkcommon_set_header(void *buf
, uint file_size
,
203 struct image_tool_params
*params
)
205 struct header1_info
*hdr
= buf
+ RK_SPL_HDR_START
;
207 if (file_size
> rkcommon_get_spl_size(params
))
210 rkcommon_set_header0(buf
, file_size
, params
);
212 /* Set up the SPL name (i.e. copy spl_hdr over) */
213 memcpy(&hdr
->magic
, rkcommon_get_spl_hdr(params
), RK_SPL_HDR_SIZE
);
215 if (rkcommon_need_rc4_spl(params
))
216 rkcommon_rc4_encode_spl(buf
, RK_SPL_HDR_START
,
217 params
->file_size
- RK_SPL_HDR_START
);
222 static inline unsigned rkcommon_offset_to_spi(unsigned offset
)
225 * While SD/MMC images use a flat addressing, SPI images are padded
226 * to use the first 2K of every 4K sector only.
228 return ((offset
& ~0x7ff) << 1) + (offset
& 0x7ff);
231 static int rkcommon_parse_header(const void *buf
, struct header0_info
*header0
,
232 struct spl_info
**spl_info
)
234 unsigned hdr1_offset
;
235 struct header1_info
*hdr1_sdmmc
, *hdr1_spi
;
242 * The first header (hdr0) is always RC4 encoded, so try to decrypt
243 * with the well-known key.
245 memcpy((void *)header0
, buf
, sizeof(struct header0_info
));
246 rc4_encode((void *)header0
, sizeof(struct header0_info
), rc4_key
);
248 if (header0
->signature
!= RK_SIGNATURE
)
251 /* We don't support RC4 encoded image payloads here, yet... */
252 if (header0
->disable_rc4
== 0)
255 hdr1_offset
= header0
->init_offset
* RK_BLK_SIZE
;
256 hdr1_sdmmc
= (struct header1_info
*)(buf
+ hdr1_offset
);
257 hdr1_spi
= (struct header1_info
*)(buf
+
258 rkcommon_offset_to_spi(hdr1_offset
));
260 for (i
= 0; i
< ARRAY_SIZE(spl_infos
); i
++) {
261 if (!memcmp(&hdr1_sdmmc
->magic
, spl_infos
[i
].spl_hdr
, 4)) {
263 *spl_info
= &spl_infos
[i
];
265 } else if (!memcmp(&hdr1_spi
->magic
, spl_infos
[i
].spl_hdr
, 4)) {
267 *spl_info
= &spl_infos
[i
];
268 return IH_TYPE_RKSPI
;
275 int rkcommon_verify_header(unsigned char *buf
, int size
,
276 struct image_tool_params
*params
)
278 struct header0_info header0
;
279 struct spl_info
*img_spl_info
, *spl_info
;
282 ret
= rkcommon_parse_header(buf
, &header0
, &img_spl_info
);
284 /* If this is the (unimplemented) RC4 case, then rewrite the result */
292 * If no 'imagename' is specified via the commandline (e.g. if this is
293 * 'dumpimage -l' w/o any further constraints), we accept any spl_info.
295 if (params
->imagename
== NULL
)
298 /* Match the 'imagename' against the 'spl_hdr' found */
299 spl_info
= rkcommon_get_spl_info(params
->imagename
);
300 if (spl_info
&& img_spl_info
)
301 return strcmp(spl_info
->spl_hdr
, img_spl_info
->spl_hdr
);
306 void rkcommon_print_header(const void *buf
)
308 struct header0_info header0
;
309 struct spl_info
*spl_info
;
313 ret
= rkcommon_parse_header(buf
, &header0
, &spl_info
);
315 /* If this is the (unimplemented) RC4 case, then fail silently */
320 fprintf(stderr
, "Error: image verification failed\n");
326 printf("Image Type: Rockchip %s (%s) boot image\n",
328 (image_type
== IH_TYPE_RKSD
) ? "SD/MMC" : "SPI");
329 printf("Data Size: %d bytes\n", header0
.init_size
* RK_BLK_SIZE
);
332 void rkcommon_rc4_encode_spl(void *buf
, unsigned int offset
, unsigned int size
)
334 unsigned int remaining
= size
;
336 while (remaining
> 0) {
337 int step
= (remaining
> RK_BLK_SIZE
) ? RK_BLK_SIZE
: remaining
;
339 rc4_encode(buf
+ offset
, step
, rc4_key
);
340 offset
+= RK_BLK_SIZE
;
345 int rkcommon_vrec_header(struct image_tool_params
*params
,
346 struct image_type_params
*tparams
,
347 unsigned int alignment
)
349 unsigned int unpadded_size
;
350 unsigned int padded_size
;
353 * The SPL image looks as follows:
355 * 0x0 header0 (see rkcommon.c)
356 * 0x800 spl_name ('RK30', ..., 'RK33')
357 * (start of the payload for AArch64 payloads: we expect the
358 * first 4 bytes to be available for overwriting with our
360 * 0x804 first instruction to be executed
361 * (start of the image/payload for 32bit payloads)
363 * For AArch64 (ARMv8) payloads, natural alignment (8-bytes) is
364 * required for its sections (so the image we receive needs to
365 * have the first 4 bytes reserved for the spl_name). Reserving
366 * these 4 bytes is done using the BOOT0_HOOK infrastructure.
368 * Depending on this, the header is either 0x800 (if this is a
369 * 'boot0'-style payload, which has reserved 4 bytes at the
370 * beginning for the 'spl_name' and expects us to overwrite
371 * its first 4 bytes) or 0x804 bytes in length.
373 if (rkcommon_spl_is_boot0(params
))
374 tparams
->header_size
= RK_SPL_HDR_START
;
376 tparams
->header_size
= RK_SPL_HDR_START
+ 4;
378 /* Allocate, clear and install the header */
379 tparams
->hdr
= malloc(tparams
->header_size
);
382 memset(tparams
->hdr
, 0, tparams
->header_size
);
385 * If someone passed in 0 for the alignment, we'd better handle
391 unpadded_size
= tparams
->header_size
+ params
->file_size
;
392 padded_size
= ROUND(unpadded_size
, alignment
);
394 return padded_size
- unpadded_size
;