rggen 0.4.4 → 0.5.1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rggen
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.1
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-14 00:00:00.000000000 Z
+date: 2017-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: baby_erubis
@@ -110,7 +110,7 @@ dependencies:
         version: '0.35'
 description: |2
       RgGen is a code generation tool for SoC designers.
-      It will automatically generate source code for control registers in a SoC design, e.g. RTL, UVM RAL model, from its register map document.
+      It will automatically generate source code for control registers in a SoC design, e.g. RTL, UVM RAL model, C header file, from its register map document.
       Also RgGen is customizable so you can build your specific generate tool.
 email:
 - taichi730@gmail.com
@@ -123,6 +123,7 @@ files:
 - LICENSE.txt
 - README.md
 - bin/rggen
+- c/rggen.h
 - lib/rggen.rb
 - lib/rggen/base/component.rb
 - lib/rggen/base/component_factory.rb
@@ -146,19 +147,19 @@ files:
 - lib/rggen/builtins/bit_field/initial_value.rb
 - lib/rggen/builtins/bit_field/name.rb
 - lib/rggen/builtins/bit_field/reference.rb
-- lib/rggen/builtins/bit_field/reserved.rb
-- lib/rggen/builtins/bit_field/ro.erb
-- lib/rggen/builtins/bit_field/ro.rb
-- lib/rggen/builtins/bit_field/rw.erb
-- lib/rggen/builtins/bit_field/rw.rb
-- lib/rggen/builtins/bit_field/rwl_rwe.erb
-- lib/rggen/builtins/bit_field/rwl_rwe.rb
 - lib/rggen/builtins/bit_field/type.rb
-- lib/rggen/builtins/bit_field/w0c_w1c.erb
-- lib/rggen/builtins/bit_field/w0c_w1c.rb
-- lib/rggen/builtins/bit_field/w0s_w1s.erb
-- lib/rggen/builtins/bit_field/w0s_w1s.rb
-- lib/rggen/builtins/bit_field/wo.rb
+- lib/rggen/builtins/bit_field/types/reserved.rb
+- lib/rggen/builtins/bit_field/types/ro.erb
+- lib/rggen/builtins/bit_field/types/ro.rb
+- lib/rggen/builtins/bit_field/types/rw.erb
+- lib/rggen/builtins/bit_field/types/rw.rb
+- lib/rggen/builtins/bit_field/types/rwl_rwe.erb
+- lib/rggen/builtins/bit_field/types/rwl_rwe.rb
+- lib/rggen/builtins/bit_field/types/w0c_w1c.erb
+- lib/rggen/builtins/bit_field/types/w0c_w1c.rb
+- lib/rggen/builtins/bit_field/types/w0s_w1s.erb
+- lib/rggen/builtins/bit_field/types/w0s_w1s.rb
+- lib/rggen/builtins/bit_field/types/wo.rb
 - lib/rggen/builtins/global/address_width.rb
 - lib/rggen/builtins/global/data_width.rb
 - lib/rggen/builtins/loaders/configuration/json_loader.rb
@@ -166,34 +167,36 @@ files:
 - lib/rggen/builtins/loaders/register_map/csv_loader.rb
 - lib/rggen/builtins/loaders/register_map/xls_loader.rb
 - lib/rggen/builtins/loaders/register_map/xlsx_ods_loader.rb
-- lib/rggen/builtins/register/accessibility.rb
 - lib/rggen/builtins/register/address_decoder.erb
 - lib/rggen/builtins/register/address_decoder.rb
 - lib/rggen/builtins/register/array.rb
 - lib/rggen/builtins/register/bus_exporter.erb
 - lib/rggen/builtins/register/bus_exporter.rb
 - lib/rggen/builtins/register/constructor.rb
-- lib/rggen/builtins/register/external.rb
 - lib/rggen/builtins/register/field_model_creator.rb
+- lib/rggen/builtins/register/indirect_index_configurator.rb
 - lib/rggen/builtins/register/name.rb
 - lib/rggen/builtins/register/offset_address.rb
 - lib/rggen/builtins/register/read_data.rb
 - lib/rggen/builtins/register/reg_model.rb
-- lib/rggen/builtins/register/shadow.rb
-- lib/rggen/builtins/register/shadow_index_configurator.rb
 - lib/rggen/builtins/register/sub_block_model.rb
+- lib/rggen/builtins/register/type.rb
+- lib/rggen/builtins/register/types/external.rb
+- lib/rggen/builtins/register/types/indirect.rb
 - lib/rggen/builtins/register/uniqueness_validator.rb
-- lib/rggen/builtins/register_block/apb.erb
-- lib/rggen/builtins/register_block/apb.rb
-- lib/rggen/builtins/register_block/axi4lite.erb
-- lib/rggen/builtins/register_block/axi4lite.rb
+- lib/rggen/builtins/register_block/address_struct.rb
 - lib/rggen/builtins/register_block/base_address.rb
 - lib/rggen/builtins/register_block/block_model.rb
 - lib/rggen/builtins/register_block/byte_size.rb
+- lib/rggen/builtins/register_block/c_header_file.rb
 - lib/rggen/builtins/register_block/clock_reset.rb
 - lib/rggen/builtins/register_block/constructor.rb
 - lib/rggen/builtins/register_block/default_map_creator.rb
 - lib/rggen/builtins/register_block/host_if.rb
+- lib/rggen/builtins/register_block/host_ifs/apb.erb
+- lib/rggen/builtins/register_block/host_ifs/apb.rb
+- lib/rggen/builtins/register_block/host_ifs/axi4lite.erb
+- lib/rggen/builtins/register_block/host_ifs/axi4lite.rb
 - lib/rggen/builtins/register_block/irq_controller.erb
 - lib/rggen/builtins/register_block/irq_controller.rb
 - lib/rggen/builtins/register_block/name.rb
@@ -204,11 +207,22 @@ files:
 - lib/rggen/builtins/register_block/top_module.rb
 - lib/rggen/commands.rb
 - lib/rggen/core_components.rb
+- lib/rggen/core_components/c_header/item.rb
+- lib/rggen/core_components/c_header/setup.rb
+- lib/rggen/core_components/c_utility.rb
+- lib/rggen/core_components/c_utility/data_structure_definition.rb
+- lib/rggen/core_components/c_utility/source_file.rb
+- lib/rggen/core_components/c_utility/variable_declaration.rb
+- lib/rggen/core_components/code_utility.rb
+- lib/rggen/core_components/code_utility/code_block.rb
+- lib/rggen/core_components/code_utility/line.rb
+- lib/rggen/core_components/code_utility/source_file.rb
 - lib/rggen/core_components/configuration/configuration_factory.rb
 - lib/rggen/core_components/configuration/item.rb
 - lib/rggen/core_components/configuration/item_factory.rb
 - lib/rggen/core_components/configuration/raise_error.rb
 - lib/rggen/core_components/configuration/setup.rb
+- lib/rggen/core_components/erb_engine.rb
 - lib/rggen/core_components/ral/component.rb
 - lib/rggen/core_components/ral/item.rb
 - lib/rggen/core_components/ral/setup.rb
@@ -227,6 +241,15 @@ files:
 - lib/rggen/core_components/rtl/component.rb
 - lib/rggen/core_components/rtl/item.rb
 - lib/rggen/core_components/rtl/setup.rb
+- lib/rggen/core_components/verilog_utility.rb
+- lib/rggen/core_components/verilog_utility/class_definition.rb
+- lib/rggen/core_components/verilog_utility/declaration.rb
+- lib/rggen/core_components/verilog_utility/identifier.rb
+- lib/rggen/core_components/verilog_utility/module_definition.rb
+- lib/rggen/core_components/verilog_utility/package_definition.rb
+- lib/rggen/core_components/verilog_utility/source_file.rb
+- lib/rggen/core_components/verilog_utility/structure_definition.rb
+- lib/rggen/core_components/verilog_utility/subroutine_definition.rb
 - lib/rggen/core_extensions/array.rb
 - lib/rggen/core_extensions/facets.rb
 - lib/rggen/core_extensions/forwardable.rb
@@ -240,32 +263,24 @@ files:
 - lib/rggen/input_base/item_factory.rb
 - lib/rggen/input_base/loader.rb
 - lib/rggen/input_base/regexp_patterns.rb
-- lib/rggen/output_base/code_block.rb
-- lib/rggen/output_base/code_utility.rb
+- lib/rggen/output_base/code_generator.rb
 - lib/rggen/output_base/component.rb
 - lib/rggen/output_base/component_factory.rb
+- lib/rggen/output_base/file_writer.rb
 - lib/rggen/output_base/item.rb
 - lib/rggen/output_base/item_factory.rb
-- lib/rggen/output_base/line.rb
-- lib/rggen/output_base/template_utility.rb
-- lib/rggen/output_base/verilog_utility.rb
-- lib/rggen/output_base/verilog_utility/class_definition.rb
-- lib/rggen/output_base/verilog_utility/declaration.rb
-- lib/rggen/output_base/verilog_utility/identifier.rb
-- lib/rggen/output_base/verilog_utility/module_definition.rb
-- lib/rggen/output_base/verilog_utility/package_definition.rb
-- lib/rggen/output_base/verilog_utility/structure_definition.rb
-- lib/rggen/output_base/verilog_utility/subroutine_definition.rb
+- lib/rggen/output_base/template_engine.rb
+- lib/rggen/rggen_home.rb
 - lib/rggen/version.rb
 - ral/compile.f
 - ral/rggen_ral_block.svh
 - ral/rggen_ral_field.svh
 - ral/rggen_ral_field_rwl_rwe.svh
+- ral/rggen_ral_indirect_reg.svh
 - ral/rggen_ral_macros.svh
 - ral/rggen_ral_map.svh
 - ral/rggen_ral_pkg.sv
 - ral/rggen_ral_reg.svh
-- ral/rggen_ral_shadow_reg.svh
 - rtl/bit_field/rggen_bit_field_common.svh
 - rtl/bit_field/rggen_bit_field_ro.sv
 - rtl/bit_field/rggen_bit_field_rw.sv
@@ -284,8 +299,10 @@ files:
 - sample/sample.xls
 - sample/sample.xlsx
 - sample/sample.yaml
+- sample/sample_0.h
 - sample/sample_0.sv
 - sample/sample_0_ral_pkg.sv
+- sample/sample_1.h
 - sample/sample_1.sv
 - sample/sample_1_ral_pkg.sv
 - sample/sample_setup.rb

data/lib/rggen/builtins/register/accessibility.rb

@@ -1,23 +0,0 @@
-simple_item :register, :accessibility do
-  register_map do
-    field :readable? do
-      register.external? || register.bit_fields.any?(&:readable?)
-    end
-
-    field :writable? do
-      register.external? || register.bit_fields.any?(&:writable?)
-    end
-
-    field :read_only? do
-      readable? && !writable?
-    end
-
-    field :write_only? do
-      writable? && !readable?
-    end
-
-    field :reserved? do
-      !register.external? && register.bit_fields.all?(&:reserved?)
-    end
-  end
-end

data/lib/rggen/builtins/register/external.rb

@@ -1,42 +0,0 @@
-simple_item :register, :external do
-  register_map do
-    field :external?
-    field :internal? do
-      !external?
-    end
-
-    input_pattern %r{(true)|(false)|()}i, convert_to_string: true
-
-    build do |cell|
-      @external = parse(cell)
-      register.need_no_children if external?
-    end
-
-    validate do
-      if (register.array? || register.shadow?) && external?
-        error 'not use array/shadow and ' \
-              'external register on the same register'
-      end
-    end
-
-    def parse(cell)
-      if pattern_matched?
-        captures.first.not_nil?
-      else
-        error "invalid value for 'external': #{cell.inspect}"
-      end
-    end
-  end
-
-  rtl do
-    export :external_index
-
-    def external_index
-      external_registers.index(&register.method(:equal?))
-    end
-
-    def external_registers
-      register_block.registers.select(&:external?)
-    end
-  end
-end

data/lib/rggen/builtins/register/shadow.rb

@@ -1,130 +0,0 @@
-simple_item :register, :shadow do
-  register_map do
-    field :shadow?
-    field :shadow_indexes
-
-    input_pattern %r{(#{variable_name})(?::(#{number}))?}
-
-    build do |cell|
-      @shadow_indexes = parse_shadow_indexes(cell)
-      @shadow         = @shadow_indexes.not_nil?
-    end
-
-    validate do
-      next unless shadow?
-      check_using_shadow_register_only
-      check_index_fields
-      check_size_of_array_index_fields
-      check_array_index_values
-      check_specific_value_index_values
-    end
-
-    define_struct :shadow_index_entry, [:name, :value] do
-      def initialize(name, value)
-        self.name   = name
-        self.value  = value && Integer(value)
-      end
-
-      def ==(other)
-        return false unless name == other.name
-        return true if [value, other.value].any?(&:nil?)
-        value == other.value
-      end
-    end
-
-    def parse_shadow_indexes(cell)
-      return nil if cell.nil? || cell.empty?
-      cell.split(/[,\n]/).map do |entry|
-        if pattern_match(entry)
-          shadow_index_entry.new(captures[0], captures[1])
-        else
-          error "invalid value for shadow index: #{cell.inspect}"
-        end
-      end
-    end
-
-    def check_using_shadow_register_only
-      return unless register.multiple? && register.array?
-      error 'not use real array and shadow register on the same register'
-    end
-
-    def check_index_fields
-      shadow_indexes.each do |entry|
-        case
-        when use_same_index_field_more_than_once?(entry.name)
-          error "not use the same index field more than once: #{entry.name}"
-        when not_find_shadow_index_field?(entry)
-          error "no such shadow index field: #{entry.name}"
-        when use_own_bit_field?(entry)
-          error 'own bit field is specified for shadow index field:' \
-                " #{entry.name}"
-        when use_arrayed_bit_field?(entry)
-          error 'arrayed bit field is specified for shadow index field:' \
-                " #{entry.name}"
-        end
-      end
-    end
-
-    def use_same_index_field_more_than_once?(name)
-      shadow_indexes.count { |entry| entry.name == name } > 1
-    end
-
-    def not_find_shadow_index_field?(entry)
-      shadow_index_bit_field[entry.name].nil?
-    end
-
-    def use_own_bit_field?(entry)
-      register.bit_fields.map(&:name).include?(entry.name)
-    end
-
-    def use_arrayed_bit_field?(entry)
-      shadow_index_bit_field[entry.name].register.array?
-    end
-
-    def check_size_of_array_index_fields
-      return if size_of_dimensions == array_indexes.size
-      error 'not match number of array dimensions and' \
-            ' number of array index fields'
-    end
-
-    def check_array_index_values
-      array_indexes.each_with_index do |entry, i|
-        next if register.dimensions[i] <= (maximum_value(entry.name) + 1)
-        error "exceeds maximum array size specified by #{entry.name}" \
-              "(#{maximum_value(entry.name) + 1}): #{register.dimensions[i]}"
-      end
-    end
-
-    def check_specific_value_index_values
-      specific_value_indexes.each do |entry|
-        next if entry.value <= maximum_value(entry.name)
-        error "exceeds maximum value of #{entry.name}" \
-              "(#{maximum_value(entry.name)}): #{entry.value}"
-      end
-    end
-
-    def size_of_dimensions
-      (register.array? && register.dimensions.size) || 0
-    end
-
-    def array_indexes
-      shadow_indexes.select { |entry| entry.value.nil? }
-    end
-
-    def specific_value_indexes
-      shadow_indexes.select { |entry| entry.value.not_nil? }
-    end
-
-    def maximum_value(index_name)
-      2**shadow_index_bit_field[index_name].width - 1
-    end
-
-    def shadow_index_bit_field
-      @shadow_index_bit_field ||= Hash.new do |hash, index_name|
-        hash[index_name]  = register_block.bit_fields.find_by(
-          name: index_name, reserved?: false
-        )
-      end
-    end
-  end
-end

data/lib/rggen/builtins/register/shadow_index_configurator.rb

@@ -1,56 +0,0 @@
-simple_item :register, :shadow_index_configurator do
-  ral do
-    available? do
-      register.shadow?
-    end
-
-    generate_code :reg_model_item do
-      function_definition :configure_shadow_indexes do |f|
-        f.return_type :void
-        f.body { |code| function_body(code) }
-      end
-    end
-
-    def function_body(code)
-      register.shadow_indexes.each do |shadow_index|
-        code << subroutine_call(:set_shadow_index, arguments(shadow_index))
-        code << semicolon
-        code << nl
-      end
-    end
-
-    def arguments(shadow_index)
-      [
-        parent_name(shadow_index),
-        index_name(shadow_index),
-        index_value(shadow_index)
-      ]
-    end
-
-    def parent_name(shadow_index)
-      parent_register = fild_parent_register(shadow_index.name)
-      string(parent_register.name)
-    end
-
-    def fild_parent_register(index_name)
-      register_block.bit_fields.find_by(name: index_name).register
-    end
-
-    def index_name(shadow_index)
-      string(shadow_index.name)
-    end
-
-    def index_value(shadow_index)
-      if shadow_index.value
-        shadow_index.value
-      else
-        "indexes[#{array_index}]"
-      end
-    end
-
-    def array_index
-      @array_index  ||= -1
-      @array_index  += 1
-    end
-  end
-end