Skip to content

C
Conv TTL Blocking
Commit ced4f5ab authored by Theodor-Adrian Stana's avatar Theodor-Adrian Stana
Browse files
Options

doc: Corrected things in user guide 

- corrected small errors (readreg instead of writereg in "Remote reset"
  section, various typos
- added a little bit of info
- made "Revision history", "List of abbreviations" and "References"
  sections appear in the Contents and the bookmarks of the .pdf
- also made Contents appear in bookmarks, without it appearing in the
  actual Contents
parent f38b9a8e
Hide whitespace changes
Inline Side-by-side
Showing with 22 additions and 14 deletions
doc/ug/cern-title.tex
View file @ ced4f5ab
......@@ -9,7 +9,7 @@
\noindent \rule{\textwidth}{.1cm}
\hfill August 11, 2014
\hfill August 12, 2014
\vspace*{3cm}
......
doc/ug/ug-conv-ttl-blo.tex
View file @ ced4f5ab
......@@ -48,7 +48,8 @@
%------------------------------------------------------------------------------
% Revision history
%------------------------------------------------------------------------------
\thispagestyle{empty}
\pagebreak
\addcontentsline{toc}{section}{Revision history}
\section*{Revision history}
\centerline
......@@ -74,21 +75,25 @@
to Section~\ref{sec:diag-sw-rtmdet}; made slight modifications to Figure~\ref{fig:man-trig-fsm}
to make it fit on its page; added reference to schematics and OHWR project page
in Additional Documents section (under Section~\ref{sec:intro}) \\
12-08-2014 & 2.21 & 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} \\
\hline
\end{tabular}
}
\pagebreak
\pagenumbering{roman}
\setcounter{page}{1}
\tableofcontents
%------------------------------------------------------------------------------
% List of figs, tables, abbrevs
% List of figs, tables
%------------------------------------------------------------------------------
\pagebreak
\pdfbookmark[1]{\contentsname}{toc}
\tableofcontents
\listoffigures
\listoftables
%------------------------------------------------------------------------------
% List of abbreviations
%------------------------------------------------------------------------------
\pagebreak
\section*{List of Abbreviations}
\begin{tabular}{l l}
......@@ -104,14 +109,12 @@
VME & VERSAmodule Eurocard \\
WR & White Rabbit \\
\end{tabular}
\addcontentsline{toc}{section}{List of abbreviations}
%======================================================================================
% SEC: Intro
%======================================================================================
\pagebreak
\pagenumbering{arabic}
\setcounter{page}{1}
\section{Introduction}
\label{sec:intro}
......@@ -176,7 +179,7 @@ part of the VME crate to the front module.
%------------------------------------------------------------------------------
% SUBSEC: Additional doc
%------------------------------------------------------------------------------
\subsection*{Additional documentation}
\subsection{Additional documentation}
\begin{itemize}
\item CONV-TTL-BLO OHWR Project Page \cite{ctb-proj}
......@@ -1179,7 +1182,7 @@ An example of resetting a card in slot 11 using the Telnet commands is given bel
\begin{verbatim}
%>writereg 11 8 1
Done!
%>readreg 11 8 2
%>writereg 11 8 2
Not acknoledged!
\end{verbatim}
......@@ -1392,7 +1395,7 @@ The FPGA on-board the CONV-TTL-BLO is configured by bitstreams downloaded from t
on-board flash chip. There are two bitstreams relevant to the user.
The first is the application bitstream, which is the bitstream that runs when the
card is powered up. It is also the bitstream that the user loads loads to the
card is powered up. It is also the bitstream that the user loads to the
CONV-TTL-BLO flash when using remote reprogramming.
The second bitstream is the Golden bitstream, which is a bitstream known to be safe in
......@@ -1406,6 +1409,10 @@ Note however that if the FPGA falls back to this Golden bitstream, even
if a new application bitstream is correctly loaded to the CONV-TTL-BLO flash chip,
a power-cycle will be needed to run this new bitstream.
To detect which bitstream is currently running, read the GWVERS field in the
board's status register (SR -- see Appendix~\ref{app:conv-regs-sr}).
%--------------------------------------------------------------------------------------
% SUBSEC: Don't program bitstreams w/o the ICAP
%--------------------------------------------------------------------------------------
......@@ -1739,6 +1746,7 @@ one-wire timings. The value for the current version of the gateware is
\nocite{sch}
\bibliographystyle{ieeetr}
\bibliography{ug-conv-ttl-blo}
\addcontentsline{toc}{section}{References}
\end{document}
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