origen_doc_helpers 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d338032f14e42458a138b9b188701a0b5914ee3e9ab5ff8990d683911ffffcf
-  data.tar.gz: f0613005c722f92600e8633b8ede68a638dcf68b5361cbd2c8f12c98fc616564
+  metadata.gz: e38c7e090bcb00c720933266cbf06095d99d817206d105a88fa2a3792f9dfd71
+  data.tar.gz: '076904f8fedfcbecab07c948341ffc529f68357d02106d235dbdebf8db6496d1'
 SHA512:
-  metadata.gz: e413e7c44118ac002618c54dbd7e926c49aec0602e2af86cf0f6eaa4f8182cb934c400b8a245b6576e9452da56454b0a17a4ac83c350e209c29b36ac4007ba47
-  data.tar.gz: b69b7a92e04b5b2ac0030998ffa9aca87e784050da0d9f798fb7b97114c28f21102d081840cd4b0d779bce7f402c52622d45455087b2758c486d8d5fdf21c7ba
+  metadata.gz: 0bb5c8624309ad1e3d5f3261c0e9b5fecc6f30e899a45ef8694d24992b7f6813aadc29bfaebd3ca33bd3915cd44ab5e2319c7c92a300a9e93379fe2aeae8f1ee
+  data.tar.gz: e6cc432dcef4200b37cbc045eec8c2777f327f055cb5e3d36366cefd0ee508996a5864a7a0c09c1f09c2f30c746c51f498e1fac13808dcce8730fb8ea2c79e6a

data/config/version.rb

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

data/lib/origen_doc_helpers_dev/dut.rb

@@ -79,18 +79,23 @@ module OrigenDocHelpersDev
           bit 31..0, :placeholder, reset: 0b0, access: :rw
         end
         reg :msb0_debug, 0xf58, 32, bit_order: 'msb0', ip_base_address: 0x1080000, description: '' do
-          bit 31..0, :placeholder, reset: 0b0, access: :rw
+          # 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

data/templates/shared/_register.html.erb

@@ -19,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>
@@ -41,33 +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
-%   if order_is_lsb0
-%     max_bit = (byte_number * 8) - 1
-%     min_bit = max_bit - 8 + 1
-%   else
-%     min_bit = (byte_index * 8)
-%     max_bit = min_bit + 7
-%   end
+%   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 <%= order_is_lsb0 ? 'rjust' : 'ljust' %><%= partial_byte ? ' partial' : '' %>" 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|
-%   if order_is_lsb0
-%     bit_num = (byte_number * 8) - i - 1
-%   else
-%     bit_num = (byte_index * 8) + i
-%   end
+%   bit_num = (byte_number * 8) - i - 1
 %   if bit_num > reg.size - 1
       <th class="spacer"></th>
 %   else
-      <th class="bit-position<%= !order_is_lsb0 && bit_num == reg.size - 1 ? ' last' : '' %>"><%= bit_num %></th>
+%     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>
@@ -78,8 +89,13 @@
 %#  Read Row
 %#############################################    
     <tr class="read">
+% if order_is_lsb0
       <td class="heading">R</td>
-% alignment_done = !order_is_lsb0
+% 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
@@ -145,7 +161,7 @@
 %#############################################    
     <tr class="write">
       <td class="heading">W</td>
-% alignment_done = !order_is_lsb0
+% 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
@@ -246,7 +262,7 @@
 %#############################################    
     <tr class="reset">
       <td class="heading">Reset</td>
-%   alignment_done = !order_is_lsb0
+%   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
@@ -304,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/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,32 +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
-%   if reg.bit_order == :lsb0
-%     max_bit = (byte_number * 8) - 1
-%     min_bit = max_bit - 8 + 1
-%   else
-%     min_bit = (byte_index * 8)
-%     max_bit = min_bit + 7
-%   end
+%   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|
-%   if reg.bit_order == :lsb0
-%     bit_num = (byte_number * 8) - i - 1
-%   else
-%     bit_num = (byte_index * 8) + i
-%   end
+%   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>
@@ -75,8 +89,13 @@
 %#  Read Row
 %#############################################    
     <tr class="read">
+% if order_is_lsb0
       <td class="heading">R</td>
-% alignment_done = reg.bit_order == :lsb0 ? false : true
+% 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
@@ -142,7 +161,7 @@
 %#############################################    
     <tr class="write">
       <td class="heading">W</td>
-% alignment_done = reg.bit_order == :lsb0 ? false : true
+% 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
@@ -200,7 +219,7 @@
 % if options[:current_value]
     <tr class="current_value">
       <td class="heading">Current Value (Hex)</td>
-%   alignment_done = reg.bit_order == :lsb0 ? false : true
+%   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
@@ -243,7 +262,7 @@
 %#############################################    
     <tr class="reset">
       <td class="heading">Reset</td>
-%   alignment_done = reg.bit_order == :lsb0 ? false : true
+%   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
@@ -301,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>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_doc_helpers
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-08 00:00:00.000000000 Z
+date: 2018-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen