rggen-duh 0.1.0

data/lib/rggen/duh/extractor/bit_assignment.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RgGen.define_value_extractor(:register_map, :duh, :bit_field, :bit_assignment) do
+  extract { |duh| { lsb: duh['bitOffset'], width: duh['bitWidth'] } }
+end

data/lib/rggen/duh/extractor/simple_extractors.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+{
+  byte_size: ['range', [:register_block]],
+  comment: ['description', [:register, :bit_field]],
+  initial_value: ['resetValue', [:bit_field]],
+  name: ['name'],
+  offset_address: ['addressOffset', [:register_file, :register]]
+}.each do |value, (key, layers)|
+  RgGen.define_value_extractor(:register_map, :duh, *[layers, value].compact) do
+    extract { |duh| duh[key] }
+  end
+end

data/lib/rggen/duh/extractor/type.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+RgGen.define_value_extractor(:register_map, :duh, :bit_field, :type) do
+  extract { |duh| find_type(duh) }
+
+  private
+
+  TYPE_MAP = {
+    rw: {
+      access: 'read-write', modified_write_value: 'default',
+      read_action: 'default', reserved: false
+    },
+    ro: {
+      access: 'read-only', read_action: 'default', reserved: false
+    },
+    wo: {
+      access: 'write-only', modified_write_value: 'default', reserved: false
+    },
+    rc: {
+      access: 'read-only', read_action: 'clear', reserved: false
+    },
+    w0c: {
+      access: 'read-write', modified_write_value: 'zeroToClear',
+      read_action: 'default', reserved: false
+    },
+    w1c: {
+      access: 'read-write', modified_write_value: 'oneToClear',
+      read_action: 'default', reserved: false
+    },
+    rs: {
+      access: 'read-only', read_action: 'set', reserved: false
+    },
+    w0s: {
+      access: 'read-write', modified_write_value: 'zeroToSet',
+      read_action: 'default', reserved: false
+    },
+    w1s: {
+      access: 'read-write', modified_write_value: 'oneToSet',
+      read_action: 'default', reserved: false
+    },
+    w0t: {
+      access: 'read-write', modified_write_value: 'zeroToToggle',
+      read_action: 'default', reserved: false
+    },
+    w1t: {
+      access: 'read-write', modified_write_value: 'oneToToggle',
+      read_action: 'default', reserved: false
+    },
+    w0crs: {
+      access: 'read-write', modified_write_value: 'zeroToClear',
+      read_action: 'set', reserved: false
+    },
+    w1crs: {
+      access: 'read-write', modified_write_value: 'oneToClear',
+      read_action: 'set', reserved: false
+    },
+    w0src: {
+      access: 'read-write', modified_write_value: 'zeroToSet',
+      read_action: 'clear', reserved: false
+    },
+    w1src: {
+      access: 'read-write', modified_write_value: 'oneToSet',
+      read_action: 'clear', reserved: false
+    },
+    w1: {
+      access: 'read-writeOnce', modified_write_value: 'default',
+      read_action: 'default', reserved: false
+    },
+    wo1: {
+      access: 'writeOnce', modified_write_value: 'default', reserved: false
+    },
+    reserved: {
+      reserved: true
+    }
+  }.freeze
+
+  def find_type(duh)
+    TYPE_MAP.find { |_, properties| match_properties?(duh, properties) }&.first
+  end
+
+  def match_properties?(duh, properties)
+    properties.all? { |name, value| __send__(name, duh) == value }
+  end
+
+  def access(duh)
+    if duh.key?('access')
+      duh['access']
+    elsif duh.layer == :register_block
+      'read-write'
+    else
+      access(duh.parent)
+    end
+  end
+
+  def modified_write_value(duh)
+    duh.fetch('modifiedWriteValue', 'default')
+  end
+
+  def read_action(duh)
+    duh.fetch('readAction', 'default')
+  end
+
+  def reserved(duh)
+    duh.fetch('reserved', false)
+  end
+end

data/lib/rggen/duh/loader.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module RgGen
+  module DUH
+    class Loader < Core::RegisterMap::Loader
+      support_types [:json5]
+
+      def disable_validation
+        @disable_validation = true
+      end
+
+      private
+
+      def read_file(file_name)
+        duh = JsonRefs.call(RbJSON5.load_file(file_name))
+        validation? && validate(duh, file_name)
+        duh
+      end
+
+      def validation?
+        !@disable_validation
+      end
+
+      def validate(duh, file_name)
+        errors = Schema.validate(duh)
+        errors.empty? || (raise ValidationFailed.new(file_name, errors))
+      end
+
+      SUB_LAYERS = {
+        root: [:register_block],
+        register_block: [:register_file, :register],
+        register_file: [:register],
+        register: [:bit_field]
+      }.freeze
+
+      def format_sub_layer_data(read_data, layer, _file)
+        SUB_LAYERS[layer]&.each_with_object({}) do |sub_layer, sub_layer_data|
+          data = __send__("collect_#{sub_layer}_data", read_data)
+          data && (sub_layer_data[sub_layer] = data)
+        end
+      end
+
+      def collect_register_block_data(read_data)
+        collect_address_blocks(read_data)
+          &.select { |address_block| address_block['usage'] == 'register' }
+          &.map { |data| add_parent_and_layer_properties(data, nil, :register_block) }
+      end
+
+      def collect_address_blocks(read_data)
+        read_data
+          .dig('component', 'memoryMaps')
+          &.flat_map { |memory_map| memory_map['addressBlocks'] }
+          &.compact
+      end
+
+      def collect_register_file_data(read_data)
+        read_data['registerFiles']&.map do |data|
+          add_parent_and_layer_properties(data, read_data, :register_file)
+        end
+      end
+
+      def collect_register_data(read_data)
+        read_data['registers']&.map do |data|
+          add_parent_and_layer_properties(data, read_data, :register)
+        end
+      end
+
+      def collect_bit_field_data(read_data)
+        read_data['fields']&.map do |data|
+          add_parent_and_layer_properties(data, read_data, :bit_field)
+        end
+      end
+
+      def add_parent_and_layer_properties(data, parent, layer)
+        data.instance_variable_set(:@parent, parent)
+        data.instance_variable_set(:@layer, layer)
+        class << data
+          attr_reader :parent
+          attr_reader :layer
+        end
+        data
+      end
+    end
+  end
+end

data/lib/rggen/duh/schema.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module RgGen
+  module DUH
+    module Schema
+      class << self
+        def validate(duh)
+          schema.validate(duh).to_a
+        end
+
+        private
+
+        def schema
+          @schema ||= build_schema
+        end
+
+        def build_schema
+          schema_data = read_schema
+          resolver = ->(uri) { uri.path == 'defs' && schema_data['defs'] || nil }
+          JSONSchemer.schema(schema_data['component'], ref_resolver: resolver)
+        end
+
+        def read_schema
+          path = File.join(__dir__, 'duh-schema', 'schema.json')
+          JSON.parse(File.read(path))
+        end
+      end
+    end
+  end
+end

data/lib/rggen/duh/setup.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'rggen/duh'
+RgGen.setup RgGen::DUH

data/lib/rggen/duh/validation_failed.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RgGen
+  module DUH
+    class ValidationFailed < RgGen::Core::LoadError
+      def initialize(file_name, errors)
+        super("input DUH file is invalid: #{file_name}")
+        @errors = errors
+      end
+
+      attr_reader :errors
+
+      def to_s
+        [
+          super,
+          *errors.map { |error| "  - #{JSONSchemer::Errors.pretty(error)}" }
+        ].join("\n")
+      end
+    end
+  end
+end

data/lib/rggen/duh/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RgGen
+  module DUH
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: rggen-duh
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Taichi Ishitani
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json_refs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: json_schemer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.12
+- !ruby/object:Gem::Dependency
+  name: rb_json5
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: DUH support for RgGen
+email:
+- rggen@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- lib/rggen/duh.rb
+- lib/rggen/duh/duh-schema/LICENSE
+- lib/rggen/duh/duh-schema/README.md
+- lib/rggen/duh/duh-schema/schema.json
+- lib/rggen/duh/extractor/bit_assignment.rb
+- lib/rggen/duh/extractor/simple_extractors.rb
+- lib/rggen/duh/extractor/type.rb
+- lib/rggen/duh/loader.rb
+- lib/rggen/duh/schema.rb
+- lib/rggen/duh/setup.rb
+- lib/rggen/duh/validation_failed.rb
+- lib/rggen/duh/version.rb
+homepage: https://github.com/rggen/rggen-dut
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/rggen/rggen-duh/issues
+  mailing_list_uri: https://groups.google.com/d/forum/rggen
+  source_code_uri: https://github.com/rggen/rggen-duh
+  wiki_uri: https://github.com/rggen/rggen/wiki
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: rggen-dut-0.1.0
+test_files: []