origen 0.7.5 → 0.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1276d6eeb4622b1418a9d51ae8d8a0f219bdf280
-  data.tar.gz: e97b54e3ccc539c3c86186ebc22a07117a1aca51
+  metadata.gz: 273cd4ec500be111fe541e1bd647d1d4a5d33116
+  data.tar.gz: 8aa30d894b3822c2b7475bdb6c87c94a75107e4e
 SHA512:
-  metadata.gz: 5260a90e5e42360a77301d73293cf5eeafa3baa657a826be98b243ec27b599e737c731b0ddbcc5131efcfbe297f3c4328f2aee342a7592caa80968d67ac7e9e3
-  data.tar.gz: b27abbbbf59392c3b119db63d2b480a11a517b961109633df713bd976bc4b8f7478182e0d243cdd1360b2479588e173e6d44e126dfe254c5850a1b0b2380c97f
+  metadata.gz: 9ff01e3074e12fb22bfe92f41fd9f740436978708c583c6a05d3cbdd7004e80d82ff1ad73e6157ef7f996df25a07799798f98fb8b855f53b8676184178b6c39e
+  data.tar.gz: bff1eb0b296d486b59232cf5d3a3ae6cefaf537ffcacfa903bd6a945a5f3b6c2e0d6206b648c4c8acebdaf86e4e5c05114450cfba78ccdd93b442d41416bd004

data/config/version.rb

@@ -1,7 +1,7 @@
 module Origen
   MAJOR = 0
   MINOR = 7
-  BUGFIX = 5
+  BUGFIX = 6
   DEV = nil
 
   VERSION = [MAJOR, MINOR, BUGFIX].join(".") + (DEV ? ".pre#{DEV}" : '')

data/lib/c99/nvm.rb

@@ -40,6 +40,11 @@ module C99
         reg.bits 7..0,     :fprot4,  reset: 0x11
       end
     end
+
+    def add_non_byte_aligned_regs
+      add_reg :non_aligned_small, 0x1000, size: 4
+      add_reg :non_aligned_big, 0x1010, size: 10
+    end
   end
 
   class NVMSub < NVM

data/lib/origen.rb

@@ -456,7 +456,16 @@ unless defined? RGen::ORIGENTRANSITION
 
       # Compile the given file and return the result as a string
       def compile(file, options = {})
-        Origen::Generator::Compiler.new.compile_inline(file, options)
+        # This has to operate on a new instance so that helper methods can use the inline
+        # compiler within an isolated context
+        c = Origen::Generator::Compiler.new
+        # It needs to be placed on the stack so that the global render method references
+        # the correct compiler instance
+        $_compiler_stack ||= []
+        $_compiler_stack << c
+        r = c.compile_inline(file, options)
+        $_compiler_stack.pop
+        r
       end
 
       def interfaces

data/lib/origen/application/lsf_manager.rb

@@ -12,6 +12,9 @@ module Origen
       attr_accessor :current_command
 
       def initialize
+        unless File.exist?(log_file_directory)
+          FileUtils.mkdir_p(log_file_directory)
+        end
       end
 
       def remote_jobs_file

data/lib/origen/commands/web.rb

@@ -140,6 +140,7 @@ The following options are available:
       else
         Origen.set_development_mode
       end
+      options[:files] = ARGV.dup
       if ARGV.empty?
         _build_web_dir
         Dir.chdir Origen.root do
@@ -152,6 +153,9 @@ The following options are available:
           Origen.app.listeners_for(:after_web_compile).each do |listener|
             listener.after_web_compile(options)
           end
+          Origen.app.listeners_for(:after_web_site_compile).each do |listener|
+            listener.after_web_site_compile(options)
+          end
         end
 
       else

data/lib/origen/generator/compiler.rb

@@ -20,6 +20,8 @@ module Origen
       # it as a string to the caller (i.e. without creating an output file)
       #
       # It expects an absolute path to a single template file as the file argument.
+      #
+      # @api private
       def compile_inline(file, options = {})
         initial_options = options.merge({})
         options = {
@@ -28,7 +30,9 @@ module Origen
           collect_stats:     false,
           initial_options:   initial_options
         }.merge(options)
-        run_erb(Pathname.new(file), options).strip
+        @scope = options[:scope]
+        file = Pathname.new(file) unless options[:string]
+        run_erb(file, options).strip
       end
 
       # Compile all files found under the source directory, non-erb files will be copied
@@ -39,6 +43,7 @@ module Origen
           sub_template:      false,
           collect_stats:     true
         }.merge(options)
+        @scope = options[:scope]
         # Doing here so the output_directory (requiring target load) doesn't get hit if
         # it is already defined
         options[:output_directory] ||= output_directory
@@ -140,10 +145,18 @@ module Origen
         options[:file] = file
         options[:top_level_file] = current_file
         b = _get_binding(opts, &block)
+        if opts[:string]
+          content = file
+          @current_buffer = '@_string_template'
+          buffer = @current_buffer
+        else
+          content = File.read(file.to_s)
+          buffer = buffer_name_for(file)
+        end
         if block_given?
-          content = ERB.new(File.read(file.to_s), 0, '%<>', buffer_name_for(file)).result(b)
+          content = ERB.new(content, 0, '%<>', buffer).result(b)
         else
-          content = ERB.new(File.read(file.to_s), 0, Origen.config.erb_trim_mode, buffer_name_for(file)).result(b)
+          content = ERB.new(content, 0, Origen.config.erb_trim_mode, buffer).result(b)
         end
         insert(content)
       end
@@ -172,11 +185,11 @@ module Origen
       end
 
       def current_buffer
-        instance_variable_get(@current_buffer || '@_anonymous')
+        (@scope || self).instance_variable_get(@current_buffer || '@_anonymous')
       end
 
       def current_buffer=(text)
-        instance_variable_set(@current_buffer || '@_anonymous', text)
+        (@scope || self).instance_variable_set(@current_buffer || '@_anonymous', text)
       end
 
       # Returns the ERB buffer name for the given file, something like "@my_file_name"

data/lib/origen/generator/renderer.rb

@@ -4,6 +4,7 @@ module Origen
     # and source files
     module Renderer
       def render(file, options = {}, &block)
+        fail 'File argument is nil' unless file
         file = Origen.file_handler.clean_path_to_sub_template(file)
         current_pipeline << { file: file, options: options,
                               placeholder: placeholder, block: block,
@@ -45,7 +46,8 @@ module Origen
           self.current_buffer = ''
           output = compile(current[:file],
                            sub_template: true,
-                           block:        current[:block]
+                           block:        current[:block],
+                           scope:        @scope
                           )
           if current[:indent] && current[:indent] > 0
             indent = ' ' * current[:indent]

data/lib/origen/global_methods.rb

@@ -31,7 +31,11 @@ module Origen
 
     # Render an ERB template
     def render(*args, &block)
-      Origen.generator.compiler.render(*args, &block)
+      if $_compiler_stack && $_compiler_stack.last
+        $_compiler_stack.last.render(*args, &block)
+      else
+        Origen.generator.compiler.render(*args, &block)
+      end
     end
 
     def dut

data/lib/origen/registers.rb

@@ -296,6 +296,9 @@ module Origen
     #
     # Can be called on any object to add a register to it
     def add_reg(id, address, size = nil, bit_info = {}, &_block)
+      if address.is_a?(Hash)
+        fail 'add_reg requires the address to be supplied as the 2nd argument, e.g. add_reg :my_reg, 0x1000'
+      end
       size, bit_info = nil, size if size.is_a?(Hash)
       size ||= bit_info.delete(:size) || 32
       description = bit_info.delete(:description)

data/lib/origen/registers/bit_collection.rb

@@ -311,7 +311,7 @@ module Origen
         end
         if value
           value = Reg.clean_value(value)
-          write(value)
+          write(value, force: true)
         end
         if options[:mask]
           each_with_index { |bit, i| bit.read if options[:mask][i] == 1 }

data/lib/origen/registers/reg.rb

@@ -120,19 +120,30 @@ module Origen
       def inspect
         bit_width = 13
         desc = ["\n0x%X - :#{name}" % address]
-        desc << '  ' + ('=' * (bit_width + 1) * 8)
+        r = size % 8
+        if r == 0
+          desc << ('   ' + ('=' * (bit_width + 1) * 8)).chop
+        else
+          desc << ('   ' + (' ' * (bit_width + 1) * (8 - r)) + ('=' * (bit_width + 1) * r)).chop
+        end
 
         # "<#{self.class}: #{self.name}>"
-        (size / 8).times do |byte_index|
+        num_bytes = (size / 8.0).ceil
+        num_bytes.times do |byte_index|
           # Need to add support for little endian regs here?
-          byte_number = (size / 8) - byte_index
-          max_bit = size - (byte_index * 8) - 1
+          byte_number = num_bytes - byte_index
+          max_bit = (byte_number * 8) - 1
           min_bit = max_bit - 8 + 1
 
-          line = '  '
           # BIT INDEX ROW
+          line = '  '
           8.times do |i|
-            line << '|' + "#{size - i - 1 - (byte_index * 8)}".center(bit_width)
+            bit_num = (byte_number * 8) - i - 1
+            if bit_num > size - 1
+              line << ' ' + ''.center(bit_width)
+            else
+              line << '|' + "#{bit_num}".center(bit_width)
+            end
           end
           line += '|'
           desc << line
@@ -141,6 +152,12 @@ module Origen
           line = '  '
           named_bits include_spacers: true do |name, bit, bitcounter|
             if _bit_in_range?(bit, max_bit, min_bit)
+              if max_bit > (size - 1)
+                (max_bit - (size - 1)).times do
+                  line << ' ' * (bit_width + 1)
+                end
+              end
+
               if bit.size > 1
 
                 if name
@@ -179,61 +196,16 @@ module Origen
           line += '|'
           desc << line
 
-          ## BIT ACCESS ROW
-          # line = "Access "
-          # self.named_bits :include_spacers => true do |name, bit|
-          #  if _bit_in_range?(bit, max_bit, min_bit)
-          #    if bit.size > 1
-          #      if name
-          #        access = _bit_rw(bit)
-          #        bit_span = _num_bits_in_range(bit, max_bit, min_bit)
-          #        width = bit_width * bit_span
-          #        line << "|" + access.center(width + bit_span - 1)
-          #      else
-          #        bit.shift_out_left do |bit|
-          #          if _index_in_range?(bit.position, max_bit, min_bit)
-          #            line << "|" +  "".center(bit_width)
-          #          end
-          #        end
-          #      end
-          #    else
-          #      access = _bit_rw(bit)
-          #      line << "|" + access.center(bit_width)
-          #    end
-          #  end
-          # end
-          # line += "|"
-          # desc << line
-
-          ## BIT RESET ROW
-          # line = "Reset  "
-          # self.named_bits :include_spacers => true do |name, bit|
-          #  if _bit_in_range?(bit, max_bit, min_bit)
-          #    if bit.size > 1
-          #      if name
-          #        value = "0x%X" % bit.reset_val[_max_bit_in_range(bit, max_bit, min_bit).._min_bit_in_range(bit, max_bit, min_bit)]
-          #        bit_span = _num_bits_in_range(bit, max_bit, min_bit)
-          #        width = bit_width * bit_span
-          #        line << "|" + value.center(width + bit_span - 1)
-          #      else
-          #        bit.shift_out_left do |bit|
-          #          if _index_in_range?(bit.position, max_bit, min_bit)
-          #             line << "|" +  "".center(bit_width)
-          #          end
-          #        end
-          #      end
-          #    else
-          #      line << "|" + "#{bit.reset_val}".center(bit_width)
-          #    end
-          #  end
-          # end
-          # line += "|"
-          # desc << line
-
           # BIT STATE ROW
           line = '  '
           named_bits include_spacers: true do |name, bit, _bitcounter|
             if _bit_in_range?(bit, max_bit, min_bit)
+              if max_bit > (size - 1)
+                (max_bit - (size - 1)).times do
+                  line << ' ' * (bit_width + 1)
+                end
+              end
+
               if bit.size > 1
                 if name
                   if bit.has_known_value?
@@ -278,7 +250,16 @@ module Origen
           line += '|'
           desc << line
 
-          desc << '  ' + ('-' * (bit_width + 1) * 8)
+          if size >= 8
+            r = size % 8
+            if byte_index == 0 && r != 0
+              desc << ('   ' + ('=' * (bit_width + 1) * (8 - r)).chop + ' ' + ('-' * (bit_width + 1) * r)).chop
+            else
+              desc << ('   ' + ('-' * (bit_width + 1) * 8)).chop
+            end
+          else
+            desc << ('   ' + (' ' * (bit_width + 1) * (8 - size)) + ('-' * (bit_width + 1) * size)).chop
+          end
         end
         desc.join("\n")
       end
@@ -394,8 +375,9 @@ module Origen
         File.readlines(define_file).each do |line|
           if line =~ /^\s*#(.*)/
             desc << Regexp.last_match[1].strip
-          elsif line =~ /^\s*(add_reg|reg)\(?\s*:(\w+)\s*,.*do/
-            @current_reg_name = Regexp.last_match[2].to_sym
+          #              http://rubular.com/r/D8lg2P5kK1                     http://rubular.com/r/XP4ydPV8Fd
+          elsif line =~ /^\s*reg\(?\s*[:"'](\w+)["']?\s*,.*\sdo/ || line =~ /^\s*add_reg\(?\s*[:"'](\w+)["']?\s*,.*/
+            @current_reg_name = Regexp.last_match[1].to_sym
             description_lookup[define_file] ||= {}
             description_lookup[define_file][@current_reg_name] ||= {}
             description_lookup[define_file][@current_reg_name][:_reg] = desc.dup
@@ -484,6 +466,7 @@ module Origen
         options = {
           include_spacers: false
         }.merge(options)
+        result = []
 
         # test if @lookup has any values stored as an array
         # if so it means there is a split group of bits
@@ -500,20 +483,38 @@ module Origen
             pos = details[:bits] + details[:pos]
             if options[:include_spacers] && (pos != current_pos)
               collection = BitCollection.dummy(self, nil, size: current_pos - pos, pos: pos)
-              yield nil, collection
+              unless collection.size == 0
+                if block_given?
+                  yield nil, collection
+                else
+                  result << [nil, collection]
+                end
+              end
             end
             collection = BitCollection.new(self, name)
             details[:bits].times do |i|
               collection << @bits[details[:pos] + i]
             end
-            yield name, collection
+            unless collection.size == 0
+              if block_given?
+                yield name, collection
+              else
+                result << [name, collection]
+              end
+            end
             current_pos = details[:pos]
           end
           if options[:include_spacers] && current_pos != 0
             collection = BitCollection.dummy(self, nil, size: current_pos, pos: 0)
-            yield nil, collection
+            unless collection.size == 0
+              if block_given?
+                yield nil, collection
+              else
+                result << [nil, collection]
+              end
+            end
           end
-        elsif split_bits == true # if there are split bits, need to convert all regsiter bit values to array elements to allow sorting
+        elsif split_bits == true # if there are split bits, need to convert all register bit values to array elements to allow sorting
 
           # if the register has bits split up across it, then store the bits in order of decreasing reg position
           # but first, stuff all the bits in a simple array, as single bits, or ranges of bits
@@ -569,20 +570,41 @@ module Origen
             pos = details[:bits] + details[:pos]
             if options[:include_spacers] && (pos != current_pos)
               collection = BitCollection.dummy(self, nil, size: current_pos - pos, pos: pos)
-              yield nil, collection, bitcounter
+              unless collection.size == 0
+                if block_given?
+                  yield nil, collection, bitcounter
+                else
+                  result << [nil, collection, bitcounter]
+                end
+              end
             end
             collection = BitCollection.new(self, name)
             details[:bits].times do |i|
               collection << @bits[details[:pos] + i]
             end
-            yield name, collection,  bitcounter
+            unless collection.size == 0
+              if block_given?
+                yield name, collection, bitcounter
+              else
+                result << [name, collection, bitcounter]
+              end
+            end
             current_pos = details[:pos]
           end
           if options[:include_spacers] && current_pos != 0
             collection = BitCollection.dummy(self, nil, size: current_pos, pos: 0)
-            yield nil, collection,  bitcounter
+            unless collection.size == 0
+              if block_given?
+                yield nil, collection, bitcounter
+              else
+                result << [nil, collection, bitcounter]
+              end
+            end
           end
         end
+        unless block_given?
+          result
+        end
       end
 
       # Returns each named bit collection contained in self

data/lib/origen/specs.rb

@@ -48,6 +48,7 @@ module Origen
         sub_type:      nil,
         mode:          current_mode.nil? ? nil : current_mode.name,
         spec:          nil,
+        symbol:        false,
         creating_spec: false
       }.update(options || {})
       _specs
@@ -102,6 +103,7 @@ module Origen
         sub_type:      nil,
         mode:          current_mode.nil? ? nil : current_mode.name,
         spec:          nil,
+        symbol:        false,
         creating_spec: false
       }.update(options)
       if @_specs.nil? || @_specs == {}
@@ -124,6 +126,7 @@ module Origen
         sub_type:      nil,
         mode:          current_mode.nil? ? nil : current_mode.name,
         spec:          nil,
+        symbol:        false,
         creating_spec: false
       }.update(options)
       options[:spec] = s
@@ -639,14 +642,22 @@ module Origen
         sub_type:          nil,
         specs_to_be_shown: SpecArray.new,
         owner:             nil,
+        symbol:            false,
         creating_spec:     false
       }.update(options)
+      options[:symbol] ? symbol = options.delete(:spec) : symbol = nil
       specs_to_be_shown = options[:specs_to_be_shown]
       filter_hash(_specs, options[:spec]).each do |_spec, hash|
         filter_hash(hash, options[:mode]).each do |_mode, hash_|
           filter_hash(hash_, options[:type]).each do |_type, hash__|
             filter_hash(hash__, options[:sub_type]).each do |_sub_type, spec|
-              specs_to_be_shown << spec
+              if symbol
+                if spec.symbol && (spec.symbol.gsub(/<.*?>/, '').downcase.to_sym == symbol)
+                  specs_to_be_shown << spec
+                end
+              else
+                specs_to_be_shown << spec
+              end
             end
           end
         end

data/templates/nanoc/lib/search_filter.rb

@@ -33,8 +33,11 @@ class SearchFilter < Nanoc::Filter
   end
 
   def search_file
-    @search_file ||= File.join(@site.config[:output_dir],
-      @site.config[:search_file] || 'search.json')
+    if item[:search_id]
+      File.join(@site.config[:output_dir], "search_#{item[:search_id]}.json")
+    else
+      File.join(@site.config[:output_dir], 'search.json')
+    end
   end
 
   def extract_first(doc, path)

data/templates/nanoc_dynamic/content/search.js.erb

@@ -1,4 +1,12 @@
-$.getJSON("<%= path 'search.json' %>", function(json) {
+var search_json;
+
+if (window.origen_search_id) {
+  search_json = "search_" + window.origen_search_id + ".json";
+} else {
+  search_json = "search.json";
+}
+
+$.getJSON("<%= path '' %>" + "/" + search_json, function(json) {
   window.index = lunr(function() {
     this.field("title", {boost: 10});
     this.field("subtitle", {boost: 5});
@@ -87,6 +95,12 @@ $(document).ready(function() {
 
   if (params.highlight) {
     var term = unescape(params.highlight);
-    $('article').highlight(term);
+    var articles = $('article');
+    articles.highlight(term);
+    if (articles[0]) {
+      var top = $($("span.highlight:contains(" + params.highlight + ")")[0]).offset().top;
+
+      $('html,body').animate({scrollTop: top - 350}, 500);
+    }
   }
 });

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.7.6
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-04 00:00:00.000000000 Z
+date: 2016-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport