Class: OrigenTesters::IGXLBasedTester::UltraFLEX

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

Defined Under Namespace

Modules: Generator Classes: ACSpecsets, ATEHardware, 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

Attributes inherited from Base

#channelmap, #default_channelmap, #default_testerconfig, #literal_enables, #literal_flags, #max_site, #memory_test_en, #min_repeat_loop, #pattern_compiler_pinmap, #software_version, #testerconfig

Instance Method Summary collapse

Methods inherited from Base

#apply_digcap_settings, #apply_digsrc_settings, #assign_dc_instr_pins, #assign_digcap_pins, #assign_digsrc_pins, #branch_to, #call_subroutine, #called_subroutines, #cycle, #digcap_store, #digsrc_overlay, #digsrc_send, #digsrc_skip_start, #digsrc_start, #digsrc_stop, #enable_flag, #flows, #format_multiple_instrument_pins, #format_vector, #get_dc_instr_pins, #get_digcap_pins, #get_digsrc_pins, #get_instrument_slots, #get_tester_channel, #get_tester_instrument, #ignore_fails, #igxl_based?, #import_chanmap, #import_tester_config, #is_hexvs_plus, #is_vhdvs_hc, #is_vhdvs_plus, #label, #local_subroutines, #mask_fails, #match, #merged_channels, #overlay_style_warn, #parser, #push_instrument, #push_microcode, #remove_store_from_vector, #repeat_previous, #set_flag, #subroutine_overlay

Methods included from VectorBasedTester

#register_tester

Constructor Details

#initialize(options = {}) ⇒ UltraFLEX

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.



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
51
52
53
54
55
56
57
 
# File 'lib/origen_testers/igxl_based_tester/ultraflex.rb', line 25

def initialize(options = {})
  super(options)
  options = { digital_instrument: 'hsdm' }.merge(options)
  @pipeline_depth = 255  # for single mode
  @software_version = '8.10.10'
  @name = 'ultraflex'
  @opcode_mode = :single   # there is also :dual
  @counter_lsb_bits = 16   # individual counter bit length
  @counter_msb_bits = 12   # temporary register commonly used to extend all counters

  @flags = %w(cpuA_cond cpuB_cond cpuC_cond cpuD_cond)
  @microcode[:enable] = 'branch_expr ='
  @microcode[:set_flag] = 'set_cpu_cond'
  @microcode[:mask_vector] = 'mask'

  # Min required for a VM module-- not for SRM modules
  # this handled in pattern_header below
  @min_pattern_vectors = (@opcode_mode == :single) ? 64 : 128

  @digital_instrument = options[:digital_instrument] # 'hsdm' for HSD1000 and UP800, ok with UP1600 though

  @capture_state = 'V'            # STV requires valid 'V' expect data

  @set_msb_issued = false        # Internal flag to keep track of set_msb usage, allowing for set_lsb to be used as a readcode
  @microcode[:keepalive] = 'keepalive'

  @onemodsubs_found = false           # flag to indicate whether a single-module subroutine has been implemented in this pattern
  @nonmodsubs_found = false           # flag to indicate whether a normal non-single-module subroutine has been implemented in this pattern

  @dssc_send_delay = 144
  @dssc_send_delay = 288 if @opcode_mode == :dual
  @dssc_send_delay = 576 if @opcode_mode == :quad
end

Instance Attribute Details

#digital_instrument ⇒ Object

Read or update the digital instrument

Ex: tester.digital_instrument = 'hsdmq'



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

def digital_instrument
  @digital_instrument
end

Instance Method Details

#ate_hardware(instrumentname = '') ⇒ Object

ate_hardware stores “key” UltraFLEX hardware information needed for test program generation Instrument types available for ppmu: “HSD-M”, “HSD-U”, “HSD-4G”, and “HSS-6G”. Sample usage: $tester.ate_hardware(“HSD-U”).ppmu Instrument types available for supply: “VSM”, “VSMx2”, “VSMx4”, “HexVS”, “HexVSx2”, “HexVSx4”, “HexVSx6”, “HexVS+x2”, “HexVS+x4”, “HexVS+x6”, “HDVS1”, “HDVS1x2”, “HDVS1x4”, “VHDVS”, “VHDVS_HC”, “VHDVSx2”, “VHDVS_HCx2”, “VHDVS_HCx4”, “VHDVS_HCx8”, “VHDVS+”, “VHDVS_HC+”, “VHDVS+x2”, “VHDVS_HC+x2”, “VHDVS_HC+x4”, and “VHDVS_HC+x8”. HDVS1 is also known as HDVS. VHDVS is also known as UVS256. x2 is Merged2, x4 is Merged4, x6 is Merged6. _HC is High-Current. + is High-Accuracy. Sample usage: $tester.ate_hardware(“VSM”).supply Sample usage: $tester.ate_hardware(“HSD-M”).ppmu



801
802
803
 
# File 'lib/origen_testers/igxl_based_tester/ultraflex.rb', line 801

def ate_hardware(instrumentname = '')
  @ate_hardware = ATEHardware.new(instrumentname)
end

#call_match ⇒ Object 



166
167
168
169
170
171
 
# File 'lib/origen_testers/igxl_based_tester/ultraflex.rb', line 166

def call_match
  #        fail 'Method call_match not yet supported for UltraFLEX!'
  @match_counter = @match_counter || 0
  call_subroutine("match_done_#{@match_counter}")
  @match_counter += 1 unless @match_counter == (@match_entries || 1) - 1
end

#dssc_store(pins, options) ⇒ Object

use digcap to store, called by tester.store()



717
718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'lib/origen_testers/igxl_based_tester/ultraflex.rb', line 717

def dssc_store(pins, options)
  repeat_count = last_vector(options[:offset]).repeat
  capt_microcode = []
  pins.each do |pin|
    if @capture_history[pin.name].nil?
      @capture_history[pin.name] = { is_digcap: true, count: repeat_count }
    else
      @capture_history[pin.name][:count] += repeat_count
    end
    capt_microcode << "((#{pin.name}):DigCap = Store)"
  end
  capt_microcode << 'stv'
  capt_microcode.join(',')
end

#end_subroutine(cond = false, options = {}) ⇒ Object 



427
428
429
430
431
432
433
 
# File 'lib/origen_testers/igxl_based_tester/ultraflex.rb', line 427

def end_subroutine(cond = false, options = {})
  (cond, options) = false, cond if cond.is_a?(Hash)
  super(cond, options)
  if options[:onemodsub]
    microcode '}'
  end
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)



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/origen_testers/igxl_based_tester/ultraflex.rb', line 67

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

  set_code(options[:readcode]) if options[:readcode]
  cycle(microcode: "#{@microcode[:set_flag]} (#{@flags[0]})") # set cpuA
  cycle(microcode: "#{@microcode[:set_flag]} (#{@flags[0]})") # set cpuB
  cycle(microcode: "#{@microcode[:set_flag]} (#{@flags[1]})") # set cpuC
  cycle(microcode: "#{@microcode[:set_flag]} (#{@flags[2]})") # set cpuD
  cycle(microcode: "freq_loop_1: #{@microcode[:enable]} (#{@flags[0]})")
  cycle(microcode: 'if (branch_expr) jump freq_loop_1')
  pin.drive_lo
  delay(2000)
  pin.dont_care
  cycle(microcode: "freq_loop_2: #{@microcode[:enable]} (#{@flags[1]})")
  cycle(microcode: 'if (branch_expr) jump freq_loop_2')
  cycle(microcode: "#{@microcode[:enable]} (#{@flags[2]})")
  cycle(microcode: 'if (branch_expr) jump freq_loop_1')
end

#handshake(options = {}) ⇒ Object

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



632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
 
# File 'lib/origen_testers/igxl_based_tester/ultraflex.rb', line 632

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]
    set_code(options[:readcode])
  end
  if options[:manual_stop]
    cycle(microcode: "#{@microcode[:enable]} (#{@flags[1]})")
    cycle(microcode: "#{@microcode[:set_flag]} (#{@flags[0]} #{@flags[1]})")
  else
    cycle(microcode: "#{@microcode[:enable]} (#{@flags[0]})")
    cycle(microcode: "#{@microcode[:set_flag]} (#{@flags[0]})")
  end
  cycle(microcode: "loop_here_#{@unique_counter}: if (branch_expr) jump loop_here_#{@unique_counter}")

  @unique_counter += 1  # Increment so a different label will be applied if another
  # handshake is called in the same pattern
end

#keep_alive(options = {}) ⇒ Object 



653
654
655
656
657
658
659
660
661
662
663
664
665
 
# File 'lib/origen_testers/igxl_based_tester/ultraflex.rb', line 653

def keep_alive(options = {})
  if options[:subroutine_pat]
    cycle(microcode: 'clr_subr')
    cycle(microcode: "#{@microcode[:enable]} (#{@flags[3]})")
    cycle(microcode: "#{@microcode[:set_flag]} (#{@flags[3]})")
    cycle(microcode: "loop_here_#{@unique_counter}: if (branch_expr) jump loop_here_#{@unique_counter}")
    cycle
    @unique_counter += 1  # Increment so a different label will be applied if another
  else
    $tester.cycle
    call_subroutine('keep_alive')
  end
end

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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/origen_testers/igxl_based_tester/ultraflex.rb', line 214

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

    if "#{loop_name}" == 'row_loop'
      cycle(microcode: 'loop c0')
    elsif "#{loop_name}" == 'quad_loop'
      cycle(microcode: 'loop c1')
    elsif "#{loop_name}" == 'page_loop_red'
      cycle(microcode: 'loop c2')
    elsif "#{loop_name}" == 'page_loop_ecc'
      cycle(microcode: 'loop c3')
    elsif "#{loop_name}" == 'page_loop_data'
      cycle(microcode: 'loop c4')
    end

    unless label_first
      global_opt = (global) ? 'global ' : ''
      cycle(microcode: "#{global_opt}#{loop_name}: ")
    end
    yield
    cycle(microcode: "end_loop #{loop_name}")
  else
    yield
  end
end

#match_block(timeout, options = {}, &block) ⇒ Object

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:

  • :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) do
  <vectors>
end



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
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
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
 
# File 'lib/origen_testers/igxl_based_tester/ultraflex.rb', line 460

def match_block(timeout, options = {}, &block)
  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

  #        if options[:check_for_fails]
  #          cc 'NOTE: check for fails prior to match loop not necessary on UltraFlex'
  #        end

  #        ss 'WARNING: MATCH LOOP FOR ULTRAFLEX STILL UNDER DEVELOPMENT'

  # Create BlockArgs objects in order to receive multiple blocks
  match_conditions = Origen::Utility::BlockArgs.new
  fail_conditions = Origen::Utility::BlockArgs.new

  # yield object to calling routine to get populated with blocks
  if block.arity > 0
    yield match_conditions, fail_conditions
  else
    # for backwards compatibility with Origen core call to match_block
    match_conditions.add(&block)
    fail_conditions.add(&block)
  end

  if options[:check_for_fails]
    if options[:multiple_entries]
      @match_entries.times do |i|
        microcode "global subr match_done_#{i}:"
        set_code(i + 100)
        cycle(microcode: 'jump call_tester') unless i == @match_entries - 1
      end
      microcode 'call_tester:'
    else
      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'

  cycle # (:microcode => "set_msb #{counter_msb}")  # set_msb microcode will be set below after counting match loop cycles
  set_msb_vector = last_vector # remember the vector with set_msb opcode

  cycle(microcode: 'branch_expr = (fail)')

  global_opt = (options[:global_loops]) ? 'global ' : ''
  microcode "#{global_opt}match_loop_#{@unique_counter}:"

  cycle # (:microcode => "set c0 #{counter_lsb}")
  set_c0_vector = last_vector # remember the vector with set_c0 opcode

  microcode "match_result_loop_#{@unique_counter}:"
  cycle(microcode: 'loop c0')

  # count cycles in match loop block passed to help with meeting
  # desired timeout value (have to back assign microcodes above)
  prematch_cycle_count = cycle_count
  match_conditions.each_with_index do |condition, i|
    mask_fails(true)
    condition.call # match condition
    mask_fails(false)

    cc ' Wait for the result to propagate through the pipeline'
    cycle(microcode: 'pipe_minus 1')
    inc_cycle_count(@pipeline_depth - 1)              # Account for pipeline depth
    cc "Branch if block condition #{i} not yet met"
    cycle(microcode: "if (branch_expr) jump block_#{i}_notyet_matched_#{@unique_counter}")
    cc 'Match found'
    cycle(microcode: 'pop_loop')
    if options[:on_block_match_goto]
      if options[:on_block_match_goto].is_a?(Hash)
        if options[:on_block_match_goto][i]
          custom_jump = options[:on_block_match_goto][i]
        else
          custom_jump = nil
        end
      else
        custom_jump = options[:on_block_match_goto]
      end
    end
    if custom_jump
      cycle(microcode: "jump #{custom_jump}")
    else
      cycle(microcode: "jump match_loop_end_#{@unique_counter}")
    end
    cc 'Match not yet found'
    cycle(microcode: "block_#{i}_notyet_matched_#{@unique_counter}:")
  end

  match_conditions_cycle_count = cycle_count - prematch_cycle_count
  cc "Match loop cycle count = #{match_conditions_cycle_count}"

  # reduce timeout requested by match loop cycle count
  timeout = (timeout.to_f / match_conditions_cycle_count).ceil

  # Calculate the counter values appropriately hit the timeout requested
  match_delay_cycles = false

  # Determine full value of counter0
  counter_value = timeout.to_f.floor

  if counter_value < (2**@counter_lsb_bits)
    # small value, don't need msb temp register
    counter_msb = 1
    counter_lsb = counter_value
  elsif counter_value < (2**(@counter_lsb_bits + @counter_msb_bits))
    # larger value, but smaller than counter maximum
    counter_msb = counter_value   # set MSB (lowest LSB bits get ignored)
    counter_lsb = counter_value & (2**@counter_lsb_bits - 1) # set LSB
  elsif counter_value < (2**(@counter_lsb_bits + @counter_msb_bits)) * @max_repeat_loop
    # larger value, greater than counter, so add time delay per instance of loop to avoid using second counter
    match_delay_cycles = (counter_value.to_f / (2**(@counter_lsb_bits + @counter_msb_bits))).ceil
    counter_msb = (counter_value / match_delay_cycles).floor   # set MSB (lowest LSB bits get ignored)
    counter_lsb = counter_msb & (2**@counter_lsb_bits - 1) # set LSB
  else
    abort 'ERROR: timeout value too large in tester match method!'
  end

  # retroactively modify the counters based on cycles in match loop conditions
  unless @inhibit_vectors
    set_msb_vector.microcode = "set_msb #{counter_msb}"
    set_c0_vector.microcode = "set c0 #{counter_lsb}"
  end

  if match_delay_cycles
    cc 'Delay to meet timeout value'
    cycle(repeat: match_delay_cycles) if match_delay_cycles
  end

  cycle(microcode: "end_loop match_result_loop_#{@unique_counter}")

  if options[:force_fail_on_timeout]
    cc 'To get here something has gone wrong, check blocks again to force a pattern failure'
    fail_conditions.each do |condition|
      cycle(microcode: 'pipe_minus 1')
      condition.call
    end
  end
  if options[:on_timeout_goto]
    cycle(microcode: "jump #{options[:on_timeout_goto]}")
  else
    cycle(microcode: "jump match_loop_end_#{@unique_counter}")
  end
  cycle(microcode: "match_loop_end_#{@unique_counter}:")

  @unique_counter += 1  # Increment so a different label will be applied if another
  # handshake is called in the same pattern
end

#memory_test(options = {}) ⇒ Object 



87
88
89
90
91
92
93
94
95
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/origen_testers/igxl_based_tester/ultraflex.rb', line 87

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)
    use_dgen_group:      false,
    set_msb:             false
  }.merge(options)

  mto_opcode = ''

  if options[:init_counter_x]
    mto_opcode += ' xenable_load jam_reg xa jam_reg'
  end

  if options[:init_counter_y]
    mto_opcode += ' yenable_load jam_reg ya jam_reg'
  end

  if options[:inc_counter_x]
    mto_opcode += ' xa inc'
  end

  if options[:inc_counter_y]
    mto_opcode += ' ya inc'
  end

  if options[:use_dgen_group]
    mto_opcode += ' dgroup 0'
  end

  if options[:set_msb]
    microcode 'set_msb 1'
  end

  unless mto_opcode.eql?('')
    mto_opcode = '(mto =' + mto_opcode + ')'
  end

  if options[:pin_data] == :expect
    mto_opcode = 'stv'
  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}", dont_compress: false)
    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

#pattern_footer(options = {}) ⇒ Object 



392
393
394
395
396
397
398
 
# File 'lib/origen_testers/igxl_based_tester/ultraflex.rb', line 392

def pattern_footer(options = {})
  # if subroutine pattern has any single-module subroutines then skip module end
  # (will be taken care of elsewhere)
  unless options[:subroutine_pat] && @onemodsubs_found
    super(options.merge(end_module: false))
  end
end

#pattern_header(options = {}) ⇒ Object 



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/origen_testers/igxl_based_tester/ultraflex.rb', line 253

def pattern_header(options = {})
  options = {
    instruments: {}
  }.merge(options)

  case $tester.vector_group_size
  when 1
    @opcode_mode = :single
  when 2
    @opcode_mode = :dual
  when 4
    @opcode_mode = :quad
  end

  options[:memory_test] = memory_test_en
  options[:dc_pins] = get_dc_instr_pins
  options[:digsrc_pins] = get_digsrc_pins
  options[:digcap_pins] = get_digcap_pins
  if options[:dc_pins]
    options[:dc_pins].each do |pin|
      options[:instruments].merge!(pin => 'DCVS')
    end
  end

  # Syntax for Digital Source
  # instruments = {
  #   pin-item:digsrc instrument-width: bit-order: instrument-mode:
  #   site-uniqueness: format: auto_cond;
  # }

  if options[:digsrc_pins]
    @digsrc_settings.each do |setting_name, setting|
      options.merge!(setting_name => setting) if options[setting_name].nil?
    end
    options[:digsrc_pins].each do |pin|
      options[:instruments].merge!(pin => 'digsrc')
    end
  end

  # Syntax for Digital Capture
  # instruments = {
  #   pin-item:digcap instrument-width: bit-order: instrument-mode:
  #   format: data-type: auto_cond: auto_trig_enable: store_stv: receive_data;
  # }

  if options[:digcap_pins]
    @digcap_settings.each do |setting_name, setting|
      options.merge!(setting_name => setting) if options[setting_name].nil?
    end
    options[:digcap_pins].each do |pin|
      options[:instruments].merge!(pin => 'digcap')
    end
  end

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

  # If tester.overlay was used to implement digsrc, update the header instruments
  auto_instr = {}
  @overlay_history.each_pair do |pin_name, value|
    if value[:is_digsrc]
      microcode "//   DigSrc SEND count for #{pin_name}: #{value[:count]}"
      new_instr = 'DigSrc '

      # override default settings
      digsrc_overrides = source_memory(:digsrc).accumulate_attributes(pin_name)

      # append instrument width
      digsrc_instr_width = (dut.pin(pin_name)).size
      # override default width if requested
      digsrc_instr_width = digsrc_overrides[:size] unless digsrc_overrides[:size].nil?
      new_instr += digsrc_instr_width.to_s

      # append any other instrument override settings
      if digsrc_instr_width > 1 && (dut.pin(pin_name)).size == 1
        new_instr += ':serial'
        if (digsrc_overrides[:bit_order] != :msb0) && (digsrc_overrides[:bit_order] != :msb)
          new_instr += ':lsb'
        else
          new_instr += ':msb'
        end
      end
      new_instr += ":format=#{digsrc_overrides[:format]}" unless digsrc_overrides[:format].nil?
      new_instr += ":data_type=#{digsrc_overrides[:data_type]}" unless digsrc_overrides[:data_type].nil?
      auto_instr["(#{pin_name})"] = new_instr
    end
  end
  # If tester.store was used to implement digcap, update the header instruments
  # TODO: a lot of duplication of digsrc logic here. This can be smart-ified.
  @capture_history.each_pair do |pin_name, value|
    if value[:is_digcap]
      microcode "//   DigCap Store count for #{pin_name}: #{value[:count]}"
      new_instr = 'DigCap '

      # override default settings
      digcap_overrides = capture_memory(:digcap).accumulate_attributes(pin_name)

      # append instrument width
      digcap_instr_width = (dut.pin(pin_name)).size
      digcap_instr_width = digcap_overrides[:size] unless digcap_overrides[:size].nil?
      new_instr += digcap_instr_width.to_s
      if digcap_instr_width > 1 && (dut.pin(pin_name)).size == 1
        new_instr += ':serial'
        if (digcap_overrides[:bit_order] != :msb0) && (digcap_overrides[:bit_order] != :msb)
          new_instr += ':lsb'
        else
          new_instr += ':msb'
        end
      end
      new_instr += ":format=#{digcap_overrides[:format]}" unless digcap_overrides[:format].nil?
      new_instr += ":data_type=#{digcap_overrides[:data_type]}" unless digcap_overrides[:data_type].nil?
      new_instr += ':auto_trig_enable'			# always enable auto-trigger for digcap, trigger microcode isn't applied
      auto_instr["(#{pin_name})"] = new_instr
    end
  end
  options[:instruments] = options[:instruments].merge(auto_instr)

  super(options.merge(digital_inst: @digital_instrument,
                      memory_test:  false,
                      high_voltage: false,
                      svm_only:     false
                     )) do |pin_list|
    # if subroutine pattern has only single-module subroutines then skip module start
    # (will be taken care of elsewhere)
    unless options[:subroutine_pat] && @onemodsubs_found && !@nonmodsubs_found
      microcode "#{options[:subroutine_pat] ? 'srm_vector' : 'vm_vector'}"
      microcode "#{options[:pattern]} ($tset, #{pin_list})"
      microcode '{'
    end
    # override min vector limit if subroutine pattern
    @min_pattern_vectors = 0 if options[:subroutine_pat]
    unless options[:subroutine_pat]
      microcode "start_label #{options[:pattern]}_st:"
    end
  end
end

#reload_counters(name) ⇒ Object 



732
733
734
 
# File 'lib/origen_testers/igxl_based_tester/ultraflex.rb', line 732

def reload_counters(name)
  microcode "reload #{name}"
end

#set_code(*code) ⇒ Object

Ultraflex implementation of J750-style ‘set_code’

Set a readcode, using one of the Ultraflex general-purpose counters. Counter C15 is used by default, this can be changed by the caller if necessary.

Use to set an explicit readcode for communicating with the tester. This method will generate an additional vector (or 2, depending if set_msb is needed).

NOTE: Some caveats when using this method:

- When setting a counter from the pattern microcode, the actual Patgen counter value is set to n-1.
  This method adjusts by using a value of n+1, so the value read by the tester is the original intended value.

- When setting a counter from pattern microcode, the upper bits must be loaded separately using 'set_msb'.
  This method calls the set_msb opcode if needed - note the tester must mask the upper 16 bits to get the desired value.
  The set_msb opcode will also generate a second vector the first time the set_code method is called.

Examples

$tester.set_code(55)



192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/origen_testers/igxl_based_tester/ultraflex.rb', line 192

def set_code(*code)
  options = code.last.is_a?(Hash) ? code.pop : {}
  options = { counter: 'c15'
            }.merge(options)
  cc " Using counter #{options[:counter]} as set_code replacement - value set to #{code[0]} + 1"
  unless @set_msb_issued
    set_msb(1)
    cycle   # set_msb doesn't issue a cycle
  end
  cycle(microcode: "set #{options[:counter]} #{code[0].next}")   #+1 here to align with VBT
end

#set_code_no_msb(*code) ⇒ Object 



204
205
206
207
208
209
210
211
212
 
# File 'lib/origen_testers/igxl_based_tester/ultraflex.rb', line 204

def set_code_no_msb(*code)
  options = code.last.is_a?(Hash) ? code.pop : {}
  options = { counter: 'c15'
            }.merge(options)
  unless @set_msb_issued
    cycle   # set_msb doesn't issue a cycle
  end
  cycle(microcode: "set #{options[:counter]} #{code[0].next}")   #+1 here to align with VBT
end

#set_msb(integer) ⇒ Object 



736
737
738
 
# File 'lib/origen_testers/igxl_based_tester/ultraflex.rb', line 736

def set_msb(integer)
  microcode "set_msb #{integer}"
end

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

allow for option of separate modules for each subroutine requirement is that any subroutines in their own module (options = true) MUST be implemented AFTER any subroutines in the common pattern module!



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/origen_testers/igxl_based_tester/ultraflex.rb', line 403

def start_subroutine(name, options = {})
  if options[:onemodsub]
    if @nonmodsubs_found && !@onemodsubs_found
      # this means we need to do end module for non-single-module subroutines
      # do only once!
      pattern_footer(options.merge(subroutine_pat: true, end_module: false))
    end
    @onemodsubs_found = true  # importnat put this after the call to pattern_footer above
    pin_list = ordered_pins.map(&:name).join(', ')
    microcode 'srm_vector'
    microcode "#{name}_module ($tset, #{pin_list})"
    microcode '{'
  else
    # normal subroutine to use common
    if @onemodsubs_found
      # give error -- requirement is that any normal subroutines using common pattern module
      # must be done BEFORE any subroutines that need their own module definition!
      fail "ERROR: Cannot implement any common module subroutines (#{name}) after implementing any single-module subroutines in the same pattern!"
    end
    @nonmodsubs_found = true
  end
  super(name, options)
end

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

Capture a vector to the tester HRAM.

This method applys a store vector (stv) opcode to the previous vector, note that is does not actually generate a new vector.

Sometimes when generating vectors within a loop you may want to apply a stv opcode retrospectively to a previous vector, passing in an offset option will allow you to do this.

On J750 the pins argument is ignored since the tester only supports whole vector capture.

Examples:

$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


686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'lib/origen_testers/igxl_based_tester/ultraflex.rb', line 686

def store(*pins)
  return if @inhibit_vectors
  options = pins.last.is_a?(Hash) ? pins.pop : {}
  options = { offset: 0,
              opcode: 'stv'
            }.merge(options)
  pins = pins.flatten.compact
  if pins.empty?
    fail 'For the UltraFLEX you must supply the pins to store/capture'
  end

  capt_style = options[:capture_style].nil? ? @capture_style : options[:capture_style]
  if capt_style == :digcap
    capt_microcode = dssc_store(pins, options)
  else
    capt_microcode = options[:opcode]
  end

  pins.each do |pin|
    pin.restore_state do
      pin.capture
      update_vector_pin_val pin, offset: options[:offset]
      last_vector(options[:offset]).dont_compress = true
    end
  end
  update_vector microcode: capt_microcode, offset: options[:offset]
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.

pin argument must be provided so that ‘V’ (valid) state can be applied to the pin if not already.

Examples:

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


751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
 
# File 'lib/origen_testers/igxl_based_tester/ultraflex.rb', line 751

def store_next_cycle(*pins)
  return if @inhibit_vectors
  options = pins.last.is_a?(Hash) ? pins.pop : {}
  options = {
    opcode: 'stv'
  }.merge(options)
  pins = pins.flatten.compact
  if pins.empty?
    fail 'For the UltraFLEX you must supply the pins to store/capture'
  end

  capt_style = options[:capture_style].nil? ? @capture_style : options[:capture_style]
  if capt_style == :digcap
    capt_microcode = []
    repeat_count = options[:repeat].nil? ? 1 : options[:repeat]
    pins.each do |pin|
      if @capture_history[pin.name].nil?
        @capture_history[pin.name] = { is_digcap: true, count: repeat_count }
      else
        @capture_history[pin.name][:count] += repeat_count
      end
      capt_microcode << "((#{pin.name}):DigCap = Store)"
    end
    capt_microcode << 'stv'
    capt_microcode = capt_microcode.join(',')
  else
    capt_microcode = options[:opcode]
  end

  pins.each { |pin| pin.save; pin.capture }
  # Register this clean up function to be run after the next vector
  # is generated (SMcG: cool or what! DH: Yes, very cool!)
  preset_next_vector(microcode: capt_microcode) do
    pins.each(&:restore)
  end
end