rggen-default-register-map 0.13.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dea6eb93a9a7c226bcc6f01cfa7b28f9562178081dac18b6aff619b4b125f37c
+  data.tar.gz: fb381afdedc89520fe440c19448cb859c8df2bf7db77142ef0d1c49a07cba29f
+SHA512:
+  metadata.gz: 3452f7129497b227616940f466c43ed4c333026883e43e6a3f1cca89796fac3ec344f47d2ba7a9b084b3a9faf69fd137f77a04986853f29dc64aedc866aef129
+  data.tar.gz: 70c32baa9be4415b05e0ca6e266242ad31a5a120375e6d1b952866c41115595ed106e28b74ab736e6541902680757a3e1403577536ddcc4f0563ce418723b32c

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+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 and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* 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
+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.
+
+## 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.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+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. 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.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+[![Gem Version](https://badge.fury.io/rb/rggen-default-register-map.svg)](https://badge.fury.io/rb/rggen-default-register-map)
+[![Build Status](https://travis-ci.com/rggen/rggen-default-register-map.svg?branch=master)](https://travis-ci.com/rggen/rggen-default-register-map)
+[![Maintainability](https://api.codeclimate.com/v1/badges/73177494e096af47f09e/maintainability)](https://codeclimate.com/github/rggen/rggen-default-register-map/maintainability)
+[![codecov](https://codecov.io/gh/rggen/rggen-default-register-map/branch/master/graph/badge.svg)](https://codecov.io/gh/rggen/rggen-default-register-map)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=rggen_rggen-default-register-map&metric=alert_status)](https://sonarcloud.io/dashboard?id=rggen_rggen-default-register-map)
+[![Gitter](https://badges.gitter.im/rggen/rggen.svg)](https://gitter.im/rggen/rggen?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+
+
+# Rggen::DefaultRegisterMap
+
+RgGen::DefaultRegisterMap provides following features.
+
+* Format of regiter map
+* APIs to handle elements of regiter map
+
+## Installation
+
+During RgGen installation, RgGen::DefaultRegisterMap will also be installed automatically.
+
+```
+$ gem install rggen
+```
+
+If you to install RgGen::DefaultRegisterMap only, use the command below:
+
+```
+$ gem install rggen-default-register-map
+```
+
+## 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-default-register-map/issues)
+* [Chat Room](https://gitter.im/rggen/rggen)
+* [Mailing List](https://groups.google.com/d/forum/rggen)
+* [Mail](mailto:rggen@googlegroups.com)
+
+## Copyright & License
+
+Copyright © 2019 Taichi Ishitani. RgGen::DefaultRegisterMap is licensed under the [MIT License](https://opensource.org/licenses/MIT), see [LICENSE](LICENSE) for futher details.
+
+## 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-default-register-map/blob/master/CODE_OF_CONDUCT.md).

data/lib/rggen/default_register_map.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative 'default_register_map/version'
+
+module RgGen
+  module DefaultRegisterMap
+    FEATURES = [
+      'default_register_map/bit_field/bit_assignment',
+      'default_register_map/bit_field/comment',
+      'default_register_map/bit_field/initial_value',
+      'default_register_map/bit_field/name',
+      'default_register_map/bit_field/reference',
+      'default_register_map/bit_field/type',
+      'default_register_map/bit_field/type/rc',
+      'default_register_map/bit_field/type/reserved',
+      'default_register_map/bit_field/type/ro',
+      'default_register_map/bit_field/type/rof',
+      'default_register_map/bit_field/type/rs',
+      'default_register_map/bit_field/type/rw',
+      'default_register_map/bit_field/type/rwc',
+      'default_register_map/bit_field/type/rwe_rwl',
+      'default_register_map/bit_field/type/w0c_w1c',
+      'default_register_map/bit_field/type/w0s_w1s',
+      'default_register_map/bit_field/type/w0trg_w1trg',
+      'default_register_map/bit_field/type/wo',
+      'default_register_map/global/address_width',
+      'default_register_map/global/bus_width',
+      'default_register_map/register/name',
+      'default_register_map/register/offset_address',
+      'default_register_map/register/size',
+      'default_register_map/register/type',
+      'default_register_map/register/type/external',
+      'default_register_map/register/type/indirect',
+      'default_register_map/register_block/byte_size',
+      'default_register_map/register_block/name'
+    ].freeze
+
+    def self.load_features
+      FEATURES.each { |file| require_relative file }
+    end
+
+    def self.default_setup(_builder)
+      load_features
+    end
+  end
+end

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

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+RgGen.define_simple_feature(:bit_field, :bit_assignment) do
+  register_map do
+    property :lsb, forward_to: :lsb_bit
+    property :msb, forward_to: :msb_bit
+    property :width, default: 1
+    property :sequence_size
+    property :step, initial: -> { width }
+    property :sequential?, body: -> { !@sequence_size.nil? }
+    property :bit_map, initial: -> { calc_bit_map }
+
+    input_pattern /#{integer}(?::#{integer}){0,3}/,
+                  match_automatically: false
+
+    build do |value|
+      input_value = preprocess(value)
+      KEYS.each { |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) &&
+        instance_variable_set("@#{key}", Integer(input_value[key]))
+    rescue ArgumentError, TypeError
+      error "cannot convert #{input_value[key].inspect} into " \
+            "bit assignment(#{key.to_s.tr('_', ' ')})"
+    end
+
+    def lsb_bit(index = 0)
+      lsb_msb_bit(index, @lsb)
+    end
+
+    def msb_bit(index = 0)
+      lsb_msb_bit(index, @lsb + width - 1)
+    end
+
+    def lsb_msb_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/default_register_map/bit_field/comment.rb

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

data/lib/rggen/default_register_map/bit_field/initial_value.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+RgGen.define_simple_feature(:bit_field, :initial_value) do
+  register_map do
+    property :initial_value, default: 0
+    property :initial_value?, body: -> { !@initial_value.nil? }
+
+    build do |value|
+      @initial_value =
+        begin
+          Integer(value)
+        rescue ArgumentError, TypeError
+          error "cannot convert #{value.inspect} into initial value"
+        end
+    end
+
+    verify(:component) do
+      error_condition { settings[:require] && !initial_value? }
+      message { 'no initial value is given' }
+    end
+
+    verify(:component) do
+      error_condition { initial_value? && initial_value < min_initial_value }
+      message do
+        'input initial value is less than minimum initial value: ' \
+        "initial value #{initial_value} " \
+        "minimum initial value #{min_initial_value}"
+      end
+    end
+
+    verify(:component) do
+      error_condition { initial_value? && initial_value > max_initial_value }
+      message do
+        'input initial value is greater than maximum initial value: ' \
+        "initial value #{initial_value} " \
+        "maximum initial value #{max_initial_value}"
+      end
+    end
+
+    verify(:component) do
+      error_condition { initial_value? && !match_valid_condition? }
+      message do
+        "does not match the valid initial value condition: #{initial_value}"
+      end
+    end
+
+    printable(:initial_value) do
+      @initial_value &&
+        begin
+          print_width = (bit_field.width + 3) / 4
+          format('0x%0*x', print_width, @initial_value)
+        end
+    end
+
+    private
+
+    def settings
+      @settings ||=
+        (bit_field.settings && bit_field.settings[:initial_value]) || {}
+    end
+
+    def min_initial_value
+      bit_field.width == 1 ? 0 : -(2**(bit_field.width - 1))
+    end
+
+    def max_initial_value
+      2**bit_field.width - 1
+    end
+
+    def match_valid_condition?
+      !settings.key?(:valid_condition) ||
+        instance_exec(@initial_value, &settings[:valid_condition])
+    end
+  end
+end

data/lib/rggen/default_register_map/bit_field/name.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+RgGen.define_simple_feature(:bit_field, :name) do
+  register_map do
+    property :name, initial: -> { register.name }
+    property :full_name, forward_to: :get_full_name
+
+    input_pattern variable_name
+
+    build do |value|
+      @name =
+        if pattern_matched?
+          match_data.to_s
+        else
+          error "illegal input value for bit field name: #{value.inspect}"
+        end
+      @full_name = [register.name, @name]
+    end
+
+    verify(:feature) do
+      error_condition { duplicated_name? }
+      message { "duplicated bit field name: #{name}" }
+    end
+
+    printable :name
+
+    private
+
+    def get_full_name(separator = '.')
+      @full_name&.join(separator) || register.name
+    end
+
+    def duplicated_name?
+      register.bit_fields.any? { |bit_field| bit_field.name == name }
+    end
+  end
+end