origen_testers 0.41.0 → 0.42.0

data/templates/origen_guides/pattern/timing.md.erb

@@ -1,5 +1,11 @@
 % render "layouts/guides.html" do
 
+% Origen.load_target('default')
+% dut.timeset(:func) do |t|
+%   t.period_in_ns = 10
+% end
+% tester.set_timeset(:func)
+
 A common workflow is to have a tester timing file defined and managed outside of Origen, in
 which case the main concern within your Origen source code is simply to refer to required
 timeset(s) by name.
@@ -8,7 +14,6 @@ However, Origen does also support a more complex timing definition where wavefor
 can be defined and mastered in Origen source code. That is discussed later on in the 
 [Complex Timing](<%= path "guides/pattern/timing/#Complex_Timing" %>) section.
 
-
 ### Simple Timing
 
 This guide gives an overview of some of the most common timing related
@@ -214,15 +219,68 @@ timeset :func do |t|
 end
 ~~~
 
+Complex waveforms also support an initial, or default, `period_in_ns`, allowing
+`set_timeset` to be used without providing a `period_in_ns`:
+
+~~~ruby
+dut.timeset :func do |t|
+  t.period_in_ns = 10
+end
+  
+tester.set_timeset(:func)
+tester.timeset.period_in_ns
+  #=> <%= tester.timeset.period_in_ns %>
+
+dut.timesets[:func].period_in_ns = 11
+% dut.timesets[:func].period_in_ns = 11
+tester.timeset.period_in_ns
+  #=> <%= tester.timeset.period_in_ns %>
+~~~
+
+<!-- This was originally planned, but causes some examples in Origen to fail.
+This `period_in_ns` can still changed prior to pattern execution, but the defining
+timeset can lock this value, disallowing other parts of the application or
+plugins to change the `period_in_ns`:
+
+~~~ruby
+timeset :func do |t|
+  t.period_in_ns = 10
+  t.lock!
+end
+  
+tester.set_timeset(:func)
+tester.timeset.period_in_ns
+  #=> 10
+
+timesets[:func].period_in_ns = 11
+  #=> OrigenTester::Timing::InvalidModification
+~~~
+-->
+
 #### Consuming Timeset Data
 
+##### Waveform Details
+
 The currently selected timeset can be retrieved via the following methods which are aliases:
 
 ~~~ruby
-dut.timeset               # => instance of Origen::Pins::Timing::Timeset
+dut.timeset               # => instance of OrigenTesters::Timing::Timeset
 dut.current_timeset
 ~~~
 
+Even though this returns a `OrigenTesters::Timing::Timeset` object, its linked
+back to the corresponding `Origen::Pins::Timing::Timeset` object underneath. To
+access it directly:
+
+~~~ruby
+dut.timeset.dut_timeset    #=> instance of Origen::Pins::Timing::Timeset
+
+tester.timeset.dut_timeset #=> instance of Origen::Pins::Timing::Timeset
+~~~
+
+However, this is generally not needed, as anything that the `OrigenTesters::Timing::Timeset`
+cannot do is given to the corresponding `Origen::Pins::Timing::Timeset` instance.
+
 Using the plural returns a hash containing all timesets, thereby allowing access to specific timesets
 regardless of the current selection:
 
@@ -277,5 +335,150 @@ dut.pin(:clk).drive_wave(1).events    # => [[0, 1], [20, 0]]
 dut.pin(:clk).drive_wave('T').events  # => [[0, 1], [10, 0], [20, 1], [30, 0]]
 ~~~
 
+##### Timeset Details
+
+You can retrieve the same `current period` information from this scope as from
+the `tester.timeset` scope:
+
+~~~ruby
+tester.set_timeset(:test, 10)
+% tester.set_timeset(:test, 10)
+
+tester.current_period
+  #=> <%= tester.current_period %>
+
+dut.current_timeset_period
+  #=> <%= dut.current_timeset_period %>
+  
+dut.current_period_in_ns
+  #=> <%= dut.current_period_in_ns %>
+
+dut.current_period_in_seconds
+  #=> <%= dut.current_period_in_seconds %>
+~~~
+
+### Timing During Execution
+
+You can freely swap between timesets during pattern execution. For example,
+a sequence resembling below is perfectly valid:
+
+~~~ruby
+# Start with an initial timeset for pattern startup
+tester.set_timeset("timing_for_startup", 100)
+tester.cycle
+# ...
+
+# Switch to a timeset for ramloading
+tester.set_timeset("timing_for_ramload", 200)
+tester.cycle
+# ...
+
+# Switch to a timeset for actual execution
+tester.set_timeset("timing_for_execution", 100)
+tester.cycle
+# ...
+~~~
+
+The period for that timeset will be remembered, allowing simpler timeset switches
+back to existing ones:
+
+~~~ruby
+# Execute using timing for SWD
+% tester.set_timeset("timing_for_swd", 40)
+tester.set_timeset("timing_for_swd", 40)
+tester.timeset.period_in_ns
+  #=> <%= tester.timeset.period_in_ns %>
+# ...
+
+# Execute using timing for an APB protocol
+% tester.set_timeset("timing_for_apb", 80)
+tester.set_timeset("timing_for_apb", 80)
+tester.timeset.period_in_ns
+  #=> <%= tester.timeset.period_in_ns %>
+# ...
+
+# Switch back to using SWD
+% tester.set_timeset("timing_for_swd")
+tester.set_timeset("timing_for_swd")
+tester.timeset.period_in_ns
+  #=> <%= tester.timeset.period_in_ns %>
+# ...
+
+# Switch back to using APB
+% tester.set_timeset("timing_for_apb")
+tester.set_timeset("timing_for_apb")
+tester.timeset.period_in_ns
+  #=> <%= tester.timeset.period_in_ns %>
+# ...
+
+# End the pattern using SWD
+% tester.set_timeset("timing_for_swd")
+tester.set_timeset("timing_for_swd")
+tester.timeset.period_in_ns
+  #=> <%= tester.timeset.period_in_ns %>
+# ...
+~~~
+
+<!--
+Notice that the `period_in_ns` is only defined once per timeset. Swiching
+the `period_in_ns` of a timeset _during_ execution is explicitly blocked
+by `OrigenTesters`:
+
+~~~ruby
+tester.set_timeset(:func, 10)
+
+tester.cycle
+tester.set_timeset(:func, 11)
+  #=> OrigenTester::Timing::InvalidModification
+~~~
+
+In this context, _during execution_ is defined as after a vector has been
+generated with the timeset in question; in other words, after the tester
+has been cycled. Up to the point of cycling though, timeset periods can be
+freely modified:
+
+~~~ruby
+tester.set_timeset(:func, 10)
+tester.timeset.period_in_ns
+  #=> 10
+
+tester.timeset.period_in_ns = 11
+tester.timeset.period_in_ns
+  #=> 11
+
+tester.set_timeset(:func, 12)
+tester.timeset.period_in_ns
+  #=> 12
+
+tester.cycle
+tester.timeset.period_in_ns = 13
+  #=> OrigenTester::Timing::InvalidModification
+~~~
+-->
+The `#cycled?` method to denotes if the timeset has been cycled or not:
+
+~~~ruby
+tester.set_timeset(:cycle_test, 10)
+% tester.set_timeset(:cycle_test, 10)
+tester.timeset.name
+  #=> "<%= tester.timeset.name %>"
+tester.timeset.cycled?
+  #=> <%= tester.timeset.cycled? %>
+
+tester.cycle
+tester.timeset.cycled?
+% tester.cycle
+  #=> <%= tester.timeset.cycled? %>
+
+tester.set_timeset(:cycle_test_2, 11)
+tester.timeset.cycled?
+% tester.set_timeset(:cycle_test_2, 11)
+  #=> <%= tester.timeset.cycled? %>
+
+tester.timesets[:cycle_test].cycled?
+  #=> <%= tester.timesets[:cycle_test].cycled? %>
+tester.timesets[:cycle_test_2].cycled?
+  #=> <%= tester.timesets[:cycle_test_2].cycled? %>
+~~~
 
 % end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_testers
 version: !ruby/object:Gem::Version
-  version: 0.41.0
+  version: 0.42.0
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-16 00:00:00.000000000 Z
+date: 2019-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -38,6 +38,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: atp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.3
 - !ruby/object:Gem::Dependency
   name: rodf
   requirement: !ruby/object:Gem::Requirement
@@ -101,6 +121,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- approved/j750/decompiler/sample/sample.atp
 - config/application.rb
 - config/boot.rb
 - config/commands.rb
@@ -155,6 +176,21 @@ files:
 - lib/origen_testers/basic_test_setups.rb
 - lib/origen_testers/callback_handlers.rb
 - lib/origen_testers/command_based_tester.rb
+- lib/origen_testers/decompiler.rb
+- lib/origen_testers/decompiler/decompiler_api.rb
+- lib/origen_testers/decompiler/nodes.rb
+- lib/origen_testers/decompiler/pattern.rb
+- lib/origen_testers/decompiler/pattern/elements/base.rb
+- lib/origen_testers/decompiler/pattern/elements/comment_block.rb
+- lib/origen_testers/decompiler/pattern/elements/frontmatter.rb
+- lib/origen_testers/decompiler/pattern/elements/pinlist.rb
+- lib/origen_testers/decompiler/pattern/elements/vector.rb
+- lib/origen_testers/decompiler/pattern/elements/vector_body_element.rb
+- lib/origen_testers/decompiler/pattern/enumerable_ext.rb
+- lib/origen_testers/decompiler/pattern/parsers.rb
+- lib/origen_testers/decompiler/pattern/spec_helpers.rb
+- lib/origen_testers/decompiler/pattern/splitter.rb
+- lib/origen_testers/decompiler/pattern/vector_delimiter_base.rb
 - lib/origen_testers/flow.rb
 - lib/origen_testers/generator.rb
 - lib/origen_testers/generator/identity_map.rb
@@ -196,6 +232,9 @@ files:
 - lib/origen_testers/igxl_based_tester/base/timeset.rb
 - lib/origen_testers/igxl_based_tester/base/timesets.rb
 - lib/origen_testers/igxl_based_tester/base/timesets_basic.rb
+- lib/origen_testers/igxl_based_tester/decompiler.rb
+- lib/origen_testers/igxl_based_tester/decompiler/atp.rb
+- lib/origen_testers/igxl_based_tester/decompiler/nodes.rb
 - lib/origen_testers/igxl_based_tester/files.rb
 - lib/origen_testers/igxl_based_tester/j750.rb
 - lib/origen_testers/igxl_based_tester/j750/custom_test_instance.rb
@@ -311,6 +350,8 @@ files:
 - lib/origen_testers/origen_ext/generator/resources.rb
 - lib/origen_testers/origen_ext/pins/pin.rb
 - lib/origen_testers/origen_ext/pins/pin_collection.rb
+- lib/origen_testers/origen_ext/pins/timing.rb
+- lib/origen_testers/origen_ext/pins/timing/timeset.rb
 - lib/origen_testers/parser.rb
 - lib/origen_testers/parser/description_lookup.rb
 - lib/origen_testers/parser/searchable_array.rb
@@ -347,6 +388,9 @@ files:
 - lib/origen_testers/smartest_based_tester/base/test_suite.rb
 - lib/origen_testers/smartest_based_tester/base/test_suites.rb
 - lib/origen_testers/smartest_based_tester/base/variables_file.rb
+- lib/origen_testers/smartest_based_tester/decompiler.rb
+- lib/origen_testers/smartest_based_tester/decompiler/avc.rb
+- lib/origen_testers/smartest_based_tester/decompiler/nodes.rb
 - lib/origen_testers/smartest_based_tester/smt7.rb
 - lib/origen_testers/smartest_based_tester/smt8.rb
 - lib/origen_testers/smartest_based_tester/v93k.rb
@@ -382,18 +426,25 @@ files:
 - lib/origen_testers/stil_based_tester/stil.rb
 - lib/origen_testers/test/basic_interface.rb
 - lib/origen_testers/test/block.rb
+- lib/origen_testers/test/complex_timing.rb
 - lib/origen_testers/test/custom_test_interface.rb
+- lib/origen_testers/test/dummy_decompiler.rb
 - lib/origen_testers/test/dut.rb
 - lib/origen_testers/test/dut2.rb
+- lib/origen_testers/test/dut_adv_timing.rb
+- lib/origen_testers/test/empty_dut.rb
 - lib/origen_testers/test/interface.rb
 - lib/origen_testers/test/nvm.rb
 - lib/origen_testers/timing.rb
+- lib/origen_testers/timing/timeset.rb
+- lib/origen_testers/timing/timing_api.rb
 - lib/origen_testers/vector.rb
 - lib/origen_testers/vector_based_tester.rb
 - lib/origen_testers/vector_generator.rb
 - lib/origen_testers/vector_pipeline.rb
 - pattern/bitmap.rb
 - pattern/dc_instr.rb
+- pattern/decompile.rb
 - pattern/delay.rb
 - pattern/freq_counter.rb
 - pattern/mem_test.rb
@@ -406,8 +457,10 @@ files:
 - pattern/nvm/j750/j750_workout.rb
 - pattern/nvm/j750/timing.rb
 - pattern/nvm/v93k/v93k_workout.rb
+- pattern/pin_flip.rb
 - pattern/read_write_reg.rb
 - pattern/reset.rb
+- pattern/simple.rb
 - pattern/single_overlay_store.rb
 - pattern/subroutines.rb
 - pattern/tester_overlay.rb
@@ -435,6 +488,10 @@ files:
 - templates/j750/_vt_instances.txt.erb
 - templates/j750/program_sheet.txt.erb
 - templates/manifest/v93k.yaml.erb
+- templates/origen_guides/decompilation/decompilerapi.md.erb
+- templates/origen_guides/decompilation/overview.md.erb
+- templates/origen_guides/decompilation/platformspecifics.md.erb
+- templates/origen_guides/decompilation/universalapi.md.erb
 - templates/origen_guides/pattern/common.md.erb
 - templates/origen_guides/pattern/creating.md.erb
 - templates/origen_guides/pattern/custom.md.erb
@@ -488,7 +545,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubyforge_project: 
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: This plugin provides Origen tester models to drive ATE type testers like