rggen 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 465d7d46de470aa8c5e35b6edb64d887b24c508ad8bcfd4b330da00c69aacef3
-  data.tar.gz: 0bcf8d36d15285a08a854de69b4807aa69edccc67b70351f29e0ff68474d1ea1
+  metadata.gz: 1d7d3f47df5783ad1f2671fcdf202591a2e002a39da7cf15a342281cebfae865
+  data.tar.gz: b3f47d55468996118bc2d9af949eeb0a690f32c19d5d8998950f3ad781bb4454
 SHA512:
-  metadata.gz: 7f49bd6b328af1b484fc37f11fa614492889a826a32c94970853232aebfec52f3fbc8531ec1e03ea8b77169a18b870ef5c28a13b3de5627c6d45c03c4121fb0b
-  data.tar.gz: 685fe218240b22443c2b48d9b5a656dd40868baf26c9954f491ca860a820db883e3bbcff1d74c8f0d4b11420bfd09a5fbdb1c46fa99abbf3821df2c62a1570ae
+  metadata.gz: 4d995db860c4f4d521ff75803bef3601a57b0b08a1eb47875193e05e4441f16ebcbddcc9258f968b8a8325106cca441b64580d173b811837f2897ed79688396d
+  data.tar.gz: 623ba730bad1ac76a8a037c79e968bd230ebd5bd1080644cba657a3c0814680ed113a359e5875cb14945eb3c9e46f593517a4040ad9293654653316c997bf686

data/README.md

@@ -1,5 +1,5 @@
 [![Gem Version](https://badge.fury.io/rb/rggen.svg)](https://badge.fury.io/rb/rggen)
-[![Build Status](https://travis-ci.org/rggen/rggen.svg?branch=master)](https://travis-ci.org/rggen/rggen)
+[![Build Status](https://travis-ci.com/rggen/rggen.svg?branch=master)](https://travis-ci.com/rggen/rggen)
 [![Maintainability](https://api.codeclimate.com/v1/badges/5ee2248300ec0517e597/maintainability)](https://codeclimate.com/github/rggen/rggen/maintainability)
 [![codecov](https://codecov.io/gh/rggen/rggen/branch/master/graph/badge.svg)](https://codecov.io/gh/rggen/rggen)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=rggen_rggen&metric=alert_status)](https://sonarcloud.io/dashboard?id=rggen_rggen)
@@ -32,7 +32,15 @@ RgGen is written in the [Ruby](https://www.ruby-lang.org/en/about/) programing l
 
 ### Installatin Command
 
-RgGen depends on [RgGen::Core](https://github.com/rggen/rggen-core), [RgGen::SystemVerilog](https://github.com/rggen/rggen-systemverilog), [RgGen::SpreadsheetLoader](https://github.com/rggen/rggen-spreadsheet-loader) and other Ruby libraries. To install RgGen and dependencies, use the command below:
+RgGen depends on following sub components and other Ruby libraries.
+
+* [rggen-core](https://github.com/rggen/rggen-core)
+* [rggen-default-register-map](https://github.com/rggen/rggen-default-register-map)
+* [rggen-systemverilog](https://github.com/rggen/rggen-systemverilog)
+* [rggen-markdown](https://github.com/rggen/rggen-markdown)
+* [rggen-spreadsheet-loader](https://github.com/rggen/rggen-spreadsheet-loader)
+
+To install RgGen and the dependencies, use the command below:
 
 ```
 $ gem install rggen
@@ -72,9 +80,12 @@ Feedbacks, bug reports, questions and etc. are wellcome! You can post them by us
 ## See Also
 
 * https://github.com/rggen/rggen-core
+* https://github.com/rggen/rggen-default-register-map
 * https://github.com/rggen/rggen-systemverilog
+* https://github.com/rggen/rggen-markdown
 * https://github.com/rggen/rggen-spreadsheet-loader
 
+
 ## Copyright & License
 
 Copyright © 2019 Taichi Ishitani. RgGen is licensed unther the [MIT License](https://opensource.org/licenses/MIT), see [LICENSE](LICENSE) for futher detils.

data/lib/rggen.rb

@@ -2,4 +2,3 @@
 
 require_relative 'rggen/version'
 require_relative 'rggen/default_setup_file'
-require_relative 'rggen/built_in'

data/lib/rggen/default.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'rggen/default_register_map/setup'
+require 'rggen/systemverilog/rtl/setup'
+require 'rggen/systemverilog/ral/setup'
+require 'rggen/markdown/setup'
+require 'rggen/spreadsheet_loader/setup'

data/lib/rggen/default_setup_file.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
 module RgGen
-  DEFAULT_SETUP_FILE =
-    File.expand_path('setup/default.rb', __dir__).freeze
+  DEFAULT_SETUP_FILE = File.join(__dir__, 'default.rb').freeze
 end

data/lib/rggen/version.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'built_in/version'
-
 module RgGen
-  VERSION = BuiltIn::VERSION
+  VERSION = '0.13.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rggen
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-19 00:00:00.000000000 Z
+date: 2019-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rggen-core
@@ -16,56 +16,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rggen-default-register-map
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: rggen-markdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: rggen-spreadsheet-loader
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: rggen-systemverilog
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,79 +108,9 @@ files:
 - LICENSE
 - README.md
 - lib/rggen.rb
-- lib/rggen/built_in.rb
-- lib/rggen/built_in/bit_field/bit_assignment.rb
-- lib/rggen/built_in/bit_field/comment.rb
-- lib/rggen/built_in/bit_field/initial_value.rb
-- lib/rggen/built_in/bit_field/name.rb
-- lib/rggen/built_in/bit_field/reference.rb
-- lib/rggen/built_in/bit_field/sv_rtl_top.rb
-- lib/rggen/built_in/bit_field/type.rb
-- lib/rggen/built_in/bit_field/type/rc_w0c_w1c.erb
-- lib/rggen/built_in/bit_field/type/rc_w0c_w1c.rb
-- lib/rggen/built_in/bit_field/type/reserved.erb
-- lib/rggen/built_in/bit_field/type/reserved.rb
-- lib/rggen/built_in/bit_field/type/ro.erb
-- lib/rggen/built_in/bit_field/type/ro.rb
-- lib/rggen/built_in/bit_field/type/rof.erb
-- lib/rggen/built_in/bit_field/type/rof.rb
-- lib/rggen/built_in/bit_field/type/rs_w0s_w1s.erb
-- lib/rggen/built_in/bit_field/type/rs_w0s_w1s.rb
-- lib/rggen/built_in/bit_field/type/rw_wo.erb
-- lib/rggen/built_in/bit_field/type/rw_wo.rb
-- lib/rggen/built_in/bit_field/type/rwc_rwe_rwl.erb
-- lib/rggen/built_in/bit_field/type/rwc_rwe_rwl.rb
-- lib/rggen/built_in/bit_field/type/w0trg_w1trg.erb
-- lib/rggen/built_in/bit_field/type/w0trg_w1trg.rb
-- lib/rggen/built_in/global/address_width.rb
-- lib/rggen/built_in/global/array_port_format.rb
-- lib/rggen/built_in/global/bus_width.rb
-- lib/rggen/built_in/global/fold_sv_interface_port.rb
-- lib/rggen/built_in/register/markdown.erb
-- lib/rggen/built_in/register/markdown.rb
-- lib/rggen/built_in/register/name.rb
-- lib/rggen/built_in/register/offset_address.rb
-- lib/rggen/built_in/register/size.rb
-- lib/rggen/built_in/register/sv_rtl_top.rb
-- lib/rggen/built_in/register/type.rb
-- lib/rggen/built_in/register/type/default_sv_ral.erb
-- lib/rggen/built_in/register/type/default_sv_rtl.erb
-- lib/rggen/built_in/register/type/external.erb
-- lib/rggen/built_in/register/type/external.rb
-- lib/rggen/built_in/register/type/indirect.rb
-- lib/rggen/built_in/register/type/indirect_sv_ral.erb
-- lib/rggen/built_in/register/type/indirect_sv_rtl.erb
-- lib/rggen/built_in/register_block/byte_size.rb
-- lib/rggen/built_in/register_block/markdown.erb
-- lib/rggen/built_in/register_block/markdown.rb
-- lib/rggen/built_in/register_block/name.rb
-- lib/rggen/built_in/register_block/protocol.rb
-- lib/rggen/built_in/register_block/protocol/apb.erb
-- lib/rggen/built_in/register_block/protocol/apb.rb
-- lib/rggen/built_in/register_block/protocol/axi4lite.erb
-- lib/rggen/built_in/register_block/protocol/axi4lite.rb
-- lib/rggen/built_in/register_block/sv_ral_block_model.erb
-- lib/rggen/built_in/register_block/sv_ral_package.rb
-- lib/rggen/built_in/register_block/sv_rtl_macros.erb
-- lib/rggen/built_in/register_block/sv_rtl_top.rb
-- lib/rggen/built_in/version.rb
+- lib/rggen/default.rb
 - lib/rggen/default_setup_file.rb
-- lib/rggen/setup/default.rb
 - lib/rggen/version.rb
-- sample/block_0.md
-- sample/block_0.rb
-- sample/block_0.sv
-- sample/block_0.xlsx
-- sample/block_0.yml
-- sample/block_0_ral_pkg.sv
-- sample/block_1.md
-- sample/block_1.rb
-- sample/block_1.sv
-- sample/block_1.xlsx
-- sample/block_1.yml
-- sample/block_1_ral_pkg.sv
-- sample/config.json
-- sample/config.yml
 homepage: https://github.com/rggen/rggen
 licenses:
 - MIT

data/lib/rggen/built_in.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-require 'rggen/systemverilog'
-require 'rggen/markdown'
-require_relative 'built_in/version'
-
-module RgGen
-  module BuiltIn
-    BUILT_IN_FILES = [
-      'built_in/global/address_width',
-      'built_in/global/array_port_format',
-      'built_in/global/bus_width',
-      'built_in/global/fold_sv_interface_port',
-      'built_in/register_block/byte_size',
-      'built_in/register_block/markdown',
-      'built_in/register_block/name',
-      'built_in/register_block/protocol',
-      'built_in/register_block/protocol/apb',
-      'built_in/register_block/protocol/axi4lite',
-      'built_in/register_block/sv_ral_package',
-      'built_in/register_block/sv_rtl_top',
-      'built_in/register/markdown',
-      'built_in/register/name',
-      'built_in/register/offset_address',
-      'built_in/register/size',
-      'built_in/register/sv_rtl_top',
-      'built_in/register/type',
-      'built_in/register/type/external',
-      'built_in/register/type/indirect',
-      'built_in/bit_field/bit_assignment',
-      'built_in/bit_field/comment',
-      'built_in/bit_field/initial_value',
-      'built_in/bit_field/name',
-      'built_in/bit_field/reference',
-      'built_in/bit_field/sv_rtl_top',
-      'built_in/bit_field/type',
-      'built_in/bit_field/type/rc_w0c_w1c',
-      'built_in/bit_field/type/reserved',
-      'built_in/bit_field/type/ro',
-      'built_in/bit_field/type/rof',
-      'built_in/bit_field/type/rs_w0s_w1s',
-      'built_in/bit_field/type/rw_wo',
-      'built_in/bit_field/type/rwc_rwe_rwl',
-      'built_in/bit_field/type/w0trg_w1trg'
-    ].freeze
-
-    def self.load_built_in
-      BUILT_IN_FILES.each { |file| require_relative file }
-    end
-
-    def self.setup(_builder)
-      load_built_in
-    end
-  end
-
-  setup :'built-in', BuiltIn
-end

data/lib/rggen/built_in/bit_field/bit_assignment.rb

@@ -1,114 +0,0 @@
-# frozen_string_literal: true
-
-RgGen.define_simple_feature(:bit_field, :bit_assignment) do
-  register_map do
-    property :lsb, body: ->(index = 0) { msb_lsb_bit(index, @lsb) }
-    property :msb, body: ->(index = 0) { msb_lsb_bit(index, @lsb + width - 1) }
-    property :width, body: -> { @width || 1 }
-    property :sequence_size
-    property :step, body: -> { @step || width }
-    property :sequential?, body: -> { !@sequence_size.nil? }
-    property :bit_map, body: -> { @bit_map ||= calc_bit_map }
-
-    input_pattern /#{integer}(?::#{integer}){0,3}/,
-                  match_automatically: false
-
-    build do |value|
-      input_value = preprocess(value)
-      @lsb, @width, @sequence_size, @step =
-        KEYS.map { |key| parse_value(input_value, key) }
-    end
-
-    verify(:feature) do
-      error_condition { [@lsb, @width, @sequence_size, @step].none? }
-      message { 'no bit assignment is given' }
-    end
-
-    verify(:feature) do
-      error_condition { !@lsb }
-      message { 'no lsb is given' }
-    end
-
-    verify(:feature) do
-      error_condition { lsb.negative? }
-      message { "lsb is less than 0: #{lsb}" }
-    end
-
-    verify(:feature) do
-      error_condition { width < 1 }
-      message { "width is less than 1: #{width}" }
-    end
-
-    verify(:feature) do
-      error_condition { sequential? && sequence_size < 1 }
-      message { "sequence size is less than 1: #{sequence_size}" }
-    end
-
-    verify(:feature) do
-      error_condition { sequential? && step < 1 }
-      message { "step is less than 1: #{step}" }
-    end
-
-    verify(:feature) do
-      error_condition { overlap? }
-      message { 'overlap with existing bit field(s)' }
-    end
-
-    printable(:bit_assignments) do
-      Array.new(@sequence_size || 1) do |i|
-        width > 1 && "[#{msb(i)}:#{lsb(i)}]" || "[#{lsb(i)}]"
-      end
-    end
-
-    private
-
-    KEYS = [:lsb, :width, :sequence_size, :step].freeze
-
-    def preprocess(value)
-      if value.is_a?(Hash)
-        value
-      elsif match_pattern(value)
-        split_match_data(match_data)
-      else
-        error "illegal input value for bit assignment: #{value.inspect}"
-      end
-    end
-
-    def split_match_data(match_data)
-      match_data
-        .to_s
-        .split(':')
-        .map.with_index { |value, i| [KEYS[i], value] }
-        .to_h
-    end
-
-    def parse_value(input_value, key)
-      (input_value.key?(key) && Integer(input_value[key])) || nil
-    rescue ArgumentError, TypeError
-      error "cannot convert #{input_value[key].inspect} into " \
-            "bit assignment(#{key.to_s.tr('_', ' ')})"
-    end
-
-    def msb_lsb_bit(index, base)
-      calc_bit_position((sequential? && index) || 0, base)
-    end
-
-    def calc_bit_position(index, base)
-      if index.is_a?(Integer)
-        base + step * index
-      else
-        "#{base}+#{step}*#{index}"
-      end
-    end
-
-    def calc_bit_map
-      Array.new(sequence_size || 1) { |i| (2**width - 1) << lsb(i) }.inject(:|)
-    end
-
-    def overlap?
-      register
-        .bit_fields
-        .any? { |bit_field| (bit_field.bit_map & bit_map).positive? }
-    end
-  end
-end

data/lib/rggen/built_in/bit_field/comment.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-RgGen.define_simple_feature(:bit_field, :comment) do
-  register_map do
-    property :comment, body: -> { @comment ||= '' }
-
-    build do |value|
-      @comment =
-        if value.is_a?(Array)
-          value.join("\n")
-        else
-          value.to_s
-        end
-    end
-
-    printable :comment
-  end
-end