rggen-vhdl 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c74cc68ef729bcf49af9fbfb49184006e2f145408fa67d77adf96cd85ab07510
-  data.tar.gz: e113dc0c84be1b6646ae0d876e4f0cb920680c0bba12d71d434fbd6d168e6f42
+  metadata.gz: aa8c8c46d699ebd0a2fb1e9f6e2b3ef54f4ad73102fce9a5e354de923d7b7d1e
+  data.tar.gz: ac14f9c1a8c9889a7b242e4d13d074f543d297241475198293ce36271f92e2e9
 SHA512:
-  metadata.gz: fc44aaaafada6892281fc6f608af510e051bfb46aa00331dd4f1ac727c551d49d27dff01fd5f775cf5dc998c552553b1d30c682764e730696306c4ccf6ee2901
-  data.tar.gz: d378636891636a4609d1a40a4878ffd4a2edde73c5c30335d9e2a45265203de768db5f34d42a2dbbc8cea9b46e6b2f82416d9f43d2d185dc5d7c9d9204f7513b
+  metadata.gz: bd6cc0cf02deba72a1cfbe5a8bb9d095c6c2b1e8020c4add4f3c7ecd30a959f0a4c90422381fa36d10cdd0438fa70a74f8b79b5a128356dfadcec95035c0e0bf
+  data.tar.gz: b90261ea9057b8dfef7d73f774a54d7a409ac7ab6741a04e646d60195fe1d9cef2342c4feef9c89524ad690328bcb6c43280feaaf1c8c8b7087ea0be800c2564

data/README.md

@@ -60,7 +60,8 @@ $ simulator \
 
 Feedbacks, bus reports, questions and etc. are welcome! You can post them bu using following ways:
 
-* [GitHub Issue Tracker](https://github.com/rggen/rggen-vhdl/issues)
+* [GitHub Issue Tracker](https://github.com/rggen/rggen/issues)
+* [GitHub Discussions](https://github.com/rggen/rggen/discussions)
 * [Chat Room](https://gitter.im/rggen/rggen)
 * [Mailing List](https://groups.google.com/d/forum/rggen)
 * [Mail](mailto:rggen@googlegroups.com)

data/lib/rggen/vhdl/bit_field/type/custom.erb

@@ -0,0 +1,34 @@
+u_bit_field: entity work.rggen_bit_field
+  generic map (
+    WIDTH               => <%= width %>,
+    INITIAL_VALUE       => <%= initial_value %>,
+    SW_READ_ACTION      => <%= sw_read_action %>,
+    SW_WRITE_ACTION     => <%= sw_write_action %>,
+    SW_WRITE_ONCE       => <%= bit_field.sw_write_once? %>,
+    HW_SET_WIDTH        => <%= width %>,
+    HW_CLEAR_WIDTH      => <%= width %>,
+    STORAGE             => <%= storage? %>,
+    EXTERNAL_READ_DATA  => <%= external_read_data? %>,
+    TRIGGER             => <%= trigger? %>
+  )
+  port map (
+    i_clk             => <%= clock %>,
+    i_rst_n           => <%= reset %>,
+    i_sw_valid        => <%= bit_field_valid %>,
+    i_sw_read_mask    => <%= bit_field_read_mask %>,
+    i_sw_write_enable => "1",
+    i_sw_write_mask   => <%= bit_field_write_mask %>,
+    i_sw_write_data   => <%= bit_field_write_data %>,
+    o_sw_read_data    => <%= bit_field_read_data %>,
+    o_sw_value        => <%= bit_field_value %>,
+    o_write_trigger   => <%= output_port(:write_trigger) %>,
+    o_read_trigger    => <%= output_port(:read_trigger) %>,
+    i_hw_write_enable => <%= input_port(:hw_write_enable, '"0"') %>,
+    i_hw_write_data   => <%= input_port(:hw_write_data) %>,
+    i_hw_set          => <%= input_port(:hw_set) %>,
+    i_hw_clear        => <%= input_port(:hw_clear) %>,
+    i_value           => <%= input_port(:value_in) %>,
+    i_mask            => (others => '1'),
+    o_value           => <%= output_port(:value_out) %>,
+    o_value_unmasked  => open
+  );

data/lib/rggen/vhdl/bit_field/type/custom.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+RgGen.define_list_item_feature(:bit_field, :type, :custom) do
+  vhdl do
+    build do
+      if external_read_data?
+        input :value_in, {
+          name: "i_#{full_name}", width: width, array_size: array_size
+        }
+      else
+        output :value_out, {
+          name: "o_#{full_name}", width: width, array_size: array_size
+        }
+      end
+      if bit_field.hw_write?
+        input :hw_write_enable, {
+          name: "i_#{full_name}_hw_write_enable", width: 1, array_size: array_size
+        }
+        input :hw_write_data, {
+          name: "i_#{full_name}_hw_write_data", width: width, array_size: array_size
+        }
+      end
+      if bit_field.hw_set?
+        input :hw_set, {
+          name: "i_#{full_name}_hw_set", width: width, array_size: array_size
+        }
+      end
+      if bit_field.hw_clear?
+        input :hw_clear, {
+          name: "i_#{full_name}_hw_clear", width: width, array_size: array_size
+        }
+      end
+      if bit_field.write_trigger?
+        output :write_trigger, {
+          name: "o_#{full_name}_write_trigger", width: 1, array_size: array_size
+        }
+      end
+      if bit_field.read_trigger?
+        output :read_trigger, {
+          name: "o_#{full_name}_read_trigger", width: 1, array_size: array_size
+        }
+      end
+    end
+
+    main_code :bit_field, from_template: true
+
+    private
+
+    def external_read_data?
+      !bit_field.sw_update? && !bit_field.hw_update?
+    end
+
+    def initial_value
+      external_read_data? && default_initial_value || super
+    end
+
+    def default_initial_value
+      value = hex(0, width)
+      "slice(#{value}, #{width}, 0)"
+    end
+
+    def sw_read_action
+      {
+        none: 'RGGEN_READ_NONE',
+        default: 'RGGEN_READ_DEFAULT',
+        set: 'RGGEN_READ_SET',
+        clear: 'RGGEN_READ_CLEAR'
+      }[bit_field.sw_read]
+    end
+
+    def sw_write_action
+      {
+        none: 'RGGEN_WRITE_NONE',
+        default: 'RGGEN_WRITE_DEFAULT',
+        clear_0: 'RGGEN_WRITE_0_CLEAR',
+        clear_1: 'RGGEN_WRITE_1_CLEAR',
+        clear: 'RGGEN_WRITE_CLEAR',
+        set_0: 'RGGEN_WRITE_0_SET',
+        set_1: 'RGGEN_WRITE_1_SET',
+        set: 'RGGEN_WRITE_SET',
+        toggle_0: 'RGGEN_WRITE_0_TOGGLE',
+        toggle_1: 'RGGEN_WRITE_1_TOGGLE'
+      }[bit_field.sw_write]
+    end
+
+    def storage?
+      !external_read_data?
+    end
+
+    def trigger?
+      bit_field.write_trigger? || bit_field.read_trigger?
+    end
+
+    def input_port(name, default = nil)
+      find_port(name, default || '(others => \'0\')')
+    end
+
+    def output_port(name)
+      find_port(name, 'open')
+    end
+
+    def find_port(name, default_value)
+      respond_to?(name) && __send__(name)[loop_variables] || default_value
+    end
+  end
+end

data/lib/rggen/vhdl/bit_field/type/rol.erb

@@ -0,0 +1,27 @@
+u_bit_field: entity work.rggen_bit_field
+  generic map (
+    WIDTH           => <%= width %>,
+    INITIAL_VALUE   => <%= initial_value %>,
+    SW_WRITE_ACTION => RGGEN_WRITE_NONE
+  )
+  port map (
+    i_clk             => <%= clock %>,
+    i_rst_n           => <%= reset %>,
+    i_sw_valid        => <%= bit_field_valid %>,
+    i_sw_read_mask    => <%= bit_field_read_mask %>,
+    i_sw_write_enable => "1",
+    i_sw_write_mask   => <%= bit_field_write_mask %>,
+    i_sw_write_data   => <%= bit_field_write_data %>,
+    o_sw_read_data    => <%= bit_field_read_data %>,
+    o_sw_value        => <%= bit_field_value %>,
+    o_write_trigger   => open,
+    o_read_trigger    => open,
+    i_hw_write_enable => <%= latch_signal %>,
+    i_hw_write_data   => <%= value_in[loop_variables] %>,
+    i_hw_set          => (others => '0'),
+    i_hw_clear        => (others => '0'),
+    i_value           => (others => '0'),
+    i_mask            => (others => '1'),
+    o_value           => <%= value_out[loop_variables] %>,
+    o_value_unmasked  => open
+  );

data/lib/rggen/vhdl/bit_field/type/rol.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+RgGen.define_list_item_feature(:bit_field, :type, :rol) do
+  vhdl do
+    build do
+      unless bit_field.reference?
+        input :latch, {
+          name: "i_#{full_name}_latch", width: 1, array_size: array_size
+        }
+      end
+      input :value_in, {
+        name: "i_#{full_name}", width: width, array_size: array_size
+      }
+      output :value_out, {
+        name: "o_#{full_name}", width: width, array_size: array_size
+      }
+    end
+
+    main_code :bit_field, from_template: true
+
+    private
+
+    def latch_signal
+      reference_bit_field || latch[loop_variables]
+    end
+  end
+end

data/lib/rggen/vhdl/bit_field/type/row0trg_row1trg.erb

@@ -0,0 +1,18 @@
+u_bit_field: entity work.rggen_bit_field_w01trg
+  generic map (
+    WRITE_ONE_TRIGGER => <%= write_one_trigger? %>,
+    WIDTH             => <%= width %>
+  )
+  port map (
+    i_clk             => i_clk,
+    i_rst_n           => i_rst_n,
+    i_sw_valid        => <%= bit_field_valid %>,
+    i_sw_read_mask    => <%= bit_field_read_mask %>,
+    i_sw_write_enable => "1",
+    i_sw_write_mask   => <%= bit_field_write_mask %>,
+    i_sw_write_data   => <%= bit_field_write_data %>,
+    o_sw_read_data    => <%= bit_field_read_data %>,
+    o_sw_value        => <%= bit_field_value %>,
+    i_value           => <%= reference_or_value_in %>,
+    o_trigger         => <%= trigger[loop_variables] %>
+  );

data/lib/rggen/vhdl/bit_field/type/row0trg_row1trg.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+RgGen.define_list_item_feature(:bit_field, :type, [:row0trg, :row1trg]) do
+  vhdl do
+    build do
+      unless bit_field.reference?
+        input :value_in, {
+          name: "i_#{full_name}", width: width, array_size: array_size
+        }
+      end
+      output :trigger, {
+        name: "o_#{full_name}_trigger", width: width, array_size: array_size
+      }
+    end
+
+    main_code :bit_field, from_template: true
+
+    private
+
+    def write_one_trigger?
+      bit_field.type == :row1trg
+    end
+
+    def reference_or_value_in
+      reference_bit_field || value_in[loop_variables]
+    end
+  end
+end

data/lib/rggen/vhdl/bit_field/type/w0crs_w0src_w1crs_w1src_wcrs_wsrc.rb

@@ -19,7 +19,7 @@ RgGen.define_list_item_feature(
     end
 
     def read_set?
-      [:w0crs, :w1crs, :wcrs].include?(bit_field.type)
+      [:w0crs, :w1crs, :wcrs].any? { |type| bit_field.type == type }
     end
 
     def write_action

data/lib/rggen/vhdl/bit_field/type/w0trg_w1trg.erb

@@ -13,5 +13,6 @@ u_bit_field: entity work.rggen_bit_field_w01trg
     i_sw_write_data   => <%= bit_field_write_data %>,
     o_sw_read_data    => <%= bit_field_read_data %>,
     o_sw_value        => <%= bit_field_value %>,
+    i_value           => (others => '0'),
     o_trigger         => <%= trigger[loop_variables] %>
   );

data/lib/rggen/vhdl/register_block/vhdl_top.rb

@@ -61,14 +61,14 @@ RgGen.define_simple_feature(:register_block, :vhdl_top) do
     def generic_declarations
       register_block
         .declarations[:generic]
-        .yield_self(&method(:add_terminator))
+        .then(&method(:add_terminator))
     end
 
     def port_declarations
       register_block
         .declarations[:port]
-        .yield_self(&method(:sort_port_declarations))
-        .yield_self(&method(:add_terminator))
+        .then(&method(:sort_port_declarations))
+        .then(&method(:add_terminator))
     end
 
     def signal_declarations

data/lib/rggen/vhdl/version.rb

@@ -2,6 +2,6 @@
 
 module RgGen
   module VHDL
-    VERSION = '0.2.1'
+    VERSION = '0.4.0'
   end
 end

data/lib/rggen/vhdl.rb

@@ -10,44 +10,45 @@ require_relative 'vhdl/component'
 require_relative 'vhdl/feature'
 require_relative 'vhdl/factories'
 
-module RgGen
-  module VHDL
-    extend Core::Plugin
+RgGen.setup_plugin :'rggen-vhdl' do |plugin|
+  plugin.version RgGen::VHDL::VERSION
 
-    setup_plugin :'rggen-vhdl' do |plugin|
-      plugin.register_component :vhdl do
-        component Component, ComponentFactory
-        feature Feature, FeatureFactory
-      end
-
-      plugin.files [
-        'vhdl/bit_field/type',
-        'vhdl/bit_field/type/rc_w0c_w1c_wc_woc',
-        'vhdl/bit_field/type/ro_rotrg',
-        'vhdl/bit_field/type/rof',
-        'vhdl/bit_field/type/rowo_rowotrg',
-        'vhdl/bit_field/type/rs_w0s_w1s_ws_wos',
-        'vhdl/bit_field/type/rw_rwtrg_w1',
-        'vhdl/bit_field/type/rwc',
-        'vhdl/bit_field/type/rwe_rwl',
-        'vhdl/bit_field/type/rws',
-        'vhdl/bit_field/type/w0crs_w0src_w1crs_w1src_wcrs_wsrc',
-        'vhdl/bit_field/type/w0t_w1t',
-        'vhdl/bit_field/type/w0trg_w1trg',
-        'vhdl/bit_field/type/wo_wo1_wotrg',
-        'vhdl/bit_field/type/wrc_wrs',
-        'vhdl/bit_field/vhdl_top',
-        'vhdl/register/type',
-        'vhdl/register/type/external',
-        'vhdl/register/type/indirect',
-        'vhdl/register/vhdl_top',
-        'vhdl/register_block/protocol',
-        'vhdl/register_block/protocol/apb',
-        'vhdl/register_block/protocol/axi4lite',
-        'vhdl/register_block/protocol/wishbone',
-        'vhdl/register_block/vhdl_top',
-        'vhdl/register_file/vhdl_top'
-      ]
-    end
+  plugin.register_component :vhdl do
+    component RgGen::VHDL::Component,
+              RgGen::VHDL::ComponentFactory
+    feature RgGen::VHDL::Feature,
+            RgGen::VHDL::FeatureFactory
   end
+
+  plugin.files [
+    'vhdl/register_block/vhdl_top',
+    'vhdl/register_block/protocol',
+    'vhdl/register_block/protocol/apb',
+    'vhdl/register_block/protocol/axi4lite',
+    'vhdl/register_block/protocol/wishbone',
+    'vhdl/register_file/vhdl_top',
+    'vhdl/register/vhdl_top',
+    'vhdl/register/type',
+    'vhdl/register/type/external',
+    'vhdl/register/type/indirect',
+    'vhdl/bit_field/vhdl_top',
+    'vhdl/bit_field/type',
+    'vhdl/bit_field/type/custom',
+    'vhdl/bit_field/type/rc_w0c_w1c_wc_woc',
+    'vhdl/bit_field/type/ro_rotrg',
+    'vhdl/bit_field/type/rof',
+    'vhdl/bit_field/type/rol',
+    'vhdl/bit_field/type/row0trg_row1trg',
+    'vhdl/bit_field/type/rowo_rowotrg',
+    'vhdl/bit_field/type/rs_w0s_w1s_ws_wos',
+    'vhdl/bit_field/type/rw_rwtrg_w1',
+    'vhdl/bit_field/type/rwc',
+    'vhdl/bit_field/type/rwe_rwl',
+    'vhdl/bit_field/type/rws',
+    'vhdl/bit_field/type/w0crs_w0src_w1crs_w1src_wcrs_wsrc',
+    'vhdl/bit_field/type/w0t_w1t',
+    'vhdl/bit_field/type/w0trg_w1trg',
+    'vhdl/bit_field/type/wo_wo1_wotrg',
+    'vhdl/bit_field/type/wrc_wrs'
+  ]
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rggen-vhdl
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-07 00:00:00.000000000 Z
+date: 2022-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rggen-systemverilog
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.26.0
+        version: 0.28.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.26.0
+        version: 0.28.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -50,12 +50,18 @@ files:
 - README.md
 - lib/rggen/vhdl.rb
 - lib/rggen/vhdl/bit_field/type.rb
+- lib/rggen/vhdl/bit_field/type/custom.erb
+- lib/rggen/vhdl/bit_field/type/custom.rb
 - lib/rggen/vhdl/bit_field/type/rc_w0c_w1c_wc_woc.erb
 - lib/rggen/vhdl/bit_field/type/rc_w0c_w1c_wc_woc.rb
 - lib/rggen/vhdl/bit_field/type/ro_rotrg.erb
 - lib/rggen/vhdl/bit_field/type/ro_rotrg.rb
 - lib/rggen/vhdl/bit_field/type/rof.erb
 - lib/rggen/vhdl/bit_field/type/rof.rb
+- lib/rggen/vhdl/bit_field/type/rol.erb
+- lib/rggen/vhdl/bit_field/type/rol.rb
+- lib/rggen/vhdl/bit_field/type/row0trg_row1trg.erb
+- lib/rggen/vhdl/bit_field/type/row0trg_row1trg.rb
 - lib/rggen/vhdl/bit_field/type/rowo_rowotrg.erb
 - lib/rggen/vhdl/bit_field/type/rowo_rowotrg.rb
 - lib/rggen/vhdl/bit_field/type/rs_w0s_w1s_ws_wos.erb
@@ -100,7 +106,6 @@ files:
 - lib/rggen/vhdl/register_block/vhdl_top.erb
 - lib/rggen/vhdl/register_block/vhdl_top.rb
 - lib/rggen/vhdl/register_file/vhdl_top.rb
-- lib/rggen/vhdl/setup.rb
 - lib/rggen/vhdl/utility.rb
 - lib/rggen/vhdl/utility/data_object.rb
 - lib/rggen/vhdl/utility/identifier.rb
@@ -110,7 +115,7 @@ homepage: https://github.com/rggen/rggen-vhdl
 licenses:
 - MIT
 metadata:
-  bug_tracker_uri: https://github.com/rggen/rggen-vhdl/issues
+  bug_tracker_uri: https://github.com/rggen/rggen/issues
   mailing_list_uri: https://groups.google.com/d/forum/rggen
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/rggen/rggen-vhdl
@@ -130,8 +135,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
-summary: rggen-vhdl-0.2.1
+summary: rggen-vhdl-0.4.0
 test_files: []

data/lib/rggen/vhdl/setup.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require 'rggen/vhdl'
-
-RgGen.register_plugin RgGen::VHDL do |builder|
-  builder.load_plugin 'rggen/systemverilog/rtl/setup'
-  builder.enable :register_block, [:vhdl_top]
-  builder.enable :register_file, [:vhdl_top]
-  builder.enable :register, [:vhdl_top]
-  builder.enable :bit_field, [:vhdl_top]
-end