blob: 6dfd64e31dd5487eea58d8077f42ee38baa363e8 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
Charles Manning832472a2014-03-06 15:40:50 +13002/*
3 * Copyright (C) 2014 Charles Manning <cdhmanning@gmail.com>
4 *
Marek Vasutcece78f2018-04-15 13:15:33 +02005 * Reference documents:
6 * Cyclone V SoC: https://www.altera.com/content/dam/altera-www/global/en_US/pdfs/literature/hb/cyclone-v/cv_5400a.pdf
7 * Arria V SoC: https://www.altera.com/content/dam/altera-www/global/en_US/pdfs/literature/hb/arria-v/av_5400a.pdf
8 * Arria 10 SoC: https://www.altera.com/content/dam/altera-www/global/en_US/pdfs/literature/hb/arria-10/a10_5400a.pdf
Charles Manning832472a2014-03-06 15:40:50 +13009 *
Marek Vasutcece78f2018-04-15 13:15:33 +020010 * Bootable SoCFPGA image requires a structure of the following format
11 * positioned at offset 0x40 of the bootable image. Endian is LSB.
Charles Manning832472a2014-03-06 15:40:50 +130012 *
Marek Vasutcece78f2018-04-15 13:15:33 +020013 * There are two versions of the SoCFPGA header format, v0 and v1.
14 * The version 0 is used by Cyclone V SoC and Arria V SoC, while
15 * the version 1 is used by the Arria 10 SoC.
Charles Manning832472a2014-03-06 15:40:50 +130016 *
Marek Vasutcece78f2018-04-15 13:15:33 +020017 * Version 0:
Charles Manning832472a2014-03-06 15:40:50 +130018 * Offset Length Usage
19 * -----------------------
Marek Vasutcece78f2018-04-15 13:15:33 +020020 * 0x40 4 Validation word (0x31305341)
21 * 0x44 1 Version (0x0)
22 * 0x45 1 Flags (unused, zero is fine)
23 * 0x46 2 Length (in units of u32, including the end checksum).
24 * 0x48 2 Zero (0x0)
Charles Manning832472a2014-03-06 15:40:50 +130025 * 0x4A 2 Checksum over the header. NB Not CRC32
26 *
Marek Vasutcece78f2018-04-15 13:15:33 +020027 * Version 1:
28 * Offset Length Usage
29 * -----------------------
30 * 0x40 4 Validation word (0x31305341)
31 * 0x44 1 Version (0x1)
32 * 0x45 1 Flags (unused, zero is fine)
33 * 0x46 2 Header length (in units of u8).
34 * 0x48 4 Length (in units of u8).
35 * 0x4C 4 Image entry offset from standard of header
36 * 0x50 2 Zero (0x0)
37 * 0x52 2 Checksum over the header. NB Not CRC32
38 *
Charles Manning832472a2014-03-06 15:40:50 +130039 * At the end of the code we have a 32-bit CRC checksum over whole binary
40 * excluding the CRC.
41 *
42 * Note that the CRC used here is **not** the zlib/Adler crc32. It is the
43 * CRC-32 used in bzip2, ethernet and elsewhere.
44 *
Marek Vasutcece78f2018-04-15 13:15:33 +020045 * The Image entry offset in version 1 image is relative the the start of
46 * the header, 0x40, and must not be a negative number. Therefore, it is
47 * only possible to make the SoCFPGA jump forward. The U-Boot bootloader
48 * places a trampoline instruction at offset 0x5c, 0x14 bytes from the
49 * start of the SoCFPGA header, which jumps to the reset vector.
50 *
Charles Manning832472a2014-03-06 15:40:50 +130051 * The image is padded out to 64k, because that is what is
52 * typically used to write the image to the boot medium.
53 */
54
55#include "pbl_crc32.h"
56#include "imagetool.h"
Guilherme Maciel Ferreira26621792015-01-15 02:54:43 -020057#include "mkimage.h"
Simon Glass3db71102019-11-14 12:57:16 -070058#include <u-boot/crc.h>
Guilherme Maciel Ferreira26621792015-01-15 02:54:43 -020059
Charles Manning832472a2014-03-06 15:40:50 +130060#include <image.h>
61
62#define HEADER_OFFSET 0x40
63#define VALIDATION_WORD 0x31305341
Charles Manning832472a2014-03-06 15:40:50 +130064
Marek Vasutcece78f2018-04-15 13:15:33 +020065static uint8_t buffer_v0[0x10000];
66static uint8_t buffer_v1[0x40000];
Charles Manning832472a2014-03-06 15:40:50 +130067
Marek Vasutcece78f2018-04-15 13:15:33 +020068struct socfpga_header_v0 {
69 uint32_t validation;
70 uint8_t version;
71 uint8_t flags;
72 uint16_t length_u32;
73 uint16_t zero;
74 uint16_t checksum;
Marek Vasut9f0021a2018-04-15 13:38:49 +020075};
Charles Manning832472a2014-03-06 15:40:50 +130076
Marek Vasutcece78f2018-04-15 13:15:33 +020077struct socfpga_header_v1 {
78 uint32_t validation;
79 uint8_t version;
80 uint8_t flags;
81 uint16_t header_u8;
82 uint32_t length_u8;
83 uint32_t entry_offset;
84 uint16_t zero;
85 uint16_t checksum;
86};
87
88static unsigned int sfp_hdr_size(uint8_t ver)
89{
90 if (ver == 0)
91 return sizeof(struct socfpga_header_v0);
92 if (ver == 1)
93 return sizeof(struct socfpga_header_v1);
94 return 0;
95}
96
97static unsigned int sfp_pad_size(uint8_t ver)
98{
99 if (ver == 0)
100 return sizeof(buffer_v0);
101 if (ver == 1)
102 return sizeof(buffer_v1);
103 return 0;
104}
105
Charles Manning832472a2014-03-06 15:40:50 +1300106/*
107 * The header checksum is just a very simple checksum over
108 * the header area.
109 * There is still a crc32 over the whole lot.
110 */
Marek Vasutcece78f2018-04-15 13:15:33 +0200111static uint16_t sfp_hdr_checksum(uint8_t *buf, unsigned char ver)
Charles Manning832472a2014-03-06 15:40:50 +1300112{
Charles Manning832472a2014-03-06 15:40:50 +1300113 uint16_t ret = 0;
Marek Vasutcece78f2018-04-15 13:15:33 +0200114 int len = sfp_hdr_size(ver) - sizeof(ret);
Charles Manning832472a2014-03-06 15:40:50 +1300115
116 while (--len)
117 ret += *buf++;
118
119 return ret;
120}
121
Marek Vasutcece78f2018-04-15 13:15:33 +0200122static void sfp_build_header(uint8_t *buf, uint8_t ver, uint8_t flags,
123 uint32_t length_bytes)
Charles Manning832472a2014-03-06 15:40:50 +1300124{
Marek Vasutcece78f2018-04-15 13:15:33 +0200125 struct socfpga_header_v0 header_v0 = {
126 .validation = cpu_to_le32(VALIDATION_WORD),
127 .version = 0,
128 .flags = flags,
129 .length_u32 = cpu_to_le16(length_bytes / 4),
130 .zero = 0,
131 };
Marek Vasut9f0021a2018-04-15 13:38:49 +0200132
Marek Vasutcece78f2018-04-15 13:15:33 +0200133 struct socfpga_header_v1 header_v1 = {
134 .validation = cpu_to_le32(VALIDATION_WORD),
135 .version = 1,
136 .flags = flags,
137 .header_u8 = cpu_to_le16(sizeof(header_v1)),
138 .length_u8 = cpu_to_le32(length_bytes),
139 .entry_offset = cpu_to_le32(0x14), /* Trampoline offset */
140 .zero = 0,
141 };
Charles Manning832472a2014-03-06 15:40:50 +1300142
Marek Vasutcece78f2018-04-15 13:15:33 +0200143 uint16_t csum;
144
145 if (ver == 0) {
146 csum = sfp_hdr_checksum((uint8_t *)&header_v0, 0);
147 header_v0.checksum = cpu_to_le16(csum);
148 memcpy(buf, &header_v0, sizeof(header_v0));
149 } else {
150 csum = sfp_hdr_checksum((uint8_t *)&header_v1, 1);
151 header_v1.checksum = cpu_to_le16(csum);
152 memcpy(buf, &header_v1, sizeof(header_v1));
153 }
Charles Manning832472a2014-03-06 15:40:50 +1300154}
155
156/*
157 * Perform a rudimentary verification of header and return
158 * size of image.
159 */
Marek Vasutcece78f2018-04-15 13:15:33 +0200160static int sfp_verify_header(const uint8_t *buf, uint8_t *ver)
Charles Manning832472a2014-03-06 15:40:50 +1300161{
Marek Vasutcece78f2018-04-15 13:15:33 +0200162 struct socfpga_header_v0 header_v0;
163 struct socfpga_header_v1 header_v1;
164 uint16_t hdr_csum, sfp_csum;
165 uint32_t img_len;
Marek Vasut9f0021a2018-04-15 13:38:49 +0200166
Marek Vasutcece78f2018-04-15 13:15:33 +0200167 /*
168 * Header v0 is always smaller than Header v1 and the validation
169 * word and version field is at the same place, so use Header v0
170 * to check for version during verifiction and upgrade to Header
171 * v1 if needed.
172 */
173 memcpy(&header_v0, buf, sizeof(header_v0));
Charles Manning832472a2014-03-06 15:40:50 +1300174
Marek Vasutcece78f2018-04-15 13:15:33 +0200175 if (le32_to_cpu(header_v0.validation) != VALIDATION_WORD)
Charles Manning832472a2014-03-06 15:40:50 +1300176 return -1;
177
Marek Vasutcece78f2018-04-15 13:15:33 +0200178 if (header_v0.version == 0) {
179 hdr_csum = le16_to_cpu(header_v0.checksum);
180 sfp_csum = sfp_hdr_checksum((uint8_t *)&header_v0, 0);
181 img_len = le16_to_cpu(header_v0.length_u32) * 4;
182 } else if (header_v0.version == 1) {
183 memcpy(&header_v1, buf, sizeof(header_v1));
184 hdr_csum = le16_to_cpu(header_v1.checksum);
185 sfp_csum = sfp_hdr_checksum((uint8_t *)&header_v1, 1);
186 img_len = le32_to_cpu(header_v1.length_u8);
187 } else { /* Invalid version */
188 return -EINVAL;
189 }
190
191 /* Verify checksum */
192 if (hdr_csum != sfp_csum)
193 return -EINVAL;
194
Atsushi Nemoto0ca8fd32018-09-21 09:19:13 +0900195 *ver = header_v0.version;
Marek Vasutcece78f2018-04-15 13:15:33 +0200196 return img_len;
Charles Manning832472a2014-03-06 15:40:50 +1300197}
198
199/* Sign the buffer and return the signed buffer size */
Marek Vasutcece78f2018-04-15 13:15:33 +0200200static int sfp_sign_buffer(uint8_t *buf, uint8_t ver, uint8_t flags,
201 int len, int pad_64k)
Charles Manning832472a2014-03-06 15:40:50 +1300202{
203 uint32_t calc_crc;
204
205 /* Align the length up */
Kever Yang02560b12020-03-30 11:56:22 +0800206 len = ALIGN(len, 4);
Charles Manning832472a2014-03-06 15:40:50 +1300207
208 /* Build header, adding 4 bytes to length to hold the CRC32. */
Marek Vasutcece78f2018-04-15 13:15:33 +0200209 sfp_build_header(buf + HEADER_OFFSET, ver, flags, len + 4);
Charles Manning832472a2014-03-06 15:40:50 +1300210
211 /* Calculate and apply the CRC */
212 calc_crc = ~pbl_crc32(0, (char *)buf, len);
213
Andreas Bießmann686ed2c22014-10-24 23:39:10 +0200214 *((uint32_t *)(buf + len)) = cpu_to_le32(calc_crc);
Charles Manning832472a2014-03-06 15:40:50 +1300215
216 if (!pad_64k)
217 return len + 4;
218
Marek Vasutcece78f2018-04-15 13:15:33 +0200219 return sfp_pad_size(ver);
Charles Manning832472a2014-03-06 15:40:50 +1300220}
221
222/* Verify that the buffer looks sane */
Marek Vasutcece78f2018-04-15 13:15:33 +0200223static int sfp_verify_buffer(const uint8_t *buf)
Charles Manning832472a2014-03-06 15:40:50 +1300224{
225 int len; /* Including 32bit CRC */
226 uint32_t calc_crc;
227 uint32_t buf_crc;
Marek Vasutcece78f2018-04-15 13:15:33 +0200228 uint8_t ver = 0;
Charles Manning832472a2014-03-06 15:40:50 +1300229
Marek Vasutcece78f2018-04-15 13:15:33 +0200230 len = sfp_verify_header(buf + HEADER_OFFSET, &ver);
Charles Manning832472a2014-03-06 15:40:50 +1300231 if (len < 0) {
Guilherme Maciel Ferreira26621792015-01-15 02:54:43 -0200232 debug("Invalid header\n");
Charles Manning832472a2014-03-06 15:40:50 +1300233 return -1;
234 }
235
Marek Vasutcece78f2018-04-15 13:15:33 +0200236 if (len < HEADER_OFFSET || len > sfp_pad_size(ver)) {
Guilherme Maciel Ferreira26621792015-01-15 02:54:43 -0200237 debug("Invalid header length (%i)\n", len);
Charles Manning832472a2014-03-06 15:40:50 +1300238 return -1;
239 }
240
241 /*
242 * Adjust length to the base of the CRC.
243 * Check the CRC.
244 */
245 len -= 4;
246
247 calc_crc = ~pbl_crc32(0, (const char *)buf, len);
248
Andreas Bießmann686ed2c22014-10-24 23:39:10 +0200249 buf_crc = le32_to_cpu(*((uint32_t *)(buf + len)));
Charles Manning832472a2014-03-06 15:40:50 +1300250
251 if (buf_crc != calc_crc) {
252 fprintf(stderr, "CRC32 does not match (%08x != %08x)\n",
253 buf_crc, calc_crc);
254 return -1;
255 }
256
257 return 0;
258}
259
260/* mkimage glue functions */
261static int socfpgaimage_verify_header(unsigned char *ptr, int image_size,
Marek Vasutcece78f2018-04-15 13:15:33 +0200262 struct image_tool_params *params)
Charles Manning832472a2014-03-06 15:40:50 +1300263{
Marek Vasutcece78f2018-04-15 13:15:33 +0200264 if (image_size < 0x80)
Charles Manning832472a2014-03-06 15:40:50 +1300265 return -1;
266
Marek Vasutcece78f2018-04-15 13:15:33 +0200267 return sfp_verify_buffer(ptr);
Charles Manning832472a2014-03-06 15:40:50 +1300268}
269
270static void socfpgaimage_print_header(const void *ptr)
271{
Marek Vasutcece78f2018-04-15 13:15:33 +0200272 if (sfp_verify_buffer(ptr) == 0)
Charles Manning832472a2014-03-06 15:40:50 +1300273 printf("Looks like a sane SOCFPGA preloader\n");
274 else
275 printf("Not a sane SOCFPGA preloader\n");
276}
277
278static int socfpgaimage_check_params(struct image_tool_params *params)
279{
280 /* Not sure if we should be accepting fflags */
281 return (params->dflag && (params->fflag || params->lflag)) ||
282 (params->fflag && (params->dflag || params->lflag)) ||
283 (params->lflag && (params->dflag || params->fflag));
284}
285
Marek Vasutcece78f2018-04-15 13:15:33 +0200286static int socfpgaimage_check_image_types_v0(uint8_t type)
Charles Manning832472a2014-03-06 15:40:50 +1300287{
288 if (type == IH_TYPE_SOCFPGAIMAGE)
289 return EXIT_SUCCESS;
290 return EXIT_FAILURE;
291}
292
Marek Vasutcece78f2018-04-15 13:15:33 +0200293static int socfpgaimage_check_image_types_v1(uint8_t type)
294{
295 if (type == IH_TYPE_SOCFPGAIMAGE_V1)
296 return EXIT_SUCCESS;
297 return EXIT_FAILURE;
298}
299
Charles Manning832472a2014-03-06 15:40:50 +1300300/*
301 * To work in with the mkimage framework, we do some ugly stuff...
302 *
303 * First, socfpgaimage_vrec_header() is called.
Marek Vasutcece78f2018-04-15 13:15:33 +0200304 * We prepend a fake header big enough to make the file sfp_pad_size().
Charles Manning832472a2014-03-06 15:40:50 +1300305 * This gives us enough space to do what we want later.
306 *
307 * Next, socfpgaimage_set_header() is called.
308 * We fix up the buffer by moving the image to the start of the buffer.
309 * We now have some room to do what we need (add CRC and padding).
310 */
311
312static int data_size;
Charles Manning832472a2014-03-06 15:40:50 +1300313
Marek Vasutcece78f2018-04-15 13:15:33 +0200314static int sfp_fake_header_size(unsigned int size, uint8_t ver)
315{
316 return sfp_pad_size(ver) - size;
317}
318
319static int sfp_vrec_header(struct image_tool_params *params,
320 struct image_type_params *tparams, uint8_t ver)
Charles Manning832472a2014-03-06 15:40:50 +1300321{
322 struct stat sbuf;
323
324 if (params->datafile &&
325 stat(params->datafile, &sbuf) == 0 &&
Marek Vasutcece78f2018-04-15 13:15:33 +0200326 sbuf.st_size <= (sfp_pad_size(ver) - sizeof(uint32_t))) {
Charles Manning832472a2014-03-06 15:40:50 +1300327 data_size = sbuf.st_size;
Marek Vasutcece78f2018-04-15 13:15:33 +0200328 tparams->header_size = sfp_fake_header_size(data_size, ver);
Charles Manning832472a2014-03-06 15:40:50 +1300329 }
330 return 0;
Marek Vasutcece78f2018-04-15 13:15:33 +0200331
Charles Manning832472a2014-03-06 15:40:50 +1300332}
333
Marek Vasutcece78f2018-04-15 13:15:33 +0200334static int socfpgaimage_vrec_header_v0(struct image_tool_params *params,
335 struct image_type_params *tparams)
336{
337 return sfp_vrec_header(params, tparams, 0);
338}
339
340static int socfpgaimage_vrec_header_v1(struct image_tool_params *params,
341 struct image_type_params *tparams)
342{
343 return sfp_vrec_header(params, tparams, 1);
344}
345
346static void sfp_set_header(void *ptr, unsigned char ver)
Charles Manning832472a2014-03-06 15:40:50 +1300347{
348 uint8_t *buf = (uint8_t *)ptr;
349
350 /*
351 * This function is called after vrec_header() has been called.
Marek Vasutcece78f2018-04-15 13:15:33 +0200352 * At this stage we have the sfp_fake_header_size() dummy bytes
353 * followed by data_size image bytes. Total = sfp_pad_size().
Charles Manning832472a2014-03-06 15:40:50 +1300354 * We need to fix the buffer by moving the image bytes back to
355 * the beginning of the buffer, then actually do the signing stuff...
356 */
Marek Vasutcece78f2018-04-15 13:15:33 +0200357 memmove(buf, buf + sfp_fake_header_size(data_size, ver), data_size);
358 memset(buf + data_size, 0, sfp_fake_header_size(data_size, ver));
Charles Manning832472a2014-03-06 15:40:50 +1300359
Marek Vasutcece78f2018-04-15 13:15:33 +0200360 sfp_sign_buffer(buf, ver, 0, data_size, 0);
361}
362
363static void socfpgaimage_set_header_v0(void *ptr, struct stat *sbuf, int ifd,
364 struct image_tool_params *params)
365{
366 sfp_set_header(ptr, 0);
367}
368
369static void socfpgaimage_set_header_v1(void *ptr, struct stat *sbuf, int ifd,
370 struct image_tool_params *params)
371{
372 sfp_set_header(ptr, 1);
Charles Manning832472a2014-03-06 15:40:50 +1300373}
374
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200375U_BOOT_IMAGE_TYPE(
376 socfpgaimage,
Marek Vasutcece78f2018-04-15 13:15:33 +0200377 "Altera SoCFPGA Cyclone V / Arria V image support",
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200378 0, /* This will be modified by vrec_header() */
Marek Vasutcece78f2018-04-15 13:15:33 +0200379 (void *)buffer_v0,
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200380 socfpgaimage_check_params,
381 socfpgaimage_verify_header,
382 socfpgaimage_print_header,
Marek Vasutcece78f2018-04-15 13:15:33 +0200383 socfpgaimage_set_header_v0,
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200384 NULL,
Marek Vasutcece78f2018-04-15 13:15:33 +0200385 socfpgaimage_check_image_types_v0,
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200386 NULL,
Marek Vasutcece78f2018-04-15 13:15:33 +0200387 socfpgaimage_vrec_header_v0
388);
389
390U_BOOT_IMAGE_TYPE(
391 socfpgaimage_v1,
392 "Altera SoCFPGA Arria10 image support",
393 0, /* This will be modified by vrec_header() */
394 (void *)buffer_v1,
395 socfpgaimage_check_params,
396 socfpgaimage_verify_header,
397 socfpgaimage_print_header,
398 socfpgaimage_set_header_v1,
399 NULL,
400 socfpgaimage_check_image_types_v1,
401 NULL,
402 socfpgaimage_vrec_header_v1
Guilherme Maciel Ferreiraa93648d2015-01-15 02:48:07 -0200403);