git.gag.com Git - fw/stlink/blob - doc/tutorial/tutorial.tex

   1 \documentclass[a4paper, 11pt]{article}
   2
   3 \usepackage{graphicx}
   4 \usepackage{graphics}
   5 \usepackage{verbatim}
   6 \usepackage{listings}
   7 \usepackage{color}
   8
   9 \begin{document}
  10
  11 \title{Using STM32 discovery kits with open source tools}
  12 \author{STLINK development team}
  13 \date{}
  14
  15 \maketitle
  16
  17 \newpage
  18 \tableofcontents
  19 \addtocontents{toc}{\protect\setcounter{tocdepth}{1}}
  20
  21
  22 \newpage
  23
  24 \section{Overview}
  25 \paragraph{}
  26 This guide details the use of STMicroelectronics STM32 discovery kits in
  27 an opensource environment.
  28
  29
  30 \newpage
  31
  32 \section{Installing a GNU toolchain}
  33 \paragraph{}
  34 Any toolchain supporting the cortex m3 should do. You can find the necessary
  35 to install such a toolchain here:\\
  36 \begin{small}
  37 \begin{lstlisting}[frame=tb]
  38 https://github.com/esden/summon-arm-toolchain
  39 \end{lstlisting}
  40 \end{small}
  41
  42 \paragraph{}
  43 Details for the installation are provided in the topmost README file.
  44 This documentation assumes the toolchains is installed in a \$TOOLCHAIN\_PATH.
  45
  46
  47 \newpage
  48
  49 \section{Installing STLINK}
  50 \paragraph{}
  51 STLINK is an opensource software to program and debug the discovery kits. Those
  52 kits have an onboard chip that translates USB commands sent by the host PC into
  53 JTAG commands. This chip is called STLINK, which is confusing since the software
  54 has the same name. It comes into 2 versions (STLINK v1 and v2). From a software
  55 point of view, those versions differ only in the transport layer used to communicate
  56 (v1 uses SCSI passthru commands, while v2 uses raw USB).
  57
  58 \paragraph{}
  59 Before continuing, the following dependencies must be met:
  60 \begin{itemize}
  61 \item libusb-1.0
  62 \item libsgutils2 (optionnal)
  63 \end{itemize}
  64
  65 \paragraph{}
  66 STLINK should run on any system meeting the above constraints.
  67
  68 \paragraph{}
  69 The STLINK software source code is retrieved using:\\
  70 \begin{small}
  71 \begin{lstlisting}[frame=tb]
  72 $> git clone https://github.com/texane/stlink stlink.git
  73 \end{lstlisting}
  74 \end{small}
  75
  76 \paragraph{}
  77 Everything can be built from the top directory:\\
  78 \begin{small}
  79 \begin{lstlisting}[frame=tb]
  80 $> cd stlink.git
  81 $> make CONFIG_USE_LIBSG=0
  82 \end{lstlisting}
  83 \end{small}
  84 It includes:
  85 \begin{itemize}
  86 \item a communication library (stlink.git/libstlink.a),
  87 \item a GDB server (stlink.git/gdbserver/st-util),
  88 \item a flash manipulation tool (stlink.git/flash/flash).
  89 \end{itemize}
  90
  91
  92 \newpage
  93
  94 \section{Building and running a program}
  95 A simple LED blinking example is provided in the example directory. It is built using:\\
  96 \begin{small}
  97 \begin{lstlisting}[frame=tb]
  98 # update the make option accordingly to your architecture
  99 cd stlink.git/example/blink ;
 100 PATH=$TOOLCHAIN_PATH/bin:$PATH make CONFIG_STM32L_DISCOVERY=1;
 101 \end{lstlisting}
 102 \end{small}
 103
 104 \paragraph{}
 105 A GDB server must be start to interact with the STM32. Depending on the discovery kit you
 106 are using, you must run one of the 2 commands:\\
 107 \begin{small}
 108 \begin{lstlisting}[frame=tb]
 109 # STM32VL discovery kit (onboard ST-link)
 110 $> sudo ./st-util --stlinkv1 [-d /dev/sg2]
 111
 112 # STM32L discovery kit (onboard ST-link/V2)
 113 $> sudo ./st-util
 114
 115 # Full help for other options (listen port, version)
 116 $> ./st-util --help
 117 \end{lstlisting}
 118 \end{small}
 119
 120 \paragraph{}
 121 Then, GDB can be used to interact with the kit:\\
 122 \begin{small}
 123 \begin{lstlisting}[frame=tb]
 124 $> $TOOLCHAIN_PATH/bin/arm-none-eabi-gdb
 125 \end{lstlisting}
 126 \end{small}
 127
 128 \paragraph{}
 129 From GDB, connect to the server using:\\
 130 \begin{small}
 131 \begin{lstlisting}[frame=tb]
 132 $> target extended localhost:4242
 133 \end{lstlisting}
 134 \end{small}
 135
 136 \paragraph{}
 137 By default, the program was linked such that the base address is 0x20000000. From the architecture
 138 memory map, GDB knows this address belongs to SRAM. To load the program in SRAM, simply use:\\
 139 \begin{small}
 140 \begin{lstlisting}[frame=tb]
 141 $> load blink.elf
 142 \end{lstlisting}
 143 \end{small}
 144
 145 \paragraph{}
 146 GDB automatically set the PC register to the correct value, 0x20000000 in this case. Then, you
 147 can run the program using:\\
 148 \begin{small}
 149 \begin{lstlisting}[frame=tb]
 150 $> continue
 151 \end{lstlisting}
 152 \end{small}
 153
 154 \paragraph{}
 155 The board BLUE and GREEN leds should be blinking (those leds are near the user and reset buttons).
 156
 157
 158 \newpage
 159 \section{Reading and writing to flash}
 160 \paragraph{}
 161 Flash memory reading and writing is done by a separate tool. A binary running in flash is assumed to
 162 be linked against address 0x8000000. The flash tool is then used as shown below:\\
 163 \begin{small}
 164 \begin{lstlisting}[frame=tb]
 165 # change to the flash tool directory
 166 $> cd stlink.git/flash ;
 167
 168 # stlinkv1 command to read 4096 from flash into out.bin
 169 $> ./flash read /dev/sg2 out.bin 0x8000000 4096
 170
 171 # stlinkv2 command
 172 $> ./flash read out.bin 0x8000000 4096
 173
 174 # stlinkv1 command to write the file in.bin into flash
 175 $> ./flash write /dev/sg2 in.bin 0x8000000
 176
 177 # stlinkv2 command
 178 $> ./flash write in.bin 0x8000000
 179 \end{lstlisting}
 180 \end{small}
 181
 182
 183 \newpage
 184 \section{Notes}
 185
 186 \subsection{Disassembling THUMB code in GDB}
 187 \paragraph{}
 188 By default, the disassemble command in GDB operates in ARM mode. The programs running on CORTEX-M3
 189 are compiled in THUMB mode. To correctly disassemble them under GDB, uses an odd address. For instance,
 190 if you want to disassemble the code at 0x20000000, use:\\
 191 \begin{small}
 192 \begin{lstlisting}[frame=tb]
 193 $> disassemble 0x20000001
 194 \end{lstlisting}
 195 \end{small}
 196
 197
 198 \subsection{libstm32l\_discovery}
 199 \paragraph{}
 200 The repository includes the STM32L discovery library source code from ST original firmware packages,
 201 available here:\\
 202 \begin{small}
 203 \begin{lstlisting}[frame=tb]
 204 http://www.st.com/internet/evalboard/product/250990.jsp#FIRMWARE
 205 \end{lstlisting}
 206 \end{small}
 207
 208 \paragraph{}
 209 It is built using:\\
 210 \begin{small}
 211 \begin{lstlisting}[frame=tb]
 212 $> cd stlink.git/example/libstm32l_discovery/build
 213 $> make
 214 \end{lstlisting}
 215 \end{small}
 216
 217 \paragraph{}
 218 An example using the library can be built using:\\
 219 \begin{small}
 220 \begin{lstlisting}[frame=tb]
 221 $> cd stlink.git/example/lcd
 222 $> make
 223 \end{lstlisting}
 224 \end{small}
 225
 226 \subsection{STM32VL support}
 227 \paragraph{}
 228 It seems support for STM32VL is quite broken. If it does not work, try build STLINK using libsg:
 229 \begin{small}
 230 \begin{lstlisting}[frame=tb]
 231 $> cd stlink.git
 232 $> make CONFIG_USE_LIBSG=1
 233 \end{lstlisting}
 234 \end{small}
 235
 236
 237 \newpage
 238 \section{References}
 239 \begin{itemize}
 240 \item http://www.st.com/internet/mcu/product/248823.jsp\\
 241   documentation related to the STM32L mcu
 242 \item http://www.st.com/internet/evalboard/product/250990.jsp\\
 243   documentation related to the STM32L discovery kit
 244 \end{itemize}
 245
 246 \end{document}