Module: OrigenTesters::API
- Defined in:
- lib/origen_testers/api.rb
Overview
This module implements the basic set of methods that a tester must have in order for Origen to talk to it.
They can be overridden by tester specific classes and who may go on to add additional methods of their own.
Essentially this API means that any class that includes Origen::Tester will function as a tester, although it might not do very much!
Instance Attribute Summary collapse
-
#comment_level ⇒ Object
Returns the value of attribute comment_level.
-
#generating ⇒ Object
Returns the value of attribute generating.
-
#includes ⇒ Object
Returns the value of attribute includes.
Instance Method Summary collapse
- #annotate(msg, options = {}) ⇒ Object
- #any_clocks_running? ⇒ Boolean
-
#c1(msg, options = {}) ⇒ Object
Output a comment in the pattern, normally you would not call this directly and instead use these shorthand methods: cc “Some comment” ss “A single line step comment” step_comment do cc “A multi line” cc “step comment” end.
- #c2(msg, options = {}) ⇒ Object
- #clocks_running ⇒ Object (also: #running_clocks)
- #comment_char ⇒ Object
-
#cycle(options = {}) ⇒ Object
Generate a vector.
- #diff_friendly_output=(value) ⇒ Object
- #diff_friendly_output? ⇒ Boolean (also: #diff_friendly_output)
- #doc? ⇒ Boolean
- #generate? ⇒ Boolean
- #generating_pattern? ⇒ Boolean
- #generating_program? ⇒ Boolean
-
#ignore_fails(*pins) ⇒ Object
Ignore fails on the given pins for the duration of the given block, this has the effect of temporarily setting the states of the given pins to don’t care.
- #import_test_time(file, options = {}) ⇒ Object
-
#inhibit_vectors_and_comments ⇒ Object
Allows a section to be run without actually generating any vectors.
- #is_command_based? ⇒ Boolean
- #is_vector_based? ⇒ Boolean
- #j750? ⇒ Boolean
- #j750_hpt? ⇒ Boolean
- #link? ⇒ Boolean
- #name ⇒ Object
- #pat_extension ⇒ Object (also: #pattern_extension)
- #pattern_footer(*args) ⇒ Object
- #pattern_header(*args) ⇒ Object
- #pattern_section(msg) ⇒ Object
- #pins_need_toggling ⇒ Object
- #pop_running_clock(pin) ⇒ Object
- #program_comment_char ⇒ Object
- #push_running_clock(pin) ⇒ Object
- #slice_repeats(options = {}) ⇒ Object
- #snip(number, options = {}) ⇒ Object
- #ss(msg = nil) ⇒ Object
- #step_comment_prefix ⇒ Object
- #ultraflex? ⇒ Boolean (also: #uflex?)
- #update_running_clocks ⇒ Object
- #v93k? ⇒ Boolean
Instance Attribute Details
#comment_level ⇒ Object
Returns the value of attribute comment_level.
12 13 14 |
# File 'lib/origen_testers/api.rb', line 12 def comment_level @comment_level end |
#generating ⇒ Object
Returns the value of attribute generating.
13 14 15 |
# File 'lib/origen_testers/api.rb', line 13 def @generating end |
#includes ⇒ Object
Returns the value of attribute includes.
11 12 13 |
# File 'lib/origen_testers/api.rb', line 11 def includes @includes end |
Instance Method Details
#annotate(msg, options = {}) ⇒ Object
88 89 |
# File 'lib/origen_testers/api.rb', line 88 def annotate(msg, = {}) end |
#any_clocks_running? ⇒ Boolean
215 216 217 |
# File 'lib/origen_testers/api.rb', line 215 def any_clocks_running? @clocks_running.nil? ? false : @clocks_running.count > 0 end |
#c1(msg, options = {}) ⇒ Object
Output a comment in the pattern, normally you would not call this directly and instead use these shorthand methods:
cc "Some comment"
ss "A single line step comment"
step_comment do
cc "A multi line"
cc "step comment"
end
117 118 119 120 121 |
# File 'lib/origen_testers/api.rb', line 117 def c1(msg, = {}) prefix = comment_char + ' ' prefix += step_comment_prefix + ' ' if @step_comment_on push_comment(prefix + msg.to_s) end |
#c2(msg, options = {}) ⇒ Object
123 124 125 |
# File 'lib/origen_testers/api.rb', line 123 def c2(msg, = {}) c1(msg, ) end |
#clocks_running ⇒ Object Also known as: running_clocks
219 220 221 |
# File 'lib/origen_testers/api.rb', line 219 def clocks_running @clocks_running end |
#comment_char ⇒ Object
36 37 38 |
# File 'lib/origen_testers/api.rb', line 36 def comment_char @comment_char || '//' end |
#cycle(options = {}) ⇒ Object
Generate a vector. Calling this method will generate a vector in the output pattern based on the current pin states and timeset.
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 |
# File 'lib/origen_testers/api.rb', line 177 def cycle( = {}) = { microcode: '', timeset: current_timeset, pin_vals: current_pin_vals, repeat: nil }.merge() if any_clocks_running? update_running_clocks if [:repeat] slice_repeats().each do |slice| [:repeat] = slice[0] delay(.delete(:repeat), ) do || push_vector() end slice[1].each { |clock_pin_name| clocks_running[clock_pin_name].toggle_clock } [:pin_vals] = current_pin_vals end else push_vector() pins_need_toggling.each { |clock_pin_name| clocks_running[clock_pin_name].toggle_clock } end else if [:repeat] delay(.delete(:repeat), ) do || push_vector() end else push_vector() end end end |
#diff_friendly_output=(value) ⇒ Object
91 92 93 |
# File 'lib/origen_testers/api.rb', line 91 def diff_friendly_output=(value) @diff_friendly_output = value end |
#diff_friendly_output? ⇒ Boolean Also known as: diff_friendly_output
95 96 97 |
# File 'lib/origen_testers/api.rb', line 95 def diff_friendly_output? !!@diff_friendly_output end |
#doc? ⇒ Boolean
84 85 86 |
# File 'lib/origen_testers/api.rb', line 84 def doc? false end |
#generate? ⇒ Boolean
19 20 21 |
# File 'lib/origen_testers/api.rb', line 19 def generate? true end |
#generating_pattern? ⇒ Boolean
23 24 25 |
# File 'lib/origen_testers/api.rb', line 23 def @generating == :pattern end |
#generating_program? ⇒ Boolean
27 28 29 |
# File 'lib/origen_testers/api.rb', line 27 def @generating == :program end |
#ignore_fails(*pins) ⇒ Object
Ignore fails on the given pins for the duration of the given block, this has the effect of temporarily setting the states of the given pins to don’t care.
103 104 105 106 107 |
# File 'lib/origen_testers/api.rb', line 103 def ignore_fails(*pins) pins.each(&:suspend) yield pins.each(&:resume) end |
#import_test_time(file, options = {}) ⇒ Object
211 212 213 |
# File 'lib/origen_testers/api.rb', line 211 def import_test_time(file, = {}) puts "Sorry but an importer doesn't exist for: #{Origen.tester.class}" end |
#inhibit_vectors_and_comments ⇒ Object
Allows a section to be run without actually generating any vectors. This can be useful to ensure the pin states end up as they otherwise would have if the section had been run. Classic example of this is a subroutine pattern, wrap this around a call to the startup routine to ensure the pin states are as they would have been immediately after the startup.
Example
# Setup state as if I had run startup without actually doing so
$tester.inhibit_vectors_and_comments do
$soc.startup
$top.startup
end
164 165 166 167 168 169 170 171 172 |
# File 'lib/origen_testers/api.rb', line 164 def inhibit_vectors_and_comments inhibit_vectors = @inhibit_vectors inhibit_comments = @inhibit_comments @inhibit_vectors = true @inhibit_comments = true yield @inhibit_vectors = inhibit_vectors # Restore to their initial state @inhibit_comments = inhibit_comments end |
#is_command_based? ⇒ Boolean
59 60 61 |
# File 'lib/origen_testers/api.rb', line 59 def is_command_based? !is_vector_based? end |
#is_vector_based? ⇒ Boolean
54 55 56 57 |
# File 'lib/origen_testers/api.rb', line 54 def is_vector_based? return @vector_based if defined?(@vector_based) true end |
#j750? ⇒ Boolean
63 64 65 |
# File 'lib/origen_testers/api.rb', line 63 def j750? is_a?(OrigenTesters::IGXLBasedTester::J750) end |
#j750_hpt? ⇒ Boolean
67 68 69 |
# File 'lib/origen_testers/api.rb', line 67 def j750_hpt? is_a?(OrigenTesters::IGXLBasedTester::J750_HPT) end |
#link? ⇒ Boolean
80 81 82 |
# File 'lib/origen_testers/api.rb', line 80 def link? !!(self.class.to_s =~ /^OrigenLink::/) end |
#name ⇒ Object
15 16 17 |
# File 'lib/origen_testers/api.rb', line 15 def name @name || self.class end |
#pat_extension ⇒ Object Also known as: pattern_extension
31 32 33 |
# File 'lib/origen_testers/api.rb', line 31 def pat_extension @pat_extension || 'txt' end |
#pattern_footer(*args) ⇒ Object
47 48 |
# File 'lib/origen_testers/api.rb', line 47 def (*args) end |
#pattern_header(*args) ⇒ Object
44 45 |
# File 'lib/origen_testers/api.rb', line 44 def pattern_header(*args) end |
#pattern_section(msg) ⇒ Object
127 128 129 130 131 132 133 134 |
# File 'lib/origen_testers/api.rb', line 127 def pattern_section(msg) if yield else step_comment(msg) yield end end |
#pins_need_toggling ⇒ Object
257 258 259 260 261 262 263 |
# File 'lib/origen_testers/api.rb', line 257 def pins_need_toggling toggle_ary = [] clocks_running.each do |name, clock_pin| toggle_ary.push("#{name}") if clock_pin.next_edge == cycle_count end toggle_ary end |
#pop_running_clock(pin) ⇒ Object
228 229 230 231 |
# File 'lib/origen_testers/api.rb', line 228 def pop_running_clock(pin) fail "ERROR: No clocks running, doesn't make sense to pop one" unless any_clocks_running? @clocks_running.delete(pin.name.to_s) end |
#program_comment_char ⇒ Object
40 41 42 |
# File 'lib/origen_testers/api.rb', line 40 def program_comment_char @program_comment_char || comment_char end |
#push_running_clock(pin) ⇒ Object
224 225 226 |
# File 'lib/origen_testers/api.rb', line 224 def push_running_clock(pin) @clocks_running.nil? ? @clocks_running = { pin.name.to_s => pin } : @clocks_running[pin.name.to_s] = pin end |
#slice_repeats(options = {}) ⇒ Object
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'lib/origen_testers/api.rb', line 233 def slice_repeats( = {}) slices = {} repeat_ary = [] clocks_running.each do |name, clock_pin| if clock_pin.next_edge < (cycle_count + [:repeat]) pin_slices = (clock_pin.next_edge..(cycle_count + [:repeat])).step(clock_pin.half_period).to_a pin_slices.insert(0, cycle_count) else pin_slices = [cycle_count] end pin_slices.each do |cycle| slices[cycle].nil? ? slices[cycle] = name : slices[cycle] = "#{slices[cycle]},#{name}" end slices[cycle_count + [:repeat]] = '' if pin_slices[-1] != cycle_count + [:repeat] end slices.keys.sort.each do |edge_cycles| # puts "Toggle #{slices[edge_cycles]} on #{edge_cycles}" repeat_ary.push([edge_cycles, slices[edge_cycles].split(',')]) end (repeat_ary.count - 1).downto(1).each { |i| repeat_ary[i][0] = repeat_ary[i][0] - repeat_ary[i - 1][0] } repeat_ary[1..-1] end |
#snip(number, options = {}) ⇒ Object
150 151 152 |
# File 'lib/origen_testers/api.rb', line 150 def snip(number, = {}) yield end |
#ss(msg = nil) ⇒ Object
136 137 138 139 140 141 142 143 144 145 146 147 148 |
# File 'lib/origen_testers/api.rb', line 136 def ss(msg = nil) div = step_comment_prefix.length div = 1 if div == 0 c1(step_comment_prefix * (70 / div)) @step_comment_on = true if block_given? yield else c1(msg) end @step_comment_on = false c1(step_comment_prefix * (70 / div)) end |
#step_comment_prefix ⇒ Object
50 51 52 |
# File 'lib/origen_testers/api.rb', line 50 def step_comment_prefix @step_comment_prefix || '##' end |
#ultraflex? ⇒ Boolean Also known as: uflex?
75 76 77 |
# File 'lib/origen_testers/api.rb', line 75 def ultraflex? is_a?(OrigenTesters::IGXLBasedTester::UltraFLEX) end |
#update_running_clocks ⇒ Object
265 266 267 268 269 |
# File 'lib/origen_testers/api.rb', line 265 def update_running_clocks clocks_running.each do |name, clock_pin| clock_pin.update_clock end end |
#v93k? ⇒ Boolean
71 72 73 |
# File 'lib/origen_testers/api.rb', line 71 def v93k? is_a?(OrigenTesters::SmartestBasedTester::V93K) end |