rggen 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2a8d729d006b9018f50cd1859191ba69eac8ffff986644c75b727606efe2cd9
-  data.tar.gz: f0f31ea88bc75e766a6aaba4205e1b38c172f80649b3641dc0923e242de37fb0
+  metadata.gz: 32752d1d159f8ad37cccf38212bd0e9dede541bde3e6271d134b517903ae7b38
+  data.tar.gz: 6eb6f3dd794801304a0aafff948bcf7461c827465701652a3b6110c2fd1e2973
 SHA512:
-  metadata.gz: beb719d28bf108dd444a090d0a08d4b99bf486368aa45f9cdd9e2ce34637fdc4f593a34b15934be3bb15456bc73da22ef08edab49c6d2c5eeb8325403491e94b
-  data.tar.gz: 51f8948e0709eaf8468e860dc71c71937e398b03cc2b59b61a875dfef3ba31345f5433b35548ac3d22c95797492febee2ed665ef313f5d146a1c4ec02ccd8da7
+  metadata.gz: 02c6eb88c7aaef70433f581477fefc13953992bf8b25b3d375621fbfbd480e309a3ec812187afcc22b8161b52ae8fd0b2768de13cb72943ef5071209616aa2cf
+  data.tar.gz: 96c06787f001392b0893d6edb3d38d5d5fca4da6ef9f3ffa16eb6e6ee56a2c8a1c936f53bb354a2e86bee57440c5a4e04ff1c36a95b43d192eb684e7422a464b

data/CODE_OF_CONDUCT.md

@@ -1,24 +1,41 @@
-# Contributor Code of Conduct
+# Contributor Covenant Code of Conduct
 
-As contributors and maintainers of this project, and in the interest of
-fostering an open and welcoming community, we pledge to respect all people who
-contribute through reporting issues, posting feature requests, updating
-documentation, submitting pull requests or patches, and other activities.
+## Our Pledge
 
-We are committed to making participation in this project a harassment-free
-experience for everyone, regardless of level of experience, gender, gender
-identity and expression, sexual orientation, disability, personal appearance,
-body size, race, ethnicity, age, religion, or nationality.
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-* Other unethical or unprofessional conduct
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
 
 Project maintainers have the right and responsibility to remove, edit, or
 reject comments, commits, code, wiki edits, issues, and other contributions
@@ -26,24 +43,32 @@ that are not aligned to this Code of Conduct, or to ban temporarily or
 permanently any contributor for other behaviors that they deem inappropriate,
 threatening, offensive, or harmful.
 
-By adopting this Code of Conduct, project maintainers commit themselves to
-fairly and consistently applying these principles to every aspect of managing
-this project. Project maintainers who do not follow or enforce the Code of
-Conduct may be permanently removed from the project team.
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
 
-This code of conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
+## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at taichi730@jf6.so-net.ne.jp. All
+reported by contacting the project team at taichi730@gmail.com. All
 complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. Maintainers are
-obligated to maintain confidentiality with regard to the reporter of an
-incident.
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 1.3.0, available at
-[http://contributor-covenant.org/version/1/3/0/][version]
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
 
 [homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/
+[version]: http://contributor-covenant.org/version/1/4/

data/{LICENSE.txt → LICENSE}

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

@@ -1,56 +1,65 @@
-[![Gem Version](https://badge.fury.io/rb/rggen.svg)](https://badge.fury.io/rb/rggen)
-[![Build Status](https://travis-ci.org/taichi-ishitani/rggen.svg?branch=master)](https://travis-ci.org/taichi-ishitani/rggen)
-[![Maintainability](https://api.codeclimate.com/v1/badges/8f184e6e714a0fbdb6b0/maintainability)](https://codeclimate.com/github/taichi-ishitani/rggen/maintainability)
-[![codecov](https://codecov.io/gh/taichi-ishitani/rggen/branch/master/graph/badge.svg)](https://codecov.io/gh/taichi-ishitani/rggen)
-[![Join the chat at https://gitter.im/taichi-ishitani/rggen](https://badges.gitter.im/taichi-ishitani/rggen.svg)](https://gitter.im/taichi-ishitani/rggen?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-
-# RgGen
-
-RgGen is a code generator tool for SoC/IP/FPGA/RTL engineers.
-It will automatically generate source code for control/status registers, e.g. RTL, UVM RAL model, C header file, from its register map document.
-Also RgGen is customizable so you can build your specific generate tool.
-
-## Ruby
-
-RgGen is written in the [*Ruby*](https://www.ruby-lang.org/en/about/) programing language and supports version 2.3 or later.
-If you don't have above version of Ruby, you need to install the Ruby at first.
-To install the Ruby, see [this page](https://www.ruby-lang.org/en/downloads/).
-
-## Installation
-
-To install RgGen and required libraries, use the following command:
-
-    $ gem install rggen
-
-RgGen will be installed under your system root.
-
-If you want to install them on other location, you need to specify the install directory and set the **GEM_PATH** environment variable like below:
-
-    $ gem install --install-dir YOUR_INSTALL_DIRECTORY rggen
-    $ export GEM_PATH=YOUR_INSTALL_DIRECTORY
-
-## Usage
-
-See [this page](https://github.com/taichi-ishitani/rggen/wiki/Getting-Started)
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contact
-
-If you have any questions, problems, ideas or somethings, you can post them on the following ways:
-
-1. [Issue tracker](https://github.com/taichi-ishitani/rggen/issues)
-2. [Chat room](https://gitter.im/taichi-ishitani/rggen)
-3. [Mail](mailto:taichi730@gmail.com)
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/taichi-ishitani/rggen. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-## Copyright
-
-Copyright © 2015-2018 Taichi Ishitani. See [LICENSE.txt](LICENSE.txt) for further details.
+[![Build Status](https://travis-ci.org/rggen/rggen.svg?branch=master)](https://travis-ci.org/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)
+
+# RgGen
+
+RgGen is a code generation tool for ASIC/IP/FPGA/RTL engineers. It will automatically generate soruce code related to control/status registers (CSR), e.g. SytemVerilog RTL, UVM RAL model, from human readable register map documents.
+
+RgGen has following features:
+
+* Generate source files related to CSR from register map documents
+    * Source files listed below will be generated:
+        * SystemVerilog RTL
+        * UVM RAL model
+* Register map documents can be written in human readable format
+    * Supported formats are listed below:
+        * Ruby with APIs to describe register map information
+        * YAML
+        * JSON
+        * Spreadsheet (XLSX, XLS, OSD, CSV)
+* Costomize RgGen for you environment
+    * E.g. add special bit field types
+
+## Installation
+
+### Ruby
+
+RgGen is written in the [Ruby](https://www.ruby-lang.org/en/about/) programing language and its required version is 2.3 or later. You need to install  any of these versions of Ruby before installing RgGen tool. To install Ruby, see [this page](https://www.ruby-lang.org/en/downloads/).
+
+### Installatin Command
+
+To isnstall RgGen and necessary libraries, use this command:
+
+```
+$ gem install rggen
+```
+
+RgGen and libraries will be installed on your system root.
+
+If you want to install them on other location, you need to specify install path and set the `GEM_PATH` environment variable:
+
+```
+$ gem install --install-dir YOUR_INSTALL_DIRECTORY rggen
+$ export GEM_PATH=YOUR_INSTALL_DIRECTORY
+```
+
+## Usage
+
+See [Wiki documents](https://github.com/rggen/rggen/wiki).
+
+## Contact
+
+Feedbacks, bug reports, questions and etc. are wellcome! You can post them by using following ways:
+
+* [GitHub Issue Tracker](https://github.com/rggen/rggen/issues)
+* [Mail](mailto:taichi730@gmail.com)
+
+## Copyright & License
+
+Copyright © 2019 Taichi Ishitani. RgGen is licensed unther the [MIT License](https://opensource.org/licenses/MIT), see [LICENSE](LICENSE) for futher detils.
+
+## Code of Conduct
+
+Everyone interacting in the RgGen project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rggen/rggen/blob/master/CODE_OF_CONDUCT.md).

data/lib/rggen.rb

@@ -1,64 +1,5 @@
-module RgGen
-  require 'forwardable'
-  require 'singleton'
-  require 'pathname'
-  require 'optparse'
-  require 'erubi'
-  require 'csv'
-  require 'roo'
-  require 'spreadsheet'
+# frozen_string_literal: true
 
-  require_relative 'rggen/version'
-  require_relative 'rggen/rggen_home'
-
-  require_relative 'rggen/exceptions'
-
-  require_relative 'rggen/core_extensions/array'
-  require_relative 'rggen/core_extensions/facets'
-  require_relative 'rggen/core_extensions/forwardable'
-  require_relative 'rggen/core_extensions/integer'
-  require_relative 'rggen/core_extensions/math'
-  require_relative 'rggen/core_extensions/roo'
-
-  require_relative 'rggen/base/hierarchical_accessors'
-  require_relative 'rggen/base/hierarchical_item_accessors'
-  require_relative 'rggen/base/internal_struct'
-  require_relative 'rggen/base/component'
-  require_relative 'rggen/base/item'
-  require_relative 'rggen/base/component_factory'
-  require_relative 'rggen/base/item_factory'
-
-  require_relative 'rggen/input_base/regexp_patterns'
-  require_relative 'rggen/input_base/component'
-  require_relative 'rggen/input_base/item'
-  require_relative 'rggen/input_base/loader'
-  require_relative 'rggen/input_base/component_factory'
-  require_relative 'rggen/input_base/item_factory'
-
-  require_relative 'rggen/output_base/code_generator'
-  require_relative 'rggen/output_base/template_engine'
-  require_relative 'rggen/output_base/file_writer'
-  require_relative 'rggen/output_base/component'
-  require_relative 'rggen/output_base/item'
-  require_relative 'rggen/output_base/component_factory'
-  require_relative 'rggen/output_base/item_factory'
-
-  require_relative 'rggen/builder/simple_item_entry'
-  require_relative 'rggen/builder/list_item_entry'
-  require_relative 'rggen/builder/item_store'
-  require_relative 'rggen/builder/component_entry'
-  require_relative 'rggen/builder/component_store'
-  require_relative 'rggen/builder/input_component_store'
-  require_relative 'rggen/builder/output_component_store'
-  require_relative 'rggen/builder/category'
-  require_relative 'rggen/builder/builder'
-
-  require_relative 'rggen/options'
-  require_relative 'rggen/option_switches'
-  require_relative 'rggen/generator'
-
-  require_relative 'rggen/commands'
-
-  require_relative 'rggen/core_components'
-  require_relative 'rggen/builtins'
-end
+require_relative 'rggen/version'
+require_relative 'rggen/default_setup_file'
+require_relative 'rggen/built_in'

data/lib/rggen/built_in.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+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/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/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/rwe_rwl',
+      'built_in/bit_field/type/rwe_rwl'
+    ].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

@@ -0,0 +1,108 @@
+# 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
+
+    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