rggen 0.3.3 → 0.4.0

data/lib/rggen/builtins/register/bus_exporter.rb

@@ -0,0 +1,44 @@
+simple_item :register, :bus_exporter do
+  rtl do
+    delegate [
+      :data_width, :byte_width
+    ] => :configuration
+    delegate [
+      :name, :byte_size, :external?, :index, :external_index
+    ] => :register
+
+    available? { external? }
+
+    build do
+      output :valid     , name: "o_#{name}_valid"     , width: 1
+      output :write     , name: "o_#{name}_write"     , width: 1
+      output :read      , name: "o_#{name}_read"      , width: 1
+      output :address   , name: "o_#{name}_address"   , width: address_width
+      output :strobe    , name: "o_#{name}_strobe"    , width: byte_width
+      output :write_data, name: "o_#{name}_write_data", width: data_width
+      input  :ready     , name: "i_#{name}_ready"     , width: 1
+      input  :status    , name: "i_#{name}_status"    , width: 2
+      input  :read_data , name: "i_#{name}_read_data" , width: data_width
+    end
+
+    generate_code :module_item do |code|
+      code << register_select_connection << nl
+      code << process_template
+    end
+
+    def address_width
+      Math.clog2(byte_size)
+    end
+
+    def register_select_connection
+      assign(
+        register_block.external_register_select[external_index],
+        register_block.register_select[index]
+      )
+    end
+
+    def start_address
+      hex(register.start_address, register_block.local_address_width)
+    end
+  end
+end

data/lib/rggen/builtins/register/{reg_model_constructor.rb → constructor.rb}

@@ -1,4 +1,4 @@
-simple_item :register, :reg_model_constructor do
+simple_item :register, :constructor do
   ral do
     generate_code :reg_model_item do
       function_definition :new do |f|

data/lib/rggen/builtins/register/external.rb

@@ -0,0 +1,42 @@
+simple_item :register, :external do
+  register_map do
+    field :external?
+    field :internal? do
+      !external?
+    end
+
+    input_pattern %r{(true)|(false)|()}i, convert_to_string: true
+
+    build do |cell|
+      @external = parse(cell)
+      register.need_no_children if external?
+    end
+
+    validate do
+      if (register.array? || register.shadow?) && external?
+        error 'not use array/shadow and ' \
+              'external register on the same register'
+      end
+    end
+
+    def parse(cell)
+      if pattern_matched?
+        captures.first.not_nil?
+      else
+        error "invalid value for 'external': #{cell.inspect}"
+      end
+    end
+  end
+
+  rtl do
+    export :external_index
+
+    def external_index
+      external_registers.index(&register.method(:equal?))
+    end
+
+    def external_registers
+      register_block.registers.select(&:external?)
+    end
+  end
+end

data/lib/rggen/builtins/register/field_model_creator.rb

@@ -3,8 +3,12 @@ simple_item :register, :field_model_creator do
     generate_code :reg_model_item do
       function_definition :create_fields do |f|
         f.return_type :void
-        f.body { register.generate_code(:field_model_creation, :top_down) }
+        f.body { |code| body_code(code) }
       end
     end
+
+    def body_code(code)
+      register.bit_fields.each { |b| b.model_creation(code) }
+    end
   end
 end

data/lib/rggen/builtins/register/read_data.rb

@@ -1,5 +1,9 @@
 simple_item :register, :read_data do
   rtl do
+    available? do
+      !register.external?
+    end
+
     generate_code :module_item do |buffer|
       buffer  << assign(register_read_data, read_data) << nl
     end

data/lib/rggen/builtins/register/reg_model.rb

@@ -0,0 +1,92 @@
+simple_item :register, :reg_model do
+  ral do
+    export :model_creation
+
+    delegate [:byte_width] => :configuration
+    delegate [:local_address_width] => :register_block
+    delegate [:name, :dimensions, :array?, :shadow?] => :register
+
+    available? { register.internal? }
+
+    build do
+      variable :block_model, :reg_model,
+               data_type:  model_name,
+               name:       name,
+               dimensions: dimensions,
+               random:     true
+    end
+
+    generate_code :package_item do
+      class_definition model_name do |c|
+        c.base      base_model
+        c.variables register.variable_declarations(:reg_model)
+        c.body { |code| body_code(code) }
+      end
+    end
+
+    def model_creation(code)
+      foreach_header(code) if array?
+      code << "`rggen_ral_create_reg_model(#{arguments.join(', ')})" << nl
+      foreach_footer(code) if array?
+    end
+
+    def foreach_header(code)
+      code << "foreach (#{name}[#{loop_varibles.join(', ')}]) begin" << nl
+      code.indent += 2
+    end
+
+    def foreach_footer(code)
+      code.indent -= 2
+      code << :end << nl
+    end
+
+    def arguments
+      [handle, string(name), array_index, offset_address, rights, unmapped]
+    end
+
+    def handle
+      create_identifier(name)[loop_varibles]
+    end
+
+    def array_index
+      return '\'{}' unless array?
+      array(*loop_varibles)
+    end
+
+    def offset_address
+      base  = hex(register.start_address, local_address_width)
+      if !array? || shadow?
+        base
+      else
+        "#{base} + #{byte_width} * #{loop_varibles.first}"
+      end
+    end
+
+    def rights
+      return string(:RO) if register.read_only?
+      return string(:WO) if register.write_only?
+      string(:RW)
+    end
+
+    def unmapped
+      (shadow? && 1) || 0
+    end
+
+    def loop_varibles
+      return nil unless array?
+      @loop_varibles ||= Array.new(dimensions.size, &method(:loop_index))
+    end
+
+    def model_name
+      "#{name}_reg_model"
+    end
+
+    def base_model
+      (register.shadow? && :rggen_ral_shadow_reg) || :rggen_ral_reg
+    end
+
+    def body_code(code)
+      register.generate_code(:reg_model_item, :top_down, code)
+    end
+  end
+end

data/lib/rggen/builtins/register/shadow_index_configurator.rb

@@ -1,10 +1,14 @@
 simple_item :register, :shadow_index_configurator do
   ral do
+    available? do
+      register.shadow?
+    end
+
     generate_code :reg_model_item do
       function_definition :configure_shadow_indexes do |f|
         f.return_type :void
         f.body { |code| function_body(code) }
-      end if register.shadow?
+      end
     end
 
     def function_body(code)

data/lib/rggen/builtins/register/sub_block_model.rb

@@ -0,0 +1,34 @@
+simple_item :register, :sub_block_model do
+  ral do
+    export :model_creation
+
+    available? { register.external? }
+
+    build do
+      parameter :block_model, :model_type,
+                data_type: :type,
+                name:      type_name,
+                default:   :rggen_ral_block
+      variable  :block_model, :sub_block_model,
+                data_type: type_name,
+                name:      register.name,
+                random:    true
+    end
+
+    def type_name
+      register.name.upcase
+    end
+
+    def model_creation(code)
+      code << "`rggen_ral_create_block_model(#{arguments.join(', ')})" << nl
+    end
+
+    def arguments
+      [register.name, string(register.name), offset_addess]
+    end
+
+    def offset_addess
+      hex(register.start_address, register_block.local_address_width)
+    end
+  end
+end

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

@@ -19,6 +19,7 @@ rggen_host_if_apb #(
   .o_write          (<%= host_if.write %>),
   .o_read           (<%= host_if.read %>),
   .o_address        (<%= host_if.address %>),
+  .o_strobe         (<%= host_if.strobe %>),
   .o_write_data     (<%= host_if.write_data %>),
   .o_write_mask     (<%= host_if.write_mask %>),
   .i_response_ready (<%= host_if.response_ready %>),

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

@@ -29,6 +29,7 @@ rggen_host_if_axi4lite #(
   .o_write          (<%= host_if.write %>),
   .o_read           (<%= host_if.read %>),
   .o_address        (<%= host_if.address %>),
+  .o_strobe         (<%= host_if.strobe %>),
   .o_write_data     (<%= host_if.write_data %>),
   .o_write_mask     (<%= host_if.write_mask %>),
   .i_response_ready (<%= host_if.response_ready %>),

data/lib/rggen/builtins/register_block/{block_model_definition.rb → block_model.rb}

@@ -1,8 +1,10 @@
-simple_item :register_block, :block_model_definition do
+simple_item :register_block, :block_model do
   ral do
     generate_code :package_item do
       class_definition model_name do |c|
-        c.base :rggen_ral_block
+        c.base       :rggen_ral_block
+        c.variables  register_block.variable_declarations(:block_model)
+        c.parameters register_block.parameter_declarations(:block_model)
         c.body { |code| body_code(code) }
       end
     end

data/lib/rggen/builtins/register_block/{block_model_constructor.rb → constructor.rb}

@@ -1,4 +1,4 @@
-simple_item :register_block, :block_model_constructor do
+simple_item :register_block, :constructor do
   ral do
     delegate [:name] => :register_block
 

data/lib/rggen/builtins/register_block/{block_model_default_map_creator.rb → default_map_creator.rb}

@@ -1,4 +1,4 @@
-simple_item :register_block, :block_model_default_map_creator do
+simple_item :register_block, :default_map_creator do
   ral do
     generate_code :block_model_item do
       function_definition :create_default_map do |f|

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

@@ -46,6 +46,7 @@ list_item :register_block, :host_if do
           logic :write         , width: 1
           logic :read          , width: 1
           logic :address       , width: register_block.local_address_width
+          logic :strobe        , width: configuration.byte_width
           logic :write_data    , width: configuration.data_width
           logic :write_mask    , width: configuration.data_width
           logic :response_ready, width: 1

data/lib/rggen/builtins/register_block/{ral_package_definition.rb → ral_package.rb}

@@ -1,4 +1,4 @@
-simple_item :register_block, :ral_package_definition do
+simple_item :register_block, :ral_package do
   ral do
     delegate :name => :register_block
 

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

@@ -1,14 +1,18 @@
 rggen_response_mux #(
-  .DATA_WIDTH       (<%= data_width %>),
-  .TOTAL_REGISTERS  (<%= total_registers %>)
+  .DATA_WIDTH               (<%= configuration.data_width %>),
+  .TOTAL_REGISTERS          (<%= total_registers %>),
+  .TOTAL_EXTERNAL_REGISTERS (<%= total_external_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 %>)
+  .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 %>),
+  .i_external_register_select (<%= actual_external_register_select %>),
+  .i_external_register_ready  (<%= actual_external_register_ready %>),
+  .i_external_register_status (<%= actual_external_register_status %>)
 );

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

@@ -2,15 +2,46 @@ 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]
+      logic :register_read_data,
+            width:      configuration.data_width,
+            dimensions: [total_registers]
+      if external_registers?
+        logic :external_register_select,
+              width:  total_external_registers,
+              vector: true
+        logic :external_register_ready ,
+              width:  total_external_registers,
+              vector: true
+        logic :external_register_status,
+              width:      2,
+              dimensions: [total_external_registers]
+      end
     end
 
     generate_code_from_template :module_item
 
-    delegate data_width: :configuration
-
     def total_registers
-      register_block.registers.map(&:count).sum(0)
+      register_block.registers.sum(0, &:count)
+    end
+
+    def external_registers?
+      register_block.registers.any?(&:external?)
+    end
+
+    def total_external_registers
+      register_block.registers.count(&:external?)
+    end
+
+    def actual_external_register_select
+      (external_registers? && external_register_select) || bin(0, 1)
+    end
+
+    def actual_external_register_ready
+      (external_registers? && external_register_ready) || bin(0, 1)
+    end
+
+    def actual_external_register_status
+      (external_registers? && external_register_status)  || array(bin(0, 2))
     end
   end
 end

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

@@ -0,0 +1,14 @@
+simple_item :register_block, :sub_model_creator do
+  ral do
+    generate_code :block_model_item do
+      function_definition :create_sub_models do |f|
+        f.return_type :void
+        f.body { |code| function_body(code) }
+      end
+    end
+
+    def function_body(code)
+      register_block.registers.each { |r| r.model_creation(code) }
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+define_simple_item :register_block, :top_module do
+  rtl do
+    write_file '<%= register_block.name %>.sv' do
+      module_definition register_block.name do |m|
+        m.parameters register_block.parameter_declarations
+        m.ports      register_block.port_declarations
+        m.signals    register_block.signal_declarations
+        m.body { |code| module_body(code) }
+      end
+    end
+
+    def module_body(code)
+      register_block.generate_code(:module_item, :top_down, code)
+    end
+  end
+end