add de1-soc demo instructions

Author: gjrchen

de1_fpga_dino_demo/README.md

@@ -0,0 +1,25 @@
+## Steps to prepare a demo on a Altera/Terasic DE1-SOC
+
+Install Quartus (Latest, Lite is fine)
+
+You can try to install the .sof file right away, if it works.
+
+If you need to rebuild the project:
+- Use dino_quartus_demo_top.v as your top file.
+- Add all the files in /src into the project
+- Compile 
+
+Tools -> Programmer 
+- Connect to the board (make sure it is powered) with a USB / USB-B connection, into the USB-Blaster-II connection beside the power connection
+- Make sure you have the drivers and that the hardware says DE-SoC
+- If it doesn't, Hardware Setup -> Currently Selected Hardware -> DE-SoC
+- Press Auto-detect
+- ![alt text](image.png)
+- Press start to program the board with the bitstream
+
+Usage:
+- The rightmost switch (SW0) is currently configured as the AI/Manual toggle
+SW0: Up = manual, Down = AI
+Key3 (button) -> Up
+Key2 (button) -> Down
+Key0 (button) -> reset

de1_fpga_dino_demo/dino_quartus_demo.qsf

@@ -0,0 +1,95 @@
+// top wrapper for DE1-SOC
+
+
+module dino_quartus_demo_top(
+    input  wire        CLOCK_50,
+    input  wire [3:0]  KEY,
+    input  wire [17:0] SW,
+
+    output wire VGA_HS,
+	 output wire VGA_VS,
+	 output wire [7:6] VGA_R,
+	 output wire [7:6] VGA_G,
+	 output wire [7:6] VGA_B,
+	 output wire VGA_CLK
+);
+
+    wire clk_25mhz;
+    wire [7:0] uio_oe;
+    wire [6:0] uio_out;
+    wire out_sound;
+
+    //---------------------------------------------
+    // TinyTapeout module wrapper
+    //---------------------------------------------
+	 
+	 //  assign uo_out = {hsync, B[0], G[0], R[0], vsync, B[1], G[1], R[1]};
+	 
+	 
+    tt_um_uwasic_dinogame dino_inst(
+        .ui_in({5'b00000, start, up, down}),     // button mapping
+        .uo_out({VGA_HS, VGA_B[6], VGA_G[6], VGA_R[6], VGA_VS, VGA_B[7], VGA_G[7], VGA_R[7]}),                           // VGA
+        .uio_in(8'b0),
+        .uio_out({out_sound, uio_out}),
+        .uio_oe(uio_oe),
+        .clk(clk_25mhz),
+        .rst_n(~reset),                          // active low reset
+        .ena(1'b1)
+    );
+
+    //---------------------------------------------
+    // assign your DE1 buttons to start/up/down
+    //---------------------------------------------
+    wire up    = ~KEY[3];
+    wire down  = ~KEY[2];
+    wire start = SW[0];
+    wire reset = ~KEY[0];
+
+    //---------------------------------------------
+    // clock divider – same as your TT code
+    //---------------------------------------------
+    clock_div clk_div_inst (
+        .clk(CLOCK_50),
+        .reset(1'b0),
+        .clk_out(clk_25mhz)
+    );
+	 
+	 assign VGA_CLK = clk_25mhz;
+
+
+endmodule
+
+module clock_div (clk,reset, clk_out);
+ 
+input clk;
+input reset;
+output clk_out;
+ 
+reg r_reg;
+wire [1:0] r_nxt;
+reg clk_track;
+ 
+always @(posedge clk or posedge reset)
+ 
+begin
+  if (reset)
+     begin
+        r_reg <= 1'b0;
+	clk_track <= 1'b0;
+     end
+ 
+  else if (r_nxt == 2'b01)
+ 	   begin
+	     r_reg <= 0;
+	     clk_track <= ~clk_track;
+	   end
+ 
+  else 
+      r_reg <= r_nxt;
+end
+ 
+ assign r_nxt = r_reg+1;   	      
+ assign clk_out = clk_track;
+endmodule
+
+

de1_fpga_dino_demo/dino_quartus_demo.sof

@@ -0,0 +1,58 @@
+`default_nettype none
+
+module ai_controller
+    #(    parameter CONV = 0, parameter PLAYER_OFFSET = 6, parameter OBSTACLE_TRESHOLD = 40 )
+(
+  input wire clk,
+  input wire rst_n,
+  input wire game_tick,
+  input wire gamepad_is_present,
+  input wire gamepad_start,
+  input wire gamepad_up,
+  input wire gamepad_down,
+  input wire [9:CONV] obstacle1_pos,
+  input wire [9:CONV] obstacle2_pos,
+  input wire crash,
+  input wire game_frozen,
+  output reg button_start,
+  output reg button_up,
+  output reg button_down
+);
+
+localparam RESTART_DELAY = 60; // Clock cycles to wait after crash to restart
+
+// reg [9:CONV] obstacle_threshold; // When an obstacle reaches this xpos, set button_up signal
+reg [7:0] restart_counter; 
+
+always @(posedge clk) begin
+  if (!rst_n) begin
+    button_start <= 1'b0;
+    button_up <= 1'b0;
+    button_down <= 1'b0;
+    restart_counter <= 8'b00000000;
+  end else if (gamepad_is_present) begin
+    button_start <= gamepad_start;
+    button_up <= gamepad_up;
+    button_down <= gamepad_down;
+  end else if (game_tick) begin
+      if (crash | game_frozen) begin
+      restart_counter <= restart_counter + 1;
+      if (restart_counter == RESTART_DELAY) begin
+        button_start <= 1'b1;
+        restart_counter <= 8'b00000000;
+      end else begin
+        button_start <= 1'b0;
+      end
+      button_up <= 1'b0;
+      button_down <= 1'b0;
+    end else if ((obstacle1_pos <= OBSTACLE_TRESHOLD && obstacle1_pos > PLAYER_OFFSET) || (obstacle2_pos <= OBSTACLE_TRESHOLD && obstacle2_pos > PLAYER_OFFSET)) begin
+      button_up <= 1'b1;
+    end else begin
+      button_up <= 1'b0;
+    end
+  end
+end
+
+
+
+endmodule

de1_fpga_dino_demo/dino_quartus_demo_top.v

@@ -0,0 +1,36 @@
+
+module audio_interface(
+    input wire clk,
+    input wire rst_n,
+    input wire game_is_over,
+    input wire jump_pulse,
+    output reg sound
+);
+    wire jump_sound;
+    wire game_over_sound;
+
+    always @(posedge clk) begin
+        if (!rst_n) begin
+            sound <= 0;
+        end else begin
+            sound <= jump_sound | game_over_sound;
+        end
+    end
+
+    jump_sound_player i_jump(
+        .clk(clk),
+        .rst_n(rst_n),
+        .sound_trigger(jump_pulse),
+        .wave_out(jump_sound)
+    );
+
+    game_over_sound_player i_over(
+        .clk(clk),
+        .rst_n(rst_n),
+        .is_over(game_is_over),
+        .wave_out(game_over_sound)
+    );
+
+endmodule
+
+

de1_fpga_dino_demo/image.png

@@ -0,0 +1,17 @@
+module bg_line #(parameter CONV = 0, parameter GND_LINE = 0) (
+  // Graphics
+  input wire [9:CONV] i_vpos,
+  output reg o_color_bg   // Dedicated outputs
+);
+
+
+  always @(*) begin
+    o_color_bg = 1'b0;
+    // optimize this heavily for ROM
+    if (i_vpos == GND_LINE) begin
+      o_color_bg = 1'b1;
+    end
+  end
+endmodule
+
+

de1_fpga_dino_demo/src/ai_controller.v

@@ -0,0 +1,22 @@
+module bg_object
+  #(    parameter CONV = 0)
+(
+    input wire clk,
+    input wire rst_n,
+    input  wire game_tick,      // 20 Hz
+    input wire [7:0] rng,
+    output reg [9:CONV] bg_object_pos
+);
+    always @(posedge clk) begin
+        if (!rst_n) begin
+            bg_object_pos <= 0;
+        end else begin
+            if (game_tick) begin
+                if (bg_object_pos != 0) bg_object_pos <= bg_object_pos - 1;
+                if (bg_object_pos == 0) begin
+                    bg_object_pos <= {{(5-CONV){1'b1}}, rng[6:2]};
+                end
+            end
+        end
+    end
+endmodule

de1_fpga_dino_demo/src/audio_interface.v

@@ -0,0 +1,38 @@
+`default_nettype none
+
+module bg_object_rom (
+  input  wire       clk,     
+  input  wire       rst, 
+  input wire [5:0] i_rom_counter,
+  output reg  o_sprite_color
+);
+
+reg [2:0] rom_x;
+reg [2:0] rom_y;
+
+
+always @(*) begin
+  {rom_y, rom_x} = i_rom_counter;
+end
+
+reg [7:0] icon_cloud [7:0];
+
+always @(posedge clk) begin
+  if (rst) begin
+    icon_cloud[0]  <= 8'b00000000;
+    icon_cloud[1]  <= 8'b00000000;
+    icon_cloud[2]  <= 8'b00001100;
+    icon_cloud[3]  <= 8'b00011110;
+    icon_cloud[4]  <= 8'b01101011;
+    icon_cloud[5]  <= 8'b11000001;
+    icon_cloud[6]  <= 8'b11111111;
+    icon_cloud[7]  <= 8'b01100110;
+  end
+end
+
+always @(*) begin
+  o_sprite_color = icon_cloud[rom_y][rom_x];
+end
+
+endmodule
+