rggen-systemverilog 0.28.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60c25d990cd209fcfe988002dee2325f1ec8d319295f9014cfe59715b87d44e7
-  data.tar.gz: db8957f134063c33fdd6efbfe3596e5871ac6f166359bb4f7b013f883ab9f3bd
+  metadata.gz: 7e5fc548cd3c93e80580efc9d2027ce309b9a6e8900078f3f5bf8bb157357e53
+  data.tar.gz: 4fb5af7f5ad76f4938406a553fe425767e2fc363ce79b79b07213fd292535efb
 SHA512:
-  metadata.gz: 759a5c90f3311b34f016b4fbade25d14785349f9ae88e1244596baa9b44abb80453eb3609ad2534d0b9d78a390aa8f39c747257c0a9ababa209b669cbb52b331
-  data.tar.gz: d0923aa115d8251966cad5ee14846b6037d1187e5c889ff288af6c0a26b132dcd7823916dd8d7214317dccbc849f85482fc1b2d947b6cf465cc218d8d704fef2
+  metadata.gz: 34cc65c49e1510303e8ca8ed7d16b941bfd331d66188602ecdf41a61cc9b1b0a627f56d33c3ba6b44b0c2e56ca1c44a896893ad3d82070a72b5cfb913e5a28b5
+  data.tar.gz: 55600c8bf365ffbbc2d8cc6b020e6cb13c33ebb91f49253d53cef0c5a7a5df86d639a61cc0a1eb2aa5d2a36d86530236e837735721da55def694c2a1c19c9d74

data/LICENSE

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

@@ -35,7 +35,7 @@ Feedbacks, bug reports, questions and etc. are wellcome! You can post them by us
 
 ## Copyright & License
 
-Copyright © 2019-2022 Taichi Ishitani. RgGen::SystemVerilog is licensed under the [MIT License](https://opensource.org/licenses/MIT), see [LICENSE](LICENSE) for futher details.
+Copyright © 2019-2023 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/utility/package_definition.rb

@@ -8,6 +8,7 @@ module RgGen
           define_attribute :name
           define_attribute :package_imports
           define_attribute :include_files
+          define_attribute :parameters
 
           def package_imports(packages)
             @package_imports ||= []
@@ -36,21 +37,28 @@ module RgGen
           def pre_body_code(code)
             package_import_declaration(code)
             file_include_directives(code)
+            parameter_declarations(code)
           end
 
           def package_import_declaration(code)
             declarations =
-              Array(@package_imports)
-                .map { |package| ['import', space, package, '::*'] }
-            add_declarations_to_body(code, declarations)
+              @package_imports
+                &.map { |package| ['import', space, package, '::*'] }
+            declarations &&
+              add_declarations_to_body(code, declarations)
           end
 
           def file_include_directives(code)
-            Array(@include_files).each do |file|
+            @include_files&.each do |file|
               code << ['`include', space, string(file), nl]
             end
           end
 
+          def parameter_declarations(code)
+            parameters &&
+              add_declarations_to_body(code, parameters)
+          end
+
           def footer_code
             'endpackage'
           end

data/lib/rggen/systemverilog/rtl.rb

@@ -7,6 +7,7 @@ require_relative 'rtl/register_index'
 require_relative 'rtl/register_type'
 require_relative 'rtl/indirect_index'
 require_relative 'rtl/bit_field_index'
+require_relative 'rtl_package/feature'
 
 RgGen.setup_plugin :'rggen-sv-rtl' do |plugin|
   plugin.version RgGen::SystemVerilog::VERSION
@@ -50,4 +51,17 @@ RgGen.setup_plugin :'rggen-sv-rtl' do |plugin|
     'rtl/bit_field/type/wo_wo1_wotrg',
     'rtl/bit_field/type/wrc_wrs'
   ]
+
+  plugin.register_component :sv_rtl_package do
+    component RgGen::SystemVerilog::Common::Component,
+              RgGen::SystemVerilog::Common::ComponentFactory
+    feature RgGen::SystemVerilog::RTLPackage::Feature,
+            RgGen::SystemVerilog::Common::FeatureFactory
+  end
+
+  plugin.files [
+    'rtl_package/bit_field/sv_rtl_package',
+    'rtl_package/register/sv_rtl_package',
+    'rtl_package/register_block/sv_rtl_package'
+  ]
 end

data/lib/rggen/systemverilog/rtl_package/bit_field/sv_rtl_package.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+RgGen.define_simple_feature(:bit_field, :sv_rtl_package) do
+  sv_rtl_package do
+    build do
+      localparam :__width, {
+        name: "#{full_name}_bit_width",
+        data_type: :int, default: bit_field.width
+      }
+      localparam :__mask, {
+        name: "#{full_name}_bit_mask",
+        data_type: :bit, width: bit_field.width, default: mask_value
+      }
+      define_offset_localparam
+      define_label_localparams
+    end
+
+    private
+
+    def mask_value
+      hex((1 << bit_field.width) - 1, bit_field.width)
+    end
+
+    def define_offset_localparam
+      if bit_field.sequential?
+        define_sequential_offset_localparam
+      else
+        define_single_offset_localparam
+      end
+    end
+
+    def define_sequential_offset_localparam
+      size = bit_field.sequence_size
+      localparam :__offset, {
+        name: "#{full_name}_bit_offset",
+        data_type: :int, array_size: [size], default: offset_value(size)
+      }
+    end
+
+    def offset_value(size)
+      array(Array.new(size, &bit_field.method(:lsb)))
+    end
+
+    def define_single_offset_localparam
+      localparam :__offset, {
+        name: "#{full_name}_bit_offset",
+        data_type: :int, default: bit_field.lsb
+      }
+    end
+
+    def define_label_localparams
+      bit_field.labels
+        .each { |label| define_label_localparam(label) }
+    end
+
+    def define_label_localparam(label)
+      identifier = "label_#{label.name}".downcase.to_sym
+      value = hex(label.value, bit_field.width)
+      localparam identifier, {
+        name: "#{full_name}_#{label.name}",
+        data_type: :bit, width: bit_field.width, default: value
+      }
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RgGen
+  module SystemVerilog
+    module RTLPackage
+      class Feature < Common::Feature
+        private
+
+        def full_name(separator = '_')
+          component.full_name(separator)
+        end
+
+        def create_parameter(parameter_type, attributes, &block)
+          attributes =
+            attributes.merge(
+              parameter_type: parameter_type, array_format: :unpacked,
+              name: attributes[:name].upcase
+            )
+          DataObject.new(
+            :parameter, attributes, &block
+          )
+        end
+
+        define_entity :localparam, :create_parameter, :parameter, -> { register_block }
+      end
+    end
+  end
+end

data/lib/rggen/systemverilog/rtl_package/register/sv_rtl_package.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+RgGen.define_simple_feature(:register, :sv_rtl_package) do
+  sv_rtl_package do
+    build do
+      localparam :__byte_width, {
+        name: "#{full_name}_byte_width",
+        data_type: :int, default: register.byte_width
+      }
+      localparam :__byte_size, {
+        name: "#{full_name}_byte_size",
+        data_type: :int, default: register.byte_size(hierarchical: true)
+      }
+      define_array_size_localparam
+      define_offset_localparams
+    end
+
+    private
+
+    def define_array_size_localparam
+      return unless array?
+
+      list = array_size_list
+      localparam :__array_size, {
+        name: "#{full_name}_array_size",
+        data_type: :int, array_size: [list.size], default: array(list)
+      }
+    end
+
+    def define_offset_localparams
+      if array?
+        define_array_offset_localparams
+      else
+        define_single_offset_localparam
+      end
+    end
+
+    def define_array_offset_localparams
+      width = register_block.local_address_width
+      size_list = array_size_list
+      value_list = group_address_list(address_list, size_list).first
+      localparam :__offset, {
+        name: "#{full_name}_byte_offset",
+        data_type: :bit, width: width, array_size: size_list, default: value_list
+      }
+    end
+
+    def address_list
+      register
+        .expanded_offset_addresses
+        .map { |address| hex(address, register_block.local_address_width) }
+    end
+
+    def group_address_list(address_list, size_list)
+      list =
+        if size_list.size > 1
+          group_address_list(address_list, size_list[1..])
+        else
+          address_list
+        end
+      list
+        .each_slice(size_list.first)
+        .map(&method(:array))
+    end
+
+    def define_single_offset_localparam
+      width = register_block.local_address_width
+      value = address_list.first
+      localparam :__offset, {
+        name: "#{full_name}_byte_offset",
+        data_type: :bit, width: width, default: value
+      }
+    end
+
+    def array?
+      register.array?(hierarchical: true)
+    end
+
+    def array_size_list
+      register.array_size(hierarchical: true)
+    end
+  end
+end

data/lib/rggen/systemverilog/rtl_package/register_block/sv_rtl_package.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+RgGen.define_simple_feature(:register_block, :sv_rtl_package) do
+  sv_rtl_package do
+    write_file '<%= package_name %>.sv' do |file|
+      file.body { sv_rtl_package_definition }
+    end
+
+    private
+
+    def sv_rtl_package_definition
+      package_definition(package_name) do |package|
+        package.parameters parameters
+      end
+    end
+
+    def package_name
+      "#{register_block.name}_rtl_pkg"
+    end
+
+    def parameters
+      register_block.declarations[:parameter]
+    end
+  end
+end

data/lib/rggen/systemverilog/version.rb

@@ -2,6 +2,6 @@
 
 module RgGen
   module SystemVerilog
-    VERSION = '0.28.0'
+    VERSION = '0.29.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rggen-systemverilog
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.29.0
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-10 00:00:00.000000000 Z
+date: 2023-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -135,6 +135,10 @@ files:
 - lib/rggen/systemverilog/rtl/register_file/sv_rtl_top.rb
 - lib/rggen/systemverilog/rtl/register_index.rb
 - lib/rggen/systemverilog/rtl/register_type.rb
+- lib/rggen/systemverilog/rtl_package/bit_field/sv_rtl_package.rb
+- lib/rggen/systemverilog/rtl_package/feature.rb
+- lib/rggen/systemverilog/rtl_package/register/sv_rtl_package.rb
+- lib/rggen/systemverilog/rtl_package/register_block/sv_rtl_package.rb
 - lib/rggen/systemverilog/version.rb
 homepage: https://github.com/rggen/rggen-systemverilog
 licenses:
@@ -153,15 +157,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
-summary: rggen-systemverilog-0.28.0
+summary: rggen-systemverilog-0.29.0
 test_files: []