origen_stil 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 49fbe57cd39de26d9c87fd212bd26eb551337803c161c63cfa1b828afa3a83e5
+  data.tar.gz: 3ca1ac84591f6473d30b33f54971ef06a3a4ed26edf8e0a6d6541bd20de580c9
+SHA512:
+  metadata.gz: 1e3ec82d5dd20c6fb008d6849ec15e787206fa757dbc5ad3a48d5939994358162866eafc07e11c539683dc6b38ed977f2c466735dd2f7cf1f9260343f48fb8c1
+  data.tar.gz: 50b3486742351da2e69ee5277147bc3f67d3ac6c1154cb5f73ceedbdc33370e141cd480215b97a8154e06f3576692579302d4f88d47a153815cab84548e329f2

data/bin/fix_my_workspace

@@ -0,0 +1,100 @@
+#!/usr/bin/env ruby
+$VERBOSE = nil  # Don't care about world writable dir warnings and the like
+
+if $_fix_my_workspace_version_check
+  $_fix_my_workspace_version = '0.7.0'
+else
+  if File.exist?(File.expand_path('../../lib/origen.rb', __FILE__))
+    # If this script is being run from within an origen-core workspace, use that Origen-core,
+    # not the system-installed origen-core version.
+    $LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+    require 'origen'
+  else
+    # Use system-installed Origen (the gem in system Ruby)
+    require 'origen'
+  end
+
+  if !Origen.site_config.gem_manage_bundler
+    puts 'Sorry but you have opted to manage Bundler yourself via your Origen site config, and this means'
+    puts 'that I cannot make certain assumptions about how your workspace is configured.'
+    puts 'You will need to either resolve this problem yourself, or else change the value of'
+    puts 'gem_mange_bundler to true.'
+    puts 'See here for more details on how to do that: http://origen-sdk.org/origen/guides/starting/company/'
+
+  else
+    ENV['BUNDLE_GEMFILE'] = File.join(Origen.root, 'Gemfile')
+    ENV['BUNDLE_PATH'] = File.expand_path(Origen.site_config.gem_install_dir)
+    ENV['BUNDLE_BIN'] = File.join(Origen.root, 'lbin')
+
+    # Force copy system gems to local gems
+    if Origen.site_config.gem_use_from_system
+      local_gem_dir = "#{ENV['BUNDLE_PATH']}/ruby/#{Pathname.new(Gem.dir).basename}"
+      gem_dir = Pathname.new(Gem.dir)
+
+      Origen.site_config.gem_use_from_system.each do |gem, version|
+        begin
+          # This will raise an error if the system doesn't have this gem installed, that
+          # will be rescued below
+          spec = Gem::Specification.find_by_name(gem, version)
+
+          local_dir = File.join(local_gem_dir, Pathname.new(spec.gem_dir).relative_path_from(gem_dir))
+          FileUtils.mkdir_p local_dir
+          FileUtils.cp_r("#{spec.gem_dir}/.", local_dir)
+
+          local_file = Pathname.new(File.join(local_gem_dir, Pathname.new(spec.cache_file).relative_path_from(gem_dir)))
+          FileUtils.mkdir_p local_file.dirname
+          FileUtils.cp(spec.cache_file, local_file)
+
+          if spec.extension_dir && File.exist?(spec.extension_dir)
+            local_dir = File.join(local_gem_dir, Pathname.new(spec.extension_dir).relative_path_from(gem_dir))
+            FileUtils.mkdir_p local_dir
+            FileUtils.cp_r("#{spec.extension_dir}/.", local_dir)
+          end
+
+          local_file = Pathname.new(File.join(local_gem_dir, Pathname.new(spec.spec_file).relative_path_from(gem_dir)))
+          FileUtils.mkdir_p local_file.dirname
+          FileUtils.cp(spec.spec_file, local_file)
+
+        rescue Gem::LoadError
+          # This just means that one of the gems that should be copied from the system
+          # was not actually installed in the system, so nothing we can do about that here
+        end
+      end
+    end
+
+    # Delete lbin
+    FileUtils.rm_rf(ENV['BUNDLE_BIN']) if File.exist?(ENV['BUNDLE_BIN'])
+
+    # Run bundler with correct switches
+    cmd = "bundle install --gemfile #{ENV['BUNDLE_GEMFILE']} --binstubs #{ENV['BUNDLE_BIN']} --path #{ENV['BUNDLE_PATH']}"
+    `chmod o-w #{Origen.root}` # Stops some annoying world writable warnings during install
+    `chmod o-w #{Origen.root}/bin` if File.exist?("#{Origen.root}/bin")
+    `chmod o-w #{Origen.root}/.bin` if File.exist?("#{Origen.root}/.bin")
+
+    # Try again, this time updating the bundle
+    if system(cmd)
+      fixed = true
+    elsif system 'bundle update'
+      fixed = true
+    end
+
+    if File.exist?(ENV['BUNDLE_BIN'])
+      `chmod o-w #{ENV['BUNDLE_BIN']}`
+
+      # Make .bat versions of all executables, Bundler should really be doing this when running
+      # on windows
+      if Origen.os.windows?
+        Dir.glob("#{ENV['BUNDLE_BIN']}/*").each do |bin|
+          unless bin =~ /.bat$/
+            bat = "#{bin}.bat"
+            unless File.exist?(bat)
+              File.open(bat, 'w') { |f| f.write('@"ruby.exe" "%~dpn0" %*') }
+            end
+          end
+        end
+      end
+    end
+
+    system 'origen -v' if fixed
+  end
+end

data/config/application.rb

@@ -0,0 +1,103 @@
+require 'origen'
+class OrigenSTILApplication < 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_stil"
+  self.namespace  = "OrigenSTIL"
+  config.name     = "origen_stil"
+  config.initials = "OrigenSTIL"
+  # Change this to point to the revision control repository for this plugin
+  config.rc_url   = "https://github.com/Origen-SDK/origen_stil.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/origen_stil"
+  #config.web_domain = "http://origen-sdk.org/origen_stil"
+
+  # 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
+
+  # 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
+ 
+  # 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 specs") || !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_stil.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_stil"
+
+module OrigenSTILDev
+  # Example of how to explicitly require a file
+  # require "origen_stil_dev/my_file"
+    
+  # Load all files in the lib/origen_stil_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_stil_dev/**/*.rb").sort.each do |file|
+    require file
+  end
+end

data/config/commands.rb

@@ -0,0 +1,86 @@
+# 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
+
+when "build"
+  Dir.chdir Origen.root do
+    system 'lbin/tt --force grammars/stil.treetop'
+  end
+  exit 0
+
+# (Working) example of how to create an application specific comment, here to generate
+# a tags file for you application to enable method definition lookup and similar within
+# editors/IDEs
+when "tags"  
+  # Here the logic is just written in-line, alternatively it could be written in a
+  # dedicated file and required here, e.g.
+  #require "origen_stil/commands/my_command"    # Would load file lib/origen_stil/commands/my_command.rb
+  Dir.chdir Origen.root do
+    system("ripper-tags -R")
+  end
+  # You must always exit upon successfully capturing and executing a command to prevent 
+  # control flowing back to Origen
+  exit 0
+
+## 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", "test"
+#  Origen.load_application
+#  status = 0
+#
+#  # Compiler tests
+#  ARGV = %w(templates/example.txt.erb -t debug -r approved)
+#  load "origen/commands/compile.rb"
+#  # Pattern generator tests
+#  #ARGV = %w(some_pattern -t debug -r approved)
+#  #load "#{Origen.top}/lib/origen/commands/generate.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 by assigning the required text to @application_commands
+  # before handing control back to Origen.
+  @application_commands = <<-EOT
+ tags         Build a tags file for this app
+ build        Build/compile the latest grammar file(s)
+  EOT
+# specs        Run the specs (tests), -c will enable coverage
+# examples     Run the examples (tests), -c will enable coverage
+# test         Run both specs and examples, -c will enable coverage
+end 

data/config/version.rb

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

data/lib/origen_stil/pattern.rb

@@ -0,0 +1,122 @@
+module OrigenSTIL
+  class Pattern
+    # Path to the STIL file on disk
+    attr_reader :path
+
+    def initialize(path, options = {})
+      unless File.exist?(path)
+        fail "STIL source file not found: #{path}"
+      end
+      @path = path
+    end
+
+    def execute(options = {})
+      timeset = nil
+      Processor::Pattern.new.run(ast) do |pattern_name|
+        each_vector(pattern_name, options) do |vector|
+          if options[:set_timesets] && vector[:timeset] && vector[:timeset] != timeset
+            tester.set_timeset(vector[:timeset], timesets[vector[:timeset]][:period] || 0)
+            timeset = vector[:timeset]
+          end
+          vector[:comments].each { |comment| cc comment }
+          vector[:pindata].each do |pin, data|
+            pin = dut.pins(pin)
+            data = data.gsub(/\s+/, '')
+            pin.vector_formatted_value = data
+          end
+          vector[:repeat].cycles
+        end
+      end
+    end
+
+    # Returns frontmatter as an AST, note that this does not contain any
+    # vector-level information from Pattern blocks at the end of the file
+    def ast
+      @ast ||= Syntax::Parser.parse_file(path)
+    end
+
+    # Returns the contents of the file before the first Pattern block
+    # as a string
+    def frontmatter
+      @frontmatter ||= begin
+        fm = ''
+        File.foreach(path) do |line|
+          break if line =~ /^\s*Pattern /
+          fm << line
+        end
+        fm
+      end
+    end
+
+    # Add the pins defined in the STIL file to the DUT, unless it has them already.
+    # This will also call the add_pin_groups method automatically unless option
+    # :pin_group is set to false
+    def add_pins(options = {})
+      options = {
+        pin_groups: true
+      }.merge(options)
+      Processor::Pins.new.run(ast, dut, options)
+      add_pin_groups(options) unless options[:pin_groups] = false
+    end
+
+    def add_pin_groups(options = {})
+      Processor::PinGroups.new.run(ast, dut, options)
+    end
+
+    # Returns a hash containing all timesets (WaveformTables) defined in the STIL file
+    #   { 'Waveset1' => { period_in_ns: 1000 } }
+    def timesets(options = {})
+      @timesets ||= Processor::Timesets.new.run(ast, options)
+    end
+
+    # Yields each vector in the given pattern to the caller as a Hash with the
+    # structure shown in these examples:
+    #
+    #     { timeset: "wave1",
+    #       comments: ["blah, blah", "blah blah blah"],
+    #       pindata: { "ALL" => "10011011101" },
+    #       repeat: 1,
+    #     }
+    #
+    #     { timeset: nil,
+    #       comments: [],
+    #       pindata: { "portA" => "10011011101", "portB" => "10010" },
+    #       repeat: 1000
+    #     }
+    #
+    def each_vector(pattern_name, options = {})
+      open = false
+      vector = { timeset: nil, comments: [], pindata: {}, repeat: 1 }
+      File.foreach(path) do |line|
+        if open
+          # Stop at next pattern or EOF
+          break if line =~ /^\s*Pattern/
+          if line =~ /^\s*Ann\s*{\*\s*(.*)\s*\*}/
+            vector[:comments] << Regexp.last_match(1)
+          elsif line =~ /(?:^|.*:)\s*(?:W|WaveformTable)\s+(.*)\s*;/
+            vector[:timeset] = Regexp.last_match(1)
+          elsif line =~ /(?:^|.*:)\s*Loop\s+(\d+)(\s|{)/
+            vector[:repeat] = Regexp.last_match(1).to_i
+          elsif line =~ /(?:^|.*:)\s*(?:V|Vector)\s+{(.*)}/
+            Regexp.last_match(1).strip.split(';').each do |assignment|
+              assignment = assignment.split(/\s*=\s*/)
+              vector[:pindata][assignment[0]] = assignment[1]
+            end
+            yield vector
+            vector = { timeset: nil, comments: [], pindata: {}, repeat: 1 }
+          end
+        else
+          open = true if line =~ /^\s*Pattern #{pattern_name}\s*{/
+        end
+      end
+    end
+
+    def each_vector_with_index(pattern_name, options = {})
+      i = 0
+      each_vector(pattern_name, options) do |vec|
+        yield vec, i
+        i += 1
+      end
+    end
+  end
+end

data/lib/origen_stil/processor/base.rb

@@ -0,0 +1,16 @@
+module OrigenSTIL
+  module Processor
+    class Base
+      include AST::Processor::Mixin
+
+      def handler_missing(node)
+        node.updated(nil, process_all(node.children))
+      end
+
+      def process(node)
+        return node unless node.respond_to?(:to_ast)
+        super
+      end
+    end
+  end
+end

data/lib/origen_stil/processor/pattern.rb

@@ -0,0 +1,34 @@
+module OrigenSTIL
+  module Processor
+    class Pattern < Base
+      # Yields back the names of pattern blocks to be run as defined
+      # in the PatternExec and PatternBurst blocks within the given node
+      def run(node, options = {})
+        @bursts = {}
+        process(node)
+        if e = node.find(:pattern_exec)
+          e.find_all(:pattern_burst).each do |pb|
+            @bursts[pb.to_a[0]].each do |pattern|
+              yield pattern
+            end
+          end
+        else
+          fail 'No PatternExec block in the given AST!'
+        end
+      end
+
+      def on_pattern_burst(node)
+        name, pat_list = *node
+        if pat_list
+          @bursts[name] = []
+          @current_burst = @bursts[name]
+          process(pat_list)
+        end
+      end
+
+      def on_pat_list_item(node)
+        @current_burst << node.to_a[0]
+      end
+    end
+  end
+end

data/lib/origen_stil/processor/pin_groups.rb

@@ -0,0 +1,36 @@
+module OrigenSTIL
+  module Processor
+    class PinGroups < Base
+      attr_reader :model
+
+      # Adds pin groups from the given node to the given model
+      def run(node, model, options = {})
+        @model = model
+        node.find_all(:signal_groups).each do |signal_groups|
+          process(signal_groups)
+        end
+      end
+
+      def on_signal_group(node)
+        name, expr = *node
+        unless model.has_pin?(name)
+          ids = process(expr).to_a[0]
+          model.add_pin_group name.to_sym, *ids
+        end
+      end
+
+      def on_add(node)
+        lhs, rhs = *node
+        Array(process(lhs)) + Array(process(rhs))
+      end
+
+      def on_subtract(node)
+        fail 'Subract not implemented yet!'
+      end
+
+      def on_paren(node)
+        fail 'Parenthesis not implemented yet!'
+      end
+    end
+  end
+end

data/lib/origen_stil/processor/pins.rb

@@ -0,0 +1,41 @@
+module OrigenSTIL
+  module Processor
+    class Pins < Base
+      attr_reader :model
+
+      # Adds pins from the given node to the given model
+      def run(node, model, options = {})
+        @model = model
+        process(node)
+      end
+
+      def on_signal(node)
+        name, direction = *node
+        if direction == 'In'
+          direction = :input
+        elsif direction == 'Out'
+          direction = :output
+        elsif direction == 'InOut'
+          direction = :io
+        else
+          direction = nil
+        end
+        # Currently does not add pins defined as "Supply" or "Pseudo"
+        if direction
+          # No need to do anything if it already responds to this pin name
+          unless model.has_pin?(name)
+            # Otherwise might need to add an alias for different casing being used
+            if model.has_pin?(name.downcase)
+              model.add_pin_alias(name.to_sym, name.downcase)
+            elsif model.has_pin?(name.upcase)
+              model.add_pin_alias(name.to_sym, name.upcase)
+            # Need to add a new pin
+            else
+              model.add_pin(name.to_sym, direction: direction)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/origen_stil/processor/timesets.rb

@@ -0,0 +1,20 @@
+module OrigenSTIL
+  module Processor
+    class Timesets < Base
+      # Extract WaveformTables from the given AST and return as a hash of
+      # timesets and attributes
+      def run(node, options = {})
+        @timesets = {}
+        process(node)
+        @timesets
+      end
+
+      def on_waveform_table(node)
+        name = node.to_a[0]
+        # Pass on resolving the period for now, could involve parameter cross referencing
+        period = node.find(:period)
+        @timesets[name] = {}
+      end
+    end
+  end
+end

data/lib/origen_stil/syntax/node.rb

@@ -0,0 +1,116 @@
+require 'ast'
+require 'treetop'
+module OrigenSTIL
+  module Syntax
+    class Node < ::AST::Node
+      attr_reader :input, :interval, :file, :number_of_lines
+
+      # Returns the value at the root of an AST node like this:
+      #
+      #   node # => (module-def
+      #               (module-name
+      #                 (SCALAR-ID "Instrument"))
+      #
+      #   node.value  # => "Instrument"
+      #
+      # No error checking is done and the caller is responsible for calling
+      # this only on compatible nodes
+      def value
+        val = children.first
+        val = val.children.first while val.respond_to?(:children)
+        val
+      end
+
+      # Returns the first child node of the given type that is found
+      def find(type)
+        nodes = find_all(type)
+        nodes.first
+      end
+
+      # Returns an array containing all child nodes of the given type(s)
+      def find_all(*types)
+        Extractor.new.process(self, types)
+      end
+
+      def line_number
+        input.line_of(interval.first)
+      end
+
+      def text_value
+        input[interval]
+      end
+
+      def directory
+        if file
+          Pathname.new(file).dirname
+        end
+      end
+
+      protected
+
+      # I'd rather see the true symbol
+      def fancy_type
+        @type
+      end
+    end
+
+    class Extractor
+      include ::AST::Processor::Mixin
+
+      attr_reader :types
+      attr_reader :results
+
+      def process(node, types = nil)
+        if types
+          @types = types
+          @results = []
+          # node = AST::Node.new(:wrapper, node) unless node.respond_to?(:to_ast)
+        end
+        super(node) if node.respond_to?(:to_ast)
+        results
+      end
+
+      def handler_missing(node)
+        @results << node if types.include?(node.type)
+        process_all(node.children)
+      end
+    end
+  end
+end
+
+# Some helpers to create the to_ast methods in syntax nodes
+module Treetop
+  module Runtime
+    class SyntaxNode
+      def n(type, *children)
+        properties = children.pop if children.last.is_a?(Hash)
+        properties ||= {}
+        properties[:input] ||= input
+        properties[:interval] ||= interval
+        properties[:file] ||= file
+        OrigenSTIL::Syntax::Node.new(type, children, properties)
+      end
+
+      def elements_to_ast(elmnts = elements)
+        elmnts.map do |e|
+          if e.respond_to?(:to_ast)
+            e.to_ast
+          elsif e.nonterminal? && !e.elements.empty?
+            elements_to_ast(e.elements)
+          end
+        end.compact.flatten
+      end
+
+      def number_of_lines(elmnts = elements)
+        elmnts.inject(0) do |sum, e|
+          lines = e.text_value.split("\n").size
+          sum + lines
+        end
+      end
+
+      def file
+        OrigenSTIL::Syntax::Parser.file
+      end
+    end
+  end
+end

data/lib/origen_stil/syntax/parser.rb

@@ -0,0 +1,53 @@
+require 'treetop'
+require 'origen_stil/syntax/node'
+module OrigenSTIL
+  module Syntax
+    class Parser
+      def self.parser
+        @parser ||= begin
+          require "#{Origen.root!}/grammars/stil"
+          GrammarParser.new
+        end
+      end
+
+      def self.parse_file(path, options = {})
+        stil = OrigenSTIL::Pattern.new(path)
+        parse(stil.frontmatter, options.merge(file: stil.path))
+      end
+
+      def self.parse(data, options = {})
+        @file = options[:file]
+        tree = parser.parse(data)
+
+        # If the AST is nil then there was an error during parsing,
+        # we need to report a simple error message to help the user
+        if tree.nil? && !options[:quiet]
+          parser.failure_reason =~ /^(Expected .+) (after|at)/m
+          @last_error_msg = []
+          @last_error_msg << "#{Regexp.last_match(1).gsub("\n", '$NEWLINE')}:" if Regexp.last_match(1)
+          if parser.failure_line >= data.lines.to_a.size
+            @last_error_msg << 'EOF'
+          else
+            @last_error_msg << data.lines.to_a[parser.failure_line - 1].gsub("\t", ' ')
+          end
+          @last_error_msg << "#{'~' * (parser.failure_column - 1)}^"
+          Origen.log.error "Failed parsing STIL file: #{file}"
+          @last_error_msg.each do |line|
+            Origen.log.error line.rstrip
+          end
+        end
+        if tree
+          tree.to_ast
+        end
+      end
+
+      def self.last_error_msg
+        @last_error_msg || []
+      end
+
+      def self.file
+        @file
+      end
+    end
+  end
+end

data/lib/origen_stil.rb

@@ -0,0 +1,68 @@
+require 'origen'
+
+Origen.register_acronym 'STIL'
+
+require_relative '../config/application.rb'
+
+module OrigenSTIL
+  # 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_stil/my_file"
+
+  # Load all files in the lib/origen_stil 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.
+  module Syntax
+    autoload :Node,   'origen_stil/syntax/node'
+    autoload :Parser, 'origen_stil/syntax/parser'
+  end
+
+  module Processor
+    autoload :Base,      'origen_stil/processor/base'
+    autoload :Pins,      'origen_stil/processor/pins'
+    autoload :PinGroups, 'origen_stil/processor/pin_groups'
+    autoload :Pattern,   'origen_stil/processor/pattern'
+    autoload :Timesets,  'origen_stil/processor/timesets'
+  end
+
+  autoload :Pattern, 'origen_stil/pattern'
+
+  # Execute the pattern vectors in the given STIL file, this will also call
+  # add_pins to ensure the pins are available so there is no need to call that
+  # separately
+  def self.execute(path, options = {})
+    options = {
+      # When true, any timeset changes from the STIL will be translated to tester.set_timeset
+      # calls, otherwise they will be ignored
+      set_timesets: false
+    }.merge(options)
+    # Bit of a hack, this is to lock in the current set of pins so that any added
+    # by the STIL are not included, the Origen model is in charge of pattern formatting
+    tester.current_pin_vals if tester
+    add_pins(path, options)
+    pattern(path).execute(options)
+  end
+
+  # Add pins (and pin groups) from the given STIL file to the current DUT
+  # unless they already exist
+  def self.add_pins(path, options = {})
+    pattern(path).add_pins(options)
+  end
+
+  # Returns an OrigenSTIL::Pattern instance for the given STIL file
+  def self.pattern(path_to_stil_file)
+    path = Pathname.new(path_to_stil_file).realpath.cleanpath.to_s
+    patterns[path] ||= OrigenSTIL::Pattern.new(path)
+  end
+
+  # @api private
+  def self.patterns
+    @patterns ||= {}
+  end
+end
+
+STIL = OrigenSTIL unless defined?(STIL)

data/lib/tasks/origen_stil.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/templates/web/index.md.erb

@@ -0,0 +1,37 @@
+% 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 plugin...
+
+### How To Install
+
+In your Gemfile add:
+
+~~~ruby
+gem "<%= Origen.app.name %>"
+~~~
+
+or if your application is a plugin, then add this to your <code>.gemspec</code>
+
+~~~ruby
+spec.add_runtime_dependency "<%= Origen.app.name %>", ">= <%= Origen.app.version %>"
+~~~
+
+__NOTE:__  In the case of a plugin, you will also need to <code>require '<%= Origen.app.name %>'</code> somewhere in your environment.
+
+
+### How To Use
+
+Add quickstart documentation here...
+
+
+### How To Setup a Development Environment
+
+Describe how a developer would setup a new workspace for this plugin...
+
+% end

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

@@ -0,0 +1,13 @@
+---
+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 %>    
+
+</div>
+</div>

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

@@ -0,0 +1,20 @@
+<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] == :api ? 'active' : '' %>"><a href="<%= path "/api/" %>">API</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,104 @@
+--- !ruby/object:Gem::Specification
+name: origen_stil
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Stephen McGinty
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: origen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.33.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.33.3
+- !ruby/object:Gem::Dependency
+  name: ast
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: treetop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- stephen.mcginty@nxp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/fix_my_workspace
+- config/application.rb
+- config/boot.rb
+- config/commands.rb
+- config/version.rb
+- lib/origen_stil.rb
+- lib/origen_stil/pattern.rb
+- lib/origen_stil/processor/base.rb
+- lib/origen_stil/processor/pattern.rb
+- lib/origen_stil/processor/pin_groups.rb
+- lib/origen_stil/processor/pins.rb
+- lib/origen_stil/processor/timesets.rb
+- lib/origen_stil/syntax/node.rb
+- lib/origen_stil/syntax/parser.rb
+- lib/tasks/origen_stil.rake
+- 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.7.6
+signing_key: 
+specification_version: 4
+summary: Helpers to consume and generate test IP in STIL format (IEEE 1450)
+test_files: []