origen 0.2.6 → 0.3.0

data/lib/origen/tester/ultraflex/parser/test_instance.rb

@@ -1,262 +0,0 @@
-module Origen
-  module Tester
-    class Ultraflex
-      class Parser
-        class TestInstance
-          attr_accessor :parser
-
-          TYPES = %w(
-            functional board_pmu empty pin_pmu power_supply
-          )
-
-          TYPE_ALIASES = {
-            functional_t:         :functional,
-            boardpmu_t:           :board_pmu,
-            nvmboardpmucal_t:     :board_pmu,
-            nvmboardpmumeasure_t: :board_pmu,
-            empty_t:              :empty,
-            pinpmu_t:             :pin_pmu,
-            nvmpinpmucal_t:       :pin_pmu,
-            nvmpinpmumeas_t:      :pin_pmu,
-            powersupply_t:        :power_supply
-          }
-
-          attributes = %w(
-            test_name proc_type proc_name proc_called_as dc_category dc_selector ac_category ac_selector
-            time_sets edge_sets pin_levels overlay
-          )
-          80.times do |i|
-            attributes << "arg#{i}"
-          end
-          attributes << 'comment'
-
-          ATTRS = attributes
-
-          ALIASES = {
-            name:       :test_name,
-
-            functional: {
-              pattern:             :arg0,
-              start_func:          :arg1,
-              pre_pat_func:        :arg2,
-              pre_test_func:       :arg3,
-              post_test_func:      :arg4,
-              post_pat_func:       :arg5,
-              end_func:            :arg6,
-              set_pass_fail:       :arg7,
-              start_func_args:     :arg13,
-              pre_pat_func_args:   :arg14,
-              pre_test_func_args:  :arg15,
-              post_test_func_args: :arg16,
-              post_pat_func_args:  :arg17,
-              end_func_args:       :arg18,
-              wait_flags:          :arg21,
-              wait_time:           :arg22,
-              pat_flag_func:       :arg23,
-              pat_flag_func_args:  :arg24,
-              relay_mode:          :arg25,
-              threading:           :arg26,
-              match_all_sites:     :arg27,
-              capture_mode:        :arg30,
-              capture_what:        :arg31,
-              capture_memory:      :arg32,
-              capture_size:        :arg33,
-              datalog_mode:        :arg34,
-              data_type:           :arg35
-            },
-
-            board_pmu:  {
-              hsp_start:           :arg0,
-              start_func:          :arg1,
-              pre_pat_func:        :arg2,
-              pre_test_func:       :arg3,
-              post_test_func:      :arg4,
-              post_pat_func:       :arg5,
-              end_func:            :arg6,
-              precond_pat:         :arg7,
-              hold_state_pat:      :arg8,
-              holdstate_pat:       :arg8,
-              pattern:             :arg8,
-              pcp_stop:            :arg9,
-              wait_flags:          :arg10,
-              start_lo:            :arg11,
-              init_lo:             :arg11,
-              start_hi:            :arg12,
-              init_hi:             :arg12,
-              start_hiz:           :arg13,
-              init_hiz:            :arg13,
-              float_pins:          :arg14,
-              pinlist:             :arg15,
-              measure_mode:        :arg16,
-              irange:              :arg17,
-              clamp:               :arg18,
-              vrange:              :arg19,
-              sampling_time:       :arg20,
-              samples:             :arg21,
-              setting_time:        :arg22,
-              hi_lo_lim_valid:     :arg23,
-              hi_limit:            :arg24,
-              lo_limit:            :arg25,
-              force_cond_1:        :arg26,
-              force_cond_2:        :arg27,
-              gang_pins_tested:    :arg28,
-              relay_mode:          :arg29,
-              wait_time_out:       :arg30,
-              start_func_args:     :arg31,
-              pre_pat_func_args:   :arg32,
-              pre_test_func_args:  :arg33,
-              post_test_func_args: :arg34,
-              post_pat_func_args:  :arg35,
-              end_func_args:       :arg36,
-              pcp_start:           :arg37,
-              pcp_check_pg:        :arg38,
-              hsp_stop:            :arg39,
-              hsp_check_pg:        :arg40,
-              resume_pat:          :arg41,
-              utility_pins_1:      :arg42,
-              utility_pins_0:      :arg43,
-              pre_charge_enable:   :arg44,
-              pre_charge:          :arg45,
-              threading:           :arg46
-            },
-
-            pin_pmu:    {
-              hsp_start:           :arg0,
-              start_func:          :arg1,
-              pre_pat_func:        :arg2,
-              pre_test_func:       :arg3,
-              post_test_func:      :arg4,
-              post_pat_func:       :arg5,
-              end_func:            :arg6,
-              precond_pat:         :arg7,
-              hold_state_pat:      :arg8,
-              holdstate_pat:       :arg8,
-              pattern:             :arg8,
-              pcp_stop:            :arg9,
-              wait_flags:          :arg10,
-              start_lo:            :arg11,
-              init_lo:             :arg11,
-              start_hi:            :arg12,
-              init_hi:             :arg12,
-              start_hiz:           :arg13,
-              init_hiz:            :arg13,
-              float_pins:          :arg14,
-              pinlist:             :arg15,
-              measure_mode:        :arg16,
-              irange:              :arg17,
-              setting_time:        :arg18,
-              hi_lo_lim_valid:     :arg19,
-              hi_limit:            :arg20,
-              lo_limit:            :arg21,
-              force_cond_1:        :arg22,
-              force_cond_2:        :arg23,
-              fload:               :arg24,
-              f_load:              :arg24,
-              relay_mode:          :arg25,
-              wait_time_out:       :arg26,
-              start_func_args:     :arg27,
-              pre_pat_func_args:   :arg28,
-              pre_test_func_args:  :arg29,
-              post_test_func_args: :arg30,
-              post_pat_func_args:  :arg31,
-              end_func_args:       :arg32,
-              pcp_start:           :arg33,
-              pcp_check_pg:        :arg34,
-              hsp_stop:            :arg35,
-              hsp_check_pg:        :arg36,
-              sampling_time:       :arg37,
-              samples:             :arg38,
-              resume_pat:          :arg39,
-              vcl:                 :arg40,
-              vch:                 :arg41,
-              utility_pins_1:      :arg42,
-              utility_pins_0:      :arg43,
-              pre_charge_enable:   :arg44,
-              pre_charge:          :arg45,
-              threading:           :arg46
-            }
-          }
-
-          # Make readers for each low level attribute
-          ATTRS.each do |attr|
-            attr_reader attr
-          end
-
-          # And the aliases
-          ALIASES.each do |alias_, attr|
-            define_method("#{alias_}") do
-              send(attr)
-            end
-          end
-
-          def initialize(line, options = {})
-            @parser = options[:parser]
-            @line = line
-            parse
-            if valid?
-              ATTRS.each_with_index do |attr, i|
-                instance_variable_set("@#{attr}", components[i + 1])
-              end
-              if ALIASES[type]
-                ALIASES[type].each do |alias_, attr|
-                  define_singleton_method("#{alias_}") do
-                    send(attr)
-                  end
-                end
-              end
-            end
-          end
-
-          def inspect  # :nodoc:
-            "<TestInstance: #{name}, Type: #{type}>"
-          end
-
-          def description
-            parser.descriptions.test_instance(name: name)
-          end
-
-          def type
-            TYPE_ALIASES[proc_name.downcase.to_sym] || :unsupported
-          end
-
-          def parse
-            @components = @line.split("\t") unless @line.strip.empty?
-          end
-
-          def valid?
-            components[4] && ['Excel Macro', 'VB DLL'].include?(components[4])
-          end
-
-          def components
-            @components ||= []
-          end
-
-          # Returns an array of all pattern names referenced in this test instance
-          def patterns
-            if self.respond_to?(:pattern)
-              pattern.split(',').map do |pat|
-                extract_pattern_from_patset(pat)
-              end.flatten.map { |pat| pat.gsub(/.*[\\\/]/, '').gsub(/\..*/, '') }
-            end
-          end
-
-          def extract_pattern_from_patset(patset)
-            pset = parser.pattern_sets.where(name: patset, exact: true)
-            if pset.size > 1
-              puts "Warning multiple pattern sets called #{patset} found, using the first one"
-            end
-            if pset.size == 0
-              patset
-            else
-              pset.first.pattern_names
-            end
-          end
-
-          def vdd
-            parser.dc_specs.where(name: 'VDD', exact: true).first.lookup(dc_category, dc_selector)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/origen/tester/ultraflex/parser/test_instances.rb

@@ -1,26 +0,0 @@
-module Origen
-  module Tester
-    class Ultraflex
-      class Parser
-        class TestInstances < Origen::Tester::Parser::SearchableHash
-          attr_accessor :parser
-
-          def initialize(options = {})
-            @parser = options[:parser]
-          end
-
-          def import(file)
-            File.readlines(file).each do |line|
-              l = TestInstance.new(line, parser: parser)
-              self[l.name] = l if l.valid?
-            end
-          end
-
-          def inspect
-            "<TestInstances: #{size}>"
-          end
-        end
-      end
-    end
-  end
-end

data/lib/origen/tester/ultraflex/parser/timeset.rb

@@ -1,15 +0,0 @@
-module Origen
-  module Tester
-    class Ultraflex
-      class Parser
-        class Timeset
-          attr_accessor :parser
-
-          def initialize(options = {})
-            @parser = options[:parser]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/origen/tester/ultraflex/ultraflex.rb

@@ -1,759 +0,0 @@
-module Origen
-  module Tester
-    # This class has been deprecated
-    Origen.deprecate <<-END
-      UltraFlex Tester in Origen core has been moved to a dedicated plugin,
-      use Testers::UltraFLEX from this plugin instead of Origen::Tester::Ultraflex
-      http://origen.freescale.net/testers
-    END
-
-    # Tester model to generate .atp patterns for the Teradyne Ultraflex
-    #
-    # == Basic Usage
-    #   $tester = Origen::Tester::Ultraflex.new
-    #   $tester.cycle       # Generate a vector
-    #
-    # Many more methods exist to generate Ultraflex 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 Ultraflex
-      include Tester
-      include Parser
-      require 'origen/tester/ultraflex/files'
-      include Files
-
-      autoload :Parser, 'origen/tester/ultraflex/parser'
-      autoload :Generator, 'origen/tester/ultraflex/generator'
-
-      attr_accessor :use_hv_pin
-      attr_accessor :software_version
-
-      # Returns a new Ultraflex instance, normally there would only ever be one of these
-      # assigned to the global variable such as $tester by your target:
-      #   $tester = Ultraflex.new
-      #
-      # NOTE: Ultraflex features not yet supported;
-      #        - dual mode (assumes single mode)
-      #        - multiple modules per pattern (only one per for now)
-      def initialize
-        @unique_counter = 0
-        @max_repeat_loop = 65_535
-        @min_repeat_loop = 2
-        @pat_extension = 'atp'
-        @active_loads = true
-        @pipeline_depth = 255  # for single mode on UP1600
-        @use_hv_pin = false   # allows to use high voltage for a pin for all patterns
-        @software_version = '8.10.10'
-        @compress = true
-        @support_repeat_previous = true
-        @match_entries = 10
-        @name = 'ultraflex'
-        @program_comment_char = ['logprint', "'"]
-        @min_module_size = 64                   # min number of vectors in a module for single
-      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 ||= ULTRAFLEX::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 Ultraflex 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 Ultraflex 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
-
-      # * Ultraflex Specific *
-      #
-      #
-      def enable_flag(options = {})
-        options = { flagnum: 4,      # which flag to enable for later checking
-                }.merge(options)
-
-        case options[:flagnum]
-          when 1
-            flagname = 'cpuA_cond'
-          when 2
-            flagname = 'cpuB_cond'
-          when 3
-            flagname = 'cpuC_cond'
-          when 4
-            flagname = 'cpuD_cond'
-          else
-            abort "ERROR! Invalid flag name passed to 'enable_flag' method!\n"
-        end
-        update_vector(microcode: "branch_expr(#{flagname})")
-      end
-
-      # * Ultraflex Specific *
-      #
-      #
-      def set_flag(options = {})
-        options = { flagnum: 4,      # which flag to set
-                }.merge(options)
-
-        case options[:flagnum]
-          when 1
-            flagname = 'cpuA_cond'
-          when 2
-            flagname = 'cpuB_cond'
-          when 3
-            flagname = 'cpuC_cond'
-          when 4
-            flagname = 'cpuD_cond'
-          else
-            abort "ERROR! Invalid flag name passed to 'set_flag' method!\n"
-        end
-        update_vector(microcode: "set_cpu_cond(#{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
-
-      # * Ultraflex Specific *
-      #
-      # No MTO avail on Ultraflex-- need to work with DSSC
-      #
-      # def memory_test
-
-      # 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}")
-        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}")
-        pin.dont_care
-        cc ' Wait for the result to propagate through the pipeline'
-        cycle(microcode: 'pipe_minus 1')
-        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')
-          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}")
-        microcode "#{global_opt}match_inner_loop_#{@unique_counter}:"
-        cycle(microcode: "loopA #{inner_loop_count}")
-        cc 'Check if block condition met'
-        yield
-        cc ' Wait for the result to propagate through the pipeline'
-        cycle(microcode: 'pipe_minus 1')
-        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 Ultraflex 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
-
-      # * Ultraflex 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
-        }.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...
-        microcode 'opcode_mode = single;'
-        microcode 'digital_inst = hsdm;'
-        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(&:name).join(', ')
-
-        microcode "#{options[:subroutine_pat] ? 'srm_vector' : 'vm_vector'}"
-        microcode "#{options[:pattern]} ($tset, #{pin_list})"
-        microcode '{'
-        unless options[:subroutine_pat]
-          microcode "start_label #{options[:pattern]}_st:"
-        end
-      end
-
-      # DDHH pad vector for single mode if pattern is less than 64 vectors??
-
-      # 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
-          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 Ultraflex 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
-        Origen.app.pin_map.each { |_id, pin| pin.repeat_previous = true }
-        yield
-        Origen.app.pin_map.each { |_id, pin| pin.repeat_previous = false }
-      end
-
-      def ignore_fails(*pins)
-        pins.each(&:suspend)
-        yield
-        pins.each(&:resume)
-      end
-
-      def ultraflex?
-        true
-      end
-    end
-  end
-end