rockchip: mkimage: Add support for RV1108
[platform/kernel/u-boot.git] / tools / rkcommon.c
1 /*
2  * (C) Copyright 2015 Google,  Inc
3  * Written by Simon Glass <sjg@chromium.org>
4  *
5  * (C) 2017 Theobroma Systems Design und Consulting GmbH
6  *
7  * SPDX-License-Identifier:     GPL-2.0+
8  *
9  * Helper functions for Rockchip images
10  */
11
12 #include "imagetool.h"
13 #include <image.h>
14 #include <rc4.h>
15 #include "mkimage.h"
16 #include "rkcommon.h"
17
18 #define DIV_ROUND_UP(n, d)      (((n) + (d) - 1) / (d))
19
20 enum {
21         RK_SIGNATURE            = 0x0ff0aa55,
22 };
23
24 /**
25  * struct header0_info - header block for boot ROM
26  *
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.
29  *
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
35  */
36 struct header0_info {
37         uint32_t signature;
38         uint8_t reserved[4];
39         uint32_t disable_rc4;
40         uint16_t init_offset;
41         uint8_t reserved1[492];
42         uint16_t init_size;
43         uint16_t init_boot_size;
44         uint8_t reserved2[2];
45 };
46
47 /**
48  * struct header1_info
49  */
50 struct header1_info {
51         uint32_t magic;
52 };
53
54 /**
55  * struct spl_info - spl info for each chip
56  *
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
63  *                      word.
64  */
65
66 struct spl_info {
67         const char *imagename;
68         const char *spl_hdr;
69         const uint32_t spl_size;
70         const bool spl_rc4;
71         const bool spl_boot0;
72 };
73
74 static struct spl_info spl_infos[] = {
75         { "rk3036", "RK30", 0x1000, false, false },
76         { "rk3188", "RK31", 0x8000 - 0x800, true, false },
77         { "rk3288", "RK32", 0x8000, false, false },
78         { "rk3328", "RK32", 0x8000 - 0x1000, false, false },
79         { "rk3399", "RK33", 0x20000, false, true },
80         { "rv1108", "RK11", 0x1800, false, false},
81 };
82
83 static unsigned char rc4_key[16] = {
84         124, 78, 3, 4, 85, 5, 9, 7,
85         45, 44, 123, 56, 23, 13, 23, 17
86 };
87
88 static struct spl_info *rkcommon_get_spl_info(char *imagename)
89 {
90         int i;
91
92         if (!imagename)
93                 return NULL;
94
95         for (i = 0; i < ARRAY_SIZE(spl_infos); i++)
96                 if (!strncmp(imagename, spl_infos[i].imagename, 6))
97                         return spl_infos + i;
98
99         return NULL;
100 }
101
102 int rkcommon_check_params(struct image_tool_params *params)
103 {
104         int i;
105
106         if (rkcommon_get_spl_info(params->imagename) != NULL)
107                 return EXIT_SUCCESS;
108
109         /*
110          * If this is a operation (list or extract), the don't require
111          * imagename to be set.
112          */
113         if (params->lflag || params->iflag)
114                 return EXIT_SUCCESS;
115
116         fprintf(stderr, "ERROR: imagename (%s) is not supported!\n",
117                 params->imagename ? params->imagename : "NULL");
118
119         fprintf(stderr, "Available imagename:");
120         for (i = 0; i < ARRAY_SIZE(spl_infos); i++)
121                 fprintf(stderr, "\t%s", spl_infos[i].imagename);
122         fprintf(stderr, "\n");
123
124         return EXIT_FAILURE;
125 }
126
127 const char *rkcommon_get_spl_hdr(struct image_tool_params *params)
128 {
129         struct spl_info *info = rkcommon_get_spl_info(params->imagename);
130
131         /*
132          * info would not be NULL, because of we checked params before.
133          */
134         return info->spl_hdr;
135 }
136
137
138 int rkcommon_get_spl_size(struct image_tool_params *params)
139 {
140         struct spl_info *info = rkcommon_get_spl_info(params->imagename);
141
142         /*
143          * info would not be NULL, because of we checked params before.
144          */
145         return info->spl_size;
146 }
147
148 bool rkcommon_need_rc4_spl(struct image_tool_params *params)
149 {
150         struct spl_info *info = rkcommon_get_spl_info(params->imagename);
151
152         /*
153          * info would not be NULL, because of we checked params before.
154          */
155         return info->spl_rc4;
156 }
157
158 bool rkcommon_spl_is_boot0(struct image_tool_params *params)
159 {
160         struct spl_info *info = rkcommon_get_spl_info(params->imagename);
161
162         /*
163          * info would not be NULL, because of we checked params before.
164          */
165         return info->spl_boot0;
166 }
167
168 static void rkcommon_set_header0(void *buf, uint file_size,
169                                  struct image_tool_params *params)
170 {
171         struct header0_info *hdr = buf;
172
173         memset(buf, '\0', RK_INIT_OFFSET * RK_BLK_SIZE);
174         hdr->signature = RK_SIGNATURE;
175         hdr->disable_rc4 = !rkcommon_need_rc4_spl(params);
176         hdr->init_offset = RK_INIT_OFFSET;
177
178         hdr->init_size = DIV_ROUND_UP(file_size, RK_BLK_SIZE);
179         /*
180          * The init_size has to be a multiple of 4 blocks (i.e. of 2K)
181          * or the BootROM will not boot the image.
182          *
183          * Note: To verify that this is not a legacy constraint, we
184          *       rechecked this against the RK3399 BootROM.
185          */
186         hdr->init_size = ROUND(hdr->init_size, 4);
187         /*
188          * init_boot_size needs to be set, as it is read by the BootROM
189          * to determine the size of the next-stage bootloader (e.g. U-Boot
190          * proper), when used with the back-to-bootrom functionality.
191          *
192          * see https://lists.denx.de/pipermail/u-boot/2017-May/293267.html
193          * for a more detailed explanation by Andy Yan
194          */
195         hdr->init_boot_size = hdr->init_size + RK_MAX_BOOT_SIZE / RK_BLK_SIZE;
196
197         rc4_encode(buf, RK_BLK_SIZE, rc4_key);
198 }
199
200 int rkcommon_set_header(void *buf, uint file_size,
201                         struct image_tool_params *params)
202 {
203         struct header1_info *hdr = buf + RK_SPL_HDR_START;
204
205         if (file_size > rkcommon_get_spl_size(params))
206                 return -ENOSPC;
207
208         rkcommon_set_header0(buf, file_size, params);
209
210         /* Set up the SPL name (i.e. copy spl_hdr over) */
211         memcpy(&hdr->magic, rkcommon_get_spl_hdr(params), RK_SPL_HDR_SIZE);
212
213         if (rkcommon_need_rc4_spl(params))
214                 rkcommon_rc4_encode_spl(buf, RK_SPL_HDR_START,
215                                         params->file_size - RK_SPL_HDR_START);
216
217         return 0;
218 }
219
220 static inline unsigned rkcommon_offset_to_spi(unsigned offset)
221 {
222         /*
223          * While SD/MMC images use a flat addressing, SPI images are padded
224          * to use the first 2K of every 4K sector only.
225          */
226         return ((offset & ~0x7ff) << 1) + (offset & 0x7ff);
227 }
228
229 static inline unsigned rkcommon_spi_to_offset(unsigned offset)
230 {
231         return ((offset & ~0x7ff) >> 1) + (offset & 0x7ff);
232 }
233
234 static int rkcommon_parse_header(const void *buf, struct header0_info *header0,
235                                  struct spl_info **spl_info)
236 {
237         unsigned hdr1_offset;
238         struct header1_info *hdr1_sdmmc, *hdr1_spi;
239         int i;
240
241         if (spl_info)
242                 *spl_info = NULL;
243
244         /*
245          * The first header (hdr0) is always RC4 encoded, so try to decrypt
246          * with the well-known key.
247          */
248         memcpy((void *)header0, buf, sizeof(struct header0_info));
249         rc4_encode((void *)header0, sizeof(struct header0_info), rc4_key);
250
251         if (header0->signature != RK_SIGNATURE)
252                 return -EPROTO;
253
254         /* We don't support RC4 encoded image payloads here, yet... */
255         if (header0->disable_rc4 == 0)
256                 return -ENOSYS;
257
258         hdr1_offset = header0->init_offset * RK_BLK_SIZE;
259         hdr1_sdmmc = (struct header1_info *)(buf + hdr1_offset);
260         hdr1_spi = (struct header1_info *)(buf +
261                                            rkcommon_offset_to_spi(hdr1_offset));
262
263         for (i = 0; i < ARRAY_SIZE(spl_infos); i++) {
264                 if (!memcmp(&hdr1_sdmmc->magic, spl_infos[i].spl_hdr, 4)) {
265                         if (spl_info)
266                                 *spl_info = &spl_infos[i];
267                         return IH_TYPE_RKSD;
268                 } else if (!memcmp(&hdr1_spi->magic, spl_infos[i].spl_hdr, 4)) {
269                         if (spl_info)
270                                 *spl_info = &spl_infos[i];
271                         return IH_TYPE_RKSPI;
272                 }
273         }
274
275         return -1;
276 }
277
278 int rkcommon_verify_header(unsigned char *buf, int size,
279                            struct image_tool_params *params)
280 {
281         struct header0_info header0;
282         struct spl_info *img_spl_info, *spl_info;
283         int ret;
284
285         ret = rkcommon_parse_header(buf, &header0, &img_spl_info);
286
287         /* If this is the (unimplemented) RC4 case, then rewrite the result */
288         if (ret == -ENOSYS)
289                 return 0;
290
291         if (ret < 0)
292                 return ret;
293
294         /*
295          * If no 'imagename' is specified via the commandline (e.g. if this is
296          * 'dumpimage -l' w/o any further constraints), we accept any spl_info.
297          */
298         if (params->imagename == NULL)
299                 return 0;
300
301         /* Match the 'imagename' against the 'spl_hdr' found */
302         spl_info = rkcommon_get_spl_info(params->imagename);
303         if (spl_info && img_spl_info)
304                 return strcmp(spl_info->spl_hdr, img_spl_info->spl_hdr);
305
306         return -ENOENT;
307 }
308
309 void rkcommon_print_header(const void *buf)
310 {
311         struct header0_info header0;
312         struct spl_info *spl_info;
313         uint8_t image_type;
314         int ret;
315
316         ret = rkcommon_parse_header(buf, &header0, &spl_info);
317
318         /* If this is the (unimplemented) RC4 case, then fail silently */
319         if (ret == -ENOSYS)
320                 return;
321
322         if (ret < 0) {
323                 fprintf(stderr, "Error: image verification failed\n");
324                 return;
325         }
326
327         image_type = ret;
328
329         printf("Image Type:   Rockchip %s (%s) boot image\n",
330                spl_info->spl_hdr,
331                (image_type == IH_TYPE_RKSD) ? "SD/MMC" : "SPI");
332         printf("Data Size:    %d bytes\n", header0.init_size * RK_BLK_SIZE);
333 }
334
335 void rkcommon_rc4_encode_spl(void *buf, unsigned int offset, unsigned int size)
336 {
337         unsigned int remaining = size;
338
339         while (remaining > 0) {
340                 int step = (remaining > RK_BLK_SIZE) ? RK_BLK_SIZE : remaining;
341
342                 rc4_encode(buf + offset, step, rc4_key);
343                 offset += RK_BLK_SIZE;
344                 remaining -= step;
345         }
346 }
347
348 int rkcommon_vrec_header(struct image_tool_params *params,
349                          struct image_type_params *tparams,
350                          unsigned int alignment)
351 {
352         unsigned int  unpadded_size;
353         unsigned int  padded_size;
354
355         /*
356          * The SPL image looks as follows:
357          *
358          * 0x0    header0 (see rkcommon.c)
359          * 0x800  spl_name ('RK30', ..., 'RK33')
360          *        (start of the payload for AArch64 payloads: we expect the
361          *        first 4 bytes to be available for overwriting with our
362          *        spl_name)
363          * 0x804  first instruction to be executed
364          *        (start of the image/payload for 32bit payloads)
365          *
366          * For AArch64 (ARMv8) payloads, natural alignment (8-bytes) is
367          * required for its sections (so the image we receive needs to
368          * have the first 4 bytes reserved for the spl_name).  Reserving
369          * these 4 bytes is done using the BOOT0_HOOK infrastructure.
370          *
371          * Depending on this, the header is either 0x800 (if this is a
372          * 'boot0'-style payload, which has reserved 4 bytes at the
373          * beginning for the 'spl_name' and expects us to overwrite
374          * its first 4 bytes) or 0x804 bytes in length.
375          */
376         if (rkcommon_spl_is_boot0(params))
377                 tparams->header_size = RK_SPL_HDR_START;
378         else
379                 tparams->header_size = RK_SPL_HDR_START + 4;
380
381         /* Allocate, clear and install the header */
382         tparams->hdr = malloc(tparams->header_size);
383         memset(tparams->hdr, 0, tparams->header_size);
384         tparams->header_size = tparams->header_size;
385
386         /*
387          * If someone passed in 0 for the alignment, we'd better handle
388          * it correctly...
389          */
390         if (!alignment)
391                 alignment = 1;
392
393         unpadded_size = tparams->header_size + params->file_size;
394         padded_size = ROUND(unpadded_size, alignment);
395
396         return padded_size - unpadded_size;
397 }