Commit e84cfb7f authored by Paolo Baesso's avatar Paolo Baesso

Added documentation about INI file

parent ec6e9a66
......@@ -4,28 +4,28 @@
0
1
Main_TLU.tex
16
17
12
0
1
Main_TLU.tex
TeX
403714043 0 -1 4536 -1 4537 75 75 1448 573 0 1 265 578 -1 -1 0 0 43 -1 -1 43 1 0 4537 -1 0 -1 0
EUDAQParameters.tex
135278587 0 -1 4536 -1 4500 75 75 1448 573 0 1 193 560 -1 -1 0 0 43 -1 -1 43 1 0 4500 -1 0 -1 0
ch_EUDAQParameters.tex
TeX
1060859 0 -1 44 -1 45 275 275 2188 952 0 1 41 17 -1 -1 0 0 -1 -1 -1 -1 1 0 45 -1 0 -1 0
269496315 4 -1 4243 -1 4244 300 300 2213 977 0 1 721 544 -1 -1 0 0 -1 -1 -1 -1 1 0 4244 -1 0 -1 0
ch_TLU_Preparation.tex
TeX
1060859 1 -1 64 -1 74 150 150 1523 648 0 1 273 17 -1 -1 0 0 43 -1 -1 43 1 0 74 -1 0 -1 0
1060859 0 -1 2428 -1 2401 150 150 1523 648 0 1 137 408 -1 -1 0 0 43 -1 -1 43 1 0 2401 -1 0 -1 0
ch_TLU_Hardware.tex
TeX
1060859 0 -1 1910 -1 1570 200 200 1573 698 0 1 425 238 -1 -1 0 0 41 -1 -1 41 1 0 1570 -1 0 -1 0
1060859 0 -1 2604 -1 2778 200 200 1573 698 0 1 369 493 -1 -1 0 0 41 -1 -1 41 1 0 2778 -1 0 -1 0
ch_TLU_Functions.tex
TeX
1060859 0 22 71 -1 3888 0 0 1398 472 0 1 233 561 -1 -1 0 0 39 -1 -1 39 1 0 3888 -1 0 -1 0
ch_TLU_IPBusRegs.tex
TeX
17838075 1 -1 14645 -1 14630 25 25 1423 497 0 1 249 442 -1 -1 0 0 45 -1 -1 45 1 0 14630 -1 0 -1 0
17838075 1 -1 14645 -1 14630 25 25 1423 497 0 1 249 169 -1 -1 0 0 45 -1 -1 45 1 0 14630 -1 0 -1 0
ch_TLU_Appendix.tex
TeX
1060859 4 -1 36 -1 37 175 175 1548 673 0 1 337 0 -1 -1 0 0 37 -1 -1 37 1 0 37 -1 0 -1 0
......@@ -37,13 +37,16 @@ TeX
1060859 0 -1 3508 -1 3508 100 100 1473 598 0 1 553 561 -1 -1 0 0 31 -1 -1 31 1 0 3508 -1 0 -1 0
ch_TLU_triggerInputs.tex
TeX
17838075 0 -1 24307 -1 24306 100 100 1473 598 0 1 977 782 -1 -1 0 0 48 -1 -1 48 1 0 24306 -1 0 -1 0
17838075 0 -1 24307 -1 24306 100 100 1473 598 0 1 977 1496 -1 -1 0 0 48 -1 -1 48 1 0 24306 -1 0 -1 0
ch_EventBuffer.tex
TeX
1060859 0 -1 545 -1 563 125 125 1498 623 0 1 41 204 -1 -1 0 0 44 -1 -1 44 1 0 563 -1 0 -1 0
O:\LatexFiles\Glossary\myGlossary.tex
TeX
1060859 0 -1 891 -1 892 50 50 1423 548 0 1 633 85 -1 -1 0 0 61 -1 -1 61 1 0 892 -1 0 0 0
EUDAQParameters.tex
TeX
269496315 0 -1 44 -1 45 275 275 2188 952 0 1 41 17 -1 -1 0 0 -1 -1 -1 -1 1 0 45 -1 0 -1 0
:\Dati\Latex files\CV\CVinglese.tex
TeX
269496315 0 -1 0 -1 0 25 25 1423 497 0 1 41 0 -1 -1 0 0 -1 -1 -1 -1 1 0 0 -1 0 -1 0
......@@ -69,4 +72,5 @@ TeX
*ch_TLU_Appendix
*ch_TLU_Functions
*ch_TLU_IPBusRegs
*ch_EUDAQParameters
<
\chapter{EUDAQ Parameters}\label{ch:EUDAQPar}
\ No newline at end of file
\chapter{EUDAQ Parameters}\label{ch:EUDAQPar}
List of parameters that are parsed by the EUDAQ run control \gls{gui} to configure the \gls{tlu}.\\
The parameters must be included in the INI or CONF file passed to the main window (see~fig.\ref{fig:EUDAQGui}).
\begin{figure}
\centering
\includegraphics[width=.90\textwidth]{./Images/RunControlGUI.jpg}
\caption{Main user iterface of the EUDAQ framework.}
\label{fig:EUDAQGui}
\end{figure}\\
Not all parameters are needed; if one of the parameters is not present in the files, the code will generally assume a default value, indicated in brackets in the following document \verb|[type, default]|.
\begin{description}
\item[initid] \verb|[string, "0"]| Does not serve any purpose in the code but can be useful to identify configuration settings used in a specific run. EUDAQ will store this information in the run data.
\item[ConnectionFile] \verb|[string, "file://./FMCTLU_connections.xml"]| Name of the xml file used to store the information required to communicate with the hardware, such as its IP address and the location of the address map. The default location indicates a file that must be located in the \texttt{bin} folder.
\item[DeviceName] \verb|[string, "fmctlu.udp"]| The name of the type of hardware to be contacted by the IPBus.
\item[TLUmod] \verb|[string, "1e"]| Version of the \gls{tlu} hardware. Reserved for future use.
\item[nDUTs] \verb|[positive int, 4]| Number of \gls{dut} in the current \gls{tlu}. This is for future upgrades and should not require editing by the user.
\item[nTrgIn] \verb|[positive int, 6]| Number of trigger inputs in the current \gls{tlu}. This is for future upgrades and should not require editing by the user.
\item[I2C\_COREEXP\_Addr] \verb|[positive int, 0x21]| \gls{i2c} address of the core expander mounted on the Enclustra board. This is not required if a different \gls{fpga} is used.
\item[I2C\_CLK\_Addr] \verb|[positive int, 0x68]| \gls{i2c} address of Si5345 clock generator installed on the \gls{tlu}.
\item[I2C\_DAC1\_Addr] \verb|[positive int, 0x13]| \gls{i2c} address of \gls{dac} installed on the \gls{tlu}. The \gls{dac} is used to configure the threshold of the trigger inputs.
\item[I2C\_DAC2\_Addr] \verb|[positive int, 0x1F]| \gls{i2c} address of \gls{dac} installed on the \gls{tlu}. The \gls{dac} is used to configure the threshold of the trigger inputs.
\item[I2C\_ID\_Addr] \verb|[positive int, 0x50]| \gls{i2c} address the unique ID \gls{eeprom} installed on the \gls{tlu}. The chip is used to provide a unique identifier to each kit.
\item[I2C\_EXP1\_Addr] \verb|[positive int, 0x74]| \gls{i2c} address the bus expander used to select the direction of the \gls{hdmi} pins on the board.
\item[I2C\_EXP2\_Addr] \verb|[positive int, 0x75]| \gls{i2c} address the bus expander used to select the direction of the \gls{hdmi} pins on the board.
\item[intRefOn] \verb|[boolean, false]| If true, the \gls{dac}s installed on the \gls{tlu} will use their internal voltage reference rather than the one provide externally.
\item[VRefInt] \verb|[float, 2.5]| Value in volts for the internal reference voltage of the \gls{dac}s. The voltage is chosen by the chip manufacturer. This is only used if \verb|intRefOn= true|.
\item[VRefExt] \verb|[float, 1.3]| Value in volts for the external reference voltage of the \gls{dac}s. The voltage is determined by a circuit on the \gls{tlu} and the value of this parameter must reflect such voltage. This is only used if \verb|intRefOn= false|.
\item[CONFCLOCK] \verb|[bool, true]| If true, the clock chip Si5345 will be re-configured when the INIT button is pressed (see figure~fig.\ref{fig:EUDAQGui}). The chip is configured via \gls{i2c} interface using a specific text file (see next parameter). After a power cycle, the chip is not configured and must be reconfigured to operate the \gls{tlu} correctly.
\item[CLOCK\_CFG\_FILE] \verb|[string, "./../user/eudet/misc/fmctlu_clock_config.txt"]| Name of the text file used to store the configuration values of the Si5345. The file can be generate using the Clockbuilder Pro software provided by \href{https://www.silabs.com/products/development-tools/software/clock}{SiLabs}.
\end{description}
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