xref: /openbmc/u-boot/tools/rkcommon.c (revision f6f7e73d)
1 /*
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 
16 enum {
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
28  * @init_offset:	Offset in blocks of the SPL code from this header
29  *			block. E.g. 4 means 2KB after the start of this header.
30  * Other fields are not used by U-Boot
31  */
32 struct header0_info {
33 	uint32_t signature;
34 	uint8_t reserved[4];
35 	uint32_t disable_rc4;
36 	uint16_t init_offset;
37 	uint8_t reserved1[492];
38 	uint16_t init_size;
39 	uint16_t init_boot_size;
40 	uint8_t reserved2[2];
41 };
42 
43 /**
44  * struct spl_info - spl info for each chip
45  *
46  * @imagename:		Image name(passed by "mkimage -n")
47  * @spl_hdr:		Boot ROM requires a 4-bytes spl header
48  * @spl_size:		Spl size(include extra 4-bytes spl header)
49  * @spl_rc4:		RC4 encode the SPL binary (same key as header)
50  */
51 struct spl_info {
52 	const char *imagename;
53 	const char *spl_hdr;
54 	const uint32_t spl_size;
55 	const bool spl_rc4;
56 };
57 
58 static struct spl_info spl_infos[] = {
59 	{ "rk3036", "RK30", 0x1000, false },
60 	{ "rk3188", "RK31", 0x8000 - 0x800, true },
61 	{ "rk3288", "RK32", 0x8000, false },
62 	{ "rk3399", "RK33", 0x20000, false },
63 };
64 
65 static unsigned char rc4_key[16] = {
66 	124, 78, 3, 4, 85, 5, 9, 7,
67 	45, 44, 123, 56, 23, 13, 23, 17
68 };
69 
70 static struct spl_info *rkcommon_get_spl_info(char *imagename)
71 {
72 	int i;
73 
74 	for (i = 0; i < ARRAY_SIZE(spl_infos); i++)
75 		if (!strncmp(imagename, spl_infos[i].imagename, 6))
76 			return spl_infos + i;
77 
78 	return NULL;
79 }
80 
81 int rkcommon_check_params(struct image_tool_params *params)
82 {
83 	int i;
84 
85 	if (rkcommon_get_spl_info(params->imagename) != NULL)
86 		return 0;
87 
88 	fprintf(stderr, "ERROR: imagename (%s) is not supported!\n",
89 		strlen(params->imagename) > 0 ? params->imagename : "NULL");
90 
91 	fprintf(stderr, "Available imagename:");
92 	for (i = 0; i < ARRAY_SIZE(spl_infos); i++)
93 		fprintf(stderr, "\t%s", spl_infos[i].imagename);
94 	fprintf(stderr, "\n");
95 
96 	return -1;
97 }
98 
99 const char *rkcommon_get_spl_hdr(struct image_tool_params *params)
100 {
101 	struct spl_info *info = rkcommon_get_spl_info(params->imagename);
102 
103 	/*
104 	 * info would not be NULL, because of we checked params before.
105 	 */
106 	return info->spl_hdr;
107 }
108 
109 int rkcommon_get_spl_size(struct image_tool_params *params)
110 {
111 	struct spl_info *info = rkcommon_get_spl_info(params->imagename);
112 
113 	/*
114 	 * info would not be NULL, because of we checked params before.
115 	 */
116 	return info->spl_size;
117 }
118 
119 bool rkcommon_need_rc4_spl(struct image_tool_params *params)
120 {
121 	struct spl_info *info = rkcommon_get_spl_info(params->imagename);
122 
123 	/*
124 	 * info would not be NULL, because of we checked params before.
125 	 */
126 	return info->spl_rc4;
127 }
128 
129 int rkcommon_set_header(void *buf, uint file_size,
130 			struct image_tool_params *params)
131 {
132 	struct header0_info *hdr;
133 
134 	if (file_size > rkcommon_get_spl_size(params))
135 		return -ENOSPC;
136 
137 	memset(buf,  '\0', RK_INIT_OFFSET * RK_BLK_SIZE);
138 	hdr = (struct header0_info *)buf;
139 	hdr->signature = RK_SIGNATURE;
140 	hdr->disable_rc4 = !rkcommon_need_rc4_spl(params);
141 	hdr->init_offset = RK_INIT_OFFSET;
142 
143 	hdr->init_size = (file_size + RK_BLK_SIZE - 1) / RK_BLK_SIZE;
144 	hdr->init_size = (hdr->init_size + 3) & ~3;
145 	hdr->init_boot_size = hdr->init_size + RK_MAX_BOOT_SIZE / RK_BLK_SIZE;
146 
147 	rc4_encode(buf, RK_BLK_SIZE, rc4_key);
148 
149 	return 0;
150 }
151 
152 void rkcommon_rc4_encode_spl(void *buf, unsigned int offset, unsigned int size)
153 {
154 	unsigned int remaining = size;
155 
156 	while (remaining > 0) {
157 		int step = (remaining > RK_BLK_SIZE) ? RK_BLK_SIZE : remaining;
158 
159 		rc4_encode(buf + offset, step, rc4_key);
160 		offset += RK_BLK_SIZE;
161 		remaining -= step;
162 	}
163 }
164