Module: Origen::Model

Extended by:
ActiveSupport::Concern
Included in:
Component::Default, Origen::Models::Mux, Origen::Models::ScanRegister, SubBlock
Defined in:
lib/origen/model.rb,
lib/origen/model/exporter.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, Exporter

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



342
343
344
345
346
347
348
349
350
351
# File 'lib/origen/model.rb', line 342

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

#==(obj) ⇒ Object Also known as: equal?



78
79
80
81
82
83
84
85
86
87
# File 'lib/origen/model.rb', line 78

def ==(obj)
  if obj.is_a?(Origen::SubBlocks::Placeholder)
    obj = obj.materialize
  end
  if controller
    super(obj) || controller.send(:==, obj, called_from_model: true)
  else
    super(obj)
  end
end

#_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)


355
356
357
# File 'lib/origen/model.rb', line 355

def _initialized?
  !!@_initialized
end

#_resolve_controller_classObject



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'lib/origen/model.rb', line 141

def _resolve_controller_class
  klass = self.class
  while klass != Object
    controller_class = "#{klass}Controller"
    unless controller_class.start_with?('#<Class')
      # klass is an anonymous class. Can't support automatic resolution with anonymous classes
      if eval("defined? #{controller_class}")
        return eval(controller_class)
      elsif eval("defined? ::#{controller_class}")
        return eval("::#{controller_class}")
      end
    end
    klass = klass.superclass
  end
end

#add_configuration(id) ⇒ Object



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

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

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

Yields:

  • (m)


228
229
230
231
232
233
234
# File 'lib/origen/model.rb', line 228

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



359
360
361
362
# File 'lib/origen/model.rb', line 359

def clock!
  clock_prepare
  clock_apply
end

#clock_applyObject



370
371
372
373
374
# File 'lib/origen/model.rb', line 370

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

#clock_prepareObject



364
365
366
367
368
# File 'lib/origen/model.rb', line 364

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

#configurationObject



168
169
170
# File 'lib/origen/model.rb', line 168

def configuration
  @configuration
end

#configuration=(id) ⇒ Object



163
164
165
166
# File 'lib/origen/model.rb', line 163

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

#configurationsObject

Returns an array containing the IDs of all known configurations



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

def configurations
  @configurations ||= []
end

#current_configurationObject



157
158
159
160
161
# File 'lib/origen/model.rb', line 157

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

#current_modeObject 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


201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
# File 'lib/origen/model.rb', line 201

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!"
  else
    unless top_level?
      # Need to do this in case a class besides SubBlock includes Origen::Model
      obj_above_self = parent.nil? ? Origen.top_level : parent
      return nil if obj_above_self.nil?
      if obj_above_self.current_mode
        _modes[obj_above_self.current_mode.id] if _modes.include? obj_above_self.current_mode.id
      end
    end
  end
end

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

Set the current mode configuration of the current model



219
220
221
222
223
224
225
# File 'lib/origen/model.rb', line 219

def current_mode=(id)
  @current_mode = id.is_a?(ChipMode) ? id.id : id
  Origen.app.listeners_for(:on_mode_changed).each do |listener|
    listener.on_mode_changed(mode: @current_mode, instance: self)
  end
  @current_mode
end

#delete_all_modesObject 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



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

def delete_all_modes
  @_modes = nil
end

#delete_all_specs_and_notes(obj = nil) ⇒ Object

Delete all specs and notes for self recursively



315
316
317
318
319
320
321
322
323
324
# File 'lib/origen/model.rb', line 315

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_specsObject

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



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
# File 'lib/origen/model.rb', line 287

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)


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

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

#inspectObject



46
47
48
49
50
51
52
# File 'lib/origen/model.rb', line 46

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

#ip_nameObject



104
105
106
# File 'lib/origen/model.rb', line 104

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

#is_a_model_and_controller?Boolean

Returns true if the instance is an Origen::Model that is wrapped in a controller

Returns:

  • (Boolean)


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

def is_a_model_and_controller?
  !!controller
end

#is_an_origen_model?Boolean

Returns:

  • (Boolean)


54
55
56
# File 'lib/origen/model.rb', line 54

def is_an_origen_model?
  true
end

#is_top_level?Boolean Also known as: is_dut?, top_level?

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

Returns:

  • (Boolean)


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

def is_top_level?
  Origen.top_level == self
end

#logObject



90
91
92
# File 'lib/origen/model.rb', line 90

def log
  Origen.log
end

#modelObject

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.



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

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



242
243
244
245
246
247
248
249
# File 'lib/origen/model.rb', line 242

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



99
100
101
102
# File 'lib/origen/model.rb', line 99

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

#respond_to?(*args) ⇒ Boolean

Returns:

  • (Boolean)


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

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

#respond_to_directly?(*args) ⇒ Boolean

Returns:

  • (Boolean)


330
331
332
333
334
335
# File 'lib/origen/model.rb', line 330

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

#to_json(*args) ⇒ Object



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
# File 'lib/origen/model.rb', line 376

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.



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

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

#with_each_modeObject 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.



265
266
267
268
269
270
271
272
273
274
275
276
# File 'lib/origen/model.rb', line 265

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



253
254
255
256
257
258
# File 'lib/origen/model.rb', line 253

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

#wrap_in_controllerObject



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
# File 'lib/origen/model.rb', line 108

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



94
95
96
97
# File 'lib/origen/model.rb', line 94

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