From: Hadaq in Frankfurt <hadaq@frankfurt>
Date: Fri, 15 Feb 2013 15:44:47 +0000 (+0100)
Subject: small clean-up, JM
X-Git-Url: https://jspc29.x-matter.uni-frankfurt.de/git/?a=commitdiff_plain;h=562aadff48575264f9749da84684885ceba5c366;p=daqdocu.git

small clean-up, JM
---

diff --git a/trb3/Trb3GeneralRemarks.tex b/trb3/Trb3GeneralRemarks.tex
index 88d2a93..6e97afb 100644
--- a/trb3/Trb3GeneralRemarks.tex
+++ b/trb3/Trb3GeneralRemarks.tex
@@ -1,4 +1,4 @@
-\subsubsection{Hardware Information}
+\subsection{Hardware Information}
 \begin{itemize*}
  \item Schematics \href{http://hades-wiki.gsi.de/pub/DaqSlowControl/TDCReadoutBoardV3/trbv3_SCHEMATIC_michael.pdf}{trbv3\_SCHEMATIC\_michael.pdf}
  \item Pin-out file for the peripheral FPGAs \href{cvs://:ext:hadaq@lxi001.gsi.de:/misc/hadesprojects/daq/cvsroot/trb3/base/trb3_periph.lpf}{cvsroot/trb3/base/trb3\_periph.lpf}
@@ -7,7 +7,7 @@
 
 
 
-\subsubsection{Board Identification}
+\subsection{Board Identification}
 \label{Trb3BoardID}
 The TRB3 boards are equipped with 5 temperature sensors, one for each FPGA. They contain a unique ID that is used to identify each FPGA. Additionally, the peripheral FPGAs have to bits identification (endpoint ID) corresponding to their position on the board.
 This information can be read out after the first initial programming of the FPGAs.
@@ -26,7 +26,7 @@ The combination of serial number and unique ids is given in the file \filename{s
 The first three digits of the SID is the serial number as written on the board, the fourth digit is an identifier for the FPGA number as printed on the PCB (central FPGA is FPGA 5, the others are numbered 1 to 4, but mapped to 0 to 3 in the file). Based on this file, a second file \filename{addresses.db} can be written for each individual set-up to assign each board the necessary network addresses.
 
 
-\subsubsection{Flash Programming}
+\subsection{Flash Programming}
 Typically only the first programming of a board is done with a JTAG cable, all later upgrades can be done directly via TrbNet to the Flash ROMs. The advantage is the increased speed (about a factor 10) and that no physical access to the board is necessary. The software needs some settings in the FPGA code to function properly:
 
 First, the name of the design has to contain a certain sub-string:
@@ -38,7 +38,7 @@ First, the name of the design has to contain a certain sub-string:
 Second, the upper 16 Bit of the Hardware Version register as described below is checked.
 
 
-\subsubsection{Design Identification}
+\subsection{Design Identification}
 The TrbNet endpoint has a generic setting \signal{Regio\_Hardware\_Version} (register 0x42) that has to be set according to the following rules:  The upper 16 Bit are used by the software to identify the hardware before programming the Flash to prevent loading invalid designs and have to contain one of the following values:
 \begin{description*}
  \item[9000] design is for the central FPGA
@@ -81,7 +81,7 @@ The lower 16 Bit are used to identify the contents of the design and the AddOn b
 
 Software versions can be stored in the generic \signal{Regio\_Compile\_Version} (register 0x41).
 
-\subsubsection{Network Addresses}
+\subsection{Network Addresses}
 All boards of a given type are accessible by a broadcast address at the same time. This is set by \signal{Broadcast\_Special\_Addr} in the TrbNet endpoint:
 \begin{itemize*}
  \item 0x40 for the central FPGA
diff --git a/trb3/main.tex b/trb3/main.tex
index 0f5af49..9ca3f5f 100755
--- a/trb3/main.tex
+++ b/trb3/main.tex
@@ -132,8 +132,6 @@
     \subsection{FPGA I/O Performance}
     \clearpage
   \section{TRB3 Platform}
-    \subsection{General Remarks}
-      \input{Trb3GeneralRemarks}
     \subsection{Known Bugs and Limitations}
       \input{Trb3KnownBugs}
     \subsection{Clock and Trigger Distribution}
@@ -156,7 +154,8 @@
   \cleardoublepage
 
 \part{Design Components}
-  \input{DesignComponents}
+  \section{General Remarks}
+    \input{Trb3GeneralRemarks}  
   \clearpage
   \section{TDC}
     \subsection{Building Blocks}
@@ -206,7 +205,6 @@
 
 \cleardoublepage
 \part{Synchronous TrbNet}
-  \section{Clock Measurements}
   \section{Media Interfaces}
     \input{SyncMediaInterface}
 
diff --git a/trb3/trb3.kilepr b/trb3/trb3.kilepr
index c0ee887..82d8f41 100644
--- a/trb3/trb3.kilepr
+++ b/trb3/trb3.kilepr
@@ -36,6 +36,16 @@ Indentation Mode=
 Mode=LaTeX
 ReadWrite=true
 
+[document-settings,item:CtsBuildingBlocks.tex]
+Bookmarks=
+Encoding=UTF-8
+FoldedColumns=
+FoldedLines=
+Highlighting=LaTeX
+Indentation Mode=
+Mode=LaTeX
+ReadWrite=true
+
 [document-settings,item:DacProgramming.tex]
 Bookmarks=
 Encoding=UTF-8
@@ -86,6 +96,16 @@ Indentation Mode=
 Mode=LaTeX
 ReadWrite=true
 
+[document-settings,item:SyncMediaInterface.tex]
+Bookmarks=
+Encoding=UTF-8
+FoldedColumns=
+FoldedLines=
+Highlighting=LaTeX
+Indentation Mode=
+Mode=LaTeX
+ReadWrite=true
+
 [document-settings,item:TdcAddOn.tex]
 Bookmarks=
 Encoding=UTF-8
@@ -156,12 +176,52 @@ Indentation Mode=
 Mode=LaTeX
 ReadWrite=true
 
+[document-settings,item:trb3qs_daqstartup.tex]
+Bookmarks=
+Encoding=UTF-8
+FoldedColumns=
+FoldedLines=
+Highlighting=LaTeX
+Indentation Mode=
+Mode=LaTeX
+ReadWrite=true
+
+[document-settings,item:trb3qs_preamble.tex]
+Bookmarks=
+Encoding=UTF-8
+FoldedColumns=
+FoldedLines=
+Highlighting=LaTeX
+Indentation Mode=
+Mode=LaTeX
+ReadWrite=true
+
+[document-settings,item:trb3qs_software.tex]
+Bookmarks=
+Encoding=UTF-8
+FoldedColumns=
+FoldedLines=
+Highlighting=LaTeX
+Indentation Mode=
+Mode=LaTeX
+ReadWrite=true
+
+[document-settings,item:trb3qs_suse.tex]
+Bookmarks=
+Encoding=UTF-8
+FoldedColumns=
+FoldedLines=
+Highlighting=LaTeX
+Indentation Mode=
+Mode=LaTeX
+ReadWrite=true
+
 [item:CodeRepository.tex]
 archive=true
-column=83
+column=24
 encoding=UTF-8
 highlight=LaTeX
-line=3
+line=7
 mode=LaTeX
 open=true
 order=9
@@ -176,6 +236,16 @@ mode=LaTeX
 open=true
 order=12
 
+[item:CtsBuildingBlocks.tex]
+archive=true
+column=0
+encoding=UTF-8
+highlight=LaTeX
+line=0
+mode=LaTeX
+open=true
+order=18
+
 [item:DacProgramming.tex]
 archive=true
 column=0
@@ -188,10 +258,10 @@ order=11
 
 [item:GbEGettingStarted.tex]
 archive=true
-column=0
+column=32
 encoding=UTF-8
 highlight=LaTeX
-line=0
+line=36
 mode=LaTeX
 open=true
 order=1
@@ -226,6 +296,16 @@ mode=LaTeX
 open=true
 order=7
 
+[item:SyncMediaInterface.tex]
+archive=true
+column=47
+encoding=UTF-8
+highlight=LaTeX
+line=46
+mode=LaTeX
+open=true
+order=14
+
 [item:TdcAddOn.tex]
 archive=true
 column=0
@@ -238,7 +318,7 @@ order=5
 
 [item:TdcSlowControl.tex]
 archive=true
-column=97
+column=16
 encoding=UTF-8
 highlight=LaTeX
 line=37
@@ -291,7 +371,7 @@ archive=true
 column=0
 encoding=UTF-8
 highlight=LaTeX
-line=106
+line=207
 mode=LaTeX
 open=true
 order=0
@@ -306,9 +386,49 @@ mode=
 open=false
 order=-1
 
+[item:trb3qs_daqstartup.tex]
+archive=true
+column=0
+encoding=UTF-8
+highlight=LaTeX
+line=19
+mode=LaTeX
+open=true
+order=17
+
+[item:trb3qs_preamble.tex]
+archive=true
+column=72
+encoding=UTF-8
+highlight=LaTeX
+line=76
+mode=LaTeX
+open=true
+order=19
+
+[item:trb3qs_software.tex]
+archive=true
+column=0
+encoding=UTF-8
+highlight=LaTeX
+line=79
+mode=LaTeX
+open=true
+order=15
+
+[item:trb3qs_suse.tex]
+archive=true
+column=0
+encoding=UTF-8
+highlight=LaTeX
+line=0
+mode=LaTeX
+open=true
+order=16
+
 [view-settings,view=0,item:CodeRepository.tex]
-CursorColumn=83
-CursorLine=3
+CursorColumn=24
+CursorLine=7
 JumpList=
 ViMarks=
 
@@ -318,6 +438,12 @@ CursorLine=0
 JumpList=
 ViMarks=
 
+[view-settings,view=0,item:CtsBuildingBlocks.tex]
+CursorColumn=0
+CursorLine=0
+JumpList=
+ViMarks=
+
 [view-settings,view=0,item:DacProgramming.tex]
 CursorColumn=0
 CursorLine=57
@@ -325,8 +451,8 @@ JumpList=
 ViMarks=
 
 [view-settings,view=0,item:GbEGettingStarted.tex]
-CursorColumn=0
-CursorLine=0
+CursorColumn=32
+CursorLine=36
 JumpList=
 ViMarks=
 
@@ -348,6 +474,12 @@ CursorLine=2
 JumpList=
 ViMarks=
 
+[view-settings,view=0,item:SyncMediaInterface.tex]
+CursorColumn=47
+CursorLine=46
+JumpList=
+ViMarks=
+
 [view-settings,view=0,item:TdcAddOn.tex]
 CursorColumn=0
 CursorLine=1
@@ -355,7 +487,7 @@ JumpList=
 ViMarks=
 
 [view-settings,view=0,item:TdcSlowControl.tex]
-CursorColumn=97
+CursorColumn=16
 CursorLine=37
 JumpList=
 ViMarks=
@@ -386,6 +518,30 @@ ViMarks=
 
 [view-settings,view=0,item:main.tex]
 CursorColumn=0
-CursorLine=106
+CursorLine=207
+JumpList=
+ViMarks=
+
+[view-settings,view=0,item:trb3qs_daqstartup.tex]
+CursorColumn=0
+CursorLine=19
+JumpList=
+ViMarks=
+
+[view-settings,view=0,item:trb3qs_preamble.tex]
+CursorColumn=72
+CursorLine=76
+JumpList=
+ViMarks=
+
+[view-settings,view=0,item:trb3qs_software.tex]
+CursorColumn=0
+CursorLine=79
+JumpList=
+ViMarks=
+
+[view-settings,view=0,item:trb3qs_suse.tex]
+CursorColumn=0
+CursorLine=0
 JumpList=
 ViMarks=
diff --git a/trb3/trb3qs_part.tex b/trb3/trb3qs_part.tex
index 8a3b188..f1115d9 100644
--- a/trb3/trb3qs_part.tex
+++ b/trb3/trb3qs_part.tex
@@ -1,4 +1,4 @@
-\part{Quick Start}
+\part{Software Quick Start}
 
 \lstset{
 %   basicstyle=\small
@@ -7,12 +7,9 @@
 	morecomment=[l][\ttfamily]{\#!},
 }
 
-\begin{abstract}
-This Quick Start manual describes way how to quickly run your TRB3. Is written
-in easy way that every, even not advanced in Linux systems users should be
-able to run his own TRB3. After successful passing this manual we recommend your
-to read man documentation for TRB3 which is much more detailed.
-\end{abstract}
+This section is supposed to give a quick overview of the steps to take to get a running TRB3 set-up. It includes installing software and configuring your PC with all necessary settings.
+
+Note that most set-ups use a openSUSE 64 Bit installation - on other distributions things are likely to differ in more or less subtle ways...
 
 \input{trb3qs_suse}
 \input{trb3qs_software}