rggen-default-register-map 0.24.0 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31786d4f412d28362fe13510c065488bdcc4f630e70323d8bfd00f18252d4889
-  data.tar.gz: 2acbf4af3aecaf5b95e2f209b995a9c7a2638e19e3ded7b77c097f9161472e8d
+  metadata.gz: 4a0b6e48b3b6da6739cbe958694f2a1cf45f22532b41fcc47f7d1eb6cc10869e
+  data.tar.gz: 3eaf3ebd9bd36133bd024cf65858fee3349322c65a43071bfd8b0dd390e4b067
 SHA512:
-  metadata.gz: 1b04ed8512a8cdc99e43864778926d59d1497d00a99c031eaea61887104d993ebdb84e8034ee6ae09fccd5e8b22b552761c0dbad1332c95aa96a9d47c9922a92
-  data.tar.gz: a1ace1cd824758b1f6a349d4586d04b05bee0f48a2c17a6f4d49375a7895b80573d654871e0c254578fb79681a98d244323ebc3f6bcd548b4c0119a6f1ea1703
+  metadata.gz: e76010e8a516197774b91c23a738c4c7b510e351d083a4bdb9c4b2e6455037e801f451ffdfc2bb58f45a23cb3904ddd25995f8c2eddb40da4e1dde396c82f208
+  data.tar.gz: 33edbad2da7140c757901aa8bebdae1b17fbe81209e51864fde2ef7be7d41d8fd971ad7e861fa60075eeb27ab76a97347d6080e387811343fc72713e8932a17c

data/lib/rggen/default_register_map.rb

@@ -39,6 +39,7 @@ module RgGen
         'default_register_map/register/type',
         'default_register_map/register/type/external',
         'default_register_map/register/type/indirect',
+        'default_register_map/register/type/reserved',
         'default_register_map/register_block/byte_size',
         'default_register_map/register_block/name',
         'default_register_map/register_file/name',

data/lib/rggen/default_register_map/bit_field/bit_assignment.rb

@@ -1,6 +1,19 @@
 # frozen_string_literal: true
 
 RgGen.define_simple_feature(:bit_field, :bit_assignment) do
+  configuration do
+    property :bit_assignment, default: :width_first
+
+    input_pattern [width_first: /width_first/i, lsb_first: /lsb_first/i]
+    ignore_empty_value false
+
+    build do |value|
+      pattern_matched? ||
+        (error "illegal input value for bit assignment: #{value.inspect}")
+      @bit_assignment = match_index
+    end
+  end
+
   register_map do
     property :lsb, forward_to: :lsb_bit
     property :msb, forward_to: :msb_bit
@@ -15,7 +28,9 @@ RgGen.define_simple_feature(:bit_field, :bit_assignment) do
 
     build do |value|
       input_value = preprocess(value)
-      helper.variable_keys.each { |key| parse_value(input_value, key) }
+      helper.variable_names.each do |key, variable_name|
+        parse_value(input_value, key, variable_name)
+      end
     end
 
     verify(:feature) do
@@ -64,13 +79,9 @@ RgGen.define_simple_feature(:bit_field, :bit_assignment) do
     define_helpers do
       def variable_names
         @variable_names ||= {
-          lsb: :@lsb_base, width: :@width, sequence_size: :@sequence_size, step: :@step
+          width: :@width, lsb: :@lsb_base, sequence_size: :@sequence_size, step: :@step
         }.freeze
       end
-
-      def variable_keys
-        @variable_keys ||= variable_names.keys
-      end
     end
 
     def preprocess(value)
@@ -87,13 +98,24 @@ RgGen.define_simple_feature(:bit_field, :bit_assignment) do
       match_data
         .to_s
         .split(':')
-        .map.with_index { |value, i| [helper.variable_keys[i], value] }
+        .map.with_index { |value, i| [variable_key(i), value] }
         .to_h
     end
 
-    def parse_value(input_value, key)
+    def variable_key(index)
+      @keys ||=
+        if configuration.bit_assignment == :width_first
+          helper.variable_names.keys
+        else
+          keys = helper.variable_names.keys
+          [keys[1], keys[0], *keys[2..-1]]
+        end
+      @keys[index]
+    end
+
+    def parse_value(input_value, key, variable_name)
       input_value.key?(key) &&
-        instance_variable_set(helper.variable_names[key], Integer(input_value[key]))
+        instance_variable_set(variable_name, Integer(input_value[key]))
     rescue ArgumentError, TypeError
       error "cannot convert #{input_value[key].inspect} into " \
             "bit assignment(#{key.to_s.tr('_', ' ')})"

data/lib/rggen/default_register_map/bit_field/type.rb

@@ -82,6 +82,11 @@ RgGen.define_list_feature(:bit_field, :type) do
 
       build { |value| @type = value }
 
+      build do |value|
+        @type = value
+        helper.reserved? && bit_field.document_only
+      end
+
       printable :type
 
       private

data/lib/rggen/default_register_map/global/address_width.rb

@@ -5,12 +5,9 @@ RgGen.define_simple_feature(:global, :address_width) do
     property :address_width, default: 32
 
     build do |value|
-      @address_width =
-        begin
-          Integer(value)
-        rescue ArgumentError, TypeError
-          error "cannot convert #{value.inspect} into address width"
-        end
+      @address_width = Integer(value)
+    rescue ArgumentError, TypeError
+      error "cannot convert #{value.inspect} into address width"
     end
 
     verify(:component) do

data/lib/rggen/default_register_map/global/bus_width.rb

@@ -6,12 +6,9 @@ RgGen.define_simple_feature(:global, :bus_width) do
     property :byte_width, initial: -> { bus_width / 8 }
 
     build do |value|
-      @bus_width =
-        begin
-          Integer(value)
-        rescue ArgumentError, TypeError
-          error "cannot convert #{value.inspect} into bus width"
-        end
+      @bus_width = Integer(value)
+    rescue ArgumentError, TypeError
+      error "cannot convert #{value.inspect} into bus width"
     end
 
     verify(:feature) do

data/lib/rggen/default_register_map/register/offset_address.rb

@@ -5,15 +5,12 @@ RgGen.define_simple_feature(:register, :offset_address) do
     property :offset_address, initial: -> { default_offset_address }
     property :expanded_offset_addresses, forward_to: :expand_addresses
     property :address_range, initial: -> { start_address..end_address }
-    property :overlap?, forward_to: :overlap_address_range?
+    property :overlap?, body: ->(other) { overlap_address_range?(other, false) }
 
     build do |value|
-      @offset_address =
-        begin
-          Integer(value)
-        rescue ArgumentError, TypeError
-          error "cannot convert #{value.inspect} into offset address"
-        end
+      @offset_address = Integer(value)
+    rescue ArgumentError, TypeError
+      error "cannot convert #{value.inspect} into offset address"
     end
 
     verify(:feature) do
@@ -44,7 +41,7 @@ RgGen.define_simple_feature(:register, :offset_address) do
     verify(:component) do
       error_condition do
         files_and_registers.any? do |other|
-          overlap_address_range?(other) && exclusive_range?(other)
+          overlap_address_range?(other, true)
         end
       end
       message do
@@ -96,8 +93,9 @@ RgGen.define_simple_feature(:register, :offset_address) do
       configuration.byte_width
     end
 
-    def overlap_address_range?(other)
-      overlap_range?(other) && competitive_access?(other)
+    def overlap_address_range?(other, sharable)
+      overlap_range?(other) &&
+        (exclusive_range?(other) || competitive_access?(other, sharable))
     end
 
     def overlap_range?(other)
@@ -106,13 +104,17 @@ RgGen.define_simple_feature(:register, :offset_address) do
       self_range.include?(othre_range.first) || othre_range.include?(self_range.first)
     end
 
-    def competitive_access?(other)
-      other.register_file? ||
+    def exclusive_range?(other)
+      other.register_file? || other.reserved? || register.reserved?
+    end
+
+    def competitive_access?(other, sharable)
+      !sharable_range?(other, sharable) &&
         [:writable?, :readable?].any? { |access| [register, other].all?(&access) }
     end
 
-    def exclusive_range?(other)
-      other.register_file? || !(shared_address? && register.match_type?(other))
+    def sharable_range?(other, sharable)
+      sharable && shared_address? && register.match_type?(other)
     end
 
     def shared_address?

data/lib/rggen/default_register_map/register/type.rb

@@ -40,6 +40,7 @@ RgGen.define_list_feature(:register, :type) do
       property :match_type?, body: ->(register) { register.type == type }
       property :writable?, initial: -> { writability }
       property :readable?, initial: -> { readability }
+      property :reserved?, initial: -> { !(writable? || readable?) }
       property :settings, forward_to_helper: true
 
       build do |value|
@@ -48,6 +49,10 @@ RgGen.define_list_feature(:register, :type) do
         helper.need_bit_fields? || register.need_no_children
       end
 
+      post_build do
+        reserved? && register.document_only
+      end
+
       verify(:component) do
         error_condition do
           helper.need_bit_fields? && register.bit_fields.empty?
@@ -62,22 +67,13 @@ RgGen.define_list_feature(:register, :type) do
       attr_reader :options
 
       def writability
-        instance_exec(&(helper.writability || default_writability))
-      end
-
-      def default_writability
-        -> { register.bit_fields.any?(&:writable?) }
+        block = helper.writability || -> { register.bit_fields.any?(&:writable?) }
+        instance_exec(&block)
       end
 
       def readability
-        instance_exec(&(helper.readability || default_readability))
-      end
-
-      def default_readability
-        lambda do
-          block = ->(bit_field) { bit_field.readable? || bit_field.reserved? }
-          register.bit_fields.any?(&block)
-        end
+        block = helper.readability || -> { register.bit_fields.any?(&:readable?) }
+        instance_exec(&block)
       end
     end
 

data/lib/rggen/default_register_map/register/type/reserved.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+RgGen.define_list_item_feature(:register, :type, :reserved) do
+  register_map do
+    writable? { false }
+    readable? { false }
+    no_bit_fields
+    support_array_register
+  end
+end

data/lib/rggen/default_register_map/register_block/byte_size.rb

@@ -6,13 +6,10 @@ RgGen.define_simple_feature(:register_block, :byte_size) do
     property :local_address_width
 
     build do |value|
-      @byte_size =
-        begin
-          Integer(value)
-        rescue ArgumentError, TypeError
-          error "cannot convert #{value.inspect} into byte size"
-        end
+      @byte_size = Integer(value)
       @local_address_width = (@byte_size - 1).bit_length
+    rescue ArgumentError, TypeError
+      error "cannot convert #{value.inspect} into byte size"
     end
 
     verify(:feature) do

data/lib/rggen/default_register_map/register_file/offset_address.rb

@@ -7,12 +7,9 @@ RgGen.define_simple_feature(:register_file, :offset_address) do
     property :address_range, initial: -> { start_address..end_address }
 
     build do |value|
-      @offset_address =
-        begin
-          Integer(value)
-        rescue ArgumentError, TypeError
-          error "cannot convert #{value.inspect} into offset address"
-        end
+      @offset_address = Integer(value)
+    rescue ArgumentError, TypeError
+      error "cannot convert #{value.inspect} into offset address"
     end
 
     verify(:feature) do

data/lib/rggen/default_register_map/setup.rb

@@ -13,7 +13,7 @@ RgGen.register_plugin RgGen::DefaultRegisterMap do |builder|
   builder.enable :register, [
     :name, :offset_address, :size, :type, :comment
   ]
-  builder.enable :register, :type, [:external, :indirect]
+  builder.enable :register, :type, [:external, :indirect, :reserved]
   builder.enable :bit_field, [
     :name, :bit_assignment, :type, :initial_value, :reference, :comment
   ]

data/lib/rggen/default_register_map/version.rb

@@ -2,6 +2,6 @@
 
 module RgGen
   module DefaultRegisterMap
-    VERSION = '0.24.0'
+    VERSION = '0.25.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rggen-default-register-map
 version: !ruby/object:Gem::Version
-  version: 0.24.0
+  version: 0.25.0
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-20 00:00:00.000000000 Z
+date: 2021-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,7 @@ files:
 - lib/rggen/default_register_map/register/type.rb
 - lib/rggen/default_register_map/register/type/external.rb
 - lib/rggen/default_register_map/register/type/indirect.rb
+- lib/rggen/default_register_map/register/type/reserved.rb
 - lib/rggen/default_register_map/register_block/byte_size.rb
 - lib/rggen/default_register_map/register_block/name.rb
 - lib/rggen/default_register_map/register_file/name.rb
@@ -89,7 +90,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -99,5 +100,5 @@ requirements: []
 rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
-summary: rggen-default-register-map-0.24.0
+summary: rggen-default-register-map-0.25.0
 test_files: []