Subversion Repositories neorv32

// #################################################################################################

// # << NEORV32 - Executable image generator tool >>                                               #

// # ********************************************************************************************* #

// # BSD 3-Clause License                                                                          #

// #                                                                                               #

// # Copyright (c) 2021, Stephan Nolting. All rights reserved.                                     #

// #                                                                                               #

// # Redistribution and use in source and binary forms, with or without modification, are          #

// # permitted provided that the following conditions are met:                                     #

// #                                                                                               #

// # 1. Redistributions of source code must retain the above copyright notice, this list of        #

// #    conditions and the following disclaimer.                                                   #

// #                                                                                               #

// # 2. Redistributions in binary form must reproduce the above copyright notice, this list of     #

// #    conditions and the following disclaimer in the documentation and/or other materials        #

// #    provided with the distribution.                                                            #

// #                                                                                               #

// # 3. Neither the name of the copyright holder nor the names of its contributors may be used to  #

// #    endorse or promote products derived from this software without specific prior written      #

// #    permission.                                                                                #

// #                                                                                               #

// # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS   #

// # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF               #

// # MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE    #

// # COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,     #

// # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE #

// # GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED    #

// # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING     #

// # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED  #

// # OF THE POSSIBILITY OF SUCH DAMAGE.                                                            #

// # ********************************************************************************************* #

// # The NEORV32 Processor - https://github.com/stnolting/neorv32              (c) Stephan Nolting #

// #################################################################################################

#include <stdint.h>

#include <stdio.h>

#include <stdlib.h>

#include <string.h>

const uint32_t signature = 0x4788CAFE;

int main(int argc, char *argv[]) {

  if ((argc != 4) && (argc != 5)){

        printf("<<< NEORV32 executable image generator >>>\n"

                 "by Stephan Nolting\n"

                 "Three arguments are required.\n"

                 "1st: Option\n"

                 " -app_bin : Generate application executable binary (binary file, little-endian, with header) \n"

                 " -app_hex : Generate application raw executable (hex file, no header)\n"

                 " -app_img : Generate application raw executable memory image (vhdl file, no header)\n"

                 " -bld_img : Generate bootloader raw executable memory image (vdhl file, no header)\n"

                       "2nd: Input file (raw binary image)\n"

                       "3rd: Output file\n"

                       "4th: Project folder (optional)\n");

        return 0;

  }

  FILE *input, *output;

  unsigned char buffer[4];

  char tmp_string[1024];

  uint32_t tmp = 0, size = 0, checksum = 0;

  unsigned int i = 0;

  int option = 0;

  unsigned long raw_exe_size = 0;

  if (strcmp(argv[1], "-app_bin") == 0)

    option = 1;

  else if (strcmp(argv[1], "-app_img") == 0)

    option = 2;

  else if (strcmp(argv[1], "-bld_img") == 0)

    option = 3;

  else if (strcmp(argv[1], "-app_hex") == 0)

    option = 4;

  else {

        printf("Invalid option!");

        return 1;

  }

  // open input file

  input = fopen(argv[2], "rb");

  if(input == NULL){

    printf("Input file error!");

    return 2;

  }

  // open output file

  output = fopen(argv[3], "wb");

  if(output == NULL){

    printf("Output file error!");

    return 3;

  }

  // get input file size

  fseek(input, 0L, SEEK_END);

  unsigned int input_size = (unsigned int)ftell(input);

  rewind(input);

  unsigned int input_words = input_size / 4;

// ------------------------------------------------------------

// Get size of application (in bytes)

// ------------------------------------------------------------

  fseek(input, 0L, SEEK_END);

  // get file size (raw executable)

  raw_exe_size = (unsigned long)ftell(input);

  // go back to beginning

  rewind(input);

// ------------------------------------------------------------

// Generate BINARY executable (with header!!!) for bootloader upload

// ------------------------------------------------------------

  if (option == 1) {

    // reserve header space for signature

    fputc(char(0), output);

    fputc(char(0), output);

    fputc(char(0), output);

    fputc(char(0), output);

    // reserve header space for size

    fputc(char(0), output);

    fputc(char(0), output);

    fputc(char(0), output);

    fputc(char(0), output);

    // reserve header space for checksum

    fputc(char(0), output);

    fputc(char(0), output);

    fputc(char(0), output);

    fputc(char(0), output);

    buffer[0] = 0;

    buffer[1] = 0;

    buffer[2] = 0;

    buffer[3] = 0;

    checksum = 0;

    size = 0;

    rewind(input);

    while(fread(&buffer, sizeof(unsigned char), 4, input) != 0) {

      tmp  = (uint32_t)(buffer[0] << 0);

      tmp |= (uint32_t)(buffer[1] << 8);

      tmp |= (uint32_t)(buffer[2] << 16);

      tmp |= (uint32_t)(buffer[3] << 24);

      checksum += tmp; // checksum: sum complement

      fputc(buffer[0], output);

      fputc(buffer[1], output);

      fputc(buffer[2], output);

      fputc(buffer[3], output);

      size += 4;

    }

    rewind(output);

    // header: signature

    fputc((unsigned char)((signature >>  0) & 0xFF), output);

    fputc((unsigned char)((signature >>  8) & 0xFF), output);

    fputc((unsigned char)((signature >> 16) & 0xFF), output);

    fputc((unsigned char)((signature >> 24) & 0xFF), output);

    // header: size

    fputc((unsigned char)((size >>  0) & 0xFF), output);

    fputc((unsigned char)((size >>  8) & 0xFF), output);

    fputc((unsigned char)((size >> 16) & 0xFF), output);

    fputc((unsigned char)((size >> 24) & 0xFF), output);

    // header: checksum (sum complement)

    checksum = (~checksum) + 1;

    fputc((unsigned char)((checksum >>  0) & 0xFF), output);

    fputc((unsigned char)((checksum >>  8) & 0xFF), output);

    fputc((unsigned char)((checksum >> 16) & 0xFF), output);

    fputc((unsigned char)((checksum >> 24) & 0xFF), output);

  }

// ------------------------------------------------------------

// Generate APPLICATION's executable memory init file (no header!!!)

// ------------------------------------------------------------

  if (option == 2) {

        // header

    sprintf(tmp_string, "-- The NEORV32 RISC-V Processor, https://github.com/stnolting/neorv32\n"

                                                            "-- Auto-generated memory init file (for APPLICATION) from source file <%s/%s>\n"

                                                            "-- Size: %lu bytes\n"

                                                            "\n"

                                                            "library ieee;\n"

                                                            "use ieee.std_logic_1164.all;\n"

                                                            "\n"

                        "library neorv32;\n"

                        "use neorv32.neorv32_package.all;\n"

                                                            "\n"

                                                            "package neorv32_application_image is\n"

                                                            "\n"

                                                            "  constant application_init_image : mem32_t := (\n", argv[4], argv[2], raw_exe_size);

    fputs(tmp_string, output);

        // data

    buffer[0] = 0;

    buffer[1] = 0;

    buffer[2] = 0;

    buffer[3] = 0;

    i = 0;

    while (i < (input_words-1)) {

      if (fread(&buffer, sizeof(unsigned char), 4, input) != 0) {

        tmp  = (uint32_t)(buffer[0] << 0);

        tmp |= (uint32_t)(buffer[1] << 8);

        tmp |= (uint32_t)(buffer[2] << 16);

        tmp |= (uint32_t)(buffer[3] << 24);

        sprintf(tmp_string, "    %08d => x\"%08x\",\n", i, (unsigned int)tmp);

        fputs(tmp_string, output);

        buffer[0] = 0;

        buffer[1] = 0;

        buffer[2] = 0;

        buffer[3] = 0;

        i++;

      }

      else {

        printf("Unexpected input file end!\n");

        break;

      }

    }

    if (fread(&buffer, sizeof(unsigned char), 4, input) != 0) {

      tmp  = (uint32_t)(buffer[0] << 0);

      tmp |= (uint32_t)(buffer[1] << 8);

      tmp |= (uint32_t)(buffer[2] << 16);

      tmp |= (uint32_t)(buffer[3] << 24);

      sprintf(tmp_string, "    %08d => x\"%08x\"\n", i, (unsigned int)tmp);

      fputs(tmp_string, output);

      buffer[0] = 0;

      buffer[1] = 0;

      buffer[2] = 0;

      buffer[3] = 0;

      i++;

    }

    else {

      printf("Unexpected input file end!\n");

    }

        // end

    sprintf(tmp_string, "  );\n"

                                                            "\n"

                                                            "end neorv32_application_image;\n");

    fputs(tmp_string, output);

  }

// ------------------------------------------------------------

// Generate BOOTLOADER's executable memory init file (no header!!!)

// ------------------------------------------------------------

  if (option == 3) {

        // header

    sprintf(tmp_string, "-- The NEORV32 RISC-V Processor, https://github.com/stnolting/neorv32\n"

                                                            "-- Auto-generated memory init file (for BOOTLOADER) from source file <%s/%s>\n"

                                                            "-- Size: %lu bytes\n"

                                                            "\n"

                                                            "library ieee;\n"

                                                            "use ieee.std_logic_1164.all;\n"

                                                            "\n"

                        "library neorv32;\n"

                        "use neorv32.neorv32_package.all;\n"

                                                            "\n"

                                                            "package neorv32_bootloader_image is\n"

                                                            "\n"

                                                            "  constant bootloader_init_image : mem32_t := (\n", argv[4], argv[2], raw_exe_size);

    fputs(tmp_string, output);

    // data

    buffer[0] = 0;

    buffer[1] = 0;

    buffer[2] = 0;

    buffer[3] = 0;

    i = 0;

    while (i < (input_words-1)) {

      if (fread(&buffer, sizeof(unsigned char), 4, input) != 0) {

        tmp  = (uint32_t)(buffer[0] << 0);

        tmp |= (uint32_t)(buffer[1] << 8);

        tmp |= (uint32_t)(buffer[2] << 16);

        tmp |= (uint32_t)(buffer[3] << 24);

        sprintf(tmp_string, "    %08d => x\"%08x\",\n", i, (unsigned int)tmp);

        fputs(tmp_string, output);

        buffer[0] = 0;

        buffer[1] = 0;

        buffer[2] = 0;

        buffer[3] = 0;

        i++;

      }

      else {

        printf("Unexpected input file end!\n");

        break;

      }

    }

    if (fread(&buffer, sizeof(unsigned char), 4, input) != 0) {

      tmp  = (uint32_t)(buffer[0] << 0);

      tmp |= (uint32_t)(buffer[1] << 8);

      tmp |= (uint32_t)(buffer[2] << 16);

      tmp |= (uint32_t)(buffer[3] << 24);

      sprintf(tmp_string, "    %08d => x\"%08x\"\n", i, (unsigned int)tmp);

      fputs(tmp_string, output);

      buffer[0] = 0;

      buffer[1] = 0;

      buffer[2] = 0;

      buffer[3] = 0;

      i++;

    }

    else {

      printf("Unexpected input file end!\n");

    }

        // end

    sprintf(tmp_string, "  );\n"

                                                            "\n"

                                                            "end neorv32_bootloader_image;\n");

    fputs(tmp_string, output);

  }

// ------------------------------------------------------------

// Generate APPLICATION's executable hex file (no header!!!)

// ------------------------------------------------------------

  if (option == 4) {

    // data

    buffer[0] = 0;

    buffer[1] = 0;

    buffer[2] = 0;

    buffer[3] = 0;

    i = 0;

    while(fread(&buffer, sizeof(unsigned char), 4, input) != 0) {

      tmp  = (uint32_t)(buffer[0] << 0);

      tmp |= (uint32_t)(buffer[1] << 8);

      tmp |= (uint32_t)(buffer[2] << 16);

      tmp |= (uint32_t)(buffer[3] << 24);

      sprintf(tmp_string, "%08x\n", (unsigned int)tmp);

      fputs(tmp_string, output);

    }

  }

  fclose(input);

  fclose(output);

  return 0;

}