origen 0.0.1 → 0.0.2

data/lib/origen/bugs/bug.rb

@@ -0,0 +1,36 @@
+module Origen
+  module Bugs
+    class Bug
+      attr_reader :affected_versions
+
+      attr_reader :name
+      alias_method :id, :name
+
+      def initialize(name, options = {})
+        @name = name
+        @affected_versions = [options[:affected_version] || options[:affected_versions]].flatten.compact
+        @fixed_on_version = options[:fixed_on_version]
+      end
+
+      def present_on_version?(version, _options = {})
+        if affected_versions.empty?
+          if fixed_on_version
+            version < fixed_on_version
+          else
+            true
+          end
+        else
+          affected_versions.include?(version)
+        end
+      end
+
+      def fixed_on_version
+        @fixed_on_version || begin
+          unless affected_versions.empty?
+            affected_versions.max + 1
+          end
+        end
+      end
+    end
+  end
+end

data/lib/origen/bugs.rb

@@ -0,0 +1,45 @@
+module Origen
+  module Bugs
+    extend ActiveSupport::Concern
+
+    autoload :Bug,           'origen/bugs/bug'
+
+    module ClassMethods # :nodoc:
+      # Define a bug on the given IP
+      def bug(name, options = {})
+        name = name.to_s.downcase.to_sym
+        bugs[name] = Bug.new(name, options)
+        define_method "has_#{name}_bug?" do
+          Origen.deprecate "Use has_bug?(:#{name}) instead of has_#{name}_bug?"
+          has_bug?(name)
+        end
+      end
+
+      def bugs
+        @bugs ||= {}
+      end
+    end
+
+    # Returns true if the version of the IP represented by the object has the bug of the
+    # given name
+    def has_bug?(name, _options = {})
+      unless self.respond_to?(:version) && version
+        puts 'To test for the presence of a bug the object must implement an attribute'
+        puts "called 'version' which returns the IP version represented by the the object."
+        fail 'Version undefined!'
+      end
+      name = name.to_s.downcase.to_sym
+      if bugs[name]
+        bugs[name].present_on_version?(version)
+      else
+        false
+      end
+    end
+
+    # Returns a hash containing all known bugs associated with
+    # the given IP, regardless of which version they are present on
+    def bugs
+      self.class.bugs
+    end
+  end
+end

data/lib/origen/callbacks.rb

@@ -0,0 +1,35 @@
+require 'active_support/concern'
+module Origen
+  module Callbacks
+    extend ActiveSupport::Concern
+
+    included do
+      include Origen::ModelInitializer
+    end
+
+    def register_callback_listener # :nodoc:
+      Origen.app.add_callback_listener(self)
+    end
+  end
+
+  # The regular callbacks module will register listeners that expire upon the next target
+  # load, normally this is what is wanted at app level since things should start afresh
+  # every time the target is loaded.
+  #
+  # However within Origen core (and possibly some plugins) it is often the case that registered
+  # listeners will be objects that are not re-instantiated upon target load and persist for
+  # the entire Origen thread. In this case use the CoreCallbacks module instead of the regular
+  # Callbacks module to make these objects register as permanent listeners.
+  module PersistentCallbacks
+    extend ActiveSupport::Concern
+
+    included do
+      include Origen::ModelInitializer
+    end
+
+    def register_callback_listener # :nodoc:
+      Origen.app.add_persistant_callback_listener(self)
+    end
+  end
+  CoreCallbacks = PersistentCallbacks
+end

data/lib/origen/chip_mode.rb

@@ -0,0 +1,118 @@
+module Origen
+  # Represents an SoC DFT/Operating mode - e.g. SCAN, RAMBIST, etc.
+  class ChipMode
+    attr_accessor :brief_description
+    attr_accessor :description
+    attr_writer :name
+    attr_accessor :data_rate
+    attr_accessor :data_rate_unit
+    attr_accessor :minimum_version_enabled
+    alias_writer :min_ver_enabled, :minimum_version_enabled
+    alias_writer :min_version_enabled, :minimum_version_enabled
+    attr_accessor :audience
+    alias_writer :full_name, :name
+    # Returns the object that owns the mode (the SoC instance usually)
+    attr_accessor :owner
+    attr_accessor :typical_voltage
+    alias_method :typ_voltage, :typical_voltage
+
+    def initialize(name, options = {})
+      @name = name
+      options.each { |k, v| instance_variable_set("@#{k}", v) }
+      validate_args
+    end
+
+    def name
+      @name || @id
+    end
+    alias_method :full_name, :name
+
+    def id
+      @id || name.to_s.downcase.gsub(/(\s|-)+/, '_').to_sym
+    end
+
+    def id=(val)
+      @id = val.to_s.gsub(/(\s|-)+/, '_').downcase.to_sym
+    end
+
+    def data_rate(options = {})
+      options = {
+        absolute_number: true
+      }.update(options)
+      # Convert the data rate to a number
+      if !!@data_rate && !!@data_rate_unit
+        if options[:absolute_number]
+          # The data rate unit was validated on init so it is good to go
+          # in theory but should still check if it returns a numeric
+          value = @data_rate.send(@data_rate_unit.to_sym)
+          if [Fixnum, Bignum, Float, Integer, Numeric].include? value.class
+            return value
+          else
+            Origen.log.error "@data_rate '#{@data_rate}' conversion using @data_rate_unit '#{@data_rate_unit}' did not product a Numeric, exiting..."
+          end
+        else
+          return @data_rate
+        end
+      else
+        return @data_rate
+      end
+    end
+
+    def respond_to_missing?(method_name, _include_private = false)
+      method_name[-1] == '?'
+    end
+
+    # Implements methods like:
+    #
+    #     if $dut.mode.rambist?
+    def method_missing(method_name, *arguments)
+      if method_name[-1] == '?'
+        id == method_name[0..-2].to_sym
+      else
+        super
+      end
+    end
+
+    def to_s
+      id.to_s
+    end
+
+    def to_sym
+      to_s.to_sym
+    end
+
+    private
+
+    def validate_args
+      unless @data_rate_unit.nil? || @data_rate_unit =~ /n\/a/i || @data_rate_unit =~ /na/i
+        # Remove special chars
+        ['/', '-'].each do |special_char|
+          @data_rate_unit.gsub!(special_char, '')
+        end
+        # Check if @data_rate_unit is found in the Numeric core_ext lib
+        fail "@data_rate_unit '#{@data_rate_unit}' is not an accepted unit" unless 1.send(@data_rate_unit.to_sym)
+        # Cannot use @data_rate_unit without @data_rate
+        fail '@data_rate_unit must be set with @data_rate, exiting...' if @data_rate.nil?
+      end
+      unless @data_rate.nil? || @data_rate =~ /n\/a/i || @data_rate =~ /na/i
+        # Check if the data rate was passed as a String, if so convert it to a number
+        if @data_rate.is_a? String
+          if @data_rate.numeric?
+            @data_rate = @data_rate.to_numeric
+          else
+            fail "@data_rate '#{@data_rate}' cannot be converted to a number, exiting..."
+          end
+        end
+      end
+      unless @typical_voltage.nil?
+        if @typical_voltage.is_a? String
+          if @typical_voltage.numeric?
+            @typical_voltage = @typical_voltage.to_numeric
+          else
+            fail "@typical_voltage '#{@typical_voltage}' cannot be converted to a number, exiting..."
+          end
+        end
+      end
+    end
+  end
+end