]>
git.ipfire.org Git - people/ms/u-boot.git/blob - tools/rkcommon.c
2 * (C) Copyright 2015 Google, Inc
3 * Written by Simon Glass <sjg@chromium.org>
5 * SPDX-License-Identifier: GPL-2.0+
7 * Helper functions for Rockchip images
10 #include "imagetool.h"
16 #define DIV_ROUND_UP(n, d) (((n) + (d) - 1) / (d))
19 RK_SIGNATURE
= 0x0ff0aa55,
23 * struct header0_info - header block for boot ROM
25 * This is stored at SD card block 64 (where each block is 512 bytes, or at
26 * the start of SPI flash. It is encoded with RC4.
28 * @signature: Signature (must be RKSD_SIGNATURE)
29 * @disable_rc4: 0 to use rc4 for boot image, 1 to use plain binary
30 * @init_offset: Offset in blocks of the SPL code from this header
31 * block. E.g. 4 means 2KB after the start of this header.
32 * Other fields are not used by U-Boot
39 uint8_t reserved1
[492];
41 uint16_t init_boot_size
;
53 * struct spl_info - spl info for each chip
55 * @imagename: Image name(passed by "mkimage -n")
56 * @spl_hdr: Boot ROM requires a 4-bytes spl header
57 * @spl_size: Spl size(include extra 4-bytes spl header)
58 * @spl_rc4: RC4 encode the SPL binary (same key as header)
59 * @spl_boot0: A new-style (ARM_SOC_BOOT0_HOOK) image that should
60 * have the boot magic (e.g. 'RK33') written to its first
65 const char *imagename
;
67 const uint32_t spl_size
;
72 static struct spl_info spl_infos
[] = {
73 { "rk3036", "RK30", 0x1000, false, false },
74 { "rk3188", "RK31", 0x8000 - 0x800, true, false },
75 { "rk3288", "RK32", 0x8000, false, false },
76 { "rk3328", "RK32", 0x8000 - 0x1000, false, false },
77 { "rk3399", "RK33", 0x20000, false, true },
80 static unsigned char rc4_key
[16] = {
81 124, 78, 3, 4, 85, 5, 9, 7,
82 45, 44, 123, 56, 23, 13, 23, 17
85 static struct spl_info
*rkcommon_get_spl_info(char *imagename
)
92 for (i
= 0; i
< ARRAY_SIZE(spl_infos
); i
++)
93 if (!strncmp(imagename
, spl_infos
[i
].imagename
, 6))
99 int rkcommon_check_params(struct image_tool_params
*params
)
103 if (rkcommon_get_spl_info(params
->imagename
) != NULL
)
107 * If this is a operation (list or extract), the don't require
108 * imagename to be set.
110 if (params
->lflag
|| params
->iflag
)
113 fprintf(stderr
, "ERROR: imagename (%s) is not supported!\n",
114 params
->imagename
? params
->imagename
: "NULL");
116 fprintf(stderr
, "Available imagename:");
117 for (i
= 0; i
< ARRAY_SIZE(spl_infos
); i
++)
118 fprintf(stderr
, "\t%s", spl_infos
[i
].imagename
);
119 fprintf(stderr
, "\n");
124 const char *rkcommon_get_spl_hdr(struct image_tool_params
*params
)
126 struct spl_info
*info
= rkcommon_get_spl_info(params
->imagename
);
129 * info would not be NULL, because of we checked params before.
131 return info
->spl_hdr
;
135 int rkcommon_get_spl_size(struct image_tool_params
*params
)
137 struct spl_info
*info
= rkcommon_get_spl_info(params
->imagename
);
140 * info would not be NULL, because of we checked params before.
142 return info
->spl_size
;
145 bool rkcommon_need_rc4_spl(struct image_tool_params
*params
)
147 struct spl_info
*info
= rkcommon_get_spl_info(params
->imagename
);
150 * info would not be NULL, because of we checked params before.
152 return info
->spl_rc4
;
155 bool rkcommon_spl_is_boot0(struct image_tool_params
*params
)
157 struct spl_info
*info
= rkcommon_get_spl_info(params
->imagename
);
160 * info would not be NULL, because of we checked params before.
162 return info
->spl_boot0
;
165 static void rkcommon_set_header0(void *buf
, uint file_size
,
166 struct image_tool_params
*params
)
168 struct header0_info
*hdr
= buf
;
170 memset(buf
, '\0', RK_INIT_OFFSET
* RK_BLK_SIZE
);
171 hdr
->signature
= RK_SIGNATURE
;
172 hdr
->disable_rc4
= !rkcommon_need_rc4_spl(params
);
173 hdr
->init_offset
= RK_INIT_OFFSET
;
175 hdr
->init_size
= DIV_ROUND_UP(file_size
, RK_BLK_SIZE
);
177 * The init_size has to be a multiple of 4 blocks (i.e. of 2K)
178 * or the BootROM will not boot the image.
180 * Note: To verify that this is not a legacy constraint, we
181 * rechecked this against the RK3399 BootROM.
183 hdr
->init_size
= ROUND(hdr
->init_size
, 4);
185 * The images we create do not contain the stage following the SPL as
186 * part of the SPL image, so the init_boot_size (which might have been
187 * read by Rockchip's miniloder) should be the same as the init_size.
189 hdr
->init_boot_size
= hdr
->init_size
;
191 rc4_encode(buf
, RK_BLK_SIZE
, rc4_key
);
194 int rkcommon_set_header(void *buf
, uint file_size
,
195 struct image_tool_params
*params
)
197 struct header1_info
*hdr
= buf
+ RK_SPL_HDR_START
;
199 if (file_size
> rkcommon_get_spl_size(params
))
202 rkcommon_set_header0(buf
, file_size
, params
);
204 /* Set up the SPL name */
205 memcpy(&hdr
->magic
, rkcommon_get_spl_hdr(params
), RK_SPL_HDR_SIZE
);
207 if (rkcommon_need_rc4_spl(params
))
208 rkcommon_rc4_encode_spl(buf
, RK_SPL_HDR_START
,
209 params
->file_size
- RK_SPL_HDR_START
);
214 void rkcommon_rc4_encode_spl(void *buf
, unsigned int offset
, unsigned int size
)
216 unsigned int remaining
= size
;
218 while (remaining
> 0) {
219 int step
= (remaining
> RK_BLK_SIZE
) ? RK_BLK_SIZE
: remaining
;
221 rc4_encode(buf
+ offset
, step
, rc4_key
);
222 offset
+= RK_BLK_SIZE
;
227 int rkcommon_vrec_header(struct image_tool_params
*params
,
228 struct image_type_params
*tparams
,
229 unsigned int alignment
)
231 unsigned int unpadded_size
;
232 unsigned int padded_size
;
235 * The SPL image looks as follows:
237 * 0x0 header0 (see rkcommon.c)
238 * 0x800 spl_name ('RK30', ..., 'RK33')
239 * (start of the payload for AArch64 payloads: we expect the
240 * first 4 bytes to be available for overwriting with our
242 * 0x804 first instruction to be executed
243 * (start of the image/payload for 32bit payloads)
245 * For AArch64 (ARMv8) payloads, natural alignment (8-bytes) is
246 * required for its sections (so the image we receive needs to
247 * have the first 4 bytes reserved for the spl_name). Reserving
248 * these 4 bytes is done using the BOOT0_HOOK infrastructure.
250 * Depending on this, the header is either 0x800 (if this is a
251 * 'boot0'-style payload, which has reserved 4 bytes at the
252 * beginning for the 'spl_name' and expects us to overwrite
253 * its first 4 bytes) or 0x804 bytes in length.
255 if (rkcommon_spl_is_boot0(params
))
256 tparams
->header_size
= RK_SPL_HDR_START
;
258 tparams
->header_size
= RK_SPL_HDR_START
+ 4;
260 /* Allocate, clear and install the header */
261 tparams
->hdr
= malloc(tparams
->header_size
);
262 memset(tparams
->hdr
, 0, tparams
->header_size
);
263 tparams
->header_size
= tparams
->header_size
;
266 * If someone passed in 0 for the alignment, we'd better handle
272 unpadded_size
= tparams
->header_size
+ params
->file_size
;
273 padded_size
= ROUND(unpadded_size
, alignment
);
275 return padded_size
- unpadded_size
;