HDLRuby 2.4.26 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f20b0aa1f19499dddcec1f7eedcff464ed1e440a323c181df7d908730899bb8
-  data.tar.gz: 512b16d80eb0621270e516ffa51c9d2b6b2b61d93842fb02a4cdeb5a1a71d5bc
+  metadata.gz: 53e83131d2fb3a3f03c085a3139a69d70f4422ade7be950d009e97e17bb92490
+  data.tar.gz: dcbbcbf3bd1e5aa43ac359e502dc0da6dec886d115371f3b2fceead01bcaa9d3
 SHA512:
-  metadata.gz: 81250f799e3e102a155fce24aeb29cfc00e254cd0e0568162f103bbccaeb8bfcc82f3f2cb43ad6fe2eb120801c55e35e631e39d10280df98b137d0f85f8df5cd
-  data.tar.gz: 5dff6e40cf54495703b7d3825f25776c0a1d1fdd7243f93ff85c8466e2f9ee1713b2a403efe3092dc5f451d5b9ba0260ffcba6f5fed1edb68edb49115d082dd0
+  metadata.gz: 1656a5763fef86bd1b8c01eff8d377cc94ff3145889fd486fac99ac7d86b6f6671a30e040679f81da6a76bc08ee09ff5babd11cae72fc8adb721f0258e724fb9
+  data.tar.gz: 8f83372948477da9374abf302ab3910d73b434b22aa020b25071f2ed9127dc7ee95b3c6959952bd9ec008f1ff17327c7edc9e1b9584d1437a530a753b0886f4d

data/lib/HDLRuby/drivers/xcd.rb

@@ -0,0 +1,79 @@
+require "HDLRuby/template_expander"
+
+##
+# XCD file generator from 'xcd' properties
+##########################################
+
+
+# Generates a xcd file from the HDLRuby objects from +top+ using
+# their 'xcd' properties.
+# The file is saved in +path+ directory.
+def xcd_generator(top, path)
+    # Ensure top is a system.
+    if top.is_a?(HDLRuby::Low::SystemI) then
+        top = top.systemT
+    elsif !top.is_a?(HDLRuby::Low::SystemT) then
+        raise "The 'xcd_generator' driver can only be applied on SystemT objects."
+    end
+
+    # Get the name of the resulting file if any.
+    if (top.properties.key?(:xcd_file)) then
+        xcd_file = top.properties[:xcd_file].join
+    else
+        # Default file name.
+        xcd_file = "default.xcd"
+    end
+
+    # Get the target template.
+    xcd_target       = top.properties[:xcd_target].join
+    xcd_target_name  = xcd_target
+    xcd_target_name += ".xcd" unless xcd_target_name.end_with?(".xcd")
+    xcd_target_tries = [ xcd_target_name,
+                         File.join(path,xcd_target_name),
+                         File.join(File.dirname(__FILE__),"xcd",xcd_target_name) ]
+    xcd_target_file = xcd_target_tries.find { |fname| File.exist?(fname) }
+    unless xcd_target_file then
+        raise "XCD target template not found for #{xcd_target}."
+    end
+    # Load the template.
+    template = File.read(xcd_target_file)
+
+    # Gather the signals by xcd key.
+    xcd2sig = top.each_signal.reduce([]) do |ar,sig|
+        ar += sig.properties.each_with_key(:xcd).map do |val|
+            [val,sig.name.to_s]
+        end
+    end
+
+    # Create the template expander that will generate the xcd file.
+    expander = TemplateExpander.new([
+        [ /^\?.*(\n|\z)/, proc do |str| # Signal link to port
+            if xcd2sig.any? do |match,rep|
+                if str.include?(match) then
+                    str = str.gsub("<>",rep)[1..-1]
+                else
+                    false
+                end
+            end then
+            str
+            else
+                ""
+            end
+        end ]
+    ])
+
+    # # Generate the xcd file.
+    # File.open(File.join(path,xcd_file),"w") do |file|
+    #     # Generate the signals mapping.
+    #     top.each_signal do |signal|
+    #         signal.properties.each_with_key(:xcd) do |value|
+    #             file << "#{value}\n"
+    #         end
+    #     end
+    # end
+    
+    # Generate the xcd file.
+    File.open(File.join(path,xcd_file),"w") do |file|
+        expander.expand(template,file)
+    end
+end

data/lib/HDLRuby/drivers/xcd/dummy.xcd

@@ -0,0 +1,4 @@
+<Dummy xcd template>
+?<PORT <> CLK>
+?<PORT <> RST>
+

data/lib/HDLRuby/hdr_samples/dff_properties.rb

@@ -0,0 +1,19 @@
+# A simple D-FF
+system :dff do
+    input :clk, :rst, :d
+    output :q, :qb
+
+    qb <= ~q
+
+    par(clk.posedge) { q <= d & ~rst }
+
+    clk.properties[:xcd] = "CLK"
+    rst.properties[:xcd] = "RST"
+    d.properties[:xcd]   = "PORT0"
+    q.properties[:xcd]   = "PORT1"
+    qb.properties[:xcd]  = "PORT2"
+    cur_system.properties[:xcd_target] = "dummy"
+    cur_system.properties[:xcd_file] = "dff.xcd"
+    cur_system.properties[:post_driver] = "drivers/xcd.rb", :xcd_generator
+end
+

data/lib/HDLRuby/hdr_samples/dff_unit.rb

@@ -0,0 +1,54 @@
+# Testing HDLRuby unit test.
+# require 'hruby_unit.rb' 
+
+# Declare multiple simple dff-systems and their corresponding test.
+
+1.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)
+
+        timed 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/seqpar_bench.rb

@@ -0,0 +1,59 @@
+# require "../hruby_low2c.rb"
+
+
+
+# A system for testing the execution of par block in seq block.
+system :seqpar_bench do
+
+    inner :rst, :clk
+    signed[8].inner :a, :b, :c, :d
+    signed[8].inner :out
+
+    seq(clk.posedge) do
+        hif(rst) do
+            a <= 0
+            b <= 0
+            c <= 0
+            d <= 0
+        end
+        helse do
+            a <= a + 1
+            b <= a + 2
+            par do
+                c <= b + 3
+                d <= c + 4
+            end
+            a <= d + 5
+        end
+    end
+
+    out <= a
+
+    timed do
+        clk <= 0
+        rst <= 0
+        !20.ns
+        clk <= 1
+        !20.ns
+        clk <= 0
+        rst <= 1
+        !20.ns
+        clk <= 1
+        !20.ns
+        clk <= 0
+        rst <= 0
+        !20.ns
+        clk <= 1
+        !20.ns
+        clk <= 0
+        !20.ns
+        clk <= 1
+        !20.ns
+        clk <= 0
+        !20.ns
+        clk <= 1
+        !20.ns
+        clk <= 0
+        !20.ns
+    end
+end

data/lib/HDLRuby/hdrcc.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/ruby
 
 require 'fileutils'
+require 'tempfile'
 require 'HDLRuby'
 require 'HDLRuby/hruby_check.rb'
 # require 'ripper'
@@ -20,6 +21,7 @@ require 'HDLRuby/hruby_low_with_var'
 require 'HDLRuby/hruby_low_without_concat'
 require 'HDLRuby/hruby_low_without_connection'
 require 'HDLRuby/hruby_low_casts_without_expression'
+require 'hruby_low_without_parinseq'
 require 'HDLRuby/hruby_low_cleanup'
 
 require 'HDLRuby/hruby_verilog.rb'
@@ -49,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
 
@@ -81,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)
@@ -173,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
@@ -182,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
@@ -309,15 +337,18 @@ $optparse = OptionParser.new do |opts|
     opts.on("-D", "--debug","Set the HDLRuby debug mode") do |d|
         $options[:debug] = d
     end
+    opts.on("-T","--test","Compile the unit tests.") do |t|
+        $options[:test] = t
+    end
     opts.on("-t", "--top system", "Specify the top system to process") do|t|
         $options[:top] = t
     end
     opts.on("-p", "--param x,y,z", "Specify the generic parameters") do |p|
         $options[:param] = p
     end
-    opts.on("--version", "Print the version number, then exit") do
-        puts "hdrcc: HDLRuby #{HDLRuby::VERSION} compiler"
-        exit
+    opts.on("--dump","Dump all the properties to yaml files") do |v|
+        $options[:dump] = v
+        $options[:multiple] = v
     end
     # opts.on_tail("-h", "--help", "Show this message") do
     opts.on("-h", "--help", "Show this message") do
@@ -369,6 +400,19 @@ if $input == nil then
     exit
 end
 
+if ($options[:test]) then
+    $top = "__test__"
+    # Generate the unit test file.
+    $test_file = Tempfile.new('tester.rb',Dir.getwd)
+    $test_file.write("require 'hruby_unit.rb'\nrequire_relative '#{$input}'\n\n" +
+                    "HDLRuby::Unit.test(\"#{$top}\")\n")
+    # $test_file.rewind
+    # puts $test_file.read
+    $test_file.rewind
+    # It is the new input file.
+    $input = $test_file
+end
+
 # Open the output.
 if $output then
     if $options[:multiple] then
@@ -393,6 +437,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."
@@ -460,6 +510,9 @@ elsif $options[:clang] then
     # top_system = $top_system
     # Preprocess the HW description for valid C generation.
     $top_system.each_systemT_deep do |systemT|
+        # Coverts the par blocks in seq blocks to seq blocks to match
+        # the simulation engine.
+        systemT.par_in_seq2seq!
         # Converts the connections to behaviors.
         systemT.connections_to_behaviors!
         # Break the RefConcat.
@@ -583,6 +636,7 @@ elsif $options[:verilog] then
         systemT.to_global_systemTs!
         # systemT.break_types!
         # systemT.expand_types!
+        systemT.par_in_seq2seq!
         systemT.initial_concat_to_timed!
         systemT.with_port!
     end
@@ -673,3 +727,31 @@ elsif $options[:vhdl] then
         end
     end
 end
+
+# Apply the post drivers if any.
+Hdecorator.each_with_property(:post_driver) do |obj, value|
+    # Load the driver.
+    require_relative(value[0].to_s)
+    # Execute it.
+    send(value[1].to_sym,obj,$output)
+end
+
+# Dump the properties
+if $options[:dump] then
+    # Decorate with the parent ids.
+    Hdecorator.decorate_parent_id
+    
+    # Generate the directory for the properties
+    property_dir = $output + "/properties"
+    unless File.directory?(property_dir)
+        FileUtils.mkdir_p(property_dir)
+    end
+
+    # Dump to one file per key
+    Properties.each_key do |key|
+        File.open(property_dir + "/#{key}.yaml", "w") do |f|
+            Hdecorator.dump(key,f)
+        end
+    end
+    
+end