rggen-systemverilog 0.35.1 → 0.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5441e91c3aba911ffc939b52377fbe897b4b6d22eae77885a2d84c9ad039f514
-  data.tar.gz: 0a6537fbd0bd1c6aca0bf386a01639ecaa9eb872aa7ab9a457cdf081c629b4e0
+  metadata.gz: c2a34fc0e11acfa4676aa94fb91a7cbeb70948f99e57010e8642a298f7ce3062
+  data.tar.gz: acae4d8983a442dd5227cc7c977c7cdfd5b1380289b8b8c15449a14477064de0
 SHA512:
-  metadata.gz: 2512a43cb38779c6ba0180c5aea816708f9a085d7f6cb80d6ad4b2f7f4e387aa110451aeddc47c5df9b212343caa106e23cca671b068978dd49e36ac39dbf379
-  data.tar.gz: c8a517c58dc5846adf3241d11abed8007e8e347ee0417a8603ff879661dfb50f5d49656130146bba2c27cd487e9a45880a98b7717b9bb0d59d7c1b5fcac19b6c
+  metadata.gz: e2ed272a3d8d45db50ff0bea82e8ee2e660eaa5e6b6320cd02960dd7c6f131f9e446c189ed54fa601dce2f4eabf1a687f1f2635db83c93be067c8affec870e50
+  data.tar.gz: 57dfbc1fe3c92b5a1b34063dea625d09274c208a606e452d2714ccc79279dc00efb5bcdcc32609a02d1bd4275f3dac359ae194f4783064f0b565671c13b0199e

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019-2025 Taichi Ishitani
+Copyright (c) 2019-2026 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

data/README.md

@@ -2,7 +2,7 @@
 [![CI](https://github.com/rggen/rggen-systemverilog/workflows/CI/badge.svg)](https://github.com/rggen/rggen-systemverilog/actions?query=workflow%3ACI)
 [![Maintainability](https://qlty.sh/badges/1b06df23-43bd-413d-90f9-b98c565be895/maintainability.svg)](https://qlty.sh/gh/rggen/projects/rggen-systemverilog)
 [![codecov](https://codecov.io/gh/rggen/rggen-systemverilog/branch/master/graph/badge.svg)](https://codecov.io/gh/rggen/rggen-systemverilog)
-[![Gitter](https://badges.gitter.im/rggen/rggen.svg)](https://gitter.im/rggen/rggen?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+[![Discord](https://img.shields.io/discord/1406572699467124806?style=flat&logo=discord)](https://discord.com/invite/KWya83ZZxr)
 
 # RgGen::SystemVerilog
 
@@ -28,13 +28,13 @@ Feedbacks, bug reports, questions and etc. are wellcome! You can post them by us
 
 * [GitHub Issue Tracker](https://github.com/rggen/rggen/issues)
 * [GitHub Discussions](https://github.com/rggen/rggen/discussions)
-* [Chat Room](https://gitter.im/rggen/rggen)
+* [Discord](https://discord.com/invite/KWya83ZZxr)
 * [Mailing List](https://groups.google.com/d/forum/rggen)
 * [Mail](mailto:rggen@googlegroups.com)
 
 ## Copyright & License
 
-Copyright © 2019-2025 Taichi Ishitani. RgGen::SystemVerilog is licensed under the [MIT License](https://opensource.org/licenses/MIT), see [LICENSE](LICENSE) for futher details.
+Copyright © 2019-2026 Taichi Ishitani. RgGen::SystemVerilog is licensed under the [MIT License](https://opensource.org/licenses/MIT), see [LICENSE](LICENSE) for futher details.
 
 ## Code of Conduct
 

data/lib/rggen/systemverilog/common/feature.rb

@@ -5,6 +5,7 @@ module RgGen
     module Common
       class Feature < Core::OutputBase::Feature
         include Common::Utility
+
         template_engine Core::OutputBase::ERBEngine
 
         EntityContext =

data/lib/rggen/systemverilog/ral/bit_field/type/counter_rwc_rwhw_rws.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RgGen.define_list_item_feature(:bit_field, :type, [:counter, :rwc, :rwhw, :rws]) do
+  sv_ral { access 'RW' }
+end

data/lib/rggen/systemverilog/ral/register/type/maskable.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+RgGen.define_list_item_feature(:register, :type, :maskable) do
+  sv_ral do
+    main_code :ral_package do
+      class_definition(model_name) do |sv_class|
+        sv_class.base 'rggen_ral_maskable_reg'
+        sv_class.variables variables
+        sv_class.body { model_body }
+      end
+    end
+
+    private
+
+    def model_body
+      process_template(File.join(__dir__, 'default.erb'))
+    end
+  end
+end

data/lib/rggen/systemverilog/ral.rb

@@ -22,13 +22,14 @@ RgGen.setup_plugin :'rggen-sv-ral' do |plugin|
     'ral/register/type',
     'ral/register/type/external',
     'ral/register/type/indirect',
+    'ral/register/type/maskable',
     'ral/bit_field/type',
+    'ral/bit_field/type/counter_rwc_rwhw_rws',
     'ral/bit_field/type/custom',
     'ral/bit_field/type/rof_rohw',
     'ral/bit_field/type/rotrg_rwtrg_wotrg',
     'ral/bit_field/type/row0trg_row1trg_w0trg_w1trg',
     'ral/bit_field/type/rowo_rowotrg',
-    'ral/bit_field/type/rwc_rwhw_rws',
     'ral/bit_field/type/rwe_rwl'
   ]
 

data/lib/rggen/systemverilog/rtl/bit_field/type/counter.erb

@@ -0,0 +1,16 @@
+rggen_bit_field_counter #(
+  .WIDTH          (<%= width %>),
+  .INITIAL_VALUE  (<%= initial_value %>),
+  .UP_WIDTH       (<%= up_width %>),
+  .DOWN_WIDTH     (<%= down_width %>),
+  .WRAP_AROUND    (<%= wrap_around %>),
+  .USE_CLEAR      (<%= use_clear_value %>)
+) u_bit_field (
+  .i_clk        (<%= clock %>),
+  .i_rst_n      (<%= reset %>),
+  .bit_field_if (<%= bit_field_if %>),
+  .i_clear      (<%= clear_signal %>),
+  .i_up         (<%= up[loop_variables]%>),
+  .i_down       (<%= down[loop_variables] %>),
+  .o_count      (<%= count[loop_variables] %>)
+);

data/lib/rggen/systemverilog/rtl/bit_field/type/counter.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+RgGen.define_list_item_feature(:bit_field, :type, :counter) do
+  sv_rtl do
+    build do
+      parameter :up_width, {
+        name: "#{full_name}_up_width".upcase,
+        data_type: :int, default: 1
+      }
+      parameter :down_width, {
+        name: "#{full_name}_down_width".upcase,
+        data_type: :int, default: 1
+      }
+      parameter :wrap_around, {
+        name: "#{full_name}_wrap_around".upcase,
+        data_type: :bit, default: 0
+      }
+      if external_clear?
+        parameter :use_clear, {
+          name: "#{full_name}_use_clear".upcase,
+          data_type: :bit, default: 1
+        }
+      end
+
+      input :up, {
+        name: "i_#{full_name}_up",
+        width: function_call(:rggen_clip_width, [up_width]), array_size:
+      }
+      input :down, {
+        name: "i_#{full_name}_down",
+        width: function_call(:rggen_clip_width, [down_width]), array_size:
+      }
+      if external_clear?
+        input :clear, {
+          name: "i_#{full_name}_clear", width: 1, array_size:
+        }
+      end
+      output :count, {
+        name: "o_#{full_name}", width:, array_size:
+      }
+    end
+
+    main_code :bit_field, from_template: true
+
+    private
+
+    def external_clear?
+      !bit_field.reference?
+    end
+
+    def use_clear_value
+      external_clear? && use_clear || 1
+    end
+
+    def clear_signal
+      reference_bit_field || clear[loop_variables]
+    end
+  end
+end

data/lib/rggen/systemverilog/rtl/register/type/maskable.erb

@@ -0,0 +1,14 @@
+rggen_maskable_register #(
+  .READABLE       (<%= readable %>),
+  .WRITABLE       (<%= writable %>),
+  .ADDRESS_WIDTH  (<%= address_width %>),
+  .OFFSET_ADDRESS (<%= offset_address %>),
+  .BUS_WIDTH      (<%= bus_width %>),
+  .DATA_WIDTH     (<%= width %>),
+  .VALUE_WIDTH    (<%= value_width %>)
+) u_register (
+  .i_clk        (<%= register_block.clock %>),
+  .i_rst_n      (<%= register_block.reset %>),
+  .register_if  (<%= register_if %>),
+  .bit_field_if (<%= bit_field_if %>)
+);

data/lib/rggen/systemverilog/rtl/register/type/maskable.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RgGen.define_list_item_feature(:register, :type, :maskable) do
+  sv_rtl do
+    main_code :register, from_template: true
+  end
+end

data/lib/rggen/systemverilog/rtl/register_block/protocol.rb

@@ -6,13 +6,17 @@ RgGen.define_list_feature(:register_block, :protocol) do
       feature_registries << registry
     end
 
+    def no_rtl_writers?
+      feature_registries
+        .none? { |registry| registry.enabled_features.include?(:protocol) }
+    end
+
     def default_protocol
       available_protocols.first
     end
 
     def find_protocol(value)
-      available_protocols
-        .find { value.to_sym.casecmp?(_1) }
+      available_protocols.find { value.to_sym.casecmp?(_1) }
     end
 
     private
@@ -23,7 +27,7 @@ RgGen.define_list_feature(:register_block, :protocol) do
 
     def available_protocols
       feature_registries
-        .map { |registry| registry.enabled_features(:protocol) }
+        .filter_map { |registry| registry.enabled_features(:protocol) }
         .inject(:&)
     end
   end
@@ -39,6 +43,14 @@ RgGen.define_list_feature(:register_block, :protocol) do
 
       factory do
         convert_value do |value, position|
+          find_protocol(value, position)
+        end
+
+        private
+
+        def find_protocol(value, position)
+          return if shared_context.no_rtl_writers?
+
           shared_context.find_protocol(value) ||
             (error "unknown protocol: #{value.inspect}", position)
         end
@@ -54,13 +66,21 @@ RgGen.define_list_feature(:register_block, :protocol) do
 
     factory do
       default_value do |position|
-        shared_context.default_protocol ||
-          (error 'no protocols are available', position)
+        default_protocol(position)
       end
 
       def target_feature_key(data)
         data.value
       end
+
+      private
+
+      def default_protocol(position)
+        return if shared_context.no_rtl_writers?
+
+        shared_context.default_protocol ||
+          (error 'no protocols are available', position)
+      end
     end
   end
 

data/lib/rggen/systemverilog/rtl.rb

@@ -33,9 +33,11 @@ RgGen.setup_plugin :'rggen-sv-rtl' do |plugin|
     'rtl/register/type',
     'rtl/register/type/external',
     'rtl/register/type/indirect',
+    'rtl/register/type/maskable',
     'rtl/register/type/rw',
     'rtl/bit_field/sv_rtl_top',
     'rtl/bit_field/type',
+    'rtl/bit_field/type/counter',
     'rtl/bit_field/type/custom',
     'rtl/bit_field/type/rc_w0c_w1c_wc_woc',
     'rtl/bit_field/type/ro_rotrg',

data/lib/rggen/systemverilog/version.rb

@@ -2,6 +2,6 @@
 
 module RgGen
   module SystemVerilog
-    VERSION = '0.35.1'
+    VERSION = '0.36.0'
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rggen-systemverilog
 version: !ruby/object:Gem::Version
-  version: 0.35.1
+  version: 0.36.0
 platform: ruby
 authors:
 - Taichi Ishitani
 bindir: bin
 cert_chain: []
-date: 2025-06-01 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: 'SystemVerilog RTL and UVM RAL model generators for RgGen.
 
@@ -40,12 +40,12 @@ files:
 - lib/rggen/systemverilog/common/utility/structure_definition.rb
 - lib/rggen/systemverilog/ral.rb
 - lib/rggen/systemverilog/ral/bit_field/type.rb
+- lib/rggen/systemverilog/ral/bit_field/type/counter_rwc_rwhw_rws.rb
 - lib/rggen/systemverilog/ral/bit_field/type/custom.rb
 - lib/rggen/systemverilog/ral/bit_field/type/rof_rohw.rb
 - lib/rggen/systemverilog/ral/bit_field/type/rotrg_rwtrg_wotrg.rb
 - lib/rggen/systemverilog/ral/bit_field/type/row0trg_row1trg_w0trg_w1trg.rb
 - lib/rggen/systemverilog/ral/bit_field/type/rowo_rowotrg.rb
-- lib/rggen/systemverilog/ral/bit_field/type/rwc_rwhw_rws.rb
 - lib/rggen/systemverilog/ral/bit_field/type/rwe_rwl.rb
 - lib/rggen/systemverilog/ral/feature.rb
 - lib/rggen/systemverilog/ral/register/type.rb
@@ -53,6 +53,7 @@ files:
 - lib/rggen/systemverilog/ral/register/type/external.rb
 - lib/rggen/systemverilog/ral/register/type/indirect.erb
 - lib/rggen/systemverilog/ral/register/type/indirect.rb
+- lib/rggen/systemverilog/ral/register/type/maskable.rb
 - lib/rggen/systemverilog/ral/register_block/sv_ral_model.erb
 - lib/rggen/systemverilog/ral/register_block/sv_ral_model.rb
 - lib/rggen/systemverilog/ral/register_block/sv_ral_package.rb
@@ -64,6 +65,8 @@ files:
 - lib/rggen/systemverilog/rtl.rb
 - lib/rggen/systemverilog/rtl/bit_field/sv_rtl_top.rb
 - lib/rggen/systemverilog/rtl/bit_field/type.rb
+- lib/rggen/systemverilog/rtl/bit_field/type/counter.erb
+- lib/rggen/systemverilog/rtl/bit_field/type/counter.rb
 - lib/rggen/systemverilog/rtl/bit_field/type/custom.erb
 - lib/rggen/systemverilog/rtl/bit_field/type/custom.rb
 - lib/rggen/systemverilog/rtl/bit_field/type/rc_w0c_w1c_wc_woc.erb
@@ -111,6 +114,8 @@ files:
 - lib/rggen/systemverilog/rtl/register/type/external.rb
 - lib/rggen/systemverilog/rtl/register/type/indirect.erb
 - lib/rggen/systemverilog/rtl/register/type/indirect.rb
+- lib/rggen/systemverilog/rtl/register/type/maskable.erb
+- lib/rggen/systemverilog/rtl/register/type/maskable.rb
 - lib/rggen/systemverilog/rtl/register/type/rw.erb
 - lib/rggen/systemverilog/rtl/register/type/rw.rb
 - lib/rggen/systemverilog/rtl/register_block/protocol.rb
@@ -150,14 +155,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 4.0.3
 specification_version: 4
-summary: rggen-systemverilog-0.35.1
+summary: rggen-systemverilog-0.36.0
 test_files: []

data/lib/rggen/systemverilog/ral/bit_field/type/rwc_rwhw_rws.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-RgGen.define_list_item_feature(:bit_field, :type, [:rwc, :rwhw, :rws]) do
-  sv_ral { access 'RW' }
-end