origen_testers 0.13.1 → 0.13.2

data/lib/origen_testers/memory_style.rb

@@ -1,77 +1,77 @@
-module OrigenTesters
-  class MemoryStyle
-    attr_reader :pin_id, :size, :bit_order, :format, :trigger, :mode, :data_type
-
-    def initialize
-      @pin_id = []
-      @size = []
-      @bit_order = []
-      @format = []
-      @trigger = []
-      @mode = []
-      @data_type = []
-    end
-
-    # Set memory style attributes for the given pin
-    #
-    # @example
-    #   mem.pin :tdi, size: 8, trigger: :auto
-    def pin(*pin_ids)
-      options = pin_ids.last.is_a?(Hash) ? pin_ids.pop : {}
-      pin_ids.each_index do |i|
-        if pin_ids[i].is_a?(Symbol)
-          pin_ids[i] = dut.pin(pin_ids[i]).name
-        else
-          pin_ids[i] = pin_ids[i].name
-        end
-      end
-      @pin_id << pin_ids
-      @size << options[:size]
-      @bit_order << options[:bit_order]
-      @format << options[:format]
-      @trigger << options[:trigger]
-      @mode << options[:mode]
-      @data_type << options[:data_type]
-    end
-
-    # Get the chronologically last setting for the given pin's attributes
-    #
-    # @example
-    #   mem.pin :tdi, size: 1
-    #   mem.pin :tdi, size: 2
-    #
-    #   my_local_attribute_hash = mem.accumulate_attributes(:tdi)
-    #   # my_local_attribute_hash now is
-    #   # {pin_id: :tdi, size: 2, bit_order: nil, format: nil, trigger: nil}
-    def accumulate_attributes(pin_id)
-      a = { pin_id: pin_id }
-      @pin_id.each_index do |i|
-        if @pin_id[i].include?(pin_id)
-          a[:size] = @size[i]
-          a[:bit_order] = @bit_order[i]
-          a[:format] = @format[i]
-          a[:trigger] = @trigger[i]
-          a[:mode] = @mode[i]
-          a[:data_type] = @data_type[i]
-        end
-      end
-      a
-    end
-
-    # Check to see if a given pin exists in this style container
-    def contains_pin?(pin_id)
-      contained_pins.include?(pin_id)
-    end
-
-    # Get an array of pins contained in this style container
-    def contained_pins
-      pins = []
-      @pin_id.each do |a|
-        a.each do |p|
-          pins << p
-        end
-      end
-      pins.uniq
-    end
-  end
-end
+module OrigenTesters
+  class MemoryStyle
+    attr_reader :pin_id, :size, :bit_order, :format, :trigger, :mode, :data_type
+
+    def initialize
+      @pin_id = []
+      @size = []
+      @bit_order = []
+      @format = []
+      @trigger = []
+      @mode = []
+      @data_type = []
+    end
+
+    # Set memory style attributes for the given pin
+    #
+    # @example
+    #   mem.pin :tdi, size: 8, trigger: :auto
+    def pin(*pin_ids)
+      options = pin_ids.last.is_a?(Hash) ? pin_ids.pop : {}
+      pin_ids.each_index do |i|
+        if pin_ids[i].is_a?(Symbol)
+          pin_ids[i] = dut.pin(pin_ids[i]).name
+        else
+          pin_ids[i] = pin_ids[i].name
+        end
+      end
+      @pin_id << pin_ids
+      @size << options[:size]
+      @bit_order << options[:bit_order]
+      @format << options[:format]
+      @trigger << options[:trigger]
+      @mode << options[:mode]
+      @data_type << options[:data_type]
+    end
+
+    # Get the chronologically last setting for the given pin's attributes
+    #
+    # @example
+    #   mem.pin :tdi, size: 1
+    #   mem.pin :tdi, size: 2
+    #
+    #   my_local_attribute_hash = mem.accumulate_attributes(:tdi)
+    #   # my_local_attribute_hash now is
+    #   # {pin_id: :tdi, size: 2, bit_order: nil, format: nil, trigger: nil}
+    def accumulate_attributes(pin_id)
+      a = { pin_id: pin_id }
+      @pin_id.each_index do |i|
+        if @pin_id[i].include?(pin_id)
+          a[:size] = @size[i]
+          a[:bit_order] = @bit_order[i]
+          a[:format] = @format[i]
+          a[:trigger] = @trigger[i]
+          a[:mode] = @mode[i]
+          a[:data_type] = @data_type[i]
+        end
+      end
+      a
+    end
+
+    # Check to see if a given pin exists in this style container
+    def contains_pin?(pin_id)
+      contained_pins.include?(pin_id)
+    end
+
+    # Get an array of pins contained in this style container
+    def contained_pins
+      pins = []
+      @pin_id.each do |a|
+        a.each do |p|
+          pins << p
+        end
+      end
+      pins.uniq
+    end
+  end
+end

data/lib/origen_testers/no_interface.rb

@@ -1,7 +1,7 @@
-module OrigenTesters
-  # Origen will instantiate this interface if the application doesn't define one,
-  # this allows test flows to be generated only
-  class NoInterface
-    include OrigenTesters::ProgramGenerators
-  end
-end
+module OrigenTesters
+  # Origen will instantiate this interface if the application doesn't define one,
+  # this allows test flows to be generated only
+  class NoInterface
+    include OrigenTesters::ProgramGenerators
+  end
+end

data/lib/origen_testers/origen_ext/application/runner.rb

@@ -1,25 +1,25 @@
-# This shim is temporary to help NXP transition to Origen from
-# our original internal version (RGen)
-if defined? RGen::ORIGENTRANSITION
-  require 'rgen/application/runner'
-else
-  require 'origen/application/runner'
-end
-module Origen
-  class Application
-    class Runner
-      alias_method :orig_launch, :launch
-      # Patch this to allow write: false to be given as an option when
-      # generating a test program. When supplied and set to false, the program
-      # output files will not be written and only a flow model will be generated.
-      def launch(options = {})
-        if options.key?(:write)
-          OrigenTesters::Interface.write = options[:write]
-        else
-          OrigenTesters::Interface.write = true
-        end
-        orig_launch(options)
-      end
-    end
-  end
-end
+# This shim is temporary to help NXP transition to Origen from
+# our original internal version (RGen)
+if defined? RGen::ORIGENTRANSITION
+  require 'rgen/application/runner'
+else
+  require 'origen/application/runner'
+end
+module Origen
+  class Application
+    class Runner
+      alias_method :orig_launch, :launch
+      # Patch this to allow write: false to be given as an option when
+      # generating a test program. When supplied and set to false, the program
+      # output files will not be written and only a flow model will be generated.
+      def launch(options = {})
+        if options.key?(:write)
+          OrigenTesters::Interface.write = options[:write]
+        else
+          OrigenTesters::Interface.write = true
+        end
+        orig_launch(options)
+      end
+    end
+  end
+end

data/lib/origen_testers/origen_ext/generator.rb

@@ -1,54 +1,54 @@
-# This shim is temporary to help NXP transition to Origen from
-# our original internal version (RGen)
-if defined? RGen::ORIGENTRANSITION
-  require 'rgen/generator'
-else
-  require 'origen/generator'
-end
-module Origen
-  class Generator
-    include Comparator
-
-    # Makes more sense for this plugin to own this method now
-    def generate_program(file, options)
-      Origen.file_handler.resolve_files(file, ignore_with_prefix: '_', default_dir: "#{Origen.root}/program") do |path|
-        Origen.file_handler.current_file = path
-        j = Job.new(path, options)
-        j.pattern = path
-        j.run
-      end
-      Origen.interface.write_files(options)
-      unless options[:quiet] || !Origen.interface.write?
-        if options[:referenced_pattern_list]
-          file = "#{Origen.root}/list/#{options[:referenced_pattern_list]}"
-        else
-          file = Origen.config.referenced_pattern_list
-        end
-        puts "Referenced pattern list written to: #{Pathname.new(file).relative_path_from(Pathname.pwd)}"
-        dir = Pathname.new(file).dirname
-        FileUtils.mkdir_p(dir) unless dir.exist?
-        File.open(file, 'w') do |f|
-          pats = Origen.interface.all_pattern_references.map do |name, refs|
-            refs[:main][:all] + refs[:main][:origen]
-          end.flatten.uniq.sort
-          unless pats.empty?
-            f.puts '# Main patterns'
-            pats.each { |p| f.puts p }
-            f.puts
-          end
-
-          pats = Origen.interface.all_pattern_references.map do |name, refs|
-            refs[:subroutine][:all] + refs[:subroutine][:origen]
-          end.flatten.uniq.sort
-          unless pats.empty?
-            f.puts '# Subroutine patterns'
-            pats.each { |p| f.puts p }
-          end
-        end
-        ref_file = File.join(Origen.file_handler.reference_directory, Pathname.new(file).basename)
-        check_for_changes(file, ref_file)
-      end
-      Origen.interface.on_program_completion(options)
-    end
-  end
-end
+# This shim is temporary to help NXP transition to Origen from
+# our original internal version (RGen)
+if defined? RGen::ORIGENTRANSITION
+  require 'rgen/generator'
+else
+  require 'origen/generator'
+end
+module Origen
+  class Generator
+    include Comparator
+
+    # Makes more sense for this plugin to own this method now
+    def generate_program(file, options)
+      Origen.file_handler.resolve_files(file, ignore_with_prefix: '_', default_dir: "#{Origen.root}/program") do |path|
+        Origen.file_handler.current_file = path
+        j = Job.new(path, options)
+        j.pattern = path
+        j.run
+      end
+      Origen.interface.write_files(options)
+      unless options[:quiet] || !Origen.interface.write?
+        if options[:referenced_pattern_list]
+          file = "#{Origen.root}/list/#{options[:referenced_pattern_list]}"
+        else
+          file = Origen.config.referenced_pattern_list
+        end
+        puts "Referenced pattern list written to: #{Pathname.new(file).relative_path_from(Pathname.pwd)}"
+        dir = Pathname.new(file).dirname
+        FileUtils.mkdir_p(dir) unless dir.exist?
+        File.open(file, 'w') do |f|
+          pats = Origen.interface.all_pattern_references.map do |name, refs|
+            refs[:main][:all] + refs[:main][:origen]
+          end.flatten.uniq.sort
+          unless pats.empty?
+            f.puts '# Main patterns'
+            pats.each { |p| f.puts p }
+            f.puts
+          end
+
+          pats = Origen.interface.all_pattern_references.map do |name, refs|
+            refs[:subroutine][:all] + refs[:subroutine][:origen]
+          end.flatten.uniq.sort
+          unless pats.empty?
+            f.puts '# Subroutine patterns'
+            pats.each { |p| f.puts p }
+          end
+        end
+        ref_file = File.join(Origen.file_handler.reference_directory, Pathname.new(file).basename)
+        check_for_changes(file, ref_file)
+      end
+      Origen.interface.on_program_completion(options)
+    end
+  end
+end

data/lib/origen_testers/origen_ext/generator/flow.rb

@@ -1,77 +1,91 @@
-# This shim is temporary to help NXP transition to Origen from
-# our original internal version (RGen)
-if defined? RGen::ORIGENTRANSITION
-  require 'rgen/generator/flow'
-else
-  require 'origen/generator/flow'
-end
-module Origen
-  class Generator
-    class Flow
-      alias_method :orig_create, :create
-
-      # Create a call stack of flows so that we can work out where the nodes
-      # of the ATP AST originated from
-      def create(options = {}, &block)
-        # Patch for Windows operation since the path can start with something like "C:/"
-        if caller[0] =~ /(:(\/|\\))/
-          orig_separator = Regexp.last_match(1)
-          file, line = *caller[0].sub(/:(\/|\\)/, '_ORIG_SEPARATOR_').split(':')
-          file = file.sub('_ORIG_SEPARATOR_', orig_separator)
-        else
-          file, line = *caller[0].split(':')
-        end
-        OrigenTesters::Flow.callstack << file
-        flow_comments, comments = *_extract_comments(OrigenTesters::Flow.callstack.last, line.to_i)
-        OrigenTesters::Flow.comment_stack << comments
-        if OrigenTesters::Flow.flow_comments
-          top = false
-          name = options[:name] || Pathname.new(file).basename('.rb').to_s.sub(/^_/, '')
-          Origen.interface.flow.group(name, description: flow_comments) do
-            orig_create(options, &block)
-          end
-        else
-          OrigenTesters::Flow.flow_comments = flow_comments
-          if options.key?(:unique_ids)
-            OrigenTesters::Flow.unique_ids = options.delete(:unique_ids)
-          else
-            OrigenTesters::Flow.unique_ids = true
-          end
-          top = true
-          orig_create(options, &block)
-        end
-        OrigenTesters::Flow.callstack.pop
-        OrigenTesters::Flow.comment_stack.pop
-        OrigenTesters::Flow.flow_comments = nil if top
-      end
-
-      def _extract_comments(file, flow_line)
-        flow_comments = []
-        comments = {}
-        comment = nil
-        File.readlines(file).each_with_index do |line, i|
-          if comment
-            if line =~ /^\s*#-(.*)/
-              # Nothing, just ignore but keep the comment open
-            elsif line =~ /^\s*#(.*)/
-              comment << Regexp.last_match(1).strip
-            else
-              comment = nil
-            end
-          else
-            if line =~ /^\s*#[^-](.*)/
-              if i < flow_line
-                comment = flow_comments
-              else
-                comment = []
-                comments[i + 1] = comment
-              end
-              comment << Regexp.last_match(1).strip
-            end
-          end
-        end
-        [flow_comments, comments]
-      end
-    end
-  end
-end
+# This shim is temporary to help NXP transition to Origen from
+# our original internal version (RGen)
+if defined? RGen::ORIGENTRANSITION
+  require 'rgen/generator/flow'
+else
+  require 'origen/generator/flow'
+end
+module Origen
+  class Generator
+    class Flow
+      alias_method :orig_create, :create
+
+      # Create a call stack of flows so that we can work out where the nodes
+      # of the ATP AST originated from
+      def create(options = {}, &block)
+        # Patch for Windows operation since the path can start with something like "C:/"
+        if caller[0] =~ /(:(\/|\\))/
+          orig_separator = Regexp.last_match(1)
+          file, line = *caller[0].sub(/:(\/|\\)/, '_ORIG_SEPARATOR_').split(':')
+          file = file.sub('_ORIG_SEPARATOR_', orig_separator)
+        else
+          file, line = *caller[0].split(':')
+        end
+        OrigenTesters::Flow.callstack << file
+        flow_comments, comments = *_extract_comments(OrigenTesters::Flow.callstack.last, line.to_i)
+        OrigenTesters::Flow.comment_stack << comments
+        if OrigenTesters::Flow.flow_comments
+          top = false
+          name = options[:name] || Pathname.new(file).basename('.rb').to_s.sub(/^_/, '')
+          Origen.interface.flow.group(name, description: flow_comments) do
+            orig_create(options, &block)
+          end
+        else
+          OrigenTesters::Flow.flow_comments = flow_comments
+          if options.key?(:unique_ids)
+            OrigenTesters::Flow.unique_ids = options.delete(:unique_ids)
+          else
+            OrigenTesters::Flow.unique_ids = true
+          end
+          top = true
+          orig_create(options, &block)
+        end
+        OrigenTesters::Flow.callstack.pop
+        OrigenTesters::Flow.comment_stack.pop
+        OrigenTesters::Flow.flow_comments = nil if top
+      end
+
+      def _extract_comments(file, flow_line)
+        flow_comments = []
+        comments = {}
+        comment = nil
+        File.readlines(file).each_with_index do |line, i|
+          if comment
+            if line =~ /^\s*#-(.*)/
+              # Nothing, just ignore but keep the comment open
+            elsif line =~ /^\s*#(.*)/
+              comment << Regexp.last_match(1).strip
+            else
+              comment = nil
+            end
+          else
+            if line =~ /^\s*#[^-](.*)/
+              if i < flow_line
+                comment = flow_comments
+              else
+                comment = []
+                comments[i + 1] = comment
+              end
+              comment << Regexp.last_match(1).strip
+            end
+          end
+        end
+        [flow_comments, comments]
+      end
+    end
+  end
+
+  # Provides a hook to enable an internal startup callback to
+  class OrigenTestersPersistentFlowCallbackHandler
+    include Origen::PersistentCallbacks
+
+    def on_flow_start(options)
+      if Origen.interface.respond_to?(:_internal_startup)
+        Origen.interface._internal_startup(options)
+      end
+    end
+  end
+  # Instantiate an instance of this class immediately when this file is loaded, this object will
+  # then listen for the remainder of the Origen thread
+  OrigenTestersPersistentFlowCallbackHandler.new
+end