rggen 0.3.0

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

@@ -0,0 +1,26 @@
+simple_item :register_block, :name do
+  register_map do
+    field :name
+
+    input_pattern %r{(#{variable_name})}
+
+    build do |cell|
+      @name = parse_name(cell)
+      error "repeated register block name: #{@name}" if repeated_name?
+    end
+
+    def parse_name(cell)
+      if pattern_matched?
+        captures.first
+      else
+        error "invalid value for register block name: #{cell.inspect}"
+      end
+    end
+
+    def repeated_name?
+      register_map.register_blocks.any? do |block|
+        @name == block.name
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+simple_item :register_block, :ral_package_definition do
+  ral do
+    delegate :name => :register_block
+
+    write_file '<%= name %>_ral_pkg.sv' do
+      package_definition "#{name}_ral_pkg" do |pkg|
+        pkg.import_package :uvm_pkg
+        pkg.import_package :rggen_ral_pkg
+        pkg.include_file   'uvm_macros.svh'
+        pkg.include_file   'rggen_ral_macros.svh'
+        pkg.body { |code| body_code(code) }
+      end
+    end
+
+    def body_code(code)
+      register_block.generate_code(:package_item, :bottom_up, code)
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+simple_item :register_block, :reg_model_creator do
+  ral do
+    generate_code :block_model_item do
+      function_definition :create_registers do |f|
+        f.return_type :void
+        f.body { |buffer| function_body(buffer) }
+      end
+    end
+
+    def function_body(buffer)
+      register_block.generate_code(:reg_model_creation, :top_down, buffer)
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+simple_item :register_block, :reg_model_declarations do
+  ral do
+    generate_code :block_model_item do |buffer|
+      register_block.generate_code(:reg_model_declaration, :top_down, buffer)
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+rggen_response_mux #(
+  .DATA_WIDTH       (<%= data_width %>),
+  .TOTAL_REGISTERS  (<%= total_registers %>)
+) u_response_mux (
+  .clk                  (<%= register_block.clock %>),
+  .rst_n                (<%= register_block.reset %>),
+  .i_command_valid      (<%= register_block.host_if.command_valid %>),
+  .i_read               (<%= register_block.host_if.read %>),
+  .o_response_ready     (<%= register_block.host_if.response_ready %>),
+  .o_read_data          (<%= register_block.host_if.read_data %>),
+  .o_status             (<%= register_block.host_if.status %>),
+  .i_register_select    (<%= register_select %>),
+  .i_register_read_data (<%= register_read_data %>)
+);

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

@@ -0,0 +1,16 @@
+simple_item :register_block, :response_mux do
+  rtl do
+    build do
+      logic :register_select   , width: total_registers
+      logic :register_read_data, width: data_width, dimensions: [total_registers]
+    end
+
+    generate_code_from_template :module_item
+
+    delegate data_width: :configuration
+
+    def total_registers
+      register_block.registers.map(&:count).sum(0)
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+define_simple_item :register_block, :signal_declarations do
+  rtl do
+    generate_code :module_item do |buffer|
+      register_block.signal_declarations.each do |declaration|
+        buffer << declaration << semicolon << nl
+      end
+    end
+  end
+end

data/lib/rggen/builtins.rb

@@ -0,0 +1,52 @@
+require_relative 'builtins/loaders/configuration/json_loader'
+require_relative 'builtins/loaders/configuration/yaml_loader'
+require_relative 'builtins/loaders/register_map/csv_loader'
+require_relative 'builtins/loaders/register_map/xls_loader'
+require_relative 'builtins/loaders/register_map/xlsx_ods_loader'
+
+require_relative 'builtins/global/address_width'
+require_relative 'builtins/global/data_width'
+
+require_relative 'builtins/bit_field/bit_assignment'
+require_relative 'builtins/bit_field/field_model_creation'
+require_relative 'builtins/bit_field/field_model_declaration'
+require_relative 'builtins/bit_field/initial_value'
+require_relative 'builtins/bit_field/name'
+require_relative 'builtins/bit_field/reference'
+require_relative 'builtins/bit_field/type'
+require_relative 'builtins/bit_field/rw'
+require_relative 'builtins/bit_field/ro'
+require_relative 'builtins/bit_field/wo'
+require_relative 'builtins/bit_field/reserved'
+
+require_relative 'builtins/register/accessibility'
+require_relative 'builtins/register/address_decoder'
+require_relative 'builtins/register/array'
+require_relative 'builtins/register/field_model_creator'
+require_relative 'builtins/register/field_model_declarations'
+require_relative 'builtins/register/offset_address'
+require_relative 'builtins/register/name'
+require_relative 'builtins/register/read_data'
+require_relative 'builtins/register/reg_model_constructor'
+require_relative 'builtins/register/reg_model_creation'
+require_relative 'builtins/register/reg_model_declaration'
+require_relative 'builtins/register/reg_model_definition'
+require_relative 'builtins/register/shadow'
+require_relative 'builtins/register/shadow_index_configurator'
+require_relative 'builtins/register/uniqueness_validator'
+
+require_relative 'builtins/register_block/base_address'
+require_relative 'builtins/register_block/block_model_constructor'
+require_relative 'builtins/register_block/block_model_default_map_creator'
+require_relative 'builtins/register_block/block_model_definition'
+require_relative 'builtins/register_block/byte_size'
+require_relative 'builtins/register_block/clock_reset'
+require_relative 'builtins/register_block/host_if'
+require_relative 'builtins/register_block/apb'
+require_relative 'builtins/register_block/module_definition'
+require_relative 'builtins/register_block/name'
+require_relative 'builtins/register_block/ral_package_definition'
+require_relative 'builtins/register_block/reg_model_creator'
+require_relative 'builtins/register_block/reg_model_declarations'
+require_relative 'builtins/register_block/response_mux'
+require_relative 'builtins/register_block/signal_declarations'

data/lib/rggen/commands.rb

@@ -0,0 +1,23 @@
+module RgGen
+  def self.builder
+    @builder  ||= Builder::Builder.new
+  end
+
+  module Commands
+    extend Forwardable
+
+    [
+      [:input_component_store , :input_component_store ],
+      [:output_component_store, :output_component_store],
+      [:define_simple_item    , :simple_item           ],
+      [:define_list_item      , :list_item             ],
+      [:enable                , :enable                ],
+      [:define_loader         , :loader                ]
+    ].each do |method_name, alias_name|
+      def_delegator('RgGen.builder', method_name)
+      alias_method(alias_name, method_name) if method_name != alias_name
+    end
+  end
+end
+
+include RgGen::Commands

data/lib/rggen/core_components/configuration/configuration_factory.rb

@@ -0,0 +1,23 @@
+module RgGen
+  module Configuration
+    class ConfigurationFactory < InputBase::ComponentFactory
+      def create_active_items(configuration, hash)
+        active_item_factories.each do |name, factory|
+          create_item(factory, configuration, hash[name])
+        end
+      end
+
+      def load(file)
+        return {} if file.nil? || file.empty?
+
+        data  = load_file(file)
+        if data.is_a?(Hash)
+          data.symbolize_keys!
+        else
+          message = "Hash type required for configuration: #{data.class}"
+          fail RgGen::LoadError, message
+        end
+      end
+    end
+  end
+end

data/lib/rggen/core_components/configuration/item_factory.rb

@@ -0,0 +1,13 @@
+module RgGen
+  module Configuration
+    class ItemFactory < InputBase::ItemFactory
+      include RaiseError
+
+      def create(configuration, data = nil)
+        item  = create_item(configuration, data)
+        item.build(data) unless data.nil?
+        item
+      end
+    end
+  end
+end

data/lib/rggen/core_components/configuration/raise_error.rb

@@ -0,0 +1,11 @@
+module RgGen
+  module Configuration
+    module RaiseError
+      private
+
+      def error(message = nil)
+        fail RgGen::ConfigurationError, message
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module RgGen
+  module Configuration
+    input_component_store :configuration do
+      entry do
+        component_class   InputBase::Component
+        component_factory ConfigurationFactory
+        item_base         InputBase::Item, include: RaiseError
+        item_factory      ItemFactory
+      end
+
+      loader_base InputBase::Loader
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module RgGen
+  module RAL
+    class Item < OutputBase::Item
+      use_verilog_utility
+
+      private
+
+      def model_declaration(model_class, name, attributes = {})
+        create_declaration(
+          :variable,
+          attributes.merge(data_type: model_class, name: name, random: true)
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module RgGen
+  module RAL
+    output_component_store :ral 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  'ral'
+    end
+  end
+end

data/lib/rggen/core_components/register_map/bit_field_factory.rb

@@ -0,0 +1,11 @@
+module RgGen
+  module RegisterMap
+    class BitFieldFactory < InputBase::ComponentFactory
+      def create_active_items(bit_field, configuration, cells)
+        active_item_factories.each_value.with_index do |factory, index|
+          create_item(factory, bit_field, configuration, cells[index])
+        end
+      end
+    end
+  end
+end

data/lib/rggen/core_components/register_map/component.rb

@@ -0,0 +1,12 @@
+module RgGen
+  module RegisterMap
+    class Component < InputBase::Component
+      include Base::HierarchicalAccessors
+
+      def initialize(parent)
+        super(parent)
+        define_hierarchical_accessors
+      end
+    end
+  end
+end

data/lib/rggen/core_components/register_map/generic_map.rb

@@ -0,0 +1,69 @@
+module RgGen
+  module RegisterMap
+    class GenericMap
+      class Cell
+        Position  = Struct.new(:file, :sheet, :row, :column)
+
+        def initialize(file, sheet, row, column)
+          @position = Position.new(file, sheet, row, column)
+        end
+
+        attr_accessor :value
+        attr_reader   :position
+
+        def empty?
+          value.to_s.empty?
+        end
+      end
+
+      class Sheet
+        def initialize(file, name)
+          @file = file
+          @name = name
+          @rows = []
+        end
+
+        attr_reader :name
+        attr_reader :rows
+
+        def [](row, column)
+          rows[row]         ||= []
+          rows[row][column] ||= Cell.new(@file, name, row, column)
+        end
+
+        def []=(row, column, value)
+          self[row, column].value = value
+        end
+      end
+
+      def initialize(file)
+        @file   = file
+        @sheets = {}
+      end
+
+      attr_reader :file
+
+      def [](sheet_name_or_index)
+        case sheet_name_or_index
+        when String
+          @sheets[sheet_name_or_index]  ||= Sheet.new(file, sheet_name_or_index)
+        when Integer
+          sheets[sheet_name_or_index]
+        end
+      end
+
+      def []=(sheet_name, table)
+        @sheets[sheet_name] = Sheet.new(file, sheet_name)
+        table.each_with_index do |values, row|
+          values.each_with_index do |value, column|
+            @sheets[sheet_name][row, column]  = value
+          end
+        end
+      end
+
+      def sheets
+        @sheets.values
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module RgGen
+  module RegisterMap
+    class Item < InputBase::Item
+      include Base::HierarchicalItemAccessors
+      include RaiseError
+
+      attr_reader :configuration
+      attr_reader :position
+
+      def initialize(owner)
+        super(owner)
+        define_hierarchical_item_accessors
+      end
+
+      def build(configuration, cell)
+        @configuration  = configuration
+        @position       = cell.position
+        super(cell.value)
+      end
+    end
+  end
+end

data/lib/rggen/core_components/register_map/item_factory.rb

@@ -0,0 +1,13 @@
+module RgGen
+  module RegisterMap
+    class ItemFactory < InputBase::ItemFactory
+      include RaiseError
+
+      def create(component, configuration, cell = nil)
+        item  = create_item(component, cell)
+        item.build(configuration, cell) unless cell.nil?
+        item
+      end
+    end
+  end
+end

data/lib/rggen/core_components/register_map/loader.rb

@@ -0,0 +1,13 @@
+module RgGen
+  module RegisterMap
+    class Loader < InputBase::Loader
+      private
+
+      def create_map(file, &block)
+        map = GenericMap.new(file)
+        block.call(map) if block_given?
+        map
+      end
+    end
+  end
+end

data/lib/rggen/core_components/register_map/raise_error.rb

@@ -0,0 +1,17 @@
+module RgGen
+  module RegisterMap
+    module RaiseError
+      private
+
+      def error(message, cell_or_position = nil)
+        error_position  =
+          case cell_or_position
+          when GenericMap::Cell::Position then cell_or_position
+          when GenericMap::Cell then cell_or_position.position
+          else @position
+          end
+        fail RgGen::RegisterMapError.new(message, error_position)
+      end
+    end
+  end
+end

data/lib/rggen/core_components/register_map/register_block_factory.rb

@@ -0,0 +1,29 @@
+module RgGen
+  module RegisterMap
+    class RegisterBlockFactory < InputBase::ComponentFactory
+      def create_active_items(register_block, configuration, sheet)
+        active_item_factories.each_value.with_index do |factory, index|
+          cell  = sheet[index, 2]
+          create_item(factory, register_block, configuration, cell)
+        end
+      end
+
+      def create_children(register_block, configuration, sheet)
+        cell_blocks(sheet).each do |block|
+          create_child(register_block, configuration, block)
+        end
+      end
+
+      def cell_blocks(sheet)
+        drop_row_size     = active_item_factories.size + 2
+        drop_column_size  = 1
+        sheet.rows.drop(drop_row_size).each_with_object([]) do |row, blocks|
+          valid_cells = row.drop(drop_column_size)
+          next if valid_cells.all?(&:empty?)
+          blocks      << [] unless valid_cells.first.empty?
+          blocks.last << valid_cells
+        end
+      end
+    end
+  end
+end

data/lib/rggen/core_components/register_map/register_factory.rb

@@ -0,0 +1,18 @@
+module RgGen
+  module RegisterMap
+    class RegisterFactory < InputBase::ComponentFactory
+      def create_active_items(register, configuration, rows)
+        active_item_factories.each_value.with_index do |factory, index|
+          create_item(factory, register, configuration, rows.first[index])
+        end
+      end
+
+      def create_children(register, configuration, rows)
+        drop_size = active_item_factories.size
+        rows.each do |row|
+          create_child(register, configuration, row.drop(drop_size))
+        end
+      end
+    end
+  end
+end

data/lib/rggen/core_components/register_map/register_map_factory.rb

@@ -0,0 +1,21 @@
+module RgGen
+  module RegisterMap
+    class RegisterMapFactory < InputBase::ComponentFactory
+      def create_children(register_map, configuration, map)
+        map.sheets.each do |sheet|
+          create_child(register_map, configuration, sheet)
+        end
+      end
+
+      def load(file)
+        map = load_file(file)
+        if map.is_a?(GenericMap)
+          map
+        else
+          message = "GenericMap type required for register map: #{map.class}"
+          fail RgGen::LoadError, message
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module RgGen
+  module RegisterMap
+    input_component_store :register_map do
+      entry do
+        component_class   Component
+        component_factory RegisterMapFactory
+      end
+
+      entry :register_block do
+        component_class   Component
+        component_factory RegisterBlockFactory
+        item_base         Item
+        item_factory      ItemFactory
+      end
+
+      entry :register do
+        component_class   Component
+        component_factory RegisterFactory
+        item_base         Item
+        item_factory      ItemFactory
+      end
+
+      entry :bit_field do
+        component_class   Component
+        component_factory BitFieldFactory
+        item_base         Item
+        item_factory      ItemFactory
+      end
+
+      loader_base Loader
+    end
+  end
+end

data/lib/rggen/core_components/rtl/component.rb

@@ -0,0 +1,28 @@
+module RgGen
+  module RTL
+    class Component < OutputBase::Component
+      def build
+        super
+        @items.each do |item|
+          def_object_delegators(item, *item.identifiers)
+        end
+      end
+
+      def signal_declarations
+        [*@items, *@children].flat_map(&:signal_declarations)
+      end
+
+      def port_declarations
+        [*@items, *@children].flat_map(&:port_declarations)
+      end
+
+      def parameter_declarations
+        [*@items, *@children].flat_map(&:parameter_declarations)
+      end
+
+      def localparam_declarations
+        [*@items, *@children].flat_map(&:localparam_declarations)
+      end
+    end
+  end
+end