origen 0.2.6 → 0.3.0

data/lib/origen/tester/j750/generator/test_instance_group.rb

@@ -1,60 +0,0 @@
-module Origen
-  module Tester
-    class J750
-      module Generator
-        class TestInstanceGroup
-          attr_accessor :name, :version, :append_version
-
-          include Enumerable
-
-          def initialize(name, _options = {})
-            @name = name
-            @store = []
-            @append_version = true
-          end
-
-          def name
-            if unversioned_name
-              if version && @append_version
-                "#{unversioned_name}_v#{version}"
-              else
-                unversioned_name.to_s
-              end
-            end
-          end
-
-          def unversioned_name
-            if @name
-              if @name =~ /grp$/
-                @name
-              else
-                "#{@name}_grp"
-              end
-            end
-          end
-
-          def <<(instance)
-            @store << instance
-          end
-
-          def size
-            @store.size
-          end
-
-          def each
-            @store.each { |ins| yield ins }
-          end
-
-          def ==(other_instance_group)
-            self.class == other_instance_group.class &&
-              unversioned_name.to_s == other_instance_group.unversioned_name.to_s &&
-              size == other_instance_group.size &&
-              self.all? do |ins|
-                other_instance_group.any? { |other_ins| ins == other_ins }
-              end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/origen/tester/j750/generator/test_instances.rb

@@ -1,182 +0,0 @@
-module Origen
-  module Tester
-    class J750
-      module Generator
-        class TestInstances
-          include Origen::Tester::Generator
-
-          TEMPLATE = "#{Origen.top}/lib/origen/tester/j750/generator/templates/instances.txt.erb"
-          OUTPUT_POSTFIX = 'instances'
-
-          class IndexedString < ::String
-            attr_accessor :index
-
-            def name
-              self
-            end
-          end
-
-          def add(name, type, options = {})
-            options = {
-              test_instance_class: TestInstance
-            }.merge(options)
-            ins = options.delete(:test_instance_class).new(name, type, options)
-            if @current_group
-              @current_group << ins
-            else
-              collection << ins
-            end
-            c = Origen.interface.consume_comments
-            Origen.interface.descriptions.add_for_test_definition(name, c)
-            ins
-          end
-
-          # IG-XL doesn't have a formal instance group type and instead declares them anonymously
-          # whenever test instances of the same name appear consecutively in the test instance sheet.
-          # However when it comes to generating a test program life becomes much easier if we have
-          # a way to explicitly declare instances as part of a group - this makes duplicate tracking
-          # and sorting of the test instance sheet much easier.
-          #
-          # Use this method to generate instance groups via a block. Within the the block you should
-          # generate instances as normal and they will automatically be assigned to the current group.
-          # Note that the name of the instances generated within the group is discarded and replaced
-          # with the name of the group. Origen automatically appends "grp" to this name to highlight
-          # instances that were generated as part of the group.
-          #
-          #   test_instances.group("erase_all_blocks") do |group|
-          #     # Generate instances here as normal
-          #     test_instances.functional("erase_blk0")
-          #     test_instances.functional("erase_blk1")
-          #   end
-          #
-          # The group object is passed into the block but usually you should not need to interact
-          # with this directly except maybe to set the name if it is not yet established at the point
-          # where the group is initiated:
-          #
-          #   test_instances.group do |group|
-          #     # Generate instances here as normal
-          #     group.name = "group_blah"
-          #   end
-          #
-          # A common way to generate groups is to create a helper method in your application which
-          # is responsible for creating groups as required:
-          #
-          #   def group_wrapper(name, options)
-          #     if options[:by_block]
-          #       test_instances.group(name) do |group|
-          #         yield group
-          #       end
-          #     else
-          #       yield
-          #     end
-          #   end
-          #
-          # In that case the group argument becomes quite useful for branching based on whether you
-          # are generating a group or standalone instances:
-          #
-          #  group_wrapper(name, options) do |group|
-          #    if group
-          #      # Generate group instances
-          #    else
-          #      # Generate standalone instances
-          #    end
-          #  end
-          def group(name = nil, options = {})
-            name, options = nil, name if name.is_a?(Hash)
-            @current_group = TestInstanceGroup.new(name, options)
-            collection << @current_group
-            yield @current_group
-            @current_group = nil
-          end
-          alias_method :add_group, :group
-
-          def finalize(_options = {}) # :nodoc:
-            uniq!
-            sort!
-          end
-
-          def uniq! # :nodoc:
-            uniques = []
-            versions = {}
-            multi_version_tests = {}
-            collection.each do |instance|
-              # If a uniquely named instance is found add it, otherwise update the version
-              # of the current instance to match that of the existing instance that it duplicates
-              unless uniques.any? do |i|
-                if i == instance
-                  instance.version = i.version
-                  true
-                else
-                  false
-                end
-              end
-                if instance.respond_to?(:version=)
-                  versions[instance.unversioned_name] ||= 0
-                  versions[instance.unversioned_name] += 1
-                  if versions[instance.unversioned_name] > 1
-                    multi_version_tests[instance.unversioned_name] = true
-                  end
-                  instance.version = versions[instance.unversioned_name]
-                end
-                uniques << instance
-              end
-            end
-            # This final loop disables the version identifier for tests that have only a single version,
-            # this makes it clearer when multiple versions exist - whenever you see a v1 you know there
-            # is at least a v2 also.
-            collection.map! do |instance|
-              if instance.respond_to?(:version=)
-                unless multi_version_tests[instance.unversioned_name]
-                  instance.append_version = false
-                end
-              end
-              instance
-            end
-            self.collection = uniques
-          end
-
-          def sort! # :nodoc:
-            # Present the instances in the final sheet in alphabetical order
-            collection.map!.with_index do |ins, _i|
-              if ins.is_a?(String)   # Can happen if content has been rendered in from a template
-                ins = IndexedString.new(ins)
-              end
-              ins
-            end
-            collection.sort! { |a, b| [a.name.to_s] <=> [b.name.to_s] }
-          end
-
-          def bpmu(name, options = {})
-            add(name, :board_pmu, options)
-          end
-          alias_method :board_pmu, :bpmu
-
-          def ppmu(name, options = {})
-            add(name, :pin_pmu, options)
-          end
-          alias_method :pin_pmu, :ppmu
-
-          def functional(name, options = {})
-            add(name, :functional, options)
-          end
-
-          def empty(name, options = {})
-            add(name, :empty, options)
-          end
-
-          def other(name, options = {})
-            add(name, :other, options)
-          end
-
-          def apmu_powersupply(name, options = {})
-            add(name, :apmu_powersupply, options)
-          end
-
-          def mto_memory(name, options = {})
-            add(name, :mto_memory, options)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/origen/tester/j750/j750.rb

@@ -1,845 +0,0 @@
-module Origen
-  module Tester
-    # This class is soon to be deprecated
-    #    Origen.deprecate <<-END
-    #      J750 Tester in Origen core is currently being moved to a dedicated plugin,
-    #      use Testers::J750 from this plugin instead of Origen::Tester::J750
-    #      http://origen.freescale.net/testers
-    #    END
-
-    # Tester model to generate .atp patterns for the Teradyne J750
-    #
-    # == Basic Usage
-    #   $tester = Origen::Tester::J750.new
-    #   $tester.cycle       # Generate a vector
-    #
-    # Many more methods exist to generate J750 specific micro-code, see below for
-    # details.
-    #
-    # Also note that this class inherits from the base Tester class and so all methods
-    # described there are also available.
-    class J750
-      include Tester
-      include Parser
-      require 'origen/tester/j750/files'
-      include Files
-
-      autoload :Parser, 'origen/tester/j750/parser'
-      autoload :Generator, 'origen/tester/j750/generator'
-
-      attr_accessor :use_hv_pin
-      attr_accessor :software_version
-
-      def self.hpt_mode
-        @@hpt_mode
-      end
-      def self.hpt_mode?
-        @@hpt_mode
-      end
-
-      # Returns a new J750 instance, normally there would only ever be one of these
-      # assigned to the global variable such as $tester by your target:
-      #   $tester = J750.new
-      def initialize
-        @unique_counter = 0
-        @max_repeat_loop = 65_535
-        @min_repeat_loop = 2
-        @pat_extension = 'atp'
-        @active_loads = true
-        @pipeline_depth = 34  # for extended mode is vectors, for normal mode is vector pairs (54 for J750Ex)
-        @use_hv_pin = false   # allows to use high voltage for a pin for all patterns
-        @software_version = '3.50.40'
-        @compress = true
-        @support_repeat_previous = true
-        @match_entries = 10
-        @name = 'j750'
-        @program_comment_char = ['logprint', "'"]
-        @@hpt_mode = false
-      end
-
-      def flows
-        parser.flows
-      end
-
-      # Main accessor to all content parsed from existing test program sheets found in the
-      # supplied directory or in Origen.config.test_program_output_directory
-      def parser(prog_dir = Origen.config.test_program_output_directory)
-        unless prog_dir
-          fail 'You must supply the directory containing the test program sheets, or define it via Origen.config.test_program_output_directory'
-        end
-        @parser ||= J750::Parser.new
-        @parsed_dir ||= false
-        if @parsed_dir != prog_dir
-          @parser.parse(prog_dir)
-          @parsed_dir = prog_dir
-        end
-        @parser
-      end
-
-      # Capture a vector to the tester HRAM.
-      #
-      # This method applys a store vector (stv) opcode to the previous vector, note that is does
-      # not actually generate a new vector.
-      #
-      # Sometimes when generating vectors within a loop you may want to apply a stv opcode
-      # retrospectively to a previous vector, passing in an offset option will allow you
-      # to do this.
-      #
-      # On J750 the pins argument is ignored since the tester only supports whole vector capture.
-      #
-      # @example
-      #   $tester.cycle                # This is the vector you want to capture
-      #   $tester.store                # This applys the STV opcode
-      #
-      #   $tester.cycle                # This one gets stored
-      #   $tester.cycle
-      #   $tester.cycle
-      #   $tester.store(:offset => -2) # Just realized I need to capture that earlier vector
-      def store(*pins)
-        options = pins.last.is_a?(Hash) ? pins.pop : {}
-        options = { offset: 0
-                  }.merge(options)
-        update_vector microcode: 'stv', offset: options[:offset]
-      end
-      alias_method :to_hram, :store
-      alias_method :capture, :store
-
-      # Capture the next vector generated to HRAM
-      #
-      # This method applys a store vector (stv) opcode to the next vector to be generated,
-      # note that is does not actually generate a new vector.
-      #
-      # On J750 the pins argument is ignored since the tester only supports whole vector capture.
-      #
-      # @example
-      #   $tester.store_next_cycle
-      #   $tester.cycle                # This is the vector that will be captured
-      def store_next_cycle(*pins)
-        options = pins.last.is_a?(Hash) ? pins.pop : {}
-        options = {
-        }.merge(options)
-        preset_next_vector microcode: 'stv'
-      end
-
-      # Call a subroutine.
-      #
-      # This method applies a call subroutine opcode to the previous vector, it does not
-      # generate a new vector.
-      #
-      # Subroutines should always be called through this method as it ensures a running
-      # log of called subroutines is maintained and which then gets output in the pattern
-      # header to import the right dependencies.
-      #
-      # An offset option is available to make the call on earlier vectors.
-      #
-      # ==== Examples
-      #   $tester.call_subroutine("mysub")
-      #   $tester.call_subroutine("my_other_sub", :offset => -1)
-      def call_subroutine(name, options = {})
-        options = {
-          offset: 0
-        }.merge(options)
-        called_subroutines << name.to_s.chomp unless called_subroutines.include?(name.to_s.chomp) || @inhibit_vectors
-        update_vector microcode: "call #{name}", offset: options[:offset]
-      end
-
-      # Start a subroutine.
-      #
-      # Generates a global subroutine label. Global is used to adhere to the best practice of
-      # containing all subroutines in dedicated patterns, e.g. global_subs.atp
-      #
-      # ==== Examples
-      #     $tester.start_subroutine("wait_for_done")
-      #     < generate your subroutine vectors here >
-      #     $tester.end_subroutine
-      def start_subroutine(name)
-        local_subroutines << name.to_s.chomp unless local_subroutines.include?(name.to_s.chomp) || @inhibit_vectors
-        microcode "global subr #{name}:"
-      end
-
-      # * J750 Specific *
-      #
-      #
-      def enable_flag(options = {})
-        options = { flagnum: 4,      # which flag to enable for later checking
-                }.merge(options)
-
-        case options[:flagnum]
-          when 1
-            flagname = 'cpuA'
-          when 2
-            flagname = 'cpuB'
-          when 3
-            flagname = 'cpuC'
-          when 4
-            flagname = 'cpuD'
-          else
-            abort "ERROR! Invalid flag name passed to 'enable_flag' method!\n"
-        end
-        update_vector(microcode: "enable(#{flagname})")
-      end
-
-      # * J750 Specific *
-      #
-      #
-      def set_flag(options = {})
-        options = { flagnum: 4,      # which flag to set
-                }.merge(options)
-
-        case options[:flagnum]
-          when 1
-            flagname = 'cpuA'
-          when 2
-            flagname = 'cpuB'
-          when 3
-            flagname = 'cpuC'
-          when 4
-            flagname = 'cpuD'
-          else
-            abort "ERROR! Invalid flag name passed to 'set_flag' method!\n"
-        end
-        update_vector(microcode: "set_cpu(#{flagname})")
-      end
-
-      # End a subroutine.
-      #
-      # Generates a return opcode on the last vector.
-      #
-      # ==== Examples
-      #     $tester.start_subroutine("wait_for_done")
-      #     < generate your subroutine vectors here >
-      #     $tester.end_subroutine
-      # cond: whether return is conditional on a flag (to permit to mix subrs together)
-      def end_subroutine(cond = false)
-        if cond
-          update_vector microcode: 'if (flag) return'
-        else
-          update_vector microcode: 'return'
-        end
-      end
-
-      # Handshake with the tester.
-      #
-      # Will set a cpu flag (A) and wait for it to be cleared by the tester, optionally
-      # pass in a read code to pass information to the tester.
-      #
-      # ==== Examples
-      #   $tester.handshake                   # Pass control to the tester for a measurement
-      #   $tester.handshake(:readcode => 10)  # Trigger a specific action by the tester
-      def handshake(options = {})
-        options = {
-          readcode:    false,
-          manual_stop: false,    # set a 2nd CPU flag in case 1st flag is automatically cleared
-        }.merge(options)
-        if options[:readcode]
-          cycle(microcode: "set_code #{options[:readcode]}")
-        end
-        if options[:manual_stop]
-          cycle(microcode: 'enable (cpuB)')
-          cycle(microcode: 'set_cpu (cpuA cpuB)')
-          cycle(microcode: "loop_here_#{@unique_counter}: if (flag) jump loop_here_#{@unique_counter}")
-        else
-          cycle(microcode: 'set_cpu (cpuA)')
-          cycle(microcode: "loop_here_#{@unique_counter}: if (cpuA) jump loop_here_#{@unique_counter}")
-        end
-        @unique_counter += 1  # Increment so a different label will be applied if another
-        # handshake is called in the same pattern
-      end
-
-      # Do a frequency measure.
-      #
-      # Write the necessary micro code to do a frequency measure on the given pin,
-      # optionally supply a read code to pass information to the tester.
-      #
-      # ==== Examples
-      #   $tester.freq_count($top.pin(:d_out))                 # Freq measure on pin "d_out"
-      #   $tester.freq_count($top.pin(:d_out):readcode => 10)
-      def freq_count(pin, options = {})
-        options = { readcode: false
-                  }.merge(options)
-
-        cycle(microcode: "set_code #{options[:readcode]}") if options[:readcode]
-        cycle(microcode: 'set_cpu (cpuA)')
-        cycle(microcode: 'set_cpu (cpuA)')
-        cycle(microcode: 'set_cpu (cpuB)')
-        cycle(microcode: 'set_cpu (cpuC)')
-        cycle(microcode: 'freq_loop_1:')
-        cycle(microcode: 'if (cpuA) jump freq_loop_1')
-        pin.drive_lo
-        delay(2000)
-        pin.dont_care
-        cycle(microcode: 'freq_loop_2: enable (cpuB)')
-        cycle(microcode: 'if (flag) jump freq_loop_2')
-        cycle(microcode: 'enable (cpuC)')
-        cycle(microcode: 'if (flag) jump freq_loop_1')
-      end
-
-      # * J750 Specific *
-      #
-      # Generates a single MTO opcode line for J750
-      #
-      # Codes implemented: xa load_preset, xa inc, ya load_preset, ya inc, stv_m0, stv_m1, stv_c<br>
-      def memory_test(options = {})
-        options = {
-          gen_vector:          true,                 # Default generate vector not just MTO opcode
-          init_counter_x:      false,            # initialize counter X
-          inc_counter_x:       false,             # increment counter X
-          init_counter_y:      false,            # initialize counter X
-          inc_counter_y:       false,             # increment counter X
-          capture_vector:      false,            # capture vector to memory using all mem types
-          capture_vector_mem0: false,       # capture vector to memory type 0, here for J750 will be stv_m0
-          capture_vector_mem1: false,       # capture vector to memory type 1, here for J750 will be stv_m1
-          capture_vector_mem2: false,       # capture vector to memory type 2, here for J750 will be stv_c
-          pin:                 false,                       # pin on which to drive or expect data, pass pin object here!
-          pin_data:            false,                  # pin data (:none, :drive, :expect)
-        }.merge(options)
-
-        mto_opcode = ''
-
-        if options[:init_counter_x]
-          mto_opcode += ' xa load_preset'
-        end
-        if options[:inc_counter_x]
-          mto_opcode += ' xa inc'
-        end
-        if options[:init_counter_y]
-          mto_opcode += ' ya load_preset'
-        end
-        if options[:inc_counter_y]
-          mto_opcode += ' ya inc'
-        end
-        if options[:capture_vector]
-          mto_opcode += ' stv_m0 stv_m1 stv_c'
-        end
-        if options[:capture_vector_mem0]
-          mto_opcode += ' stv_m0'
-        end
-        if options[:capture_vector_mem1]
-          mto_opcode += ' stv_m1'
-        end
-        if options[:capture_vector_mem2]
-          mto_opcode += ' stv_c'
-        end
-
-        unless mto_opcode.eql?('')
-          mto_opcode = '(mto:' + mto_opcode + ')'
-        end
-
-        if options[:gen_vector]
-          if options[:pin]
-            case options[:pin_data]
-              when :drive
-                # store current pin state
-                cur_pin_state = options[:pin].state.to_sym
-                options[:pin].drive_mem
-              when :expect
-                # store current pin state
-                cur_pin_state = options[:pin].state.to_sym
-                options[:pin].expect_mem
-            end
-          end
-          cycle(microcode: "#{mto_opcode}")
-          if options[:pin]
-            # restore previous pin state
-            case options[:pin_data]
-              when :drive
-                options[:pin].state = cur_pin_state
-              when :expect
-                options[:pin].state = cur_pin_state
-            end
-          end
-        else
-          microcode "#{mto_opcode}"
-        end
-      end
-
-      # Generates a match loop on up to two pins.
-      #
-      # This method is not really intended to be called directly, rather you should call
-      # via Tester#wait e.g. $tester.wait(:match => true).
-      #
-      # The timeout should be provided in cycles, however when called via the wait method the
-      # time-based helpers (time_in_us, etc) will be converted to cycles for you.
-      # The following options are available to tailor the match loop behavior, defaults in
-      # parenthesis:
-      # * :pin - The pin object to match on (*required*)
-      # * :state - The pin state to match on, :low or :high (*required*)
-      # * :pin2 (nil) - Optionally supply a second pin to match on
-      # * :state2 (nil) - State for the second pin (required if :pin2 is supplied)
-      # * :check_for_fails (false) - Flushes the pipeline and handshakes with the tester (passing readcode 100) prior to the match (to allow binout of fails encountered before the match)
-      # * :force_fail_on_timeout (true) - Force a vector mis-compare if the match loop times out
-      # * :on_timeout_goto ("") - Optionally supply a label to branch to on timeout, by default will continue from the end of the match loop
-      # * :on_pin_match_goto ("") - Optionally supply a label to branch to when pin 1 matches, by default will continue from the end of the match loop
-      # * :on_pin2_match_goto ("") - Optionally supply a label to branch to when pin 2 matches, by default will continue from the end of the match loop
-      # * :multiple_entries (false) - Supply an integer to generate multiple entries into the match (each with a unique readcode), this can be useful when debugging patterns with multiple matches
-      # * :force_fail_on_timeout (true) - force pattern to fail if timeout occurs
-      # * :global_loops (false) - whether match loop loops should use global labels
-      # * :manual_stop (false) - whether to use extra cpuB flag to resolve IG-XL v.3.50.xx bug where VBT clears cpuA immediately
-      #                          at start of PatFlagFunc instead of at end.  Use will have to manually clear cpuB to resume this pattern.
-      # ==== Examples
-      #   $tester.wait(:match => true, :time_in_us => 5000, :pin => $top.pin(:done), :state => :high)
-      def match(pin, state, timeout, options = {})
-        options = {
-          check_for_fails:       false,
-          on_timeout_goto:       false,
-          pin2:                  false,
-          state2:                false,
-          on_pin_match_goto:     false,
-          on_pin2_match_goto:    false,
-          multiple_entries:      false,
-          force_fail_on_timeout: true,
-          global_loops:          false,
-          manual_stop:           false,
-          clr_fail_post_match:   false
-        }.merge(options)
-
-        # Flush the pipeline first and then pass control to the program to bin out any failures
-        # prior to entering the match loop
-        if options[:check_for_fails]
-          if options[:multiple_entries]
-            @match_entries.times do |i|
-              microcode "global subr match_done_#{i}:"
-              cycle(microcode: "set_code #{i + 100}")
-              cycle(microcode: 'jump call_tester') unless i == @match_entries - 1
-            end
-            microcode 'call_tester:'
-          else
-            cycle(microcode: 'set_code 100')
-          end
-          cc 'Wait for any prior failures to propagate through the pipeline'
-          cycle(microcode: 'pipe_minus 1')
-          cc 'Now handshake with the tester to bin out and parts that have failed before they got here'
-          handshake(manual_stop: options[:manual_stop])
-        end
-
-        # Now do the main match loop
-        cc 'Start the match loop'
-
-        # Calculate the loop counts for the 2 loops to appropriately hit the timeout requested
-        inner_loop_vectors = (@pipeline_depth - 1) + 4  # num vectors in inner loop
-        if timeout.to_f < @max_repeat_loop * inner_loop_vectors * @min_repeat_loop
-          # Handle case for smaller timeouts (that would force small outer loop count)
-          inner_loop_count = (timeout.to_f / (inner_loop_vectors * @min_repeat_loop)).ceil
-          outer_loop_count = @min_repeat_loop
-        else
-          # Handle longer delays
-          inner_loop_count = @max_repeat_loop
-          outer_loop_count = (timeout.to_f / (@max_repeat_loop * inner_loop_vectors)).ceil  # Will do a minimum of 1 * max_repeat_loop * (pipeline_depth-1)
-        end
-
-        global_opt = (options[:global_loops]) ? 'global ' : ''
-        microcode "#{global_opt}match_outer_loop_#{@unique_counter}:"
-        cycle(microcode: "loopB #{outer_loop_count} ign ifc icc")
-        microcode "#{global_opt}match_inner_loop_#{@unique_counter}:"
-        state == :low ? pin.expect_lo : pin.expect_hi
-        cc "Check if #{pin.name} is #{state == :low ? 'low' : 'high'} yet"
-        cycle(microcode: "loopA #{inner_loop_count} ign ifc icc")
-        pin.dont_care
-        cc ' Wait for the result to propagate through the pipeline'
-        cycle(microcode: 'pipe_minus 1 ign ifc icc')
-        cc "Branch if #{pin.name} was #{state == :low ? 'low' : 'high'}"
-        cycle(microcode: "if (pass) jump #{pin.name}_matched_#{@unique_counter} icc ifc")
-        cycle(microcode: 'clr_flag (fail) icc')
-        if options[:pin2]
-          cc "Check if #{options[:pin2].name} is #{options[:state2] == :low ? 'low' : 'high'} yet"
-          options[:state2] == :low ? options[:pin2].expect_lo : options[:pin2].expect_hi
-          state == :low ? pin.expect_hi : pin.expect_lo   # Give priority to pin 1, don't match pin 2 on this cycle
-          # if it is really a pin 1 match
-          cycle  # Read for pin 2 and !pin 1
-          options[:pin2].dont_care
-          pin.dont_care
-          cc 'Again wait for the result to propagate through the pipeline'
-          cycle(microcode: 'pipe_minus 1 ign ifc icc')
-          cc "Branch if #{options[:pin2].name} was #{options[:state2] == :low ? 'low' : 'high'}"
-          cycle(microcode: "if (pass) jump #{options[:pin2].name}_matched_#{@unique_counter} icc ifc")
-          cycle(microcode: 'clr_flag (fail) icc')
-        end
-        cc 'Loop back around if time remaining'
-        cycle(microcode: "end_loopA match_inner_loop_#{@unique_counter} icc")
-        cycle(microcode: "end_loopB match_outer_loop_#{@unique_counter} icc")
-        if options[:force_fail_on_timeout]
-          cc 'To get here something has gone wrong, strobe again to force a pattern failure'
-          state == :low ? pin.expect_lo : pin.expect_hi
-          options[:state2] == :low ? options[:pin2].expect_lo : options[:pin2].expect_hi if options[:pin2]
-          cycle
-          pin.dont_care
-          options[:pin2].dont_care if options[:pin2]
-        end
-        if options[:on_timeout_goto]
-          cycle(microcode: "jump #{options[:on_timeout_goto]} icc")
-        else
-          cycle(microcode: "jump match_loop_end_#{@unique_counter} icc")
-          # cycle(:microcode => 'halt')
-        end
-        microcode "#{pin.name}_matched_#{@unique_counter}:"
-        cycle(microcode: 'pop_loop icc')
-        unless options[:clr_fail_post_match]
-          cycle(microcode: 'clr_fail')
-        end
-        if options[:on_pin_match_goto]
-          cycle(microcode: "jump #{options[:on_pin_match_goto]}")
-        end
-        if options[:pin2]
-          microcode "#{options[:pin2].name}_matched_#{@unique_counter}:"
-          cycle(microcode: 'pop_loop icc')
-          cycle(microcode: 'clr_fail')
-          if options[:on_pin2_match_goto]
-            cycle(microcode: "jump #{options[:on_pin2_match_goto]}")
-          end
-        end
-        microcode "match_loop_end_#{@unique_counter}:"
-        if options[:clr_fail_post_match]
-          cycle(microcode: 'clr_fail')
-        end
-
-        @unique_counter += 1  # Increment so a different label will be applied if another
-        # handshake is called in the same pattern
-      end
-
-      # Generates a match loop based on vector condition passed in via block
-      #
-      # This method is not really intended to be called directly, rather you should call
-      # via Tester#wait:
-      #      e.g. $tester.wait(:match => true) do
-      #             reg(:status_reg).bit(:done).read(1)!  # vector condition that you want to match
-      #           end
-      #
-      # The timeout should be provided in cycles, however when called via the wait method the
-      # time-based helpers (time_in_us, etc) will be converted to cycles for you.
-      #
-      # The following options are available to tailor the match loop behavior, defaults in
-      # parenthesis:
-      # * :check_for_fails (false) - Flushes the pipeline and handshakes with the tester (passing readcode 100) prior to the match (to allow binout of fails encountered before the match)
-      # * :force_fail_on_timeout (true) - Force a vector mis-compare if the match loop times out
-      # * :on_timeout_goto ("") - Optionally supply a label to branch to on timeout, by default will continue from the end of the match loop
-      # * :on_block_match_goto ("") - Optionally supply a label to branch to when block condition is met, by default will continue from the end of the match loop
-      # * :multiple_entries (false) - Supply an integer to generate multiple entries into the match (each with a unique readcode), this can be useful when debugging patterns with multiple matches
-      # * :force_fail_on_timeout (true) - force pattern to fail if timeout occurs
-      # * :global_loops (false) - whether match loop loops should use global labels
-      # * :manual_stop (false) - whether to use extra cpuB flag to resolve IG-XL v.3.50.xx bug where VBT clears cpuA immediately
-      #                          at start of PatFlagFunc instead of at end.  Use will have to manually clear cpuB to resume this pattern.
-      # ==== Examples
-      #   $tester.wait(:match => true, :time_in_us => 5000, :pin => $top.pin(:done), :state => :high)
-      def match_block(timeout, options = {})
-        options = {
-          check_for_fails:       false,
-          on_timeout_goto:       false,
-          on_block_match_goto:   false,
-          multiple_entries:      false,
-          force_fail_on_timeout: true,
-          global_loops:          false,
-          manual_stop:           false,
-          clr_fail_post_match:   false
-        }.merge(options)
-
-        unless block_given?
-          fail 'ERROR: block not passed to match_block!'
-        end
-
-        # Flush the pipeline first and then pass control to the program to bin out any failures
-        # prior to entering the match loop
-        if options[:check_for_fails]
-          if options[:multiple_entries]
-            @match_entries.times do |i|
-              microcode "global subr match_done_#{i}:"
-              cycle(microcode: "set_code #{i + 100}")
-              cycle(microcode: 'jump call_tester') unless i == @match_entries - 1
-            end
-            microcode 'call_tester:'
-          else
-            cycle(microcode: 'set_code 100')
-          end
-          cc 'Wait for any prior failures to propagate through the pipeline'
-          cycle(microcode: 'pipe_minus 1')
-          cc 'Now handshake with the tester to bin out and parts that have failed before they got here'
-          handshake(manual_stop: options[:manual_stop])
-        end
-
-        # Now do the main match loop
-        cc 'Start the match loop'
-
-        # Calculate the loop counts for the 2 loops to appropriately hit the timeout requested
-        inner_loop_vectors = (@pipeline_depth - 1) + 4  # num vectors in inner loop
-        if timeout.to_f < @max_repeat_loop * inner_loop_vectors * @min_repeat_loop
-          # Handle case for smaller timeouts (that would force small outer loop count)
-          inner_loop_count = (timeout.to_f / (inner_loop_vectors * @min_repeat_loop)).ceil
-          outer_loop_count = @min_repeat_loop
-        else
-          # Handle longer delays
-          inner_loop_count = @max_repeat_loop
-          outer_loop_count = (timeout.to_f / (@max_repeat_loop * inner_loop_vectors)).ceil  # Will do a minimum of 1 * max_repeat_loop * (pipeline_depth-1)
-        end
-
-        global_opt = (options[:global_loops]) ? 'global ' : ''
-        microcode "#{global_opt}match_outer_loop_#{@unique_counter}:"
-        cycle(microcode: "loopB #{outer_loop_count} ign ifc icc")
-        microcode "#{global_opt}match_inner_loop_#{@unique_counter}:"
-        cycle(microcode: "loopA #{inner_loop_count} ign ifc icc")
-        cc 'Check if block condition met'
-        yield
-        cc ' Wait for the result to propagate through the pipeline'
-        cycle(microcode: 'pipe_minus 1 ign ifc icc')
-        cc 'Branch if block condition met'
-        cycle(microcode: "if (pass) jump block_matched_#{@unique_counter} icc ifc")
-        cycle(microcode: 'clr_flag (fail) icc')
-        cc 'Loop back around if time remaining'
-        cycle(microcode: "end_loopA match_inner_loop_#{@unique_counter} icc")
-        cycle(microcode: "end_loopB match_outer_loop_#{@unique_counter} icc")
-        if options[:force_fail_on_timeout]
-          cc 'To get here something has gone wrong, check block again to force a pattern failure'
-          yield
-        end
-        if options[:on_timeout_goto]
-          cycle(microcode: "jump #{options[:on_timeout_goto]} icc")
-        else
-          cycle(microcode: "jump match_loop_end_#{@unique_counter} icc")
-          # cycle(:microcode => 'halt')
-        end
-        microcode "block_matched_#{@unique_counter}:"
-        cycle(microcode: 'pop_loop icc')
-        unless options[:clr_fail_post_match]
-          cycle(microcode: 'clr_fail')
-        end
-        if options[:on_block_match_goto]
-          cycle(microcode: "jump #{options[:on_block_match_goto]}")
-        end
-        microcode "match_loop_end_#{@unique_counter}:"
-        if options[:clr_fail_post_match]
-          cycle(microcode: 'clr_fail')
-        end
-
-        @unique_counter += 1  # Increment so a different label will be applied if another
-        # handshake is called in the same pattern
-      end
-
-      # Call a match loop.
-      #
-      # Normally you would put your match loop in a global subs pattern, then you can
-      # call it via this method. This method automatically syncs match loop naming with
-      # the match generation flow, no arguments required.
-      #
-      # This is a J750 specific API.
-      #
-      # ==== Examples
-      #   $tester.cycle
-      #   $tester.call_match  # Calls the match loop, or the first entry point if you have multiple
-      #   $tester.cycle
-      #   $tester.call_match  # Calls the match loop, or the second entry point if you have multiple
-      def call_match
-        @match_counter = @match_counter || 0
-        call_subroutine("match_done_#{@match_counter}")
-        @match_counter += 1 unless @match_counter == (@match_entries || 1) - 1
-      end
-
-      # Apply a label to the pattern.
-      #
-      # No additional vector is generated.
-      # Arguments:
-      #    name : label name
-      #  global : (optional) whether to apply global label, default=false
-      #
-      # ==== Examples
-      #   $tester.label("something_significant")
-      #   $tester.label("something_significant",true) # apply global label
-      def label(name, global = false)
-        global_opt = (global) ? 'global ' : ''
-        microcode global_opt + name + ':'
-      end
-
-      # * J750 Specific *
-      #
-      # Set a readcode.
-      #
-      # Use the set an explicit readcode for communicating with the tester. This method
-      # will generate an additional vector.
-      #
-      # ==== Examples
-      #   $tester.set_code(55)
-      def set_code(code)
-        cycle(microcode: "set_code #{code}")
-      end
-
-      # Branch execution to the given point.
-      #
-      # This generates a new vector with a jump instruction to a given label. This method
-      # will generate an additional vector.
-      #
-      # ==== Examples
-      #   $tester.branch_to("something_significant")
-      def branch_to(label)
-        cycle(microcode: "jump #{label}")
-      end
-      alias_method :branch, :branch_to
-
-      # Add loop to the pattern.
-      #
-      # Pass in a name for the loop and the number of times to execute it, all vectors
-      # generated by the given block will be captured in the loop.
-      #
-      # Optional arguments: global - whether to apply global label (default=false)
-      #                label_first - whether to apply loop label before loop vector or not
-      #
-      # ==== Examples
-      #   $tester.loop_vectors("pulse_loop", 3) do   # Do this 3 times...
-      #       $tester.cycle
-      #       some_other_method_to_generate_vectors
-      #   end
-      def loop_vectors(name, number_of_loops, global = false, label_first = false)
-        if number_of_loops > 1
-          @loop_counters ||= {}
-          if @loop_counters[name]
-            @loop_counters[name] += 1
-          else
-            @loop_counters[name] = 0
-          end
-          loop_name = @loop_counters[name] == 0 ? name : "#{name}_#{@loop_counters[name]}"
-          if label_first
-            global_opt = (global) ? 'global ' : ''
-            microcode "#{global_opt}#{loop_name}: "
-          end
-          cycle(microcode: "loopA #{number_of_loops}")
-          unless label_first
-            global_opt = (global) ? 'global ' : ''
-            cycle(microcode: "#{global_opt}#{loop_name}: ")
-          end
-          yield
-          cycle(microcode: "end_loopA #{loop_name}")
-        else
-          yield
-        end
-      end
-      alias_method :loop_vector, :loop_vectors
-
-      # An internal method called by Origen to create the pattern header
-      def pattern_header(options = {})
-        options = {
-          subroutine_pat: false,
-          group:          false,            # If true the end pattern is intended to run within a pattern group
-          high_voltage:   false,     # Supply a pin name here to declare it as an HV instrument
-          freq_counter:   false,     # Supply a pin name here to declare it as a frequency counter
-          memory_test:    false,      # If true, define 2-bit MTO DGEN as instrument
-        }.merge(options)
-
-        called_timesets.each do |timeset|
-          microcode "import tset #{timeset.name};"
-        end
-        unless options[:group]    # Withhold imports for pattern groups, is this correct?
-          called_subroutines.each do |sub_name|
-            # Don't import any called subroutines that are declared in the current pattern
-            microcode "import svm_subr #{sub_name};" unless local_subroutines.include?(sub_name)
-          end
-        end
-        # Should implement this more like @instruments.each...
-        if options[:memory_test]
-          microcode 'instruments = {'
-          microcode '               mto:dgen_2bit;'
-          microcode '}'
-        end
-        microcode "svm_only_file = #{options[:subroutine_pat] ? 'yes' : 'no'};"
-        microcode 'opcode_mode = extended;'
-        microcode 'compressed = yes;' # if $soc.gzip_patterns
-        options[:high_voltage] = @use_hv_pin
-        microcode "pin_setup = {#{options[:high_voltage]} high_voltage;}" if options[:high_voltage]
-        microcode "pin_setup = {#{options[:freq_counter]} freq_count;}" if options[:freq_counter]
-        microcode ''
-
-        pin_list = ordered_pins.map do |p|
-          if Origen.app.pin_pattern_order.include?(p.id)
-            p.id # specified name overrides pin name
-          else
-            p.name
-          end
-        end.join(', ')
-
-        microcode "vector ($tset, #{pin_list})"
-        microcode '{'
-        unless options[:subroutine_pat]
-          microcode 'start_label pattern_st:'
-        end
-      end
-
-      # An internal method called by Origen to generate the pattern footer
-      def pattern_footer(options = {})
-        options = {
-          subroutine_pat: false,
-          end_in_ka:      false,
-          end_with_halt:  false
-        }.merge(options)
-        # cycle(:microcode => "#{$soc.end_of_pattern_label}:") if $soc.end_of_pattern_label
-        if options[:end_in_ka]
-          $tester.cycle microcode: 'keep_alive'
-        else
-          if options[:end_with_halt]
-            $tester.cycle microcode: 'halt'
-          else
-            $tester.cycle microcode: 'end_module' unless options[:subroutine_pat]
-          end
-        end
-        microcode '}'
-      end
-
-      # Returns an array of subroutines called while generating the current pattern
-      def called_subroutines
-        @called_subroutines ||= []
-      end
-
-      # Returns an array of subroutines created by the current pattern
-      def local_subroutines # :nodoc:
-        @local_subroutines ||= []
-      end
-
-      # This is an internal method use by Origen which returns a fully formatted vector
-      # You can override this if you wish to change the output formatting at vector level
-      def format_vector(vec)
-        timeset = vec.timeset ? "> #{vec.timeset.name}" : ''
-        pin_vals = vec.pin_vals ? "#{vec.pin_vals} ;" : ''
-        if vec.repeat > 1
-          microcode = "repeat #{vec.repeat}"
-        else
-          microcode = vec.microcode ? vec.microcode : ''
-        end
-        # if vec.pin_vals && vec.number && vec.cycle_number
-        #  comment = " // Vector #{@pattern_vectors}, Cycle #{@pattern_cycles}"
-        # else
-        comment = ''
-        # end
-        "#{microcode.ljust(65)}#{timeset.ljust(31)}#{pin_vals}#{comment}"
-      end
-
-      # Override this to force the formatting to match the v1 J750 model (easier diffs)
-      def push_microcode(code) # :nodoc:
-        stage.store(code.ljust(65) + ''.ljust(31))
-      end
-      alias_method :microcode, :push_microcode
-
-      # All vectors generated with the supplied block will have all pins set
-      # to the repeat previous state. Any pins that are changed state within
-      # the block will still update to the supplied value.
-      # ==== Example
-      #   # All pins except invoke will be assigned the repeat previous code
-      #   # in the generated vector. On completion of the block they will
-      #   # return to their previous state, except for invoke which will
-      #   # retain the value assigned within the block.
-      #   $tester.repeat_previous do
-      #       $top.pin(:invoke).drive(1)
-      #       $tester.cycle
-      #   end
-      def repeat_previous
-        pinmap = Origen.pin_bank.pins
-        pinmap.each { |_id, pin| pin.repeat_previous = true }
-        yield
-        pinmap.each { |_id, pin| pin.repeat_previous = false }
-      end
-
-      def ignore_fails(*pins)
-        pins.each(&:suspend)
-        yield
-        pins.each(&:resume)
-      end
-
-      def j750?
-        true
-      end
-    end
-  end
-end