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
 110 $> sudo ./st-util /dev/sg2
 111
 112 # STM32L discovery kit
 113 # 2 dummy command line arguments needed, will be fixed soon
 114 $> sudo ./st-util fu bar
 115 \end{lstlisting}
 116 \end{small}
 117
 118 \paragraph{}
 119 Then, GDB can be used to interact with the kit:\\
 120 \begin{small}
 121 \begin{lstlisting}[frame=tb]
 122 $> $TOOLCHAIN_PATH/bin/arm-none-eabi-gdb
 123 \end{lstlisting}
 124 \end{small}
 125
 126 \paragraph{}
 127 From GDB, connect to the server using:\\
 128 \begin{small}
 129 \begin{lstlisting}[frame=tb]
 130 $> target extended localhost:4242
 131 \end{lstlisting}
 132 \end{small}
 133
 134 \paragraph{}
 135 By default, the program was linked such that the base address is 0x20000000. From the architecture
 136 memory map, GDB knows this address belongs to SRAM. To load the program in SRAM, simply use:\\
 137 \begin{small}
 138 \begin{lstlisting}[frame=tb]
 139 $> load blink.elf
 140 \end{lstlisting}
 141 \end{small}
 142
 143 \paragraph{}
 144 GDB automatically set the PC register to the correct value, 0x20000000 in this case. Then, you
 145 can run the program using:\\
 146 \begin{small}
 147 \begin{lstlisting}[frame=tb]
 148 $> continue
 149 \end{lstlisting}
 150 \end{small}
 151
 152 \paragraph{}
 153 The board BLUE and GREEN leds should be blinking (those leds are near the user and reset buttons).
 154
 155
 156 \newpage
 157 \section{Reading and writing to flash}
 158 \paragraph{}
 159 Flash memory reading and writing is done by a separate tool. A binary running in flash is assumed to
 160 be linked against address 0x8000000. The flash tool is then used as shown below:\\
 161 \begin{small}
 162 \begin{lstlisting}[frame=tb]
 163 # change to the flash tool directory
 164 $> cd stlink.git/flash ;
 165
 166 # stlinkv1 command to read 4096 from flash into out.bin
 167 $> ./flash read /dev/sg2 out.bin 0x8000000 4096
 168
 169 # stlinkv2 command
 170 $> ./flash read out.bin 0x8000000 4096
 171
 172 # stlinkv1 command to write the file in.bin into flash
 173 $> ./flash write /dev/sg2 in.bin 0x8000000
 174
 175 # stlinkv2 command
 176 $> ./flash write in.bin 0x8000000
 177 \end{lstlisting}
 178 \end{small}
 179
 180
 181 \newpage
 182 \section{Notes}
 183
 184 \subsection{Disassembling THUMB code in GDB}
 185 \paragraph{}
 186 By default, the disassemble command in GDB operates in ARM mode. The programs running on CORTEX-M3
 187 are compiled in THUMB mode. To correctly disassemble them under GDB, uses an odd address. For instance,
 188 if you want to disassemble the code at 0x20000000, use:\\
 189 \begin{small}
 190 \begin{lstlisting}[frame=tb]
 191 $> disassemble 0x20000001
 192 \end{lstlisting}
 193 \end{small}
 194
 195
 196 \subsection{libstm32l\_discovery}
 197 \paragraph{}
 198 The repository includes the STM32L discovery library source code from ST original firmware packages,
 199 available here:\\
 200 \begin{small}
 201 \begin{lstlisting}[frame=tb]
 202 http://www.st.com/internet/evalboard/product/250990.jsp#FIRMWARE
 203 \end{lstlisting}
 204 \end{small}
 205
 206 \paragraph{}
 207 It is built using:\\
 208 \begin{small}
 209 \begin{lstlisting}[frame=tb]
 210 $> cd stlink.git/example/libstm32l_discovery/build
 211 $> make
 212 \end{lstlisting}
 213 \end{small}
 214
 215 \paragraph{}
 216 An example using the library can be built using:\\
 217 \begin{small}
 218 \begin{lstlisting}[frame=tb]
 219 $> cd stlink.git/example/lcd
 220 $> make
 221 \end{lstlisting}
 222 \end{small}
 223
 224 \subsection{STM32VL support}
 225 \paragraph{}
 226 It seems support for STM32VL is quite broken. If it does not work, try build STLINK using libsg:
 227 \begin{small}
 228 \begin{lstlisting}[frame=tb]
 229 $> cd stlink.git
 230 $> make CONFIG_USE_LIBSG=1
 231 \end{lstlisting}
 232 \end{small}
 233
 234
 235 \newpage
 236 \section{References}
 237 \begin{itemize}
 238 \item http://www.st.com/internet/mcu/product/248823.jsp\\
 239   documentation related to the STM32L mcu
 240 \item http://www.st.com/internet/evalboard/product/250990.jsp\\
 241   documentation related to the STM32L discovery kit
 242 \end{itemize}
 243
 244 \end{document}