Generate DTB in runtime

Author: RinHizakura

.gitignore

@@ -20,6 +20,8 @@ build/linux-x86-softfp/
 build/riscv32/
 build/sail_cSim/
 build/sha1sum-*
+build/bin_to_c
+build/minimal.dtb
 *.a
 *.o
 *.o.d
@@ -29,3 +31,4 @@ tests/arch-test-target/sail_cSim/riscv_sim_RV32
 tests/scimark2/
 __pycache__/
 src/rv32_jit.c
+src/minimal_dtb.h

Makefile

@@ -241,7 +241,7 @@ include mk/artifact.mk
 include mk/wasm.mk
 include mk/system.mk
 
-all: config $(BUILD_DTB) $(BIN)
+all: config $(BUILD_DTB) $(BUILD_DTB2C) $(BIN)
 
 OBJS := \
 	map.o \
@@ -369,7 +369,7 @@ endif
 endif
 
 clean:
-	$(RM) $(BIN) $(OBJS) $(DEV_OBJS) $(BUILD_DTB) $(HIST_BIN) $(HIST_OBJS) $(deps) $(WEB_FILES) $(CACHE_OUT) src/rv32_jit.c
+	$(RM) $(BIN) $(OBJS) $(DEV_OBJS) $(BUILD_DTB) $(BUILD_DTB2C) $(HIST_BIN) $(HIST_OBJS) $(deps) $(WEB_FILES) $(CACHE_OUT) src/rv32_jit.c
 distclean: clean
 	-$(RM) $(DOOM_DATA) $(QUAKE_DATA) $(BUILDROOT_DATA) $(LINUX_DATA)
 	$(RM) -r $(OUT)/linux-image

README.md

@@ -77,7 +77,7 @@ $ make ENABLE_SYSTEM=1 system
 Build using run using specified images:
 ```shell
 $ make ENABLE_SYSTEM=1
-$ build/rv32emu -k <kernel_img_path> -i <rootfs_img_path> -b <dtb_path>
+$ build/rv32emu -k <kernel_img_path> -i <rootfs_img_path>
 ```
 
 #### Build Linux image

mk/system.mk

@@ -4,10 +4,18 @@ ifeq ($(call has, SYSTEM), 1)
 DEV_SRC := src/devices
 
 DTC ?= dtc
-$(OUT)/minimal.dtb: $(DEV_SRC)/minimal.dts
+BUILD_DTB := $(OUT)/minimal.dtb
+$(BUILD_DTB): $(DEV_SRC)/minimal.dts
 	$(VECHO) " DTC\t$@\n"
 	$(Q)$(DTC) $^ -o $@
-BUILD_DTB := $(OUT)/minimal.dtb
+
+BIN_TO_C := $(OUT)/bin_to_c
+$(BIN_TO_C): tools/bin_to_c.c
+	$(Q)$(CC) -Wall -o $@ $^
+
+BUILD_DTB2C := src/minimal_dtb.h
+$(BUILD_DTB2C): $(BIN_TO_C) $(BUILD_DTB)
+	$(BIN_TO_C) $(BUILD_DTB) > $(BUILD_DTB2C)
 
 $(DEV_OUT)/%.o: $(DEV_SRC)/%.c $(deps_emcc)
 	$(Q)mkdir -p $(DEV_OUT)
@@ -20,8 +28,8 @@ OBJS_EXT += system.o
 
 # system target execution by using default dependencies
 LINUX_IMAGE_DIR := linux-image
-system_action := ($(BIN) -k $(OUT)/$(LINUX_IMAGE_DIR)/Image -i $(OUT)/$(LINUX_IMAGE_DIR)/rootfs.cpio -b $(OUT)/minimal.dtb)
-system_deps += artifact $(BUILD_DTB) $(BIN)
+system_action := ($(BIN) -k $(OUT)/$(LINUX_IMAGE_DIR)/Image -i $(OUT)/$(LINUX_IMAGE_DIR)/rootfs.cpio)
+system_deps += artifact $(BUILD_DTB) $(BUILD_DTB2C) $(BIN)
 system: $(system_deps)
 	$(system_action)
 

src/main.c

@@ -42,7 +42,7 @@ static char *opt_prog_name;
 /* target argc and argv */
 static int prog_argc;
 static char **prog_args;
-static const char *optstr = "tgqmhpd:a:k:i:b:";
+static const char *optstr = "tgqmhpd:a:k:i:";
 
 /* enable misaligned memory access */
 static bool opt_misaligned = false;
@@ -55,7 +55,6 @@ static char *prof_out_file;
 /* Linux kernel data */
 static char *opt_kernel_img;
 static char *opt_rootfs_img;
-static char *opt_dtb;
 #endif
 
 static void print_usage(const char *filename)
@@ -73,7 +72,6 @@ static void print_usage(const char *filename)
 #if RV32_HAS(SYSTEM) && !RV32_HAS(ELF_LOADER)
             "  -k <image> : use <image> as kernel image\n"
             "  -i <image> : use <image> as rootfs\n"
-            "  -b <dtb> : use <dtb> as device tree blob\n"
 #endif
             "  -d [filename]: dump registers as JSON to the "
             "given file or `-` (STDOUT)\n"
@@ -114,10 +112,6 @@ static bool parse_args(int argc, char **args)
             opt_rootfs_img = optarg;
             emu_argc++;
             break;
-        case 'b':
-            opt_dtb = optarg;
-            emu_argc++;
-            break;
 #endif
         case 'q':
             opt_quiet_outputs = true;
@@ -263,7 +257,6 @@ int main(int argc, char **args)
 #if RV32_HAS(SYSTEM) && !RV32_HAS(ELF_LOADER)
     attr.data.system.kernel = opt_kernel_img;
     attr.data.system.initrd = opt_rootfs_img;
-    attr.data.system.dtb = opt_dtb;
 #else
     attr.data.user.elf_program = opt_prog_name;
 #endif

src/riscv.c

@@ -259,6 +259,14 @@ static void map_file(char **ram_loc, const char *name)
     exit(EXIT_FAILURE);
 }
 
+static void load_dtb(char **ram_loc)
+{
+#include "minimal_dtb.h"
+    memcpy(*ram_loc, minimal, sizeof(minimal));
+    *ram_loc += sizeof(minimal);
+    return;
+}
+
 /*
  * The control mode flag for keyboard.
  *
@@ -294,6 +302,7 @@ static void capture_keyboard_input()
     term.c_lflag &= ~TERMIOS_C_CFLAG;
     tcsetattr(0, TCSANOW, &term);
 }
+
 #endif
 
 /*
@@ -409,7 +418,7 @@ riscv_t *rv_create(riscv_user_t rv_attr)
 
     uint32_t dtb_addr = attr->mem->mem_size - (1 * 1024 * 1024);
     ram_loc = ((char *) attr->mem->mem_base) + dtb_addr;
-    map_file(&ram_loc, attr->data.system.dtb);
+    load_dtb(&ram_loc);
     /*
      * Load optional initrd image at last 8 MiB before the dtb region to
      * prevent kernel from overwritting it
@@ -517,8 +526,7 @@ void rv_run(riscv_t *rv)
     vm_attr_t *attr = PRIV(rv);
     assert(attr &&
 #if RV32_HAS(SYSTEM) && !RV32_HAS(ELF_LOADER)
-           attr->data.system.kernel && attr->data.system.initrd &&
-           attr->data.system.dtb
+           attr->data.system.kernel && attr->data.system.initrd
 #else
            attr->data.user.elf_program
 #endif

src/riscv.h

@@ -551,7 +551,6 @@ typedef struct {
 typedef struct {
     char *kernel;
     char *initrd;
-    char *dtb;
 } vm_system_t;
 #endif /* RV32_HAS(SYSTEM) */
 

tools/bin_to_c.c

@@ -0,0 +1,152 @@
+//
+// bin_to_c - convert binary data into c-compatible data tables
+//
+// Written by Larry Bank
+// Copyright (c) 2009 BitBank Software, Inc.
+// Change history
+// 2/1/09 - Started the project
+// 11/6/15 - converted to Linux
+// 7/29/20 - tailored to Arduino FLASH data output
+//
+#include <stdint.h>
+#include <string.h>
+#include <stdio.h>
+#include <stdlib.h>
+FILE * ihandle;
+void MakeC(unsigned char *, int, int);
+void GetLeafName(char *fname, char *leaf);
+void FixName(char *name);
+
+int main(int argc, char *argv[])
+{
+int iSize, iData;
+unsigned char *p;
+char szLeaf[256];
+
+   if (argc != 2)
+      {
+      printf("bin_to_c Copyright (c) 2013 BitBank Software, Inc.\n"); 
+      printf("Usage: bin_to_c <filename>\n");
+      printf("output is written to stdout\n"); 
+      return 0; // no filename passed
+      }
+   ihandle = fopen(argv[1],"rb"); // open input file
+   if (ihandle == NULL)
+      {
+      printf("Unable to open file: %s\n", argv[1]);
+      return -1; // bad filename passed
+      }
+   
+   fseek(ihandle, 0L, SEEK_END); // get the file size
+   iSize = (int)ftell(ihandle);
+   fseek(ihandle, 0, SEEK_SET);
+   p = (unsigned char *)malloc(0x10000); // allocate 64k to play with
+   GetLeafName(argv[1], szLeaf);
+   printf("//\n// %s\n//\n", szLeaf); // comment header with filename
+   FixName(szLeaf); // remove unusable characters
+   printf("const uint8_t %s[] = {", szLeaf); // start of data array
+   while (iSize)
+   {
+      iData = fread(p, 1, 0x10000, ihandle); // try to read 64k
+      MakeC(p, iData, iSize == iData); // create the output data
+      iSize -= iData;
+   }
+   free(p);
+   fclose(ihandle);
+   printf("};\n"); // final closing brace
+   return 0;
+} /* main() */
+//
+// Generate C hex characters from each byte of file data
+//
+void MakeC(unsigned char *p, int iLen, int bLast)
+{
+int i, j, iCount;
+char szTemp[256], szOut[256];
+
+   iCount = 0;
+   for (i=0; i<iLen>>4; i++) // do lines of 16 bytes
+   {
+      strcpy(szOut, "\t");
+      for (j=0; j<16; j++)
+      {
+         if (iCount == iLen-1 && bLast) // last one, skip the comma
+            sprintf(szTemp, "0x%02x", p[(i*16)+j]);
+         else
+            sprintf(szTemp, "0x%02x,", p[(i*16)+j]);
+         strcat(szOut, szTemp);
+         iCount++;
+      }
+      if (!bLast || iCount != iLen)
+         strcat(szOut, "\n");
+      printf("%s",szOut);
+   }
+   p += (iLen & 0xfff0); // point to last section
+   if (iLen & 0xf) // any remaining characters?
+      {
+      strcpy(szOut, "\t");
+      for (j=0; j<(iLen & 0xf); j++)
+      {
+         if (iCount == iLen-1 && bLast)
+            sprintf(szTemp, "0x%02x", p[j]);
+         else
+            sprintf(szTemp, "0x%02x,", p[j]);
+         strcat(szOut, szTemp);
+         iCount++;
+      }
+      if (!bLast)
+         strcat(szOut, "\n");
+      printf("%s",szOut);
+      }
+} /* MakeC() */
+//
+// Make sure the name can be used in C/C++ as a variable
+// replace invalid characters and make sure it starts with a letter
+//
+void FixName(char *name)
+{
+char c, *d, *s, szTemp[256];
+int i, iLen;
+
+   iLen = strlen(name);
+   d = szTemp;
+   s = name;
+   if (s[0] >= '0' && s[0] <= '9') // starts with a digit
+      *d++ = '_'; // Insert an underscore
+   for (i=0; i<iLen; i++)
+   {
+      c = *s++;
+      // these characters can't be in a variable name
+      if (c < ' ' || (c >= '!' && c < '0') || (c > 'Z' && c < 'a'))
+         c = '_'; // convert all to an underscore
+      *d++ = c;
+   }
+   *d++ = 0;
+   strcpy(name, szTemp);
+} /* FixName() */
+//
+// Trim off the leaf name from a fully
+// formed file pathname
+//
+void GetLeafName(char *fname, char *leaf)
+{
+int i, iLen;
+   
+   iLen = strlen(fname);
+   for (i=iLen-1; i>=0; i--)
+      {
+      if (fname[i] == '\\' || fname[i] == '/') // Windows or Linux
+         break;
+      }
+   strcpy(leaf, &fname[i+1]);
+   // remove the filename extension
+   iLen = strlen(leaf); 
+   for (i=iLen-1; i>=0; i--)
+   {
+      if (leaf[i] == '.')
+      {
+         leaf[i] = 0;
+         break;
+      }
+   }
+} /* GetLeafName() */