Commit c98b7e63 authored by Theodor-Adrian Stana's avatar Theodor-Adrian Stana

doc: Updated gw-test-procedure from master

parent d488b60c
...@@ -9,7 +9,7 @@ ...@@ -9,7 +9,7 @@
\noindent \rule{\textwidth}{.1cm} \noindent \rule{\textwidth}{.1cm}
\hfill April 25, 2014 \hfill May 2, 2014
\vspace*{3cm} \vspace*{3cm}
......
This source diff could not be displayed because it is too large. You can view the blob instead.
@misc{coding-guidelines,
author = "Patrick Loschmidt and Nata{\v s}a Simani\'c and C\'esar Prados and Pablo Alvarez and Javier Serrano",
title = {{Guidelines for VHDL Coding}},
month = 04,
year = 2011,
note = {\url{http://www.ohwr.org/documents/24}}
}
@misc{ctb-proj, @misc{ctb-proj,
title = {{Conv TTL Blocking Project Page on OHWR}}, title = {{Conv TTL Blocking Project Page on OHWR}},
howpublished = {\url{http://www.ohwr.org/projects/conv-ttl-blo}} howpublished = {\url{http://www.ohwr.org/projects/conv-ttl-blo}}
} }
@misc{ctb-repo,
title = {{Conv TTL Blocking Repository on OHWR}},
howpublished = {\url{http://www.ohwr.org/projects/conv-ttl-blo/repository}}
}
...@@ -61,6 +61,7 @@ ...@@ -61,6 +61,7 @@
\multicolumn{1}{c}{\textbf{Date}} & \multicolumn{1}{c}{\textbf{Version}} & \multicolumn{1}{c}{\textbf{Change}} \\ \multicolumn{1}{c}{\textbf{Date}} & \multicolumn{1}{c}{\textbf{Version}} & \multicolumn{1}{c}{\textbf{Change}} \\
\hline \hline
25-04-2014 & 0.1 & First draft \\ 25-04-2014 & 0.1 & First draft \\
02-05-2014 & 1.0 & First version, corrected and added some wording and added Figure~\ref{fig:switches} \\
\hline \hline
\end{tabular} \end{tabular}
} }
...@@ -76,15 +77,6 @@ ...@@ -76,15 +77,6 @@
%\listoffigures %\listoffigures
%\listoftables %\listoftables
%------------------------------------------------------------------------------
% List of abbreviations
%------------------------------------------------------------------------------
\pagebreak
\section*{List of Abbreviations}
\begin{tabular}{l l}
DUT & Device Under Test \\
\end{tabular}
\pagebreak \pagebreak
\pagenumbering{arabic} \pagenumbering{arabic}
\setcounter{page}{1} \setcounter{page}{1}
...@@ -143,7 +135,7 @@ sequence}. ...@@ -143,7 +135,7 @@ sequence}.
\begin{itemize} \begin{itemize}
\item \textbf{1x} Two-slot ELMA crate \item \textbf{1x} Two-slot ELMA crate
\item \textbf{1x} CONV-TTL-BLO \item \textbf{1x} CONV-TTL-BLO device under test (DUT)
% \begin{itemize} % \begin{itemize}
% \item \textbf{1x} DUT with gateware to be tested for release % \item \textbf{1x} DUT with gateware to be tested for release
% \item \textbf{1x} with \textit{pulsetest} gateware programmed into its % \item \textbf{1x} with \textit{pulsetest} gateware programmed into its
...@@ -152,8 +144,8 @@ sequence}. ...@@ -152,8 +144,8 @@ sequence}.
\item \textbf{1x} CONV-TTL-BLO-RTM \item \textbf{1x} CONV-TTL-BLO-RTM
\item \textbf{1x} Pulse generator \item \textbf{1x} Pulse generator
\item \textbf{1x} Oscilloscope \item \textbf{1x} Oscilloscope
\item \textbf{5x} Long LEMO cables \item \textbf{5x} Long LEMO cables (1~m or more)
\item \textbf{3x} Short LEMO cables \item \textbf{3x} Short LEMO cables (12~cm bridge cable or equivalent)
\item \textbf{4x} BNC M / LEMO F adapters \item \textbf{4x} BNC M / LEMO F adapters
\item \textbf{4x} LEMO "Y" splitter plug \item \textbf{4x} LEMO "Y" splitter plug
\item \textbf{2x} LEMO 50~$\Omega$ terminations \item \textbf{2x} LEMO 50~$\Omega$ terminations
...@@ -231,6 +223,28 @@ it is not necessary to trigger on the external channel. ...@@ -231,6 +223,28 @@ it is not necessary to trigger on the external channel.
\end{itemize} \end{itemize}
\end{itemize} \end{itemize}
%==============================================================================
\subsection{Test scripts}
\label{sec:prep-test-scripts}
%==============================================================================
Some test scripts will need to be run across this test procedure. These
test scripts can be found in the \textit{software/} folder of the CONV-TTL-BLO
\textit{git} repository~\cite{ctb-repo}. One way to obtain this repository is
by running the following command in a Linux command line:
\begin{small}
\begin{center}
\verb+git clone --depth=1 git://ohwr.org/level-conversion/conv-ttl-blo.git+
\end{center}
\end{small}
\begin{figure}
\centerline{\includegraphics[width=.7\textwidth]{fig/switches}}
\caption{On-board switches}
\label{fig:switches}
\end{figure}
%============================================================================== %==============================================================================
% SEC: Test procedure % SEC: Test procedure
%============================================================================== %==============================================================================
...@@ -260,8 +274,9 @@ and follow the steps one by one, ticking on completion. ...@@ -260,8 +274,9 @@ and follow the steps one by one, ticking on completion.
\label{sec:proc-multiboot} \label{sec:proc-multiboot}
%============================================================================== %==============================================================================
\begin{enumerate} \begin{enumerate}
\item \textbf{MultiBoot} the new gateware to \textbf{address 0x170000} in flash \item Load the new gateware to the \textbf{on-board flash memory} at
(use, for example, \textit{software/multiboot/multiboot.py}) \textbf{address 0x170000} and \textbf{run MultiBoot} \\
(use, for example \textit{software/multiboot/multiboot.py})
\end{enumerate} \end{enumerate}
%============================================================================== %==============================================================================
...@@ -269,8 +284,8 @@ and follow the steps one by one, ticking on completion. ...@@ -269,8 +284,8 @@ and follow the steps one by one, ticking on completion.
\label{sec:proc-ttl-blo} \label{sec:proc-ttl-blo}
%============================================================================== %==============================================================================
\begin{enumerate} \begin{enumerate}
\item Make sure the \textbf{TTL switch} of the CONV-TTL-BLO is in the \textbf{TTL position (on)} \item Make sure the \textbf{TTL switch} (Figure~\ref{fig:switches}) of the CONV-TTL-BLO is in the \textbf{TTL position (on)}
\item Make sure the \textbf{glitch filter switch} is in the \textbf{OFF} position \item Make sure the \textbf{glitch filter switch} (Figure~\ref{fig:switches}) is in the \textbf{OFF} position
\item \label{item:ttl-proc} Repeat the following steps for \textbf{all six channels}, filling in the \item \label{item:ttl-proc} Repeat the following steps for \textbf{all six channels}, filling in the
\textbf{table in Appendix~\ref{app:pulse-validation-ttl}}: \textbf{table in Appendix~\ref{app:pulse-validation-ttl}}:
\begin{enumerate} \begin{enumerate}
...@@ -287,8 +302,8 @@ and follow the steps one by one, ticking on completion. ...@@ -287,8 +302,8 @@ and follow the steps one by one, ticking on completion.
\item 3.3~V \item 3.3~V
\item less than 1.2~$\mu$s delay from trigger \item less than 1.2~$\mu$s delay from trigger
\end{itemize} \end{itemize}
\item \textbf{Tick} the \textbf{TTL column for the channel} on the \textbf{Front panel} side \item If the signal characteristics are as above, \textbf{tick} the \textbf{TTL column for the channel} on the \textbf{Front panel} side
of the table in Appendix~\ref{app:pulse-validation-ttl} if they are of the table in Appendix~\ref{app:pulse-validation-ttl}
\item \label{item:ttl-meas-blo-out} Check that the characteristics of the signals at the \item \label{item:ttl-meas-blo-out} Check that the characteristics of the signals at the
\textbf{rear panel} are as follows (Figure~\ref{fig:ttl-blo}): \textbf{rear panel} are as follows (Figure~\ref{fig:ttl-blo}):
\begin{itemize} \begin{itemize}
...@@ -296,9 +311,8 @@ and follow the steps one by one, ticking on completion. ...@@ -296,9 +311,8 @@ and follow the steps one by one, ticking on completion.
\item approx. 24~V \item approx. 24~V
\item less than 1.2~$\mu$s delay from trigger \item less than 1.2~$\mu$s delay from trigger
\end{itemize} \end{itemize}
\item \label{item:ttl-meas-end} \textbf{Tick} the \textbf{Blo} column for the channel \item \label{item:ttl-meas-end} If the signal characteristics are as above, \textbf{tick} the \textbf{Blo} column for the channel
on the \textbf{Front panel} side of the table in Appendix~\ref{app:pulse-validation-ttl} on the \textbf{Front panel} side of the table in Appendix~\ref{app:pulse-validation-ttl}
if they are
\item Connect the \textbf{DUT trigger} to the CONV-TTL-BLO \textbf{channel 1 rear panel \item Connect the \textbf{DUT trigger} to the CONV-TTL-BLO \textbf{channel 1 rear panel
input connector} input connector}
\item Repeat \textbf{steps \ref{item:ttl-meas-start} to \ref{item:ttl-meas-end}}, this time \item Repeat \textbf{steps \ref{item:ttl-meas-start} to \ref{item:ttl-meas-end}}, this time
...@@ -306,12 +320,12 @@ and follow the steps one by one, ticking on completion. ...@@ -306,12 +320,12 @@ and follow the steps one by one, ticking on completion.
table in Appendix~\ref{app:pulse-validation-ttl} table in Appendix~\ref{app:pulse-validation-ttl}
\end{enumerate} \end{enumerate}
\item Turn off power to the ELMA crate \item Turn off power to the ELMA crate
\item Change the \textbf{glitch filter switch} to the \textbf{ON position} \item Change the \textbf{glitch filter switch} (Figure~\ref{fig:switches}) to the \textbf{ON position}
\item Turn on power to the ELMA crate \item Turn on power to the ELMA crate
\item Repeat the steps under step~\ref{item:ttl-proc}, filling in the table in \item Repeat the steps under step~\ref{item:ttl-proc}, filling in the table in
Appendix~\ref{app:pulse-validation-ttl-gf} Appendix~\ref{app:pulse-validation-ttl-gf}
\item Turn off power to the ELMA crate \item Turn off power to the ELMA crate
\item Change the \textbf{glitch filter switch} back to the \textbf{OFF position} \item Change the \textbf{glitch filter switch} (Figure~\ref{fig:switches}) back to the \textbf{OFF position}
\end{enumerate} \end{enumerate}
\begin{figure} \begin{figure}
...@@ -331,7 +345,7 @@ and follow the steps one by one, ticking on completion. ...@@ -331,7 +345,7 @@ and follow the steps one by one, ticking on completion.
\end{figure} \end{figure}
\begin{enumerate} \begin{enumerate}
\item Turn off power and change the \textbf{TTL switch} to \textbf{TTL-BAR position (OFF)} \item Turn off power and change the \textbf{TTL switch} (Figure~\ref{fig:switches}) to \textbf{TTL-BAR position (OFF)}
\item \label{item:ttlbar-proc} Repeat the following steps for \textbf{all six channels}, filling in the \item \label{item:ttlbar-proc} Repeat the following steps for \textbf{all six channels}, filling in the
\textbf{table in Appendix~\ref{app:pulse-validation-ttlbar}}: \textbf{table in Appendix~\ref{app:pulse-validation-ttlbar}}:
\begin{enumerate} \begin{enumerate}
...@@ -348,8 +362,8 @@ and follow the steps one by one, ticking on completion. ...@@ -348,8 +362,8 @@ and follow the steps one by one, ticking on completion.
\item 3.3~V \item 3.3~V
\item less than 1.2~$\mu$s delay from trigger \item less than 1.2~$\mu$s delay from trigger
\end{itemize} \end{itemize}
\item \textbf{Tick} the \textbf{TTL column for the channel} on the \textbf{Front panel} side \item If the signal characteristics are as above, \textbf{tick} the \textbf{TTL column for the channel} on the \textbf{Front panel} side
of the table in Appendix~\ref{app:pulse-validation-ttlbar} if they are of the table in Appendix~\ref{app:pulse-validation-ttlbar}
\item \label{item:ttlbar-meas-blo-out} Check that the characteristics of the signals at the \item \label{item:ttlbar-meas-blo-out} Check that the characteristics of the signals at the
\textbf{rear panel} are as follows (Figure~\ref{fig:ttlbar-blo}): \textbf{rear panel} are as follows (Figure~\ref{fig:ttlbar-blo}):
\begin{itemize} \begin{itemize}
...@@ -357,9 +371,8 @@ and follow the steps one by one, ticking on completion. ...@@ -357,9 +371,8 @@ and follow the steps one by one, ticking on completion.
\item approx. 24~V \item approx. 24~V
\item less than 1.2~$\mu$s delay from trigger \item less than 1.2~$\mu$s delay from trigger
\end{itemize} \end{itemize}
\item \label{item:ttlbar-meas-end} \textbf{Tick} the \textbf{Blo} column for the channel \item \label{item:ttlbar-meas-end} If the signal characteristics are as above, \textbf{tick} the \textbf{Blo} column for the channel
on the \textbf{Front panel} side of the table in Appendix~\ref{app:pulse-validation-ttlbar} on the \textbf{Front panel} side of the table in Appendix~\ref{app:pulse-validation-ttlbar}
if they are
\item Connect the \textbf{DUT trigger} to the CONV-TTL-BLO \textbf{channel 1 rear panel \item Connect the \textbf{DUT trigger} to the CONV-TTL-BLO \textbf{channel 1 rear panel
input connector} input connector}
\item Repeat \textbf{steps \ref{item:ttlbar-meas-start} to \ref{item:ttlbar-meas-end}}, this time \item Repeat \textbf{steps \ref{item:ttlbar-meas-start} to \ref{item:ttlbar-meas-end}}, this time
...@@ -367,12 +380,12 @@ and follow the steps one by one, ticking on completion. ...@@ -367,12 +380,12 @@ and follow the steps one by one, ticking on completion.
table in Appendix~\ref{app:pulse-validation-ttlbar} table in Appendix~\ref{app:pulse-validation-ttlbar}
\end{enumerate} \end{enumerate}
\item Turn off power to the ELMA crate \item Turn off power to the ELMA crate
\item Change the \textbf{glitch filter switch} to the \textbf{ON position} \item Change the \textbf{glitch filter switch} (Figure~\ref{fig:switches}) to the \textbf{ON position}
\item Turn on power to the ELMA crate \item Turn on power to the ELMA crate
\item Repeat the steps under step~\ref{item:ttlbar-proc}, filling in the table in \item Repeat the steps under step~\ref{item:ttlbar-proc}, filling in the table in
Appendix~\ref{app:pulse-validation-ttlbar-gf} Appendix~\ref{app:pulse-validation-ttlbar-gf}
\item Turn off power to the ELMA crate \item Turn off power to the ELMA crate
\item Change the \textbf{glitch filter switch} back to the \textbf{OFF position} \item Change the \textbf{glitch filter switch} (Figure~\ref{fig:switches}) back to the \textbf{OFF position}
\end{enumerate} \end{enumerate}
%============================================================================== %==============================================================================
...@@ -382,7 +395,7 @@ and follow the steps one by one, ticking on completion. ...@@ -382,7 +395,7 @@ and follow the steps one by one, ticking on completion.
\begin{enumerate} \begin{enumerate}
\item Turn off the ELMA crate \item Turn off the ELMA crate
\item Remove \textbf{all cables} from the \textbf{TTL and blocking inputs} \item Remove \textbf{all cables} from the \textbf{TTL and blocking inputs}
\item Make sure the TTL switch is \textbf{OFF} \item Make sure the \textbf{TTL switch} (Figure~\ref{fig:switches}) is \textbf{OFF}
\item \label{item:ttlbar-poweron} Follow the following procedure: \item \label{item:ttlbar-poweron} Follow the following procedure:
\begin{enumerate} \begin{enumerate}
\item Configure the oscilloscope to trigger on the \textbf{falling edge} of the \item Configure the oscilloscope to trigger on the \textbf{falling edge} of the
...@@ -416,7 +429,7 @@ and follow the steps one by one, ticking on completion. ...@@ -416,7 +429,7 @@ and follow the steps one by one, ticking on completion.
blocking output with a connected TTL-BAR input) blocking output with a connected TTL-BAR input)
\item Turn off ELMA crate \item Turn off ELMA crate
\end{enumerate} \end{enumerate}
\item Flip the \textbf{glitch filter switch} to the \textbf{ON position} \item Flip the \textbf{glitch filter switch} (Figure~\ref{fig:switches}) to the \textbf{ON position}
\item Follow the procedure in step~\ref{item:ttlbar-poweron} \item Follow the procedure in step~\ref{item:ttlbar-poweron}
\item Power-cycle the ELMA crate \item Power-cycle the ELMA crate
\item Run the \textit{rdchxpcr.py} script (\textit{software/diag/rdchxpcr.py}) \item Run the \textit{rdchxpcr.py} script (\textit{software/diag/rdchxpcr.py})
...@@ -424,7 +437,7 @@ and follow the steps one by one, ticking on completion. ...@@ -424,7 +437,7 @@ and follow the steps one by one, ticking on completion.
\item Run the \textit{rdtb.py} script (\textit{software/diag/timetag/rdtb.py}) \item Run the \textit{rdtb.py} script (\textit{software/diag/timetag/rdtb.py})
and confirm that no pulses were stored to the timetag buffer and confirm that no pulses were stored to the timetag buffer
\item Turn off ELMA crate \item Turn off ELMA crate
\item Flip the \textbf{glitch filter switch} back to the \textbf{OFF position} \item Flip the \textbf{glitch filter switch} (Figure~\ref{fig:switches}) back to the \textbf{OFF position}
\end{enumerate} \end{enumerate}
...@@ -436,7 +449,7 @@ and follow the steps one by one, ticking on completion. ...@@ -436,7 +449,7 @@ and follow the steps one by one, ticking on completion.
\begin{enumerate} \begin{enumerate}
\item Turn off the ELMA crate \item Turn off the ELMA crate
\item Remove \textbf{all cables} from the \textbf{TTL and blocking inputs} \item Remove \textbf{all cables} from the \textbf{TTL and blocking inputs}
\item Put the TTL switch in the \textbf{ON} position \item Put the \textbf{TTL switch} (Figure~\ref{fig:switches}) in the \textbf{ON} position
\item \label{item:ttl-poweron} Follow the following procedure: \item \label{item:ttl-poweron} Follow the following procedure:
\begin{enumerate} \begin{enumerate}
\item Configure the oscilloscope to trigger on the \textbf{rising edge} of the \item Configure the oscilloscope to trigger on the \textbf{rising edge} of the
...@@ -470,7 +483,7 @@ and follow the steps one by one, ticking on completion. ...@@ -470,7 +483,7 @@ and follow the steps one by one, ticking on completion.
blocking output with a connected TTL input) blocking output with a connected TTL input)
\item Turn off ELMA crate \item Turn off ELMA crate
\end{enumerate} \end{enumerate}
\item Flip the \textbf{glitch filter switch} to the \textbf{ON position} \item Flip the \textbf{glitch filter switch} (Figure~\ref{fig:switches}) to the \textbf{ON position}
\item Follow the procedure in step~\ref{item:ttl-poweron} \item Follow the procedure in step~\ref{item:ttl-poweron}
\item Power-cycle the ELMA crate \item Power-cycle the ELMA crate
\item Run the \textit{rdchxpcr.py} script (\textit{software/diag/rdchxpcr.py}) \item Run the \textit{rdchxpcr.py} script (\textit{software/diag/rdchxpcr.py})
...@@ -478,7 +491,7 @@ and follow the steps one by one, ticking on completion. ...@@ -478,7 +491,7 @@ and follow the steps one by one, ticking on completion.
\item Run the \textit{rdtb.py} script (\textit{software/diag/timetag/rdtb.py}) \item Run the \textit{rdtb.py} script (\textit{software/diag/timetag/rdtb.py})
and confirm that no pulses were stored to the timetag buffer and confirm that no pulses were stored to the timetag buffer
\item Turn off ELMA crate \item Turn off ELMA crate
\item Flip the \textbf{glitch filter switch} back to the \textbf{OFF position} \item Flip the \textbf{glitch filter switch} (Figure~\ref{fig:switches}) back to the \textbf{OFF position}
\end{enumerate} \end{enumerate}
......
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