origen_sim 0.12.0 → 0.13.0

data/lib/origen_sim/tester.rb

@@ -14,13 +14,24 @@ module OrigenSim
       end
 
       simulator.configure(opts, &block)
+      @comment_buffer = []
+      @last_comment_size = 0
       super()
     end
 
+    # Returns the current cycle count
+    def cycle_count
+      @cycle_count || 0
+    end
+
     def simulator
       OrigenSim.simulator
     end
 
+    def dut_version
+      simulator.dut_version
+    end
+
     def handshake(options = {})
     end
 
@@ -50,6 +61,12 @@ module OrigenSim
       simulator.sync_up
     end
 
+    # Flush any buffered simulation output, this should cause live waveviewers to
+    # reflect the latest state
+    def flush
+      simulator.flush
+    end
+
     def set_timeset(name, period_in_ns)
       super
       # Need to remove this once OrigenTesters does it
@@ -68,7 +85,10 @@ module OrigenSim
         puts '$tester.set_timeset("nvmbist", 40)   # Where 40 is the period in ns'
         exit 1
       end
+      flush_comments unless @comment_buffer.empty?
       simulator.cycle(options[:repeat] || 1)
+      @cycle_count ||= 0
+      @cycle_count += options[:repeat] || 1
       if @after_next_vector
         @after_next_vector.call(@after_next_vector_args)
         @after_next_vector = nil
@@ -76,7 +96,7 @@ module OrigenSim
     end
 
     def c1(msg, options = {})
-      simulator.write_comment(msg) if @step_comment_on
+      @comment_buffer << msg if @step_comment_on
     end
 
     def loop_vectors(name, number_of_loops, options = {})
@@ -126,8 +146,97 @@ module OrigenSim
       end
     end
 
+    def match(pin, state, timeout_in_cycles, options = {})
+      if dut_version <= '0.12.0'
+        OrigenSim.error "Use of match loops requires a DUT model compiled with OrigenSim version > 0.12.0, the current dut was compiled with #{dut_version}"
+      end
+      expected_val = state == :high ? 1 : 0
+      if options[:pin2]
+        expected_val2 = options[:state2] == :high ? 1 : 0
+      end
+      timed_out = true
+      10.times do
+        (timeout_in_cycles / 10).cycles
+        current_val = simulator.peek("dut.#{pin.rtl_name}").to_i
+        if options[:pin2]
+          current_val2 = simulator.peek("dut.#{options[:pin2].rtl_name}").to_i
+          if current_val == expected_val || current_val2 == expected_val2
+            timed_out = false
+            break
+          end
+        else
+          if current_val == expected_val
+            timed_out = false
+            break
+          end
+        end
+      end
+      # Final assertion to make the pattern fail if the loop timed out
+      if timed_out
+        pin.restore_state do
+          pin.assert!(expected_val)
+        end
+        if options[:pin2]
+          options[:pin2].restore_state do
+            options[:pin2].assert!(expected_val2)
+          end
+        end
+      end
+    end
+
+    def match_block(timeout_in_cycles, options = {}, &block)
+      if dut_version <= '0.12.0'
+        OrigenSim.error "Use of match loops requires a DUT model compiled with OrigenSim version > 0.12.0, the current dut was compiled with #{dut_version}"
+      end
+      match_conditions = Origen::Utility::BlockArgs.new
+      fail_conditions = Origen::Utility::BlockArgs.new
+      if block.arity > 0
+        block.call(match_conditions, fail_conditions)
+      else
+        match_conditions.add(&block)
+      end
+      timed_out = true
+      simulator.match_loop do
+        10.times do
+          (timeout_in_cycles / 10).cycles
+          # Consider the match resolved if any condition can execute without generating errors
+          if match_conditions.any? do |condition|
+            e = simulator.match_errors
+            condition.call
+            e == simulator.match_errors
+          end
+            timed_out = false
+            break
+          end
+        end
+      end
+      # Final execution to make the pattern fail if the loop timed out
+      if timed_out
+        if fail_conditions.instance_variable_get(:@block_args).empty?
+          match_conditions.each(&:call)
+        else
+          fail_conditions.each(&:call)
+        end
+      end
+    end
+
+    def wait(*args)
+      super
+      flush if Origen.running_interactively? && dut_version > '0.12.1'
+    end
+
     private
 
+    def flush_comments
+      # Looping for at least the length of the last comment is require to ensure that all lines
+      # from the last comment are either overwritten or cleared
+      [@comment_buffer.size, @last_comment_size].max.times do |i|
+        simulator.write_comment(i, @comment_buffer[i])
+      end
+      @last_comment_size = @comment_buffer.size
+      @comment_buffer.clear
+    end
+
     def after_next_vector(*args, &block)
       @after_next_vector = block
       @after_next_vector_args = args

data/lib/origen_sim_dev/dut.rb

@@ -24,6 +24,7 @@ module OrigenSimDev
       add_pin :p4, size: 4, force: 0xA
       add_pin :v1, rtl_name: 'nc'
       add_pin :v2, rtl_name: :nc
+      add_pin :done
       add_pin :not_present
 
       timeset :func do |t|
@@ -84,6 +85,10 @@ module OrigenSimDev
       # tester.simulator.log_messages = true
       tester.set_timeset('func', 100)
 
+      dut.pin(:rstn).drive!(1)
+      10.cycles
+      dut.pin(:rstn).drive!(0)
+      10.cycles
       dut.pin(:rstn).drive!(1)
       10.cycles
       dut.pin(:tck).drive!(1)

data/pattern/test.rb

@@ -11,6 +11,9 @@ Pattern.create do
   dut.jtag.read_ir(0xE, size: 4)
 
   ss "Switch to slower timeset"
+  ss "And test multiple comments for Github issue #8"
+  ss "Blah blah, more stuff to verify that we can handle large comment blocks without having problems"
+  ss "Blah blah, more stuff to verify that we can handle large comment blocks without having problems"
   tester.set_timeset("func", 200)
 
   dut.jtag.write_ir(0x5, size: 4)
@@ -103,4 +106,144 @@ Pattern.create do
     dut.cmd.write!(0x55)
     60.cycles
   end
+
+  ss "Test the command works with static vectors"
+  dut.pin(:done).assert!(1)
+  dut.pin(:done).dont_care
+  dut.cmd.write!(0x75)
+  5.cycles
+  dut.pin(:done).assert!(0)
+  dut.pin(:done).dont_care
+  500.cycles
+  dut.pin(:done).assert!(0)
+  dut.pin(:done).dont_care
+  500.cycles
+  dut.pin(:done).assert!(1)
+  dut.pin(:done).dont_care
+
+  ss "Test basic match loop"
+  dut.pin(:done).assert!(1)
+  dut.pin(:done).dont_care
+  dut.cmd.write!(0x75)
+  5.cycles
+  dut.pin(:done).assert!(0)
+  dut.pin(:done).dont_care
+  tester.wait match: true, time_in_cycles: 2000, pin: dut.pin(:done), state: :high
+  dut.pin(:done).assert!(1)
+  dut.pin(:done).dont_care
+
+  ss "Test basic 2-pin match loop"
+  dut.pin(:done).assert!(1)
+  dut.pin(:done).dont_care
+  dut.cmd.write!(0x75)
+  5.cycles
+  dut.pin(:done).assert!(0)
+  dut.pin(:done).dont_care
+  tester.wait match: true, time_in_cycles: 2000, pin: dut.pin(:tdo), state: :low,
+                                                 pin2: dut.pin(:done), state2: :high
+  dut.pin(:done).assert!(1)
+  dut.pin(:done).dont_care
+
+  ss "Test a block match loop"
+  dut.pin(:done).assert!(1)
+  dut.pin(:done).dont_care
+  dut.cmd.write!(0x75)
+  5.cycles
+  dut.pin(:done).assert!(0)
+  dut.pin(:done).dont_care
+  tester.wait match: true, time_in_cycles: 2000 do
+    dut.pin(:done).assert!(1)
+  end
+  dut.pin(:done).assert!(1)
+  dut.pin(:done).dont_care
+
+#  ss "Test a multi-block match loop"
+#  dut.pin(:done).assert!(1)
+#  dut.pin(:done).dont_care
+#  dut.cmd.write!(0x75)
+#  dut.pin(:done).assert!(0)
+#  dut.pin(:done).dont_care
+#  tester.wait match: true, time_in_cycles: 2000 do |conditions, fail|
+#    # Just do two conditions that do the same thing here, the content
+#    # is not important for testing this feature
+#    conditions.add do
+#      dut.pin(:done).assert!(1)
+#    end
+#    conditions.add do
+#      dut.pin(:done).assert!(1)
+#    end
+#  end
+#  dut.pin(:done).assert!(0)
+#  dut.pin(:done).dont_care
+
+  ss "Test sim_delay"
+  dut.pin(:done).assert!(1)
+  dut.pin(:done).dont_care
+  dut.cmd.write!(0x75)
+  5.cycles
+  dut.pin(:done).assert!(0)
+  dut.pin(:done).dont_care
+  tester.sim_delay :delay1 do
+    dut.pin(:done).assert!(1)
+  end
+  dut.pin(:done).assert!(1)
+  dut.pin(:done).dont_care
+
+  ss "Test sim delay with timeout"
+  dut.pin(:done).assert!(1)
+  dut.pin(:done).dont_care
+  dut.cmd.write!(0x75)
+  5.cycles
+  dut.pin(:done).assert!(0)
+  dut.pin(:done).dont_care
+  tester.sim_delay :delay1, time_in_cycles: 2000 do
+    dut.pin(:done).assert!(1)
+  end
+  dut.pin(:done).assert!(1)
+  dut.pin(:done).dont_care
+
+  ss "Test sim delay with resolution"
+  dut.pin(:done).assert!(1)
+  dut.pin(:done).dont_care
+  e = tester.cycle_count
+  dut.cmd.write!(0x75)
+  5.cycles
+  dut.pin(:done).assert!(0)
+  dut.pin(:done).dont_care
+  tester.sim_delay :delay1, resolution: 10 do
+    dut.pin(:done).assert!(1)
+  end
+  dut.pin(:done).assert!(1)
+  dut.pin(:done).dont_care
+
+  ss "Test sim delay with resolution and timeout"
+  dut.pin(:done).assert!(1)
+  dut.pin(:done).dont_care
+  e = tester.cycle_count
+  dut.cmd.write!(0x75)
+  5.cycles
+  dut.pin(:done).assert!(0)
+  dut.pin(:done).dont_care
+  tester.sim_delay :delay1, time_in_cycles: 2000, resolution: { time_in_cycles: 10 } do
+    dut.pin(:done).assert!(1)
+  end
+  dut.pin(:done).assert!(1)
+  dut.pin(:done).dont_care
+
+  ss "Test sim delay with padding"
+  dut.pin(:done).assert!(1)
+  dut.pin(:done).dont_care
+  e = tester.cycle_count
+  dut.cmd.write!(0x75)
+  5.cycles
+  dut.pin(:done).assert!(0)
+  dut.pin(:done).dont_care
+  tester.sim_delay :delay1, time_in_cycles: 2000, padding: { time_in_cycles: 500 } do
+    dut.pin(:done).assert!(1)
+  end
+  dut.pin(:done).assert!(1)
+  dut.pin(:done).dont_care
+  if (tester.cycle_count - e) < 1400
+    OrigenSim.error "sim_delay padding was not applied!"
+  end
 end

data/templates/empty.gtkw

@@ -17,10 +17,28 @@
 [signals_width] 158
 [sst_expanded] 1
 [sst_vpaned_height] 337
+@800200
+-debug
 @820
 origen.debug.pattern[1023:0]
-origen.debug.comments[1023:0]
+@800200
+-Comments
+@820
+origen.debug.comments0[1023:0]
+origen.debug.comments1[1023:0]
+origen.debug.comments2[1023:0]
+origen.debug.comments3[1023:0]
+origen.debug.comments4[1023:0]
+origen.debug.comments5[1023:0]
+origen.debug.comments6[1023:0]
+origen.debug.comments7[1023:0]
+origen.debug.comments8[1023:0]
+origen.debug.comments9[1023:0]
+@1000200
+-Comments
 @22
 origen.debug.errors[31:0]
+@1000200
+-debug
 [pattern_trace] 1
 [pattern_trace] 0

data/templates/empty.rc

@@ -0,0 +1,86 @@
+Magic 271485
+Revision Verdi_N-2017.12-SP2
+
+; Window Layout <x> <y> <width> <height> <signalwidth> <valuewidth>
+viewPort 0 28 1450 327 288 65
+
+; File list:
+; openDirFile [-d delimiter] [-s time_offset] [-rf auto_bus_rule_file] path_name file_name
+openDirFile -d / "" ""
+
+; file time scale:
+; fileTimeScale ### s|ms|us|ns|ps
+
+; signal spacing:
+signalSpacing 5
+
+; windowTimeUnit is used for zoom, cursor & marker
+windowTimeUnit 1ns
+
+; waveform viewport range
+zoom 0.000000 4013756.949425 1n
+cursor 10096.000000
+marker 0.000000
+
+; user define markers
+; userMarker time_pos marker_name color linestyle
+; visible top row signal index
+top 0
+; marker line index
+markerPos 6
+
+; event list
+; addEvent event_name event_expression
+; curEvent event_name
+
+
+
+COMPLEX_EVENT_BEGIN
+
+
+COMPLEX_EVENT_END
+
+
+
+; toolbar current search type
+; curSTATUS search_type
+curSTATUS ByChange
+
+
+activeDirFile "" ""
+addGroup "Debug"
+addSignal -h 15 -UNSIGNED -HEX -holdScope errors[31:0]
+addSignal -h 15 -UNSIGNED -ASC -holdScope pattern[1023:0]
+addGroup "Comments"
+addSignal -h 15 -UNSIGNED -ASC /origen/debug/comments[0]
+addSignal -h 15 -UNSIGNED -ASC /origen/debug/comments[1]
+addSignal -h 15 -UNSIGNED -ASC /origen/debug/comments[2]
+addSignal -h 15 -UNSIGNED -ASC /origen/debug/comments[3]
+addSignal -h 15 -UNSIGNED -ASC /origen/debug/comments[4]
+addSignal -h 15 -UNSIGNED -ASC /origen/debug/comments[5]
+addSignal -h 15 -UNSIGNED -ASC /origen/debug/comments[6]
+addSignal -h 15 -UNSIGNED -ASC /origen/debug/comments[7]
+addSignal -h 15 -UNSIGNED -ASC /origen/debug/comments[8]
+addSignal -h 15 -UNSIGNED -ASC /origen/debug/comments[9]
+addGroup "DUT"
+
+; getSignalForm Scope Hierarchy Status
+; active file of getSignalForm
+activeDirFile "" ""
+
+GETSIGNALFORM_SCOPE_HIERARCHY_BEGIN
+getSignalForm close
+
+"/FSN_DLLDELAY_1"
+"/origen"
+
+SCOPE_LIST_BEGIN
+"/testbench/msf1"
+"/FSN_DLLDELAY_1"
+"/testbench"
+"/origen"
+"/origen/dut"
+"/origen/debug"
+SCOPE_LIST_END
+
+GETSIGNALFORM_SCOPE_HIERARCHY_END

data/templates/empty.svcf

@@ -2,18 +2,22 @@
 # Preferences
 #
 preferences set plugin-enable-svdatabrowser-new 1
-preferences set toolbar-SimControl-WaveWindow {
+preferences set toolbar-Standard-WaveWindow {
   usual
-  position -row 1 -pos 4 -anchor e
+  position -pos 1
 }
 preferences set plugin-enable-groupscope 0
-preferences set sb-display-values 1
 preferences set plugin-enable-interleaveandcompare 0
 preferences set plugin-enable-waveformfrequencyplot 0
 preferences set toolbar-WaveZoom-WaveWindow {
   usual
   position -row 1 -pos 3 -anchor w
 }
+preferences set toolbar-SimControl-WaveWindow {
+  usual
+  position -row 1 -pos 4 -anchor e
+}
+preferences set sb-display-values 1
 preferences set whats-new-dont-show-at-startup 1
 #
 # Groups
@@ -21,6 +25,7 @@ preferences set whats-new-dont-show-at-startup 1
 catch {group new -name Debug -overlay 0}
 catch {group new -name {Group 2} -overlay 0}
 catch {group new -name DUT -overlay 0}
+catch {group new -name Comments -overlay 0}
 group using Debug
 group set -overlay 0
 group set -comment {}
@@ -28,8 +33,7 @@ group clear 0 end
 
 group insert \
     [subst  {[format {origen.debug.pattern[1023:0]}]} ] \
-    [subst  {[format {origen.debug.comments[1023:0]}]} ] \
-    [subst  {[format {origen.debug.errors[31:0]}]} ]
+    Comments
 group using {Group 2}
 group set -overlay 0
 group set -comment {}
@@ -40,6 +44,22 @@ group set -overlay 0
 group set -comment {}
 group clear 0 end
 
+group using Comments
+group set -overlay 0
+group set -comment {}
+group clear 0 end
+
+group insert \
+    [subst  {[format {origen.debug.comments0[1023:0]}]} ] \
+    [subst  {[format {origen.debug.comments1[1023:0]}]} ] \
+    [subst  {[format {origen.debug.comments2[1023:0]}]} ] \
+    [subst  {[format {origen.debug.comments3[1023:0]}]} ] \
+    [subst  {[format {origen.debug.comments4[1023:0]}]} ] \
+    [subst  {[format {origen.debug.comments5[1023:0]}]} ] \
+    [subst  {[format {origen.debug.comments6[1023:0]}]} ] \
+    [subst  {[format {origen.debug.comments7[1023:0]}]} ] \
+    [subst  {[format {origen.debug.comments8[1023:0]}]} ] \
+    [subst  {[format {origen.debug.comments9[1023:0]}]} ]
 
 #
 # Mnemonic Maps
@@ -70,16 +90,52 @@ waveform baseline set -time 0
 
 
 set groupId0 [waveform add -groups Debug]
+
+set groupId1 [waveform find -name Comments]
+set gpGlist1 [waveform hierarchy contents $groupId1]
+set gpID1 [lindex $gpGlist1 0]
+foreach {name attrs} [subst  {
+    {[format {origen.debug.comments0[1023:0]}]} {-radix %a}
+    {[format {origen.debug.comments1[1023:0]}]} {-radix %a}
+    {[format {origen.debug.comments2[1023:0]}]} {-radix %a}
+    {[format {origen.debug.comments3[1023:0]}]} {-radix %a}
+    {[format {origen.debug.comments4[1023:0]}]} {-radix %a}
+    {[format {origen.debug.comments5[1023:0]}]} {-radix %a}
+    {[format {origen.debug.comments6[1023:0]}]} {-radix %a}
+    {[format {origen.debug.comments7[1023:0]}]} {-radix %a}
+    {[format {origen.debug.comments8[1023:0]}]} {-radix %a}
+    {[format {origen.debug.comments9[1023:0]}]} {-radix %a}
+}] childcmds {
+    {}
+    {}
+    {}
+    {}
+    {}
+    {}
+    {}
+    {}
+    {}
+    {}
+} {
+    set expected [ join [waveform signals -format path $gpID1] ]
+    if {[string equal $name $expected] || $name == "cdivider"} {
+        if {$attrs != ""} {
+            eval waveform format $gpID1 $attrs
+        }
+        if { $childcmds != ""} {
+            eval $childcmds
+        }
+    }
+    set gpGlist1 [lrange $gpGlist1 1 end]
+    set gpID1 [lindex $gpGlist1 0]
+}
+
 set gpGlist0 [waveform hierarchy contents $groupId0]
 set gpID0 [lindex $gpGlist0 0]
 foreach {name attrs} [subst  {
     {[format {origen.debug.pattern[1023:0]}]} {-radix %a}
-    {[format {origen.debug.comments[1023:0]}]} {-radix %a}
-    {[format {origen.debug.errors[31:0]}]} {}
 }] childcmds {
     {}
-    {}
-    {}
 } {
     set expected [ join [waveform signals -format path $gpID0] ]
     if {[string equal $name $expected] || $name == "cdivider"} {
@@ -94,7 +150,21 @@ foreach {name attrs} [subst  {
     set gpID0 [lindex $gpGlist0 0]
 }
 
+set id [waveform add -signals [subst  {
+	{[format {origen.debug.errors[31:0]}]}
+	} ]]
 
 set groupId0 [waveform add -groups DUT]
 
+waveform xview limits 0 32768000ns
+
+#
+# Waveform Window Links
+#
+
+#
+# Console windows
+#
+console set -windowname Console
+window geometry Console 600x250+2364+0