Add pkg-config to the list of requirements.

[fw/stlink] / doc / tutorial / tutorial.tex

diff --git a/doc/tutorial/tutorial.tex b/doc/tutorial/tutorial.tex
index f177e2b87c703c012f64e4411ab9a712b21385e1..2045d77dac7b231e942d08d9e4f8dde41511dde2 100644 (file)
--- a/doc/tutorial/tutorial.tex
+++ b/doc/tutorial/tutorial.tex
@@ -24,7 +24,7 @@
 \section{Overview}
 \paragraph{}
 This guide details the use of STMicroelectronics STM32 discovery kits in
 \section{Overview}
 \paragraph{}
 This guide details the use of STMicroelectronics STM32 discovery kits in

-an opensource environment.
+an open source environment.

 
 
 \newpage
 
 
 \newpage


@@ -48,61 +48,82 @@ This documentation assumes the toolchains is installed in a \$TOOLCHAIN\_PATH.
 
 \section{Installing STLINK}
 \paragraph{}
 
 \section{Installing STLINK}
 \paragraph{}

-STLINK is an opensource software to program and debug the discovery kits. Those
+STLINK is open source software to program and debug ST's STM32 Discovery kits. Those

 kits have an onboard chip that translates USB commands sent by the host PC into
 kits have an onboard chip that translates USB commands sent by the host PC into

-JTAG commands. This chip is called STLINK, which is confusing since the software
-has the same name. It comes into 2 versions (STLINK v1 and v2). From a software
+JTAG/SWD commands. This chip is called STLINK, (yes, isn't that confusing? suggest a better
+name!)  and comes in 2 versions (STLINK v1 and v2). From a software

 point of view, those versions differ only in the transport layer used to communicate
 point of view, those versions differ only in the transport layer used to communicate

-(v1 uses SCSI passthru commands, while v2 uses raw USB).
+(v1 uses SCSI passthru commands, while v2 uses raw USB).  From a user point of view, they 
+are identical. 

 
 \paragraph{}
 
 \paragraph{}

-Before continuing, the following dependencies are required:
+Before continuing, the following dependencies must be met:

 \begin{itemize}
 \item libusb-1.0
 \begin{itemize}
 \item libusb-1.0

-\item libsg2
+\item pkg-config

 \end{itemize}
 
 \end{itemize}
 

+\paragraph{}
+STLINK should run on any system meeting the above constraints.
+

 \paragraph{}
 The STLINK software source code is retrieved using:\\
 \begin{small}
 \begin{lstlisting}[frame=tb]
 \paragraph{}
 The STLINK software source code is retrieved using:\\
 \begin{small}
 \begin{lstlisting}[frame=tb]

-git clone https://github.com/texane/stlink stlink.git
+$> git clone https://github.com/texane/stlink stlink.git

 \end{lstlisting}
 \end{small}
 
 \paragraph{}
 \end{lstlisting}
 \end{small}
 
 \paragraph{}

-The GDB server is called st-util and is built using:\\
+Everything can be built from the top directory:\\

 \begin{small}
 \begin{lstlisting}[frame=tb]
 \begin{small}
 \begin{lstlisting}[frame=tb]

-$> cd stlink.git;
-$> make ;
-$> cd gdbserver ;
-$> make ;
+$> cd stlink.git
+$> make 

 \end{lstlisting}
 \end{small}
 \end{lstlisting}
 \end{small}

+It includes:
+\begin{itemize}
+\item a communication library (stlink.git/libstlink.a),
+\item a GDB server (stlink.git/gdbserver/st-util),
+\item a flash manipulation tool (stlink.git/flash/flash).
+\end{itemize}

 
 
 \newpage
 
 
 \newpage

-
-\section{Building and running a program}
+\section{Building and running a program in SRAM}
+\paragraph{}

 A simple LED blinking example is provided in the example directory. It is built using:\\
 \begin{small}
 \begin{lstlisting}[frame=tb]
 cd stlink.git/example/blink ;
 A simple LED blinking example is provided in the example directory. It is built using:\\
 \begin{small}
 \begin{lstlisting}[frame=tb]
 cd stlink.git/example/blink ;

-PATH=$TOOLCHAIN_PATH/bin:$PATH make ;
+PATH=$TOOLCHAIN_PATH/bin:$PATH make

 \end{lstlisting}
 \end{small}
 \end{lstlisting}
 \end{small}

+This builds three files, one for each of the Discovery boards currently
+available, linked to run from SRAM. (So no risk of overwriting anything you didn't mean to) 
+These blink examples can safely be used to verify that:
+
+\begin{itemize}
+\item Your installed toolchain is capable of compiling for cortex M3/M4 targets
+\item stlink is functional
+\item Your arm-none-eabi-gdb is functional
+\item Your board is functional
+\end{itemize}

 
 \paragraph{}
 
 \paragraph{}

-A GDB server must be start to interact with the STM32. Depending on the discovery kit you
+A GDB server must be started to interact with the STM32. Depending on the discovery kit you

 are using, you must run one of the 2 commands:\\
 \begin{small}
 \begin{lstlisting}[frame=tb]
 are using, you must run one of the 2 commands:\\
 \begin{small}
 \begin{lstlisting}[frame=tb]

-# STM32VL discovery kit
-$> sudo ./st-util /dev/sg2
+# STM32VL discovery kit (onboard ST-link)
+$> ./st-util --stlinkv1
+
+# STM32L or STM32F4 discovery kit (onboard ST-link/V2)
+$> ./st-util 

 
 

-# STM32L discovery kit
-$> sudo ./st-util
+# Full help for other options (listen port, version)
+$> ./st-util --help

 \end{lstlisting}
 \end{small}
 
 \end{lstlisting}
 \end{small}
 


@@ -127,7 +148,8 @@ By default, the program was linked such that the base address is 0x20000000. Fro
 memory map, GDB knows this address belongs to SRAM. To load the program in SRAM, simply use:\\
 \begin{small}
 \begin{lstlisting}[frame=tb]
 memory map, GDB knows this address belongs to SRAM. To load the program in SRAM, simply use:\\
 \begin{small}
 \begin{lstlisting}[frame=tb]

-$> load blink.elf
+$> # Choose one as appropriate for your Discovery kit
+$> load blink_32L.elf | load blink_32VL.elf | load blink_F4.elf

 \end{lstlisting}
 \end{small}
 
 \end{lstlisting}
 \end{small}
 


@@ -141,11 +163,79 @@ $> continue
 \end{small}
 
 \paragraph{}
 \end{small}
 
 \paragraph{}

-The board BLUE and GREEN leds should be blinking (those leds are near the user and reset buttons).
+All the LEDs on the board should now be blinking in time (those leds are near the user and reset buttons).
+
+\newpage
+\section{Building and flashing a program}
+\paragraph{}
+FLASH memory reading and writing is done by a separate tool, as shown below:\\
+\begin{small}
+\begin{lstlisting}[frame=tb]
+# change to the flash tool directory
+$> cd stlink.git/flash ;
+
+# stlinkv1 command to read 4096 from flash into out.bin
+$> ./flash read v1 out.bin 0x8000000 4096

 
 

+# stlinkv2 command
+$> ./flash read out.bin 0x8000000 4096
+
+# stlinkv1 command to write the file in.bin into flash
+$> ./flash write v1 in.bin 0x8000000
+
+# stlinkv2 command
+$> ./flash write in.bin 0x8000000
+\end{lstlisting}
+\end{small}
+
+\paragraph{}
+A LED blinking example is provided:\\
+\begin{small}
+\begin{lstlisting}[frame=tb]
+# build the example, resulting in blink.bin
+$> cd stlink.git/example/blink_flash
+$> PATH=$TOOLCHAIN_PATH:$PATH make CONFIG_STM32L_DISCOVERY=1
+
+# write blink.bin into FLASH
+$> sudo ./flash write blink.bin 0x08000000
+\end{lstlisting}
+\end{small}
+
+\paragraph{}
+Upon reset, the board LEDs should be blinking.
+
+\newpage
+\section{Building and installing the CHIBIOS kernel}
+\paragraph{}
+CHIBIOS is an open source RTOS. More information can be found on the project website:
+\begin{center}
+http://www.chibios.org/dokuwiki/doku.php
+\end{center}
+
+\paragraph{}
+It supports several boards, including the STM32L DISCOVERY kit:
+\begin{center}
+http://www.chibios.org/dokuwiki/doku.php?id=chibios:articles:stm32l\_discovery
+\end{center}
+
+\paragraph{}
+The installation procedure is detailed below:\\
+\begin{small}
+\begin{lstlisting}[frame=tb]
+# checkout and build CHIBIOS for STM32L DISCOVERY kits
+svn checkout https://chibios.svn.sourceforge.net/svnroot/chibios/trunk
+cd chibios/trunk/demos/ARMCM3-STM32L152-DISCOVERY
+PATH=$TOOLCHAIN_PATH:$PATH make
+
+# flash the image into STM32L
+sudo ./flash write build/ch.bin 0x08000000
+\end{lstlisting}
+\end{small}

 
 \newpage
 \section{Notes}
 
 \newpage
 \section{Notes}

+
+\subsection{Disassembling THUMB code in GDB}

 \paragraph{}
 By default, the disassemble command in GDB operates in ARM mode. The programs running on CORTEX-M3
 are compiled in THUMB mode. To correctly disassemble them under GDB, uses an odd address. For instance,
 \paragraph{}
 By default, the disassemble command in GDB operates in ARM mode. The programs running on CORTEX-M3
 are compiled in THUMB mode. To correctly disassemble them under GDB, uses an odd address. For instance,


@@ -157,6 +247,35 @@ $> disassemble 0x20000001
 \end{small}
 
 
 \end{small}
 
 

+\subsection{libstm32l\_discovery}
+\paragraph{}
+The repository includes the STM32L discovery library source code from ST original firmware packages,
+available here:\\
+\begin{small}
+\begin{lstlisting}[frame=tb]
+http://www.st.com/internet/evalboard/product/250990.jsp#FIRMWARE
+\end{lstlisting}
+\end{small}
+
+\paragraph{}
+It is built using:\\
+\begin{small}
+\begin{lstlisting}[frame=tb]
+$> cd stlink.git/example/libstm32l_discovery/build
+$> make
+\end{lstlisting}
+\end{small}
+
+\paragraph{}
+An example using the library can be built using:\\
+\begin{small}
+\begin{lstlisting}[frame=tb]
+$> cd stlink.git/example/lcd
+$> make
+\end{lstlisting}
+\end{small}
+
+

 \newpage
 \section{References}
 \begin{itemize}
 \newpage
 \section{References}
 \begin{itemize}