rggen 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78e4a09b9a969654a984d332dd8a275f9a77a554
-  data.tar.gz: 4880ac0a2c985415276dc82ad19bebdf95126dc3
+  metadata.gz: 33c2428ac880c98ecf68e103721e0decec844892
+  data.tar.gz: e2c208ee59c2c860aeadcde867e69a95336c78b7
 SHA512:
-  metadata.gz: 1de6c549f3e86452ebbd36f9cad45f2c05722f538d58f41448adecf41f764986a6ce936c929a6c1ab377f7deaac713e487136cd94edb0ab9fd2a5e185aa42032
-  data.tar.gz: 497e9ac09db980509796b0e341a116769f7183aead238866f46f0fc4b049a14e37c18465e8e66e6feee8fa568c374b3bbfc857b2dcd46a9704bdbff88b2f7cf6
+  metadata.gz: bf5a199dd488d76174bc36d3b758d4df1af53ded4bd5513c8c0d00f297e4c8f183ef9364c9a23663385c82c6466483ee3803aa654fe96ee2f9d0d7d116e810f5
+  data.tar.gz: 6acdf0c8e0e223c69ee547a15db390221622c4c29e8d1d5ac0efc3589f8e483b4ea8ee79f4c2be02588997913ad630c99594677175d9552c0c54e46909989cfc

data/README.md

@@ -1,7 +1,8 @@
 [![Gem Version](https://badge.fury.io/rb/rggen.svg)](https://badge.fury.io/rb/rggen)
 [![Build Status](https://travis-ci.org/taichi-ishitani/rggen.svg?branch=master)](https://travis-ci.org/taichi-ishitani/rggen)
 [![Code Climate](https://codeclimate.com/github/taichi-ishitani/rggen/badges/gpa.svg)](https://codeclimate.com/github/taichi-ishitani/rggen)
-[![Test Coverage](https://codeclimate.com/github/taichi-ishitani/rggen/badges/coverage.svg)](https://codeclimate.com/github/taichi-ishitani/rggen/coverage)
+[![Test Coverage](https://codeclimate.com/github/taichi-ishitani/rggen/badges/coverage.svg)](https://codeclimate.com/github/taichi-ishitani/rggen/coverage)
+[![Join the chat at https://gitter.im/taichi-ishitani/rggen](https://badges.gitter.im/taichi-ishitani/rggen.svg)](https://gitter.im/taichi-ishitani/rggen?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 # RgGen
 
@@ -58,18 +59,19 @@ In addition, if you use default values for all of attributes, you don't need to
 RgGen allows to use a spreadsheet to input the register map of your design so you can directly input your register map document to RgGen.
 To do this, you need to write your register map document according to below table format.
 
-|    |A   |B             |C            |D              |E                                |F             |G         |H   |I           |
-|:---|:---|:-------------|:------------|:--------------|:--------------------------------|:-------------|:---------|:---|:-----------|
-|1   |    |Block Name    |block_0      |               |                                 |              |          |    |            |
-|2   |    |Byte Size     |256          |               |                                 |              |          |    |            |
-|3   |    |              |             |               |                                 |              |          |    |            |
-|4   |    |Offset Address|Register Name|Array Dimension|Shadow Index                     |Bit Assignment|Field Name|Type|Iitial Value|
-|5   |    |0x00          |register_0   |               |                                 |[31:16]       |field_0_0 |rw  |0           |
-|6   |    |              |             |               |                                 |[15:0]        |field_0_1 |rw  |0           |
-|7   |    |0x04          |register_1   |               |                                 |[16]          |field_1_0 |rw  |0           |
-|8   |    |              |             |               |                                 |[0]           |field_1_1 |ro  |            |
-|9   |    |0x10 - 0x1F   |register_2   |[4]            |                                 |[7:0]         |field_2_0 |rw  |0           |
-|10  |    |0x20          |register_3   |[2, 4]         |field_1_0:1, field_0_0, field_0_1|[7:0]         |field_3_0 |rw  |0           |
+|    |A   |B             |C            |D              |E                                |F       |G             |H         |I   |J           |
+|:---|:---|:-------------|:------------|:--------------|:--------------------------------|:-------|:-------------|:---------|:---|:-----------|
+|1   |    |Block Name    |block_0      |               |                                 |        |              |          |    |            |
+|2   |    |Byte Size     |256          |               |                                 |        |              |          |    |            |
+|3   |    |              |             |               |                                 |        |              |          |    |            |
+|4   |    |Offset Address|Register Name|Array Dimension|Shadow Index                     |External|Bit Assignment|Field Name|Type|Iitial Value|
+|5   |    |0x00          |register_0   |               |                                 |        |[31:16]       |field_0_0 |rw  |0           |
+|6   |    |              |             |               |                                 |        |[15:0]        |field_0_1 |rw  |0           |
+|7   |    |0x04          |register_1   |               |                                 |        |[16]          |field_1_0 |rw  |0           |
+|8   |    |              |             |               |                                 |        |[0]           |field_1_1 |ro  |            |
+|9   |    |0x10 - 0x1F   |register_2   |[4]            |                                 |        |[7:0]         |field_2_0 |rw  |0           |
+|10  |    |0x20 - 0x3F   |register_3   |               |                                 |true    |              |          |    |            |
+|11  |    |0x40          |register_4   |[2, 4]         |field_1_0:1, field_0_0, field_0_1|        |[7:0]         |field_4_0 |rw  |0           |
 
 By default, RgGen supports CSV, ODS, XLS and XLSX sparedsheet file types.
 
@@ -93,7 +95,7 @@ In addition, file name of generated files is accoding to below rule.
 ### Compiling Your Design
 
 RgGen has base RTL modules and RAL model package (the base library) to build generated RTL and UVM RAL models.
-Therefore, To compile your design with the base library, you need followins steps:
+Therefore, to compile your design with the base library, you need followins steps:
 
 1. Set the RGGEN_HOME environment variable
 2. Link the base library with you design
@@ -124,12 +126,20 @@ Also you can change these by customizing RgGen.
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
+
+## Contact
+
+If you have any questions, problems, ideas or somethings, you can post them on the following ways:
+
+1. [Issue tracker](https://github.com/taichi-ishitani/rggen/issues)
+2. [Chat room](https://gitter.im/taichi-ishitani/rggen)
+3. [Mail](mailto:taichi730@gmail.com)
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/taichi-ishitani/rggen. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
-Copyright © 2015-2016 [Taichi Ishitani](mailto:taichi730@gmail.com).
-RgGen is available as open source under the terms of the [MIT License](LICENSE.txt).
+Copyright © 2015-2016 Taichi Ishitani.
+RgGen is available as open source under the terms of [the MIT License](LICENSE.txt).

data/lib/rggen/base/component.rb

@@ -15,8 +15,12 @@ module RgGen
       attr_reader :level
       attr_reader :items
 
+      def need_children?
+        @need_children
+      end
+
       def add_child(child)
-        @children << child
+        @children << child if need_children?
       end
 
       def add_item(item)

data/lib/rggen/base/component_factory.rb

@@ -13,9 +13,9 @@ module RgGen
         parent  = (child_factory? && args.shift) || nil
         sources = args
         create_component(parent, *sources).tap do |component|
-          create_items(component, *sources) if @item_factories
-          parent.add_child(component) unless @root_factory
-          create_children(component, *sources) if @child_factory
+          create_items(component, *sources) if create_items?
+          parent.add_child(component) if child_factory?
+          create_children(component, *sources) if create_children?(component)
         end
       end
 
@@ -29,13 +29,20 @@ module RgGen
         !@root_factory
       end
 
+      def create_items?
+        @item_factories.not_nil?
+      end
+
+      def create_children?(component)
+        @child_factory.not_nil? && component.need_children?
+      end
+
       def create_component(parent, *_sources)
         @target_component.new(parent)
       end
 
       def create_item(item_factory, component, *sources)
-        item  = item_factory.create(component, *sources)
-        component.add_item(item)
+        item_factory.create(component, *sources)
       end
 
       def create_child(component, *sources)

data/lib/rggen/base/item.rb

@@ -3,21 +3,31 @@ module RgGen
     class Item
       extend Forwardable
 
+      class << self
+        def define_helpers(&body)
+          singleton_class.class_exec(&body) if block_given?
+        end
+
+        def available?(&body)
+          define_method(:available?, &body)
+        end
+
+        def inherit_class_instance_variable(variable_name, klass, &block)
+          return unless klass.instance_variable_defined?(variable_name)
+          v = klass.instance_variable_get(variable_name)
+          v = block.call(v) if block_given?
+          instance_variable_set(variable_name, v)
+        end
+      end
+
       def initialize(owner)
         @owner  = owner
       end
 
       attr_reader :owner
 
-      def self.define_helpers(&body)
-        singleton_class.class_exec(&body) if block_given?
-      end
-
-      def self.inherit_class_instance_variable(variable_name, parent_class, &block)
-        return unless parent_class.instance_variable_defined?(variable_name)
-        v = parent_class.instance_variable_get(variable_name)
-        v = block.call(v) if block_given?
-        instance_variable_set(variable_name, v)
+      def available?
+        true
       end
     end
   end

data/lib/rggen/base/item_factory.rb

@@ -4,13 +4,17 @@ module RgGen
       attr_writer :target_items
       attr_writer :target_item
 
-      def create(owner, *args)
-        create_item(owner, *args)
-      end
-
       private
 
-      def create_item(owner, *args)
+      def create_item(owner, *args, &block)
+        item  = create_item_object(owner, *args)
+        if item.available?
+          block.call(item) if block_given?
+          owner.add_item(item)
+        end
+      end
+
+      def create_item_object(owner, *args)
         klass ||= @target_items && select_target_item(*args)
         klass ||= @target_item
         klass.new(owner)

data/lib/rggen/builtins.rb

@@ -8,8 +8,7 @@ require_relative 'builtins/global/address_width'
 require_relative 'builtins/global/data_width'
 
 require_relative 'builtins/bit_field/bit_assignment'
-require_relative 'builtins/bit_field/field_model_creation'
-require_relative 'builtins/bit_field/field_model_declaration'
+require_relative 'builtins/bit_field/field_model'
 require_relative 'builtins/bit_field/initial_value'
 require_relative 'builtins/bit_field/name'
 require_relative 'builtins/bit_field/reference'
@@ -22,32 +21,30 @@ require_relative 'builtins/bit_field/reserved'
 require_relative 'builtins/register/accessibility'
 require_relative 'builtins/register/address_decoder'
 require_relative 'builtins/register/array'
+require_relative 'builtins/register/bus_exporter'
+require_relative 'builtins/register/constructor'
+require_relative 'builtins/register/external'
 require_relative 'builtins/register/field_model_creator'
-require_relative 'builtins/register/field_model_declarations'
 require_relative 'builtins/register/offset_address'
 require_relative 'builtins/register/name'
 require_relative 'builtins/register/read_data'
-require_relative 'builtins/register/reg_model_constructor'
-require_relative 'builtins/register/reg_model_creation'
-require_relative 'builtins/register/reg_model_declaration'
-require_relative 'builtins/register/reg_model_definition'
+require_relative 'builtins/register/reg_model'
 require_relative 'builtins/register/shadow'
 require_relative 'builtins/register/shadow_index_configurator'
+require_relative 'builtins/register/sub_block_model'
 require_relative 'builtins/register/uniqueness_validator'
 
 require_relative 'builtins/register_block/base_address'
-require_relative 'builtins/register_block/block_model_constructor'
-require_relative 'builtins/register_block/block_model_default_map_creator'
-require_relative 'builtins/register_block/block_model_definition'
+require_relative 'builtins/register_block/block_model'
 require_relative 'builtins/register_block/byte_size'
 require_relative 'builtins/register_block/clock_reset'
+require_relative 'builtins/register_block/constructor'
+require_relative 'builtins/register_block/default_map_creator'
 require_relative 'builtins/register_block/host_if'
 require_relative 'builtins/register_block/apb'
 require_relative 'builtins/register_block/axi4lite'
-require_relative 'builtins/register_block/module_definition'
 require_relative 'builtins/register_block/name'
-require_relative 'builtins/register_block/ral_package_definition'
-require_relative 'builtins/register_block/reg_model_creator'
-require_relative 'builtins/register_block/reg_model_declarations'
+require_relative 'builtins/register_block/ral_package'
 require_relative 'builtins/register_block/response_mux'
-require_relative 'builtins/register_block/signal_declarations'
+require_relative 'builtins/register_block/sub_model_creator'
+require_relative 'builtins/register_block/top_module'

data/lib/rggen/builtins/bit_field/{field_model_creation.rb → field_model.rb}

@@ -1,9 +1,18 @@
-simple_item :bit_field, :field_model_creation do
+simple_item :bit_field, :field_model do
   ral do
+    export :model_creation
+
     delegate [:name, :width, :lsb, :access] => :bit_field
 
-    generate_code :field_model_creation do
-      "`rggen_ral_create_field_model(#{arguments.join(', ')})\n"
+    build do
+      variable :reg_model, :field_model,
+               data_type: :rggen_ral_field,
+               name:      name,
+               random:    true
+    end
+
+    def model_creation(code)
+      code << "`rggen_ral_create_field_model(#{arguments.join(', ')})" << nl
     end
 
     def arguments

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

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

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

@@ -61,7 +61,7 @@ simple_item :register, :address_decoder do
 
     def shadow_index_width
       return 1 unless shadow?
-      shadow_index_fields.map(&:width).sum(0)
+      shadow_index_fields.sum(0, &:width)
     end
 
     def shadow_index_value

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

@@ -51,27 +51,43 @@ simple_item :register, :array do
   end
 
   rtl do
+    delegate [:array?, :dimensions] => :register
+
     export :index
     export :local_index
     export :loop_variables
     export :loop_variable
 
+    generate_pre_code :module_item do |code|
+      if array?
+        generate_header(code)
+        generate_for_headers(code)
+      end
+    end
+
+    generate_post_code :module_item do |code|
+      if array?
+        generate_for_footers(code)
+        generate_footer(code)
+      end
+    end
+
     def index
-      (register.array? && "#{base_index}+#{local_index}") || base_index
+      (array? && "#{base_index}+#{local_index}") || base_index
     end
 
     def local_index
-      return nil unless register.array?
+      return nil unless array?
       local_index_terms(0).join('+')
     end
 
     def loop_variables
-      return nil unless register.array?
-      Array.new(register.dimensions.size) { |l| loop_variable(l) }
+      return nil unless array?
+      Array.new(dimensions.size) { |l| loop_variable(l) }
     end
 
     def loop_variable(level)
-      return nil unless register.array? && level < register.dimensions.size
+      return nil unless array? && level < dimensions.size
       @loop_variables ||= Hash.new do |h, l|
         h[l]  = create_identifier("g_#{loop_index(l)}")
       end
@@ -79,12 +95,16 @@ simple_item :register, :array do
     end
 
     def base_index
-      previous_registers.map(&:count).sum(0)
+      former_registers.sum(0, &:count)
+    end
+
+    def former_registers
+      register_block.registers.take_while { |r| !register.equal?(r) }
     end
 
     def local_index_terms(level)
-      if level < (register.dimensions.size - 1)
-        partial_count = register.dimensions[(level + 1)..-1].inject(:*)
+      if level < (dimensions.size - 1)
+        partial_count = dimensions[(level + 1)..-1].inject(:*)
         term          = [partial_count, '*', loop_variable(level)].join
         local_index_terms(level + 1).unshift(term)
       else
@@ -92,24 +112,6 @@ simple_item :register, :array do
       end
     end
 
-    def previous_registers
-      register_block.registers.take_while { |r| !register.equal?(r) }
-    end
-
-    generate_pre_code :module_item do |code|
-      if register.array?
-        generate_header(code)
-        generate_for_headers(code)
-      end
-    end
-
-    generate_post_code :module_item do |code|
-      if register.array?
-        generate_for_footers(code)
-        generate_footer(code)
-      end
-    end
-
     def generate_header(code)
       code << "generate if (1) begin : g_#{register.name}" << nl
       code.indent += 2
@@ -117,7 +119,7 @@ simple_item :register, :array do
     end
 
     def generate_for_headers(code)
-      register.dimensions.each_with_index do |dimension, level|
+      dimensions.each_with_index do |dimension, level|
         code << generate_for_header(dimension, level) << nl
         code.indent += 2
       end
@@ -129,7 +131,7 @@ simple_item :register, :array do
     end
 
     def generate_for_footers(code)
-      register.dimensions.size.times do
+      dimensions.size.times do
         code.indent -= 2
         code << :end << nl
       end

data/lib/rggen/builtins/register/bus_exporter.erb

@@ -0,0 +1,28 @@
+rggen_bus_exporter #(
+  .DATA_WIDTH             (<%= configuration.data_width %>),
+  .LOCAL_ADDRESS_WIDTH    (<%= register_block.local_address_width %>),
+  .EXTERNAL_ADDRESS_WIDTH (<%= address_width %>),
+  .START_ADDRESS          (<%= start_address %>)
+) u_<%= name %>_bus_exporter (
+  .clk          (<%= register_block.clock %>),
+  .rst_n        (<%= register_block.reset %>),
+  .i_valid      (<%= register_block.host_if.command_valid %>),
+  .i_select     (<%= register_block.register_select[index] %>),
+  .i_write      (<%= register_block.host_if.write %>),
+  .i_read       (<%= register_block.host_if.read %>),
+  .i_address    (<%= register_block.host_if.address %>),
+  .i_strobe     (<%= register_block.host_if.strobe %>),
+  .i_write_data (<%= register_block.host_if.write_data %>),
+  .o_ready      (<%= register_block.external_register_ready[external_index] %>),
+  .o_read_data  (<%= register_block.register_read_data[index] %>),
+  .o_status     (<%= register_block.external_register_status[external_index] %>),
+  .o_valid      (<%= valid %>),
+  .o_write      (<%= write %>),
+  .o_read       (<%= read %>),
+  .o_address    (<%= address %>),
+  .o_strobe     (<%= strobe %>),
+  .o_write_data (<%= write_data %>),
+  .i_ready      (<%= ready %>),
+  .i_read_data  (<%= read_data %>),
+  .i_status     (<%= status %>)
+);