rggen 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d33b1f653bd2968858ddf63a333f4f14b6886556
-  data.tar.gz: ef5da01aa0b3ec7a1c5097e1ffdcf14e1c1848ab
+  metadata.gz: 19195a9804097d391d2ee4c629922ef49a1d1d82
+  data.tar.gz: 7052fa9b494b2948f452649797f5280bef883af2
 SHA512:
-  metadata.gz: 16848790ca403c61edc82245bc55b4d6c3edd6ff2638bb08305d5c8df4789d4bf5c71fd9ed06e469023be7fb6d107ed66c53f8348c41ec13ed67328c51d91efd
-  data.tar.gz: 6b89fa0fe23b35b41052335784b0b9de65d1b4d890e3b906707c84ce35ff2b227496613b611de011de991ef7a834946d35f96bef13f1517ac3af302026e00a4a
+  metadata.gz: 59827fbc8e93f033570dd65f7bfaaeb0123c977bc095d0b7d835c80b2f21f263058b880408fc840ed8a7a1da77e05da4e40884462526ade82824336d3ede4014
+  data.tar.gz: f31b881ee297b1915fbfe6b60266b8eed027f73d7eb2f0161fe3fb15bddc2a5df4c64304051b2964d3dee59664abe3a0c52e158f2078014f5e498b9cae197a0d

data/README.md

@@ -8,8 +8,8 @@
 
 # RgGen
 
-RgGen is a code generation tool for SoC designers.
-It will automatically generate source code for control registers in a SoC design, e.g. RTL, UVM RAL model, C header file, from its register map document.
+RgGen is a code generator tool for SoC/IP/FPGA/RTL engineers.
+It will automatically generate source code for control/status registers, e.g. RTL, UVM RAL model, C header file, from its register map document.
 Also RgGen is customizable so you can build your specific generate tool.
 
 ## Ruby

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

@@ -2,7 +2,16 @@ module RgGen
   module RegisterMap
     class GenericMap
       class Cell
-        Position  = Struct.new(:file, :sheet, :row, :column)
+        Position  = Struct.new(:file, :sheet, :row, :column) do
+          def to_s
+            [
+              "file: #{file}",
+              "sheet: #{sheet}",
+              "row: #{row}",
+              "column: #{column}"
+            ].join(' ')
+          end
+        end
 
         def initialize(file, sheet, row, column)
           @position = Position.new(file, sheet, row, column)

data/lib/rggen/core_extensions/facets.rb

@@ -10,6 +10,7 @@ require 'facets/kernel/not_nil'
 require 'facets/method/curry' unless Method.public_method_defined?(:curry)
 require 'facets/module/attr_class_accessor'
 require 'facets/module/attr_setter'
+require 'facets/module/lastname'
 require 'facets/numeric/positive'
 require 'facets/object/itself' unless Object.public_method_defined?(:itself)
 require 'facets/pathname/to_path'

data/lib/rggen/exceptions.rb

@@ -5,18 +5,24 @@ module RgGen
   class BuilderError < RgGenError
   end
 
-  class LoadError < RgGenError
+  class RuntimeError < RgGenError
   end
 
-  class ConfigurationError < RgGenError
+  class LoadError < RgGen::RuntimeError
   end
 
-  class RegisterMapError < RgGenError
-    def initialize(message, position)
+  class ConfigurationError < RgGen::RuntimeError
+  end
+
+  class RegisterMapError < RgGen::RuntimeError
+    def initialize(message, position = nil)
       super(message)
       @position = position
     end
 
-    attr_reader :position
+    def to_s
+      return super.to_s unless @position
+      "#{super.to_s} -- #{@position}"
+    end
   end
 end

data/lib/rggen/generator.rb

@@ -140,9 +140,11 @@ module RgGen
         parse_options(argv, context)
         load_setup(context)
         load_configuration(context)
-        load_register_map(context, argv.first)
+        load_register_map(context, argv)
         write_files(context)
       end
+    rescue RgGen::RuntimeError, OptionParser::ParseError => e
+      abort "[#{e.class.lastname}] #{e.message}"
     end
 
     private
@@ -167,7 +169,12 @@ module RgGen
     end
 
     def load_setup(context)
-      load(context.options[:setup])
+      context.options[:setup].tap do |setup|
+        File.exist?(setup) || (
+          raise RgGen::LoadError, "cannot load such file -- #{setup}"
+        )
+        load(setup)
+      end
     end
 
     def build_factory(component_name)
@@ -179,9 +186,10 @@ module RgGen
         build_factory(:configuration).create(context.options[:configuration])
     end
 
-    def load_register_map(context, file)
+    def load_register_map(context, argv)
+      raise RgGen::LoadError, 'no register map is specified' if argv.empty?
       context.register_map  =
-        build_factory(:register_map).create(context.configuration, file)
+        build_factory(:register_map).create(context.configuration, argv.first)
     end
 
     def write_files(context)

data/lib/rggen/input_base/component_factory.rb

@@ -45,13 +45,13 @@ module RgGen
       end
 
       def load_file(file)
-        find_loader(file).load_file(file)
+        find_loader(file).load(file)
       end
 
       def find_loader(file)
-        loader  = @loaders && @loaders.find { |l| l.acceptable?(file) }
-        return loader.new unless loader.nil?
-        fail RgGen::LoadError, "unsupported file type: #{File.ext(file)}"
+        @loaders.find { |l| l.acceptable?(file) } || (
+          raise RgGen::LoadError, "unsupported file type -- #{file}"
+        )
       end
     end
   end

data/lib/rggen/input_base/loader.rb

@@ -4,10 +4,19 @@ module RgGen
       class << self
         attr_writer :supported_types
 
-        def acceptable?(file_name)
-          ext = File.ext(file_name).to_sym
+        def acceptable?(file)
+          ext = File.ext(file).to_sym
           @supported_types.any? { |type| type.casecmp(ext) == 0 }
         end
+
+        def load(file)
+          new.load(file)
+        end
+      end
+
+      def load(file)
+        return load_file(file) if File.exist?(file)
+        raise RgGen::LoadError, "cannot load such file -- #{file}"
       end
     end
   end

data/lib/rggen/version.rb

@@ -1,6 +1,6 @@
 module RgGen
   MAJOR   = 0
   MINOR   = 6
-  TEENY   = 1
+  TEENY   = 2
   VERSION = "#{MAJOR}.#{MINOR}.#{TEENY}".freeze
 end

data/rtl/rggen_bus_splitter.sv

@@ -9,29 +9,16 @@ module rggen_bus_splitter #(
 );
   import  rggen_rtl_pkg::*;
 
-  localparam  INDEX_WIDTH   = $clog2(TOTAL_REGISTERS+1);
+  localparam  int STATUS_WIDTH  = $bits(rggen_status);
 
-  typedef struct packed {
-    logic [DATA_WIDTH-1:0]  read_data;
-    rggen_status            status;
-  } s_response;
-
-  logic [TOTAL_REGISTERS:0]   select;
-  logic [TOTAL_REGISTERS:0]   ready;
-  s_response                  response[TOTAL_REGISTERS+1];
+  logic [TOTAL_REGISTERS-1:0] select;
+  logic [TOTAL_REGISTERS-1:0] ready;
   logic                       response_ready;
-  logic                       no_register_selected;
+  logic                       register_selected;
   logic                       done;
-  logic                       read_done;
-  logic                       write_done;
-  s_response                  selected_response;
-  genvar                      g_i;
-
-  assign  bus_if.done       = done;
-  assign  bus_if.read_done  = read_done;
-  assign  bus_if.write_done = write_done;
-  assign  bus_if.read_data  = selected_response.read_data;
-  assign  bus_if.status     = selected_response.status;
+  logic [DATA_WIDTH-1:0]      selected_read_data;
+  rggen_status                selected_status;
+  genvar                      g_i, g_j;
 
   generate for (g_i = 0;g_i < TOTAL_REGISTERS;++g_i) begin : g
     assign  register_if[g_i].request      = bus_if.request;
@@ -41,47 +28,59 @@ module rggen_bus_splitter #(
     assign  register_if[g_i].write_strobe = bus_if.write_strobe;
     assign  select[g_i]                   = register_if[g_i].select;
     assign  ready[g_i]                    = register_if[g_i].ready;
-    assign  response[g_i].read_data       = register_if[g_i].read_data;
-    assign  response[g_i].status          = register_if[g_i].status;
   end endgenerate
 
-  //  dummy response
-  assign  no_register_selected      = ~|select[TOTAL_REGISTERS-1:0];
-  assign  select[TOTAL_REGISTERS]   = no_register_selected;
-  assign  ready[TOTAL_REGISTERS]    = no_register_selected;
-  assign  response[TOTAL_REGISTERS] = '{read_data: '0, status: RGGEN_SLAVE_ERROR};
-
-  assign  response_ready  = |ready;
+  assign  bus_if.done       = done;
+  assign  response_ready    = |ready;
+  assign  register_selected = |select;
   always_ff @(posedge clk, negedge rst_n) begin
     if (!rst_n) begin
       done              <= '0;
-      read_done         <= '0;
-      write_done        <= '0;
-      selected_response <= '{read_data: '0, status: RGGEN_OKAY};
+      bus_if.read_done  <= '0;
+      bus_if.write_done <= '0;
+      bus_if.read_data  <= '0;
+      bus_if.status     <= RGGEN_OKAY;
     end
-    else if (bus_if.request && response_ready && (!done)) begin
+    else if (bus_if.request && (response_ready || (!register_selected)) && (!done)) begin
       done              <= '1;
-      write_done        <= (bus_if.direction == RGGEN_WRITE) ? '1 : '0;
-      read_done         <= (bus_if.direction == RGGEN_READ ) ? '1 : '0;
-      selected_response <= response[calc_index()];
+      bus_if.read_done  <= (bus_if.direction == RGGEN_READ ) ? '1 : '0;
+      bus_if.write_done <= (bus_if.direction == RGGEN_WRITE) ? '1 : '0;
+      if (register_selected) begin
+        bus_if.read_data  <= selected_read_data;
+        bus_if.status     <= selected_status;
+      end
+      else begin
+        bus_if.read_data  <= '0;
+        bus_if.status     <= RGGEN_SLAVE_ERROR;
+      end
     end
     else begin
       done              <= '0;
-      read_done         <= '0;
-      write_done        <= '0;
-      selected_response <= '{read_data: '0, status: RGGEN_OKAY};
+      bus_if.read_done  <= '0;
+      bus_if.write_done <= '0;
+      bus_if.read_data  <= '0;
+      bus_if.status     <= RGGEN_OKAY;
     end
   end
 
-  function automatic logic [INDEX_WIDTH-1:0] calc_index();
-    logic [INDEX_WIDTH-1:0] index;
-    for (int i = 0;i < INDEX_WIDTH;++i) begin
-      logic [TOTAL_REGISTERS:0] temp;
-      for (int j = 0;j <= TOTAL_REGISTERS;++j) begin
-        temp[j] = j[i] & select[j];
+  //  Response Selection
+  generate if (1) begin : read_data_selection
+    for (g_i = 0;g_i < DATA_WIDTH;++g_i) begin : g
+      logic [TOTAL_REGISTERS-1:0] temp;
+      assign  selected_read_data[g_i] = |temp;
+      for (g_j = 0;g_j < TOTAL_REGISTERS;++g_j) begin : g
+        assign  temp[g_j] = register_if[g_j].read_data[g_i] & register_if[g_j].select;
+      end
+    end
+  end endgenerate
+
+  generate if (1) begin : status_selection
+    for (g_i = 0;g_i < STATUS_WIDTH;++g_i) begin : g
+      logic [TOTAL_REGISTERS-1:0] temp;
+      assign  selected_status[g_i]  = |temp;
+      for (g_j = 0;g_j < TOTAL_REGISTERS;++g_j) begin : g
+        assign  temp[g_j] = register_if[g_j].status[g_i] & register_if[g_j].select;
       end
-      index[i]  = |temp;
     end
-    return index;
-  endfunction
+  end endgenerate
 endmodule

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rggen
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Taichi Ishitani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-31 00:00:00.000000000 Z
+date: 2017-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: baby_erubis