doc: More work on user guide

3a4209b4 · Theodor-Adrian Stana · 389e5fce · 3a4209b4 · 3a4209b4 · 3a4209b4
Commit 3a4209b4 authored Jan 22, 2015 by Theodor-Adrian Stana
Showing with 245 additions and 73561 deletions

switches.svg doc/ug/fig/switches.svg +160 -73534

ttl-vs-ttlbar.svg doc/ug/fig/ttl-vs-ttlbar.svg +66 -4

ug-conv-ttl-rs485.tex doc/ug/ug-conv-ttl-rs485.tex +19 -23

No files found.
--- a/doc/ug/fig/switches.svg
+++ b/doc/ug/fig/switches.svg
--- a/doc/ug/fig/ttl-vs-ttlbar.svg
+++ b/doc/ug/fig/ttl-vs-ttlbar.svg
@@ -10,7 +10,7 @@
   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
   width="328.25592"
-   height="139.01797"
+   height="230.94185"
   id="svg2"
   version="1.1"
   inkscape:version="0.48.3.1 r9886"
@@ -24,9 +24,9 @@
     borderopacity="1.0"
     inkscape:pageopacity="0.0"
     inkscape:pageshadow="2"
-     inkscape:zoom="2.8"
-     inkscape:cx="194.9332"
-     inkscape:cy="0.025139333"
+     inkscape:zoom="1.979899"
+     inkscape:cx="227.12621"
+     inkscape:cy="105.85782"
     inkscape:document-units="px"
     inkscape:current-layer="layer1"
     showgrid="true"
@@ -145,5 +145,67 @@
           style="fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" />
      </g>
    </g>
+    <text
+       xml:space="preserve"
+       style="font-size:10px;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="-15.391184"
+       y="349.30267"
+       id="text2998"
+       sodipodi:linespacing="125%"><tspan
+         sodipodi:role="line"
+         id="tspan3000"
+         x="-15.391184"
+         y="349.30267"
+         style="font-size:16px;font-weight:bold">RS-485</tspan></text>
+    <g
+       id="g3794">
+      <g
+         id="g3004"
+         transform="matrix(1,0,0,-1,16.172919,432.70831)"
+         style="fill:none">
+        <path
+           style="fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+           d="m 168.30709,53.447583 c -5.31496,5.016962 3.54331,8.560269 0,13.87523"
+           id="path3006"
+           inkscape:connector-curvature="0"
+           sodipodi:nodetypes="cc" />
+        <path
+           sodipodi:nodetypes="cc"
+           inkscape:connector-curvature="0"
+           id="path3008"
+           d="m 171.85039,53.447583 c -5.31496,5.016962 3.54331,8.560269 0,13.87523"
+           style="fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" />
+      </g>
+      <path
+         style="fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+         d="m 67.550868,372.17412 35.433072,0 0,-35.43307 0,-17.71654 35.43307,0 0,53.14961 45.52728,0"
+         id="path3010"
+         inkscape:connector-curvature="0"
+         sodipodi:nodetypes="ccccccc" />
+      <path
+         style="fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+         d="m 187.4876,372.17412 39.51209,0 0,-53.14961 26.5748,0 0,53.14961 53.14961,0"
+         id="path3012"
+         inkscape:connector-curvature="0"
+         sodipodi:nodetypes="cccccc" />
+    </g>
+    <path
+       style="fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:3, 3;stroke-dashoffset:0"
+       d="m 64.917815,345.59932 241.747705,0"
+       id="path3014"
+       inkscape:connector-curvature="0"
+       sodipodi:nodetypes="cc" />
+    <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"
+       x="66.111046"
+       y="342.83685"
+       id="text3801"
+       sodipodi:linespacing="125%"><tspan
+         sodipodi:role="line"
+         id="tspan3803"
+         x="66.111046"
+         y="342.83685"
+         style="font-size:10px">0V</tspan></text>
  </g>
 </svg>
--- a/doc/ug/ug-conv-ttl-rs485.tex
+++ b/doc/ug/ug-conv-ttl-rs485.tex
@@ -346,10 +346,8 @@ There are twelve switches provided on-board the CONV-TTL-RS485. Eight of these s
 are general-purpose, and four of them are dedicated multicast switches, for selecting the
 board's multicast address.

-Figure~\ref{fig:switches} shows the switches. Table~\ref{tbl:switches} lists the used
-general-purpose switches.
-
-Note that both switches in Table~\ref{tbl:switches} are board-wide switches; selecting
+Figure~\ref{fig:switches} shows the switches and Table~\ref{tbl:switches} lists the used ones.
+Note that all switches in Table~\ref{tbl:switches} are board-wide switches; selecting
 one position or the other yields a selection valid for all six pulse replication channels.

 \begin{figure}[h]
@@ -371,6 +369,12 @@ one position or the other yields a selection valid for all six pulse replication
    SW1.1 & Glitch filter enable (see Section~\ref{sec:pulse-rep}) \newline
            \textbf{ON} -- glitch filter enabled, output jitter present \newline
            \textbf{OFF} -- glitch filter disabled, no output jitter \textbf{(default)} \\
+    SW1.2 & Input termination enable (see Section~\ref{sec:rp}) \newline
+            \textbf{ON} -- input terminations for all channels are turned on \newline
+            \textbf{OFF} --  input terminations for all channels are turned off \\
+    SW1.3 & Output termination enable (see Section~\ref{sec:rp}) \newline
+            \textbf{ON} -- output terminations for all channels are turned on \newline
+            \textbf{OFF} --  output terminations for all channels are turned off \\
    SW2.4 & TTL/TTL-BAR selection switch (see Section~\ref{sec:pulse-ttl-vs-ttlbar}) \newline
            \textbf{ON} -- TTL channels receive and generate TTL \textbf{(default)} \newline
            \textbf{OFF} -- TTL channels receive and generate TTL-BAR \\
@@ -379,10 +383,15 @@ one position or the other yields a selection valid for all six pulse replication
  }
 \end{table}

+\pagebreak
+General-purpose switches not listed in Table~\ref{tbl:switches} (GP\_1 through GP\_4)
+perform no particular function, but their setting is reflected in the status register
+(SR -- see Appendix~\ref{app:conv-regs-sr}).
+
 The multicast switches shown in Figure~\ref{fig:switches} can be used to select a
 multicast address for the board. At the moment, no particular functionality is defined
-in this respect, but setting a switch to ON also lights the corresponding front-panel
-multicast bicolor LED.
+in this respect, but setting a switch to ON is reflected in the Other Switches
+Register~(OSWR -- see Appendix~\ref{app:conv-regs-mwsr}).

 The status of all on-board switches can be read from status registers; for more information
 see Section~\ref{sec:diag-sw-rtmdet}.
@@ -420,7 +429,7 @@ The two signal types that may be replicated on the front panel are TTL or TTL-BA
 Figure~\ref{fig:pulse-ttl-vs-ttlbar} shows, TTL-BAR is an inverted version of TTL.

 Selection between these two signal types is done by means of the TTL selection switch,
-SW2.4 (Figure~\ref{fig:switches-ttl}). The TTL selection switch is valid board-wide,
+SW2.4 (Figure~\ref{fig:switches}). The TTL selection switch is valid board-wide,
 i.e., if it is set for TTL inputs (\textbf{ON}), TTL signals should be input on all TTL channels.

 \begin{figure}[hbtp]
@@ -429,16 +438,9 @@ i.e., if it is set for TTL inputs (\textbf{ON}), TTL signals should be input on
  \label{fig:pulse-ttl-vs-ttlbar}
 \end{figure}

-\begin{figure}[hbtp]
-  \centerline{\includegraphics[width=.9\textwidth]{fig/switches-ttl}}
-  \caption{TTL/TTL-BAR selection switch}
-  \label{fig:switches-ttl}
-\end{figure}
-
 %--------------------------------------------------------------------------------------
 % SUBSEC: Rep details
 %--------------------------------------------------------------------------------------
-\pagebreak
 \subsection{Pulse replication mechanism}
 \label{sec:pulse-rep}

@@ -472,21 +474,15 @@ At reset or board power-up, during the time that the \textit{no signal detect} b
 the 100~${\mu}s$ until disabling the line with no signal on it, a pulse will be generated
 due to the high state of the line. For this reason, the \textit{first pulse inhibit} block has
 been implemented, which keeps the line disabled for an extra 100~${\mu}s$ after reset. Note
-that the block is only active for 100~${\mu}s$ after reset, no pulses will be rejected in the
-occasion of the cable being removed. \textbf{It is for this reason that a pulse will be generated
+that the block is only active for 100~${\mu}s$ after reset, no pulses will be rejected should the
+cable be removed. \textbf{It is for this reason that a pulse will be generated
 whenever the cable is removed when the board is in TTL-BAR repetition mode.}

 A glitch filter may be optionally selected by means of the glitch filter switch. The glitch
-filter is enabled by the \textit{glitch filter} general-purpose switch~\ref{fig:switches-gf}.
+filter is enabled by the \textit{glitch filter} general-purpose switch~\ref{fig:switches}.
 The glitch filter ignores signals with a width shorter than 50~ns, but also introduces
 a 50~ns jitter on the leading edge, due to the fact it is sampling the line with a 20~MHz clock.

-\begin{figure}[htbp]
-  \centerline{\includegraphics[width=.9\textwidth]{fig/switches-gf}}
-  \caption{Glitch filter enable switch}
-  \label{fig:switches-gf}
-\end{figure}
-
 %======================================================================================
 % SEC: Communicating to the CONV-TTL-RS485
 %======================================================================================