Module: Origen::Model

Extended by:
ActiveSupport::Concern
Included in:
Origen::Models::Mux, Origen::Models::ScanRegister, SubBlock
Defined in:
lib/origen/model.rb

Overview

Include this module to identify it as an SoC IP Block, this will automatically include common modules such as Pin and Register support

Defined Under Namespace

Modules: ClassMethods

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args, &block) ⇒ Object

Used to proxy all method and attribute requests not implemented on the model to the controller.

On first call of a missing method a method is generated to avoid the missing lookup next time, this should be faster for repeated lookups of the same method, e.g. reg



297
298
299
300
301
302
303
304
305
306
 
# File 'lib/origen/model.rb', line 297

def method_missing(method, *args, &block)
  if controller.respond_to?(method)
    define_singleton_method(method) do |*args, &block|
      controller.send(method, *args, &block)
    end
    send(method, *args, &block)
  else
    super
  end
end

Instance Method Details

#_initialized? ⇒ Boolean

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.

Returns true after the model’s initialize method has been run

Returns:

  • (Boolean) 


310
311
312
 
# File 'lib/origen/model.rb', line 310

def _initialized?
  !!@_initialized
end

#_resolve_controller_class ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/origen/model.rb', line 112

def _resolve_controller_class
  klass = self.class
  while klass != Object
    controller_class = "#{klass}Controller"
    if eval("defined? #{controller_class}")
      return eval(controller_class)
    elsif eval("defined? ::#{controller_class}")
      return eval("::#{controller_class}")
    end
    klass = klass.superclass
  end
end

#add_configuration(id) ⇒ Object 



140
141
142
 
# File 'lib/origen/model.rb', line 140

def add_configuration(id)
  configurations << id unless configurations.include?(id)
end

#add_mode(id, options = {}) {|m| ... } ⇒ Object

Yields:

  • (m) 


183
184
185
186
187
188
189
 
# File 'lib/origen/model.rb', line 183

def add_mode(id, options = {})
  m = ChipMode.new(id, options)
  m.owner = self
  yield m if block_given?
  _add_mode(m)
  m
end

#clock! ⇒ Object 



314
315
316
317
 
# File 'lib/origen/model.rb', line 314

def clock!
  clock_prepare
  clock_apply
end

#clock_apply ⇒ Object 



325
326
327
328
329
 
# File 'lib/origen/model.rb', line 325

def clock_apply
  sub_blocks.each do |name, block|
    block.clock_apply if block.respond_to?(:clock_apply)
  end
end

#clock_prepare ⇒ Object 



319
320
321
322
323
 
# File 'lib/origen/model.rb', line 319

def clock_prepare
  sub_blocks.each do |name, block|
    block.clock_prepare if block.respond_to?(:clock_prepare)
  end
end

#configuration ⇒ Object 



136
137
138
 
# File 'lib/origen/model.rb', line 136

def configuration
  @configuration
end

#configuration=(id) ⇒ Object 



131
132
133
134
 
# File 'lib/origen/model.rb', line 131

def configuration=(id)
  add_configuration(id)
  @configuration = id
end

#configurations ⇒ Object

Returns an array containing the IDs of all known configurations



145
146
147
 
# File 'lib/origen/model.rb', line 145

def configurations
  @configurations ||= []
end

#current_configuration ⇒ Object 



125
126
127
128
129
 
# File 'lib/origen/model.rb', line 125

def current_configuration
  if self.respond_to?(:configuration)
    configuration
  end
end

#current_mode ⇒ Object Also known as: mode

Returns the current mode/configuration of the top level SoC. If no mode has been specified yet this will return nil

$dut = DUT.new
$dut.mode             # => default
$dut.mode.default?    # => true
$dut.mode.ram_bist?   # => false
$dut.mode = :ram_bist
$dut.mode.default?    # => false
$dut.mode.ram_bist?   # => true



169
170
171
172
173
174
 
# File 'lib/origen/model.rb', line 169

def current_mode
  if @current_mode
    return _modes[@current_mode] if _modes[@current_mode]
    fail "The mode #{@current_mode} of #{self.class} has not been defined!"
  end
end

#current_mode=(id) ⇒ Object Also known as: mode=

Set the current mode configuration of the current model



178
179
180
 
# File 'lib/origen/model.rb', line 178

def current_mode=(id)
  @current_mode = id.is_a?(ChipMode) ? id.id : id
end

#delete_all_modes ⇒ Object Also known as: del_all_modes

Sets the modes array to nil. Written so modes created in memory can be erased so modes defined in Ruby files can be loaded



236
237
238
 
# File 'lib/origen/model.rb', line 236

def delete_all_modes
  @_modes = nil
end

#delete_all_specs_and_notes(obj = nil) ⇒ Object

Delete all specs and notes for self recursively



270
271
272
273
274
275
276
277
278
279
 
# File 'lib/origen/model.rb', line 270

def delete_all_specs_and_notes(obj = nil)
  obj = self if obj.nil?
  obj.delete_all_specs
  obj.delete_all_notes
  obj.delete_all_exhibits
  obj.children.each do |_name, child|
    next unless child.has_specs?
    delete_all_specs_and_notes(child)
  end
end

#find_specs ⇒ Object

Returns all specs found for the model. if none found it returns an empty array



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/origen/model.rb', line 242

def find_specs
  specs_found = []
  # Check for specs the object owns
  if self.respond_to? :specs
    object_specs = specs
    unless object_specs.nil?
      if object_specs.class == Origen::Specs::Spec
        specs_found << object_specs
      else
        specs_found.concat(object_specs)
      end
    end
  end
  sub_blocks.each do |_name, sb|
    next unless sb.respond_to? :specs
    child_specs = sb.specs
    unless child_specs.nil?
      if child_specs.class == Origen::Specs::Spec
        specs_found << child_specs
      else
        specs_found.concat(child_specs)
      end
    end
  end
  specs_found
end

#has_mode?(id) ⇒ Boolean

Returns:

  • (Boolean) 


191
192
193
 
# File 'lib/origen/model.rb', line 191

def has_mode?(id)
  !!(_modes[id.is_a?(ChipMode) ? id.id : id])
end

#inspect ⇒ Object 



36
37
38
39
40
41
42
 
# File 'lib/origen/model.rb', line 36

def inspect
  if controller
    "<Model/Controller: #{self.class}:#{object_id}/#{controller.class}:#{controller.object_id}>"
  else
    "<Model: #{self.class}:#{object_id}>"
  end
end

#ip_name ⇒ Object 



75
76
77
 
# File 'lib/origen/model.rb', line 75

def ip_name
  @ip_name || self.class.to_s.split('::').last.symbolize
end

#is_an_origen_model? ⇒ Boolean

Returns:

  • (Boolean) 


44
45
46
 
# File 'lib/origen/model.rb', line 44

def is_an_origen_model?
  true
end

#is_top_level? ⇒ Boolean Also known as: is_dut?

Returns true if the model is the current DUT/top-level model

Returns:

  • (Boolean) 


49
50
51
 
# File 'lib/origen/model.rb', line 49

def is_top_level?
  Origen.top_level == self
end

#log ⇒ Object 



61
62
63
 
# File 'lib/origen/model.rb', line 61

def log
  Origen.log
end

#model ⇒ Object

Means that when dealing with a controller/model pair, you can always call obj.model and obj.controller to get the one you want, regardless of the one you currently have.



57
58
59
 
# File 'lib/origen/model.rb', line 57

def model
  self
end

#modes(id = nil, _options = {}) ⇒ Object

Returns an array containing the IDs of all known modes if no ID is supplied, otherwise returns an object representing the given mode ID



197
198
199
200
201
202
203
204
 
# File 'lib/origen/model.rb', line 197

def modes(id = nil, _options = {})
  id = nil if id.is_a?(Hash)
  if id
    _modes[id]
  else
    _modes.ids
  end
end

#read_memory(*args) ⇒ Object 



70
71
72
73
 
# File 'lib/origen/model.rb', line 70

def read_memory(*args)
  return super if defined?(super)
  read_register(*args)
end

#respond_to?(*args) ⇒ Boolean

Returns:

  • (Boolean) 


281
282
283
 
# File 'lib/origen/model.rb', line 281

def respond_to?(*args)
  super || !!(!@respond_directly && controller && controller.respond_to_directly?(*args))
end

#respond_to_directly?(*args) ⇒ Boolean

Returns:

  • (Boolean) 


285
286
287
288
289
290
 
# File 'lib/origen/model.rb', line 285

def respond_to_directly?(*args)
  @respond_directly = true
  result = respond_to?(*args)
  @respond_directly = false
  result
end

#to_json(*args) ⇒ Object 



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/origen/model.rb', line 331

def to_json(*args)
  JSON.pretty_generate({
                         name:      name,
                         address:   base_address,
                         path:      path,
                         blocks:    sub_blocks.map do |name, block|
                           {
                             name:    name,
                             address: block.base_address
                           }
                         end,
                         registers: regs.map do |name, reg|
                           reg
                         end
                       }, *args)
end

#with_configuration(id, _options = {}) ⇒ Object

Execute the supplied block within the context of the given configuration, at the end the model’s configuration attribute will be restored to what it was before calling this method.



152
153
154
155
156
157
 
# File 'lib/origen/model.rb', line 152

def with_configuration(id, _options = {})
  orig = configuration
  self.configuration = id
  yield
  self.configuration = orig
end

#with_each_mode ⇒ Object Also known as: each_mode

Executes the given block of code for each known chip mode, inside the block the current mode of the top level block will be set to the given mode.

At the end of the block the current mode will be restored to whatever it was before entering the block.



220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/origen/model.rb', line 220

def with_each_mode
  begin
    orig = current_mode
  rescue
    orig = nil
  end
  modes.each do |_id, mode|
    self.current_mode = mode
    yield mode
  end
  self.current_mode = orig
end

#with_mode(id, _options = {}) ⇒ Object

Executes the given block of code within the context of the given mode, at the end the mode will be restored back to what it was on entry



208
209
210
211
212
213
 
# File 'lib/origen/model.rb', line 208

def with_mode(id, _options = {})
  orig = mode
  self.mode = id
  yield
  self.mode = orig
end

#wrap_in_controller ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/origen/model.rb', line 79

def wrap_in_controller
  c = Origen.controllers.find do |params|
    self.is_a?(params[:model_class]) if params[:model_class]
  end
  if c
    c = c[:controller_class].send(:allocate)
    if c.method(:initialize).arity == 0
      c.send(:initialize)
    else
      c.send(:initialize, self)
    end
    c.send('_model=', self)
    @controller = c
    c
  else
    controller_class = _resolve_controller_class
    if controller_class
      c = controller_class.send(:allocate)
      if c.method(:initialize).arity == 0
        c.send(:initialize)
      else
        c.send(:initialize, self)
      end
      c.extend(Origen::Controller)
      c.send('_model=', self)
      @controller = c
      c
    else
      self
    end
  end
end

#write_memory(*args) ⇒ Object 



65
66
67
68
 
# File 'lib/origen/model.rb', line 65

def write_memory(*args)
  return super if defined?(super)
  write_register(*args)
end