tools/socfpgaimage.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright (C) 2014 Charles Manning <cdhmanning@gmail.com>
   4  *
   5  * 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
   9  *
  10  * Bootable SoCFPGA image requires a structure of the following format
  11  * positioned at offset 0x40 of the bootable image. Endian is LSB.
  12  *
  13  * 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.
  16  *
  17  * Version 0:
  18  * Offset   Length   Usage
  19  * -----------------------
  20  *   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)
  25  *   0x4A        2   Checksum over the header. NB Not CRC32
  26  *
  27  * 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  *
  39  * 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  *
  45  * 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  *
  51  * 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"
  57 #include "mkimage.h"
  58 #include <u-boot/crc.h>
  59
  60 #include <image.h>
  61
  62 #define HEADER_OFFSET   0x40
  63 #define VALIDATION_WORD 0x31305341
  64
  65 /* Minimum and default entry point offset */
  66 #define ENTRY_POINT_OFFSET      0x14
  67
  68 static uint8_t buffer_v0[0x10000];
  69 static uint8_t buffer_v1[0x40000];
  70
  71 struct socfpga_header_v0 {
  72         uint32_t        validation;
  73         uint8_t         version;
  74         uint8_t         flags;
  75         uint16_t        length_u32;
  76         uint16_t        zero;
  77         uint16_t        checksum;
  78 };
  79
  80 struct socfpga_header_v1 {
  81         uint32_t        validation;
  82         uint8_t         version;
  83         uint8_t         flags;
  84         uint16_t        header_u8;
  85         uint32_t        length_u8;
  86         uint32_t        entry_offset;
  87         uint16_t        zero;
  88         uint16_t        checksum;
  89 };
  90
  91 static unsigned int sfp_hdr_size(uint8_t ver)
  92 {
  93         if (ver == 0)
  94                 return sizeof(struct socfpga_header_v0);
  95         if (ver == 1)
  96                 return sizeof(struct socfpga_header_v1);
  97         return 0;
  98 }
  99
 100 static unsigned int sfp_pad_size(uint8_t ver)
 101 {
 102         if (ver == 0)
 103                 return sizeof(buffer_v0);
 104         if (ver == 1)
 105                 return sizeof(buffer_v1);
 106         return 0;
 107 }
 108
 109 /*
 110  * The header checksum is just a very simple checksum over
 111  * the header area.
 112  * There is still a crc32 over the whole lot.
 113  */
 114 static uint16_t sfp_hdr_checksum(uint8_t *buf, unsigned char ver)
 115 {
 116         uint16_t ret = 0;
 117         int len = sfp_hdr_size(ver) - sizeof(ret);
 118
 119         while (--len)
 120                 ret += *buf++;
 121
 122         return ret;
 123 }
 124
 125 static void sfp_build_header(uint8_t *buf, uint8_t ver, uint8_t flags,
 126                              uint32_t length_bytes)
 127 {
 128         struct socfpga_header_v0 header_v0 = {
 129                 .validation     = cpu_to_le32(VALIDATION_WORD),
 130                 .version        = 0,
 131                 .flags          = flags,
 132                 .length_u32     = cpu_to_le16(length_bytes / 4),
 133                 .zero           = 0,
 134         };
 135
 136         struct socfpga_header_v1 header_v1 = {
 137                 .validation     = cpu_to_le32(VALIDATION_WORD),
 138                 .version        = 1,
 139                 .flags          = flags,
 140                 .header_u8      = cpu_to_le16(sizeof(header_v1)),
 141                 .length_u8      = cpu_to_le32(length_bytes),
 142                 .entry_offset   = cpu_to_le32(0x14),    /* Trampoline offset */
 143                 .zero           = 0,
 144         };
 145
 146         uint16_t csum;
 147
 148         if (ver == 0) {
 149                 csum = sfp_hdr_checksum((uint8_t *)&header_v0, 0);
 150                 header_v0.checksum = cpu_to_le16(csum);
 151                 memcpy(buf, &header_v0, sizeof(header_v0));
 152         } else {
 153                 csum = sfp_hdr_checksum((uint8_t *)&header_v1, 1);
 154                 header_v1.checksum = cpu_to_le16(csum);
 155                 memcpy(buf, &header_v1, sizeof(header_v1));
 156         }
 157 }
 158
 159 /*
 160  * Perform a rudimentary verification of header and return
 161  * size of image.
 162  */
 163 static int sfp_verify_header(const uint8_t *buf, uint8_t *ver)
 164 {
 165         struct socfpga_header_v0 header_v0;
 166         struct socfpga_header_v1 header_v1;
 167         uint16_t hdr_csum, sfp_csum;
 168         uint32_t img_len;
 169
 170         /*
 171          * Header v0 is always smaller than Header v1 and the validation
 172          * word and version field is at the same place, so use Header v0
 173          * to check for version during verifiction and upgrade to Header
 174          * v1 if needed.
 175          */
 176         memcpy(&header_v0, buf, sizeof(header_v0));
 177
 178         if (le32_to_cpu(header_v0.validation) != VALIDATION_WORD)
 179                 return -1;
 180
 181         if (header_v0.version == 0) {
 182                 hdr_csum = le16_to_cpu(header_v0.checksum);
 183                 sfp_csum = sfp_hdr_checksum((uint8_t *)&header_v0, 0);
 184                 img_len = le16_to_cpu(header_v0.length_u32) * 4;
 185         } else if (header_v0.version == 1) {
 186                 memcpy(&header_v1, buf, sizeof(header_v1));
 187                 hdr_csum = le16_to_cpu(header_v1.checksum);
 188                 sfp_csum = sfp_hdr_checksum((uint8_t *)&header_v1, 1);
 189                 img_len = le32_to_cpu(header_v1.length_u8);
 190         } else {        /* Invalid version */
 191                 return -EINVAL;
 192         }
 193
 194         /* Verify checksum */
 195         if (hdr_csum != sfp_csum)
 196                 return -EINVAL;
 197
 198         *ver = header_v0.version;
 199         return img_len;
 200 }
 201
 202 /* Sign the buffer and return the signed buffer size */
 203 static int sfp_sign_buffer(uint8_t *buf, uint8_t ver, uint8_t flags,
 204                            int len, int pad_64k)
 205 {
 206         uint32_t calc_crc;
 207
 208         /* Align the length up */
 209         len = ALIGN(len, 4);
 210
 211         /* Build header, adding 4 bytes to length to hold the CRC32. */
 212         sfp_build_header(buf + HEADER_OFFSET, ver, flags, len + 4);
 213
 214         /* Calculate and apply the CRC */
 215         calc_crc = ~pbl_crc32(0, (char *)buf, len);
 216
 217         *((uint32_t *)(buf + len)) = cpu_to_le32(calc_crc);
 218
 219         if (!pad_64k)
 220                 return len + 4;
 221
 222         return sfp_pad_size(ver);
 223 }
 224
 225 /* Verify that the buffer looks sane */
 226 static int sfp_verify_buffer(const uint8_t *buf)
 227 {
 228         int len; /* Including 32bit CRC */
 229         uint32_t calc_crc;
 230         uint32_t buf_crc;
 231         uint8_t ver = 0;
 232
 233         len = sfp_verify_header(buf + HEADER_OFFSET, &ver);
 234         if (len < 0) {
 235                 debug("Invalid header\n");
 236                 return -1;
 237         }
 238
 239         if (len < HEADER_OFFSET || len > sfp_pad_size(ver)) {
 240                 debug("Invalid header length (%i)\n", len);
 241                 return -1;
 242         }
 243
 244         /*
 245          * Adjust length to the base of the CRC.
 246          * Check the CRC.
 247         */
 248         len -= 4;
 249
 250         calc_crc = ~pbl_crc32(0, (const char *)buf, len);
 251
 252         buf_crc = le32_to_cpu(*((uint32_t *)(buf + len)));
 253
 254         if (buf_crc != calc_crc) {
 255                 fprintf(stderr, "CRC32 does not match (%08x != %08x)\n",
 256                         buf_crc, calc_crc);
 257                 return -1;
 258         }
 259
 260         return 0;
 261 }
 262
 263 /* mkimage glue functions */
 264 static int socfpgaimage_verify_header(unsigned char *ptr, int image_size,
 265                                       struct image_tool_params *params)
 266 {
 267         if (image_size < 0x80)
 268                 return -1;
 269
 270         return sfp_verify_buffer(ptr);
 271 }
 272
 273 static void socfpgaimage_print_header(const void *ptr)
 274 {
 275         if (sfp_verify_buffer(ptr) == 0)
 276                 printf("Looks like a sane SOCFPGA preloader\n");
 277         else
 278                 printf("Not a sane SOCFPGA preloader\n");
 279 }
 280
 281 static int socfpgaimage_check_params_v0(struct image_tool_params *params)
 282 {
 283         /* Not sure if we should be accepting fflags */
 284         return  (params->dflag && (params->fflag || params->lflag)) ||
 285                 (params->fflag && (params->dflag || params->lflag)) ||
 286                 (params->lflag && (params->dflag || params->fflag));
 287 }
 288
 289 static int socfpgaimage_check_params_v1(struct image_tool_params *params)
 290 {
 291         /*
 292          * If the entry point is specified, ensure it is >= ENTRY_POINT_OFFSET
 293          * and it is 4 bytes aligned.
 294          */
 295         if (params->eflag && (params->ep < ENTRY_POINT_OFFSET ||
 296                               params->ep % 4 != 0)) {
 297                 fprintf(stderr,
 298                         "Error: Entry point must be greater than 0x%x.\n",
 299                         ENTRY_POINT_OFFSET);
 300                 return -1;
 301         }
 302
 303         /* Not sure if we should be accepting fflags */
 304         return  (params->dflag && (params->fflag || params->lflag)) ||
 305                 (params->fflag && (params->dflag || params->lflag)) ||
 306                 (params->lflag && (params->dflag || params->fflag));
 307 }
 308
 309 static int socfpgaimage_check_image_types_v0(uint8_t type)
 310 {
 311         if (type == IH_TYPE_SOCFPGAIMAGE)
 312                 return EXIT_SUCCESS;
 313         return EXIT_FAILURE;
 314 }
 315
 316 static int socfpgaimage_check_image_types_v1(uint8_t type)
 317 {
 318         if (type == IH_TYPE_SOCFPGAIMAGE_V1)
 319                 return EXIT_SUCCESS;
 320         return EXIT_FAILURE;
 321 }
 322
 323 /*
 324  * To work in with the mkimage framework, we do some ugly stuff...
 325  *
 326  * First, socfpgaimage_vrec_header() is called.
 327  * We prepend a fake header big enough to make the file sfp_pad_size().
 328  * This gives us enough space to do what we want later.
 329  *
 330  * Next, socfpgaimage_set_header() is called.
 331  * We fix up the buffer by moving the image to the start of the buffer.
 332  * We now have some room to do what we need (add CRC and padding).
 333  */
 334
 335 static int data_size;
 336
 337 static int sfp_fake_header_size(unsigned int size, uint8_t ver)
 338 {
 339         return sfp_pad_size(ver) - size;
 340 }
 341
 342 static int sfp_vrec_header(struct image_tool_params *params,
 343                            struct image_type_params *tparams, uint8_t ver)
 344 {
 345         struct stat sbuf;
 346
 347         if (params->datafile &&
 348             stat(params->datafile, &sbuf) == 0 &&
 349             sbuf.st_size <= (sfp_pad_size(ver) - sizeof(uint32_t))) {
 350                 data_size = sbuf.st_size;
 351                 tparams->header_size = sfp_fake_header_size(data_size, ver);
 352         }
 353         return 0;
 354
 355 }
 356
 357 static int socfpgaimage_vrec_header_v0(struct image_tool_params *params,
 358                                        struct image_type_params *tparams)
 359 {
 360         return sfp_vrec_header(params, tparams, 0);
 361 }
 362
 363 static int socfpgaimage_vrec_header_v1(struct image_tool_params *params,
 364                                        struct image_type_params *tparams)
 365 {
 366         return sfp_vrec_header(params, tparams, 1);
 367 }
 368
 369 static void sfp_set_header(void *ptr, unsigned char ver)
 370 {
 371         uint8_t *buf = (uint8_t *)ptr;
 372
 373         /*
 374          * This function is called after vrec_header() has been called.
 375          * At this stage we have the sfp_fake_header_size() dummy bytes
 376          * followed by data_size image bytes. Total = sfp_pad_size().
 377          * We need to fix the buffer by moving the image bytes back to
 378          * the beginning of the buffer, then actually do the signing stuff...
 379          */
 380         memmove(buf, buf + sfp_fake_header_size(data_size, ver), data_size);
 381         memset(buf + data_size, 0, sfp_fake_header_size(data_size, ver));
 382
 383         sfp_sign_buffer(buf, ver, 0, data_size, 0);
 384 }
 385
 386 static void socfpgaimage_set_header_v0(void *ptr, struct stat *sbuf, int ifd,
 387                                        struct image_tool_params *params)
 388 {
 389         sfp_set_header(ptr, 0);
 390 }
 391
 392 static void socfpgaimage_set_header_v1(void *ptr, struct stat *sbuf, int ifd,
 393                                        struct image_tool_params *params)
 394 {
 395         sfp_set_header(ptr, 1);
 396 }
 397
 398 U_BOOT_IMAGE_TYPE(
 399         socfpgaimage,
 400         "Altera SoCFPGA Cyclone V / Arria V image support",
 401         0, /* This will be modified by vrec_header() */
 402         (void *)buffer_v0,
 403         socfpgaimage_check_params_v0,
 404         socfpgaimage_verify_header,
 405         socfpgaimage_print_header,
 406         socfpgaimage_set_header_v0,
 407         NULL,
 408         socfpgaimage_check_image_types_v0,
 409         NULL,
 410         socfpgaimage_vrec_header_v0
 411 );
 412
 413 U_BOOT_IMAGE_TYPE(
 414         socfpgaimage_v1,
 415         "Altera SoCFPGA Arria10 image support",
 416         0, /* This will be modified by vrec_header() */
 417         (void *)buffer_v1,
 418         socfpgaimage_check_params_v1,
 419         socfpgaimage_verify_header,
 420         socfpgaimage_print_header,
 421         socfpgaimage_set_header_v1,
 422         NULL,
 423         socfpgaimage_check_image_types_v1,
 424         NULL,
 425         socfpgaimage_vrec_header_v1
 426 );