origen_testers 0.31.0 → 0.40.0

data/program/prb1.rb

@@ -10,4 +10,8 @@ Flow.create interface: 'OrigenTesters::Test::Interface', flow_description: 'Prob
 
   import 'components/prb1_main'
 
+  # Test that a reference to a deeply nested test works (mainly for SMT8)
+  test :on_deep_1, if_failed: :deep_test
+
+  pass 1, description: "Good die!", softbin: 1
 end

data/program/prb2.rb

@@ -1,6 +1,6 @@
 # An example of creating an entire test program from
 # a single source file
-Flow.create interface: 'OrigenTesters::Test::Interface' do
+Flow.create interface: 'OrigenTesters::Test::Interface', environment: :probe do
 
   # Test that this can be overridden from the target at flow-level
   self.add_flow_enable = :enabled
@@ -21,8 +21,12 @@ Flow.create interface: 'OrigenTesters::Test::Interface' do
   func :erase_all, duration: :dynamic, number: 12000
   func :margin_read1_all1, id: 'erased_successfully', number: 12010
 
-  if_enable 'extra_tests' do
-    import 'components/prb2_main', number: 13000
+  # Check that an instance variable change in a sub-flow (prb2_main in this case)
+  # is preserved back here in the main flow
+  if include_additional_prb2_test
+    if_enable 'extra_tests' do
+      import 'components/prb2_main', number: 13000
+    end
   end
 
   func :margin_read1_all1, number: 14000

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

@@ -36,6 +36,30 @@ clk _______|       |_______|       |_| |_| |_| |_| |_| |_| |_| |_| |_______|
 
 ~~~
 
+#### SmarTest 8
 
+The Origen V93K driver supports generating patterns into both SMT7 and SMT8 pattern formats.
+
+To enable SMT8 format, set the `smt_version:` attribute to 8 when instantiating the tester in your
+[application environment](<%= path "guides/runtime/environment" %>) as shown here:
+
+~~~ruby
+# environment/v93k_smt7.rb
+OrigenTesters::V93K.new
+
+# environment/v93k_smt8.rb
+OrigenTesters::V93K.new smt_version: 8
+~~~
+
+SMT8 patterns can either be in a zipped/binary format, or an ASCII file format.
+Zipped is the default, but the ASCII format can sometimes be useful when visually inspecting patterns or
+when comparing them via a difftool.
+To enable ASCII format patterns, configure your environment like this:
+
+~~~ruby
+# environment/v93k_smt8.rb
+OrigenTesters::V93K.new smt_version: 8,
+                        zip_patterns: false
+~~~
 
 % end

data/templates/origen_guides/program/v93k.md.erb

@@ -1,70 +1,5 @@
 % render "layouts/guides.html" do
 
-### Flow Considerations
-
-By default, a top-level `Flow.create` call in Origen will generate a standalone V93K testflow file which is
-internally wrapped by a flow group, like this:
-
-~~~text
-group <FLOW_NAME> {
-  // Flow content here
-}
-~~~
-
-When such flows are imported into a master flow file, SmarTest does not provide a standard enable mechanism
-to control which sub-flows are executed.
-
-However, Origen provides the ability to generate V93K flow modules with an enable-word wrapper, thereby allowing
-the top-level flow to easily enable/disable the execution of flow modules via flow variables.
-
-By enabling this feature in the target like this:
-
-~~~ruby
-OrigenTesters::V93K.new(add_flow_enable: :enabled)
-~~~
-
-the flow will now generate like this:
-
-~~~text
-group <FLOW_NAME> {
-  if @<FLOW_NAME>_ENABLE == 1 {
-    // Flow content here
-  }
-}
-~~~
-
-The `@<FLOW_NAME>_ENABLE` variable will be initialized to 1 in the generated variables file for the given flow,
-meaning that the module will run by default if the top-level flow does nothing with this variable.
-
-Alternatively, the variable can be initialized to off like this:
-
-~~~ruby
-OrigenTesters::V93K.new(add_flow_enable: :disabled)
-~~~
-
-Meaning that by default, the module will not run and the top-level flow must always enable it by including
-`@<FLOW_NAME>_ENABLE = 1` before hitting the module.
-
-Setting this attribute in the target means that it will apply to all flows. Alternatively, it can be set within
-the flow itself (or the interface) if it is necessary to use this feature for only a subset of flows, or to override
-the default setting for a particular flow.
-
-Here is an example:
-
-~~~ruby
-Flow.create interface: 'MyApp::Interface' do
-
-  # Ensure that this flow is always generated with an enable word wrapper that is enabled by default
-  self.add_flow_enable = :enabled
-
-  # Some functional test
-  func :blah
-end
-~~~
-
-This same API may be used to implement similar features on other platforms in future, but for now only the V93K is implemented.
-
-
 ### Interface Considerations
 
 Be sure to read and understand the guide to
@@ -133,6 +68,12 @@ t.lev_spec_set = 8
 t.levset = 1
 ~~~
 
+or to assign a spec in SMT8:
+
+~~~ruby
+t.spec = 'my_spec_min'
+~~~
+
 If the test method provides parameters, you can set them in the same way. As a convenience,
 Origen will automatically work out whether the reference is to a parameter of the test suite
 or of the test method, and will assign it accordingly.
@@ -164,38 +105,6 @@ t.lo_limit = 100.uA
 t.hi_limit = 150.uA
 ~~~
 
-#### Built-in Test Methods
-
-SmarTest comes with a standard AC and DC test method library and Origen provides a built-in API to
-generate a test flow which uses those test methods, here are some examples:
-
-~~~ruby
-# Execute a functional test
-test_method = test_methods.ac_tml.ac_test.functional_test
-
-# A basic DC voltage measurement
-test_method = test_methods.dc_tml.dc_test.general_pmu force_mode: 'CURR', force_value: 100.uA
-~~~
-
-Generally the parameter naming is the lower-cased and underscored version of the name that appears
-in the SMT documentation.
-
-See the [DC library API](http://origen-sdk.org/testers/api/OrigenTesters/SmartestBasedTester/Base/TestMethods/DcTml.html)
-and the [AC library API](http://origen-sdk.org/testers/api/OrigenTesters/SmartestBasedTester/Base/TestMethods/AcTml.html)
-for up-to-date details of the implemented test methods and the parameter names.
-
-However, some of these test methods are not particularly good and the recommendation from Advantest these
-days is generally not to use them.
-
-Since that means there is now a void where a universally available test method library should be, work is
-underway to provide an Origen standard test method library.
-The aim of this is to provide a complete generation solution from Origen so that those who have
-a fairly conventional use case can rapidly build a complete test program from off-the-shelf
-components, but that is still a work in progress and not yet ready for prime time use.
-
-Many users of the V93K program generator however, are likely to want to use it in combination
-with their own custom test method library...
-
 #### Custom Test Methods
 
 An API exists to define the naming and parameter signature of test methods provided by
@@ -402,55 +311,4 @@ For a more advanced integration which gets rid of the need to even call `add_my_
 can refer to how the `origen_std_lib` interface integration works 
 [here](https://github.com/Origen-SDK/origen_std_lib/blob/master/plugin/lib/origen_std_lib.rb).
 
-### Test Name Uniqueness
-
-Test (suite) naming collisions can occur when importing multiple independent test flow modules into a
-V93K master flow file.
-
-To prevent that from ever occurring, Origen will generate and append a unique signature to the end of
-all test names by default, for example:
-
-~~~ruby
-t = test_suites.add("my_test_name", options)
-
-t.name   # => "my_test_name_E32ABE8"
-~~~
-
-Applications can override this default behavior by setting the corresponding test interface attribute,
-`unique_test_names`, to one of the following values:
-
-* `:signature` - this is the default which will generate a unique signature as shown in the above example
-* `nil` - no value will be appended to the test names at all
-* `:flowname` - the name of the current top-level flow will be appended to all test names
-* Setting this attribute to any other value will append that value directly to all test names
-
-This attribute can be set in the [environment file](<%= path 'guides/runtime/environment' %>) when instantiating
-the tester:
-
-~~~ruby
-OrigenTesters::V93K.new unique_test_names: nil
-~~~
-
-This provides a single place to control the behavior within a [monolithic application architecture](<%= path 'guides/starting/architecture/#Monolithic_Application_Architecture' %>).
-
-However, under a [distributed application architecture](<%= path 'guides/starting/architecture/#Distributed_Application_Architecture' %>)
-a given test flow module may be generated under a target/environment that is controlled by a 3rd party.
-
-In that case, it is recommended to either set it at the flow-level, which will override any setting set at the
-environment-level:
-
-~~~ruby
-# program/wt1_start.rb
-Flow.create interface: 'MyApp::Interface', unique_test_names: 'wt1' do
-
-end
-~~~
-
-Or, it can be set directly within your interface logic which will take the highest precedence:
-
-~~~ruby
-# lib/my_app/interface.rb
-self.unique_test_names = :flowname
-~~~
-
 % end

data/templates/origen_guides/program/v93ksmt7.md.erb

@@ -0,0 +1,165 @@
+% render "layouts/guides.html" do
+
+This guide covers aspects of the V93K program generator API that are unique to SmarTest 7.
+
+Be sure to also consult the [V93K Common API guide](<%= path "guides/program/v93k" %>) which is also applicable
+to SMT7.
+
+The SMT7 API is enabled by default when instantiating a V93K test environment:
+
+~~~ruby
+# environment/v93k_smt7.rb
+OrigenTesters::V93K.new
+~~~
+
+### Interface Considerations
+
+#### Built-in Test Methods
+
+SmarTest comes with a standard AC and DC test method library and Origen provides a built-in API to
+generate a test flow which uses those test methods, here are some examples:
+
+~~~ruby
+# Execute a functional test
+test_method = test_methods.ac_tml.ac_test.functional_test
+
+# A basic DC voltage measurement
+test_method = test_methods.dc_tml.dc_test.general_pmu force_mode: 'CURR', force_value: 100.uA
+~~~
+
+Generally the parameter naming is the lower-cased and underscored version of the name that appears
+in the SMT documentation.
+
+See the [DC library API](http://origen-sdk.org/testers/api/OrigenTesters/SmartestBasedTester/Base/TestMethods/DcTml.html)
+and the [AC library API](http://origen-sdk.org/testers/api/OrigenTesters/SmartestBasedTester/Base/TestMethods/AcTml.html)
+for up-to-date details of the implemented test methods and the parameter names.
+
+However, some of these test methods are not particularly good and the recommendation from Advantest these
+days is generally not to use them.
+
+Since that means there is now a void where a universally available test method library should be, work is
+underway to provide an Origen standard test method library.
+The aim of this is to provide a complete generation solution from Origen so that those who have
+a fairly conventional use case can rapidly build a complete test program from off-the-shelf
+components, but that is still a work in progress and not yet ready for prime time use.
+
+Many users of the V93K program generator however, are likely to want to use it in combination
+with their own custom test method library, see [how to define one here](<%= path "guides/program/v93k/#Custom_Test_Methods" %>).
+
+### Flow Considerations
+
+By default, a top-level `Flow.create` call in Origen will generate a standalone V93K testflow file which is
+internally wrapped by a flow group, like this:
+
+~~~text
+group <FLOW_NAME> {
+  // Flow content here
+}
+~~~
+
+When such flows are imported into a master flow file, SmarTest does not provide a standard enable mechanism
+to control which sub-flows are executed.
+
+However, Origen provides the ability to generate V93K flow modules with an enable-word wrapper, thereby allowing
+the top-level flow to easily enable/disable the execution of flow modules via flow variables.
+
+By enabling this feature in the target like this:
+
+~~~ruby
+OrigenTesters::V93K.new(add_flow_enable: :enabled)
+~~~
+
+the flow will now generate like this:
+
+~~~text
+group <FLOW_NAME> {
+  if @<FLOW_NAME>_ENABLE == 1 {
+    // Flow content here
+  }
+}
+~~~
+
+The `@<FLOW_NAME>_ENABLE` variable will be initialized to 1 in the generated variables file for the given flow,
+meaning that the module will run by default if the top-level flow does nothing with this variable.
+
+Alternatively, the variable can be initialized to off like this:
+
+~~~ruby
+OrigenTesters::V93K.new(add_flow_enable: :disabled)
+~~~
+
+Meaning that by default, the module will not run and the top-level flow must always enable it by including
+`@<FLOW_NAME>_ENABLE = 1` before hitting the module.
+
+Setting this attribute in the target means that it will apply to all flows. Alternatively, it can be set within
+the flow itself (or the interface) if it is necessary to use this feature for only a subset of flows, or to override
+the default setting for a particular flow.
+
+Here is an example:
+
+~~~ruby
+Flow.create interface: 'MyApp::Interface' do
+
+  # Ensure that this flow is always generated with an enable word wrapper that is enabled by default
+  self.add_flow_enable = :enabled
+
+  # Some functional test
+  func :blah
+end
+~~~
+
+This same API may be used to implement similar features on other platforms in future, but for now only the V93K is implemented.
+
+### Test Name Uniqueness
+
+Test (suite) naming collisions can occur when importing multiple independent test flow modules into a
+V93K master flow file.
+
+To prevent that from ever occurring, Origen will generate and append a unique signature to the end of
+all test names by default, for example:
+
+~~~ruby
+t = test_suites.add("my_test_name", options)
+
+t.name   # => "my_test_name_E32ABE8"
+~~~
+
+Applications can override this default behavior by setting the corresponding test interface attribute,
+`unique_test_names`, to one of the following values:
+
+* `:signature` - this is the default which will generate a unique signature as shown in the above example
+* `nil` - no value will be appended to the test names at all
+* `:flowname` - the name of the current top-level flow will be appended to all test names
+* Setting this attribute to any other value will append that value directly to all test names
+
+This attribute can be set in the [environment file](<%= path 'guides/runtime/environment' %>) when instantiating
+the tester:
+
+~~~ruby
+OrigenTesters::V93K.new unique_test_names: nil
+~~~
+
+This provides a single place to control the behavior within a [monolithic application architecture](<%= path 'guides/starting/architecture/#Monolithic_Application_Architecture' %>).
+
+However, under a [distributed application architecture](<%= path 'guides/starting/architecture/#Distributed_Application_Architecture' %>)
+a given test flow module may be generated under a target/environment that is controlled by a 3rd party.
+
+In that case, it is recommended to either set it at the flow-level, which will override any setting set at the
+environment-level:
+
+~~~ruby
+# program/wt1_start.rb
+Flow.create interface: 'MyApp::Interface', unique_test_names: 'wt1' do
+
+end
+~~~
+
+Or, it can be set directly within your interface logic which will take the highest precedence:
+
+~~~ruby
+# lib/my_app/interface.rb
+self.unique_test_names = :flowname
+~~~
+
+
+% end

data/templates/origen_guides/program/v93ksmt8.md.erb

@@ -0,0 +1,112 @@
+% render "layouts/guides.html" do
+
+This guide covers aspects of the V93K program generator API that are unique to SmarTest 8.
+
+Be sure to also consult the [V93K Common API guide](<%= path "guides/program/v93k" %>) which is also applicable
+to SMT8.
+
+The SMT8 API is enabled by adding `smt_version: 8` when instantiating a V93K test environment:
+
+~~~ruby
+# environment/v93k_smt8.rb
+OrigenTesters::V93K.new smt_version: 8
+~~~
+
+### Package Structure
+
+The V93K SMT8 test program generator will create a package with the following structure:
+
+~~~text
+MyAppNamespace/
+├── common/    
+│   └── limits.ods
+├── flows/        
+│   ├── my_flow_1/              
+│   │   └── MY_SUB_FLOW.flow
+│   ├── MY_FLOW_2.flow
+│   └── MY_FLOW_1.flow
+└── limits/
+    ├── Main.MY_FLOW_2_TESTS.csv
+    └── Main.MY_FLOW_1_TESTS.csv
+~~~
+
+Here is a description of each component:
+
+
+##### MyAppNamespace/
+
+This is the name of this test program package, it should be unique and the entire directory is intended to be
+dropped directly into your test program's `src/` directory.
+By default, your Origen application's namespace is used, though this can be overridden within your V93K environment
+file:
+
+~~~ruby
+# environment/v93k_smt8.rb
+OrigenTesters::V93K.new smt_version: 8,
+                        package_namespace: 'something_else'
+~~~
+
+##### common/limits.ods
+
+Contains the limits tables for all flows.
+
+##### flows/
+
+A top-level test program flow file in Origen will generate a correspondingly named file in the `flows/` directory,
+where the name of the generated file is the upper-cased version of the source file name.
+If the flow imports sub-flows or contains groups, then those will be contained in a directory named after the
+lower-cased version of the flow name.
+
+##### limits/
+
+Origen generates the limts into CSV files before combining them into `common/limits.ods`. These intermediate files
+will not be used by the test program but they are kept around in case they are useful.
+
+### Flow Integration
+
+The generated flow(s) should be integrated into a top-level (Main) flow like this:
+
+~~~java
+flow Main {
+    setup {
+        flow MY_FLOW_1 calls MyAppNamespace.flows.MY_FLOW_1 {}
+        flow MY_FLOW_2 calls MyAppNamespace.flows.MY_FLOW_2 {}
+    }
+
+    execute {
+        MY_FLOW_1.execute();
+        MY_FLOW_2.execute();
+    }
+}
+~~~
+
+The `add_flow_enable:` tester option [as described in the SMT7 guide](<%= path "guides/program/v93ksmt7/#Flow_Considerations" %>)
+is also supported by the SMT8 generator, though it may not make as much sense to use it in that case.
+It generates an `ENABLE` flow parameter which could be used something like this:
+
+
+~~~java
+flow Main {
+    setup {
+        flow MY_FLOW_1 calls MyAppNamespace.flows.MY_FLOW_1 {}
+        flow MY_FLOW_2 calls MyAppNamespace.flows.MY_FLOW_2 {}
+    }
+
+    execute {
+        // Skip FLOW_1 and run only FLOW_2
+        MY_FLOW_1.ENABLE = 0;
+        MY_FLOW_2.ENABLE = 1;
+
+        MY_FLOW_1.execute();
+        MY_FLOW_2.execute();
+    }
+}
+~~~
+
+
+
+
+
+
+
+% end