doc: Update userguide to add ring buffer info

Signed-off-by: Theodor Stana <t.stana@cern.ch>

doc: Update userguide to add ring buffer info
Signed-off-by: Theodor Stana <t.stana@cern.ch>
2904e984 · Theodor-Adrian Stana · 17a7bc21 · 2904e984 · 2904e984 · 2904e984
Commit 2904e984 authored Mar 25, 2014 by Theodor-Adrian Stana
5 changed files
--- a/doc/userguide/conv-regs.tex
+++ b/doc/userguide/conv-regs.tex
--- a/doc/userguide/fig/timetag-arch.svg
+++ b/doc/userguide/fig/timetag-arch.svg
@@ -10,7 +10,7 @@
   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
   width="280.03534"
-   height="118.4444"
+   height="120.21608"
   id="svg2"
   version="1.1"
   inkscape:version="0.48.3.1 r9886"
@@ -67,9 +67,9 @@
     borderopacity="1.0"
     inkscape:pageopacity="0.0"
     inkscape:pageshadow="2"
-     inkscape:zoom="4"
-     inkscape:cx="111.14235"
-     inkscape:cy="40.54635"
+     inkscape:zoom="2.8284271"
+     inkscape:cx="150.54789"
+     inkscape:cy="-3.0567936"
     inkscape:document-units="px"
     inkscape:current-layer="layer1"
     showgrid="true"
@@ -113,7 +113,7 @@
     inkscape:label="Layer 1"
     inkscape:groupmode="layer"
     id="layer1"
-     transform="translate(-269.67716,-216.01222)">
+     transform="translate(-269.67716,-214.24054)">
    <path
       style="fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-end:url(#TriangleOutM)"
       d="m 270.17716,244.48812 76.1811,0"
@@ -126,23 +126,23 @@
       height="53.14962"
       width="13.287388"
       id="rect5794"
-       style="fill:none;fill-opacity:1;stroke:#000000;stroke-width:1;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" />
+       style="fill:none;stroke:#000000;stroke-width:1;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" />
    <rect
       y="232.97237"
       x="522.6377"
       height="53.14962"
       width="13.287388"
       id="rect5796"
-       style="fill:none;fill-opacity:1;stroke:#000000;stroke-width:1;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" />
+       style="fill:none;stroke:#000000;stroke-width:1;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" />
    <rect
-       style="fill:none;fill-opacity:1;stroke:#000000;stroke-width:1;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0"
+       style="fill:none;stroke:#000000;stroke-width:1;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0"
       id="rect5798"
       width="13.287388"
       height="53.14962"
       x="535.92511"
       y="232.97237" />
    <rect
-       style="fill:none;fill-opacity:1;stroke:#000000;stroke-width:1;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0"
+       style="fill:none;stroke:#000000;stroke-width:1;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0"
       id="rect6253"
       width="13.287388"
       height="53.14962"
@@ -195,14 +195,14 @@
       xml:space="preserve"
       style="font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
       x="516.43695"
-       y="220.57082"
+       y="218.79913"
       id="text5986"
       sodipodi:linespacing="125%"><tspan
         sodipodi:role="line"
         x="516.43695"
-         y="220.57082"
+         y="218.79913"
         style="font-size:6px;text-align:center;text-anchor:middle"
-         id="tspan4215">Head</tspan></text>
+         id="tspan4215">Read pointer</tspan></text>
    <text
       xml:space="preserve"
       style="font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
@@ -469,7 +469,7 @@
       height="17.716564"
       width="26.57486"
       id="rect4408"
-       style="fill:none;fill-opacity:1;stroke:#000000;stroke-width:1;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" />
+       style="fill:none;stroke:#000000;stroke-width:1;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" />
    <text
       sodipodi:linespacing="125%"
       id="text4431"
@@ -481,7 +481,7 @@
         y="319.78339"
         x="381.07394"
         sodipodi:role="line"
-         id="tspan4825">TFLR</tspan></text>
+         id="tspan4825">TVLR</tspan></text>
    <path
       style="fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-end:url(#TriangleOutM)"
       d="m 456.20079,271.06292 0,50.49213 7.97244,0"
@@ -547,7 +547,7 @@
         id="tspan4872"
         x="519.19116"
         y="309.15347"
-         style="font-size:6px;text-align:center;text-anchor:middle">TFMR</tspan></text>
+         style="font-size:6px;text-align:center;text-anchor:middle">TBMR</tspan></text>
    <text
       sodipodi:linespacing="125%"
       id="text4874"
@@ -559,7 +559,7 @@
         y="316.24008"
         x="519.19116"
         id="tspan4876"
-         sodipodi:role="line">TFCYR</tspan></text>
+         sodipodi:role="line">TBCYR</tspan></text>
    <text
       xml:space="preserve"
       style="font-size:40px;font-style:normal;font-weight:normal;line-height:125%;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans"
@@ -571,7 +571,7 @@
         id="tspan4880"
         x="519.19116"
         y="324.21252"
-         style="font-size:6px;text-align:center;text-anchor:middle">TFTLR</tspan></text>
+         style="font-size:6px;text-align:center;text-anchor:middle">TBTLR</tspan></text>
    <text
       sodipodi:linespacing="125%"
       id="text4882"
@@ -583,7 +583,7 @@
         y="332.18497"
         x="519.19116"
         id="tspan4884"
-         sodipodi:role="line">TFTHR</tspan></text>
+         sodipodi:role="line">TBTHR</tspan></text>
    <path
       inkscape:connector-curvature="0"
       id="path4890"
@@ -601,6 +601,6 @@
         sodipodi:role="line"
         x="381.07394"
         y="328.64166"
-         style="font-size:6px;text-align:center;text-anchor:middle">TFHR</tspan></text>
+         style="font-size:6px;text-align:center;text-anchor:middle">TVHR</tspan></text>
  </g>
 </svg>
--- a/doc/userguide/fig/timetag-buf-mech.svg
+++ b/doc/userguide/fig/timetag-buf-mech.svg
--- a/doc/userguide/multiboot-regs.tex
+++ b/doc/userguide/multiboot-regs.tex
@@ -6,7 +6,7 @@ Base address: 0x040
 \rowcolors{2}{white}{gray!25}
 \begin{longtable}{l l l p{.5\textwidth}}
 \hline
-\textbf{Offset} & \textbf{Default} & \textbf{Name} 
+\textbf{Offset} & \textbf{Reset} & \textbf{Name} 
 		& \textbf{Description} \\
 \hline
 \endfirsthead

--- a/doc/userguide/userguide-conv-ttl-blo.tex
+++ b/doc/userguide/userguide-conv-ttl-blo.tex