origen 0.6.5 → 0.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfb17fbaff27198d30ddd8202744f4956bd7cb56
-  data.tar.gz: 3d2a5b349dd72b01513beab277e1f2aba2f968ea
+  metadata.gz: eb7e3006eff54d7d70809e8d54b0b976d1ecb01e
+  data.tar.gz: 1932c4799723ef86e1c7564863b310b0a6c271cf
 SHA512:
-  metadata.gz: ed4777c6f9c07bfea3dbd590c368ad7973ddc3d1be75c98137762efa514ad238b1178dd81931ef5ec1321cf20fd95feaf2b4fac94ed29f0aec0b7b7f91ce18be
-  data.tar.gz: d0cb6d346bc8f631cef41e6fa25c81c507a76ed7e0a53ba3d1dd01bbd37a1bace6ea8795f67812613b3b4e393b37a25f009fcd4a457bea7eb1c0e7563a79de01
+  metadata.gz: 76e2aaec740bca336ff8de376f0354abdfbbb5706391a5726af8355997fb63a870a84649e75782667d545791f246c032d446e781897ed8ec743182b42bb5bbac
+  data.tar.gz: dc7e62542c9d488e5b5629f3dd15bfacd51e0a8390c887ae653a61f14a33a3ea5615c4d9fddce5839dad7e59c3de6f39eda9cf046060e1bae1dbcd50b1bab6d5

data/config/version.rb

@@ -1,7 +1,7 @@
 module Origen
   MAJOR = 0
   MINOR = 6
-  BUGFIX = 5
+  BUGFIX = 6
   DEV = nil
 
   VERSION = [MAJOR, MINOR, BUGFIX].join(".") + (DEV ? ".pre#{DEV}" : '')

data/lib/origen/pins.rb

@@ -176,6 +176,7 @@ module Origen
     autoload :PinClock,      'origen/pins/pin_clock'
     autoload :PowerPin,      'origen/pins/power_pin'
     autoload :GroundPin,     'origen/pins/ground_pin'
+    autoload :VirtualPin,    'origen/pins/virtual_pin'
     autoload :FunctionProxy, 'origen/pins/function_proxy'
 
     # @api private
@@ -213,6 +214,7 @@ module Origen
       id, options = nil, id if id.is_a?(Hash)
       power_pin = options.delete(:power_pin)
       ground_pin = options.delete(:ground_pin)
+      virtual_pin = options.delete(:virtual_pin)
       if options[:size] && options[:size] > 1
         group = PinCollection.new(self, options.merge(placeholder: true))
         group.id = id if id
@@ -227,6 +229,8 @@ module Origen
             group[i] = PowerPin.new(i, self, options)
           elsif ground_pin
             group[i] = GroundPin.new(i, self, options)
+          elsif virtual_pin
+            group[i] = VirtualPin.new(i, self, options)
           else
             group[i] = Pin.new(i, self, options)
           end
@@ -247,6 +251,8 @@ module Origen
           pin = PowerPin.new(id || :temp, self, options)
         elsif ground_pin
           pin = GroundPin.new(id || :temp, self, options)
+        elsif virtual_pin
+          pin = VirtualPin.new(id || :temp, self, options)
         else
           pin = Pin.new(id || :temp, self, options)
         end
@@ -275,6 +281,15 @@ module Origen
     end
     alias_method :add_ground_pins, :add_ground_pin
 
+    def add_virtual_pin(id = nil, options = {}, &block)
+      id, options = nil, id if id.is_a?(Hash)
+      options = {
+        virtual_pin: true
+      }.merge(options)
+      add_pin(id, options, &block)
+    end
+    alias_method :add_virtual_pins, :add_virtual_pin
+
     # Specify the order that pins will appear in the output pattern, unspecified
     # pins will appear in an arbitrary order at the end
     #
@@ -384,6 +399,12 @@ module Origen
     end
     alias_method :has_ground_pins?, :has_ground_pin?
 
+    # Equivalent to the has_pin? method but considers virtual pins rather than regular pins
+    def has_virtual_pin?(id)
+      !!Origen.pin_bank.find(id, virtual_pin: true)
+    end
+    alias_method :has_virtual_pins?, :has_virtual_pin?
+
     def add_pin_group(id, *pins, &_block)
       if pins.last.is_a?(Hash)
         options = pins.pop
@@ -457,6 +478,18 @@ module Origen
       add_pin_group(id, *pins, options, &block)
     end
 
+    def add_virtual_pin_group(id, *pins, &block)
+      if pins.last.is_a?(Hash)
+        options = pins.pop
+      else
+        options = {}
+      end
+      options = {
+        virtual_pin: true
+      }.merge(options)
+      add_pin_group(id, *pins, options, &block)
+    end
+
     # Similar to the pins method except that this method will bypass the package/mode/configuration
     # scope.
     #
@@ -488,6 +521,15 @@ module Origen
       end
     end
 
+    # Equivalent to the all_pins method but considers ground pins rather than regular pins
+    def all_virtual_pins(id = nil, _options = {}, &_block)
+      if id
+        pin = Origen.pin_bank.find(id, ignore_context: true, virtual_pin: true)
+      else
+        Origen.pin_bank.all_virtual_pins
+      end
+    end
+
     def pin_groups(id = nil, options = {}, &_block)
       id, options = nil, id if id.is_a?(Hash)
       if id
@@ -553,6 +595,28 @@ If you meant to define the ground_pin_group then use the add_ground_pin_group me
     end
     alias_method :ground_pin_group, :ground_pin_groups
 
+    # Equivalent to the pin_groups method but considers virtual pins rather than regular pins
+    def virtual_pin_groups(id = nil, options = {}, &_block)
+      id, options = nil, id if id.is_a?(Hash)
+      if id
+        pin = Origen.pin_bank.find(id, options.merge(virtual_pin: true))
+        unless pin
+          puts <<-END
+You have tried to reference virtual_pin_group :#{id} within #{self.class} but it does not exist, this could be
+because the pin group has not been defined yet or it is an alias that is not available in the current context.
+
+If you meant to define the virtual_pin_group then use the add_virtual_pin_group method instead.
+
+          END
+          fail 'Utility pin group not found'
+        end
+        pin
+      else
+        Origen.pin_bank.virtual_pin_groups(options)
+      end
+    end
+    alias_method :virtual_pin_group, :virtual_pin_groups
+
     # Permits access via object.pin(x), returns a hash of all pins if no id
     # is specified.
     # ==== Examples
@@ -579,6 +643,8 @@ If you meant to define the pin then use the add_pin method instead.
           Origen.pin_bank.power_pins
         elsif options[:ground_pin]
           Origen.pin_bank.ground_pins
+        elsif options[:virtual_pin]
+          Origen.pin_bank.virtual_pins
         else
           Origen.pin_bank.pins
         end
@@ -604,6 +670,15 @@ If you meant to define the pin then use the add_pin method instead.
       pins(id, options, &block)
     end
 
+    # Equivalent to the pins method but considers virtual pins rather than regular pins
+    def virtual_pins(id = nil, options = {}, &block)
+      id, options = nil, id if id.is_a?(Hash)
+      options = {
+        virtual_pin: true
+      }.merge(options)
+      pins(id, options, &block)
+    end
+
     def delete_all_pins
       Origen.pin_bank.send :empty!
     end

data/lib/origen/pins/pin_bank.rb

@@ -23,6 +23,8 @@ module Origen
           bank = all_power_pins
         elsif pin.is_a?(GroundPin)
           bank = all_ground_pins
+        elsif pin.is_a?(VirtualPin)
+          bank = all_virtual_pins
         else
           bank = all_pins
         end
@@ -73,6 +75,12 @@ module Origen
         end
       end
 
+      def virtual_pins(options = {})
+        all_virtual_pins.select do |_id, pin|
+          pin.enabled?(options)
+        end
+      end
+
       # Returns a hash containing all pin_groups available in the current context stored by their primary ID
       def pin_groups(options = {})
         current_pin_group_store(all_pin_groups, options).select do |_id, group|
@@ -94,6 +102,13 @@ module Origen
         end
       end
 
+      # Returns a hash containing all virtual_pin_groups available in the current context stored by their primary ID
+      def virtual_pin_groups(options = {})
+        current_pin_group_store(all_virtual_pin_groups, options).select do |_id, group|
+          group.enabled?(options)
+        end
+      end
+
       # Returns a hash containing all pins stored by their primary ID
       def all_pins
         @all_pins ||= {}
@@ -114,6 +129,11 @@ module Origen
         @all_ground_pins ||= {}
       end
 
+      # Returns a hash containing all virtual pins stored by their primary ID
+      def all_virtual_pins
+        @all_virtual_pins ||= {}
+      end
+
       # Returns a hash containing all power pin groups stored by context
       def all_power_pin_groups
         @all_power_pin_groups ||= {}
@@ -124,12 +144,19 @@ module Origen
         @all_ground_pin_groups ||= {}
       end
 
+      # Returns a hash containing all virtual pin groups stored by context
+      def all_virtual_pin_groups
+        @all_virtual_pin_groups ||= {}
+      end
+
       def find(id, options = {})
         id = id.to_sym
         if options[:power_pin]
           pin = all_power_pins[id] || find_pin_group(id, options)
         elsif options[:ground_pin]
           pin = all_ground_pins[id] || find_pin_group(id, options)
+        elsif options[:virtual_pin]
+          pin = all_virtual_pins[id] || find_pin_group(id, options)
         else
           pin = all_pins[id] || find_by_alias(id, options) || find_pin_group(id, options)
         end
@@ -148,6 +175,8 @@ module Origen
           base = all_power_pin_groups
         elsif options[:ground_pin]
           base = all_ground_pin_groups
+        elsif options[:virtual_pin]
+          base = all_virtual_pin_groups
         else
           base = all_pin_groups
         end
@@ -180,6 +209,8 @@ module Origen
           bank = all_power_pins
         elsif pin.is_a?(GroundPin)
           bank = all_ground_pins
+        elsif pin.is_a?(VirtualPin)
+          bank = all_virtual_pins
         else
           bank = all_pins
         end
@@ -209,6 +240,8 @@ module Origen
           base = all_power_pin_groups
         elsif group.ground_pins?
           base = all_ground_pin_groups
+        elsif group.virtual_pins?
+          base = all_virtual_pin_groups
         else
           base = all_pin_groups
         end
@@ -252,6 +285,8 @@ module Origen
           base = all_power_pin_groups
         elsif group.ground_pins?
           base = all_ground_pin_groups
+        elsif group.virtual_pins?
+          base = all_virtual_pin_groups
         else
           base = all_pin_groups
         end
@@ -332,9 +367,11 @@ module Origen
         @all_pins = nil
         @all_power_pins = nil
         @all_ground_pins = nil
+        @all_virtual_pins = nil
         @all_pin_groups = nil
         @all_power_pin_groups = nil
         @all_ground_pin_groups = nil
+        @all_virtual_pin_groups = nil
       end
 
       def known_aliases

data/lib/origen/pins/pin_collection.rb

@@ -16,6 +16,7 @@ module Origen
         }.merge(options)
         @power_pins = options.delete(:power_pin) || options.delete(:power_pins)
         @ground_pins = options.delete(:ground_pin) || options.delete(:ground_pins)
+        @virtual_pins = options.delete(:virtual_pin) || options.delete(:virtual_pins)
         @endian = options[:endian]
         @description = options[:description] || options[:desc]
         @options = options
@@ -81,6 +82,11 @@ module Origen
         @ground_pins
       end
 
+      # Returns true if the pin collection contains virtual pins rather than regular pins
+      def virtual_pins?
+        @virtual_pins
+      end
+
       def id
         @id
       end
@@ -176,6 +182,8 @@ module Origen
             pin = owner.power_pins(pin)
           elsif ground_pins?
             pin = owner.ground_pins(pin)
+          elsif virtual_pins?
+            pin = owner.virtual_pins(pin)
           else
             pin = owner.pins(pin)
           end

data/lib/origen/pins/virtual_pin.rb

@@ -0,0 +1,16 @@
+module Origen
+  module Pins
+    class VirtualPin < Pin
+      # Pin Types
+      TYPES = [:virtual_bit, :ate_ch]
+
+      def type=(value)
+        if TYPES.include? value
+          @type = value
+        else
+          fail "VirtualPin type '#{value}' must be set to one of the following: #{TYPES.join(', ')}"
+        end
+      end
+    end
+  end
+end

data/lib/origen/specs.rb

@@ -215,6 +215,8 @@ module Origen
         id:   nil,
         type: nil
       }.update(options)
+      return nil if @_notes.nil?
+      return nil if @_notes.empty?
       # Empty 2-D Hash to be used for notes found based on id and type
       notes_found = Hash.new do |h, k|
         # h is the id portion of the hash
@@ -244,6 +246,8 @@ module Origen
         device: nil
       }.update(options)
       return @_spec_features if options[:id].nil? && options[:device].nil?
+      return nil if @_spec_features.nil?
+      return nil if @_spec_features.empty?
       features_found = Hash.new do |h, k|
         h[k] = {}
       end
@@ -267,12 +271,14 @@ module Origen
         id:    nil,
         type:  nil
       }.update(options)
+      return nil if @_exhibits.nil?
+      return nil if @_exhibits.empty?
       ex_found = Hash.new do |h, k|
         h[k] = Hash.new do |hh, kk|
           hh[kk] = {}
         end
       end
-      filter_hash(_exhibits, options[:block]).each do |_block, hash|
+      filter_hash(@_exhibits, options[:block]).each do |_block, hash|
         filter_hash(hash, options[:id]).each do |_id, hash_|
           filter_hash(hash_, options[:type]).each do |_type, exh|
             ex_found[_block][_id][_type] = exh
@@ -293,6 +299,8 @@ module Origen
         sub_type: nil,
         audience: nil
       }.update(options)
+      return nil if @_doc_resources.nil?
+      return nil if @_doc_resources.empty?
       dr_found = Hash.new do |h, k|
         h[k] = Hash.new do |hh, kk|
           hh[kk] = Hash.new do |hhh, kkk|
@@ -300,7 +308,7 @@ module Origen
           end
         end
       end
-      filter_hash(_doc_resources, options[:mode]).each do |_mode, hash|
+      filter_hash(@_doc_resources, options[:mode]).each do |_mode, hash|
         filter_hash(hash, options[:type]).each do |_type, hash_|
           filter_hash(hash_, options[:sub_type]).each do |_sub_type, hash__|
             filter_hash(hash__, options[:audience]).each do |_audience, spec|
@@ -324,6 +332,8 @@ module Origen
         sub_type: nil,
         audience: nil
       }.update(options)
+      return nil if @_overrides.nil?
+      return nil if @_overrides.empty?
       overrides_found = Hash.new do |h, k|
         h[k] = Hash.new do |hh, kk|
           hh[kk] = Hash.new do |hhh, kkk|
@@ -333,7 +343,7 @@ module Origen
           end
         end
       end
-      filter_hash(_overrides, options[:block]).each do |_block, hash|
+      filter_hash(@_overrides, options[:block]).each do |_block, hash|
         filter_hash(hash, options[:spec_ref]).each do |_spec_ref, hash_|
           filter_hash(hash_, options[:mode_ref]).each do |_mode_ref, hash__|
             filter_hash(hash__, options[:sub_type]).each do |_sub_type, hash___|
@@ -356,10 +366,12 @@ module Origen
         block: nil,
         mode:  nil
       }.update(options)
+      return nil if @_mode_selects.nil?
+      return nil if @_mode_selects.empty?
       modes_found = Hash.new do|h, k|
         h[k] = {}
       end
-      filter_hash(_mode_selects, options[:block]).each do |block, hash|
+      filter_hash(@_mode_selects, options[:block]).each do |block, hash|
         filter_hash(hash, options[:mode]).each do |mode, sel|
           modes_found[block][mode] = sel
         end
@@ -379,7 +391,9 @@ module Origen
       ps_found = Hash.new do|h, k|
         h[k] = {}
       end
-      filter_hash(_power_supplies, options[:gen]).each do |gen, hash|
+      return nil if @_power_supplies.nil?
+      return nil if @_power_supplies.empty?
+      filter_hash(@_power_supplies, options[:gen]).each do |gen, hash|
         filter_hash(hash, options[:act]).each do |act, sel|
           ps_found[gen][act] = sel
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.6.6
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-25 00:00:00.000000000 Z
+date: 2016-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -551,6 +551,7 @@ files:
 - lib/origen/pins/pin_collection.rb
 - lib/origen/pins/pin_common.rb
 - lib/origen/pins/power_pin.rb
+- lib/origen/pins/virtual_pin.rb
 - lib/origen/ports.rb
 - lib/origen/ports/bit_collection.rb
 - lib/origen/ports/port.rb