Skip to content

F
FMC ADC 100M 14b 4cha - Gateware
Commit 2e6afd3a authored by mcattin's avatar mcattin
Browse files
Options

Working on users guide. 

git-svn-id: http://svn.ohwr.org/fmc-adc-100m14b4cha/trunk@130 ddd67a1a-c8ad-4635-afe9-0b8a11d8f8e4
parent 05b0eeed
Hide whitespace changes
Inline Side-by-side
Showing with 143 additions and 77 deletions
documentation/user_guides/fmcadc100m14b4cha_users_guide.tex
View file @ 2e6afd3a
\documentclass[11pt,a4paper]{article}
\usepackage[pdftex]{color,graphicx}
\usepackage{tabularx}
\usepackage{amsmath}
% Uncomment the following two lines to check syntax only (no .dvi output produced, so it's faster!)
%\usepackage{syntonly}
......@@ -57,21 +58,85 @@ Revision & Date & Author & Comments\\
\section{Overview}
Here's an overview of the fmcadc100m14b4cha board...
\begin{figure}[h!]
\includegraphics[width=\textwidth]{figures/firmware_arch.pdf}
\caption{FPGA firmware architecture.}
\label{fig:firmware_arch}
\end{figure}
%===============================================================================
\section{Settings}
\subsection{Trigger}
\begin{figure}[h!]
\includegraphics[width=\textwidth]{figures/trigger_unit.pdf}
\caption{Trigger unit details.}
\label{fig:trigger_unit}
\end{figure}
\subsection{Input ranges}
Three input ranges, optional input 50ohms termination.
Calibration input configuration.
\subsection{Input offset}
\begin{equation}\label{dac_digital2volts}
V\subscript{dac} = V\subscript{ref} \cdot \frac{32768 \cdot D\subscript{dac}}{32768} \\
\end{equation}
where:
\begin{equation}
V\subscript{ref} = 5 [Volts]
\end{equation}
\begin{equation}\label{in_dac_offset}
V\subscript{out} = V\subscript{in} - (gain\subscript{dac} \cdot V\subscript{dac} + offset\subscript{dac})
\end{equation}
\subsection{Time-stamping}
%===============================================================================
\section{Acquisition}
* Single shot mode:
\begin{figure}[h!]
\includegraphics[width=\textwidth]{figures/adc_core_fs_clk.pdf}
\caption{ADC core, sampling clock domain.}
\label{fig:adc_core_fs_clk}
\end{figure}
\begin{figure}[h!]
\includegraphics[width=\textwidth]{figures/adc_core_sys_clk.pdf}
\caption{ADC core, system clock domain.}
\label{fig:adc_core_sys_clk}
\end{figure}
* Multi-shot mode:
\begin{itemize}
\item Single shot mode
\begin{itemize}
\item State machine
\item Memory managment
\item ...
\end{itemize}
\subsection{Trigger}
\item Multi-shot mode
\begin{itemize}
\item State machine
\item Memory managment
\item ...
\end{itemize}
\end{itemize}
\subsection{Memory}
%===============================================================================
\section{Calibration}
The calibration is done once during the prodoction tests.
......@@ -80,50 +145,51 @@ The calibration process gives four values per channel and per input range:
ADC gain correction, ADC offset correction, DAC gain correction and DAC offset correction.
The temperature during the calibration process is also measured.
All the calibration values are stored in the FmcAdc100m14b4cha EEPROM.
More precisely they are stored in the "Internal Use Area" as defined in the IPMI standard\footnote{Platform Management FRU Information Storage Definition v1.0}.
Tables \ref{tab:adc_calibr_data_eeprom} and \ref{tab:dac_calibr_data_eeprom} shows the calibration data types and the arrangement in the EEPROM.
Note that ADC calibration data are stored before DAC calibration data in the EEPROM.
The first column "Byte offset" represents the offset within the "Internal Use Area".
\begin{table}[ht]
\centering
\begin{tabularx}{\textwidth}{|c|l|X|}
\begin{tabularx}{\textwidth}{| >{\centering}p{1.1cm} | >{\centering}p{1.2cm} | l | X |}
\hline
\multicolumn{3}{|c|}{\textbf{ADC correction values}} \\ \hline
\textbf{Input range} & \textbf{Description} & \textbf{Type} \\ \hline
10V & Offset correction channel 1 & 16-bit signed \\
& Offset correction channel 2 & 16-bit signed \\
& Offset correction channel 3 & 16-bit signed \\
& Offset correction channel 4 & 16-bit signed \\
\cline{2-3}
& Gain correction channel 1 & 16-bit unsigned \\
& Gain correction channel 2 & 16-bit unsigned \\
& Gain correction channel 3 & 16-bit unsigned \\
& Gain correction channel 4 & 16-bit unsigned \\
\cline{2-3}
& Temperature & 16-bit unsigned * 0.01$^\circ$C \\
\multicolumn{4}{|c|}{\textbf{ADC correction values}} \\ \hline
\textbf{Byte offset} & \textbf{Input range} & \textbf{Description} & \textbf{Type} \\ \hline
0 & 10V & Offset correction channel 1 & 16-bit signed \\
2 & & Offset correction channel 2 & 16-bit signed \\
4 & & Offset correction channel 3 & 16-bit signed \\
6 & & Offset correction channel 4 & 16-bit signed \\
\cline{3-4}
8 & & Gain correction channel 1 & 16-bit unsigned \\
10 & & Gain correction channel 2 & 16-bit unsigned \\
12 & & Gain correction channel 3 & 16-bit unsigned \\
14 & & Gain correction channel 4 & 16-bit unsigned \\
\cline{3-4}
16 & & Temperature & 16-bit unsigned * 0.01$^\circ$C \\
\hline
1V & Offset correction channel 1 & 16-bit signed \\
& Offset correction channel 2 & 16-bit signed \\
& Offset correction channel 3 & 16-bit signed \\
& Offset correction channel 4 & 16-bit signed \\
\cline{2-3}
& Gain correction channel 1 & 16-bit unsigned \\
& Gain correction channel 2 & 16-bit unsigned \\
& Gain correction channel 3 & 16-bit unsigned \\
& Gain correction channel 4 & 16-bit unsigned \\
\cline{2-3}
& Temperature & 16-bit unsigned * 0.01$^\circ$C \\
18 & 1V & Offset correction channel 1 & 16-bit signed \\
20 & & Offset correction channel 2 & 16-bit signed \\
22 & & Offset correction channel 3 & 16-bit signed \\
24 & & Offset correction channel 4 & 16-bit signed \\
\cline{3-4}
26 & & Gain correction channel 1 & 16-bit unsigned \\
28 & & Gain correction channel 2 & 16-bit unsigned \\
30 & & Gain correction channel 3 & 16-bit unsigned \\
32 & & Gain correction channel 4 & 16-bit unsigned \\
\cline{3-4}
34 & & Temperature & 16-bit unsigned * 0.01$^\circ$C \\
\hline
100mV & Offset correction channel 1 & 16-bit signed \\
& Offset correction channel 2 & 16-bit signed \\
& Offset correction channel 3 & 16-bit signed \\
& Offset correction channel 4 & 16-bit signed \\
\cline{2-3}
& Gain correction channel 1 & 16-bit unsigned \\
& Gain correction channel 2 & 16-bit unsigned \\
& Gain correction channel 3 & 16-bit unsigned \\
& Gain correction channel 4 & 16-bit unsigned \\
\cline{2-3}
& Temperature & 16-bit unsigned * 0.01$^\circ$C \\
36 & 100mV & Offset correction channel 1 & 16-bit signed \\
38 & & Offset correction channel 2 & 16-bit signed \\
40 & & Offset correction channel 3 & 16-bit signed \\
42 & & Offset correction channel 4 & 16-bit signed \\
\cline{3-4}
44 & & Gain correction channel 1 & 16-bit unsigned \\
46 & & Gain correction channel 2 & 16-bit unsigned \\
48 & & Gain correction channel 3 & 16-bit unsigned \\
50 & & Gain correction channel 4 & 16-bit unsigned \\
\cline{3-4}
52 & & Temperature & 16-bit unsigned * 0.01$^\circ$C \\
\hline
\end{tabularx}
\caption{ADC calibration data}
......@@ -132,45 +198,45 @@ Note that ADC calibration data are stored before DAC calibration data in the EEP
\begin{table}[ht]
\centering
\begin{tabularx}{\textwidth}{|c|l|X|}
\begin{tabularx}{\textwidth}{| >{\centering}p{1.1cm} | >{\centering}p{1.2cm} | l | X |}
\hline
\multicolumn{3}{|c|}{\textbf{DAC correction values}} \\ \hline
\textbf{Input range} & \textbf{Description} & \textbf{Type} \\ \hline
10V & Offset correction channel 1 & 16-bit signed \\
& Offset correction channel 2 & 16-bit signed \\
& Offset correction channel 3 & 16-bit signed \\
& Offset correction channel 4 & 16-bit signed \\
\cline{2-3}
& Gain correction channel 1 & 16-bit unsigned \\
& Gain correction channel 2 & 16-bit unsigned \\
& Gain correction channel 3 & 16-bit unsigned \\
& Gain correction channel 4 & 16-bit unsigned \\
\cline{2-3}
& Temperature & 16-bit unsigned * 0.01$^\circ$C \\
\multicolumn{4}{|c|}{\textbf{DAC correction values}} \\ \hline
\textbf{Byte offset} & \textbf{Input range} & \textbf{Description} & \textbf{Type} \\ \hline
54 & 10V & Offset correction channel 1 & 16-bit signed \\
56 & & Offset correction channel 2 & 16-bit signed \\
58 & & Offset correction channel 3 & 16-bit signed \\
60 & & Offset correction channel 4 & 16-bit signed \\
\cline{3-4}
62 & & Gain correction channel 1 & 16-bit unsigned \\
64 & & Gain correction channel 2 & 16-bit unsigned \\
66 & & Gain correction channel 3 & 16-bit unsigned \\
68 & & Gain correction channel 4 & 16-bit unsigned \\
\cline{3-4}
70 & & Temperature & 16-bit unsigned * 0.01$^\circ$C \\
\hline
1V & Offset correction channel 1 & 16-bit signed \\
& Offset correction channel 2 & 16-bit signed \\
& Offset correction channel 3 & 16-bit signed \\
& Offset correction channel 4 & 16-bit signed \\
\cline{2-3}
& Gain correction channel 1 & 16-bit unsigned \\
& Gain correction channel 2 & 16-bit unsigned \\
& Gain correction channel 3 & 16-bit unsigned \\
& Gain correction channel 4 & 16-bit unsigned \\
\cline{2-3}
& Temperature & 16-bit unsigned * 0.01$^\circ$C \\
72 & 1V & Offset correction channel 1 & 16-bit signed \\
74 & & Offset correction channel 2 & 16-bit signed \\
76 & & Offset correction channel 3 & 16-bit signed \\
78 & & Offset correction channel 4 & 16-bit signed \\
\cline{3-4}
80 & & Gain correction channel 1 & 16-bit unsigned \\
82 & & Gain correction channel 2 & 16-bit unsigned \\
84 & & Gain correction channel 3 & 16-bit unsigned \\
86 & & Gain correction channel 4 & 16-bit unsigned \\
\cline{3-4}
88 & & Temperature & 16-bit unsigned * 0.01$^\circ$C \\
\hline
100mV & Offset correction channel 1 & 16-bit signed \\
& Offset correction channel 2 & 16-bit signed \\
& Offset correction channel 3 & 16-bit signed \\
& Offset correction channel 4 & 16-bit signed \\
\cline{2-3}
& Gain correction channel 1 & 16-bit unsigned \\
& Gain correction channel 2 & 16-bit unsigned \\
& Gain correction channel 3 & 16-bit unsigned \\
& Gain correction channel 4 & 16-bit unsigned \\
\cline{2-3}
& Temperature & 16-bit unsigned * 0.01$^\circ$C \\
90 & 100mV & Offset correction channel 1 & 16-bit signed \\
92 & & Offset correction channel 2 & 16-bit signed \\
94 & & Offset correction channel 3 & 16-bit signed \\
96 & & Offset correction channel 4 & 16-bit signed \\
\cline{3-4}
98 & & Gain correction channel 1 & 16-bit unsigned \\
100 & & Gain correction channel 2 & 16-bit unsigned \\
102 & & Gain correction channel 3 & 16-bit unsigned \\
104 & & Gain correction channel 4 & 16-bit unsigned \\
\cline{3-4}
106 & & Temperature & 16-bit unsigned * 0.01$^\circ$C \\
\hline
\end{tabularx}
\caption{DAC calibration data}
......
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