origen_doc_helpers 0.7.1 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c9913b384df5e46cc7aaa1a413e4bdebf5707074
-  data.tar.gz: 0eec0a9f93a7760a5d19a833f12d4aa88c3221bf
+SHA256:
+  metadata.gz: 86607573815de7e69eb55f1fb1afc8798ff50ba92a4b3a230b1b6cb3627f1365
+  data.tar.gz: a230731ac9a2d6049c2432d496260174ff93cc448f3a9b3ed2ec4cc1abc866e0
 SHA512:
-  metadata.gz: 201b1b79b0c2ca2b556536ca635c1602154901fd25511f43a576f14ad805c7d5bc50dc97464c3229f4eed04ea2c966b581327618aaf2c2aa214f66a87c0123fc
-  data.tar.gz: 60ec544a89a90dfb5a3a040a2f7ca747f7d51e12ed488c58f0bcbd95187cea043243d1d9b4d1b3c47c0288f0df81647e047090c92999d33fdd2ccc4fe2306107
+  metadata.gz: 3c06e83e7c9aab01cb997d2845ebb6d14822ad69ffffd3c22cd7b36c5aa9cb83ecd42241b51dad2c6e3d8b2c94de931c270a94b4bb1094169abdd19aa374d8a3
+  data.tar.gz: ddcdb9f112688745f8503094fe83defdcf3c5fb2ca855cc48c7138cc0175e286291a8d2f936a173bba28e5a9a19b97daeaf95412e94fe47533deab2c7740c133

data/config/application.rb

@@ -8,7 +8,7 @@ class OrigenDocHelpersApplication < Origen::Application
   # To enable deployment of your documentation to a web server (via the 'origen web'
   # command) fill in these attributes.
   config.web_directory = "git@github.com:Origen-SDK/Origen-SDK.github.io.git/doc_helpers"
-  config.web_domain = "http://origen-sdk.org/doc_helpers"
+  config.web_domain = "https://origen-sdk.org/doc_helpers"
   config.disqus_shortname = "origen-sdk"
 
   config.semantically_version = true

data/config/version.rb

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

data/lib/origen_doc_helpers/guide_index.rb

@@ -1,7 +1,7 @@
 module OrigenDocHelpers
   # Provides an API to programatically construct an index hash as used
   # by the Searchable Documents helper -
-  # http://origen-sdk.org/doc_helpers/helpers/searchable/intro/#The_Document_Index
+  # https://origen-sdk.org/doc_helpers/helpers/searchable/intro/#The_Document_Index
   class GuideIndex
     def initialize
       @index = {}

data/lib/origen_doc_helpers/helpers.rb

@@ -272,7 +272,11 @@ END
             if options[:tab]
               options[:tab]
             else
-              rel = options[:top_level_file].relative_path_from(_doc_root_dir(options)).sub_ext('').sub_ext('').to_s
+              rel = begin
+                  options[:top_level_file].relative_path_from(_doc_root_dir(options)).sub_ext('').sub_ext('').to_s
+                rescue
+                  '..'
+                end
               # If the file lives outside of the current app (e.g. it comes from a plugin), then the above approach
               # doesn't work, so let's just take the last dirname and the filename
               if rel =~ /\.\./

data/lib/origen_doc_helpers/html_flow_formatter.rb

@@ -1,7 +1,11 @@
-require 'atp'
+begin
+  require 'origen_testers/atp'
+rescue LoadError
+  require 'atp'
+end
 require 'kramdown'
 module OrigenDocHelpers
-  class HtmlFlowFormatter < ATP::Formatter
+  class HtmlFlowFormatter < (defined?(OrigenTesters::ATP) ? OrigenTesters::ATP::Formatter : ATP::Formatter)
     include Origen::Generator::Compiler::DocHelpers::TestFlowHelpers
 
     attr_reader :html

data/lib/origen_doc_helpers/list_flow_formatter.rb

@@ -1,6 +1,10 @@
-require 'atp'
+begin
+  require 'origen_testers/atp'
+rescue LoadError
+  require 'atp'
+end
 module OrigenDocHelpers
-  class ListFlowFormatter < ATP::Formatter
+  class ListFlowFormatter < (defined?(OrigenTesters::ATP) ? OrigenTesters::ATP::Formatter : ATP::Formatter)
     attr_reader :html
 
     def format(node, options = {})

data/lib/origen_doc_helpers_dev/dut.rb

@@ -78,6 +78,26 @@ module OrigenDocHelpersDev
         reg :debug_22, 0xf54, 32, bit_order: 'lsb0', ip_base_address: 0x1080000, description: '' do
           bit 31..0, :placeholder, reset: 0b0, access: :rw
         end
+        reg :msb0_debug, 0xf58, 32, bit_order: 'msb0', ip_base_address: 0x1080000, description: '' do
+          # placeholder field description
+          bit 31..1, :placeholder, reset: 0b0, access: :rw
+          # single bit
+          bit 0,     :single_bit, reset: 1, access: :rw
+        end
+        reg :lsb0_non_byte_aligned, 0xf5c, 9, bit_order: 'lsb0', ip_base_address: 0x1080000, description: '' do
+          bit 8..0, :placeholder, reset: 0b0, access: :rw
+        end
+        reg :msb0_non_byte_aligned, 0xf60, 9, bit_order: :msb0, ip_base_address: 0x1080000, description: '' do
+          # placeholder field description
+          bit 8..0, :placeholder, reset: 0b0, access: :rw
+        end
+        reg :lsb0_tiny, 0xf64, 3, bit_order: :lsb0, ip_base_address: 0x1080000, description: '' do
+          bit 2..0, :placeholder, reset: 0b0, access: :rw
+        end
+        reg :msb0_tiny, 0xf68, 3, bit_order: :msb0, ip_base_address: 0x1080000, description: '' do
+          # placeholder field description
+          bit 2..0, :placeholder, reset: 0b0, access: :rw
+        end
       end
     end
 

data/templates/model_index.md.erb

@@ -3,7 +3,7 @@
 
 <div class="row" style="margin-top: 10px; margin-bottom: 15px;">
   <div class="col-md-9">
-    <img src="http://origen-sdk.org/img/origen-device.png" style="float: left; height:50px; width: 50px; margin-top: 14px;">
+    <img src="https://origen-sdk.org/img/origen-device.png" style="float: left; height:50px; width: 50px; margin-top: 14px;">
     <h1 style="float: left; margin-left: 10px;">Models</h1>
   </div>
 </div>

data/templates/model_page.md.erb

@@ -20,7 +20,7 @@
 
 <div class="row" style="margin-top: 10px; margin-bottom: 15px;">
   <div class="col-md-9">
-    <img src="http://origen-sdk.org/img/origen-device.png" style="float: left; height:50px; width: 50px; margin-top: 14px;">
+    <img src="https://origen-sdk.org/img/origen-device.png" style="float: left; height:50px; width: 50px; margin-top: 14px;">
     <h1 style="float: left; margin-left: 10px;"><%= opts[:heading] %></h1>
   </div>
 % if opts[:search_box]

data/templates/shared/_register.html.erb

@@ -1,4 +1,6 @@
 % reg = options[:reg]
+% order_is_lsb0 = true
+% order_is_lsb0 = false if reg.bit_order == :msb0 || reg.bit_order == 'msb0'
 % include_data = false
 
 <div class="register">
@@ -17,6 +19,7 @@
 <h4>0x<%= reg.address.to_s(16).upcase %> - <%= reg_path %></h4>
 % end
 </a>
+
 % if options[:current_value]
 %   if reg.size <= 8
 <h4><font style="background-color: #66FF66">Current Value: <%= sprintf("0x%02X",reg.value) %></font></h4>
@@ -39,23 +42,43 @@
 </div>
 % end
 
+% if !order_is_lsb0
+<table class="reg table table-condensed ljust" style="margin-bottom: 0; table-layout: fixed;">
+  <thead>
+    <tr class="bit-positions">
+      <b><tr class = "heading"><%= reg_path%> <span class="msb0_specific" style="color:gray;">(<%= reg_path %>.with_msb0)</span></tr></b>
+    </tr>
+  </thead>
+</table>
+% end
+
 % num_bytes = (reg.size / 8.0).ceil
 % num_bytes.times do |byte_index|
 %   # Need to add support for little endian regs here?
 %   byte_number = num_bytes - byte_index
 %   max_bit = (byte_number * 8) - 1
 %   min_bit = max_bit - 8 + 1
+%   partial_byte = max_bit > (reg.size - 1)
 
-<table class="reg table table-condensed" style="margin-bottom: 0; table-layout: fixed;">
+<table class="reg table table-condensed <%= 'rjust' %><%= partial_byte ? ' partial' : '' %>" style="margin-bottom: 0; table-layout: fixed;">
   <thead>
     <tr class="bit-positions">
+% if order_is_lsb0
       <th class="spacer"></th>
+% else
+      <td class="heading">LSB0<span class="msb0_specific" style="color:gray;"> (MSB0)</span></td>
+% end
+
 % 8.times do |i|
 %   bit_num = (byte_number * 8) - i - 1
 %   if bit_num > reg.size - 1
       <th class="spacer"></th>
 %   else
+%     if order_is_lsb0
       <th class="bit-position"><%= bit_num %></th>
+%     else
+      <th class="bit-position"><%= bit_num %><span class="msb0_specific" style="color:gray;"> (<%= reg.size - bit_num -1%>)</span></th>
+%     end
 %   end
 % end
     </tr>
@@ -66,13 +89,18 @@
 %#  Read Row
 %#############################################    
     <tr class="read">
+% if order_is_lsb0
       <td class="heading">R</td>
+% else
+      <td class="heading"><span class="msb0_specific" style="color:gray;">[LSB0] </span>R</td>
+% end
+
 % alignment_done = false
 % reg.named_bits :include_spacers => true do |name, bit|
 %  if _bit_in_range?(bit, max_bit, min_bit)
 %   if max_bit > (reg.size - 1) && !alignment_done
 %     (max_bit - (reg.size - 1)).times do
-      <td class="spacer"></td>
+        <td class="spacer"></td>
 %     end
 %     alignment_done = true
 %   end
@@ -191,7 +219,7 @@
 % if options[:current_value]
     <tr class="current_value">
       <td class="heading">Current Value (Hex)</td>
-%   alignment_done = false
+%   alignment_done = !order_is_lsb0
 %   reg.named_bits :include_spacers => true do |name, bit|
 %     if _bit_in_range?(bit, max_bit, min_bit)
 %       if max_bit > (reg.size - 1) && !alignment_done
@@ -292,16 +320,16 @@
         <p>
           <a class="anchor" name="<%= "#{reg.name}_#{name}_#{bits.position}" %>"></a>
 % if bits.size == 1        
-          <%= bits.position %>
+          <%= bits.position %><%= order_is_lsb0 ? '' : "<span class=\"msb0_specific\" style=\"color:gray;\"> (#{reg.size - bits.position - 1})</span>" %>
 % else
-          <%= bits.position + bits.size - 1 %>-<%= bits.position %>
+          <%= bits.position + bits.size - 1 %>-<%= bits.position %><%= order_is_lsb0 ? '' : "<span class=\"msb0_specific\" style=\"color:gray;\"> (#{reg.size - bits.position - bits.size}-#{reg.size - bits.position - 1})</span>" %>
 % end
         </p>
         <p>
 % if bits.size == 1        
           <%= name %>
 % else
-          <%= name %>[<%= bits.size - 1 %>:0]
+          <%= name %>[<%= bits.size - 1 %>:0]<%= order_is_lsb0 ? '' : "<span class=\"msb0_specific\" style=\"color:gray;\"> ([0:#{bits.size - 1}])</span>" %>
 % end
         </p>
       </td>

data/templates/web/helpers.md.erb

@@ -16,7 +16,7 @@ These helpers will generate complete web pages for you.
 
 The following are components that you can embed within your own web pages.
 
-| [Searchable Documents](<%= path "/helpers/searchable/intro" %>) | Provides a layout for a guides section of your website, complete with search box (the [Origen Guides](http://origen-sdk.org/guides) uses this)
+| [Searchable Documents](<%= path "/helpers/searchable/intro" %>) | Provides a layout for a guides section of your website, complete with search box (the [Origen Guides](https://origen-sdk.org/guides) uses this)
 | [Register Descriptions](<%= path "/helpers/register" %>)        | Create a tabular register view, similar to that used in device reference manuals
 | [Yammer Comments](<%= path "/helpers/yammer" %>)                | Embed a comments section at the bottom of your page using Yammer
 | [Disqus Comments](<%= path "/helpers/disqus" %>)                | Embed a comments section at the bottom of your page using Disqus

data/templates/web/helpers/model.md.erb

@@ -5,9 +5,9 @@
 This helper will build a collection of web pages that document a model's attributes,
 currently this includes its sub-blocks and registers.
 
-[Here is an example](http://origen-sdk.org/link_demo/models/linkdemo_toplevel/).
+[Here is an example](https://origen-sdk.org/link_demo/models/linkdemo_toplevel/).
 
-Multiple models can be supplied and an [index page like this](http://origen-sdk.org/link_demo/models)
+Multiple models can be supplied and an [index page like this](https://origen-sdk.org/link_demo/models)
 is generated to help locate the documentation for a given model.
 
 The collection of pages associated with a particular model is also fully searchable via

data/templates/web/helpers/register.md.erb

@@ -2,7 +2,7 @@
 
 # Register Helpers
 
-Use the [Origen register API](http://origen-sdk.org/origen/guides/models/registers)
+Use the [Origen register API](https://origen-sdk.org/origen/guides/models/registers)
 to define registers in the normal way,
 all of the examples are here are based on this register definition:
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_doc_helpers
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.3
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-16 00:00:00.000000000 Z
+date: 2021-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -31,7 +31,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/fix_my_workspace
 - config/application.rb
 - config/boot.rb
 - config/commands.rb
@@ -77,7 +76,7 @@ files:
 - templates/web/layouts/_helpers.html.erb
 - templates/web/partials/_navbar.html.erb
 - templates/web/release_notes.md.erb
-homepage: http://origen-sdk.org/doc_helpers
+homepage: https://origen-sdk.org/doc_helpers
 licenses:
 - MIT
 metadata: {}
@@ -96,8 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.8.11
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Snippets and helpers for creating Origen web documents

data/bin/fix_my_workspace

@@ -1,100 +0,0 @@
-#!/usr/bin/env ruby
-$VERBOSE = nil  # Don't care about world writable dir warnings and the like
-
-if $_fix_my_workspace_version_check
-  $_fix_my_workspace_version = '0.7.0'
-else
-  if File.exist?(File.expand_path('../../lib/origen.rb', __FILE__))
-    # If this script is being run from within an origen-core workspace, use that Origen-core,
-    # not the system-installed origen-core version.
-    $LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
-    require 'origen'
-  else
-    # Use system-installed Origen (the gem in system Ruby)
-    require 'origen'
-  end
-
-  if !Origen.site_config.gem_manage_bundler
-    puts 'Sorry but you have opted to manage Bundler yourself via your Origen site config, and this means'
-    puts 'that I cannot make certain assumptions about how your workspace is configured.'
-    puts 'You will need to either resolve this problem yourself, or else change the value of'
-    puts 'gem_mange_bundler to true.'
-    puts 'See here for more details on how to do that: http://origen-sdk.org/origen/guides/starting/company/'
-
-  else
-    ENV['BUNDLE_GEMFILE'] = File.join(Origen.root, 'Gemfile')
-    ENV['BUNDLE_PATH'] = File.expand_path(Origen.site_config.gem_install_dir)
-    ENV['BUNDLE_BIN'] = File.join(Origen.root, 'lbin')
-
-    # Force copy system gems to local gems
-    if Origen.site_config.gem_use_from_system
-      local_gem_dir = "#{ENV['BUNDLE_PATH']}/ruby/#{Pathname.new(Gem.dir).basename}"
-      gem_dir = Pathname.new(Gem.dir)
-
-      Origen.site_config.gem_use_from_system.each do |gem, version|
-        begin
-          # This will raise an error if the system doesn't have this gem installed, that
-          # will be rescued below
-          spec = Gem::Specification.find_by_name(gem, version)
-
-          local_dir = File.join(local_gem_dir, Pathname.new(spec.gem_dir).relative_path_from(gem_dir))
-          FileUtils.mkdir_p local_dir
-          FileUtils.cp_r("#{spec.gem_dir}/.", local_dir)
-
-          local_file = Pathname.new(File.join(local_gem_dir, Pathname.new(spec.cache_file).relative_path_from(gem_dir)))
-          FileUtils.mkdir_p local_file.dirname
-          FileUtils.cp(spec.cache_file, local_file)
-
-          if spec.extension_dir && File.exist?(spec.extension_dir)
-            local_dir = File.join(local_gem_dir, Pathname.new(spec.extension_dir).relative_path_from(gem_dir))
-            FileUtils.mkdir_p local_dir
-            FileUtils.cp_r("#{spec.extension_dir}/.", local_dir)
-          end
-
-          local_file = Pathname.new(File.join(local_gem_dir, Pathname.new(spec.spec_file).relative_path_from(gem_dir)))
-          FileUtils.mkdir_p local_file.dirname
-          FileUtils.cp(spec.spec_file, local_file)
-
-        rescue Gem::LoadError
-          # This just means that one of the gems that should be copied from the system
-          # was not actually installed in the system, so nothing we can do about that here
-        end
-      end
-    end
-
-    # Delete lbin
-    FileUtils.rm_rf(ENV['BUNDLE_BIN']) if File.exist?(ENV['BUNDLE_BIN'])
-
-    # Run bundler with correct switches
-    cmd = "bundle install --gemfile #{ENV['BUNDLE_GEMFILE']} --binstubs #{ENV['BUNDLE_BIN']} --path #{ENV['BUNDLE_PATH']}"
-    `chmod o-w #{Origen.root}` # Stops some annoying world writable warnings during install
-    `chmod o-w #{Origen.root}/bin` if File.exist?("#{Origen.root}/bin")
-    `chmod o-w #{Origen.root}/.bin` if File.exist?("#{Origen.root}/.bin")
-
-    # Try again, this time updating the bundle
-    if system(cmd)
-      fixed = true
-    elsif system 'bundle update'
-      fixed = true
-    end
-
-    if File.exist?(ENV['BUNDLE_BIN'])
-      `chmod o-w #{ENV['BUNDLE_BIN']}`
-
-      # Make .bat versions of all executables, Bundler should really be doing this when running
-      # on windows
-      if Origen.os.windows?
-        Dir.glob("#{ENV['BUNDLE_BIN']}/*").each do |bin|
-          unless bin =~ /.bat$/
-            bat = "#{bin}.bat"
-            unless File.exist?(bat)
-              File.open(bat, 'w') { |f| f.write('@"ruby.exe" "%~dpn0" %*') }
-            end
-          end
-        end
-      end
-    end
-
-    system 'origen -v' if fixed
-  end
-end