Class: OrigenLink::VectorBased

Inherits:
Object
  • Object
show all
Includes:
CaptureSupport, ConfigurationCommands, ServerCom, OrigenTesters::VectorBasedTester
Defined in:
lib/origen_link/vector_based.rb

Overview

OrigenLink::VectorBased

This class is meant to be used for live silicon debug.  Vector data that Origen
generates is intercepted and sent to a debug device (typically will be a Udoo
Neo - www.udoo.org).  The debug device can be any device that is able to serve
a TCP socket, recieve and interpret the command set used by this class and send
the expected responses.

Integration instructions

Set the pin map (must be done first) and pin order
  if tester.link?
     tester.pinmap = 'tclk,26,tms,19,tdi,16,tdo,23'
     tester.pinorder = 'tclk,tms,tdi,tdo'
  end

Set Origen to only generate vectors for pins in the pinmap (order should match)
     pin_pattern_order :tclk, :tms, :tdi, :tdo, only: true if tester.link?

At the beginning of the Startup method add this line
   tester.initialize_pattern if tester.link?

At the end of the Shutdown method add this line
  tester.finalize_pattern if tester.link?

Create a link environment with the IP address and socket number of a link server
  $tester = OrigenLink::VectorBased.new('192.168.0.2', 12777)

Direct Known Subclasses

Test::VectorBased

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ConfigurationCommands

#get_tset_number, #pinformat=, #pinmap=, #pinorder=, #pintiming=, #replace_tset_name_w_number

Methods included from CaptureSupport

#capture, #store, #store_next_cycle

Methods included from ServerCom

#send_batch, #send_cmd, #setup_cmd_response_logger

Constructor Details

#initialize(address, port, options = {}) ⇒ VectorBased

Returns a new instance of VectorBased.



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/origen_link/vector_based.rb', line 43

def initialize(address, port, options = {})
  @address = address
  @port = port
  @fail_count = 0
  @vector_count = 0
  @previous_vectordata = ''
  @previous_tset = ''
  @vector_repeatcount = 0
  @total_comm_time = 0
  @total_connect_time = 0
  @total_xmit_time = 0
  @total_recv_time = 0
  @total_packets = 0
  @max_packet_time = 0
  @max_receive_time = 0
  @tsets_programmed = {}
  @tset_count = 1
  @store_pins = []
  @captured_data = []
  # A tester seems to be unable to register as a callback handler, so for now instantiating a
  # dedicated object to implement the handlers related to this tester
  CallbackHandlers.new
  @vector_batch = []
  @store_pins_batch = {}
  @comment_batch = {}
  @batch_vectors = true
  @pattern_link_messages = []
  @pattern_comments = {}
end

Instance Attribute Details

#captured_data ⇒ Object (readonly)

Returns the value of attribute captured_data.



40
41
42
 
# File 'lib/origen_link/vector_based.rb', line 40

def captured_data
  @captured_data
end

#comment_batch ⇒ Object (readonly)

Returns the value of attribute comment_batch.



41
42
43
 
# File 'lib/origen_link/vector_based.rb', line 41

def comment_batch
  @comment_batch
end

#fail_count ⇒ Object (readonly)

these attributes are exposed for testing purposes, a user would not need to read them



39
40
41
 
# File 'lib/origen_link/vector_based.rb', line 39

def fail_count
  @fail_count
end

#store_pins_batch ⇒ Object (readonly)

Returns the value of attribute store_pins_batch.



41
42
43
 
# File 'lib/origen_link/vector_based.rb', line 41

def store_pins_batch
  @store_pins_batch
end

#total_comm_time ⇒ Object (readonly)

these attributes are exposed for testing purposes, a user would not need to read them



39
40
41
 
# File 'lib/origen_link/vector_based.rb', line 39

def total_comm_time
  @total_comm_time
end

#total_connect_time ⇒ Object (readonly)

these attributes are exposed for testing purposes, a user would not need to read them



39
40
41
 
# File 'lib/origen_link/vector_based.rb', line 39

def total_connect_time
  @total_connect_time
end

#total_packets ⇒ Object (readonly)

Returns the value of attribute total_packets.



40
41
42
 
# File 'lib/origen_link/vector_based.rb', line 40

def total_packets
  @total_packets
end

#total_recv_time ⇒ Object (readonly)

Returns the value of attribute total_recv_time.



40
41
42
 
# File 'lib/origen_link/vector_based.rb', line 40

def total_recv_time
  @total_recv_time
end

#total_xmit_time ⇒ Object (readonly)

these attributes are exposed for testing purposes, a user would not need to read them



39
40
41
 
# File 'lib/origen_link/vector_based.rb', line 39

def total_xmit_time
  @total_xmit_time
end

#tsets_programmed ⇒ Object (readonly)

Returns the value of attribute tsets_programmed.



40
41
42
 
# File 'lib/origen_link/vector_based.rb', line 40

def tsets_programmed
  @tsets_programmed
end

#vector_batch ⇒ Object (readonly)

Returns the value of attribute vector_batch.



41
42
43
 
# File 'lib/origen_link/vector_based.rb', line 41

def vector_batch
  @vector_batch
end

#vector_count ⇒ Object (readonly)

these attributes are exposed for testing purposes, a user would not need to read them



39
40
41
 
# File 'lib/origen_link/vector_based.rb', line 39

def vector_count
  @vector_count
end

#vector_repeatcount ⇒ Object (readonly)

Returns the value of attribute vector_repeatcount.



40
41
42
 
# File 'lib/origen_link/vector_based.rb', line 40

def vector_repeatcount
  @vector_repeatcount
end

Instance Method Details

#finalize_pattern(output_file) ⇒ Object

finalize_pattern

This method flushes the final vector.  Then, it logs success or failure of the
pattern execution along with execution time information.



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
 
# File 'lib/origen_link/vector_based.rb', line 288

def finalize_pattern(output_file)
  Origen.log.debug('Pattern generation completed. Sending all stored vector data')
  synchronize(output_file)
  # for debug, report communication times
  Origen.log.debug("total communication time: #{@total_comm_time}")
  Origen.log.debug("total connect time: #{@total_connect_time}")
  Origen.log.debug("total transmit time: #{@total_xmit_time}")
  Origen.log.debug("total receive time: #{@total_recv_time}")
  Origen.log.debug("total packets: #{@total_packets}")
  Origen.log.debug("total time per packet: #{@total_comm_time / @total_packets}")
  Origen.log.debug("connect time per packet: #{@total_connect_time / @total_packets}")
  Origen.log.debug("transmit time per packet: #{@total_xmit_time / @total_packets}")
  Origen.log.debug("receive time per packet: #{@total_recv_time / @total_packets}")
  Origen.log.debug("max packet time: #{@max_packet_time}")
  Origen.log.debug("max duration command - #{@longest_packet}")
  Origen.log.debug("max receive time: #{@max_receive_time}")
  if @fail_count == 0
    # Origen.log.success("PASS - pattern execution passed (#{@vector_count} vectors pass)")
    Origen.app.stats.report_pass
  else
    # Origen.log.error("FAIL - pattern execution failed (#{@fail_count} failures)")
    Origen.app.stats.report_fail
  end
  commands_file = Origen.app.current_job.output_file.split('.')[0] + '_link_cmds.txt'
  File.open(commands_file, 'w') do |file|
    file.puts("pin_assign:#{@pinmap}")
    file.puts("pin_patternorder:#{@pinorder}")
    @pattern_link_messages.each_index do |index|
      file.puts(@pattern_link_messages[index])
      file.puts(@pattern_comments[index]) if @pattern_comments.key?(index)
    end
  end
end

#flush_vector(programmed_data = '', tset = '') ⇒ Object

flush_vector

Just as the name suggests, this method "flushes" a vector.  This is necessary because
of repeat compression (a vector isn't sent until different vector data is encountered)

Don't forget to flush when you're in debug mode.  Otherwise, the last vector of a
write command won't be sent to the server.



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
 
# File 'lib/origen_link/vector_based.rb', line 128

def flush_vector(programmed_data = '', tset = '')
  # prevent server crash when vector_flush is used during debug
  unless @previous_vectordata == ''
    if @vector_repeatcount > 1
      repeat_prefix = "repeat#{@vector_repeatcount},"
    else
      repeat_prefix = ''
    end
    if @tsets_programmed[@previous_tset]
      tset_prefix = "tset#{@tsets_programmed[@previous_tset]},"
    else
      tset_prefix = ''
    end

    if @batch_vectors
      @vector_batch << 'pin_cycle:' + tset_prefix + repeat_prefix + @previous_vectordata
      # store capture pins for batch processing
      unless @store_pins.empty?
        @store_pins_batch[@vector_batch.length - 1] = @store_pins
      end
    else
      process_vector_response(send_cmd('pin_cycle', tset_prefix + repeat_prefix + @previous_vectordata))
    end

    # make sure that only requested vectors are stored when batching is enabled
    @store_pins = []
  end

  @vector_repeatcount = 1
  @previous_vectordata = programmed_data
  @previous_tset = tset
end

#initialize_pattern ⇒ Object

initialize_pattern

This method sets initializes variables at the start of a pattern.
it is called automatically when pattern generation starts.



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/origen_link/vector_based.rb', line 263

def initialize_pattern
  @fail_count = 0
  @vector_count = 0
  @vector_batch.delete_if { true }
  @store_pins_batch.clear
  @comment_batch.clear
  @pattern_link_messages.delete_if { true }
  @pattern_comments.clear

  @total_packets = 0
  @total_comm_time = 0
  @total_connect_time = 0
  @total_xmit_time = 0
  @total_recv_time = 0

  if @pinmap.nil?
    Origen.log.error('pinmap has not been setup, use tester.pinmap= to initialize a pinmap')
  else
    Origen.log.debug('executing pattern with pinmap:' + @pinmap.to_s)
  end
end

#process_response(response, output_file = '') ⇒ Object

process_response

This method will process a server response.  Send log info to the output,
keep track of fail count and captured data



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/origen_link/vector_based.rb', line 177

def process_response(response, output_file = '')
  if response.is_a?(Array)
    # if called from finalize_pattern -> synchronize, open the output_file and store results
    output_obj = nil
    output_obj = File.open(output_file, 'a+') unless output_file == ''

    # in case there were only comments and no vectors, place comments (if any)
    microcode @comment_batch[0] if response.size == 0

    response.each_index do |index|
      # restore store pins state for processing
      if @store_pins_batch.key?(index)
        @store_pins = @store_pins_batch[index]
      else
        @store_pins = []
      end
      process_vector_response(response[index], output_obj)
      if @comment_batch.key?(index)
        if output_file == ''
          microcode @comment_batch[index]
        else
          # get the header placed correctly, the below code doesn't work
          # if index == response.length - 1
          #   output_obj.puts 'last comment'
          #   output_obj.lineno = 0
          # end
          output_obj.puts(@comment_batch[index])
        end
      end
    end
    output_obj.close unless output_file == ''
  else
    process_vector_response(response)
  end
end

#process_vector_response(vector_response, output_obj = nil) ⇒ Object

process_vector_response

This method exists to prevent code duplication when handling an array of
batched responses versus a single response string.



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
250
251
252
253
254
255
256
257
258
 
# File 'lib/origen_link/vector_based.rb', line 216

def process_vector_response(vector_response, output_obj = nil)
  unless @store_pins.empty?
    msg = "  (Captured #{@store_pins.map(&:name).join(', ')})\n"
    capture_data(vector_response)
    vector_response.strip!
    vector_response += msg
  end
  vector_cycles = vector_response.split(/\s+/)
  expected_msg = ''
  expected_msg = ' ' + vector_cycles.pop if vector_cycles[vector_cycles.length - 1] =~ /Expected/
  pfstatus = vector_cycles[0].chr
  vector_cycles[0] = vector_cycles[0].byteslice(2, vector_cycles[0].length - 2)

  vector_cycles.each do |cycle|
    thiscyclefail = false
    if pfstatus == 'F'
      # check to see if this cycle failed
      0.upto(cycle.length - 1) do |index|
        thiscyclefail = true if (cycle[index] == 'H') && (expected_msg[expected_msg.length - cycle.length + index] == 'L')
        thiscyclefail = true if (cycle[index] == 'L') && (expected_msg[expected_msg.length - cycle.length + index] == 'X')
      end
    end
    if thiscyclefail
      expected_msg_prnt = expected_msg
      prepend = 'F:'
    else
      expected_msg_prnt = ''
      prepend = 'P:'
    end

    if output_obj.nil?
      microcode prepend + cycle + expected_msg_prnt
    else
      output_obj.puts(prepend + cycle + expected_msg_prnt)
    end
  end

  unless vector_response.chr == 'P'
    # TODO: Put this back with an option to disable, based on a serial or parallel interface being used
    # microcode 'E:' + @previous_vectordata + ' //expected data for previous vector'
    @fail_count += 1
  end
end

#push_comment(msg) ⇒ Object

push_comment

This method intercepts comments so they can be correctly placed in the output file
when vector batching is used



76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/origen_link/vector_based.rb', line 76

def push_comment(msg)
  if @batch_vectors
    key = @vector_batch.length
    if @comment_batch.key?(key)
      @comment_batch[key] = @comment_batch[key] + "\n" + msg
    else
      @comment_batch[key] = msg
    end
    pattern_key = @pattern_link_messages.length + key
    @pattern_comments[pattern_key] = @comment_batch[key]
  else
    microcode msg
  end
end

#push_vector(options) ⇒ Object

push_vector

This method intercepts vector data from Origen, removes white spaces and compresses repeats



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
 
# File 'lib/origen_link/vector_based.rb', line 93

def push_vector(options)
  programmed_data = options[:pin_vals].gsub(/\s+/, '')
  unless options[:timeset]
    puts 'No timeset defined!'
    puts 'Add one to your top level startup method or target like this:'
    puts '$tester.set_timeset("nvmbist", 40)   # Where 40 is the period in ns'
    exit 1
  end
  tset = options[:timeset].name
  if @vector_count > 0
    # compressing repeats as we go
    if (programmed_data == @previous_vectordata) && (@previous_tset == tset) && @store_pins.empty?
      @vector_repeatcount += 1
    else
      # all repeats of the previous vector have been counted
      # time to flush.  Don't panic though!  @previous_vectordata
      # is what gets flushed.  programmed_data is passed as an
      # arg to be set as the new @previous_vectordata
      flush_vector(programmed_data, tset)
    end
  else
    # if this is the first vector of the pattern, insure variables are initialized
    @previous_vectordata = programmed_data
    @previous_tset = tset
    @vector_repeatcount = 1
  end # if vector_count > 0
  @vector_count += 1
end

#synchronize(output_file = '') ⇒ Object

synchronize

This method will synchronize the DUT state with Origen.  All generated
vectors are sent to the DUT for execution and the responses are processed



164
165
166
167
168
169
170
171
172
 
# File 'lib/origen_link/vector_based.rb', line 164

def synchronize(output_file = '')
  flush_vector
  if @batch_vectors
    process_response(send_batch(@vector_batch), output_file)
  end
  @vector_batch = []
  @store_pins_batch.clear
  @comment_batch.clear
end

#to_s ⇒ Object

to_s

returns 'Origen::VectorBased'

This method at the moment is used for implementing code that runs only if the
environment is set to link vector based.  tester.link? will be used once the testers
plug in supports the method link?.



328
329
330
 
# File 'lib/origen_link/vector_based.rb', line 328

def to_s
  'OrigenLink::VectorBased'
end

#transaction ⇒ Object

transaction

returns true/false indicating whether the transaction passed
true = pass
false = fail

TODO: capture transaction vector data and response for use in debug

if !tester.transaction blah blah

puts 'transaction failed'

end



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/origen_link/vector_based.rb', line 342

def transaction
  if block_given?
    synchronize
    transaction_fail_count = @fail_count
    yield
    synchronize
    transaction_fail_count = @fail_count - transaction_fail_count
    if transaction_fail_count == 0
      true
    else
      false
    end
  else
    true
  end
end