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 are required:
  60 \begin{itemize}
  61 \item libusb-1.0
  62 \item libsg2
  63 \end{itemize}
  64
  65 \paragraph{}
  66 The STLINK software source code is retrieved using:\\
  67 \begin{small}
  68 \begin{lstlisting}[frame=tb]
  69 git clone https://github.com/texane/stlink stlink.git
  70 \end{lstlisting}
  71 \end{small}
  72
  73 \paragraph{}
  74 The GDB server is called st-util and is built using:\\
  75 \begin{small}
  76 \begin{lstlisting}[frame=tb]
  77 $> cd stlink.git;
  78 $> make ;
  79 $> cd gdbserver ;
  80 $> make ;
  81 \end{lstlisting}
  82 \end{small}
  83
  84
  85 \newpage
  86
  87 \section{Building and running a program}
  88 A simple LED blinking example is provided in the example directory. It is built using:\\
  89 \begin{small}
  90 \begin{lstlisting}[frame=tb]
  91 cd stlink.git/example/blink ;
  92 PATH=$TOOLCHAIN_PATH/bin:$PATH make ;
  93 \end{lstlisting}
  94 \end{small}
  95
  96 \paragraph{}
  97 A GDB server must be start to interact with the STM32. Depending on the discovery kit you
  98 are using, you must run one of the 2 commands:\\
  99 \begin{small}
 100 \begin{lstlisting}[frame=tb]
 101 # STM32VL discovery kit
 102 $> sudo ./st-util /dev/sg2
 103
 104 # STM32L discovery kit
 105 $> sudo ./st-util
 106 \end{lstlisting}
 107 \end{small}
 108
 109 \paragraph{}
 110 Then, GDB can be used to interact with the kit:\\
 111 \begin{small}
 112 \begin{lstlisting}[frame=tb]
 113 $> $TOOLCHAIN_PATH/bin/arm-none-eabi-gdb
 114 \end{lstlisting}
 115 \end{small}
 116
 117 \paragraph{}
 118 From GDB, connect to the server using:\\
 119 \begin{small}
 120 \begin{lstlisting}[frame=tb]
 121 $> target extended localhost:4242
 122 \end{lstlisting}
 123 \end{small}
 124
 125 \paragraph{}
 126 By default, the program was linked such that the base address is 0x20000000. From the architecture
 127 memory map, GDB knows this address belongs to SRAM. To load the program in SRAM, simply use:\\
 128 \begin{small}
 129 \begin{lstlisting}[frame=tb]
 130 $> load blink.elf
 131 \end{lstlisting}
 132 \end{small}
 133
 134 \paragraph{}
 135 GDB automatically set the PC register to the correct value, 0x20000000 in this case. Then, you
 136 can run the program using:\\
 137 \begin{small}
 138 \begin{lstlisting}[frame=tb]
 139 $> continue
 140 \end{lstlisting}
 141 \end{small}
 142
 143 \paragraph{}
 144 The board BLUE and GREEN leds should be blinking (those leds are near the user and reset buttons).
 145
 146
 147 \newpage
 148 \section{References}
 149 \begin{itemize}
 150 \item http://www.st.com/internet/mcu/product/248823.jsp\\
 151   documentation related to the STM32L mcu
 152 \item http://www.st.com/internet/evalboard/product/250990.jsp\\
 153   documentation related to the STM32L discovery kit
 154 \end{itemize}
 155
 156 \end{document}