rggen-c-header 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bde50cf30f12147cac1bbe3b5d13ba5a1fadf7714d24f64a3fbe339708eadae4
-  data.tar.gz: e88709a2d9362c0d326e732a59ad910df61176d61a9acf55e2463e7505f44d3f
+  metadata.gz: 4150e4e77b8fee78e7832a812c4332ce5b56f016c1caa803c23dd2ee032fad55
+  data.tar.gz: 372b8614c051deee871ab887a24930c02d8d93cc97401aa937541f1d6b5fcde9
 SHA512:
-  metadata.gz: ff93ca1e266012860248b3df4a63c3fd1789ba6937761bd077c6bf53b456eded67b0a0fa19529910a36aea4843c44408941a0a4bb97fc6124ea71d5063a1644c
-  data.tar.gz: 97f87c1eed64dba48287b0645a5f93a0e4b34d3b14921f85fc7737825c86cbb3c7467e8c53fb59e68e21741ff24243cc863a51fc42a5c5f4029510108c45f6cf
+  metadata.gz: a01adcc5020ff80a58c547978cff3eadb24edacf9d96c861600fb9d5136f9a70190bf64a71205bea2c4270456e2134c1d3afbe73955a9c3c311459189c843e6d
+  data.tar.gz: ba3d13e5ac18902391b2797bfbda75c78846ca0c240c9fc750195beab84875d8f8a03ed300ed63eb5e839c4c4e8a14a357c90968454f3cfd0e63abf55860293a

data/README.md

@@ -8,29 +8,18 @@
 
 RgGen::CHeader is a RgGen plugin to generate C header file.
 
-## Installation
+## Installati
 
-To install RgGen::CHeader, use the following command:
+During RgGen installation, RgGen::CHeader will also be installed autoamtically.
 
 ```
-$ gem install rggen-c-header
-```
-
-## Usage
-
-You need to tell RgGen to load RgGen::CHeader plugin. There are two ways.
-
-### Using `--plugin` runtime option
-
-```
-$ rggen --plugin rggen-c-header your_register_map.yml
+$ gem install rggen
 ```
 
-### Using `RGGEN_PLUGINS` environment variable
+If you want to install RgGen::CHeader only, use the command below.
 
 ```
-$ export RGGEN_PLUGINS=${RGGEN_PLUGINS}:rggen-c-header
-$ rggen your_register_map.yml
+$ gem install rggen-c-header
 ```
 
 ## Example

data/lib/rggen/c_header/component.rb

@@ -5,8 +5,15 @@ module RgGen
     class Component < Core::OutputBase::Component
       def macro_definitions
         [
-          @features.each_value.map(&:macro_definitions),
-          @children.map(&:macro_definitions)
+          @children.map(&:macro_definitions),
+          @features.each_value.map(&:macro_definitions)
+        ].flatten
+      end
+
+      def struct_definitions
+        [
+          @children.map(&:struct_definitions),
+          @features.each_value.map(&:struct_definitions)
         ].flatten
       end
     end

data/lib/rggen/c_header/feature.rb

@@ -9,6 +9,10 @@ module RgGen
         @macro_definitions ||= []
       end
 
+      def struct_definitions
+        @struct_definitions ||= []
+      end
+
       private
 
       def define_macro(name, value = nil)
@@ -16,6 +20,16 @@ module RgGen
           Utility::MacroDefinition.new(name.upcase, value)
       end
 
+      def define_struct(name, members)
+        struct_definitions <<
+          Utility::StructDefinition.new(:struct, name, members)
+      end
+
+      def define_union(name, members)
+        struct_definitions <<
+          Utility::StructDefinition.new(:union, name, members)
+      end
+
       def full_name(separator = '_')
         [register_block.name, component.full_name(separator)].join(separator)
       end

data/lib/rggen/c_header/register/c_header.rb

@@ -2,15 +2,6 @@
 
 RgGen.define_simple_feature(:register, :c_header) do
   c_header do
-    pre_build do
-      if register.width > 64
-        message =
-          'register of which width is wider than 64 bits is not allowed: ' \
-          "#{full_name('.')} width #{register.width}"
-        raise RgGen::Core::RegisterMap::RegisterMapError.new(message)
-      end
-    end
-
     build do
       define_macro("#{full_name}_byte_width", byte_width)
       define_macro("#{full_name}_byte_size", byte_size)
@@ -18,6 +9,13 @@ RgGen.define_simple_feature(:register, :c_header) do
       define_offset_address_macros
     end
 
+    export def declaration
+      type = "uint#{register.width}_t"
+      name = register.name
+      size = !shared_address? && register.size || nil
+      create_declaration(type, name, size)
+    end
+
     private
 
     def byte_width
@@ -32,6 +30,10 @@ RgGen.define_simple_feature(:register, :c_header) do
       register_files.any?(&:array?) || register.array?
     end
 
+    def shared_address?
+      register.settings[:support_shared_address]
+    end
+
     def define_array_macros
       size_list = array_size
       define_macro("#{full_name}_array_dimension", size_list.size)
@@ -57,7 +59,7 @@ RgGen.define_simple_feature(:register, :c_header) do
 
     def local_address_list
       Array.new(register.count) do |i|
-        if register.settings[:support_shared_address]
+        if shared_address?
           register.offset_address
         else
           register.offset_address + register.byte_width * i

data/lib/rggen/c_header/register_block/c_header.rb

@@ -2,13 +2,42 @@
 
 RgGen.define_simple_feature(:register_block, :c_header) do
   c_header do
+    include RgGen::CHeader::StructBuilder
+
+    pre_build do
+      if configuration.enable_wide_register?
+        message =
+          'enabling wide register is not allowed ' \
+          'for c header file generation'
+        raise RgGen::Core::Configuration::ConfigurationError.new(message)
+      end
+    end
+
+    build do
+      build_struct
+    end
+
     write_file '<%= register_block.name %>.h' do |f|
       f.include_guard
+      f.include_file 'stdint.h'
       f.body do |code|
         register_block.macro_definitions.each do |macro|
           code << macro << nl
         end
+        register_block.struct_definitions.each do |struct|
+          code << struct
+        end
       end
     end
+
+    private
+
+    def struct_base_name
+      register_block.name
+    end
+
+    def byte_size
+      register_block.byte_size
+    end
   end
 end

data/lib/rggen/c_header/register_file/c_header.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+RgGen.define_simple_feature(:register_file, :c_header) do
+  c_header do
+    include RgGen::CHeader::StructBuilder
+
+    build do
+      build_struct
+    end
+
+    export def declaration
+      create_declaration(
+        struct_name, register_file.name, register_file.array_size
+      )
+    end
+
+    private
+
+    def struct_base_name
+      full_name
+    end
+
+    def byte_size
+      register_file.byte_size(false)
+    end
+  end
+end

data/lib/rggen/c_header/struct_builder.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module RgGen
+  module CHeader
+    module StructBuilder
+      private
+
+      def struct_name
+        "#{struct_base_name}_t"
+      end
+
+      def build_struct
+        members = collect_struct_members
+        define_struct(struct_name, members)
+      end
+
+      def collect_struct_members
+        members = []
+        offset = 0
+        while offset < byte_size
+          declaration, size = define_struct_member(offset)
+          members << declaration
+          offset += size
+        end
+        members
+      end
+
+      def define_struct_member(offset)
+        entries = select_children_by_offset(offset)
+        if entries.size >= 2
+          [define_shared_union(offset, entries), entries.first.byte_size]
+        elsif entries.size == 1
+          [entries.first.declaration, entries.first.byte_size]
+        else
+          [reserved_member(offset), bus_byte_width]
+        end
+      end
+
+      def select_children_by_offset(offset)
+        component.children.select { |child| child.offset_address == offset }
+      end
+
+      def define_shared_union(offset, members)
+        type = "#{struct_base_name}_reg_#{hex(offset, offset_width)}_t"
+        name = "reg_#{hex(offset, offset_width)}"
+        define_union(type, members.map(&:declaration))
+        create_declaration(type, name)
+      end
+
+      def reserved_member(offset)
+        type = "uint#{bus_width}_t"
+        name = "__reserved_#{hex(offset, offset_width)}"
+        create_declaration(type, name)
+      end
+
+      def offset_width
+        (register_block.byte_size - 1).bit_length
+      end
+
+      def bus_width
+        configuration.bus_width
+      end
+
+      def bus_byte_width
+        configuration.byte_width
+      end
+    end
+  end
+end

data/lib/rggen/c_header/utility/declaration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RgGen
+  module CHeader
+    module Utility
+      Declaration = Struct.new(:type, :name, :array_size) do
+        def to_s
+          [
+            type, ' ', name, array_size&.map { |size| "[#{size}]" }
+          ].compact.join
+        end
+      end
+    end
+  end
+end

data/lib/rggen/c_header/utility/struct_definition.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RgGen
+  module CHeader
+    module Utility
+      class StructDefinition < Core::Utility::CodeUtility::StructureDefinition
+        def initialize(type, name, members)
+          @type = type
+          @name = name
+          @members = members
+          super()
+        end
+
+        private
+
+        def code_blocks
+          blocks = []
+          blocks << [method(:header_code), 0]
+          blocks << [method(:body_code), 2]
+          blocks << [method(:footer_code), 0]
+          blocks
+        end
+
+        def header_code(code)
+          code << 'typedef' << space << @type << space << '{' << nl
+        end
+
+        def body_code(code)
+          @members.each do |member|
+            code << member << semicolon << nl
+          end
+        end
+
+        def footer_code(code)
+          code << '}' << space << @name << semicolon << nl
+        end
+      end
+    end
+  end
+end

data/lib/rggen/c_header/utility.rb

@@ -11,8 +11,17 @@ module RgGen
 
       private
 
-      def hex(value)
-        format('0x%x', value)
+      def hex(value, width = nil)
+        if width
+          print_width = ([1, value.bit_length, width].max + 3) / 4
+          format('0x%0*x', print_width, value)
+        else
+          format('0x%x', value)
+        end
+      end
+
+      def create_declaration(type, name, array_size = nil)
+        Declaration.new(type, name, array_size)
       end
     end
   end

data/lib/rggen/c_header/version.rb

@@ -2,6 +2,6 @@
 
 module RgGen
   module CHeader
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/lib/rggen/c_header.rb

@@ -1,28 +1,30 @@
 # frozen_string_literal: true
 
 require_relative 'c_header/version'
+require_relative 'c_header/utility/declaration'
+require_relative 'c_header/utility/struct_definition'
 require_relative 'c_header/utility/macro_definition'
 require_relative 'c_header/utility/source_file'
 require_relative 'c_header/utility'
+require_relative 'c_header/struct_builder'
 require_relative 'c_header/feature'
 require_relative 'c_header/component'
 require_relative 'c_header/factories'
 
-module RgGen
-  module CHeader
-    extend Core::Plugin
+RgGen.setup_plugin :'rggen-c-header' do |plugin|
+  plugin.version RgGen::CHeader::VERSION
 
-    setup_plugin :'rggen-c-header' do |plugin|
-      plugin.register_component :c_header do
-        component Component, ComponentFactory
-        feature Feature, FeatureFactory
-      end
-
-      plugin.files [
-        'c_header/bit_field/c_header',
-        'c_header/register/c_header',
-        'c_header/register_block/c_header'
-      ]
-    end
+  plugin.register_component :c_header do
+    component RgGen::CHeader::Component,
+              RgGen::CHeader::ComponentFactory
+    feature RgGen::CHeader::Feature,
+            RgGen::CHeader::FeatureFactory
   end
+
+  plugin.files [
+    'c_header/register_block/c_header',
+    'c_header/register_file/c_header',
+    'c_header/register/c_header',
+    'c_header/bit_field/c_header'
+  ]
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rggen-c-header
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-13 00:00:00.000000000 Z
+date: 2022-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -41,16 +41,19 @@ files:
 - lib/rggen/c_header/feature.rb
 - lib/rggen/c_header/register/c_header.rb
 - lib/rggen/c_header/register_block/c_header.rb
-- lib/rggen/c_header/setup.rb
+- lib/rggen/c_header/register_file/c_header.rb
+- lib/rggen/c_header/struct_builder.rb
 - lib/rggen/c_header/utility.rb
+- lib/rggen/c_header/utility/declaration.rb
 - lib/rggen/c_header/utility/macro_definition.rb
 - lib/rggen/c_header/utility/source_file.rb
+- lib/rggen/c_header/utility/struct_definition.rb
 - lib/rggen/c_header/version.rb
 homepage: https://github.com/rggen/rggen-c-header
 licenses:
 - MIT
 metadata:
-  bug_tracker_uri: https://github.com/rggen/rggen-c-header/issues
+  bug_tracker_uri: https://github.com/rggen/rggen/issues
   mailing_list_uri: https://groups.google.com/d/forum/rggen
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/rggen/rggen-c-header
@@ -73,5 +76,5 @@ requirements: []
 rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
-summary: rggen-c-header-0.1.0
+summary: rggen-c-header-0.2.0
 test_files: []

data/lib/rggen/c_header/setup.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-require 'rggen/c_header'
-
-RgGen.register_plugin RgGen::CHeader do |builder|
-  builder.enable :register_block, [:c_header]
-  builder.enable :register, [:c_header]
-  builder.enable :bit_field, [:c_header]
-end