origen_std_lib 0.10.1 → 0.13.1

data/templates/web/guides/v93ksmt7/customizable.md.erb

@@ -0,0 +1,139 @@
+% render "templates/web/layouts/guides.html" do
+
+The [Complete Tests](<%= path "guides/v93ksm7/complete" %>) provide a way to rapidly build a test program using
+off-the-shelf building blocks, however in many cases it will be desired to run a slightly customized version of these
+tests that is tweaked in some way to suit a particular application domain or for a few specific tests.
+
+This is where the customizable test template system should be used to get an easy way to create the
+following types of test methods:
+
+* Application-specific test primitives, for example a functional test method which calls an applications-specific
+  power up function at the start, or which enforces the use of a particular test port.
+* Test-specific variations on the primitive test methods, for example a functional test which will patch/overlay
+  the pattern with some data before running and/or capture and process some data at the end.
+
+The key goal of this system is to give test engineers the ability to implement common customization scenarios
+while writing an absolute minimum of application-specific code.
+
+## Concept
+
+To create a custom test based on a template, create a test method class that inherits from one of the template classes
+[defined in `Origen::TestMethod`](<%= path "/v93k_smt7/html/namespace_origen_1_1_test_method.html" %>), such as 
+[`FunctionalTest`](<%= path "/v93k_smt7/html/class_origen_1_1_test_method_1_1_functional_test.html" %>):
+
+~~~cpp
+#include "origen/test_method/functional_test.hpp"
+
+class Functional: public Origen::TestMethod::FunctionalTest {
+
+}
+~~~
+
+The test template will take care of many of the low-level details of how to create test methods in SMT7,
+such as having to remember to call `RDI_INIT()` and the use of `ON_FIRST_INVOCATION` and friends.
+
+To achieve this, the template takes control of the conventional SMT7 integration functions `initialize()`, 
+`run()` and `SMC_backgroundProcessing()`, which means that you should not use these within your application code.
+Instead, use the functions that are described here and these will allow you to hook into the test's
+lifecycle at various points during execution of the test.
+**Note that you do not have do define all of these, only the ones that you want to use.**
+
+#### Common Lifecycle Functions
+
+Here is a summary of the available lifecycle functions that should be supported by a majority of the
+templates (exceptions will be noted in the documentation for each template below):
+
+~~~cpp
+// This should be used to define any test methods parameters/arguments, it is a direct equivalent of the standard 
+// initialize() function.
+function init() {
+}
+
+// This will be invoked once (applied to all sites) before executing the main body of the test.
+// It should be used to do any setup that you wish to apply to all sites.
+function preBody() {
+}
+
+// This will be invoked once for each active site and the current site number will be passed in.
+// It should be used to do any site-specific setup.
+function preBody(int site) {
+}
+
+// This is invoked once per site and can be thought of as roughly equivalent to the standard run() function.
+function body() {
+  // By default it calls the test methods execute() method (more on this below), and this will internally apply
+  // ON_FIRST_INVOCATION wrappers as required so you should not add these around the call to origen.
+  origen.execute();
+}
+
+// This will be invoked once (applied to all sites) after executing the main body of the test.
+// It should be used to do any teardown that you wish to apply to all sites.
+// Note that this function is called synchronously, i.e. it will block execution of the test flow until it
+// has completed.
+function postBody() {
+}
+
+// This will be invoked once for each active site and the current site number will be passed in.
+// It should be used to do any site-specific teardown.
+// Note that this function is called synchronously, i.e. it will block execution of the test flow until it
+// has completed.
+function postBody(int site) {
+}
+
+
+// This will be invoked once for each active site and is intended to be the place where any processing of the
+// test result or captured data is performed.
+// If async is enabled then it will be called asynchronously and will not block execution of the test flow.
+// If async is not enabled then it will be called after postBody(int site), but is otherwise equivalent.
+function process(int site) {
+}
+~~~
+
+#### Common Configuration and Execute API
+
+All test templates expose their core functionality via an API that is launched through an object called `origen`.
+This is intended to provide a similar look and feel to the native SMT7 RDI API which is exposed through the `rdi` object.
+
+As mentioned above, the default `body()` function implementation will call `origen.execute()` which as the name
+suggests will execute the test.
+
+Configuration can be done ahead of calling `execute()`, for example a majority of test templates support the concept
+of selecting a port to execute the pattern on, that can be done like this:
+
+~~~cpp
+origen.port("MY_PORT_NAME");
+origen.execute();
+~~~
+
+Or, if you prefer, these can be chained together similar to the RDI API:
+
+~~~cpp
+origen.port("MY_PORT_NAME").execute();
+~~~
+
+To see what configuration options are available from a given test
+[defined in `Origen::TestMethod`](<%= path "/v93k_smt7/html/namespace_origen_1_1_test_method.html" %>), such as 
+
+#### Asynchronous Processing
+
+Asynchronous processing of test results is not supported yet, how to enable it will be described here when it
+is available.
+
+The plan is to provide a global switch that will enable/disable asynchronous processing and then an
+individual test-level switch to allow the global setting to be overridden.
+
+In the meantime, do all processing that could be done asynchronously within the `process(int site)` function
+described above. Your tests will then be ready to take advantage of the asynchronous feature when it becomes available.
+
+
+### Available Templates
+
+There now follows some template-specific guidance, which includes some usage examples:
+
+* [FunctionalTest](#Functional_Test)
+* [DCMeasurement](#DCMeasurement)
+* [FrequencyMeasurement](#FrequencyMeasurement)
+* [Empty](#Empty)
+
+
+% end

data/templates/web/guides/v93ksmt7/helpers.md.erb

@@ -0,0 +1,3 @@
+% render "templates/web/layouts/guides.html" do
+
+% end

data/templates/web/guides/{v93k → v93ksmt7}/install.md.erb

@@ -118,7 +118,7 @@ To check if everything is hooked up correctly, you can add this to one of your s
 and see if it builds:
 
 ~~~cpp
-require "origen.hpp"
+include "origen.hpp"
 ~~~
 
 % end

data/templates/web/guides/v93ksmt7/integration.md.erb

@@ -0,0 +1,3 @@
+% render "templates/web/layouts/guides.html" do
+
+% end

data/templates/web/guides/v93ksmt7/intro.md.erb

@@ -0,0 +1,8 @@
+% render "templates/web/layouts/guides.html" do
+
+The SmarTest 7 version of the library provides helpers, 
+
+
+
+
+% end

data/templates/web/guides/v93ksmt7/patching.md.erb

@@ -0,0 +1,3 @@
+% render "templates/web/layouts/guides.html" do
+
+% end

data/templates/web/guides/v93ksmt8/intro.md.erb

@@ -0,0 +1,9 @@
+% render "templates/web/layouts/guides.html" do
+
+<div class="alert alert-danger" role="alert">
+  <strong>Sorry, Documentation Fail</strong>
+</div>
+
+Unfortunately this guide has not been written yet, the SMT8 library is still in initial development.
+
+% end

data/templates/web/index.md.erb

@@ -4,18 +4,35 @@
 %# formatting like this, but in most cases that is not required.
 <h1><%= Origen.app.namespace %> <span style="font-size: 14px">(<%= Origen.app.version %>)</span></h1>
 
-### Purpose
+### Introduction
 
-This project provides a modern, standard test method library for the
-Advantest V93000 tester that is freely available for anyone to use.
+OrigenStdLib aims to provide a standard ATE library with the following goals:
 
-[See the FAQ](<%= path "faq" %>) for more background.
+* Be agnostic to any particular company or business so that anyone can use this
+* Be higher level than the native functionality provided by the ATE vendors - reducing the amount of low-level knowledge required by test engineers and the footprint of custom code required to be written for a particular test program application
+* Complement the Origen test program and test pattern generators (although it can still be used standalone with flows and patterns originating from any backend flow)
+
+It should be noted that this library does not aim to provide a common API across different ATE platforms. Instead, the goal is to provide
+a library which has a natural look and feel on each platform, while still providing a feature set which is broadly similar
+across all platforms.
+
+If abstraction of the test platform is required then that is expected to be done by higher level program generators, such
+as Origen, which can provide a common API that compiles to tests which target different ATE implementations of
+this library.
 
-### How To Install
+Generally, this library provides three main components:
 
+* Helper functions for general use in custom application code
+* Complete tests for use off-the-shelf
+* Customizable test templates that provide core functionality with the ability to customize around the edges
+
+[See the FAQ](<%= path "faq" %>) for more background.
 
-### How To Use
+### Supported Platforms
 
+OrigenStdLib currently provides libraries for the following platforms:
 
+* [Advantest V93K SMT7](<%= path 'guides/v93ksmt7/intro' %>)
+* [Advantest V93K SMT8](<%= path 'guides/v93ksmt8/intro' %>)
 
 % end

data/templates/web/layouts/_guides.html.erb

@@ -4,9 +4,21 @@ title: Origen Std Lib
 <%= render "partials/navbar.html", tab: :guides %>
 
 % index = {}
-% index["V93K"] = {
-%   v93k_intro: "Introduction",
-%   v93k_install: "How to Install",
+% index[nil] = {
+%   intro: "Introduction",
+% }
+% index["V93K SMT7"] = {
+%   v93ksmt7_intro: "Introduction",
+%   v93ksmt7_install: "How to Install",
+%   v93ksmt7_helpers: "Helper Functions",
+%   v93ksmt7_complete: "Complete Tests",
+%   v93ksmt7_customizable: "Customizable Tests",
+%   v93ksmt7_patching: "Patching Patterns (Overlay)",
+%   v93ksmt7_capture: "Data Capture",
+%   v93ksmt7_integration: "Origen Integration",
+% }
+% index["V93K SMT8"] = {
+%   v93ksmt8_intro: "Introduction",
 % }
 
 % opts = options.merge(index: index, root: "guides", prompt: "Search the guides...")

data/templates/web/partials/_common_args.md.erb

@@ -0,0 +1,13 @@
+* **port (string)** - (Optional, Default="") The name of a port to execute the pattern on, will be
+  run on all pins ('@') if a port name is not supplied.
+* **testName (string)** - (Optional) An explicit name to be used when logging the result of this
+  test, if not given the test suite name will be used
+* **forcePass (int)** - (Optional, Default=0) When set to 1, the test will appear to always pass in the flow (produce
+  a green box), although the actual pass/fail result value will be logged to STDF. Normally this would be
+  used for tests in the flow which are for data collection only. 
+* **onPassFlag (string)** - (Optional) The name of a test flow variable to be set if the test fails, e.g.
+  setting this to "MY_FLAG" would cause "@MY_FLAG" to be set to 1 in the event of the test passing.
+  No modification will be made to the variable if the test fails.
+* **onFailFlag (string)** - (Optional) The name of a test flow variable to be set if the test fails, e.g.
+  setting this to "MY_FLAG" would cause "@MY_FLAG" to be set to 1 in the event of the test failing.
+  No modification will be made to the variable if the test passes.

data/templates/web/partials/_navbar.html.erb

@@ -11,14 +11,14 @@
     </div>
     <div id="navbar" class="collapse navbar-collapse">
       <ul class="nav navbar-nav">
-        <li class="<%= options[:tab] == :guides ? 'active' : '' %>"><a href="<%= path "/guides/v93k/intro" %>">Guides</a></li>
+        <li class="<%= options[:tab] == :guides ? 'active' : '' %>"><a href="<%= path "/guides/intro" %>">Guides</a></li>
 
         <li class="<%= options[:tab] == :faq ? 'active' : '' %>"><a href="<%= path "/faq" %>">FAQ</a></li>
 
         <li class="dropdown">
           <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">API <span class="caret"></span></a>
           <ul class="dropdown-menu">
-            <li><a href="<%= path "/v93k/annotated.html" %>">V93K</a></li>
+            <li><a href="<%= path "/v93k_smt7/html/annotated.html" %>">V93K SMT7</a></li>
           </ul>
         </li>
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_std_lib
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.13.1
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-05 00:00:00.000000000 Z
+date: 2021-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.31.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.31.0
 description: 
 email:
 - stephen.mcginty@nxp.com
@@ -55,34 +55,53 @@ files:
 - lib/origen_std_lib_dev/interface.rb
 - lib/tasks/origen_std_lib.rake
 - program/prb1.rb
-- stdlib/v93k/origen/.cproject
-- stdlib/v93k/origen/.project
-- stdlib/v93k/origen/origen.cpp
-- stdlib/v93k/origen/origen.hpp
-- stdlib/v93k/origen/origen/helpers.hpp
-- stdlib/v93k/origen/origen/helpers/console.cpp
-- stdlib/v93k/origen/origen/helpers/misc.cpp
-- stdlib/v93k/origen/origen/site.cpp
-- stdlib/v93k/origen/origen/site.hpp
-- stdlib/v93k/origen/origen/test_method.hpp
-- stdlib/v93k/origen/origen/test_method/base.hpp
-- stdlib/v93k/origen/origen/test_method/dc_measurement.cpp
-- stdlib/v93k/origen/origen/test_method/dc_measurement.hpp
-- stdlib/v93k/origen/origen/test_method/frequency_measurement.cpp
-- stdlib/v93k/origen/origen/test_method/frequency_measurement.hpp
-- stdlib/v93k/origen/origen/test_method/functional_test.cpp
-- stdlib/v93k/origen/origen/test_method/functional_test.hpp
-- stdlib/v93k/origen/origen/utils.hpp
-- stdlib/v93k/origen/origen/utils/version.cpp
-- stdlib/v93k/origen/origen/utils/version.hpp
-- stdlib/v93k/origen/test_methods/ApplyBin.cpp
-- stdlib/v93k/origen/test_methods/DCMeasurement.cpp
-- stdlib/v93k/origen/test_methods/FrequencyMeasurement.cpp
-- stdlib/v93k/origen/test_methods/FunctionalTest.cpp
-- stdlib/v93k/origen/test_methods/RecordBin.cpp
+- src/advantest/smt7/origen/.cproject
+- src/advantest/smt7/origen/.project
+- src/advantest/smt7/origen/origen.cpp
+- src/advantest/smt7/origen/origen.hpp
+- src/advantest/smt7/origen/origen/helpers.hpp
+- src/advantest/smt7/origen/origen/helpers/console.cpp
+- src/advantest/smt7/origen/origen/helpers/misc.cpp
+- src/advantest/smt7/origen/origen/helpers/time.cpp
+- src/advantest/smt7/origen/origen/site.cpp
+- src/advantest/smt7/origen/origen/site.hpp
+- src/advantest/smt7/origen/origen/test_method.hpp
+- src/advantest/smt7/origen/origen/test_method/base.cpp
+- src/advantest/smt7/origen/origen/test_method/base.hpp
+- src/advantest/smt7/origen/origen/test_method/dc_measurement.cpp
+- src/advantest/smt7/origen/origen/test_method/dc_measurement.hpp
+- src/advantest/smt7/origen/origen/test_method/empty.cpp
+- src/advantest/smt7/origen/origen/test_method/empty.hpp
+- src/advantest/smt7/origen/origen/test_method/frequency_measurement.cpp
+- src/advantest/smt7/origen/origen/test_method/frequency_measurement.hpp
+- src/advantest/smt7/origen/origen/test_method/functional_test.cpp
+- src/advantest/smt7/origen/origen/test_method/functional_test.hpp
+- src/advantest/smt7/origen/origen/utils.hpp
+- src/advantest/smt7/origen/origen/utils/version.cpp
+- src/advantest/smt7/origen/origen/utils/version.hpp
+- src/advantest/smt7/origen/test_methods/ApplyBin.cpp
+- src/advantest/smt7/origen/test_methods/DCMeasurement.cpp
+- src/advantest/smt7/origen/test_methods/FrequencyMeasurement.cpp
+- src/advantest/smt7/origen/test_methods/FunctionalTest.cpp
+- src/advantest/smt7/origen/test_methods/RecordBin.cpp
+- src/advantest/smt8/origen/common/Origen.java
+- src/advantest/smt8/origen/common/OrigenData.java
+- src/advantest/smt8/origen/common/OrigenHelpers.java
+- src/advantest/smt8/origen/test_methods/Base.java
+- src/advantest/smt8/origen/test_methods/DC_Measurement.java
+- src/advantest/smt8/origen/test_methods/Empty.java
+- src/advantest/smt8/origen/test_methods/Functional_test.java
 - templates/web/faq.md.erb
-- templates/web/guides/v93k/install.md.erb
-- templates/web/guides/v93k/intro.md.erb
+- templates/web/guides/intro.md.erb
+- templates/web/guides/v93ksmt7/capture.md.erb
+- templates/web/guides/v93ksmt7/complete.md.erb
+- templates/web/guides/v93ksmt7/customizable.md.erb
+- templates/web/guides/v93ksmt7/helpers.md.erb
+- templates/web/guides/v93ksmt7/install.md.erb
+- templates/web/guides/v93ksmt7/integration.md.erb
+- templates/web/guides/v93ksmt7/intro.md.erb
+- templates/web/guides/v93ksmt7/patching.md.erb
+- templates/web/guides/v93ksmt8/intro.md.erb
 - templates/web/img/install1.png
 - templates/web/img/install2.png
 - templates/web/img/install3.png
@@ -91,6 +110,7 @@ files:
 - templates/web/index.md.erb
 - templates/web/layouts/_basic.html.erb
 - templates/web/layouts/_guides.html.erb
+- templates/web/partials/_common_args.md.erb
 - templates/web/partials/_navbar.html.erb
 - templates/web/release_notes.md.erb
 homepage: 
@@ -111,8 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.8.11
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Test program interface drivers for the Origen tester standard library

data/stdlib/v93k/origen/origen/helpers/console.cpp

@@ -1,105 +0,0 @@
-/** @file */
-#include "../helpers.hpp"
-#include <cerrno>
-#include <stdlib.h>
-#include "../../origen.hpp"
-
-using namespace std;
-
-namespace Origen {
-
-/// Prints the result of a parametric test to the console
-void logParametricTest(string name, int site, double result, LIMIT limits, string pin) {
-
-    cout << site << " ";
-    if (isPass(result, limits))
-        cout << "     ";
-    else
-        cout << "FAIL ";
-    cout << left << setw(65) << setfill(' ') << name << "  ";
-    cout << left << setw(20) << setfill(' ') << loStr(limits) << "  ";
-    cout << left << setw(20) << setfill(' ') << result;
-    cout << left << setw(20) << setfill(' ') << hiStr(limits);
-    cout << pin << endl;
-
-}
-
-/// Returns a LIMIT object with no limits enabled
-LIMIT noLimits() {
-	return LIMIT(TM::NA, 0, TM::NA, 0);
-}
-
-/// Prints the result of a functional test to the console
-void logFunctionalTest(string name, int site, bool passed, string pattern) {
-    cout << site << " ";
-    if (passed)
-        cout << "     ";
-    else
-        cout << "FAIL ";
-    cout << left << setw(65) << setfill(' ') << name << "  ";
-    cout << pattern << endl;
-}
-
-/// Converts the low limit in the given LIMIT object into a string, where an empty string will be returned if the limit is not enabled
-string loStr(LIMIT limits) {
-    double lo = 0.0;
-    double * plo = &lo;
-    TM::COMPARE clo;
-
-    clo = limits.getLow(plo);
-
-    if (clo == TM::NA) {
-        return "";
-    } else {
-        stringstream val;
-        val << lo;
-        return val.str();
-    }
-}
-
-/// Converts the high limit in the given LIMIT object into a string, where an empty string will be returned if the limit is not enabled
-string hiStr(LIMIT limits) {
-    double hi = 0.0;
-    double * phi = &hi;
-    TM::COMPARE chi;
-
-    chi = limits.getHigh(phi);
-
-    if (chi == TM::NA) {
-        return "";
-    } else {
-        stringstream val;
-        val << hi;
-        return val.str();
-    }
-}
-/// Returns true if the result is within the given limits
-bool isPass(double val, LIMIT limits) {
-    double lo = 0.0;
-    double hi = 0.0;
-    double * plo = &lo;
-    double * phi = &hi;
-    TM::COMPARE clo, chi;
-    bool result;
-
-    clo = limits.getLow(plo);
-    chi = limits.getHigh(phi);
-
-    result = true;
-
-    if (clo != TM::NA) {
-        if (clo == TM::GE && val < lo)
-            result = false;
-        if (clo == TM::GT && val <= lo)
-            result = false;
-    }
-    if (chi != TM::NA) {
-        if (chi == TM::LE && val > hi)
-            result = false;
-        if (chi == TM::LT && val >= hi)
-            result = false;
-    }
-    return result;
-}
-
-}