origen_testers 0.51.0 → 0.51.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5ff2e2f1b209e2dadbf045bc52f45361a8220f7f43b5fa27a1782f6c2b61a9e
-  data.tar.gz: a0387e3b6629f520a42dde25ae6c5b78a86d4f93a1beefbff6bd865988b8577d
+  metadata.gz: d1ba41af6b65ac674916979e0732f2ec945cd3871a9764ed26eed0c1fc9ad9df
+  data.tar.gz: 63be076e3b7dfc1dfa525b420b233b8a79eb33f6c86a06852f0069f01cfd7668
 SHA512:
-  metadata.gz: 8c1b698fc08e769ce66ce5b65073f1aa3644b59497587849338c6fa343c615e42c5300e45238d4f706c347d6b7e354aab7fae28541f90f8845ee3cdcd0633a72
-  data.tar.gz: a227d7203f78c6d36aa2963478067b8e4a7746e588f464d680da7e36069f48fa2bbed19743d8e2923045bb53adb42856ab700061bd52492d28bf0c188f7c2db3
+  metadata.gz: 13f984fad6402b0749eaa3029aa8ccecf3870f6e534c553884a6dc6de42a11b4383e268378ec84968b7e71ce2ed75b800fe9c8f7128f37c32e3b1b78a7d70ec7
+  data.tar.gz: a4b421dfd78750be92b44112ca13506a6f281a98ee9f84faa3ccf49b08a4e1f32fecfe979aa7f2eafb4f66a1875a66ad092949d39bd7638ccdbfb6ba812308a6

data/config/version.rb

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

data/lib/origen_testers/atp/flow.rb

@@ -220,6 +220,15 @@ module OrigenTesters::ATP
       @pipeline[0] = add_volatile_flags(@pipeline[0], flags)
     end
 
+    # Indicate the that given flags should keep state between units
+    # prevent them from being in the initialization block
+    # these flags will be the user's responsibility to initialize
+    def add_global_flag(*flags)
+      options = flags.pop if flags.last.is_a?(Hash)
+      flags = flags.flatten
+      @pipeline[0] = add_global_flag_to_node(@pipeline[0], flags)
+    end
+
     # Record a description for a bin number
     def describe_bin(number, description, options = {})
       @pipeline[0] = add_bin_description(@pipeline[0], number, description, type: :hard)
@@ -947,6 +956,24 @@ module OrigenTesters::ATP
       node.updated(nil, [name, v] + nodes)
     end
 
+    # Ensures the flow ast has a global node, then adds the
+    # given flags to it
+    def add_global_flag_to_node(node, flags)
+      name, *nodes = *node
+      if nodes[0] && nodes[0].type == :global
+        v = nodes.shift
+      else
+        v = n0(:global)
+      end
+      existing = v.children.map { |f| f.type == :flag ? f.value : nil }.compact
+      new = []
+      flags.each do |flag|
+        new << n1(:flag, flag) unless existing.include?(flag)
+      end
+      v = v.updated(nil, v.children + new)
+      node.updated(nil, [name, v] + nodes)
+    end
+
     # Ensures the flow ast has a bin descriptions node, then adds the
     # given description to it
     def add_bin_description(node, number, description, options)

data/lib/origen_testers/atp/flow_api.rb

@@ -8,7 +8,7 @@ module OrigenTesters::ATP
       @atp
     end
 
-    ([:test, :bin, :pass, :continue, :cz, :log, :sub_test, :volatile, :set_flag, :set, :enable, :disable, :render,
+    ([:test, :bin, :pass, :continue, :cz, :log, :sub_test, :volatile, :add_global_flag, :set_flag, :set, :enable, :disable, :render,
       :context_changed?, :ids, :describe_bin, :describe_softbin, :describe_soft_bin, :loop] +
       OrigenTesters::ATP::Flow::CONDITION_KEYS.keys + OrigenTesters::ATP::Flow::RELATIONAL_OPERATORS).each do |method|
       define_method method do |*args, &block|

data/lib/origen_testers/atp/processor.rb

@@ -33,6 +33,8 @@ module OrigenTesters::ATP
         n = process(node)
         if n.respond_to?(:type) && n.type == :inline
           results += n.children
+        elsif n.respond_to?(:type) && n.type == :global
+          add_global_flag(n.to_a[0].value)
         else
           results << n unless n.respond_to?(:type) && n.type == :remove
         end
@@ -64,6 +66,32 @@ module OrigenTesters::ATP
       result
     end
 
+    def add_global_flag(flag)
+      # Had to do @@ because the state got lost after the recursive calls
+      @@globals ||= {}
+      @@globals[:flags] ||= []
+      @@globals[:flags] << flag
+    end
+
+    def extract_globals(flow)
+      @@globals ||= {}
+      if v = flow.find(:global)
+        @@globals[:flags] ||= []
+        @@globals[:flags] += Array(v.find_all(:flag)).map(&:value) if v.respond_to?(:find_all) && v.method(:find_all).parameters.size == 1
+      end
+    end
+
+    def global_flags
+      @@globals ||= {}
+      @@globals[:flags] || []
+    end
+
+    # Returns true if the given flag name has been marked as global
+    def global_flag?(flag)
+      result = global_flags.any? { |f| clean_flag(f) == clean_flag(flag) }
+      result
+    end
+
     def clean_flag(flag)
       flag = flag.dup.to_s
       flag[0] = '' if flag[0] == '$'

data/lib/origen_testers/charz/profile.rb

@@ -19,7 +19,7 @@ module OrigenTesters
       #   @return [Array] list of charz routines to be called under this profile
       # @!attribute charz_only
       #   @return [Boolean] indicates if the point tests should or shouldn't be added to the flow
-      attr_accessor :id, :name, :placement, :on_result, :enables, :flags, :routines, :charz_only
+      attr_accessor :id, :name, :placement, :on_result, :enables, :flags, :routines, :charz_only, :and_enables, :and_flags
 
       def initialize(id, options, &block)
         @id = id
@@ -74,8 +74,20 @@ module OrigenTesters
         end
 
         unless @gate_checks == false
-          gate_check(@enables, :enables) if @enables
-          gate_check(@flags, :flags) if @flags
+          if @and_enables && @and_flags
+            Origen.log.error "@and_enables and @and_flags are both set to true. Please only 'and' one gate type"
+            fail
+          end
+          if @and_enables
+            gate_check(@flags, :flags) if @flags
+            gate_check_and(@enables, :enables, @flags) if @enables
+          elsif @and_flags
+            gate_check(@enables, :enables) if @enables
+            gate_check_and(@flags, :flags, @enables) if @flags
+          else
+            gate_check(@enables, :enable) if @enables
+            gate_check(@flags, :flags) if @flags
+          end
         end
       end
 
@@ -112,6 +124,46 @@ module OrigenTesters
         end
       end
 
+      def gate_check_and(gates, gate_type, other_gate)
+        if other_gate.is_a? Hash
+          Origen.log.error "Profile #{id}: #{other_gate} When using &&-ing feature, the non-anded gate can not be of type hash."
+          fail
+        end
+        case gates
+        when Symbol, String
+          return
+        when Array
+          unknown_gates = gates.reject { |gate| [String, Symbol].include? gate.class }
+          if unknown_gates.empty?
+            return
+          else
+            Origen.log.error "Profile #{id}: Unknown #{gate_type} type(s) in #{gate_type} array."
+            Origen.log.error "Arrays must contain Strings and/or Symbols, but #{unknown_gates.map(&:class).uniq } were found in #{gates}"
+            fail
+          end
+        when Hash
+          gates.each do |gated_routine, gates|
+            if gated_routine.is_a? Hash
+              Origen.log.error "Profile #{id}: #{gate_type} Hash keys cannot be of type Hash, but only Symbol, String, or Array"
+              fail
+            end
+            unless @defined_routines.include?(gated_routine)
+              Origen.log.error "Profile #{id}: #{gated_routine} Hash keys for &&-ed gates must be defined routines."
+              fail
+            end
+            gates = [gates] unless gates.is_a? Array
+            unknown_gates = gates.reject { |gate| [String, Symbol].include? gate.class }
+            unless unknown_gates.empty?
+              Origen.log.error "Gate array must contain Strings and/or Symbols, but #{unknown_gates.map(&:class).uniq } were found in #{gates}"
+              fail
+            end
+          end
+        else
+          Origen.log.error "Profile #{id}: Unknown #{gate_type} type: #{gates.class}. #{gate_type} must be of type Symbol, String, Array, or Hash"
+          fail
+        end
+      end
+
       def method_missing(m, *args, &block)
         ivar = "@#{m.to_s.gsub('=', '')}"
         ivar_sym = ":#{ivar}"

data/lib/origen_testers/charz/session.rb

@@ -16,12 +16,13 @@ module OrigenTesters
           @defaults = options[:defaults]
         else
           @defaults = {
-            placement:  :inline,
-            on_result:  nil,
-            enables:    nil,
-            flags:      nil,
-            name:       'charz',
-            charz_only: false
+            placement:   :inline,
+            on_result:   nil,
+            enables:     nil,
+            flags:       nil,
+            enables_and: nil,
+            name:        'charz',
+            charz_only:  false
           }
         end
       end
@@ -53,6 +54,17 @@ module OrigenTesters
           return @valid
         end
         @defined_routines = options.delete(:defined_routines)
+
+        if charz_obj.and_flags
+          @and_flags = charz_obj.and_flags
+        else
+          @and_flags = false
+        end
+        if charz_obj.and_enables
+          @and_enables = charz_obj.and_enables
+        else
+          @and_enables = false
+        end
         assign_by_priority(:placement, charz_obj, options)
         assign_by_priority(:on_result, charz_obj, options)
         assign_by_priority(:enables, charz_obj, options)

data/lib/origen_testers/charz.rb

@@ -334,13 +334,102 @@ module OrigenTesters
     #
     # This is the final method of handling the insert_charz_test usecases, where the block thats been passed around is finally called
     # the user's provided block is passed the current routine (one at a time) to then take its info to generate a charz test
+
+    # Pass an "and_if_true" variable for enables and flags? And use that to to decide what to do? Then we don't need 4.
+    # But the hash has to be structured a different way for the enable_and (routine is key, enables is value.)
     def process_gates(options, &block)
       if options[:skip_gates] || !(charz_session.enables || charz_session.flags)
         charz_session.routines.each do |routine|
           block.call(options.merge(current_routine: routine))
         end
       else
-        if charz_session.enables && charz_session.flags
+        if charz_session.and_enables
+          if charz_session.flags
+            # Wrap all tests in flag, wrap some tests in anded enables.
+            ungated_routines = charz_session.routines - charz_session.enables.keys
+            ungated_routines.each do |routine|
+              if_flag charz_session.flags do
+                block.call(options.merge(current_routine: routine))
+              end
+            end
+            gated_routines = charz_session.routines - ungated_routines
+            # Build the proc which contains the nested if statements for each routine so they are anded.
+            gated_routines.each do |routine|
+              my_proc = -> do
+                if_flag charz_session.flags do
+                  block.call(options.merge(current_routine: routine))
+                end
+              end
+              charz_session.enables[routine].inject(my_proc) do |my_block, enable|
+                lambda do
+                  if_enable :"#{enable}" do
+                    my_block.call
+                  end
+                end
+              end.call
+            end
+          else
+            ungated_routines = charz_session.routines - charz_session.enables.keys
+            ungated_routines.each do |routine|
+              block.call(options.merge(current_routine: routine))
+            end
+            # Build the proc which contains the nested if statements for each routine so they are anded.
+            gated_routines = charz_session.routines - ungated_routines
+            gated_routines.each do |routine|
+              my_proc = -> { block.call(options.merge(current_routine: routine)) }
+              charz_session.enables[routine].inject(my_proc) do |my_block, enable|
+                lambda do
+                  if_enable :"#{enable}" do
+                    my_block.call
+                  end
+                end
+              end.call
+            end
+          end
+        elsif charz_session.and_flags
+          if charz_session.enables
+            # Wrap all tests in enable, some tests in anded flags.
+            ungated_routines = charz_session.routines - charz_session.flags.keys
+            ungated_routines.each do |routine|
+              if_enable charz_session.enables do
+                block.call(options.merge(current_routine: routine))
+              end
+            end
+            # Build the proc which contains the nested if statemements for each routine so they are anded.
+            gated_routines = charz_session.routines - ungated_routines
+            gated_routines.each do |routine|
+              my_proc = -> do
+                if_enable charz_session.enables do
+                  block.call(options.merge(current_routine: routine))
+                end
+              end
+              charz_session.flags[routine].inject(my_proc) do |my_block, flag|
+                lambda do
+                  if_flag :"#{flag}" do
+                    my_block.call
+                  end
+                end
+              end.call
+            end
+          else
+            ungated_routines = charz_session.routines - charz_session.flags.keys
+            ungated_routines.each do |routine|
+              block.call(options.merge(current_routine: routine))
+            end
+            # Build the proc which contains the nested if statemements for each routine so they are anded.
+            gated_routines = charz_session.routines - ungated_routines
+            gated_routines.each do |routine|
+              my_proc = -> { block.call(options.merge(current_routine: routine)) }
+              charz_session.flags[routine].inject(my_proc) do |my_block, flag|
+                lambda do
+                  if_flag :"#{flag}" do
+                    my_block.call
+                  end
+                end
+              end.call
+            end
+          end
+        elsif charz_session.enables && charz_session.flags
           if charz_session.enables.is_a?(Hash) && !charz_session.flags.is_a?(Hash)
             # wrap all tests in flags, wrap specific tests in enables
             if_flag charz_session.flags do

data/lib/origen_testers/igxl_based_tester/base/flow.rb

@@ -129,7 +129,7 @@ module OrigenTesters
               current_line.flag_pass = flag
             end
           else
-            unless set_previously
+            if !set_previously && !global_flags.include?(flag)
               completed_lines << platform::FlowLine.new(:defaults, flag_fail: flag)
             end
             completed_lines << new_line(:flag_true, parameter: flag)

data/lib/origen_testers/smartest_based_tester/base/flow.rb

@@ -37,6 +37,10 @@ module OrigenTesters
           @var_filename || 'global'
         end
 
+        def set_var_filename(new_var_filename)
+          @var_filename = new_var_filename
+        end
+
         def subdirectory
           @subdirectory ||= begin
             if smt8?
@@ -218,6 +222,10 @@ module OrigenTesters
           @post_test_lines = []
           @stack = { on_fail: [], on_pass: [] }
           @set_runtime_variables = ast.excluding_sub_flows.set_flags
+          global_flags.each do |global_var_name|
+            @set_runtime_variables.delete(global_var_name)
+            @set_runtime_variables.delete('$' + global_var_name)
+          end
           process(ast)
           unless smt8?
             unless flow_variables[:empty?]

data/lib/origen_testers/test/interface.rb

@@ -50,6 +50,28 @@ module OrigenTesters
           profile.enables = { ['$MyEnable1'] => [:routine1], ['$MyEnable2'] => [:routine2, :routine3], '$MyEnable3' => :routine5 }
           profile.routines = [:routine1, :routine2, :routine3, :routine4, :routine5, :routine6]
         end
+
+        add_charz_profile :simple_anded_flags do |profile|
+          profile.and_flags = true
+          profile.routines = [:routine1]
+        end
+
+        add_charz_profile :simple_anded_enables do |profile|
+          profile.and_enables = true
+          profile.routines = [:routine1]
+        end
+
+        add_charz_profile :complex_anded_flags do |profile|
+          profile.and_flags = true
+          profile.enables = :my_enable
+          profile.routines = [:routine1]
+        end
+
+        add_charz_profile :complex_anded_enables do |profile|
+          profile.and_enables = true
+          profile.flags = :my_flag
+          profile.routines = [:routine1]
+        end
       end
 
       # Test that the block form of flow control methods like this can

data/program/charz.rb

@@ -7,11 +7,11 @@ Flow.create interface: 'OrigenTesters::Test::Interface' do
 
   if tester.v93k? && tester.smt7?
     charz_on :complex_gates, { on_result: :fail }
-    func_with_charz :func_complex_gates_on_fail
+      func_with_charz :func_complex_gates_on_fail
     charz_off
 
     charz_on :complex_gates, { enables: :my_enable }
-    func_with_charz :func_complex_flag_simple_enable
+      func_with_charz :func_complex_flag_simple_enable
     charz_off
 
     charz_on :complex_gates, { flags: :my_flag } do
@@ -19,17 +19,17 @@ Flow.create interface: 'OrigenTesters::Test::Interface' do
     end
 
     charz_on :cz_only, { placement: :eof }
-    func_with_charz :func_charz_only
+      func_with_charz :func_charz_only
     charz_off
 
     func_with_charz :func_test_level_routine, charz: [:routine1, { type: :routine }]
 
     charz_on :cz
-    func_with_charz :func_skip_group, skip_group: true
-    charz_pause
-    func_with_charz :func_pause_charz
-    charz_resume
-    func_with_charz :func_resume_charz
+      func_with_charz :func_skip_group, skip_group: true
+      charz_pause
+      func_with_charz :func_pause_charz
+      charz_resume
+      func_with_charz :func_resume_charz
     charz_off
 
     charz_on :simple_gates, { on_result: :pass } do 
@@ -43,6 +43,22 @@ Flow.create interface: 'OrigenTesters::Test::Interface' do
     charz_on :simple_gates, { flags: nil }
     func_with_charz :func_simple_enables
     charz_off
-  end
 
+    charz_on :simple_anded_flags, { flags: { routine1: [:my_flag1, :my_flag2]}}
+    func_with_charz :func_simple_anded_flags
+    charz_off
+
+    charz_on :simple_anded_enables, {enables: { routine1: [:my_enable1, :my_enable2]}}
+      func_with_charz :func_simple_anded_enables
+    charz_off
+    
+    charz_on :complex_anded_flags, {flags: { routine1: [:my_flag1, :my_flag2]}}
+      func_with_charz :func_complex_anded_flags
+    charz_off
+
+    charz_on :complex_anded_enables, {enables: { routine1: [:my_enable1, :my_enable2]}}
+      func_with_charz :func_complex_anded_enables
+    charz_off
+
+  end
 end

data/program/flow_control.rb

@@ -309,6 +309,16 @@ Flow.create interface: 'OrigenTesters::Test::Interface', flow_name: "Flow Contro
     test :test2, number: 51470
   end
 
+  log 'Test global flag functionality'
+  add_global_flag :global
+  test :global_test1, on_fail: { set_flag: :$non_global }, continue: true
+  unless_flag "$global" do
+    set_flag '$non_global'
+  end
+  if_flag "$non_global" do
+    set_flag '$global'
+  end
+
   if tester.v93k?
     log "This should retain the set-run-flag in the else conditional"
     func :test22, id: :at22, number: 51480

data/templates/origen_guides/program/charz.md.erb

@@ -48,7 +48,7 @@ end
 Charz profiles contain a collection of routines, as well as test creation meta data related to test placement, production test result dependence, and conditional execution.
 
 The interface adds charz profiles by calling the `add_charz_profile` method. To create a profile that contains previously defined vmin and vmax search routines, whose resulting searches
-only run if the production test failed, and sets the vmax search routine to only run if the 'VmaxEnable' variable is set:
+only run if the production test failed, and sets the vmax search routine to only run if the 'VmaxEnable' variable is set. 
 
 ~~~ruby
 add_charz_profile :fail_searches do |profile|
@@ -59,6 +59,26 @@ add_charz_profile :fail_searches do |profile|
 end
 ~~~
 
+The default behavior for gates is to "OR" them if multiple are defined. The below will result in each routine being nested inside 'my_enable1 or my_enable2'.
+~~~ruby
+add_charz_profile :enables do |profile|
+  profile.name = 'enables'
+  profile.routines = [:vmin, :vmax]
+  profile.enables = [:my_enable1, :my_enable2]
+end
+~~~
+
+The profile can be updated to "AND" together multiple enables or flags. To set up this functionality
+create a hash which maps a routine name to multiple flags and set the corresponding "and_" profile attribute to true.
+~~~ruby
+add_charz_profile :anded_enables do |profile|
+  profile.name = 'anded_enables'
+  profile.routines = [:vmin, :vmax]
+  profile.and_enables = true
+  profile.enables = { vmin: [:overall_enable, :vmin_enable], vmax: [:overall_enable, :vmax_enable]}
+end
+~~~
+
 ### Charz Session
 
 The charz session (stored in your interfaces `@charz_session` attribute) monitors the current state of characterization at a given point in flow generation.

data/templates/origen_guides/program/flowapi.md.erb

@@ -305,6 +305,19 @@ end
 
 In all cases the `$` will be removed from the final flag name that appears in the test program.
 
+Whenever you set a flag or automation initializes a variable, you can remove the variable from initialization flow by labeling as a global flag
+with the `add_global_flag` API. The below example will set the `global` variable in the flow but not initialize it to a value. `non_global` will behave as normal.
+
+~~~ruby
+add_global_flag :global
+test :global_test1, on_fail: { set_flag: :$non_global }, continue: true
+unless_flag "$global" do
+  set_flag '$non_global'
+end
+if_flag "$non_global" do
+  set_flag '$global'
+end
+~~~
 
 
 #### Adding the V93K bypass option:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_testers
 version: !ruby/object:Gem::Version
-  version: 0.51.0
+  version: 0.51.2
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-20 00:00:00.000000000 Z
+date: 2023-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.57.1
+        version: 0.60.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.57.1
+        version: 0.60.7
 - !ruby/object:Gem::Dependency
   name: dentaku
   requirement: !ruby/object:Gem::Requirement
@@ -601,7 +601,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: This plugin provides Origen tester models to drive ATE type testers like