In process of adding processor_kind to portfolios. Needed so I can include RVB23 in comparisons with RVA releases.

james-ball-qualcomm · james-ball-qualcomm · commit 0632dbb3ccdd · 2024-12-24T10:15:19.000-08:00
diff --git a/arch/certificate_class/MC.yaml b/arch/certificate_class/MC.yaml
@@ -2,6 +2,7 @@
 
 $schema: cert_class_schema.json#
 kind: Processor CRD
+processor_kind: Microcontroller
 name: MC
 long_name: Microcontroller Class CRD
 
diff --git a/arch/certificate_class/MockCertificateClass.yaml b/arch/certificate_class/MockCertificateClass.yaml
@@ -2,6 +2,7 @@
 
 $schema: cert_class_schema.json#
 kind: Processor CRD
+processor_kind: Apps Processor
 name: MockCertificateClass
 long_name: Mock Certificate Class Long Name
 
diff --git a/arch/profile_class/MockProfileClass.yaml b/arch/profile_class/MockProfileClass.yaml
@@ -1,5 +1,6 @@
 $schema: profile_class_schema.json#
 kind: profile class
+processor_kind: Microcontroller
 name: MockProfileClass
 marketing_name: Mock Profile Class
 introduction: Here's the Mock Profile Class introduction.
diff --git a/arch/profile_class/RVA.yaml b/arch/profile_class/RVA.yaml
@@ -2,6 +2,7 @@
 
 $schema: profile_class_schema.json#
 kind: profile class
+processor_kind: Apps Processor
 name: RVA
 marketing_name: RVA
 introduction: |
diff --git a/arch/profile_class/RVB.yaml b/arch/profile_class/RVB.yaml
@@ -1,5 +1,6 @@
 $schema: profile_class_schema.json#
 kind: profile class
+processor_kind: Apps Processor
 name: RVB
 marketing_name: RVB
 introduction: |
diff --git a/arch/profile_class/RVI.yaml b/arch/profile_class/RVI.yaml
@@ -1,5 +1,6 @@
 $schema: profile_class_schema.json#
 kind: profile class
+processor_kind: Generic Unprivileged
 name: RVI
 marketing_name: RVI
 introduction: The RVI profile class documents the initial set of unprivileged instructions.
diff --git a/backends/profile_doc/templates/profile.adoc.erb b/backends/profile_doc/templates/profile.adoc.erb
@@ -403,6 +403,20 @@ associated implementation-defined parameters.
 [appendix]
 == Profile Comparisons
 
+=== Processor Kind Comparison
+
+The <%= profile_class.processor_kind %> processor kind has <%= profile_class.profile_releases.filter_processor_kind.size %> processor
+profile releases that reference a total of <%= profile_class.filter_processor_kind.referenced_extensions.size %> extensions.
+
+.Extension Presence
+|===
+| Extension | <%= profile_class.profile_releases.filter_processor_kind.map(&:marketing_name).join(" | ") %>
+
+<% profile_class.filter_processor_kind.referenced_extensions.sort_by(&:name).each do |ext| -%>
+| <%= ext.name %> | <%= profile_class.profile_releases.filter_processor_kind.map { |profile_release| profile_release.extension_presence(ext.name) }.join(" | ") %>
+<% end -%>
+|===
+
 === Release Comparison
 
 The <%= profile_class.marketing_name %> Profile Class has <%= profile_class.profile_releases.size %> releases that
diff --git a/lib/arch_obj_models/csr.rb b/lib/arch_obj_models/csr.rb
@@ -3,7 +3,7 @@
 require_relative "obj"
 
 # CSR definition
-class Csr < DatabaseObjectect
+class Csr < DatabaseObject
   def ==(other)
     if other.is_a?(Csr)
       name == other.name
diff --git a/lib/arch_obj_models/csr_field.rb b/lib/arch_obj_models/csr_field.rb
@@ -5,7 +5,7 @@
 require_relative "../idl/passes/gen_option_adoc"
 
 # A CSR field object
-class CsrField < DatabaseObjectect
+class CsrField < DatabaseObject
   # @return [Csr] The Csr that defines this field
   attr_reader :parent
 
diff --git a/lib/arch_obj_models/extension.rb b/lib/arch_obj_models/extension.rb
@@ -125,7 +125,7 @@ def initialize(param, value)
 end
 
 # Extension definition
-class Extension < DatabaseObjectect
+class Extension < DatabaseObject
   # @return [ConfiguredArchitecture] The architecture defintion
   attr_reader :cfg_arch
 
diff --git a/lib/arch_obj_models/instruction.rb b/lib/arch_obj_models/instruction.rb
@@ -6,7 +6,7 @@
 
 
 # model of a specific instruction in a specific base (RV32/RV64)
-class Instruction < DatabaseObjectect
+class Instruction < DatabaseObject
   def self.ary_from_location(location_str_or_int)
     return [location_str_or_int] if location_str_or_int.is_a?(Integer)
 
diff --git a/lib/arch_obj_models/manual.rb b/lib/arch_obj_models/manual.rb
@@ -4,7 +4,7 @@
 
 require_relative "obj"
 
-class Manual < DatabaseObjectect
+class Manual < DatabaseObject
   def versions
     return @versions unless @versions.nil?
 
@@ -121,7 +121,7 @@ def repo_path=(path)
   end
 end
 
-class ManualVersion < DatabaseObjectect
+class ManualVersion < DatabaseObject
   # @return [Manual] The manual this version belongs to
   def manual
     return @manual unless @manual.nil?
diff --git a/lib/arch_obj_models/obj.rb b/lib/arch_obj_models/obj.rb
@@ -11,7 +11,7 @@
 #          ...
 #        }
 #
-#     obj = DatabaseObjectect.new(data)
+#     obj = DatabaseObject.new(data)
 #     obj['name']    # 'mstatus'
 #     obj['address'] # 0x320
 #
@@ -24,7 +24,7 @@
 # Subclasses may override the accessors when a more complex data structure
 # is warranted, e.g., the CSR Field 'alias' returns a CsrFieldAlias object
 # instead of a simple string
-class DatabaseObjectect
+class DatabaseObject
   # Exception raised when there is a problem with a schema file
   class SchemaError < ::StandardError
     # result from JsonSchemer.validate
@@ -206,7 +206,7 @@ def inspect
   extend Forwardable
   def_delegator :@data, :[]
 
-  # @return [Array<String>] List of keys added by this DatabaseObjectect
+  # @return [Array<String>] List of keys added by this DatabaseObject
   def keys = @data.keys
 
   # @param k (see Hash#key?)
diff --git a/lib/arch_obj_models/portfolio.rb b/lib/arch_obj_models/portfolio.rb
@@ -4,7 +4,7 @@
 #   RVA20U64 and MC100 are examples of portfolio instances
 #   RVA and MC are examples of portfolio classes
 #
-# Many classes inherit from the DatabaseObjectect class. This provides facilities for accessing the contents of a
+# Many classes inherit from the DatabaseObject class. This provides facilities for accessing the contents of a
 # Portfolio Class YAML or Portfolio Model YAML file via the "data" member (hash holding releated YAML file contents).
 #
 # A variable name with a "_data" suffix indicates it is the raw hash data from the porfolio YAML file.
@@ -20,10 +20,13 @@
 
 # Holds information from Portfolio class YAML file (certificate class or profile class).
 # The inherited "data" member is the database of extensions, instructions, CSRs, etc.
-class PortfolioClass < DatabaseObjectect
+class PortfolioClass < DatabaseObject
   # @return [ConfiguredArchitecture] The defining ConfiguredArchitecture
   attr_reader :cfg_arch
 
+  # @return [String] What kind of processor portfolio is this?
+  def processor_kind = @data["processor_kind"]
+
   # @return [String] Small enough (~1 paragraph) to be suitable immediately after a higher-level heading.
   def introduction = @data["introduction"]
 
@@ -42,7 +45,7 @@ def eql?(other)
 
 # Holds information about a PortfolioInstance YAML file (certificate or profile).
 # The inherited "data" member is the database of extensions, instructions, CSRs, etc.
-class PortfolioInstance < DatabaseObjectect
+class PortfolioInstance < DatabaseObject
   # @return [ConfiguredArchitecture] The defining ConfiguredArchitecture
   attr_reader :cfg_arch
 
diff --git a/lib/arch_obj_models/profile.rb b/lib/arch_obj_models/profile.rb
@@ -30,6 +30,11 @@ def profile_releases
     @profile_releases
   end
 
+  # @return [Array<ProfileRelease>] Defined profile releases of this processor class
+  def profile_releases_matching_processor_kind
+
+  end
+
   # @return [Array<Profile>] All profiles in this profile class (for all releases).
   def profiles
     return @profiles unless @profiles.nil?
@@ -64,7 +69,7 @@ def referenced_extensions
 # For example, the RVA20 profile release has profiles RVA20U64 and RVA20S64.
 # Note there is no Portfolio* base class for a ProfileRelease to inherit from since there is no
 # equivalent to a ProfileRelease in a Certificate so no potential for a shared base class.
-class ProfileRelease < DatabaseObjectect
+class ProfileRelease < DatabaseObject
   def marketing_name = @data["marketing_name"]
 
   # @return [String] Small enough (~1 paragraph) to be suitable immediately after a higher-level heading.
diff --git a/lib/architecture.rb b/lib/architecture.rb
@@ -150,7 +150,7 @@ def self.generate_obj_methods(fn_name, arch_dir, obj_class)
     generate_obj_methods(obj_info[:fn_name], obj_info[:arch_dir], obj_info[:klass])
   end
 
-  # @return [Array<DatabaseObjectect>] All known objects
+  # @return [Array<DatabaseObject>] All known objects
   def objs
     return @objs unless @objs.nil?
 
diff --git a/lib/cfg_arch.rb b/lib/cfg_arch.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Many classes have an "cfg_arch" member which is an ConfiguredArchitecture (not DatabaseObjectect) class.
+# Many classes have an "cfg_arch" member which is an ConfiguredArchitecture (not DatabaseObject) class.
 # The "cfg_arch" member contains the "database" of RISC-V standards including extensions, instructions,
 # CSRs, Profiles, and Certificates.
 #
diff --git a/schemas/cert_class_schema.json b/schemas/cert_class_schema.json
@@ -22,6 +22,11 @@
       "type": "string",
       "description": "Descriptive name of the class"
     },
+    "processor_kind": {
+      "type": "string",
+      "enum": ["Generic Unprivileged", "Microcontroller", "Apps Processor"],
+      "description": "What kind of class is this?"
+    },
     "introduction": {
       "type": "string",
       "description": "Asciidoc text containing the introduction prose for the class"
diff --git a/schemas/profile_class_schema.json b/schemas/profile_class_schema.json
@@ -12,6 +12,11 @@
       "type": "string",
       "const": "profile class"
     },
+    "processor_kind": {
+      "type": "string",
+      "enum": ["Generic Unprivileged", "Microcontroller", "Apps Processor"],
+      "description": "What kind of class is this?"
+    },
     "name": {
       "type": "string",
       "description": "Name (database key) of this Profile Class"
