Class: OrigenTesters::IGXLBasedTester::Base

Inherits:
Object
  • Object
show all
Includes:
VectorBasedTester
Defined in:
lib/origen_testers/igxl_based_tester/base.rb,
lib/origen_testers/igxl_based_tester/base/job.rb,
lib/origen_testers/igxl_based_tester/base/edge.rb,
lib/origen_testers/igxl_based_tester/base/flow.rb,
lib/origen_testers/igxl_based_tester/base/jobs.rb,
lib/origen_testers/igxl_based_tester/base/edges.rb,
lib/origen_testers/igxl_based_tester/base/levels.rb,
lib/origen_testers/igxl_based_tester/base/patset.rb,
lib/origen_testers/igxl_based_tester/base/pinmap.rb,
lib/origen_testers/igxl_based_tester/base/edgeset.rb,
lib/origen_testers/igxl_based_tester/base/patsets.rb,
lib/origen_testers/igxl_based_tester/base/patsubr.rb,
lib/origen_testers/igxl_based_tester/base/timeset.rb,
lib/origen_testers/igxl_based_tester/base/edgesets.rb,
lib/origen_testers/igxl_based_tester/base/levelset.rb,
lib/origen_testers/igxl_based_tester/base/patgroup.rb,
lib/origen_testers/igxl_based_tester/base/patsubrs.rb,
lib/origen_testers/igxl_based_tester/base/timesets.rb,
lib/origen_testers/igxl_based_tester/base/flow_line.rb,
lib/origen_testers/igxl_based_tester/base/generator.rb,
lib/origen_testers/igxl_based_tester/base/patgroups.rb,
lib/origen_testers/igxl_based_tester/base/references.rb,
lib/origen_testers/igxl_based_tester/base/ac_specsets.rb,
lib/origen_testers/igxl_based_tester/base/dc_specsets.rb,
lib/origen_testers/igxl_based_tester/base/level_io_se.rb,
lib/origen_testers/igxl_based_tester/base/global_specs.rb,
lib/origen_testers/igxl_based_tester/base/level_supply.rb,
lib/origen_testers/igxl_based_tester/base/test_instance.rb,
lib/origen_testers/igxl_based_tester/base/patset_pattern.rb,
lib/origen_testers/igxl_based_tester/base/test_instances.rb,
lib/origen_testers/igxl_based_tester/base/timesets_basic.rb,
lib/origen_testers/igxl_based_tester/base/patsubr_pattern.rb,
lib/origen_testers/igxl_based_tester/base/test_instance_group.rb,
lib/origen_testers/igxl_based_tester/base/custom_test_instance.rb,
lib/origen_testers/igxl_based_tester/base/test_instances/custom_til.rb

Overview

This is the base class of all IGXL-based testers

Direct Known Subclasses

J750, UltraFLEX

Defined Under Namespace

Modules: Generator Classes: ACSpecsets, CustomTestInstance, DCSpecsets, Edge, Edges, Edgeset, Edgesets, Flow, FlowLine, GlobalSpecs, Job, Jobs, Levels, Levelset, Patgroup, Patgroups, Patset, PatsetPattern, Patsets, Patsubr, PatsubrPattern, Patsubrs, PinLevelSingle, Pinmap, References, SupplyLevel, TestInstance, TestInstanceGroup, TestInstances, Timeset, Timesets, TimesetsBasic

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from VectorBasedTester

#register_tester

Constructor Details

#initialize ⇒ Base

Returns a new IGXLBasedTester instance, normally there would only ever be one of these assigned to the global variable such as $tester by your target.



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 20

def initialize
  @unique_counter = 0
  @counter_lsb_bits = 0
  @counter_msb_bits = 0
  @max_repeat_loop = 65_535 # 16 bits
  @min_repeat_loop = 2
  @pat_extension = 'atp'
  @active_loads = true
  @pipeline_depth = 34
  @software_version = ''
  @compress = true
  @support_repeat_previous = true
  @match_entries = 10
  @name = ''
  @program_comment_char = ['logprint', "'"]
  @opcode_mode = :extended
  @flags = %w(cpuA cpuB cpuC cpuD)
  @microcode = {}
  @microcode[:enable] = 'enable'
  @microcode[:set_flag] = 'set_cpu'
  @microcode[:mask_vector] = 'ign ifc icc'

  @mask_vector = false   # sticky option to mask all subsequent vectors

  @min_pattern_vectors = 0  # no minimum

  @memory_test_en = false  # memory test enabled (for all patterns?)

  @testerconfig ||= {}
  @channelmap ||= {}
end

Instance Attribute Details

#channelmap ⇒ Object

Returns the value of attribute channelmap.



11
12
13
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 11

def channelmap
  @channelmap
end

#default_channelmap ⇒ Object

Returns the value of attribute default_channelmap.



12
13
14
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 12

def default_channelmap
  @default_channelmap
end

#default_testerconfig ⇒ Object

Returns the value of attribute default_testerconfig.



13
14
15
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 13

def default_testerconfig
  @default_testerconfig
end

#max_site ⇒ Object

Returns the value of attribute max_site.



14
15
16
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 14

def max_site
  @max_site
end

#memory_test_en ⇒ Object

Returns the value of attribute memory_test_en.



9
10
11
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 9

def memory_test_en
  @memory_test_en
end

#pattern_compiler_pinmap ⇒ Object

Returns the value of attribute pattern_compiler_pinmap.



8
9
10
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 8

def pattern_compiler_pinmap
  @pattern_compiler_pinmap
end

#software_version ⇒ Object

Returns the value of attribute software_version.



7
8
9
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 7

def software_version
  @software_version
end

#testerconfig ⇒ Object

Returns the value of attribute testerconfig.



10
11
12
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 10

def testerconfig
  @testerconfig
end

Instance Method Details

#apply_digcap_settings(options = {}) ⇒ Object 



883
884
885
886
887
888
889
890
891
892
893
894
895
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 883

def apply_digcap_settings(options = {})
  options.merge!(digcap_width: 8) if options[:digcap_width].nil? # default to digcap 8
  options.merge!(digcap_bit_order: :lsb) if options[:digcap_bit_order].nil? # default to lsb
  options.merge!(digcap_mode: :serial) if options[:digcap_mode].nil? # default to serial mode
  options.merge!(digcap_site_uniqueness: :unique_sites) if options[:digcap_site_uniqueness].nil? # default to unique sites
  options.merge!(digcap_format: :binary) if options[:digcap_format].nil? # default to binary
  options.merge!(digcap_data_type: :default) if options[:digcap_data_type].nil? # default to default
  options.merge!(digcap_auto_cond: :auto_cond_disable) if options[:digcap_auto_cond].nil? # default to disable
  options.merge!(digcap_auto_trig_enable: :auto_trig_disable) if options[:digcap_auto_trig_enable].nil? # default to disable
  options.merge!(digcap_store_stv: :store_stv_disable) if options[:digcap_store_stv].nil? # default to disable
  options.merge!(digcap_receive_data: :store_stv_disable) if options[:digcap_receive_data].nil? # default to logic
  @digcap_settings = options
end

#apply_digsrc_settings(options = {}) ⇒ Object 



872
873
874
875
876
877
878
879
880
881
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 872

def apply_digsrc_settings(options = {})
  options.merge!(digsrc_width: 1) if options[:digsrc_width].nil? # default to digsrc 1
  options.merge!(digsrc_bit_order: :lsb) if options[:digsrc_bit_order].nil? # default to lsb
  options.merge!(digsrc_mode: :serial) if options[:digsrc_mode].nil? # default to serial mode
  options.merge!(digsrc_format: :binary) if options[:digsrc_format].nil? # default to binary
  options.merge!(digsrc_site_uniqueness: :unique_sites) if options[:digsrc_site_uniqueness].nil? # default to unique sites
  options.merge!(digsrc_data_type: :default) if options[:digsrc_data_type].nil? # default to default
  options.merge!(digsrc_auto_cond: :auto_cond_disable) if options[:digsrc_auto_cond].nil? # default to disable
  @digsrc_settings = options
end

#assign_dc_instr_pins(dc_pins) ⇒ Object 



191
192
193
194
195
196
197
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 191

def assign_dc_instr_pins(dc_pins)
  if !dc_pins.is_a?(Array)
    @dc_pins = [] << dc_pins
  else
    @dc_pins = dc_pins
  end
end

#assign_digcap_pins(digcap_pins) ⇒ Object 



207
208
209
210
211
212
213
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 207

def assign_digcap_pins(digcap_pins)
  if !digcap_pins.is_a?(Array)
    @digcap_pins = [] << digcap_pins
  else
    @digcap_pins = digcap_pins
  end
end

#assign_digsrc_pins(digsrc_pins) ⇒ Object 



199
200
201
202
203
204
205
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 199

def assign_digsrc_pins(digsrc_pins)
  if !digsrc_pins.is_a?(Array)
    @digsrc_pins = [] << digsrc_pins
  else
    @digsrc_pins = digsrc_pins
  end
end

#branch_to(label) ⇒ Object Also known as: branch

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")



590
591
592
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 590

def branch_to(label)
  cycle(microcode: "jump #{label}")
end

#call_match ⇒ Object

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 an IGXLBasedTester 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



549
550
551
552
553
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 549

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

#call_subroutine(name, options = {}) ⇒ Object

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)



315
316
317
318
319
320
321
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 315

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

#called_subroutines ⇒ Object

Returns an array of subroutines called while generating the current pattern



735
736
737
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 735

def called_subroutines
  @called_subroutines ||= []
end

#cycle(options = {}) ⇒ Object 



816
817
818
819
820
821
822
823
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 816

def cycle(options = {})
  if @mask_vector
    # tack on masking opcodes
    super(options.merge(microcode: "#{options[:microcode]} #{@microcode[:mask_vector]}"))
  else
    super(options)
  end
end

#digcap_store(pins) ⇒ Object

Call this method before each tester cycle to inser the digcap overlay microcode



868
869
870
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 868

def digcap_store(pins)
  microcode "((#{format_multiple_instrument_pins(pins)}):DigCap = STORE)"
end

#digsrc_send(pins) ⇒ Object

Call this method before each tester cycle to insert the digsrc overlay microcode



863
864
865
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 863

def digsrc_send(pins)
  microcode "((#{format_multiple_instrument_pins(pins)}):DigSrc = SEND)"
end

#digsrc_start(pins, options = {}) ⇒ Object

Call this method at the start of any digsrc overlay operations, this method takes care of all the microcodes and delays that’s needed for digsrc overlay Required arguments:

pins

Optionsal arguments:

options[:dssc_mode] = :single or :dual, anything else wil be
treated as if it's operating in :quad mode



832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 832

def digsrc_start(pins, options = {})
  options = {
    dssc_mode: :single # defaults dssc_mode to single mode
  }.merge(options)
  if pins.size > 1
    microcode "((#{format_multiple_instrument_pins(pins)}):DigSrc = Start)"
  else
    microcode "((#{pin}):DigSrc = Start)"
  end
  if options[:dssc_mode] == :single
    $tester.cycle(repeat: 145) # minimum of 144 cycles, adding 1 for safey measures
  elsif options[:dssc_mode] == :dual
    $tester.cycle(repeat: 289) # minimum of 288 cycles, adding 1 for safety measures
  else
    $tester.cycle(repeat: 577) # minimum of 577 cycles, adding 1 for safety measures
  end
end

#digsrc_stop(pins, options = {}) ⇒ Object

Call this method at the end of each digscr overlay operation to clear the pattern memory pipeline, so that the pattern is ready to do the next digsrc overlay operation. Required arguments:

pins



854
855
856
857
858
859
860
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 854

def digsrc_stop(pins, options = {})
  if pins.size > 1
    microcode "((#{format_multiple_instrument_pins(pins)}):DigSrc = Stop)"
  else
    microcode "((#{pins}):DigSrc = Stop)"
  end
end

#enable_flag(options = {}) ⇒ Object 



794
795
796
797
798
799
800
801
802
803
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 794

def enable_flag(options = {})
  options = { flagnum: 4,      # default flag to use
          }.merge(options)

  if options[:flagnum] > @flags.length
    abort "ERROR! Invalid flag value passed to 'enable_flag' method!\n"
  end
  flagname = @flags[options[:flagnum] - 1]
  update_vector(microcode: "#{@microcode[:enable]}(#{flagname})")
end

#end_subroutine(cond = false) ⇒ Object

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)



346
347
348
349
350
351
352
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 346

def end_subroutine(cond = false)
  if cond
    update_vector microcode: 'if (flag) return'
  else
    update_vector microcode: 'return'
  end
end

#flows ⇒ Object 



227
228
229
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 227

def flows
  parser.flows
end

#format_multiple_instrument_pins(pins, options = {}) ⇒ Object

Call this method if there are more than one pin/pin groups used with an instrument, this method will format an array of pins into the correct format required by igxl pattern microcodes.



900
901
902
903
904
905
906
907
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 900

def format_multiple_instrument_pins(pins, options = {})
  return_value = ''
  pins.each do |pin|
    return_value += "#{pin}"
    return_value += ',' unless pins.last == pin
  end
  return_value
end

#format_vector(vec) ⇒ Object

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



746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 746

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 && ($_testers_enable_vector_comments || vector_comments)
    comment = " // #{vec.number}:#{vec.cycle} #{vec.inline_comment}"
  else
    comment = vec.inline_comment.empty? ? '' : " // #{vec.inline_comment}"
  end

  "#{microcode.ljust(65)}#{timeset.ljust(31)}#{pin_vals}#{comment}"
end

#freq_count(pin, options = {}) ⇒ Object

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)



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 362

def freq_count(pin, options = {})
  options = { readcode: false
            }.merge(options)

  set_code(options[:readcode]) if options[:readcode]
  cycle(microcode: "#{@microcode[:set_flag]} (cpuA)")
  cycle(microcode: "#{@microcode[:set_flag]} (cpuA)")
  cycle(microcode: "#{@microcode[:set_flag]} (cpuB)")
  cycle(microcode: "#{@microcode[:set_flag]} (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: #{@microcode[:enable]} (#{@flags[1]})")
  cycle(microcode: 'if (flag) jump freq_loop_2')
  cycle(microcode: "#{@microcode[:enable]} (#{@flags[2]})")
  cycle(microcode: 'if (flag) jump freq_loop_1')
end

#get_dc_instr_pins ⇒ Object 



215
216
217
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 215

def get_dc_instr_pins
  @dc_pins
end

#get_digcap_pins ⇒ Object 



223
224
225
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 223

def get_digcap_pins
  @digcap_pins
end

#get_digsrc_pins ⇒ Object 



219
220
221
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 219

def get_digsrc_pins
  @digsrc_pins
end

#get_instrument_slots(testconfigname, instrument) ⇒ Object

testconfigname example “WT”, “FT”, “Production”



86
87
88
89
90
91
92
93
94
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 86

def get_instrument_slots(testconfigname, instrument)  # testconfigname example "WT", "FT", "Production"
  @slots = []
  @testerconfig[testconfigname].each_with_index do |element, index|
    if instrument.to_s == element[1][:instrument].to_s
      @slots << element[0].to_i
    end
  end
  @slots  # if no corresponding slot
end

#get_tester_channel(chanmapname, pinname, sitenum) ⇒ Object 



132
133
134
135
136
137
138
139
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 132

def get_tester_channel(chanmapname, pinname, sitenum)
  if sitenum <= @max_site
    @testerchannel = @channelmap[chanmapname][sitenum][pinname].channel
    return @testerchannel
  else
    return nil
  end
end

#get_tester_instrument(testconfigname, slot) ⇒ Object 



77
78
79
80
81
82
83
84
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 77

def get_tester_instrument(testconfigname, slot)
  @testerconfig[testconfigname].each_with_index do |element, index|
    if slot.to_s == element[0].to_s
      return element[1][:instrument]
    end
  end
  nil  # if no corresponding slot
end

#ignore_fails(*pins) ⇒ Object 



788
789
790
791
792
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 788

def ignore_fails(*pins)
  pins.each(&:suspend)
  yield
  pins.each(&:resume)
end

#igxl_based? ⇒ Boolean

Returns:

  • (Boolean) 


52
53
54
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 52

def igxl_based?
  true
end

#import_chanmap(chanmapname, fullchanmappath) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 96

def import_chanmap(chanmapname, fullchanmappath)
  # This function reads IG-XL ChannelMap file
  # chanmapname example ==> "FT", "WT", "FTX2"
  # fullchanmappath example ==> "/product_folder/Chans_FT.txt"

  puts "importing ChannelMap #{fullchanmappath}..."

  chanassignment = Struct.new(:pinname, :site, :channel, :type, :packagepin)
  chanmap_file = Pathname.new(fullchanmappath)
  @channelmap[chanmapname] ||= {}
  File.open(chanmap_file, 'r').each_line.with_index do |line, index|
    if index == 0
      unless line =~ /DTChanMap/
        puts "#{fullchanmappath} is not a valid IG-XL ChannelMap!"
        break
      end
    end
    if index == 5
      siteloc = line.strip.split(/\t/).size - 1 # strip all white spaces and grab second to last
      @max_site_s = line.split(/\t/)[siteloc].strip.split(/\s/)[1]
      @max_site = @max_site_s.to_i
      (0..@max_site).each do |sitenum|
        @channelmap[chanmapname][sitenum] ||= {}
      end
    end
    if index > 5
      (blank1, pinname, packagepin, type) = line.split(/\t/)
      (0..@max_site).each do |sitenum|
        channel = line.split(/\t/)[4 + sitenum].to_s
        @channelmap[chanmapname][sitenum][pinname.downcase.intern] = chanassignment.new(pinname.downcase.intern, sitenum, channel.chomp, type.chomp, packagepin)
      end
    end
  end
  @default_channelmap ||= chanmapname # Default Channelmap gets set if it's not nil
end

#import_tester_config(testconfigname, fullconfigpath) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 56

def import_tester_config(testconfigname, fullconfigpath)
  # This function reads in CurrentConfig.txt file generated by IG-XL.
  # testconfigname example ==> "FT", "WT", "Production"
  # fullconfigpath example ==> "/product_folder/CurrentConfig.txt"

  puts "importing Testerconfig #{testconfigname}..."
  slotnum = Struct.new(:slot, :instrument, :idprom)
  @testerconfig[testconfigname] ||= {}
  current_config_file = Pathname.new(fullconfigpath)
  File.open(current_config_file, 'r').each_line do |line|
    if line =~ /^\d*.0/
      (slot, blank1, instrument, blank2, idprom) = line.split(/\t/)
      if (!slot.nil?) && (!instrument.nil?) && (!idprom.nil?)
        @testerconfig[testconfigname][slot.split('.').first.to_i] = slotnum.new(slot.split('.').first.to_i, instrument, idprom.chomp)
      end
    end
  end

  @default_testerconfig ||= testconfigname  # Default TesterConfig gets set if it's not nil
end

#is_hexvs_plus(testconfigname, slot) ⇒ Object

Check if a specific HexVS supply is HexVS+ variety, which has /-2mV accuracy as opposed to /-7mV accuracy. If the specific HexVS is HexVS+ variety, returns a “+” string, otherwise nil.



157
158
159
160
161
162
163
164
165
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 157

def is_hexvs_plus(testconfigname, slot)
  if @testerconfig[testconfigname][slot][:instrument].to_s == 'HexVS'
    @productnum = @testerconfig[testconfigname][slot][:idprom].split(' ')[0]
    if (@productnum.include?('974-294-')) && (@productnum.split('-')[2].to_i >= 20)
      return '+'
    end
  end
  nil  # if nothing matched
end

#is_vhdvs_hc(chanmapname, pinname, sitenum) ⇒ Object

Check if a specific VHDVS (UVS256) channel assignment is _HC variety (high-current) If the specific VHDVS channel is _HC variety, returns a “_HC” string, otherwise nil.



182
183
184
185
186
187
188
189
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 182

def is_vhdvs_hc(chanmapname, pinname, sitenum)
  if sitenum <= @max_site
    if @channelmap[chanmapname][sitenum][pinname].channel.downcase.include?('hc')
      return '_HC'
    end
  end
  nil  # if nothing matched
end

#is_vhdvs_plus(testconfigname, slot) ⇒ Object

Check if a specific VHDVS (UVS256) supply is High-Accuracy (HA) variety, which has /-5mV0.1%*SUPPLY accuracy as opposed to /-10mV0.1%*SUPPLY accuracy. If the specific VHDVS is of High-Accuracy variety, returns a “+” string, otherwise nil.



170
171
172
173
174
175
176
177
178
179
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 170

def is_vhdvs_plus(testconfigname, slot)
  if @testerconfig[testconfigname][slot][:instrument].to_s == 'VHDVS'
    @productnum = @testerconfig[testconfigname][slot][:idprom].split(' ')[0]
    # binding.pry
    if (@productnum.include?('805-052-')) && (@productnum.split('-')[2].to_i >= 05)
      return '+'
    end
  end
  nil  # if nothing matched
end

#label(name, global = false) ⇒ Object

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



565
566
567
568
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 565

def label(name, global = false)
  global_opt = (global) ? 'global ' : ''
  microcode global_opt + name + ':'
end

#local_subroutines ⇒ Object

Returns an array of subroutines created by the current pattern



740
741
742
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 740

def local_subroutines # :nodoc:
  @local_subroutines ||= []
end

#loop_vectors(name, number_of_loops, global = false, label_first = false) ⇒ Object Also known as: loop_vector

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



608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 608

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

#mask_fails(setclr) ⇒ Object 



909
910
911
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 909

def mask_fails(setclr)
  @mask_vector = setclr
end

#match(pin, state, timeout, options = {}) ⇒ Object

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)



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 486

def match(pin, state, timeout, options = {})
  options = {
    check_for_fails:       false,
    on_timeout_goto:       false,
    pin2:                  false,
    state2:                false,
    on_pin_match_goto:     false,
    multiple_entries:      false,
    force_fail_on_timeout: true,
    global_loops:          false,
    manual_stop:           false,
    clr_fail_post_match:   false
  }.merge(options)
  options[:on_block_match_goto] ||= options.delete(:on_pin_match_goto)

  match_block(timeout, options) do |match_conditions, fail_conditions|
    # Define match conditions
    match_conditions.add do
      state == :low ? pin.expect_lo : pin.expect_hi
      cc "Check if #{pin.name} is #{state == :low ? 'low' : 'high'}"
      cycle
      pin.dont_care
    end

    if options[:pin2]
      match_conditions.add do
        state == :low ? pin.expect_hi : pin.expect_lo
        options[:state2] == :low ? options[:pin2].expect_lo : options[:pin2].expect_hi
        cc "Check if #{options[:pin2].name} is #{options[:state2] == :low ? 'low' : 'high'}"
        cycle
        options[:pin2].dont_care
        pin.dont_care
      end
    end

    # Define fail conditions
    fail_conditions.add do
      state == :low ? pin.expect_lo : pin.expect_hi
      cc "Check if #{pin.name} is #{state == :low ? 'low' : 'high'}"
      if options[:pin2]
        options[:state2] == :low ? options[:pin2].expect_lo : options[:pin2].expect_hi
        cc "Check if #{options[:pin2].name} is #{options[:state2] == :low ? 'low' : 'high'}"
      end
      cycle
      pin.dont_care
      options[:pin2].dont_care if options[:pin2]
    end
  end
end

#memory_test(options = {}) ⇒ Object

  • 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



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 387

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

#merged_channels(chanmapname, pinname, sitenum) ⇒ Object

Check if a specific pin for a given channelmap for a given site number is using merged channel. If yes, return x2 for Merged2, x4 for Merged4, etc. If no, return nil.



143
144
145
146
147
148
149
150
151
152
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 143

def merged_channels(chanmapname, pinname, sitenum)
  if sitenum <= @max_site
    if @channelmap[chanmapname][sitenum][pinname].type.include?('Merged')
      @merged_channels = @channelmap[chanmapname][sitenum][pinname].type.split('Merged')[1]
      return 'x' + @merged_channels
    end
  else
    return nil
  end
end

#parser(prog_dir = Origen.config.test_program_output_directory) ⇒ Object

Main accessor to all content parsed from existing test program sheets found in the supplied directory or in Origen.config.test_program_output_directory



233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 233

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 ||= IGXLBasedTester::Parser.new
  @parsed_dir ||= false
  if @parsed_dir != prog_dir
    @parser.parse(prog_dir)
    @parsed_dir = prog_dir
  end
  @parser
end

#pattern_footer(options = {}) ⇒ Object

An internal method called by Origen to generate the pattern footer



709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 709

def pattern_footer(options = {})
  options = {
    subroutine_pat: false,
    end_in_ka:      false,
    end_with_halt:  false,
    end_module:     true
  }.merge(options)
  $tester.align_to_last
  # cycle(:microcode => "#{$dut.end_of_pattern_label}:") if $dut.end_of_pattern_label
  if options[:end_in_ka]
    $tester.cycle microcode: "#{@microcode[:keepalive]}"
  else
    if options[:end_with_halt]
      $tester.cycle microcode: 'halt'
    else
      if options[:end_module]
        $tester.cycle microcode: 'end_module' unless options[:subroutine_pat]
      else
        $tester.cycle
      end
    end
  end
  microcode '}'
end

#pattern_header(options = {}) {|pin_list| ... } ⇒ Object

An internal method called by Origen Pattern Create to create the pattern header

Yields:

  • (pin_list) 


635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 635

def pattern_header(options = {})
  options = {
    instruments:    {},            # Provide instruments here if desired as a hash (e.g. "mto" => "dgen_2bit")
    subroutine_pat: false,
    svm_only:       true,          # Whether 'svm_only' can be specified
    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 (not yet defined)
    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)

  if level_period?
    microcode "import tset #{min_period_timeset.name};"
  else
    called_timesets.each do |timeset|
      microcode "import tset #{timeset.name};"
    end
  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

  # If memory test, then add to instruments hash
  if options[:memory_test]
    options[:instruments].merge!('mto' => 'dgen_2bit')
  end

  if options[:svm_only]
    microcode "svm_only_file = #{options[:subroutine_pat] ? 'yes' : 'no'};"
  end

  microcode "opcode_mode = #{@opcode_mode};"
  microcode "digital_inst = #{options[:digital_inst]};" if options[:digital_inst]
  microcode 'compressed = yes;' # if $dut.gzip_patterns

  # Take care of any instruments
  if options[:instruments].length > 0
    microcode 'instruments = {'
    options[:instruments].each do |pins, instrument|
      if "#{pins}" == 'nil'
        microcode "               #{instrument};"
      elsif instrument == 'digsrc'
        microcode "               #{pins}:#{instrument} #{options[:digsrc_width]}:#{options[:digsrc_bit_order]}:#{options[:digsrc_mode]}:format=#{options[:digsrc_format]}:#{options[:digsrc_site_uniqueness]}:#{options[:digsrc_auto_cond]};"
      elsif instrument == 'digcap'
        microcode "               #{pins}:#{instrument} #{options[:digcap_width]}:#{options[:digcap_bit_order]}:#{options[:digcap_mode]}:format=#{options[:digcap_format]}:data_type=#{options[:digcap_data_type]}:#{options[:digcap_auto_cond]}:#{options[:digcap_auto_trig_enable]}:#{options[:digcap_store_stv]}:#{options[:digcap_receive_data]};"
      else
        microcode "               #{pins}:#{instrument};"
      end
    end
    microcode '}'
  end

  options[:high_voltage] = @use_hv_pin
  microcode "pin_setup = {#{options[:high_voltage]} high_voltage;}" if options[:high_voltage]
  microcode ''

  pin_list = ordered_pins.map(&:name).join(', ')

  # here indicate pattern header specific stuff
  yield pin_list
  if ordered_pins.size > 0
    max_pin_name_length = ordered_pins.map(&:name).max { |a, b| a.length <=> b.length }.length
    pin_widths = ordered_pins.map { |p| p.size - 1 }

    max_pin_name_length.times do |i|
      cc((' ' * 93) + ordered_pins.map.with_index { |p, x| ((p.name[i] || ' ') + ' ' * pin_widths[x]).gsub('_', '-') }.join(' '))
    end
  end
end

#push_microcode(code) ⇒ Object Also known as: microcode

Override this to force the formatting to match the v1 J750 model (easier diffs)



764
765
766
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 764

def push_microcode(code) # :nodoc:
  stage.store(code.ljust(65) + ''.ljust(31))
end

#remove_store_from_vector(vector) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



296
297
298
299
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 296

def remove_store_from_vector(vector)
  super
  vector.microcode = nil
end

#repeat_previous ⇒ Object

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



781
782
783
784
785
786
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 781

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

#set_code(code) ⇒ Object

  • 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)



579
580
581
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 579

def set_code(code)
  cycle(microcode: "set_code #{code}")
end

#set_flag(options = {}) ⇒ Object 



805
806
807
808
809
810
811
812
813
814
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 805

def set_flag(options = {})
  options = { flagnum: 4,      # default flag to use
          }.merge(options)

  if options[:flagnum] > @flags.length
    abort "ERROR! Invalid flag value passed to 'set_flag' method!\n"
  end
  flagname = @flags[options[:flagnum] - 1]
  update_vector(microcode: "#{@microcode[:set_flag]}(#{flagname})")
end

#start_subroutine(name) ⇒ Object

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



332
333
334
335
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 332

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

#store(*pins) ⇒ Object Also known as: to_hram, capture

Capture a vector to the tester HRAM.

This method applies 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.

Examples:

$tester.cycle                # This is the vector you want to capture
$tester.store                # This applies 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


265
266
267
268
269
270
271
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 265

def store(*pins)
  options = pins.last.is_a?(Hash) ? pins.pop : {}
  options = { offset: 0
            }.merge(options)
  update_vector microcode: 'stv', offset: options[:offset]
  last_vector(options[:offset]).contains_capture = true
end

#store_next_cycle(*pins) ⇒ Object Also known as: store!

Capture the next vector generated to HRAM

This method applies 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.

Examples:

$tester.store_next_cycle
$tester.cycle                # This is the vector that will be captured


285
286
287
288
289
290
291
292
 
# File 'lib/origen_testers/igxl_based_tester/base.rb', line 285

def store_next_cycle(*pins)
  options = pins.last.is_a?(Hash) ? pins.pop : {}
  options = {
  }.merge(options)
  preset_next_vector microcode: 'stv' do |vector|
    vector.contains_capture = true
  end
end