origen_sim 0.20.5 → 0.20.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10adeb117e20dbfb4c23febad8c5e17f690583c7aff915459459482610c9db73
-  data.tar.gz: 0f6f9ce9fd304904a2c470e73d7e1fae6e377c1b3a28a2e1cbd5df1626f4f0d0
+  metadata.gz: 460b8179907e128d77b2974255f034d547f60c33c91f1ffde8e1bd25726238a7
+  data.tar.gz: a76d417628ad05a2a8da4d6ad4a2c7d0f97e9f275c9fe8aaa8c3ec21fa2a3e57
 SHA512:
-  metadata.gz: 4459230d306681f87128cf22b9310fc101f7354a0bc6a0a79f1d08cd31fa66c9bb57f7b49b5cc9684abab7be8a47390db6bf6eaa663ddea8984853318429057f
-  data.tar.gz: 778e3e0643ac8ceb58c2f741fae6ef954d494c85a9301e6e8e7c3b37d59910cd413e6a494a848ee860128a3b79f75e1f999d9255fff5b2df3cab8543395204b8
+  metadata.gz: d7b355f2be67eab8558b7e396da1116bbb5895a12a706202e509e1d617858d711fe13f2a30ded4c575bb487358dea5d6c75bb9b7742442e6b50ea6242f8cc91c
+  data.tar.gz: 743428765629ffc1100a2f749f99f587eaf4e673bb049b43a919f16a940e74d35d34ba49ab2c9abf6fc569951f2ce31846626e60cdb0c28a9cf40580a0394f50

data/config/version.rb

@@ -1,7 +1,7 @@
 module OrigenSim
   MAJOR = 0
   MINOR = 20
-  BUGFIX = 5
+  BUGFIX = 6
   DEV = nil
   VERSION = [MAJOR, MINOR, BUGFIX].join(".") + (DEV ? ".pre#{DEV}" : '')
 end

data/lib/origen_sim/simulator.rb

@@ -1252,6 +1252,8 @@ module OrigenSim
     end
 
     def clean(net)
+      # substitute ruby syntax ".." for verilog ":"
+      net.gsub!('..', ':')
       if net =~ /^dut\./
         "#{testbench_top}.#{net}"
       else

data/lib/origen_sim/tester.rb

@@ -5,6 +5,8 @@ module OrigenSim
 
     TEST_PROGRAM_GENERATOR = OrigenSim::Generator
 
+    attr_accessor :out_of_bounds_handler
+
     def initialize(options = {}, &block)
       # Use Origen's collector to allow options to be set either from the options hash, or from the block
       if block_given?
@@ -328,10 +330,19 @@ module OrigenSim
                 end
 
                 diffs.each do |position, expected, received|
-                  if received == -1 || received == -2
-                    reg_or_val[position].unknown = true
+                  if position < reg_or_val.size
+                    if received == -1 || received == -2
+                      reg_or_val[position].unknown = true
+                    else
+                      reg_or_val[position].write(received, force: true)
+                    end
                   else
-                    reg_or_val[position].write(received, force: true)
+                    # This bit position is beyond the bounds of the register
+                    if @out_of_bounds_handler
+                      @out_of_bounds_handler.call(position, received, expected, reg_or_val)
+                    else
+                      Origen.log.error "bit[#{position}] of read operation on #{reg_or_val.path}.#{reg_or_val.name}: expected #{expected} received #{received}"
+                    end
                   end
                 end
 
@@ -345,7 +356,7 @@ module OrigenSim
                 # Put the data back so the application behaves as it would if generating
                 # for a non-simulation tester target
                 diffs.each do |position, expected, received|
-                  reg_or_val[position].write(expected, force: true)
+                  reg_or_val[position].write(expected, force: true) if position < reg_or_val.size
                 end
               end
             end

data/lib/origen_sim_dev/dut.rb

@@ -170,7 +170,12 @@ module OrigenSimDev
               jtag.write_dr(dr)
               dr.rg_enable.write(0)
               dr.rg_data.copy_all(reg)
-              jtag.read_dr(dr)
+              if !options[:force_out_of_bounds]
+                jtag.read_dr(dr)
+              else
+                expect_val = dr.data + 2**dr.size
+                jtag.read_dr expect_val, size: dr.size + 1
+              end
             end
           end
         end

data/pattern/fails.rb

@@ -20,4 +20,16 @@ Pattern.create do
     ss "Test reading an X register value, expect LSB nibble to be 0"
     dut.x_reg[3..0].read!(0)
   end
+
+  ss "Test an out of bounds miscompare"
+  dut.cmd.write!(0x1234_5678)
+  dut.cmd.read!(0x1233_5678, force_out_of_bounds: true)
+
+  ss "Test user out of bounds handler"
+  if tester.sim?
+    tester.out_of_bounds_handler = proc do |position, received, expected, reg|
+      Origen.log.error "User handler hook is working --> #{reg.name}, bit[#{position}]: expected #{expected}, received #{received}"
+    end
+  end
+  dut.cmd.read!(0x1233_5678, force_out_of_bounds: true)
 end

data/templates/origen_guides/simulation/debugging.md.erb

@@ -100,6 +100,21 @@ For reference, here is the update that was made to the JTAG driver to support th
 
 If the driver has not provided this then a warning will be output and no received data will be given.
 
+In some cases the protocol being used may generate failed compares that contain bit position meta data 
+that does not map to the register being read. In this case a generic message will be displayed with the 
+bit position that failed along with the register that was being read. It may be desirable to have application 
+specific code interpret these bits (for example if it is a status bit). Origen provides a hook for this. Below 
+is an example of how to implement a custom interpreter.
+
+~~~ruby
+if tester.sim?
+  tester.out_of_bounds_handler = proc do |position, received, expected, reg|
+    Origen.log.error "Got data ouside of #{reg.name} during the transaction, bit[#{position}]: expected #{expected}, received #{received}"
+    Origen.log.error "ECC error during read of #{reg.path}.#{reg.name}" if position == 39
+  end
+end
+~~~
+
 This feature will automatically be enabled for any reads launched via the register object itself, e.g.
 `my_reg.read!`, but not for reads launched by calling the `read_register` method manually,
 e.g. `dut.read_register(my_reg)`.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_sim
 version: !ruby/object:Gem::Version
-  version: 0.20.5
+  version: 0.20.6
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-12 00:00:00.000000000 Z
+date: 2019-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen