Skip to content

Commit a426777

Browse files
committed
Making more consistent references; applying formatting changes from Larry
1 parent 1f904e6 commit a426777

3 files changed

Lines changed: 27 additions & 26 deletions

File tree

docs/README_fab.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Materials and thicknesses according to the board stackup description:
2626
marble-stack.txt
2727

2828
Two Class 2 via types are utilized:
29-
- 0.152mm (6.0mil) finished hole size, +0.076mm/-0.152mm(+3mil/-6mil), with a 0.35mm (13.7mil) pad
29+
- 0.152mm (6.0mil) finished hole size, +0.076mm/-0.152mm (+3mil/-6mil), with a 0.35mm (13.7mil) pad
3030
- 0.350mm (13.8mil) finished hole size, +0.076mm/-0.350mm (+3mil/-13.8mil), with a 0.60mm (23.6mil) pad
3131
The standard hole size tolerances above indicate that the via hole diameter after
3232
plating is not critical, in fact, it is acceptable if the via is completely filled.

docs/marble_test_guide/Marble_Test_Guide.tex

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ \subsection{Hardware requirements}
7272
\item QSFP loopback module.
7373
\item FMC Tester module.
7474
\item Multimeter.
75-
\item MMC JTAG (either SEGGER J-LINK mini or STMicroelectronics ST-Link V2).
75+
\item MMC JTAG (either SEGGER J-Link Mini or STMicroelectronics ST-Link V2).
7676
\item FPGA JTAG (example: Digilent JTAG HS3).
7777
\end{enumerate}
7878

@@ -129,14 +129,15 @@ \section{Power connection}\label{sec:Power_Connection}
129129
\end{leftbar}
130130

131131
It is also highly recommended at this point to attach silicone feet (bumpers) to the bottom of the board to avoid
132-
short circuits from resting on a conductive surface. See \texttt{doc/README\_fab.txt} for details.
132+
both mechanical component damage in general and short circuits if resting on a conductive surface.
133+
See \texttt{doc/README\_fab.txt} for details.
133134

134-
If the resistance is correct, connect the main power. For this purpose, the current limitation on the power supply should be set to 100mA and the voltage to 12V. \textbf{Make sure that the current limit of the laboratory power supply is on.} Now the power cable can be connected to the board and the used laboratory power supply channel can be switched on.
135-
This should result in the \textit{3.3V} and \textit{12V} LEDs lighting up as shown on Figure \ref{02}. Now it is recommended to go to section \nameref{microcontroller}.
135+
If the resistance is correct, connect the main power. For this purpose, the current limitation on the power supply should be set to 100\thinspace mA and the voltage to \hbox{12\thinspace V}. \textbf{Make sure that the current limit of the laboratory power supply is on.} Now the power cable can be connected to the board and the used laboratory power supply channel can be switched on.
136+
This should result in the \textit{3.3V} and \textit{12V} LEDs lighting up as shown on Figure \ref{fig:12V_led}. Now it is recommended to go to section \nameref{microcontroller}.
136137
\begin{figure}[H]
137138
\begin{center}
138139
\includegraphics[width=0.8\linewidth, angle = 180]{xrpoff.png}
139-
\caption{12V indicator LED is on. }\label{02}
140+
\caption{12V indicator LED is on. }\label{fig:12V_led}
140141
\end{center}
141142
\end{figure}
142143

@@ -150,7 +151,7 @@ \section{Microcontroller Programming}
150151

151152
A recent version of OpenOCD (v0.10.0 or later) is required.
152153
\begin{enumerate}
153-
\item Connect JTAG module to \textbf{J14} as shown on Figure \ref{23}.
154+
\item Connect JTAG module to \textbf{J14} as shown on Figure \ref{fig:j14}.
154155
\item Connect the micro USB cable and using the serial terminal, connect to the last serial port for the new listed device in the operating system. Use 115200 baudrate.
155156
\item Power up the board.
156157
\item Program the microcontroller using the following commands:
@@ -167,7 +168,7 @@ \section{Microcontroller Programming}
167168
\begin{figure}[H]
168169
\begin{center}
169170
\includegraphics[width=0.8\linewidth]{mmcjtag.png}
170-
\caption{J14 connector. }\label{23}
171+
\caption{J14 connector. }\label{fig:j14}
171172
\end{center}
172173
\end{figure}
173174

@@ -178,34 +179,34 @@ \section{Power Supply Programming}
178179

179180
\begin{enumerate}
180181
\item Connect the micro USB cable and note the serial device name assigned to it (i.e. /dev/ttyUSB3). It will always be the last port of a group of 4 associated with the Marble's FT4232 USB-to-UART.
181-
\item Set up voltage to 12V and the current limit to 1A on a lab power supply.
182+
\item Set up voltage to 12\thinspace V and the current limit to 1\thinspace A on a lab power supply.
182183
\item Power up the board.
183184
\item Open a terminal in the Marble-MMC repository downloaded in section 3.
184185
\item Run the LTM4673 programming script (where \$TTY is the serial device name noted above):
185186
\begin{lstlisting}[backgroundcolor = \color{Gainsboro}, language=bash, frame=none]]
186187
$ sh scripts/program_ltm4673.sh $TTY -f LTM4673_reglist.txt -s
187188
\end{lstlisting}
188189
\item Power cycle by turning the lab power supply Off and then On.
189-
\item All power LED indicators should be On (Figure \ref{leds}).
190+
\item All power LED indicators should be On (Figure \ref{fig:leds}).
190191
\item Using multimeter measure the voltage between the test points:
191192
\begin{enumerate}
192-
\item \textbf{TP12 (GND)} and \textbf{TP7 (+2V0)} - expected voltage: +2.0V.
193-
\item \textbf{TP12 (GND)} and \textbf{TP9 (+1V0)} - expected voltage: +1.0V.
194-
\item \textbf{TP12 (GND)} and \textbf{TP10 (+2V5)} - expected voltage: +2.5V.
195-
\item \textbf{TP12 (GND)} and \textbf{TP8 (+1V8)} - expected voltage: +1.8V.
196-
\item \textbf{TP12 (GND)} and \textbf{TP6 (+1V5)} - expected voltage: +1.5V.
197-
\item \textbf{TP12 (GND)} and \textbf{TP4 (+1V2)} - expected voltage: +1.2V.
198-
\item \textbf{TP12 (GND)} and \textbf{TP11 (+3V3)} - expected voltage: +3.3V.
199-
\item \textbf{TP12 (GND)} and \textbf{TP15 (+3V3USB)} - expected voltage: +3.3V.
200-
\item \textbf{TP12 (GND)} and \textbf{TP14 (+3V3P)} - expected voltage: +3.3V.
201-
\item \textbf{TP12 (GND)} and \textbf{TP5 (+1V05)} - expected voltage: +1.05V.
193+
\item \textbf{TP12 (GND)} and \textbf{TP7 (+2V0)} - expected voltage: +2.0\thinspace V.
194+
\item \textbf{TP12 (GND)} and \textbf{TP9 (+1V0)} - expected voltage: +1.0\thinspace V.
195+
\item \textbf{TP12 (GND)} and \textbf{TP10 (+2V5)} - expected voltage: +2.5\thinspace V.
196+
\item \textbf{TP12 (GND)} and \textbf{TP8 (+1V8)} - expected voltage: +1.8\thinspace V.
197+
\item \textbf{TP12 (GND)} and \textbf{TP6 (+1V5)} - expected voltage: +1.5\thinspace V.
198+
\item \textbf{TP12 (GND)} and \textbf{TP4 (+1V2)} - expected voltage: +1.2\thinspace V.
199+
\item \textbf{TP12 (GND)} and \textbf{TP11 (+3V3)} - expected voltage: +3.3\thinspace V.
200+
\item \textbf{TP12 (GND)} and \textbf{TP15 (+3V3USB)} - expected voltage: +3.3\thinspace V.
201+
\item \textbf{TP12 (GND)} and \textbf{TP14 (+3V3P)} - expected voltage: +3.3\thinspace V.
202+
\item \textbf{TP12 (GND)} and \textbf{TP5 (+1V05)} - expected voltage: +1.05\thinspace V.
202203
\end{enumerate}
203204
\end{enumerate}
204205

205206
\begin{figure}[H]
206207
\begin{center}
207208
\includegraphics[width=0.7\linewidth]{leds.png}
208-
\caption{Power LED indicators after a successful power cycle.}\label{leds}
209+
\caption{Power LED indicators after a successful power cycle.}\label{fig:leds}
209210
\end{center}
210211
\end{figure}
211212

@@ -272,20 +273,20 @@ \subsection{QSFP test}
272273
\item Configure FPGA using \texttt{marble\_ibert.bit} bit file.
273274
\begin{enumerate}
274275
\item Run Vivado
275-
\item Go to \menu{Flow>Open Hardware Manager} and then \menu{Tools>Auto Connect}
276+
\item Go to \menu{Flow>Open Hardware Manager} and then \menu{Tools>Auto Connect}
276277
\item Click \menu{Tools>Program Device>xc7k160t\_0} to open the programming window.
277278
\item Choose the \textit{bitstream file} and click \menu{Program}
278279
\end{enumerate}
279280
\item After successful programming, the Dashboard should start automatically.
280281
\item Detect links by clicking \menu{Serial I/O Links>Auto-detect links}
281-
\item Correctly detected and working links should appear as shown in figure \ref{links}.
282+
\item Correctly detected and working links should appear as shown in figure \ref{fig:links}.
282283
\item Connect the QSFP loopback module to the other QSFP connector and repeat the steps above.
283284
\end{enumerate}
284285

285286
\begin{figure}[H]
286287
\begin{center}
287288
\includegraphics[width=1\linewidth]{links.png}
288-
\caption{Working links.}\label{links}
289+
\caption{Working links.}\label{fig:links}
289290
\end{center}
290291
\end{figure}
291292

@@ -331,7 +332,7 @@ \subsection{An alternative way to program FPGA}
331332
Programming FPGA using Vivado and Digilent JTAG HS3:
332333
\begin{enumerate}
333334
\item Run Vivado
334-
\item Go to \menu{Flow>Open Hardware Manager} and then \menu{Tools>Auto Connect}
335+
\item Go to \menu{Flow>Open Hardware Manager} and then \menu{Tools>Auto Connect}
335336
\item Click \menu{Tools>Program Device>xc7k160t\_0} to open the programming window.
336337
\item Choose the \textit{bitstream file} and click \menu{Program}
337338

docs/marble_user_guide/Marble_User_Guide.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -655,7 +655,7 @@ \section{MMC}\label{sec:MMC}
655655
\end{enumerate}
656656

657657
\subsection{Programming}\label{sec:MMC:Programming}
658-
MMC programming can be done by using external tools such as STM Nucleo-SWD programmer, SEGGER J-LINK Mini (Fig. \ref{mmcjtag}, Fig. \ref{mmcjtagswd}).
658+
MMC programming can be done by using external tools such as STM Nucleo-SWD programmer, SEGGER J-Link Mini (Fig. \ref{mmcjtag}, Fig. \ref{mmcjtagswd}).
659659

660660
\begin{figure}[H]
661661
\begin{center}

0 commit comments

Comments
 (0)