rggen 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5ce1005a53b9e917a5b5e00783ac95122b51d9c
-  data.tar.gz: 2cd68011eb9acbf244743a660311cd973a249b53
+  metadata.gz: ad6fc3632abba4953ce0e0fe205a009db33e7b8d
+  data.tar.gz: '068dffc83856248d9042c658766e3eaa3423cb1e'
 SHA512:
-  metadata.gz: b16b2bcae8107eadff8fe24ac66c335eaeae10c514233e25e6756da8629879bc7bc1088658cd612ddd8c77f6b4a91d06ec27dadb126e63461f489a4be59dd1f2
-  data.tar.gz: b37b9f7952ba07addf76a5cff942e75353d883a58c8a754e0d09134ebe91aa2ecd5982ab51a571a23865583a1f1d34205185e9fa43dd8a7b173873db55bc36a7
+  metadata.gz: 71fcd5f1de2247416ceecf9adfe5a32f0e1b8e9c130cc1b7ec562cec34288594eafd1d788edede1775e7dfbf2f939e6c7cc89cd2d048981ecfebeb030c17dcca
+  data.tar.gz: 7e9124eac17384c66e967beefa5da946e466e9798fb01d07270c6175c565d1af7e2fd28f2ff644c212a1f371f9141f9b330a00b7ae07b5ac3ba6e01de6811e4c

data/c_header/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Taichi Ishitani
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/lib/rggen/builtins.rb

@@ -21,16 +21,14 @@ require_relative 'builtins/bit_field/types/w0s_w1s'
 require_relative 'builtins/bit_field/types/wo'
 require_relative 'builtins/bit_field/types/reserved'
 
-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/field_model_creator'
 require_relative 'builtins/register/indirect_index_configurator'
 require_relative 'builtins/register/offset_address'
 require_relative 'builtins/register/name'
-require_relative 'builtins/register/read_data'
 require_relative 'builtins/register/reg_model'
+require_relative 'builtins/register/rtl_top'
 require_relative 'builtins/register/sub_block_model'
 require_relative 'builtins/register/type'
 require_relative 'builtins/register/types/external'
@@ -51,6 +49,5 @@ require_relative 'builtins/register_block/host_ifs/axi4lite'
 require_relative 'builtins/register_block/irq_controller'
 require_relative 'builtins/register_block/name'
 require_relative 'builtins/register_block/ral_package'
-require_relative 'builtins/register_block/response_mux'
+require_relative 'builtins/register_block/rtl_top'
 require_relative 'builtins/register_block/sub_model_creator'
-require_relative 'builtins/register_block/top_module'

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

@@ -166,18 +166,33 @@ list_item :bit_field, :type do
 
   rtl do
     item_base do
+      export :value
+
+      delegate [
+        :name, :width, :msb, :lsb, :reserved?
+      ] => :bit_field
+      delegate [
+        :dimensions, :index, :local_index, :loop_variables
+      ] => :register
+
+      available? { !bit_field.reserved? }
+
       build do
-        next if bit_field.reserved?
-        logic :value, name: value_name, width: width, dimensions: dimensions
+        interface :register, :bit_field_if,
+                  type:       :rggen_bit_field_if,
+                  name:       "#{name}_if",
+                  parameters: [width]
       end
 
-      def value_name
-        "#{bit_field.name}_value"
+      generate_pre_code :register do |c|
+        c << subroutine_call(:'`rggen_connect_bit_field_if', [
+          register.bit_field_if, bit_field_if, msb, lsb
+        ]) << nl
       end
 
-      delegate [:dimensions                          ] => :register
-      delegate [:width                               ] => :bit_field
-      delegate [:index, :local_index, :loop_variables] => :register
+      def value
+        register.register_if.value[msb, lsb]
+      end
     end
 
     default_item do

data/lib/rggen/builtins/bit_field/types/ro.erb

@@ -1,6 +1,6 @@
 rggen_bit_field_ro #(
   .WIDTH  (<%= width %>)
 ) u_<%= bit_field.name %> (
-  .i_value  (<%= value_in[loop_variables] %>),
-  .o_value  (<%= value[loop_variables] %>)
+  .bit_field_if (<%= bit_field_if %>),
+  .i_value      (<%= value_in[loop_variables] %>)
 );

data/lib/rggen/builtins/bit_field/types/ro.rb

@@ -5,13 +5,13 @@ list_item :bit_field, :type, :ro do
 
   rtl do
     build do
-      input :value_in,
+      input :register_block, :value_in,
             name:       "i_#{bit_field.name}",
             width:      width,
             dimensions: dimensions
     end
 
-    generate_code_from_template :module_item
+    generate_code_from_template :register
   end
 
   ral do

data/lib/rggen/builtins/bit_field/types/rw.erb

@@ -1,13 +1,9 @@
 rggen_bit_field_rw #(
-  .WIDTH          (<%= bit_field.width %>),
+  .WIDTH          (<%= width %>),
   .INITIAL_VALUE  (<%= initial_value %>)
 ) u_<%= bit_field.name %> (
-  .clk              (<%= register_block.clock %>),
-  .rst_n            (<%= register_block.reset %>),
-  .i_command_valid  (<%= register_block.host_if.command_valid %>),
-  .i_select         (<%= register_block.register_select[index] %>),
-  .i_write          (<%= register_block.host_if.write %>),
-  .i_write_data     (<%= register_block.host_if.write_data[bit_field.msb, bit_field.lsb] %>),
-  .i_write_mask     (<%= register_block.host_if.write_mask[bit_field.msb, bit_field.lsb] %>),
-  .o_value          (<%= value[loop_variables] %>)
+  .clk          (<%= register_block.clock %>),
+  .rst_n        (<%= register_block.reset %>),
+  .bit_field_if (<%= bit_field_if %>),
+  .o_value      (<%= value_out[loop_variables] %>)
 );

data/lib/rggen/builtins/bit_field/types/rw.rb

@@ -6,13 +6,13 @@ list_item :bit_field, :type, :rw do
 
   rtl do
     build do
-      output :value_out, name: port_name, width: width, dimensions: dimensions
+      output :register_block, :value_out,
+             name: port_name,
+             width: width,
+             dimensions: dimensions
     end
 
-    generate_code :module_item do |buffer|
-      buffer << assign(value_out[loop_variables], value[loop_variables]) << nl
-      buffer << process_template
-    end
+    generate_code_from_template :register
 
     def port_name
       "o_#{bit_field.name}"

data/lib/rggen/builtins/bit_field/types/rwl_rwe.erb

@@ -1,15 +1,11 @@
 rggen_bit_field_rwl_rwe #(
-  .LOCK_MODE      (<%= lock_mode %>),
+  .MODE           (rggen_rtl_pkg::<%= mode %>),
   .WIDTH          (<%= width %>),
   .INITIAL_VALUE  (<%= initial_value %>)
 ) u_<%= bit_field.name %> (
   .clk              (<%= register_block.clock %>),
   .rst_n            (<%= register_block.reset %>),
   .i_lock_or_enable (<%= lock_or_enable %>),
-  .i_command_valid  (<%= register_block.host_if.command_valid %>),
-  .i_select         (<%= register_block.register_select[index] %>),
-  .i_write          (<%= register_block.host_if.write %>),
-  .i_write_data     (<%= register_block.host_if.write_data[bit_field.msb, bit_field.lsb] %>),
-  .i_write_mask     (<%= register_block.host_if.write_mask[bit_field.msb, bit_field.lsb] %>),
-  .o_value          (<%= value[loop_variables] %>)
+  .bit_field_if     (<%= bit_field_if %>),
+  .o_value          (<%= value_out[loop_variables] %>)
 );

data/lib/rggen/builtins/bit_field/types/rwl_rwe.rb

@@ -7,19 +7,18 @@ list_item :bit_field, :type, [:rwl, :rwe] do
 
   rtl do
     build do
-      output :value_out,
+      output :register_block, :value_out,
              name:      "o_#{bit_field.name}",
              width:      width,
              dimensions: dimensions
     end
 
-    generate_code :module_item do |code|
-      code << assign(value_out[loop_variables], value[loop_variables]) << nl
-      code << process_template
-    end
+    generate_code_from_template :register
 
-    def lock_mode
-      { rwl: 1, rwe: 0 }[bit_field.type]
+    def mode
+      {
+        rwl: :RGGEN_LOCK_MODE, rwe: :RGGEN_ENABLE_MODE
+      }[bit_field.type]
     end
 
     def initial_value

data/lib/rggen/builtins/bit_field/types/w0c_w1c.erb

@@ -1,16 +1,12 @@
 rggen_bit_field_w01s_w01c #(
+  .MODE             (rggen_rtl_pkg::RGGEN_CLEAR_MODE),
+  .SET_CLEAR_VALUE  (<%= clear_value %>),
   .WIDTH            (<%= width %>),
-  .INITIAL_VALUE    (<%= initial_value %>),
-  .SET_MODE         (0),
-  .SET_CLEAR_VALUE  (<%= clear_value %>)
+  .INITIAL_VALUE    (<%= initial_value %>)
 ) u_<%= name%> (
-  .clk              (<%= register_block.clock %>),
-  .rst_n            (<%= register_block.reset %>),
-  .i_set_or_clear   (<%= set[loop_variables] %>),
-  .i_command_valid  (<%= register_block.host_if.command_valid %>),
-  .i_select         (<%= register_block.register_select[index] %>),
-  .i_write          (<%= register_block.host_if.write %>),
-  .i_write_data     (<%= register_block.host_if.write_data[bit_field.msb, bit_field.lsb] %>),
-  .i_write_mask     (<%= register_block.host_if.write_mask[bit_field.msb, bit_field.lsb] %>),
-  .o_value          (<%= value[loop_variables] %>)
+  .clk            (<%= register_block.clock %>),
+  .rst_n          (<%= register_block.reset %>),
+  .i_set_or_clear (<%= set[loop_variables] %>),
+  .bit_field_if   (<%= bit_field_if %>),
+  .o_value        ()
 );

data/lib/rggen/builtins/bit_field/types/w0c_w1c.rb

@@ -10,10 +10,13 @@ list_item :bit_field, :type, [:w0c, :w1c] do
     delegate [:name, :type] => :bit_field
 
     build do
-      input :set, name: "i_#{name}_set", width: width, dimensions: dimensions
+      input :register_block, :set,
+            name: "i_#{name}_set",
+            width: width,
+            dimensions: dimensions
     end
 
-    generate_code_from_template :module_item
+    generate_code_from_template :register
 
     def initial_value
       hex(bit_field.initial_value, width)

data/lib/rggen/builtins/bit_field/types/w0s_w1s.erb

@@ -1,16 +1,12 @@
 rggen_bit_field_w01s_w01c #(
+  .MODE             (rggen_rtl_pkg::RGGEN_SET_MODE),
+  .SET_CLEAR_VALUE  (<%= set_value %>),
   .WIDTH            (<%= width %>),
-  .INITIAL_VALUE    (<%= initial_value %>),
-  .SET_MODE         (1),
-  .SET_CLEAR_VALUE  (<%= set_value %>)
+  .INITIAL_VALUE    (<%= initial_value %>)
 ) u_<%= name %> (
-  .clk              (<%= register_block.clock %>),
-  .rst_n            (<%= register_block.reset %>),
-  .i_set_or_clear   (<%= clear[loop_variables] %>),
-  .i_command_valid  (<%= register_block.host_if.command_valid %>),
-  .i_select         (<%= register_block.register_select[index] %>),
-  .i_write          (<%= register_block.host_if.write %>),
-  .i_write_data     (<%= register_block.host_if.write_data[bit_field.msb, bit_field.lsb] %>),
-  .i_write_mask     (<%= register_block.host_if.write_mask[bit_field.msb, bit_field.lsb] %>),
-  .o_value          (<%= value[loop_variables] %>)
+  .clk            (<%= register_block.clock %>),
+  .rst_n          (<%= register_block.reset %>),
+  .i_set_or_clear (<%= clear[loop_variables] %>),
+  .bit_field_if   (<%= bit_field_if %>),
+  .o_value        (<%= value_out[loop_variables] %>)
 );

data/lib/rggen/builtins/bit_field/types/w0s_w1s.rb

@@ -8,20 +8,17 @@ list_item :bit_field, :type, [:w0s, :w1s] do
     delegate [:name, :type] => :bit_field
 
     build do
-      output :value_out,
+      output :register_block, :value_out,
              name:      "o_#{name}",
              width:      width,
              dimensions: dimensions
-       input :clear,
+       input :register_block, :clear,
              name:       "i_#{name}_clear",
              width:      width,
              dimensions: dimensions
     end
 
-    generate_code :module_item do |code|
-      code << assign(value_out[loop_variables], value[loop_variables]) << nl
-      code << process_template
-    end
+    generate_code_from_template :register
 
     def initial_value
       hex(bit_field.initial_value, width)

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

@@ -27,97 +27,4 @@ simple_item :register, :array do
       end
     end
   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
-      (array? && "#{base_index}+#{local_index}") || base_index
-    end
-
-    def local_index
-      return nil unless array?
-      local_index_terms(0).join('+')
-    end
-
-    def loop_variables
-      return nil unless array?
-      Array.new(dimensions.size) { |l| loop_variable(l) }
-    end
-
-    def loop_variable(level)
-      return nil unless array? && level < dimensions.size
-      @loop_variables ||= Hash.new do |h, l|
-        h[l]  = create_identifier("g_#{loop_index(l)}")
-      end
-      @loop_variables[level]
-    end
-
-    def base_index
-      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 < (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
-        [loop_variable(level)]
-      end
-    end
-
-    def generate_header(code)
-      code << "generate if (1) begin : g_#{register.name}" << nl
-      code.indent += 2
-      code << "genvar #{loop_variables.join(', ')};" << nl
-    end
-
-    def generate_for_headers(code)
-      dimensions.each_with_index do |dimension, level|
-        code << generate_for_header(dimension, level) << nl
-        code.indent += 2
-      end
-    end
-
-    def generate_for_header(dimension, level)
-      gv  = loop_variable(level)
-      "for (#{gv} = 0;#{gv} < #{dimension};#{gv}++) begin : g"
-    end
-
-    def generate_for_footers(code)
-      dimensions.size.times do
-        code.indent -= 2
-        code << :end << nl
-      end
-    end
-
-    def generate_footer(code)
-      code.indent -= 2
-      code << :end << space << :endgenerate << nl
-    end
-  end
 end

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

@@ -80,7 +80,7 @@ simple_item :register, :reg_model do
     end
 
     def hdl_path
-      return string('') unless array?
+      return string("g_#{name}") unless array?
       subroutine_call '$sformatf', [
         string("g_#{name}" + '.g[%0d]' * loop_varibles.size),
         *loop_varibles

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

@@ -0,0 +1,68 @@
+simple_item :register, :rtl_top do
+  rtl do
+    export :index
+    export :local_index
+    export :loop_variables
+    export :loop_variable
+
+    delegate [:array?, :dimensions] => :register
+
+    generate_code :register_block do
+      local_scope "g_#{register.name}" do |s|
+        s.signals register.signal_declarations(:register)
+        s.loops loops
+        s.body { |c| register.generate_code(:register, :top_down, c) }
+      end
+    end
+
+    def index
+      return base_index unless array?
+      "#{base_index}+#{local_index}"
+    end
+
+    def local_index
+      return nil unless array?
+      local_index_terms(0).join('+')
+    end
+
+    def loop_variables
+      return nil unless array?
+      dimensions.size.times.map(&method(:loop_variable))
+    end
+
+    def loop_variable(level)
+      return nil unless array?
+      return nil if level >= dimensions.size
+      @loop_variables ||= Hash.new do |h, l|
+        h[l]  = create_identifier("g_#{loop_index(l)}")
+      end
+      @loop_variables[level]
+    end
+
+    private
+
+    def base_index
+      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 < (dimensions.size - 1)
+        partial_count = dimensions[(level + 1)..-1].inject(&:*)
+        local_index_terms(level + 1).unshift(
+          [partial_count, :'*', loop_variable(level)].join
+        )
+      else
+        [loop_variable(level)]
+      end
+    end
+
+    def loops
+      return nil unless array?
+      Hash[*loop_variables.zip(dimensions).flatten]
+    end
+  end
+end