HDLRuby 2.9.0 → 2.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96e1ddbe94d4b2b40301b61373ed4cea3b2b5bcb461338844af6ebd23380ad4f
-  data.tar.gz: e8e3c5bdc2c7a91c25f41964a15a80a39701c54a49b09540c637b14130bc08e6
+  metadata.gz: 960102912fa0b766d6d17de3d6f4c727e022b459813c47ce5156d4f695a97231
+  data.tar.gz: d79ea380f00deed3419e8565ee82c59d9568fd8844e2422c2d00e163548225c4
 SHA512:
-  metadata.gz: 2c63c50fb2aa3683cb43246b0036ccbe89155ad08d122f738a6ba68bd0886a089608ddc6592d0a728dc7476d00e480ed1f8e0ba4ac97dd97dcbb994099598f90
-  data.tar.gz: 04ee073e082ab0cc9993a7f7888d85959570e969bf83b3247874df6888559be8c4a8d561d5276a9c9d8042f86302b95d4454bb7803aec0e41210c1c747cc4fba
+  metadata.gz: 45f8c0e72f6ebfee3fbf7cbd0172ccb24995d175134ff8d456c1d7aef22466bd1a0bf8b1fac4fef9f2e912d6e51bd16426b6fd376a7e07796f03114ae8a2bc38
+  data.tar.gz: 1fe88f2ce84c4e48eacc20119804062cb50ccf1a36acec6c0bbb82e6e0e9b1414af93af8daff4760c722159fa319d3af19082a2533b34ba9d6bac33ac3cd0f5a

data/README.md

@@ -44,6 +44,7 @@ Where:
 
 |  Options         |          |
 |:------------------|:-----------------------------------------------------|
+| `-I, --interactive` | Run in interactive mode                            |
 | `-y, --yaml`      | Output in YAML format                                |
 | `-v, --verilog`   | Output in Verilog HDL format                         |
 | `-V, --vhdl`      | Output in VHDL format                                |
@@ -97,6 +98,18 @@ hdrcc -y -t multer -p 16,16,32 multer_gen.rb multer
 hdrcc -S counter_bench.rb counter
 ```
 
+* Run in interactive mode.
+
+```
+hdrcc -I
+```
+
+* Run in interactive mode using pry as UI.
+
+```
+hdrcc -I pry
+```
+
 
 ## Using HDLRuby within Ruby
 

data/lib/HDLRuby/hdr_samples/with_delay.rb

@@ -0,0 +1,72 @@
+require 'std/delays.rb'
+
+include HDLRuby::High::Std
+
+# System descending for delayp for adding a reset.
+system :delayp_rst do |num|
+    include(delayp(num))
+
+    input :rst
+
+    par(clk.posedge) do
+        hif(rst) { state <= 0 }
+    end
+end
+
+
+# System testing delay, delayp and the new delayp_rst.
+system :with_delays do
+    num = 10
+
+    # The clock and reset signals
+    inner :clk,:rst
+    # The request signals.
+    inner :req, :reqp, :reqp_rst
+    # The ack signals.
+    inner :ack, :ackp, :ackp_rst
+
+    # Instantiate the delays.
+    delay(num).(:delayI).(clk,req,ack)
+    delayp(num).(:delaypI).(clk,reqp,ackp)
+    delayp_rst(num).(:delaypI_rst).(rst,clk,reqp_rst,ackp_rst)
+
+    # Test the delays.
+    timed do
+        clk <= 0
+        rst <= 0
+        !10.ns
+        clk <= 1
+        !10.ns
+        clk <= 0
+        req <= 1
+        reqp <= 1
+        reqp_rst <= 1
+        !10.ns
+        clk <= 1
+        !10.ns
+        req <= 0
+        clk <= 0
+        rst <= 1
+        !10.ns
+        clk <= 1
+        !10.ns
+        clk <= 0
+        rst <= 0
+        !10.ns
+        clk <= 1
+        !10.ns
+        clk <= 0
+        reqp <= 0
+        !10.ns
+        clk <= 1
+        !10.ns
+        clk <= 0
+        reqp_rst <= 0
+        10.times do
+            !10.ns
+            clk <= 1
+            !10.ns
+            clk <= 0
+        end
+    end
+end

data/lib/HDLRuby/hdr_samples/with_handshake.rb

@@ -0,0 +1,110 @@
+require 'std/handshakes.rb'
+
+include HDLRuby::High::Std
+
+
+# System using a handshake for summing inputs.
+system :hs_adder do
+    input :clk
+    [8].input :x,:y
+    [8].output :z
+
+    inner :read, :write
+
+    include(hs_pipe(clk.posedge,read,write))
+
+    par(clk.posedge) do
+        hif(read) do
+            z <= x + y
+            write <= 1
+        end
+        hif(ackO) do
+            z <= _zzzzzzzz
+            write <= 0
+        end
+    end
+end
+
+
+# System testing handshakes.
+system :with_handshake do
+
+    # The clock signal.
+    inner :clk
+    # The request and acknoledge signals.
+    inner :reqI,:ackI,:reqO,:ackO
+
+    # The input and output values.
+    [8].inner :x, :y, :z
+
+    # Instantiate the handshake adder.
+    hs_adder.(:adderI).(clk: clk, x: x, y: y, z: z,
+                        reqI: reqI, ackI: ackI, reqO: reqO, ackO: ackO)
+
+    # Test the handshake adder.
+    timed do
+        clk  <= 0
+        x    <= 0
+        y    <= 0
+        reqI <= 0
+        ackO <= 0
+        !10.ns
+        clk  <= 1
+        !10.ns
+        clk  <= 0
+        x    <= 1
+        y    <= 2
+        !10.ns
+        clk  <= 1
+        !10.ns
+        clk  <= 0
+        reqI <= 1
+        !10.ns
+        clk  <= 1
+        !10.ns
+        clk  <= 0
+        reqI <= 0
+        !10.ns
+        clk  <= 1
+        !10.ns
+        clk  <= 0
+        ackO <= 1
+        !10.ns
+        clk  <= 1
+        !10.ns
+        clk  <= 0
+        !10.ns
+        clk  <= 1
+        !10.ns
+        clk  <= 0
+        !10.ns
+        clk  <= 1
+        !10.ns
+        clk  <= 0
+        ackO <= 0
+        !10.ns
+        clk  <= 0
+        x    <= 3
+        y    <= 4
+        !10.ns
+        clk  <= 1
+        !10.ns
+        clk  <= 0
+        reqI <= 1
+        !10.ns
+        clk  <= 1
+        !10.ns
+        clk  <= 0
+        reqI <= 0
+        !10.ns
+        clk  <= 1
+        !10.ns
+        clk  <= 0
+        ackO <= 1
+        !10.ns
+        clk  <= 1
+        !10.ns
+        clk  <= 0
+        ackO <= 0
+    end
+end

data/lib/HDLRuby/hdrcc.rb

@@ -1,5 +1,41 @@
 #!/usr/bin/ruby
 
+
+# Check if run in interactive mode.
+if ARGV.include?("-I") || ARGV.include?("--interactive") then
+    # Yes, first check which repl to use.
+    idx = ARGV.index("-I")
+    idx = ARGV.index("--interactive") unless idx
+    if ARGV[idx+1] == "irb" || ARGV[idx+1] == nil then
+        repl = :irb
+    elsif ARGV[idx+1] == "pry" then
+        repl = :pry
+    else 
+        raise "Unknown repl: #{ARGV[idx+1]}"
+    end
+    # Look for the interactive Ruby library.
+    libpath = ""
+    $:.each do |dir|
+        if File.exist?(dir + "/hdrlib.rb") then
+            libpath = dir + "/hdrlib.rb"
+            break
+        end
+    end
+    ARGV.clear
+    ARGV.concat(['-r', libpath])
+    case repl
+    when :irb
+        require 'irb'
+        IRB.start
+    when :pry
+        require 'pry'
+        require libpath
+        # Pry.start(binding)
+        Pry.start()
+    end
+    abort
+end
+
 require 'fileutils'
 require 'tempfile'
 require 'HDLRuby'
@@ -267,6 +303,9 @@ def which(cmd)
 end
 
 
+# Used standalone, check the files given in the standard input.
+include HDLRuby
+
 
 if __FILE__ == $0 then
     # From hdrcc.rb
@@ -278,9 +317,6 @@ else
 end
 
 require 'optparse'
-# Used standalone, check the files given in the standard input.
-include HDLRuby
-
 # Process the command line options
 $options = {}
 $optparse = OptionParser.new do |opts|
@@ -293,7 +329,10 @@ $optparse = OptionParser.new do |opts|
     opts.separator "* `<output file>` is the output file"
     opts.separator ""
     opts.separator "Options:"
-    
+
+    opts.on("-I", "--interactive") do |repl|
+        raise "Internal error: the --interactive option should have been processed earlier."
+    end
     opts.on("-y", "--yaml", "Output in YAML format") do |y|
         $options[:yaml] = y
     end