rggen 0.4.4 → 0.5.1

data/lib/rggen/builtins/register_block/address_struct.rb

@@ -0,0 +1,56 @@
+simple_item :register_block, :address_struct do
+  c_header do
+    delegate [:data_width, :byte_width] => :configuration
+    delegate [:registers, :name] => :register_block
+
+    generate_code :c_header_item do
+      struct_definition(stuct_name) do |s|
+        s.with_typedef
+        s.members address_struct_members
+      end
+    end
+
+    def stuct_name
+      "s_#{name}_address_struct"
+    end
+
+    def address_struct_members
+      address_struct_entries.each_cons(2).with_object([]) do |entries, members|
+        dummy_size  = entries[1].start_address - entries[0].end_address - 1
+        members << dummy_member(dummy_size) if dummy_size > 0
+        members << entries[1].address_struct_member
+      end
+    end
+
+    def dummy_member(size)
+      variable_declaration(
+        data_type:  "rggen_uint#{data_width}",
+        name:       "__dummy_#{dummy_index}",
+        dimensions: [size / byte_width]
+      )
+    end
+
+    def dummy_index
+      @dummy_index ||= -1
+      @dummy_index += 1
+    end
+
+    def address_struct_entries
+      [].tap do |entries|
+        entries << dummy_entry
+        entries.concat(non_reserved_registers)
+      end
+    end
+
+    def dummy_entry
+      Object.new.tap do |dummy|
+        dummy.attr_singleton_accessor :end_address
+        dummy.end_address = -1
+      end
+    end
+
+    def non_reserved_registers
+      registers.reject(&:reserved?).sort_by(&:start_address)
+    end
+  end
+end

data/lib/rggen/builtins/register_block/c_header_file.rb

@@ -0,0 +1,15 @@
+simple_item :register_block, :c_header_file do
+  c_header do
+    delegate [:name] => :register_block
+
+    write_file '<%= name %>.h' do |f|
+      f.include_guard
+      f.include_file 'rggen.h'
+      f.body { |code| source_file_body(code) }
+    end
+
+    def source_file_body(code)
+      register_block.generate_code(:c_header_item, :top_down, code)
+    end
+  end
+end

data/lib/rggen/builtins/register_block/ral_package.rb

@@ -2,7 +2,12 @@ simple_item :register_block, :ral_package do
   ral do
     delegate :name => :register_block
 
-    write_file '<%= name %>_ral_pkg.sv' do
+    write_file '<%= name %>_ral_pkg.sv' do |f|
+      f.include_guard
+      f.body { source_file_body }
+    end
+
+    def source_file_body
       package_definition "#{name}_ral_pkg" do |pkg|
         pkg.import_package :uvm_pkg
         pkg.import_package :rggen_ral_pkg

data/lib/rggen/builtins/register_block/response_mux.rb

@@ -25,11 +25,11 @@ simple_item :register_block, :response_mux do
     end
 
     def external_registers?
-      register_block.registers.any?(&:external?)
+      register_block.registers.any? { |r| r.type?(:external) }
     end
 
     def total_external_registers
-      register_block.registers.count(&:external?)
+      register_block.registers.count  { |r| r.type?(:external) }
     end
 
     def actual_external_register_select

data/lib/rggen/builtins/register_block/top_module.rb

@@ -1,6 +1,10 @@
 define_simple_item :register_block, :top_module do
   rtl do
-    write_file '<%= register_block.name %>.sv' do
+    write_file '<%= register_block.name %>.sv' do |f|
+      f.body { source_file_body }
+    end
+
+    def source_file_body
       module_definition register_block.name do |m|
         m.parameters register_block.parameter_declarations
         m.ports      register_block.port_declarations

data/lib/rggen/core_components.rb

@@ -1,3 +1,25 @@
+require_relative 'core_components/erb_engine'
+
+require_relative 'core_components/code_utility/line'
+require_relative 'core_components/code_utility/code_block'
+require_relative 'core_components/code_utility/source_file'
+require_relative 'core_components/code_utility'
+
+require_relative 'core_components/verilog_utility/identifier'
+require_relative 'core_components/verilog_utility/declaration'
+require_relative 'core_components/verilog_utility/structure_definition'
+require_relative 'core_components/verilog_utility/module_definition'
+require_relative 'core_components/verilog_utility/package_definition'
+require_relative 'core_components/verilog_utility/class_definition'
+require_relative 'core_components/verilog_utility/subroutine_definition'
+require_relative 'core_components/verilog_utility/source_file'
+require_relative 'core_components/verilog_utility'
+
+require_relative 'core_components/c_utility/variable_declaration'
+require_relative 'core_components/c_utility/data_structure_definition'
+require_relative 'core_components/c_utility/source_file'
+require_relative 'core_components/c_utility'
+
 require_relative 'core_components/configuration/raise_error'
 require_relative 'core_components/configuration/item'
 require_relative 'core_components/configuration/configuration_factory'
@@ -24,3 +46,6 @@ require_relative 'core_components/rtl/setup'
 require_relative 'core_components/ral/component'
 require_relative 'core_components/ral/item'
 require_relative 'core_components/ral/setup'
+
+require_relative 'core_components/c_header/item'
+require_relative 'core_components/c_header/setup'

data/lib/rggen/core_components/c_header/item.rb

@@ -0,0 +1,8 @@
+module RgGen
+  module CHeader
+    class Item < OutputBase::Item
+      include         CUtility
+      template_engine ERBEngine
+    end
+  end
+end

data/lib/rggen/core_components/c_header/setup.rb

@@ -0,0 +1,19 @@
+module RgGen
+  module CHeader
+    output_component_store :c_header do
+      entry do
+        component_class   OutputBase::Component
+        component_factory OutputBase::ComponentFactory
+      end
+
+      entry [:register_block, :register, :bit_field] do
+        component_class   OutputBase::Component
+        component_factory OutputBase::ComponentFactory
+        item_base         Item
+        item_factory      OutputBase::ItemFactory
+      end
+
+      output_directory  'c_header'
+    end
+  end
+end

data/lib/rggen/core_components/c_utility.rb

@@ -0,0 +1,19 @@
+module RgGen
+  module CUtility
+    include CodeUtility
+
+    def create_blank_file(path)
+      SourceFile.new(path)
+    end
+
+    private
+
+    def variable_declaration(attributes)
+      VariableDeclaration.new(attributes)
+    end
+
+    def struct_definition(type_name, &body)
+      DataStructureDefinition.new(:struct, type_name, &body).to_code
+    end
+  end
+end

data/lib/rggen/core_components/c_utility/data_structure_definition.rb

@@ -0,0 +1,62 @@
+module RgGen
+  module CUtility
+    class DataStructureDefinition
+      include CodeUtility
+
+      def initialize(type_keyword, type_name, &body)
+        @type_keyword = type_keyword
+        @type_name    = type_name
+        body.call(self) if block_given?
+      end
+
+      attr_setter :members
+
+      def with_typedef(typedef_name = nil)
+        @with_typedef = true
+        @typedef_name = typedef_name
+      end
+
+      def to_code
+        code_block do |code|
+          header_code(code)
+          body_code(code)
+          footer_code(code)
+        end
+      end
+
+      private
+
+      def header_code(code)
+        code << [
+          typedef, @type_keyword, type_name, '{'
+        ].compact.join(space) << nl
+      end
+
+      def body_code(code)
+        indent(code, 2) do
+          @members.each do |member, i|
+            code << member << semicolon << nl
+          end
+        end
+      end
+
+      def footer_code(code)
+        code << ['}', typedef_name].compact.join(space) << semicolon << nl
+      end
+
+      def typedef
+        @with_typedef && :typedef
+      end
+
+      def type_name
+        return @type_name unless @with_typedef
+        @typedef_name && @type_name
+      end
+
+      def typedef_name
+        return nil unless @with_typedef
+        @typedef_name || @type_name
+      end
+    end
+  end
+end

data/lib/rggen/core_components/c_utility/source_file.rb

@@ -0,0 +1,10 @@
+module RgGen
+  module CUtility
+    class SourceFile < CodeUtility::SourceFile
+      ifndef_keyword  :'#ifndef'
+      endif_keyword   :'#endif'
+      define_keyword  :'#define'
+      include_keyword :'#include'
+    end
+  end
+end

data/lib/rggen/core_components/c_utility/variable_declaration.rb

@@ -0,0 +1,35 @@
+module RgGen
+  module CUtility
+    class VariableDeclaration
+      def initialize(attributes)
+        @attributes = attributes
+      end
+
+      def to_s
+        [
+          data_type, identifier, default_value_assignment
+        ].compact.join(' ')
+      end
+
+      private
+
+      def data_type
+        @attributes[:data_type]
+      end
+
+      def identifier
+        "#{@attributes[:name]}#{dimensions}"
+      end
+
+      def dimensions
+        return unless @attributes[:dimensions]
+        @attributes[:dimensions].map { |d| "[#{d}]" }.join
+      end
+
+      def default_value_assignment
+        return unless @attributes[:default]
+        "= #{@attributes[:default]}"
+      end
+    end
+  end
+end

data/lib/rggen/core_components/code_utility.rb

@@ -0,0 +1,56 @@
+module RgGen
+  module CodeUtility
+    def create_blank_code
+      CodeBlock.new
+    end
+
+    private
+
+    def newline
+      :newline
+    end
+
+    alias_method :nl, :newline
+
+    def comma
+      ','
+    end
+
+    def semicolon
+      ';'
+    end
+
+    def space(size = 1)
+      ' ' * size
+    end
+
+    def string(expression)
+      "\"#{expression}\""
+    end
+
+    def code_block(indent_size = 0, &block)
+      CodeBlock.new.tap do |code|
+        code.indent = indent_size
+        block.call(code) if block_given?
+      end
+    end
+
+    def indent(code_block, indent_size, &indent_block)
+      code_block << nl unless code_block.last_line_empty?
+      code_block.indent += indent_size
+      indent_block.call if block_given?
+      code_block << nl unless code_block.last_line_empty?
+      code_block.indent -= indent_size
+    end
+
+    def wrap(code_block, head, tail, &block)
+      code_block << head
+      block.call if block_given?
+      code_block << tail
+    end
+
+    def loop_index(level)
+      level.times.with_object('i') { |_, index| index.next! }
+    end
+  end
+end

data/lib/rggen/{output_base → core_components/code_utility}/code_block.rb

@@ -1,5 +1,5 @@
 module RgGen
-  module OutputBase
+  module CodeUtility
     class CodeBlock
       def initialize
         @lines  = []

data/lib/rggen/{output_base → core_components/code_utility}/line.rb

@@ -1,5 +1,5 @@
 module RgGen
-  module OutputBase
+  module CodeUtility
     class Line
       def initialize
         @words      = []

data/lib/rggen/core_components/code_utility/source_file.rb

@@ -0,0 +1,97 @@
+module RgGen
+  module CodeUtility
+    class SourceFile
+      include CodeUtility
+
+      class << self
+        attr_setter :ifndef_keyword
+        attr_setter :endif_keyword
+        attr_setter :define_keyword
+        attr_setter :include_keyword
+      end
+
+      def initialize(path, &body)
+        @path = path
+        body.call(self) if block_given?
+      end
+
+      attr_reader :path
+
+      def header(&block)
+        @header_block ||= block
+      end
+
+      def include_guard(prefix = nil, suffix = prefix, &block)
+        @guard_macro  ||= (
+          block || method(:default_guard_macro)
+        ).call(prefix, suffix)
+      end
+
+      def include_file(file)
+        include_files << file
+      end
+
+      def body(&block)
+        @body_block ||= block
+      end
+
+      def to_code
+        code_block do |c|
+          blocks.each { |b| generate_code(c, b) }
+        end
+      end
+
+      def to_s
+        to_code.to_s
+      end
+
+      private
+
+      def blocks
+        [
+          @header_block,
+          include_guard_header,
+          include_files_block,
+          @body_block,
+          include_guard_footer
+        ].compact
+      end
+
+      def include_files
+        @include_files  ||= []
+      end
+
+      def default_guard_macro(prefix, suffix)
+       "#{prefix}#{path.basename.to_s.upcase.gsub(/\W/, '_')}#{suffix}"
+      end
+
+      def include_guard_header
+        @guard_macro && lambda do |c|
+          c << "#{self.class.ifndef_keyword} #{@guard_macro}" << nl
+          c << "#{self.class.define_keyword} #{@guard_macro}" << nl
+        end
+      end
+
+      def include_guard_footer
+        @guard_macro && lambda { |c| c << self.class.endif_keyword << nl }
+      end
+
+      def include_files_block
+        @include_files && lambda do |c|
+          include_files.each do |f|
+            c << "#{self.class.include_keyword} #{f.to_s.quote}" << nl
+          end
+        end
+      end
+
+      def generate_code(code, block)
+        if block.arity.zero?
+          code << block.call
+        else
+          block.call(code)
+        end
+        code << nl unless code.last_line_empty?
+      end
+    end
+  end
+end