HDLRuby 3.3.2 → 3.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9857a28c7409d23aa1aab98acc247b92b1ac294db826539bb21b2f0e6bb39c8
-  data.tar.gz: 034ec0e1795b49b33db4c2a3461384af2e13fe1270a39109671d3d0772235904
+  metadata.gz: 160a8c6607e6dd20282a50fa26e0d472e055992ebce5f7cdf62d39e8c6bf7db5
+  data.tar.gz: 2c44f4edc3e4fdd76d64c2cb349f7083a255b68b1a18c6f41bef77c6d82138ab
 SHA512:
-  metadata.gz: 235423b177255a0729fcd5f33338431f25dfa94b7ebe9ed0fc99c125518aedcabd0e6bd0cab927c683cf8752571d9b707e6ddf1d8056a7a20dd2ebcd67779c01
-  data.tar.gz: e0f605b4360ffe0a05b15a65a197ba9606e43c7eff2747bf3d6fd9c07cfca1287df8e1c437f2339e86ca8efa4762676d689e81d4d79f4195b313a1684df7df23
+  metadata.gz: 234d4901bc7ae389c1e0893ad19a7a2aff93c2bc2851066a80ce07b778787a1fa25950af60dd30d32d7e77a8804f0ef4dbc2c43bdf2f026f7b725cd15a943c84
+  data.tar.gz: 774369895db9a9f30b7a85061aba5190d3e45f962f6ca28e2cee7fe77d7c02c049570dd6e2a0f730640f687bc8069f19e433ea6d4bb2f79b6cb7875a6ef423a4

data/lib/HDLRuby/hdr_samples/with_board_sequencer.rb

@@ -0,0 +1,69 @@
+
+# A benchmark for testing the use of a board model in conjuction
+# with a sequencer implementing:
+# * a simple adder whose input are set using slide switches, and
+#   whose output bits are showns on LEDs.
+# * simple unsigned and signed counters whose values are shown using
+#   decimal or hexadecimal displays, and oscilloscopes.
+system :with_board_sequencer do
+    inner :clk, :clk2
+    [8].inner clk_cnt: 0
+    inner rst: 0
+    [8].inner :sw_a, :sw_b
+    [9].inner :led_z
+    [16].inner counter: 0
+    [8].inner :counter8
+    signed[8].inner :scounter8
+
+    # Description of the board.
+    # It is updated at each rising edge of +clk2+.
+    board(:some_board) do
+        actport clk2.posedge
+        bt  reset:    rst
+        row
+        sw  sw_a:     sw_a
+        sw  sw_b:     sw_b
+        led led_z:    led_z
+        row
+        digit cnt_d:  counter
+        hexa  cnt_h:  counter
+        digit cnt_s:  scounter8
+        row
+        scope scope:  counter8
+        scope scope_s:scounter8
+    end
+
+    # The adder.
+    led_z <= sw_a.as(bit[9]) + sw_b
+
+    # The counters and the generation of +clk2+.
+    counter8 <= counter[7..0]
+    scounter8 <= counter[7..0]
+
+    seq(clk.posedge) do
+      clk_cnt <= clk_cnt + 1
+      hif(clk_cnt & 3 == 0) { clk2 <= ~clk2 }
+    end
+
+    sequencer(clk.posedge,rst) do
+      counter <= 0
+      sloop do
+        counter <= counter + 1 
+      end
+    end
+
+
+
+    timed do
+        clk <= 0
+        clk2 <= 0
+        !10.ns
+        repeat(1000) do
+            clk <= 1
+            !10.ns
+            clk <= 0
+            !10.ns
+        end
+
+    end
+end

data/lib/HDLRuby/hdr_samples/with_nand_board.rb

@@ -10,7 +10,7 @@ system :nand_board do
 
     inner :clk
     # Description of the board.
-    # It is updated at each rising edge of +clk2+.
+    # It is updated at each rising edge of +clk+.
     board(:nand,8080) do
         actport clk.posedge
         sw din0: din0

data/lib/HDLRuby/hruby_high.rb

@@ -1529,15 +1529,19 @@ module HDLRuby::High
             self.each_program { |prog| scopeL.add_program(prog.to_low) }
             # Adds the code chunks.
             self.each_code { |code| scopeL.add_code(code.to_low) }
+            # Adds the behaviors.
+            self.each_behavior { |behavior|
+                scopeL.add_behavior(behavior.to_low)
+            }
             # Adds the connections.
             self.each_connection { |connection|
                 # puts "connection=#{connection}"
                 scopeL.add_connection(connection.to_low)
             }
-            # Adds the behaviors.
-            self.each_behavior { |behavior|
-                scopeL.add_behavior(behavior.to_low)
-            }
+            # # Adds the behaviors.
+            # self.each_behavior { |behavior|
+            #     scopeL.add_behavior(behavior.to_low)
+            # }
         end
 
         # Converts the scope to HDLRuby::Low.
@@ -2247,17 +2251,21 @@ module HDLRuby::High
         ruby_block = proc {} unless block_given?
         if HDLRuby::High.in_system? then
             define_singleton_method(name.to_sym) do |*args,&other_block|
+                res = nil
                 sub(HDLRuby.uniq_name(name)) do
-                    HDLRuby::High.top_user.instance_exec(*args,*other_block,
-                                                         &ruby_block)
+                    res = HDLRuby::High.top_user.instance_exec(*args,
+                                            *other_block, &ruby_block)
                 end
+                res
             end
         else
             define_method(name.to_sym) do |*args,&other_block|
+                res = nil
                 sub(HDLRuby.uniq_name(name)) do
-                    HDLRuby::High.top_user.instance_exec(*args,*other_block,
-                                                         &ruby_block)
+                    res = HDLRuby::High.top_user.instance_exec(*args,
+                                            *other_block, &ruby_block)
                 end
+                res
             end
         end
     end
@@ -3089,10 +3097,14 @@ module HDLRuby::High
          end
 
 
-         # Creates an access to elements of range +rng+ of the signal.
+         # Creates an access to elements of range +rng+ of the signal,
+         # and set the type of elements as +typ+ if given.
          #
          # NOTE: +rng+ can be a single expression in which case it is an index.
-         def [](rng)
+         def [](typ,rng=nil)
+             # Treat the number of arguments
+             rng, typ = typ, nil unless rng
+             # Process the range.
              if rng.is_a?(::Range) then
                  first = rng.first
                  if (first.is_a?(::Integer)) then
@@ -3113,14 +3125,23 @@ module HDLRuby::High
              end 
              if rng.is_a?(HDLRuby::Low::Expression) then
                  # Index case
-                 return RefIndex.new(self.type.base,self.to_expr,rng)
+                 if typ then
+                    return RefIndex.new(typ,self.to_expr,rng)
+                 else
+                    return RefIndex.new(self.type.base,self.to_expr,rng)
+                 end
              else
                  # Range case, ensure it is made among expression.
                  first = rng.first.to_expr
                  last = rng.last.to_expr
-                 # Abd create the reference.
-                 return RefRange.new(self.type.slice(first..last),
-                                     self.to_expr,first..last)
+                 # And create the reference.
+                 if typ then
+                    return RefRange.new(typ,
+                                        self.to_expr,first..last)
+                 else
+                    return RefRange.new(self.type.slice(first..last),
+                                        self.to_expr,first..last)
+                 end
              end
          end
 
@@ -3524,8 +3545,8 @@ module HDLRuby::High
             if @base.is_a?(RefThis) && 
                     (@object.parent != High.top_user) &&
                     (@object.parent != High.cur_system) &&
-                    (@object.parent != High.cur_system.scope) &&
-                    (!@object.parent.name.empty?) then
+                    (@object.parent != High.cur_system.scope) then # &&
+                    # (!@object.parent.name.empty?) then
                 # Need to have a hierachical access.
                 if @object.respond_to?(:low_object) && @object.low_object then
                     # There where already a low object, create the ref from it.
@@ -4387,9 +4408,15 @@ module HDLRuby::High
         end
 
         # Converts the block to HDLRuby::Low.
-        def to_low
+        # def to_low
+        def to_low(low_parent = nil)
             # Create the resulting block
             blockL = HDLRuby::Low::Block.new(self.mode,self.name)
+            # Is there a low parent?
+            if low_parent then
+                # Set it straight away to have correct references.
+                low_parent.block = blockL
+            end
             # # For debugging: set the source high object 
             # blockL.properties[:low2high] = self.hdr_id
             # self.properties[:high2low] = blockL
@@ -4555,12 +4582,16 @@ module HDLRuby::High
 
         # Converts the time behavior to HDLRuby::Low.
         def to_low
+            # Create an empty low behavior for the result.
+            behaviorL = HDLRuby::Low::Behavior.new
+            # Then fill it.
             # Create the low level block.
-            blockL = self.block.to_low
+            # blockL = self.block.to_low
+            blockL = self.block.to_low(behaviorL)
             # Create the low level events.
             eventLs = self.each_event.map { |event| event.to_low }
-            # Create and return the resulting low level behavior.
-            behaviorL = HDLRuby::Low::Behavior.new(blockL)
+            # # Create and return the resulting low level behavior.
+            # behaviorL = HDLRuby::Low::Behavior.new(blockL)
             # # For debugging: set the source high object 
             # behaviorL.properties[:low2high] = self.hdr_id
             # self.properties[:high2low] = behaviorL
@@ -4908,6 +4939,11 @@ module HDLRuby::High
         def width
             return self.bit_length
         end
+
+        # Cast.
+        def as(typ)
+            return self.to_expr.as(typ)
+        end
     end
 
     # Extends the Float class for computing the bit width and conversion

data/lib/HDLRuby/hruby_low.rb

@@ -74,6 +74,7 @@ module HDLRuby::Low
             res = []
             cur = self
             while(cur) do
+                # puts "cur=#{cur} cur.parent=#{cur.parent}"
                 res << cur
                 cur = cur.parent
             end
@@ -82,6 +83,7 @@ module HDLRuby::Low
 
         # Get an absolute reference to the object.
         def absolute_ref
+            # puts "absolute_ref for self=#{self}"
             # Get the full hierarchy up to the object.
             path = self.hierarchy
             # Create the reference.
@@ -2379,7 +2381,7 @@ module HDLRuby::Low
         attr_reader :block
 
         # Creates a new behavior executing +block+.
-        def initialize(block)
+        def initialize(block = nil)
             # Initialize the sensitivity list.
             @events = []
             # Check and set the block.
@@ -2417,7 +2419,7 @@ module HDLRuby::Low
             # And set the block
             @block = block
         end
-        private :block=
+        # private :block=
 
         # Comparison for hash: structural comparison.
         def eql?(obj)
@@ -6078,6 +6080,10 @@ module HDLRuby::Low
                 raise AnyError, "Invalid class for a range last: #{last.class}."
             end
             @range = first..last
+            # Clears the parent of first and last that is automatically added
+            # by Ruby when creating a range.
+            first.no_parent! if first.is_a?(Hparent)
+            last.no_parent! if last.is_a?(Hparent)
             # And set their parents.
             first.parent = last.parent = self
         end

data/lib/HDLRuby/hruby_low_without_namespace.rb

@@ -88,6 +88,7 @@ module HDLRuby::Low
 
         # Moves the declarations to the upper namespace.
         def to_upper_space!
+            # puts "to_upper_space for scope=#{self}"
             # First recurse.
             # On the sub scopes.
             self.each_scope(&:to_upper_space!)
@@ -472,6 +473,7 @@ module HDLRuby::Low
         # Fix the references names using scopes given in +scopes + list (they
         # are marked to be deleted).
         def fix_scope_refnames!(scopes)
+          # puts "fix_scope_refnames for self=#{self}"
           self.block.fix_scope_refnames!(scopes)
           return self
         end
@@ -834,10 +836,13 @@ module HDLRuby::Low
 
         # Replaces recursively +former+ name by +nname+ until it is redeclared.
         def replace_names!(former,nname)
+            # Already processed with fix_scope_refnames, so nothing to do
+            # here.
+            return
             # Stop here if the name is redeclared.
-            return if self.each_inner.find {|inner| inner.name == former }
+            # return if self.each_inner.find {|inner| inner.name == former }
             # Recurse on the sub scopes and behaviors.
-            replace_names_subs!(former,nname)
+            # replace_names_subs!(former,nname)
         end
 
         # Fix the references names using scopes given in +scopes + list (they
@@ -856,14 +861,16 @@ module HDLRuby::Low
         # are marked to be deleted).
         def fix_scope_refnames!(scopes)
             return self unless self.ref.is_a?(RefName)
-            # puts "fix_scope_refnames! with self.name=#{name} and self.ref=#{self.ref}"
+            # puts "fix_scope_refnames! with self=#{self} self.name=#{name} and self.ref=#{self.ref}"
             # Recurse on the ref.
-            self.set_ref!(self.ref.fix_scope_refnames!(scopes))
+            # self.set_ref!(self.ref.fix_scope_refnames!(scopes))
             # Rename and curt the subref if referening to one of the scopes.
             if scopes.find {|scope| scope.name == self.ref.name } then
                 self.ref.extend_name!(self)
+                # But need to remove the scope reference.
                 self.set_ref!(RefThis.new)
             end
+            # puts "Now self=#{self} self.name=#{self.name} self.ref=#{self.ref}"
             return self
         end
     end

data/lib/HDLRuby/hruby_low_without_subsignals.rb

@@ -243,6 +243,7 @@ module HDLRuby::Low
         # Flatten a reference to a list of reference to leaf signals
         # from signal +sig+ and add to result to +subrefs+
         def flatten_to(sig,subrefs)
+            # puts "flatten_to with sig=#{sig}"
             # Shall we decompose 2d vectors, and is the current signal
             # for one of them?
             if SystemT.decompose_vec2d? and sig.type.is_a?(TypeVector) and

data/lib/HDLRuby/ui/hruby_board.rb

@@ -63,7 +63,8 @@ module HDLRuby::High::Std
     end
 
     ## Class describing a digit display.
-    DIGIT = Struct.new(:id, :size, :hread) do
+    #  Need to know the data type since signed is supported.
+    DIGIT = Struct.new(:id, :size, :type, :hread) do
       def to_html
         return '<div class="digitset" id=' + self.id.to_s +
               ' data-width="' + self.size.to_s + '" data-value="0" >' +
@@ -559,6 +560,9 @@ Content-Type: text/html
   const cartouche = document.getElementById("cartouche");
   const panel     = document.getElementById("panel");
 
+  // The current time stamp.
+  var time_stamp = 0;
+
   // The input and output elements' ids.
   const input_ids = [];
   const output_ids = [];
@@ -689,7 +693,7 @@ Content-Type: text/html
   function digitset_update(digitset,value) {
     // Update the digiset value.
     digitset.dataset.value = value;
-    // Unsigned case.
+    // Update its display.
     const num = digitset.dataset.width;
     digitset.lastElementChild.innerHTML = String(value).padStart(num,"\u00A0");
   }
@@ -704,7 +708,9 @@ Content-Type: text/html
   }
 
   // Update an oscilloscope.
-  function scope_update(scope,value) {
+  function scope_update(scope,value,new_time_stamp) {
+    // Compute the advance in time.
+    let diff_time_stamp = new_time_stamp - time_stamp;
     // Get the canvas.
     const canvas = scope.lastElementChild;
     // Shall we set up its size?
@@ -775,21 +781,21 @@ Content-Type: text/html
       // Draw a line to the new position.
       cxt.beginPath();
       cxt.moveTo(toPx(pos),   toPy(previous));
-      cxt.lineTo(toPx(pos+1), toPy(value)); 
+      cxt.lineTo(toPx(pos+diff_time_stamp), toPy(value)); 
       cxt.stroke();
       /* Update the values. */
       scope.dataset.previous = value;
-      scope.dataset.pos = pos + 1;
+      scope.dataset.pos = pos + diff_time_stamp;
     }
   }
 
   // Update a general display element.
-  function element_update(element,value) {
+  function element_update(element,value,new_time_stamp) {
     if(element.classList.contains('ledset'))  { ledset_update(element,value); }
     if(element.classList.contains('digitset')){ digitset_update(element,value); }
     if(element.classList.contains('signedset')){signedset_update(element,value);}
     if(element.classList.contains('hexaset')) { hexaset_update(element,value); }
-    if(element.classList.contains('scope'))   { scope_update(element,value); }
+    if(element.classList.contains('scope'))   { scope_update(element,value,new_time_stamp); }
   }
 
 
@@ -799,19 +805,25 @@ Content-Type: text/html
     xhttp.onreadystatechange = function() {
       // console.log("response=" + this.responseText);
       if (this.readyState == 4 && this.status == 200) {
-        if (/[0-9]+:[0-9]/.test(this.responseText)) {
+        if (/^[0-9]+;[0-9]+:-?[0-9]/.test(this.responseText)) {
           // There is a real response.
           // Update the interface with the answer.
           const commands = this.responseText.split(';');
+          // Get the new time stamp.
+          let new_time_stamp = commands.shift();
+          // console.log("new_time_stamp=" + new_time_stamp);
+          // Process the other commands.
           for(command of commands) {
              const toks = command.split(':');
-             element_update(document.getElementById(toks[0]),toks[1]);
+             element_update(document.getElementById(toks[0]),toks[1],new_time_stamp);
           }
+          // Update the time stamp
+          time_stamp = new_time_stamp
         }
       }
     };
     // Builds the action from the state of the input elements.
-    act = '';
+    let act = '';
     for(id of input_ids) {
       act += id + ':' + document.getElementById(id).dataset.value + ';';
     }
@@ -824,8 +836,9 @@ Content-Type: text/html
   // First call of synchronisation.
   hruby_sync();
 
-  // Then periodic synchronize.
-  setInterval(function() { hruby_sync(); }, 100);
+  // Moved to the Ruby constructor to allow setting the time intervals.
+  // // Then periodic synchronize.
+  // setInterval(function() { hruby_sync(); }, 100);
 
 </script>
 
@@ -850,9 +863,14 @@ HTMLRESPONSE
 
     # Create a new board named +name+ accessible on HTTP port +http_port+
     # and whose content is describe in +hdlruby_block+.
-    def initialize(name, http_port = 8000, &hdlruby_block)
+    def initialize(name, http_port: 8000, refresh_rate: 100,
+                   &hdlruby_block)
       # Set the name.
       @name = name.to_s
+      # Set the refresh rate.
+      @refresh_rate = refresh_rate.to_i
+      # Tell the interface is to be built.
+      @first = true
       # Check and set the port.
       http_port = http_port.to_i
       if (@@http_ports.include?(http_port)) then
@@ -869,13 +887,17 @@ HTMLRESPONSE
       # Initialize the list of board elements to empty.
       @elements = []
       @out_elements = []
+      # Initialize the time stamp.
+      @time_stamp = 0
       # And build the board.
       # Create the namespace for the program.
       @namespace = Namespace.new(self)
       # Build the program object.
       High.space_push(@namespace)
       pr = nil
-      High.top_user.instance_eval { pr = program(:ruby, @name.to_sym) {} }
+      High.top_user.instance_eval do
+        pr = program(:ruby, @name.to_sym) { }
+      end
       @program = pr
       # Fill it.
       High.top_user.instance_eval(&hdlruby_block)
@@ -936,6 +958,7 @@ HTMLRESPONSE
       # Createthe ui component.
       @elements << DIGIT.new(@elements.size, 
               Math.log10(2**hport[1].type.width - 1).to_i + (sign ? 2 : 1),
+              hport[1].type,
               hport[0])
       @out_elements << @elements[-1]
     end
@@ -1018,9 +1041,13 @@ HTMLRESPONSE
     # Generate a response to a request to the server.
     def make_response(request)
       # puts "request=#{request}"
-      if (request.empty?) then
+      if (@first) then
+        @first = false
         # First or re-connection, generate the UI.
-        return UI_header + "\n<script>\n" + 
+        return UI_header + 
+          "\n<script>\n" + 
+          "// Then periodic synchronize.\n" + 
+          "setInterval(function() { hruby_sync(); }, #{@refresh_rate});\n" + 
           "set_cartouche('#{@name}');\n" +
           @elements.map do |elem|
             "add_element('#{elem.to_html}');"
@@ -1030,11 +1057,13 @@ HTMLRESPONSE
         # This should be an AJAX request, process it.
         commands = request.split(";")
         commands.each do |command|
+          next unless command.include?(":")
           id, val = command.split(":").map {|t| t.to_i}
           self.update_port(id,val)
         end
         # And generate the response: an update of each board output element.
-        return UI_response + @out_elements.each.map do |e|
+        return UI_response + "#{@time_stamp};" + 
+          @out_elements.each.map do |e|
           # puts "resp=" + "#{e.id}:#{RubyHDL.send(e.hread)}"
           "#{e.id}:#{RubyHDL.send(e.hread)}"
         end.join(";")
@@ -1057,6 +1086,8 @@ HTMLRESPONSE
             session.print self.make_response(path[1..-1])
             # And tell the ui has been connected.
             @connected = true
+            # Then advance the time stamp.
+            @time_stamp += 1
           else
             session.print 'Connection Refuse'
           end
@@ -1072,8 +1103,11 @@ HTMLRESPONSE
 
   # Create a new board named +name+ accessible on HTTP port +http_port+
   # and whose content is describe in +block+.
-  def board(name, http_port = 8000, &block)
-    return Board.new(name,http_port,&block)
+  def board(name, http_port: 8000, refresh_rate: 100, &block)
+    # puts "name=#{name} http_port=#{http_port} refresh_rate=#{refresh_rate} block=#{block}"
+    return Board.new(name,
+                     http_port: http_port, refresh_rate: refresh_rate,
+                     &block)
   end
 
 end

data/lib/HDLRuby/version.rb

@@ -1,3 +1,3 @@
 module HDLRuby
-  VERSION = "3.3.2"
+  VERSION = "3.3.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: HDLRuby
 version: !ruby/object:Gem::Version
-  version: 3.3.2
+  version: 3.3.4
 platform: ruby
 authors:
 - Lovic Gauthier
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-12 00:00:00.000000000 Z
+date: 2024-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -186,6 +186,7 @@ files:
 - lib/HDLRuby/hdr_samples/tuple.rb
 - lib/HDLRuby/hdr_samples/type_minmax_bench.rb
 - lib/HDLRuby/hdr_samples/with_board.rb
+- lib/HDLRuby/hdr_samples/with_board_sequencer.rb
 - lib/HDLRuby/hdr_samples/with_bram.rb
 - lib/HDLRuby/hdr_samples/with_bram_frame_stack.rb
 - lib/HDLRuby/hdr_samples/with_bram_stack.rb
@@ -475,7 +476,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: HDLRuby is a library for describing and simulating digital electronic systems.