Skip to content

C
Conv TTL RS485
Commit 47ecbadb authored by Theodor-Adrian Stana's avatar Theodor-Adrian Stana
Browse files
Options

doc: Started updating user guide

parent b890e61b
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 108719 additions and 58211 deletions
doc/ug/cern-title.tex
View file @ 47ecbadb
......@@ -9,7 +9,7 @@
\noindent \rule{\textwidth}{.1cm}
\hfill August 12, 2014
\hfill January 22, 2015
\vspace*{3cm}
......
doc/ug/fig/front-panel.svg
View file @ 47ecbadb
This diff is collapsed.
doc/ug/fig/invttl-chan.svg
View file @ 47ecbadb
This diff is collapsed.
doc/ug/fig/oterm.svg 0 → 100644
View file @ 47ecbadb
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
width="120.75002"
height="60.750004"
id="svg150366"
version="1.1"
inkscape:version="0.48.3.1 r9886"
sodipodi:docname="oterm.svg">
<defs
id="defs150368">
<marker
inkscape:stockid="TriangleOutM"
orient="auto"
refY="0"
refX="0"
id="TriangleOutM"
style="overflow:visible">
<path
id="path151109"
d="m 5.77,0 -8.65,5 0,-10 8.65,5 z"
style="fill-rule:evenodd;stroke:#000000;stroke-width:1pt"
transform="scale(0.4,0.4)"
inkscape:connector-curvature="0" />
</marker>
<marker
inkscape:stockid="DiamondLstart"
orient="auto"
refY="0"
refX="0"
id="DiamondLstart"
style="overflow:visible">
<path
id="path151052"
d="M 0,-7.0710768 -7.0710894,0 0,7.0710589 7.0710462,0 0,-7.0710768 z"
style="fill-rule:evenodd;stroke:#000000;stroke-width:1pt"
transform="matrix(0.8,0,0,0.8,5.6,0)"
inkscape:connector-curvature="0" />
</marker>
<marker
inkscape:stockid="TriangleInS"
orient="auto"
refY="0"
refX="0"
id="TriangleInS"
style="overflow:visible">
<path
id="path151103"
d="m 5.77,0 -8.65,5 0,-10 8.65,5 z"
style="fill-rule:evenodd;stroke:#000000;stroke-width:1pt"
transform="scale(-0.2,-0.2)"
inkscape:connector-curvature="0" />
</marker>
<marker
inkscape:stockid="TriangleOutS"
orient="auto"
refY="0"
refX="0"
id="TriangleOutS"
style="overflow:visible">
<path
id="path151112"
d="m 5.77,0 -8.65,5 0,-10 8.65,5 z"
style="fill-rule:evenodd;stroke:#000000;stroke-width:1pt"
transform="scale(0.2,0.2)"
inkscape:connector-curvature="0" />
</marker>
</defs>
<sodipodi:namedview
id="base"
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1.0"
inkscape:pageopacity="0.0"
inkscape:pageshadow="2"
inkscape:zoom="3.959798"
inkscape:cx="24.985403"
inkscape:cy="40.656933"
inkscape:document-units="px"
inkscape:current-layer="g3911"
showgrid="true"
inkscape:window-width="1855"
inkscape:window-height="1176"
inkscape:window-x="65"
inkscape:window-y="24"
inkscape:window-maximized="1"
fit-margin-top="0"
fit-margin-left="0"
fit-margin-right="0"
fit-margin-bottom="0">
<inkscape:grid
type="xygrid"
id="grid150374"
empspacing="5"
visible="true"
enabled="true"
snapvisiblegridlinesonly="true"
spacingx="0.5px"
spacingy="0.5px"
originx="-159.75px"
originy="-869.75px" />
</sodipodi:namedview>
<metadata
id="metadata150371">
<rdf:RDF>
<cc:Work
rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title></dc:title>
</cc:Work>
</rdf:RDF>
</metadata>
<g
inkscape:label="Layer 1"
inkscape:groupmode="layer"
id="layer1"
transform="translate(-159.75,-121.86218)">
<g
style="stroke-width:0.36447069;stroke-miterlimit:4;stroke-dasharray:none"
id="g3911"
transform="matrix(0,2.7304638,-2.75701,0,829.30087,-12.47056)">
<path
inkscape:connector-curvature="0"
id="path3883"
d="m 60.368038,233.69551 -5.493572,9.0678 10.723508,0 z"
style="fill:none;stroke:#000000;stroke-width:0.18223535;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none"
sodipodi:nodetypes="cccc" />
<path
sodipodi:type="arc"
style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.43805501;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0"
id="path3885"
sodipodi:cx="42.519684"
sodipodi:cy="223.22832"
sodipodi:rx="2.6156552"
sodipodi:ry="2.6156552"
d="m 45.135339,223.22832 c 0,1.44458 -1.171069,2.61565 -2.615655,2.61565 -1.444587,0 -2.615655,-1.17107 -2.615655,-2.61565 0,-1.44459 1.171068,-2.61566 2.615655,-2.61566 1.444586,0 2.615655,1.17107 2.615655,2.61566 z"
transform="matrix(0.4160102,0,0,0.4160102,45.598746,143.36924)" />
<path
style="fill:none;stroke:#000000;stroke-width:0.18223535;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none"
d="m 64.03042,218.46161 7.324763,0 -10e-7,-2.17626 -7.324763,0 1e-6,2.17626"
id="path150411"
inkscape:connector-curvature="0"
sodipodi:nodetypes="ccccc" />
<text
xml:space="preserve"
style="font-size:14.57882786px;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="-215.51186"
y="68.823997"
id="text150940"
sodipodi:linespacing="125%"
transform="matrix(0,-0.99517401,1.0048494,0,0,0)"><tspan
sodipodi:role="line"
id="tspan150942"
x="-215.51186"
y="68.823997"
style="font-size:3.64470696px">100R</tspan></text>
<path
style="fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
d="m 174,145.36218 16,0 0,-23 90,0"
id="path150946"
inkscape:connector-curvature="0"
transform="matrix(0,-0.36271178,0.36623815,0,4.5671948,300.79719)" />
<path
style="fill:none;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none"
d="m 222.5,137.36218 0,5"
id="path151799"
inkscape:connector-curvature="0"
transform="matrix(0,-0.36271178,0.36623815,0,4.5671948,300.79719)" />
<path
style="fill:none;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none"
d="m 230,147.36218 0,-5.5 -5.00001,0 0,-4 5,0 0,-5.5"
id="path151803"
inkscape:connector-curvature="0"
transform="matrix(0,-0.36271178,0.36623815,0,4.5671948,300.79719)"
sodipodi:nodetypes="cccccc" />
<path
style="fill:none;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none"
d="m 224.99999,139.86218 5.00001,0 0,2"
id="path151805"
inkscape:connector-curvature="0"
transform="matrix(0,-0.36271178,0.36623815,0,4.5671948,300.79719)"
sodipodi:nodetypes="ccc" />
<path
style="fill:none;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;marker-mid:url(#TriangleOutM)"
d="m 230,139.86218 -2.50001,0 -2.5,0"
id="path151809"
inkscape:connector-curvature="0"
transform="matrix(0,-0.36271178,0.36623815,0,4.5671948,300.79719)"
sodipodi:nodetypes="ccc" />
</g>
</g>
</svg>
doc/ug/fig/rear-panel.svg
View file @ 47ecbadb
......@@ -11,7 +11,7 @@
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
version="1.1"
width="339.0531"
height="922.875"
height="301.3692"
id="svg5146"
inkscape:version="0.48.3.1 r9886"
sodipodi:docname="rear-panel.svg">
......@@ -28,9 +28,9 @@
inkscape:window-height="1176"
id="namedview37"
showgrid="false"
inkscape:zoom="1.3244222"
inkscape:cx="242.15612"
inkscape:cy="565.93089"
inkscape:zoom="1.8730158"
inkscape:cx="201.32651"
inkscape:cy="128.13466"
inkscape:window-x="65"
inkscape:window-y="24"
inkscape:window-maximized="1"
......@@ -54,6 +54,18 @@
ry="0"
transform="scale(1,-1)" />
</clipPath>
<clipPath
clipPathUnits="userSpaceOnUse"
id="clipPath150362">
<rect
style="fill:none"
id="rect150364"
width="115.37107"
height="242.43867"
x="391.69601"
y="-1029.5023"
transform="scale(1,-1)" />
</clipPath>
</defs>
<metadata
id="metadata5151">
......@@ -71,7 +83,7 @@
xml:space="preserve"
id="flowRoot3116"
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"
transform="translate(-146.13311,47.742608)"><flowRegion
transform="translate(-146.13311,47.742558)"><flowRegion
id="flowRegion3118"><rect
id="rect3120"
width="956.74579"
......@@ -81,35 +93,35 @@
id="flowPara3122" /></flowRoot> <text
sodipodi:linespacing="125%"
id="text3185"
y="143.03442"
y="143.03438"
x="264.60974"
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"
xml:space="preserve"><tspan
style="font-size:16px;font-weight:bold;text-align:start;text-anchor:start"
y="143.03442"
y="143.03438"
x="264.60974"
sodipodi:role="line"
id="tspan3193">INPUT</tspan><tspan
style="font-size:12px;font-weight:normal;text-align:start;text-anchor:start"
y="159.04742"
y="159.04738"
x="264.60974"
sodipodi:role="line"
id="tspan181707">RS-485 level</tspan></text>
<text
sodipodi:linespacing="125%"
id="text3195"
y="91.789352"
y="91.789299"
x="100.4813"
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"
xml:space="preserve"><tspan
style="font-size:16px;font-weight:bold;text-align:end;text-anchor:end"
id="tspan3199"
y="91.789352"
y="91.789299"
x="100.4813"
sodipodi:role="line">Pulse LED</tspan></text>
<path
style="fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
d="m 103.36663,85.589508 45.6803,0 21.89634,24.347942"
d="m 103.36663,85.589458 45.6803,0 21.89634,24.347942"
id="path181711"
inkscape:connector-curvature="0"
sodipodi:nodetypes="ccc" />
......@@ -117,28 +129,29 @@
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="-0.796875"
y="171.85573"
y="171.85568"
id="text181713"
sodipodi:linespacing="125%"><tspan
id="tspan181715"
sodipodi:role="line"
x="-0.796875"
y="171.85573"
y="171.85568"
style="font-size:16px;font-weight:bold;text-align:start;text-anchor:start">OUTPUTS</tspan><tspan
id="tspan181717"
sodipodi:role="line"
x="-0.796875"
y="187.86873"
y="187.86868"
style="font-size:12px;font-weight:normal;text-align:start;text-anchor:start">RS-485 level</tspan></text>
<path
style="fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
d="M 131.97464,147.44571 86.21196,166.78396"
d="M 131.97464,147.44566 86.21196,166.78391"
id="path181719"
inkscape:connector-curvature="0"
sodipodi:nodetypes="cc" />
<g
transform="matrix(1.25,0,0,-1.25,-373.34289,1285.1988)"
id="g96946">
id="g96946"
clip-path="url(#clipPath150362)">
<g
transform="translate(495.48,355.439)"
id="g32658">
......@@ -91527,6 +91540,6 @@
sodipodi:nodetypes="cc"
inkscape:connector-curvature="0"
id="path178342"
d="M 132.64201,193.76739 86.21196,166.55414"
d="M 132.64201,193.76734 86.21196,166.55409"
style="fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" />
</svg>
doc/ug/ug-conv-ttl-rs485.tex
View file @ 47ecbadb
......@@ -46,11 +46,26 @@
\include{cern-title}
%------------------------------------------------------------------------------
% Revision history
% Licensing info
%------------------------------------------------------------------------------
\pagebreak
\addcontentsline{toc}{section}{Revision history}
\thispagestyle{empty}
\addcontentsline{toc}{section}{Licensing information}
\section*{Licensing information}
\noindent
This document is licensed under a Creative Commons Attribution-ShareAlike 4.0
International License. If you have not received a copy of the license along with this
work, see \\
\url{http://creativecommons.org/licenses/by-sa/4.0/}
%------------------------------------------------------------------------------
% Revision history
%------------------------------------------------------------------------------
\section*{Revision history}
\addcontentsline{toc}{section}{Revision history}
\centerline
{
......@@ -63,6 +78,7 @@
12-08-2014 & 1.0 & First release, after small error corrections (\textit{writereg} instead of \textit{readreg}
in Section~\ref{sec:diag-remote-reset}, and typo in Section~\ref{sec:reprog-bitstreams}), and
addition of how to read gateware version in Section~\ref{sec:reprog-bitstreams} \\
22-01-2015 & 1.1 & \textcolor{red}{\textbf{WHAT?}} \\
\hline
\end{tabular}
}
......@@ -120,27 +136,27 @@ pulses, or for timing distribution. The main features of the board are:
\item RS-485 to TTL-BAR
\item RS-485 to RS-485
\end{itemize}
\item Four general-purpose inverter channels
\begin{itemize}
\item TTL to TTL-BAR
\item TTL-BAR to TTL
\end{itemize}
\item Four general-purpose inverter channels, for conversion from TTL to TTL-BAR and viceversa
\item Each TTL and inverter channel has 50~$\Omega$ input termination
\item Each TTL and inverter channel capable of driving 50~$\Omega$ load
\item Each RS-485 channel capable of driving up to 256 nodes
\item Each RS-485 channel contains lack of signal detection logic
\item SFP connector
\item Diagnostics
\begin{itemize}
\item converter board ID
\item gateware version
\item state of on-board switches and RTM detection lines
\item line state at board input
\item input pulse counters
\item input pulse time-stamping with dedicated per-channel latest timestamp
readout
\item manual pulse triggering
\item remotely reset the FPGA logic
\end{itemize}
\item Remote reprogramming over I$^2$C lines on VME P1 connector
\item Status LEDs
\item Pulse LEDs for each replication channel
\item SFP connector
\end{itemize}
Pulse conversion is obtained by combining the CONV-TTL-RS485 front module (FM) board
......@@ -192,7 +208,7 @@ It consists of several ports and status LEDs, which are detailed in the followin
subsections.
\begin{figure}
\centerline{\includegraphics[scale=.75]{fig/front-panel}}
\centerline{\includegraphics[scale=.85]{fig/front-panel}}
\caption{Front panel}
\label{fig:fp}
\end{figure}
......@@ -209,25 +225,28 @@ LEDs are \textit{off}.
\centerline
{
\rowcolors{2}{white}{gray!25}
\begin{tabular}{l p{.75\textwidth}}
\begin{tabular}{l p{.9\textwidth}}
\hline
\multicolumn{1}{c}{\textbf{LED}} & \multicolumn{1}{c}{\textbf{Description}} \\
\hline
\textit{PW} & Power LED \newline
-- \textbf{Green} when a valid CONV-TTL-RS485 gateware is loaded
to the FPGA \\
-- \textbf{Green} when a valid CONV-TTL-RS485 gateware is loaded to the FPGA \\
\textit{ERR} & Error LED \newline
-- \textbf{Red} when a system error occured (see Section~\ref{sec:diag-syserr}) \newline
-- \textbf{Off} otherwise \\
-- \textbf{Red} when a system error occured (see Section~\ref{sec:diag-syserr}) \\
\textit{I2C} & I$^2$C status LED \newline
-- \textbf{Flashes green} when an I$^2$C transfer takes places \\
\textit{GF} & Glitch filter state \newline
-- \textbf{Green} when the pulse channel glitch filters are enabled \\
\textit{ITERM} & State of input terminations (Section~\ref{sec:rp})\newline
-- \textbf{Green} when the channel input terminations are enabled via the
on-board enable switch (see Section~\ref{sec:switches})\\
\textit{OTERM} & State of output terminations (Section~\ref{sec:rp})\newline
-- \textbf{Green} when the channel output terminations are enabled via the
on-board enable switch (see Section~\ref{sec:switches})\\
\textit{TTL} & TTL status LED \newline
-- \textbf{Green} when TTL logic is selected via the on-board selection switch \newline
-- \textbf{Green} when TTL logic is selected via the on-board selection switch
(see Section~\ref{sec:switches})\newline
-- \textbf{Off} when TTL-BAR logic is selected. \\
\textit{I2C} & I$^2$C status LED \newline
-- \textbf{Flashes green} when an I$^2$C transfer takes places \newline
-- \textbf{Off} otherwise \\
\textit{MULTICAST} & Multicast switch status LEDs \newline
-- \textbf{Green} when the corresponding multicast switch is ON \newline
-- \textbf{Off} otherwise \\
\hline
\end{tabular}
}
......@@ -241,11 +260,12 @@ outputs can be either TTL or TTL-BAR, as selected by the TTL switch (SW2.4, see
Section~\ref{sec:pulse-ttl-vs-ttlbar}).
A simplified diagram of pulse repetition is shown in Figure~\ref{fig:ttl-chan},
more details can be found in Section~\ref{sec:pulse-rep}. If a TTL (TTL-BAR) pulse arrives
on a channel input, it is regenerated on the output of the same channel in TTL (TTL-BAR),
as well as the RS-485 outputs of the same channel on the rear panel, if an RTM
board with an attached RS-485 piggyback is present. Similarly, if an RS-485 pulse arrives
on the rear panel, it is replicated on the TTL output channel.
more details can be found in Section~\ref{sec:pulse-rep}.
If a TTL (TTL-BAR) pulse arrives on a channel input, it is regenerated on the output of
the same channel in TTL (TTL-BAR), as well as the RS-485 outputs of the same channel on the
rear panel, if an RTM board with an attached RS-485 piggyback is present. Similarly, if an
RS-485 pulse arrives on the rear panel, it is replicated on the TTL output channel.
Each TTL replication channel has a pulse LED which flashes shortly whenever a pulse is replicated
on the channel.
......@@ -254,7 +274,7 @@ All TTL input channels are terminated with 50$\Omega$ resistors; TTL output chan
not terminated.
\begin{figure}[h]
\centerline{\includegraphics[width=.8\textwidth]{fig/ttl-chan}}
\centerline{\includegraphics[width=.5\textwidth]{fig/ttl-chan}}
\caption{Pulse repetition on front panel}
\label{fig:ttl-chan}
\end{figure}
......@@ -267,11 +287,14 @@ No regeneration is performed on the input signal, nor is it in any way connected
on the RTM. The input signal is simply passed through an inverter and the FPGA, and presented at the
channel output.
Each INV-TTL channel has one LED which flashes shortly on every falling edge of the input
signal.
All general-purpose inputs are terminated with 50$\Omega$ resistors; the outputs are not
terminated.
\begin{figure}[h]
\centerline{\includegraphics[width=.6\textwidth]{fig/invttl-chan}}
\centerline{\includegraphics[width=.4\textwidth]{fig/invttl-chan}}
\caption{TTL general-purpose inverter channel}
\label{fig:invttl-chan}
\end{figure}
......@@ -280,6 +303,7 @@ terminated.
% SUBSEC: Rear panel
%--------------------------------------------------------------------------------------
\subsection{Rear panel}
\label{sec:rp}
The rear panel on CONV-TTL-RTM-RS485 boards is shown in Figure~\ref{fig:rear-panel}. It contains the
input and output connectors, as well as pulse status LEDs for the six RS-485 pulse channels. An RS-485
......@@ -287,16 +311,28 @@ pulse at the input connector of a channel is passed through the FPGA and regener
of the same channel in RS-485 level, as well as in TTL level at the output connector of the corresponding
TTL channel on the front panel.
Each RS-485 output on a channel has its dedicated transceiver capable of driving 256 nodes.
When a pulse is repeated on the output connector of a channel, the pulse status LED flashes briefly.
\begin{figure}[htbp]
\centerline{\includegraphics[scale=.75]{fig/rear-panel}}
\begin{figure}[h]
\centerline{\includegraphics[scale=.83]{fig/rear-panel}}
\caption{Rear panel}
\label{fig:rear-panel}
\end{figure}
Each RS-485 output on a channel has its dedicated transceiver capable of driving 256 nodes. Additionally,
each input and output channel has a selectable 100~$\Omega$ termination, which can be enabled by the
input and output termination switches (see Section~\ref{sec:switches}). Setting the input or output
termination enable switch to the ON position enables a connection via a solid-state relay, which in turns
enables the termination connection as shown in Figures~\ref{fig:iterm}~and~\ref{fig:oterm}.
Finally, when a pulse is repeated on the output connector of a channel, the pulse status LED flashes briefly.
\begin{figure}[h]
% \centerline{\includegraphics[width=.6\textwidth]{fig/iterm}}
% \caption{\label{fig:iterm} Input termination enable}
\centerline{\includegraphics[width=.6\textwidth]{fig/oterm}}
\caption{\label{fig:iterm} Output termination enable}
\end{figure}
%======================================================================================
% SEC: Switches
%======================================================================================
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment