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 version differ only in the transport layer used to communicate
  56 (v1 uses SCSI passthru commands, while v2 uses raw USB).
  57 \paragraph{}
  58 The STLINK software source code is retrieved using:\\
  59 \begin{small}
  60 \begin{lstlisting}[frame=tb]
  61 git clone https://github.com/texane/stlink stlink.git
  62 \end{lstlisting}
  63 \end{small}
  64
  65 \paragraph{}
  66 The GDB server is called st-util and is built using:\\
  67 \begin{small}
  68 \begin{lstlisting}[frame=tb]
  69 $> cd stlink.git; make ;
  70 \end{lstlisting}
  71 \end{small}
  72
  73
  74 \newpage
  75
  76 \section{Building and running a program}
  77 A simple LED blinking example is provided in the example directory. It is built using:\\
  78 \begin{small}
  79 \begin{lstlisting}[frame=tb]
  80 cd stlink.git/example ;
  81 PATH=$TOOLCHAIN_PATH/bin:$PATH make ;
  82 \end{lstlisting}
  83 \end{small}
  84
  85 \paragraph{}
  86 A GDB server must be start to interact with the STM32.
  87 Depending on the discovery kit you are using, you must
  88 run one of the 2 commands:\\
  89 \begin{small}
  90 \begin{lstlisting}[frame=tb]
  91 # STM32VL discovery kit
  92 $> sudo ./st-util /dev/sg2
  93
  94 # STM32L discovery kit
  95 $> sudo ./st-util
  96 \end{lstlisting}
  97 \end{small}
  98
  99 \paragraph{}
 100 Then, GDB can be used to interact with the kit:\\
 101 \begin{small}
 102 \begin{lstlisting}[frame=tb]
 103 $> $TOOLCHAIN_PATH/bin/arm-none-eabi-gdb
 104 \end{lstlisting}
 105 \end{small}
 106
 107 \paragraph{}
 108 From GDB, connect to the server using:\\
 109 \begin{small}
 110 \begin{lstlisting}[frame=tb]
 111 $> target extended localhost:4242
 112 \end{lstlisting}
 113 \end{small}
 114
 115 \paragraph{}
 116 To load the program, use:\\
 117 \begin{small}
 118 \begin{lstlisting}[frame=tb]
 119 $> load blinky.elf
 120 \end{lstlisting}
 121 \end{small}
 122
 123 \paragraph{}
 124 Then, you can run the program using:\\
 125 \begin{small}
 126 \begin{lstlisting}[frame=tb]
 127 $> run
 128 \end{lstlisting}
 129 \end{small}
 130
 131
 132 \newpage
 133 \section{References}
 134 \begin{itemize}
 135 \item http://www.st.com/internet/mcu/product/248823.jsp\\
 136   documentation related to the STM32L mcu
 137 \item http://www.st.com/internet/evalboard/product/250990.jsp\\
 138   documentation related to the STM32L discovery kit
 139 \end{itemize}
 140
 141 \end{document}