origen 0.60.7 → 0.60.8

data/lib/origen/pins/pin.rb

@@ -30,7 +30,7 @@ module Origen
       attr_accessor :invert
       # Attribute used to generate vectors where the pin state is assigned the
       # repeat_previous opcode, used by Tester#repeat_previous
-      attr_accessor :repeat_previous
+      attr_reader :repeat_previous
       attr_reader :owner
       attr_reader :size
       # Returns a hash containing the aliases associated with the given pin
@@ -41,15 +41,15 @@ module Origen
       attr_accessor :supply
       attr_accessor :supply_str
       # Boolean on whether pin is open drain
-      attr_accessor :open_drain
+      attr_reader :open_drain
       # Boolean on whether pin has external pull-up
-      attr_accessor :ext_pullup
+      attr_reader :ext_pullup
       # Boolean on whether pin has external pull-down
-      attr_accessor :ext_pulldown
+      attr_reader :ext_pulldown
       # Pin type, either :analog or :digital
-      attr_accessor :type
+      attr_reader :type
       # Pin RTL name
-      attr_accessor :rtl_name
+      attr_writer :rtl_name
       # Value to be forced on the pin, e.g. during simulation
       attr_accessor :force
 
@@ -694,7 +694,7 @@ module Origen
           # If val is a data bit extract the value of it
           val = val.respond_to?(:data) ? val.data : val
           # Assume driving/asserting a nil value means 0
-          val = 0 unless val
+          val ||= 0
           if !val.x_or_z? && val > 1
             fail "Attempt to set a value of #{val} on pin #{name}"
           end
@@ -1047,6 +1047,7 @@ module Origen
 
       def toggle_clock
         fail "ERROR: Clock on #{@owner.name} not running." unless is_a_running_clock?
+
         @clock.toggle
       end
 
@@ -1090,11 +1091,12 @@ module Origen
         end
       end
 
-      def index?(context: nil)
-        !!index(context: context).nil?
+      def index?(options = { context: nil })
+        !!index(options).nil?
       end
 
-      def index(context: nil)
+      def index(options = { context: nil })
+        context = options[:context]
         if context.is_a?(Symbol)
           # Context pin group provided
           group = groups[context].instance_variable_get(:@store)
@@ -1114,7 +1116,8 @@ module Origen
         end
       end
 
-      def mask(context: nil)
+      def mask(options = { context: nil })
+        context = options[:context]
         index = context.is_a?(Integer) ? context : self.index(context: context)
 
         if index.nil? && context.nil?
@@ -1130,7 +1133,10 @@ module Origen
       alias_method :set_mask, :mask
       alias_method :smask, :mask
 
-      def clear_mask(context: nil, size: nil)
+      def clear_mask(options = { context: nil, size: nil })
+        context = options[:context]
+        size = options[:size]
+
         index = context.is_a?(Integer) ? context : self.index(context: context)
 
         if index.nil? && context.nil?

data/lib/origen/pins/pin_bank.rb

@@ -33,6 +33,7 @@ module Origen
         if bank[pin.id]
           fail "A pin with id #{pin.id} already exists!"
         end
+
         all_ids << pin.id
         bank[pin.id] = pin
         # If ends in a number
@@ -248,6 +249,7 @@ module Origen
         # First delete the pin from any of the pin groups it resides
         Origen.pin_bank.pin_groups.each do |_name, grp|
           next unless grp.store.include?(pin)
+
           grp.delete(pin)
         end
         # Now delete the pin from the pin bank
@@ -391,6 +393,7 @@ module Origen
           if pins.size > 1
             fail "Mutliple pins with the alias #{id} have been found in the current scope!"
           end
+
           pins.first
         end
       end

data/lib/origen/pins/pin_clock.rb

@@ -85,10 +85,10 @@ module Origen
 
       def update_tester_period_local
         if Origen.tester.current_period_in_ns == @tester_period_in_ns
-          return false
+          false
         else
           @tester_period_in_ns = Origen.tester.current_period_in_ns
-          return true
+          true
         end
       end
 
@@ -127,6 +127,7 @@ module Origen
 
         return @clock_period_in_ns if p.empty?
         fail "[Pin Clock] ERROR: Multiple unit declarations for #{@owner.name}.clock" if p.size > 1
+
         p[0].to_int
       end
 

data/lib/origen/pins/pin_collection.rb

@@ -62,6 +62,7 @@ module Origen
       #   pin_group.to_vector   # => "LLLLLLLL"
       def to_vector
         return @vector_formatted_value if @vector_formatted_value
+
         vals = map(&:to_vector)
         vals.reverse! if endian == :little
         @vector_formatted_value = vals.join('')
@@ -90,6 +91,7 @@ module Origen
           unless val.size == size
             fail 'When setting vector_formatted_value on a pin group you must supply values for all pins!'
           end
+
           val.split(//).reverse.each_with_index do |val, i|
             myself[i].vector_formatted_value = val
           end
@@ -507,6 +509,7 @@ pins(:some_group).map(&:id).sort
 
       def clean_value(val)
         return val if val.respond_to?(:contains_bits?)
+
         val = val.data if val.respond_to?('data')
         if val.is_a?(String) || val.is_a?(Symbol)
           Origen::Value.new(val)

data/lib/origen/pins/timing/wave.rb

@@ -99,11 +99,13 @@ module Origen
           unless valid.include?(data)
             fail "Uknown data value #{data}, only these are valid: #{valid.join(', ')}"
           end
+
           yield data
         end
 
         def calc
           return @calc if @calc
+
           require 'dentaku'
           @calc = Dentaku::Calculator.new
         end
@@ -122,6 +124,7 @@ module Origen
           unless options[:at]
             fail 'When defining a wave event you must supply the time via the option :at'
           end
+
           t = options[:at]
 
           if t.is_a?(String)
@@ -129,10 +132,12 @@ module Origen
             unless d.empty?
               fail "Wave time formulas can only include the variable 'period' (or 'period_in_ns'), this variable is not allowed: #{d}"
             end
+
             t = t.gsub('period_in_ns', 'period')
             unless calc.evaluate(t, period: 100)
               fail "There appears to be an error in the formula: #{t}"
             end
+
             yield t
             return
           elsif t.is_a?(Numeric)

data/lib/origen/pins.rb

@@ -693,7 +693,13 @@ If you meant to define the virtual_pin_group then use the add_virtual_pin_group
     end
     alias_method :virtual_pin_group, :virtual_pin_groups
 
-    def all_pin_ids(type: nil, **options)
+    def all_pin_ids(*options)
+      type = nil
+      if options.first.is_a?(Hash)
+        options = options.first
+        type = options[:type]
+      end
+
       case type
       when :power_pin, :power_pins
         dut.pins(power_pin: true).map { |n, p| [n, *p.aliases.keys] }.flatten.map { |n| [n, dut.power_pin(n)] }.to_h

data/lib/origen/ports.rb

@@ -2,7 +2,7 @@ module Origen
   module Ports
     autoload :Port,     'origen/ports/port'
     autoload :Section,  'origen/ports/section'
-    autoload :BitCollection,  'origen/ports/bit_collection'
+    autoload :BitCollection, 'origen/ports/bit_collection'
     autoload :PortCollection,  'origen/ports/port_collection'
 
     def add_port(name, options = {})

data/lib/origen/power_domains/power_domain.rb

@@ -3,7 +3,8 @@ module Origen
   module PowerDomains
     class PowerDomain
       include Origen::Specs
-      attr_accessor :id, :description, :unit_voltage_range, :nominal_voltage, :setpoint, :maximum_voltage_rating, :min, :max
+      attr_accessor :id, :description, :min, :max
+      attr_writer :maximum_voltage_rating, :nominal_voltage, :unit_voltage_range
 
       # Generic Power Domain Name
       # This is the power supply that can be blocked off to multiple power supplies
@@ -38,6 +39,7 @@ module Origen
         (block.arity < 1 ? (instance_eval(&block)) : block.call(self)) if block_given?
         @unit_voltage_range = :fixed if @unit_voltage_range.nil?
         fail unless attrs_ok?
+
         create_dut_spec unless @min.nil? || @max.nil?
       end
 
@@ -110,7 +112,7 @@ module Origen
 
       # Checks for a pin type, returns nil if it is not found
       def pin_type(pin)
-        if self.has_pin?(pin) == false
+        if has_pin?(pin) == false
           nil
         else
           [:signal, :ground, :power].each do |pintype|
@@ -152,6 +154,7 @@ module Origen
       # This will need rework once the class has spec limits added
       def setpoint_ok?(val = nil)
         return true if maximum_voltage_rating.nil?
+
         compare_val = val.nil? ? setpoint : val
         if compare_val.nil?
           false

data/lib/origen/power_domains/power_domains_collection.rb

@@ -14,6 +14,7 @@ module Origen
               attr_getter = attr.to_s[/\@(\S+)/, 1].to_sym
               attr_val = domain.send attr_getter
               next unless [String, Numeric, Float, Integer, Symbol, Range].include? attr_val.class
+
               headers << attr_getter unless headers.include?(attr_getter)
               str = case attr_val
               when Range
@@ -22,7 +23,7 @@ module Origen
                 "#{start_voltage}\.\.#{end_voltage}"
               else
                 attr_val.to_s
-              end
+                    end
               curr_longest = [attr_getter, str].max_by(&:length).size + 2 # Add 2 for the whitespace
               if colhash[attr].nil? || (colhash[attr] < curr_longest)
                 colhash[attr] = curr_longest

data/lib/origen/registers/bit.rb

@@ -32,14 +32,14 @@ module Origen
         w1crs: { implemented: false, base: 'read-write',     write: 'oneToClear',   read: 'set',    writable: true,  readable: true,  w1c: true,  set_only: false,  clr_only: false, description: "Write '1' to clear and set-on-read" },
         w0src: { implemented: false, base: 'read-write',     write: 'zeroToSet',    read: 'clear',  writable: true,  readable: true,  w1c: false, set_only: false,  clr_only: false, description: "Write '0' to set and clear-on-read" },
         w0crs: { implemented: false, base: 'read-write',     write: 'zeroToClear',  read: 'set',    writable: true,  readable: true,  w1c: false, set_only: false,  clr_only: false, description: "Write '0' to clear and set-on-read" },
-        wo:    { implemented: false, base: 'write-only',     write: nil,            read: nil,      writable: true,  readable: false, w1c: false, set_only: false,  clr_only: false, description: 'Write-only' },
-        woc:   { implemented: false, base: 'write-only',     write: 'clear',        read: nil,      writable: true,  readable: false, w1c: false, set_only: false,  clr_only: true,  description: "When written sets the field to '0'. Read undeterministic" },
-        worz:  { implemented: false, base: 'write-only',     write: nil,            read: nil,      writable: true,  readable: false, w1c: false, set_only: false,  clr_only: false, description: 'Write-only, Reads zero' },
-        wos:   { implemented: false, base: 'write-only',     write: 'set',          read: nil,      writable: true,  readable: false, w1c: false, set_only: true,   clr_only: false, description: "When written sets all bits to '1'. Read undeterministic" },
-        w1:    { implemented: false, base: 'read-writeOnce', write: nil,            read: nil,      writable: true,  readable: true,  w1c: false, set_only: false,  clr_only: false, description: 'Write-once. Next time onwards, write is ignored. Read returns the value' },
-        wo1:   { implemented: false, base: 'writeOnce',      write: nil,            read: nil,      writable: true,  readable: false, w1c: false, set_only: false,  clr_only: false, description: 'Write-once. Next time onwards, write is ignored. Read is undeterministic' },
-        dc:    { implemented: false, base: 'read-write',     write: nil,            read: nil,      writable: true,  readable: true,  w1c: false, set_only: false,  clr_only: false, description: 'RW but no check' },
-        rowz:  { implemented: false, base: 'read-only',      write: nil,            read: 'clear',  writable: false, readable: true,  w1c: false, set_only: false,  clr_only: false, description: 'Read-only, value is cleared on read' }
+        wo:    { implemented: false, base: 'write-only', write: nil, read: nil, writable: true, readable: false, w1c: false, set_only: false, clr_only: false, description: 'Write-only' },
+        woc:   { implemented: false, base: 'write-only', write: 'clear', read: nil, writable: true, readable: false, w1c: false, set_only: false, clr_only: true, description: "When written sets the field to '0'. Read undeterministic" },
+        worz:  { implemented: false, base: 'write-only', write: nil, read: nil, writable: true, readable: false, w1c: false, set_only: false, clr_only: false, description: 'Write-only, Reads zero' },
+        wos:   { implemented: false, base: 'write-only', write: 'set', read: nil, writable: true, readable: false, w1c: false, set_only: true, clr_only: false, description: "When written sets all bits to '1'. Read undeterministic" },
+        w1:    { implemented: false, base: 'read-writeOnce', write: nil, read: nil, writable: true, readable: true, w1c: false, set_only: false, clr_only: false, description: 'Write-once. Next time onwards, write is ignored. Read returns the value' },
+        wo1:   { implemented: false, base: 'writeOnce', write: nil, read: nil, writable: true, readable: false, w1c: false, set_only: false, clr_only: false, description: 'Write-once. Next time onwards, write is ignored. Read is undeterministic' },
+        dc:    { implemented: false, base: 'read-write', write: nil, read: nil, writable: true, readable: true, w1c: false, set_only: false, clr_only: false, description: 'RW but no check' },
+        rowz:  { implemented: false, base: 'read-only', write: nil, read: 'clear', writable: false, readable: true, w1c: false, set_only: false, clr_only: false, description: 'Read-only, value is cleared on read' }
       }
 
       # Returns the Reg object that owns the bit
@@ -100,7 +100,7 @@ module Origen
       # Can be set to indicate that the current state of the bit is unknown, e.g. after reading X from a simulation
       attr_accessor :unknown
 
-      def initialize(owner, position, options = {}) # rubocop:disable MethodLength
+      def initialize(owner, position, options = {})
         options = {
           start:                   false,        # whether bit starts a state machine so be careful
           read_data_matches_write: true,
@@ -109,7 +109,7 @@ module Origen
           store:                   false,
           sticky_overlay:          true,
           sticky_store:            false,
-          nvm_dep:                 false,        # whether is an NVM dependent bit
+          nvm_dep:                 false        # whether is an NVM dependent bit
         }.merge(options)
         @owner = owner
         @position = position
@@ -141,7 +141,7 @@ module Origen
             readable: true,         # whether bit is readable
             clr_only: false,        # whether bit is clear only
             set_only: false,        # whether bit is set only
-            w1c:      false,        # whether bit is w1c (when written to 1 immediately becomes 0)
+            w1c:      false        # whether bit is w1c (when written to 1 immediately becomes 0)
           }.merge(options)
           @readable = options.delete(:readable)
           @writable = options.delete(:writable)
@@ -240,7 +240,8 @@ module Origen
       def default_bit_metadata
         if owner
           Origen::Registers.default_bit_metadata.merge(
-            Origen::Registers.bit_metadata[owner.owner.class] || {})
+            Origen::Registers.bit_metadata[owner.owner.class] || {}
+          )
         else
           Origen::Registers.default_bit_metadata
         end
@@ -336,11 +337,14 @@ module Origen
         self
       end
 
+      # rubocop:disable Lint/DuplicateMethods
+
       # Set the overlay attribute to the supplied value
       def overlay(value)
         @overlay = value
         self
       end
+      # rubocop:enable Lint/DuplicateMethods
 
       # Returns the overlay attribute
       def overlay_str
@@ -411,7 +415,7 @@ module Origen
       # Returns the value you would need to write to the register to put the given
       # value in this bit
       def setting(value)
-        value = value & 1   # As this bit can only hold one bit of data force it
+        value = value & 1 # As this bit can only hold one bit of data force it
         value << @position
       end
 
@@ -495,7 +499,7 @@ module Origen
                 return true
               end
             end
-            return false
+            false
           else
             feature == name
           end
@@ -538,7 +542,7 @@ module Origen
                 break # break if feature not found and return false
               end
             end # iterated through all features in array
-            return value
+            value
           else # if feature.class != Array
             loop do
               if current_owner.respond_to?(:owner)
@@ -561,10 +565,10 @@ module Origen
                 value = true
               end
             end
-            return value
+            value
           end
         else
-          return true
+          true
         end
       end
     end

data/lib/origen/registers/bit_collection.rb

@@ -88,6 +88,7 @@ module Origen
       #   end
       def [](*indexes)
         return self if indexes.empty?
+
         b = BitCollection.new(parent, name)
         expand_and_order(*indexes).each do |i|
           b << fetch(i)
@@ -261,6 +262,7 @@ module Origen
         if any? { |b| b.access != val }
           fail 'Not all bits the collection have the same access value!'
         end
+
         val
       end
 
@@ -334,6 +336,7 @@ module Origen
         data = 0
         shift_out_with_index do |bit, i|
           return undefined if bit.is_a?(Origen::UndefinedClass)
+
           data |= bit.data << i
         end
         data
@@ -352,16 +355,20 @@ module Origen
         data = 0
         reverse_shift_out_with_index do |bit, i|
           return undefined if bit.is_a?(Origen::UndefinedClass)
+
           data |= bit.data << i
         end
         data
       end
       alias_method :reverse_data, :data_reverse
 
+      # rubocop:disable Lint/DuplicateMethods
+
       # Supports reg.bit[0] and bitcollection.bit[0]
       def bit
         self
       end
+      # rubocop:enable Lint/DuplicateMethods
 
       # Returns true if the collection contains all bits in the register
       def whole_reg?
@@ -647,8 +654,8 @@ module Origen
 
       # Sets the store flag on all bits that already have the overlay flag set
       def store_overlay_bits(options = {})
-        options = { exclude: [],         # Pass in an array of any overlays that are to be excluded from store
-                  }.merge(options)
+        # Pass in an array of any overlays that are to be excluded from store
+        options = { exclude: [] }.merge(options)
         each do |bit|
           bit.store if bit.has_overlay? && !options[:exclude].include?(bit.overlay_str)
         end
@@ -768,6 +775,7 @@ module Origen
           data = 0
           shift_out_with_index do |bit, i|
             return bit.reset_data if bit.reset_data.is_a?(Symbol)
+
             data |= bit.reset_data << i
           end
           data
@@ -799,15 +807,16 @@ module Origen
         feature.delete(nil) if feature.include?(nil)
         if !feature.empty?
           if feature.size == 1
-            return feature[0]
+            feature[0]
           else
-            return feature.uniq
+            feature.uniq
           end
         else
           if Origen.config.strict_errors
             fail 'No feature found'
           end
-          return nil
+
+          nil
         end
       end
       alias_method :features, :feature
@@ -995,7 +1004,7 @@ module Origen
         Regexp.new(regex) =~ regval
 
         nibbles = []
-        size_in_nibbles.times do |n|                   # now grouped by nibble
+        size_in_nibbles.times do |n| # now grouped by nibble
           nibbles << Regexp.last_match[n + 1]
         end