2 * Copyright (C) 2014 Charles Manning <cdhmanning@gmail.com>
4 * SPDX-License-Identifier: GPL-2.0+
6 * Reference doc http://www.altera.com.cn/literature/hb/cyclone-v/cv_5400A.pdf
7 * Note this doc is not entirely accurate. Of particular interest to us is the
8 * "header" length field being in U32s and not bytes.
10 * "Header" is a structure of the following format.
11 * this is positioned at 0x40.
16 * -----------------------
17 * 0x40 4 Validation word 0x31305341
18 * 0x44 1 Version (whatever, zero is fine)
19 * 0x45 1 Flags (unused, zero is fine)
20 * 0x46 2 Length (in units of u32, including the end checksum).
22 * 0x4A 2 Checksum over the header. NB Not CRC32
24 * At the end of the code we have a 32-bit CRC checksum over whole binary
27 * Note that the CRC used here is **not** the zlib/Adler crc32. It is the
28 * CRC-32 used in bzip2, ethernet and elsewhere.
30 * The image is padded out to 64k, because that is what is
31 * typically used to write the image to the boot medium.
34 #include "pbl_crc32.h"
35 #include "imagetool.h"
40 #define HEADER_OFFSET 0x40
41 #define VALIDATION_WORD 0x31305341
42 #define PADDED_SIZE 0x10000
44 /* To allow for adding CRC, the max input size is a bit smaller. */
45 #define MAX_INPUT_SIZE (PADDED_SIZE - sizeof(uint32_t))
47 static uint8_t buffer
[PADDED_SIZE
];
49 static struct socfpga_header
{
59 * The header checksum is just a very simple checksum over
61 * There is still a crc32 over the whole lot.
63 static uint16_t hdr_checksum(struct socfpga_header
*header
)
65 int len
= sizeof(*header
) - sizeof(header
->checksum
);
66 uint8_t *buf
= (uint8_t *)header
;
76 static void build_header(uint8_t *buf
, uint8_t version
, uint8_t flags
,
77 uint16_t length_bytes
)
79 header
.validation
= cpu_to_le32(VALIDATION_WORD
);
80 header
.version
= version
;
82 header
.length_u32
= cpu_to_le16(length_bytes
/4);
84 header
.checksum
= cpu_to_le16(hdr_checksum(&header
));
86 memcpy(buf
, &header
, sizeof(header
));
90 * Perform a rudimentary verification of header and return
93 static int verify_header(const uint8_t *buf
)
95 memcpy(&header
, buf
, sizeof(header
));
97 if (le32_to_cpu(header
.validation
) != VALIDATION_WORD
)
99 if (le16_to_cpu(header
.checksum
) != hdr_checksum(&header
))
102 return le16_to_cpu(header
.length_u32
) * 4;
105 /* Sign the buffer and return the signed buffer size */
106 static int sign_buffer(uint8_t *buf
,
107 uint8_t version
, uint8_t flags
,
108 int len
, int pad_64k
)
112 /* Align the length up */
113 len
= (len
+ 3) & (~3);
115 /* Build header, adding 4 bytes to length to hold the CRC32. */
116 build_header(buf
+ HEADER_OFFSET
, version
, flags
, len
+ 4);
118 /* Calculate and apply the CRC */
119 calc_crc
= ~pbl_crc32(0, (char *)buf
, len
);
121 *((uint32_t *)(buf
+ len
)) = cpu_to_le32(calc_crc
);
129 /* Verify that the buffer looks sane */
130 static int verify_buffer(const uint8_t *buf
)
132 int len
; /* Including 32bit CRC */
136 len
= verify_header(buf
+ HEADER_OFFSET
);
138 debug("Invalid header\n");
142 if (len
< HEADER_OFFSET
|| len
> PADDED_SIZE
) {
143 debug("Invalid header length (%i)\n", len
);
148 * Adjust length to the base of the CRC.
153 calc_crc
= ~pbl_crc32(0, (const char *)buf
, len
);
155 buf_crc
= le32_to_cpu(*((uint32_t *)(buf
+ len
)));
157 if (buf_crc
!= calc_crc
) {
158 fprintf(stderr
, "CRC32 does not match (%08x != %08x)\n",
166 /* mkimage glue functions */
167 static int socfpgaimage_verify_header(unsigned char *ptr
, int image_size
,
168 struct image_tool_params
*params
)
170 if (image_size
!= PADDED_SIZE
)
173 return verify_buffer(ptr
);
176 static void socfpgaimage_print_header(const void *ptr
)
178 if (verify_buffer(ptr
) == 0)
179 printf("Looks like a sane SOCFPGA preloader\n");
181 printf("Not a sane SOCFPGA preloader\n");
184 static int socfpgaimage_check_params(struct image_tool_params
*params
)
186 /* Not sure if we should be accepting fflags */
187 return (params
->dflag
&& (params
->fflag
|| params
->lflag
)) ||
188 (params
->fflag
&& (params
->dflag
|| params
->lflag
)) ||
189 (params
->lflag
&& (params
->dflag
|| params
->fflag
));
192 static int socfpgaimage_check_image_types(uint8_t type
)
194 if (type
== IH_TYPE_SOCFPGAIMAGE
)
200 * To work in with the mkimage framework, we do some ugly stuff...
202 * First, socfpgaimage_vrec_header() is called.
203 * We prepend a fake header big enough to make the file PADDED_SIZE.
204 * This gives us enough space to do what we want later.
206 * Next, socfpgaimage_set_header() is called.
207 * We fix up the buffer by moving the image to the start of the buffer.
208 * We now have some room to do what we need (add CRC and padding).
211 static int data_size
;
212 #define FAKE_HEADER_SIZE (PADDED_SIZE - data_size)
214 static int socfpgaimage_vrec_header(struct image_tool_params
*params
,
215 struct image_type_params
*tparams
)
219 if (params
->datafile
&&
220 stat(params
->datafile
, &sbuf
) == 0 &&
221 sbuf
.st_size
<= MAX_INPUT_SIZE
) {
222 data_size
= sbuf
.st_size
;
223 tparams
->header_size
= FAKE_HEADER_SIZE
;
228 static void socfpgaimage_set_header(void *ptr
, struct stat
*sbuf
, int ifd
,
229 struct image_tool_params
*params
)
231 uint8_t *buf
= (uint8_t *)ptr
;
234 * This function is called after vrec_header() has been called.
235 * At this stage we have the FAKE_HEADER_SIZE dummy bytes followed by
236 * data_size image bytes. Total = PADDED_SIZE.
237 * We need to fix the buffer by moving the image bytes back to
238 * the beginning of the buffer, then actually do the signing stuff...
240 memmove(buf
, buf
+ FAKE_HEADER_SIZE
, data_size
);
241 memset(buf
+ data_size
, 0, FAKE_HEADER_SIZE
);
243 sign_buffer(buf
, 0, 0, data_size
, 0);
248 "Altera SOCFPGA preloader support",
249 0, /* This will be modified by vrec_header() */
251 socfpgaimage_check_params
,
252 socfpgaimage_verify_header
,
253 socfpgaimage_print_header
,
254 socfpgaimage_set_header
,
256 socfpgaimage_check_image_types
,
258 socfpgaimage_vrec_header