HDLRuby 2.5.0 → 2.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99c77fd470dae8d84cb066923fc8ed89d18e2aafa8bc826df85e03cae674c4e2
-  data.tar.gz: 4ef6902aec739f56c398bd653dc30f0dc03227799e1f54a9900b762d1a077aaa
+  metadata.gz: 928c0006bc7fee9ebff9356509ed09ad9109d310e64eea92a41f42d751d560b1
+  data.tar.gz: d63743942c8c73f79224c129ca8265995ddff3397a5628e185da497b0599a6e0
 SHA512:
-  metadata.gz: 8c9972c8567cb1fd496268c4385b7f3caa0bd8718769254542adeceafafdc26ed09d5ce7c47430e0b0732ecbcda4ea5d0220cf4bc7be9721faf5b99bf47057cf
-  data.tar.gz: d300640fdc354ed55f9210c95d4aee10e52768a59ac39a993b402d8da78dd091f31d97fe307fe96b729d9194b532bf958761070224663e3bf2cd37e165877c21
+  metadata.gz: b7508f64a04a6662c035ce362d9193d617b022dd21bbccaa28f8c70d2a38790919f6d995b545a5082df0be6e23654a4bacb158ea6dfaaa673ea592ccac4c67f9
+  data.tar.gz: 8e77890ec50610400f848340a4ad4a4eb0d9095aff8c674ecb695cdddf9aabbd7e585b2bf5bfc8b76553612f1e216bcc7e21f00888335f07b95f54c89b88efc2

data/lib/HDLRuby/hdr_samples/adder.rb

@@ -3,5 +3,5 @@ system :adder do
     [15..0].input :x,:y
     [16..0].output :s
 
-    s <= x + y
+    s <= x.as(bit[17]) + y
 end

data/lib/HDLRuby/hdr_samples/adder_bench.rb

@@ -3,7 +3,7 @@ system :adder do
     [15..0].input :x,:y
     [16..0].output :s
 
-    s <= x + y
+    s <= x.as(bit[17]) + y
 end
 
 # A benchmark for the adder.

data/lib/HDLRuby/hdr_samples/adder_gen.rb

@@ -3,5 +3,5 @@ system :adder do |w|
     [(w-1)..0].input :x,:y
     [w..0].output :s
 
-    s <= x + y
+    s <= x.as(bit[w+1]) + y
 end

data/lib/HDLRuby/hdr_samples/constant_in_function.rb

@@ -0,0 +1,27 @@
+# Sample for testing constant declaration in function.
+
+
+function :func do |addr|
+    bit[4][-4].constant tbl: [ _0000, _0001, _0010, _0011 ]
+    
+    tbl[addr]
+end
+
+
+system :with_func do
+    [4].inner :addr, :val
+
+    val <= func(addr)
+    # val <= 1
+
+    timed do
+        addr <= 0
+        !10.ns
+        addr <= 1
+        !10.ns
+        addr <= 2
+        !10.ns
+        addr <= 3
+        !10.ns
+    end
+end

data/lib/HDLRuby/hdr_samples/dff_unit.rb

@@ -0,0 +1,54 @@
+# Testing HDLRuby unit test.
+# require 'std/hruby_unit.rb' 
+
+# Declare multiple simple dff-systems and their corresponding test.
+
+3.times do |i|
+
+    # A simple D-FF
+    system:"dff#{i}" do
+        input :clk, :rst, :d
+        output :q, :qb
+
+        qb <= ~q
+
+        par(clk.posedge) { q <= d & ~rst }
+    end
+
+    # Code for testing it.
+    Unit.system :"test_dff#{i}" do
+        inner :clk, :rst, :d, :q, :qb
+
+        send(:"dff#{i}",:dffI).(clk,rst,d,q,qb)
+
+        test do
+            clk <= 0
+            rst <= 0
+            d   <= 0
+            !10.ns
+            clk <= 1
+            !10.ns
+            clk <= 0
+            rst <= 1
+            !10.ns
+            clk <= 1
+            !10.ns
+            clk <= 0
+            rst <= 0
+            !10.ns
+            clk <= 1
+            !10.ns
+            clk <= 0
+            d   <= 1
+            !10.ns
+            clk <= 1
+            !10.ns
+            clk <= 0
+            d   <= 0
+            !10.ns
+            clk <= 1
+            !10.ns
+        end
+    end
+end
+

data/lib/HDLRuby/hdr_samples/huge_rom.rb

@@ -0,0 +1,25 @@
+# Describes an 8-bit data 16-bit address ROM.
+system :huge_rom do
+    [15..0].input :addr
+    [7..0].output :data
+
+    bit[7..0][-65536].constant content: 65536.times.to_a
+
+    data <= content[addr]
+end
+
+
+
+system :test_rom do
+    [15..0].inner :addr
+    [7..0].inner :data
+
+    huge_rom(:my_rom).(addr,data)
+
+    timed do
+        8.times do |i|
+            addr <= i
+            !10.ns
+        end
+    end
+end

data/lib/HDLRuby/hdr_samples/logic_bench.rb

@@ -0,0 +1,21 @@
+
+# A benchmark for the logic operations.
+system :logic_bench do
+    [3].inner :x,:y
+    [3].inner :s_not, :s_and, :s_or, :s_xor, :s_nxor
+
+    timed do
+        8.times do |i|
+            8.times do |j|
+                x      <= i
+                y      <= j
+                s_not  <= ~x
+                s_and  <= x & y
+                s_or   <= x | y
+                s_xor  <= x ^ y
+                s_nxor <= (x == y)
+                !10.ns
+            end
+        end
+    end
+end

data/lib/HDLRuby/hdr_samples/mei8_bench.rb

@@ -28,7 +28,7 @@ system :mei8 do |prog_file = "./prog.obj"|
         bit[7..0][-256].constant mem: # The content of the memory
             ( File.readlines(prog_file).map {|l| l.split[0] }.select do |l|
             ["0","1"].include?(l[2])
-        end.map {|l| l[2..9] } )
+        end.map {|l| l[2..9].to_i(2) } )
         instr <= mem[addr]       # The access procedure
     end
 

data/lib/HDLRuby/hdr_samples/multi_timed_bench.rb

@@ -0,0 +1,54 @@
+# Test the execution of multiple timed behaviors
+system :multi_timed do
+    inner :clk1, :clk2, :rst, :button
+    [8].inner :counter1, :counter2 
+
+    # The process controlling counter1.
+    par(clk1.posedge) do
+        hif(rst) { counter1 <= 0 }
+        helsif(button) { counter1 <= counter1 + 1 }
+    end
+
+    # The process controlling counter2.
+    par(clk2.posedge) do
+        hif(rst) { counter2 <= 0 }
+        helsif(button) { counter2 <= counter2 + 1 }
+    end
+
+    # The process for clk1
+    timed do
+        50.times do
+            clk1 <= 0
+            !10.ns
+            clk1 <= 1
+            !10.ns
+        end
+    end
+
+    # The process for clk2
+    timed do
+        80.times do
+            clk2 <= 0
+            !3.ns
+            clk2 <= 1
+            !3.ns
+        end
+    end
+
+    # The control process
+    timed do
+        rst <= 0
+        button <= 0
+        !10.ns
+        rst <= 1
+        !20.ns
+        rst <= 0
+        !10.ns
+        10.times do
+            button <= 1
+            !20.ns
+            button <= 0
+            !20.ns
+        end
+    end
+end

data/lib/HDLRuby/hdr_samples/music.rb

@@ -0,0 +1,79 @@
+# require "std/fixpoint.rb"
+# require_relative "activation_function.rb"
+require 'std/function_generator.rb'
+
+include HDLRuby::High::Std
+
+system :music do
+
+   input :clk, :rst
+   [24].output :sound 
+   
+   # func_sin = proc { |i| Math.sin(i) }
+   # More efficient:
+   func_sin = Math.method(:sin)
+
+   # bit[8,8].inner :time
+   # signed[2,22].inner :sin_val0
+   # signed[2,22].inner :sin_val1
+   bit[8].inner :time
+   signed[24].inner :sin_val0
+   signed[24].inner :sin_val1
+
+   # activation_function(func_sin,signed[2,22],8,8,16).(:func_sin0_generator).(time,sin_val0)
+   # activation_function(func_sin,signed[2,22],8,8,16).(:func_sin1_generator).(time/2,sin_val1)
+   function_generator(func_sin,bit[8],signed[24],4,-Math::PI..Math::PI,-2..2).(:func_sin0_generator).(time,sin_val0)
+   function_generator(func_sin,bit[8],signed[24],4,-Math::PI*2..Math::PI*2,-2..2).(:func_sin1_generator).(time/2,sin_val1)
+
+   # signed[2,22].inner :sound0
+   signed[48].inner :sound0
+
+   sound0 <= sin_val0.as(signed[24]) * sin_val1
+
+   sound <= sound0[47..24]
+
+   par(clk.posedge) do
+      hif(rst) { time <= 0 }
+      helse do
+        # time <= time + _0000000000000001
+        time <= time + _00000001
+      end
+   end
+
+end
+
+
+
+
+system :music_test do
+
+    inner :clk,:rst
+    [24].inner :sound
+
+    music(:my_music).(clk,rst,sound)
+
+    timed do
+        clk <= 0
+        rst <= 0
+        !10.ns
+        clk <= 1
+        !10.ns
+        clk <= 0
+        rst <= 1
+        !10.ns
+        clk <= 1
+        !10.ns
+        clk <= 0
+        !10.ns
+        clk <= 1
+        !10.ns
+        clk <= 0
+        rst <= 0
+        256.times do
+            !10.ns
+            clk <= 1
+            !10.ns
+            clk <= 0
+        end
+    end
+end

data/lib/HDLRuby/hdr_samples/named_sub.rb

@@ -0,0 +1,42 @@
+## 
+#  Sample testing named sub
+#######################################
+
+
+# A simple circuit with named sub
+system :named_sub do
+    input  :x, :y
+    output :s
+
+    sub :somesub do
+        inner :sig
+    end
+
+    seq do
+        somesub.sig <= x | y
+        s <= ~somesub.sig
+    end
+
+end
+
+# A benchmark for the circuit.
+system :named_sub_bench do
+    inner :x, :y, :s
+
+    named_sub(:my_named_sub).(x,y,s)
+
+    timed do
+        x <= 0
+        y <= 0
+        !10.ns
+        x <= 1
+        y <= 0
+        !10.ns
+        x <= 0
+        y <= 1
+        !10.ns
+        x <= 1
+        y <= 1
+        !10.ns
+    end
+end

data/lib/HDLRuby/hdr_samples/rom.rb

@@ -14,3 +14,19 @@ system :rom4_8 do
     data1 <= content1[addr]
     data2 <= content2[addr]
 end
+
+
+
+system :test_rom do
+    [2..0].inner :addr
+    [7..0].inner :data0,:data1,:data2
+
+    rom4_8(:my_rom).(addr,data0,data1,data2)
+
+    timed do
+        8.times do |i|
+            addr <= i
+            !10.ns
+        end
+    end
+end

data/lib/HDLRuby/hdr_samples/with_function_generator.rb

@@ -0,0 +1,25 @@
+require 'std/function_generator.rb'
+
+include HDLRuby::High::Std
+
+# System for testing the function generator standard library.
+system :with_function_generator do
+    # signed[8].inner :x
+    # signed[32].inner :y
+    bit[8].inner :x
+    signed[8].inner :y
+
+    # function_generator(Math.method(:sin).to_proc,
+    #                    signed[8],signed[32],4,-Math::PI..Math::PI,-2..2).
+    function_generator(Math.method(:sin).to_proc,
+                       bit[8],signed[8],4,-Math::PI..Math::PI,-2..2).
+    (:my_sin).(x,y)
+
+    timed do
+        # (-128..127).each do |i|
+        (0..255).each do |i|
+            x <= i
+            !10.ns
+        end
+    end
+end

data/lib/HDLRuby/hdrcc.rb

@@ -1,10 +1,11 @@
 #!/usr/bin/ruby
 
 require 'fileutils'
+require 'tempfile'
 require 'HDLRuby'
 require 'HDLRuby/hruby_check.rb'
 # require 'ripper'
-require 'HDLRuby/hruby_low2high'
+require 'HDLRuby/hruby_low2hdr'
 require 'HDLRuby/hruby_low2c'
 require 'HDLRuby/hruby_low2vhd'
 require 'HDLRuby/hruby_low_fix_types'
@@ -50,12 +51,21 @@ module HDLRuby
         # The required files.
         attr_reader :requires
 
-        # Creates a new loader for a +top_system+ system in file +top_file+
+        # Creates a new loader for a +top_system+ system in file +top_file_name+
         # from directory +dir+ with generic parameters +params+.
+        #
+        # NOTE: +top_file+ can either be a file or a file name.
         def initialize(top_system,top_file,dir,*params)
             # Sets the top and the looking directory.
             @top_system = top_system.to_s
-            @top_file = top_file.to_s
+            # @top_file can either be a file or a string giving the file name.
+            if top_file.respond_to?(:path) then
+                @top_file = top_file
+                @top_file_name = top_file.path
+            else
+                @top_file = nil
+                @top_file_name = top_file.to_s
+            end
             @dir = dir.to_s
             @params = params
 
@@ -82,31 +92,48 @@ module HDLRuby
         end
 
         # Loads a single +file+.
+        #
+        # NOTE: +file+ can either be a file or a file name.
         def read(file)
             # Resolve the file.
-            found = File.join(@dir,file)
-            unless File.exist?(found) then
-                founds = Dir.glob(@std_dirs.map {|path| File.join(path,file) })
-                if founds.empty? then
-                    # No standard file with this name, this is an error.
-                    raise "Unknown required file: #{file}."
-                else
-                    # A standard file is found, skip it since it does not
-                    # need to be read.
-                    # puts "Standard files: #{founds}"
-                    return false
+            if file.respond_to?(:read) then
+                found = file
+            else
+                found = File.join(@dir,file)
+                unless File.exist?(found) then
+                    founds = Dir.glob(@std_dirs.map do |path|
+                        File.join(path,file) 
+                    end)
+                    if founds.empty? then
+                        # No standard file with this name, this is an error.
+                        raise "Unknown required file: #{file}."
+                    else
+                        # A standard file is found, skip it since it does not
+                        # need to be read.
+                        # puts "Standard files: #{founds}"
+                        return false
+                    end
                 end
             end
             # Load the file.
-            # @texts << File.read(File.join(@dir,file) )
             @texts << File.read(found)
-            # @checks << Checker.new(@texts[-1],file)
-            @checks << Checker.new(@texts[-1],found)
+            if found.respond_to?(:path) then
+                @checks << Checker.new(@texts[-1],found.path)
+            else
+                @checks << Checker.new(@texts[-1])
+            end
             return true
         end
 
         # Loads all the files from +file+.
-        def read_all(file = @top_file)
+        def read_all(file = nil)
+            unless file then
+                if @top_file then
+                    file = @top_file
+                else
+                    file = @top_file_name
+                end
+            end
             # puts "read_all with file=#{file}"
             # Read the file
             # read(file)
@@ -174,7 +201,7 @@ module HDLRuby
                     # Maybe it is a parse error, look for it.
                     bind = TOPLEVEL_BINDING.clone
                     eval("require 'HDLRuby'\n\nconfigure_high\n\n",bind)
-                    eval(@texts[0],bind,@top_file,1)
+                    eval(@texts[0],bind,@top_file_name,1)
                     # No parse error found.
                     raise "Cannot find a top system." unless @top_system
                 end
@@ -183,7 +210,7 @@ module HDLRuby
             bind = TOPLEVEL_BINDING.clone
             eval("require 'HDLRuby'\n\nconfigure_high\n\n",bind)
             # Process it.
-            eval(@texts[0],bind,@top_file,1)
+            eval(@texts[0],bind,@top_file_name,1)
             # Get the resulting instance
             if @params.empty? then
                 # There is no generic parameter
@@ -225,6 +252,20 @@ module HDLRuby
 
 end
 
+# Locate an executable from cmd.
+def which(cmd)
+    # Get the possible exetensions (for windows case).
+    exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+    # Look for the command within the executable paths.
+    ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts.each do |ext|
+            exe = File.join(path, "#{cmd}#{ext}")
+            return exe if File.executable?(exe) && !File.directory?(exe)
+        end
+    end
+    nil
+end
+
 
 
 if __FILE__ == $0 then
@@ -310,6 +351,12 @@ $optparse = OptionParser.new do |opts|
     opts.on("-D", "--debug","Set the HDLRuby debug mode") do |d|
         $options[:debug] = d
     end
+    opts.on("-T","--test t0,t1,t2","Compile the unit tests named t0,t1,...") do |t|
+        $options[:test] = t
+    end
+    opts.on("--testall","Compile all the available unit tests.") do |t|
+        $options[:testall] = t
+    end
     opts.on("-t", "--top system", "Specify the top system to process") do|t|
         $options[:top] = t
     end
@@ -320,6 +367,10 @@ $optparse = OptionParser.new do |opts|
         $options[:dump] = v
         $options[:multiple] = v
     end
+    opts.on("--version", "Shows the version of HDLRuby.") do |v|
+        puts VERSION
+        exit
+    end
     # opts.on_tail("-h", "--help", "Show this message") do
     opts.on("-h", "--help", "Show this message") do
         puts opts
@@ -370,6 +421,28 @@ if $input == nil then
     exit
 end
 
+if ($options[:test] || $options[:testall]) then
+    $top = "__test__"
+    tests = $options[:test]
+    if tests then
+        tests = tests.to_s.split(",")
+        tests.map! {|test| ":\"#{test}\"" }
+        tests = ", #{tests.join(",")}"
+    else
+        tests = ""
+    end
+    # Generate the unit test file.
+    $test_file = Tempfile.new('tester.rb',Dir.getwd)
+    $test_file.write("require 'std/hruby_unit.rb'\nrequire_relative '#{$input}'\n\n" +
+                     "HDLRuby::Unit.test(:\"#{$top}\"#{tests})\n")
+    # $test_file.rewind
+    # puts $test_file.read
+    # exit
+    $test_file.rewind
+    # It is the new input file.
+    $input = $test_file
+end
+
 # Open the output.
 if $output then
     if $options[:multiple] then
@@ -382,7 +455,7 @@ if $output then
         $output = File.open($output,"w")
     end
 else
-    if $option[:multiple] then
+    if $options[:multiple] then
         raise "Need a target directory in multiple files generation mode."
     end
     $output = $stdout
@@ -394,6 +467,12 @@ $loader = HDRLoad.new($top,$input,$options[:directory].to_s,*$params)
 $loader.read_all
 $loader.check_all
 
+# Remove the test file if any, it is not needed any longer.
+if $test_file then
+    $test_file.close
+    $test_file.unlink 
+end
+
 if $options[:syntax] then
     if $options[:multiple] then
         raise "Multiple files generation mode not supported for syntax tree output."
@@ -414,6 +493,24 @@ end
 # Get the top systemT.
 $top_system = $top_instance.to_low.systemT
 
+
+# Apply the pre drivers if any.
+Hdecorator.each_with_property(:pre_driver) do |obj, value|
+    unless value.is_a?(Array) && value.size == 2 then
+        raise "pre_driver requires a driver file name command name."
+    end
+    # Load the driver.
+    require_relative(value[0].to_s)
+    # Ensure obj is the low version.
+    if obj.properties.key?(:high2low) then
+        # obj is high, get the corresponding low.
+        obj = obj.properties[:high2low][0]
+    end
+    # Execute it.
+    send(value[1].to_sym,obj,*value[2..-1])
+end
+
+
 # Gather the non-HDLRuby code.
 $non_hdlruby = []
 $top_system.each_systemT_deep do |systemT|
@@ -455,7 +552,7 @@ elsif $options[:hdr] then
     #     $output << systemT.to_high
     # end
     # $output << $top_instance.to_low.systemT.to_high
-    $output << $top_system.to_high
+    $output << $top_system.to_hdr
 elsif $options[:clang] then
     # top_system = $top_instance.to_low.systemT
     # top_system = $top_system
@@ -572,8 +669,19 @@ elsif $options[:clang] then
             end
         end
         Dir.chdir($output)
-        # Kernel.system("make -s")
-        Kernel.system("cc -o3 -o hruby_simulator *.c -lpthread")
+        # Find the compiler.
+        cc_cmd = which('cc')
+        unless cc_cmd then
+            cc_cmd = which('gcc')
+        end
+        unless cc_cmd then
+            raise "Could not find any compiler, please compile by hand as follows:\n" +
+                "   In folder #{$output} execute:\n" +
+                "     <my compiler> -o hruby_simulator *.c -lpthread\n" +
+                "   Then execute:\n   hruby_simulator"
+        end
+        # Use it.
+        Kernel.system("#{cc_cmd} -o3 -o hruby_simulator *.c -lpthread")
         Kernel.system("./hruby_simulator")
     end
 elsif $options[:verilog] then