rggen-default-register-map 0.16.0 → 0.21.0

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

@@ -7,12 +7,9 @@ RgGen.define_simple_feature(:register_block, :name) do
     input_pattern variable_name
 
     build do |value|
-      @name =
-        if pattern_matched?
-          match_data.to_s
-        else
-          error "illegal input value for register block name: #{value.inspect}"
-        end
+      pattern_matched? ||
+        (error "illegal input value for register block name: #{value.inspect}")
+      @name = match_data.to_s
     end
 
     verify(:feature) do
@@ -30,9 +27,7 @@ RgGen.define_simple_feature(:register_block, :name) do
     private
 
     def duplicated_name?
-      register_map
-        .register_blocks
-        .any? { |register_block| register_block.name == name }
+      register_blocks.any? { |register_block| register_block.name == name }
     end
   end
 end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+RgGen.define_simple_feature(:register_file, :name) do
+  register_map do
+    property :name
+    property :full_name, forward_to: :get_full_name
+
+    input_pattern variable_name
+
+    build do |value|
+      pattern_matched? ||
+        (error "illegal input value for register file name: #{value.inspect}")
+      @name = match_data.to_s
+    end
+
+    verify(:feature) do
+      error_condition { !name }
+      message { 'no register file name is given' }
+    end
+
+    verify(:feature) do
+      error_condition { duplicated_name? }
+      message { "duplicated register file name: #{name}" }
+    end
+
+    printable(:name) do
+      array_name
+    end
+
+    printable(:layer_name) do
+      [
+        register_file(:upper)&.printables&.fetch(:layer_name),
+        array_name
+      ].compact.join('.')
+    end
+
+    private
+
+    def get_full_name(separator = '.')
+      [*register_file(:upper)&.full_name(separator), name].join(separator)
+    end
+
+    def duplicated_name?
+      files_and_registers
+        .any? { |file_or_register| file_or_register.name == name }
+    end
+
+    def array_name
+      RgGen::Core::Utility::CodeUtility
+        .array_name(name, register_file.array_size)
+    end
+  end
+end

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

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+RgGen.define_simple_feature(:register_file, :offset_address) do
+  register_map do
+    property :offset_address, initial: -> { defalt_offset_address }
+    property :expanded_offset_addresses, forward_to: :expand_addresses
+    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
+    end
+
+    verify(:feature) do
+      error_condition { offset_address.negative? }
+      message { "offset address is less than 0: #{offset_address}" }
+    end
+
+    verify(:feature) do
+      error_condition { (offset_address % byte_width).nonzero? }
+      message do
+        "offset address is not aligned with bus width(#{bus_width}): " \
+        "0x#{offset_address.to_s(16)}"
+      end
+    end
+
+    verify(:component) do
+      error_condition do
+        register_file.parent.register_block? &&
+          end_address > register_block.byte_size
+      end
+      message do
+        'offset address range exceeds byte size of register block' \
+        "(#{register_block.byte_size}): " \
+        "0x#{start_address.to_s(16)}-0x#{end_address.to_s(16)}"
+      end
+    end
+
+    verify(:component) do
+      error_condition do
+        files_and_registers.any?(&method(:overlap_address_range?))
+      end
+      message do
+        'offset address range overlaps with other offset address range: ' \
+        "0x#{start_address(true).to_s(16)}-0x#{end_address(true).to_s(16)}"
+      end
+    end
+
+    printable(:offset_address) do
+      expand_addresses.map(&method(:format_address))
+    end
+
+    private
+
+    def defalt_offset_address
+      register_file.component_index.zero? && 0 ||
+        (previous_component.offset_address + previous_component.byte_size)
+    end
+
+    def previous_component
+      index = register_file.component_index - 1
+      block_or_file.files_and_registers[index]
+    end
+
+    def start_address(full = false)
+      full && expand_addresses.first || offset_address
+    end
+
+    def end_address(full = false)
+      start_address(full) + register_file.byte_size - 1
+    end
+
+    def expand_addresses
+      uppser_addresses = register_file(:upper)&.expanded_offset_addresses || [0]
+      uppser_addresses.product(expand_local_addresses).map(&:sum)
+    end
+
+    def expand_local_addresses
+      Array.new(register_file.array_size&.inject(:*) || 1) do |i|
+        offset_address + register_file.byte_size(false) * i
+      end
+    end
+
+    def overlap_address_range?(other)
+      self_range = address_range
+      other_range = other.address_range
+      self_range.include?(other_range.first) || other_range.include?(self_range.first)
+    end
+
+    def bus_width
+      configuration.bus_width
+    end
+
+    def byte_width
+      configuration.byte_width
+    end
+
+    def format_address(address)
+      print_width = (register_block.local_address_width.to_f / 4.0).ceil
+      format('0x%0*x', print_width, address)
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+RgGen.define_simple_feature(:register_file, :size) do
+  register_map do
+    property :size
+    property :byte_size, forward_to: :calc_byte_size
+    property :array?, body: -> { !@size.nil? }
+    property :array_size, forward_to: :size
+    property :count, forward_to: :calc_count
+
+    input_pattern [
+      /(#{integer}(:?,#{integer})*)/,
+      /\[(#{integer}(:?,#{integer})*)\]/
+    ], match_automatically: false
+
+    build do |values|
+      @size =
+        (values.is_a?(String) && parse_string_value(values) || Array(values))
+          .map(&method(:convert_value))
+    end
+
+    verify(:feature) do
+      error_condition { array? && !size.all?(&:positive?) }
+      message do
+        "non positive value(s) are not allowed for register file size: #{size}"
+      end
+    end
+
+    private
+
+    def parse_string_value(value)
+      match_pattern(value) && match_data.captures.first.split(',') ||
+        (error "illegal input value for register file size: #{value.inspect}")
+    end
+
+    def convert_value(value)
+      Integer(value)
+    rescue ArgumentError, TypeError
+      error "cannot convert #{value.inspect} into register file size"
+    end
+
+    def calc_byte_size(whole_size = true)
+      (whole_size ? total_entries : 1) * entry_byte_size
+    end
+
+    def entry_byte_size
+      register_file.files_and_registers
+        .map { |r| r.offset_address + r.byte_size }.max
+    end
+
+    def calc_count(whole_count = true)
+      (whole_count ? total_entries : 1) *
+        register_file.files_and_registers.sum(&:count)
+    end
+
+    def total_entries
+      size&.inject(:*) || 1
+    end
+  end
+end

data/lib/rggen/default_register_map/setup.rb

@@ -4,8 +4,15 @@ require 'rggen/default_register_map'
 
 RgGen.setup :'rggen-defualt-register-map', RgGen::DefaultRegisterMap do |builder|
   builder.enable :global, [:bus_width, :address_width]
-  builder.enable :register_block, [:name, :byte_size]
-  builder.enable :register, [:name, :offset_address, :size, :type]
+  builder.enable :register_block, [
+    :name, :byte_size, :comment
+  ]
+  builder.enable :register_file, [
+    :name, :offset_address, :size, :comment
+  ]
+  builder.enable :register, [
+    :name, :offset_address, :size, :type, :comment
+  ]
   builder.enable :register, :type, [:external, :indirect]
   builder.enable :bit_field, [
     :name, :bit_assignment, :type, :initial_value, :reference, :comment
@@ -14,6 +21,6 @@ RgGen.setup :'rggen-defualt-register-map', RgGen::DefaultRegisterMap do |builder
     :rc, :reserved, :ro, :rof, :rs,
     :rw, :rwc, :rwe, :rwl, :rws,
     :w0c, :w0crs, :w0s, :w0src, :w0trg,
-    :w1c, :w1crs, :w1s, :w1src, :w1trg, :wo
+    :w1, :w1c, :w1crs, :w1s, :w1src, :w1trg, :wo, :wo1
   ]
 end

data/lib/rggen/default_register_map/version.rb

@@ -2,6 +2,6 @@
 
 module RgGen
   module DefaultRegisterMap
-    VERSION = '0.16.0'
+    VERSION = '0.21.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rggen-default-register-map
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-01 00:00:00.000000000 Z
+date: 2020-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -36,7 +36,6 @@ files:
 - README.md
 - lib/rggen/default_register_map.rb
 - lib/rggen/default_register_map/bit_field/bit_assignment.rb
-- lib/rggen/default_register_map/bit_field/comment.rb
 - lib/rggen/default_register_map/bit_field/initial_value.rb
 - lib/rggen/default_register_map/bit_field/name.rb
 - lib/rggen/default_register_map/bit_field/reference.rb
@@ -46,14 +45,15 @@ files:
 - lib/rggen/default_register_map/bit_field/type/ro.rb
 - lib/rggen/default_register_map/bit_field/type/rof.rb
 - lib/rggen/default_register_map/bit_field/type/rs.rb
-- lib/rggen/default_register_map/bit_field/type/rw.rb
+- lib/rggen/default_register_map/bit_field/type/rw_w1.rb
 - lib/rggen/default_register_map/bit_field/type/rwc_rws.rb
 - lib/rggen/default_register_map/bit_field/type/rwe_rwl.rb
 - lib/rggen/default_register_map/bit_field/type/w0c_w1c.rb
 - lib/rggen/default_register_map/bit_field/type/w0crs_w1crs_w0src_w1src.rb
 - lib/rggen/default_register_map/bit_field/type/w0s_w1s.rb
 - lib/rggen/default_register_map/bit_field/type/w0trg_w1trg.rb
-- lib/rggen/default_register_map/bit_field/type/wo.rb
+- lib/rggen/default_register_map/bit_field/type/wo_wo1.rb
+- lib/rggen/default_register_map/common/comment.rb
 - lib/rggen/default_register_map/global/address_width.rb
 - lib/rggen/default_register_map/global/bus_width.rb
 - lib/rggen/default_register_map/register/name.rb
@@ -64,6 +64,9 @@ files:
 - lib/rggen/default_register_map/register/type/indirect.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
+- lib/rggen/default_register_map/register_file/offset_address.rb
+- lib/rggen/default_register_map/register_file/size.rb
 - lib/rggen/default_register_map/setup.rb
 - lib/rggen/default_register_map/version.rb
 homepage: https://github.com/rggen/rggen-default-register-map
@@ -82,15 +85,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: rggen-default-register-map-0.16.0
+summary: rggen-default-register-map-0.21.0
 test_files: []

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

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-RgGen.define_simple_feature(:bit_field, :comment) do
-  register_map do
-    property :comment, body: -> { @comment ||= '' }
-
-    build do |value|
-      @comment =
-        if value.is_a?(Array)
-          value.join("\n")
-        else
-          value.to_s
-        end
-    end
-
-    printable :comment
-  end
-end