origen 0.7.7 → 0.7.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55a0a4e8ad4368f828c29d55fcbd1e2c533276f7
-  data.tar.gz: 4a894872729fbb79801e9c98cb5d9e6cf7f2fc26
+  metadata.gz: 791d145cfc52402f0d89004ab08060ce874dd30c
+  data.tar.gz: 1fe96f4f97b1e2d8011d003c1161ccb025d8ae9e
 SHA512:
-  metadata.gz: 0be4fa923fbb1c97519f13c20a82b106cbf7bbeae07646e6a26bca64b6abd9df5fee15ee97452e54461998d48742423f56e44aa6d970b7119928c238f0395680
-  data.tar.gz: 39a0a321e38e7e1ff2f3acb953816428e57f6c961d0f4eace51678c6a54ab9c8dab6b6659c18a5ecaa02a65baaef4af35061a61b648af1734c6ce5c4dcb4634e
+  metadata.gz: a5fece355b661ae5756822e9b994a4430b507ae9a3ceef369c128e893a58453990cbfd2f2b84e1bf9535df1d8ebdce88d33ccb930c6e39059cc4b40131c7a2a0
+  data.tar.gz: 2ca85d5ba16eed7a2350a3afd328c367a8218cfaee4c7a4e34e296e6e3903e4d24c51ed173f4b363fc98768c636ad9f614e9b4b70c6b748056b7ed6c76f97bbb

data/config/version.rb

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

data/lib/origen.rb

@@ -3,6 +3,7 @@
 unless defined? RGen::ORIGENTRANSITION
   require 'English'
   require 'pathname'
+  require 'pry'
   # Keep a note of the pwd at the time when Origen was first loaded, this is initially used
   # by the site_config lookup.
   $_origen_invocation_pwd ||= Pathname.pwd
@@ -53,6 +54,7 @@ unless defined? RGen::ORIGENTRANSITION
     autoload :Chips,     'origen/chips'
     autoload :Netlist,   'origen/netlist'
     autoload :Models,    'origen/models'
+    autoload :Errata,    'origen/errata'
 
     APP_CONFIG = File.join('config', 'application.rb')
 

data/lib/origen/errata.rb

@@ -0,0 +1,117 @@
+module Origen
+  module Errata
+    autoload :HwErratum,		'origen/errata/hw_erratum'
+    autoload :SwErratumWorkaround,	'origen/errata/sw_erratum_workaround'
+
+    attr_accessor :_errata
+
+    attr_accessor :_sw_workarounds
+
+    # Define and instantiate an erratum object
+    def erratum(id, ip_block, overview = {}, status = {}, sw_workaround = {})
+      _errata
+      @_errata[id][ip_block][status[:disposition]] = HwErratum.new(id, ip_block, overview, status, sw_workaround)
+    end
+
+    # Returns an erratum or list of erratum that meet a specific criteria
+    def errata(options = {})
+      options = {
+        id:          nil,
+        ip_block:    nil,
+        disposition: nil
+      }.update(options)
+      return nil if @_errata.nil?
+      return nil if @_errata.empty?
+
+      errata_found = Hash.new do |h, k|
+        h[k] = Hash.new do |hh, kk|
+          hh[kk] = {}
+        end
+      end
+
+      # First filter on id, then ip_block, then disposition
+      filter_hash(@_errata, options[:id]).each do |id, hash|
+        filter_hash(hash, options[:ip_block]).each do |ip_block, hash1|
+          filter_hash(hash1, options[:disposition]).each do |disposition, errata|
+            errata_found[id][ip_block][disposition] = errata
+          end
+        end
+      end
+
+      # Return nil if there are no errata that meet criteria
+      if errata_found.empty?
+        return nil
+      # If only one errata meets criteria, return that HwErratum object
+      elsif errata_found.size == 1
+        errata_found.values.first.values.first.values.first
+      else
+        return errata_found
+      end
+    end
+
+    # Define and instantiate a sw_workaround object
+    def sw_workaround(id, overview = {}, resolution = {})
+      _sw_workarounds
+      @_sw_workarounds[id] = SwErratumWorkaround.new(id, overview, resolution)
+    end
+
+    # Returns a sw_workaround object with a specific id
+    def sw_workarounds(options = {})
+      options = {
+        id: nil
+      }.update(options)
+      return nil if @_sw_workarounds.nil?
+      return nil if @_sw_workarounds.empty?
+
+      sw_workarounds_found = Hash.new do |h, k|
+        h[k] = {}
+      end
+
+      # filter on id
+      filter_hash(@_sw_workarounds, options[:id]).each do |id, workarounds|
+        sw_workarounds_found[id] = workarounds
+      end
+      if sw_workarounds_found.empty?
+        return nil
+      elsif sw_workarounds_found.size == 1
+        sw_workarounds_found.values.first # .values.first
+      else
+        return sw_workarounds_found
+      end
+    end
+
+    private
+
+    def _errata
+      @_errata ||= Hash.new do |h, k|
+        h[k] = Hash.new do |hh, kk|
+          hh[kk] = {}
+        end
+      end
+    end
+
+    def _sw_workarounds
+      @_sw_workarounds ||= {}
+    end
+
+    # Return a hash based on the filter provided
+    # def filter_hash(hash, filter)
+    #  fail 'Hash argument is not a Hash!' unless hash.is_a? Hash
+    #  filtered_hash = {}
+    #  select_logic = case filter
+    #    when String then 'k[Regexp.new(filter)] && k.length == filter.length'
+    #    when (Fixnum || Integer || Float || Numeric) then "k[Regexp.new('#{filter}')]"
+    #    when Regexp then 'k[filter]'
+    #    when Symbol then
+    #      'k == filter'
+    #    when NilClass then true # Return all specs if a filter is set to nil (i.e. user doesn't care about this filter)
+    #    else true
+    #  end
+    # rubocop:disable UnusedBlockArgument
+    #  filtered_hash = hash.select do |k, v|
+    #    [TrueClass, FalseClass].include?(select_logic.class) ? select_logic : eval(select_logic)
+    #  end
+    #  filtered_hash
+    # end
+  end
+end

data/lib/origen/errata/hw_erratum.rb

@@ -0,0 +1,47 @@
+module Origen
+  module Errata
+    class HwErratum
+      # ID number used to identify erratum
+      attr_reader :id
+
+      # Erratum Title
+      attr_accessor :title
+
+      # Description of erratum
+      attr_accessor :description
+
+      # Description of the hardware workaround for the erratum
+      attr_accessor :hw_workaround_description
+
+      # How the errata is to be distributed ex:
+      #  --Internal Only
+      #  --Customer visible
+      #  --Other: 3rd party, etc.
+      attr_accessor :disposition
+
+      # Impact of erratum to customer
+      attr_accessor :impact
+
+      # When/if the erratum will be fixed
+      attr_accessor :fix_plan
+
+      # IP block that is associate with this errata
+      attr_accessor :ip_block
+
+      # Software workaround object associated with erratum
+      attr_accessor :sw_workaround
+
+      def initialize(id, ip_block, overview  = {}, status = {}, sw_workaround = {})
+        @id = id
+        @ip_block = ip_block
+        @title = overview[:title]
+        @description = overview[:description]
+        @hw_workaround_description = overview[:hw_workaround_description]
+        @disposition = status[:disposition]
+        @impact = status[:impact]
+        @fix_plan = status[:fix_plan]
+        @sw_workaround = sw_workaround
+      end
+    end
+  end
+end

data/lib/origen/errata/sw_erratum_workaround.rb

@@ -0,0 +1,39 @@
+module Origen
+  module Errata
+    class SwErratumWorkaround
+      # ID number used to identify software workaround
+      attr_reader :id
+
+      # Title of software workaround
+      attr_accessor :title
+
+      # Description of software workaround and implementation
+      attr_accessor :description
+
+      # Availability of workaround, ex:
+      #    -- Not Applicable: Errata does not affect software
+      #    -- Not Available: Workaround not available
+      #    -- Available: Workaround is available to be distributed
+      attr_accessor :sw_disposition
+
+      # Software distribution version which incorporates the workaround
+      attr_accessor :distribution
+
+      # Release note
+      attr_accessor :note
+
+      # Link to patch(s) for workaround
+      attr_accessor :patches
+
+      def initialize(id, overview = {}, resolution = {})
+        @id = id
+        @title = overview[:title]
+        @description = overview[:description]
+        @sw_disposition = overview[:sw_disposition]
+        @distribution = overview[:distribution]
+        @note = resolution[:note]
+        @patches = resolution[:patches]
+      end
+    end
+  end
+end

data/lib/origen/model.rb

@@ -23,6 +23,7 @@ module Origen
       include Origen::Ports
       include Origen::Netlist
       include Origen::Memory
+      include Origen::Errata
     end
 
     module ClassMethods

data/lib/origen/specs.rb

@@ -137,7 +137,7 @@ module Origen
     def documentation(header_info, selection,  link)
       _documentation
       # Create a new documenation and place it in the 5-D hash
-      @_documentation[header_info[:section]][header_info[:subsection]][selection[:interface]][selection[:type]][selection[:subtype]][selection[:mode]][selection[:audience]] = Documentation.new(header_info, selection, link)
+      @_documentation[header_info[:section]][header_info[:subsection]][selection[:interface]][selection[:type]][selection[:sub_type]][selection[:mode]][selection[:audience]] = Documentation.new(header_info, selection, link)
     end
 
     # Adds a new feature to the block

data/lib/origen/specs/documentation.rb

@@ -2,6 +2,9 @@ module Origen
   module Specs
     # This class is used to store documentation map that the user can change
     class Documentation
+      # Level that Section is at.  Allows for a key to be found.
+      attr_accessor :level
+
       # This is the Section Header for the Documentation Map.  Usually these are main headers
       # Examples:
       #  I. Overall DC Electricals
@@ -43,6 +46,7 @@ module Origen
 
       # Initialize the Class
       def initialize(header_info = {}, selection = {}, link = nil)
+        @level = header_info[:level]
         @section = header_info[:section]
         @subsection = header_info[:subsection]
         @interface = selection[:interface]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen
 version: !ruby/object:Gem::Version
-  version: 0.7.7
+  version: 0.7.8
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-07 00:00:00.000000000 Z
+date: 2016-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -508,6 +508,9 @@ files:
 - lib/origen/database/key_value_store.rb
 - lib/origen/database/key_value_stores.rb
 - lib/origen/encodings.rb
+- lib/origen/errata.rb
+- lib/origen/errata/hw_erratum.rb
+- lib/origen/errata/sw_erratum_workaround.rb
 - lib/origen/features.rb
 - lib/origen/features/feature.rb
 - lib/origen/file_handler.rb
@@ -649,7 +652,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.8.11
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.2
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: The Semiconductor Developer's Kit