origen_doc_helpers 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ddb0151af6cf74f9080784ce49f885fd55952d81
-  data.tar.gz: d18ecaa6b5e985b720082027f1377d442f3f26b0
+  metadata.gz: f197ebf8b884da0d6aa316309bf03b18bcf2e5bd
+  data.tar.gz: 91ed5f470f146302befb1aeacb25b759dff6194e
 SHA512:
-  metadata.gz: 6339ee1a74d32e6073ad1e7a5f4483f9323ee08f6d73a348782902b104471a811ada5a40b0657e585bd671214729ba355410a9d66fa1ff83ce2b5426a6861bb9
-  data.tar.gz: 027348178efe90fac8e8f9ab8a623724c6beb119579f3ee438b71c8fcb9fed80c7f9158ab93e8bed5a62b0008cdc9d67fe816e5b3ed19070b43e1ad4f8283b21
+  metadata.gz: 58141e8f821a5b924c52cc8eae91899afb1c12a837ed9238fe6f7104bdfdad950bfa8f4d5281015c39387dd6531b907f73b7c45d3af1b059960830e0cacca81e
+  data.tar.gz: 3794c4cba5c64a35e63e33d175c741d9b1c827c5f170eb55ef814436261f31df05da5adeb34c41c9dc5fe2f7d070abdd033bdf884f352697a732bc84504a62f2

data/config/version.rb

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

data/templates/shared/_register.html.erb

@@ -17,7 +17,19 @@
 <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>
+%   elsif reg.size <= 16
+<h4><font style="background-color: #66FF66">Current Value: <%= sprintf("0x%04X",reg.value) %></font></h4>
+%   elsif reg.size <= 24
+<h4><font style="background-color: #66FF66">Current Value: <%= sprintf("0x%06X",reg.value) %></font></h4>
+%   elsif reg.size <= 32
+<h4><font style="background-color: #66FF66">Current Value: <%= sprintf("0x%08X",reg.value) %></font></h4>
+%   end
+% end
 
+% # binding.pry
 % if options[:descriptions]
 <div markdown="1" style="margin: 0 0 20px 0">
 
@@ -177,49 +189,90 @@
 % end
     </tr>
 
+% if options[:current_value]
+    <tr class="current_value">
+      <td class="heading">Current Value</td>
+%   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>
+%       end
+%       alignment_done = true
+%     end
+%     if bit.size > 1
+%       if name
+%         if bit.nvm_dep != 0 || bit.data == :memory
+            <td colspan="<%= _num_bits_in_range(bit, max_bit, min_bit) %>">M</td>
+%         elsif bit.data == :undefined
+            <td colspan="<%= _num_bits_in_range(bit, max_bit, min_bit) %>">X</td>
+%         else
+            <td colspan="<%= _num_bits_in_range(bit, max_bit, min_bit) %>"><%= bit.data[_max_bit_in_range(bit, max_bit, min_bit).._min_bit_in_range(bit, max_bit, min_bit)].to_s(16).upcase %></td>
+%         end
+%       else
+%         bit.shift_out_left do |bit|
+%           if _index_in_range?(bit.position, max_bit, min_bit)
+      <td></td> 
+%           end
+%         end
+%       end
+%     else
+%       if bit.nvm_dep != 0 || bit.reset_val == :memory
+        <td>M</td>
+%       elsif bit.data == :undefined
+        <td>X</td>
+%       else
+        <td><%= bit.data.to_s(16).upcase %></td>
+%       end
+%     end
+%    end
+%   end
+    </tr>
+% else
 %#############################################    
 %#  Reset Row
 %#############################################    
     <tr class="reset">
       <td class="heading">Reset</td>
-% 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
+%   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>
+%       end
+%       alignment_done = true
 %     end
-%     alignment_done = true
-%   end
-%   if bit.size > 1
-%     if name
-%       if bit.nvm_dep != 0 || bit.reset_val == :memory
-          <td colspan="<%= _num_bits_in_range(bit, max_bit, min_bit) %>">M</td>
-%       elsif bit.reset_val == :undefined
-          <td colspan="<%= _num_bits_in_range(bit, max_bit, min_bit) %>">X</td>
+%     if bit.size > 1
+%       if name
+%         if bit.nvm_dep != 0 || bit.reset_val == :memory
+            <td colspan="<%= _num_bits_in_range(bit, max_bit, min_bit) %>">M</td>
+%         elsif bit.reset_val == :undefined
+            <td colspan="<%= _num_bits_in_range(bit, max_bit, min_bit) %>">X</td>
+%         else
+            <td colspan="<%= _num_bits_in_range(bit, max_bit, min_bit) %>"><%= bit.reset_val[_max_bit_in_range(bit, max_bit, min_bit).._min_bit_in_range(bit, max_bit, min_bit)].to_s(16).upcase %></td>
+%         end
 %       else
-          <td colspan="<%= _num_bits_in_range(bit, max_bit, min_bit) %>"><%= bit.reset_val[_max_bit_in_range(bit, max_bit, min_bit).._min_bit_in_range(bit, max_bit, min_bit)].to_s(16).upcase %></td>
-%       end
-%     else
-%       bit.shift_out_left do |bit|
-%         if _index_in_range?(bit.position, max_bit, min_bit)
+%         bit.shift_out_left do |bit|
+%           if _index_in_range?(bit.position, max_bit, min_bit)
       <td></td> 
+%           end
 %         end
 %       end
-%     end
-%   else
-%     if bit.nvm_dep != 0 || bit.reset_val == :memory
+%     else
+%       if bit.nvm_dep != 0 || bit.reset_val == :memory
         <td>M</td>
-%     elsif bit.reset_val == :undefined
+%       elsif bit.reset_val == :undefined
         <td>X</td>
-%     else
+%       else
         <td><%= bit.reset_val.to_s(16).upcase %></td>
+%       end
 %     end
-%   end
-%  end
+%    end
 % end
     </tr>
-
+% end
   </tbody>
 </table>
 
@@ -254,9 +307,27 @@
         </p>
       </td>
 <td markdown="1">
-
+% bit_val_str = ''
+% start_bit = bits.position
+% end_bit = bits.position + bits.size - 1
+% (start_bit..end_bit).each do |b|
+%  bit_val_str << reg.bits[b].data.to_s
+% end
 % bits.description.each do |line|
+%   if options[:current_value]
+%     if line =~ /^\d{#{bit_val_str.length}}/ 
+%       if line =~ /^#{bit_val_str}/
+<span style="background-color: #66FF66"> <%=        line.gsub("\\'", "'") %>
+</span><br/>
+%       else
+<%=        line.gsub("\\'", "'") %><br/>
+%       end
+%     else
+<%=        line.gsub("\\'", "'") %>
+%     end
+%   else
 <%= line.gsub("\\'", "'") %>
+%   end
 % end
 
 </td>

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

@@ -86,7 +86,22 @@ bit descriptions:
 <%= "%" %> end
 ~~~
 
-<%= render "templates/shared/register", :reg => $dut.reg(:mclkdiv), :descriptions => true %>
+~~~eruby
+## Register Map with Current Value
+
+<%= "%" %> $dut.regs.each do |name, reg|
+
+<%= "<" + "%= render \"doc_helpers/register.html\", reg: reg, preserve_target: true, descriptions: true , current_value: true%" + ">" %>
+
+<%= "%" %> end
+~~~
+
+Please note that the highlighting only works when the bit values match 
+explicitly.  It will not match partial descriptions, e.g. value is 000
+and bitfield description is 00.
+
+
+<%= render "templates/shared/register", :reg => $dut.reg(:mclkdiv), :descriptions => true, current_value: true %>
 
 ### Additional Test Cases
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_doc_helpers
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-28 00:00:00.000000000 Z
+date: 2018-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -67,7 +67,6 @@ files:
 - templates/flow_page.md.erb
 - templates/model_index.md.erb
 - templates/model_page.md.erb
-- templates/model_page.md.erb~
 - templates/pdf/topic_wrapper.html
 - templates/shared/_register.html.erb
 - templates/shared/_searchable.html.erb
@@ -77,7 +76,6 @@ files:
 - templates/web/helpers/disqus.md.erb
 - templates/web/helpers/flow.md.erb
 - templates/web/helpers/model.md.erb
-- templates/web/helpers/model.md.erb~
 - templates/web/helpers/register.md.erb
 - templates/web/helpers/searchable/intro.md.erb
 - templates/web/helpers/searchable/page2.md.erb

data/templates/model_page.md.erb~

@@ -1,129 +0,0 @@
-% opts = options
-% model = options[:model]
-% render options[:layout], options[:layout_options] do
-
-<script type="text/javascript">
-  // Modified from: http://jsfiddle.net/jhfrench/mc4Qd/
-  window.onload = function() {
-    // Links to the top of the page
-    $('.top-link').click(function() {
-      jQuery('html,body').animate({scrollTop: 0}, 500);
-      return false;
-    });
-  };
-</script>
-
-<style>
-  tr.clickable td { padding: 0px !important; }
-  tr.clickable a { display: block; height: 100%; width: 100%; padding: 8px; text-decoration: none; }
-</style>
-
-<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;">
-    <h1 style="float: left; margin-left: 10px;"><%= opts[:heading] %></h1>
-  </div>
-% if opts[:search_box]
-  <div id="search" class="col-md-3" style="margin-top: 20px;">
-    <form style="margin-bottom: 15px;">
-      <div class="input-group">
-        <input class="form-control" type="search" placeholder="Search within this model..."/>
-        <span class="input-group-btn">
-          <button type="submit" class="btn btn-search">GO!</button>
-        </span>
-      </div>
-    </form>
-  </div>
-% end
-</div>
-
-<div class="row">
-  <div class="col-md-12">
-    <ol class="breadcrumb">
-%   size = opts[:breadcrumbs].size      
-%   opts[:breadcrumbs].each_with_index do |crumb, i|
-%     if i == size - 1
-      <li class="active"><%= crumb[0] %></li>
-%     else
-      <li><a href="<%= path crumb[1] %>"><%= crumb[0] %></a></li>
-%     end
-%   end      
-    </ol>
-  </div>
-</div>
-
-<div class="row">
-  <div class="col-md-12 search-results">
-  </div>
-</div>
-
-<div class="row">
-  <div class="col-md-6">
-    <h3>Blocks</h3>
-
-    <table class="table table-hover">
-      <thead><tr>
-        <th>Address</th>
-        <th>Name</th>
-      </tr></thead>
-      <tbody>
-%   model.sub_blocks.sort_by { |name, block| block.base_address }.each do |name, block|
-        <tr class="clickable"> 
-          <td><a href="<%= path "#{opts[:path]}/#{name}" %>"><%= block.base_address.to_hex %></a></td>
-          <td><a href="<%= path "#{opts[:path]}/#{name}" %>"><%= name %></a></td>
-        </tr> 
-%   end
-      </tbody>
-    </table>
-  </div>
-
-  <div class="col-md-6">
-    <h3>Registers</h3>
-
-    <table class="table table-hover">
-      <thead><tr>
-        <th>Address</th>
-        <th>Name</th>
-      </tr></thead>
-      <tbody>
-%   model.regs.sort_by { |name, reg| reg.offset }.each do |name, reg|
-        <tr class="clickable"> 
-          <td><a href="#<%= reg.name %>"><%= reg.address.to_hex %></a></td>
-          <td><a href="#<%= reg.name %>"><%= name %></a></td>
-        </tr> 
-%   end
-      </tbody>
-    </table>
-  </div>
-</div>
-
-
-%   if model.owns_registers?
-
-<hr>
-<div class="row">
-  <div class="col-md-12">
-%   if opts[:search_box]
-    <article>
-%   end
-    <h3>Registers of <%= model.model.class%> <%= model.name ? "(#{model.name})" : model.try(:includes_origen_top_level?) ? "(dut)" : "" %></h3>
-
-%     model.regs.sort_by { |name, reg| reg.offset }.each do |name, reg|
-
-    <div>
-      <span class="pull-right"><a class="top-link" href="#">back to top</a></span>
-    </div>
-
-<%= render "doc_helpers/register.html", reg: reg, preserve_target: true, descriptions: true, origen_path: opts[:origen_path] %>
-
-%     end
-
-    </article>
-  </div>
-</div>
-
-%   end
-
-% end
-<script>window.origen_search_id = "<%= opts[:search_id] %>";</script>
-<script src="<%= path "search.js" %>"></script>

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

@@ -1,81 +0,0 @@
-% render "../layouts/helpers.html" do
-
-# Model Documentation
-
-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/).
-
-Multiple models can be supplied and an [index page like this](http://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
-the provided search box.
-
-## How To Use
-
-Call the helper from an <code>after_web_site_compile</code> callback handler in your
-application's <code>config/application.rb</code> like this:
-
-~~~ruby
-def after_web_site_compile(options)
-  # Build the model documentation
-  OrigenDocHelpers.generate_model_docs layout: "#{Origen.root}/templates/web/layouts/_basic.html.erb", tab: :model do |d|
-    d.page model: $dut
-  end
-end
-~~~
-
-To generate documentation for more than one model, call the page method multiple times like this:
-
-~~~ruby
-def after_web_site_compile(options)
-  # Build the model documentation
-  OrigenDocHelpers.generate_model_docs layout: "#{Origen.root}/templates/web/layouts/_basic.html.erb", tab: :model do |d|
-    d.page model: MyApp::ModelA.new
-    d.page model: MyApp::ModelB.new
-    d.page model: MyApp::ModelC.new
-  end
-end
-~~~
-
-If the different models are all top-level instances (i.e. they include <code>Origen::TopLevel</code> and are
-what is commonly referred to as <code>$dut</code>), then a target loop should be used like this:
-
-~~~ruby
-def after_web_site_compile(options)
-  # Build the model documentation
-  OrigenDocHelpers.generate_model_docs layout: "#{Origen.root}/templates/web/layouts/_basic.html.erb", tab: :model do |d|
-    Origen.target.loop targets: ["target_a", "target_b", "target_c"] do
-      d.page model: $dut
-    end
-  end
-end
-~~~
-
-## Options
-
-<code>OrigenDocHelpers.generate_model_docs</code>
-
-* <code>:layout</code> - **Required**, supply a full path to your application's layout file
-* Any other options will be passed to your layout file unmodified, e.g. to set the tab in the generated
-  pages in the above example
-
-<code>page</code>  
-
-* <code>:model</code> - **Required**, supply an instance of the model
-* <code>:group</code> - Optional, a heading to group similar models under on the index page, e.g. "Production", "In Development"
-
-## Website Integration
-
-The model index page will be generated at path <code>/models</code> within your application, and it is common
-to create a "Model(s)" tab in your website's navigation bar to link to this.
-
-If your application only has one model, then the navbar link should be setup to point directly to
-that model's page.
-
-The location of the pages for the individual models are based on the model name and will be unique to each application,
-you can find them initially via the index page.
-
-% end