Initial Release

All the files for the initial release of the DESim software tool.

Author: fpgacademy

.gitignore

@@ -30,3 +30,37 @@
 *.exe
 *.out
 *.app
+
+# Compiled class file
+*.class
+
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.jar
+*.war
+*.nar
+*.ear
+*.zip
+*.tar.gz
+*.rar
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+
+# VI Swap Files
+*.swp
+
+# ModelSim VPI
+*.vpi
+
+# Software Build/Release Paths
+dist/
+out/

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 fpgacademy
+Copyright (c) 2020 fpgacademy
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1 +1,10 @@
-# DESim
+# DESim
+
+The DESim tool is an interactive graphical user interface showing features of a DE-Series board, such as switches, lights, and displays. The tool interfaces with the ModelSim simulation software. The simulation results affect the lights and displays in the GUI, as opposed to showing the waveforms corresponding to the signals being simulated.
+
+The DESim tool has three parts:
+1) The frontend graphical user interface
+2) The backend simulator interface
+3) Various demos showcasing the different capabilities of the tool
+
+The DESim tool requires the ModelSim HDL simuator. Preferably, one of the ModelSim-Intel FPGA editions, which has the Intel FPGA IP Core simulation models built-in.

backend/Makefile

@@ -0,0 +1,56 @@
+# Copyright (c) 2020 FPGAcademy
+# Please see license at https://github.com/fpgacademy/DESim
+
+MODELSIM_DIR = C:\intelFPGA\19.1\modelsim_ae
+
+CFLAGS = -m32 -static -c -Wall -g -fno-diagnostics-show-caret -fpic -Iinclude -I$(MODELSIM_DIR)/include
+LDFLAGS = -m32 -static -g -shared -lmtipli
+
+ifeq ($(OS),Windows_NT)
+	LDFLAGS += -lws2_32
+	LDFLAGS += -L$(MODELSIM_DIR)/win32aloem
+endif
+
+all: dist/simfpga.vpi
+
+utils.o: utils.c include/utils.h
+	gcc utils.c $(CFLAGS)
+
+fpga_output_device.o: fpga_output_device.cpp include/fpga_output_device.h
+	g++ fpga_output_device.cpp $(CFLAGS)
+
+fpga_input_device.o: fpga_input_device.cpp include/fpga_input_device.h
+	g++ fpga_input_device.cpp $(CFLAGS)
+
+fpga_inout_device.o: fpga_inout_device.cpp include/fpga_inout_device.h
+	g++ fpga_inout_device.cpp $(CFLAGS)
+
+keyboard_input.o: keyboard_input.cpp include/keyboard_input.h
+	g++ keyboard_input.cpp $(CFLAGS)
+
+fpga.o: fpga.cpp include/fpga*.h include/keyboard_input.h include/utils.h include/helper.h
+	g++ fpga.cpp $(CFLAGS)
+
+sim_task.o: sim_task.cpp include/sim_task.h include/fpga.h include/utils.h include/helper.h
+	g++ sim_task.cpp $(CFLAGS)
+
+dist/simfpga.vpi: sim_task.o utils.o fpga.o fpga_output_device.o fpga_input_device.o keyboard_input.o fpga_inout_device.o
+	g++ -o dist/simfpga.vpi fpga_inout_device.o keyboard_input.o fpga_input_device.o fpga_output_device.o fpga.o sim_task.o utils.o $(LDFLAGS)
+
+update_demos: dist/simfpga.vpi
+	cp dist/simfpga.vpi ../demos/Accumulate/sim/.
+	cp dist/simfpga.vpi ../demos/Addern/sim/.
+	cp dist/simfpga.vpi ../demos/Counter/sim/.
+	cp dist/simfpga.vpi ../demos/Counter_LPM/sim/.
+	cp dist/simfpga.vpi ../demos/Display/sim/.
+	cp dist/simfpga.vpi ../demos/GPIO/gpio_bidir_demo/sim/.
+	cp dist/simfpga.vpi ../demos/GPIO/gpio_in_demo/sim/.
+	cp dist/simfpga.vpi ../demos/GPIO/gpio_out_demo/sim/.
+	cp dist/simfpga.vpi ../demos/LED_HEX/sim/.
+	cp dist/simfpga.vpi ../demos/ps2_demo/sim/.
+	cp dist/simfpga.vpi ../demos/vga_demo/sim/.
+
+clean:
+	rm -rf *.o
+	rm -rf dist/*.vpi
+

backend/fpga.cpp

@@ -0,0 +1,211 @@
+// Copyright (c) 2020 FPGAcademy
+// Please see license at https://github.com/fpgacademy/DESim
+
+#include "fpga.h"
+#include "helper.h"
+
+fpga::fpga(vpiHandle clk_handle, vpiHandle switch_handle, vpiHandle key_handle,
+					 vpiHandle led_handle, vpiHandle hex_handle, vpiHandle key_action_handle,
+					 vpiHandle scan_code_handle, vpiHandle ps2_lock_handle,
+					 vpiHandle x_handle, vpiHandle y_handle, vpiHandle color_handle, vpiHandle plot_handle,
+					 vpiHandle gpio_handle) {
+	// basic I/O
+	this->leds = new fpga_output_device(NUM_LEDS, vpiBinStrVal, 'l', led_handle);
+	this->hex_displays = new fpga_output_device(HEX_SIG_LENGTH, vpiHexStrVal, 'h', hex_handle);
+
+	this->switches = new fpga_input_device(NUM_SW, vpiBinStrVal, "0000000000", switch_handle);
+	this->keys = new fpga_input_device(NUM_KEYS, vpiBinStrVal, "1111", key_handle);
+
+	// gpio
+	this->gpio = new fpga_inout_device(NUM_GPIO, vpiBinStrVal, 'g', gpio_handle);
+
+	// ps2
+	this->ps2_locks = new fpga_output_device(NUM_PS2_LOCKS, vpiBinStrVal, 'p', ps2_lock_handle);
+	this->keyboard = new keyboard_input(key_action_handle, scan_code_handle);
+
+	// vga
+	this->clk_handle = clk_handle;
+	this->vga_x_handle = x_handle;
+	this->vga_y_handle = y_handle;
+	this->vga_color_handle = color_handle;
+	this->vga_plot_handle = plot_handle;
+
+	this->rwsync_cb_reg = 0;
+	this->rosync_cb_reg = 0;
+
+	this->keep_alive_cb_handle = NULL;
+}
+
+
+void fpga::UpdateOutputValue(char device_type, s_vpi_value *value) {
+	if (device_type == 'l') {
+		if(this->leds->UpdateValue(value)){
+			vpi_printf_helper("Error: incorrect led value format\n");
+			vpi_control(vpiFinish, 1);
+		}
+	} else if(device_type == 'h') {
+		if(this->hex_displays->UpdateValue(value)){
+			vpi_printf_helper("Error: incorrect hex display value format\n");
+			vpi_control(vpiFinish, 1);
+		}
+	} else if(device_type == 'p') {
+		if(this->ps2_locks->UpdateValue(value)){
+			vpi_printf_helper("Error: incorrect ps2 lock value format\n");
+			vpi_control(vpiFinish, 1);
+		}
+	}else if(device_type == 'g'){
+		if(this->gpio->UpdateOutputValue(value)){
+			vpi_printf_helper("Error: incorrect gpio value format\n");
+			vpi_control(vpiFinish, 1);
+		}
+	}
+}
+
+// Send output signals to GUI
+void fpga::SendOutputValue(sockfd server) {
+	this->leds->SendValue(server);
+	this->hex_displays->SendValue(server);
+	this->ps2_locks->SendValue(server);
+	this->gpio->SendValue(server);
+}
+
+
+void fpga::SetInitialSimInput() {
+	this->switches->SetInitialValue();
+	this->keys->SetInitialValue();
+	this->keyboard->SetInitialValue();
+}
+
+// Process input signals from GUI
+int fpga::HandleInput(char *msg) {
+
+	char *tokens = strpbrk(msg, " \t\r\n\v");
+	if (tokens) {
+		// truncate msg in order to compare the first word of msg
+		*tokens = 0;
+		tokens++;
+	}
+
+	if (!tokens) {
+		vpi_printf_helper("Warning: malformed command. Ignoring...\n");
+		vpi_mcd_flush(1);
+		return 0;
+	}
+	if (!strcmp(msg, "SW")) {
+		if(this->switches->UpdateValue(tokens)){
+			vpi_printf_helper("Warning: malformed switch command. Ignoring...\n");
+			vpi_mcd_flush(1);
+		}
+
+	} else if (!strcmp(msg, "KEY")) {
+		if(this->keys->UpdateValue(tokens)){
+			vpi_printf_helper("Warning: malformed push button command. Ignoring...\n");
+			vpi_mcd_flush(1);
+		}
+
+	} else if (!strcmp(msg, "KB")) {
+		if(this->keyboard->UpdateValue(tokens)){
+			vpi_printf_helper("Warning: malformed keyboard scan code. Ignoring...\n");
+			vpi_mcd_flush(1);
+		}
+
+	} else if (!strcmp(msg, "GPIO")) {
+		if(this->gpio->UpdateInputValue(tokens)){
+			vpi_printf_helper("Warning: malformed gpio command. Ignoring...\n");
+			vpi_mcd_flush(1);
+		}
+	}else if (!strcmp(msg, "end")) {
+		vpi_control(vpiFinish, 1);
+		return 0;
+	}
+
+	return 0;
+}
+
+
+void fpga::SendVGAPixelValue(sockfd server){
+
+	s_vpi_value val = {.format = vpiIntVal};
+	vpi_get_value(this->vga_plot_handle, &val);
+
+	// first check if plot is 1, then send pixel value
+	if(val.value.integer != 0){
+		int x, y, color;
+
+		vpi_get_value(this->vga_x_handle, &val);
+		x = val.value.integer;
+		vpi_get_value(this->vga_y_handle, &val);
+		y = val.value.integer;
+		vpi_get_value(this->vga_color_handle, &val);
+		color = val.value.integer;
+
+		char line[80];
+		//write at most size bytes (including '\0')
+		snprintf(line, 80, "c %03d %03d %d\n", x, y, color);
+
+		int rc = send(server, line, 12, 0);
+		if (rc <= 0) {
+			vpi_printf_helper("Could not send VGA signal to GUI\n");
+			vpi_mcd_flush(1);
+			vpi_control(vpiFinish, 1);
+		}
+	}
+}
+
+
+
+fpga::~fpga(){
+	delete this->leds;
+	delete this->hex_displays;
+	delete this->switches;
+	delete this->keys;
+	delete this->gpio;
+	delete this->ps2_locks;
+	delete this->keyboard;
+
+}
+
+bool fpga::operator = (fpga const &other){
+	// devices should be the same
+	if(this->leds != other.leds) return false;
+	if(this->hex_displays != other.hex_displays) return false;
+	if(this->switches != other.switches) return false;
+	if(this->keys != other.keys) return false;
+	if(this->ps2_locks != other.ps2_locks) return false;
+	if(this->keyboard != other.keyboard) return false;
+	if(this->gpio != other.gpio) return false;
+
+	// device handles
+	if(this->clk_handle != other.clk_handle) return false;
+	if(this->vga_x_handle != other.vga_x_handle) return false;
+	if(this->vga_y_handle != other.vga_y_handle) return false;
+	if(this->vga_color_handle != other.vga_y_handle) return false;
+	if(this->vga_plot_handle != other.vga_plot_handle) return false;
+
+	// read/write/keep alive callback can be either registered or not
+	return true;
+}
+
+
+fpga::fpga(fpga const &other){
+	this->leds = new fpga_output_device(*(other.leds));
+	this->hex_displays = new fpga_output_device(*(other.hex_displays));
+	this->switches = new fpga_input_device(*(other.switches));
+	this->keys = new fpga_input_device(*(other.keys));
+	this->ps2_locks = new fpga_output_device(*(other.ps2_locks));
+	this->keyboard = new keyboard_input(*(other.keyboard));
+	this->gpio = new fpga_inout_device(*(other.gpio));
+
+	this->clk_handle = other.clk_handle;
+	this->vga_x_handle = other.vga_x_handle;
+	this->vga_y_handle = other.vga_y_handle;
+	this->vga_color_handle = other.vga_color_handle;
+	this->vga_plot_handle = other.vga_plot_handle;
+
+	this->rwsync_cb_reg = 0;
+	this->rosync_cb_reg = 0;
+	this->keep_alive_cb_handle = NULL;
+}
+
+
+