origen_std_lib 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02307391c68ec5b25893847224f546c0351b0c70
-  data.tar.gz: 87152340d9f9075d485451655bf8669f5684825e
+  metadata.gz: 0f1a67852650af0bf19859349606985c99f2a063
+  data.tar.gz: b5775c7ab62c12e1864dceb7a0edc297e172dea4
 SHA512:
-  metadata.gz: a75556d60c14f0a5e7ec6f8f3611945a3af54141a2943568be8442b129dbf719ff3c1337d6a658a47c498f29acf8869d9ce1eb3b0c9f55ed544ec746433665ea
-  data.tar.gz: f7013a87de39b5c71fe8099a96140a6b5c8def865db2a12ca72462a596860c4b3487183178ddecf2d88c0d0365de203afa39aab5ba31897c0957ac182d45b7c1
+  metadata.gz: fcb77fc428cb22c3667b93735e5d78981fd1d495698c67b4d2b731b5842f728ba08426c1b06ec4db2d6877ff9a83d67dfba57e2ea1683b52ba9e47a147a5dc50
+  data.tar.gz: fbddce5eb769e6c9a667a3659626804a6f3b1253ede6a87917ab285d347a1d3e9aed332102b187ac16c5be21460d8384e5b0fc3edd96b4d366bf76c4a37294b0

data/config/version.rb

@@ -1,6 +1,6 @@
 module OrigenStdLib
   MAJOR = 0
-  MINOR = 6
+  MINOR = 7
   BUGFIX = 0
   DEV = nil
 

data/lib/origen_std_lib/v93k.rb

@@ -42,6 +42,39 @@ module OrigenStdLib
                 pin:          [:string, nil],
                 samples:      [:integer, 2000],
                 period_in_ns: [:integer, nil]
+              },
+
+              record_bin:            {
+                bin:     [:integer, nil],
+                softbin: [:integer, nil]
+              },
+
+              apply_bin:             {
               }
   end
+
+  # Record the given bin / softbin
+  def record_bin(options = {})
+    if tester.v93k?
+      n = 'delayed'
+      n += "_bin#{options[:bin]}" if options[:bin]
+      n += "_sbin#{options[:softbin]}" if options[:softbin]
+      i = test_suites.add(n)
+      i.test_method = test_methods.origen.record_bin(options)
+      # The bins are included here to insert them into the flow, which is required by SMT to
+      # allow them to be applied later.
+      # However the bins really refer to some parent test, so we tell the TestIds plugin (if
+      # it is being used), not to consider them attached to this record bin test suite.
+      test(i, options.merge(test_ids: :notrack))
+    end
+  end
+
+  # Bins out the device if a delayed bin has been set
+  def apply_bin(options = {})
+    if tester.v93k?
+      i = test_suites.add('ApplyBin')
+      i.test_method = test_methods.origen.apply_bin
+      test(i, options.merge(on_fail: { render: 'multi_bin;' }, continue: true))
+    end
+  end
 end

data/templates/web/faq.md.erb

@@ -0,0 +1,117 @@
+% render "layouts/basic.html", tab: :faq do
+
+# Frequently Asked Questions
+
+## General
+
+#### Do I need to use Origen to use this?
+
+No. This library complements the Origen eco-system but it has no dependencies on it.
+It can be used with a test program and patterns that originate from any tool
+chain.
+
+#### Do I need to pay for it?
+
+No. It is licensed under the [MIT License](https://tldrlegal.com/license/mit-license) which means
+that you can do whatever you like with it.
+
+#### Is it production worthy?
+
+Sort of. We are using it in some minor production scenarios within NXP, however it is still
+in the very early stages of development and the APIs are subject to change until we reach version 1.
+
+#### Will it break my test program when I upgrade to a new version of the library?
+
+No. This project will follow the [semantic versioning](http://semver.org/) standard
+which means that we must be fully backwards-compatible between major version releases, which
+should not happen very often (maybe every few years).
+
+However, until we hit major version 1, some minor instability is allowed while we
+get the foundational architecture and APIs worked out.
+Having said that, this library will soon be qualified in some production test programs within NXP
+and at that point any API breakages will be as painful for us as it would be for anyone else,
+so major flux is not expected.
+
+Of course bugs can and do happen, and we would recommend that you follow normal checkout
+procedures to qualify your test program when updating the Origen library.
+
+#### Can I contribute?
+
+Yes! NXP is releasing this to the industry with the hope that we can work together to create
+common infrastructure that goes beyond the foundation provided by the ATE vendors.
+
+Please [contact us](http://origen-sdk.org/origen/community/) if you need help to get started.
+
+
+#### Is it supported by the ATE vendors?
+
+No. Although we hope in time that the vendor's apps engineers will become active
+contributors to this library and will start to use it in their own applications.
+
+#### Is it supported by NXP?
+
+Not officially. It is open source and comes with no guarantees.
+
+#### So who does support it then?
+
+Right now the Origen core team (who are mainly all NXP employees today, but we hope that will change),
+are the primary
+maintainers and we will consider feature requests and address bug reports that are submitted by users
+of the library.
+
+However anyone is more then welcome to contribute bug fixes, feature additions,
+documentation, etc. and ultimately we hope to see a self-sustaining community grow around
+this project.
+
+#### What platforms do you intend to support?
+
+Initially we are developing this as an offshoot of some new test programs we are making for
+the Advantest V93K platform.
+
+We do expect to start to adding similar features for Teradyne platforms (likely J570 and UltraFLEX)
+next year.
+
+## V93K Specific
+
+#### Why do we need this?
+
+The standard test method library that comes with SmarTest for AC and DC tests, is no longer
+recommended by Advantest.
+
+However, while its replacement (RDI) is a high-level API in terms of the tester hardware, it is
+still a low level
+API in terms of a complete test. Anyone who wants to implement even a basic test, has
+to write a custom test method from scratch instead of just picking up an existing test
+method off the shelf.
+
+This project aims to fill that void and provide a modern library of off-the-shelf test
+methods that adhere to the latest Advantest guidelines.
+
+#### I will probably still need some custom tests, can this help with those?
+
+Yes. The off-the-shelf test methods provided by this library are very thin wrappers around
+a high level Origen API, which implements high level functions such as "run a functional test",
+"run a pattern and take a DC measurement", etc.
+Each of these functions provides a standard set of callback points so that your test program can easily
+hook into their execution in order to add your own customizations.
+
+Additionally, as well as complete test methods, this project also aims to provide a rich
+library of helper functions
+that can be used when writing your own tests.
+
+#### Does it perform well?
+
+Yes. It uses the latest RDI APIs recommended by Advantest under the hood and it will in future
+fully support background data-processing using the SmartCalc framework.
+
+#### Why is the library not installed at system level?
+
+We want to encourage the users of the library to look inside it, so that they can begin to understand
+it, be empowered to do front line debug, and be able to experiment with adding new features.
+Distributing it as a binary for installation at system level would add a significant barrier
+to the open and inclusive way of working that we want to encourage.
+
+Installing it within the test program itself also makes the test programs self contained and
+therefore more portable between test systems.
+
+% end

data/templates/web/guides/v93k/install.md.erb

@@ -0,0 +1,124 @@
+% render "templates/web/layouts/guides.html" do
+
+<style>
+  img { margin: 20px 0; }
+</style>
+
+This document describes how to obtain the Origen V93K library
+and then install it within a test program.
+
+The guide is split into two parts:
+
+* [Part 1](#Part_1) - Describes how to obtain and add the library to your test program. Everyone must
+  do this part; for example when you have no plans to use it directly in your own code,
+  but you want to use another 3rd party library which depends on Origen.
+
+* [Part 2](#Part_2) - Describes the additional steps that are required if you want to use the Origen
+  APIs within your own code.
+
+
+### Part 1
+
+#### Get the Code
+
+The library is installed by placing a complete copy of the source code within your test program's
+top-level directory (the standard place to put test method libraries).
+
+[See the FAQ](<%= path "faq/#Why_is_the_library_not_installed_at_system_level?" %>) for why this
+approach has been chosen.
+
+If you have access to the web and have Git installed, the easiest
+way is to check it out directly from Github:
+
+~~~text
+cd your/test/program
+git clone https://github.com/Origen-SDK/origen_std_lib.git
+~~~
+
+Then run these commands anytime you want to change version, substituting the version reference as
+appropriate (note that this will blow away any local edits that you may have made to the library):
+
+~~~text
+cd your/test/program/origen_std_lib
+git pull
+git reset --hard <%= Origen.app.version.prefixed %>
+~~~
+
+Alternatively, you can always [download a specific version of the library from our releases page](https://github.com/Origen-SDK/origen_std_lib/releases).
+
+#### Create a preload Symlink
+
+A symlink then needs to be created to add the Origen library to the preload folder within the
+device directory, this ensures
+that it is loaded before any 3rd party libraries that depend on it:
+
+~~~text
+mkdir -p your/device/testmethod/sh_lib\-EL5\-64bit/preload
+pushd your/device/testmethod/sh_lib\-EL5\-64bit/preload 
+ln -s ../liborigen.so liborigen.so
+popd 
+~~~
+
+
+#### Add the Library to your Workspace
+
+With the source code in place, the last step is to make sure that it can be referenced through your
+test program's workspace.
+
+If it has not been automatically detected, then **right-click** within the **Project Explorer** pane
+and select **"Import..."**:
+
+
+<p style="text-align: center">
+  <img src="<%= path "img/install1.png" %>" height="300">
+</p>
+
+
+Then select **"93000"** -> **"Test Method Project"** on the next screen:
+
+
+<p style="text-align: center">
+  <img src="<%= path "img/install2.png" %>" height="450">
+</p>
+
+Accept the defaults on the next screen, making sure that the **"origen"** checkbox is enabled:
+
+<p style="text-align: center">
+  <img src="<%= path "img/install3.png" %>" height="450">
+</p>
+
+
+The Origen test methods will now be available from the test method selector once you build
+the program, and any references to Origen from other libraries should now be valid.
+
+If you do experience any issues at this point, please comment below to get help.
+
+
+### Part 2
+
+If you want to use the Origen library within your own test method library for the first time,
+then these additional steps are required.
+
+From the **"Project Explorer"** pane, **right-click** your library and select **"Properties"**.
+
+Then select the options shown below to add Origen to your project's include path:
+
+<p style="text-align: center">
+  <img src="<%= path "img/use1.png" %>" height="600">
+</p>
+
+It should end up like this, with a new entry for Origen that is relative to the top-level
+workspace:
+
+<p style="text-align: center">
+  <img src="<%= path "img/use2.png" %>" height="600">
+</p>
+
+To check if everything is hooked up correctly, you can add this to one of your source files
+and see if it builds:
+
+~~~cpp
+require "origen.hpp"
+~~~
+
+% end

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

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

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

@@ -0,0 +1,19 @@
+---
+title: Origen Std Lib
+---
+<%= render "partials/navbar.html", tab: :guides %>
+
+% index = {}
+% index["V93K"] = {
+%   v93k_intro: "Introduction",
+%   v93k_install: "How to Install",
+% }
+
+% opts = options.merge(index: index, root: "guides", prompt: "Search the guides...")
+% render "doc_helpers/searchable.html", options.merge(opts) do
+
+<%= yield %>
+
+<%= disqus_comments %>
+
+% end

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

@@ -11,9 +11,17 @@
     </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] == :faq ? 'active' : '' %>"><a href="<%= path "/faq" %>">FAQ</a></li>
-        <li class="<%= options[:tab] == :v93k ? 'active' : '' %>"><a href="<%= path "/v93k/annotated.html" %>">V93K</a></li>
-        <li class="<%= options[:tab] == :api ? 'active' : '' %>"><a href="<%= path "/api/" %>">API</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>
+          </ul>
+        </li>
+
         <li><a href="https://github.com/Origen-SDK/origen_std_lib">Github</a></li>
         <li class="<%= options[:tab] == :release ? 'active' : '' %>"><a href="<%= path "/release_notes" %>">Release Notes</a></li>
       </ul>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_std_lib
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-01 00:00:00.000000000 Z
+date: 2017-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -55,8 +55,17 @@ files:
 - lib/origen_std_lib_dev/interface.rb
 - lib/tasks/origen_std_lib.rake
 - program/prb1.rb
+- templates/web/faq.md.erb
+- templates/web/guides/v93k/install.md.erb
+- templates/web/guides/v93k/intro.md.erb
+- templates/web/img/install1.png
+- templates/web/img/install2.png
+- templates/web/img/install3.png
+- templates/web/img/use1.png
+- templates/web/img/use2.png
 - templates/web/index.md.erb
 - templates/web/layouts/_basic.html.erb
+- templates/web/layouts/_guides.html.erb
 - templates/web/partials/_navbar.html.erb
 - templates/web/release_notes.md.erb
 homepage: