Skip to content

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

New title page for UG, work on I2C HDL docs 

- shortened I2C section in i2c_slave UG
- enlarged read and write transfers in elma_i2c UG
parent 6517490d
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 3095 additions and 3790 deletions
doc/ug/Makefile
View file @ 41e314fe
FILE=ug-conv-ttl-blo
all:
pdflatex -synctex=1 -interaction=nonstopmode *.tex
bibtex *.aux
pdflatex -synctex=1 -interaction=nonstopmode *.tex
pdflatex -synctex=1 -interaction=nonstopmode *.tex
pdflatex -synctex=1 -interaction=nonstopmode $(FILE).tex *.tex
bibtex $(FILE).aux
pdflatex -synctex=1 -interaction=nonstopmode $(FILE).tex *.tex
pdflatex -synctex=1 -interaction=nonstopmode $(FILE).tex *.tex
evince $(FILE).pdf &
clean:
......
doc/ug/build/ug-conv-ttl-blo.tex deleted 100644 → 0
View file @ 6517490d
This diff is collapsed.
doc/ug/fig/cern-logo.png
View replaced file @ 6517490d View file @ 41e314fe
doc/ug/fig/cern-logo.png

19.7 KB | W: | H:

doc/ug/fig/cern-logo.png

32.6 KB | W: | H:

doc/ug/fig/cern-logo.png
doc/ug/fig/cern-logo.png
doc/ug/fig/cern-logo.png
doc/ug/fig/cern-logo.png
  • 2-up
  • Swipe
  • Onion skin
doc/ug/title.tex 0 → 100644
View file @ 41e314fe
\begin{titlepage}
\vspace*{3cm}
\noindent{\LARGE \textbf{CONV-TTL-BLO User Guide}}
\noindent \rule{\textwidth}{.1cm}
\hfill\today
\vspace*{3cm}
\begin{figure}[h]
\includegraphics[height=3cm]{fig/cern-logo.png}
\hfill
\includegraphics[height=3cm]{fig/ohwr-logo}
\end{figure}
\vfill
\noindent {\Large \textbf{Theodor-Adrian Stana (CERN/BE-CO-HT)}}
\noindent \rule{\textwidth}{.05cm}
\end{titlepage}
doc/ug/ug-conv-ttl-blo.tex
View file @ 41e314fe
......@@ -4,13 +4,19 @@
\documentclass[a4paper,11pt]{article}
\usepackage[pdfborder= 0 0 0 1]{hyperref}
\usepackage{graphicx}
\usepackage{rotating}
\usepackage{multirow}
\usepackage{color}
\usepackage[toc,page]{appendix}
\usepackage{fancyhdr}
\setlength{\headheight}{15.2pt}
\pagestyle{fancy}
\fancyhead[L]{\nouppercase{\leftmark}}
\fancyhead[R]{}
\renewcommand{\footrulewidth}{0.4pt}
%==============================================================================
% Start of document
%==============================================================================
......@@ -19,23 +25,7 @@
%------------------------------------------------------------------------------
% Title
%------------------------------------------------------------------------------
\title{
\textbf{
CONV-TTL-BLO \\
User Guide}
}
\author{Theodor-Adrian Stana}
\date{\today}
\maketitle
\thispagestyle{empty}
\begin{figure}[htb]
\begin{center}
\includegraphics[scale=0.25]{fig/cern-logo.png}
\end{center}
\end{figure}
\maketitle{}
\pagebreak
\include{title}
%------------------------------------------------------------------------------
% Revision history
......@@ -49,8 +39,9 @@ User Guide}
\hline
\multicolumn{1}{c}{\textbf{Date}} & \multicolumn{1}{c}{\textbf{Version}} & \multicolumn{1}{c}{\textbf{Change}} \\
\hline
2013-06-19 & 1.00 & First version \\
2013-06-21 & 1.01 & Added termination resistors to Fig.~\ref{fig:ttl-chan},~\ref{fig:invttl-chan} \\
19-06-2013 & 1.00 & First version \\
21-06-2013 & 1.01 & Added termination resistors to Fig.~\ref{fig:ttl-chan},~\ref{fig:invttl-chan} \\
25-06-2013 & 1.02 & New title page and page layout \\
\hline
\end{tabular}
}
......@@ -77,11 +68,12 @@ User Guide}
VME & VERSAmodule Eurocard \\
\end{tabular}
\pagebreak
%======================================================================================
% SEC: Intro
%======================================================================================
\pagebreak
\pagenumbering{arabic}
\setcounter{page}{1}
......@@ -269,11 +261,9 @@ load.
When a pulse is repeated on the output connector of a channel, the pulse status LED flashes briefly.
\begin{figure}[htbp]
\begin{center}
\includegraphics[scale=.55, keepaspectratio]{fig/rear-panel}
\centerline{\includegraphics[scale=.75]{fig/rear-panel}}
\caption{CONV-TTL-BLO-RTM panel (rear panel)}
\label{fig:rear-panel}
\end{center}
\end{figure}
%======================================================================================
......
hdl/elma_i2c/doc/elma_i2c/Makefile
View file @ 41e314fe
FILE=elma_i2c
all:
pdflatex -synctex=1 -interaction=nonstopmode *.tex
bibtex *.aux
pdflatex -synctex=1 -interaction=nonstopmode *.tex
pdflatex -synctex=1 -interaction=nonstopmode *.tex
pdflatex -synctex=1 -interaction=nonstopmode $(FILE).tex *.tex
bibtex $(FILE).aux
pdflatex -synctex=1 -interaction=nonstopmode $(FILE).tex *.tex
pdflatex -synctex=1 -interaction=nonstopmode $(FILE).tex *.tex
evince $(FILE).pdf &
clean:
......
hdl/elma_i2c/doc/elma_i2c/elma_i2c.tex
View file @ 41e314fe
......@@ -4,39 +4,70 @@
\documentclass[a4paper,11pt]{article}
\usepackage[pdfborder= 0 0 0 1]{hyperref}
\usepackage{graphicx}
\usepackage{hyperref}
\usepackage{rotating}
\usepackage{multirow}
\usepackage{color}
\usepackage[toc,page]{appendix}
% Header and footer customization
\usepackage{fancyhdr}
\setlength{\headheight}{15.2pt}
\pagestyle{fancy}
\fancyhead[L]{\nouppercase{\leftmark}}
\fancyhead[R]{}
\renewcommand{\footrulewidth}{0.4pt}
%==============================================================================
% Start of document
%==============================================================================
\begin{document}
\title{VME64x I$^2$C to Wishbone bridge}
\author
%------------------------------------------------------------------------------
% Title
%------------------------------------------------------------------------------
\include{title}
%------------------------------------------------------------------------------
% Revision history
%------------------------------------------------------------------------------
\thispagestyle{empty}
\section*{Revision history}
\centerline
{
Theodor-Adrian Stana \\
CERN, BE-CO-HT \\
\begin{tabular}{l c p{.6\textwidth}}
\hline
\multicolumn{1}{c}{\textbf{Date}} & \multicolumn{1}{c}{\textbf{Version}} & \multicolumn{1}{c}{\textbf{Change}} \\
\hline
25-06-2013 & 1.00 & First version \\
\hline
\end{tabular}
}
\date{\today}
\maketitle
\thispagestyle{empty}
\begin{figure}
\begin{center}
\includegraphics[scale=.25,keepaspectratio]{fig/cern-logo.png}
\end{center}
\end{figure}
\pagebreak
\pagenumbering{roman}
\setcounter{page}{1}
\tableofcontents
% Break page
%------------------------------------------------------------------------------
% List of figs, tables, abbrevs
%------------------------------------------------------------------------------
\pagebreak
\listoffigures
\listoftables
\section*{List of Abbreviations}
\begin{tabular}{l l}
FSM & Finite-State Machine \\
I$^2$C & Inter-Integrated Circuit (bus) \\
SysMon & ELMA crate System Monitor board \\
VME & VERSAmodule Eurocard \\
\end{tabular}
% Generate TOC and pagebreak after it
\tableofcontents
\pagebreak
\pagenumbering{arabic}
\setcounter{page}{1}
%==============================================================================
% SEC: Intro
......@@ -44,7 +75,7 @@ CERN, BE-CO-HT \\
\section{Introduction}
\label{sec:intro}
This document describes the \textit{vme64x\_i2c} module, an I$^2$C to Wishbone
This document describes the \textit{elma\_i2c} module, an I$^2$C to Wishbone
bridge for the VME64x crates. The module implements an I$^2$C slave and translates
the protocol defined by ELMA in \cite{sysmon-i2c} into Wishbone accesses to a
Wishbone slave device.
......@@ -95,7 +126,7 @@ are sent by the VME board in big-endian order.
\label{sec:implem}
In order to perform low-level I$^2$C transfers, the \textit{i2c\_slave} module
is instantiated and used within the \textit{vme64x\_i2c} module. The outputs of
is instantiated and used within the \textit{elma\_i2c} module. The outputs of
the \textit{i2c\_slave} module \textcolor{red}{REFERENCE?} are used as controls
for an eight-state finite state machine (FSM), a simplified version of which
is shown in Fig.~\ref{fig:fsm}. Table~\ref{tbl:fsm} also lists the states of
......@@ -103,31 +134,19 @@ the state machine.
\begin{figure}[h]
\centerline{\includegraphics[width=\textwidth, keepaspectratio]{fig/fsm}}
\caption{Main FSM of \textit{vme64x\_i2c} module}
\caption{Main FSM of \textit{elma\_i2c} module}
\label{fig:fsm}
\end{figure}
\begin{figure}[h]
\centerline{\includegraphics[width=\textwidth]{fig/sysmon-wr-fsm}}
\caption{FSM states when the SysMon writes to the \textit{vme64x\_i2c}}
\label{fig:sysmon-wr-fsm}
\end{figure}
\begin{figure}[h]
\centerline{\includegraphics[width=\textwidth]{fig/sysmon-rd-fsm}}
\caption{FSM states when the SysMon reads from the \textit{vme64x\_i2c}}
\label{fig:sysmon-rd-fsm}
\end{figure}
When the \textit{i2c\_slave} module finishes a transfer (signaled by a \textit{done\_p\_o} pulse),
the status is checked and if it is as expected (e.g., a \textit{address good} in the
\textit{ST\_IDLE} state), the FSM advances to the next state. It should be noted that where the
SysMon appears in the state names, it indicates what the SysMon action is. For example, if the state
of the FSM is \textit{ST\_SYSMON\_WR}, this means the SysMon is writing and the \textit{vme64x\_i2c}
of the FSM is \textit{ST\_SYSMON\_WR}, this means the SysMon is writing and the \textit{elma\_i2c}
is reading.
\begin{table}[h]
\caption{\textit{vme64x\_i2c} state machine}
\caption{States of \textit{elma\_i2c} FSM}
\label{tbl:fsm}
\centerline
{
......@@ -143,12 +162,12 @@ is reading.
\textit{ST\_SIM\_WB\_TRANSF} \\
ST\_SIM\_WB\_TRANSF & Start a Wishbone read transfer from address received in previous
state and go to \textit{ST\_OP} if Wishbone address exists (Wishbone
\textit{ack} received, or \textit{ST\_IDLE} otherwise (Wishbone \textit{err}
\textit{ack} received), or \textit{ST\_IDLE} otherwise (Wishbone \textit{err}
received) \\
ST\_OP & Check the \textit{op\_o} output of the \textit{i2c\_slave} module.
If different from the value at the start, go to \textit{ST\_SYSMON\_RD\_WB} state
(SysMon is reading from \textit{vme64x\_i2c}), otherwise continue shifting
in bytes (SysMon writing to \textit{vme64x\_i2c}) \\
(SysMon is reading from \textit{elma\_i2c}), otherwise continue shifting
in bytes (SysMon writing to \textit{elma\_i2c}) \\
ST\_SYSMON\_WR & Continue reading up to four bytes sent by the SysMon and go to
\textit{ST\_SYSMON\_WR\_WB}\\
ST\_SYSMON\_WR\_WB & Perform a Wishbone write transfer to the register with the address obtained in
......@@ -166,8 +185,14 @@ To better understand how the FSM operates, Figures \ref{fig:sysmon-wr-fsm} and
\ref{fig:sysmon-rd-fsm} can be consulted, where the state of the FSM is shown
during reads and writes from the SysMon.
\begin{figure}[h]
\centerline{\includegraphics[width=\textwidth]{fig/sysmon-wr-fsm}}
\caption{FSM states when the SysMon writes to the \textit{elma\_i2c}}
\label{fig:sysmon-wr-fsm}
\end{figure}
When reading from the SysMon (Fig.~\ref{fig:sysmon-wr-fsm}), the
\textit{vme64x\_i2c} module will wait in the \textit{ST\_IDLE} state while
\textit{elma\_i2c} module will wait in the \textit{ST\_IDLE} state while
the I$^2$C address is sent, then go to the \textit{ST\_WB\_ADR} state to
shift in the address. A Wishbone transfer is simulated and if the address
exists (a Wishbone \textit{ack} is received), the first byte is shifted in
......@@ -185,12 +210,18 @@ detects a different value of \textit{op\_o} and goes into the
executed, the value of the register is read and sent via I$^2$C in the
\textit{ST\_SYSMON\_RD} state.
\begin{figure}[h]
\centerline{\includegraphics[width=\textwidth]{fig/sysmon-rd-fsm}}
\caption{FSM states when the SysMon reads from the \textit{elma\_i2c}}
\label{fig:sysmon-rd-fsm}
\end{figure}
%==============================================================================
% Bibliography
%==============================================================================
\pagebreak
\bibliographystyle{ieeetr}
\bibliography{vme64x_i2c}
\bibliography{elma_i2c}
\end{document}
hdl/elma_i2c/doc/elma_i2c/fig/sysmon-rd.svg
View file @ 41e314fe
This diff is collapsed.
hdl/elma_i2c/doc/elma_i2c/fig/sysmon-wr.svg
View file @ 41e314fe
This diff is collapsed.
hdl/elma_i2c/doc/elma_i2c/title.tex 0 → 100644
View file @ 41e314fe
\begin{titlepage}
\vspace*{3cm}
%---------------------------------------------------------------
% title
%---------------------------------------------------------------
\noindent{\LARGE \textbf{ELMA I$^2$C to Wishbone bridge}}
\noindent \rule{\textwidth}{.1cm}
\hfill\today
\vspace*{3cm}
\begin{figure}[h]
\includegraphics[height=3cm]{fig/cern-logo.png}
\hfill
\includegraphics[height=3cm]{fig/ohwr-logo}
\end{figure}
\vfill
%---------------------------------------------------------------
% name
%---------------------------------------------------------------
\noindent {\Large \textbf{Theodor-Adrian Stana (CERN/BE-CO-HT)}}
\noindent \rule{\textwidth}{.05cm}
\end{titlepage}
hdl/elma_i2c/doc/i2c_slave/Makefile
View file @ 41e314fe
......@@ -2,7 +2,7 @@ FILE=i2c_slave
all:
pdflatex -synctex=1 -interaction=nonstopmode *.tex
bibtex *.aux
bibtex $(FILE).aux
pdflatex -synctex=1 -interaction=nonstopmode *.tex
pdflatex -synctex=1 -interaction=nonstopmode *.tex
evince $(FILE).pdf &
......
hdl/elma_i2c/doc/i2c_slave/fig/i2c-addr.svg deleted 100644 → 0
View file @ 6517490d
This diff is collapsed.
hdl/elma_i2c/doc/i2c_slave/i2c_slave.tex
View file @ 41e314fe
This diff is collapsed.
hdl/elma_i2c/doc/i2c_slave/title.tex 0 → 100644
View file @ 41e314fe
\begin{titlepage}
\vspace*{3cm}
\noindent{\LARGE \textbf{I$^2$C Slave Core}}
\noindent \rule{\textwidth}{.1cm}
\hfill\today
\vspace*{3cm}
\begin{figure}[h]
\includegraphics[height=3cm]{fig/cern-logo.png}
\hfill
\includegraphics[height=3cm]{fig/ohwr-logo}
\end{figure}
\vfill
\noindent {\Large \textbf{Theodor-Adrian Stana (CERN/BE-CO-HT)}}
\noindent \rule{\textwidth}{.05cm}
\end{titlepage}
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