origen_std_lib 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23e07c1053dbf863471b6358d7695c9d67a298ec
+  data.tar.gz: 85629fd2efc77a3e5f320d01efc7b3cca92016e1
+SHA512:
+  metadata.gz: 5ff4fabc366485fd8123219b502c5d31257f9f150c126b19946a2c5df938a51132709d09d8fc53cf5821e1290ef88d70a240e8cbbd37029e4cefeb3db4a3e4a5
+  data.tar.gz: ba7a297071ee31fce54aeebfbd0a62805a62588c2c0df5834eead7595bed7047c9bea5aab7afaaf508dfcf0bdc24c3fb83844356ae88e3731ea7e5bd8becc44a

data/config/application.rb

@@ -0,0 +1,126 @@
+require 'origen'
+class OrigenStdLibApplication < Origen::Application
+
+  # See http://origen-sdk.org/origen/api/Origen/Application/Configuration.html
+  # for a full list of the configuration options available
+
+  # These attributes should never be changed, the duplication here will be resolved in future
+  # by condensing these attributes that do similar things
+  self.name       = "origen_std_lib"
+  self.namespace  = "OrigenStdLib"
+  config.name     = "origen_std_lib"
+  config.initials = "OrigenStdLib"
+  # Change this to point to the revision control repository for this plugin
+  config.rc_url   = "git@github.com:Origen-SDK/origen_std_lib.git"
+  config.release_externally = true
+
+  # To enable deployment of your documentation to a web server (via the 'origen web'
+  # command) fill in these attributes.
+  config.web_directory = "git@github.com:Origen-SDK/Origen-SDK.github.io.git/std_lib"
+  config.web_domain = "http://origen-sdk.org/std_lib"
+
+  # When false Origen will be less strict about checking for some common coding errors,
+  # it is recommended that you leave this to true for better feedback and easier debug.
+  # This will be the default setting in Origen v3.
+  config.strict_errors = true
+
+  # See: http://origen-sdk.org/origen/latest/guides/utilities/lint/
+  config.lint_test = {
+    # Require the lint tests to pass before allowing a release to proceed
+    run_on_tag: true,
+    # Auto correct violations where possible whenever 'origen lint' is run
+    auto_correct: true, 
+    # Limit the testing for large legacy applications
+    #level: :easy,
+    # Run on these directories/files by default
+    #files: ["lib", "config/application.rb"],
+  }
+
+  config.semantically_version = true
+
+  def after_web_site_compile(options={})
+    if options[:api]
+      Dir.chdir "#{Origen.app.rc.root}/v93k" do
+        system "doxygen .doxygen"
+        d = "#{Origen.root}/web/output"
+        FileUtils.mkdir_p(d)
+        FileUtils.mv "html", "#{d}/v93k"
+      end
+    end
+  end
+
+  # An example of how to set application specific LSF parameters
+  #config.lsf.project = "msg.te"
+  
+  # An example of how to specify a prefix to add to all generated patterns
+  #config.pattern_prefix = "nvm"
+
+  # An example of how to add header comments to all generated patterns
+  #config.pattern_header do
+  #  cc "This is a pattern created by the example origen application"
+  #end
+
+  # By default all generated output will end up in ./output.
+  # Here you can specify an alternative directory entirely, or make it dynamic such that
+  # the output ends up in a setup specific directory. 
+  #config.output_directory do
+  #  "#{Origen.root}/output/#{$dut.class}"
+  #end
+
+  # Similarly for the reference files, generally you want to setup the reference directory
+  # structure to mirror that of your output directory structure.
+  #config.reference_directory do
+  #  "#{Origen.root}/.ref/#{$dut.class}"
+  #end
+
+  def before_release_tag(identifier, note, type, selector, options)
+    v = Origen::VersionString.new(identifier)
+    # Update the version in the C code
+    f = "#{Origen.app.rc.root}/v93k/src/origen/origen.hpp"
+    data = File.read(f) 
+    filtered_data = data.sub(/#define ORIGEN_VERSION \"\d+\.\d+\.\d+\"/, "#define ORIGEN_VERSION \"#{v}\"") 
+    File.open(f, "w") do |f|
+      f.write(filtered_data)
+    end
+    Origen.app.rc.checkin f, comment: "Wrote new version in C++ code"
+  end
+ 
+  # This will automatically deploy your documentation after every tag
+  def after_release_email(tag, note, type, selector, options)
+    command = "origen web compile --remote --api"
+    Dir.chdir Origen.root do
+      system command
+    end
+  end
+
+  # Ensure that all tests pass before allowing a release to continue
+  def validate_release
+    if !system("origen examples")
+      puts "Sorry but you can't release with failing tests, please fix them and try again."
+      exit 1
+    else
+      puts "All tests passing, proceeding with release process!"
+    end
+  end
+
+  # To enabled source-less pattern generation create a class (for example PatternDispatcher)
+  # to generate the pattern. This should return false if the requested pattern has been
+  # dispatched, otherwise Origen will proceed with looking up a pattern source as normal.
+  #def before_pattern_lookup(requested_pattern)
+  #  PatternDispatcher.new.dispatch_or_return(requested_pattern)
+  #end
+
+  # If you use pattern iterators you may come across the case where you request a pattern
+  # like this:
+  #   origen g example_pat_b0.atp
+  #
+  # However it cannot be found by Origen since the pattern name is actually example_pat_bx.atp
+  # In the case where the pattern cannot be found Origen will pass the name to this translator
+  # if it exists, and here you can make any substitutions to help Origen find the file you 
+  # want. In this example any instances of _b\d, where \d means a number, are replaced by
+  # _bx.
+  #config.pattern_name_translator do |name|
+  #  name.gsub(/_b\d/, "_bx")
+  #end
+
+end

data/config/boot.rb

@@ -0,0 +1,24 @@
+# This file is used to boot your plugin when it is running in standalone mode
+# from its own workspace - i.e. when the plugin is being developed.
+#
+# It will not be loaded when the plugin is imported by a 3rd party app - in that
+# case only lib/origen_std_lib.rb is loaded.
+#
+# Therefore this file can be used to load anything extra that you need to boot
+# the development environment for this app. For example, this is typically used
+# to load some additional test classes to use your plugin APIs so that they can
+# be tested and/or interacted with in the console.
+require "origen_std_lib"
+
+module OrigenStdLibDev
+  # Example of how to explicitly require a file
+  # require "origen_std_lib_dev/my_file"
+    
+  # Load all files in the lib/origen_std_lib_dev directory.
+  # Note that there is no problem from requiring a file twice (Ruby will ignore
+  # the second require), so if you have a file that must be required first, then
+  # explicitly require it up above and then let this take care of the rest.
+  Dir.glob("#{File.dirname(__FILE__)}/../lib/origen_std_lib_dev/**/*.rb").sort.each do |file|
+    require file
+  end
+end

data/config/commands.rb

@@ -0,0 +1,60 @@
+# This file should be used to extend the origen with application specific commands
+
+# Map any command aliases here, for example to allow 'origen ex' to refer to a 
+# command called execute you would add a reference as shown below: 
+aliases ={
+#  "ex" => "execute",
+}
+
+# The requested command is passed in here as @command, this checks it against
+# the above alias table and should not be removed.
+@command = aliases[@command] || @command
+
+# Now branch to the specific task code
+case @command
+
+## Example of how to make a command to run unit tests, this simply invokes RSpec on
+## the spec directory
+#when "specs"
+#  require "rspec"
+#  exit RSpec::Core::Runner.run(['spec'])
+
+# Example of how to make a command to run diff-based tests
+when "examples"
+  Origen.load_application
+  status = 0
+
+  # Program generator tests
+  ARGV = %w(program/prb1.rb -t default -e v93k -r approved)
+  load "#{Origen.top}/lib/origen/commands/program.rb"
+
+  if Origen.app.stats.changed_files == 0 &&
+     Origen.app.stats.new_files == 0 &&
+     Origen.app.stats.changed_patterns == 0 &&
+     Origen.app.stats.new_patterns == 0
+
+    Origen.app.stats.report_pass
+  else
+    Origen.app.stats.report_fail
+    status = 1
+  end
+  puts
+  if @command == "test"
+    Origen.app.unload_target!
+    require "rspec"
+    result = RSpec::Core::Runner.run(['spec'])
+    status = status == 1 ? 1 : result
+  end
+  exit status  # Exit with a 1 on the event of a failure per std unix result codes
+
+# Always leave an else clause to allow control to fall back through to the
+# Origen command handler.
+else
+  # You probably want to also add the your commands to the help shown via
+  # origen -h, you can do this be assigning the required text to @application_commands
+  # before handing control back to Origen. Un-comment the example below to get started.
+  @application_commands = <<-EOT
+ examples     Run the examples (tests), -c will enable coverage
+  EOT
+
+end 

data/config/version.rb

@@ -0,0 +1,8 @@
+module OrigenStdLib
+  MAJOR = 0
+  MINOR = 3
+  BUGFIX = 0
+  DEV = nil
+
+  VERSION = [MAJOR, MINOR, BUGFIX].join(".") + (DEV ? ".pre#{DEV}" : '')
+end

data/lib/origen_std_lib/v93k.rb

@@ -0,0 +1,45 @@
+module OrigenStdLib
+  def self.add_v93k_std_lib(i)
+    i.add_tml :origen,
+              class_name:            'origen_tml',
+
+              functional_test:       {
+              },
+
+              dc_measurement:        {
+                class_name:       'DCMeasurement',
+
+                apply_shutdown:   [:integer, 1],
+                shutdown_pattern: [:string, nil],
+                measure:          [:string, 'VOLT', %w(VOLT CURR v i voltage current)],
+                settling_time:    [:double, 0],
+                pin:              [:string, nil],
+                force_value:      [:double, 0],
+                i_range:          [:integer, nil],
+                methods:          {
+                  finalize: lambda  do |tm|
+                    # Clean up the measurement type parameter
+                    if tm.measure == 'v' || tm.measure == 'voltage'
+                      tm.measure = 'VOLT'
+                    elsif tm.measure == 'i' || tm.measure == 'current'
+                      tm.measure = 'CURR'
+                    end
+                    tm.measure = tm.measure.upcase # In case 'volt' entered
+
+                    # Calculate an autorange if not supplied for current meas
+                    if tm.measure == 'CURR' && !tm.i_range
+                      max = [tm.limits.lo.to_f.abs, tm.limits.hi.to_f.abs].max
+                      tm.i_range = max
+                    end
+                  end
+                }
+              },
+
+              frequency_measurement: {
+                period_based: [:integer, 0],
+                pin:          [:string, nil],
+                samples:      [:integer, 2000],
+                period_in_ns: [:integer, nil]
+              }
+  end
+end

data/lib/origen_std_lib.rb

@@ -0,0 +1,26 @@
+require 'origen'
+require_relative '../config/application.rb'
+require 'origen_testers'
+module OrigenStdLib
+  # THIS FILE SHOULD ONLY BE USED TO LOAD RUNTIME DEPENDENCIES
+  # If this plugin has any development dependencies (e.g. dummy DUT or other models that are only used
+  # for testing), then these should be loaded from config/boot.rb
+
+  # Example of how to explicitly require a file
+  # require "origen_std_lib/my_file"
+
+  # Load all files in the lib/origen_std_lib directory.
+  # Note that there is no problem from requiring a file twice (Ruby will ignore
+  # the second require), so if you have a file that must be required first, then
+  # explicitly require it up above and then let this take care of the rest.
+  Dir.glob("#{File.dirname(__FILE__)}/origen_std_lib/**/*.rb").sort.each do |file|
+    require file
+  end
+
+  def initialize(*args)
+    super
+    if tester.v93k?
+      OrigenStdLib.add_v93k_std_lib(self)
+    end
+  end
+end

data/lib/origen_std_lib_dev/dut.rb

@@ -0,0 +1,5 @@
+module OrigenStdLibDev
+  class DUT
+    include Origen::TopLevel
+  end
+end

data/lib/origen_std_lib_dev/interface.rb

@@ -0,0 +1,42 @@
+require 'origen_std_lib'
+module OrigenStdLibDev
+  class Interface
+    include OrigenTesters::ProgramGenerators
+    include OrigenStdLib
+
+    def func(name)
+      i = test_suites.add(name)
+      i.test_method = test_methods.origen.functional_test
+      flow.test(i)
+    end
+
+    def dc_meas(name)
+      i = test_suites.add(name)
+      tm = test_methods.origen.dc_measurement
+      tm.apply_shutdown = 1
+      tm.shutdown_pattern = 'some_pattern'
+      tm.measure = 'CURR'
+      tm.settling_time = 100
+      tm.pin = 'SOME_PIN'
+      tm.force_value = 10.4
+      tm.i_range = 1000
+      tm.limits.lo = 1
+      tm.limits.hi = 2
+      i.test_method = tm
+      flow.test(i)
+    end
+
+    def freq_meas(name)
+      i = test_suites.add(name)
+      tm = test_methods.origen.frequency_measurement
+      tm.period_based = 1
+      tm.pin = 'PINA'
+      tm.samples = 4000
+      tm.period_in_ns = 40
+      tm.limits.lo = 1.Mhz
+      tm.limits.hi = 2.Mhz
+      i.test_method = tm
+      flow.test(i)
+    end
+  end
+end

data/lib/tasks/origen_std_lib.rake

@@ -0,0 +1,6 @@
+# You can define any Rake tasks to support your application here (or in any file
+# ending in .rake in this directory).
+#
+# Rake (Ruby Make) is very useful for creating build scripts, see this short video
+# for a quick introduction:
+# http://railscasts.com/episodes/66-custom-rake-tasks

data/program/prb1.rb

@@ -0,0 +1,5 @@
+Flow.create interface: "OrigenStdLibDev::Interface" do
+  func :test1
+  dc_meas :test2
+  freq_meas :test3
+end

data/templates/web/index.md.erb

@@ -0,0 +1,21 @@
+% render "layouts/basic.html" do
+
+%# HTML tags can be embedded in mark down files if you want to do specific custom
+%# 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
+
+This project provides a modern, standard test method library for the
+Advantest V93000 tester that is freely available for anyone to use.
+
+[See the FAQ](<%= path "faq" %>) for more background.
+
+### How To Install
+
+
+### How To Use
+
+
+
+% end

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

@@ -0,0 +1,15 @@
+---
+title: <%= options[:title] || Origen.config.name %>
+---
+<%= render "partials/navbar.html", tab: options[:tab] %>
+
+<div class="row">
+%# The markdown attribute is important if you are going to include content written
+%# in markdown, without this is will be included verbatim
+  <div class="span12" markdown="1">
+<%= yield %>    
+
+<%= disqus_comments %>
+
+</div>
+</div>

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

@@ -0,0 +1,23 @@
+<nav class="navbar navbar-inverse navbar-fixed-top">
+  <div class="container">
+    <div class="navbar-header">
+      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
+        <span class="sr-only">Toggle navigation</span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+      </button>
+      <a class="navbar-brand" href="<%= path "/" %>">Home</a>
+    </div>
+    <div id="navbar" class="collapse navbar-collapse">
+      <ul class="nav navbar-nav">
+        <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><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>
+      <%= import "origen/web/logo.html" %>
+    </div><!--/.nav-collapse -->
+  </div>
+</nav>

data/templates/web/release_notes.md.erb

@@ -0,0 +1,5 @@
+% render "layouts/basic.html", tab: :release do
+
+<%= render "#{Origen.root}/doc/history" %>
+
+% end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: origen_std_lib
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Stephen McGinty
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: origen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.29
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.29
+- !ruby/object:Gem::Dependency
+  name: origen_testers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+description: 
+email:
+- stephen.mcginty@nxp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- config/application.rb
+- config/boot.rb
+- config/commands.rb
+- config/version.rb
+- lib/origen_std_lib.rb
+- lib/origen_std_lib/v93k.rb
+- lib/origen_std_lib_dev/dut.rb
+- lib/origen_std_lib_dev/interface.rb
+- lib/tasks/origen_std_lib.rake
+- program/prb1.rb
+- templates/web/index.md.erb
+- templates/web/layouts/_basic.html.erb
+- templates/web/partials/_navbar.html.erb
+- templates/web/release_notes.md.erb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.11
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Test program interface drivers for the Origen tester standard library
+test_files: []